curl/docs/cmdline-opts/dump-header.d

c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Long: dump-header
Short: D
Arg: <filename>
Help: Write the received headers to <filename>
Protocols: HTTP FTP
See-also: output
Category: http ftp
Example: --dump-header store.txt $URL
Added: 5.7
Multi: single
---
Write the received protocol headers to the specified file. If no headers are
received, the use of this option will create an empty file.

When used in FTP, the FTP server response lines are considered being "headers"
and thus are saved there.

Having multiple transfers in one set of operations (i.e. the URLs in one
--next clause), will append them to the same file, separated by a blank line.
copyright: update all copyright lines and remove year ranges - they are mostly pointless in all major jurisdictions - many big corporations and projects already don't use them - saves us from pointless churn - git keeps history for us - the year range is kept in COPYING checksrc is updated to allow non-year using copyright statements Closes #10205 2023-01-02 20:51:48 +08:00			`c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.`
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			`SPDX-License-Identifier: curl`
cmdline-docs: more options converted over 2016-11-16 06:44:58 +08:00			`Long: dump-header`
			`Short: D`
			`Arg: <filename>`
			`Help: Write the received headers to <filename>`
			`Protocols: HTTP FTP`
			`See-also: output`
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 ftp`
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: --dump-header store.txt $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: 5.7`
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			`---`
dump-header.d: Drop suggestion to use for cookie storage Since --cookie-jar is the preferred way to store cookies, no longer suggest using --dump-header to do so. Co-authored-by: Daniel Stenberg Closes https://github.com/curl/curl/issues/7414 2021-07-19 01:11:14 +08:00			`Write the received protocol headers to the specified file. If no headers are`
			`received, the use of this option will create an empty file.`
dump-header.d: spell out that no headers == empty file [ci skip] Reported-by: wesinator at github Fixes #3964 Closes #3974 2019-06-01 05:09:54 +08:00
cmdline-docs: more options converted over 2016-11-16 06:44:58 +08:00			`When used in FTP, the FTP server response lines are considered being "headers"`
			`and thus are saved there.`
docs: extend the dump-header documentation This commit extends the documentation of the --dump-header command-line option to reflect the behavior introduced in 8b1e5df7. See #10079 Closes #10085 2022-12-13 02:44:35 +08:00
			`Having multiple transfers in one set of operations (i.e. the URLs in one`
misc: fix grammar and spelling Closes #10137 2022-12-22 22:22:11 +08:00			`--next clause), will append them to the same file, separated by a blank line.`