Generate manual and manual dependencies.

Author: jcamiel

README.md

@@ -1,4 +1,4 @@
-.TH hurl 1 "19 Oct 2023" "hurl 4.2.0-SNAPSHOT" " Hurl Manual"
+.TH hurl 1 "08 Jan 2024" "hurl 4.2.0-SNAPSHOT" " Hurl Manual"
 .SH NAME
 
 hurl - run and test HTTP requests.
@@ -145,7 +145,7 @@ See also \fI--key\fP.
 
 .IP "--color "
 
-Colorize debug output (the HTTP response output is not colorized). 
+Colorize debug output (the HTTP response output is not colorized).
 
 .IP "--compressed "
 
@@ -189,26 +189,20 @@ Combined with \fI-b, --cookie\fP, you can simulate a cookie storage between succ
 
 Sets delay before each request.
 
-
 .IP "--error-format <FORMAT> "
 
 Control the format of error message (short by default or long)
 
-
 .IP "--file-root <DIR> "
 
-Set root file system to import files in Hurl. This is used for both files in multipart form data and request body.
-When this is not explicitly defined, the files are relative to the current directory in which Hurl is running.
-
-.IP "-L, --location "
-
-Follow redirect. To limit the amount of redirects to follow use the \fI--max-redirs\fP option
+Set root directory to import files in Hurl. This is used for files in multipart form data, request body and response output.
+When it is not explicitly defined, files are relative to the current directory in which Hurl is running.
 
 .IP "--glob <GLOB> "
 
 Specify input files that match the given glob pattern.
 
-Multiple glob flags may be used. This flag supports common Unix glob patterns like *, ? and []. 
+Multiple glob flags may be used. This flag supports common Unix glob patterns like *, ? and [].
 However, to avoid your shell accidentally expanding glob patterns before Hurl handles them, you must use single quotes or double quotes around each pattern.
 
 .IP "-0, --http1.0 "
@@ -229,21 +223,22 @@ For HTTP, this means Hurl attempts to upgrade the request to HTTP/2 using the Up
 
 Tells Hurl to try HTTP/3 to the host in the URL, but fallback to earlier HTTP versions if the HTTP/3 connection establishment fails. HTTP/3 is only available for HTTPS and not for HTTP URLs.
 
-.IP "-i, --include "
-
-Include the HTTP headers in the output (last entry).
-
 .IP "--ignore-asserts "
 
 Ignore all asserts defined in the Hurl file.
 
+.IP "-i, --include "
+
+Include the HTTP headers in the output
+
 .IP "-k, --insecure "
 
 This option explicitly allows Hurl to perform "insecure" SSL connections and transfers.
 
 .IP "--interactive "
 
 Stop between requests.
+
 This is similar to a break point, You can then continue (Press C) or quit (Press Q).
 
 .IP "-4, --ipv4 "
@@ -256,15 +251,25 @@ This option tells Hurl to use IPv6 addresses only when resolving host names, and
 
 .IP "--json "
 
-Output each hurl file result to JSON. The format is very closed to HAR format. 
+Output each hurl file result to JSON. The format is very closed to HAR format.
 
 .IP "--key <KEY> "
 
 Private key file name.
 
+.IP "-L, --location "
+
+Follow redirect. To limit the amount of redirects to follow use the \fI--max-redirs\fP option
+
+.IP "--location-trusted "
+
+Like \fI-L, --location\fP, but allows sending the name + password to all hosts that the site may redirect to.
+This may or may not introduce a security breach if the site redirects you to a site to which you send your authentication info (which is plaintext in the case of HTTP Basic authentication).
+
 .IP "--max-redirs <NUM> "
 
 Set maximum number of redirection-followings allowed
+
 By default, the limit is set to 50 redirections. Set this option to -1 to make it unlimited.
 
 .IP "-m, --max-time <SECONDS> "
@@ -284,6 +289,7 @@ Suppress output. By default, Hurl outputs the body of the last response.
 .IP "--noproxy <HOST(S)> "
 
 Comma-separated list of hosts which do not use a proxy.
