gopher-validator.1: document param argument, order sections - gopher-validator - Simple gopher menu validator.
 (HTM) git clone git://bitreich.org/gopher-validator git://enlrupgkhuxnvlhsf6lc3fziv5h2hhfrinws65d7roiv6bfj7d652fid.onion/gopher-validator
 (DIR) Log
 (DIR) Files
 (DIR) Refs
 (DIR) Tags
 (DIR) README
 (DIR) LICENSE
       ---
 (DIR) commit 936d0f6a5c92d6580cd15d60fac5c0e98b01e946
 (DIR) parent a19073d4e019f0a18d854ca2ff1df7d6132d563a
 (HTM) Author: Hiltjo Posthuma <hiltjo@codemadness.org>
       Date:   Thu,  9 Jan 2020 20:19:07 +0100
       
       gopher-validator.1: document param argument, order sections
       
       Diffstat:
         M gopher-validator.1                  |      31 +++++++++++++++++++------------
       
       1 file changed, 19 insertions(+), 12 deletions(-)
       ---
 (DIR) diff --git a/gopher-validator.1 b/gopher-validator.1
       @@ -1,4 +1,4 @@
       -.Dd July 22, 2019
       +.Dd January 9, 2020
        .Dt GOPHER-VALIDATOR 1
        .Os
        .Sh NAME
       @@ -7,6 +7,7 @@
        .Sh SYNOPSIS
        .Nm
        .Op Ar url
       +.Op Ar param
        .Sh DESCRIPTION
        .Nm
        reads raw Gopher data from stdin.
       @@ -15,14 +16,31 @@ When an
        .Ar url
        is specified it retrieves the raw Gopher data from this url.
        .Pp
       +When a
       +.Ar param
       +is specified it will be added after the selector as a (search) parameter.
       +.Pp
        When the environment variable
        .Ev QUERY_STRING
        is set the program runs in Command Gateway Interface (CGI) mode.
        It will use the content of this variable as if it was
        .Ar url .
        .Pp
       +CGI-mode has precedence over command-line arguments.
       +.Pp
        .Nm
        validates Gopher data of directory (1) and search types (7).
       +.Sh EXIT STATUS
       +When there is a fatal error the exitcode is 2.
       +When there is any Gopher error the exitcode is 1.
       +When there is no error (could still have a warning) the exitcode is 0.
       +.Sh EXAMPLES
       +.Bd -literal
       +printf '\\r\\n' | nc codemadness.org 70 | gopher-validator
       +.Ed
       +.Bd -literal
       +gopher-validator gopher://codemadness.org/1
       +.Ed
        .Sh DIAGNOSTICS
        The following output format is used for the fatal, error and warning messages.
        These are prefixed with the following texts:
       @@ -44,17 +62,6 @@ These messages are written to stdout.
        .El
        .Pp
        If possible the messages are also prefixed with the output line number.
       -.Sh EXIT STATUS
       -When there is a fatal error the exitcode is 2.
       -When there is any Gopher error the exitcode is 1.
       -When there is no error (could still have a warning) the exitcode is 0.
       -.Sh EXAMPLES
       -.Bd -literal
       -printf '\\r\\n' | nc codemadness.org 70 | gopher-validator
       -.Ed
       -.Bd -literal
       -gopher-validator gopher://codemadness.org/1
       -.Ed
        .Sh SEE ALSO
        .Xr nc 1
        .Sh STANDARDS