The man2html from jbasney on pkilab2 works whereas the standard one doesn't.

[gssapi-openssh.git] / openssh / ssh-add.1

diff --git a/openssh/ssh-add.1 b/openssh/ssh-add.1
index 327fcddaeff2af1f4a306c09eb93f95e34a8f0e5..b842080d632ae497d37682457c8dec8e061662b5 100644 (file)
--- a/openssh/ssh-add.1
+++ b/openssh/ssh-add.1
@@ -1,4 +1,4 @@
-.\"    $OpenBSD: ssh-add.1,v 1.43 2005/04/21 06:17:50 djm Exp $
+.\"    $OpenBSD: ssh-add.1,v 1.27 2001/08/23 18:08:59 stevesk Exp $

 .\"
 .\"  -*- nroff -*-
 .\"
 .\"
 .\"  -*- nroff -*-
 .\"


@@ -45,8 +45,7 @@
 .Nd adds RSA or DSA identities to the authentication agent
 .Sh SYNOPSIS
 .Nm ssh-add
 .Nd adds RSA or DSA identities to the authentication agent
 .Sh SYNOPSIS
 .Nm ssh-add

-.Op Fl cDdLlXx
-.Op Fl t Ar life
+.Op Fl lLdD

 .Op Ar
 .Nm ssh-add
 .Fl s Ar reader
 .Op Ar
 .Nm ssh-add
 .Fl s Ar reader


@@ -56,11 +55,8 @@
 .Nm
 adds RSA or DSA identities to the authentication agent,
 .Xr ssh-agent 1 .
 .Nm
 adds RSA or DSA identities to the authentication agent,
 .Xr ssh-agent 1 .

-When run without arguments, it adds the files
-.Pa ~/.ssh/id_rsa ,
-.Pa ~/.ssh/id_dsa
-and
-.Pa ~/.ssh/identity .
+When run without arguments, it adds the file
+.Pa $HOME/.ssh/identity .

 Alternative file names can be given on the command line.
 If any file requires a passphrase,
 .Nm
 Alternative file names can be given on the command line.
 If any file requires a passphrase,
 .Nm


@@ -69,47 +65,46 @@ The passphrase is read from the user's tty.
 .Nm
 retries the last passphrase if multiple identity files are given.
 .Pp
 .Nm
 retries the last passphrase if multiple identity files are given.
 .Pp

-The authentication agent must be running and the
-.Ev SSH_AUTH_SOCK
-environment variable must contain the name of its socket for
+The authentication agent must be running and must be an ancestor of
+the current process for

 .Nm
 to work.
 .Pp
 The options are as follows:
 .Bl -tag -width Ds
 .Nm
 to work.
 .Pp
 The options are as follows:
 .Bl -tag -width Ds

-.It Fl c
-Indicates that added identities should be subject to confirmation before
-being used for authentication.
-Confirmation is performed by the
-.Ev SSH_ASKPASS
-program mentioned below.
-Successful confirmation is signaled by a zero exit status from the
-.Ev SSH_ASKPASS
-program, rather than text entered into the requester.
-.It Fl D
-Deletes all identities from the agent.
-.It Fl d
-Instead of adding the identity, removes the identity from the agent.
-.It Fl e Ar reader
-Remove key in smartcard
-.Ar reader .
-.It Fl L
-Lists public key parameters of all identities currently represented
-by the agent.

 .It Fl l
 Lists fingerprints of all identities currently represented by the agent.
 .It Fl l
 Lists fingerprints of all identities currently represented by the agent.

+.It Fl L
+Lists public key parameters of all identities currently represented by the agent.
+.It Fl d
+Instead of adding the identity, removes the identity from the agent.
+.It Fl D
+Deletes all identities from the agent.

 .It Fl s Ar reader
 Add key in smartcard
 .Ar reader .
 .It Fl s Ar reader
 Add key in smartcard
 .Ar reader .

-.It Fl t Ar life
-Set a maximum lifetime when adding identities to an agent.
-The lifetime may be specified in seconds or in a time format
-specified in
-.Xr sshd_config 5 .
-.It Fl X
-Unlock the agent.
-.It Fl x
-Lock the agent with a password.
+.It Fl e Ar reader
+Remove key in smartcard
+.Ar reader .
+.El
+.Sh FILES
+.Bl -tag -width Ds
+.It Pa $HOME/.ssh/identity
+Contains the protocol version 1 RSA authentication identity of the user.
+This file should not be readable by anyone but the user.
+Note that
+.Nm
+ignores this file if it is accessible by others.
+It is possible to
+specify a passphrase when generating the key; that passphrase will be
+used to encrypt the private part of this file.
+This is the default file added by
+.Nm
+when no other files have been specified.
+.It Pa $HOME/.ssh/id_dsa
+Contains the protocol version 2 DSA authentication identity of the user.
+.It Pa $HOME/.ssh/id_rsa
+Contains the protocol version 2 RSA authentication identity of the user.

 .El
 .Sh ENVIRONMENT
 .Bl -tag -width Ds
 .El
 .Sh ENVIRONMENT
 .Bl -tag -width Ds


@@ -130,40 +125,13 @@ and open an X11 window to read the passphrase.
 This is particularly useful when calling
 .Nm
 from a
 This is particularly useful when calling
 .Nm
 from a

-.Pa .xsession
+.Pa .Xsession

 or related script.
 (Note that on some machines it
 may be necessary to redirect the input from
 .Pa /dev/null
 to make this work.)
 or related script.
 (Note that on some machines it
 may be necessary to redirect the input from
 .Pa /dev/null
 to make this work.)

-.It Ev SSH_AUTH_SOCK
-Identifies the path of a unix-domain socket used to communicate with the
-agent.
-.El
-.Sh FILES
-.Bl -tag -width Ds
-.It Pa ~/.ssh/identity
-Contains the protocol version 1 RSA authentication identity of the user.
-.It Pa ~/.ssh/id_dsa
-Contains the protocol version 2 DSA authentication identity of the user.
-.It Pa ~/.ssh/id_rsa
-Contains the protocol version 2 RSA authentication identity of the user.

 .El
 .El

-.Pp
-Identity files should not be readable by anyone but the user.
-Note that
-.Nm
-ignores identity files if they are accessible by others.
-.Sh DIAGNOSTICS
-Exit status is 0 on success, 1 if the specified command fails,
-and 2 if
-.Nm
-is unable to contact the authentication agent.
-.Sh SEE ALSO
-.Xr ssh 1 ,
-.Xr ssh-agent 1 ,
-.Xr ssh-keygen 1 ,
-.Xr sshd 8

 .Sh AUTHORS
 OpenSSH is a derivative of the original and free
 ssh 1.2.12 release by Tatu Ylonen.
 .Sh AUTHORS
 OpenSSH is a derivative of the original and free
 ssh 1.2.12 release by Tatu Ylonen.


@@ -173,3 +141,8 @@ removed many bugs, re-added newer features and
 created OpenSSH.
 Markus Friedl contributed the support for SSH
 protocol versions 1.5 and 2.0.
 created OpenSSH.
 Markus Friedl contributed the support for SSH
 protocol versions 1.5 and 2.0.

+.Sh SEE ALSO
+.Xr ssh 1 ,
+.Xr ssh-agent 1 ,
+.Xr ssh-keygen 1 ,
+.Xr sshd 8