Fixed some typos in documentation
This commit is contained in:
parent
0f15ed1617
commit
cb787b70bf
@ -18,7 +18,7 @@ This release includes the following changes:
|
|||||||
o pop3: Added support for sasl digest-md5 authentication
|
o pop3: Added support for sasl digest-md5 authentication
|
||||||
o pop3: Added support for apop authentication
|
o pop3: Added support for apop authentication
|
||||||
o Added support for Schannel (Native Windows) SSL/TLS encryption [2]
|
o Added support for Schannel (Native Windows) SSL/TLS encryption [2]
|
||||||
o Added support for Dwarin SSL (Native Mac OS X and iOS) [6]
|
o Added support for Darwin SSL (Native Mac OS X and iOS) [6]
|
||||||
|
|
||||||
This release includes the following bugfixes:
|
This release includes the following bugfixes:
|
||||||
|
|
||||||
|
@ -91,7 +91,7 @@ BUGS
|
|||||||
your problem and to work on a fix (if we agree it truly is a problem).
|
your problem and to work on a fix (if we agree it truly is a problem).
|
||||||
|
|
||||||
Lots of problems that appear to be libcurl problems are actually just abuses
|
Lots of problems that appear to be libcurl problems are actually just abuses
|
||||||
of the libcurl API or other malfunctions in your applications. It is adviced
|
of the libcurl API or other malfunctions in your applications. It is advised
|
||||||
that you run your problematic program using a memory debug tool like
|
that you run your problematic program using a memory debug tool like
|
||||||
valgrind or similar before you post memory-related or "crashing" problems to
|
valgrind or similar before you post memory-related or "crashing" problems to
|
||||||
us.
|
us.
|
||||||
|
@ -279,7 +279,7 @@
|
|||||||
|
|
||||||
3.6 Please don't send pull requests
|
3.6 Please don't send pull requests
|
||||||
|
|
||||||
With git (and expecially github) it is easy and tempting to send a pull
|
With git (and especially github) it is easy and tempting to send a pull
|
||||||
request to one or more people in the curl project to have changes merged this
|
request to one or more people in the curl project to have changes merged this
|
||||||
way instead of mailing patches to the curl-library mailing list.
|
way instead of mailing patches to the curl-library mailing list.
|
||||||
|
|
||||||
@ -294,7 +294,7 @@
|
|||||||
|
|
||||||
- Commit messages can be tweaked and changed if merged locally instead of
|
- Commit messages can be tweaked and changed if merged locally instead of
|
||||||
using github. Merges directly on github requires the changes to be perfect
|
using github. Merges directly on github requires the changes to be perfect
|
||||||
already, which they seldomly are.
|
already, which they seldom are.
|
||||||
|
|
||||||
- Merges on github prevents rebases and even enforces --no-ff which is a git
|
- Merges on github prevents rebases and even enforces --no-ff which is a git
|
||||||
style we don't otherwise use in the project
|
style we don't otherwise use in the project
|
||||||
|
4
docs/FAQ
4
docs/FAQ
@ -138,7 +138,7 @@ FAQ
|
|||||||
|
|
||||||
libcurl is highly portable, it builds and works identically on numerous
|
libcurl is highly portable, it builds and works identically on numerous
|
||||||
platforms, including Solaris, NetBSD, FreeBSD, OpenBSD, Darwin, HPUX,
|
platforms, including Solaris, NetBSD, FreeBSD, OpenBSD, Darwin, HPUX,
|
||||||
IRIX, AIX, Tru64, Linux, UnixWare, HURD, Windows, Amiga, OS/2, BeOs, Mac
|
IRIX, AIX, Tru64, Linux, UnixWare, HURD, Windows, Amiga, OS/2, BeOS, Mac
|
||||||
OS X, Ultrix, QNX, OpenVMS, RISC OS, Novell NetWare, DOS, Symbian, OSF,
|
OS X, Ultrix, QNX, OpenVMS, RISC OS, Novell NetWare, DOS, Symbian, OSF,
|
||||||
Android, Minix, IBM TPF and more...
|
Android, Minix, IBM TPF and more...
|
||||||
|
|
||||||
@ -807,7 +807,7 @@ FAQ
|
|||||||
|
|
||||||
4.5.3 "403 Forbidden"
|
4.5.3 "403 Forbidden"
|
||||||
|
|
||||||
The server understood the request, but is refusing to fulfill it.
|
The server understood the request, but is refusing to fulfil it.
|
||||||
Authorization will not help and the request SHOULD NOT be repeated.
|
Authorization will not help and the request SHOULD NOT be repeated.
|
||||||
|
|
||||||
4.5.4 "404 Not Found"
|
4.5.4 "404 Not Found"
|
||||||
|
@ -26,12 +26,12 @@ libcurl supports
|
|||||||
- compiles on win32 (reported builds on 40+ operating systems)
|
- compiles on win32 (reported builds on 40+ operating systems)
|
||||||
- selectable network interface for outgoing traffic
|
- selectable network interface for outgoing traffic
|
||||||
- IPv6 support on unix and Windows
|
- IPv6 support on unix and Windows
|
||||||
- persistant connections
|
- persistent connections
|
||||||
- socks5 support
|
- socks5 support
|
||||||
- supports user name + password in proxy environment variables
|
- supports user name + password in proxy environment variables
|
||||||
- operations through proxy "tunnel" (using CONNECT)
|
- operations through proxy "tunnel" (using CONNECT)
|
||||||
- supports large files (>2GB and >4GB) both upload/download
|
- supports large files (>2GB and >4GB) both upload/download
|
||||||
- replacable memory functions (malloc, free, realloc, etc)
|
- replaceable memory functions (malloc, free, realloc, etc)
|
||||||
- asynchronous name resolving (*6)
|
- asynchronous name resolving (*6)
|
||||||
- both a push and a pull style interface
|
- both a push and a pull style interface
|
||||||
|
|
||||||
|
@ -546,7 +546,7 @@ VMS
|
|||||||
Curl seems to work with FTP & HTTP other protocols are not tested. (the
|
Curl seems to work with FTP & HTTP other protocols are not tested. (the
|
||||||
perl http/ftp testing server supplied as testing too cannot work on VMS
|
perl http/ftp testing server supplied as testing too cannot work on VMS
|
||||||
because vms has no concept of fork(). [ I tried to give it a whack, but
|
because vms has no concept of fork(). [ I tried to give it a whack, but
|
||||||
thats of no use.
|
that's of no use.
|
||||||
|
|
||||||
SSL stuff has not been ported.
|
SSL stuff has not been ported.
|
||||||
|
|
||||||
@ -679,7 +679,7 @@ NetWare
|
|||||||
you can find precompiled packages at:
|
you can find precompiled packages at:
|
||||||
http://www.gknw.net/development/ossl/netware/
|
http://www.gknw.net/development/ossl/netware/
|
||||||
for CLIB-based builds OpenSSL 0.9.8h or later is required - earlier versions
|
for CLIB-based builds OpenSSL 0.9.8h or later is required - earlier versions
|
||||||
dont support buildunf with CLIB BSD sockets.
|
don't support buildunf with CLIB BSD sockets.
|
||||||
- optional SSH2 sources (version 0.17 or later);
|
- optional SSH2 sources (version 0.17 or later);
|
||||||
|
|
||||||
Set a search path to your compiler, linker and tools; on Linux make
|
Set a search path to your compiler, linker and tools; on Linux make
|
||||||
|
@ -11,7 +11,7 @@ Building with CMake
|
|||||||
This document describes how to compile, build and install curl and libcurl
|
This document describes how to compile, build and install curl and libcurl
|
||||||
from source code using the CMake build tool. To build with CMake, you will
|
from source code using the CMake build tool. To build with CMake, you will
|
||||||
of course have to first install CMake. The minimum required version of
|
of course have to first install CMake. The minimum required version of
|
||||||
CMake is specifed in the file CMakeLists.txt found in the top of the curl
|
CMake is specified in the file CMakeLists.txt found in the top of the curl
|
||||||
source tree. Once the correct version of CMake is installed you can follow
|
source tree. Once the correct version of CMake is installed you can follow
|
||||||
the instructions below for the platform you are building on.
|
the instructions below for the platform you are building on.
|
||||||
|
|
||||||
@ -39,7 +39,7 @@ Command Line CMake
|
|||||||
cd curl-build
|
cd curl-build
|
||||||
# now run CMake from the build tree, giving it the path to the top of
|
# now run CMake from the build tree, giving it the path to the top of
|
||||||
# the Curl source tree. CMake will pick a compiler for you. If you
|
# the Curl source tree. CMake will pick a compiler for you. If you
|
||||||
# want to specifiy the compile, you can set the CC environment
|
# want to specify the compile, you can set the CC environment
|
||||||
# variable prior to running CMake.
|
# variable prior to running CMake.
|
||||||
cmake ../curl
|
cmake ../curl
|
||||||
make
|
make
|
||||||
@ -51,7 +51,7 @@ Command Line CMake
|
|||||||
ccmake
|
ccmake
|
||||||
=========
|
=========
|
||||||
CMake comes with a curses based interface called ccmake. To run ccmake on
|
CMake comes with a curses based interface called ccmake. To run ccmake on
|
||||||
a curl use the instructions for the command line cmake, but substitue
|
a curl use the instructions for the command line cmake, but substitute
|
||||||
ccmake ../curl for cmake ../curl. This will bring up a curses interface
|
ccmake ../curl for cmake ../curl. This will bring up a curses interface
|
||||||
with instructions on the bottom of the screen. You can press the "c" key
|
with instructions on the bottom of the screen. You can press the "c" key
|
||||||
to configure the project, and the "g" key to generate the project. After
|
to configure the project, and the "g" key to generate the project. After
|
||||||
@ -65,7 +65,7 @@ cmake-gui
|
|||||||
the curl source tree.
|
the curl source tree.
|
||||||
2. Fill in the "Where to build the binaries" combo box with the path
|
2. Fill in the "Where to build the binaries" combo box with the path
|
||||||
to the directory for your build tree, ideally this should not be the
|
to the directory for your build tree, ideally this should not be the
|
||||||
same as the source tree, but a parallel diretory called curl-build or
|
same as the source tree, but a parallel directory called curl-build or
|
||||||
something similar.
|
something similar.
|
||||||
3. Once the source and binary directories are specified, press the
|
3. Once the source and binary directories are specified, press the
|
||||||
"Configure" button.
|
"Configure" button.
|
||||||
@ -73,5 +73,5 @@ cmake-gui
|
|||||||
5. At this point you can change any of the options presented in the
|
5. At this point you can change any of the options presented in the
|
||||||
GUI. Once you have selected all the options you want, click the
|
GUI. Once you have selected all the options you want, click the
|
||||||
"Generate" button.
|
"Generate" button.
|
||||||
6. Run the native build tool that you used CMake to genratate.
|
6. Run the native build tool that you used CMake to generate.
|
||||||
|
|
||||||
|
@ -26,7 +26,7 @@ exists for a Unix/linux command line environments. This is of little help when
|
|||||||
it comes to Windows O/S.
|
it comes to Windows O/S.
|
||||||
|
|
||||||
Secondly the help that does exist for the Windows O/S focused around mingw
|
Secondly the help that does exist for the Windows O/S focused around mingw
|
||||||
thru a command line argument environment.
|
through a command line argument environment.
|
||||||
|
|
||||||
You may ask "Why is this a problem?"
|
You may ask "Why is this a problem?"
|
||||||
|
|
||||||
|
@ -220,7 +220,7 @@ Library
|
|||||||
done" loop. It loops if there's a Location: to follow.
|
done" loop. It loops if there's a Location: to follow.
|
||||||
|
|
||||||
When completed, the curl_easy_cleanup() should be called to free up used
|
When completed, the curl_easy_cleanup() should be called to free up used
|
||||||
resources. It runs Curl_disconnect() on all open connectons.
|
resources. It runs Curl_disconnect() on all open connections.
|
||||||
|
|
||||||
A quick roundup on internal function sequences (many of these call
|
A quick roundup on internal function sequences (many of these call
|
||||||
protocol-specific function-pointers):
|
protocol-specific function-pointers):
|
||||||
|
@ -19,7 +19,7 @@ may have been fixed since this was written!
|
|||||||
http://curl.haxx.se/bug/view.cgi?id=3438362
|
http://curl.haxx.se/bug/view.cgi?id=3438362
|
||||||
|
|
||||||
77. CURLOPT_FORBID_REUSE on a handle prevents NTLM from working since it
|
77. CURLOPT_FORBID_REUSE on a handle prevents NTLM from working since it
|
||||||
"absuses" the underlying connection re-use system and if connections are
|
"abuses" the underlying connection re-use system and if connections are
|
||||||
forced to close they break the NTLM support.
|
forced to close they break the NTLM support.
|
||||||
|
|
||||||
76. The SOCKET type in Win64 is 64 bits large (and thus so is curl_socket_t on
|
76. The SOCKET type in Win64 is 64 bits large (and thus so is curl_socket_t on
|
||||||
|
@ -59,7 +59,7 @@ MAIL ETIQUETTE
|
|||||||
no way to read the reply, but to ask the one person the question. The one
|
no way to read the reply, but to ask the one person the question. The one
|
||||||
person consequently gets overloaded with mail.
|
person consequently gets overloaded with mail.
|
||||||
|
|
||||||
If you really want to contact an individual and perhaps pay for his or her's
|
If you really want to contact an individual and perhaps pay for his or her
|
||||||
services, by all means go ahead, but if it's just another curl question,
|
services, by all means go ahead, but if it's just another curl question,
|
||||||
take it to a suitable list instead.
|
take it to a suitable list instead.
|
||||||
|
|
||||||
@ -92,7 +92,7 @@ MAIL ETIQUETTE
|
|||||||
|
|
||||||
1.6 Handling trolls and spam
|
1.6 Handling trolls and spam
|
||||||
|
|
||||||
Despite our good intensions and hard work to keep spam off the lists and to
|
Despite our good intentions and hard work to keep spam off the lists and to
|
||||||
maintain a friendly and positive atmosphere, there will be times when spam
|
maintain a friendly and positive atmosphere, there will be times when spam
|
||||||
and or trolls get through.
|
and or trolls get through.
|
||||||
|
|
||||||
@ -170,8 +170,8 @@ MAIL ETIQUETTE
|
|||||||
Q: What is the most annoying thing in e-mail?
|
Q: What is the most annoying thing in e-mail?
|
||||||
|
|
||||||
Apart from the screwed up read order (especially when mixed together in a
|
Apart from the screwed up read order (especially when mixed together in a
|
||||||
thread when some responds doing the mandaded bottom-posting style), it also
|
thread when someone responds using the mandated bottom-posting style), it
|
||||||
makes it impossible to quote only parts of the original mail.
|
also makes it impossible to quote only parts of the original mail.
|
||||||
|
|
||||||
When you reply to a mail. You let the mail client insert the previous mail
|
When you reply to a mail. You let the mail client insert the previous mail
|
||||||
quoted. Then you put the cursor on the first line of the mail and you move
|
quoted. Then you put the cursor on the first line of the mail and you move
|
||||||
|
@ -613,7 +613,7 @@ SFTP and SCP and PATH NAMES
|
|||||||
FTP and firewalls
|
FTP and firewalls
|
||||||
|
|
||||||
The FTP protocol requires one of the involved parties to open a second
|
The FTP protocol requires one of the involved parties to open a second
|
||||||
connection as soon as data is about to get transfered. There are two ways to
|
connection as soon as data is about to get transferred. There are two ways to
|
||||||
do this.
|
do this.
|
||||||
|
|
||||||
The default way for curl is to issue the PASV command which causes the
|
The default way for curl is to issue the PASV command which causes the
|
||||||
|
@ -188,7 +188,6 @@ Dan Zitter
|
|||||||
Daniel Black
|
Daniel Black
|
||||||
Daniel Cater
|
Daniel Cater
|
||||||
Daniel Egger
|
Daniel Egger
|
||||||
Daniel Fandrich
|
|
||||||
Daniel Johnson
|
Daniel Johnson
|
||||||
Daniel Mentz
|
Daniel Mentz
|
||||||
Daniel Steinberg
|
Daniel Steinberg
|
||||||
|
@ -330,7 +330,7 @@ Pass a pointer to a function that matches the following prototype: \fBint
|
|||||||
function(void *clientp, double dltotal, double dlnow, double ultotal, double
|
function(void *clientp, double dltotal, double dlnow, double ultotal, double
|
||||||
ulnow); \fP. This function gets called by libcurl instead of its internal
|
ulnow); \fP. This function gets called by libcurl instead of its internal
|
||||||
equivalent with a frequent interval during operation (roughly once per second
|
equivalent with a frequent interval during operation (roughly once per second
|
||||||
or sooner) no matter if data is being transfered or not. Unknown/unused
|
or sooner) no matter if data is being transferred or not. Unknown/unused
|
||||||
argument values passed to the callback will be set to zero (like if you only
|
argument values passed to the callback will be set to zero (like if you only
|
||||||
download data, the upload size will remain 0). Returning a non-zero value from
|
download data, the upload size will remain 0). Returning a non-zero value from
|
||||||
this callback will cause libcurl to abort the transfer and return
|
this callback will cause libcurl to abort the transfer and return
|
||||||
@ -504,7 +504,7 @@ order. See \fIRFC2326 Section 10.12\fP for more information on how RTP
|
|||||||
interleaving behaves. If unset or set to NULL, curl will use the default write
|
interleaving behaves. If unset or set to NULL, curl will use the default write
|
||||||
function.
|
function.
|
||||||
|
|
||||||
Interleaved RTP poses some challeneges for the client application. Since the
|
Interleaved RTP poses some challenges for the client application. Since the
|
||||||
stream data is sharing the RTSP control connection, it is critical to service
|
stream data is sharing the RTSP control connection, it is critical to service
|
||||||
the RTP in a timely fashion. If the RTP data is not handled quickly,
|
the RTP in a timely fashion. If the RTP data is not handled quickly,
|
||||||
subsequent response processing may become unreasonably delayed and the
|
subsequent response processing may become unreasonably delayed and the
|
||||||
@ -1173,8 +1173,8 @@ the server is ignored. See the special file lib/README.encoding for details.
|
|||||||
.IP CURLOPT_TRANSFER_ENCODING
|
.IP CURLOPT_TRANSFER_ENCODING
|
||||||
Adds a request for compressed Transfer Encoding in the outgoing HTTP
|
Adds a request for compressed Transfer Encoding in the outgoing HTTP
|
||||||
request. If the server supports this and so desires, it can respond with the
|
request. If the server supports this and so desires, it can respond with the
|
||||||
HTTP resonse sent using a compressed Transfer-Encoding that will be
|
HTTP response sent using a compressed Transfer-Encoding that will be
|
||||||
automatically uncompressed by libcurl on receival.
|
automatically uncompressed by libcurl on reception.
|
||||||
|
|
||||||
Transfer-Encoding differs slightly from the Content-Encoding you ask for with
|
Transfer-Encoding differs slightly from the Content-Encoding you ask for with
|
||||||
\fBCURLOPT_ACCEPT_ENCODING\fP in that a Transfer-Encoding is strictly meant to
|
\fBCURLOPT_ACCEPT_ENCODING\fP in that a Transfer-Encoding is strictly meant to
|
||||||
@ -1636,7 +1636,7 @@ already exists or lack of permissions prevents creation. (Added in 7.16.3)
|
|||||||
|
|
||||||
Starting with 7.19.4, you can also set this value to 2, which will make
|
Starting with 7.19.4, you can also set this value to 2, which will make
|
||||||
libcurl retry the CWD command again if the subsequent MKD command fails. This
|
libcurl retry the CWD command again if the subsequent MKD command fails. This
|
||||||
is especially useful if you're doing many simultanoes connections against the
|
is especially useful if you're doing many simultaneous connections against the
|
||||||
same server and they all have this option enabled, as then CWD may first fail
|
same server and they all have this option enabled, as then CWD may first fail
|
||||||
but then another connection does MKD before this connection and thus MKD fails
|
but then another connection does MKD before this connection and thus MKD fails
|
||||||
but trying CWD works! 7.19.4 also introduced the \fICURLFTP_CREATE_DIR\fP and
|
but trying CWD works! 7.19.4 also introduced the \fICURLFTP_CREATE_DIR\fP and
|
||||||
@ -1723,7 +1723,7 @@ initialized. (Added in 7.20.0)
|
|||||||
.RS
|
.RS
|
||||||
.IP CURL_RTSPREQ_OPTIONS
|
.IP CURL_RTSPREQ_OPTIONS
|
||||||
Used to retrieve the available methods of the server. The application is
|
Used to retrieve the available methods of the server. The application is
|
||||||
responsbile for parsing and obeying the response. \fB(The session ID is not
|
responsible for parsing and obeying the response. \fB(The session ID is not
|
||||||
needed for this method.)\fP (Added in 7.20.0)
|
needed for this method.)\fP (Added in 7.20.0)
|
||||||
.IP CURL_RTSPREQ_DESCRIBE
|
.IP CURL_RTSPREQ_DESCRIBE
|
||||||
Used to get the low level description of a stream. The application should note
|
Used to get the low level description of a stream. The application should note
|
||||||
@ -1894,7 +1894,7 @@ to a proper GET use CURLOPT_HTTPGET.
|
|||||||
With the POP3 protocol when you tell libcurl to use a custom request it will
|
With the POP3 protocol when you tell libcurl to use a custom request it will
|
||||||
behave like a LIST or RETR command was sent where it expects data to be
|
behave like a LIST or RETR command was sent where it expects data to be
|
||||||
returned by the server. As such \fICURLOPT_NOBODY\fP should be used when
|
returned by the server. As such \fICURLOPT_NOBODY\fP should be used when
|
||||||
specifing commands such as DELE and NOOP for example.
|
specifying commands such as DELE and NOOP for example.
|
||||||
|
|
||||||
Restore to the internal default by setting this to NULL.
|
Restore to the internal default by setting this to NULL.
|
||||||
|
|
||||||
@ -2379,7 +2379,7 @@ require you to disable this in order for you to succeed. (Added in 7.16.0)
|
|||||||
Pass a long with a bitmask to tell libcurl about specific SSL behaviors.
|
Pass a long with a bitmask to tell libcurl about specific SSL behaviors.
|
||||||
|
|
||||||
CURLSSLOPT_ALLOW_BEAST is the only supported bit and by setting this the user
|
CURLSSLOPT_ALLOW_BEAST is the only supported bit and by setting this the user
|
||||||
will tell libcurl to not attempt to use any work-arounds for a security flaw
|
will tell libcurl to not attempt to use any workarounds for a security flaw
|
||||||
in the SSL3 and TLS1.0 protocols. If this option isn't used or this bit is
|
in the SSL3 and TLS1.0 protocols. If this option isn't used or this bit is
|
||||||
set to 0, the SSL layer libcurl uses may use a work-around for this flaw
|
set to 0, the SSL layer libcurl uses may use a work-around for this flaw
|
||||||
although it might cause interoperability problems with some (older) SSL
|
although it might cause interoperability problems with some (older) SSL
|
||||||
|
@ -65,7 +65,7 @@ object. Note that when you use the multi interface, all easy handles added to
|
|||||||
the same multi handle will share DNS cache by default without this having to
|
the same multi handle will share DNS cache by default without this having to
|
||||||
be used!
|
be used!
|
||||||
.IP CURL_LOCK_DATA_SSL_SESSION
|
.IP CURL_LOCK_DATA_SSL_SESSION
|
||||||
SSL session IDs will be shared accross the easy handles using this shared
|
SSL session IDs will be shared across the easy handles using this shared
|
||||||
object. This will reduce the time spent in the SSL handshake when reconnecting
|
object. This will reduce the time spent in the SSL handshake when reconnecting
|
||||||
to the same server. Note SSL session IDs are reused within the same easy handle
|
to the same server. Note SSL session IDs are reused within the same easy handle
|
||||||
by default.
|
by default.
|
||||||
|
@ -285,5 +285,5 @@ An invalid share object was passed to the function.
|
|||||||
Not enough memory was available.
|
Not enough memory was available.
|
||||||
(Added in 7.12.0)
|
(Added in 7.12.0)
|
||||||
.IP "CURLSHE_NOT_BUILT_IN (5)"
|
.IP "CURLSHE_NOT_BUILT_IN (5)"
|
||||||
The requsted sharing could not be done because the library you use don't have
|
The requested sharing could not be done because the library you use don't have
|
||||||
that particular feature enabled. (Added in 7.23.0)
|
that particular feature enabled. (Added in 7.23.0)
|
||||||
|
Loading…
x
Reference in New Issue
Block a user