cvs: peardoc /en/pecl net-gopher.xml
| From: | Martin Jansen | Date: | Sat, 10 Sep 2005 13:35:48 +0000 |
| Subject: | cvs: peardoc /en/pecl net-gopher.xml | ||
| Groups: | php.doc php.pear.doc | ||
| Request: | Send a blank email to phpdoc+get-969370061@lists.php.net to get a copy of this message | ||
mj Sat Sep 10 09:35:48 2005 EDT
Modified files:
/peardoc/en/pecl net-gopher.xml
Log:
* The Net_Gopher docs are now part of the PHP manual.
http://cvs.php.net/diff.php/peardoc/en/pecl/net-gopher.xml?r1=1.3&r2=1.4&ty=u Index: peardoc/en/pecl/net-gopher.xml diff -u peardoc/en/pecl/net-gopher.xml:1.3 peardoc/en/pecl/net-gopher.xml:1.4 --- peardoc/en/pecl/net-gopher.xml:1.3 Sat Jul 19 22:10:20 2003 +++ peardoc/en/pecl/net-gopher.xml Sat Sep 10 09:35:47 2005 @@ -1,259 +1,19 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> - <reference id="pecl.net-gopher"> +<!-- $Revision: 1.4 $ --> +<reference id="pecl.net-gopher"> <title>Net_Gopher</title> - <titleabbrev>gopher</titleabbrev> - <partintro> - <sect1 id="pecl.net-gopher.partintro"> - <title>Introduction</title> - <sect2 id="pecl.net-gopher.intro"> - <title>About gopher</title> - <simpara> - The gopher protocol, as defined by <ulink url="&url.rfc;1436">RFC 1436</ulink>, - is generally considered the ancestor of the modern HTTP protocol. - However, gopher was also intended to provide references to non-gopher resources - including telnet, wais, nntp, and even http. This extension adds gopher support - to PHP's <ulink url="&url.php.lookup;wrappers">URL Wrappers</ulink>, and - provides a helper function <function>gopher_parsedir</function> to make sense - of gopher formatted directory listings. - </simpara> - </sect2> - - <sect2 id="pecl.net-gopher.install"> - <title>Installation</title> - <simpara> - Net_Gopher is installed through the usual PECL package installation process. - </simpara> - <itemizedlist> - <listitem> - <simpara> - Prerequisite: <literal>PHP 4.3.0</literal>. - </simpara> - </listitem> - <listitem> - <simpara> - <literal>pear install Net_Gopher</literal> - </simpara> - </listitem> - <listitem> - <simpara> - Copy the resulting <literal>gopher.so</literal> to an appropriate location - and add <literal>extension=gopher.so</literal> to your <literal>php.ini</literal> - file or load it dynamically in your PHP script using - <literal>dl("gopher.so");</literal> - </simpara> - </listitem> - </itemizedlist> - </sect2> - - <sect2 id="pecl.net-gopher.usage"> - <title>Usage</title> - <informalexample> - <programlisting role="php"> -<![CDATA[ -<?php -dl("gopher.so"); - -readfile("gopher://gopher.example.com/somedocument"); -?> -]]> - </programlisting> - </informalexample> - </sect2> - </sect1> - </partintro> - - <refentry id="pecl.net-gopher.gopher-parsedir"> + <refentry id="pecl.net-gopher.docs"> <refnamediv> - <refname>gopher_parsedir</refname> - <refpurpose>Translate a gopher formatted directory entry into an associative array.</refpurpose> + <refname>Documentation</refname> + <refpurpose /> </refnamediv> <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>gopher_parsedir</function></funcdef> - <paramdef>string <parameter>dirent</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <simpara> - While gopher returns <literal>text/plain</literal> documents for - actual document requests. A request to a directory (such as /) will - return specially encoded series of lines with each line being one - directory entry or information line. - </simpara> - <example> - <title>Hypothetical output from <literal>gopher://gopher.example.com/</literal></title> - <screen> -<![CDATA[ -0All about my gopher site. /allabout.txt gopher.example.com 70 -9A picture of my cat. /pics/cat.png gopher.example.com 70 -1A collection of my writings. /stories gopher.example.com 70 -hThe HTTP version of this site. URL:http://www.example.com gopher.example.com 70 -1Mirror of this site in Spain. / gopher.ejemplo.co.es 70 -iWelcome to my gopher site. error.host 1 -iPlease select one of the options above error.host 1 -iSend complaints to /dev/null error.host 1 -iLong live gopher! error.host 1 -]]> - </screen> - </example> - <simpara> - In the example above, the root directory at gopher.example.com knows about - one <literal>DOCUMENT</literal> identified by <literal>0</literal> located at - <literal>gopher://gopher.example.com:70/allabout.txt</literal>. It also knows - about two other directory (which have their own listing files) at - <literal>gopher://gopher.exmaple.com:70/stories</literal> and at - <literal>gopher://gopher.ejemplo.co.es:70/</literal>. - In addition there is a binary file, a link to an HTTP url, and several - informative lines. - </simpara> - <simpara> - By passing each line of the directory listing into - <function>gopher_parsedir</function>, an associative array is formed containing - a parsed out version of the data. - </simpara> - <example> - <title>Using <function>gopher_parsedir</function></title> - <programlisting role="php"> -<![CDATA[ -<?php -dl("gopher.so"); - -$directory = file("gopher://gopher.example.com"); - -foreach($directory as $dirent) { - print_r(gopher_parsedir($dirent)); -} - -/* Expected Output - --------------- - -Array ( - [type] => 0 - [title] => All about my gopher site. - [path] => /allabout.txt - [host] => gopher.example.com - [port] => 70 -) -Array ( - [type] => 9 - [title] => A picture of my cat. - [path] => /pics/cat.png - [host] => gopher.example.com - [port] => 70 -) -Array ( - [type] => 1 - [title] => A collection of my writings. - [path] => /stories - [host] => gopher.example.com - [port] => 70 -) -Array ( - [type] => 254 - [title] => The HTTP version of this site. - [path] => URL:http://www.example.com - [host] => gopher.example.com - [port] => 70 -) -Array ( - [type] => 1 - [title] => Mirror of this site in Spain. - [path] => / - [host] => gopher.ejemplo.co.es - [port] => 70 -) -Array ( - [type] => 255 - [title] => Welcome to my gopher site. - [path] => - [host] => error.host - [port] => 1 -) -Array ( - [type] => 255 - [title] => Please select one of the options above. - [path] => - [host] => error.host - [port] => 1 -) -Array ( - [type] => 255 - [title] => Send complaints to /dev/null - [path] => - [host] => error.host - [port] => 1 -) -Array ( - [type] => 255 - [title] => Long live gopher! - [path] => - [host] => error.host - [port] => 1 -) -*/ -?> -]]> - </programlisting> - </example> + <title>Documentation moved</title> <simpara> - The values given by <parameter>type</parameter> are associated with - the following constants. + The documentation is now part of the <ulink url="&url.php.manual;/en/ref.net-gopher.php">PHP + manual</ulink>. </simpara> - <table> - <title>Gopher Constants</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Constant</entry> - <entry>Definition</entry> - </row> - </thead> - <tbody> - <row> - <entry><constant>GOPHER_DOCUMENT</constant></entry> - <entry>Standard <literal>text/plain</literal> document.</entry> - </row> - <row> - <entry><constant>GOPHER_DIRECTORY</constant></entry> - <entry>A resource containing a gopher formatted directory listing.</entry> - </row> - <row> - <entry><constant>GOPHER_BINHEX</constant></entry> - <entry>A BinHex encoded binary file.</entry> - </row> - <row> - <entry><constant>GOPHER_DOSBINARY</constant></entry> - <entry>A DOS formatted binary archive.</entry> - </row> - <row> - <entry><constant>GOPHER_UUENCODED</constant></entry> - <entry>A UUEncoded file.</entry> - </row> - <row> - <entry><constant>GOPHER_BINARY</constant></entry> - <entry>A generic binary file.</entry> - </row> - <row> - <entry><constant>GOPHER_INFO</constant></entry> - <entry>An Informational entry</entry> - </row> - <row> - <entry><constant>GOPHER_HTTP</constant></entry> - <entry>A reference to an HTTP resource.</entry> - </row> - <row> - <entry><constant>GOPHER_UNKNOWN</constant></entry> - <entry> - An unrecognized entry, the line will be returned - in <parameter>data</parameter>. - </entry> - </row> - </tbody> - </tgroup> - </table> </refsect1> </refentry> </reference>
http://cvs.php.net/diff.php/peardoc/en/pecl/net-gopher.xml?r1=1.3&r2=1.4&ty=u Index: peardoc/en/pecl/net-gopher.xml diff -u peardoc/en/pecl/net-gopher.xml:1.3 peardoc/en/pecl/net-gopher.xml:1.4 --- peardoc/en/pecl/net-gopher.xml:1.3 Sat Jul 19 22:10:20 2003 +++ peardoc/en/pecl/net-gopher.xml Sat Sep 10 09:35:47 2005 @@ -1,259 +1,19 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> - <reference id="pecl.net-gopher"> +<!-- $Revision: 1.4 $ --> +<reference id="pecl.net-gopher"> <title>Net_Gopher</title> - <titleabbrev>gopher</titleabbrev> - <partintro> - <sect1 id="pecl.net-gopher.partintro"> - <title>Introduction</title> - <sect2 id="pecl.net-gopher.intro"> - <title>About gopher</title> - <simpara> - The gopher protocol, as defined by <ulink url="&url.rfc;1436">RFC 1436</ulink>, - is generally considered the ancestor of the modern HTTP protocol. - However, gopher was also intended to provide references to non-gopher resources - including telnet, wais, nntp, and even http. This extension adds gopher support - to PHP's <ulink url="&url.php.lookup;wrappers">URL Wrappers</ulink>, and - provides a helper function <function>gopher_parsedir</function> to make sense - of gopher formatted directory listings. - </simpara> - </sect2> - - <sect2 id="pecl.net-gopher.install"> - <title>Installation</title> - <simpara> - Net_Gopher is installed through the usual PECL package installation process. - </simpara> - <itemizedlist> - <listitem> - <simpara> - Prerequisite: <literal>PHP 4.3.0</literal>. - </simpara> - </listitem> - <listitem> - <simpara> - <literal>pear install Net_Gopher</literal> - </simpara> - </listitem> - <listitem> - <simpara> - Copy the resulting <literal>gopher.so</literal> to an appropriate location - and add <literal>extension=gopher.so</literal> to your <literal>php.ini</literal> - file or load it dynamically in your PHP script using - <literal>dl("gopher.so");</literal> - </simpara> - </listitem> - </itemizedlist> - </sect2> - - <sect2 id="pecl.net-gopher.usage"> - <title>Usage</title> - <informalexample> - <programlisting role="php"> -<![CDATA[ -<?php -dl("gopher.so"); - -readfile("gopher://gopher.example.com/somedocument"); -?> -]]> - </programlisting> - </informalexample> - </sect2> - </sect1> - </partintro> - - <refentry id="pecl.net-gopher.gopher-parsedir"> + <refentry id="pecl.net-gopher.docs"> <refnamediv> - <refname>gopher_parsedir</refname> - <refpurpose>Translate a gopher formatted directory entry into an associative array.</refpurpose> + <refname>Documentation</refname> + <refpurpose /> </refnamediv> <refsect1> - <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>array <function>gopher_parsedir</function></funcdef> - <paramdef>string <parameter>dirent</parameter></paramdef> - </funcprototype> - </funcsynopsis> - <simpara> - While gopher returns <literal>text/plain</literal> documents for - actual document requests. A request to a directory (such as /) will - return specially encoded series of lines with each line being one - directory entry or information line. - </simpara> - <example> - <title>Hypothetical output from <literal>gopher://gopher.example.com/</literal></title> - <screen> -<![CDATA[ -0All about my gopher site. /allabout.txt gopher.example.com 70 -9A picture of my cat. /pics/cat.png gopher.example.com 70 -1A collection of my writings. /stories gopher.example.com 70 -hThe HTTP version of this site. URL:http://www.example.com gopher.example.com 70 -1Mirror of this site in Spain. / gopher.ejemplo.co.es 70 -iWelcome to my gopher site. error.host 1 -iPlease select one of the options above error.host 1 -iSend complaints to /dev/null error.host 1 -iLong live gopher! error.host 1 -]]> - </screen> - </example> - <simpara> - In the example above, the root directory at gopher.example.com knows about - one <literal>DOCUMENT</literal> identified by <literal>0</literal> located at - <literal>gopher://gopher.example.com:70/allabout.txt</literal>. It also knows - about two other directory (which have their own listing files) at - <literal>gopher://gopher.exmaple.com:70/stories</literal> and at - <literal>gopher://gopher.ejemplo.co.es:70/</literal>. - In addition there is a binary file, a link to an HTTP url, and several - informative lines. - </simpara> - <simpara> - By passing each line of the directory listing into - <function>gopher_parsedir</function>, an associative array is formed containing - a parsed out version of the data. - </simpara> - <example> - <title>Using <function>gopher_parsedir</function></title> - <programlisting role="php"> -<![CDATA[ -<?php -dl("gopher.so"); - -$directory = file("gopher://gopher.example.com"); - -foreach($directory as $dirent) { - print_r(gopher_parsedir($dirent)); -} - -/* Expected Output - --------------- - -Array ( - [type] => 0 - [title] => All about my gopher site. - [path] => /allabout.txt - [host] => gopher.example.com - [port] => 70 -) -Array ( - [type] => 9 - [title] => A picture of my cat. - [path] => /pics/cat.png - [host] => gopher.example.com - [port] => 70 -) -Array ( - [type] => 1 - [title] => A collection of my writings. - [path] => /stories - [host] => gopher.example.com - [port] => 70 -) -Array ( - [type] => 254 - [title] => The HTTP version of this site. - [path] => URL:http://www.example.com - [host] => gopher.example.com - [port] => 70 -) -Array ( - [type] => 1 - [title] => Mirror of this site in Spain. - [path] => / - [host] => gopher.ejemplo.co.es - [port] => 70 -) -Array ( - [type] => 255 - [title] => Welcome to my gopher site. - [path] => - [host] => error.host - [port] => 1 -) -Array ( - [type] => 255 - [title] => Please select one of the options above. - [path] => - [host] => error.host - [port] => 1 -) -Array ( - [type] => 255 - [title] => Send complaints to /dev/null - [path] => - [host] => error.host - [port] => 1 -) -Array ( - [type] => 255 - [title] => Long live gopher! - [path] => - [host] => error.host - [port] => 1 -) -*/ -?> -]]> - </programlisting> - </example> + <title>Documentation moved</title> <simpara> - The values given by <parameter>type</parameter> are associated with - the following constants. + The documentation is now part of the <ulink url="&url.php.manual;/en/ref.net-gopher.php">PHP + manual</ulink>. </simpara> - <table> - <title>Gopher Constants</title> - <tgroup cols="2"> - <thead> - <row> - <entry>Constant</entry> - <entry>Definition</entry> - </row> - </thead> - <tbody> - <row> - <entry><constant>GOPHER_DOCUMENT</constant></entry> - <entry>Standard <literal>text/plain</literal> document.</entry> - </row> - <row> - <entry><constant>GOPHER_DIRECTORY</constant></entry> - <entry>A resource containing a gopher formatted directory listing.</entry> - </row> - <row> - <entry><constant>GOPHER_BINHEX</constant></entry> - <entry>A BinHex encoded binary file.</entry> - </row> - <row> - <entry><constant>GOPHER_DOSBINARY</constant></entry> - <entry>A DOS formatted binary archive.</entry> - </row> - <row> - <entry><constant>GOPHER_UUENCODED</constant></entry> - <entry>A UUEncoded file.</entry> - </row> - <row> - <entry><constant>GOPHER_BINARY</constant></entry> - <entry>A generic binary file.</entry> - </row> - <row> - <entry><constant>GOPHER_INFO</constant></entry> - <entry>An Informational entry</entry> - </row> - <row> - <entry><constant>GOPHER_HTTP</constant></entry> - <entry>A reference to an HTTP resource.</entry> - </row> - <row> - <entry><constant>GOPHER_UNKNOWN</constant></entry> - <entry> - An unrecognized entry, the line will be returned - in <parameter>data</parameter>. - </entry> - </row> - </tbody> - </tgroup> - </table> </refsect1> </refentry> </reference>