Skip to content

Commit

Permalink
docs: Add note about libcurl copying strings to CURLOPT_* manpages
Browse files Browse the repository at this point in the history
Closes #1169
  • Loading branch information
gevaerts authored and bagder committed Jan 13, 2017
1 parent d2b2c63 commit dbd3793
Show file tree
Hide file tree
Showing 74 changed files with 222 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_ACCEPT_ENCODING.3
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,9 @@ The Content-Length: servers send for a compressed response is supposed to
indicate the length of the compressed content so when auto decoding is enabled
it may not match the sum of bytes reported by the write callbacks (although,
sending the length of the non-compressed content is a common server mistake).

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_CAINFO.3
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@ option is supported for backward compatibility with other SSL engines, but it
should not be set. If the option is not set, then curl will use the
certificates in the system and user Keychain to verify the peer, which is the
preferred method of verifying the peer's certificate chain.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
Built-in system specific
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_CAPATH.3
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ This makes sense only when used in combination with the

The \fICURLOPT_CAPATH(3)\fP function apparently does not work in Windows due
to some limitation in openssl.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_COOKIE.3
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,9 @@ previous ones.
This option will not enable the cookie engine. Use \fICURLOPT_COOKIEFILE(3)\fP
or \fICURLOPT_COOKIEJAR(3)\fP to enable parsing and sending cookies
automatically.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL, no cookies
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_COOKIEFILE.3
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,9 @@ sub-domains) or use the Netscape format.

If you use this option multiple times, you just add more files to read.
Subsequent files will add more cookies.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_COOKIEJAR.3
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,9 @@ only visible feedback you get about this possibly lethal situation.

Since 7.43.0 cookies that were imported in the Set-Cookie format without a
domain name are not exported by this option.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_CRLFILE.3
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,9 @@ A specific error code (\fICURLE_SSL_CRL_BADFILE\fP) is defined with the
option. It is returned when the SSL exchange fails because the CRL file cannot
be loaded. A failure in certificate verification due to a revocation
information found in the CRL does not trigger this specific error.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_CUSTOMREQUEST.3
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,9 @@ Normally a multiline response is returned which can be used, in conjunction
with \fICURLOPT_MAIL_RCPT(3)\fP, to specify an EXPN request. If the
\fICURLOPT_NOBODY(3)\fP option is specified then the request can be used to
issue NOOP and RSET commands.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_DEFAULT_PROTOCOL.3
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,9 @@ This option does not change the default proxy protocol (http).

Without this option libcurl would make a guess based on the host, see
\fICURLOPT_URL(3)\fP for details.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL (make a guess based on the host)
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_DNS_INTERFACE.3
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ Pass a char * as parameter. Set the name of the network interface that the DNS
resolver should bind to. This must be an interface name (not an address). Set
this option to NULL to use the default setting (don't bind to a specific
interface).

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_DNS_LOCAL_IP4.3
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ Set the local IPv4 \fIaddress\fP that the resolver should bind to. The
argument should be of type char * and contain a single numerical IPv4 address
as a string. Set this option to NULL to use the default setting (don't bind
to a specific IP address).

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_DNS_LOCAL_IP6.3
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ Set the local IPv6 \fIaddress\fP that the resolver should bind to. The
argument should be of type char * and contain a single IPv6 address as a
string. Set this option to NULL to use the default setting (don't bind to a
specific IP address).

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_DNS_SERVERS.3
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ host[:port][,host[:port]]...
For example:

192.168.1.100,192.168.1.101,3.4.5.6

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL - use system default
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_EGDSOCKET.3
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,9 @@ CURLcode curl_easy_setopt(CURL *handle, CURLOPT_EGDSOCKET, char *path);
.SH DESCRIPTION
Pass a char * to the zero terminated path name to the Entropy Gathering Daemon
socket. It will be used to seed the random engine for SSL.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_FTPPORT.3
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,9 @@ Examples with specified ports:

You disable PORT again and go back to using the passive version by setting
this option to NULL.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_FTP_ACCOUNT.3
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ CURLcode curl_easy_setopt(CURL *handle, CURLOPT_FTP_ACCOUNT, char *account);
Pass a pointer to a zero terminated string (or NULL to disable). When an FTP
server asks for "account data" after user name and password has been provided,
this data is sent off using the ACCT command.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_FTP_ALTERNATIVE_TO_USER.3
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ authenticate if the usual FTP "USER user" and "PASS password" negotiation
fails. This is currently only known to be required when connecting to
Tumbleweed's Secure Transport FTPS server using client certificates for
authentication.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_INTERFACE.3
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ synchronously. Using the if! format is highly recommended when using the
multi interfaces to avoid allowing the code to block. If "if!" is specified
but the parameter does not match an existing interface, CURLE_INTERFACE_FAILED
is returned from the libcurl function used to perform the transfer.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL, use whatever the TCP stack finds suitable
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_ISSUERCERT.3
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ A specific error code (CURLE_SSL_ISSUER_ERROR) is defined with the option,
which is returned if the setup of the SSL/TLS session has failed due to a
mismatch with the issuer of peer certificate (\fICURLOPT_SSL_VERIFYPEER(3)\fP
has to be set too for the check to fail). (Added in 7.19.0)

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_KEYPASSWD.3
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ Pass a pointer to a zero terminated string as parameter. It will be used as
the password required to use the \fICURLOPT_SSLKEY(3)\fP or
\fICURLOPT_SSH_PRIVATE_KEYFILE(3)\fP private key. You never needed a pass
phrase to load a certificate but you need one to load your private key.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_KRBLEVEL.3
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ enables kerberos awareness. This is a string that should match one of the
following: \&'clear', \&'safe', \&'confidential' or \&'private'. If the
string is set but doesn't match one of these, 'private' will be used. Set the
string to NULL to disable kerberos support for FTP.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_LOGIN_OPTIONS.3
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@ IETF draft draft-earhart-url-smtp-00.txt
options, such as the preferred authentication mechanism via "AUTH=NTLM" or
"AUTH=*", and should be used in conjunction with the \fICURLOPT_USERNAME(3)\fP
option.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_MAIL_AUTH.3
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ Unlike \fICURLOPT_MAIL_FROM(3)\fP and \fICURLOPT_MAIL_RCPT(3)\fP, the address
should not be specified within a pair of angled brackets (<>). However, if an
empty string is used then a pair of brackets will be sent by libcurl as
required by RFC2554.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_MAIL_FROM.3
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ around it, which if not specified will be added automatically.

