cleanup on language, content and facts

docs/curl_easy_setopt.3

@@ -2,83 +2,83 @@
 .\" nroff -man [file]
 .\" $Id$
 .\"
-.TH curl_easy_setopt 3 "12 Sep 2001" "libcurl 7.9" "libcurl Manual"
+.TH curl_easy_setopt 3 "11 Oct 2001" "libcurl 7.9.1" "libcurl Manual"
 .SH NAME
 curl_easy_setopt - Set curl easy-session options
 .SH SYNOPSIS
-.B #include <curl/curl.h>
+#include <curl/curl.h>
-.sp
+
-.BI "CURLcode curl_easy_setopt(CURL *" handle ", CURLoption "option ", ...);"
+CURLcode curl_easy_setopt(CURL *handle, CURLoption option, parameter);
 .ad
 .SH DESCRIPTION
-curl_easy_setopt() is called to tell libcurl how to behave in a number of
+curl_easy_setopt() is used to tell libcurl how to behave. Most operations in
-ways. Most operations in libcurl have default actions, and by using the
+libcurl have default actions, and by using the appropriate options to
-appropriate options you can make them behave differently (as documented).  All
+\fIcurl_easy_setopt\fP, you can change them.  All options are set with the
-options are set with the
+\fIoption\fP followed by a \fIparameter\fP. That parameter can be a long, a
-.I option
+function pointer or an object pointer, all depending on what the specific
-followed by a parameter. That parameter can be a long, a function pointer or
+option expects. Read this manual carefully as bad input values may cause
-an object pointer, all depending on what the option in question expects. Read
+libcurl to behave badly!  You can only set one option in each function call. A
-this manual carefully as bad input values may cause libcurl to behave badly!
+typical application uses many curl_easy_setopt() calls in the setup phase.
-You can only set one option in each function call. A typical application uses
-many curl_easy_setopt() calls in the setup phase.
 
-NOTE: strings passed to libcurl as 'char *' arguments, will not be copied by
+\fBNOTE:\fP strings passed to libcurl as 'char *' arguments, will not be
-the library. Instead you should keep them available until libcurl no longer
+copied by the library. Instead you should keep them available until libcurl no
-needs them. Failing to do so will cause very odd behaviour or even crashes.
+longer needs them. Failing to do so will cause very odd behavior or even
+crashes.
 
-More note: the options set with this function call are valid for the
+\fBNOTE2:\fP options set with this function call are valid for the forthcoming
-forthcoming data transfers that are performed when you invoke
+data transfers that are performed when you invoke \fIcurl_easy_perform\fP.
-.I curl_easy_perform .
 The options are not in any way reset between transfers, so if you want
 subsequent transfers with different options, you must change them between the
 transfers.
 
-The
+The \fIhandle\fP is the return code from a \fIcurl_easy_init(3)\fP or
-.I "handle"
+\fIcurl_easy_duphandle(3)\fP call.
-is the return code from the
-.I "curl_easy_init"
-call.
 .SH OPTIONS
-These options are in a bit of random order, but you'll figure it out!
+The options are listed in a sort of random order, but you'll figure it out!
 .TP 0.8i
 .B CURLOPT_FILE
-Data pointer to pass to file write function. Note that if you specify the
+Data pointer to pass to the file write function. Note that if you specify the
-.I CURLOPT_WRITEFUNCTION
+\fICURLOPT_WRITEFUNCTION\fP, this is the pointer you'll get as input. If you
-, this is the pointer you'll get as input. If you don't use a callback, you
+don't use a callback, you must pass a 'FILE *' as libcurl will pass this to
-must pass a 'FILE *' as libcurl passes it to fwrite() when writing data.
+fwrite() when writing data.
 
-NOTE: If you're using libcurl as a win32 DLL, you MUST use the
+\fBNOTE:\fP If you're using libcurl as a win32 DLL, you MUST use the
-\fICURLOPT_WRITEFUNCTION\fP if you set this option.
+\fICURLOPT_WRITEFUNCTION\fP if you set this option or you will experience
+crashes.
 .TP
 .B 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 received data that needs
+function gets called by libcurl as soon as there is data available to pass
-to be written down. The size of the data pointed to by \fIptr\fP is \fIsize\fP
+available that needs to be saved. The size of the data pointed to by \fIptr\fP
-multiplied with \fInmemb\fP.  Return the number of bytes actually written or
+is \fIsize\fP multiplied with \fInmemb\fP.  Return the number of bytes
-return -1 to signal error to the library (it will cause it to abort the
+actually written or return -1 to signal error to the library (it will cause it
-transfer with CURLE_WRITE_ERROR).
+to abort the transfer with \fICURLE_WRITE_ERROR\fP).
 
 Set the \fIstream\fP argument with the \fBCURLOPT_FILE\fP option.
