Rev 2 | Go to most recent revision | Only display areas with differences | Ignore whitespace | Details | Blame | Last modification | View Log | RSS feed
Rev 2 | Rev 5 | ||
---|---|---|---|
1 | .\" Hey, EMACS: -*- nroff -*- |
1 | .\" Hey, EMACS: -*- nroff -*- |
2 | .\" First parameter, NAME, should be all caps |
2 | .\" First parameter, NAME, should be all caps |
3 | .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection |
3 | .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection |
4 | .\" other parameters are allowed: see man(7), man(1) |
4 | .\" other parameters are allowed: see man(7), man(1) |
5 | .TH LSH-WRITEKEY 1 "Aug 21 2002" lsh-writekey "lsh manuals" |
5 | .TH LSH-WRITEKEY 1 "Aug 21 2002" lsh-writekey "lsh manuals" |
6 | .\" Please adjust this date whenever revising the manpage. |
6 | .\" Please adjust this date whenever revising the manpage. |
7 | .\" |
7 | .\" |
8 | .\" Some roff macros, for reference: |
8 | .\" Some roff macros, for reference: |
9 | .\" .nh disable hyphenation |
9 | .\" .nh disable hyphenation |
10 | .\" .hy enable hyphenation |
10 | .\" .hy enable hyphenation |
11 | .\" .ad l left justify |
11 | .\" .ad l left justify |
12 | .\" .ad b justify to both left and right margins |
12 | .\" .ad b justify to both left and right margins |
13 | .\" .nf disable filling |
13 | .\" .nf disable filling |
14 | .\" .fi enable filling |
14 | .\" .fi enable filling |
15 | .\" .br insert line break |
15 | .\" .br insert line break |
16 | .\" .sp <n> insert n+1 empty lines |
16 | .\" .sp <n> insert n+1 empty lines |
17 | .\" for manpage-specific macros, see man(7) |
17 | .\" for manpage-specific macros, see man(7) |
18 | .SH NAME |
18 | .SH NAME |
19 | lsh-writekey \- store a public / private key pair. |
19 | lsh-writekey \- store a public / private key pair. |
20 | .SH SYNOPSIS |
20 | .SH SYNOPSIS |
21 | .B lsh-writekey |
21 | .B lsh-writekey |
22 | .RI [ options ] |
22 | .RI [ options ] |
23 | .SH DESCRIPTION |
23 | .SH DESCRIPTION |
24 | This manual page documents briefly the |
24 | This manual page documents briefly the |
25 | .B lsh-writekey |
25 | .B lsh-writekey |
26 | command. |
26 | command. |
27 | This manual page was written for the Debian distribution |
27 | This manual page was written for the Debian distribution |
28 | because the original program does not have a manual page. |
28 | because the original program does not have a manual page. |
29 | Instead, it has documentation in the GNU Info format; see below. |
29 | Instead, it has documentation in the GNU Info format; see below. |
30 | .PP |
30 | .PP |
31 | .\" TeX users may be more comfortable with the \fB<whatever>\fP and |
31 | .\" TeX users may be more comfortable with the \fB<whatever>\fP and |
32 | .\" \fI<whatever>\fP escape sequences to invode bold face and italics, |
32 | .\" \fI<whatever>\fP escape sequences to invode bold face and italics, |
33 | .\" respectively. |
33 | .\" respectively. |
34 | \fBlsh-writekey\fP is a program that reads a public / private key pair in |
34 | \fBlsh-writekey\fP is a program that reads a public / private key pair in |
35 | \fBSPKI(5)\fP format on stdin, separates the public and private sections of |
35 | \fBSPKI(5)\fP format on stdin, separates the public and private sections of |
36 | the key and writes them to separate files. |
36 | the key and writes them to separate files. |
37 | .SH OPTIONS |
37 | .SH OPTIONS |
38 | This program follows the usual GNU command line syntax, with long |
38 | This program follows the usual GNU command line syntax, with long |
39 | options starting with two dashes (`-'). |
39 | options starting with two dashes (`-'). |
40 | A summary of options is included below. |
40 | A summary of options is included below. |
41 | For a complete description, see the Info files. |
41 | For a complete description, see the Info files. |
42 | .TP |
42 | .TP |
43 | .B \-c, \-\-crypto=\fIalgorithm\fP |
43 | .B \-c, \-\-crypto=\fIalgorithm\fP |
44 | Encryption algorithm to use on the private key file. |
44 | Encryption algorithm to use on the private key file. |
45 | .TP |
45 | .TP |
46 | .B \-i, \-\-iteration\-count=\fIPKCS#5\fP |
46 | .B \-i, \-\-iteration\-count=\fIPKCS#5\fP |
47 | Iteration count, the default is 1500. |
47 | Iteration count, the default is 1500. |
48 | .TP |
48 | .TP |
49 | .B \-l, \-\-label=\fItext\fP |
49 | .B \-l, \-\-label=\fItext\fP |
50 | Sets the unencrypted label for the key. |
50 | Sets the unencrypted label for the key. |
51 | .TP |
51 | .TP |
52 | .B \-o, \-\-output\-file=\fIfilename\fP |
52 | .B \-o, \-\-output\-file=\fIfilename\fP |
53 | The file to write the private key to. The public key file has a ".pub" |
53 | The file to write the private key to. The public key file has a ".pub" |
54 | appended to the end of it. The default output file is "~/.lsh/identity". |
54 | appended to the end of it. The default output file is "~/.lsh/identity". |
55 | .TP |
55 | .TP |
56 | .B \-f, \-\-output\-format=\fIformat\fP |
56 | .B \-f, \-\-output\-format=\fIformat\fP |
57 | Specifies the variant of the S-expression syntax to generate. Valid formats are |
57 | Specifies the variant of the S-expression syntax to generate. Valid formats are |
58 | "transport", "canonical", "advanced" and "international". |
58 | "transport", "canonical", "advanced" and "international". |
59 | .TP |
59 | .TP |
60 | .B \-p, \-\-passphrase=\fIpassword\fP |
60 | .B \-p, \-\-passphrase=\fIpassword\fP |
61 | Specifies a passphrase for the private key. |
61 | Specifies a passphrase for the private key. |
62 | .TP |
62 | .TP |
63 | .B \-\-server |
63 | .B \-\-server |
64 | Use the server seed file, and change the default output file to |
64 | Use the server seed file, and change the default output file to |
65 | /etc/lsh_host_key. |
65 | /etc/lsh_host_key. |
66 | .TP |
66 | .TP |
67 | .B \-\-debug |
67 | .B \-\-debug |
68 | Print huge amounts of debug information. |
68 | Print huge amounts of debug information. |
69 | .TP |
69 | .TP |
70 | .B \-\-log\-file=\fIfile\fP |
70 | .B \-\-log\-file=\fIfile\fP |
71 | Append messages to \fIfile\fP. |
71 | Append messages to \fIfile\fP. |
72 | .TP |
72 | .TP |
73 | .B \-q, \-\-quiet |
73 | .B \-q, \-\-quiet |
74 | Suppress all warnings and diagnostic messages. |
74 | Suppress all warnings and diagnostic messages. |
75 | .TP |
75 | .TP |
76 | .B \-\-trace |
76 | .B \-\-trace |
77 | Print a detailed program trace. |
77 | Print a detailed program trace. |
78 | .TP |
78 | .TP |
79 | .B \-v, \-\-verbose |
79 | .B \-v, \-\-verbose |
80 | Print verbose diagnostic messages |
80 | Print verbose diagnostic messages |
81 | .TP |
81 | .TP |
82 | .B \-?, \-\-help |
82 | .B \-?, \-\-help |
83 | Show summary of options. |
83 | Show summary of options. |
84 | .TP |
84 | .TP |
85 | .B \-\-usage |
85 | .B \-\-usage |
86 | Show a short usage message. |
86 | Show a short usage message. |
87 | .TP |
87 | .TP |
88 | .B \-V, \-\-version |
88 | .B \-V, \-\-version |
89 | Show version of program. |
89 | Show version of program. |
90 | .SH ENVIRONMENT |
90 | .SH ENVIRONMENT |
91 | .TP |
91 | .TP |
92 | HOME |
92 | HOME |
93 | The user's home directory. |
93 | The user's home directory. |
94 | .SH FILES |
94 | .SH FILES |
95 | .TP |
95 | .TP |
96 | ~/.lsh/identity |
96 | ~/.lsh/identity |
97 | Default location where the private key is stored. |
97 | Default location where the private key is stored. |
98 | ~/.lsh/identity.pub |
98 | ~/.lsh/identity.pub |
99 | Default location where the public key is stored. |
99 | Default location where the public key is stored. |
100 | /etc/lsh_host_key, /etc/lsh_host_key.pub |
100 | /etc/lsh_host_key, /etc/lsh_host_key.pub |
101 | The server's private and public host keys. |
101 | The server's private and public host keys. |
102 | .SH EXAMPLE |
102 | .SH EXAMPLE |
103 | A typical usage of lsh-writekey is: |
103 | A typical usage of lsh-writekey is: |
104 | 104 | ||
105 | lsh-keygen -l 8 | lsh-writekey |
105 | lsh-keygen -l 8 | lsh-writekey |
106 | 106 | ||
107 | which generates a public / private key pair using \fBlsh-keygen(1)\fP and |
107 | which generates a public / private key pair using \fBlsh-keygen(1)\fP and |
108 | stores it to the default ~/.lsh/identity. |
108 | stores it to the default ~/.lsh/identity. |
109 | .SH SEE ALSO |
109 | .SH SEE ALSO |
110 | .BR lsh-keygen (1), |
110 | .BR lsh-keygen (1), |
111 | .BR lsh-make-seed (1), |
111 | .BR lsh-make-seed (1), |
112 | .BR lshc (1), |
112 | .BR lshc (1), |
113 | .BR lshd (8), |
113 | .BR lshd (8), |
114 | .BR SPKI (5). |
114 | .BR SPKI (5). |
115 | .BR |
115 | .BR |
116 | The programs are documented fully by |
116 | The programs are documented fully by |
117 | .IR "Lsh" , |
117 | .IR "Lsh" , |
118 | available via the Info system. |
118 | available via the Info system. |
119 | .SH AUTHOR |
119 | .SH AUTHOR |
120 | This manual page was written by Timshel Knoll <timshel@debian.org>, |
120 | This manual page was written by Timshel Knoll <timshel@debian.org>, |
121 | for the Debian GNU/Linux system (but may be used by others). |
121 | for the Debian GNU/Linux system (but may be used by others). |