curl/docs/cmdline-opts/referer.d

c: Copyright (C) 1998 - 2022, Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Long: referer
Short: e
Arg: <URL>
Protocols: HTTP
Help: Referrer URL
See-also: user-agent header
Category: http
Example: --referer "https://fake.example" $URL
Example: --referer "https://fake.example;auto" -L $URL
Example: --referer ";auto" -L $URL
Added: 4.0
Multi: single
---
Sends the "Referrer Page" information to the HTTP server. This can also be set
with the --header flag of course. When used with --location you can append
";auto" to the --referer URL to make curl automatically set the previous URL
when it follows a Location: header. The ";auto" string can be used alone,
even if you do not set an initial --referer.
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`
cmdline-docs: more options converted over 2016-11-16 06:44:58 +08:00			`Long: referer`
cmdline-docs: more options converted and fixed Now all options are in the new system. 2016-11-28 08:01:13 +08:00			`Short: e`
cmdline-opts: added some missing info 2016-12-17 05:01:01 +08:00			`Arg: <URL>`
cmdline-docs: more options converted over 2016-11-16 06:44:58 +08:00			`Protocols: HTTP`
cmdline-opts: fixed a few typos 2017-03-11 18:44:06 +08:00			`Help: Referrer URL`
cmdline-docs: more options converted over 2016-11-16 06:44:58 +08:00			`See-also: user-agent header`
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: http`
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: --referer "https://fake.example" $URL`
			`Example: --referer "https://fake.example;auto" -L $URL`
			`Example: --referer ";auto" -L $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: 4.0`
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: single`
cmdline-docs: more options converted over 2016-11-16 06:44:58 +08:00			`---`
			`Sends the "Referrer Page" information to the HTTP server. This can also be set`
docs: address proselint nits - avoid exclamation marks - use consistent number of spaces after periods: one - avoid clichés - avoid using 'very' Closes #8060 2021-11-26 15:46:59 +08:00			`with the --header flag of course. When used with --location you can append`
cmdline-docs: more options converted over 2016-11-16 06:44:58 +08:00			`";auto" to the --referer URL to make curl automatically set the previous URL`
docs/cmdline-opts: remove \& escapes from all .d files gen.pl escapes them itself now 2022-08-23 19:42:49 +08:00			`when it follows a Location: header. The ";auto" string can be used alone,`
docs: reduce/avoid English contractions You're => You are Hasn't => Has not Doesn't => Does not Don't => Do not You'll => You will etc Closes #7930 2021-10-31 23:34:44 +08:00			`even if you do not set an initial --referer.`