Annotation of src/usr.bin/ssh/ssh-add.1, Revision 1.1
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: .\"
! 14: .TH SSH-ADD 1 "November 8, 1995" "SSH" "SSH"
! 15:
! 16: .SH NAME
! 17: ssh-add \- adds identities for the authentication agent
! 18:
! 19: .SH SYNOPSIS
! 20: .B ssh-add
! 21: [\c
! 22: .B \-l\c
! 23: ]
! 24: [\c
! 25: .B \-d\c
! 26: ]
! 27: [\c
! 28: .B \-D\c
! 29: ]
! 30: [\c
! 31: .B file\c
! 32: \&.\|.\|.\|]
! 33:
! 34: .SH DESCRIPTION
! 35: .LP
! 36: .B Ssh-add
! 37: adds identities to the authentication agent,
! 38: .B ssh-agent.
! 39: When run without arguments, it adds the file
! 40: .IR $HOME/\s+2.\s0ssh/identity ".
! 41: Alternative file names can be given on the
! 42: command line. If any file requires a passphrase,
! 43: .B ssh-add
! 44: asks for the passphrase from the user. If the user is using X11, the
! 45: passphrase is requested using a small X11 program; otherwise it is
! 46: read from the user's tty. (Note: it may be necessary to redirect
! 47: stdin from /dev/null to get the passphrase requested using X11.)
! 48: .LP
! 49: The authentication agent must be running and must be an ancestor of
! 50: the current process for
! 51: .B ssh-add
! 52: to work.
! 53:
! 54: .SH OPTIONS
! 55: .TP 0.5i
! 56: .B \-l
! 57: Lists all identities currently represented by the agent.
! 58: .TP
! 59: .B \-d
! 60: Instead of adding the identity, removes the identity from the agent.
! 61: .TP
! 62: .B \-D
! 63: Deletes all identities from the agent.
! 64:
! 65: .SH FILES
! 66: .TP
! 67: .I \&$HOME/\s+2.\s0ssh/identity
! 68: Contains the RSA authentication identity of the user. This file
! 69: should not be readable by anyone but the user. It is possible to
! 70: specify a passphrase when generating the key; that passphrase will be
! 71: used to encrypt the private part of this file. This is the
! 72: default file added by
! 73: .B ssh-add
! 74: when no other files have been specified.
! 75: .IP
! 76: If
! 77: .B ssh-add
! 78: needs a passphrase, it will read the passphrase from the current
! 79: terminal if it was run from a terminal. If
! 80: .B ssh-add
! 81: does not have a terminal associated with it but
! 82: .SM DISPLAY\s0
! 83: is set, it
! 84: will open an X11 window to read the passphrase. This is particularly
! 85: useful when calling
! 86: .B ssh-add
! 87: from a .Xsession or related script. (Note that on some machines it
! 88: may be necessary to redirect the input from /dev/null to make this work.)
! 89:
! 90: .SH AUTHOR
! 91: .LP
! 92: Tatu Ylonen <ylo@cs.hut.fi>
! 93:
! 94: .SH SEE ALSO
! 95: .BR ssh-agent (1),
! 96: .BR ssh-keygen (1),
! 97: .BR ssh (1),
! 98: .BR sshd (8)