annotate dropbearkey.1 @ 1060:4c733310c21d nocircbuffer

reword comment for clarity
author Matt Johnston <matt@ucc.asn.au>
date Sun, 01 Mar 2015 23:26:42 +0800
parents 295a08e9d07e
children cdea5dbb1755
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
820
830fae485d40 Add manpage for dropbearconvert
Matt Johnston <matt@ucc.asn.au>
parents: 690
diff changeset
1 .TH dropbearkey 1
128
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
2 .SH NAME
820
830fae485d40 Add manpage for dropbearconvert
Matt Johnston <matt@ucc.asn.au>
parents: 690
diff changeset
3 dropbearkey \- create private keys for the use with dropbear(8) or dbclient(1)
128
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
4 .SH SYNOPSIS
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
5 .B dropbearkey
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
6 \-t
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
7 .I type
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
8 \-f
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
9 .I file
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
10 [\-s
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
11 .IR bits ]
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
12 .SH DESCRIPTION
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
13 .B dropbearkey
514
e30a962c09b9 Mention DSS and DSA being the same thing
Matt Johnston <matt@ucc.asn.au>
parents: 181
diff changeset
14 generates a
860
057204b3dd61 docs for ecdsa
Matt Johnston <matt@ucc.asn.au>
parents: 820
diff changeset
15 .I RSA
057204b3dd61 docs for ecdsa
Matt Johnston <matt@ucc.asn.au>
parents: 820
diff changeset
16 .I DSS,
128
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
17 or
860
057204b3dd61 docs for ecdsa
Matt Johnston <matt@ucc.asn.au>
parents: 820
diff changeset
18 .I ECDSA
514
e30a962c09b9 Mention DSS and DSA being the same thing
Matt Johnston <matt@ucc.asn.au>
parents: 181
diff changeset
19 format SSH private key, and saves it to a file for the use with the
820
830fae485d40 Add manpage for dropbearconvert
Matt Johnston <matt@ucc.asn.au>
parents: 690
diff changeset
20 Dropbear client or server.
514
e30a962c09b9 Mention DSS and DSA being the same thing
Matt Johnston <matt@ucc.asn.au>
parents: 181
diff changeset
21 Note that
e30a962c09b9 Mention DSS and DSA being the same thing
Matt Johnston <matt@ucc.asn.au>
parents: 181
diff changeset
22 some SSH implementations
e30a962c09b9 Mention DSS and DSA being the same thing
Matt Johnston <matt@ucc.asn.au>
parents: 181
diff changeset
23 use the term "DSA" rather than "DSS", they mean the same thing.
128
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
24 .SH OPTIONS
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
25 .TP
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
26 .B \-t \fItype
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
27 Type of key to generate.
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
28 Must be one of
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
29 .I rsa
860
057204b3dd61 docs for ecdsa
Matt Johnston <matt@ucc.asn.au>
parents: 820
diff changeset
30 .I ecdsa
128
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
31 or
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
32 .IR dss .
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
33 .TP
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
34 .B \-f \fIfile
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
35 Write the secret key to the file
999
295a08e9d07e Document ~/.ssh/id_dropbear
Matt Johnston <matt@ucc.asn.au>
parents: 860
diff changeset
36 .IR file . For client authentication ~/.ssh/id_dropbear is loaded by default
128
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
37 .TP
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
38 .B \-s \fIbits
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
39 Set the key size to
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
40 .I bits
860
057204b3dd61 docs for ecdsa
Matt Johnston <matt@ucc.asn.au>
parents: 820
diff changeset
41 bits, should be multiple of 8 (optional).
820
830fae485d40 Add manpage for dropbearconvert
Matt Johnston <matt@ucc.asn.au>
parents: 690
diff changeset
42 .SH NOTES
830fae485d40 Add manpage for dropbearconvert
Matt Johnston <matt@ucc.asn.au>
parents: 690
diff changeset
43 The program dropbearconvert(1) can be used to convert between Dropbear and OpenSSH key formats.
830fae485d40 Add manpage for dropbearconvert
Matt Johnston <matt@ucc.asn.au>
parents: 690
diff changeset
44 .P
830fae485d40 Add manpage for dropbearconvert
Matt Johnston <matt@ucc.asn.au>
parents: 690
diff changeset
45 Dropbear does not support encrypted keys.
128
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
46 .SH EXAMPLE
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
47 # dropbearkey -t rsa -f /etc/dropbear/dropbear_rsa_host_key
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
48 .SH AUTHOR
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
49 Matt Johnston ([email protected]).
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
50 .br
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
51 Gerrit Pape ([email protected]) wrote this manual page.
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
52 .SH SEE ALSO
820
830fae485d40 Add manpage for dropbearconvert
Matt Johnston <matt@ucc.asn.au>
parents: 690
diff changeset
53 dropbear(8), dbclient(1), dropbearconvert(1)
128
a9dddd13c4ba Added dropbear.8 and dropbearkey.8 back in
Matt Johnston <matt@ucc.asn.au>
parents:
diff changeset
54 .P
690
4b47ff154ff6 Document "-m" and "-c"
Matt Johnston <matt@ucc.asn.au>
parents: 514
diff changeset
55 https://matt.ucc.asn.au/dropbear/dropbear.html