diff --git a/doc/.cvsignore b/doc/.cvsignore index fef278ff..c59962b5 100644 --- a/doc/.cvsignore +++ b/doc/.cvsignore @@ -2,3 +2,4 @@ *.cnt *.hlp *.gid *.GID *.log +*.1 diff --git a/doc/Makefile b/doc/Makefile index 30e5c439..2fac0bc6 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -6,6 +6,8 @@ INPUTS = $(patsubst %,%.but,$(CHAPTERS)) # This is temporary. Hack it locally or something. HALIBUT = $(HOME)/src/halibut/build/halibut +all: Contents.html man + Contents.html: $(INPUTS) $(HOME)/src/halibut/build/halibut $(INPUTS) rm -f index.html @@ -14,5 +16,17 @@ Contents.html: $(INPUTS) mv output.hlp putty.hlp mv output.cnt putty.cnt +MKMAN = $(HOME)/src/halibut/build/halibut mancfg.but $< && mv output.1 $@ +MANPAGES = putty.1 puttygen.1 plink.1 pscp.1 psftp.1 puttytel.1 pterm.1 +man: $(MANPAGES) + +putty.1: man-putt.but mancfg.but; $(MKMAN) +puttygen.1: man-pg.but mancfg.but; $(MKMAN) +plink.1: man-pl.but mancfg.but; $(MKMAN) +pscp.1: man-pscp.but mancfg.but; $(MKMAN) +psftp.1: man-psft.but mancfg.but; $(MKMAN) +puttytel.1: man-ptel.but mancfg.but; $(MKMAN) +pterm.1: man-pter.but mancfg.but; $(MKMAN) + clean: - rm -f *.html *.txt *.hlp *.cnt + rm -f *.html *.txt *.hlp *.cnt *.1 diff --git a/doc/man-pg.but b/doc/man-pg.but new file mode 100644 index 00000000..4dbc022f --- /dev/null +++ b/doc/man-pg.but @@ -0,0 +1,187 @@ +\cfg{man-identity}{puttygen}{1}{2004-03-24}{PuTTY tool suite}{PuTTY tool suite} + +\H{puttygen-manpage} Man page for PuTTYgen + +\S{puttygen-manpage-name} NAME + +\cw{puttygen} - public-key generator for the PuTTY tools + +\S{puttygen-manpage-synopsis} SYNOPSIS + +\c puttygen ( keyfile | -t keytype [ -b bits ] ) +\e bbbbbbbb iiiiiii bb iiiiiii bb iiii +\c [ -C new-comment ] [ -P ] +\e bb iiiiiiiiiii bb +\c [ -O output-type | -l | -L | -p ] +\e bb iiiiiiiiiii bb bb bb +\c [ -o output-file ] +\e bb iiiiiiiiiii + +\S{puttygen-manpage-description} DESCRIPTION + +\c{puttygen} is a tool to generate and manipulate SSH public and +private key pairs. It is part of the PuTTY suite, although it can +also interoperate with the private key formats used by some other +SSH clients. + +When you run \c{puttygen}, it does three things. Firstly, it either +loads an existing key file (if you specified \e{keyfile}), or +generates a new key (if you specified \e{keytype}). Then, it +optionally makes modifications to the key (changing the comment +and/or the passphrase); finally, it outputs the key, or some +information about the key, to a file. + +All three of these phases are controlled by the options described in +the following section. + +\S{puttygen-manpage-options} OPTIONS + +In the first phase, \c{puttygen} either loads or generates a key. +The options to control this are: + +\dt \e{keyfile} + +\dd Specify a private key file to be loaded. This private key file can +be in the (de facto standard) SSH1 key format, or in PuTTY's SSH2 +key format, or in either of the SSH2 private key formats used by +OpenSSH and ssh.com's implementation. + +\dt \cw{\-t} \e{keytype} + +\dd Specify a type of key to generate. The acceptable values here are +\c{rsa} and \c{dsa} (to generate SSH2 keys), and \c{rsa1} (to +generate SSH1 keys). + +\dt \cw{\-b} \e{bits} + +\dd Specify the size of the key to generate, in bits. Default is 1024. + +In the second phase, \c{puttygen} optionally alters properties of +the key it has loaded or generated. The options to control this are: + +\dt \cw{\-C} \e{new\-comment} + +\dd Specify a comment string to describe the key. This comment string +will be used by PuTTY to identify the key to you (when asking you to +enter the passphrase, for example, so that you know which passphrase +to type). + +\dt \cw{\-P} + +\dd Indicate that you want to change the key's passphrase. This is +automatic when you are generating a new key, but not when you are +modifying an existing key. + +In the third phase, \c{puttygen} saves the key or information +about it. The options to control this are: + +\dt \cw{\-O} \e{output\-type} + +\dd Specify the type of output you want \c{puttygen} to produce. +Acceptable options are: + +\lcont{ + +\dt \cw{private} + +\dd Save the private key in a format usable by PuTTY. This will either +be the standard SSH1 key format, or PuTTY's own SSH2 key format. + +\dt \cw{public} + +\dd Save the public key only. For SSH1 keys, the standard public key +format will be used (\q{\cw{1024 37 5698745}...}). For SSH2 keys, the +public key will be output in the format specified in the IETF +drafts, which is a multi-line text file beginning with the line +\q{\cw{---- BEGIN SSH2 PUBLIC KEY ----}}. + +\dt \cw{public-openssh} + +\dd Save the public key only, in a format usable by OpenSSH. For SSH1 +keys, this output format behaves identically to \c{public}. For +SSH2 keys, the public key will be output in the OpenSSH format, +which is a single line (\q{\cw{ssh-rsa AAAAB3NzaC1yc2}...}). + +\dt \cw{fingerprint} + +\dd Print the fingerprint of the public key. All fingerprinting +algorithms are believed compatible with OpenSSH. + +\dt \cw{private-openssh} + +\dd Save an SSH2 private key in OpenSSH's format. This option is not +permitted for SSH1 keys. + +\dt \cw{private-sshcom} + +\dd Save an SSH2 private key in ssh.com's format. This option is not +permitted for SSH1 keys. + +If no output type is specified, the default is \c{private}. + +} + +\dt \cw{\-o} \e{output\-file} + +\dd Specify the file where \c{puttygen} should write its output. If +this option is not specified, \c{puttygen} will assume you want to +overwrite the original file if the input and output file types are +the same (changing a comment or passphrase), and will assume you +want to output to stdout if you are asking for a public key or +fingerprint. Otherwise, the \c{\-o} option is required. + +\dt \cw{\-l} + +\dd Synonym for \q{\cw{-O fingerprint}}. + +\dt \cw{\-L} + +\dd Synonym for \q{\cw{-O public-openssh}}. + +\dt \cw{\-p} + +\dd Synonym for \q{\cw{-O public}}. + +\S{puttygen-manpage-examples} EXAMPLES + +To generate an SSH2 RSA key pair and save it in PuTTY's own format +(you will be prompted for the passphrase): + +\c puttygen -t rsa -C "my home key" -o mykey.ppk + +To generate a larger (2048-bit) key: + +\c puttygen -t rsa -b 2048 -C "my home key" -o mykey.ppk + +To change the passphrase on a key (you will be prompted for the old +and new passphrases): + +\c puttygen -P mykey.ppk + +To change the comment on a key: + +\c puttygen -C "new comment" mykey.ppk + +To convert a key into OpenSSH's private key format: + +\c puttygen mykey.ppk -O private-openssh -o my-openssh-key + +To convert a key \e{from} another format (\c{puttygen} will +automatically detect the input key type): + +\c puttygen my-ssh.com-key -o mykey.ppk + +To display the fingerprint of a key (some key types require a +passphrase to extract even this much information): + +\c puttygen -l mykey.ppk + +To add the OpenSSH-format public half of a key to your authorised +keys file: + +\c puttygen -L mykey.ppk >> $HOME/.ssh/authorized_keys + +\S{puttygen-manpage-bugs} BUGS + +There's currently no way to supply passphrases in batch mode, or +even just to specify that you don't want a passphrase at all. diff --git a/doc/man-pl.but b/doc/man-pl.but new file mode 100644 index 00000000..f23de40f --- /dev/null +++ b/doc/man-pl.but @@ -0,0 +1,144 @@ +\cfg{man-identity}{plink}{1}{2004-03-24}{PuTTY tool suite}{PuTTY tool suite} +\cfg{man-mindepth}{1} + +\H{plink-manpage} Man page for Plink + +\S{plink-manpage-name} NAME + +\cw{plink} \- PuTTY link, command line network connection tool + +\S{plink-manpage-synopsis} SYNOPSIS + +\c plink [options] [user@]host [command] +\e bbbbb iiiiiii iiiib iiii iiiiiii + +\S{plink-manpage-description} DESCRIPTION + +\cw{plink} is a network connection tool supporting several protocols. + +\S{plink-manpage-options} OPTIONS + +The command-line options supported by \cw{plink} are: + +\dt \cw{-v} + +\dd Show verbose messages. + +\dt \cw{-load} \e{session} + +\dd Load settings from saved session. + +\dt \cw{-ssh} + +\dd Force use of SSH protocol (default). + +\dt \cw{-telnet} + +\dd Force use of Telnet protocol. + +\dt \cw{-rlogin} + +\dd Force use of rlogin protocol. + +\dt \cw{-raw} + +\dd Force raw mode. + +\dt \cw{-P} \e{port} + +\dd Connect to port \e{port}. + +\dt \cw{-l} \e{user} + +\dd Set remote username to \e{user}. + +\dt \cw{-m} \e{path} + +\dd Read remote command(s) from local file \e{path}. + +\dt \cw{-batch} + +\dd Disable interactive prompts. + +\dt \cw{-pw} \e{password} + +\dd Set remote password to \e{password}. + +\dt \cw{\-L} \cw{[}\e{srcaddr}\cw{:]}\e{srcport}\cw{:}\e{desthost}\cw{:}\e{destport} + +\dd Set up a local port forwarding: listen on \e{srcport} (or +\e{srcaddr}:\e{srcport} if specified), and forward any connections +over the SSH connection to the destination address +\e{desthost}:\e{destport}. Only works in SSH. + +\dt \cw{\-R} \cw{[}\e{srcaddr}\cw{:]}\e{srcport}\cw{:}\e{desthost}\cw{:}\e{destport} + +\dd Set up a remote port forwarding: ask the SSH server to listen on +\e{srcport} (or \e{srcaddr}:\e{srcport} if specified), and to +forward any connections back over the SSH connection where the +client will pass them on to the destination address +\e{desthost}:\e{destport}. Only works in SSH. + +\dt \cw{\-D} [\e{srcaddr}:]\e{srcport} + +\dd Set up dynamic port forwarding. The client listens on +\e{srcport} (or \e{srcaddr}:\e{srcport} if specified), and +implements a SOCKS server. So you can point SOCKS-aware applications +at this port and they will automatically use the SSH connection to +tunnel all their connections. Only works in SSH. + +\dt \cw{-X} + +\dd Enable X11 forwarding. + +\dt \cw{-x} + +\dd Disable X11 forwarding (default). + +\dt \cw{-A} + +\dd Enable agent forwarding. + +\dt \cw{-a} + +\dd Disable agent forwarding (default). + +\dt \cw{-t} + +\dd Enable pty allocation (default if a command is NOT specified). + +\dt \cw{-T} + +\dd Disable pty allocation (default if a command is specified). + +\dt \cw{-1} + +\dd Force use of SSH protocol version 1. + +\dt \cw{-2} + +\dd Force use of SSH protocol version 2. + +\dt \cw{-C} + +\dd Enable SSH compression. + +\dt \cw{-i} \e{path} + +\dd Private key file for authentication. + +\dt \cw{-s} + +\dd Remote command is SSH subsystem (SSH-2 only). + +\S{plink-manpage-more-information} MORE INFORMATION + +For more information on plink, it's probably best to go and look at +the manual on the PuTTY web page: + +\W{http://www.chiark.greenend.org.uk/~sgtatham/putty/}\cw{http://www.chiark.greenend.org.uk/~sgtatham/putty/} + +\S{plink-manpage-bugs} BUGS + +This man page isn't terribly complete. See the above web link for +better documentation. diff --git a/doc/man-pscp.but b/doc/man-pscp.but new file mode 100644 index 00000000..e628def9 --- /dev/null +++ b/doc/man-pscp.but @@ -0,0 +1,97 @@ +\cfg{man-identity}{pscp}{1}{2004-03-24}{PuTTY tool suite}{PuTTY tool suite} + +\H{pscp-manpage} Man page for PSCP + +\S{pscp-manpage-name} NAME + +\cw{pscp} \- command-line SCP (secure copy) / SFTP client + +\S{pscp-manpage-synopsis} SYNOPSIS + +\c pscp [options] [user@]host:source target +\e bbbb iiiiiii iiiib iiiibiiiiii iiiiii +\c pscp [options] source [source...] [user@]host:target +\e bbbb iiiiiii iiiiii iiiiii iiiib iiiibiiiiii +\c pscp [options] -ls [user@]host:filespec +\e bbbb iiiiiii bbb iiiib iiiibiiiiiiii + +\S{pscp-manpage-description} DESCRIPTION + +\cw{pscp} is a command-line client for the SSH-based SCP (secure +copy) and SFTP (secure file transfer protocol) protocols. + +\S{pscp-manpage-options} OPTIONS + +The command-line options supported by \e{pscp} are: + +\dt \cw{-ls} + +\dd Remote directory listing. + +\dt \cw{-p} + +\dd Preserve file attributes. + +\dt \cw{-q} + +\dd Quiet, don't show statistics. + +\dt \cw{-r} + +\dd Copy directories recursively. + +\dt \cw{-unsafe} + +\dd Allow server-side wildcards (DANGEROUS). + +\dt \cw{-v} + +\dd Show verbose messages. + +\dt \cw{-load} \e{session} + +\dd Load settings from saved session. + +\dt \cw{-P} \e{port} + +\dd Connect to port \e{port}. + +\dt \cw{-l} \e{user} + +\dd Set remote username to \e{user}. + +\dt \cw{-batch} + +\dd Disable interactive prompts. + +\dt \cw{-pw} \e{password} + +\dd Set remote password to \e{password}. + +\dt \cw{-1} + +\dd Force use of SSH protocol version 1. + +\dt \cw{-2} + +\dd Force use of SSH protocol version 2. + +\dt \cw{-C} + +\dd Enable SSH compression. + +\dt \cw{-i} \e{path} + +\dd Private key file for authentication. + +\S{pscp-manpage-more-information} MORE INFORMATION + +For more information on \cw{pscp} it's probably best to go and look at +the manual on the PuTTY web page: + +\W{http://www.chiark.greenend.org.uk/~sgtatham/putty/}\cw{http://www.chiark.greenend.org.uk/~sgtatham/putty/} + +\S{pscp-manpage-bugs} BUGS + +This man page isn't terribly complete. See the above web link for +better documentation. diff --git a/doc/man-psft.but b/doc/man-psft.but new file mode 100644 index 00000000..118d1575 --- /dev/null +++ b/doc/man-psft.but @@ -0,0 +1,90 @@ +\cfg{man-identity}{psftp}{1}{2004-03-24}{PuTTY tool suite}{PuTTY tool suite} + +\H{psftp-manpage} Man page for PSFTP + +\S{psftp-manpage-name} NAME + +\cw{psftp} \- interactive SFTP (secure file transfer protocol) client + +\S{psftp-manpage-synopsis} SYNOPSIS + +\c psftp [options] [user@]host +\e bbbbb iiiiiii iiiib iiii + +\S{psftp-manpage-description} DESCRIPTION + +\cw{psftp} is an interactive text-based client for the SSH-based SFTP +(secure file transfer) protocol. + +\S{psftp-manpage-options} OPTIONS + +The command-line options supported by \cw{psftp} are: + +\dt \cw{-b} \e{batchfile} + +\dd Use specified batchfile. + +\dt \cw{-bc} + +\dd Output batchfile commands. + +\dt \cw{-be} + +\dd Don't stop batchfile processing on errors. + +\dt \cw{-v} + +\dd Show verbose messages. + +\dt \cw{-load} \e{session} + +\dd Load settings from saved session. + +\dt \cw{-P} \e{port} + +\dd Connect to port \e{port}. + +\dt \cw{-l} \e{user} + +\dd Set remote username to \e{user}. + +\dt \cw{-batch} + +\dd Disable interactive prompts. + +\dt \cw{-pw} \e{password} + +\dd Set remote password to \e{password}. + +\dt \cw{-1} + +\dd Force use of SSH protocol version 1. + +\dt \cw{-2} + +\dd Force use of SSH protocol version 2. + +\dt \cw{-C} + +\dd Enable SSH compression. + +\dt \cw{-i} \e{path} + +\dd Private key file for authentication. + +\S{psftp-manpage-commands} COMMANDS + +For a list of commands available inside \cw{psftp}, type \cw{help} +at the \cw{psftp>} prompt. + +\S{psftp-manpage-more-information} MORE INFORMATION + +For more information on \cw{psftp} it's probably best to go and look at +the manual on the PuTTY web page: + +\cw{http://www.chiark.greenend.org.uk/~sgtatham/putty/} + +\S{psftp-manpage-bugs} BUGS + +This man page isn't terribly complete. See the above web link for +better documentation. diff --git a/doc/man-ptel.but b/doc/man-ptel.but new file mode 100644 index 00000000..4364c230 --- /dev/null +++ b/doc/man-ptel.but @@ -0,0 +1,184 @@ +\cfg{man-identity}{puttytel}{1}{2004-03-24}{PuTTY tool suite}{PuTTY tool suite} + +\H{puttytel-manpage} Man page for PuTTYtel + +\S{puttytel-manpage-name} NAME + +\cw{puttytel} \- GUI Telnet and Rlogin client for X + +\S{puttytel-manpage-synopsis} SYNOPSIS + +\c puttytel [ options ] [ host ] +\e bbbbbbbb iiiiiii iiii + +\S{puttytel-manpage-description} DESCRIPTION + +\cw{puttytel} is a graphical Telnet and Rlogin client for X. It +is a direct port of the Windows Telnet and Rlogin client of the same +name, and a cut-down cryptography-free version of PuTTY. + +\S{puttytel-manpage-options} OPTIONS + +The command-line options supported by \cw{puttytel} are: + +\dt \cw{\-\-display} \e{display\-name} + +\dd Specify the X display on which to open \cw{puttytel}. (Note this +option has a double minus sign, even though none of the others do. +This is because this option is supplied automatically by GTK. +Sorry.) + +\dt \cw{\-fn} \e{font-name} + +\dd Specify the font to use for normal text displayed in the terminal. + +\dt \cw{\-fb} \e{font-name} + +\dd Specify the font to use for bold text displayed in the terminal. If +the \cw{BoldAsColour} resource is set to 1 (the default), bold text +will be displayed in different colours instead of a different font, +so this option will be ignored. If \cw{BoldAsColour} is set to 0 +and you do not specify a bold font, \cw{puttytel} will overprint the +normal font to make it look bolder. + +\dt \cw{\-fw} \e{font-name} + +\dd Specify the font to use for double-width characters (typically +Chinese, Japanese and Korean text) displayed in the terminal. + +\dt \cw{\-fwb} \e{font-name} + +\dd Specify the font to use for bold double-width characters +(typically Chinese, Japanese and Korean text). Like \cw{-fb}, this +will be ignored unless the \cw{BoldAsColour} resource is set to 0. + +\dt \cw{\-geometry} \e{geometry} + +\dd Specify the size of the terminal, in rows and columns of text. See +\e{X(7)} for more information on the syntax of geometry +specifications. + +\dt \cw{\-sl} \e{lines} + +\dd Specify the number of lines of scrollback to save off the top of the +terminal. + +\dt \cw{\-fg} \e{colour} + +\dd Specify the foreground colour to use for normal text. + +\dt \cw{\-bg} \e{colour} + +\dd Specify the background colour to use for normal text. + +\dt \cw{\-bfg} \e{colour} + +\dd Specify the foreground colour to use for bold text, if the +\cw{BoldAsColour} resource is set to 1 (the default). + +\dt \cw{\-bbg} \e{colour} + +\dd Specify the foreground colour to use for bold reverse-video text, if +the \cw{BoldAsColour} resource is set to 1 (the default). (This +colour is best thought of as the bold version of the background +colour; so it only appears when text is displayed \e{in} the +background colour.) + +\dt \cw{\-cfg} \e{colour} + +\dd Specify the foreground colour to use for text covered by the cursor. + +\dt \cw{\-cbg} \e{colour} + +\dd Specify the background colour to use for text covered by the cursor. +In other words, this is the main colour of the cursor. + +\dt \cw{\-title} \e{title} + +\dd Specify the initial title of the terminal window. (This can be +changed under control of the server.) + +\dt \cw{\-sb\-} or \cw{+sb} + +\dd Tells \cw{puttytel} not to display a scroll bar. + +\dt \cw{\-sb} + +\dd Tells \cw{puttytel} to display a scroll bar: this is the opposite of +\cw{\-sb\-}. This is the default option: you will probably only need +to specify it explicitly if you have changed the default using the +\cw{ScrollBar} resource. + +\dt \cw{\-log} \e{filename} + +\dd This option makes \cw{puttytel} log all the terminal output to a file +as well as displaying it in the terminal. + +\dt \cw{\-cs} \e{charset} + +\dd This option specifies the character set in which \cw{puttytel} +should assume the session is operating. This character set will be +used to interpret all the data received from the session, and all +input you type or paste into \cw{puttytel} will be converted into +this character set before being sent to the session. + +\lcont{ Any character set name which is valid in a MIME header (and +supported by \cw{puttytel}) should be valid here (examples are +\q{\cw{ISO-8859-1}}, \q{\cw{windows-1252}} or \q{\cw{UTF-8}}). Also, +any character encoding which is valid in an X logical font +description should be valid (\q{\cw{ibm-cp437}}, for example). + +\cw{puttytel}'s default behaviour is to use the same character +encoding as its primary font. If you supply a Unicode +(\cw{iso10646-1}) font, it will default to the UTF-8 character set. + +Character set names are case-insensitive. +} + +\dt \cw{\-nethack} + +\dd Tells \cw{puttytel} to enable NetHack keypad mode, in which the +numeric keypad generates the NetHack \c{hjklyubn} direction keys. +This enables you to play NetHack with the numeric keypad without +having to use the NetHack \c{number_pad} option (which requires you +to press \q{\cw{n}} before any repeat count). So you can move with +the numeric keypad, and enter repeat counts with the normal number +keys. + +\dt \cw{\-help}, \cw{\-\-help} + +\dd Display a message summarizing the available options. + +\dt \cw{\-load} \e{session} + +\dd Load a saved session by name. This allows you to run a saved session +straight from the command line without having to go through the +configuration box first. + +\dt \cw{\-telnet}, \cw{\-rlogin}, \cw{\-raw} + +\dd Select the protocol \cw{puttytel} will use to make the connection. + +\dt \cw{\-l} \e{username} + +\dd Specify the username to use when logging in to the server. + +\dt \cw{\-P} \e{port} + +\dd Specify the port to connect to the server on. + +\S{puttytel-manpage-saved-sessions} SAVED SESSIONS + +Saved sessions are stored in a \cw{.putty/sessions} subdirectory in +your home directory. + +\S{puttytel-manpage-more-information} MORE INFORMATION + +For more information on PuTTY and PuTTYtel, it's probably best to go +and look at the manual on the web page: + +\W{http://www.chiark.greenend.org.uk/~sgtatham/putty/}\cw{http://www.chiark.greenend.org.uk/~sgtatham/putty/} + +\S{puttytel-manpage-bugs} BUGS + +This man page isn't terribly complete. diff --git a/doc/man-pter.but b/doc/man-pter.but new file mode 100644 index 00000000..f647223e --- /dev/null +++ b/doc/man-pter.but @@ -0,0 +1,671 @@ +\cfg{man-identity}{pterm}{1}{2004-03-24}{PuTTY tool suite}{PuTTY tool suite} + +\H{pterm-manpage} Man page for pterm + +\S{pterm-manpage-name} NAME + +pterm \- yet another X terminal emulator + +\S{pterm-manpage-synopsis} SYNOPSIS + +\c pterm [ options ] +\e bbbbb iiiiiii + +\S{pterm-manpage-description} DESCRIPTION + +\cw{pterm} is a terminal emulator for X. It is based on a port of +the terminal emulation engine in the Windows SSH client PuTTY. + +\S{pterm-manpage-options} OPTIONS + +The command-line options supported by \cw{pterm} are: + +\dt \cw{\-e} \e{command} [ \e{arguments} ] + +\dd Specify a command to be executed in the new terminal. Everything on +the command line after this option will be passed straight to the +\cw{execvp} system call; so if you need the command to redirect its +input or output, you will have to use \cw{sh}: + +\lcont{ + +\c pterm -e sh -c 'mycommand < inputfile' + +} + +\dt \cw{\-\-display} \e{display\-name} + +\dd Specify the X display on which to open \cw{pterm}. (Note this +option has a double minus sign, even though none of the others do. +This is because this option is supplied automatically by GTK. +Sorry.) + +\dt \cw{\-name} \e{font-name} + +\dd Specify the name under which \cw{pterm} looks up X resources. +Normally it will look them up as (for example) \cw{pterm.Font}. If +you specify \q{\cw{\-name xyz}}, it will look them up as +\cw{xyz.Font} instead. This allows you to set up several different +sets of defaults and choose between them. + +\dt \cw{\-fn} \e{font-name} + +\dd Specify the font to use for normal text displayed in the terminal. + +\dt \cw{\-fb} \e{font-name} + +\dd Specify the font to use for bold text displayed in the terminal. If +the \cw{BoldAsColour} resource is set to 1 (the default), bold text +will be displayed in different colours instead of a different font, +so this option will be ignored. If \cw{BoldAsColour} is set to 0 +and you do not specify a bold font, \cw{pterm} will overprint the +normal font to make it look bolder. + +\dt \cw{\-fw} \e{font-name} + +\dd Specify the font to use for double-width characters (typically +Chinese, Japanese and Korean text) displayed in the terminal. + +\dt \cw{\-fwb} \e{font-name} + +\dd Specify the font to use for bold double-width characters +(typically Chinese, Japanese and Korean text). Like \cw{-fb}, this +will be ignored unless the \cw{BoldAsColour} resource is set to 0. + +\dt \cw{\-geometry} \e{geometry} + +\dd Specify the size of the terminal, in rows and columns of text. See +\e{X(7)} for more information on the syntax of geometry +specifications. + +\dt \cw{\-sl} \e{lines} + +\dd Specify the number of lines of scrollback to save off the top of the +terminal. + +\dt \cw{\-fg} \e{colour} + +\dd Specify the foreground colour to use for normal text. + +\dt \cw{\-bg} \e{colour} + +\dd Specify the background colour to use for normal text. + +\dt \cw{\-bfg} \e{colour} + +\dd Specify the foreground colour to use for bold text, if the +\cw{BoldAsColour} resource is set to 1 (the default). + +\dt \cw{\-bbg} \e{colour} + +\dd Specify the foreground colour to use for bold reverse-video text, if +the \cw{BoldAsColour} resource is set to 1 (the default). (This +colour is best thought of as the bold version of the background +colour; so it only appears when text is displayed \e{in} the +background colour.) + +\dt \cw{\-cfg} \e{colour} + +\dd Specify the foreground colour to use for text covered by the cursor. + +\dt \cw{\-cbg} \e{colour} + +\dd Specify the background colour to use for text covered by the cursor. +In other words, this is the main colour of the cursor. + +\dt \cw{\-title} \e{title} + +\dd Specify the initial title of the terminal window. (This can be +changed under control of the server.) + +\dt \cw{\-ut\-} or \cw{+ut} + +\dd Tells \cw{pterm} not to record your login in the \cw{utmp}, +\cw{wtmp} and \cw{lastlog} system log files; so you will not show +up on \cw{finger} or \cw{who} listings, for example. + +\dt \cw{\-ut} + +\dd Tells \cw{pterm} to record your login in \cw{utmp}, \cw{wtmp} and +\cw{lastlog}: this is the opposite of \cw{\-ut\-}. This is the +default option: you will probably only need to specify it explicitly +if you have changed the default using the \cw{StampUtmp} resource. + +\dt \cw{\-ls\-} or \cw{+ls} + +\dd Tells \cw{pterm} not to execute your shell as a login shell. + +\dt \cw{\-ls} + +\dd Tells \cw{pterm} to execute your shell as a login shell: this is +the opposite of \cw{\-ls\-}. This is the default option: you will +probably only need to specify it explicitly if you have changed the +default using the \cw{LoginShell} resource. + +\dt \cw{\-sb\-} or \cw{+sb} + +\dd Tells \cw{pterm} not to display a scroll bar. + +\dt \cw{\-sb} + +\dd Tells \cw{pterm} to display a scroll bar: this is the opposite of +\cw{\-sb\-}. This is the default option: you will probably only need +to specify it explicitly if you have changed the default using the +\cw{ScrollBar} resource. + +\dt \cw{\-log} \e{filename} + +\dd This option makes \cw{pterm} log all the terminal output to a file +as well as displaying it in the terminal. + +\dt \cw{\-cs} \e{charset} + +\dd This option specifies the character set in which \cw{pterm} should +assume the session is operating. This character set will be used to +interpret all the data received from the session, and all input you +type or paste into \cw{pterm} will be converted into this character +set before being sent to the session. + +\lcont{ Any character set name which is valid in a MIME header (and +supported by \cw{pterm}) should be valid here (examples are +\q{\cw{ISO-8859-1}}, \q{\cw{windows-1252}} or \q{\cw{UTF-8}}). Also, +any character encoding which is valid in an X logical font +description should be valid (\q{\cw{ibm-cp437}}, for example). + +\cw{pterm}'s default behaviour is to use the same character encoding +as its primary font. If you supply a Unicode (\cw{iso10646-1}) font, +it will default to the UTF-8 character set. + +Character set names are case-insensitive. +} + +\dt \cw{\-nethack} + +\dd Tells \cw{pterm} to enable NetHack keypad mode, in which the +numeric keypad generates the NetHack \c{hjklyubn} direction keys. +This enables you to play NetHack with the numeric keypad without +having to use the NetHack \c{number_pad} option (which requires you +to press \q{\cw{n}} before any repeat count). So you can move with +the numeric keypad, and enter repeat counts with the normal number +keys. + +\dt \cw{\-xrm} \e{resource-string} + +\dd This option specifies an X resource string. Useful for setting +resources which do not have their own command-line options. For +example: + +\lcont{ + +\c pterm -xrm 'ScrollbarOnLeft: 1' + +} + +\dt \cw{\-help}, \cw{\-\-help} + +\dd Display a message summarizing the available options. + +\S{pterm-manpage-x-resources} X RESOURCES + +\cw{pterm} can be more completely configured by means of X +resources. All of these resources are of the form \cw{pterm.FOO} for +some \cw{FOO}; you can make \cw{pterm} look them up under another +name, such as \cw{xyz.FOO}, by specifying the command-line option +\q{\cw{\-name xyz}}. + +\dt \cw{pterm.CloseOnExit} + +\dd This option should be set to 0, 1 or 2; the default is 2. It +controls what \cw{pterm} does when the process running inside it +terminates. When set to 2 (the default), \cw{pterm} will close its +window as soon as the process inside it terminates. When set to 0, +\cw{pterm} will print the process's exit status, and the window +will remain present until a key is pressed (allowing you to inspect +the scrollback, and copy and paste text out of it). + +\lcont{ + +When this setting is set to 1, \cw{pterm} will close +immediately if the process exits cleanly (with an exit status of +zero), but the window will stay around if the process exits with a +non-zero code or on a signal. This enables you to see what went +wrong if the process suffers an error, but not to have to bother +closing the window in normal circumstances. + +} + +\dt \cw{pterm.WarnOnClose} + +\dd This option should be set to either 0 or 1; the default is 1. +When set to 1, \cw{pterm} will ask for confirmation before closing +its window when you press the close button. + +\dt \cw{pterm.TerminalType} + +\dd This controls the value set in the \cw{TERM} environment +variable inside the new terminal. The default is \q{\cw{xterm}}. + +\dt \cw{pterm.BackspaceIsDelete} + +\dd This option should be set to either 0 or 1; the default is 1. +When set to 0, the ordinary Backspace key generates the Backspace +character (\cw{^H}); when set to 1, it generates the Delete +character (\cw{^?}). Whichever one you set, the terminal device +inside \cw{pterm} will be set up to expect it. + +\dt \cw{pterm.RXVTHomeEnd} + +\dd This option should be set to either 0 or 1; the default is 0. When +it is set to 1, the Home and End keys generate the control sequences +they would generate in the \cw{rxvt} terminal emulator, instead of +the more usual ones generated by other emulators. + +\dt \cw{pterm.LinuxFunctionKeys} + +\dd This option can be set to any number between 0 and 5 inclusive; +the default is 0. The modes vary the control sequences sent by the +function keys; for more complete documentation, it is probably +simplest to try each option in \q{\cw{pterm \-e cat}}, and press the +keys to see what they generate. + +\dt \cw{pterm.NoApplicationKeys} + +\dd This option should be set to either 0 or 1; the default is 0. When +set to 1, it stops the server from ever switching the numeric keypad +into application mode (where the keys send function-key-like +sequences instead of numbers or arrow keys). You probably only need +this if some application is making a nuisance of itself. + +\dt \cw{pterm.NoApplicationCursors} + +\dd This option should be set to either 0 or 1; the default is 0. When +set to 1, it stops the server from ever switching the cursor keys +into application mode (where the keys send slightly different +sequences). You probably only need this if some application is +making a nuisance of itself. + +\dt \cw{pterm.NoMouseReporting} + +\dd This option should be set to either 0 or 1; the default is 0. When +set to 1, it stops the server from ever enabling mouse reporting +mode (where mouse clicks are sent to the application instead of +controlling cut and paste). + +\dt \cw{pterm.NoRemoteResize} + +\dd This option should be set to either 0 or 1; the default is 0. When +set to 1, it stops the server from being able to remotely control +the size of the \cw{pterm} window. + +\dt \cw{pterm.NoAltScreen} + +\dd This option should be set to either 0 or 1; the default is 0. When +set to 1, it stops the server from using the \q{alternate screen} +terminal feature, which lets full-screen applications leave the +screen exactly the way they found it. + +\dt \cw{pterm.NoRemoteWinTitle} + +\dd This option should be set to either 0 or 1; the default is 0. When +set to 1, it stops the server from remotely controlling the title of +the \cw{pterm} window. + +\dt \cw{pterm.NoRemoteQTitle} + +\dd This option should be set to either 0 or 1; the default is 1. When +set to 1, it stops the server from remotely requesting the title of +the \cw{pterm} window. + +\lcont{ +This feature is a \e{POTENTIAL SECURITY HAZARD}. If a malicious +application can write data to your terminal (for example, if you +merely \cw{cat} a file owned by someone else on the server +machine), it can change your window title (unless you have disabled +this using the \cw{NoRemoteWinTitle} resource) and then use this +service to have the new window title sent back to the server as if +typed at the keyboard. This allows an attacker to fake keypresses +and potentially cause your server-side applications to do things you +didn't want. Therefore this feature is disabled by default, and we +recommend you do not turn it on unless you \e{really} know what +you are doing. +} + +\dt \cw{pterm.NoDBackspace} + +\dd This option should be set to either 0 or 1; the default is 0. +When set to 1, it disables the normal action of the Delete (\cw{^?}) +character when sent from the server to the terminal, which is to +move the cursor left by one space and erase the character now under +it. + +\dt \cw{pterm.ApplicationCursorKeys} + +\dd This option should be set to either 0 or 1; the default is 0. When +set to 1, the default initial state of the cursor keys are +application mode (where the keys send function-key-like sequences +instead of numbers or arrow keys). When set to 0, the default state +is the normal one. + +\dt \cw{pterm.ApplicationKeypad} + +\dd This option should be set to either 0 or 1; the default is 0. When +set to 1, the default initial state of the numeric keypad is +application mode (where the keys send function-key-like sequences +instead of numbers or arrow keys). When set to 0, the default state +is the normal one. + +\dt \cw{pterm.NetHackKeypad} + +\dd This option should be set to either 0 or 1; the default is 0. When +set to 1, the numeric keypad operates in NetHack mode. This is +equivalent to the \cw{\-nethack} command-line option. + +\dt \cw{pterm.Answerback} + +\dd This option controls the string which the terminal sends in +response to receiving the \cw{^E} character (\q{tell me about +yourself}). By default this string is \q{\cw{PuTTY}}. + +\dt \cw{pterm.HideMousePtr} + +\dd This option should be set to either 0 or 1; the default is 0. When +it is set to 1, the mouse pointer will disappear if it is over the +\cw{pterm} window and you press a key. It will reappear as soon as +you move it. + +\dt \cw{pterm.WindowBorder} + +\dd This option controls the number of pixels of space between the text +in the \cw{pterm} window and the window frame. The default is 1. +You can increase this value, but decreasing it to 0 is not +recommended because it can cause the window manager's size hints to +work incorrectly. + +\dt \cw{pterm.CurType} + +\dd This option should be set to either 0, 1 or 2; the default is 0. +When set to 0, the text cursor displayed in the window is a +rectangular block. When set to 1, the cursor is an underline; when +set to 2, it is a vertical line. + +\dt \cw{pterm.BlinkCur} + +\dd This option should be set to either 0 or 1; the default is 0. When +it is set to 1, the text cursor will blink when the window is active. + +\dt \cw{pterm.Beep} + +\dd This option should be set to either 0 or 2 (yes, 2); the default +is 0. When it is set to 2, \cw{pterm} will respond to a bell +character (\cw{^G}) by flashing the window instead of beeping. + +\dt \cw{pterm.BellOverload} + +\dd This option should be set to either 0 or 1; the default is 0. When +it is set to 1, \cw{pterm} will watch out for large numbers of +bells arriving in a short time and will temporarily disable the bell +until they stop. The idea is that if you \cw{cat} a binary file, +the frantic beeping will mostly be silenced by this feature and will +not drive you crazy. + +\lcont{ +The bell overload mode is activated by receiving N bells in time T; +after a further time S without any bells, overload mode will turn +itself off again. + +Bell overload mode is always deactivated by any keypress in the +terminal. This means it can respond to large unexpected streams of +data, but does not interfere with ordinary command-line activities +that generate beeps (such as filename completion). +} + +\dt \cw{pterm.BellOverloadN} + +\dd This option counts the number of bell characters which will activate +bell overload if they are received within a length of time T. The +default is 5. + +\dt \cw{pterm.BellOverloadT} + +\dd This option specifies the time period in which receiving N or more +bells will activate bell overload mode. It is measured in +microseconds, so (for example) set it to 1000000 for one second. The +default is 2000000 (two seconds). + +\dt \cw{pterm.BellOverloadS} + +\dd This option specifies the time period of silence required to turn +off bell overload mode. It is measured in microseconds, so (for +example) set it to 1000000 for one second. The default is 5000000 +(five seconds of silence). + +\dt \cw{pterm.ScrollbackLines} + +\dd This option specifies how many lines of scrollback to save above the +visible terminal screen. The default is 200. This resource is +equivalent to the \cw{\-sl} command-line option. + +\dt \cw{pterm.DECOriginMode} + +\dd This option should be set to either 0 or 1; the default is 0. It +specifies the default state of DEC Origin Mode. (If you don't know +what that means, you probably don't need to mess with it.) + +\dt \cw{pterm.AutoWrapMode} + +\dd This option should be set to either 0 or 1; the default is 1. It +specifies the default state of auto wrap mode. When set to 1, very +long lines will wrap over to the next line on the terminal; when set +to 0, long lines will be squashed against the right-hand edge of the +screen. + +\dt \cw{pterm.LFImpliesCR} + +\dd This option should be set to either 0 or 1; the default is 0. When +set to 1, the terminal will return the cursor to the left side of +the screen when it receives a line feed character. + +\dt \cw{pterm.WinTitle} + +\dd This resource is the same as the \cw{\-T} command-line option: +it controls the initial title of the window. The default is +\q{\cw{pterm}}. + +\dt \cw{pterm.TermWidth} + +\dd This resource is the same as the width part of the \cw{\-geometry} +command-line option: it controls the number of columns of text in +the window. The default is 80. + +\dt \cw{pterm.TermHeight} + +\dd This resource is the same as the width part of the \cw{\-geometry} +command-line option: it controls the number of columns of text in +the window. The defaults is 24. + +\dt \cw{pterm.Font} + +\dd This resource is the same as the \cw{\-fn} command-line option: it +controls the font used to display normal text. The default is +\q{\cw{fixed}}. + +\dt \cw{pterm.BoldFont} + +\dd This resource is the same as the \cw{\-fb} command-line option: it +controls the font used to display bold text when \cw{BoldAsColour} +is turned off. The default is unset (the font will be bolded by +printing it twice at a one-pixel offset). + +\dt \cw{pterm.WideFont} + +\dd This resource is the same as the \cw{\-fw} command-line option: it +controls the font used to display double-width characters. The +default is unset (double-width characters cannot be displayed). + +\dt \cw{pterm.WideBoldFont} + +\dd This resource is the same as the \cw{\-fwb} command-line option: it +controls the font used to display double-width characters in bold, +when \cw{BoldAsColour} is turned off. The default is unset +(double-width characters are displayed in bold by printing them +twice at a one-pixel offset). + +\dt \cw{pterm.ShadowBoldOffset} + +\dd This resource can be set to an integer; the default is \-1. It +specifies the offset at which text is overprinted when using +\q{shadow bold} mode. The default (1) means that the text will be +printed in the normal place, and also one character to the right; +this seems to work well for most X bitmap fonts, which have a blank +line of pixels down the right-hand side. For some fonts, you may +need to set this to \-1, so that the text is overprinted one pixel +to the left; for really large fonts, you may want to set it higher +than 1 (in one direction or the other). + +\dt \cw{pterm.BoldAsColour} + +\dd This option should be set to either 0 or 1; the default is 1. It +specifies the default state of auto wrap mode. When set to 1, bold +text is shown by displaying it in a brighter colour; when set to 0, +bold text is shown by displaying it in a heavier font. + +\dt \cw{pterm.Colour0}, \cw{pterm.Colour1}, ..., \cw{pterm.Colour21} + +\dd These options control the various colours used to display text +in the \cw{pterm} window. Each one should be specified as a triple +of decimal numbers giving red, green and blue values: so that black +is \q{\cw{0,0,0}}, white is \q{\cw{255,255,255}}, red is +\q{\cw{255,0,0}} and so on. + +\lcont{ + +Colours 0 and 1 specify the foreground colour and its bold +equivalent (the \cw{\-fg} and \cw{\-bfg} command-line options). +Colours 2 and 3 specify the background colour and its bold +equivalent (the \cw{\-bg} and \cw{\-bbg} command-line options). +Colours 4 and 5 specify the text and block colours used for the +cursor (the \cw{\-cfg} and \cw{\-cbg} command-line options). Each +even number from 6 to 20 inclusive specifies the colour to be used +for one of the ANSI primary colour specifications (black, red, +green, yellow, blue, magenta, cyan, white, in that order); the odd +numbers from 7 to 21 inclusive specify the bold version of each +colour, in the same order. The defaults are: + +\c pterm.Colour0: 187,187,187 +\c pterm.Colour1: 255,255,255 +\c pterm.Colour2: 0,0,0 +\c pterm.Colour3: 85,85,85 +\c pterm.Colour4: 0,0,0 +\c pterm.Colour5: 0,255,0 +\c pterm.Colour6: 0,0,0 +\c pterm.Colour7: 85,85,85 +\c pterm.Colour8: 187,0,0 +\c pterm.Colour9: 255,85,85 +\c pterm.Colour10: 0,187,0 +\c pterm.Colour11: 85,255,85 +\c pterm.Colour12: 187,187,0 +\c pterm.Colour13: 255,255,85 +\c pterm.Colour14: 0,0,187 +\c pterm.Colour15: 85,85,255 +\c pterm.Colour16: 187,0,187 +\c pterm.Colour17: 255,85,255 +\c pterm.Colour18: 0,187,187 +\c pterm.Colour19: 85,255,255 +\c pterm.Colour20: 187,187,187 +\c pterm.Colour21: 255,255,255 + +} + +\dt \cw{pterm.RectSelect} + +\dd This option should be set to either 0 or 1; the default is 0. When +set to 0, dragging the mouse over several lines selects to the end +of each line and from the beginning of the next; when set to 1, +dragging the mouse over several lines selects a rectangular region. +In each case, holding down Alt while dragging gives the other +behaviour. + +\dt \cw{pterm.MouseOverride} + +\dd This option should be set to either 0 or 1; the default is 1. When +set to 1, if the application requests mouse tracking (so that mouse +clicks are sent to it instead of doing selection), holding down +Shift will revert the mouse to normal selection. When set to 0, +mouse tracking completely disables selection. + +\dt \cw{pterm.Printer} + +\dd This option is unset by default. If you set it, then +server-controlled printing is enabled: the server can send control +sequences to request data to be sent to a printer. That data will be +piped into the command you specify here; so you might want to set it +to \q{\cw{lpr}}, for example, or \q{\cw{lpr \-Pmyprinter}}. + +\dt \cw{pterm.ScrollBar} + +\dd This option should be set to either 0 or 1; the default is 1. When +set to 0, the scrollbar is hidden (although Shift-PageUp and +Shift-PageDown still work). This is the same as the \cw{\-sb} +command-line option. + +\dt \cw{pterm.ScrollbarOnLeft} + +\dd This option should be set to either 0 or 1; the default is 0. When +set to 1, the scrollbar will be displayed on the left of the +terminal instead of on the right. + +\dt \cw{pterm.ScrollOnKey} + +\dd This option should be set to either 0 or 1; the default is 0. When +set to 1, any keypress causes the position of the scrollback to be +reset to the very bottom. + +\dt \cw{pterm.ScrollOnDisp} + +\dd This option should be set to either 0 or 1; the default is 1. When +set to 1, any activity in the display causes the position of the +scrollback to be reset to the very bottom. + +\dt \cw{pterm.LineCodePage} + +\dd This option specifies the character set to be used for the session. +This is the same as the \cw{\-cs} command-line option. + +\dt \cw{pterm.NoRemoteCharset} + +\dd This option disables the terminal's ability to change its character +set when it receives escape sequences telling it to. You might need +to do this to interoperate with programs which incorrectly change +the character set to something they think is sensible. + +\dt \cw{pterm.BCE} + +\dd This option should be set to either 0 or 1; the default is 1. When +set to 1, the various control sequences that erase parts of the +terminal display will erase in whatever the current background +colour is; when set to 0, they will erase in black always. + +\dt \cw{pterm.BlinkText} + +\dd This option should be set to either 0 or 1; the default is 0. When +set to 1, text specified as blinking by the server will actually +blink on and off; when set to 0, \cw{pterm} will use the less +distracting approach of making the text's background colour bold. + +\dt \cw{pterm.StampUtmp} + +\dd This option should be set to either 0 or 1; the default is 1. When +set to 1, \cw{pterm} will log the login in the various system log +files. This resource is equivalent to the \cw{\-ut} command-line +option. + +\dt \cw{pterm.LoginShell} + +\dd This option should be set to either 0 or 1; the default is 1. When +set to 1, \cw{pterm} will execute your shell as a login shell. This +resource is equivalent to the \cw{\-ls} command-line option. + +\S{pterm-manpage-bugs} BUGS + +Most of the X resources have silly names. (Historical reasons from +PuTTY, mostly.) diff --git a/doc/man-putt.but b/doc/man-putt.but new file mode 100644 index 00000000..f4da07b0 --- /dev/null +++ b/doc/man-putt.but @@ -0,0 +1,235 @@ +\cfg{man-identity}{putty}{1}{2004-03-24}{PuTTY tool suite}{PuTTY tool suite} + +\H{putty-manpage} Man page for PuTTY + +\S{putty-manpage-name} NAME + +\cw{putty} - GUI SSH, Telnet and Rlogin client for X + +\S{putty-manpage-synopsis} SYNOPSIS + +\c putty [ options ] [ host ] +\e bbbbb iiiiiii iiii + +\S{putty-manpage-description} DESCRIPTION + +\cw{putty} is a graphical SSH, Telnet and Rlogin client for X. It is +a direct port of the Windows SSH client of the same name. + +\S{putty-manpage-options} OPTIONS + +The command-line options supported by \cw{putty} are: + +\dt \cw{\-\-display} \e{display\-name} + +\dd Specify the X display on which to open \cw{putty}. (Note this +option has a double minus sign, even though none of the others do. +This is because this option is supplied automatically by GTK. +Sorry.) + +\dt \cw{\-fn} \e{font-name} + +\dd Specify the font to use for normal text displayed in the terminal. + +\dt \cw{\-fb} \e{font-name} + +\dd Specify the font to use for bold text displayed in the terminal. +If the \cw{BoldAsColour} resource is set to 1 (the default), bold +text will be displayed in different colours instead of a different +font, so this option will be ignored. If \cw{BoldAsColour} is set to +0 and you do not specify a bold font, \cw{putty} will overprint the +normal font to make it look bolder. + +\dt \cw{\-fw} \e{font-name} + +\dd Specify the font to use for double-width characters (typically +Chinese, Japanese and Korean text) displayed in the terminal. + +\dt \cw{\-fwb} \e{font-name} + +\dd Specify the font to use for bold double-width characters +(typically Chinese, Japanese and Korean text). Like \cw{-fb}, this +will be ignored unless the \cw{BoldAsColour} resource is set to 0. + +\dt \cw{\-geometry} \e{geometry} + +\dd Specify the size of the terminal, in rows and columns of text. +See \e{X(7)} for more information on the syntax of geometry +specifications. + +\dt \cw{\-sl} \e{lines} + +\dd Specify the number of lines of scrollback to save off the top of the +terminal. + +\dt \cw{\-fg} \e{colour} + +\dd Specify the foreground colour to use for normal text. + +\dt \cw{\-bg} \e{colour} + +\dd Specify the background colour to use for normal text. + +\dt \cw{\-bfg} \e{colour} + +\dd Specify the foreground colour to use for bold text, if the +\cw{BoldAsColour} resource is set to 1 (the default). + +\dt \cw{\-bbg} \e{colour} + +\dd Specify the foreground colour to use for bold reverse-video +text, if the \cw{BoldAsColour} resource is set to 1 (the default). +(This colour is best thought of as the bold version of the +background colour; so it only appears when text is displayed \e{in} +the background colour.) + +\dt \cw{\-cfg} \e{colour} + +\dd Specify the foreground colour to use for text covered by the cursor. + +\dt \cw{\-cbg} \e{colour} + +\dd Specify the background colour to use for text covered by the cursor. +In other words, this is the main colour of the cursor. + +\dt \cw{\-title} \e{title} + +\dd Specify the initial title of the terminal window. (This can be +changed under control of the server.) + +\dt \cw{\-sb\-} or \cw{+sb} + +\dd Tells \cw{putty} not to display a scroll bar. + +\dt \cw{\-sb} + +\dd Tells \cw{putty} to display a scroll bar: this is the opposite of +\cw{\-sb\-}. This is the default option: you will probably only need +to specify it explicitly if you have changed the default using the +\cw{ScrollBar} resource. + +\dt \cw{\-log} \e{filename} + +\dd This option makes \cw{putty} log all the terminal output to a file +as well as displaying it in the terminal. + + +\dt \cw{\-cs} \e{charset} + +\dd This option specifies the character set in which \cw{putty} +should assume the session is operating. This character set will be +used to interpret all the data received from the session, and all +input you type or paste into \cw{putty} will be converted into +this character set before being sent to the session. + +\lcont{ Any character set name which is valid in a MIME header (and +supported by \cw{putty}) should be valid here (examples are +\q{\cw{ISO-8859-1}}, \q{\cw{windows-1252}} or \q{\cw{UTF-8}}). Also, +any character encoding which is valid in an X logical font +description should be valid (\q{\cw{ibm-cp437}}, for example). + +\cw{putty}'s default behaviour is to use the same character +encoding as its primary font. If you supply a Unicode +(\cw{iso10646-1}) font, it will default to the UTF-8 character set. + +Character set names are case-insensitive. +} + +\dt \cw{\-nethack} + +\dd Tells \cw{putty} to enable NetHack keypad mode, in which the +numeric keypad generates the NetHack \c{hjklyubn} direction keys. +This enables you to play NetHack with the numeric keypad without +having to use the NetHack \c{number_pad} option (which requires you +to press \q{\cw{n}} before any repeat count). So you can move with +the numeric keypad, and enter repeat counts with the normal number +keys. + +\dt \cw{\-help}, \cw{\-\-help} + +\dd Display a message summarizing the available options. + +\dt \cw{\-load} \e{session} + +\dd Load a saved session by name. This allows you to run a saved session +straight from the command line without having to go through the +configuration box first. + +\dt \cw{\-ssh}, \cw{\-telnet}, \cw{\-rlogin}, \cw{\-raw} + +\dd Select the protocol \cw{putty} will use to make the connection. + +\dt \cw{\-l} \e{username} + +\dd Specify the username to use when logging in to the server. + +\dt \cw{\-L} \cw{[}\e{srcaddr}\cw{:]}\e{srcport}\cw{:}\e{desthost}\cw{:}\e{destport} + +\dd Set up a local port forwarding: listen on \e{srcport} (or +\e{srcaddr}:\e{srcport} if specified), and forward any connections +over the SSH connection to the destination address +\e{desthost}:\e{destport}. Only works in SSH. + +\dt \cw{\-R} \cw{[}\e{srcaddr}\cw{:]}\e{srcport}\cw{:}\e{desthost}\cw{:}\e{destport} + +\dd Set up a remote port forwarding: ask the SSH server to listen on +\e{srcport} (or \e{srcaddr}:\e{srcport} if specified), and to +forward any connections back over the SSH connection where the +client will pass them on to the destination address +\e{desthost}:\e{destport}. Only works in SSH. + +\dt \cw{\-D} [\e{srcaddr}:]\e{srcport} + +\dd Set up dynamic port forwarding. The client listens on +\e{srcport} (or \e{srcaddr}:\e{srcport} if specified), and +implements a SOCKS server. So you can point SOCKS-aware applications +at this port and they will automatically use the SSH connection to +tunnel all their connections. Only works in SSH. + +\dt \cw{\-P} \e{port} + +\dd Specify the port to connect to the server on. + +\dt \cw{\-A}, \cw{\-a} + +\dd Enable (\cw{\-A}) or disable (\cw{\-a}) SSH agent forwarding. +Currently this only works with OpenSSH and SSH1. + +\dt \cw{\-X}, \cw{\-x} + +\dd Enable (\cw{\-X}) or disable (\cw{\-x}) X11 forwarding. + +\dt \cw{\-T}, \cw{\-t} + +\dd Enable (\cw{\-t}) or disable (\cw{\-T}) the allocation of a +pseudo-terminal at the server end. + +\dt \cw{\-C} + +\dd Enable zlib-style compression on the connection. + +\dt \cw{\-1}, \cw{\-2} + +\dd Select SSH protocol v1 or v2. + +\dt \cw{\-i} \e{keyfile} + +\dd Specify a private key file to use for authentication. For SSH2 +keys, this key file must be in PuTTY's format, not OpenSSH's or +anyone else's. + +\S{putty-manpage-saved-sessions} SAVED SESSIONS + +Saved sessions are stored in a \cw{.putty/sessions} subdirectory in +your home directory. + +\S{putty-manpage-more-information} MORE INFORMATION + +For more information on PuTTY, it's probably best to go and look at +the manual on the web page: + +\W{http://www.chiark.greenend.org.uk/~sgtatham/putty/}\cw{http://www.chiark.greenend.org.uk/~sgtatham/putty/} + +\S{putty-manpage-bugs} BUGS + +This man page isn't terribly complete. diff --git a/doc/mancfg.but b/doc/mancfg.but new file mode 100644 index 00000000..04f7fc44 --- /dev/null +++ b/doc/mancfg.but @@ -0,0 +1,3 @@ +\cfg{man-mindepth}{2} + +\C{not-shown} Chapter title which is not shown diff --git a/doc/manpages.but b/doc/manpages.but new file mode 100644 index 00000000..bb75ec8c --- /dev/null +++ b/doc/manpages.but @@ -0,0 +1,3 @@ +\A{man-pages} Man pages for Unix PuTTY + +This appendix contains all the man pages for Unix PuTTY. diff --git a/unix/plink.1 b/unix/plink.1 deleted file mode 100644 index feb9e608..00000000 --- a/unix/plink.1 +++ /dev/null @@ -1,67 +0,0 @@ -.TH plink 1 -.SH NAME -plink \- PuTTY link, command line network connection tool -.SH SYNOPSIS -\fBplink\fR [\fIoptions\fR] [\fIuser\fB@\fR]\fIhost\fR [\fIcommand\fR] -.SH DESCRIPTION -\fBplink\fR is a network connection tool supporting several protocols. -.SH OPTIONS -The command-line options supported by \fIplink\fP are: -.IP "\fB-v\fR" -Show verbose messages. -.IP "\fB-load\fR \fIsession\fR" -Load settings from saved session. -.IP "\fB-ssh\fR" -Force use of SSH protocol (default). -.IP "\fB-telnet\fR" -Force use of Telnet protocol. -.IP "\fB-rlogin\fR" -Force use of rlogin protocol. -.IP "\fB-raw\fR" -Force raw mode. -.IP "\fB-P\fR \fIport\fR" -Connect to port \fIport\fR. -.IP "\fB-l\fR \fIuser\fR" -Set remote username to \fIuser\fR. -.IP "\fB-m\fR \fIpath\fR" -Read remote command(s) from local file \fIpath\fR. -.IP "\fB-batch\fR" -Disable interactive prompts. -.IP "\fB-pw\fR \fIpassword\fR" -Set remote password to \fIpassword\fR. -.IP "\fB-L\fR [\fIlisten-IP\fB:\fR]\fIlisten\fB:\fIhost\fB:\fIport\fR" -Forward the local port to a remote address. -.IP "\fB-R\fR [\fIlisten-IP\fB:\fR]\fIlisten\fB:\fIhost\fB:\fIport\fR" -Forward the a remote port to a local address. -.IP "\fB-D\fR [\fIlisten-IP\fB:\fR]\fIlisten-port\fR" -Dynamic port forwarding: start a SOCKS server on \fIlisten-port\fR. -.IP "\fB-X\fR" -Enable X11 forwarding. -.IP "\fB-x\fR" -Disable X11 forwarding (default). -.IP "\fB-A\fR" -Enable agent forwarding. -.IP "\fB-a\fR" -Disable agent forwarding (default). -.IP "\fB-t\fR" -Enable pty allocation (default if a command is NOT specified). -.IP "\fB-T\fR" -Disable pty allocation (default if a command is specified). -.IP "\fB-1\fR" -Force use of SSH protocol version 1. -.IP "\fB-2\fR" -Force use of SSH protocol version 2. -.IP "\fB-C\fR" -Enable SSH compression. -.IP "\fB-i\fR \fIpath\fR" -Private key file for authentication. -.IP "\fB-s\fR" -Remote command is SSH subsystem (SSH-2 only). -.SH MORE INFORMATION -For more information on plink, it's probably best to go and look at -the manual on the PuTTY web page: - -\fBhttp://www.chiark.greenend.org.uk/~sgtatham/putty/\fP -.SH BUGS -This man page isn't terribly complete. See the above web link for -better documentation. diff --git a/unix/pscp.1 b/unix/pscp.1 deleted file mode 100644 index ea08180a..00000000 --- a/unix/pscp.1 +++ /dev/null @@ -1,52 +0,0 @@ -.TH pscp 1 -.SH NAME -pscp \- command-line SCP (secure copy) / SFTP client -.SH SYNOPSIS -\fBpscp\fR [\fIoptions\fR] [\fIuser\fB@\fR]\fIhost\fB:\fIsource\fR \fItarget\fR -.br -\fBpscp\fR [\fIoptions\fR] \fIsource\fR [\fIsource\fR...] [\fIuser\fB@\fR]\fIhost\fB:\fItarget\fR -.br -\fBpscp\fR [\fIoptions\fR] \fB-ls\fR [\fIuser\fB@\fR]\fIhost\fB:\fIfilespec\fR -.SH DESCRIPTION -\fBpscp\fR is a command-line client for the SSH-based SCP (secure -copy) and SFTP (secure file transfer protocol) protocols. -.SH OPTIONS -The command-line options supported by \fIpscp\fP are: -.IP "\fB-ls\fR" -Remote directory listing. -.IP "\fB-p\fR" -Preserve file attributes. -.IP "\fB-q\fR" -Quiet, don't show statistics. -.IP "\fB-r\fR" -Copy directories recursively. -.IP "\fB-unsafe\fR" -Allow server-side wildcards (DANGEROUS). -.IP "\fB-v\fR" -Show verbose messages. -.IP "\fB-load\fR \fIsession\fR" -Load settings from saved session. -.IP "\fB-P\fR \fIport\fR" -Connect to port \fIport\fR. -.IP "\fB-l\fR \fIuser\fR" -Set remote username to \fIuser\fR. -.IP "\fB-batch\fR" -Disable interactive prompts. -.IP "\fB-pw\fR \fIpassword\fR" -Set remote password to \fIpassword\fR. -.IP "\fB-1\fR" -Force use of SSH protocol version 1. -.IP "\fB-2\fR" -Force use of SSH protocol version 2. -.IP "\fB-C\fR" -Enable SSH compression. -.IP "\fB-i\fR \fIpath\fR" -Private key file for authentication. -.SH MORE INFORMATION -For more information on \fBpscp\fR it's probably best to go and look at -the manual on the PuTTY web page: - -\fBhttp://www.chiark.greenend.org.uk/~sgtatham/putty/\fP -.SH BUGS -This man page isn't terribly complete. See the above web link for -better documentation. diff --git a/unix/psftp.1 b/unix/psftp.1 deleted file mode 100644 index c29caec6..00000000 --- a/unix/psftp.1 +++ /dev/null @@ -1,47 +0,0 @@ -.TH psftp 1 -.SH NAME -psftp \- interactive SFTP (secure file transfer protocol) client -.SH SYNOPSIS -\fBpsftp\fR [\fIoptions\fR] [\fIuser\fB@\fR]\fIhost\fR -.SH DESCRIPTION -\fBpsftp\fR is an interactive text-based client for the SSH-based SFTP -(secure file transfer) protocol. -.SH OPTIONS -The command-line options supported by \fIpsftp\fP are: -.IP "\fB-b\fR \fIbatchfile\fR" -Use specified batchfile. -.IP "\fB-bc\fR" -Output batchfile commands. -.IP "\fB-be\fR" -Don't stop batchfile processing on errors. -.IP "\fB-v\fR" -Show verbose messages. -.IP "\fB-load\fR \fIsession\fR" -Load settings from saved session. -.IP "\fB-P\fR \fIport\fR" -Connect to port \fIport\fR. -.IP "\fB-l\fR \fIuser\fR" -Set remote username to \fIuser\fR. -.IP "\fB-batch\fR" -Disable interactive prompts. -.IP "\fB-pw\fR \fIpassword\fR" -Set remote password to \fIpassword\fR. -.IP "\fB-1\fR" -Force use of SSH protocol version 1. -.IP "\fB-2\fR" -Force use of SSH protocol version 2. -.IP "\fB-C\fR" -Enable SSH compression. -.IP "\fB-i\fR \fIpath\fR" -Private key file for authentication. -.SH COMMANDS -For a list of commands available inside \fBpsftp\fR, type \fBhelp\fR -at the \fBpsftp>\fR prompt. -.SH MORE INFORMATION -For more information on \fBpsftp\fR it's probably best to go and look at -the manual on the PuTTY web page: - -\fBhttp://www.chiark.greenend.org.uk/~sgtatham/putty/\fP -.SH BUGS -This man page isn't terribly complete. See the above web link for -better documentation. diff --git a/unix/pterm.1 b/unix/pterm.1 deleted file mode 100644 index 4a049eef..00000000 --- a/unix/pterm.1 +++ /dev/null @@ -1,472 +0,0 @@ -.TH pterm 1 -.UC -.SH NAME -pterm \- yet another X terminal emulator -.SH SYNOPSIS -\fBpterm\fP [ \fIoptions\fP ] -.SH DESCRIPTION -\fIpterm\fP is a terminal emulator for X. It is based on a port of -the terminal emulation engine in the Windows SSH client PuTTY. -.SH OPTIONS -The command-line options supported by \fIpterm\fP are: -.IP "\fB\-e\fP \fIcommand\fP [ \fIarguments\fP ]" -Specify a command to be executed in the new terminal. Everything on -the command line after this option will be passed straight to the -\fIexecvp\fP system call; so if you need the command to redirect its -input or output, you will have to use \fIsh\fP: - -pterm \-e sh \-c 'mycommand < inputfile' -.IP "\fB\-\-display\fP \fIdisplay\-name\fP" -Specify the X display on which to open \fIpterm\fP. (Note this -option has a double minus sign, even though none of the others do. -This is because this option is supplied automatically by GTK. -Sorry.) -.IP "\fB\-name\fP \fIfont-name\fP" -Specify the name under which \fIpterm\fP looks up X resources. -Normally it will look them up as (for example) \fBpterm.Font\fP. If -you specify "\-name xyz", it will look them up as \fBxyz.Font\fP -instead. This allows you to set up several different sets of -defaults and choose between them. -.IP "\fB\-fn\fP \fIfont-name\fP" -Specify the font to use for normal text displayed in the terminal. -.IP "\fB\-fb\fP \fIfont-name\fP" -Specify the font to use for bold text displayed in the terminal. If -the \fIBoldAsColour\fP resource is set to 1 (the default), bold text -will be displayed in different colours instead of a different font, -so this option will be ignored. If \fIBoldAsColour\fP is set to 0 -and you do not specify a bold font, \fIpterm\fP will overprint the -normal font to make it look bolder. -.IP "\fB\-fw\fP \fIfont-name\fP" -Specify the font to use for double-width characters (typically -Chinese, Japanese and Korean text) displayed in the terminal. -.IP "\fB\-fwb\fP \fIfont-name\fP" -Specify the font to use for bold double-width characters (typically -Chinese, Japanese and Korean text) Like \fI-fb\fP, this will be -ignored unless the \fIBoldAsColour\fP resource is set to 0. -.IP "\fB\-geometry\fP \fIgeometry\fP" -Specify the size of the terminal, in rows and columns of text. See -\fIX(7)\fP for more information on the syntax of geometry -specifications. -.IP "\fB\-sl\fP \fIlines\fP" -Specify the number of lines of scrollback to save off the top of the -terminal. -.IP "\fB\-fg\fP \fIcolour\fP" -Specify the foreground colour to use for normal text. -.IP "\fB\-bg\fP \fIcolour\fP" -Specify the background colour to use for normal text. -.IP "\fB\-bfg\fP \fIcolour\fP" -Specify the foreground colour to use for bold text, if the -\fIBoldAsColour\fP resource is set to 1 (the default). -.IP "\fB\-bbg\fP \fIcolour\fP" -Specify the foreground colour to use for bold reverse-video text, if -the \fIBoldAsColour\fP resource is set to 1 (the default). (This -colour is best thought of as the bold version of the background -colour; so it only appears when text is displayed \fIin\fP the -background colour.) -.IP "\fB\-cfg\fP \fIcolour\fP" -Specify the foreground colour to use for text covered by the cursor. -.IP "\fB\-cbg\fP \fIcolour\fP" -Specify the background colour to use for text covered by the cursor. -In other words, this is the main colour of the cursor. -.IP "\fB\-title\fP \fItitle\fP" -Specify the initial title of the terminal window. (This can be -changed under control of the server.) -.IP "\fB\-ut\-\fP or \fB+ut\fP" -Tells \fIpterm\fP not to record your login in the \fIutmp\fP, -\fIwtmp\fP and \fIlastlog\fP system log files; so you will not show -up on \fIfinger\fP or \fIwho\fP listings, for example. -.IP "\fB\-ut\fP" -Tells \fIpterm\fP to record your login in \fIutmp\fP, \fIwtmp\fP and -\fIlastlog\fP: this is the opposite of \fI\-ut\-\fP. This is the -default option: you will probably only need to specify it explicitly -if you have changed the default using the \fIStampUtmp\fP resource. -.IP "\fB\-ls\-\fP or \fB+ls\fP" -Tells \fIpterm\fP not to execute your shell as a login shell. -.IP "\fB\-ls\fP" -Tells \fIpterm\fP to execute your shell as a login shell: this is -the opposite of \fI\-ls\-\fP. This is the default option: you will -probably only need to specify it explicitly if you have changed the -default using the \fILoginShell\fP resource. -.IP "\fB\-sb\-\fP or \fB+sb\fP" -Tells \fIpterm\fP not to display a scroll bar. -.IP "\fB\-sb\fP" -Tells \fIpterm\fP to display a scroll bar: this is the opposite of -\fI\-sb\-\fP. This is the default option: you will probably only need -to specify it explicitly if you have changed the default using the -\fIScrollBar\fP resource. -.IP "\fB\-log\fP \fIfilename\fP" -This option makes \fIpterm\fP log all the terminal output to a file -as well as displaying it in the terminal. -.IP "\fB\-cs\fP \fIcharset\fP" -This option specifies the character set in which \fIpterm\fP should -assume the session is operating. This character set will be used to -interpret all the data received from the session, and all input you -type or paste into \fIpterm\fP will be converted into this character -set before being sent to the session. - -Any character set name which is valid in a MIME header (and -supported by \fIpterm\fP) should be valid here (examples are -"ISO-8859-1", "windows-1252" or "UTF-8"). Also, any character -encoding which is valid in an X logical font description should be -valid ("ibm-cp437", for example). - -\fIpterm\fP's default behaviour is to use the same character -encoding as its primary font. If you supply a Unicode (iso10646-1) -font, it will default to the UTF-8 character set. - -Character set names are case-insensitive. -.IP "\fB\-nethack\fP" -Tells \fIpterm\fP to enable NetHack keypad mode, in which the -numeric keypad generates the NetHack "hjklyubn" direction keys. This -enables you to play NetHack with the numeric keypad without having -to use the NetHack "number_pad" option (which requires you to press -"n" before any repeat count). So you can move with the numeric -keypad, and enter repeat counts with the normal number keys. -.IP "\fB\-xrm\fP \fIresource-string\fP" -This option specifies an X resource string. Useful for setting -resources which do not have their own command-line options. For -example: - -pterm \-xrm 'ScrollbarOnLeft: 1' -.IP "\fB\-help\fP, \fB\-\-help\fP" -Display a message summarizing the available options. -.SH X RESOURCES -\fIpterm\fP can be more completely configured by means of X -resources. All of these resources are of the form \fIpterm.FOO\fP -for some FOO; you can make \fIpterm\fP look them up under another -name, such as \fIxyz.FOO\fP, by specifying the command-line option -"\-name xyz". -.IP "\fBpterm.CloseOnExit\fP" -This option should be set to 0, 1 or 2; the default is 2. It -controls what \fIpterm\fP does when the process running inside it -terminates. When set to 2 (the default), \fIpterm\fP will close its -window as soon as the process inside it terminates. When set to 0, -\fIpterm\fP will print the process's exit status, and the window -will remain present until a key is pressed (allowing you to inspect -the scrollback, and copy and paste text out of it). - -When this setting is set to 1, \fIpterm\fP will close -immediately if the process exits cleanly (with an exit status of -zero), but the window will stay around if the process exits with a -non-zero code or on a signal. This enables you to see what went -wrong if the process suffers an error, but not to have to bother -closing the window in normal circumstances. -.IP "\fBpterm.WarnOnClose\fP" -This option should be set to either 0 or 1; the default is 1. -When set to 1, \fIpterm\fP will ask for confirmation before closing -its window when you press the close button. -.IP "\fBpterm.TerminalType\fP" -This controls the value set in the TERM environment variable inside -the new terminal. The default is "xterm". -.IP "\fBpterm.BackspaceIsDelete\fP" -This option should be set to either 0 or 1; the default is 1. When -set to 0, the ordinary Backspace key generates the Backspace -character (^H); when set to 1, it generates the Delete character -(^?). Whichever one you set, the terminal device inside \fIpterm\fP -will be set up to expect it. -.IP "\fBpterm.RXVTHomeEnd\fP" -This option should be set to either 0 or 1; the default is 0. When -it is set to 1, the Home and End keys generate the control sequences -they would generate in the \fIrxvt\fP terminal emulator, instead of -the more usual ones generated by other emulators. -.IP "\fBpterm.LinuxFunctionKeys\fP" -This option can be set to any number between 0 and 5 inclusive; the -default is 0. The modes vary the control sequences sent by the -function keys; for more complete documentation, it is probably -simplest to try each option in "pterm \-e cat", and press the keys to -see what they generate. -.IP "\fBpterm.NoApplicationKeys\fP" -This option should be set to either 0 or 1; the default is 0. When -set to 1, it stops the server from ever switching the numeric keypad -into application mode (where the keys send function-key-like -sequences instead of numbers or arrow keys). You probably only need -this if some application is making a nuisance of itself. -.IP "\fBpterm.NoApplicationCursors\fP" -This option should be set to either 0 or 1; the default is 0. When -set to 1, it stops the server from ever switching the cursor keys -into application mode (where the keys send slightly different -sequences). You probably only need this if some application is -making a nuisance of itself. -.IP "\fBpterm.NoMouseReporting\fP" -This option should be set to either 0 or 1; the default is 0. When -set to 1, it stops the server from ever enabling mouse reporting -mode (where mouse clicks are sent to the application instead of -controlling cut and paste). -.IP "\fBpterm.NoRemoteResize\fP" -This option should be set to either 0 or 1; the default is 0. When -set to 1, it stops the server from being able to remotely control -the size of the \fIpterm\fP window. -.IP "\fBpterm.NoAltScreen\fP" -This option should be set to either 0 or 1; the default is 0. When -set to 1, it stops the server from using the "alternate screen" -terminal feature, which lets full-screen applications leave the -screen exactly the way they found it. -.IP "\fBpterm.NoRemoteWinTitle\fP" -This option should be set to either 0 or 1; the default is 0. When -set to 1, it stops the server from remotely controlling the title of -the \fIpterm\fP window. -.IP "\fBpterm.NoRemoteQTitle\fP" -This option should be set to either 0 or 1; the default is 1. When -set to 1, it stops the server from remotely requesting the title of -the \fIpterm\fP window. - -This feature is a \fBPOTENTIAL SECURITY HAZARD\fP. If a malicious -application can write data to your terminal (for example, if you -merely \fIcat\fP a file owned by someone else on the server -machine), it can change your window title (unless you have disabled -this using the \fBNoRemoteWinTitle\fP resource) and then use this -service to have the new window title sent back to the server as if -typed at the keyboard. This allows an attacker to fake keypresses -and potentially cause your server-side applications to do things you -didn't want. Therefore this feature is disabled by default, and we -recommend you do not turn it on unless you \fBreally\fP know what -you are doing. -.IP "\fBpterm.NoDBackspace\fP" -This option should be set to either 0 or 1; the default is 0. When -set to 1, it disables the normal action of the Delete (^?) character -when sent from the server to the terminal, which is to move the -cursor left by one space and erase the character now under it. -.IP "\fBpterm.ApplicationCursorKeys\fP" -This option should be set to either 0 or 1; the default is 0. When -set to 1, the default initial state of the cursor keys are -application mode (where the keys send function-key-like sequences -instead of numbers or arrow keys). When set to 0, the default state -is the normal one. -.IP "\fBpterm.ApplicationKeypad\fP" -This option should be set to either 0 or 1; the default is 0. When -set to 1, the default initial state of the numeric keypad is -application mode (where the keys send function-key-like sequences -instead of numbers or arrow keys). When set to 0, the default state -is the normal one. -.IP "\fBpterm.NetHackKeypad\fP" -This option should be set to either 0 or 1; the default is 0. When -set to 1, the numeric keypad operates in NetHack mode. This is -equivalent to the \fI\-nethack\fP command-line option. -.IP "\fBpterm.Answerback\fP" -This option controls the string which the terminal sends in response -to receiving the ^E character ("tell me about yourself"). By default -this string is "PuTTY". -.IP "\fBpterm.HideMousePtr\fP" -This option should be set to either 0 or 1; the default is 0. When -it is set to 1, the mouse pointer will disappear if it is over the -\fIpterm\fP window and you press a key. It will reappear as soon as -you move it. -.IP "\fBpterm.WindowBorder\fP" -This option controls the number of pixels of space between the text -in the \fIpterm\fP window and the window frame. The default is 1. -You can increase this value, but decreasing it to 0 is not -recommended because it can cause the window manager's size hints to -work incorrectly. -.IP "\fBpterm.CurType\fP" -This option should be set to either 0, 1 or 2; the default is 0. -When set to 0, the text cursor displayed in the window is a -rectangular block. When set to 1, the cursor is an underline; when -set to 2, it is a vertical line. -.IP "\fBpterm.BlinkCur\fP" -This option should be set to either 0 or 1; the default is 0. When -it is set to 1, the text cursor will blink when the window is active. -.IP "\fBpterm.Beep\fP" -This option should be set to either 0 or 2 (yes, 2); the default is -0. When it is set to 2, \fIpterm\fP will respond to a bell character -(^G) by flashing the window instead of beeping. -.IP "\fBpterm.BellOverload\fP" -This option should be set to either 0 or 1; the default is 0. When -it is set to 1, \fIpterm\fP will watch out for large numbers of -bells arriving in a short time and will temporarily disable the bell -until they stop. The idea is that if you \fIcat\fP a binary file, -the frantic beeping will mostly be silenced by this feature and will -not drive you crazy. - -The bell overload mode is activated by receiving N bells in time T; -after a further time S without any bells, overload mode will turn -itself off again. - -Bell overload mode is always deactivated by any keypress in the -terminal. This means it can respond to large unexpected streams of -data, but does not interfere with ordinary command-line activities -that generate beeps (such as filename completion). -.IP "\fBpterm.BellOverloadN\fP" -This option counts the number of bell characters which will activate -bell overload if they are received within a length of time T. The -default is 5. -.IP "\fBpterm.BellOverloadT\fP" -This option specifies the time period in which receiving N or more -bells will activate bell overload mode. It is measured in -microseconds, so (for example) set it to 1000000 for one second. The -default is 2000000 (two seconds). -.IP "\fBpterm.BellOverloadS\fP" -This option specifies the time period of silence required to turn -off bell overload mode. It is measured in microseconds, so (for -example) set it to 1000000 for one second. The default is 5000000 -(five seconds of silence). -.IP "\fBpterm.ScrollbackLines\fP" -This option specifies how many lines of scrollback to save above the -visible terminal screen. The default is 200. This resource is -equivalent to the \fI\-sl\fP command-line option. -.IP "\fBpterm.DECOriginMode\fP" -This option should be set to either 0 or 1; the default is 0. It -specifies the default state of DEC Origin Mode. (If you don't know -what that means, you probably don't need to mess with it.) -.IP "\fBpterm.AutoWrapMode\fP" -This option should be set to either 0 or 1; the default is 1. It -specifies the default state of auto wrap mode. When set to 1, very -long lines will wrap over to the next line on the terminal; when set -to 0, long lines will be squashed against the right-hand edge of the -screen. -.IP "\fBpterm.LFImpliesCR\fP" -This option should be set to either 0 or 1; the default is 0. When -set to 1, the terminal will return the cursor to the left side of -the screen when it receives a line feed character. -.IP "\fBpterm.WinTitle\fP" -This resource is the same as the \fI\-T\fP command-line option: it -controls the initial title of the window. The default is "pterm". -.IP "\fBpterm.TermWidth\fP" -This resource is the same as the width part of the \fI\-geometry\fP -command-line option: it controls the number of columns of text in -the window. The default is 80. -.IP "\fBpterm.TermHeight\fP" -This resource is the same as the width part of the \fI\-geometry\fP -command-line option: it controls the number of columns of text in -the window. The defaults is 24. -.IP "\fBpterm.Font\fP" -This resource is the same as the \fI\-fn\fP command-line option: it -controls the font used to display normal text. The default is -"fixed". -.IP "\fBpterm.BoldFont\fP" -This resource is the same as the \fI\-fb\fP command-line option: it -controls the font used to display bold text when \fIBoldAsColour\fP -is turned off. The default is unset (the font will be bolded by -printing it twice at a one-pixel offset). -.IP "\fBpterm.WideFont\fP" -This resource is the same as the \fI\-fw\fP command-line option: it -controls the font used to display double-width characters. The -default is unset (double-width characters cannot be displayed). -.IP "\fBpterm.WideBoldFont\fP" -This resource is the same as the \fI\-fwb\fP command-line option: it -controls the font used to display double-width characters in bold, -when \fIBoldAsColour\fP is turned off. The default is unset -(double-width characters are displayed in bold by printing them -twice at a one-pixel offset). -.IP "\fBpterm.ShadowBoldOffset\fP" -This resource can be set to an integer; the default is \-1. It -specifies the offset at which text is overprinted when using "shadow -bold" mode. The default (1) means that the text will be printed in -the normal place, and also one character to the right; this seems to -work well for most X bitmap fonts, which have a blank line of pixels -down the right-hand side. For some fonts, you may need to set this to -\-1, so that the text is overprinted one pixel to the left; for -really large fonts, you may want to set it higher than 1 (in one -direction or the other). -.IP "\fBpterm.BoldAsColour\fP" -This option should be set to either 0 or 1; the default is 1. It -specifies the default state of auto wrap mode. When set to 1, bold -text is shown by displaying it in a brighter colour; when set to 0, -bold text is shown by displaying it in a heavier font. -.IP "\fBpterm.Colour0\fP, \fBpterm.Colour1\fP, ..., \fBpterm.Colour21\fP" -These options control the various colours used to display text in -the \fIpterm\fP window. Each one should be specified as a triple of -decimal numbers giving red, green and blue values: so that black is -"0,0,0", white is "255,255,255", red is "255,0,0" and so on. - -Colours 0 and 1 specify the foreground colour and its bold -equivalent (the \fI\-fg\fP and \fI\-bfg\fP command-line options). -Colours 2 and 3 specify the background colour and its bold -equivalent (the \fI\-bg\fP and \fI\-bbg\fP command-line options). -Colours 4 and 5 specify the text and block colours used for the -cursor (the \fI\-cfg\fP and \fI\-cbg\fP command-line options). Each -even number from 6 to 20 inclusive specifies the colour to be used -for one of the ANSI primary colour specifications (black, red, -green, yellow, blue, magenta, cyan, white, in that order); the odd -numbers from 7 to 21 inclusive specify the bold version of each -colour, in the same order. The defaults are: - -.nf -pterm.Colour0: 187,187,187 -pterm.Colour1: 255,255,255 -pterm.Colour2: 0,0,0 -pterm.Colour3: 85,85,85 -pterm.Colour4: 0,0,0 -pterm.Colour5: 0,255,0 -pterm.Colour6: 0,0,0 -pterm.Colour7: 85,85,85 -pterm.Colour8: 187,0,0 -pterm.Colour9: 255,85,85 -pterm.Colour10: 0,187,0 -pterm.Colour11: 85,255,85 -pterm.Colour12: 187,187,0 -pterm.Colour13: 255,255,85 -pterm.Colour14: 0,0,187 -pterm.Colour15: 85,85,255 -pterm.Colour16: 187,0,187 -pterm.Colour17: 255,85,255 -pterm.Colour18: 0,187,187 -pterm.Colour19: 85,255,255 -pterm.Colour20: 187,187,187 -pterm.Colour21: 255,255,255 -.fi -.IP "\fBpterm.RectSelect\fP" -This option should be set to either 0 or 1; the default is 0. When -set to 0, dragging the mouse over several lines selects to the end -of each line and from the beginning of the next; when set to 1, -dragging the mouse over several lines selects a rectangular region. -In each case, holding down Alt while dragging gives the other -behaviour. -.IP "\fBpterm.MouseOverride\fP" -This option should be set to either 0 or 1; the default is 1. When -set to 1, if the application requests mouse tracking (so that mouse -clicks are sent to it instead of doing selection), holding down -Shift will revert the mouse to normal selection. When set to 0, -mouse tracking completely disables selection. -.IP "\fBpterm.Printer\fP" -This option is unset by default. If you set it, then -server-controlled printing is enabled: the server can send control -sequences to request data to be sent to a printer. That data will be -piped into the command you specify here; so you might want to set it -to "lpr", for example, or "lpr \-Pmyprinter". -.IP "\fBpterm.ScrollBar\fP" -This option should be set to either 0 or 1; the default is 1. When -set to 0, the scrollbar is hidden (although Shift-PageUp and -Shift-PageDown still work). This is the same as the \fI\-sb\fP -command-line option. -.IP "\fBpterm.ScrollbarOnLeft\fP" -This option should be set to either 0 or 1; the default is 0. When -set to 1, the scrollbar will be displayed on the left of the -terminal instead of on the right. -.IP "\fBpterm.ScrollOnKey\fP" -This option should be set to either 0 or 1; the default is 0. When -set to 1, any keypress causes the position of the scrollback to be -reset to the very bottom. -.IP "\fBpterm.ScrollOnDisp\fP" -This option should be set to either 0 or 1; the default is 1. When -set to 1, any activity in the display causes the position of the -scrollback to be reset to the very bottom. -.IP "\fBpterm.LineCodePage\fP" -This option specifies the character set to be used for the session. -This is the same as the \fI\-cs\fP command-line option. -.IP "\fBpterm.NoRemoteCharset\fP" -This option disables the terminal's ability to change its character -set when it receives escape sequences telling it to. You might need -to do this to interoperate with programs which incorrectly change -the character set to something they think is sensible. -.IP "\fBpterm.BCE\fP" -This option should be set to either 0 or 1; the default is 1. When -set to 1, the various control sequences that erase parts of the -terminal display will erase in whatever the current background -colour is; when set to 0, they will erase in black always. -.IP "\fBpterm.BlinkText\fP" -This option should be set to either 0 or 1; the default is 0. When -set to 1, text specified as blinking by the server will actually -blink on and off; when set to 0, \fIpterm\fP will use the less -distracting approach of making the text's background colour bold. -.IP "\fBpterm.StampUtmp\fP" -This option should be set to either 0 or 1; the default is 1. When -set to 1, \fIpterm\fP will log the login in the various system log -files. This resource is equivalent to the \fI\-ut\fP command-line -option. -.IP "\fBpterm.LoginShell\fP" -This option should be set to either 0 or 1; the default is 1. When -set to 1, \fIpterm\fP will execute your shell as a login shell. This -resource is equivalent to the \fI\-ls\fP command-line option. -.SH BUGS -Most of the X resources have silly names. (Historical reasons from -PuTTY, mostly.) diff --git a/unix/putty.1 b/unix/putty.1 deleted file mode 100644 index 3b66bbae..00000000 --- a/unix/putty.1 +++ /dev/null @@ -1,150 +0,0 @@ -.TH putty 1 -.UC -.SH NAME -putty \- GUI SSH, Telnet and Rlogin client for X -.SH SYNOPSIS -\fBputty\fP [ \fIoptions\fP ] [ \fIhost\fP ] -.SH DESCRIPTION -\fIputty\fP is a graphical SSH, Telnet and Rlogin client for X. It -is a direct port of the Windows SSH client of the same name. -.SH OPTIONS -The command-line options supported by \fIputty\fP are: -.IP "\fB\-\-display\fP \fIdisplay\-name\fP" -Specify the X display on which to open \fIputty\fP. (Note this -option has a double minus sign, even though none of the others do. -This is because this option is supplied automatically by GTK. -Sorry.) -.IP "\fB\-fn\fP \fIfont-name\fP" -Specify the font to use for normal text displayed in the terminal. -.IP "\fB\-fb\fP \fIfont-name\fP" -Specify the font to use for bold text displayed in the terminal. If -the \fIBoldAsColour\fP resource is set to 1 (the default), bold text -will be displayed in different colours instead of a different font, -so this option will be ignored. If \fIBoldAsColour\fP is set to 0 -and you do not specify a bold font, \fIputty\fP will overprint the -normal font to make it look bolder. -.IP "\fB\-fw\fP \fIfont-name\fP" -Specify the font to use for double-width characters (typically -Chinese, Japanese and Korean text) displayed in the terminal. -.IP "\fB\-fwb\fP \fIfont-name\fP" -Specify the font to use for bold double-width characters (typically -Chinese, Japanese and Korean text) Like \fI-fb\fP, this will be -ignored unless the \fIBoldAsColour\fP resource is set to 0. -.IP "\fB\-geometry\fP \fIgeometry\fP" -Specify the size of the terminal, in rows and columns of text. See -\fIX(7)\fP for more information on the syntax of geometry -specifications. -.IP "\fB\-sl\fP \fIlines\fP" -Specify the number of lines of scrollback to save off the top of the -terminal. -.IP "\fB\-fg\fP \fIcolour\fP" -Specify the foreground colour to use for normal text. -.IP "\fB\-bg\fP \fIcolour\fP" -Specify the background colour to use for normal text. -.IP "\fB\-bfg\fP \fIcolour\fP" -Specify the foreground colour to use for bold text, if the -\fIBoldAsColour\fP resource is set to 1 (the default). -.IP "\fB\-bbg\fP \fIcolour\fP" -Specify the foreground colour to use for bold reverse-video text, if -the \fIBoldAsColour\fP resource is set to 1 (the default). (This -colour is best thought of as the bold version of the background -colour; so it only appears when text is displayed \fIin\fP the -background colour.) -.IP "\fB\-cfg\fP \fIcolour\fP" -Specify the foreground colour to use for text covered by the cursor. -.IP "\fB\-cbg\fP \fIcolour\fP" -Specify the background colour to use for text covered by the cursor. -In other words, this is the main colour of the cursor. -.IP "\fB\-title\fP \fItitle\fP" -Specify the initial title of the terminal window. (This can be -changed under control of the server.) -.IP "\fB\-sb\-\fP or \fB+sb\fP" -Tells \fIputty\fP not to display a scroll bar. -.IP "\fB\-sb\fP" -Tells \fIputty\fP to display a scroll bar: this is the opposite of -\fI\-sb\-\fP. This is the default option: you will probably only need -to specify it explicitly if you have changed the default using the -\fIScrollBar\fP resource. -.IP "\fB\-log\fP \fIfilename\fP" -This option makes \fIputty\fP log all the terminal output to a file -as well as displaying it in the terminal. -.IP "\fB\-cs\fP \fIcharset\fP" -This option specifies the character set in which \fIputty\fP should -assume the session is operating. This character set will be used to -interpret all the data received from the session, and all input you -type or paste into \fIputty\fP will be converted into this character -set before being sent to the session. - -Any character set name which is valid in a MIME header (and -supported by \fIputty\fP) should be valid here (examples are -"ISO-8859-1", "windows-1252" or "UTF-8"). Also, any character -encoding which is valid in an X logical font description should be -valid ("ibm-cp437", for example). - -\fIputty\fP's default behaviour is to use the same character -encoding as its primary font. If you supply a Unicode (iso10646-1) -font, it will default to the UTF-8 character set. - -Character set names are case-insensitive. -.IP "\fB\-nethack\fP" -Tells \fIputty\fP to enable NetHack keypad mode, in which the -numeric keypad generates the NetHack "hjklyubn" direction keys. This -enables you to play NetHack with the numeric keypad without having -to use the NetHack "number_pad" option (which requires you to press -"n" before any repeat count). So you can move with the numeric -keypad, and enter repeat counts with the normal number keys. -.IP "\fB\-help\fP, \fB\-\-help\fP" -Display a message summarizing the available options. -.IP "\fB\-load\fP \fIsession\fP" -Load a saved session by name. This allows you to run a saved session -straight from the command line without having to go through the -configuration box first. -.IP "\fB\-ssh\fP, \fB\-telnet\fP, \fB\-rlogin\fP, \fB\-raw\fP" -Select the protocol \fIputty\fP will use to make the connection. -.IP "\fB\-l\fP \fIusername\fP" -Specify the username to use when logging in to the server. -.IP "\fB\-L\fP [\fIsrcaddr\fP:]\fIsrcport\fP:\fIdesthost\fP:\fIdestport\fP" -Set up a local port forwarding: listen on \fIsrcport\fP (or -\fIsrcaddr\fP:\fIsrcport\fP if specified), and forward any -connections over the SSH connection to the destination address -\fIdesthost\fP:\fIdestport\fP. Only works in SSH. -.IP "\fB\-R\fP [\fIsrcaddr\fP:]\fIsrcport\fP:\fIdesthost\fP:\fIdestport\fP" -Set up a remote port forwarding: ask the SSH server to listen on -\fIsrcport\fP (or \fIsrcaddr\fP:\fIsrcport\fP if specified), -and to forward any connections back over the SSH connection where -the client will pass them on to the destination address -\fIdesthost\fP:\fIdestport\fP. Only works in SSH. -.IP "\fB\-D\fP [\fIsrcaddr\fP:]\fIsrcport\fP" -Set up dynamic port forwarding. The client listens on \fIsrcport\fP -(or \fIsrcaddr\fP:\fIsrcport\fP if specified), and implements a -SOCKS server. So you can point SOCKS-aware applications at this port -and they will automatically use the SSH connection to tunnel all -their connections. Only works in SSH. -.IP "\fB\-P\fP \fIport\fP" -Specify the port to connect to the server on. -.IP "\fB\-A\fP, \fB\-a\fP" -Enable (\fB\-A\fP) or disable (\fB\-a\fP) SSH agent forwarding. -Currently this only works with OpenSSH and SSH1. -.IP "\fB\-X\fP, \fB\-x\fP" -Enable (\fB\-X\fP) or disable (\fB\-x\fP) X11 forwarding. -.IP "\fB\-T\fP, \fB\-t\fP" -Enable (\fB\-t\fP) or disable (\fB\-T\fP) the allocation of a -pseudo-terminal at the server end. -.IP "\fB\-C\fP" -Enable zlib-style compression on the connection. -.IP "\fB\-1\fP, \fB\-2\fP" -Select SSH protocol v1 or v2. -.IP "\fB\-i\fP \fIkeyfile\fP" -Specify a private key file to use for authentication. For SSH2 keys, -this key file must be in PuTTY's format, not OpenSSH's or anyone -else's. -.SH SAVED SESSIONS -Saved sessions are stored in a \fI.putty/sessions\fP subdirectory in -your home directory. -.SH MORE INFORMATION -For more information on PuTTY, it's probably best to go and look at -the manual on the web page: - -\fBhttp://www.chiark.greenend.org.uk/~sgtatham/putty/\fP -.SH BUGS -This man page isn't terribly complete. diff --git a/unix/puttygen.1 b/unix/puttygen.1 deleted file mode 100644 index fd0bcba4..00000000 --- a/unix/puttygen.1 +++ /dev/null @@ -1,137 +0,0 @@ -.TH puttygen 1 -.UC -.SH NAME -puttygen \- public-key generator for the PuTTY tools -.SH SYNOPSIS -\fBputtygen\fP ( \fIkeyfile\fP | \-t \fIkeytype\fP [ \-b \fIbits\fP ] ) - [ \-C \fInew-comment\fP ] [ \-P ] - [ \-O \fIoutput-type\fP | \-l | \-L | \-p ] - [ \-o \fIoutput-file\fP ] -.SH DESCRIPTION -\fBputtygen\fP is a tool to generate and manipulate SSH public and -private key pairs. It is part of the PuTTY suite, although it can -also interoperate with the private key formats used by some other -SSH clients. - -When you run \fBputtygen\fP, it does three things. Firstly, it -either loads an existing key file (if you specified \fIkeyfile\fP), -or generates a new key (if you specified \fIkeytype\fP). Then, it -optionally makes modifications to the key (changing the comment -and/or the passphrase); finally, it outputs the key, or some -information about the key, to a file. - -All three of these phases are controlled by the options described in -the following section. -.SH OPTIONS -In the first phase, \fBputtygen\fP either loads or generates a key. -The options to control this are: -.IP "\fIkeyfile\fP" -Specify a private key file to be loaded. This private key file can -be in the (de facto standard) SSH1 key format, or in PuTTY's SSH2 -key format, or in either of the SSH2 private key formats used by -OpenSSH and ssh.com's implementation. -.IP "\fB\-t\fP \fIkeytype\fP" -Specify a type of key to generate. The acceptable values here are -\fBrsa\fP and \fBdsa\fP (to generate SSH2 keys), and \fBrsa1\fP (to -generate SSH1 keys). -.IP "\fB\-b\fP \fIbits\fP" -Specify the size of the key to generate, in bits. Default is 1024. -.PP -In the second phase, \fBputtygen\fP optionally alters properties of -the key it has loaded or generated. The options to control this are: -.IP "\fB\-C\fP \fInew\-comment\fP" -Specify a comment string to describe the key. This comment string -will be used by PuTTY to identify the key to you (when asking you to -enter the passphrase, for example, so that you know which passphrase -to type). -.IP "\fB\-P\fP" -Indicate that you want to change the key's passphrase. This is -automatic when you are generating a new key, but not when you are -modifying an existing key. -.PP -In the third phase, \fBputtygen\fP saves the key or information -about it. The options to control this are: -.IP "\fB\-O\fP \fIoutput\-type\fP" -Specify the type of output you want \fBputtygen\fP to produce. -Acceptable options are: -.RS -.IP "\fBprivate\fP" -Save the private key in a format usable by PuTTY. This will either -be the standard SSH1 key format, or PuTTY's own SSH2 key format. -.IP "\fBpublic\fP" -Save the public key only. For SSH1 keys, the standard public key -format will be used ("1024 37 5698745...."). For SSH2 keys, the -public key will be output in the format specified in the IETF -drafts, which is a multi-line text file beginning with the line -"---- BEGIN SSH2 PUBLIC KEY ----". -.IP "\fBpublic-openssh\fP" -Save the public key only, in a format usable by OpenSSH. For SSH1 -keys, this output format behaves identically to \fBpublic\fP. For -SSH2 keys, the public key will be output in the OpenSSH format, -which is a single line ("ssh-rsa AAAAB3NzaC1yc2..."). -.IP "\fBfingerprint\fP" -Print the fingerprint of the public key. All fingerprinting -algorithms are believed compatible with OpenSSH. -.IP "\fBprivate-openssh\fP" -Save an SSH2 private key in OpenSSH's format. This option is not -permitted for SSH1 keys. -.IP "\fBprivate-sshcom\fP" -Save an SSH2 private key in ssh.com's format. This option is not -permitted for SSH1 keys. -.RE -.IP -If no output type is specified, the default is \fBprivate\fP. -.IP "\fB\-o\fP \fIoutput\-file\fP" -Specify the file where \fBputtygen\fP should write its output. If -this option is not specified, \fBputtygen\fP will assume you want to -overwrite the original file if the input and output file types are -the same (changing a comment or passphrase), and will assume you -want to output to stdout if you are asking for a public key or -fingerprint. Otherwise, the \fB\-o\fP option is required. -.IP "\fB\-l\fP" -Synonym for "\fB-O fingerprint\fP". -.IP "\fB\-L\fP" -Synonym for "\fB-O public-openssh\fP". -.IP "\fB\-p\fP" -Synonym for "\fB-O public\fP". -.SH EXAMPLES -To generate an SSH2 RSA key pair and save it in PuTTY's own format -(you will be prompted for the passphrase): - -\fBputtygen -t rsa -C "my home key" -o mykey.ppk\fP - -To generate a larger (2048-bit) key: - -\fBputtygen -t rsa -b 2048 -C "my home key" -o mykey.ppk\fP - -To change the passphrase on a key (you will be prompted for the old -and new passphrases): - -\fBputtygen -P mykey.ppk\fP - -To change the comment on a key: - -\fBputtygen -C "new comment" mykey.ppk\fP - -To convert a key into OpenSSH's private key format: - -\fBputtygen mykey.ppk -O private-openssh -o my-openssh-key\fP - -To convert a key \fIfrom\fP another format (\fBputtygen\fP will -automatically detect the input key type): - -\fBputtygen my-ssh.com-key -o mykey.ppk\fP - -To display the fingerprint of a key (some key types require a -passphrase to extract even this much information): - -\fBputtygen -l mykey.ppk\fP - -To add the OpenSSH-format public half of a key to your authorised -keys file: - -\fBputtygen -L mykey.ppk >> $HOME/.ssh/authorized_keys\fP - -.SH BUGS -There's currently no way to supply passphrases in batch mode, or -even just to specify that you don't want a passphrase at all. diff --git a/unix/puttytel.1 b/unix/puttytel.1 deleted file mode 100644 index e6cd4c0d..00000000 --- a/unix/puttytel.1 +++ /dev/null @@ -1,118 +0,0 @@ -.TH puttytel 1 -.UC -.SH NAME -puttytel \- GUI Telnet and Rlogin client for X -.SH SYNOPSIS -\fBputtytel\fP [ \fIoptions\fP ] [ \fIhost\fP ] -.SH DESCRIPTION -\fIputtytel\fP is a graphical Telnet and Rlogin client for X. It -is a direct port of the Windows Telnet and Rlogin client of the same -name, and a cut-down cryptography-free version of PuTTY. -.SH OPTIONS -The command-line options supported by \fIputtytel\fP are: -.IP "\fB\-\-display\fP \fIdisplay\-name\fP" -Specify the X display on which to open \fIputtytel\fP. (Note this -option has a double minus sign, even though none of the others do. -This is because this option is supplied automatically by GTK. -Sorry.) -.IP "\fB\-fn\fP \fIfont-name\fP" -Specify the font to use for normal text displayed in the terminal. -.IP "\fB\-fb\fP \fIfont-name\fP" -Specify the font to use for bold text displayed in the terminal. If -the \fIBoldAsColour\fP resource is set to 1 (the default), bold text -will be displayed in different colours instead of a different font, -so this option will be ignored. If \fIBoldAsColour\fP is set to 0 -and you do not specify a bold font, \fIputtytel\fP will overprint the -normal font to make it look bolder. -.IP "\fB\-fw\fP \fIfont-name\fP" -Specify the font to use for double-width characters (typically -Chinese, Japanese and Korean text) displayed in the terminal. -.IP "\fB\-fwb\fP \fIfont-name\fP" -Specify the font to use for bold double-width characters (typically -Chinese, Japanese and Korean text) Like \fI-fb\fP, this will be -ignored unless the \fIBoldAsColour\fP resource is set to 0. -.IP "\fB\-geometry\fP \fIgeometry\fP" -Specify the size of the terminal, in rows and columns of text. See -\fIX(7)\fP for more information on the syntax of geometry -specifications. -.IP "\fB\-sl\fP \fIlines\fP" -Specify the number of lines of scrollback to save off the top of the -terminal. -.IP "\fB\-fg\fP \fIcolour\fP" -Specify the foreground colour to use for normal text. -.IP "\fB\-bg\fP \fIcolour\fP" -Specify the background colour to use for normal text. -.IP "\fB\-bfg\fP \fIcolour\fP" -Specify the foreground colour to use for bold text, if the -\fIBoldAsColour\fP resource is set to 1 (the default). -.IP "\fB\-bbg\fP \fIcolour\fP" -Specify the foreground colour to use for bold reverse-video text, if -the \fIBoldAsColour\fP resource is set to 1 (the default). (This -colour is best thought of as the bold version of the background -colour; so it only appears when text is displayed \fIin\fP the -background colour.) -.IP "\fB\-cfg\fP \fIcolour\fP" -Specify the foreground colour to use for text covered by the cursor. -.IP "\fB\-cbg\fP \fIcolour\fP" -Specify the background colour to use for text covered by the cursor. -In other words, this is the main colour of the cursor. -.IP "\fB\-title\fP \fItitle\fP" -Specify the initial title of the terminal window. (This can be -changed under control of the server.) -.IP "\fB\-sb\-\fP or \fB+sb\fP" -Tells \fIputtytel\fP not to display a scroll bar. -.IP "\fB\-sb\fP" -Tells \fIputtytel\fP to display a scroll bar: this is the opposite of -\fI\-sb\-\fP. This is the default option: you will probably only need -to specify it explicitly if you have changed the default using the -\fIScrollBar\fP resource. -.IP "\fB\-log\fP \fIfilename\fP" -This option makes \fIputtytel\fP log all the terminal output to a file -as well as displaying it in the terminal. -.IP "\fB\-cs\fP \fIcharset\fP" -This option specifies the character set in which \fIputtytel\fP should -assume the session is operating. This character set will be used to -interpret all the data received from the session, and all input you -type or paste into \fIputtytel\fP will be converted into this character -set before being sent to the session. - -Any character set name which is valid in a MIME header (and -supported by \fIputtytel\fP) should be valid here (examples are -"ISO-8859-1", "windows-1252" or "UTF-8"). Also, any character -encoding which is valid in an X logical font description should be -valid ("ibm-cp437", for example). - -\fIputtytel\fP's default behaviour is to use the same character -encoding as its primary font. If you supply a Unicode (iso10646-1) -font, it will default to the UTF-8 character set. - -Character set names are case-insensitive. -.IP "\fB\-nethack\fP" -Tells \fIputtytel\fP to enable NetHack keypad mode, in which the -numeric keypad generates the NetHack "hjklyubn" direction keys. This -enables you to play NetHack with the numeric keypad without having -to use the NetHack "number_pad" option (which requires you to press -"n" before any repeat count). So you can move with the numeric -keypad, and enter repeat counts with the normal number keys. -.IP "\fB\-help\fP, \fB\-\-help\fP" -Display a message summarizing the available options. -.IP "\fB\-load\fP \fIsession\fP" -Load a saved session by name. This allows you to run a saved session -straight from the command line without having to go through the -configuration box first. -.IP "\fB\-telnet\fP, \fB\-rlogin\fP, \fB\-raw\fP" -Select the protocol \fIputtytel\fP will use to make the connection. -.IP "\fB\-l\fP \fIusername\fP" -Specify the username to use when logging in to the server. -.IP "\fB\-P\fP \fIport\fP" -Specify the port to connect to the server on. -.SH SAVED SESSIONS -Saved sessions are stored in a \fI.putty/sessions\fP subdirectory in -your home directory. -.SH MORE INFORMATION -For more information on PuTTY and PuTTYtel, it's probably best to go -and look at the manual on the web page: - -\fBhttp://www.chiark.greenend.org.uk/~sgtatham/putty/\fP -.SH BUGS -This man page isn't terribly complete.