[misc] / gorp.1

.\" -*-nroff-*-
.TH gorp 1 "9 October 2003" "Straylight/Edgeware"
.SH NAME
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.
.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 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>
Commit	Line	Data
f342fce2	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
22fb157c	7	.RB [ \-y ]
	8	.RB [ \-l
	9	.IR length ]
	10	.RB [ \-f
	11	.IR format ]
f342fce2	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
22fb157c	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 hex
	45	(plain hexadecimal encoding), or
	46	.B raw
	47	(raw binary output, not printable).
	48	.TP
1dec4fa3	49	.BI "\-l, \-\-line=" length
22fb157c	50	Breaks textual output into lines of at most
	51	.I length
	52	characters, and does all encoding in a strictly conforming way. By
	53	default, the textual output is not line-broken, and strange terminator
	54	characters are not printed.
	55	.TP
	56	.B "\-y, \-\-bytes"
	57	The output length is bits, not bytes. This doesn't affect the default
	58	value of 128.
f342fce2	59	.SH BUGS
	60	None known.
	61	.SH AUTHOR
	62	Mark Wooding <mdw@nsict.org>