+
 Override value from Environment variable no_proxy.
 
 .IP "-o, --output <FILE> "
@@ -298,29 +304,29 @@ Tell Hurl to not handle sequences of /../ or /./ in the given URL path. Normally
 
 Use the specified proxy.
 
-.IP "--report-junit <FILE> "
-
-Generate JUnit File.
-
-If the FILE report already exists, it will be updated with the new test results.
-
 .IP "--report-html <DIR> "
 
 Generate HTML report in DIR.
 
 If the HTML report already exists, it will be updated with the new test results.
 
+.IP "--report-junit <FILE> "
+
+Generate JUnit File.
+
+If the FILE report already exists, it will be updated with the new test results.
+
 .IP "--report-tap <FILE> "
 
 Generate TAP report.
 
 If the FILE report already exists, it will be updated with the new test results.
 
-.IP "--resolve <HOST:PORT:ADDR>  <HOST:PORT:ADDR>"
+.IP "--resolve <HOST:PORT:ADDR> "
 
 Provide a custom address for a specific host and port pair. Using this, you can make the Hurl requests(s) use a specified address and prevent the otherwise normally resolved address to be used. Consider it a sort of /etc/hosts alternative provided on the command line.
 
-.IP "--retry  <NUM> "
+.IP "--retry <NUM> "
 
 Maximum number of retries, 0 for no retries, -1 for unlimited retries. Retry happens if any error occurs (asserts, captures, runtimes etc...).
 
@@ -332,10 +338,6 @@ Duration in milliseconds between each retry. Default is 1000 ms.
 
 (Windows) This option tells Hurl to disable certificate revocation checks. WARNING: this option loosens the SSL security, and by using this flag you ask for exactly that.
 
-.IP "--unix-socket <PATH> "
-
-(HTTP) Connect through this Unix domain socket, instead of using the network.
-
 .IP "--test "
 
 Activate test mode: with this, the HTTP response is not outputted anymore, progress is reported for each Hurl file tested, and a text summary is displayed when all files have been run.
@@ -345,6 +347,10 @@ Activate test mode: with this, the HTTP response is not outputted anymore, progr
 Execute Hurl file to ENTRY_NUMBER (starting at 1).
 Ignore the remaining of the file. It is useful for debugging a session.
 
+.IP "--unix-socket <PATH> "
+
+(HTTP) Connect through this Unix domain socket, instead of using the network.
+
 .IP "-u, --user <USER:PASSWORD> "
 
 Add basic Authentication header to each request.
@@ -365,7 +371,7 @@ Each variable is defined as name=value exactly as with \fI--variable\fP option.
 
 Note that defining a variable twice produces an error.
 
-.IP "-v, --verbose "
+.IP "--verbose "
 
 Turn on verbose output on standard error stream.
 Useful for debugging.
@@ -382,7 +388,6 @@ Turn on more verbose output on standard error stream.
 
 In contrast to  \fI--verbose\fP option, this option outputs the full HTTP body request and response on standard error. In addition, lines starting with '**' are libcurl debug logs.
 
-
 .IP "-h, --help "
 
 Usage help. This lists all current command line options with a short description.

docs/manual.md

@@ -214,8 +214,8 @@ Control the format of error message (short by default or long)
 
 ### --file-root <DIR> {#file-root}
 
-Set root file system to import files in Hurl. This is used for both files in multipart form data and request body.
-When this is not explicitly defined, the files are relative to the current directory in which Hurl is running.
+Set root directory to import files in Hurl. This is used for files in multipart form data, request body and response output.
+When it is not explicitly defined, files are relative to the current directory in which Hurl is running.
 
 ### --glob <GLOB> {#glob}
 
