version 1.1, 1999/09/26 20:53:37 |
version 1.2, 1999/09/26 22:30:06 |
|
|
.\" |
.\" |
.\" $Id$ |
.\" $Id$ |
.\" |
.\" |
.TH SSH-ADD 1 "November 8, 1995" "SSH" "SSH" |
.Dd September 25, 1999 |
|
.Dt SSH-ADD 1 |
.SH NAME |
.Os |
ssh-add \- adds identities for the authentication agent |
.Sh NAME |
|
.Nm ssh-add |
.SH SYNOPSIS |
.Nd adds identities for the authentication agent |
.B ssh-add |
.Sh SYNOPSIS |
[\c |
.Nm ssh-add |
.B \-l\c |
.Op Fl ldD |
] |
.Op Ar |
[\c |
.Sh DESCRIPTION |
.B \-d\c |
.Nm |
] |
|
[\c |
|
.B \-D\c |
|
] |
|
[\c |
|
.B file\c |
|
\&.\|.\|.\|] |
|
|
|
.SH DESCRIPTION |
|
.LP |
|
.B Ssh-add |
|
adds identities to the authentication agent, |
adds identities to the authentication agent, |
.B ssh-agent. |
.Xr ssh-agent 1 . |
When run without arguments, it adds the file |
When run without arguments, it adds the file |
.IR $HOME/\s+2.\s0ssh/identity ". |
.Pa $HOME/.ssh/identity . |
Alternative file names can be given on the |
Alternative file names can be given on the |
command line. If any file requires a passphrase, |
command line. If any file requires a passphrase, |
.B ssh-add |
.Nm |
asks for the passphrase from the user. If the user is using X11, the |
asks for the passphrase from the user. If the user is using X11, the |
passphrase is requested using a small X11 program; otherwise it is |
passphrase is requested using a small X11 program; otherwise it is |
read from the user's tty. (Note: it may be necessary to redirect |
read from the user's tty. (Note: it may be necessary to redirect |
stdin from /dev/null to get the passphrase requested using X11.) |
stdin from |
.LP |
.Pa /dev/null |
|
to get the passphrase requested using X11.) |
|
.Pp |
The authentication agent must be running and must be an ancestor of |
The authentication agent must be running and must be an ancestor of |
the current process for |
the current process for |
.B ssh-add |
.Nm |
to work. |
to work. |
|
.Pp |
.SH OPTIONS |
The options are as follows: |
.TP 0.5i |
.Pp |
.B \-l |
.Bl -tag -width Ds |
|
.It Fl l |
Lists all identities currently represented by the agent. |
Lists all identities currently represented by the agent. |
.TP |
.It Fl d |
.B \-d |
|
Instead of adding the identity, removes the identity from the agent. |
Instead of adding the identity, removes the identity from the agent. |
.TP |
.It Fl D |
.B \-D |
|
Deletes all identities from the agent. |
Deletes all identities from the agent. |
|
.El |
.SH FILES |
.Sh FILES |
.TP |
.Bl -tag -width Ds |
.I \&$HOME/\s+2.\s0ssh/identity |
.Pa $HOME/.ssh/identity |
Contains the RSA authentication identity of the user. This file |
Contains the RSA authentication identity of the user. This file |
should not be readable by anyone but the user. It is possible to |
should not be readable by anyone but the user. It is possible to |
specify a passphrase when generating the key; that passphrase will be |
specify a passphrase when generating the key; that passphrase will be |
used to encrypt the private part of this file. This is the |
used to encrypt the private part of this file. This is the |
default file added by |
default file added by |
.B ssh-add |
.Nm |
when no other files have been specified. |
when no other files have been specified. |
.IP |
.Pp |
If |
If |
.B ssh-add |
.Nm |
needs a passphrase, it will read the passphrase from the current |
needs a passphrase, it will read the passphrase from the current |
terminal if it was run from a terminal. If |
terminal if it was run from a terminal. If |
.B ssh-add |
.Nm |
does not have a terminal associated with it but |
does not have a terminal associated with it but |
.SM DISPLAY\s0 |
.Ev DISPLAY |
is set, it |
is set, it |
will open an X11 window to read the passphrase. This is particularly |
will open an X11 window to read the passphrase. This is particularly |
useful when calling |
useful when calling |
.B ssh-add |
.Nm |
from a .Xsession or related script. (Note that on some machines it |
from a |
may be necessary to redirect the input from /dev/null to make this work.) |
.Pa .Xsession |
|
or related script. (Note that on some machines it |
.SH AUTHOR |
may be necessary to redirect the input from |
.LP |
.Pa /dev/null |
|
to make this work.) |
|
.Sh AUTHOR |
Tatu Ylonen <ylo@cs.hut.fi> |
Tatu Ylonen <ylo@cs.hut.fi> |
|
.Sh SEE ALSO |
.SH SEE ALSO |
.Xr ssh 1 , |
.BR ssh-agent (1), |
.Xr ssh-agent 1 , |
.BR ssh-keygen (1), |
.Xr ssh-keygen 1 , |
.BR ssh (1), |
.Xr sshd 8 |
.BR sshd (8) |
|