Fixed grammatical errors and spelling mistakes.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@95949 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Erica Douglass 2002-09-17 09:46:58 +00:00
parent 55f2a0f788
commit 80f92c7e16
28 changed files with 104 additions and 101 deletions

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<section id="ftp.constants">
&reftitle.constants;
&extension.constants;
@ -82,8 +82,8 @@
</term>
<listitem>
<simpara>
Automaticly determine resumepos/startpos for get/put request
(does only work if FTP_AUTOSEEK is enabled)
Automatically determine resume position and start position for GET and PUT requests
(only works if FTP_AUTOSEEK is enabled)
</simpara>
</listitem>
</varlistentry>

View file

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.ftp-async-continue">
<refnamediv>
<refname>ftp_async_continue</refname>
<refpurpose>Continues retrieving/sending a file asyncronously</refpurpose>
<refpurpose>Continues retrieving/sending a file asynchronously</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -12,7 +12,7 @@
<methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
</methodsynopsis>
<para>
Continues retrieving/sending a file asyncronously
Continues retrieving/sending a file asynchronously
</para>
<para>
Returns <constant>FTP_FAILED</constant> or <constant>FTP_FINISHED</constant>

View file

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.ftp-async-fget">
<refnamediv>
<refname>ftp_async_fget</refname>
<refpurpose>Retrieves a file from the FTP server asynchronly and writes it to an open file</refpurpose>
<refpurpose>Retrieves a file from the FTP server asynchronously and writes it to an open file</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -20,13 +20,13 @@
from the FTP server, and writes it to the given file pointer,
<parameter>fp</parameter>. The transfer <parameter>mode</parameter>
specified must be either <constant>FTP_ASCII</constant> or
<constant>FTP_BINARY</constant>. The difference between
<constant>FTP_BINARY</constant>. The difference between this function and the
<function>ftp_fget</function> is that this function retrieves the file
asyncronously, so you can do other things in your program while the
file is downloaded.
asynchronously, so your program can perform other operations while the
file is being downloaded.
</para>
<para>
Returns &true; on success, &false; on error.
Returns &true; on success or &false; on error.
</para>
<para>
See also <function>ftp_async_get</function>.

View file

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.ftp-async-fput">
<refnamediv>
<refname>ftp_async_fput</refname>
<refpurpose>Stores a file from an open file to the FTP server asyncronly</refpurpose>
<refpurpose>Stores a file from an open file to the FTP server asynchronously</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -17,16 +17,16 @@
</methodsynopsis>
<para>
<function>ftp_async_fput</function> uploads the data from the file pointer
<parameter>fp</parameter> until end of file. The results are stored
<parameter>fp</parameter> until it reaches the end of the file. The results are stored
in <parameter>remote_file</parameter> on the FTP server. The transfer
<parameter>mode</parameter> specified must be either
<constant>FTP_ASCII</constant> or <constant>FTP_BINARY</constant>.
The difference between <function>ftp_fput</function> is that this
function uploads the file asyncronously, so you can do other things
in your program while the file is uploadde.
The difference between this function and the <function>ftp_fput</function> is that this
function uploads the file asynchronously, so your program can perform other operations while the
file is being downloaded.
</para>
<para>
Returns &true; on success, &false; on error.
Returns &true; on success or &false; on error.
</para>
<para>
See also <function>ftp_async_put</function>,