+
+\fBNOTE:\fP you will be passed as much data as possible in all invokes, but
+you cannot possibly make any assumptions. It may be one byte, it may be
+thousands.
 .TP
 .B CURLOPT_INFILE
 Data pointer to pass to the file read function. Note that if you specify the
 \fICURLOPT_READFUNCTION\fP, this is the pointer you'll get as input. If you
 don't specify a read callback, this must be a valid FILE *.
 
-NOTE: If you're using libcurl as a win32 DLL, you MUST use a
+\fBNOTE:\fP If you're using libcurl as a win32 DLL, you MUST use a
 \fICURLOPT_READFUNCTION\fP if you set this option.
 .TP
 .B CURLOPT_READFUNCTION
-Function pointer that should match the following prototype:
+Function pointer that should match the following prototype: \fBsize_t
-.BI "size_t function( void *ptr, size_t size, size_t nmemb, void *stream);"
+function( void *ptr, size_t size, size_t nmemb, void *stream);\fP This
-This function gets called by libcurl as soon as it needs to read data in order
+function gets called by libcurl as soon as it needs to read data in order to
-to send it to the peer. The data area pointed at by the pointer \fIptr\fP may
+send it to the peer. The data area pointed at by the pointer \fIptr\fP may be
-be filled with at most \fIsize\fP multiplied with \fInmemb\fP number of
+filled with at most \fIsize\fP multiplied with \fInmemb\fP number of
 bytes. Your function must return the actual number of bytes that you stored in
 that memory area. Returning -1 will signal an error to the library and cause
-it to abort the current transfer immediately (with a CURLE_READ_ERROR return
+it to abort the current transfer immediately (with a \fICURLE_READ_ERROR\fP
-code).
+return code).
 .TP
 .B CURLOPT_INFILESIZE
 When uploading a file to a remote site, this option should be used to tell
@@ -87,49 +87,67 @@ libcurl what the expected size of the infile is.
 .B CURLOPT_URL
 The actual URL to deal with. The parameter should be a char * to a zero
 terminated string. The string must remain present until curl no longer needs
-it, as it doesn't copy the string. NOTE: this option is required to be set
+it, as it doesn't copy the string.
-before curl_easy_perform() is called.
+
+\fBNOTE:\fP this option is (the only one) required to be set before
+\fIcurl_easy_perform(3)\fP is called.
 .TP
 .B CURLOPT_PROXY
-If you need libcurl to use a http proxy to access the outside world, set the
+Set HTTP proxy to use. The parameter should be a char * to a zero terminated
-proxy string with this option. The parameter should be a char * to a zero
+string holding the host name or dotted IP address. To specify port number in
-terminated string. To specify port number in this string, append :[port] to
+this string, append :[port] to the end of the host name. The proxy string may
-the end of the host name. The proxy string may be prefixed with
+be prefixed with [protocol]:// since any such prefix will be ignored. The
-[protocol]:// since any such prefix will be ignored.
+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
+etc. This may have an impact on what other features of the library you can
+use, such as CURLOPT_QUOTE and similar FTP specifics that don't work unless
+you tunnel through the HTTP proxy. Such tunneling is activated with
+\fICURLOPT_HTTPPROXYTUNNEL\fP.
+
+\fBNOTE2:\fP libcurl respects the environment variables \fBhttp_proxy\fP,
+\fBftp_proxy\fP, \fBall_proxy\fP etc, if any of those is set.
 .TP
 .B CURLOPT_PROXYPORT
-Set this long with this option to set the proxy port to use unless it is
+Pass a long with this option to set the proxy port to connect to unless it is
-specified in the proxy string CURLOPT_PROXY.
+specified in the proxy string \fICURLOPT_PROXY\fP.
 .TP
 .B CURLOPT_HTTPPROXYTUNNEL
