summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBatuhan Taskaya <isidentical@gmail.com>2022-05-05 21:17:37 +0300
committerGitHub <noreply@github.com>2022-05-05 11:17:37 -0700
commitf9b5c2f69696e370bf3ed63307311d97ca66a151 (patch)
tree3edde80fe37fd182e3511bbbb68d971eb8fe30e4
parent76495cbdecc44d9dd2f4aa4196f2e2b9040890c5 (diff)
Man page fixes (#1364)
- Highlighting for options (-x, --x) now doesn't strip the prefix (may be whitespace). - Escape sequences are now cross-platform compatible (directly taken by groff/troff [man's renderer]) - Now we check for the section before displaying the man pages. - On MacOS, there is HTTP(n) which is different from our HTTP(1). This used to conflict with it, and we showed the wrong page. Now we specifically ask foir HTTP(1). - Errors that might happen (e.g non executable man command) is now suppressed. So in the worst case (if anything regarding man execution goes wrong), we'll always display the manual. - Docs for man pages. - HTTPie man pages. - Epilog for the man pages (see also) - Auto-generated comments.
-rw-r--r--docs/README.md2
-rw-r--r--extras/man/http.1162
-rw-r--r--extras/man/httpie.112
-rw-r--r--extras/man/https.1162
-rw-r--r--extras/scripts/generate_man_pages.py63
-rw-r--r--httpie/cli/definition.py5
-rw-r--r--httpie/cli/options.py18
-rw-r--r--httpie/manager/cli.py10
-rw-r--r--httpie/output/ui/man_pages.py32
-rw-r--r--httpie/output/ui/rich_help.py11
-rw-r--r--httpie/output/ui/rich_palette.py2
-rw-r--r--httpie/output/ui/rich_utils.py4
-rw-r--r--setup.py1
13 files changed, 280 insertions, 204 deletions
diff --git a/docs/README.md b/docs/README.md
index f714db6f..dd8424de 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -279,7 +279,7 @@ Synopsis:
$ http [flags] [METHOD] URL [ITEM [ITEM]]
```
-See also `http --help`.
+See also `http --help` (and for systems where man pages are available, you can use `man http`).
### Examples
diff --git a/extras/man/http.1 b/extras/man/http.1
index 2a0b450d..3cf7b702 100644
--- a/extras/man/http.1
+++ b/extras/man/http.1
@@ -1,3 +1,4 @@
+.\" This file is auto-generated from the parser declaration in httpie/cli/definition.py by extras/scripts/generate_man_pages.py.
.TH http 1 "2022-03-08" "HTTPie 3.1.1.dev0" "HTTPie Manual"
.SH NAME
http
@@ -6,7 +7,7 @@ http [METHOD] URL [REQUEST_ITEM ...]
.SH DESCRIPTION
HTTPie: modern, user-friendly command-line HTTP client for the API era. <https://httpie.io>
-.SH Positional Arguments
+.SH Positional arguments
These arguments come after any flags and in the order they are listed here.
Only URL is required.
@@ -27,8 +28,8 @@ is some data to be sent, otherwise GET:
.IP "\fB\,URL\/\fR"
-The request URL. Scheme defaults to \'http://\' if the URL
-does not include one. (You can override this with:\fB\,--default-scheme\/\fR=http/https)
+The request URL. Scheme defaults to \[aq]http://\[aq] if the URL
+does not include one. (You can override this with: \fB\,--default-scheme\/\fR=http/https)
You can also use a shorthand for localhost
@@ -43,44 +44,44 @@ You can also use a shorthand for localhost
Optional key-value pairs to be included in the request. The separator used
determines the type:
-\':\' HTTP headers:
+\[aq]:\[aq] HTTP headers:
Referer:https://httpie.io Cookie:foo=bar User-Agent:bacon/1.0
-\'==\' URL parameters to be appended to the request URI:
+\[aq]==\[aq] URL parameters to be appended to the request URI:
search==httpie
-\'=\' Data fields to be serialized into a JSON object (with\fB\,--json\/\fR,\fB\,-j\/\fR)
- or form data (with\fB\,--form\/\fR,\fB\,-f\/\fR):
+\[aq]=\[aq] Data fields to be serialized into a JSON object (with \fB\,--json\/\fR, \fB\,-j\/\fR)
+ or form data (with \fB\,--form\/\fR, \fB\,-f\/\fR):
- name=HTTPie language=Python description=\'CLI HTTP client\'
+ name=HTTPie language=Python description=\[aq]CLI HTTP client\[aq]
-\':=\' Non-string JSON data fields (only with\fB\,--json\/\fR,\fB\,-j\/\fR):
+\[aq]:=\[aq] Non-string JSON data fields (only with \fB\,--json\/\fR, \fB\,-j\/\fR):
- awesome:=true amount:=42 colors:=\'["red", "green", "blue"]\'
+ awesome:=true amount:=42 colors:=\[aq][\[dq]red\[dq], \[dq]green\[dq], \[dq]blue\[dq]]\[aq]
-\'@\' Form file fields (only with\fB\,--form\/\fR or\fB\,--multipart\/\fR):
+\[aq]@\[aq] Form file fields (only with \fB\,--form\/\fR or \fB\,--multipart\/\fR):
- cv@\~/Documents/CV.pdf
- cv@\'\~/Documents/CV.pdf;type=application/pdf\'
+ cv@\(ti/Documents/CV.pdf
+ cv@\[aq]\(ti/Documents/CV.pdf;type=application/pdf\[aq]
-\'=@\' A data field like \'=\', but takes a file path and embeds its content:
+\[aq]=@\[aq] A data field like \[aq]=\[aq], but takes a file path and embeds its content:
essay=@Documents/essay.txt
-\':=@\' A raw JSON field like \':=\', but takes a file path and embeds its content:
+\[aq]:=@\[aq] A raw JSON field like \[aq]:=\[aq], but takes a file path and embeds its content:
package:=@./package.json
You can use a backslash to escape a colliding separator in the field name:
- field-name-with\\:colon=value
+ field-name-with\e:colon=value
.PP
-.SH Predefined Content Types
+.SH Predefined content types
.IP "\fB\,--json\/\fR, \fB\,-j\/\fR"
@@ -104,13 +105,13 @@ multipart/form-data request.
.IP "\fB\,--multipart\/\fR"
-Similar to\fB\,--form\/\fR, but always sends a multipart/form-data request (i.e., even without files).
+Similar to \fB\,--form\/\fR, but always sends a multipart/form-data request (i.e., even without files).
.IP "\fB\,--boundary\/\fR"
-Specify a custom boundary string for multipart/form-data requests. Only has effect only together with\fB\,--form\/\fR.
+Specify a custom boundary string for multipart/form-data requests. Only has effect only together with \fB\,--form\/\fR.
.IP "\fB\,--raw\/\fR"
@@ -119,7 +120,7 @@ Specify a custom boundary string for multipart/form-data requests. Only has effe
This option allows you to pass raw request data without extra processing
(as opposed to the structured request items syntax):
- $ http\fB\,--raw\/\fR=\'data\' pie.dev/post
+ $ http \fB\,--raw\/\fR=\[aq]data\[aq] pie.dev/post
You can achieve the same by piping the data via stdin:
@@ -133,7 +134,7 @@ Or have HTTPie load the raw data from a file:
.PP
-.SH Content Processing Options
+.SH Content processing options
.IP "\fB\,--compress\/\fR, \fB\,-x\/\fR"
@@ -146,39 +147,39 @@ negative. Compression can be forced by repeating the argument.
.PP
-.SH Output Processing
+.SH Output processing
.IP "\fB\,--pretty\/\fR"
-Controls output processing. The value can be "none" to not prettify
-the output (default for redirected output), "all" to apply both colors
-and formatting (default for terminal output), "colors", or "format".
+Controls output processing. The value can be \[dq]none\[dq] to not prettify
+the output (default for redirected output), \[dq]all\[dq] to apply both colors
+and formatting (default for terminal output), \[dq]colors\[dq], or \[dq]format\[dq].
.IP "\fB\,--style\/\fR, \fB\,-s\/\fR \fI\,STYLE\/\fR"
-Output coloring style (default is "auto"). It can be one of:
+Output coloring style (default is \[dq]auto\[dq]). It can be one of:
auto, pie, pie-dark, pie-light, solarized
For finding out all available styles in your system, try:
-$ http\fB\,--style\/\fR
+$ http \fB\,--style\/\fR
-The "auto" style follows your terminal\'s ANSI color styles.
+The \[dq]auto\[dq] style follows your terminal\[aq]s ANSI color styles.
For non-auto styles to work properly, please make sure that the
-$TERM environment variable is set to "xterm-256color" or similar
-(e.g., via `export TERM=xterm-256color\' in your \~/.bashrc).
+$TERM environment variable is set to \[dq]xterm-256color\[dq] or similar
+(e.g., via `export TERM=xterm-256color\[aq] in your \(ti/.bashrc).
.IP "\fB\,--unsorted\/\fR"
Disables all sorting while formatting output. It is a shortcut for:
- \fB\,--format-options\/\fR=headers.sort:false,json.sort_keys:false
+ \fB\,--format-options\/\fR=headers.sort:false,json.sort_keys:false
@@ -187,7 +188,7 @@ Disables all sorting while formatting output. It is a shortcut for:
Re-enables all sorting options while formatting output. It is a shortcut for:
- \fB\,--format-options\/\fR=headers.sort:true,json.sort_keys:true
+ \fB\,--format-options\/\fR=headers.sort:true,json.sort_keys:true
@@ -196,8 +197,8 @@ Re-enables all sorting options while formatting output. It is a shortcut for:
Override the response encoding for terminal display purposes, e.g.:
- \fB\,--response-charset\/\fR=utf8
- \fB\,--response-charset\/\fR=big5
+ \fB\,--response-charset\/\fR=utf8
+ \fB\,--response-charset\/\fR=big5
@@ -206,8 +207,8 @@ Override the response encoding for terminal display purposes, e.g.:
Override the response mime type for coloring and formatting for the terminal, e.g.:
- \fB\,--response-mime\/\fR=application/json
- \fB\,--response-mime\/\fR=text/xml
+ \fB\,--response-mime\/\fR=application/json
+ \fB\,--response-mime\/\fR=text/xml
@@ -215,7 +216,7 @@ Override the response mime type for coloring and formatting for the terminal, e.
Controls output formatting. Only relevant when formatting is enabled
-through (explicit or implied)\fB\,--pretty\/\fR=all or\fB\,--pretty\/\fR=format.
+through (explicit or implied) \fB\,--pretty\/\fR=all or \fB\,--pretty\/\fR=format.
The following are the default options:
headers.sort:true
@@ -229,26 +230,26 @@ You may use this option multiple times, as well as specify multiple
comma-separated options at the same time. For example, this modifies the
settings to disable the sorting of JSON keys, and sets the indent size to 2:
- \fB\,--format-options\/\fR json.sort_keys:false,json.indent:2
+ \fB\,--format-options\/\fR json.sort_keys:false,json.indent:2
This is something you will typically put into your config file.
.PP
-.SH Output Options
+.SH Output options
.IP "\fB\,--print\/\fR, \fB\,-p\/\fR \fI\,WHAT\/\fR"
String specifying what the output should contain:
- \'H\' request headers
- \'B\' request body
- \'h\' response headers
- \'b\' response body
- \'m\' response metadata
+ \[aq]H\[aq] request headers
+ \[aq]B\[aq] request body
+ \[aq]h\[aq] response headers
+ \[aq]b\[aq] response body
+ \[aq]m\[aq] response metadata
-The default behaviour is \'hb\' (i.e., the response
+The default behaviour is \[aq]hb\[aq] (i.e., the response
headers and body is printed), if standard output is not redirected.
If the output is piped to another program or to a file, then only the
response body is printed by default.
@@ -258,34 +259,34 @@ response body is printed by default.
.IP "\fB\,--headers\/\fR, \fB\,-h\/\fR"
-Print only the response headers. Shortcut for\fB\,--print\/\fR=h.
+Print only the response headers. Shortcut for \fB\,--print\/\fR=h.
.IP "\fB\,--meta\/\fR, \fB\,-m\/\fR"
-Print only the response metadata. Shortcut for\fB\,--print\/\fR=m.
+Print only the response metadata. Shortcut for \fB\,--print\/\fR=m.
.IP "\fB\,--body\/\fR, \fB\,-b\/\fR"
-Print only the response body. Shortcut for\fB\,--print\/\fR=b.
+Print only the response body. Shortcut for \fB\,--print\/\fR=b.
.IP "\fB\,--verbose\/\fR, \fB\,-v\/\fR"
-Verbose output. For the level one (with single \fB\,-v\/\fR`/\fB\,--verbose\/\fR`), print
+Verbose output. For the level one (with single `\fB\,-v\/\fR`/`\fB\,--verbose\/\fR`), print
the whole request as well as the response. Also print any intermediary
requests/responses (such as redirects). For the second level and higher,
print these as well as the response metadata.
-Level one is a shortcut for:\fB\,--all\/\fR\fB\,--print\/\fR=BHbh
-Level two is a shortcut for:\fB\,--all\/\fR\fB\,--print\/\fR=BHbhm
+Level one is a shortcut for: \fB\,--all\/\fR \fB\,--print\/\fR=BHbh
+Level two is a shortcut for: \fB\,--all\/\fR \fB\,--print\/\fR=BHbhm
.IP "\fB\,--all\/\fR"
@@ -293,23 +294,23 @@ Level two is a shortcut for:\fB\,--all\/\fR\fB\,--print\/\fR=BHbhm
By default, only the final request/response is shown. Use this flag to show
any intermediary requests/responses as well. Intermediary requests include
-followed redirects (with\fB\,--follow\/\fR), the first unauthorized request when
-Digest auth is used \fB\,--auth\/\fR=digest), etc.
+followed redirects (with \fB\,--follow\/\fR), the first unauthorized request when
+Digest auth is used (\fB\,--auth\/\fR=digest), etc.
.IP "\fB\,--stream\/\fR, \fB\,-S\/\fR"
-Always stream the response body by line, i.e., behave like `tail\fB\,-f\/\fR\'.
+Always stream the response body by line, i.e., behave like `tail \fB\,-f\/\fR\[aq].
-Without\fB\,--stream\/\fR and with\fB\,--pretty\/\fR (either set or implied),
+Without \fB\,--stream\/\fR and with \fB\,--pretty\/\fR (either set or implied),
HTTPie fetches the whole response before it outputs the processed data.
Set this option when you want to continuously display a prettified
long-lived response, such as one from the Twitter streaming API.
-It is useful also without\fB\,--pretty\/\fR: It ensures that the output is flushed
+It is useful also without \fB\,--pretty\/\fR: It ensures that the output is flushed
more often and in smaller chunks.
@@ -317,7 +318,7 @@ more often and in smaller chunks.
.IP "\fB\,--output\/\fR, \fB\,-o\/\fR \fI\,FILE\/\fR"
-Save output to FILE instead of stdout. If\fB\,--download\/\fR is also set, then only
+Save output to FILE instead of stdout. If \fB\,--download\/\fR is also set, then only
the response body is saved to FILE. Other parts of the HTTP exchange are
printed to stderr.
@@ -327,7 +328,7 @@ printed to stderr.
Do not print the response body to stdout. Rather, download it and store it
-in a file. The filename is guessed unless specified with\fB\,--output\/\fR
+in a file. The filename is guessed unless specified with \fB\,--output\/\fR
[filename]. This action is similar to the default behaviour of wget.
@@ -335,7 +336,7 @@ in a file. The filename is guessed unless specified with\fB\,--output\/\fR
.IP "\fB\,--continue\/\fR, \fB\,-c\/\fR"
-Resume an interrupted download. Note that the\fB\,--output\/\fR option needs to be
+Resume an interrupted download. Note that the \fB\,--output\/\fR option needs to be
specified as well.
@@ -345,8 +346,8 @@ specified as well.
Do not print to stdout or stderr, except for errors and warnings when provided once.
Provide twice to suppress warnings as well.
-stdout is still redirected if\fB\,--output\/\fR is specified.
-Flag doesn\'t affect behaviour of download beyond not printing to terminal.
+stdout is still redirected if \fB\,--output\/\fR is specified.
+Flag doesn\[aq]t affect behaviour of download beyond not printing to terminal.
@@ -383,24 +384,24 @@ exchange.
For username/password based authentication mechanisms (e.g
basic auth or digest auth) if only the username is provided
-\fB\,-a\/\fR username), HTTPie will prompt for the password.
+(\fB\,-a\/\fR username), HTTPie will prompt for the password.
.IP "\fB\,--auth-type\/\fR, \fB\,-A\/\fR"
-The authentication mechanism to be used. Defaults to "basic".
+The authentication mechanism to be used. Defaults to \[dq]basic\[dq].
-"basic": Basic HTTP auth
+\[dq]basic\[dq]: Basic HTTP auth
-"digest": Digest HTTP auth
+\[dq]digest\[dq]: Digest HTTP auth
-"bearer": Bearer HTTP Auth
+\[dq]bearer\[dq]: Bearer HTTP Auth
For finding out all available authentication types in your system, try:
-$ http\fB\,--auth-type\/\fR
+$ http \fB\,--auth-type\/\fR
.IP "\fB\,--ignore-netrc\/\fR"
@@ -413,7 +414,7 @@ Ignore credentials from .netrc.
.IP "\fB\,--offline\/\fR"
-Build the request and print it but don\'t actually send it.
+Build the request and print it but don\(gat actually send it.
.IP "\fB\,--proxy\/\fR \fI\,PROTOCOL:PROXY_URL\/\fR"
@@ -435,7 +436,7 @@ Follow 30x Location redirects.
.IP "\fB\,--max-redirects\/\fR"
-By default, requests have a limit of 30 redirects (works with\fB\,--follow\/\fR).
+By default, requests have a limit of 30 redirects (works with \fB\,--follow\/\fR).
@@ -466,7 +467,7 @@ exit with an error if the status indicates one.
When the server replies with a 4xx (Client Error) or 5xx (Server Error)
status code, HTTPie exits with 4 or 5 respectively. If the response is a
-3xx (Redirect) and\fB\,--follow\/\fR hasn\'t been set, then the exit status is 3.
+3xx (Redirect) and \fB\,--follow\/\fR hasn\[aq]t been set, then the exit status is 3.
Also an error message is written to stderr if stdout is redirected.
@@ -488,8 +489,8 @@ Enable streaming via chunked transfer encoding. The Transfer-Encoding header is
.IP "\fB\,--verify\/\fR"
-Set to "no" (or "false") to skip checking the host\'s SSL certificate.
-Defaults to "yes" ("true"). You can also pass the path to a CA_BUNDLE file
+Set to \[dq]no\[dq] (or \[dq]false\[dq]) to skip checking the host\[aq]s SSL certificate.
+Defaults to \[dq]yes\[dq] (\[dq]true\[dq]). You can also pass the path to a CA_BUNDLE file
for private certs. (Or you can set the REQUESTS_CA_BUNDLE environment
variable instead.)
@@ -521,14 +522,14 @@ ECDHE+AESGCM:ECDHE+CHACHA20:DHE+AESGCM:DHE+CHACHA20:ECDH+AESGCM:DH+AESGCM:ECDH+A
You can specify a local cert to use as client side SSL certificate.
This file may either contain both private key and certificate or you may
-specify\fB\,--cert-key\/\fR separately.
+specify \fB\,--cert-key\/\fR separately.
.IP "\fB\,--cert-key\/\fR"
-The private key to use with SSL. Only needed if\fB\,--cert\/\fR is given and the
+The private key to use with SSL. Only needed if \fB\,--cert\/\fR is given and the
certificate file does not contain the private key.
@@ -536,9 +537,9 @@ certificate file does not contain the private key.
.IP "\fB\,--cert-key-pass\/\fR"
-The passphrase to be used to with the given private key. Only needed if\fB\,--cert-key\/\fR
+The passphrase to be used to with the given private key. Only needed if \fB\,--cert-key\/\fR
is given and the key file requires a passphrase.
-If not provided, you\'ll be prompted interactively.
+If not provided, you\(gall be prompted interactively.
.PP
@@ -587,4 +588,11 @@ information useful for debugging HTTPie itself and for reporting bugs.
-.PP \ No newline at end of file
+.PP
+.SH SEE ALSO
+
+For every \fB\,--OPTION\/\fR there is also a \fB\,--no-OPTION\/\fR that reverts OPTION
+to its default value.
+
+Suggestions and bug reports are greatly appreciated:
+https://github.com/httpie/httpie/issues \ No newline at end of file
diff --git a/extras/man/httpie.1 b/extras/man/httpie.1
index ad62f5a1..43fdcd07 100644
--- a/extras/man/httpie.1
+++ b/extras/man/httpie.1
@@ -1,9 +1,9 @@
+.\" This file is auto-generated from the parser declaration in httpie/manager/cli.py by extras/scripts/generate_man_pages.py.
.TH httpie 1 "2022-03-08" "HTTPie 3.1.1.dev0" "HTTPie Manual"
.SH NAME
httpie
.SH SYNOPSIS
-httpie HOSTNAME SESSION_NAME_OR_PATH TARGET TARGET TARGET TARGET TARGET TARGET
-
+httpie
.SH DESCRIPTION
Managing interface for the HTTPie itself. <https://httpie.io/docs#manager>
@@ -12,11 +12,17 @@ Be aware that you might be looking for http/https commands for sending
HTTP requests. This command is only available for managing the HTTTPie
plugins and the configuration around it.
+
+If you are looking for the man pages of http/https commands, try one of the following:
+ $ man http
+ $ man https
+
+
.SH httpie cli export-args
Export available options for the CLI
.IP "\fB\,-f\/\fR, \fB\,--format\/\fR"
-
+Format to export in.
.PP
.SH httpie cli sessions upgrade
diff --git a/extras/man/https.1 b/extras/man/https.1
index c94c1a1d..4ecf5551 100644
--- a/extras/man/https.1
+++ b/extras/man/https.1
@@ -1,3 +1,4 @@
+.\" This file is auto-generated from the parser declaration in httpie/cli/definition.py by extras/scripts/generate_man_pages.py.
.TH https 1 "2022-03-08" "HTTPie 3.1.1.dev0" "HTTPie Manual"
.SH NAME
https
@@ -6,7 +7,7 @@ https [METHOD] URL [REQUEST_ITEM ...]
.SH DESCRIPTION
HTTPie: modern, user-friendly command-line HTTP client for the API era. <https://httpie.io>
-.SH Positional Arguments
+.SH Positional arguments
These arguments come after any flags and in the order they are listed here.
Only URL is required.
@@ -27,8 +28,8 @@ is some data to be sent, otherwise GET:
.IP "\fB\,URL\/\fR"
-The request URL. Scheme defaults to \'http://\' if the URL
-does not include one. (You can override this with:\fB\,--default-scheme\/\fR=http/https)
+The request URL. Scheme defaults to \[aq]http://\[aq] if the URL
+does not include one. (You can override this with: \fB\,--default-scheme\/\fR=http/https)
You can also use a shorthand for localhost
@@ -43,44 +44,44 @@ You can also use a shorthand for localhost
Optional key-value pairs to be included in the request. The separator used
determines the type:
-\':\' HTTP headers:
+\[aq]:\[aq] HTTP headers:
Referer:https://httpie.io Cookie:foo=bar User-Agent:bacon/1.0
-\'==\' URL parameters to be appended to the request URI:
+\[aq]==\[aq] URL parameters to be appended to the request URI:
search==httpie
-\'=\' Data fields to be serialized into a JSON object (with\fB\,--json\/\fR,\fB\,-j\/\fR)
- or form data (with\fB\,--form\/\fR,\fB\,-f\/\fR):
+\[aq]=\[aq] Data fields to be serialized into a JSON object (with \fB\,--json\/\fR, \fB\,-j\/\fR)
+ or form data (with \fB\,--form\/\fR, \fB\,-f\/\fR):
- name=HTTPie language=Python description=\'CLI HTTP client\'
+ name=HTTPie language=Python description=\[aq]CLI HTTP client\[aq]
-\':=\' Non-string JSON data fields (only with\fB\,--json\/\fR,\fB\,-j\/\fR):
+\[aq]:=\[aq] Non-string JSON data fields (only with \fB\,--json\/\fR, \fB\,-j\/\fR):
- awesome:=true amount:=42 colors:=\'["red", "green", "blue"]\'
+ awesome:=true amount:=42 colors:=\[aq][\[dq]red\[dq], \[dq]green\[dq], \[dq]blue\[dq]]\[aq]
-\'@\' Form file fields (only with\fB\,--form\/\fR or\fB\,--multipart\/\fR):
+\[aq]@\[aq] Form file fields (only with \fB\,--form\/\fR or \fB\,--multipart\/\fR):
- cv@\~/Documents/CV.pdf
- cv@\'\~/Documents/CV.pdf;type=application/pdf\'
+ cv@\(ti/Documents/CV.pdf
+ cv@\[aq]\(ti/Documents/CV.pdf;type=application/pdf\[aq]
-\'=@\' A data field like \'=\', but takes a file path and embeds its content:
+\[aq]=@\[aq] A data field like \[aq]=\[aq], but takes a file path and embeds its content:
essay=@Documents/essay.txt
-\':=@\' A raw JSON field like \':=\', but takes a file path and embeds its content:
+\[aq]:=@\[aq] A raw JSON field like \[aq]:=\[aq], but takes a file path and embeds its content:
package:=@./package.json
You can use a backslash to escape a colliding separator in the field name:
- field-name-with\\:colon=value
+ field-name-with\e:colon=value
.PP
-.SH Predefined Content Types
+.SH Predefined content types
.IP "\fB\,--json\/\fR, \fB\,-j\/\fR"
@@ -104,13 +105,13 @@ multipart/form-data request.
.IP "\fB\,--multipart\/\fR"
-Similar to\fB\,--form\/\fR, but always sends a multipart/form-data request (i.e., even without files).
+Similar to \fB\,--form\/\fR, but always sends a multipart/form-data request (i.e., even without files).
.IP "\fB\,--boundary\/\fR"
-Specify a custom boundary string for multipart/form-data requests. Only has effect only together with\fB\,--form\/\fR.
+Specify a custom boundary string for multipart/form-data requests. Only has effect only together with \fB\,--form\/\fR.
.IP "\fB\,--raw\/\fR"
@@ -119,7 +120,7 @@ Specify a custom boundary string for multipart/form-data requests. Only has effe
This option allows you to pass raw request data without extra processing
(as opposed to the structured request items syntax):
- $ http\fB\,--raw\/\fR=\'data\' pie.dev/post
+ $ http \fB\,--raw\/\fR=\[aq]data\[aq] pie.dev/post
You can achieve the same by piping the data via stdin:
@@ -133,7 +134,7 @@ Or have HTTPie load the raw data from a file:
.PP
-.SH Content Processing Options
+.SH Content processing options
.IP "\fB\,--compress\/\fR, \fB\,-x\/\fR"
@@ -146,39 +147,39 @@ negative. Compression can be forced by repeating the argument.
.PP
-.SH Output Processing
+.SH Output processing
.IP "\fB\,--pretty\/\fR"
-Controls output processing. The value can be "none" to not prettify
-the output (default for redirected output), "all" to apply both colors
-and formatting (default for terminal output), "colors", or "format".
+Controls output processing. The value can be \[dq]none\[dq] to not prettify
+the output (default for redirected output), \[dq]all\[dq] to apply both colors
+and formatting (default for terminal output), \[dq]colors\[dq], or \[dq]format\[dq].
.IP "\fB\,--style\/\fR, \fB\,-s\/\fR \fI\,STYLE\/\fR"
-Output coloring style (default is "auto"). It can be one of:
+Output coloring style (default is \[dq]auto\[dq]). It can be one of:
auto, pie, pie-dark, pie-light, solarized
For finding out all available styles in your system, try:
-$ http\fB\,--style\/\fR
+$ http \fB\,--style\/\fR
-The "auto" style follows your terminal\'s ANSI color styles.
+The \[dq]auto\[dq] style follows your terminal\[aq]s ANSI color styles.
For non-auto styles to work properly, please make sure that the
-$TERM environment variable is set to "xterm-256color" or similar
-(e.g., via `export TERM=xterm-256color\' in your \~/.bashrc).
+$TERM environment variable is set to \[dq]xterm-256color\[dq] or similar
+(e.g., via `export TERM=xterm-256color\[aq] in your \(ti/.bashrc).
.IP "\fB\,--unsorted\/\fR"
Disables all sorting while formatting output. It is a shortcut for:
- \fB\,--format-options\/\fR=headers.sort:false,json.sort_keys:false
+ \fB\,--format-options\/\fR=headers.sort:false,json.sort_keys:false
@@ -187,7 +188,7 @@ Disables all sorting while formatting output. It is a shortcut for:
Re-enables all sorting options while formatting output. It is a shortcut for:
- \fB\,--format-options\/\fR=headers.sort:true,json.sort_keys:true
+ \fB\,--format-options\/\fR=headers.sort:true,json.sort_keys:true
@@ -196,8 +197,8 @@ Re-enables all sorting options while formatting output. It is a shortcut for:
Override the response encoding for terminal display purposes, e.g.:
- \fB\,--response-charset\/\fR=utf8
- \fB\,--response-charset\/\fR=big5
+ \fB\,--response-charset\/\fR=utf8
+ \fB\,--response-charset\/\fR=big5
@@ -206,8 +207,8 @@ Override the response encoding for terminal display purposes, e.g.:
Override the response mime type for coloring and formatting for the terminal, e.g.:
- \fB\,--response-mime\/\fR=application/json
- \fB\,--response-mime\/\fR=text/xml
+ \fB\,--response-mime\/\fR=application/json
+ \fB\,--response-mime\/\fR=text/xml
@@ -215,7 +216,7 @@ Override the response mime type for coloring and formatting for the terminal, e.
Controls output formatting. Only relevant when formatting is enabled
-through (explicit or implied)\fB\,--pretty\/\fR=all or\fB\,--pretty\/\fR=format.
+through (explicit or implied) \fB\,--pretty\/\fR=all or \fB\,--pretty\/\fR=format.
The following are the default options:
headers.sort:true
@@ -229,26 +230,26 @@ You may use this option multiple times, as well as specify multiple
comma-separated options at the same time. For example, this modifies the
settings to disable the sorting of JSON keys, and sets the indent size to 2:
- \fB\,--format-options\/\fR json.sort_keys:false,json.indent:2
+ \fB\,--format-options\/\fR json.sort_keys:false,json.indent:2
This is something you will typically put into your config file.
.PP
-.SH Output Options
+.SH Output options
.IP "\fB\,--print\/\fR, \fB\,-p\/\fR \fI\,WHAT\/\fR"
String specifying what the output should contain:
- \'H\' request headers
- \'B\' request body
- \'h\' response headers
- \'b\' response body
- \'m\' response metadata
+ \[aq]H\[aq] request headers
+ \[aq]B\[aq] request body
+ \[aq]h\[aq] response headers
+ \[aq]b\[aq] response body
+ \[aq]m\[aq] response metadata
-The default behaviour is \'hb\' (i.e., the response
+The default behaviour is \[aq]hb\[aq] (i.e., the response
headers and body is printed), if standard output is not redirected.
If the output is piped to another program or to a file, then only the
response body is printed by default.
@@ -258,34 +259,34 @@ response body is printed by default.
.IP "\fB\,--headers\/\fR, \fB\,-h\/\fR"
-Print only the response headers. Shortcut for\fB\,--print\/\fR=h.
+Print only the response headers. Shortcut for \fB\,--print\/\fR=h.
.IP "\fB\,--meta\/\fR, \fB\,-m\/\fR"
-Print only the response metadata. Shortcut for\fB\,--print\/\fR=m.
+Print only the response metadata. Shortcut for \fB\,--print\/\fR=m.
.IP "\fB\,--body\/\fR, \fB\,-b\/\fR"
-Print only the response body. Shortcut for\fB\,--print\/\fR=b.
+Print only the response body. Shortcut for \fB\,--print\/\fR=b.
.IP "\fB\,--verbose\/\fR, \fB\,-v\/\fR"
-Verbose output. For the level one (with single \fB\,-v\/\fR`/\fB\,--verbose\/\fR`), print
+Verbose output. For the level one (with single `\fB\,-v\/\fR`/`\fB\,--verbose\/\fR`), print
the whole request as well as the response. Also print any intermediary
requests/responses (such as redirects). For the second level and higher,
print these as well as the response metadata.
-Level one is a shortcut for:\fB\,--all\/\fR\fB\,--print\/\fR=BHbh
-Level two is a shortcut for:\fB\,--all\/\fR\fB\,--print\/\fR=BHbhm
+Level one is a shortcut for: \fB\,--all\/\fR \fB\,--print\/\fR=BHbh
+Level two is a shortcut for: \fB\,--all\/\fR \fB\,--print\/\fR=BHbhm
.IP "\fB\,--all\/\fR"
@@ -293,23 +294,23 @@ Level two is a shortcut for:\fB\,--all\/\fR\fB\,--print\/\fR=BHbhm
By default, only the final request/response is shown. Use this flag to show
any intermediary requests/responses as well. Intermediary requests include
-followed redirects (with\fB\,--follow\/\fR), the first unauthorized request when
-Digest auth is used \fB\,--auth\/\fR=digest), etc.
+followed redirects (with \fB\,--follow\/\fR), the first unauthorized request when
+Digest auth is used (\fB\,--auth\/\fR=digest), etc.
.IP "\fB\,--stream\/\fR, \fB\,-S\/\fR"
-Always stream the response body by line, i.e., behave like `tail\fB\,-f\/\fR\'.
+Always stream the response body by line, i.e., behave like `tail \fB\,-f\/\fR\[aq].
-Without\fB\,--stream\/\fR and with\fB\,--pretty\/\fR (either set or implied),
+Without \fB\,--stream\/\fR and with \fB\,--pretty\/\fR (either set or implied),
HTTPie fetches the whole response before it outputs the processed data.
Set this option when you want to continuously display a prettified
long-lived response, such as one from the Twitter streaming API.
-It is useful also without\fB\,--pretty\/\fR: It ensures that the output is flushed
+It is useful also without \fB\,--pretty\/\fR: It ensures that the output is flushed
more often and in smaller chunks.
@@ -317,7 +318,7 @@ more often and in smaller chunks.
.IP "\fB\,--output\/\fR, \fB\,-o\/\fR \fI\,FILE\/\fR"
-Save output to FILE instead of stdout. If\fB\,--download\/\fR is also set, then only
+Save output to FILE instead of stdout. If \fB\,--download\/\fR is also set, then only
the response body is saved to FILE. Other parts of the HTTP exchange are
printed to stderr.
@@ -327,7 +328,7 @@ printed to stderr.
Do not print the response body to stdout. Rather, download it and store it
-in a file. The filename is guessed unless specified with\fB\,--output\/\fR
+in a file. The filename is guessed unless specified with \fB\,--output\/\fR
[filename]. This action is similar to the default behaviour of wget.
@@ -335,7 +336,7 @@ in a file. The filename is guessed unless specified with\fB\,--output\/\fR
.IP "\fB\,--continue\/\fR, \fB\,-c\/\fR"
-Resume an interrupted download. Note that the\fB\,--output\/\fR option needs to be
+Resume an interrupted download. Note that the \fB\,--output\/\fR option needs to be
specified as well.
@@ -345,8 +346,8 @@ specified as well.
Do not print to stdout or stderr, except for errors and warnings when provided once.
Provide twice to suppress warnings as well.
-stdout is still redirected if\fB\,--output\/\fR is specified.
-Flag doesn\'t affect behaviour of download beyond not printing to terminal.
+stdout is still redirected if \fB\,--output\/\fR is specified.
+Flag doesn\[aq]t affect behaviour of download beyond not printing to terminal.