OSDN Git Service

Add PuTTY 0.61 to contrib directory.
[ffftp/ffftp.git] / contrib / putty / DOC / MAN-PG.BUT
diff --git a/contrib/putty/DOC/MAN-PG.BUT b/contrib/putty/DOC/MAN-PG.BUT
new file mode 100644 (file)
index 0000000..d71fe57
--- /dev/null
@@ -0,0 +1,211 @@
+\cfg{man-identity}{puttygen}{1}{2004-03-24}{PuTTY tool suite}{PuTTY tool suite}\r
+\r
+\H{puttygen-manpage} Man page for PuTTYgen\r
+\r
+\S{puttygen-manpage-name} NAME\r
+\r
+\cw{puttygen} - public-key generator for the PuTTY tools\r
+\r
+\S{puttygen-manpage-synopsis} SYNOPSIS\r
+\r
+\c puttygen ( keyfile | -t keytype [ -b bits ] )\r
+\e bbbbbbbb   iiiiiii   bb iiiiiii   bb iiii\r
+\c          [ -C new-comment ] [ -P ] [ -q ]\r
+\e            bb iiiiiiiiiii     bb     bb\r
+\c          [ -O output-type | -l | -L | -p ]\r
+\e            bb iiiiiiiiiii   bb   bb   bb\r
+\c          [ -o output-file ]\r
+\e            bb iiiiiiiiiii\r
+\r
+\S{puttygen-manpage-description} DESCRIPTION\r
+\r
+\c{puttygen} is a tool to generate and manipulate SSH public and\r
+private key pairs. It is part of the PuTTY suite, although it can\r
+also interoperate with the private key formats used by some other\r
+SSH clients.\r
+\r
+When you run \c{puttygen}, it does three things. Firstly, it either\r
+loads an existing key file (if you specified \e{keyfile}), or\r
+generates a new key (if you specified \e{keytype}). Then, it\r
+optionally makes modifications to the key (changing the comment\r
+and/or the passphrase); finally, it outputs the key, or some\r
+information about the key, to a file.\r
+\r
+All three of these phases are controlled by the options described in\r
+the following section.\r
+\r
+\S{puttygen-manpage-options} OPTIONS\r
+\r
+In the first phase, \c{puttygen} either loads or generates a key.\r
+Note that generating a key requires random data (from\r
+\c{/dev/random}), which can cause \c{puttygen} to pause, possibly for\r
+some time if your system does not have much randomness available.\r
+\r
+The options to control this phase are:\r
+\r
+\dt \e{keyfile}\r
+\r
+\dd Specify a private key file to be loaded. This private key file can\r
+be in the (de facto standard) SSH-1 key format, or in PuTTY's SSH-2\r
+key format, or in either of the SSH-2 private key formats used by\r
+OpenSSH and ssh.com's implementation.\r
+\r
+\dt \cw{\-t} \e{keytype}\r
+\r
+\dd Specify a type of key to generate. The acceptable values here are\r
+\c{rsa} and \c{dsa} (to generate SSH-2 keys), and \c{rsa1} (to\r
+generate SSH-1 keys).\r
+\r
+\dt \cw{\-b} \e{bits}\r
+\r
+\dd Specify the size of the key to generate, in bits. Default is 1024.\r
+\r
+\dt \cw{\-q}\r
+\r
+\dd Suppress the progress display when generating a new key.\r
+\r
+In the second phase, \c{puttygen} optionally alters properties of\r
+the key it has loaded or generated. The options to control this are:\r
+\r
+\dt \cw{\-C} \e{new\-comment}\r
+\r
+\dd Specify a comment string to describe the key. This comment string\r
+will be used by PuTTY to identify the key to you (when asking you to\r
+enter the passphrase, for example, so that you know which passphrase\r
+to type).\r
+\r
+\dt \cw{\-P}\r
+\r
+\dd Indicate that you want to change the key's passphrase. This is\r
+automatic when you are generating a new key, but not when you are\r
+modifying an existing key.\r
+\r
+In the third phase, \c{puttygen} saves the key or information\r
+about it. The options to control this are:\r
+\r
+\dt \cw{\-O} \e{output\-type}\r
+\r
+\dd Specify the type of output you want \c{puttygen} to produce.\r
+Acceptable options are:\r
+\r
+\lcont{\r
+\r
+\dt \cw{private}\r
+\r
+\dd Save the private key in a format usable by PuTTY. This will either\r
+be the standard SSH-1 key format, or PuTTY's own SSH-2 key format.\r
+\r
+\dt \cw{public}\r
+\r
+\dd Save the public key only. For SSH-1 keys, the standard public key\r
+format will be used (\q{\cw{1024 37 5698745}...}). For SSH-2 keys, the\r
+public key will be output in the format specified by RFC 4716,\r
+which is a multi-line text file beginning with the line\r
+\q{\cw{---- BEGIN SSH2 PUBLIC KEY ----}}.\r
+\r
+\dt \cw{public-openssh}\r
+\r
+\dd Save the public key only, in a format usable by OpenSSH. For SSH-1\r
+keys, this output format behaves identically to \c{public}. For\r
+SSH-2 keys, the public key will be output in the OpenSSH format,\r
+which is a single line (\q{\cw{ssh-rsa AAAAB3NzaC1yc2}...}).\r
+\r
+\dt \cw{fingerprint}\r
+\r
+\dd Print the fingerprint of the public key. All fingerprinting\r
+algorithms are believed compatible with OpenSSH.\r
+\r
+\dt \cw{private-openssh}\r
+\r
+\dd Save an SSH-2 private key in OpenSSH's format. This option is not\r
+permitted for SSH-1 keys.\r
+\r
+\dt \cw{private-sshcom}\r
+\r
+\dd Save an SSH-2 private key in ssh.com's format. This option is not\r
+permitted for SSH-1 keys.\r
+\r
+If no output type is specified, the default is \c{private}.\r
+\r
+}\r
+\r
+\dt \cw{\-o} \e{output\-file}\r
+\r
+\dd Specify the file where \c{puttygen} should write its output. If\r
+this option is not specified, \c{puttygen} will assume you want to\r
+overwrite the original file if the input and output file types are\r
+the same (changing a comment or passphrase), and will assume you\r
+want to output to stdout if you are asking for a public key or\r
+fingerprint. Otherwise, the \c{\-o} option is required.\r
+\r
+\dt \cw{\-l}\r
+\r
+\dd Synonym for \q{\cw{-O fingerprint}}.\r
+\r
+\dt \cw{\-L}\r
+\r
+\dd Synonym for \q{\cw{-O public-openssh}}.\r
+\r
+\dt \cw{\-p}\r
+\r
+\dd Synonym for \q{\cw{-O public}}.\r
+\r
+The following options do not run PuTTYgen as normal, but print\r
+informational messages and then quit:\r
+\r
+\dt \cw{\-h}, \cw{\-\-help}\r
+\r
+\dd Display a message summarizing the available options.\r
+\r
+\dt \cw{\-V}, \cw{\-\-version}\r
+\r
+\dd Display the version of PuTTYgen.\r
+\r
+\dt \cw{\-\-pgpfp}\r
+\r
+\dd Display the fingerprints of the PuTTY PGP Master Keys, to aid\r
+in verifying new files released by the PuTTY team.\r
+\r
+\S{puttygen-manpage-examples} EXAMPLES\r
+\r
+To generate an SSH-2 RSA key pair and save it in PuTTY's own format\r
+(you will be prompted for the passphrase):\r
+\r
+\c puttygen -t rsa -C "my home key" -o mykey.ppk\r
+\r
+To generate a larger (2048-bit) key:\r
+\r
+\c puttygen -t rsa -b 2048 -C "my home key" -o mykey.ppk\r
+\r
+To change the passphrase on a key (you will be prompted for the old\r
+and new passphrases):\r
+\r
+\c puttygen -P mykey.ppk\r
+\r
+To change the comment on a key:\r
+\r
+\c puttygen -C "new comment" mykey.ppk\r
+\r
+To convert a key into OpenSSH's private key format:\r
+\r
+\c puttygen mykey.ppk -O private-openssh -o my-openssh-key\r
+\r
+To convert a key \e{from} another format (\c{puttygen} will\r
+automatically detect the input key type):\r
+\r
+\c puttygen my-ssh.com-key -o mykey.ppk\r
+\r
+To display the fingerprint of a key (some key types require a\r
+passphrase to extract even this much information):\r
+\r
+\c puttygen -l mykey.ppk\r
+\r
+To add the OpenSSH-format public half of a key to your authorised\r
+keys file:\r
+\r
+\c puttygen -L mykey.ppk >> $HOME/.ssh/authorized_keys\r
+\r
+\S{puttygen-manpage-bugs} BUGS\r
+\r
+There's currently no way to supply passphrases in batch mode, or\r
+even just to specify that you don't want a passphrase at all.\r