@@ -280,6 +280,11 @@ Private key file name.
 
 Follow redirect. To limit the amount of redirects to follow use the [`--max-redirs`](#max-redirs) option
 
+### --location-trusted {#location-trusted}
+
+Like [`-L, --location`](#location), but allows sending the name + password to all hosts that the site may redirect to.
+This may or may not introduce a security breach if the site redirects you to a site to which you send your authentication info (which is plaintext in the case of HTTP Basic authentication).
+
 ### --max-redirs <NUM> {#max-redirs}
 
 Set maximum number of redirection-followings allowed

docs/manual/hurl.1

@@ -1,4 +1,4 @@
-.TH hurl 1 "19 Oct 2023" "hurl 4.2.0-SNAPSHOT" " Hurl Manual"
+.TH hurl 1 "08 Jan 2024" "hurl 4.2.0-SNAPSHOT" " Hurl Manual"
 .SH NAME
 
 hurlfmt - format Hurl files

docs/manual/hurl.md

@@ -1,7 +1,7 @@
 name: file_root
 long: file-root
 value: DIR
-help: Set root filesystem to import files [default: current directory]
+help: Set root directory to import files [default: current directory]
 ---
-Set root file system to import files in Hurl. This is used for both files in multipart form data and request body.
-When this is not explicitly defined, the files are relative to the current directory in which Hurl is running.
+Set root directory to import files in Hurl. This is used for files in multipart form data, request body and response output.
+When it is not explicitly defined, files are relative to the current directory in which Hurl is running.

docs/manual/hurlfmt.1

@@ -2,5 +2,5 @@ name: follow_location_trusted
 long: location-trusted
 help: Follow redirects but allows sending the name + password to all hosts that the site may redirect to.
 ---
-Like -L, --location, but allows sending the name + password to all hosts that the site may redirect to.
+Like [`-L, --location`](#location), but allows sending the name + password to all hosts that the site may redirect to.
 This may or may not introduce a security breach if the site redirects you to a site to which you send your authentication info (which is plaintext in the case of HTTP Basic authentication).

docs/spec/options/hurl/file_root.option

@@ -1,6 +1,6 @@
 name: unix_socket
 long: unix-socket
-value: path
+value: PATH
 help: (HTTP) Connect through this Unix domain socket, instead of using the network
 ---
 (HTTP) Connect through this Unix domain socket, instead of using the network.

docs/spec/options/hurl/follow_location_trusted.option

@@ -33,12 +33,11 @@ Options:
       --error-format <FORMAT>
           Control the format of error messages [default: short] [possible values: short, long]
       --file-root <DIR>
-          Set root filesystem to import files [default: current directory]
+          Set root directory to import files [default: current directory]
   -L, --location
           Follow redirects
       --location-trusted
-          Follow redirects but allows sending the name + password to all hosts that the site may
-          redirect to.
+          Follow redirects but allows sending the name + password to all hosts that the site may redirect to.
       --glob <GLOB>
           Specify input files that match the given GLOB. Multiple glob flags may be used
   -0, --http1.0
@@ -58,11 +57,9 @@ Options:
       --interactive
           Turn on interactive mode
   -4, --ipv4
-          Tell Hurl to use IPv4 addresses only when resolving host names, and not for example try
-          IPv6
+          Tell Hurl to use IPv4 addresses only when resolving host names, and not for example try IPv6
   -6, --ipv6
-          Tell Hurl to use IPv6 addresses only when resolving host names, and not for example try
-          IPv4
+          Tell Hurl to use IPv6 addresses only when resolving host names, and not for example try IPv4
       --json
           Output each Hurl file result to JSON
       --max-redirs <NUM>
@@ -94,13 +91,13 @@ Options:
       --retry-interval <MILLISECONDS>
           Interval in milliseconds before a retry [default: 1000]
       --ssl-no-revoke
-          (Windows) Tell Hurl to disable certificate revocation checks. WARNING: this option loosens
-          the SSL security, and by using this flag you ask for exactly that.
+          (Windows) Tell Hurl to disable certificate revocation checks. WARNING: this option loosens the SSL security, and by using this flag you ask for
+          exactly that.
       --test
           Activate test mode
       --to-entry <ENTRY_NUMBER>
           Execute Hurl file to ENTRY_NUMBER (starting at 1)
-      --unix-socket <path>
+      --unix-socket <PATH>
           (HTTP) Connect through this Unix domain socket, instead of using the network
   -A, --user-agent <NAME>
           Specify the User-Agent string to send to the HTTP server