curl/docs/cmdline-opts/url.d

c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Long: url
Arg: <url>
Help: URL to work with
Category: curl
Example: --url $URL
Added: 7.5
See-also: next config
Multi: append
---
Specify a URL to fetch. This option is mostly handy when you want to specify
URL(s) in a config file.

If the given URL is missing a scheme name (such as "http://" or "ftp://" etc)
then curl will make a guess based on the host. If the outermost sub-domain
name matches DICT, FTP, IMAP, LDAP, POP3 or SMTP then that protocol will be
used, otherwise HTTP will be used. Since 7.45.0 guessing can be disabled by
setting a default protocol, see --proto-default for details.

To control where this URL is written, use the --output or the --remote-name
options.

**WARNING**: On Windows, particular file:// accesses can be converted to
network accesses by the operating system. Beware!
docs/cmdline-opts: add copyright and license identifier to each file gen.pl now insists on C: and SPDX-License-Identifier: fields to be present in all files. Closes #9002 2022-06-14 06:12:03 +08:00			`c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al.`
			`SPDX-License-Identifier: curl`
docs: fix cmdline-opts metadata headers case consistency. Almost all headers start with an uppercase letter, but some didn't. 2018-05-28 20:16:27 +08:00			`Long: url`
cmdline-docs: more options converted and fixed Now all options are in the new system. 2016-11-28 08:01:13 +08:00			`Arg: <url>`
			`Help: URL to work with`
docs: add categories to all cmdline opts Adapted gen.pl with 'listcats' This commit is a part of "--help me if you can" Closes #5680 2020-07-13 20:15:04 +08:00			`Category: curl`
curl.1: provide examples for each option The file format for each option now features a "Example:" header that can provide one or more examples that get rendered appropriately in the output. All options MUST have at least one example or gen.pl complains at build-time. This fix also does a few other minor format and consistency cleanups. Closes #7654 2021-08-31 22:37:14 +08:00			`Example: --url $URL`
cmdline-opts: made the 'Added:' field mandatory Since "too old" versions are no longer included in the generated man page, this field is now mandatory so that it won't be forgotten and then not included in the documentation. Closes #7786 2021-09-28 17:50:07 +08:00			`Added: 7.5`
curl.1: require "see also" for every documented option gen.pl now generates a warning if the "See Also" field is not filled in for a command line option All command line options now provide one or more related options. 167 "See alsos" added! Closes #8019 2021-11-15 22:58:20 +08:00			`See-also: next config`
cmdline/docs: add a required 'multi' keyword for each option The keyword specifies how option works when specified multiple times: - single: the last provided value replaces the earlier ones - append: it supports being provided multiple times - boolean: on/off values - mutex: flag-like option that disable anoter flag The 'gen.pl' script then outputs the proper and unified language for each option's multi-use behavior in the generated man page. The multi: header is requires in each .d file and will cause build error if missing or set to an unknown value. Closes #9759 2022-10-18 16:39:43 +08:00			`Multi: append`
cmdline-docs: more options converted and fixed Now all options are in the new system. 2016-11-28 08:01:13 +08:00			`---`
			`Specify a URL to fetch. This option is mostly handy when you want to specify`
			`URL(s) in a config file.`

			`If the given URL is missing a scheme name (such as "http://" or "ftp://" etc)`
			`then curl will make a guess based on the host. If the outermost sub-domain`
			`name matches DICT, FTP, IMAP, LDAP, POP3 or SMTP then that protocol will be`
			`used, otherwise HTTP will be used. Since 7.45.0 guessing can be disabled by`
			`setting a default protocol, see --proto-default for details.`

cmdline/docs: add a required 'multi' keyword for each option The keyword specifies how option works when specified multiple times: - single: the last provided value replaces the earlier ones - append: it supports being provided multiple times - boolean: on/off values - mutex: flag-like option that disable anoter flag The 'gen.pl' script then outputs the proper and unified language for each option's multi-use behavior in the generated man page. The multi: header is requires in each .d file and will cause build error if missing or set to an unknown value. Closes #9759 2022-10-18 16:39:43 +08:00			`To control where this URL is written, use the --output or the --remote-name`
			`options.`
docs: add warnings about FILE: URLs on Windows - --url man page section - libcurl-security.3 gets the full text - CURLOPT_URL.3 Reported-by: Tim Sedlmeyer 2020-03-09 21:59:21 +08:00
curl.1: provide examples for each option The file format for each option now features a "Example:" header that can provide one or more examples that get rendered appropriately in the output. All options MUST have at least one example or gen.pl complains at build-time. This fix also does a few other minor format and consistency cleanups. Closes #7654 2021-08-31 22:37:14 +08:00			`WARNING: On Windows, particular file:// accesses can be converted to`
			`network accesses by the operating system. Beware!`