curl/docs
Jay Satiro 65ca229461 tool_writeout: refactor write-out and write-out json
- Deduplicate the logic used by write-out and write-out json.

Rather than have separate writeLong, writeString, etc, logic for
each of write-out and write-out json instead have respective shared
functions that can output either format and a 'use_json' parameter to
indicate whether it is json that is output.

This will make it easier to maintain. Rather than have to go through
two sets of logic now we only have to go through one.

- Support write-out %{errormsg} and %{exitcode} in json.

- Clarify in the doc that %{exitcode} is the exit code of the transfer.

Prior to this change it just said "The numerical exitcode" which
implies it's the exit code of the tool, and it's not necessarily that.

Closes https://github.com/curl/curl/pull/6544
2021-02-09 02:48:27 -05:00
..
cmdline-opts tool_writeout: refactor write-out and write-out json 2021-02-09 02:48:27 -05:00
examples examples/curlgtk.c: fix the copyright year range 2020-12-30 22:37:44 +01:00
libcurl CURLOPT_QUOTE.3: clarify that libcurl doesn't parse what's sent 2021-02-08 22:35:50 +01:00
.gitignore
ALTSVC.md alt-svc: enable by default 2020-10-25 23:08:54 +01:00
BINDINGS.md
BUG-BOUNTY.md BUG-BOUNTY: removed the cooperation mention 2021-02-03 14:24:25 +01:00
BUGS.md curl.se: new home 2020-11-04 23:59:47 +01:00
CHECKSRC.md
CIPHERS.md curl.se: new home 2020-11-04 23:59:47 +01:00
CMakeLists.txt curl.se: new home 2020-11-04 23:59:47 +01:00
CODE_OF_CONDUCT.md
CODE_REVIEW.md docs: Fix some typos 2020-12-12 09:59:28 -08:00
CODE_STYLE.md docs: enable syntax highlighting in several docs files 2020-12-11 18:06:41 +01:00
CONTRIBUTE.md curl.se: new home 2020-11-04 23:59:47 +01:00
CURL-DISABLE.md alt-svc: enable by default 2020-10-25 23:08:54 +01:00
DEPRECATE.md
DYNBUF.md docs: enable syntax highlighting in several docs files 2020-12-11 18:06:41 +01:00
ECH.md curl.se: new home 2020-11-04 23:59:47 +01:00
EXPERIMENTAL.md EXPERIMENTAL: add the Hyper backend to the list 2020-12-22 17:17:59 +01:00
FAQ misc: assorted typo fixes 2020-12-26 23:54:25 +01:00
FEATURES.md docs/FEATURE: convert to markdown 2020-10-15 15:47:38 +02:00
GOVERNANCE.md
HELP-US.md docs: Fix some typos 2020-12-12 09:59:28 -08:00
HISTORY.md HISTORY: added dates to early history 2021-01-03 16:27:51 +01:00
HSTS.md hsts: add support for Strict-Transport-Security 2020-11-03 16:08:42 +01:00
HTTP-COOKIES.md curl.se: new home 2020-11-04 23:59:47 +01:00
HTTP2.md docs: Fix some typos 2020-12-12 09:59:28 -08:00
HTTP3.md travis: enable quiche's FFI feature 2021-02-01 13:13:12 +00:00
HYPER.md misc: fix typos 2021-01-11 15:12:25 +01:00
INSTALL
INSTALL.cmake
INSTALL.md INSTALL.md: fix typo 2021-01-20 22:45:12 +01:00
INTERNALS.md language: s/behaviour/behavior/g 2021-01-02 23:35:59 +01:00
KNOWN_BUGS KNOWN_BUGS: cmake: ExternalProject_Add does not set CURL_CA_PATH 2021-01-28 09:27:41 +01:00
MAIL-ETIQUETTE curl.se: new home 2020-11-04 23:59:47 +01:00
MANUAL.md docs: fix FILE example url in --metalink documentation 2021-02-05 13:34:12 +01:00
MQTT.md
Makefile.am docs: add HYPER.md 2020-12-18 09:58:03 +01:00
NEW-PROTOCOL.md docs: fix typos in NEW-PROTOCOL.md 2021-01-17 12:56:03 +01:00
PARALLEL-TRANSFERS.md
README.md curl.se: new home 2020-11-04 23:59:47 +01:00
RELEASE-PROCEDURE.md RELEASE-PROCEDURE: remove old release dates, add new 2021-02-08 14:04:05 +01:00
ROADMAP.md ROADMAP: refreshed 2021-01-14 09:49:17 +01:00
SECURITY-PROCESS.md SECURITY-PROCESS: disclose on hackerone 2020-12-03 22:29:34 +01:00
SSL-PROBLEMS.md docs/SSL-PROBLEMS: enhanced 2021-02-05 23:56:47 +01:00
SSLCERTS.md curl.se: new home 2020-11-04 23:59:47 +01:00
THANKS THANKS: remove a Jon Rumsey dupe 2021-02-05 13:43:26 +01:00
THANKS-filter mailmap: Jon Rumsey 2021-02-05 08:46:11 +01:00
TODO TODO: remove items for next SONAME bump etc 2021-02-02 08:46:37 +01:00
TheArtOfHttpScripting.md docs: enable syntax highlighting in several docs files 2020-12-11 18:06:41 +01:00
URL-SYNTAX.md URL-SYNTAX: add gophers details 2020-12-15 12:58:19 +01:00
VERSIONS.md docs: enable syntax highlighting in several docs files 2020-12-11 18:06:41 +01:00
curl-config.1 curl.se: new home 2020-11-04 23:59:47 +01:00
mk-ca-bundle.1 curl.se: new home 2020-11-04 23:59:47 +01:00
options-in-versions docs: add AWS HTTP v4 Signature 2020-12-21 16:28:03 +01:00

README.md

curl logo

Documentation

You'll find a mix of various documentation in this directory and subdirectories, using several different formats. Some of them are not ideal for reading directly in your browser.

If you'd rather see the rendered version of the documentation, check out the curl website's documentation section for general curl stuff or the libcurl section for libcurl related documentation.