- (tim) [contrib/cygwin/README] add minires-devel requirement. Patch from

[openssh.git] / ssh-add.1

diff --git a/ssh-add.1 b/ssh-add.1
index 41d5def6ff150e6cf35c452ccb300d804629169f..6348197b332aa3493905bf854a9c7b00b32e2185 100644 (file)
--- a/ssh-add.1
+++ b/ssh-add.1
@@ -1,4 +1,4 @@
-.\"    $OpenBSD: ssh-add.1,v 1.30 2002/02/04 20:41:16 stevesk Exp $
+.\"    $OpenBSD: ssh-add.1,v 1.40 2003/11/25 23:10:08 matthieu Exp $

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


@@ -45,7 +45,8 @@
 .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 lLdD
+.Op Fl lLdDxXc
+.Op Fl t Ar life

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


@@ -57,7 +58,7 @@ 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 ,
 .Xr ssh-agent 1 .
 When run without arguments, it adds the files
 .Pa $HOME/.ssh/id_rsa ,

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

 and
 .Pa $HOME/.ssh/identity .
 Alternative file names can be given on the command line.
 and
 .Pa $HOME/.ssh/identity .
 Alternative file names can be given on the command line.


@@ -68,8 +69,9 @@ 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 must be an ancestor of
-the current process for
+The authentication agent must be running and the
+.Ev SSH_AUTH_SOCK
+environment variable must contain the name of its socket for

 .Nm
 to work.
 .Pp
 .Nm
 to work.
 .Pp


@@ -83,6 +85,24 @@ Lists public key parameters of all identities currently represented by the agent
 Instead of adding the identity, removes the identity from the agent.
 .It Fl D
 Deletes all identities from the agent.
 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.
+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 s Ar reader
 Add key in smartcard
 .Ar reader .
 .It Fl s Ar reader
 Add key in smartcard
 .Ar reader .


@@ -90,20 +110,6 @@ Add key in smartcard
 Remove key in smartcard
 .Ar reader .
 .El
 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.
-.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
-.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 ENVIRONMENT
 .Bl -tag -width Ds
 .It Ev "DISPLAY" and "SSH_ASKPASS"
 .Sh ENVIRONMENT
 .Bl -tag -width Ds
 .It Ev "DISPLAY" and "SSH_ASKPASS"


@@ -129,12 +135,34 @@ or related script.
 may be necessary to redirect the input from
 .Pa /dev/null
 to make this work.)
 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 $HOME/.ssh/identity
+Contains the protocol version 1 RSA authentication identity of the user.
+.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
 .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 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.


@@ -144,8 +172,3 @@ 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