luo980/curl
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

write-out.md: clarify error handling details

Browse Source 
- it gets used even if the transfer fails

- it does not cause error to be returned even if it fails

Closes #12909
This commit is contained in:
Daniel Stenberg 2024-02-08 23:41:50 +01:00
parent e7fd32b9ac
commit c54d0ff6b3
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
1 changed files with 15 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/cmdline-opts/write-out.md
View File

@ -18,10 +18,10 @@ Example:
# `--write-out`
Make curl display information on stdout after a completed transfer. The format
is a string that may contain plain text mixed with any number of
variables. The format can be specified as a literal "string", or you can have
curl read the format from a file with "@filename" and to tell curl to read the
format from stdin you write "@-".
is a string that may contain plain text mixed with any number of variables.
The format can be specified as a literal "string", or you can have curl read
the format from a file with "@filename" and to tell curl to read the format
from stdin you write "@-".
The variables present in the output format are substituted by the value or
text that curl thinks fit, as described below. All variables are specified as
@ -45,11 +45,17 @@ the file name cannot be created, curl leaves the output destination to the one
used prior to the *%output{}* instruction. Use *%output{\>\>name}* to append
data to an existing file.
**NOTE:**
In Windows the %-symbol is a special symbol used to expand environment
variables. In batch files all occurrences of % must be doubled when using this
option to properly escape. If this option is used at the command prompt then
the % cannot be escaped and unintended expansion is possible.
This output is done independently of if the file transfer was successful or
not.
If the specified action or output specified with this option fails in any way,
it will not make curl return a (different) error.
**NOTE:** On Windows, the %-symbol is a special symbol used to expand
environment variables. In batch files, all occurrences of % must be doubled
when using this option to properly escape. If this option is used at the
command prompt then the % cannot be escaped and unintended expansion is
possible.
The variables available are: