mdw@git.distorted.org.uk Git - misc/blob - gorp.1

   1 .\" -*-nroff-*-
   2 .TH gorp 1 "9 October 2003" "Straylight/Edgeware"
   3 .SH NAME
   4 gorp \- write a short random string
   5 .SH SYNOPSIS
   6 .B gorp
   7 .RB [ \-y ]
   8 .RB [ \-l
   9 .IR length ]
  10 .RB [ \-f
  11 .IR format ]
  12 .RI [ bits ]
  13 .SH DESCRIPTION
  14 Generates
  15 .I bits
  16 random bits (must be a multiple of 8, default is 128) and writes the
  17 resulting string to standard output.
  18 .PP
  19 The following options are recognized.
  20 .TP
  21 .B "\-h, \-\-help"
  22 Prints a help message to standard output and exits successfully.
  23 .TP
  24 .B "\-v, \-\-version"
  25 Prints the program's version number to standard output and exits
  26 successfully.
  27 .TP
  28 .B "\-u, \-\-usage"
  29 Prints a really short usage summary to standard output and exits
  30 successfully.
  31 .TP
  32 .BI "\-f, \-\-format=" format
  33 Prints the random string using the chosen output
  34 .IR format ,
  35 which may be
  36 .B base64
  37 (standard Base64 encoding, as described in RFC2045; this is the default),
  38 .B file64
  39 (Base64 encoding, with
  40 .RB ` % '
  41 instead of
  42 .RB ` / ',
  43 so the output is suitable for use as a filename),
  44 .B safe64
  45 (Base64 encoding, with
  46 .RB ` - '
  47 instead of
  48 .RB ` + ',
  49 and
  50 .RB ` _ '
  51 instead of
  52 .RB ` / ',
  53 as specified in RFC3548, as an attempt to achieve the same goal but
  54 inconveniently using up all the good separator characters),
  55 .B base32
  56 (Base32 encoding, as described in RFC2938),
  57 .B hex
  58 (plain hexadecimal encoding), or
  59 .B raw
  60 (raw binary output, not printable).
  61 .TP
  62 .BI "\-l, \-\-line=" length
  63 Breaks textual output into lines of at most
  64 .I length
  65 characters, and does all encoding in a strictly conforming way.  By
  66 default, the textual output is not line-broken, and strange terminator
  67 characters are not printed.
  68 .TP
  69 .B "\-y, \-\-bytes"
  70 The output length is bits, not bytes.  This doesn't affect the default
  71 value of 128.
  72 .SH BUGS
  73 None known.
  74 .SH AUTHOR
  75 Mark Wooding <mdw@distorted.org.uk>