-Set the parameter to non-zero to get the library to tunnel all non-HTTP
+Set the parameter to non-zero to get the library to tunnel all operations
-operations through the given HTTP proxy. Do note that there is a big
+through a given HTTP proxy. Note that there is a big difference between using
-difference to use a proxy and to tunnel through it. If you don't know what
+a proxy and to tunnel through it. If you don't know what this means, you
-this means, you probably don't want this tunnel option. (Added in libcurl 7.3)
+probably don't want this tunneling option. (Added in libcurl 7.3)
 .TP
 .B CURLOPT_VERBOSE
 Set the parameter to non-zero to get the library to display a lot of verbose
-information about its operations. Very useful for libcurl and/or protocl
+information about its operations. Very useful for libcurl and/or protocol
 debugging and understanding.
+
+You hardly ever want this set in production use, you will almost always want
+this when you debug/report problems.
 .TP
 .B CURLOPT_HEADER
-A non-zero parameter tells the library to include the header in the
+A non-zero parameter tells the library to include the header in the body
-output. This is only relevant for protocols that actually has a header
+output. This is only relevant for protocols that actually have headers
-preceeding the data (like HTTP).
+preceding the data (like HTTP).
 .TP
 .B CURLOPT_NOPROGRESS
 A non-zero parameter tells the library to shut of the built-in progress meter
-completely. (NOTE: future versions of the lib is likely to not have any
+completely.
-built-in progress meter at all).
+
+\fBNOTE:\fP future versions of libcurl is likely to not have any built-in
+progress meter at all.
 .TP
 .B CURLOPT_NOBODY
 A non-zero parameter tells the library to not include the body-part in the
-output. This is only relevant for protocols that have a separate header and
+output. This is only relevant for protocols that have separate header and body
-body part.
+parts.
 .TP
 .B CURLOPT_FAILONERROR
 A non-zero parameter tells the library to fail silently if the HTTP code
-returned is equal or larger than 300. The default action would be to return
+returned is equal to or larger than 300. The default action would be to return
 the page normally, ignoring that code.
 .TP
 .B CURLOPT_UPLOAD
@@ -146,7 +164,7 @@ will imply this option.
 .TP
 .B CURLOPT_FTPLISTONLY
 A non-zero parameter tells the library to just list the names of an ftp
-directory, instead of doing a full directory listin that would include file
+directory, instead of doing a full directory listing that would include file
 sizes, dates etc.
 .TP
 .B CURLOPT_FTPAPPEND
@@ -154,91 +172,108 @@ 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.
 .TP
 .B CURLOPT_NETRC
