host names\b:hostnames
file name\b:filename
file names\b:filenames
-user name\b:username
-user names\b:usernames
+\buser name\b:username
+\buser names\b:usernames
didn't:did not
doesn't:does not
won't:will not
- uses: actions/checkout@v2
- name: check
- run: ./.github/scripts/badwords.pl < .github/scripts/badwords.txt docs/*.md docs/libcurl/*.md docs/libcurl/opts/*.md
+ run: ./.github/scripts/badwords.pl < .github/scripts/badwords.txt docs/*.md docs/libcurl/*.md docs/libcurl/opts/*.md docs/cmdline-opts/*.md
% make
% make install
- If `make install` results in `Permission denied` error, you will need to prepend it with `sudo`.
+ If `make install` results in `Permission denied` error, you need to prepend
+ it with `sudo`.
# OpenSSL version
% make
% make install
- If `make install` results in `Permission denied` error, you will need to prepend it with `sudo`.
+ If `make install` results in `Permission denied` error, you need to prepend
+ it with `sudo`.
# msh3 (msquic) version
please use the one or the ones that suit you the most.
Each mailing list has hundreds up to thousands of readers, meaning that each
- mail sent will be received and read by a large number of people. People
- from various cultures, regions, religions and continents.
+ mail sent is received and read by a large number of people. People from
+ various cultures, regions, religions and continents.
1.2 Netiquette
Netiquette is a common term for how to behave on the Internet. Of course, in
- each particular group and subculture there will be differences in what is
+ each particular group and subculture there are differences in what is
acceptable and what is considered good manners.
This document outlines what we in the curl project consider to be good
through to all the subscribers.
If you post without being subscribed (or from a different mail address than
- the one you are subscribed with), your mail will simply be silently
- discarded. You have to subscribe first, then post.
+ the one you are subscribed with), your mail is simply silently discarded.
+ You have to subscribe first, then post.
The reason for this unfortunate and strict subscription policy is of course
to stop spam from pestering the lists.
1.5 Moderation of new posters
Several of the curl mailing lists automatically make all posts from new
- subscribers be moderated. This means that after you have subscribed and
- sent your first mail to a list, that mail will not be let through to the
- list until a mailing list administrator has verified that it is OK and
- permits it to get posted.
+ subscribers be moderated. After you have subscribed and sent your first mail
+ to a list, that mail is not let through to the list until a mailing list
+ administrator has verified that it is OK and permits it to get posted.
Once a first post has been made that proves the sender is actually talking
- about curl-related subjects, the moderation "flag" will be switched off and
- future posts will go through without being moderated.
+ about curl-related subjects, the moderation "flag" is switched off and
+ future posts go through without being moderated.
The reason for this moderation policy is that we do suffer from spammers who
actually subscribe and send spam to our lists.
1.6 Handling trolls and spam
Despite our good intentions and hard work to keep spam off the lists and to
- maintain a friendly and positive atmosphere, there will be times when spam
- and or trolls get through.
+ maintain a friendly and positive atmosphere, there are times when spam and
+ or trolls get through.
Troll - "someone who posts inflammatory, extraneous, or off-topic messages
in an online community"
No matter what, we NEVER EVER respond to trolls or spammers on the list. If
you believe the list admin should do something in particular, contact them
- off-list. The subject will be taken care of as much as possible to prevent
- repeated offenses, but responding on the list to such messages never leads to
- anything good and only puts the light even more on the offender: which was
- the entire purpose of it getting sent to the list in the first place.
+ off-list. The subject is taken care of as much as possible to prevent
+ repeated offenses, but responding on the list to such messages never leads
+ to anything good and only puts the light even more on the offender: which
+ was the entire purpose of it getting sent to the list in the first place.
Do not feed the trolls.
1.8 I posted, now what?
If you are not subscribed with the same email address that you used to send
- the email, your post will just be silently discarded.
+ the email, your post is silently discarded.
If you posted for the first time to the mailing list, you first need to wait
for an administrator to allow your email to go through (moderated). This
what you did with details enough to allow others to help point out the
problem or repeat the steps in their locations.
- Failing to include details will only delay responses and make people respond
- and ask for more details and you will have to send a follow-up email that
- includes them.
+ Failing to include details only delays responses and make people respond and
+ ask for more details and you have to send follow-up emails that include
+ them.
Expect the responses to primarily help YOU debug the issue, or ask YOU
questions that can lead you or others towards a solution or explanation to
whatever you experience.
If you are a repeat offender to the guidelines outlined in this document,
- chances are that people will ignore you at will and your chances to get
- responses in the future will greatly diminish.
+ chances are that people ignore you and your chances to get responses in the
+ future greatly diminish.
1.9 Your emails are public
Your email, its contents and all its headers and the details in those
- headers will be received by every subscriber of the mailing list that you
- send your email to.
+ headers are received by every subscriber of the mailing list that you send
+ your email to.
- Your email as sent to a curl mailing list will end up in mail archives, on
- the curl website and elsewhere, for others to see and read. Today and in
- the future. In addition to the archives, the mail is sent out to thousands
- of individuals. There is no way to undo a sent email.
+ Your email as sent to a curl mailing list ends up in mail archives, on the
+ curl website and elsewhere, for others to see and read. Today and in the
+ future. In addition to the archives, the mail is sent out to thousands of
+ individuals. There is no way to undo a sent email.
When sending emails to a curl mailing list, do not include sensitive
information such as user names and passwords; use fake ones, temporary ones
certificates need to be stored as individual PEM files in this directory.
You may need to run c_rehash after adding files there.
- If neither of the two options is specified, configure will try to
- auto-detect a setting. It's also possible to explicitly not set any
- default store but rely on the built in default the crypto library may
- provide instead. You can achieve that by passing both
- `--without-ca-bundle` and `--without-ca-path` to the configure script.
+ If neither of the two options is specified, configure tries to auto-detect
+ a setting. It's also possible to explicitly not set any default store but
+ rely on the built in default the crypto library may provide instead. You
+ can achieve that by passing both `--without-ca-bundle` and
+ `--without-ca-path` to the configure script.
If you use Internet Explorer, this is one way to get extract the CA cert
for a particular server:
- `openssl s_client -showcerts -servername server -connect server:443 > cacert.pem`
- type "quit", followed by the "ENTER" key
- - The certificate will have "BEGIN CERTIFICATE" and "END CERTIFICATE"
- markers.
+ - The certificate has `BEGIN CERTIFICATE` and `END CERTIFICATE` markers.
- If you want to see the data in the certificate, you can do: `openssl
x509 -inform PEM -in certfile -text -out certdata` where `certfile` is
the cert you extracted from logfile. Look in `certdata`.
Schannel then you can specify your own CA cert file by setting the
environment variable `CURL_CA_BUNDLE` to the path of your choice.
- If you are using the curl command line tool on Windows, curl will search
- for a CA cert file named "curl-ca-bundle.crt" in these directories and in
- this order:
+ If you are using the curl command line tool on Windows, curl searches for
+ a CA cert file named "curl-ca-bundle.crt" in these directories and in this
+ order:
1. application's directory
2. current working directory
3. Windows System directory (e.g. C:\windows\system32)
## Option files
Each command line option is described in a file named `<long name>.d`, where
-option name is written without any prefixing dashes. Like the file name for
-the `-v, --verbose` option is named `verbose.d`.
+option name is written without any prefixing dashes. Like the filename for the
+`-v, --verbose` option is named `verbose.d`.
Each file has a set of meta-data in the top of the file, followed by a body of
text.
Sets the proxy server to use if no protocol-specific proxy is set.
## `NO_PROXY` <comma-separated list of hosts/domains>
-list of host names that should not go through any proxy. If set to an asterisk
-'*' only, it matches all hosts. Each name in this list is matched as either
-a domain name which contains the hostname, or the hostname itself.
+list of hostnames that should not go through any proxy. If set to an asterisk
+'*' only, it matches all hosts. Each name in this list is matched as either a
+domain name which contains the hostname, or the hostname itself.
This environment variable disables use of the proxy even when specified with
the --proxy option. That is
accesses the target URL through the proxy.
-The list of host names can also be include numerical IP addresses, and IPv6
+The list of hostnames can also be include numerical IP addresses, and IPv6
versions should then be given without enclosing brackets.
IP addresses can be specified using CIDR notation: an appended slash and
If set, it is used as the --cacert value. This environment variable is ignored
if Schannel is used as the TLS backend.
-## `SSLKEYLOGFILE` <file name>
-If you set this environment variable to a file name, curl stores TLS secrets
+## `SSLKEYLOGFILE` <filename>
+If you set this environment variable to a filename, curl stores TLS secrets
from its connections in that file when invoked to enable you to analyze the
TLS traffic in real time using network analyzing tools such as Wireshark. This
works with the following TLS backends: OpenSSL, libressl, BoringSSL, GnuTLS
## 66
Failed to initialize SSL Engine.
## 67
-The user name, password, or similar was not accepted and curl failed to log in.
+The username, password, or similar was not accepted and curl failed to log in.
## 68
File not found on TFTP server.
## 69
If you provide a URL without a leading **protocol://** scheme, curl guesses
what protocol you want. It then defaults to HTTP but assumes others based on
-often-used host name prefixes. For example, for host names starting with
-`ftp.` curl assumes you want FTP.
+often-used hostname prefixes. For example, for hostnames starting with `ftp.`
+curl assumes you want FTP.
You can specify any amount of URLs on the command line. They are fetched in a
sequential manner in the specified order unless you use --parallel. You can
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Long: alt-svc
-Arg: <file name>
+Arg: <filename>
Protocols: HTTPS
Help: Enable alt-svc with this cache file
Added: 7.64.1
# `--alt-svc`
-This option enables the alt-svc parser in curl. If the file name points to an
+This option enables the alt-svc parser in curl. If the filename points to an
existing alt-svc cache file, that gets used. After a completed transfer, the
-cache is saved to the file name again if it has been modified.
+cache is saved to the filename again if it has been modified.
-Specify a "" file name (zero length) to avoid loading/saving and make curl
-just handle the cache in memory.
+Specify a "" filename (zero length) to avoid loading/saving and make curl just
+handle the cache in memory.
If this option is used several times, curl loads contents from all the
files but the last one is used for saving.
7) Non-Windows: use getpwuid to find the home directory
8) On Windows, if it finds no *.curlrc* file in the sequence described above, it
-checks for one in the same dir the curl executable is placed.
+checks for one in the same directory the curl executable is placed.
On Windows two filenames are checked per location: *.curlrc* and *_curlrc*,
preferring the former. Older versions on Windows checked for *_curlrc* only.
operation. Curl writes all cookies from its in-memory cookie storage to the
given file at the end of operations. If no cookies are known, no data is
written. The file is created using the Netscape cookie file format. If you set
-the file name to a single dash, "-", the cookies are written to stdout.
+the filename to a single dash, "-", the cookies are written to stdout.
The file specified with --cookie-jar is only used for output. No cookies are
read from the file. To read cookies, use the --cookie option. Both options
using this in combination with the --location option or do multiple URL
transfers on the same invoke.
-If the file name is exactly a minus ("-"), curl instead reads the contents from
-stdin. If the file name is an empty string ("") and is the only cookie input,
-curl will activate the cookie engine without any cookies.
+If the filename is exactly a minus ("-"), curl instead reads the contents from
+stdin. If the filename is an empty string ("") and is the only cookie input,
+curl activates the cookie engine without any cookies.
The file format of the file to read cookies from should be plain HTTP headers
(Set-Cookie style) or the Netscape/Mozilla cookie file format.
When used in conjunction with the --output option, curl creates the necessary
local directory hierarchy as needed. This option creates the directories
mentioned with the --output option combined with the path possibly set with
---output-dir. If the combined output file name uses no directory, or if the
+--output-dir. If the combined output filename uses no directory, or if the
directories it mentions already exist, no directories are created.
Created directories are made with mode 0750 on unix style file systems.
'-d name=daniel -d skill=lousy' would generate a post chunk that looks like
'name=daniel&skill=lousy'.
-If you start the data with the letter @, the rest should be a file name to
-read the data from, or - if you want curl to read the data from stdin. Posting
-data from a file named 'foobar' would thus be done with --data @foobar. When
---data is told to read from a file like that, carriage returns and newlines
-are stripped out. If you do not want the @ character to have a special
+If you start the data with the letter @, the rest should be a filename to read
+the data from, or - if you want curl to read the data from stdin. Posting data
+from a file named 'foobar' would thus be done with --data @foobar. When --data
+is told to read from a file like that, carriage returns and newlines are
+stripped out. If you do not want the @ character to have a special
interpretation use --data-raw instead.
The data for this option is passed on to the server exactly as provided on the
Enables HTTP Digest authentication. This is an authentication scheme that
prevents the password from being sent over the wire in clear text. Use this in
-combination with the normal --user option to set user name and password.
+combination with the normal --user option to set username and password.
SPDX-License-Identifier: curl
Long: doh-url
Arg: <URL>
-Help: Resolve host names over DoH
+Help: Resolve hostnames over DoH
Added: 7.62.0
Category: dns
Multi: single
When curl is used to do multiple transfers on the command line, it attempts to
operate on each given URL, one by one. By default, it ignores errors if there
are more URLs given and the last URL's success determines the error code curl
-returns. So early failures are "hidden" by subsequent successful transfers.
+returns. Early failures are "hidden" by subsequent successful transfers.
Using this option, curl instead returns an error on the first transfer that
fails, independent of the amount of URLs that are given on the command
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Long: form-escape
-Help: Escape multipart form field/file names using backslash
+Help: Escape multipart form field/filenames using backslash
Protocols: HTTP
Added: 7.81.0
Category: http upload
message to transmit.
This enables uploading of binary files etc. To force the 'content' part to be
-a file, prefix the file name with an @ sign. To just get the content part from
-a file, prefix the file name with the symbol \<. The difference between @ and
-< is then that @ makes a file get attached in the post as a file upload, while
+a file, prefix the filename with an @ sign. To just get the content part from
+a file, prefix the filename with the symbol \<. The difference between @ and <
+is then that @ makes a file get attached in the post as a file upload, while
the \< makes a text field and just get the contents for that text field from a
file.
# `--ftp-account`
-When an FTP server asks for "account data" after user name and password has
+When an FTP server asks for "account data" after username and password has
been provided, this data is sent off using the ACCT command.
## IP address
e.g. **192.168.10.1** to specify the exact IP address
-## host name
+## hostname
e.g. **my.host.domain** to specify the machine
## -
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Long: hsts
-Arg: <file name>
+Arg: <filename>
Protocols: HTTPS
Help: Enable HSTS with this cache file
Added: 7.74.0
# `--hsts`
-This option enables HSTS for the transfer. If the file name points to an
-existing HSTS cache file, that is used. After a completed transfer, the
-cache is saved to the file name again if it has been modified.
+This option enables HSTS for the transfer. If the filename points to an
+existing HSTS cache file, that is used. After a completed transfer, the cache
+is saved to the filename again if it has been modified.
-If curl is told to use HTTP:// for a transfer involving a host name that
-exists in the HSTS cache, it upgrades the transfer to use HTTPS. Each HSTS
-cache entry has an individual life time after which the upgrade is no longer
+If curl is told to use HTTP:// for a transfer involving a hostname that exists
+in the HSTS cache, it upgrades the transfer to use HTTPS. Each HSTS cache
+entry has an individual life time after which the upgrade is no longer
performed.
-Specify a "" file name (zero length) to avoid loading/saving and make curl
-just handle HSTS in memory.
+Specify a "" filename (zero length) to avoid loading/saving and make curl just
+handle HSTS in memory.
If this option is used several times, curl loads contents from all the
files but the last one is used for saving.
When this option is not used for protocols using TLS, curl verifies the
server's TLS certificate before it continues: that the certificate contains
-the right name which matches the host name used in the URL and that the
-certificate has been signed by a CA certificate present in the cert store.
-See this online resource for further details:
+the right name which matches the hostname used in the URL and that the
+certificate has been signed by a CA certificate present in the cert store. See
+this online resource for further details:
**https://curl.se/docs/sslcerts.html**
For SFTP and SCP, this option makes curl skip the *known_hosts* verification.
*known_hosts* is a file normally stored in the user's home directory in the
-".ssh" subdirectory, which contains host names and their public keys.
+".ssh" subdirectory, which contains hostnames and their public keys.
**WARNING**: using this option makes the transfer insecure.
# `--interface`
Perform an operation using a specified interface. You can enter interface
-name, IP address or host name. An example could look like:
+name, IP address or hostname. An example could look like:
curl --interface eth0:1 https://www.example.com/
# `--ipfs-gateway`
-Specify which gateway to use for IPFS and IPNS URLs. Not specifying this will
-instead make curl check if the IPFS_GATEWAY environment variable is set, or if
-a `~/.ipfs/gateway` file holding the gateway URL exists.
+Specify which gateway to use for IPFS and IPNS URLs. Not specifying this
+instead makes curl check if the IPFS_GATEWAY environment variable is set, or
+if a `~/.ipfs/gateway` file holding the gateway URL exists.
If you run a local IPFS node, this gateway is by default available under
`http://localhost:8080`. A full example URL would look like:
There are many public IPFS gateways. See for example:
https://ipfs.github.io/public-gateway-checker/
-WARNING: If you opt to go for a remote gateway you should be aware that you
-completely trust the gateway. This is fine in local gateways as you host it
-yourself. With remote gateways there could potentially be a malicious actor
+If you opt to go for a remote gateway you need to be aware that you completely
+trust the gateway. This might be fine in local gateways that you host
+yourself. With remote gateways there could potentially be malicious actors
returning you data that does not match the request you made, inspect or even
-interfere with the request. You will not notice this when using curl. A
+interfere with the request. You may not notice this when using curl. A
mitigation could be to go for a "trustless" gateway. This means you locally
verify that the data. Consult the docs page on trusted vs trustless:
https://docs.ipfs.tech/reference/http/gateway/#trusted-vs-trustless
# `--ipv4`
-This option tells curl to use IPv4 addresses only when resolving host names,
+This option tells curl to use IPv4 addresses only when resolving hostnames,
and not for example try IPv6.
# `--ipv6`
-This option tells curl to use IPv6 addresses only when resolving host names,
+This option tells curl to use IPv6 addresses only when resolving hostnames,
and not for example try IPv4.
There is **no verification** that the passed in data is actual JSON or that
the syntax is correct.
-If you start the data with the letter @, the rest should be a file name to
-read the data from, or a single dash (-) if you want curl to read the data
-from stdin. Posting data from a file named 'foobar' would thus be done with
---json @foobar and to instead read the data from stdin, use --json @-.
+If you start the data with the letter @, the rest should be a filename to read
+the data from, or a single dash (-) if you want curl to read the data from
+stdin. Posting data from a file named 'foobar' would thus be done with --json
+@foobar and to instead read the data from stdin, use --json @-.
If this option is used more than once on the same command line, the additional
data pieces are concatenated to the previous before sending.
Long: key
Arg: <key>
Protocols: TLS SSH
-Help: Private key file name
+Help: Private key filename
Category: tls ssh
Added: 7.9.3
Multi: single
# `--key`
-Private key file name. Allows you to provide your private key in this separate
+Private key filename. Allows you to provide your private key in this separate
file. For SSH, if not specified, curl tries the following candidates in order:
`~/.ssh/id_rsa`, `~/.ssh/id_dsa`, `./id_rsa`, `./id_dsa`.
include sub-directories and symbolic links.
(SFTP)
-When listing an SFTP directory, this switch forces a name-only view, one per line.
-This is especially useful if the user wants to machine-parse the contents of an
-SFTP directory since the normal directory view provides more information than just
-file names.
+When listing an SFTP directory, this switch forces a name-only view, one per
+line. This is especially useful if the user wants to machine-parse the
+contents of an SFTP directory since the normal directory view provides more
+information than just filenames.
(POP3)
When retrieving a specific email from POP3, this switch forces a LIST command
# `--mail-rcpt`
-Specify a single email address, user name or mailing list name. Repeat this
+Specify a single email address, username or mailing list name. Repeat this
option several times to send to multiple recipients.
-When performing an address verification (**VRFY** command), the recipient should be
-specified as the user name or user name and domain (as per Section 3.5 of
-RFC 5321). (Added in 7.34.0)
+When performing an address verification (**VRFY** command), the recipient
+should be specified as the username or username and domain (as per Section 3.5
+of RFC 5321). (Added in 7.34.0)
When performing a mailing list expand (EXPN command), the recipient should be
specified using the mailing list name, such as "Friends" or "London-Office".
--version to see if your curl supports GSS-API/SSPI or SPNEGO.
When using this option, you must also provide a fake --user option to activate
-the authentication code properly. Sending a '-u :' is enough as the user name
+the authentication code properly. Sending a '-u :' is enough as the username
and password from the --user option are not actually used.
SPDX-License-Identifier: curl
Long: netrc
Short: n
-Help: Must read .netrc for user name and password
+Help: Must read .netrc for username and password
Category: curl
Added: 4.6
Mutexed: netrc-file netrc-optional
only.
A quick and simple example of how to setup a *.netrc* to allow curl to FTP to
-the machine host.domain.com with user name 'myself' and password 'secret'
-could look similar to:
+the machine host.domain.com with username 'myself' and password 'secret' could
+look similar to:
machine host.domain.com
login myself
Tells curl to use a separate operation for the following URL and associated
options. This allows you to send several URL requests, each with their own
-specific options, for example, such as different user names or custom requests
+specific options, for example, such as different usernames or custom requests
for each.
--next resets all local options and only global ones have their values survive
# `--oauth2-bearer`
Specify the Bearer Token for OAUTH 2.0 server authentication. The Bearer Token
-is used in conjunction with the user name which can be specified as part of
-the --url or --user options.
+is used in conjunction with the username which can be specified as part of the
+--url or --user options.
-The Bearer Token and user name are formatted according to RFC 6750.
+The Bearer Token and username are formatted according to RFC 6750.
Write output to the given file instead of stdout. If you are using globbing to
fetch multiple documents, you should quote the URL and you can use `#`
-followed by a number in the file name. That variable is then replaced with the
+followed by a number in the filename. That variable is then replaced with the
current string for the URL being fetched. Like in:
curl "http://{one,two}.example.com" -o "file_#1.txt"
This option does not change the default proxy protocol (http).
-Without this option set, curl guesses protocol based on the host name, see
+Without this option set, curl guesses protocol based on the hostname, see
--url for details.
See-also:
- proxy-pass
Example:
- - --proxy-user name:pwd -x proxy $URL
+ - --proxy-user smith:secret -x proxy $URL
---
# `--proxy-user`
-Specify the user name and password to use for proxy authentication.
+Specify the username and password to use for proxy authentication.
If you use a Windows SSPI-enabled curl binary and do either Negotiate or NTLM
-authentication then you can tell curl to select the user name and password
-from your environment by specifying a single colon with this option: "-U :".
+authentication then you can tell curl to select the username and password from
+your environment by specifying a single colon with this option: "-U :".
On systems where it works, curl hides the given option argument from process
listings. This is not enough to protect credentials from possibly getting seen
Long: pubkey
Arg: <key>
Protocols: SFTP SCP
-Help: SSH Public key file name
+Help: SSH Public key filename
Category: sftp scp auth
Added: 7.16.2
Multi: single
# `--pubkey`
-Public key file name. Allows you to provide your public key in this separate
+Public key filename. Allows you to provide your public key in this separate
file.
curl attempts to automatically extract the public key from the private key
servers, or one of the commands listed below to SFTP servers.
SFTP is a binary protocol. Unlike for FTP, curl interprets SFTP quote commands
-itself before sending them to the server. File names may be quoted
-shell-style to embed spaces or special characters. Following is the list of
-all supported SFTP quote commands:
+itself before sending them to the server. Filenames may be quoted shell-style
+to embed spaces or special characters. Following is the list of all supported
+SFTP quote commands:
## atime date file
The atime command sets the last access time of the file named by the file
This option tells the --remote-name option to use the server-specified
Content-Disposition filename instead of extracting a filename from the URL. If
-the server-provided file name contains a path, that is stripped off before the
-file name is used.
+the server-provided filename contains a path, that is stripped off before the
+filename is used.
The file is saved in the current directory, or in the directory specified with
--output-dir.
-If the server specifies a file name and a file with that name already exists
-in the destination directory, it is not overwritten and an error occurs -
-unless you allow it by using the --clobber option. If the server does not
-specify a file name then this option has no effect.
+If the server specifies a filename and a file with that name already exists in
+the destination directory, it is not overwritten and an error occurs - unless
+you allow it by using the --clobber option. If the server does not specify a
+filename then this option has no effect.
-There is no attempt to decode %-sequences (yet) in the provided file name, so
-this option may provide you with rather unexpected file names.
+There is no attempt to decode %-sequences (yet) in the provided filename, so
+this option may provide you with rather unexpected filenames.
This feature uses the name from the `filename` field, it does not yet support
the `filename*` field (filenames with explicit character sets).
c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Long: remote-name-all
-Help: Use the remote file name for all URLs
+Help: Use the remote filename for all URLs
Added: 7.19.0
Category: output
Multi: boolean
# `--remote-name-all`
This option changes the default action for all given URLs to be dealt with as
-if --remote-name were used for each one. So if you want to disable that for a
+if --remote-name were used for each one. If you want to disable that for a
specific URL after --remote-name-all has been used, you must use "-o -" or
--no-remote-name.
in a different directory, make sure you change the current working directory
before invoking curl with this option or use --output-dir.
-The remote file name to use for saving is extracted from the given URL,
-nothing else, and if it already exists it is overwritten. If you want the
-server to be able to choose the file name refer to --remote-header-name which
-can be used in addition to this option. If the server chooses a file name and
-that name already exists it is not overwritten.
+The remote filename to use for saving is extracted from the given URL, nothing
+else, and if it already exists it is overwritten. If you want the server to be
+able to choose the filename refer to --remote-header-name which can be used in
+addition to this option. If the server chooses a filename and that name
+already exists it is not overwritten.
-There is no URL decoding done on the file name. If it has %20 or other URL
-encoded parts of the name, they end up as-is as file name.
+There is no URL decoding done on the filename. If it has %20 or other URL
+encoded parts of the name, they end up as-is as filename.
You may use this option as many times as the number of URLs you have.
*PUT* requests are rather invoked by using dedicated command line options.
This option only changes the actual word used in the HTTP request, it does not
-alter the way curl behaves. So for example if you want to make a proper HEAD
+alter the way curl behaves. For example if you want to make a proper HEAD
request, using -X HEAD does not suffice. You need to use the --head option.
The method string you set with --request is used for all requests, which
This option is the "sledgehammer" of retrying. Do not use this option by
default (for example in your **curlrc**), there may be unintended consequences
such as sending or receiving duplicate data. Do not use with redirected input
-or output. You'd be much better off handling your unique problems in shell
+or output. You might be better off handling your unique problems in a shell
script. Please read the example below.
**WARNING**: For server compatibility curl attempts to retry failed flaky
# `--socks4`
Use the specified SOCKS4 proxy. If the port number is not specified, it is
-assumed at port 1080. Using this socket type make curl resolve the host name
+assumed at port 1080. Using this socket type make curl resolve the hostname
and passing the address on to the proxy.
To specify proxy on a unix domain socket, use localhost for host, e.g.
# `--socks4a`
Use the specified SOCKS4a proxy. If the port number is not specified, it is
-assumed at port 1080. This asks the proxy to resolve the host name.
+assumed at port 1080. This asks the proxy to resolve the hostname.
To specify proxy on a unix domain socket, use localhost for host, e.g.
`socks4a://localhost/path/to/socket.sock`
SPDX-License-Identifier: curl
Long: socks5-hostname
Arg: <host[:port]>
-Help: SOCKS5 proxy, pass host name to proxy
+Help: SOCKS5 proxy, pass hostname to proxy
Added: 7.18.0
Category: proxy
Multi: single
# `--socks5-hostname`
-Use the specified SOCKS5 proxy (and let the proxy resolve the host name). If
+Use the specified SOCKS5 proxy (and let the proxy resolve the hostname). If
the port number is not specified, it is assumed at port 1080.
To specify proxy on a unix domain socket, use localhost for host, e.g.
# `--socks5`
-Use the specified SOCKS5 proxy - but resolve the host name locally. If the
+Use the specified SOCKS5 proxy - but resolve the hostname locally. If the
port number is not specified, it is assumed at port 1080.
To specify proxy on a unix domain socket, use localhost for host, e.g.
# `--stderr`
-Redirect all writes to stderr to the specified file instead. If the file name
+Redirect all writes to stderr to the specified file instead. If the filename
is a plain '-', it is instead written to stdout.
SPDX-License-Identifier: curl
Long: tlsuser
Arg: <name>
-Help: TLS user name
+Help: TLS username
Added: 7.21.4
Protocols: TLS
Category: tls auth
for untrained humans.
Note that verbose output of curl activities and network traffic might contain
-sensitive data, including user names, credentials or secret data content. Be
+sensitive data, including usernames, credentials or secret data content. Be
aware and be careful when sharing trace logs with others.
stderr.
Note that verbose output of curl activities and network traffic might contain
-sensitive data, including user names, credentials or secret data content. Be
+sensitive data, including usernames, credentials or secret data content. Be
aware and be careful when sharing trace logs with others.
If there is no file part in the specified URL, curl appends the local file
name to the end of the URL before the operation starts. You must use a
trailing slash (/) on the last directory to prove to curl that there is no
-file name or curl thinks that your last directory name is the remote file name
+filename or curl thinks that your last directory name is the remote filename
to use.
-When putting the local file name at the end of the URL, curl ignores what is
-on the left side of any slash (/) or backslash (\) used in the file name and
-only appends what is on the right side of the rightmost such character.
+When putting the local filename at the end of the URL, curl ignores what is on
+the left side of any slash (/) or backslash (\) used in the filename and only
+appends what is on the right side of the rightmost such character.
-Use the file name `-` (a single dash) to use stdin instead of a given file.
-Alternately, the file name `.` (a single period) may be specified instead of
+Use the filename `-` (a single dash) to use stdin instead of a given file.
+Alternately, the filename `.` (a single period) may be specified instead of
`-` to use stdin in non-blocking mode to allow reading server output while
stdin is being uploaded.
-If this option is used with a HTTP(S) URL, the PUT method is used.
+If this option is used with an HTTP(S) URL, the PUT method is used.
You can specify one --upload-file for each URL on the command line. Each
--upload-file + URL pair specifies what to upload and to where. curl also
# `--user`
-Specify the user name and password to use for server authentication. Overrides
+Specify the username and password to use for server authentication. Overrides
--netrc and --netrc-optional.
-If you simply specify the user name, curl prompts for a password.
+If you simply specify the username, curl prompts for a password.
-The user name and passwords are split up on the first colon, which makes it
-impossible to use a colon in the user name with this option. The password can,
+The username and passwords are split up on the first colon, which makes it
+impossible to use a colon in the username with this option. The password can,
still.
On systems where it works, curl hides the given option argument from process
similar and never used in clear text in a command line.
When using Kerberos V5 with a Windows based server you should include the
-Windows domain name in the user name, in order for the server to successfully
+Windows domain name in the username, in order for the server to successfully
obtain a Kerberos Ticket. If you do not, then the initial authentication
handshake may fail.
-When using NTLM, the user name can be specified simply as the user name,
-without the domain, if there is a single domain and forest in your setup
-for example.
+When using NTLM, the username can be specified simply as the username, without
+the domain, if there is a single domain and forest in your setup for example.
To specify the domain name use either Down-Level Logon Name or UPN (User
Principal Name) formats. For example, EXAMPLE\user and user@example.com
respectively.
If you use a Windows SSPI-enabled curl binary and perform Kerberos V5,
-Negotiate, NTLM or Digest authentication then you can tell curl to select
-the user name and password from your environment by specifying a single colon
-with this option: "-u :".
+Negotiate, NTLM or Digest authentication then you can tell curl to select the
+username and password from your environment by specifying a single colon with
+this option: "-u :".
--trace or --trace-ascii instead.
Note that verbose output of curl activities and network traffic might contain
-sensitive data, including user names, credentials or secret data content. Be
+sensitive data, including usernames, credentials or secret data content. Be
aware and be careful when sharing trace logs with others.
and trailing whitespace trimmed (added in 7.84.0).
Select a specific target destination file to write the output to, by using
-*%output{name}* (added in curl 8.3.0) where *name* is the full file name. The
+*%output{name}* (added in curl 8.3.0) where *name* is the full filename. The
output following that instruction is then written to that file. More than one
*%output{}* instruction can be specified in the same write-out argument. If
-the file name cannot be created, curl leaves the output destination to the one
+the filename cannot be created, curl leaves the output destination to the one
used prior to the *%output{}* instruction. Use *%output{\>\>name}* to append
data to an existing file.
not.
If the specified action or output specified with this option fails in any way,
-it will not make curl return a (different) error.
+it does not make curl return a (different) error.
**NOTE:** On Windows, the %-symbol is a special symbol used to expand
environment variables. In batch files, all occurrences of % must be doubled
## `filename_effective`
The ultimate filename that curl writes out to. This is only meaningful if curl
-is told to write to a file with the --remote-name or --output
-option. It's most useful in combination with the --remote-header-name
-option. (Added in 7.26.0)
+is told to write to a file with the --remote-name or --output option. It is
+most useful in combination with the --remote-header-name option. (Added in
+7.26.0)
## `ftp_entry_path`
The initial path curl ended up in when logging on to the remote FTP
{" --abstract-unix-socket <path>",
"Connect via abstract Unix domain socket",
CURLHELP_CONNECTION},
- {" --alt-svc <file name>",
+ {" --alt-svc <filename>",
"Enable alt-svc with this cache file",
CURLHELP_HTTP},
{" --anyauth",
"Allow insecure DoH server connections",
CURLHELP_DNS | CURLHELP_TLS},
{" --doh-url <URL>",
- "Resolve host names over DoH",
+ "Resolve hostnames over DoH",
CURLHELP_DNS},
{"-D, --dump-header <filename>",
"Write the received headers to <filename>",
"Specify multipart MIME data",
CURLHELP_HTTP | CURLHELP_UPLOAD},
{" --form-escape",
- "Escape multipart form field/file names using backslash",
+ "Escape multipart form field/filenames using backslash",
CURLHELP_HTTP | CURLHELP_UPLOAD},
{" --form-string <name=string>",
"Specify multipart MIME data",
{" --hostpubsha256 <sha256>",
"Acceptable SHA256 hash of the host public key",
CURLHELP_SFTP | CURLHELP_SCP},
- {" --hsts <file name>",
+ {" --hsts <filename>",
"Enable HSTS with this cache file",
CURLHELP_HTTP},
{" --http0.9",
"Interval time for keepalive probes",
CURLHELP_CONNECTION},
{" --key <key>",
- "Private key file name",
+ "Private key filename",
CURLHELP_TLS | CURLHELP_SSH},
{" --key-type <type>",
"Private key file type (DER/PEM/ENG)",
"Use HTTP Negotiate (SPNEGO) authentication",
CURLHELP_AUTH | CURLHELP_HTTP},
{"-n, --netrc",
- "Must read .netrc for user name and password",
+ "Must read .netrc for username and password",
CURLHELP_CURL},
{" --netrc-file <filename>",
"Specify FILE for netrc",
"Operate through an HTTP proxy tunnel (using CONNECT)",
CURLHELP_PROXY},
{" --pubkey <key>",
- "SSH Public key file name",
+ "SSH Public key filename",
CURLHELP_SFTP | CURLHELP_SCP | CURLHELP_AUTH},
{"-Q, --quote <command>",
"Send command(s) to server before transfer",
"Write output to a file named as the remote file",
CURLHELP_IMPORTANT | CURLHELP_OUTPUT},
{" --remote-name-all",
- "Use the remote file name for all URLs",
+ "Use the remote filename for all URLs",
CURLHELP_OUTPUT},
{"-R, --remote-time",
"Set the remote file's time on the local output",
"SOCKS5 proxy service name for GSS-API",
CURLHELP_PROXY | CURLHELP_AUTH},
{" --socks5-hostname <host[:port]>",
- "SOCKS5 proxy, pass host name to proxy",
+ "SOCKS5 proxy, pass hostname to proxy",
CURLHELP_PROXY},
{"-Y, --speed-limit <speed>",
"Stop transfers slower than this",
"TLS password",
CURLHELP_TLS | CURLHELP_AUTH},
{" --tlsuser <name>",
- "TLS user name",
+ "TLS username",
CURLHELP_TLS | CURLHELP_AUTH},
{"-1, --tlsv1",
"Use TLSv1.0 or greater",
projects / thirdparty / curl.git / commitdiff
