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-WRITEKEY 1 "Aug 21 2002" lsh-writekey "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-writekey \- store a public / private key pair.
.SH SYNOPSIS
.B lsh-writekey
.RI [ options ]
.SH DESCRIPTION
This manual page documents briefly the
.B lsh-writekey
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-writekey\fP is a program that reads a public / private key pair in
\fBSPKI(5)\fP format on stdin, separates the public and private sections of
the key and writes them to separate files.
.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 \-c, \-\-crypto=\fIalgorithm\fP
Encryption algorithm to use on the private key file.
.TP
.B \-i, \-\-iteration\-count=\fIPKCS#5\fP
Iteration count, the default is 1500.
.TP
.B \-l, \-\-label=\fItext\fP
Sets the unencrypted label for the key.
.TP
.B \-o, \-\-output\-file=\fIfilename\fP
The file to write the private key to. The public key file has a ".pub"
appended to the end of it. The default output file is "~/.lsh/identity".
.TP
.B \-f, \-\-output\-format=\fIformat\fP
Specifies the variant of the S-expression syntax to generate. Valid formats are
"transport", "canonical", "advanced" and "international".
.TP
.B \-p, \-\-passphrase=\fIpassword\fP
Specifies a passphrase for the private key.
.TP
.B \-\-server
Use the server seed file, and change the default output file to
/etc/lsh_host_key.
.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 ENVIRONMENT
.TP
HOME
The user's home directory.
.SH FILES
.TP
~/.lsh/identity
Default location where the private key is stored.
~/.lsh/identity.pub
Default location where the public key is stored.
/etc/lsh_host_key, /etc/lsh_host_key.pub
The server's private and public host keys.
.SH EXAMPLE
A typical usage of lsh-writekey is:

lsh-keygen -l 8 | lsh-writekey

which generates a public / private key pair using \fBlsh-keygen(1)\fP and
stores it to the default ~/.lsh/identity.
.SH SEE ALSO
.BR lsh-keygen (1),
.BR lsh-make-seed (1),
.BR lsh (1),
.BR lshd (8),
.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).