Subversion Repositories

.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH LSH-KEYGEN 1 "Aug 21 2002" lsh-keygen "lsh manuals"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
lsh-keygen \- generate a public/private key pair
.SH SYNOPSIS
.B lsh-keygen
.RI [ options ]
.SH DESCRIPTION
This manual page documents briefly the
.B lsh-keygen
command.
This manual page was written for the Debian distribution
because the original program does not have a manual page.
Instead, it has documentation in the GNU Info format; see below.
.PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
.\" respectively.
\fBlsh-keygen\fP is a program that generates a public / private key pair in
\fBSPKI(5)\fP format and writes it to stdout. Usually you will pipe this
output to \fBlsh-writekey(1)\fP to write it to disk.
.SH OPTIONS
This program follows the usual GNU command line syntax, with long
options starting with two dashes (`-').
A summary of options is included below.
For a complete description, see the Info files.
.TP
.B \-f, \-\-output\-format=\fIformat\fP
The output SPKI format to use. Valid values of \fIformat\fP are "transport",
"canonical", "advanced" and "international". The default format is "transport".
See also \fBSPKI(5)\fP.
.TP
.B \-l, \-\-nist\-level=\fIsecurity\-level\fP
For DSA keys, this is the NIST security level: level 0 uses 512-bit primes,
level 8 uses 1024 bit primes, and the default is 8. For RSA keys, it's the bit
length of the modulus, and the default is 2048 bits.
.TP
.B \-a, \-\-algorithm=\fIalgorithm\fP
The public / private key algorithm to use. This can be either "RSA" or "DSA".
The default is to generate DSA keys.
.TP
.B \-\-server
Use the server random seed file
.TP
.B \-\-debug
Print huge amounts of debug information.
.TP
.B \-\-log\-file=\fIfile\fP
Append messages to \fIfile\fP.
.TP
.B \-q, \-\-quiet
Suppress all warnings and diagnostic messages.
.TP
.B \-\-trace
Print a detailed program trace.
.TP
.B \-v, \-\-verbose
Print verbose diagnostic messages
.TP
.B \-?, \-\-help
Show summary of options.
.TP
.B \-\-usage
Show a short usage message.
.TP
.B \-V, \-\-version
Show version of program.
.SH EXAMPLE
A typical usage of lsh-keygen is:

lsh-keygen -l 8 | lsh-writekey

Which generates a public / private key pair and stores it using
\fBlsh-writekey(1)\fP.
.SH BUGS
lsh-writekey should use \fBrandom(4)\fP rather than a less strong source of
randomness like \fBurandom(4)\fP where available.
.SH SEE ALSO
.BR lsh-writekey (1),
.BR lsh-make-seed (1),
.BR lshc (1),
.BR lshd (8),
.BR DSA (5),
.BR SPKI (5).
.BR
The programs are documented fully by
.IR "Lsh" ,
available via the Info system.
.SH AUTHOR
This manual page was written by Timshel Knoll <timshel@debian.org>,
for the Debian GNU/Linux system (but may be used by others).