- dtucker@cvs.openbsd.org 2010/01/12 00:16:47

[openssh.git] / ssh-add.1

diff --git a/ssh-add.1 b/ssh-add.1
index 6348197b332aa3493905bf854a9c7b00b32e2185..2e909ab13d58357e98a31ce2c228c90919e08bfe 100644 (file)
--- a/ssh-add.1
+++ b/ssh-add.1
@@ -1,4 +1,4 @@
-.\"    $OpenBSD: ssh-add.1,v 1.40 2003/11/25 23:10:08 matthieu Exp $
+.\"    $OpenBSD: ssh-add.1,v 1.48 2009/10/22 15:02:12 sobrado Exp $

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


@@ -37,7 +37,7 @@
 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"
 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 .\"

-.Dd September 25, 1999
+.Dd $Mdocdate$

 .Dt SSH-ADD 1
 .Os
 .Sh NAME
 .Dt SSH-ADD 1
 .Os
 .Sh NAME


@@ -45,7 +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 lLdDxXc
+.Op Fl cDdLlXx

 .Op Fl t Ar life
 .Op Ar
 .Nm ssh-add
 .Op Fl t Ar life
 .Op Ar
 .Nm ssh-add


@@ -57,10 +57,10 @@
 adds RSA or DSA identities to the authentication agent,
 .Xr ssh-agent 1 .
 When run without arguments, it adds the files
 adds RSA or DSA identities to the authentication agent,
 .Xr ssh-agent 1 .
 When run without arguments, it adds the files

-.Pa $HOME/.ssh/id_rsa ,
-.Pa $HOME/.ssh/id_dsa
+.Pa ~/.ssh/id_rsa ,
+.Pa ~/.ssh/id_dsa

 and
 and

-.Pa $HOME/.ssh/identity .
+.Pa ~/.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


@@ -77,23 +77,6 @@ to work.
 .Pp
 The options are as follows:
 .Bl -tag -width Ds
 .Pp
 The options are as follows:
 .Bl -tag -width Ds

-.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 x
-Lock the agent with a password.
-.It Fl X
-Unlock the agent.
-.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 c
 Indicates that added identities should be subject to confirmation before
 being used for authentication.
 .It Fl c
 Indicates that added identities should be subject to confirmation before
 being used for authentication.


@@ -103,12 +86,41 @@ 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.
 Successful confirmation is signaled by a zero exit status from the
 .Ev SSH_ASKPASS
 program, rather than text entered into the requester.

-.It Fl s Ar reader
-Add key in smartcard
-.Ar reader .
+.It Fl D
+Deletes all identities from the agent.
+.It Fl d
+Instead of adding identities, removes identities from the agent.
+If
+.Nm
+has been run without arguments, the keys for the default identities will
+be removed.
+Otherwise, the argument list will be interpreted as a list of paths to
+public key files and matching keys will be removed from the agent.
+If no public key is found at a given path,
+.Nm
+will append
+.Pa .pub
+and retry.

 .It Fl e Ar reader
 Remove key in smartcard
 .Ar reader .
 .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 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.

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


@@ -129,23 +141,24 @@ 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.)
 .It Ev SSH_AUTH_SOCK
 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.
+Identifies the path of a
+.Ux Ns -domain
+socket used to communicate with the agent.

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

-.It Pa $HOME/.ssh/identity
+.It Pa ~/.ssh/identity

 Contains the protocol version 1 RSA authentication identity of the user.
 Contains the protocol version 1 RSA authentication identity of the user.

-.It Pa $HOME/.ssh/id_dsa
+.It Pa ~/.ssh/id_dsa

 Contains the protocol version 2 DSA authentication identity of the user.
 Contains the protocol version 2 DSA authentication identity of the user.

-.It Pa $HOME/.ssh/id_rsa
+.It Pa ~/.ssh/id_rsa

 Contains the protocol version 2 RSA authentication identity of the user.
 .El
 .Pp
 Contains the protocol version 2 RSA authentication identity of the user.
 .El
 .Pp