curl/docs/cmdline-opts/fail-with-body.d

c: Copyright (C) Daniel Stenberg, <daniel@haxx.se>, et al.
SPDX-License-Identifier: curl
Long: fail-with-body
Protocols: HTTP
Help: Fail on HTTP errors but save the body
Category: http output
Added: 7.76.0
See-also: fail
Mutexed: fail
Example: --fail-with-body $URL
Multi: boolean
---
Return an error on server errors where the HTTP response code is 400 or
greater). In normal cases when an HTTP server fails to deliver a document, it
returns an HTML document stating so (which often also describes why and
more). This flag will still allow curl to output and save that content but
also to return error 22.

This is an alternative option to --fail which makes curl fail for the same
circumstances but without saving the content.
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`
curl: add --fail-with-body Prevent both --fail and --fail-with-body on the same command line. Verify with test 349, 360 and 361. Closes #6449 2021-02-11 15:30:39 +08:00			`Long: fail-with-body`
			`Protocols: HTTP`
			`Help: Fail on HTTP errors but save the body`
			`Category: http output`
			`Added: 7.76.0`
			`See-also: fail`
docs/cmdline: mark fail and fail-with-body as mutually exclusive Reported-by: Andreas Sommer Fixes #9221 Closes #9222 2022-07-29 03:02:45 +08:00			`Mutexed: fail`
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: --fail-with-body $URL`
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: boolean`
curl: add --fail-with-body Prevent both --fail and --fail-with-body on the same command line. Verify with test 349, 360 and 361. Closes #6449 2021-02-11 15:30:39 +08:00			`---`
			`Return an error on server errors where the HTTP response code is 400 or`
			`greater). In normal cases when an HTTP server fails to deliver a document, it`
			`returns an HTML document stating so (which often also describes why and`
docs: fix typo in fail-with-body doc This commit fixes a small typo in the documentation for the --fail-with-body flag. Closes https://github.com/curl/curl/pull/6977 2021-04-27 23:53:39 +08:00			`more). This flag will still allow curl to output and save that content but`
curl: add --fail-with-body Prevent both --fail and --fail-with-body on the same command line. Verify with test 349, 360 and 361. Closes #6449 2021-02-11 15:30:39 +08:00			`also to return error 22.`

			`This is an alternative option to --fail which makes curl fail for the same`
			`circumstances but without saving the content.`