Improve shadow bold mode: set the default shadow bold offset to +1

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

diff --git a/unix/pterm.1 b/unix/pterm.1
index 744ff6f..6d90725 100644 (file)
--- a/unix/pterm.1
+++ b/unix/pterm.1
@@ -84,7 +84,7 @@ default using the \fILoginShell\fP resource.
 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-ls-\fP. This is the default option: you will probably only need
+\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"
@@ -103,12 +103,29 @@ 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.TerminalType\fP"
 This controls the value set in the TERM environment variable inside
 the new terminal. The default is "xterm".
@@ -218,6 +235,11 @@ 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
@@ -270,6 +292,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).
+.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