View file

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.ftp-async-get">
<refnamediv>
<refname>ftp_async_get</refname>
<refpurpose>Retrieves a file from the FTP server asynchronly and writes it to a local file</refpurpose>
<refpurpose>Retrieves a file from the FTP server asynchronously and writes it to a local file</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -20,13 +20,13 @@
from the FTP server, and saves it to <parameter>local_file</parameter>
locally. The transfer <parameter>mode</parameter> specified must
be either <constant>FTP_ASCII</constant> or
<constant>FTP_BINARY</constant>. The difference between
<constant>FTP_BINARY</constant>. The difference between this function and the
<function>ftp_get</function> is that this function retrieves the file
asyncronously, so you can do other things in your program while the
file is downloaded.
asynchronously, so your program can perform other operations while the
file is being downloaded.
</para>
<para>
Returns &true; on success, &false; on error.
Returns &true; on success or &false; on error.
</para>
<para>
<example>
@ -101,7 +101,7 @@ while ($ret == FTP_MOREDATA) {
In the example above, <filename>"newfile"</filename> is 100
bytes smaller than <filename>"README"</filename> on the FTP
server because we started reading at offset 100. If we have
not have disabled <constant>FTP_AUTOSEEK</constant> the first
not have disabled <constant>FTP_AUTOSEEK</constant>, the first
100 bytes of newfile will be <literal>'\0'</literal>.
</para>
<para>

View file

@ -1,9 +1,9 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- $Revision: 1.2 $ -->
<refentry id="function.ftp-async-put">
<refnamediv>
<refname>ftp_async_put</refname>
<refpurpose>Stores a file on the FTP server asynchronly</refpurpose>
<refpurpose>Stores a file on the FTP server asynchronously</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -20,12 +20,12 @@
on the FTP server, as <parameter>remote_file</parameter>. The transfer
<parameter>mode</parameter> specified must be either
<constant>FTP_ASCII</constant> or <constant>FTP_BINARY</constant>.
The difference between <function>ftp_put</function> is that this
function uploads the file asyncronously, so you can do other things
in your program while the file is uploadde.
The difference between this function and the <function>ftp_put</function> is that this
function uploads the file asynchronously, so your program can perform other operations while the
file is being downloaded.
</para>
<para>
Returns &true; on success, &false; on error.
Returns &true; on success or &false; on error.
</para>
<para>
<example>

View file

@ -1,6 +1,6 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- splitted from ./en/functions/ftp.xml, last change in rev 1.2 -->
<!-- $Revision: 1.3 $ -->
<!-- split from ./en/functions/ftp.xml, last change in rev 1.2 -->
<refentry id="function.ftp-cdup">
<refnamediv>
<refname>ftp_cdup</refname>
@ -16,7 +16,7 @@
Changes to the parent directory.
</para>
<para>
Returns &true; on success, &false; on error.
Returns &true; on success or &false; on error.
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ftp.xml, last change in rev 1.2 -->
<refentry id="function.ftp-chdir">
<refnamediv>
@ -17,7 +17,7 @@
Changes to the specified <parameter>directory</parameter>.
</para>
<para>
Returns &true; on success, &false; on error.</para>
Returns &true; on success or &false; on error.</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ftp.xml, last change in rev 1.34 -->
<refentry id="function.ftp-close">
<refnamediv>
@ -19,7 +19,7 @@
</note>
<para>
<function>ftp_close</function> closes <parameter>ftp_stream</parameter>
and releases the resource. You can't reuse this resource but have to
and releases the resource. After calling this function, you can no longer use the FTP connection and must
create a new one with <function>ftp_connect</function>.
</para>
</refsect1>

View file

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ftp.xml, last change in rev 1.2 -->
<refentry id="function.ftp-connect">
<refnamediv>
<refname>ftp_connect</refname>
<refpurpose>Opens up an FTP connection</refpurpose>
<refpurpose>Opens an FTP connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -15,23 +15,23 @@
<methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam>
</methodsynopsis>
<para>
Returns a FTP stream on success, &false; on error.
Returns a FTP stream on success or &false; on error.
</para>
<para>
<function>ftp_connect</function> opens up a FTP connection to the
<function>ftp_connect</function> opens an FTP connection to the
specified <parameter>host</parameter>. The <parameter>port</parameter>
parameter specifies an alternate port to connect to. If it is
omitted or zero, then the default FTP port, 21, will be used.
omitted or set to zero, then the default FTP port, 21, will be used.
</para>
<para>
The <parameter>timeout</parameter> parameter specifies the timeout for all
subsequent network operations. If omitted, the default value is 90
seconds. The timeout can be changed and queried anytime with
seconds. The timeout can be changed and queried at any time with
<function>ftp_set_option</function> and
<function>ftp_get_option</function>.
<note>
<para>
This parameter is available since 4.2.0 .
This parameter is available beginning with PHP 4.2.0.
</para>
</note>
</para>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ftp.xml, last change in rev 1.2 -->
<refentry id="function.ftp-delete">
<refnamediv>
@ -18,7 +18,7 @@
<parameter>path</parameter> from the FTP server.
</para>
<para>
Returns &true; on success, &false; on error.
Returns &true; on success or &false; on error.
</para>
</refsect1>
</refentry>

View file

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ftp.xml, last change in rev 1.32 -->
<refentry id='function.ftp-exec'>
<refnamediv>
<refname>ftp_exec</refname>
<refpurpose>Request execution of a program on the FTP server</refpurpose>
<refpurpose>Requests execution of a program on the FTP server</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -15,8 +15,7 @@
</methodsynopsis>
<para>
Sends a SITE EXEC <parameter>command</parameter> request to the FTP
server. Returns &false; if the request fails, returns the output of the
command otherwise.
server. Returns the output of the command if successful; otherwise returns &false;.
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ftp.xml, last change in rev 1.2 -->
<refentry id="function.ftp-fget">
<refnamediv>
@ -29,7 +29,7 @@
</para>
</note>
<para>
Returns &true; on success, &false; on error.
Returns &true; on success or &false; on error.
</para>
<para>
See also <function>ftp_get</function>.

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ftp.xml, last change in rev 1.2 -->
<refentry id="function.ftp-fput">
<refnamediv>
@ -18,7 +18,7 @@
</methodsynopsis>
<para>
<function>ftp_fput</function> uploads the data from the file pointer
<parameter>fp</parameter> until end of file. The results are stored
<parameter>fp</parameter> until the end of the file is reached. The results are stored
in <parameter>remote_file</parameter> on the FTP server. The transfer
<parameter>mode</parameter> specified must be either
<constant>FTP_ASCII</constant> or <constant>FTP_BINARY</constant>.
@ -29,7 +29,7 @@
</para>
</note>
<para>
Returns &true; on success, &false; on error.
Returns &true; on success or &false; on error.
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ftp.xml, last change in rev 1.30 -->
<refentry id='function.ftp-get-option'>
<refnamediv>
@ -19,7 +19,7 @@
</para>
</note>
<para>
Returns the value on success, or &false; if the given
Returns the value on success or &false; if the given
<parameter>option</parameter> is not supported. In the latter case, a
warning message is also thrown.
</para>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ftp.xml, last change in rev 1.2 -->
<refentry id="function.ftp-get">
<refnamediv>
@ -29,7 +29,7 @@
</para>
</note>
<para>
Returns &true; on success, &false; on error.
Returns &true; on success or &false; on error.
</para>
<para>
See also <function>ftp_fget</function> and <function>ftp_async_get</function>.

View file

@ -1,10 +1,10 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ftp.xml, last change in rev 1.2 -->
<refentry id="function.ftp-login">
<refnamediv>
<refname>ftp_login</refname>
<refpurpose>Logs in an FTP connection</refpurpose>
<refpurpose>Logs in to an FTP connection</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
@ -15,10 +15,10 @@
<methodparam><type>string</type><parameter>password</parameter></methodparam>
</methodsynopsis>
<para>
Logs in the given FTP stream.
Logs in to the given FTP stream.
</para>
<para>
Returns &true; on success, &false; on error.
Returns &true; on success or &false; on error.
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ftp.xml, last change in rev 1.2 -->
<refentry id="function.ftp-mdtm">
<refnamediv>
@ -14,14 +14,18 @@
<methodparam><type>string</type><parameter>remote_file</parameter></methodparam>
</methodsynopsis>
<para>
<function>ftp_mdtm</function> checks the last-modified time for a
<function>ftp_mdtm</function> checks the last modified time for a
file, and returns it as a UNIX timestamp. If an error occurs, or
the file does not exist, -1 is returned. Note that not all servers
support this feature.
the file does not exist, -1 is returned.
</para>
<para>
Returns a UNIX timestamp on success, or -1 on error.
</para>
<note>
<para>
Not all servers support this feature!
</para>
</note>
<note>
<para>
<function>ftp_mdtm</function> does not work with directories.

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ftp.xml, last change in rev 1.2 -->
<refentry id="function.ftp-mkdir">
<refnamediv>
@ -17,7 +17,7 @@
Creates the specified <parameter>directory</parameter>.
</para>
<para>
Returns the newly created directory name on success, &false; on error.
Returns the newly created directory name on success or &false; on error.
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ftp.xml, last change in rev 1.2 -->
<refentry id="function.ftp-nlist">
<refnamediv>
@ -15,7 +15,7 @@
</methodsynopsis>
<para>
Returns an array of filenames from the specified directory
on success, &false; on error.
on success or &false; on error.
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ftp.xml, last change in rev 1.2 -->
<refentry id="function.ftp-pasv">
<refnamediv>
@ -15,13 +15,13 @@
</methodsynopsis>
<para>
<function>ftp_pasv</function> turns on passive mode if the
<parameter>pasv</parameter> parameter is &true; (it turns off
passive mode if <parameter>pasv</parameter> is &false;.) In
<parameter>pasv</parameter> parameter is &true;. It turns off
passive mode if <parameter>pasv</parameter> is &false;. In
passive mode, data connections are initiated by the client,
rather than by the server.
</para>
<para>
Returns &true; on success, &false; on error.
Returns &true; on success or &false; on error.
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<!-- $Revision: 1.4 $ -->
<!-- splitted from ./en/functions/ftp.xml, last change in rev 1.2 -->
<refentry id="function.ftp-put">
<refnamediv>
@ -28,7 +28,7 @@
</para>
</note>
<para>
Returns &true; on success, &false; on error.
Returns &true; on success or &false; on error.
</para>
<para>
<example>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ftp.xml, last change in rev 1.2 -->
<refentry id="function.ftp-pwd">
<refnamediv>
@ -13,7 +13,7 @@
<methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
</methodsynopsis>
<para>
Returns the current directory, or &false; on error.
Returns the current directory or &false; on error.
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ftp.xml, last change in rev 1.2 -->
<refentry id="function.ftp-rename">
<refnamediv>
@ -15,13 +15,13 @@
<methodparam><type>string</type><parameter>to</parameter></methodparam>
</methodsynopsis>
<para>
<function>ftp_rename</function> renames the file or directory
<function>ftp_rename</function> renames the file or directory that is
currently named <parameter>from</parameter> to the new name
<parameter>to</parameter>, on the FTP stream
<parameter>to</parameter>, using the FTP stream
<parameter>ftp_stream</parameter>.
</para>
<para>
Returns &true; on success, &false; on error.
Returns &true; on success or &false; on error.
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ftp.xml, last change in rev 1.2 -->
<refentry id="function.ftp-rmdir">
<refnamediv>
@ -17,7 +17,7 @@
Removes the specified <parameter>directory</parameter>.
</para>
<para>
Returns &true; on success, &false; on error.</para>
Returns &true; on success or &false; on error.</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- $Revision: 1.6 $ -->
<!-- splitted from ./en/functions/ftp.xml, last change in rev 1.32 -->
<refentry id='function.ftp-set-option'>
<refnamediv>
@ -37,15 +37,15 @@
<row>
<entry>FTP_TIMEOUT_SEC</entry>
<entry>Changes the timeout in seconds used for all network related
functions. Parameter <parameter>value</parameter> has be to of type
<type>int</type> and must be greater than 0. The default timeout is 90
seconds.</entry>
functions. <parameter>value</parameter> must be an integer that is greater than 0.
The default timeout is 90 seconds.</entry>
</row>
<row>
<entry>FTP_AUTOSEEK</entry>
<entry>When enabled (which is the default) get/put requests with
a <parameter>resumepos</parameter>/<parameter>startpos</parameter>
parameter will first seek to the wanted position within the stream.
<entry>When enabled, GET or PUT requests with
a <parameter>resumepos</parameter> or <parameter>startpos</parameter>
parameter will first seek to the requested position within the file. This is enabled
by default.
</entry>
</row>
</tbody>
@ -57,7 +57,7 @@
<title><function>ftp_set_option</function> example</title>
<programlisting role="php">
<![CDATA[
// Set the network timeout down to 10 seconds
// Set the network timeout to 10 seconds
ftp_set_option($conn_id, FTP_TIMEOUT_SEC, 10);
]]>
</programlisting>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/ftp.xml, last change in rev 1.3 -->
<refentry id="function.ftp-site">
<refnamediv>
@ -21,7 +21,7 @@
membership.
</para>
<para>
Returns &true; on success, &false; on error.
Returns &true; on success or &false; on error.
</para>
</refsect1>
</refentry>

View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.4 $ -->
<!-- $Revision: 1.5 $ -->
<reference id="ref.ftp">
<title>FTP functions</title>
<titleabbrev>FTP</titleabbrev>
@ -25,7 +25,7 @@
In order to use FTP functions with your PHP configuration, you should
add the <link linkend="install.configure.enable-ftp">
<option role="configure">--enable-ftp</option></link> option when
installing PHP 4, and <link linkend="install.configure.with-ftp">
installing PHP 4 or <link linkend="install.configure.with-ftp">
<option role="configure">--with-ftp</option></link> when using PHP 3.
</para>
</section>
@ -38,8 +38,8 @@
<section id="ftp.resources">
&reftitle.resources;
<para>
This extension uses one resource-type, which is the link-identifier
of the ftp-connection.
This extension uses one resource type, which is the link identifier
of the FTP connection.
</para>
</section>