Annotation of src/usr.bin/ssh/ssh-add.1, Revision 1.2
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: .\"
12: .\" $Id: ssh-add.1,v 1.2 1999/05/04 11:59:11 bg Exp $
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.1 deraadt 33: asks for the passphrase from the user. If the user is using X11, the
34: passphrase is requested using a small X11 program; otherwise it is
35: read from the user's tty. (Note: it may be necessary to redirect
1.2 ! deraadt 36: stdin from
! 37: .Pa /dev/null
! 38: to get the passphrase requested using X11.)
! 39: .Pp
1.1 deraadt 40: The authentication agent must be running and must be an ancestor of
41: the current process for
1.2 ! deraadt 42: .Nm
1.1 deraadt 43: to work.
1.2 ! deraadt 44: .Pp
! 45: The options are as follows:
! 46: .Pp
! 47: .Bl -tag -width Ds
! 48: .It Fl l
1.1 deraadt 49: Lists all identities currently represented by the agent.
1.2 ! deraadt 50: .It Fl d
1.1 deraadt 51: Instead of adding the identity, removes the identity from the agent.
1.2 ! deraadt 52: .It Fl D
1.1 deraadt 53: Deletes all identities from the agent.
1.2 ! deraadt 54: .El
! 55: .Sh FILES
! 56: .Bl -tag -width Ds
! 57: .Pa $HOME/.ssh/identity
1.1 deraadt 58: Contains the RSA authentication identity of the user. This file
59: should not be readable by anyone but the user. It is possible to
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.2 ! deraadt 85: .Sh SEE ALSO
! 86: .Xr ssh 1 ,
! 87: .Xr ssh-agent 1 ,
! 88: .Xr ssh-keygen 1 ,
! 89: .Xr sshd 8