|
|
@@ -0,0 +1,258 @@
|
|
|
+.\" Automatically generated by Pod::Man version 1.15
|
|
|
+.\" Tue May 7 19:43:46 2002
|
|
|
+.\"
|
|
|
+.\" Standard preamble:
|
|
|
+.\" ======================================================================
|
|
|
+.de Sh \" Subsection heading
|
|
|
+.br
|
|
|
+.if t .Sp
|
|
|
+.ne 5
|
|
|
+.PP
|
|
|
+\fB\\$1\fR
|
|
|
+.PP
|
|
|
+..
|
|
|
+.de Sp \" Vertical space (when we can't use .PP)
|
|
|
+.if t .sp .5v
|
|
|
+.if n .sp
|
|
|
+..
|
|
|
+.de Ip \" List item
|
|
|
+.br
|
|
|
+.ie \\n(.$>=3 .ne \\$3
|
|
|
+.el .ne 3
|
|
|
+.IP "\\$1" \\$2
|
|
|
+..
|
|
|
+.de Vb \" Begin verbatim text
|
|
|
+.ft CW
|
|
|
+.nf
|
|
|
+.ne \\$1
|
|
|
+..
|
|
|
+.de Ve \" End verbatim text
|
|
|
+.ft R
|
|
|
+
|
|
|
+.fi
|
|
|
+..
|
|
|
+.\" Set up some character translations and predefined strings. \*(-- will
|
|
|
+.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
|
+.\" double quote, and \*(R" will give a right double quote. | will give a
|
|
|
+.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used
|
|
|
+.\" to do unbreakable dashes and therefore won't be available. \*(C` and
|
|
|
+.\" \*(C' expand to `' in nroff, nothing in troff, for use with C<>
|
|
|
+.tr \(*W-|\(bv\*(Tr
|
|
|
+.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
|
+.ie n \{\
|
|
|
+. ds -- \(*W-
|
|
|
+. ds PI pi
|
|
|
+. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
|
+. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
|
+. ds L" ""
|
|
|
+. ds R" ""
|
|
|
+. ds C` ""
|
|
|
+. ds C' ""
|
|
|
+'br\}
|
|
|
+.el\{\
|
|
|
+. ds -- \|\(em\|
|
|
|
+. ds PI \(*p
|
|
|
+. ds L" ``
|
|
|
+. ds R" ''
|
|
|
+'br\}
|
|
|
+.\"
|
|
|
+.\" If the F register is turned on, we'll generate index entries on stderr
|
|
|
+.\" for titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and
|
|
|
+.\" index entries marked with X<> in POD. Of course, you'll have to process
|
|
|
+.\" the output yourself in some meaningful fashion.
|
|
|
+.if \nF \{\
|
|
|
+. de IX
|
|
|
+. tm Index:\\$1\t\\n%\t"\\$2"
|
|
|
+..
|
|
|
+. nr % 0
|
|
|
+. rr F
|
|
|
+.\}
|
|
|
+.\"
|
|
|
+.\" For nroff, turn off justification. Always turn off hyphenation; it
|
|
|
+.\" makes way too many mistakes in technical documents.
|
|
|
+.hy 0
|
|
|
+.if n .na
|
|
|
+.\"
|
|
|
+.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
|
+.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
|
+.bd B 3
|
|
|
+. \" fudge factors for nroff and troff
|
|
|
+.if n \{\
|
|
|
+. ds #H 0
|
|
|
+. ds #V .8m
|
|
|
+. ds #F .3m
|
|
|
+. ds #[ \f1
|
|
|
+. ds #] \fP
|
|
|
+.\}
|
|
|
+.if t \{\
|
|
|
+. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
|
+. ds #V .6m
|
|
|
+. ds #F 0
|
|
|
+. ds #[ \&
|
|
|
+. ds #] \&
|
|
|
+.\}
|
|
|
+. \" simple accents for nroff and troff
|
|
|
+.if n \{\
|
|
|
+. ds ' \&
|
|
|
+. ds ` \&
|
|
|
+. ds ^ \&
|
|
|
+. ds , \&
|
|
|
+. ds ~ ~
|
|
|
+. ds /
|
|
|
+.\}
|
|
|
+.if t \{\
|
|
|
+. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
|
+. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
|
+. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
|
+. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
|
+. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
|
+. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
|
+.\}
|
|
|
+. \" troff and (daisy-wheel) nroff accents
|
|
|
+.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
|
+.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
|
+.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
|
+.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
|
+.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
|
+.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
|
+.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
|
+.ds ae a\h'-(\w'a'u*4/10)'e
|
|
|
+.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
|
+. \" corrections for vroff
|
|
|
+.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
|
+.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
|
+. \" for low resolution devices (crt and lpr)
|
|
|
+.if \n(.H>23 .if \n(.V>19 \
|
|
|
+\{\
|
|
|
+. ds : e
|
|
|
+. ds 8 ss
|
|
|
+. ds o a
|
|
|
+. ds d- d\h'-1'\(ga
|
|
|
+. ds D- D\h'-1'\(hy
|
|
|
+. ds th \o'bp'
|
|
|
+. ds Th \o'LP'
|
|
|
+. ds ae ae
|
|
|
+. ds Ae AE
|
|
|
+.\}
|
|
|
+.rm #[ #] #H #V #F C
|
|
|
+.\" ======================================================================
|
|
|
+.\"
|
|
|
+.IX Title "SSH-KEYMAN 1"
|
|
|
+.TH SSH-KEYMAN 1 "perl v5.6.1" "2002-05-07" "User Contributed Perl Documentation"
|
|
|
+.UC
|
|
|
+.SH "NAME"
|
|
|
+\&\fBssh-keyman\fR \- authentication key agent management
|
|
|
+.SH "SYNOPSIS"
|
|
|
+.IX Header "SYNOPSIS"
|
|
|
+\&\fBssh-keyman\fR
|
|
|
+[\fB\-q\fR]
|
|
|
+[\fB\-c\fR]
|
|
|
+[\fB\-k\fR]
|
|
|
+[\fB\-s\fR]
|
|
|
+[\fB\-e\fR]
|
|
|
+[\fB\-d\fR]
|
|
|
+[\fB\-a\fR]
|
|
|
+[\fB\-l\fR]
|
|
|
+[\fIkeyfile\fR ...]
|
|
|
+.PP
|
|
|
+\&\fBssh-keyman\fR
|
|
|
+\&\fB\-h\fR
|
|
|
+\&\fB\-v\fR
|
|
|
+.SH "DESCRIPTION"
|
|
|
+.IX Header "DESCRIPTION"
|
|
|
+\&\fBssh-keyman\fR is a frontend to the \fBssh-agent\fR and \fBssh-add\fR commands
|
|
|
+for managing a long-running \fBssh-agent\fR process. The idea is that
|
|
|
+a single \fBssh-agent\fR process is kept persistently running across
|
|
|
+multiple user login sessions in order to prevent the startup of multiple
|
|
|
+\&\fBssh-agent\fR processes and to avoid having to enter pass-phrases more
|
|
|
+often than really necessary from a security point of view.
|
|
|
+.PP
|
|
|
+The command line options can be combined and are executed internally in
|
|
|
+the given order below.
|
|
|
+.Ip "\fB\-q\fR, \fB\*(--quiet\fR" 4
|
|
|
+.IX Item "-q, quiet"
|
|
|
+Quiet operation. Do not print verbose messages.
|
|
|
+.Ip "\fB\-c\fR, \fB\*(--cluster\fR" 4
|
|
|
+.IX Item "-c, cluster"
|
|
|
+Cluster indicator. This forces the use of
|
|
|
+\&\fB$HOME/.ssh/agent-\fR\fIhostname\fR as the agent attachment informations
|
|
|
+file instead of the default \fB$HOME/.ssh/agent\fR. Use this if your home
|
|
|
+directory is NFS-mounted on a cluster of desktops.
|
|
|
+.Ip "\fB\-k\fR, \fB\*(--kill\fR" 4
|
|
|
+.IX Item "-k, kill"
|
|
|
+Kill agent. This makes sure the \fBssh-agent\fR process
|
|
|
+is no longer running.
|
|
|
+.Ip "\fB\-s\fR, \fB\*(--start\fR" 4
|
|
|
+.IX Item "-s, start"
|
|
|
+Start agent. This makes sure the \fBssh-agent\fR process is
|
|
|
+running. If not, it automatically spawns a new one.
|
|
|
+.Ip "\fB\-e\fR, \fB\*(--env\fR" 4
|
|
|
+.IX Item "-e, env"
|
|
|
+Environment setup. This outputs to \fIstdout\fR the Bourne-Shell commands
|
|
|
+necessary to attach the current shell session to the \fBssh-agent\fR
|
|
|
+process. The intended usage is "\f(CW\*(C`eval `\f(CBssh-keyman\f(CW \-q \-e \-s`\*(C'\fR" from
|
|
|
+within \fB$HOME/.xsession\fR or \fB$HOME/.bash_login\fR scripts.
|
|
|
+.Ip "\fB\-d\fR, \fB\*(--delete\fR" 4
|
|
|
+.IX Item "-d, delete"
|
|
|
+Delete key. This deletes one or more (or all if not \fIkeyfile\fR arguments
|
|
|
+are specified at all) from the \fBssh-agent\fR process.
|
|
|
+.Ip "\fB\-a\fR, \fB\*(--add\fR" 4
|
|
|
+.IX Item "-a, add"
|
|
|
+Add key. This adds one or more keys (in \fIkeyfile\fR) to the \fBssh-agent\fR
|
|
|
+process. If a key is already loaded, it is skipped and not reloaded.
|
|
|
+Additionally, all specified keys are loaded with a single \fBssh-add\fR
|
|
|
+call. This way the pass-phrase dialog is reduced to its possible
|
|
|
+minimum.
|
|
|
+.Ip "\fB\-l\fR, \fB\*(--list\fR" 4
|
|
|
+.IX Item "-l, list"
|
|
|
+List keys. This lists the currently available keys in the \fBssh-agent\fR
|
|
|
+process.
|
|
|
+.Ip "\fB\-h\fR, \fB\*(--help\fR" 4
|
|
|
+.IX Item "-h, help"
|
|
|
+Help information. Display a usage summary on \fIstdout\fR.
|
|
|
+.Ip "\fB\-v\fR, \fB\*(--version\fR" 4
|
|
|
+.IX Item "-v, version"
|
|
|
+Version information. Display a version summary on \fIstdout\fR.
|
|
|
+.SH "EXAMPLE"
|
|
|
+.IX Header "EXAMPLE"
|
|
|
+\&\fI.xsession\fR:
|
|
|
+.PP
|
|
|
+.Vb 5
|
|
|
+\& eval `ssh-keyman -q -s -e`
|
|
|
+\& ssh-keyman -q -a </dev/null \e
|
|
|
+\& ~/.ssh/id_rsa_1 \e
|
|
|
+\& ~/.ssh/id_rsa_2 \e
|
|
|
+\& ~/.ssh/id_rsa_3
|
|
|
+.Ve
|
|
|
+\&\fI.bash_login\fR:
|
|
|
+.PP
|
|
|
+.Vb 1
|
|
|
+\& eval `ssh-keyman -q -s -e`
|
|
|
+.Ve
|
|
|
+.SH "FILES"
|
|
|
+.IX Header "FILES"
|
|
|
+.Ip "\fB$HOME/.ssh/agent\fR" 4
|
|
|
+.IX Item "$HOME/.ssh/agent"
|
|
|
+The generated shell script for attaching the current shell
|
|
|
+session (and all of its sub-processes) to the \fBssh-agent\fR process.
|
|
|
+At any time this can be directly sourced from within the shell session
|
|
|
+or indirectly through the \fBssh-keyman\fR \fB\-e\fR option.
|
|
|
+This file is used if the cluster option \fB\-c\fR is not used.
|
|
|
+.Ip "\fB$HOME/.ssh/agent-\fR\fIhostname\fR" 4
|
|
|
+.IX Item "$HOME/.ssh/agent-hostname"
|
|
|
+The generated shell script for attaching the current shell
|
|
|
+session (and all of its sub-processes) to the \fBssh-agent\fR process.
|
|
|
+At any time this can be directly sourced from within the shell session
|
|
|
+or indirectly through the \fBssh-keyman\fR \fB\-e\fR option.
|
|
|
+This file is used if the cluster option \fB\-c\fR is used.
|
|
|
+.SH "SEE ALSO"
|
|
|
+.IX Header "SEE ALSO"
|
|
|
+\&\fBssh-agent\fR(1), \fBssh-add\fR(1).
|
|
|
+.SH "HISTORY"
|
|
|
+.IX Header "HISTORY"
|
|
|
+\&\fBssh-keyman\fR was written in May 2002 by Ralf S. Engelschall
|
|
|
+<rse@engelschall.com>. It was inspired by the similar program
|
|
|
+\&\fBkeychain\fR from Daniel Robbins <drobbins@gentoo.org>. The main
|
|
|
+difference between \fBkeychain\fR and \fBssh-keyman\fR is that \fBssh-keyman\fR
|
|
|
+uses a more orthogonal interface which even allows you to combine
|
|
|
+multiple actions into a single call.
|