Control of 'addr' is now handed over to {platform_,}new_connection() and

[u/mdw/putty] / unix / puttytel.1

.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.