Return to ssh-add.1 CVS log

Up to [local] / src / usr.bin / ssh

Annotation of src/usr.bin/ssh/ssh-add.1, Revision 1.7

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.7     ! markus     12: .\" $Id: ssh-add.1,v 1.6 1999/10/17 20:35:46 aaron 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
1.7     ! markus     22: .Op Fl lLdD
1.2       deraadt    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: .Bl -tag -width Ds
                     43: .It Fl l
1.7     ! markus     44: Lists fingerprints of all identities currently represented by the agent.
        !            45: .It Fl L
        !            46: Lists public key parameters of all identities currently represented by the agent.
1.2       deraadt    47: .It Fl d
1.1       deraadt    48: Instead of adding the identity, removes the identity from the agent.
1.2       deraadt    49: .It Fl D
1.1       deraadt    50: Deletes all identities from the agent.
1.2       deraadt    51: .El
                     52: .Sh FILES
                     53: .Bl -tag -width Ds
                     54: .Pa $HOME/.ssh/identity
1.1       deraadt    55: Contains the RSA authentication identity of the user.  This file
1.4       markus     56: should not be readable by anyone but the user.
                     57: Note that
                     58: .Nm
                     59: ignores this file if it is accessible by others.
                     60: It is possible to
1.1       deraadt    61: specify a passphrase when generating the key; that passphrase will be
                     62: used to encrypt the private part of this file.  This is the
                     63: default file added by
1.2       deraadt    64: .Nm
1.1       deraadt    65: when no other files have been specified.
1.2       deraadt    66: .Pp
1.1       deraadt    67: If
1.2       deraadt    68: .Nm
1.1       deraadt    69: needs a passphrase, it will read the passphrase from the current
                     70: terminal if it was run from a terminal.  If
1.2       deraadt    71: .Nm
1.1       deraadt    72: does not have a terminal associated with it but
1.2       deraadt    73: .Ev DISPLAY
1.1       deraadt    74: is set, it
                     75: will open an X11 window to read the passphrase.  This is particularly
                     76: useful when calling
1.2       deraadt    77: .Nm
                     78: from a
                     79: .Pa .Xsession
                     80: or related script.  (Note that on some machines it
                     81: may be necessary to redirect the input from
                     82: .Pa /dev/null
                     83: to make this work.)
                     84: .Sh AUTHOR
1.1       deraadt    85: Tatu Ylonen <ylo@cs.hut.fi>
1.3       deraadt    86: .Pp
1.5       deraadt    87: OpenSSH
                     88: is a derivative of the original (free) ssh 1.2.12 release, but with bugs
                     89: removed and newer features re-added.   Rapidly after the 1.2.12 release,
                     90: newer versions bore successively more restrictive licenses.  This version
                     91: of OpenSSH
                     92: .Bl -bullet
                     93: .It
                     94: has all components of a restrictive nature (ie. patents, see
                     95: .Xr ssl 8 )
                     96: directly removed from the source code; any licensed or patented components
                     97: are chosen from
                     98: external libraries.
                     99: .It
                    100: has been updated to support ssh protocol 1.5.
                    101: .It
                    102: contains added support for
                    103: .Xr kerberos 8
                    104: authentication and ticket passing.
                    105: .It
                    106: supports one-time password authentication with
                    107: .Xr skey 1 .
                    108: .El
                    109: .Pp
                    110: The libraries described in
1.3       deraadt   111: .Xr ssl 8
                    112: are required for proper operation.
1.2       deraadt   113: .Sh SEE ALSO
                    114: .Xr ssh 1 ,
                    115: .Xr ssh-agent 1 ,
                    116: .Xr ssh-keygen 1 ,
1.3       deraadt   117: .Xr sshd 8 ,
                    118: .Xr ssl 8