Updated usage messages for command-line utilities to reflect new options.

[u/mdw/putty] / doc / pageant.but

diff --git a/doc/pageant.but b/doc/pageant.but
index cf8db03..c1f2a82 100644 (file)
--- a/doc/pageant.but
+++ b/doc/pageant.but
@@ -1,4 +1,4 @@
-\versionid $Id: pageant.but,v 1.6 2001/12/11 18:48:29 simon Exp $
+\versionid $Id: pageant.but,v 1.8 2002/09/11 17:30:36 jacob Exp $
 
 \C{pageant} Using Pageant for authentication
 
@@ -115,6 +115,38 @@ You can apply this to keys you added using the \q{Add Key} button,
 or to keys you added remotely using agent forwarding (see
 \k{pageant-forward}); it makes no difference.
 
+\H{pageant-cmdline} The Pageant command line
+
+Pageant can be made to do things automatically when it starts up, by
+specifying instructions on its command line. If you're starting
+Pageant from the Windows GUI, you can arrange this by editing the
+properties of the Windows shortcut that it was started from.
+
+\S{pageant-cmdline-loadkey} Making Pageant automatically load keys
+on startup
+
+Pageant can automatically load one or more private keys when it
+starts up, if you provide them on the Pageant command line. Your
+command line might then look like:
+
+\c C:\PuTTY\pageant.exe d:\main.key d:\secondary.key
+
+If the keys are stored encrypted, Pageant will request the
+passphrases on startup.
+
+\S{pageant-cmdline-command} Making Pageant run another program
+
+You can arrange for Pageant to start another program once it has
+initialised itself and loaded any keys specified on its command
+line. This program (perhaps a PuTTY, or a WinCVS making use of
+Plink, or whatever) will then be able to use the keys Pageant has
+loaded.
+
+You do this by specifying the \c{-c} option followed by the command,
+like this:
+
+\c C:\PuTTY\pageant.exe d:\main.key -c C:\PuTTY\putty.exe
+
 \H{pageant-forward} Using agent forwarding
 
 Agent forwarding is a mechanism that allows applications on your SSH
@@ -130,7 +162,9 @@ secret.
 
 To enable agent forwarding, first start Pageant. Then set up a PuTTY
 SSH session in which \q{Allow agent forwarding} is enabled (see
-\k{config-ssh-agentfwd}). Open the session as normal.
+\k{config-ssh-agentfwd}). Open the session as normal. (Alternatively,
+you can use the \c{-A} command line option; see
+\k{using-cmdline-agent} for details.)
 
 If this has worked, your applications on the server should now have
 access to a Unix domain socket which the SSH server will forward