If this parameter is not specified then an empty address will be sent to the
mail server which may cause the email to be rejected.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
blank
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_NETRC_FILE.3
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ the full path name to the \fIfile\fP you want libcurl to use as .netrc
file. If this option is omitted, and \fICURLOPT_NETRC(3)\fP is set, libcurl
will attempt to find a .netrc file in the current user's home
directory.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_NOPROXY.3
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ list is matched as either a domain which contains the hostname, or the
hostname itself. For example, example.com would match example.com,
example.com:80, and www.example.com, but not www.notanexample.com or
example.com.othertld.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_PASSWORD.3
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ password to use for the transfer.

The \fICURLOPT_PASSWORD(3)\fP option should be used in conjunction with the
\fICURLOPT_USERNAME(3)\fP option.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
blank
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_PINNEDPUBLICKEY.3
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ if it does not exactly match the public key provided to this option, curl will
abort the connection before sending or receiving any data.

On mismatch, \fICURLE_SSL_PINNEDPUBKEYNOTMATCH\fP is returned.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_PRE_PROXY.3
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,9 @@ be used. Otherwise SOCKS4 is used as default.

Setting the pre proxy string to "" (an empty string) will explicitly disable
the use of a pre proxy.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
Default is NULL, meaning no pre proxy is used.

Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_PROXY.3
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,9 @@ use of a proxy, even if there is an environment variable set for it.

A proxy host string can also include protocol scheme (http://) and embedded
user + password.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
Default is NULL, meaning no proxy is used.

Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_PROXYPASSWORD.3
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ password to use for authentication with the proxy.

The \fICURLOPT_PROXYPASSWORD(3)\fP option should be used in conjunction with
the \fICURLOPT_PROXYUSERNAME(3)\fP option.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
blank
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_PROXYUSERNAME.3
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ user name to use for the transfer.
authentication with the proxy.

To specify the proxy password use the \fICURLOPT_PROXYPASSWORD(3)\fP.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
blank
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_PROXYUSERPWD.3
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,9 @@ should encode it as %3A. (This is different to how \fICURLOPT_USERPWD(3)\fP is
used - beware.)

Use \fICURLOPT_PROXYAUTH(3)\fP to specify the authentication method.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
This is NULL by default.
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_PROXY_CAINFO.3
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@ option is supported for backward compatibility with other SSL engines, but it
should not be set. If the option is not set, then curl will use the
certificates in the system and user Keychain to verify the peer, which is the
preferred method of verifying the peer's certificate chain.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
Built-in system specific
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_PROXY_CAPATH.3
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ CA certificates to verify the HTTPS proxy with. If libcurl is built against
OpenSSL, the certificate directory must be prepared using the openssl c_rehash
utility. This makes sense only when \fICURLOPT_SSL_VERIFYPEER(3)\fP is enabled
(which it is by default).

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_PROXY_CRLFILE.3
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ A specific error code (\fICURLE_SSL_CRL_BADFILE\fP) is defined with the
option. It is returned when the SSL exchange fails because the CRL file cannot
be loaded. A failure in certificate verification due to a revocation
information found in the CRL does not trigger this specific error.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_PROXY_KEYPASSWD.3
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,9 @@ Pass a pointer to a zero terminated string as parameter. It will be used as
the password required to use the \fICURLOPT_PROXY_SSLKEY(3)\fP private key.
You never needed a pass phrase to load a certificate but you need one to load
your private key.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_PROXY_PINNEDPUBLICKEY.3
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,9 @@ if it does not exactly match the public key provided to this option, curl will
abort the connection before sending or receiving any data.

On mismatch, \fICURLE_SSL_PINNEDPUBKEYNOTMATCH\fP is returned.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_PROXY_SERVICE_NAME.3
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ CURLcode curl_easy_setopt(CURL *handle, CURLOPT_PROXY_SERVICE_NAME, char *name);
Pass a char * as parameter to a string holding the \fIname\fP of the
service. The default service name is "HTTP" for HTTP based proxies and "rcmd"
for SOCKS5. This option allows you to change it.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
See above
.SH PROTOCOLS
Expand Down
3 changes: 3 additions & 0 deletions docs/libcurl/opts/CURLOPT_PROXY_SSLCERT.3
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,9 @@ prefix, in order to avoid confusion with a nickname.

When using a client certificate, you most likely also need to provide a
private key with \fICURLOPT_PROXY_SSLKEY(3)\fP.

The application does not have to keep the string around after setting this
option.
.SH DEFAULT
NULL
.SH PROTOCOLS
Expand Down
Loading

0 comments on commit dbd3793

Please sign in to comment.