[prev in list] [next in list] [prev in thread] [next in thread]
List: pear-doc
Subject: [PEAR-DOC] cvs: peardoc /en/package/networking/net-finger query.xml
From: "Christophe Gesché" <moosh () php ! net>
Date: 2005-10-25 19:40:36
Message-ID: cvsmoosh1130269236 () cvsserver
[Download RAW message or body]
moosh Tue Oct 25 15:40:36 2005 EDT
Modified files:
/peardoc/en/package/networking/net-finger query.xml
Log:
- 2 params has the same name ;-*
- WS 80
- use entities
http://cvs.php.net/diff.php/peardoc/en/package/networking/net-finger/query.xml?r1=1.1.1.1&r2=1.2&ty=u
Index: peardoc/en/package/networking/net-finger/query.xml
diff -u peardoc/en/package/networking/net-finger/query.xml:1.1.1.1 \
peardoc/en/package/networking/net-finger/query.xml:1.2
--- peardoc/en/package/networking/net-finger/query.xml:1.1.1.1 Mon Sep 30 23:23:43 \
2002
+++ peardoc/en/package/networking/net-finger/query.xml Tue Oct 25 15:40:31 2005
@@ -1,83 +1,91 @@
-<!-- $Revision: 1.1.1.1 $ -->
+<!-- $Revision: 1.2 $ -->
+<!-- Package Version for this doc : 1.0.0.Stable -->
<refentry id="package.networking.net-finger.query">
- <refnamediv>
- <refname>Net_Finger::query()</refname>
- <refpurpose>does a finger query</refpurpose>
- </refnamediv>
- <refsynopsisdiv>
- <funcsynopsis>
- <funcsynopsisinfo>
- require_once 'Net/Finger.php';
- </funcsynopsisinfo>
- <funcprototype>
- <funcdef>string <function>Net_Finger::query</function></funcdef>
- <paramdef>
- string <parameter>$server</parameter>
- </paramdef>
- <paramdef>
- string <parameter>$server</parameter>
- </paramdef>
- </funcprototype>
- </funcsynopsis>
- </refsynopsisdiv>
- <refsect1 id="package.networking.net-finger.query.desc">
- &title.desc;
- <para>
- Execute a finger query on a server
- </para>
- </refsect1>
- <refsect1 id="package.networking.net-finger.query.parameter">
- &title.param;
- <para>
- <itemizedlist>
- <listitem>
- <para>
- <parameter>string $server</parameter> - The name of the server or the
- IP-adress
- </para>
- </listitem>
- <listitem>
- <para>
- <parameter>string $query</parameter> - The finger object to look up
- </para>
- </listitem>
- </itemizedlist>
- </para>
- </refsect1>
- <refsect1 id="package.networking.net-finger.query.return">
- &title.returns;
- <para>
- <parameter>string</parameter> - the data from the finger request.
- </para>
- </refsect1>
- <refsect1 id="package.networking.net-finger.query.throws">
- &title.throws;
- <para>
- The returned &class.pear-error; object in case of an error
- is unspecific, so you can ignore the error code and/or message.
- The reason for a failure could be a failed connection to the server
- or the server did not run a finger service.
- </para>
- <note>
+ <refnamediv>
+ <refname>Net_Finger::query()</refname>
+ <refpurpose>does a finger query</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <funcsynopsis>
+ <funcsynopsisinfo>
+ require_once 'Net/Finger.php';
+ </funcsynopsisinfo>
+ <funcprototype>
+ <funcdef>&type.string;
+ <function>Net_Finger::query</function>
+ </funcdef>
+ <paramdef>
+ &type.string; <parameter>$server</parameter>
+ </paramdef>
+ <paramdef>
+ &type.string; <parameter>$query</parameter>
+ </paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ </refsynopsisdiv>
+ <refsect1 id="package.networking.net-finger.query.desc">
+ &title.desc;
+ <para>
+ Execute a finger query on a server
+ </para>
+ </refsect1>
+ <refsect1 id="package.networking.net-finger.query.parameter">
+ &title.param;
+ <para>
+ <itemizedlist>
+ <listitem>
<para>
- You will <emphasis>not</emphasis> get a &class.pear-error;, if
- the query fails due to a not existing finger object. This can be
- only done by checking the data returned by <function>query</function>.
+ <parameter>&type.string; $server</parameter>
+ - The name of the server or the IP-adress
</para>
- </note>
- </refsect1>
- <refsect1 id="package.networking.net-finger.query.note">
- &title.note;
- ¬e.canstatic;
- </refsect1>
- <refsect1 id="package.networking.net-finger.query.example">
- &title.example;
- <example>
- <title>Using <function>query</function></title>
- <programlisting role="php">
- <![CDATA[
+ </listitem>
+ <listitem>
+ <para>
+ <parameter>&type.string; $query</parameter>
+ - The finger object to look up
+ </para>
+ </listitem>
+ </itemizedlist>
+ </para>
+ </refsect1>
+ <refsect1 id="package.networking.net-finger.query.return">
+ &title.returns;
+ <para>
+ <parameter>&type.string;</parameter>
+ - the data from the finger request.
+ </para>
+ </refsect1>
+ <refsect1 id="package.networking.net-finger.query.throws">
+ &title.throws;
+ <para>
+ The returned &class.pear-error; object in case of an error
+ is unspecific, so you can ignore the error code and/or message.
+
+ The reason for a failure could be a failed connection to the server
+ or the server did not run a finger service.
+ </para>
+ <note>
+ <para>
+ You will <emphasis>not</emphasis> get a &class.pear-error;,
+ if the query fails due to a not existing finger object.
+
+ This can be only done by checking the data returned by
+ <function>query</function>.
+ </para>
+ </note>
+ </refsect1>
+ <refsect1 id="package.networking.net-finger.query.note">
+ &title.note;
+ ¬e.canstatic;
+ </refsect1>
+ <refsect1 id="package.networking.net-finger.query.example">
+ &title.example;
+ <example>
+ <title>Using <function>query</function></title>
+ <programlisting role="php">
+ <![CDATA[
<?php
-
+
$server = "localhost" ; // or IP adress to use
$query = "ralph" ; // Username to look up
@@ -86,10 +94,10 @@
?>
]]>
- </programlisting>
- </example>
- </refsect1>
- </refentry>
+ </programlisting>
+ </example>
+ </refsect1>
+</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
--
PEAR Documentation List Mailing List (http://pear.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic