aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDaniel Stenberg <daniel@haxx.se>2004-03-05 07:55:02 +0000
committerDaniel Stenberg <daniel@haxx.se>2004-03-05 07:55:02 +0000
commit13f98c5c1814866d418e06b79395354dc2de36e9 (patch)
treec84ca5a057e777963867b946197426a9b5add309
parent30e71d54e0db659951a6577083aa71599cf71ec9 (diff)
Multiple updates, most of them being proper formatting to create nice html
links in the web pages, but also additional facts and removal of old crap.
-rw-r--r--docs/curl.1103
1 files changed, 63 insertions, 40 deletions
diff --git a/docs/curl.1 b/docs/curl.1
index e5b3968e1..9ed452883 100644
--- a/docs/curl.1
+++ b/docs/curl.1
@@ -2,7 +2,7 @@
.\" nroff -man curl.1
.\" Written by Daniel Stenberg
.\"
-.TH curl 1 "6 Feb 2004" "Curl 7.11.1" "Curl Manual"
+.TH curl 1 "5 Mar 2004" "Curl 7.11.1" "Curl Manual"
.SH NAME
curl \- transfer a URL
.SH SYNOPSIS
@@ -165,9 +165,9 @@ that can emulate as if a user has filled in a HTML form and pressed the submit
button. Note that the data is sent exactly as specified with no extra
processing (with all newlines cut off). The data is expected to be
\&"url-encoded". This will cause curl to pass the data to the server using the
-content-type application/x-www-form-urlencoded. Compare to -F. If this option
-is used more than once on the same command line, the data pieces specified
-will be merged together with a separating &-letter. Thus, using '-d
+content-type application/x-www-form-urlencoded. Compare to \fI-F/--form\fP. If
+this option is used more than once on the same command line, the data pieces
+specified will be merged together with a separating &-letter. Thus, using '-d
name=daniel -d skill=lousy' would generate a post chunk that looks like
\&'name=daniel&skill=lousy'.
@@ -421,7 +421,7 @@ should be one of 'clear', 'safe', 'confidential' or 'private'. Should you use
a level that is not one of these, 'private' will instead be used.
This option requiures that the library was built with kerberos4 support. This
-is not very common. Use \fI--version\fP to see if your version supports it.
+is not very common. Use \fI-V/--version\fP to see if your curl supports it.
If this option is used several times, the last one will be used.
.IP "-K/--config <config file>"
@@ -451,7 +451,7 @@ The given speed is measured in bytes/second, unless a suffix is appended.
Appending 'k' or 'K' will count the number as kilobytes, 'm' or M' makes it
megabytes while 'g' or 'G' makes it gigabytes. Examples: 200K, 3m and 1G.
-If you are also using the \fI--speed-limit\fP option, that option will take
+If you are also using the \fI-Y/--speed-limit\fP option, that option will take
precedence and might cripple the rate-limiting slightly, to help keeping the
speed-limit logic working.
@@ -473,11 +473,12 @@ If this option is used twice, the second will again disable list only.
.IP "-L/--location"
(HTTP/HTTPS) If the server reports that the requested page has a different
location (indicated with the header line Location:) this flag will let curl
-attempt to reattempt the get on the new place. If used together with -i or -I,
-headers from all requested pages will be shown. If authentication is used,
-curl will only send its credentials to the initial host, so if a redirect
-takes curl to a different host, it won't intercept the user+password. See also
-\fI--location-trusted\fP on how to change this.
+attempt to reattempt the get on the new place. If used together with
+\fI-i/--include\fP or \fI-I/--head\fP, headers from all requested pages will
+be shown. If authentication is used, curl will only send its credentials to
+the initial host, so if a redirect takes curl to a different host, it won't
+intercept the user+password. See also \fI--location-trusted\fP on how to
+change this.
If this option is used twice, the second will again disable location following.
.IP "--location-trusted"
@@ -535,7 +536,7 @@ with another authentication methods. For more information see IETF draft
draft-brezak-spnego-http-04.txt. (Added in 7.10.6)
This option requiures that the library was built with GSSAPI support. This is
-not very common. Use \fI--version\fP to see if your version supports
+not very common. Use \fI-V/--version\fP to see if your version supports
GSS-Negotiate.
If this option is used several times, the following occurrences make no
@@ -555,8 +556,11 @@ on their efforts. This kind of behavior should not be endorsed, you should
encourage everyone who uses NTLM to switch to a public and documented
authentication method instead. Such as Digest. (Added in 7.10.6)
-This option requiures that the library was built with SSL support. Use \fIcurl
---version\fP to see if your version supports NTLM.
+If you want to enable NTLM for your proxy authentication, then use
+\fI--proxy-ntlm\fP.
+
+This option requiures that the library was built with SSL support. Use
+\fI-V/--version\fP to see if your curl supports NTLM.
If this option is used several times, the following occurrences make no
difference.
@@ -574,7 +578,8 @@ or use several variables like:
You may use this option as many times as you have number of URLs.
-See also the --create-dirs option to create the local directories dynamically.
+See also the \fI--create-dirs\fP option to create the local directories
+dynamically.
.IP "-O/--remote-name"
Write output to a local file named like the remote file we get. (Only the file
part of the remote file is used, the path is cut off.)
@@ -585,15 +590,16 @@ You may use this option as many times as you have number of URLs.
If this option is used several times, the last one will be used.
.IP "--proxy-ntlm"
-Tells curl to use NTLM authentication when communicating with the given proxy.
+Tells curl to use NTLM authentication when communicating with the given
+proxy. Use \fI--ntlm\fP for enabling NTLM with a remote host.
If this option is used twice, the second will again disable proxy NTLM.
.IP "-p/--proxytunnel"
-When an HTTP proxy is used, this option will cause non-HTTP protocols to
-attempt to tunnel through the proxy instead of merely using it to do HTTP-like
-operations. The tunnel approach is made with the HTTP proxy CONNECT request
-and requires that the proxy allows direct connect to the remote port number
-curl wants to tunnel through to.
+When an HTTP proxy is used (\fI-x/--proxy\fP), this option will cause non-HTTP
+protocols to attempt to tunnel through the proxy instead of merely using it to
+do HTTP-like operations. The tunnel approach is made with the HTTP proxy
+CONNECT request and requires that the proxy allows direct connect to the
+remote port number curl wants to tunnel through to.
If this option is used twice, the second will again disable proxy tunnel.
.IP "-P/--ftp-port <address>"
@@ -614,7 +620,8 @@ i.e "my.host.domain" to specify machine
.RE
If this option is used several times, the last one will be used. Disable the
-use of PORT with \fI--ftp-pasv\fP.
+use of PORT with \fI--ftp-pasv\fP. Disable the attempt to use the EPRT command
+instead of PORT by using \fI--disable-eprt\fP. EPRT is really PORT++.
.IP "-q"
If used as the first parameter on the command line, the \fI$HOME/.curlrc\fP
file will not be read and used as a config file.
@@ -743,24 +750,18 @@ Enables a full trace dump of all incoming and outgoing data, including
descriptive information, to the given output file. Use "-" as filename to have
the output sent to stdout.
-This is very similar to --trace, but leaves out the hex part and only shows
-the ASCII part of the dump. It makes smaller output that might be easier to
-read for untrained humans.
+This is very similar to \fI--trace\fP, but leaves out the hex part and only
+shows the ASCII part of the dump. It makes smaller output that might be easier
+to read for untrained humans.
If this option is used several times, the last one will be used. (Added in
7.9.7)
.IP "-u/--user <user:password>"
-Specify user and password to use when fetching. Read the MANUAL for detailed
-examples of how to use this. If no password is specified, curl will ask for it
-interactively.
-
-You can also use the --digest option to enable Digest authentication when
-communicating with HTTP 1.1 servers.
+Specify user and password to use for server authentication.
If this option is used several times, the last one will be used.
.IP "-U/--proxy-user <user:password>"
-Specify user and password to use for Proxy authentication. If no
-password is specified, curl will ask for it interactively.
+Specify user and password to use for proxy authentication.
If this option is used several times, the last one will be used.
.IP "--url <URL>"
@@ -768,7 +769,7 @@ Specify a URL to fetch. This option is mostly handy when you want to specify
URL(s) in a config file.
This option may be used any number of times. To control where this URL is
-written, use the \fI-o\fP or the \fI-O\fP options.
+written, use the \fI-o/--output\fP or the \fI-O/--remote-name\fP options.
.IP "-v/--verbose"
Makes the fetching more verbose/talkative. Mostly usable for debugging. Lines
starting with '>' means data sent by curl, '<' means data received by curl
@@ -792,8 +793,30 @@ The second line (starts with "Protocols:") shows all protocols that libcurl
reports to support.
The third line (starts with "Features:") shows specific features libcurl
-reports to offer.
-
+reports to offer. Available features include:
+.RS
+.IP "IPv6"
+You can use IPv6 with this.
+.IP "krb4"
+Krb4 for ftp is supported.
+.IP "SSL"
+HTTPS and FTPS are supported.
+.IP "libz"
+Automatic decompression of compressed files over HTTP is supported.
+.IP "NTLM"
+NTLM authenticaion is supported.
+.IP "GSS-Negotiate"
+Negotiate authenticaion is supported.
+.IP "Debug"
+This curl uses a libcurl built with Debug. This enables more error-tracking
+and memory debugging etc. For curl-developers only!
+.IP "AsynchDNS"
+This curl uses asynchronous name resolves.
+.IP "SPNEGO"
+SPNEGO Negotiate authenticaion is supported.
+.IP "Largefile"
+This curl supports transfers of large files, files larger than 2GB.
+.RE
.IP "-w/--write-out <format>"
Defines what to display after a completed and successful operation. The format
is a string that may contain plain text mixed with any number of variables. The
@@ -923,9 +946,9 @@ than the specified date/time.
If this option is used several times, the last one will be used.
.IP "-Z/--max-redirs <num>"
-Set maximum number of redirection-followings allowed. If -L/--location is
-used, this option can be used to prevent curl from following redirections "in
-absurdum".
+Set maximum number of redirection-followings allowed. If \fI-L/--location\fP
+is used, this option can be used to prevent curl from following redirections
+\&"in absurdum".
If this option is used several times, the last one will be used.
.IP "-0/--http1.0"
@@ -1023,7 +1046,7 @@ FTP quote error. A quote command returned error from the server.
.IP 22
HTTP page not retrieved. The requested url was not found or returned another
error with the HTTP error code being 400 or above. This return code only
-appears if --fail is used.
+appears if \fI-f/--fail\fP is used.
.IP 23
Write error. Curl couldn't write data to a local filesystem or similar.
.IP 24