From 80f92c7e1635bcc63bb87ac8197425030783b39d Mon Sep 17 00:00:00 2001 From: Erica Douglass Date: Tue, 17 Sep 2002 09:46:58 +0000 Subject: [PATCH] Fixed grammatical errors and spelling mistakes. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@95949 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/ftp/constants.xml | 6 +++--- reference/ftp/functions/ftp-async-continue.xml | 6 +++--- reference/ftp/functions/ftp-async-fget.xml | 12 ++++++------ reference/ftp/functions/ftp-async-fput.xml | 14 +++++++------- reference/ftp/functions/ftp-async-get.xml | 14 +++++++------- reference/ftp/functions/ftp-async-put.xml | 12 ++++++------ reference/ftp/functions/ftp-cdup.xml | 6 +++--- reference/ftp/functions/ftp-chdir.xml | 4 ++-- reference/ftp/functions/ftp-close.xml | 4 ++-- reference/ftp/functions/ftp-connect.xml | 14 +++++++------- reference/ftp/functions/ftp-delete.xml | 4 ++-- reference/ftp/functions/ftp-exec.xml | 7 +++---- reference/ftp/functions/ftp-fget.xml | 4 ++-- reference/ftp/functions/ftp-fput.xml | 6 +++--- reference/ftp/functions/ftp-get-option.xml | 4 ++-- reference/ftp/functions/ftp-get.xml | 4 ++-- reference/ftp/functions/ftp-login.xml | 8 ++++---- reference/ftp/functions/ftp-mdtm.xml | 12 ++++++++---- reference/ftp/functions/ftp-mkdir.xml | 4 ++-- reference/ftp/functions/ftp-nlist.xml | 4 ++-- reference/ftp/functions/ftp-pasv.xml | 8 ++++---- reference/ftp/functions/ftp-put.xml | 4 ++-- reference/ftp/functions/ftp-pwd.xml | 4 ++-- reference/ftp/functions/ftp-rename.xml | 8 ++++---- reference/ftp/functions/ftp-rmdir.xml | 4 ++-- reference/ftp/functions/ftp-set-option.xml | 16 ++++++++-------- reference/ftp/functions/ftp-site.xml | 4 ++-- reference/ftp/reference.xml | 8 ++++---- 28 files changed, 104 insertions(+), 101 deletions(-) diff --git a/reference/ftp/constants.xml b/reference/ftp/constants.xml index da8bac2943..ee7397b4c9 100644 --- a/reference/ftp/constants.xml +++ b/reference/ftp/constants.xml @@ -1,5 +1,5 @@ - +
&reftitle.constants; &extension.constants; @@ -82,8 +82,8 @@ - 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) diff --git a/reference/ftp/functions/ftp-async-continue.xml b/reference/ftp/functions/ftp-async-continue.xml index e7378d9155..53009d1ead 100644 --- a/reference/ftp/functions/ftp-async-continue.xml +++ b/reference/ftp/functions/ftp-async-continue.xml @@ -1,9 +1,9 @@ - + ftp_async_continue - Continues retrieving/sending a file asyncronously + Continues retrieving/sending a file asynchronously Description @@ -12,7 +12,7 @@ resourceftp_stream - Continues retrieving/sending a file asyncronously + Continues retrieving/sending a file asynchronously Returns FTP_FAILED or FTP_FINISHED diff --git a/reference/ftp/functions/ftp-async-fget.xml b/reference/ftp/functions/ftp-async-fget.xml index ab8f0519f0..4854ac0842 100644 --- a/reference/ftp/functions/ftp-async-fget.xml +++ b/reference/ftp/functions/ftp-async-fget.xml @@ -1,9 +1,9 @@ - + ftp_async_fget - Retrieves a file from the FTP server asynchronly and writes it to an open file + Retrieves a file from the FTP server asynchronously and writes it to an open file Description @@ -20,13 +20,13 @@ from the FTP server, and writes it to the given file pointer, fp. The transfer mode specified must be either FTP_ASCII or - FTP_BINARY. The difference between + FTP_BINARY. The difference between this function and the ftp_fget 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. - Returns &true; on success, &false; on error. + Returns &true; on success or &false; on error. See also ftp_async_get. diff --git a/reference/ftp/functions/ftp-async-fput.xml b/reference/ftp/functions/ftp-async-fput.xml index 5d5031c341..78b1558778 100644 --- a/reference/ftp/functions/ftp-async-fput.xml +++ b/reference/ftp/functions/ftp-async-fput.xml @@ -1,9 +1,9 @@ - + ftp_async_fput - Stores a file from an open file to the FTP server asyncronly + Stores a file from an open file to the FTP server asynchronously Description @@ -17,16 +17,16 @@ ftp_async_fput uploads the data from the file pointer - fp until end of file. The results are stored + fp until it reaches the end of the file. The results are stored in remote_file on the FTP server. The transfer mode specified must be either FTP_ASCII or FTP_BINARY. - The difference between ftp_fput 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 ftp_fput is that this + function uploads the file asynchronously, so your program can perform other operations while the + file is being downloaded. - Returns &true; on success, &false; on error. + Returns &true; on success or &false; on error. See also ftp_async_put, diff --git a/reference/ftp/functions/ftp-async-get.xml b/reference/ftp/functions/ftp-async-get.xml index 340ee97dbf..e5d29816df 100644 --- a/reference/ftp/functions/ftp-async-get.xml +++ b/reference/ftp/functions/ftp-async-get.xml @@ -1,9 +1,9 @@ - + ftp_async_get - Retrieves a file from the FTP server asynchronly and writes it to a local file + Retrieves a file from the FTP server asynchronously and writes it to a local file Description @@ -20,13 +20,13 @@ from the FTP server, and saves it to local_file locally. The transfer mode specified must be either FTP_ASCII or - FTP_BINARY. The difference between + FTP_BINARY. The difference between this function and the ftp_get 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. - Returns &true; on success, &false; on error. + Returns &true; on success or &false; on error. @@ -101,7 +101,7 @@ while ($ret == FTP_MOREDATA) { In the example above, "newfile" is 100 bytes smaller than "README" on the FTP server because we started reading at offset 100. If we have - not have disabled FTP_AUTOSEEK the first + not have disabled FTP_AUTOSEEK, the first 100 bytes of newfile will be '\0'. diff --git a/reference/ftp/functions/ftp-async-put.xml b/reference/ftp/functions/ftp-async-put.xml index ea642d5167..9559041946 100644 --- a/reference/ftp/functions/ftp-async-put.xml +++ b/reference/ftp/functions/ftp-async-put.xml @@ -1,9 +1,9 @@ - + ftp_async_put - Stores a file on the FTP server asynchronly + Stores a file on the FTP server asynchronously Description @@ -20,12 +20,12 @@ on the FTP server, as remote_file. The transfer mode specified must be either FTP_ASCII or FTP_BINARY. - The difference between ftp_put 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 ftp_put is that this + function uploads the file asynchronously, so your program can perform other operations while the + file is being downloaded. - Returns &true; on success, &false; on error. + Returns &true; on success or &false; on error. diff --git a/reference/ftp/functions/ftp-cdup.xml b/reference/ftp/functions/ftp-cdup.xml index 3c910876bd..9b953c7034 100644 --- a/reference/ftp/functions/ftp-cdup.xml +++ b/reference/ftp/functions/ftp-cdup.xml @@ -1,6 +1,6 @@ - - + + ftp_cdup @@ -16,7 +16,7 @@ Changes to the parent directory. - Returns &true; on success, &false; on error. + Returns &true; on success or &false; on error. diff --git a/reference/ftp/functions/ftp-chdir.xml b/reference/ftp/functions/ftp-chdir.xml index c4ae27f971..235596088a 100644 --- a/reference/ftp/functions/ftp-chdir.xml +++ b/reference/ftp/functions/ftp-chdir.xml @@ -1,5 +1,5 @@ - + @@ -17,7 +17,7 @@ Changes to the specified directory. - Returns &true; on success, &false; on error. + Returns &true; on success or &false; on error. diff --git a/reference/ftp/functions/ftp-close.xml b/reference/ftp/functions/ftp-close.xml index 1795c95f1b..c0315b7543 100644 --- a/reference/ftp/functions/ftp-close.xml +++ b/reference/ftp/functions/ftp-close.xml @@ -1,5 +1,5 @@ - + @@ -19,7 +19,7 @@ ftp_close closes ftp_stream - 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 ftp_connect. diff --git a/reference/ftp/functions/ftp-connect.xml b/reference/ftp/functions/ftp-connect.xml index 32f4eb374d..8b95593ae5 100644 --- a/reference/ftp/functions/ftp-connect.xml +++ b/reference/ftp/functions/ftp-connect.xml @@ -1,10 +1,10 @@ - + ftp_connect - Opens up an FTP connection + Opens an FTP connection Description @@ -15,23 +15,23 @@ inttimeout - Returns a FTP stream on success, &false; on error. + Returns a FTP stream on success or &false; on error. - ftp_connect opens up a FTP connection to the + ftp_connect opens an FTP connection to the specified host. The port 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. The timeout 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 ftp_set_option and ftp_get_option. - This parameter is available since 4.2.0 . + This parameter is available beginning with PHP 4.2.0. diff --git a/reference/ftp/functions/ftp-delete.xml b/reference/ftp/functions/ftp-delete.xml index d7012eabd9..e580b9c955 100644 --- a/reference/ftp/functions/ftp-delete.xml +++ b/reference/ftp/functions/ftp-delete.xml @@ -1,5 +1,5 @@ - + @@ -18,7 +18,7 @@ path from the FTP server. - Returns &true; on success, &false; on error. + Returns &true; on success or &false; on error. diff --git a/reference/ftp/functions/ftp-exec.xml b/reference/ftp/functions/ftp-exec.xml index 4105c6ae67..967f87cd39 100644 --- a/reference/ftp/functions/ftp-exec.xml +++ b/reference/ftp/functions/ftp-exec.xml @@ -1,10 +1,10 @@ - + ftp_exec - Request execution of a program on the FTP server + Requests execution of a program on the FTP server Description @@ -15,8 +15,7 @@ Sends a SITE EXEC command 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;. diff --git a/reference/ftp/functions/ftp-fget.xml b/reference/ftp/functions/ftp-fget.xml index 4cd68244be..b7c2a13caf 100644 --- a/reference/ftp/functions/ftp-fget.xml +++ b/reference/ftp/functions/ftp-fget.xml @@ -1,5 +1,5 @@ - + @@ -29,7 +29,7 @@ - Returns &true; on success, &false; on error. + Returns &true; on success or &false; on error. See also ftp_get. diff --git a/reference/ftp/functions/ftp-fput.xml b/reference/ftp/functions/ftp-fput.xml index eb635f278c..2b8646b29c 100644 --- a/reference/ftp/functions/ftp-fput.xml +++ b/reference/ftp/functions/ftp-fput.xml @@ -1,5 +1,5 @@ - + @@ -18,7 +18,7 @@ ftp_fput uploads the data from the file pointer - fp until end of file. The results are stored + fp until the end of the file is reached. The results are stored in remote_file on the FTP server. The transfer mode specified must be either FTP_ASCII or FTP_BINARY. @@ -29,7 +29,7 @@ - Returns &true; on success, &false; on error. + Returns &true; on success or &false; on error. diff --git a/reference/ftp/functions/ftp-get-option.xml b/reference/ftp/functions/ftp-get-option.xml index f212955228..84342aa7dc 100644 --- a/reference/ftp/functions/ftp-get-option.xml +++ b/reference/ftp/functions/ftp-get-option.xml @@ -1,5 +1,5 @@ - + @@ -19,7 +19,7 @@ - Returns the value on success, or &false; if the given + Returns the value on success or &false; if the given option is not supported. In the latter case, a warning message is also thrown. diff --git a/reference/ftp/functions/ftp-get.xml b/reference/ftp/functions/ftp-get.xml index 8118e43f85..f51818efd5 100644 --- a/reference/ftp/functions/ftp-get.xml +++ b/reference/ftp/functions/ftp-get.xml @@ -1,5 +1,5 @@ - + @@ -29,7 +29,7 @@ - Returns &true; on success, &false; on error. + Returns &true; on success or &false; on error. See also ftp_fget and ftp_async_get. diff --git a/reference/ftp/functions/ftp-login.xml b/reference/ftp/functions/ftp-login.xml index f15884c0b8..2fb7ceb73d 100644 --- a/reference/ftp/functions/ftp-login.xml +++ b/reference/ftp/functions/ftp-login.xml @@ -1,10 +1,10 @@ - + ftp_login - Logs in an FTP connection + Logs in to an FTP connection Description @@ -15,10 +15,10 @@ stringpassword - Logs in the given FTP stream. + Logs in to the given FTP stream. - Returns &true; on success, &false; on error. + Returns &true; on success or &false; on error. diff --git a/reference/ftp/functions/ftp-mdtm.xml b/reference/ftp/functions/ftp-mdtm.xml index 1764e9c03a..378013241f 100644 --- a/reference/ftp/functions/ftp-mdtm.xml +++ b/reference/ftp/functions/ftp-mdtm.xml @@ -1,5 +1,5 @@ - + @@ -14,14 +14,18 @@ stringremote_file - ftp_mdtm checks the last-modified time for a + ftp_mdtm 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. Returns a UNIX timestamp on success, or -1 on error. + + + Not all servers support this feature! + + ftp_mdtm does not work with directories. diff --git a/reference/ftp/functions/ftp-mkdir.xml b/reference/ftp/functions/ftp-mkdir.xml index c0bbf5dcca..22a133e8f1 100644 --- a/reference/ftp/functions/ftp-mkdir.xml +++ b/reference/ftp/functions/ftp-mkdir.xml @@ -1,5 +1,5 @@ - + @@ -17,7 +17,7 @@ Creates the specified directory. - Returns the newly created directory name on success, &false; on error. + Returns the newly created directory name on success or &false; on error. diff --git a/reference/ftp/functions/ftp-nlist.xml b/reference/ftp/functions/ftp-nlist.xml index 90dd88e9d1..808652c716 100644 --- a/reference/ftp/functions/ftp-nlist.xml +++ b/reference/ftp/functions/ftp-nlist.xml @@ -1,5 +1,5 @@ - + @@ -15,7 +15,7 @@ Returns an array of filenames from the specified directory - on success, &false; on error. + on success or &false; on error. diff --git a/reference/ftp/functions/ftp-pasv.xml b/reference/ftp/functions/ftp-pasv.xml index 2eb352dfeb..35fb546fd1 100644 --- a/reference/ftp/functions/ftp-pasv.xml +++ b/reference/ftp/functions/ftp-pasv.xml @@ -1,5 +1,5 @@ - + @@ -15,13 +15,13 @@ ftp_pasv turns on passive mode if the - pasv parameter is &true; (it turns off - passive mode if pasv is &false;.) In + pasv parameter is &true;. It turns off + passive mode if pasv is &false;. In passive mode, data connections are initiated by the client, rather than by the server. - Returns &true; on success, &false; on error. + Returns &true; on success or &false; on error. diff --git a/reference/ftp/functions/ftp-put.xml b/reference/ftp/functions/ftp-put.xml index 4bb1ec1dab..0830802d4f 100644 --- a/reference/ftp/functions/ftp-put.xml +++ b/reference/ftp/functions/ftp-put.xml @@ -1,5 +1,5 @@ - + @@ -28,7 +28,7 @@ - Returns &true; on success, &false; on error. + Returns &true; on success or &false; on error. diff --git a/reference/ftp/functions/ftp-pwd.xml b/reference/ftp/functions/ftp-pwd.xml index d4c519547b..af94dfad50 100644 --- a/reference/ftp/functions/ftp-pwd.xml +++ b/reference/ftp/functions/ftp-pwd.xml @@ -1,5 +1,5 @@ - + @@ -13,7 +13,7 @@ resourceftp_stream - Returns the current directory, or &false; on error. + Returns the current directory or &false; on error. diff --git a/reference/ftp/functions/ftp-rename.xml b/reference/ftp/functions/ftp-rename.xml index d4268b7fec..68030bbac1 100644 --- a/reference/ftp/functions/ftp-rename.xml +++ b/reference/ftp/functions/ftp-rename.xml @@ -1,5 +1,5 @@ - + @@ -15,13 +15,13 @@ stringto - ftp_rename renames the file or directory + ftp_rename renames the file or directory that is currently named from to the new name - to, on the FTP stream + to, using the FTP stream ftp_stream. - Returns &true; on success, &false; on error. + Returns &true; on success or &false; on error. diff --git a/reference/ftp/functions/ftp-rmdir.xml b/reference/ftp/functions/ftp-rmdir.xml index 206ea2c522..b9e4d52f09 100644 --- a/reference/ftp/functions/ftp-rmdir.xml +++ b/reference/ftp/functions/ftp-rmdir.xml @@ -1,5 +1,5 @@ - + @@ -17,7 +17,7 @@ Removes the specified directory. - Returns &true; on success, &false; on error. + Returns &true; on success or &false; on error. diff --git a/reference/ftp/functions/ftp-set-option.xml b/reference/ftp/functions/ftp-set-option.xml index ebbf4a6269..dd2feb7351 100644 --- a/reference/ftp/functions/ftp-set-option.xml +++ b/reference/ftp/functions/ftp-set-option.xml @@ -1,5 +1,5 @@ - + @@ -37,15 +37,15 @@ FTP_TIMEOUT_SEC Changes the timeout in seconds used for all network related - functions. Parameter value has be to of type - int and must be greater than 0. The default timeout is 90 - seconds. + functions. value must be an integer that is greater than 0. + The default timeout is 90 seconds. FTP_AUTOSEEK - When enabled (which is the default) get/put requests with - a resumepos/startpos - parameter will first seek to the wanted position within the stream. + When enabled, GET or PUT requests with + a resumepos or startpos + parameter will first seek to the requested position within the file. This is enabled + by default. @@ -57,7 +57,7 @@ <function>ftp_set_option</function> example diff --git a/reference/ftp/functions/ftp-site.xml b/reference/ftp/functions/ftp-site.xml index 3eb5a0da80..4af0bb4bf0 100644 --- a/reference/ftp/functions/ftp-site.xml +++ b/reference/ftp/functions/ftp-site.xml @@ -1,5 +1,5 @@ - + @@ -21,7 +21,7 @@ membership. - Returns &true; on success, &false; on error. + Returns &true; on success or &false; on error. diff --git a/reference/ftp/reference.xml b/reference/ftp/reference.xml index aae3c3656a..ad9fd93ebc 100644 --- a/reference/ftp/reference.xml +++ b/reference/ftp/reference.xml @@ -1,5 +1,5 @@ - + FTP functions FTP @@ -25,7 +25,7 @@ In order to use FTP functions with your PHP configuration, you should add the option when - installing PHP 4, and + installing PHP 4 or when using PHP 3.
@@ -38,8 +38,8 @@
&reftitle.resources; - 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.