docs/MANUAL

   1 LATEST VERSION
   2
   3   You always find news about what's going on as well as the latest versions
   4   from the curl web pages, located at:
   5
   6         https://curl.haxx.se
   7
   8 SIMPLE USAGE
   9
  10   Get the main page from Netscape's web-server:
  11
  12         curl http://www.netscape.com/
  13
  14   Get the README file the user's home directory at funet's ftp-server:
  15
  16         curl ftp://ftp.funet.fi/README
  17
  18   Get a web page from a server using port 8000:
  19
  20         curl http://www.weirdserver.com:8000/
  21
  22   Get a directory listing of an FTP site:
  23
  24         curl ftp://cool.haxx.se/
  25
  26   Get the definition of curl from a dictionary:
  27
  28         curl dict://dict.org/m:curl
  29
  30   Fetch two documents at once:
  31
  32         curl ftp://cool.haxx.se/ http://www.weirdserver.com:8000/
  33
  34   Get a file off an FTPS server:
  35
  36         curl ftps://files.are.secure.com/secrets.txt
  37
  38   or use the more appropriate FTPS way to get the same file:
  39
  40         curl --ftp-ssl ftp://files.are.secure.com/secrets.txt
  41
  42   Get a file from an SSH server using SFTP:
  43
  44         curl -u username sftp://example.com/etc/issue
  45
  46   Get a file from an SSH server using SCP using a private key
  47   (not password-protected) to authenticate:
  48
  49         curl -u username: --key ~/.ssh/id_rsa \
  50              scp://example.com/~/file.txt
  51
  52   Get a file from an SSH server using SCP using a private key
  53   (password-protected) to authenticate:
  54
  55         curl -u username: --key ~/.ssh/id_rsa --pass private_key_password \
  56              scp://example.com/~/file.txt
  57
  58   Get the main page from an IPv6 web server:
  59
  60         curl "http://[2001:1890:1112:1::20]/"
  61
  62   Get a file from an SMB server:
  63
  64         curl -u "domain\username:passwd" smb://server.example.com/share/file.txt
  65
  66 DOWNLOAD TO A FILE
  67
  68   Get a web page and store in a local file with a specific name:
  69
  70         curl -o thatpage.html http://www.netscape.com/
  71
  72   Get a web page and store in a local file, make the local file get the name
  73   of the remote document (if no file name part is specified in the URL, this
  74   will fail):
  75
  76         curl -O http://www.netscape.com/index.html
  77
  78   Fetch two files and store them with their remote names:
  79
  80         curl -O www.haxx.se/index.html -O curl.haxx.se/download.html
  81
  82 USING PASSWORDS
  83
  84  FTP
  85
  86    To ftp files using name+passwd, include them in the URL like:
  87
  88         curl ftp://name:passwd@machine.domain:port/full/path/to/file
  89
  90    or specify them with the -u flag like
  91
  92         curl -u name:passwd ftp://machine.domain:port/full/path/to/file
  93
  94  FTPS
  95
  96    It is just like for FTP, but you may also want to specify and use
  97    SSL-specific options for certificates etc.
  98
  99    Note that using FTPS:// as prefix is the "implicit" way as described in the
 100    standards while the recommended "explicit" way is done by using FTP:// and
 101    the --ftp-ssl option.
 102
 103  SFTP / SCP
 104
 105    This is similar to FTP, but you can use the --key option to specify a
 106    private key to use instead of a password. Note that the private key may
 107    itself be protected by a password that is unrelated to the login password
 108    of the remote system; this password is specified using the --pass option.
 109    Typically, curl will automatically extract the public key from the private
 110    key file, but in cases where curl does not have the proper library support,
 111    a matching public key file must be specified using the --pubkey option.
 112
 113  HTTP
 114
 115    Curl also supports user and password in HTTP URLs, thus you can pick a file
 116    like:
 117
 118         curl http://name:passwd@machine.domain/full/path/to/file
 119
 120    or specify user and password separately like in
 121
 122         curl -u name:passwd http://machine.domain/full/path/to/file
 123
 124    HTTP offers many different methods of authentication and curl supports
 125    several: Basic, Digest, NTLM and Negotiate (SPNEGO). Without telling which
 126    method to use, curl defaults to Basic. You can also ask curl to pick the
 127    most secure ones out of the ones that the server accepts for the given URL,
 128    by using --anyauth.
 129
 130    NOTE! According to the URL specification, HTTP URLs can not contain a user
 131    and password, so that style will not work when using curl via a proxy, even
 132    though curl allows it at other times. When using a proxy, you _must_ use
 133    the -u style for user and password.
 134
 135  HTTPS
 136
 137    Probably most commonly used with private certificates, as explained below.
 138
 139 PROXY
 140
 141  curl supports both HTTP and SOCKS proxy servers, with optional authentication.
 142  It does not have special support for FTP proxy servers since there are no
 143  standards for those, but it can still be made to work with many of them. You
 144  can also use both HTTP and SOCKS proxies to transfer files to and from FTP
 145  servers.
 146
 147  Get an ftp file using an HTTP proxy named my-proxy that uses port 888:
 148
 149         curl -x my-proxy:888 ftp://ftp.leachsite.com/README
 150
 151  Get a file from an HTTP server that requires user and password, using the
 152  same proxy as above:
 153
 154         curl -u user:passwd -x my-proxy:888 http://www.get.this/
 155
 156  Some proxies require special authentication. Specify by using -U as above:
 157
 158         curl -U user:passwd -x my-proxy:888 http://www.get.this/
 159
 160  A comma-separated list of hosts and domains which do not use the proxy can
 161  be specified as:
 162
 163         curl --noproxy localhost,get.this -x my-proxy:888 http://www.get.this/
 164
 165  If the proxy is specified with --proxy1.0 instead of --proxy or -x, then
 166  curl will use HTTP/1.0 instead of HTTP/1.1 for any CONNECT attempts.
 167
 168  curl also supports SOCKS4 and SOCKS5 proxies with --socks4 and --socks5.
 169
 170  See also the environment variables Curl supports that offer further proxy
 171  control.
 172
 173  Most FTP proxy servers are set up to appear as a normal FTP server from the
 174  client's perspective, with special commands to select the remote FTP server.
 175  curl supports the -u, -Q and --ftp-account options that can be used to
 176  set up transfers through many FTP proxies. For example, a file can be
 177  uploaded to a remote FTP server using a Blue Coat FTP proxy with the
 178  options:
 179
 180    curl -u "Remote-FTP-Username@remote.ftp.server Proxy-Username:Remote-Pass" \
 181     --ftp-account Proxy-Password --upload-file local-file \
 182     ftp://my-ftp.proxy.server:21/remote/upload/path/
 183
 184  See the manual for your FTP proxy to determine the form it expects to set up
 185  transfers, and curl's -v option to see exactly what curl is sending.
 186
 187 RANGES
 188
 189   HTTP 1.1 introduced byte-ranges. Using this, a client can request
 190   to get only one or more subparts of a specified document. Curl supports
 191   this with the -r flag.
 192
 193   Get the first 100 bytes of a document:
 194
 195         curl -r 0-99 http://www.get.this/
 196
 197   Get the last 500 bytes of a document:
 198
 199         curl -r -500 http://www.get.this/
 200
 201   Curl also supports simple ranges for FTP files as well. Then you can only
 202   specify start and stop position.
 203
 204   Get the first 100 bytes of a document using FTP:
 205
 206         curl -r 0-99 ftp://www.get.this/README
 207
 208 UPLOADING
 209
 210  FTP / FTPS / SFTP / SCP
 211
 212   Upload all data on stdin to a specified server:
 213
 214         curl -T - ftp://ftp.upload.com/myfile
 215
 216   Upload data from a specified file, login with user and password:
 217
 218         curl -T uploadfile -u user:passwd ftp://ftp.upload.com/myfile
 219
 220   Upload a local file to the remote site, and use the local file name at the remote
 221   site too:
 222
 223         curl -T uploadfile -u user:passwd ftp://ftp.upload.com/
 224
 225   Upload a local file to get appended to the remote file:
 226
 227         curl -T localfile -a ftp://ftp.upload.com/remotefile
 228
 229   Curl also supports ftp upload through a proxy, but only if the proxy is
 230   configured to allow that kind of tunneling. If it does, you can run curl in
 231   a fashion similar to:
 232
 233         curl --proxytunnel -x proxy:port -T localfile ftp.upload.com
 234
 235 SMB / SMBS
 236
 237         curl -T file.txt -u "domain\username:passwd"
 238          smb://server.example.com/share/
 239
 240  HTTP
 241
 242   Upload all data on stdin to a specified HTTP site:
 243
 244         curl -T - http://www.upload.com/myfile
 245
 246   Note that the HTTP server must have been configured to accept PUT before
 247   this can be done successfully.
 248
 249   For other ways to do HTTP data upload, see the POST section below.
 250
 251 VERBOSE / DEBUG
 252
 253   If curl fails where it isn't supposed to, if the servers don't let you in,
 254   if you can't understand the responses: use the -v flag to get verbose
 255   fetching. Curl will output lots of info and what it sends and receives in
 256   order to let the user see all client-server interaction (but it won't show
 257   you the actual data).
 258
 259         curl -v ftp://ftp.upload.com/
 260
 261   To get even more details and information on what curl does, try using the
 262   --trace or --trace-ascii options with a given file name to log to, like
 263   this:
 264
 265         curl --trace trace.txt www.haxx.se
 266
 267
 268 DETAILED INFORMATION
 269
 270   Different protocols provide different ways of getting detailed information
 271   about specific files/documents. To get curl to show detailed information
 272   about a single file, you should use -I/--head option. It displays all
 273   available info on a single file for HTTP and FTP. The HTTP information is a
 274   lot more extensive.
 275
 276   For HTTP, you can get the header information (the same as -I would show)
 277   shown before the data by using -i/--include. Curl understands the
 278   -D/--dump-header option when getting files from both FTP and HTTP, and it
 279   will then store the headers in the specified file.
 280
 281   Store the HTTP headers in a separate file (headers.txt in the example):
 282
 283         curl --dump-header headers.txt curl.haxx.se
 284
 285   Note that headers stored in a separate file can be very useful at a later
 286   time if you want curl to use cookies sent by the server. More about that in
 287   the cookies section.
 288
 289 POST (HTTP)
 290
 291   It's easy to post data using curl. This is done using the -d <data>
 292   option.  The post data must be urlencoded.
 293
 294   Post a simple "name" and "phone" guestbook.
 295
 296         curl -d "name=Rafael%20Sagula&phone=3320780" \
 297                 http://www.where.com/guest.cgi
 298
 299   How to post a form with curl, lesson #1:
 300
 301   Dig out all the <input> tags in the form that you want to fill in.
 302
 303   If there's a "normal" post, you use -d to post. -d takes a full "post
 304   string", which is in the format
 305
 306         <variable1>=<data1>&<variable2>=<data2>&...
 307
 308   The 'variable' names are the names set with "name=" in the <input> tags, and
 309   the data is the contents you want to fill in for the inputs. The data *must*
 310   be properly URL encoded. That means you replace space with + and that you
 311   replace weird letters with %XX where XX is the hexadecimal representation of
 312   the letter's ASCII code.
 313
 314   Example:
 315
 316   (page located at http://www.formpost.com/getthis/
 317
 318         <form action="post.cgi" method="post">
 319         <input name=user size=10>
 320         <input name=pass type=password size=10>
 321         <input name=id type=hidden value="blablabla">
 322         <input name=ding value="submit">
 323         </form>
 324
 325   We want to enter user 'foobar' with password '12345'.
 326
 327   To post to this, you enter a curl command line like:
 328
 329         curl -d "user=foobar&pass=12345&id=blablabla&ding=submit"  (continues)
 330           http://www.formpost.com/getthis/post.cgi
 331
 332
 333   While -d uses the application/x-www-form-urlencoded mime-type, generally
 334   understood by CGI's and similar, curl also supports the more capable
 335   multipart/form-data type. This latter type supports things like file upload.
 336
 337   -F accepts parameters like -F "name=contents". If you want the contents to
 338   be read from a file, use <@filename> as contents. When specifying a file,
 339   you can also specify the file content type by appending ';type=<mime type>'
 340   to the file name. You can also post the contents of several files in one
 341   field.  For example, the field name 'coolfiles' is used to send three files,
 342   with different content types using the following syntax:
 343
 344         curl -F "coolfiles=@fil1.gif;type=image/gif,fil2.txt,fil3.html" \
 345         http://www.post.com/postit.cgi
 346
 347   If the content-type is not specified, curl will try to guess from the file
 348   extension (it only knows a few), or use the previously specified type (from
 349   an earlier file if several files are specified in a list) or else it will
 350   use the default type 'application/octet-stream'.
 351
 352   Emulate a fill-in form with -F. Let's say you fill in three fields in a
 353   form. One field is a file name which to post, one field is your name and one
 354   field is a file description. We want to post the file we have written named
 355   "cooltext.txt". To let curl do the posting of this data instead of your
 356   favourite browser, you have to read the HTML source of the form page and
 357   find the names of the input fields. In our example, the input field names
 358   are 'file', 'yourname' and 'filedescription'.
 359
 360         curl -F "file=@cooltext.txt" -F "yourname=Daniel" \
 361              -F "filedescription=Cool text file with cool text inside" \
 362              http://www.post.com/postit.cgi
 363
 364   To send two files in one post you can do it in two ways:
 365
 366   1. Send multiple files in a single "field" with a single field name:
 367
 368         curl -F "pictures=@dog.gif,cat.gif"
 369
 370   2. Send two fields with two field names:
 371
 372         curl -F "docpicture=@dog.gif" -F "catpicture=@cat.gif"
 373
 374   To send a field value literally without interpreting a leading '@'
 375   or '<', or an embedded ';type=', use --form-string instead of
 376   -F. This is recommended when the value is obtained from a user or
 377   some other unpredictable source. Under these circumstances, using
 378   -F instead of --form-string would allow a user to trick curl into
 379   uploading a file.
 380
 381 REFERRER
 382
 383   An HTTP request has the option to include information about which address
 384   referred it to the actual page.  Curl allows you to specify the
 385   referrer to be used on the command line. It is especially useful to
 386   fool or trick stupid servers or CGI scripts that rely on that information
 387   being available or contain certain data.
 388
 389         curl -e www.coolsite.com http://www.showme.com/
 390
 391   NOTE: The Referer: [sic] field is defined in the HTTP spec to be a full URL.
 392
 393 USER AGENT
 394
 395   An HTTP request has the option to include information about the browser
 396   that generated the request. Curl allows it to be specified on the command
 397   line. It is especially useful to fool or trick stupid servers or CGI
 398   scripts that only accept certain browsers.
 399
 400   Example:
 401
 402   curl -A 'Mozilla/3.0 (Win95; I)' http://www.nationsbank.com/
 403
 404   Other common strings:
 405     'Mozilla/3.0 (Win95; I)'     Netscape Version 3 for Windows 95
 406     'Mozilla/3.04 (Win95; U)'    Netscape Version 3 for Windows 95
 407     'Mozilla/2.02 (OS/2; U)'     Netscape Version 2 for OS/2
 408     'Mozilla/4.04 [en] (X11; U; AIX 4.2; Nav)'           NS for AIX
 409     'Mozilla/4.05 [en] (X11; U; Linux 2.0.32 i586)'      NS for Linux
 410
 411   Note that Internet Explorer tries hard to be compatible in every way:
 412     'Mozilla/4.0 (compatible; MSIE 4.01; Windows 95)'    MSIE for W95
 413
 414   Mozilla is not the only possible User-Agent name:
 415     'Konqueror/1.0'             KDE File Manager desktop client
 416     'Lynx/2.7.1 libwww-FM/2.14' Lynx command line browser
 417
 418 COOKIES
 419
 420   Cookies are generally used by web servers to keep state information at the
 421   client's side. The server sets cookies by sending a response line in the
 422   headers that looks like 'Set-Cookie: <data>' where the data part then
 423   typically contains a set of NAME=VALUE pairs (separated by semicolons ';'
 424   like "NAME1=VALUE1; NAME2=VALUE2;"). The server can also specify for what
 425   path the "cookie" should be used for (by specifying "path=value"), when the
 426   cookie should expire ("expire=DATE"), for what domain to use it
 427   ("domain=NAME") and if it should be used on secure connections only
 428   ("secure").
 429
 430   If you've received a page from a server that contains a header like:
 431         Set-Cookie: sessionid=boo123; path="/foo";
 432
 433   it means the server wants that first pair passed on when we get anything in
 434   a path beginning with "/foo".
 435
 436   Example, get a page that wants my name passed in a cookie:
 437
 438         curl -b "name=Daniel" www.sillypage.com
 439
 440   Curl also has the ability to use previously received cookies in following
 441   sessions. If you get cookies from a server and store them in a file in a
 442   manner similar to:
 443
 444         curl --dump-header headers www.example.com
 445
 446   ... you can then in a second connect to that (or another) site, use the
 447   cookies from the 'headers' file like:
 448
 449         curl -b headers www.example.com
 450
 451   While saving headers to a file is a working way to store cookies, it is
 452   however error-prone and not the preferred way to do this. Instead, make curl
 453   save the incoming cookies using the well-known netscape cookie format like
 454   this:
 455
 456         curl -c cookies.txt www.example.com
 457
 458   Note that by specifying -b you enable the "cookie awareness" and with -L
 459   you can make curl follow a location: (which often is used in combination
 460   with cookies). So that if a site sends cookies and a location, you can
 461   use a non-existing file to trigger the cookie awareness like:
 462
 463         curl -L -b empty.txt www.example.com
 464
 465   The file to read cookies from must be formatted using plain HTTP headers OR
 466   as netscape's cookie file. Curl will determine what kind it is based on the
 467   file contents.  In the above command, curl will parse the header and store
 468   the cookies received from www.example.com.  curl will send to the server the
 469   stored cookies which match the request as it follows the location.  The
 470   file "empty.txt" may be a nonexistent file.
 471
 472   To read and write cookies from a netscape cookie file, you can set both -b
 473   and -c to use the same file:
 474
 475         curl -b cookies.txt -c cookies.txt www.example.com
 476
 477 PROGRESS METER
 478
 479   The progress meter exists to show a user that something actually is
 480   happening. The different fields in the output have the following meaning:
 481
 482   % Total    % Received % Xferd  Average Speed          Time             Curr.
 483                                  Dload  Upload Total    Current  Left    Speed
 484   0  151M    0 38608    0     0   9406      0  4:41:43  0:00:04  4:41:39  9287
 485
 486   From left-to-right:
 487    %             - percentage completed of the whole transfer
 488    Total         - total size of the whole expected transfer
 489    %             - percentage completed of the download
 490    Received      - currently downloaded amount of bytes
 491    %             - percentage completed of the upload
 492    Xferd         - currently uploaded amount of bytes
 493    Average Speed
 494    Dload         - the average transfer speed of the download
 495    Average Speed
 496    Upload        - the average transfer speed of the upload
 497    Time Total    - expected time to complete the operation
 498    Time Current  - time passed since the invoke
 499    Time Left     - expected time left to completion
 500    Curr.Speed    - the average transfer speed the last 5 seconds (the first
 501                    5 seconds of a transfer is based on less time of course.)
 502
 503   The -# option will display a totally different progress bar that doesn't
 504   need much explanation!
 505
 506 SPEED LIMIT
 507
 508   Curl allows the user to set the transfer speed conditions that must be met
 509   to let the transfer keep going. By using the switch -y and -Y you
 510   can make curl abort transfers if the transfer speed is below the specified
 511   lowest limit for a specified time.
 512
 513   To have curl abort the download if the speed is slower than 3000 bytes per
 514   second for 1 minute, run:
 515
 516         curl -Y 3000 -y 60 www.far-away-site.com
 517
 518   This can very well be used in combination with the overall time limit, so
 519   that the above operation must be completed in whole within 30 minutes:
 520
 521         curl -m 1800 -Y 3000 -y 60 www.far-away-site.com
 522
 523   Forcing curl not to transfer data faster than a given rate is also possible,
 524   which might be useful if you're using a limited bandwidth connection and you
 525   don't want your transfer to use all of it (sometimes referred to as
 526   "bandwidth throttle").
 527
 528   Make curl transfer data no faster than 10 kilobytes per second:
 529
 530         curl --limit-rate 10K www.far-away-site.com
 531
 532     or
 533
 534         curl --limit-rate 10240 www.far-away-site.com
 535
 536   Or prevent curl from uploading data faster than 1 megabyte per second:
 537
 538         curl -T upload --limit-rate 1M ftp://uploadshereplease.com
 539
 540   When using the --limit-rate option, the transfer rate is regulated on a
 541   per-second basis, which will cause the total transfer speed to become lower
 542   than the given number. Sometimes of course substantially lower, if your
 543   transfer stalls during periods.
 544
 545 CONFIG FILE
 546
 547   Curl automatically tries to read the .curlrc file (or _curlrc file on win32
 548   systems) from the user's home dir on startup.
 549
 550   The config file could be made up with normal command line switches, but you
 551   can also specify the long options without the dashes to make it more
 552   readable. You can separate the options and the parameter with spaces, or
 553   with = or :. Comments can be used within the file. If the first letter on a
 554   line is a '#'-symbol the rest of the line is treated as a comment.
 555
 556   If you want the parameter to contain spaces, you must enclose the entire
 557   parameter within double quotes ("). Within those quotes, you specify a
 558   quote as \".
 559
 560   NOTE: You must specify options and their arguments on the same line.
 561
 562   Example, set default time out and proxy in a config file:
 563
 564         # We want a 30 minute timeout:
 565         -m 1800
 566         # ... and we use a proxy for all accesses:
 567         proxy = proxy.our.domain.com:8080
 568
 569   White spaces ARE significant at the end of lines, but all white spaces
 570   leading up to the first characters of each line are ignored.
 571
 572   Prevent curl from reading the default file by using -q as the first command
 573   line parameter, like:
 574
 575         curl -q www.thatsite.com
 576
 577   Force curl to get and display a local help page in case it is invoked
 578   without URL by making a config file similar to:
 579
 580         # default url to get
 581         url = "http://help.with.curl.com/curlhelp.html"
 582
 583   You can specify another config file to be read by using the -K/--config
 584   flag. If you set config file name to "-" it'll read the config from stdin,
 585   which can be handy if you want to hide options from being visible in process
 586   tables etc:
 587
 588         echo "user = user:passwd" | curl -K - http://that.secret.site.com
 589
 590 EXTRA HEADERS
 591
 592   When using curl in your own very special programs, you may end up needing
 593   to pass on your own custom headers when getting a web page. You can do
 594   this by using the -H flag.
 595
 596   Example, send the header "X-you-and-me: yes" to the server when getting a
 597   page:
 598
 599         curl -H "X-you-and-me: yes" www.love.com
 600
 601   This can also be useful in case you want curl to send a different text in a
 602   header than it normally does. The -H header you specify then replaces the
 603   header curl would normally send. If you replace an internal header with an
 604   empty one, you prevent that header from being sent. To prevent the Host:
 605   header from being used:
 606
 607         curl -H "Host:" www.server.com
 608
 609 FTP and PATH NAMES
 610
 611   Do note that when getting files with the ftp:// URL, the given path is
 612   relative the directory you enter. To get the file 'README' from your home
 613   directory at your ftp site, do:
 614
 615         curl ftp://user:passwd@my.site.com/README
 616
 617   But if you want the README file from the root directory of that very same
 618   site, you need to specify the absolute file name:
 619
 620         curl ftp://user:passwd@my.site.com//README
 621
 622   (I.e with an extra slash in front of the file name.)
 623
 624 SFTP and SCP and PATH NAMES
 625
 626   With sftp: and scp: URLs, the path name given is the absolute name on the
 627   server. To access a file relative to the remote user's home directory,
 628   prefix the file with /~/ , such as:
 629
 630         curl -u $USER sftp://home.example.com/~/.bashrc
 631
 632 FTP and firewalls
 633
 634   The FTP protocol requires one of the involved parties to open a second
 635   connection as soon as data is about to get transferred. There are two ways to
 636   do this.
 637
 638   The default way for curl is to issue the PASV command which causes the
 639   server to open another port and await another connection performed by the
 640   client. This is good if the client is behind a firewall that doesn't allow
 641   incoming connections.
 642
 643         curl ftp.download.com
 644
 645   If the server, for example, is behind a firewall that doesn't allow connections
 646   on ports other than 21 (or if it just doesn't support the PASV command), the
 647   other way to do it is to use the PORT command and instruct the server to
 648   connect to the client on the given IP number and port (as parameters to the
 649   PORT command).
 650
 651   The -P flag to curl supports a few different options. Your machine may have
 652   several IP-addresses and/or network interfaces and curl allows you to select
 653   which of them to use. Default address can also be used:
 654
 655         curl -P - ftp.download.com
 656
 657   Download with PORT but use the IP address of our 'le0' interface (this does
 658   not work on windows):
 659
 660         curl -P le0 ftp.download.com
 661
 662   Download with PORT but use 192.168.0.10 as our IP address to use:
 663
 664         curl -P 192.168.0.10 ftp.download.com
 665
 666 NETWORK INTERFACE
 667
 668   Get a web page from a server using a specified port for the interface:
 669
 670         curl --interface eth0:1 http://www.netscape.com/
 671
 672   or
 673
 674         curl --interface 192.168.1.10 http://www.netscape.com/
 675
 676 HTTPS
 677
 678   Secure HTTP requires SSL libraries to be installed and used when curl is
 679   built. If that is done, curl is capable of retrieving and posting documents
 680   using the HTTPS protocol.
 681
 682   Example:
 683
 684         curl https://www.secure-site.com
 685
 686   Curl is also capable of using your personal certificates to get/post files
 687   from sites that require valid certificates. The only drawback is that the
 688   certificate needs to be in PEM-format. PEM is a standard and open format to
 689   store certificates with, but it is not used by the most commonly used
 690   browsers (Netscape and MSIE both use the so called PKCS#12 format). If you
 691   want curl to use the certificates you use with your (favourite) browser, you
 692   may need to download/compile a converter that can convert your browser's
 693   formatted certificates to PEM formatted ones. This kind of converter is
 694   included in recent versions of OpenSSL, and for older versions Dr Stephen
 695   N. Henson has written a patch for SSLeay that adds this functionality. You
 696   can get his patch (that requires an SSLeay installation) from his site at:
 697   http://www.drh-consultancy.demon.co.uk/
 698
 699   Example on how to automatically retrieve a document using a certificate with
 700   a personal password:
 701
 702         curl -E /path/to/cert.pem:password https://secure.site.com/
 703
 704   If you neglect to specify the password on the command line, you will be
 705   prompted for the correct password before any data can be received.
 706
 707   Many older SSL-servers have problems with SSLv3 or TLS, which newer versions
 708   of OpenSSL etc use, therefore it is sometimes useful to specify what
 709   SSL-version curl should use. Use -3, -2 or -1 to specify that exact SSL
 710   version to use (for SSLv3, SSLv2 or TLSv1 respectively):
 711
 712         curl -2 https://secure.site.com/
 713
 714   Otherwise, curl will first attempt to use v3 and then v2.
 715
 716   To use OpenSSL to convert your favourite browser's certificate into a PEM
 717   formatted one that curl can use, do something like this:
 718
 719     In Netscape, you start with hitting the 'Security' menu button.
 720
 721     Select 'certificates->yours' and then pick a certificate in the list
 722
 723     Press the 'Export' button
 724
 725     enter your PIN code for the certs
 726
 727     select a proper place to save it
 728
 729     Run the 'openssl' application to convert the certificate. If you cd to the
 730     openssl installation, you can do it like:
 731
 732      # ./apps/openssl pkcs12 -in [file you saved] -clcerts -out [PEMfile]
 733
 734     In Firefox, select Options, then Advanced, then the Encryption tab,
 735     View Certificates. This opens the Certificate Manager, where you can
 736     Export. Be sure to select PEM for the Save as type.
 737
 738     In Internet Explorer, select Internet Options, then the Content tab, then
 739     Certificates. Then you can Export, and depending on the format you may
 740     need to convert to PEM.
 741
 742     In Chrome, select Settings, then Show Advanced Settings. Under HTTPS/SSL
 743     select Manage Certificates.
 744
 745 RESUMING FILE TRANSFERS
 746
 747  To continue a file transfer where it was previously aborted, curl supports
 748  resume on HTTP(S) downloads as well as FTP uploads and downloads.
 749
 750  Continue downloading a document:
 751
 752         curl -C - -o file ftp://ftp.server.com/path/file
 753
 754  Continue uploading a document(*1):
 755
 756         curl -C - -T file ftp://ftp.server.com/path/file
 757
 758  Continue downloading a document from a web server(*2):
 759
 760         curl -C - -o file http://www.server.com/
 761
 762  (*1) = This requires that the FTP server supports the non-standard command
 763         SIZE. If it doesn't, curl will say so.
 764
 765  (*2) = This requires that the web server supports at least HTTP/1.1. If it
 766         doesn't, curl will say so.
 767
 768 TIME CONDITIONS
 769
 770  HTTP allows a client to specify a time condition for the document it
 771  requests. It is If-Modified-Since or If-Unmodified-Since. Curl allows you to
 772  specify them with the -z/--time-cond flag.
 773
 774  For example, you can easily make a download that only gets performed if the
 775  remote file is newer than a local copy. It would be made like:
 776
 777         curl -z local.html http://remote.server.com/remote.html
 778
 779  Or you can download a file only if the local file is newer than the remote
 780  one. Do this by prepending the date string with a '-', as in:
 781
 782         curl -z -local.html http://remote.server.com/remote.html
 783
 784  You can specify a "free text" date as condition. Tell curl to only download
 785  the file if it was updated since January 12, 2012:
 786
 787         curl -z "Jan 12 2012" http://remote.server.com/remote.html
 788
 789  Curl will then accept a wide range of date formats. You always make the date
 790  check the other way around by prepending it with a dash '-'.
 791
 792 DICT
 793
 794   For fun try
 795
 796         curl dict://dict.org/m:curl
 797         curl dict://dict.org/d:heisenbug:jargon
 798         curl dict://dict.org/d:daniel:web1913
 799
 800   Aliases for 'm' are 'match' and 'find', and aliases for 'd' are 'define'
 801   and 'lookup'. For example,
 802
 803         curl dict://dict.org/find:curl
 804
 805   Commands that break the URL description of the RFC (but not the DICT
 806   protocol) are
 807
 808         curl dict://dict.org/show:db
 809         curl dict://dict.org/show:strat
 810
 811   Authentication is still missing (but this is not required by the RFC)
 812
 813 LDAP
 814
 815   If you have installed the OpenLDAP library, curl can take advantage of it
 816   and offer ldap:// support.
 817   On Windows, curl will use WinLDAP from Platform SDK by default.
 818
 819   Default protocol version used by curl is LDAPv3. LDAPv2 will be used as
 820   fallback mechanism in case if LDAPv3 will fail to connect.
 821
 822   LDAP is a complex thing and writing an LDAP query is not an easy task. I do
 823   advise you to dig up the syntax description for that elsewhere. One such
 824   place might be:
 825
 826   RFC 2255, "The LDAP URL Format" https://curl.haxx.se/rfc/rfc2255.txt
 827
 828   To show you an example, this is how I can get all people from my local LDAP
 829   server that has a certain sub-domain in their email address:
 830
 831         curl -B "ldap://ldap.frontec.se/o=frontec??sub?mail=*sth.frontec.se"
 832
 833   If I want the same info in HTML format, I can get it by not using the -B
 834   (enforce ASCII) flag.
 835
 836   You also can use authentication when accessing LDAP catalog:
 837
 838       curl -u user:passwd "ldap://ldap.frontec.se/o=frontec??sub?mail=*"
 839       curl "ldap://user:passwd@ldap.frontec.se/o=frontec??sub?mail=*"
 840
 841   By default, if user and password provided, OpenLDAP/WinLDAP will use basic
 842   authentication. On Windows you can control this behavior by providing
 843   one of --basic, --ntlm or --digest option in curl command line
 844
 845       curl --ntlm "ldap://user:passwd@ldap.frontec.se/o=frontec??sub?mail=*"
 846
 847   On Windows, if no user/password specified, auto-negotiation mechanism will
 848   be used with current logon credentials (SSPI/SPNEGO).
 849
 850 ENVIRONMENT VARIABLES
 851
 852   Curl reads and understands the following environment variables:
 853
 854         http_proxy, HTTPS_PROXY, FTP_PROXY
 855
 856   They should be set for protocol-specific proxies. General proxy should be
 857   set with
 858
 859         ALL_PROXY
 860
 861   A comma-separated list of host names that shouldn't go through any proxy is
 862   set in (only an asterisk, '*' matches all hosts)
 863
 864         NO_PROXY
 865
 866   If the host name matches one of these strings, or the host is within the
 867   domain of one of these strings, transactions with that node will not be
 868   proxied. When a domain is used, it needs to start with a period. A user can
 869   specify that both www.example.com and foo.example.com should not uses a
 870   proxy by setting NO_PROXY to ".example.com". By including the full name you
 871   can exclude specific host names, so to make www.example.com not use a proxy
 872   but still have foo.example.com do it, set NO_PROXY to "www.example.com"
 873
 874   The usage of the -x/--proxy flag overrides the environment variables.
 875
 876 NETRC
 877
 878   Unix introduced the .netrc concept a long time ago. It is a way for a user
 879   to specify name and password for commonly visited FTP sites in a file so
 880   that you don't have to type them in each time you visit those sites. You
 881   realize this is a big security risk if someone else gets hold of your
 882   passwords, so therefore most unix programs won't read this file unless it is
 883   only readable by yourself (curl doesn't care though).
 884
 885   Curl supports .netrc files if told to (using the -n/--netrc and
 886   --netrc-optional options). This is not restricted to just FTP,
 887   so curl can use it for all protocols where authentication is used.
 888
 889   A very simple .netrc file could look something like:
 890
 891         machine curl.haxx.se login iamdaniel password mysecret
 892
 893 CUSTOM OUTPUT
 894
 895   To better allow script programmers to get to know about the progress of
 896   curl, the -w/--write-out option was introduced. Using this, you can specify
 897   what information from the previous transfer you want to extract.
 898
 899   To display the amount of bytes downloaded together with some text and an
 900   ending newline:
 901
 902         curl -w 'We downloaded %{size_download} bytes\n' www.download.com
 903
 904 KERBEROS FTP TRANSFER
 905
 906   Curl supports kerberos4 and kerberos5/GSSAPI for FTP transfers. You need
 907   the kerberos package installed and used at curl build time for it to be
 908   available.
 909
 910   First, get the krb-ticket the normal way, like with the kinit/kauth tool.
 911   Then use curl in way similar to:
 912
 913         curl --krb private ftp://krb4site.com -u username:fakepwd
 914
 915   There's no use for a password on the -u switch, but a blank one will make
 916   curl ask for one and you already entered the real password to kinit/kauth.
 917
 918 TELNET
 919
 920   The curl telnet support is basic and very easy to use. Curl passes all data
 921   passed to it on stdin to the remote server. Connect to a remote telnet
 922   server using a command line similar to:
 923
 924         curl telnet://remote.server.com
 925
 926   And enter the data to pass to the server on stdin. The result will be sent
 927   to stdout or to the file you specify with -o.
 928
 929   You might want the -N/--no-buffer option to switch off the buffered output
 930   for slow connections or similar.
 931
 932   Pass options to the telnet protocol negotiation, by using the -t option. To
 933   tell the server we use a vt100 terminal, try something like:
 934
 935         curl -tTTYPE=vt100 telnet://remote.server.com
 936
 937   Other interesting options for it -t include:
 938
 939    - XDISPLOC=<X display> Sets the X display location.
 940
 941    - NEW_ENV=<var,val> Sets an environment variable.
 942
 943   NOTE: The telnet protocol does not specify any way to login with a specified
 944   user and password so curl can't do that automatically. To do that, you need
 945   to track when the login prompt is received and send the username and
 946   password accordingly.
 947
 948 PERSISTENT CONNECTIONS
 949
 950   Specifying multiple files on a single command line will make curl transfer
 951   all of them, one after the other in the specified order.
 952
 953   libcurl will attempt to use persistent connections for the transfers so that
 954   the second transfer to the same host can use the same connection that was
 955   already initiated and was left open in the previous transfer. This greatly
 956   decreases connection time for all but the first transfer and it makes a far
 957   better use of the network.
 958
 959   Note that curl cannot use persistent connections for transfers that are used
 960   in subsequence curl invokes. Try to stuff as many URLs as possible on the
 961   same command line if they are using the same host, as that'll make the
 962   transfers faster. If you use an HTTP proxy for file transfers, practically
 963   all transfers will be persistent.
 964
 965 MULTIPLE TRANSFERS WITH A SINGLE COMMAND LINE
 966
 967   As is mentioned above, you can download multiple files with one command line
 968   by simply adding more URLs. If you want those to get saved to a local file
 969   instead of just printed to stdout, you need to add one save option for each
 970   URL you specify. Note that this also goes for the -O option (but not
 971   --remote-name-all).
 972
 973   For example: get two files and use -O for the first and a custom file
 974   name for the second:
 975
 976     curl -O http://url.com/file.txt ftp://ftp.com/moo.exe -o moo.jpg
 977
 978   You can also upload multiple files in a similar fashion:
 979
 980     curl -T local1 ftp://ftp.com/moo.exe -T local2 ftp://ftp.com/moo2.txt
 981
 982 IPv6
 983
 984   curl will connect to a server with IPv6 when a host lookup returns an IPv6
 985   address and fall back to IPv4 if the connection fails. The --ipv4 and --ipv6
 986   options can specify which address to use when both are available. IPv6
 987   addresses can also be specified directly in URLs using the syntax:
 988
 989     http://[2001:1890:1112:1::20]/overview.html
 990
 991   When this style is used, the -g option must be given to stop curl from
 992   interpreting the square brackets as special globbing characters.  Link local
 993   and site local addresses including a scope identifier, such as fe80::1234%1,
 994   may also be used, but the scope portion must be numeric or match an existing
 995   network interface on Linux and the percent character must be URL escaped. The
 996   previous example in an SFTP URL might look like:
 997
 998     sftp://[fe80::1234%251]/
 999
1000   IPv6 addresses provided other than in URLs (e.g. to the --proxy, --interface
1001   or --ftp-port options) should not be URL encoded.
1002
1003 METALINK
1004
1005   Curl supports Metalink (both version 3 and 4 (RFC 5854) are supported), a way
1006   to list multiple URIs and hashes for a file. Curl will make use of the mirrors
1007   listed within for failover if there are errors (such as the file or server not
1008   being available). It will also verify the hash of the file after the download
1009   completes. The Metalink file itself is downloaded and processed in memory and
1010   not stored in the local file system.
1011
1012   Example to use a remote Metalink file:
1013
1014     curl --metalink http://www.example.com/example.metalink
1015
1016   To use a Metalink file in the local file system, use FILE protocol (file://):
1017
1018     curl --metalink file://example.metalink
1019
1020   Please note that if FILE protocol is disabled, there is no way to use a local
1021   Metalink file at the time of this writing. Also note that if --metalink and
1022   --include are used together, --include will be ignored. This is because including
1023   headers in the response will break Metalink parser and if the headers are included
1024   in the file described in Metalink file, hash check will fail.
1025
1026 MAILING LISTS
1027
1028   For your convenience, we have several open mailing lists to discuss curl,
1029   its development and things relevant to this. Get all info at
1030   https://curl.haxx.se/mail/. Some of the lists available are:
1031
1032   curl-users
1033
1034     Users of the command line tool. How to use it, what doesn't work, new
1035     features, related tools, questions, news, installations, compilations,
1036     running, porting etc.
1037
1038   curl-library
1039
1040     Developers using or developing libcurl. Bugs, extensions, improvements.
1041
1042   curl-announce
1043
1044     Low-traffic. Only receives announcements of new public versions. At worst,
1045     that makes something like one or two mails per month, but usually only one
1046     mail every second month.
1047
1048   curl-and-php
1049
1050     Using the curl functions in PHP. Everything curl with a PHP angle. Or PHP
1051     with a curl angle.
1052
1053   curl-and-python
1054
1055     Python hackers using curl with or without the python binding pycurl.
1056
1057   Please direct curl questions, feature requests and trouble reports to one of
1058   these mailing lists instead of mailing any individual.