Annotation of src/usr.bin/ssh/ssh-add.1, Revision 1.4
1.1 deraadt 1: .\" -*- nroff -*-
2: .\"
3: .\" ssh-add.1
4: .\"
5: .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
6: .\"
7: .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
8: .\" All rights reserved
9: .\"
10: .\" Created: Sat Apr 22 23:55:14 1995 ylo
11: .\"
1.4 ! markus 12: .\" $Id: ssh-add.1,v 1.3 1999/10/02 13:10:26 deraadt Exp $
1.1 deraadt 13: .\"
1.2 deraadt 14: .Dd September 25, 1999
15: .Dt SSH-ADD 1
16: .Os
17: .Sh NAME
18: .Nm ssh-add
19: .Nd adds identities for the authentication agent
20: .Sh SYNOPSIS
21: .Nm ssh-add
22: .Op Fl ldD
23: .Op Ar
24: .Sh DESCRIPTION
25: .Nm
1.1 deraadt 26: adds identities to the authentication agent,
1.2 deraadt 27: .Xr ssh-agent 1 .
1.1 deraadt 28: When run without arguments, it adds the file
1.2 deraadt 29: .Pa $HOME/.ssh/identity .
1.1 deraadt 30: Alternative file names can be given on the
31: command line. If any file requires a passphrase,
1.2 deraadt 32: .Nm
1.4 ! markus 33: asks for the passphrase from the user.
! 34: The Passphrase it is read from the user's tty.
1.2 deraadt 35: .Pp
1.1 deraadt 36: The authentication agent must be running and must be an ancestor of
37: the current process for
1.2 deraadt 38: .Nm
1.1 deraadt 39: to work.
1.2 deraadt 40: .Pp
41: The options are as follows:
42: .Pp
43: .Bl -tag -width Ds
44: .It Fl l
1.1 deraadt 45: Lists all identities currently represented by the agent.
1.2 deraadt 46: .It Fl d
1.1 deraadt 47: Instead of adding the identity, removes the identity from the agent.
1.2 deraadt 48: .It Fl D
1.1 deraadt 49: Deletes all identities from the agent.
1.2 deraadt 50: .El
51: .Sh FILES
52: .Bl -tag -width Ds
53: .Pa $HOME/.ssh/identity
1.1 deraadt 54: Contains the RSA authentication identity of the user. This file
1.4 ! markus 55: should not be readable by anyone but the user.
! 56: Note that
! 57: .Nm
! 58: ignores this file if it is accessible by others.
! 59: It is possible to
1.1 deraadt 60: specify a passphrase when generating the key; that passphrase will be
61: used to encrypt the private part of this file. This is the
62: default file added by
1.2 deraadt 63: .Nm
1.1 deraadt 64: when no other files have been specified.
1.2 deraadt 65: .Pp
1.1 deraadt 66: If
1.2 deraadt 67: .Nm
1.1 deraadt 68: needs a passphrase, it will read the passphrase from the current
69: terminal if it was run from a terminal. If
1.2 deraadt 70: .Nm
1.1 deraadt 71: does not have a terminal associated with it but
1.2 deraadt 72: .Ev DISPLAY
1.1 deraadt 73: is set, it
74: will open an X11 window to read the passphrase. This is particularly
75: useful when calling
1.2 deraadt 76: .Nm
77: from a
78: .Pa .Xsession
79: or related script. (Note that on some machines it
80: may be necessary to redirect the input from
81: .Pa /dev/null
82: to make this work.)
83: .Sh AUTHOR
1.1 deraadt 84: Tatu Ylonen <ylo@cs.hut.fi>
1.3 deraadt 85: .Pp
86: This version of
87: .Nm
88: is a derivative of the original 1.2.12 release, but with bugs removed and
89: newer features re-added. Rapidly after the 1.2.12 release, newer versions
90: bore successively more restrictive licenses. In this version, all components
91: of a restrictive nature (ie. patents) have been directly removed from the
92: source code; any licensed or patented components are chosen from external
93: libraries. The libraries described in
94: .Xr ssl 8
95: are required for proper operation.
1.2 deraadt 96: .Sh SEE ALSO
97: .Xr ssh 1 ,
98: .Xr ssh-agent 1 ,
99: .Xr ssh-keygen 1 ,
1.3 deraadt 100: .Xr sshd 8 ,
101: .Xr ssl 8