- stevesk@cvs.openbsd.org 2001/05/05 13:42:52

[openssh.git] / ssh-keygen.1

diff --git a/ssh-keygen.1 b/ssh-keygen.1
index 6808ede698c4e0f19be2e52481dcb8cd034467c3..f85357c7a7d01c5ad95cc8aed61d4502a05dbac7 100644 (file)
--- a/ssh-keygen.1
+++ b/ssh-keygen.1
@@ -1,4 +1,4 @@
-.\"    $OpenBSD: ssh-keygen.1,v 1.36 2001/04/10 09:13:21 itojun Exp $
+.\"    $OpenBSD: ssh-keygen.1,v 1.41 2001/05/05 13:42:52 stevesk Exp $
 .\"
 .\"  -*- nroff -*-
 .\"
@@ -42,7 +42,7 @@
 .Os
 .Sh NAME
 .Nm ssh-keygen
-.Nd authentication key generation
+.Nd authentication key generation, management and conversion
 .Sh SYNOPSIS
 .Nm ssh-keygen
 .Op Fl q
@@ -57,10 +57,10 @@
 .Op Fl N Ar new_passphrase
 .Op Fl f Ar keyfile
 .Nm ssh-keygen
-.Fl x
+.Fl i
 .Op Fl f Ar input_keyfile
 .Nm ssh-keygen
-.Fl X
+.Fl e
 .Op Fl f Ar input_keyfile
 .Nm ssh-keygen
 .Fl y
@@ -78,13 +78,13 @@
 .Op Fl f Ar input_keyfile
 .Sh DESCRIPTION
 .Nm
-generates and manages authentication keys for
+generates, manages and converts authentication keys for
 .Xr ssh 1 .
 .Nm
-defaults to generating an RSA key for use by protocols 1.3 and 1.5;
+defaults to generating a RSA1 key for use by SSH protocol version 1.
 specifying the
 .Fl t
-option allows you to create a key for use by protocol 2.0.
+option allows you to create a key for use by SSH protocol version 2.
 .Pp
 Normally each user wishing to use SSH
 with RSA or DSA authentication runs this once to create the authentication
@@ -119,7 +119,8 @@ If the passphrase is
 lost or forgotten, you will have to generate a new key and copy the
 corresponding public key to other machines.
 .Pp
-For RSA, there is also a comment field in the key file that is only for
+For RSA1 keys,
+there is also a comment field in the key file that is only for
 convenience to the user to help identify the key.
 The comment can tell what the key is for, or whatever is useful.
 The comment is initialized to
@@ -142,9 +143,25 @@ The default is 1024 bits.
 .It Fl c
 Requests changing the comment in the private and public key files.
 The program will prompt for the file containing the private keys, for
-passphrase if the key has one, and for the new comment.
+the passphrase if the key has one, and for the new comment.
+.It Fl e
+This option will read a private or public OpenSSH key file and
+print the key in a
+.Sq SECSH Public Key File Format
+to stdout.
+This option allows exporting keys for use by several commercial
+SSH implementations.
 .It Fl f
 Specifies the filename of the key file.
+.It Fl i
+This option will read an unencrypted private (or public) key file
+in SSH2-compatible format and print an OpenSSH compatible private
+(or public) key to stdout.
+.Nm
+also reads the
+.Sq SECSH Public Key File Format .
+This option allows importing keys from several commercial
+SSH implementations.
 .It Fl l
 Show fingerprint of specified private or public key file.
 .It Fl p
@@ -159,6 +176,9 @@ Silence
 Used by
 .Pa /etc/rc
 when creating a new key.
+.It Fl y
+This option will read a private
+OpenSSH format file and print an OpenSSH public key to stdout.
 .It Fl t Ar type
 Specifies the type of the key to create.
 The possible values are
@@ -178,16 +198,6 @@ Provides the new comment.
 Provides the new passphrase.
 .It Fl P Ar passphrase
 Provides the (old) passphrase.
-.It Fl x
-This option will read a private
-OpenSSH DSA format file and print a SSH2-compatible public key to stdout.
-.It Fl X
-This option will read a unencrypted
-SSH2-compatible private (or public) key file and
-print an OpenSSH compatible private (or public) key to stdout.
-.It Fl y
-This option will read a private
-OpenSSH format file and print an OpenSSH public key to stdout.
 .El
 .Sh FILES
 .Bl -tag -width Ds
@@ -260,3 +270,11 @@ protocol versions 1.5 and 2.0.
 .Xr ssh-add 1 ,
 .Xr ssh-agent 1 ,
 .Xr sshd 8
+.Rs
+.%A J. Galbraith
+.%A R. Thayer
+.%T "SECSH Public Key File Format"
+.%N draft-ietf-secsh-publickeyfile-01.txt
+.%D March 2001
+.%O work in progress material
+.Re