quickjs-tart

quickjs-based runtime for wallet-core logic
Log | Files | Refs | README | LICENSE

MANUAL.md (36330B)


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