summaryrefslogtreecommitdiff
path: root/ssh-add.0
diff options
context:
space:
mode:
authorColin Watson <cjwatson@debian.org>2003-09-01 00:45:47 +0000
committerColin Watson <cjwatson@debian.org>2003-09-01 00:45:47 +0000
commitd984a3c6658e950881edcfb2aae464add93f68d4 (patch)
treeed2052b4001227cf8179393cba172ae470e6c097 /ssh-add.0
parent3e36f9f4fff8f5b573f163eecd12a677ce66fe89 (diff)
Import OpenSSH 3.4p1.
Diffstat (limited to 'ssh-add.0')
-rw-r--r--ssh-add.096
1 files changed, 96 insertions, 0 deletions
diff --git a/ssh-add.0 b/ssh-add.0
new file mode 100644
index 000000000..d5b49d35d
--- /dev/null
+++ b/ssh-add.0
@@ -0,0 +1,96 @@
1SSH-ADD(1) System General Commands Manual SSH-ADD(1)
2
3NAME
4 ssh-add - adds RSA or DSA identities to the authentication agent
5
6SYNOPSIS
7 ssh-add [-lLdDxX] [-t life] [file ...]
8 ssh-add -s reader
9 ssh-add -e reader
10
11DESCRIPTION
12 ssh-add adds RSA or DSA identities to the authentication agent,
13 ssh-agent(1). When run without arguments, it adds the files
14 $HOME/.ssh/id_rsa, $HOME/.ssh/id_dsa and $HOME/.ssh/identity. AlternaM--
15 tive file names can be given on the command line. If any file requires a
16 passphrase, ssh-add asks for the passphrase from the user. The
17 passphrase is read from the user's tty. ssh-add retries the last
18 passphrase if multiple identity files are given.
19
20 The authentication agent must be running and must be an ancestor of the
21 current process for ssh-add to work.
22
23 The options are as follows:
24
25 -l Lists fingerprints of all identities currently represented by the
26 agent.
27
28 -L Lists public key parameters of all identities currently repreM--
29 sented by the agent.
30
31 -d Instead of adding the identity, removes the identity from the
32 agent.
33
34 -D Deletes all identities from the agent.
35
36 -x Lock the agent with a password.
37
38 -X Unlock the agent.
39
40 -t life
41 Set a maximum lifetime when adding identities to an agent. The
42 lifetime may be specified in seconds or in a time format speciM--
43 fied in sshd(8).
44
45 -s reader
46 Add key in smartcard reader.
47
48 -e reader
49 Remove key in smartcard reader.
50
51FILES
52 $HOME/.ssh/identity
53 Contains the protocol version 1 RSA authentication identity of
54 the user.
55
56 $HOME/.ssh/id_dsa
57 Contains the protocol version 2 DSA authentication identity of
58 the user.
59
60 $HOME/.ssh/id_rsa
61 Contains the protocol version 2 RSA authentication identity of
62 the user.
63
64 Identity files should not be readable by anyone but the user. Note that
65 ssh-add ignores identity files if they are accessible by others.
66
67ENVIRONMENT
68 DISPLAY and SSH_ASKPASS
69 If ssh-add needs a passphrase, it will read the passphrase from
70 the current terminal if it was run from a terminal. If ssh-add
71 does not have a terminal associated with it but DISPLAY and
72 SSH_ASKPASS are set, it will execute the program specified by
73 SSH_ASKPASS and open an X11 window to read the passphrase. This
74 is particularly useful when calling ssh-add from a .Xsession or
75 related script. (Note that on some machines it may be necessary
76 to redirect the input from /dev/null to make this work.)
77
78 SSH_AUTH_SOCK
79 Identifies the path of a unix-domain socket used to communicate
80 with the agent.
81
82DIAGNOSTICS
83 Exit status is 0 on success, 1 if the specified command fails, and 2 if
84 ssh-add is unable to contact the authentication agent.
85
86AUTHORS
87 OpenSSH is a derivative of the original and free ssh 1.2.12 release by
88 Tatu Ylonen. Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, Theo
89 de Raadt and Dug Song removed many bugs, re-added newer features and creM--
90 ated OpenSSH. Markus Friedl contributed the support for SSH protocol
91 versions 1.5 and 2.0.
92
93SEE ALSO
94 ssh(1), ssh-agent(1), ssh-keygen(1), sshd(8)
95
96BSD September 25, 1999 BSD