Manpage of SSH-ADD
Section: SSH (1)
Updated: November 8, 1995
ssh-add - adds identities for the authentication agent
adds identities to the authentication agent,
When run without arguments, it adds the file
Alternative file names can be given on the
command line. If any file requires a passphrase,
asks for the passphrase from the user. If the -p option is given then
the passphrase is read from stdin, otherwise if the user is using X11,
the passphrase is requested using a small X11 program; otherwise it is
read from the user's tty. (Note: it may be necessary to redirect stdin
from /dev/null to get the passphrase requested using X11.)
The authentication agent must be running and must be an ancestor of
the current process for
Read passphrase from stdin (or pipe).
Lists all identities currently represented by the agent.
Instead of adding the identity, removes the identity from the agent.
Deletes all identities from the agent.
returns one of the following exit statuses. These may be useful in scripts.
The requested operation was performed successfully.
No connection could be made to the authentication agent. Presumably
there is no authentication agent active in the execution environment
The user did not supply a required passphrase.
An identify file could not be found, was not readable, or was in
The agent does not have the requested identity.
An unspecified error has occurred; this is a catch-all for errors not
Contains the RSA authentication identity of the user. This file
should not be readable by anyone but the user. 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
when no other files have been specified.
needs a passphrase, it will read the passphrase from the current
terminal if it was run from a terminal. If
does not have a terminal associated with it but
is set, it
will open an X11 window to read the passphrase. This is particularly
useful when calling
from a .Xsession or related script. (Note that on some machines it
may be necessary to redirect the input from /dev/null to make this work.)
Tatu Ylonen <email@example.com>
- RETURN STATUS
- SEE ALSO
This document was created by man2html,
using the manual pages.
Time: 12:30:31 GMT, January 02, 2000