summaryrefslogtreecommitdiff
path: root/ssh-add.0
diff options
context:
space:
mode:
Diffstat (limited to 'ssh-add.0')
-rw-r--r--ssh-add.0102
1 files changed, 102 insertions, 0 deletions
diff --git a/ssh-add.0 b/ssh-add.0
new file mode 100644
index 000000000..0e2d1bca6
--- /dev/null
+++ b/ssh-add.0
@@ -0,0 +1,102 @@
1SSHM-bM-^@M-^PADD(1) BSD General Commands Manual SSHM-bM-^@M-^PADD(1)
2
3^[[1mNAME^[[0m
4 ^[[1msshM-bM-^@M-^Padd ^[[22mM-bMM-^R adds RSA or DSA identities to the authentication agent
5
6^[[1mSYNOPSIS^[[0m
7 ^[[1msshM-bM-^@M-^Padd ^[[22m[^[[1mM-bMM-^RlLdDxXc^[[22m] [^[[1mM-bMM-^Rt ^[[4m^[[22mlife^[[24m] [^[[4mfile^[[24m ^[[4m...^[[24m]
8 ^[[1msshM-bM-^@M-^Padd M-bMM-^Rs ^[[4m^[[22mreader^[[0m
9 ^[[1msshM-bM-^@M-^Padd M-bMM-^Re ^[[4m^[[22mreader^[[0m
10
11^[[1mDESCRIPTION^[[0m
12 ^[[1msshM-bM-^@M-^Padd ^[[22madds RSA or DSA identities to the authentication agent,
13 sshM-bM-^@M-^Pagent(1). When run without arguments, it adds the files
14 ^[[4m$HOME/.ssh/id_rsa^[[24m, ^[[4m$HOME/.ssh/id_dsa^[[24m and ^[[4m$HOME/.ssh/identity^[[24m. AlternaM-bM-^@M-^P
15 tive file names can be given on the command line. If any file requires a
16 passphrase, ^[[1msshM-bM-^@M-^Padd ^[[22masks for the passphrase from the user. The
17 passphrase is read from the userM-bM-^@M-^Ys tty. ^[[1msshM-bM-^@M-^Padd ^[[22mretries 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 ^[[1msshM-bM-^@M-^Padd ^[[22mto work.
22
23 The options are as follows:
24
25 ^[[1mM-bMM-^Rl ^[[22mLists fingerprints of all identities currently represented by the
26 agent.
27
28 ^[[1mM-bMM-^RL ^[[22mLists public key parameters of all identities currently repreM-bM-^@M-^P
29 sented by the agent.
30
31 ^[[1mM-bMM-^Rd ^[[22mInstead of adding the identity, removes the identity from the
32 agent.
33
34 ^[[1mM-bMM-^RD ^[[22mDeletes all identities from the agent.
35
36 ^[[1mM-bMM-^Rx ^[[22mLock the agent with a password.
37
38 ^[[1mM-bMM-^RX ^[[22mUnlock the agent.
39
40 ^[[1mM-bMM-^Rt ^[[4m^[[22mlife^[[0m
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-bM-^@M-^P
43 fied in sshd_config(5).
44
45 ^[[1mM-bMM-^Rc ^[[22mIndicates that added identities should be subject to confirmation
46 before being used for authentication. Confirmation is performed
47 by the SSH_ASKPASS program mentioned below. Successful confirmaM-bM-^@M-^P
48 tion is signaled by a zero exit status from the SSH_ASKPASS proM-bM-^@M-^P
49 gram, rather than text entered into the requester.
50
51 ^[[1mM-bMM-^Rs ^[[4m^[[22mreader^[[0m
52 Add key in smartcard ^[[4mreader^[[24m.
53
54 ^[[1mM-bMM-^Re ^[[4m^[[22mreader^[[0m
55 Remove key in smartcard ^[[4mreader^[[24m.
56
57^[[1mFILES^[[0m
58 $HOME/.ssh/identity
59 Contains the protocol version 1 RSA authentication identity of
60 the user.
61
62 $HOME/.ssh/id_dsa
63 Contains the protocol version 2 DSA authentication identity of
64 the user.
65
66 $HOME/.ssh/id_rsa
67 Contains the protocol version 2 RSA authentication identity of
68 the user.
69
70 Identity files should not be readable by anyone but the user. Note that
71 ^[[1msshM-bM-^@M-^Padd ^[[22mignores identity files if they are accessible by others.
72
73^[[1mENVIRONMENT^[[0m
74 DISPLAY and SSH_ASKPASS
75 If ^[[1msshM-bM-^@M-^Padd ^[[22mneeds a passphrase, it will read the passphrase from
76 the current terminal if it was run from a terminal. If ^[[1msshM-bM-^@M-^Padd^[[0m
77 does not have a terminal associated with it but DISPLAY and
78 SSH_ASKPASS are set, it will execute the program specified by
79 SSH_ASKPASS and open an X11 window to read the passphrase. This
80 is particularly useful when calling ^[[1msshM-bM-^@M-^Padd ^[[22mfrom a ^[[4m.Xsession^[[24m or
81 related script. (Note that on some machines it may be necessary
82 to redirect the input from ^[[4m/dev/null^[[24m to make this work.)
83
84 SSH_AUTH_SOCK
85 Identifies the path of a unixM-bM-^@M-^Pdomain socket used to communicate
86 with the agent.
87
88^[[1mDIAGNOSTICS^[[0m
89 Exit status is 0 on success, 1 if the specified command fails, and 2 if
90 ^[[1msshM-bM-^@M-^Padd ^[[22mis unable to contact the authentication agent.
91
92^[[1mAUTHORS^[[0m
93 OpenSSH is a derivative of the original and free ssh 1.2.12 release by
94 Tatu Ylonen. Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, Theo
95 de Raadt and Dug Song removed many bugs, reM-bM-^@M-^Padded newer features and creM-bM-^@M-^P
96 ated OpenSSH. Markus Friedl contributed the support for SSH protocol
97 versions 1.5 and 2.0.
98
99^[[1mSEE ALSO^[[0m
100 ssh(1), sshM-bM-^@M-^Pagent(1), sshM-bM-^@M-^Pkeygen(1), sshd(8)
101
102BSD September 25, 1999 BSD