From 4b78b4124eee95c42f05e9c3df9ca798a0318db9 Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Wed, 24 Mar 2004 21:40:45 +0000 Subject: Tor Arntsen's major ispell patch --- docs/libcurl/curl_easy_getinfo.3 | 6 ++--- docs/libcurl/curl_easy_init.3 | 2 +- docs/libcurl/curl_easy_setopt.3 | 45 +++++++++++++++++++------------------ docs/libcurl/curl_formadd.3 | 4 ++-- docs/libcurl/curl_getdate.3 | 2 +- docs/libcurl/curl_mprintf.3 | 2 +- docs/libcurl/curl_multi_info_read.3 | 2 +- docs/libcurl/curl_multi_init.3 | 2 +- docs/libcurl/curl_multi_perform.3 | 4 ++-- docs/libcurl/curl_share_init.3 | 2 +- docs/libcurl/libcurl-easy.3 | 2 +- docs/libcurl/libcurl-errors.3 | 8 +++---- docs/libcurl/libcurl-multi.3 | 4 ++-- docs/libcurl/libcurl.3 | 8 +++---- 14 files changed, 47 insertions(+), 46 deletions(-) (limited to 'docs/libcurl') diff --git a/docs/libcurl/curl_easy_getinfo.3 b/docs/libcurl/curl_easy_getinfo.3 index 49c7211d1..ca1c287d4 100644 --- a/docs/libcurl/curl_easy_getinfo.3 +++ b/docs/libcurl/curl_easy_getinfo.3 @@ -20,7 +20,7 @@ filled in accordingly and can be relied upon only if the function returns CURLE_OK. This function is intended to get used *AFTER* a performed transfer, all results from this function are undefined until the transfer is completed. .SH AVAILABLE INFORMATION -These are informations that can be extracted: +The following information can be extracted: .IP CURLINFO_EFFECTIVE_URL Pass a pointer to a 'char *' to receive the last used effective URL. .IP CURLINFO_RESPONSE_CODE @@ -51,7 +51,7 @@ pre-transfer commands and negotiations that are specific to the particular protocol(s) involved. .IP CURLINFO_STARTTRANSFER_TIME Pass a pointer to a double to receive the time, in seconds, it took from the -start until the first byte is just about to be transfered. This includes +start until the first byte is just about to be transferred. This includes CURLINFO_PRETRANSFER_TIME and also the time the server needs to calculate the result. .IP CURLINFO_REDIRECT_TIME @@ -106,7 +106,7 @@ method(s) available. The meaning of the bits is explained in the CURLOPT_HTTPAUTH option for \fIcurl_easy_setopt(3)\fP. (Added in 7.10.8) .IP CURLINFO_PROXYAUTH_AVAIL Pass a pointer to a long to receive a bitmask indicating the authentication -method(s) available for your proxy athentication. (Added in 7.10.8) +method(s) available for your proxy authentication. (Added in 7.10.8) .SH RETURN VALUE If the operation was successful, CURLE_OK is returned. Otherwise an appropriate error code will be returned. diff --git a/docs/libcurl/curl_easy_init.3 b/docs/libcurl/curl_easy_init.3 index 890a8a85a..13f25cd11 100644 --- a/docs/libcurl/curl_easy_init.3 +++ b/docs/libcurl/curl_easy_init.3 @@ -13,7 +13,7 @@ curl_easy_init - Start a libcurl easy session .SH DESCRIPTION This function must be the first function to call, and it returns a CURL easy handle that you must use as input to other easy-functions. curl_easy_init -intializes curl and this call \fBMUST\fP have a corresponding call to +initializes curl and this call \fBMUST\fP have a corresponding call to \fIcurl_easy_cleanup(3)\fP when the operation is complete. .SH RETURN VALUE diff --git a/docs/libcurl/curl_easy_setopt.3 b/docs/libcurl/curl_easy_setopt.3 index 0e5ab98ee..16bed31a9 100644 --- a/docs/libcurl/curl_easy_setopt.3 +++ b/docs/libcurl/curl_easy_setopt.3 @@ -85,7 +85,7 @@ lookups. It enables nice timeouts for name resolves without signals. .IP CURLOPT_WRITEFUNCTION Function pointer that should match the following prototype: \fBsize_t function( void *ptr, size_t size, size_t nmemb, void *stream);\fP This -function gets called by libcurl as soon as there is data reveiced that needs +function gets called by libcurl as soon as there is data received that needs to be saved. The size of the data pointed to by \fIptr\fP is \fIsize\fP multiplied with \fInmemb\fP, it will not be zero terminated. Return the number of bytes actually taken care of. If that amount differs from the amount passed @@ -165,7 +165,7 @@ Function pointer that should match the following prototype: \fIint curl_debug_callback (CURL *, curl_infotype, char *, size_t, void *);\fP \fICURLOPT_DEBUGFUNCTION\fP replaces the standard debug function used when \fICURLOPT_VERBOSE \fP is in effect. This callback receives debug information, -as specified with the \fBcurl_infotype\fP argument. This funtion must return +as specified with the \fBcurl_infotype\fP argument. This function must return 0. The data pointed to by the char * passed to this function WILL NOT be zero terminated, but will be exactly of the size as told by the size_t argument. @@ -191,7 +191,7 @@ Function pointer that should match the following prototype: \fBCURLcode sslctxfun(CURL *curl, void *sslctx, void *parm);\fP This function gets called by libcurl just before the initialization of an SSL connection after having processed all other SSL related options to give a last chance to an -application to modify the behaviour of openssl's ssl initilaization. The +application to modify the behaviour of openssl's ssl initialization. The \fIsslctx\fP parameter is actually a pointer to an openssl \fISSL_CTX\fP. If an error is returned no attempt to establish a connection is made and the perform operation will return the error code from this callback function. Set @@ -249,8 +249,8 @@ be prefixed with [protocol]:// since any such prefix will be ignored. The proxy's port number may optionally be specified with the separate option \fICURLOPT_PROXYPORT\fP. -\fBNOTE:\fP when you tell the library to use a HTTP proxy, libcurl will -transparently convert operations to HTTP even if you specify a FTP URL +\fBNOTE:\fP when you tell the library to use an HTTP proxy, libcurl will +transparently convert operations to HTTP even if you specify an FTP URL etc. This may have an impact on what other features of the library you can use, such as \fICURLOPT_QUOTE\fP and similar FTP specifics that don't work unless you tunnel through the HTTP proxy. Such tunneling is activated with @@ -282,13 +282,13 @@ libcurl caches this info for 60 seconds. .IP CURLOPT_DNS_USE_GLOBAL_CACHE Pass a long. If the value is non-zero, it tells curl to use a global DNS cache that will survive between easy handle creations and deletions. This is not -thread-safe and this will use a global varible. +thread-safe and this will use a global variable. \fBWARNING:\fP this option is considered obsolete. Stop using it. Switch over to using the share interface instead! See \fICURLOPT_SHARE\fP and \fIcurl_share_init(3)\fP. .IP CURLOPT_BUFFERSIZE -Pass a long specifying your prefered size for the receive buffer in libcurl. +Pass a long specifying your preferred size for the receive buffer in libcurl. The main point of this would be that the write callback gets called more often and with smaller chunks. This is just treated as a request, not an order. You cannot be guaranteed to actually get the given size. (Added in 7.10) @@ -370,7 +370,7 @@ regular old-fashioned Basic method. .IP CURLAUTH_GSSNEGOTIATE HTTP GSS-Negotiate authentication. The GSS-Negotiate (also known as plain "Negotiate") method was designed by Microsoft and is used in their web -aplications. It is primarily meant as a support for Kerberos5 authentication +applications. It is primarily meant as a support for Kerberos5 authentication but may be also used along with another authentication methods. For more information see IETF draft draft-brezak-spnego-http-04.txt. @@ -379,17 +379,17 @@ this to work. .IP CURLAUTH_NTLM HTTP NTLM authentication. A proprietary protocol invented and used by Microsoft. It uses a challenge-response and hash concept similar to Digest, to -prevent the password from being evesdropped. +prevent the password from being eavesdropped. \fBNOTE\fP that you need to build libcurl with SSL support for this option to work. .IP CURLAUTH_ANY This is a convenience macro that sets all bits and thus makes libcurl pick any -it finds suitable. libcurl will automaticly select the one it finds most +it finds suitable. libcurl will automatically select the one it finds most secure. .IP CURLAUTH_ANYSAFE This is a convenience macro that sets all bits except Basic and thus makes -libcurl pick any it finds suitable. libcurl will automaticly select the one it +libcurl pick any it finds suitable. libcurl will automatically select the one it finds most secure. .RE .IP CURLOPT_PROXYAUTH @@ -405,7 +405,7 @@ this writing, only Basic and NTLM work. (Added in 7.10.7) .SH HTTP OPTIONS .IP CURLOPT_AUTOREFERER Pass a non-zero parameter to enable this. When enabled, libcurl will -automaticly set the Referer: field in requests where it follows a Location: +automatically set the Referer: field in requests where it follows a Location: redirect. .IP CURLOPT_ENCODING Sets the contents of the Accept-Encoding: header sent in an HTTP @@ -422,7 +422,7 @@ encoding done by the server is ignored. See the special file lib/README.encoding for details. .IP CURLOPT_FOLLOWLOCATION A non-zero parameter tells the library to follow any Location: header that the -server sends as part of a HTTP header. +server sends as part of an HTTP header. \fBNOTE:\fP this means that the library will re-send the same request on the new location and follow new Location: headers all the way until no more such @@ -447,7 +447,7 @@ one by HTML forms. See the \fICURLOPT_POSTFIELDS\fP option for how to specify the data to post and \fICURLOPT_POSTFIELDSIZE\fP in how to set the data size. Using the \fICURLOPT_POSTFIELDS\fP option implies this option. .IP CURLOPT_POSTFIELDS -Pass a char * as parameter, which should be the full data to post in a HTTP +Pass a char * as parameter, which should be the full data to post in an HTTP post operation. You need to make sure that the data is formatted the way you want the server to receive it. libcurl will not convert or encode it for you. Most web servers will assume this data to be url-encoded. Take note. @@ -529,9 +529,10 @@ set a cookie in the http request. The format of the string should be NAME=CONTENTS, where NAME is the cookie name and CONTENTS is what the cookie should contain. -If you need to set mulitple cookies, you need to set them all using a single -option and thus you need to concat them all in one single string. Set multiple -cookies in one string like this: "name1=content1; name2=content2;" etc. +If you need to set multiple cookies, you need to set them all using a single +option and thus you need to concatenate them all in one single string. Set +multiple cookies in one string like this: "name1=content1; name2=content2;" +etc. Using this option multiple times will only make the latest string override the previously ones. @@ -622,7 +623,7 @@ only files in their response to NLST; they might not include subdirectories and symbolic links. .IP CURLOPT_FTPAPPEND A non-zero parameter tells the library to append to the remote file instead of -overwrite it. This is only useful when uploading to a ftp site. +overwrite it. This is only useful when uploading to an ftp site. .IP CURLOPT_FTP_USE_EPRT Pass a long. If the value is non-zero, it tells curl to use the EPRT (and LPRT) command when doing active FTP downloads (which is enabled by @@ -684,7 +685,7 @@ Pass an curl_off_t as parameter. It contains the offset in number of bytes that you want the transfer to start from. (Added in 7.11.0) .IP CURLOPT_CUSTOMREQUEST Pass a pointer to a zero terminated string as parameter. It will be user -instead of GET or HEAD when doing a HTTP request, or instead of LIST or NLST +instead of GET or HEAD when doing an HTTP request, or instead of LIST or NLST when doing an ftp directory listing. This is useful for doing DELETE or other more or less obscure HTTP requests. Don't do this at will, make sure your server supports the command first. @@ -863,7 +864,7 @@ key. \fBNOTE:\fPIf the crypto device cannot be loaded, \fICURLE_SSL_ENGINE_NOTFOUND\fP is returned. .IP CURLOPT_SSLENGINE_DEFAULT -Sets the actual crypto engine as the default for (asymetric) crypto +Sets the actual crypto engine as the default for (asymmetric) crypto operations. \fBNOTE:\fPIf the crypto device cannot be set, @@ -904,8 +905,8 @@ in the SSL handshake, set 1 to check existence, 2 to ensure that it matches the provided hostname. This is by default set to 2. (default changed in 7.10) .IP CURLOPT_SSL_CIPHER_LIST Pass a char *, pointing to a zero terminated string holding the list of -ciphers to use for the SSL connection. The list must be syntactly correct, it -consists of one or more cipher strings separated by colons. Commas or spaces +ciphers to use for the SSL connection. The list must be syntactically correct, +it consists of one or more cipher strings separated by colons. Commas or spaces are also acceptable separators but colons are normally used, \!, \- and \+ can be used as operators. Valid examples of cipher lists include 'RC4-SHA', \'SHA1+DES\', 'TLSv1' and 'DEFAULT'. The default list is normally set when you diff --git a/docs/libcurl/curl_formadd.3 b/docs/libcurl/curl_formadd.3 index 3cc428019..95671e7f9 100644 --- a/docs/libcurl/curl_formadd.3 +++ b/docs/libcurl/curl_formadd.3 @@ -13,7 +13,7 @@ curl_formadd - add a section to a multipart/formdata HTTP POST .ad .SH DESCRIPTION curl_formadd() is used to append sections when building a multipart/formdata -HTTP POST (sometimes refered to as rfc1867-style posts). Append one section at +HTTP POST (sometimes referred to as rfc1867-style posts). Append one section at a time until you've added all the sections you want included and then you pass the \fIfirstitem\fP pointer as parameter to \fBCURLOPT_HTTPPOST\fP. \fIlastitem\fP is set after each call and on repeated invokes it should be @@ -81,7 +81,7 @@ internally chosen one. .B CURLFORM_FILENAME followed by a pointer to a string to a name, will make libcurl use the given -name in the file upload part, intead of the actual file name given to +name in the file upload part, instead of the actual file name given to \fICURLFORM_FILE\fP. .B BCURLFORM_BUFFER diff --git a/docs/libcurl/curl_getdate.3 b/docs/libcurl/curl_getdate.3 index dd29567b8..6e936cf13 100644 --- a/docs/libcurl/curl_getdate.3 +++ b/docs/libcurl/curl_getdate.3 @@ -36,7 +36,7 @@ This string specifies the time on a given day. Syntax supported includes: .TP .B time zone items Specifies international time zone. There are a few acronyms supported, but in -general you should instead use the specific realtive time compared to +general you should instead use the specific relative time compared to UTC. Supported formats include: -1200, MST, +0100. .TP .B day of the week items diff --git a/docs/libcurl/curl_mprintf.3 b/docs/libcurl/curl_mprintf.3 index 839b22536..68621ff0b 100644 --- a/docs/libcurl/curl_mprintf.3 +++ b/docs/libcurl/curl_mprintf.3 @@ -42,7 +42,7 @@ See this table for notable exceptions. Normal printf() clone. .TP .B curl_mfprintf() -Normal fprinf() clone. +Normal fprintf() clone. .TP .B curl_msprintf() Normal sprintf() clone. diff --git a/docs/libcurl/curl_multi_info_read.3 b/docs/libcurl/curl_multi_info_read.3 index eb8363c0b..26b9e40b3 100644 --- a/docs/libcurl/curl_multi_info_read.3 +++ b/docs/libcurl/curl_multi_info_read.3 @@ -23,7 +23,7 @@ remaining messages after this function was called. The data the returned pointer points to will not survive calling \fIcurl_multi_cleanup(3)\fP. -The 'CURLMsg' struct is very simple and only contain very basic informations. +The 'CURLMsg' struct is very simple and only contain very basic information. If more involved information is wanted, the particular "easy handle" in present in that struct and can thus be used in subsequent regular \fIcurl_easy_getinfo(3)\fP calls (or similar): diff --git a/docs/libcurl/curl_multi_init.3 b/docs/libcurl/curl_multi_init.3 index 40875a81e..59f845b15 100644 --- a/docs/libcurl/curl_multi_init.3 +++ b/docs/libcurl/curl_multi_init.3 @@ -10,7 +10,7 @@ curl_multi_init - create a multi handle .ad .SH DESCRIPTION This function returns a CURLM handle to be used as input to all the other -multi-functions, sometimes refered to as a multi handle on some places in the +multi-functions, sometimes referred to as a multi handle on some places in the documentation. This init call MUST have a corresponding call to \fIcurl_multi_cleanup(3)\fP when the operation is complete. .SH RETURN VALUE diff --git a/docs/libcurl/curl_multi_perform.3 b/docs/libcurl/curl_multi_perform.3 index 51c45aa93..263550df2 100644 --- a/docs/libcurl/curl_multi_perform.3 +++ b/docs/libcurl/curl_multi_perform.3 @@ -19,14 +19,14 @@ integer-pointer. .SH "RETURN VALUE" CURLMcode type, general libcurl multi interface error code. -If you receive \fICURLM_CALL_MULTI_PERFORM\fP, this basicly means that you +If you receive \fICURLM_CALL_MULTI_PERFORM\fP, this basically means that you should call \fIcurl_multi_perform\fP again, before you select() on more actions. You don't have to do it immediately, but the return code means that libcurl may have more data available to return or that there may be more data to send off before it is "satisfied". NOTE that this only returns errors etc regarding the whole multi stack. There -might still have occurred problems on invidual transfers even when this +might still have occurred problems on individual transfers even when this function returns OK. .SH "TYPICAL USAGE" Most application will use \fIcurl_multi_fdset(3)\fP to get the multi_handle's diff --git a/docs/libcurl/curl_share_init.3 b/docs/libcurl/curl_share_init.3 index eb0b23e4e..ead7f4b81 100644 --- a/docs/libcurl/curl_share_init.3 +++ b/docs/libcurl/curl_share_init.3 @@ -10,7 +10,7 @@ curl_share_init - Create a shared object .ad .SH DESCRIPTION This function returns a CURLSH handle to be used as input to all the other -share-functions, sometimes refered to as a share handle on some places in the +share-functions, sometimes referred to as a share handle on some places in the documentation. This init call MUST have a corresponding call to \fIcurl_share_cleanup\fP when all operations using the share are complete. diff --git a/docs/libcurl/libcurl-easy.3 b/docs/libcurl/libcurl-easy.3 index b5689c459..2fe4c82e5 100644 --- a/docs/libcurl/libcurl-easy.3 +++ b/docs/libcurl/libcurl-easy.3 @@ -23,7 +23,7 @@ return until it is done (successfully or not). After the transfer has been made, you can set new options and make another transfer, or if you're done, cleanup the session by calling -\fIcurl_easy_cleanup(3)\fP. If you want persistant connections, you don't +\fIcurl_easy_cleanup(3)\fP. If you want persistent connections, you don't cleanup immediately, but instead run ahead and perform other transfers using the same easy handle. diff --git a/docs/libcurl/libcurl-errors.3 b/docs/libcurl/libcurl-errors.3 index 850198f0c..7f315357a 100644 --- a/docs/libcurl/libcurl-errors.3 +++ b/docs/libcurl/libcurl-errors.3 @@ -36,7 +36,7 @@ Couldn't resolve host. The given remote host was not resolved. .IP "CURLE_COULDNT_CONNECT (7)" Failed to connect() to host or proxy. .IP "CURLE_FTP_WEIRD_SERVER_REPLY (8)" -After connecting to a FTP server, libcurl expects to get a certain reply back. +After connecting to an FTP server, libcurl expects to get a certain reply back. This error code implies that it god a strange or bad reply. The given remote server is probably not an OK FTP server. .IP "CURLE_FTP_ACCESS_DENIED (9)" @@ -93,7 +93,7 @@ There was a problem reading a local file or an error returned by the read callback. .IP "CURLE_OUT_OF_MEMORY (27)" Out of memory. A memory allocation request failed. This is serious badness and -things are severly screwed up if this ever occur. +things are severely screwed up if this ever occur. .IP "CURLE_OPERATION_TIMEOUTED (28)" Operation timeout. The specified time-out period was reached according to the conditions. @@ -106,14 +106,14 @@ specified a good enough address for libcurl to use. See \fICURLOPT_FTPPORT\fP. The FTP REST command returned error. This should never happen if the server is sane. .IP "CURLE_FTP_COULDNT_GET_SIZE (32)" -The FTP SIZE command returned errror. SIZE is not a kosher FTP command, it is +The FTP SIZE command returned error. SIZE is not a kosher FTP command, it is an extension and not all servers support it. This is not a surprising error. .IP "CURLE_HTTP_RANGE_ERROR (33)" The HTTP server does not support or accept range requests. .IP "CURLE_HTTP_POST_ERROR (34)" This is an odd error that mainly occurs due to internal confusion. .IP "CURLE_SSL_CONNECT_ERROR (35)" -A problem occured somewhere in the SSL/TLS handshake. You really want the +A problem occurred somewhere in the SSL/TLS handshake. You really want the error buffer and read the message there as it pinpoints the problem slightly more. Could be certificates (file formats, paths, permissions), passwords, and others. diff --git a/docs/libcurl/libcurl-multi.3 b/docs/libcurl/libcurl-multi.3 index 13b6b84dc..b97ac9856 100644 --- a/docs/libcurl/libcurl-multi.3 +++ b/docs/libcurl/libcurl-multi.3 @@ -71,7 +71,7 @@ timeout every now and then, should you want that. A little note here about the return codes from the multi functions, and especially the \fIcurl_multi_perform(3)\fP: if you receive -\fICURLM_CALL_MULTI_PERFORM\fP, this basicly means that you should call +\fICURLM_CALL_MULTI_PERFORM\fP, this basically means that you should call \fIcurl_multi_perform(3)\fP again, before you select() on more actions. You don't have to do it immediately, but the return code means that libcurl may have more data available to return or that there may be more data to send off @@ -97,4 +97,4 @@ to clean them up properly. If you want to re-use an easy handle that was added to the multi handle for transfer, you must first remove it from the multi stack and then re-add it -again (possbily after having altered some options at your own choice). +again (possibly after having altered some options at your own choice). diff --git a/docs/libcurl/libcurl.3 b/docs/libcurl/libcurl.3 index 54c7d0a54..632bcdf61 100644 --- a/docs/libcurl/libcurl.3 +++ b/docs/libcurl/libcurl.3 @@ -21,8 +21,8 @@ libcurl is complete, it \fBmust\fP call \fIcurl_global_cleanup(3)\fP. In between those two calls, you can use libcurl as described below. To transfer files, you always set up an "easy handle" using -\fIcurl_easy_init(3)\fP, but when you want the file(s) transfered you have the -option of using the "easy" interface, or the "multi" interface. +\fIcurl_easy_init(3)\fP, but when you want the file(s) transferred you have +the option of using the "easy" interface, or the "multi" interface. The easy interface is a synchronous interface with which you call \fIcurl_easy_perform(3)\fP and let it perform the transfer. When it is @@ -30,7 +30,7 @@ completed, the function return and you can continue. More details are found in the \fIlibcurl-easy(3)\fP man page. The multi interface on the other hand is an asynchronous interface, that you -call and that performs only a little piece of the tranfer on each invoke. It +call and that performs only a little piece of the transfer on each invoke. It is perfect if you want to do things while the transfer is in progress, or similar. The multi interface allows you to select() on libcurl action, and even to easily download multiple files simultaneously using a single thread. @@ -56,7 +56,7 @@ portable environment variable reader get information about a performed transfer .TP .B curl_formadd() -helps building a HTTP form POST +helps building an HTTP form POST .TP .B curl_formfree() free a list built with \fIcurl_formadd(3)\fP -- cgit v1.2.3