git.distorted.org.uk Git - u/mdw/putty/blob - unix/puttytel.1

   1 .TH puttytel 1
   2 .UC
   3 .SH NAME
   4 puttytel \- GUI Telnet and Rlogin client for X
   5 .SH SYNOPSIS
   6 \fBputtytel\fP [ \fIoptions\fP ] [ \fIhost\fP ]
   7 .SH DESCRIPTION
   8 \fIputtytel\fP is a graphical Telnet and Rlogin client for X. It
   9 is a direct port of the Windows Telnet and Rlogin client of the same
  10 name, and a cut-down cryptography-free version of PuTTY.
  11 .SH OPTIONS
  12 The command-line options supported by \fIputtytel\fP are:
  13 .IP "\fB\-\-display\fP \fIdisplay\-name\fP"
  14 Specify the X display on which to open \fIputtytel\fP. (Note this
  15 option has a double minus sign, even though none of the others do.
  16 This is because this option is supplied automatically by GTK.
  17 Sorry.)
  18 .IP "\fB\-fn\fP \fIfont-name\fP"
  19 Specify the font to use for normal text displayed in the terminal.
  20 .IP "\fB\-fb\fP \fIfont-name\fP"
  21 Specify the font to use for bold text displayed in the terminal. If
  22 the \fIBoldAsColour\fP resource is set to 1 (the default), bold text
  23 will be displayed in different colours instead of a different font,
  24 so this option will be ignored. If \fIBoldAsColour\fP is set to 0
  25 and you do not specify a bold font, \fIputtytel\fP will overprint the
  26 normal font to make it look bolder.
  27 .IP "\fB\-fw\fP \fIfont-name\fP"
  28 Specify the font to use for double-width characters (typically
  29 Chinese, Japanese and Korean text) displayed in the terminal.
  30 .IP "\fB\-fwb\fP \fIfont-name\fP"
  31 Specify the font to use for bold double-width characters (typically
  32 Chinese, Japanese and Korean text) Like \fI-fb\fP, this will be
  33 ignored unless the \fIBoldAsColour\fP resource is set to 0.
  34 .IP "\fB\-geometry\fP \fIgeometry\fP"
  35 Specify the size of the terminal, in rows and columns of text. See
  36 \fIX(7)\fP for more information on the syntax of geometry
  37 specifications.
  38 .IP "\fB\-sl\fP \fIlines\fP"
  39 Specify the number of lines of scrollback to save off the top of the
  40 terminal.
  41 .IP "\fB\-fg\fP \fIcolour\fP"
  42 Specify the foreground colour to use for normal text.
  43 .IP "\fB\-bg\fP \fIcolour\fP"
  44 Specify the background colour to use for normal text.
  45 .IP "\fB\-bfg\fP \fIcolour\fP"
  46 Specify the foreground colour to use for bold text, if the
  47 \fIBoldAsColour\fP resource is set to 1 (the default).
  48 .IP "\fB\-bbg\fP \fIcolour\fP"
  49 Specify the foreground colour to use for bold reverse-video text, if
  50 the \fIBoldAsColour\fP resource is set to 1 (the default). (This
  51 colour is best thought of as the bold version of the background
  52 colour; so it only appears when text is displayed \fIin\fP the
  53 background colour.)
  54 .IP "\fB\-cfg\fP \fIcolour\fP"
  55 Specify the foreground colour to use for text covered by the cursor.
  56 .IP "\fB\-cbg\fP \fIcolour\fP"
  57 Specify the background colour to use for text covered by the cursor.
  58 In other words, this is the main colour of the cursor.
  59 .IP "\fB\-title\fP \fItitle\fP"
  60 Specify the initial title of the terminal window. (This can be
  61 changed under control of the server.)
  62 .IP "\fB\-sb\-\fP or \fB+sb\fP"
  63 Tells \fIputtytel\fP not to display a scroll bar.
  64 .IP "\fB\-sb\fP"
  65 Tells \fIputtytel\fP to display a scroll bar: this is the opposite of
  66 \fI\-sb\-\fP. This is the default option: you will probably only need
  67 to specify it explicitly if you have changed the default using the
  68 \fIScrollBar\fP resource.
  69 .IP "\fB\-log\fP \fIfilename\fP"
  70 This option makes \fIputtytel\fP log all the terminal output to a file
  71 as well as displaying it in the terminal.
  72 .IP "\fB\-cs\fP \fIcharset\fP"
  73 This option specifies the character set in which \fIputtytel\fP should
  74 assume the session is operating. This character set will be used to
  75 interpret all the data received from the session, and all input you
  76 type or paste into \fIputtytel\fP will be converted into this character
  77 set before being sent to the session.
  78
  79 Any character set name which is valid in a MIME header (and
  80 supported by \fIputtytel\fP) should be valid here (examples are
  81 "ISO-8859-1", "windows-1252" or "UTF-8"). Also, any character
  82 encoding which is valid in an X logical font description should be
  83 valid ("ibm-cp437", for example).
  84
  85 \fIputtytel\fP's default behaviour is to use the same character
  86 encoding as its primary font. If you supply a Unicode (iso10646-1)
  87 font, it will default to the UTF-8 character set.
  88
  89 Character set names are case-insensitive.
  90 .IP "\fB\-nethack\fP"
  91 Tells \fIputtytel\fP to enable NetHack keypad mode, in which the
  92 numeric keypad generates the NetHack "hjklyubn" direction keys. This
  93 enables you to play NetHack with the numeric keypad without having
  94 to use the NetHack "number_pad" option (which requires you to press
  95 "n" before any repeat count). So you can move with the numeric
  96 keypad, and enter repeat counts with the normal number keys.
  97 .IP "\fB\-help\fP, \fB\-\-help\fP"
  98 Display a message summarizing the available options.
  99 .IP "\fB\-load\fP \fIsession\fP"
 100 Load a saved session by name. This allows you to run a saved session
 101 straight from the command line without having to go through the
 102 configuration box first.
 103 .IP "\fB\-telnet\fP, \fB\-rlogin\fP, \fB\-raw\fP"
 104 Select the protocol \fIputtytel\fP will use to make the connection.
 105 .IP "\fB\-l\fP \fIusername\fP"
 106 Specify the username to use when logging in to the server.
 107 .IP "\fB\-P\fP \fIport\fP"
 108 Specify the port to connect to the server on.
 109 .SH SAVED SESSIONS
 110 Saved sessions are stored in a \fI.putty/sessions\fP subdirectory in
 111 your home directory.
 112 .SH MORE INFORMATION
 113 For more information on PuTTY and PuTTYtel, it's probably best to go
 114 and look at the manual on the web page:
 115
 116 \fBhttp://www.chiark.greenend.org.uk/~sgtatham/putty/\fP
 117 .SH BUGS
 118 This man page isn't terribly complete.