Patch from Theo Markettos: apparently "BSD-derived IP stacks fall over when

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

diff --git a/unix/pterm.1 b/unix/pterm.1
index 0cad725..4a049ee 100644 (file)
--- a/unix/pterm.1
+++ b/unix/pterm.1
@@ -36,10 +36,17 @@ 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.
 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\-geometry\fP \fIwidth\fPx\fIheight\fP"
-Specify the size of the terminal, in rows and columns of text.
-Unfortunately \fIpterm\fP does not currently support specifying the
-initial position of the window.
+.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\-sl\fP \fIlines\fP"
 Specify the number of lines of scrollback to save off the top of the
 terminal.


@@ -61,7 +68,7 @@ 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\-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\-T\fP \fItitle\fP"
+.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"
 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"


@@ -103,6 +110,10 @@ supported by \fIpterm\fP) should be valid here (examples are
 encoding which is valid in an X logical font description should be
 valid ("ibm-cp437", for example).
 
 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
 Character set names are case-insensitive.
 .IP "\fB\-nethack\fP"
 Tells \fIpterm\fP to enable NetHack keypad mode, in which the


@@ -118,7 +129,7 @@ example:
 
 pterm \-xrm 'ScrollbarOnLeft: 1'
 .IP "\fB\-help\fP, \fB\-\-help\fP"
 
 pterm \-xrm 'ScrollbarOnLeft: 1'
 .IP "\fB\-help\fP, \fB\-\-help\fP"

-Display a message summarizing the available options
+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
 .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


@@ -140,6 +151,10 @@ 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.
 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.TerminalType\fP"
 This controls the value set in the TERM environment variable inside
 the new terminal. The default is "xterm".


@@ -190,6 +205,22 @@ screen exactly the way they found it.
 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.
 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
 .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


@@ -306,6 +337,16 @@ 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).
 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
 .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


@@ -429,5 +470,3 @@ 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.)
 .SH BUGS
 Most of the X resources have silly names. (Historical reasons from
 PuTTY, mostly.)

-
-Character-set switching and Unicode are not yet supported.