curl/docs/cmdline-opts/etag-compare.d

Long: etag-compare
Arg: <file>
Help: Pass an ETag from a file as a custom header
Protocols: HTTP
Added: 7.68.0
Category: http
Example: --etag-compare etag.txt $URL
See-also: etag-save time-cond
---
This option makes a conditional HTTP request for the specific ETag read
from the given file by sending a custom If-None-Match header using the
stored ETag.

For correct results, make sure that the specified file contains only a
single line with the desired ETag. An empty file is parsed as an empty
ETag.

Use the option --etag-save to first save the ETag from a response, and
then use this option to compare against the saved ETag in a subsequent
request.
curl: two new command line options for etags --etag-compare and --etag-save Suggested-by: Paul Hoffman Fixes #4277 Closes #4543 2019-10-30 11:43:14 +03:00			`Long: etag-compare`
			`Arg: <file>`
			`Help: Pass an ETag from a file as a custom header`
			`Protocols: HTTP`
docs: add "added: 7.68.0" to the --etag-* docs 2019-12-02 13:22:32 +03:00			`Added: 7.68.0`
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 15:15:04 +03: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 17:37:14 +03:00			`Example: --etag-compare etag.txt $URL`
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 17:58:20 +03:00			`See-also: etag-save time-cond`
curl: two new command line options for etags --etag-compare and --etag-save Suggested-by: Paul Hoffman Fixes #4277 Closes #4543 2019-10-30 11:43:14 +03:00			`---`
docs: make the documentation for --etag-save match the program behaviour When using curl with the option `--etag-save` I expected it to save the ETag without its surrounding quotes, as stated by the documentation in the repository and by the generated man pages. My first endeavour was to fix the program, but while investigating the history of the relevant parts, I discovered that curl once saved the ETag without the quotes. This was undone by Daniel Stenberg in commit `98c94596f5928840177b6bd3c7b0f0dd03a431af`, therefore I decided that in this case the documentation should be adjusted to match the behaviour of curl. The changed save behaviour also made parts of the `--etag-compare` documentation wrong or superfluous, so I adjusted those accordingly. Closes #7429 2021-07-18 11:42:54 +03:00			`This option makes a conditional HTTP request for the specific ETag read`
			`from the given file by sending a custom If-None-Match header using the`
			`stored ETag.`
curl: two new command line options for etags --etag-compare and --etag-save Suggested-by: Paul Hoffman Fixes #4277 Closes #4543 2019-10-30 11:43:14 +03:00
docs: make the documentation for --etag-save match the program behaviour When using curl with the option `--etag-save` I expected it to save the ETag without its surrounding quotes, as stated by the documentation in the repository and by the generated man pages. My first endeavour was to fix the program, but while investigating the history of the relevant parts, I discovered that curl once saved the ETag without the quotes. This was undone by Daniel Stenberg in commit `98c94596f5928840177b6bd3c7b0f0dd03a431af`, therefore I decided that in this case the documentation should be adjusted to match the behaviour of curl. The changed save behaviour also made parts of the `--etag-compare` documentation wrong or superfluous, so I adjusted those accordingly. Closes #7429 2021-07-18 11:42:54 +03:00			`For correct results, make sure that the specified file contains only a`
			`single line with the desired ETag. An empty file is parsed as an empty`
			`ETag.`
curl: two new command line options for etags --etag-compare and --etag-save Suggested-by: Paul Hoffman Fixes #4277 Closes #4543 2019-10-30 11:43:14 +03:00
			`Use the option --etag-save to first save the ETag from a response, and`
docs: make the documentation for --etag-save match the program behaviour When using curl with the option `--etag-save` I expected it to save the ETag without its surrounding quotes, as stated by the documentation in the repository and by the generated man pages. My first endeavour was to fix the program, but while investigating the history of the relevant parts, I discovered that curl once saved the ETag without the quotes. This was undone by Daniel Stenberg in commit `98c94596f5928840177b6bd3c7b0f0dd03a431af`, therefore I decided that in this case the documentation should be adjusted to match the behaviour of curl. The changed save behaviour also made parts of the `--etag-compare` documentation wrong or superfluous, so I adjusted those accordingly. Closes #7429 2021-07-18 11:42:54 +03:00			`then use this option to compare against the saved ETag in a subsequent`
			`request.`