opts: added some DEFAULT and RETURN VALUE sections
authorDan Fandrich <dan@coneharvesters.com>
Mon, 23 Jun 2014 22:00:34 +0000 (00:00 +0200)
committerDan Fandrich <dan@coneharvesters.com>
Mon, 23 Jun 2014 22:00:34 +0000 (00:00 +0200)
docs/libcurl/opts/CURLOPT_HEADER.3
docs/libcurl/opts/CURLOPT_NOPROGRESS.3
docs/libcurl/opts/CURLOPT_NOSIGNAL.3
docs/libcurl/opts/CURLOPT_VERBOSE.3
docs/libcurl/opts/CURLOPT_WILDCARDMATCH.3

index aa1afc4..130575a 100644 (file)
@@ -31,7 +31,6 @@ CURLcode curl_easy_setopt(CURL *handle, CURLOPT_HEADER, long onoff);
 Pass in \fIonoff\fP set to 1 to tell the library to include the header in the
 body output for requests with this \fIhandle\fP. This option is relevant for
 protocols that actually have headers or other meta-data (like HTTP and FTP).
-The default value for this option is 0.
 
 When asking to get the header info passed to the same callback as the body, it
 is not possible to accurately separate them again without detailed knowledge
@@ -39,5 +38,9 @@ about the protocol in use.
 
 It is often better to use \fICURLOPT_HEADERFUNCTION(3)\fP to get the header
 data separately.
+.SH DEFAULT
+0
+.SH RETURN VALUE
+Returns CURLE_OK.
 .SH "SEE ALSO"
 .BR CURLOPT_HEADERFUNCTION "(3), "
index bcb3974..ebdecb0 100644 (file)
@@ -30,10 +30,13 @@ CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NOPROGRESS, long onoff);
 .SH DESCRIPTION
 If \fIonoff\fP is to 1, it tells the library to shut off the progress meter
 completely for requests done with this \fIhandle\fP. It will also prevent the
-\fICURLOPT_PROGRESSFUNCTION(3)\fP from getting called. The default value for
-this parameter is 1, meaning it normally runs without a progress meter.
+\fICURLOPT_PROGRESSFUNCTION(3)\fP from getting called.
 
 Future versions of libcurl are likely to not have any built-in progress meter
 at all.
+.SH DEFAULT
+1, meaning it normally runs without a progress meter.
+.SH RETURN VALUE
+Returns CURLE_OK.
 .SH "SEE ALSO"
 .BR CURLOPT_PROGRESSFUNCTION "(3), "
index 21969e3..27fe158 100644 (file)
@@ -31,8 +31,7 @@ CURLcode curl_easy_setopt(CURL *handle, CURLOPT_NOSIGNAL, long onoff);
 If \fIonoff\fP is 1, libcurl will not use any functions that install signal
 handlers or any functions that cause signals to be sent to the process. This
 option is here to allow multi-threaded unix applications to still set/use all
-timeout options etc, without risking getting signals.  The default value for
-this parameter is 0.
+timeout options etc, without risking getting signals.
 
 If this option is set and libcurl has been built with the standard name
 resolver, timeouts will not occur while the name resolve takes place.
@@ -48,5 +47,9 @@ have no way to avoid them and even on those that have there are some corner
 cases when they may still happen, contrary to our desire. In addition, using
 \fICURLAUTH_NTLM_WB\fP authentication could cause a SIGCHLD signal to be
 raised.
+.SH DEFAULT
+0
 .SH AVAILABILITY
 Added in 7.10
+.SH RETURN VALUE
+Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
index b62c7b7..53e29f9 100644 (file)
@@ -31,13 +31,16 @@ CURLcode curl_easy_setopt(CURL *handle, CURLOPT_VERBOSE, long onoff);
 Set the \fIonoff\fP parameter to 1 to make the library display a lot of
 verbose information about its operations on this \fIhandle\fP. Very useful for
 libcurl and/or protocol debugging and understanding. The verbose information
-will be sent to stderr, or the stream set with \fICURLOPT_STDERR(3)\fP. The
-default value for this parameter is 0, meaning disabled.
+will be sent to stderr, or the stream set with \fICURLOPT_STDERR(3)\fP.
 
 You hardly ever want this set in production use, you will almost always want
 this when you debug/report problems.
 
 To also get all the protocol data sent and received, consider using the
 \fICURLOPT_DEBUGFUNCTION(3)\fP.
+.SH DEFAULT
+0, meaning disabled.
+.SH RETURN VALUE
+Returns CURLE_OK.
 .SH "SEE ALSO"
 .BR CURLOPT_STDERR "(3), " CURLOPT_DEBUGFUNCTION "(3), "
index cb47fd1..b567045 100644 (file)
@@ -81,5 +81,7 @@ This feature is only supported for FTP download.
 See http://curl.haxx.se/libcurl/c/ftp-wildcard.html
 .SH AVAILABILITY
 Added in 7.21.0
+.SH RETURN VALUE
+Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
 .SH "SEE ALSO"
 .BR CURLOPT_FNMATCH_FUNCTION "(3), " CURLOPT_URL "(3), "