X-Git-Url: https://asedeno.scripts.mit.edu/gitweb/?a=blobdiff_plain;f=doc%2Fman-pag.but;h=098d33250925ae85823706b0c247a7c695202955;hb=145ecf611238c4f1e39d89d3eee40319a2c54fe8;hp=2798cacc3ef4589ae5309536fede4fc2b8655d04;hpb=4b8a86b1ac4acd857fd607f5da1a8cc8416b61ce;p=PuTTY.git diff --git a/doc/man-pag.but b/doc/man-pag.but index 2798cacc..098d3325 100644 --- a/doc/man-pag.but +++ b/doc/man-pag.but @@ -4,7 +4,7 @@ \S{pageant-manpage-name} NAME -\cw{pageant} - SSH authentication agent for the PuTTY tools +\cw{pageant} - PuTTY SSH authentication agent \S{pageant-manpage-synopsis} SYNOPSIS @@ -37,6 +37,10 @@ that the server they are connecting to will accept. with an already-running agent to add or remove keys, list the keys, or extract their public half. +The agent protocol used by \c{pageant} is compatible with the PuTTY +tools and also with other implementations such as OpenSSH's SSH client +and \e{ssh-agent(1)}. + To run \c{pageant} as an agent, you must provide an option to tell it what its \e{lifetime} should be. Typically you would probably want Pageant to last for the duration of a login session, in which case you @@ -71,9 +75,9 @@ extra command-line arguments, e.g. in which case Pageant will prompt for the keys' passphrases (if any) and start the agent with those keys already loaded. Passphrase prompts -will use the controlling terminal if one is available, or the GUI if -one of those is available. If neither is available, no passphrase -prompting can be done. +will use the controlling terminal if one is available, or failing that +the GUI if one of those is available. If neither is available, no +passphrase prompting can be done. To use Pageant to talk to an existing agent, you can add new keys using \cw{-a}, list the current set of keys' fingerprints and comments @@ -256,6 +260,14 @@ output. } +\dt \cw{-s}, \cw{-c} + +\dd Force Pageant to output its environment setup commands in the +style of POSIX / Bourne shells (\cw{-s}) or C shells (\cw{-c}) +respectively. If neither option is given, Pageant will guess based on +whether the environment variable \cw{SHELL} has a value ending in +\cq{csh}. + \dt \cw{--help} \dd Print a brief summary of command-line options and terminate.