X-Git-Url: https://git.distorted.org.uk/~mdw/misc/blobdiff_plain/f342fce2e614f9d34503082b165bf70c0a211631..df33ee5494fe4ac181807406cd8dcf6dba6f5275:/gorp.1

diff --git a/gorp.1 b/gorp.1
index f00ce13..ac3d02a 100644
--- a/gorp.1
+++ b/gorp.1
@@ -4,13 +4,72 @@
 gorp \- write a short random string
 .SH SYNOPSIS
 .B gorp
+.RB [ \-y ]
+.RB [ \-l
+.IR length ]
+.RB [ \-f
+.IR format ]
 .RI [ bits ]
 .SH DESCRIPTION
 Generates
 .I bits
 random bits (must be a multiple of 8, default is 128) and writes the
-resulting string to standard output in base64 format.
+resulting string to standard output.
+.PP
+The following options are recognized.
+.TP
+.B "\-h, \-\-help"
+Prints a help message to standard output and exits successfully.
+.TP
+.B "\-v, \-\-version"
+Prints the program's version number to standard output and exits
+successfully.
+.TP
+.B "\-u, \-\-usage"
+Prints a really short usage summary to standard output and exits
+successfully.
+.TP
+.BI "\-f, \-\-format=" format
+Prints the random string using the chosen output
+.IR format ,
+which may be
+.B base64
+(standard Base64 encoding, as described in RFC2045; this is the default), 
+.B file64
+(Base64 encoding, with
+.RB ` % '
+instead of
+.RB ` / ',
+so the output is suitable for use as a filename),
+.B safe64
+(Base64 encoding, with
+.RB ` - '
+instead of
+.RB ` + ',
+and
+.RB ` _ '
+instead of
+.RB ` / ',
+as specified in RFC3548, as an attempt to achieve the same goal but
+inconveniently using up all the good separator characters),
+.B base32
+(Base32 encoding, as described in RFC2938),
+.B hex
+(plain hexadecimal encoding), or
+.B raw
+(raw binary output, not printable).
+.TP
+.BI "\-l, \-\-line=" length
+Breaks textual output into lines of at most
+.I length
+characters, and does all encoding in a strictly conforming way.  By
+default, the textual output is not line-broken, and strange terminator
+characters are not printed.
+.TP
+.B "\-y, \-\-bytes"
+The output length is bits, not bytes.  This doesn't affect the default
+value of 128.
 .SH BUGS
 None known.
 .SH AUTHOR
-Mark Wooding <mdw@nsict.org>
+Mark Wooding <mdw@distorted.org.uk>