-A non-zero parameter tells the library to scan your
+A non-zero parameter tells the library to scan your \fI~/.netrc\fP file to
-.I ~/.netrc
+find user name and password for the remote site you are about to access. Only
-file to find user name and password for the remote site you are about to
+machine name, user name and password is taken into account (init macros and
-access. Do note that curl does not verify that the file has the correct
+similar things aren't supported).
-properties set (as the standard unix ftp client does), and that only machine
+
-name, user name and password is taken into account (init macros and similar
+\fBNote:\fP libcurl does not verify that the file has the correct properties
-things aren't supported).
+set (as the standard Unix ftp client does). It should only be readable by
+user.
 .TP
 .B CURLOPT_FOLLOWLOCATION
 A non-zero parameter tells the library to follow any Location: header that the
-server sends as part of a HTTP header. NOTE that this means that the library
+server sends as part of a HTTP header.
-will resend the same request on the new location and follow new Location:
+
-headers all the way until no more such headers are returned.
+\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
+headers are returned. \fICURLOPT_MAXREDIRS\fP can be used to limit the number
+of redirects libcurl will follow.
 .TP
 .B CURLOPT_TRANSFERTEXT
 A non-zero parameter tells the library to use ASCII mode for ftp transfers,
 instead of the default binary transfer. For LDAP transfers it gets the data in
 plain text instead of HTML and for win32 systems it does not set the stdout to
-binary mode. This option can be useable when transfering text data between
+binary mode. This option can be usable when transferring text data between
-system with different views on certain characters, such as newlines or
+systems with different views on certain characters, such as newlines or
 similar.
 .TP
 .B CURLOPT_PUT
-A non-zero parameter tells the library to use HTTP PUT a file. The file to put
+A non-zero parameter tells the library to use HTTP PUT to transfer data. The
-must be set with CURLOPT_INFILE and CURLOPT_INFILESIZE.
+data should be set with CURLOPT_INFILE and CURLOPT_INFILESIZE.
 .TP
 .B CURLOPT_USERPWD
-Pass a char * as parameter, which should be [username]:[password] to use for
+Pass a char * as parameter, which should be [user name]:[password] to use for
 the connection. If the password is left out, you will be prompted for it.
+\fICURLOPT_PASSWDFUNCTION\fP can be used to set your own prompt function.
 .TP
 .B CURLOPT_PROXYUSERPWD
-Pass a char * as parameter, which should be [username]:[password] to use for
+Pass a char * as parameter, which should be [user name]:[password] to use for
 the connection to the HTTP proxy. If the password is left out, you will be
-prompted for it.
+prompted for it. \fICURLOPT_PASSWDFUNCTION\fP can be used to set your own
+prompt function.
 .TP
 .B CURLOPT_RANGE
 Pass a char * as parameter, which should contain the specified range you
 want. It should be in the format "X-Y", where X or Y may be left out. HTTP
 transfers also support several intervals, separated with commas as in
-.I "X-Y,N-M"
+\fI"X-Y,N-M"\fP. Using this kind of multiple intervals will cause the HTTP
-. Using this kind of multiple intervals will cause the HTTP server to send the
+server to send the response document in pieces (using standard MIME separation
-response document in pieces.
+techniques).
 .TP
 .B CURLOPT_ERRORBUFFER
 Pass a char * to a buffer that the libcurl may store human readable error
 messages in. This may be more helpful than just the return code from the
 library. The buffer must be at least CURL_ERROR_SIZE big.
+
+\fBNote:\fP if the library does not return an error, the buffer may not have
+been touched. Do not rely on the contents in those cases.
 .TP
 .B CURLOPT_TIMEOUT
 Pass a long as parameter containing the maximum time in seconds that you allow
 the libcurl transfer operation to take. Normally, name lookups can take a
 considerable time and limiting operations to less than a few minutes risk
 aborting perfectly normal operations. This option will cause curl to use the
-SIGALRM to enable timeouting system calls.
+SIGALRM to enable time-outing system calls.
-.B NOTE
+
-that this does not work in multi-threaded programs!
+\fBNOTE:\fP this does not work in Unix multi-threaded programs, as it uses
+signals.
 .TP
 .B CURLOPT_POSTFIELDS
 Pass a char * as parameter, which should be the full data to post in a HTTP
-post operation. See also the CURLOPT_POST. Since 7.8, using CURLOPT_POSTFIELDS
+post operation. This is a normal application/x-www-form-urlencoded kind, which
-implies CURLOPT_POST.
+is the most commonly used one by HTML forms. See also the CURLOPT_POST. Since
+7.8, using CURLOPT_POSTFIELDS implies CURLOPT_POST.
+
+\fBNote:\fP to make multipart/formdata posts (aka rfc1867-posts), check out
+the \fICURLOPT_HTTPPOST\fP option.
 .TP
 .B CURLOPT_POSTFIELDSIZE
 If you want to post data to the server without letting libcurl do a strlen()
-to measure the data size, this option must be used. Also, when this option is
+to measure the data size, this option must be used. When this option is used
-used, you can post fully binary data which otherwise is likely to fail. If
+you can post fully binary data, which otherwise is likely to fail. If this
-this size is set to zero, the library will use strlen() to get the data
+size is set to zero, the library will use strlen() to get the size. (Added in
-size. (Added in libcurl 7.2)
+libcurl 7.2)
 .TP
 .B CURLOPT_REFERER
 Pass a pointer to a zero terminated string as parameter. It will be used to
-set the referer: header in the http request sent to the remote server. This
+set the Referer: header in the http request sent to the remote server. This
-can be used to fool servers or scripts.
+can be used to fool servers or scripts. You can also set any custom header
+with \fICURLOPT_HTTPHEADER\fP.
 .TP
 .B CURLOPT_USERAGENT
 Pass a pointer to a zero terminated string as parameter. It will be used to
-set the user-agent: header in the http request sent to the remote server. This
+set the User-Agent: header in the http request sent to the remote server. This
-can be used to fool servers or scripts.
+can be used to fool servers or scripts. You can also set any custom header
+with \fICURLOPT_HTTPHEADER\fP.
 .TP
 .B CURLOPT_FTPPORT
 Pass a pointer to a zero terminated string as parameter. It will be used to
 get the IP address to use for the ftp PORT instruction. The PORT instruction
 tells the remote server to connect to our specified IP address. The string may
-be a plain IP address, a host name, an network interface name (under unix) or
+be a plain IP address, a host name, an network interface name (under Unix) or
-just a '-' letter to let the library use your systems default IP address.
+just a '-' letter to let the library use your systems default IP
+address. Default FTP operations are passive, and thus won't use PORT.
 .TP
 .B CURLOPT_LOW_SPEED_LIMIT
 Pass a long as parameter. It contains the transfer speed in bytes per second
@@ -261,82 +296,71 @@ set a cookie in the http request. The format of the string should be
 .TP
 .B CURLOPT_HTTPHEADER
 Pass a pointer to a linked list of HTTP headers to pass to the server in your
-HTTP request. The linked list should be a fully valid list of 'struct
+HTTP request. The linked list should be a fully valid list of \fBstruct
-curl_slist' structs properly filled in. Use
+curl_slist\fP structs properly filled in. Use \fIcurl_slist_append(3)\fP to
-.I curl_slist_append(3)
+create the list and \fIcurl_slist_free_all(3)\fP to clean up an entire
-to create the list and
+list. If you add a header that is otherwise generated and used by libcurl
-.I curl_slist_free_all(3)
+internally, your added one will be used instead. If you add a header with no
-to clean up an entire list. If you add a header that is otherwise generated
+contents as in 'Accept:' (no data on the right side of the colon), the
-and used by libcurl internally, your added one will be used instead. If you
+internally used header will get disabled. Thus, using this option you can add
-add a header with no contents as in 'Accept:', the internally used header will
+new headers, replace internal headers and remove internal headers.
-just get disabled. Thus, using this option you can add new headers, replace
+
-internal headers and remove internal headers.
+\fBNOTE:\fPThe most commonly replaced headers have "shortcuts" in the options
+CURLOPT_COOKIE, CURLOPT_USERAGENT and CURLOPT_REFERER.
 .TP
 .B CURLOPT_HTTPPOST
 Tells libcurl you want a multipart/formdata HTTP POST to be made and you
 instruct what data to pass on to the server.  Pass a pointer to a linked list
 of HTTP post structs as parameter.  The linked list should be a fully valid
 list of 'struct HttpPost' structs properly filled in. The best and most
-elegant way to do this, is to use
+elegant way to do this, is to use \fIcurl_formadd(3)\fP as documented. The
-.I curl_formadd(3)
+data in this list must remained intact until you close this curl handle again
-as documented. The data in this list must remained intact until you close this
+with \fIcurl_easy_cleanup(3)\fP.
-curl handle again with curl_easy_cleanup().
 .TP
 .B CURLOPT_SSLCERT
 Pass a pointer to a zero terminated string as parameter. The string should be
-the file name of your certficicate in PEM format.
+the file name of your certificate in PEM format.
 .TP
 .B CURLOPT_SSLCERTPASSWD
 Pass a pointer to a zero terminated string as parameter. It will be used as
 the password required to use the CURLOPT_SSLCERT certificate. If the password
-is not supplied, you will be prompted for it.
+is not supplied, you will be prompted for it. \fICURLOPT_PASSWDFUNCTION\fP can
+be used to set your own prompt function.
 .TP
 .B CURLOPT_CRLF
-Convert unix newlines to CRLF newlines on FTP uploads.
+Convert Unix newlines to CRLF newlines on FTP uploads.
 .TP
 .B CURLOPT_QUOTE
 Pass a pointer to a linked list of FTP commands to pass to the server prior to
 your ftp request. The linked list should be a fully valid list of 'struct
-curl_slist' structs properly filled in. Use
+curl_slist' structs properly filled in. Use \fIcurl_slist_append(3)\fP to
-.I curl_slist_append(3)
+append strings (commands) to the list, and clear the entire list afterwards
-to append strings (commands) to the list, and clear the entire list afterwards
+with \fIcurl_slist_free_all(3)\fP.
-with
-.I curl_slist_free_all(3)
 .TP
 .B CURLOPT_POSTQUOTE
 Pass a pointer to a linked list of FTP commands to pass to the server after
 your ftp transfer request. The linked list should be a fully valid list of
 struct curl_slist structs properly filled in as described for
-.I "CURLOPT_QUOTE"
+\fICURLOPT_QUOTE\fP.
 .TP
 .B CURLOPT_WRITEHEADER
 Pass a pointer to be used to write the header part of the received data to. If
-you don't use a callback to take care of the writing, this must be a FILE
+you don't use your own callback to take care of the writing, this must be a
-*. The headers are guaranteed to be written one-by-one and only complete lines
+valid FILE *. See also the \fICURLOPT_HEADERFUNCTION\fP option below on how to set a
-are written. Parsing headers should be easy enough using this. See also the
+custom get-all-headers callback.
-\fICURLOPT_HEADERFUNCTION\fP option.
 .TP
 .B CURLOPT_HEADERFUNCTION
-Function pointer that should match the following prototype:
+Function pointer that should match the following prototype: \fIsize_t
-.BI "size_t function( void *ptr, size_t size, size_t nmemb, void *stream);"
+function( void *ptr, size_t size, size_t nmemb, void *stream);\fP. This
-This function gets called by libcurl as soon as there is received header data
+function gets called by libcurl as soon as there is received header data that
-that needs to be written down. The function will be called once for each
+needs to be written down. The headers are guaranteed to be written one-by-one
-header with a complete header line in each invoke. The size of the data
+and only complete lines are written. Parsing headers should be easy enough
-pointed to by
+using this. The size of the data pointed to by \fIptr\fP is \fIsize\fP
-.I ptr 
+multiplied with \fInmemb\fP.  The pointer named \fIstream\fP will be the one
-is
+you passed to libcurl with the \fICURLOPT_WRITEHEADER\fP option.  Return the
-.I size
+number of bytes actually written or return -1 to signal error to the library
-multiplied with
+(it will cause it to abort the transfer with a \fICURLE_WRITE_ERROR\fP return
-.I nmemb.
+code). (Added in libcurl 7.7.2)
-The pointer named
-.I stream
-will be the one you passed to libcurl with the
-.I CURLOPT_WRITEHEADER
-option.
-Return the number of bytes actually written or return -1 to signal error to
-the library (it will cause it to abort the transfer with a
-.I CURLE_WRITE_ERROR
-return code). (Added in libcurl 7.7.2)
 .TP
 .B CURLOPT_COOKIEFILE
 Pass a pointer to a zero terminated string as parameter. It should contain the
@@ -347,12 +371,12 @@ file.
 .B CURLOPT_SSLVERSION
 Pass a long as parameter. Set what version of SSL to attempt to use, 2 or
 3. By default, the SSL library will try to solve this by itself although some
-servers make this difficult why you at times will have to use this option.
+servers make this difficult why you at times may have to use this option.
 .TP
 .B CURLOPT_TIMECONDITION
 Pass a long as parameter. This defines how the CURLOPT_TIMEVALUE time value is
 treated. You can set this parameter to TIMECOND_IFMODSINCE or
-TIMECOND_IFUNMODSINCE. This is aa HTTP-only feature. (TBD)
+TIMECOND_IFUNMODSINCE. This is a HTTP-only feature. (TBD)
 .TP
 .B CURLOPT_TIMEVALUE
 Pass a long as parameter. This should be the time in seconds since 1 jan 1970,
@@ -362,8 +386,8 @@ isn't used, it will be TIMECOND_IFMODSINCE by default.
 .B CURLOPT_CUSTOMREQUEST
 Pass a pointer to a zero terminated string as parameter. It will be user
 instead of GET or HEAD when doing the HTTP request. This is useful for doing
-DELETE or other more obscure HTTP requests. Don't do this at will, make sure
+DELETE or other more or less obscure HTTP requests. Don't do this at will,
-your server supports the command first.
+make sure your server supports the command first.
 .TP
 .B CURLOPT_STDERR
 Pass a FILE * as parameter. This is the stream to use instead of stderr
@@ -382,21 +406,17 @@ will be used. Set the string to NULL to disable kerberos4. The kerberos
 support only works for FTP. (Added in libcurl 7.3)
 .TP
 .B CURLOPT_PROGRESSFUNCTION
-Function pointer that should match the
+Function pointer that should match the \fIcurl_progress_callback\fP prototype
-.BI curl_progress_callback
+found in \fI<curl/curl.h>\fP. This function gets called by libcurl instead of
-prototype found in
+its internal equivalent with a frequent interval during data transfer.
-.I <curl/curl.h>
+Unknown/unused argument values will be set to zero (like if you only download
-This function gets called by libcurl instead of its internal
+data, the upload size will remain 0). Returning a non-zero value from this
-equivalent. Unknown/unused argument values will be set to zero (like if you
+callback will cause libcurl to abort the transfer and return
-only download data, the upload size will remain 0). Returning a non-zero value
+\fICURLE_ABORTED_BY_CALLBACK\fP.
-from this callback will cause libcurl to abort the transfer and return
-CURLE_ABORTED_BY_CALLBACK.
 .TP
 .B CURLOPT_PROGRESSDATA
 Pass a pointer that will be untouched by libcurl and passed as the first
-argument in the progress callback set with
+argument in the progress callback set with \fICURLOPT_PROGRESSFUNCTION\fP.
-.I CURLOPT_PROGRESSFUNCTION
- .
 .TP
 .B CURLOPT_SSL_VERIFYPEER
 Pass a long that is set to a non-zero value to make curl verify the peer's
@@ -409,67 +429,66 @@ verify the peer with. This only makes sense when used in combination with the
 CURLOPT_SSL_VERIFYPEER option. (Added in 7.4.2)
 .TP
 .B CURLOPT_PASSWDFUNCTION
-Pass a pointer to a curl_passwd_callback function that will then be called
+Pass a pointer to a \fIcurl_passwd_callback\fP function that will be called
 instead of the internal one if libcurl requests a password. The function must
-match this prototype:
+match this prototype: \fBint my_getpass(void *client, char *prompt, char*
-.BI "int my_getpass(void *client, char *prompt, char* buffer, int buflen );"
+buffer, int buflen );\fP.  If set to NULL, it equals to making the function
-If set to NULL, it equals to making the function always fail. If the function
+always fail. If the function returns a non-zero value, it will abort the
-returns a non-zero value, it will abort the operation and an error
+operation and an error (CURLE_BAD_PASSWORD_ENTERED) will be returned.
-(CURLE_BAD_PASSWORD_ENTERED) will be returned.
+\fIclient\fP is a generic pointer, see \fICURLOPT_PASSWDDATA\fP.  \fIprompt\fP
-.I client
-is a generic pointer, see CURLOPT_PASSWDDATA.
-.I prompt
 is a zero-terminated string that is text that prefixes the input request.
-.I buffer
+\fIbuffer\fP is a pointer to data where the entered password should be stored
-is a pointer to data where the entered password should be stored and
+and \fIbuflen\fP is the maximum number of bytes that may be written in the
-.I buflen
+buffer.  (Added in 7.4.2)
-is the maximum number of bytes that may be written in the buffer.
-(Added in 7.4.2)
 .TP
 .B CURLOPT_PASSWDDATA
 Pass a void * to whatever data you want. The passed pointer will be the first
-argument sent to the specifed CURLOPT_PASSWDFUNCTION function. (Added in
+argument sent to the specifed \fICURLOPT_PASSWDFUNCTION\fP function. (Added in
 7.4.2)
 .TP
 .B CURLOPT_FILETIME
 Pass a long. If it is a non-zero value, libcurl will attempt to get the
 modification date of the remote document in this operation. This requires that
 the remote server sends the time or replies to a time querying command. The
-curl_easy_getinfo() function with the CURLINFO_FILETIME argument can be used
+\fIcurl_easy_getinfo(3)\fP function with the \fICURLINFO_FILETIME\fP argument
-after a transfer to extract the received time (if any). (Added in 7.5)
+can be used after a transfer to extract the received time (if any). (Added in
+7.5)
 .TP
 .B CURLOPT_MAXREDIRS
 Pass a long. The set number will be the redirection limit. If that many
-redirections have been followed, the next redirect will cause an error. This
+redirections have been followed, the next redirect will cause an error
-option only makes sense if the CURLOPT_FOLLOWLOCATION is used at the same
+(\fICURLE_TOO_MANY_REDIRECTS\fP). This option only makes sense if the
-time. (Added in 7.5)
+\fICURLOPT_FOLLOWLOCATION\fP is used at the same time. (Added in 7.5)
 .TP
 .B CURLOPT_MAXCONNECTS
 Pass a long. The set number will be the persistant connection cache size. The
 set amount will be the maximum amount of simultaneous connections that libcurl
 may cache between file transfers. Default is 5, and there isn't much point in
 changing this value unless you are perfectly aware of how this work and
-changes libcurl's behaviour. Note: if you have already performed transfers
+changes libcurl's behaviour.
-with this curl handle, setting a smaller MAXCONNECTS than before may cause
+
-open connections to unnecessarily get closed. (Added in 7.7)
+\fBNOTE:\fP if you already have performed transfers with this curl handle,
+setting a smaller MAXCONNECTS than before may cause open connections to get
+closed unnecessarily. (Added in 7.7)
 .TP
 .B CURLOPT_CLOSEPOLICY
 Pass a long. This option sets what policy libcurl should use when the
 connection cache is filled and one of the open connections has to be closed to
 make room for a new connection. This must be one of the CURLCLOSEPOLICY_*
-defines. Use CURLCLOSEPOLICY_LEAST_RECENTLY_USED to make libcurl close the
+defines. Use \fICURLCLOSEPOLICY_LEAST_RECENTLY_USED\fP to make libcurl close
-connection that was least recently used, that connection is also least likely
+the connection that was least recently used, that connection is also least
-to be capable of re-use. Use CURLCLOSEPOLICY_OLDEST to make libcurl close the
+likely to be capable of re-use. Use \fICURLCLOSEPOLICY_OLDEST\fP to make
-oldest connection, the one that was created first among the ones in the
+libcurl close the oldest connection, the one that was created first among the
-connection cache. The other close policies are not support yet. (Added in 7.7)
+ones in the connection cache. The other close policies are not support
+yet. (Added in 7.7)
 .TP
 .B CURLOPT_FRESH_CONNECT
-Pass a long. Set to non-zero to make the next transfer use a new connection by
+Pass a long. Set to non-zero to make the next transfer use a new (fresh)
-force. If the connection cache is full before this connection, one of the
+connection by force. If the connection cache is full before this connection,
-existinf connections will be closed as according to the set policy. This
+one of the existing connections will be closed as according to the selected or
-option should be used with caution and only if you understand what it
+default policy. This option should be used with caution and only if you
-does. Set to 0 to have libcurl attempt re-use of an existing connection.
+understand what it does. Set this to 0 to have libcurl attempt re-using an
-(Added in 7.7)
+existing connection (default behavior).  (Added in 7.7)
 .TP
 .B CURLOPT_FORBID_REUSE
 Pass a long. Set to non-zero to make the next transfer explicitly close the
@@ -477,7 +496,7 @@ connection when done. Normally, libcurl keep all connections alive when done
 with one transfer in case there comes a succeeding one that can re-use them.
 This option should be used with caution and only if you understand what it
 does. Set to 0 to have libcurl keep the connection open for possibly later
-re-use. (Added in 7.7)
+re-use (default behavior). (Added in 7.7)
 .TP
 .B CURLOPT_RANDOM_FILE
 Pass a char * to a zero terminated file name. The file will be used to read
@@ -493,11 +512,10 @@ Pass a long. It should contain the maximum time in seconds that you allow the
 connection to the server to take.  This only limits the connection phase, once
 it has connected, this option is of no more use. Set to zero to disable
 connection timeout (it will then only timeout on the system's internal
-timeouts). See also the
+timeouts). See also the \fICURLOPT_TIMEOUT\fP option.
-.I CURLOPT_TIMEOUT
+
-option.
+\fBNOTE:\fP this does not work in unix multi-threaded programs, as it uses
-.B NOTE
+signals.
-that this does not work in multi-threaded programs!
 .TP
 .B CURLOPT_HTTPGET
 Pass a long. If the long is non-zero, this forces the HTTP request to get back
@@ -511,8 +529,8 @@ the provided hostname. (Added in 7.8.1)
 .TP
 .B CURLOPT_COOKIEJAR
 Pass a file name as char *, zero terminated. This will make libcurl dump all
-internally known cookies to the specified file when curl_easy_cleanup() is
+internally known cookies to the specified file when \fIcurl_easy_cleanup(3)\fP
-called. If no cookies are known, no file will be created. Specify "-" to
+is called. If no cookies are known, no file will be created. Specify "-" to
 instead have the cookies written to stdout.
 .TP
 .B CURLOPT_SSL_CIPHER_LIST
@@ -524,14 +542,15 @@ 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
 compile OpenSSL.
 
-You'll find all details about cipher lists on this URL:
+You'll find more details about cipher lists on this URL:
-.I http://www.openssl.org/docs/apps/ciphers.html
+\fIhttp://www.openssl.org/docs/apps/ciphers.html\fP
 .PP
 .SH RETURN VALUE
-0 means the option was set properly, non-zero means an error as
+CURLE_OK (zero) means that the option was set properly, non-zero means an
-.I <curl/curl.h>
+error occurred as \fI<curl/curl.h>\fP defines.
-defines
 .SH "SEE ALSO"
 .BR curl_easy_init "(3), " curl_easy_cleanup "(3), "
 .SH BUGS
-Surely there are some, you tell me!
+If you find any bugs, or just have questions, subscribe to one of the mailing
+lists and post. We won't bite.
+