summaryrefslogtreecommitdiff
path: root/ssh-add.0
diff options
context:
space:
mode:
Diffstat (limited to 'ssh-add.0')
-rw-r--r--ssh-add.088
1 files changed, 47 insertions, 41 deletions
diff --git a/ssh-add.0 b/ssh-add.0
index d5b49d35d..0e2d1bca6 100644
--- a/ssh-add.0
+++ b/ssh-add.0
@@ -1,54 +1,60 @@
1SSH-ADD(1) System General Commands Manual SSH-ADD(1) 1SSHM-bM-^@M-^PADD(1) BSD General Commands Manual SSHM-bM-^@M-^PADD(1)
2 2
3NAME 3^[[1mNAME^[[0m
4 ssh-add - adds RSA or DSA identities to the authentication agent 4 ^[[1msshM-bM-^@M-^Padd ^[[22mM-bMM-^R adds RSA or DSA identities to the authentication agent
5 5
6SYNOPSIS 6^[[1mSYNOPSIS^[[0m
7 ssh-add [-lLdDxX] [-t life] [file ...] 7 ^[[1msshM-bM-^@M-^Padd ^[[22m[^[[1mM-bMM-^RlLdDxXc^[[22m] [^[[1mM-bMM-^Rt ^[[4m^[[22mlife^[[24m] [^[[4mfile^[[24m ^[[4m...^[[24m]
8 ssh-add -s reader 8 ^[[1msshM-bM-^@M-^Padd M-bMM-^Rs ^[[4m^[[22mreader^[[0m
9 ssh-add -e reader 9 ^[[1msshM-bM-^@M-^Padd M-bMM-^Re ^[[4m^[[22mreader^[[0m
10 10
11DESCRIPTION 11^[[1mDESCRIPTION^[[0m
12 ssh-add adds RSA or DSA identities to the authentication agent, 12 ^[[1msshM-bM-^@M-^Padd ^[[22madds RSA or DSA identities to the authentication agent,
13 ssh-agent(1). When run without arguments, it adds the files 13 sshM-bM-^@M-^Pagent(1). When run without arguments, it adds the files
14 $HOME/.ssh/id_rsa, $HOME/.ssh/id_dsa and $HOME/.ssh/identity. AlternaM-- 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 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 16 passphrase, ^[[1msshM-bM-^@M-^Padd ^[[22masks for the passphrase from the user. The
17 passphrase is read from the user's tty. ssh-add retries the last 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. 18 passphrase if multiple identity files are given.
19 19
20 The authentication agent must be running and must be an ancestor of the 20 The authentication agent must be running and must be an ancestor of the
21 current process for ssh-add to work. 21 current process for ^[[1msshM-bM-^@M-^Padd ^[[22mto work.
22 22
23 The options are as follows: 23 The options are as follows:
24 24
25 -l Lists fingerprints of all identities currently represented by the 25 ^[[1mM-bMM-^Rl ^[[22mLists fingerprints of all identities currently represented by the
26 agent. 26 agent.
27 27
28 -L Lists public key parameters of all identities currently repreM-- 28 ^[[1mM-bMM-^RL ^[[22mLists public key parameters of all identities currently repreM-bM-^@M-^P
29 sented by the agent. 29 sented by the agent.
30 30
31 -d Instead of adding the identity, removes the identity from the 31 ^[[1mM-bMM-^Rd ^[[22mInstead of adding the identity, removes the identity from the
32 agent. 32 agent.
33 33
34 -D Deletes all identities from the agent. 34 ^[[1mM-bMM-^RD ^[[22mDeletes all identities from the agent.
35 35
36 -x Lock the agent with a password. 36 ^[[1mM-bMM-^Rx ^[[22mLock the agent with a password.
37 37
38 -X Unlock the agent. 38 ^[[1mM-bMM-^RX ^[[22mUnlock the agent.
39 39
40 -t life 40 ^[[1mM-bMM-^Rt ^[[4m^[[22mlife^[[0m
41 Set a maximum lifetime when adding identities to an agent. The 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-- 42 lifetime may be specified in seconds or in a time format speciM-bM-^@M-^P
43 fied in sshd(8). 43 fied in sshd_config(5).
44 44
45 -s reader 45 ^[[1mM-bMM-^Rc ^[[22mIndicates that added identities should be subject to confirmation
46 Add key in smartcard reader. 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.
47 50
48 -e reader 51 ^[[1mM-bMM-^Rs ^[[4m^[[22mreader^[[0m
49 Remove key in smartcard reader. 52 Add key in smartcard ^[[4mreader^[[24m.
50 53
51FILES 54 ^[[1mM-bMM-^Re ^[[4m^[[22mreader^[[0m
55 Remove key in smartcard ^[[4mreader^[[24m.
56
57^[[1mFILES^[[0m
52 $HOME/.ssh/identity 58 $HOME/.ssh/identity
53 Contains the protocol version 1 RSA authentication identity of 59 Contains the protocol version 1 RSA authentication identity of
54 the user. 60 the user.
@@ -62,35 +68,35 @@ FILES
62 the user. 68 the user.
63 69
64 Identity files should not be readable by anyone but the user. Note that 70 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. 71 ^[[1msshM-bM-^@M-^Padd ^[[22mignores identity files if they are accessible by others.
66 72
67ENVIRONMENT 73^[[1mENVIRONMENT^[[0m
68 DISPLAY and SSH_ASKPASS 74 DISPLAY and SSH_ASKPASS
69 If ssh-add needs a passphrase, it will read the passphrase from 75 If ^[[1msshM-bM-^@M-^Padd ^[[22mneeds a passphrase, it will read the passphrase from
70 the current terminal if it was run from a terminal. If ssh-add 76 the current terminal if it was run from a terminal. If ^[[1msshM-bM-^@M-^Padd^[[0m
71 does not have a terminal associated with it but DISPLAY and 77 does not have a terminal associated with it but DISPLAY and
72 SSH_ASKPASS are set, it will execute the program specified by 78 SSH_ASKPASS are set, it will execute the program specified by
73 SSH_ASKPASS and open an X11 window to read the passphrase. This 79 SSH_ASKPASS and open an X11 window to read the passphrase. This
74 is particularly useful when calling ssh-add from a .Xsession or 80 is particularly useful when calling ^[[1msshM-bM-^@M-^Padd ^[[22mfrom a ^[[4m.Xsession^[[24m or
75 related script. (Note that on some machines it may be necessary 81 related script. (Note that on some machines it may be necessary
76 to redirect the input from /dev/null to make this work.) 82 to redirect the input from ^[[4m/dev/null^[[24m to make this work.)
77 83
78 SSH_AUTH_SOCK 84 SSH_AUTH_SOCK
79 Identifies the path of a unix-domain socket used to communicate 85 Identifies the path of a unixM-bM-^@M-^Pdomain socket used to communicate
80 with the agent. 86 with the agent.
81 87
82DIAGNOSTICS 88^[[1mDIAGNOSTICS^[[0m
83 Exit status is 0 on success, 1 if the specified command fails, and 2 if 89 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. 90 ^[[1msshM-bM-^@M-^Padd ^[[22mis unable to contact the authentication agent.
85 91
86AUTHORS 92^[[1mAUTHORS^[[0m
87 OpenSSH is a derivative of the original and free ssh 1.2.12 release by 93 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 94 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-- 95 de Raadt and Dug Song removed many bugs, reM-bM-^@M-^Padded newer features and creM-bM-^@M-^P
90 ated OpenSSH. Markus Friedl contributed the support for SSH protocol 96 ated OpenSSH. Markus Friedl contributed the support for SSH protocol
91 versions 1.5 and 2.0. 97 versions 1.5 and 2.0.
92 98
93SEE ALSO 99^[[1mSEE ALSO^[[0m
94 ssh(1), ssh-agent(1), ssh-keygen(1), sshd(8) 100 ssh(1), sshM-bM-^@M-^Pagent(1), sshM-bM-^@M-^Pkeygen(1), sshd(8)
95 101
96BSD September 25, 1999 BSD 102BSD September 25, 1999 BSD