diff options
Diffstat (limited to 'usr/src/man/man1/ssh-keygen.1')
-rw-r--r-- | usr/src/man/man1/ssh-keygen.1 | 67 |
1 files changed, 8 insertions, 59 deletions
diff --git a/usr/src/man/man1/ssh-keygen.1 b/usr/src/man/man1/ssh-keygen.1 index d1a4419538..ef8927f664 100644 --- a/usr/src/man/man1/ssh-keygen.1 +++ b/usr/src/man/man1/ssh-keygen.1 @@ -2,19 +2,19 @@ .\" To view license terms, attribution, and copyright for OpenSSH, the default path is /var/sadm/pkg/SUNWsshdr/install/copyright. If the Solaris operating environment has been installed anywhere other than the default, modify the given path to access the file at the .\" installed location. .\" Portions Copyright (c) 2009, Sun Microsystems, Inc. All Rights Reserved. -.TH ssh-keygen 1 "17 Feb 2009" "SunOS 5.11" "User Commands" +.TH SSH-KEYGEN 1 "Feb 17, 2009" .SH NAME ssh-keygen \- authentication key generation .SH SYNOPSIS .LP .nf -\fBssh-keygen\fR [\fB-q\fR] [\fB-b\fR \fIbits\fR ] \fB-t\fR \fItype\fR [\fB-N\fR \fInew_passphrase\fR] +\fBssh-keygen\fR [\fB-q\fR] [\fB-b\fR \fIbits\fR ] \fB-t\fR \fItype\fR [\fB-N\fR \fInew_passphrase\fR] [\fB-C\fR \fIcomment\fR] [\fB-f\fR \fIoutput_keyfile\fR] .fi .LP .nf -\fBssh-keygen\fR \fB-p\fR [\fB-P\fR \fIold_passphrase\fR] [\fB-N\fR \fInew_passphrase\fR] +\fBssh-keygen\fR \fB-p\fR [\fB-P\fR \fIold_passphrase\fR] [\fB-N\fR \fInew_passphrase\fR] [\fB-f\fR \fIkeyfile\fR] .fi @@ -113,12 +113,10 @@ activate them. The following options are supported: .sp .ne 2 -.mk .na \fB\fB-b\fR \fIbits\fR\fR .ad .RS 21n -.rt Specifies the number of bits in the key to create. The minimum number is 512 bits. Generally, 1024 bits is considered sufficient. Key sizes above that no longer improve security but make things slower. The default is 1024 bits. @@ -126,23 +124,19 @@ longer improve security but make things slower. The default is 1024 bits. .sp .ne 2 -.mk .na \fB\fB-B\fR\fR .ad .RS 21n -.rt Shows the bubblebabble digest of the specified private or public key file. .RE .sp .ne 2 -.mk .na \fB\fB-c\fR\fR .ad .RS 21n -.rt Requests changing the comment in the private and public key files. The program prompts for the file containing the private keys, for the passphrase if the key has one, and for the new comment. @@ -152,23 +146,19 @@ This option only applies to \fBrsa1\fR (\fBSSHv1\fR) keys. .sp .ne 2 -.mk .na \fB\fB-C\fR \fIcomment\fR\fR .ad .RS 21n -.rt Provides the new comment. .RE .sp .ne 2 -.mk .na \fB\fB-e\fR\fR .ad .RS 21n -.rt This option reads a private or public OpenSSH key file and prints the key in a "SECSH" Public Key File Format to stdout. This option allows exporting keys for use by several other SSH implementations. @@ -176,23 +166,19 @@ use by several other SSH implementations. .sp .ne 2 -.mk .na \fB\fB-f\fR\fR .ad .RS 21n -.rt Specifies the filename of the key file. .RE .sp .ne 2 -.mk .na \fB\fB-F\fR\fR .ad .RS 21n -.rt Search for the specified \fIhostname\fR in a \fBknown_hosts\fR file, listing any occurrences found. This option is useful to find hashed host names or addresses and can also be used in conjunction with the \fB-H\fR option to print @@ -201,12 +187,10 @@ found keys in a hashed format. .sp .ne 2 -.mk .na \fB\fB-H\fR\fR .ad .RS 21n -.rt Hash a \fBknown_hosts\fR file. This replaces all host names and addresses with hashed representations within the specified file. The original content is moved to a file with a \fB\&.old\fR suffix. These hashes may be used normally by @@ -218,12 +202,10 @@ names. .sp .ne 2 -.mk .na \fB\fB-i\fR\fR .ad .RS 21n -.rt This option reads an unencrypted private (or public) key file in SSH2-compatible format and prints an OpenSSH compatible private (or public) key to stdout. \fBssh-keygen\fR also reads the "SECSH" Public Key File Format. This @@ -232,34 +214,28 @@ option allows importing keys from several other SSH implementations. .sp .ne 2 -.mk .na \fB\fB-l\fR\fR .ad .RS 21n -.rt Shows the fingerprint of the specified private or public key file. .RE .sp .ne 2 -.mk .na \fB\fB-N\fR \fInew_passphrase\fR\fR .ad .RS 21n -.rt Provides the new passphrase. .RE .sp .ne 2 -.mk .na \fB\fB-p\fR\fR .ad .RS 21n -.rt Requests changing the passphrase of a private key file instead of creating a new private key. The program prompts for the file containing the private key, for the old passphrase, and prompts twice for the new passphrase. @@ -267,80 +243,66 @@ for the old passphrase, and prompts twice for the new passphrase. .sp .ne 2 -.mk .na \fB\fB-P\fR \fIpassphrase\fR\fR .ad .RS 21n -.rt Provides the (old) passphrase. .RE .sp .ne 2 -.mk .na \fB\fB-q\fR\fR .ad .RS 21n -.rt Silences \fBssh-keygen\fR. .RE .sp .ne 2 -.mk .na \fB\fB-t\fR \fItype\fR\fR .ad .RS 21n -.rt Specifies the algorithm used for the key, where \fItype\fR is one of \fBrsa\fR, \fBdsa\fR, and \fBrsa1\fR. Type \fBrsa1\fR is used only for the SSHv1 protocol. .RE .sp .ne 2 -.mk .na \fB\fB-R\fR \fIhostname\fR\fR .ad .RS 21n -.rt Removes all keys belonging to \fIhostname\fR from a \fBknown_hosts\fR file. This option is useful to delete hashed hosts. See \fB-H\fR. .RE .sp .ne 2 -.mk .na \fB\fB-x\fR\fR .ad .RS 21n -.rt Obsolete. Replaced by the \fB-e\fR option. .RE .sp .ne 2 -.mk .na \fB\fB-X\fR\fR .ad .RS 21n -.rt Obsolete. Replaced by the \fB-i\fR option. .RE .sp .ne 2 -.mk .na \fB\fB-y\fR\fR .ad .RS 21n -.rt This option reads a private OpenSSH format file and prints an OpenSSH public key to stdout. .RE @@ -351,35 +313,29 @@ key to stdout. The following exit values are returned: .sp .ne 2 -.mk .na \fB\fB0\fR\fR .ad .RS 5n -.rt Successful completion. .RE .sp .ne 2 -.mk .na \fB\fB1\fR\fR .ad .RS 5n -.rt An error occurred. .RE .SH FILES .sp .ne 2 -.mk .na \fB\fB$HOME/.ssh/identity\fR\fR .ad .RS 27n -.rt This file contains the RSA private key for the SSHv1 protocol. This file should not be readable by anyone but the user. It is possible to specify a passphrase when generating the key; that passphrase is used to encrypt the private part of @@ -390,12 +346,10 @@ this file using 3DES. This file is not automatically accessed by .sp .ne 2 -.mk .na \fB\fB$HOME/.ssh/identity.pub\fR\fR .ad .RS 27n -.rt This file contains the RSA public key for the SSHv1 protocol. The contents of this file should be added to \fB$HOME/.ssh/authorized_keys\fR on all machines where you wish to log in using \fBRSA\fR authentication. There is no need to @@ -404,7 +358,6 @@ keep the contents of this file secret. .sp .ne 2 -.mk .na \fB\fB$HOME/.ssh/id_dsa\fR\fR .ad @@ -413,7 +366,6 @@ keep the contents of this file secret. \fB\fB$HOME/.ssh/id_rsa\fR\fR .ad .RS 27n -.rt These files contain, respectively, the DSA or RSA private key for the SSHv2 protocol. These files should not be readable by anyone but the user. It is possible to specify a passphrase when generating the key; that passphrase is @@ -425,7 +377,6 @@ is made. .sp .ne 2 -.mk .na \fB\fB$HOME/.ssh/id_dsa.pub\fR\fR .ad @@ -434,7 +385,6 @@ is made. \fB\fB$HOME/.ssh/id_rsa.pub\fR\fR .ad .RS 27n -.rt These files contain, respectively, the DSA or RSA public key for the SSHv2 protocol. The contents of these files should be added, respectively, to \fB$HOME/.ssh/authorized_keys\fR on all machines where you wish to log in using @@ -450,13 +400,12 @@ See \fBattributes\fR(5) for descriptions of the following attributes: .sp .TS -tab() box; -cw(2.75i) |cw(2.75i) -lw(2.75i) |lw(2.75i) -. -ATTRIBUTE TYPEATTRIBUTE VALUE +box; +c | c +l | l . +ATTRIBUTE TYPE ATTRIBUTE VALUE _ -Interface StabilityCommitted +Interface Stability Committed .TE .SH SEE ALSO |