From b205622789770e2b81482c8a79140fb4e834d37c Mon Sep 17 00:00:00 2001 From: Jacob Nevins Date: Tue, 11 Feb 2025 23:48:16 +0000 Subject: [PATCH] Docs: index some missing command-line options. In PuTTYgen and Pageant. --- doc/index.but | 9 +++++++++ doc/pageant.but | 8 ++++---- doc/pubkey.but | 12 ++++++------ 3 files changed, 19 insertions(+), 10 deletions(-) diff --git a/doc/index.but b/doc/index.but index 41d18a36..df2d31d7 100644 --- a/doc/index.but +++ b/doc/index.but @@ -918,8 +918,17 @@ saved sessions from \IM{authentication agent} authentication agent \IM{authentication agent} agent, authentication +\IM{-t-puttygen} \c{\-t} PuTTYgen command-line option +\IM{-b-puttygen} \c{\-b} PuTTYgen command-line option +\IM{--primes-puttygen} \c{\-\-primes} PuTTYgen command-line option +\IM{--strong-rsa-puttygen} \c{\-\-strong\-rsa} PuTTYgen command-line option +\IM{--ppk-param-puttygen} \c{\-\-ppk\-param} PuTTYgen command-line option +\IM{-E-upper-puttygen} \c{\-E} PuTTYgen command-line option + \IM{-c-pageant} \c{\-c} Pageant command-line option \IM{\-\-keylist} \c{\-\-keylist} Pageant command-line option +\IM{\-\-encrypted} \c{\-\-encrypted} Pageant command-line option +\IM{\-\-unix} \c{\-\-unix} Pageant command-line option \IM{\-\-openssh\-config} \c{\-\-openssh\-config} Pageant command-line option \IM{Windows OpenSSH} Windows OpenSSH diff --git a/doc/pageant.but b/doc/pageant.but index cf3a2955..a45270e3 100644 --- a/doc/pageant.but +++ b/doc/pageant.but @@ -167,7 +167,7 @@ passphrases on startup. If Pageant is already running, this syntax loads keys into the existing Pageant. -You can specify the \cq{\-\-encrypted} option to defer decryption of +You can specify the \c{\-\-encrypted} option to defer decryption of these keys; see \k{pageant-deferred-decryption}. \S{pageant-cmdline-command} Making Pageant run another program @@ -238,7 +238,7 @@ original Windows Subsystem for Linux (now known as WSL 1). So if you ask Pageant to listen on one of these, then your WSL 1 processes can talk directly to Pageant. -To configure this, run Pageant with the option \c{\-\-unix}, followed +To configure this, run Pageant with the option \i\c{\-\-unix}, followed with a pathname. Then, in WSL 1, set the environment variable \cw{SSH_AUTH_SOCK} to point at the WSL translation of that pathname. @@ -282,7 +282,7 @@ see \k{using-cmdline-restrict-acl} for why you might want to do this. By default, if Pageant is started with \c{\-restrict\-acl}, it won't pass this to any PuTTY sessions started from its System Tray submenu. -Use \c{\-restrict\-putty\-acl} to change this. (Again, see +Use \i\c{\-restrict\-putty\-acl} to change this. (Again, see \k{using-cmdline-restrict-acl} for details.) \H{pageant-forward} Using \i{agent forwarding} @@ -365,7 +365,7 @@ won't ask for a passphrase. Instead, the key will be listed in the main window with \q{(encrypted)} after it. To start Pageant up in the first place with encrypted keys loaded into -it, you can use the \cq{\-\-encrypted} option on the command line. For +it, you can use the \i\c{\-\-encrypted} option on the command line. For example: \c C:\PuTTY\pageant.exe --encrypted d:\main.ppk diff --git a/doc/pubkey.but b/doc/pubkey.but index cdba9f8d..7ff2ee12 100644 --- a/doc/pubkey.but +++ b/doc/pubkey.but @@ -539,27 +539,27 @@ organisation containing your local standards.) The options supported on the command line are: -\dt \cw{\-t} \e{keytype} +\dt \I{-t-puttygen}\cw{\-t} \e{keytype} \dd Type of key to generate. You can select \c{rsa}, \c{dsa}, \c{ecdsa}, \c{eddsa}, \c{ed25519}, \c{ed448}, or \c{rsa1}. See \k{puttygen-keytype}. -\dt \cw{\-b} \e{bits} +\dt \I{-b-puttygen}\cw{\-b} \e{bits} \dd Size of the key to generate, in bits. See \k{puttygen-strength}. -\dt \cw{\-\-primes} \e{method} +\dt \I{--primes-puttygen}\cw{\-\-primes} \e{method} \dd Method for generating prime numbers. You can select \c{probable}, \c{proven}, and \c{proven-even}. See \k{puttygen-primes}. -\dt \cw{\-\-strong-rsa} +\dt \I{--strong-rsa-puttygen}\cw{\-\-strong-rsa} \dd When generating an RSA key, make sure the prime factors of the key modulus are \q{strong primes}. See \k{puttygen-primes}. -\dt \cw{\-\-ppk-param} \e{key}\cw{=}\e{value}\cw{,}... +\dt \I{--ppk-param-puttygen}\cw{\-\-ppk-param} \e{key}\cw{=}\e{value}\cw{,}... \dd Allows setting all the same details of the PPK save file format described in \k{puttygen-save-params}. @@ -599,7 +599,7 @@ key. } -\dt \cw{\-E} \e{fptype} +\dt \I{-E-upper-puttygen}\cw{\-E} \e{fptype} \dd Algorithm to use when displaying key fingerprints. You can select \c{sha256} or \c{md5}. See \k{puttygen-fingerprint}.