[ViewVC] Diff of: cvs/rxvt-unicode/doc/rxvt.1.html

Comparing rxvt-unicode/doc/rxvt.1.html (file contents):
Revision 1.1 by root, Tue Jan 11 02:24:59 2005 UTC vs.
Revision 1.23 by root, Thu Jul 7 19:37:46 2005 UTC

 <p><strong>rxvt</strong> [options] [-e command [ args ]]</p>
 <p>
 </p>
 <hr />
 <h1><a name="description">DESCRIPTION</a></h1>
-<p><strong>rxvt-unicode</strong>, version <strong>4.8</strong>, is a colour vt102 terminal
+<p><strong>rxvt-unicode</strong>, version <strong>5.6</strong>, is a colour vt102 terminal
 emulator intended as an <em>xterm</em>(1) replacement for users who do not
 require features such as Tektronix 4014 emulation and toolkit-style
 configurability. As a result, <strong>rxvt-unicode</strong> uses much less swap space --
 a significant advantage on a machine serving many X sessions.</p>
 <p>
 </p>
 <hr />
 <h1><a name="frequently_asked_questions">FREQUENTLY ASKED QUESTIONS</a></h1>
-<p>See <code>rxvt(7)</code> (try <code>man 7 rxvt</code>) for a list of frequently
+<p>See <code>rxvt(7)</code> (try <code>man 7 rxvt</code>) for a list of
-asked questions and answer to them and some common problems.</p>
+frequently asked questions and answer to them and some common
+problems. That document is also accessible on the World-Wide-Web at
+<a href="http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html">http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html</a>.</p>
 <p>
 </p>
 <hr />
 <h1><a name="rxvtunicode_vs__rxvt">RXVT-UNICODE VS. RXVT</a></h1>
 <p>Unlike the original rxvt, <strong>rxvt-unicode</strong> stores all text in Unicode
 <p></p>
 <dt><strong><a name="item__2dpixmap_file_5b_3bgeom_5d"><strong>-pixmap</strong> <em>file[;geom]</em></a></strong><br />
 </dt>
 <dd>
 Compile <em>XPM</em>: Specify XPM file for the background and also optionally
-specify its scaling with a geometry string. Note you may need to add
+specify its scaling with a geometry string. Note you may need to
-quotes to avoid special shell interpretation of the `;' in the
+add quotes to avoid special shell interpretation of the <code>;</code> in the
 command-line; resource <strong>backgroundPixmap</strong>.
 </dd>
 <p></p>
 <dt><strong><a name="item__2dcr_colour"><strong>-cr</strong> <em>colour</em></a></strong><br />
 </dt>
 </dd>
 <p></p>
 <dt><strong><a name="item__2dst_7c_2bst"><strong>-st</strong>|<strong>+st</strong></a></strong><br />
 </dt>
 <dd>
-Display normal (non XTerm/NeXT) scrollbar without/with a trough;
+Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
 resource <strong>scrollBar_floating</strong>.
 </dd>
 <p></p>
 <dt><strong><a name="item__2dptab_7c_2bptab"><strong>-ptab</strong>|<strong>+ptab</strong></a></strong><br />
 </dt>
 </dd>
 <p></p>
 <dt><strong><a name="item__2dimlocale_string"><strong>-imlocale</strong> <em>string</em></a></strong><br />
 </dt>
 <dd>
-The locale to use for opening the IM. You can use an LC_CTYPE of e.g.
+The locale to use for opening the IM. You can use an <code>LC_CTYPE</code> of e.g.
-de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input
+<code>de_DE.UTF-8</code> for normal text processing but <code>ja_JP.EUC-JP</code> for the
-extension to be able to input japanese characters while staying in
+input extension to be able to input japanese characters while staying in
-another locale.
+another locale. resource <strong>imLocale</strong>.
+</dd>
+<p></p>
+<dt><strong><a name="item__2dimfont_fontset"><strong>-imfont</strong> <em>fontset</em></a></strong><br />
+</dt>
+<dd>
+Set the font set to use for the X Input Method, see resource <strong>imFont</strong>
+for more info.
+</dd>
+<p></p>
+<dt><strong><a name="item__2dtcw"><strong>-tcw</strong></a></strong><br />
+</dt>
+<dd>
+Change the meaning of triple-click selection with the left mouse
+button. Instead of selecting a full line it will extend the selection the
+end of the logical line only. resource <strong>tripleclickwords</strong>.
 </dd>
 <p></p>
 <dt><strong><a name="item__2dinsecure"><strong>-insecure</strong></a></strong><br />
 </dt>
 <dd>
 <dd>
 Turn on/off secondary screen scroll (default enabled); resource
 <strong>secondaryScroll</strong>.
 </dd>
 <p></p>
-<dt><strong><a name="item__2dxrm_resourcestring"><strong>-xrm</strong> <em>resourcestring</em></a></strong><br />
+<dt><strong><a name="item__2dkeysym_2esym_string"><strong>-keysym.</strong><em>sym</em> <em>string</em></a></strong><br />
 </dt>
+<dd>
+Remap a key symbol. See resource <strong>keysym</strong>.
-<dd>
+</dd>
-No effect on rxvt-unicode. Simply passes through an argument to be made
+<p></p>
-available in the instance's argument list. Appears in <em>WM_COMMAND</em> in
+<dt><strong><a name="item__2dembed_windowid"><strong>-embed</strong> <em>windowid</em></a></strong><br />
-some window managers.
+</dt>
+<dd>
+Tells rxvt to embed it's windows into an already-existing window,
+which enables applications to easily embed a terminal.
+</dd>
+<dd>
+<p>Right now, rxvt will first unmap/map the specified window, so it
+shouldn't be a top-level window. rxvt will also reconfigure it
+quite a bit, so don't expect it to keep some specific state. It's best to
+create an extra subwindow for rxvt and leave it alone.</p>
+</dd>
+<dd>
+<p>The window will not be destroyed when rxvt exits.</p>
+</dd>
+<dd>
+<p>It might be useful to know that rxvt will not close file
+descriptors passed to it (except for stdin/out/err, of course), so you
+can use file descriptors to communicate with the programs within the
+terminal. This works regardless of wether the <code>-embed</code> option was used or
+not.</p>
+</dd>
+<dd>
+<p>Here is a short Gtk2-perl snippet that illustrates how this option can be
+used (a longer example is in <em>doc/embed</em>):</p>
+</dd>
+<dd>
+<pre>
+   my $rxvt = new Gtk2::Socket;
+   $rxvt-&gt;signal_connect_after (realize =&gt; sub {
+      my $xid = $_[0]-&gt;window-&gt;get_xid;
+      system &quot;rxvt -embed $xid &amp;&quot;;
+   });</pre>
+</dd>
+<p></p>
+<dt><strong><a name="item__2dpty_2dfd_fileno"><strong>-pty-fd</strong> <em>fileno</em></a></strong><br />
+</dt>
+<dd>
+Tells rxvt NOT to execute any commands or create a new pty/tty
+pair but instead use the given filehandle as the tty master. This is
+useful if you want to drive rxvt as a generic terminal emulator
+without having to run a program within it.
+</dd>
+<dd>
+<p>If this switch is given, rxvt will not create any utmp/wtmp
+entries and will not tinker with pty/tty permissions - you have to do that
+yourself if you want that.</p>
+</dd>
+<dd>
+<p>Here is a example in perl that illustrates how this option can be used (a
+longer example is in <em>doc/pty-fd</em>):</p>
+</dd>
+<dd>
+<pre>
+   use IO::Pty;
+   use Fcntl;</pre>
+</dd>
+<dd>
+<pre>
+   my $pty = new IO::Pty;
+   fcntl $pty, F_SETFD, 0; # clear close-on-exec
+   system &quot;rxvt -pty-fd &quot; . (fileno $pty) . &quot;&amp;&quot;;
+   close $pty;</pre>
+</dd>
+<dd>
+<pre>
+   # now communicate with rxvt
+   my $slave = $pty-&gt;slave;
+   while (&lt;$slave&gt;) { print $slave &quot;got &lt;$_&gt;\n&quot; }</pre>
 </dd>
 <p></p></dl>
 <p>
 </p>
 <hr />
 options) compiled into your version.</p>
 <p>There are two different methods that rxvt can use to get the
 Xresource data: using the X libraries (Xrm*-functions) or internal
 Xresources reader (<strong>~/.Xdefaults</strong>). For the first method (ie.
 <strong>rxvt -h</strong> lists <strong>XGetDefaults</strong>), you can set and change the
-resources using X11 tools like <strong>xset</strong>. Many distribution do also load
+resources using X11 tools like <strong>xrdb</strong>. Many distribution do also load
-settings from the <strong>~/.Xresources</strong> file when X starts.</p>
+settings from the <strong>~/.Xresources</strong> file when X starts. rxvt
+will consult the following files/resources in order, with later settings
+overwriting earlier ones:</p>
+<pre>
+  1. system-wide app-defaults file, either locale-dependent OR global
+  2. app-defaults file in $XAPPLRESDIR
+  3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
+  4. SCREEN_RESOURCES for the current screen
+  5. $XENVIRONMENT file OR $HOME/.Xdefaults-&lt;nodename&gt;</pre>
 <p>If compiled with internal Xresources support (i.e. <strong>rxvt -h</strong>
 lists <strong>.Xdefaults</strong>) then <strong>rxvt</strong> accepts application defaults
 set in XAPPLOADDIR/URxvt (compile-time defined: usually
 <strong>/usr/lib/X11/app-defaults/URxvt</strong>) and resources set in
 <strong>~/.Xdefaults</strong>, or <strong>~/.Xresources</strong> if <strong>~/.Xdefaults</strong> does not exist.
 <dt><strong><a name="item_colorit_3a_colour"><strong>colorIT:</strong> <em>colour</em></a></strong><br />
 </dt>
 <dd>
 Use the specified colour to display bold or italic characters when the
 foreground colour is the default. If font styles are not available
-(Compile styles) and this option is unset, reverse video is used instead.
+(Compile <em>styles</em>) and this option is unset, reverse video is used instead.
 </dd>
 <p></p>
 <dt><strong><a name="item_colorul_3a_colour"><strong>colorUL:</strong> <em>colour</em></a></strong><br />
 </dt>
 <dd>
 <p></p>
 <dt><strong><a name="item_troughcolor_3a_colour"><strong>troughColor:</strong> <em>colour</em></a></strong><br />
 </dt>
 <dd>
 Use the specified colour for the scrollbar's trough area [default
-#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.
+#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
 </dd>
 <p></p>
 <dt><strong><a name="item_bordercolor_3a_colour"><strong>borderColor:</strong> <em>colour</em></a></strong><br />
 </dt>
 <dd>
 be smaller, but not larger. A reasonable default font list is always
 appended to it. option <strong>-fn</strong>.
 </dd>
 <dd>
 <p>Each font can either be a standard X11 core font (XLFD) name, with
-optional prefix <code>x:</code> or a Xft font (Compile xft), prefixed with <code>xft:</code>.</p>
+optional prefix <code>x:</code> or a Xft font (Compile <em>xft</em>), prefixed with <code>xft:</code>.</p>
 </dd>
 <dd>
 <p>In addition, each font can be prefixed with additional hints and
 specifications enclosed in square brackets (<code>[]</code>). The only available
 hint currently is <code>codeset=codeset-name</code>, and this is only used for Xft
 <p></p>
 <dt><strong><a name="item_scrollstyle_3a_mode"><strong>scrollstyle:</strong> <em>mode</em></a></strong><br />
 </dt>
 <dd>
 Set scrollbar style to <strong>rxvt</strong>, <strong>plain</strong>, <strong>next</strong> or <strong>xterm</strong>. <strong>plain</strong> is
-the author's favourite..
+the author's favourite.
 </dd>
 <p></p>
 <dt><strong><a name="item_title_3a_string"><strong>title:</strong> <em>string</em></a></strong><br />
 </dt>
 <dd>
 <dd>
 Specify a command pipe for vt100 printer [default <em>lpr(1)</em>]. Use
 <strong>Print</strong> to initiate a screen dump to the printer and <strong>Ctrl-Print</strong> or
 <strong>Shift-Print</strong> to include the scrollback as well.
 </dd>
+<dd>
+<p>The string will be interpreted as if typed into the shell as-is.</p>
+</dd>
+<dd>
+<p>Example:</p>
+</dd>
+<dd>
+<pre>
+   URxvt*print-pipe: cat &gt; $(TMPDIR=$HOME mktemp urxvt.XXXXXX)</pre>
+</dd>
+<dd>
+<p>This creates a new file in your home directory with the screen contents
+everytime you hit <code>Print</code>.</p>
+</dd>
 <p></p>
 <dt><strong><a name="item_scrollbar_3a_boolean"><strong>scrollBar:</strong> <em>boolean</em></a></strong><br />
 </dt>
 <dd>
 <strong>True</strong>: enable the scrollbar [default]; option <strong>-sb</strong>. <strong>False</strong>:
 <p></p>
 <dt><strong><a name="item_scrollwithbuffer_3a_boolean"><strong>scrollWithBuffer:</strong> <em>boolean</em></a></strong><br />
 </dt>
 <dd>
 <strong>True</strong>: scroll with scrollback buffer when tty receives new lines (and
-<strong>scrollTtyOutput</strong> is False); option <strong>+sw</strong>. <strong>False</strong>: do not scroll
+<strong>scrollTtyOutput</strong> is False); option <strong>-sw</strong>. <strong>False</strong>: do not scroll
-with scrollback buffer when tty recieves new lines; option <strong>-sw</strong>.
+with scrollback buffer when tty recieves new lines; option <strong>+sw</strong>.
 </dd>
 <p></p>
 <dt><strong><a name="item_scrollttykeypress_3a_boolean"><strong>scrollTtyKeypress:</strong> <em>boolean</em></a></strong><br />
 </dt>
 <dd>
 </dd>
 <p></p>
 <dt><strong><a name="item_pointerblankdelay_3a_number"><strong>pointerBlankDelay:</strong> <em>number</em></a></strong><br />
 </dt>
 <dd>
-Specifies number of seconds before blanking the pointer [default 2].
+Specifies number of seconds before blanking the pointer [default 2]. Use a
+large number (e.g. <code>987654321</code>) to effectively disable the timeout.
 </dd>
 <p></p>
 <dt><strong><a name="item_backspacekey_3a_string"><strong>backspacekey:</strong> <em>string</em></a></strong><br />
 </dt>
 <dd>
 </dd>
 <p></p>
 <dt><strong><a name="item_imlocale_3a_name"><strong>imLocale:</strong> <em>name</em></a></strong><br />
 </dt>
 <dd>
-The locale to use for opening the IM. You can use an LC_CTYPE of e.g.
+The locale to use for opening the IM. You can use an <code>LC_CTYPE</code> of e.g.
-de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input
+<code>de_DE.UTF-8</code> for normal text processing but <code>ja_JP.EUC-JP</code> for the
-extension to be able to input japanese characters while staying in
+input extension to be able to input japanese characters while staying in
 another locale. option <strong>-imlocale</strong>.
+</dd>
+<p></p>
+<dt><strong><a name="item_imfont_3a_fontset"><strong>imFont:</strong> <em>fontset</em></a></strong><br />
+</dt>
+<dd>
+Specify the font-set used for XIM styles <code>OverTheSpot</code> or
+<code>OffTheSpot</code>. It must be a standard X font set (XLFD patterns separated
+by commas), i.e. it's not in the same format as the other font lists used
+in rxvt. The default will be set-up to chose *any* suitable found
+found, preferably one or two pixels differing in size to the base font.
+option <strong>-imfont</strong>.
+</dd>
+<p></p>
+<dt><strong><a name="item_tripleclickwords_3a_boolean"><strong>tripleclickwords:</strong> <em>boolean</em></a></strong><br />
+</dt>
+<dd>
+Change the meaning of triple-click selection with the left mouse
+button. Instead of selecting a full line it will extend the selection to
+the end of the logical line only. option <strong>-tcw</strong>.
 </dd>
 <p></p>
 <dt><strong><a name="item_insecure_3a_boolean"><strong>insecure:</strong> <em>boolean</em></a></strong><br />
 </dt>
 <dd>
 </dd>
 <p></p>
 <dt><strong><a name="item_keysym_2esym_3a_string"><strong>keysym.</strong><em>sym</em>: <em>string</em></a></strong><br />
 </dt>
 <dd>
-Associate <em>string</em> with keysym <em>sym</em> (<strong>0xFF00 - 0xFFFF</strong>). It may
+Compile <em>frills</em>: Associate <em>string</em> with keysym <em>sym</em>. The
-contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n:
-newline, \r: return, \t:
-tab, \000: octal number) or control characters (^?: delete, ^@: null,
-^A ...) and may enclosed with double quotes so that it can start or end
-with whitespace. The intervening resource name <strong>keysym.</strong> cannot be
+intervening resource name <strong>keysym.</strong> cannot be omitted.
-omitted. This resource is only available when compiled with
+</dd>
-KEYSYM_RESOURCE.
+<dd>
+<p>The format of <em>sym</em> is ``<em>(modifiers-)key</em>'', where <em>modifiers</em> can be
+any combination of <strong>ISOLevel3</strong>, <strong>AppKeypad</strong>, <strong>Control</strong>, <strong>NumLock</strong>,
+<strong>Shift</strong>, <strong>Meta</strong>, <strong>Lock</strong>, <strong>Mod1</strong>, <strong>Mod2</strong>, <strong>Mod3</strong>, <strong>Mod4</strong>, <strong>Mod5</strong>,
+and the abbreviated <strong>I</strong>, <strong>K</strong>, <strong>C</strong>, <strong>N</strong>, <strong>S</strong>, <strong>M</strong>, <strong>A</strong>, <strong>L</strong>, <strong>1</strong>,
+<strong>2</strong>, <strong>3</strong>, <strong>4</strong>, <strong>5</strong>.</p>
+</dd>
+<dd>
+<p>The <strong>NumLock</strong>, <strong>Meta</strong> and <strong>ISOLevel3</strong> modifiers are usually aliased to
+whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
+keys are being mapped. <strong>AppKeypad</strong> is a synthetic modifier mapped to the
+current application keymap mode state.</p>
+</dd>
+<dd>
+<p>The spellings of <em>key</em> can be obtained by using <strong>xev</strong>(1) command or
+searching keysym macros from <strong>/usr/X11R6/include/X11/keysymdef.h</strong> and
+omitting the prefix <strong>XK_</strong>. Alternatively you can specify <em>key</em> by its hex
+keysym value (<strong>0x0000 - 0xFFFF</strong>). Note that the lookup of <em>sym</em>s is not
+performed in an exact manner; however, the closest match is assured.</p>
+</dd>
+<dd>
+<p><em>string</em> may contain escape values (<code>\a</code>: bell, <code>\b</code>: backspace,
+<code>\e</code>, <code>\E</code>: escape, <code>\n</code>: newline, <code>\r</code>: carriage return, <code>\t</code>: tab,
+<code>\000</code>: octal number) or verbatim control characters (<code>^?</code>: delete,
+<code>^@</code>: null, <code>^A</code> ...) and may be enclosed with double quotes so that it
+can start or end with whitespace.</p>
+</dd>
+<dd>
+<p>Please note that you need to double the <code>\</code> when using
+<code>--enable-xgetdefault</code>, as X itself does it's own de-escaping (you can
+use <code>\033</code> instead of <code>\e</code> (and so on), which will work with both Xt and
+rxvt's own processing).</p>
+</dd>
+<dd>
+<p>You can define a range of keysyms in one shot by providing a <em>string</em>
+with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimeter `/'
+should be a character not used by the strings.</p>
+</dd>
+<dd>
+<p>Its usage can be demonstrated by an example:</p>
+</dd>
+<dd>
+<pre>
+  URxvt.keysym.M-C-0x61:    list|\033&lt;M-C-|abc|&gt;</pre>
+</dd>
+<dd>
+<p>The above line is equivalent to the following three lines:</p>
+</dd>
+<dd>
+<pre>
+  URxvt.keysym.Meta-Control-0x61:    \033&lt;M-C-a&gt;
+  URxvt.keysym.Meta-Control-0x62:    \033&lt;M-C-b&gt;
+  URxvt.keysym.Meta-Control-0x63:    \033&lt;M-C-c&gt;</pre>
+</dd>
+<dd>
+<p>If <em>string</em> takes the form of <code>command:STRING</code>, the specified <strong>STRING</strong>
+is interpreted and executed as rxvt's control sequence. For
+example the following means ``change the current locale to <code>zh_CN.GBK</code>
+when Control-Meta-c is being pressed'':</p>
+</dd>
+<dd>
+<pre>
+  URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007</pre>
+</dd>
+<dd>
+<p>Due the the large number of modifier combinations, a defined key mapping
+will match if at <em>at least</em> the specified identifiers are being set, and
+no other key mappings with those and more bits are being defined. That
+means that defining a key map for <code>a</code> will automatically provide
+definitions for <code>Meta-a</code>, <code>Shift-a</code> and so on, unless some of those are defined
+mappings themselves.</p>
+</dd>
+<dd>
+<p>Unfortunately, this will override built-in key mappings. For example
+if you overwrite the <code>Insert</code> key you will disable rxvt's
+<code>Shift-Insert</code> mapping. To re-enable that, you can poke ``holes'' into the
+user-defined keymap using the <code>builtin:</code> replacement:</p>
+</dd>
+<dd>
+<pre>
+  URxvt.keysym.Insert: &lt;my insert key sequence&gt;
+  URxvt.keysym.S-Insert: builtin:</pre>
+</dd>
+<dd>
+<p>The first line defines a mapping for <code>Insert</code> and <em>any</em> combination
+of modifiers. The second line re-establishes the default mapping for
+<code>Shift-Insert</code>.</p>
+</dd>
+<dd>
+<p>The following example will map Control-Meta-1 and Control-Meta-2 to
+the fonts <code>suxuseuro</code> and <code>9x15bold</code>, so you can have some limited
+font-switching at runtime:</p>
+</dd>
+<dd>
+<pre>
+  URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
+  URxvt.keysym.M-C-2: command:\033]50;9x15bold\007</pre>
+</dd>
+<dd>
+<p>Other things are possible, e.g. resizing (see <code>rxvt(7)</code> for more
+info):</p>
+</dd>
+<dd>
+<pre>
+  URxvt.keysym.M-C-3: command:\033[8;25;80t
+  URxvt.keysym.M-C-4: command:\033[8;48;110t</pre>
 </dd>
 <p></p></dl>
 <p>
 </p>
 <hr />
 <p>To temporarily override mouse reporting, for either the scrollbar or
 the normal text selection/insertion, hold either the Shift or the Meta
 (Alt) key while performing the desired mouse action.</p>
 <p>If mouse reporting mode is active, the normal scrollbar actions are
 disabled -- on the assumption that we are using a fullscreen
-application. Instead, pressing Button1 and Button3 sends <strong>ESC[6~</strong>
+application. Instead, pressing Button1 and Button3 sends <strong>ESC [ 6 ~</strong>
-(Next) and <strong>ESC[5~</strong> (Prior), respectively. Similarly, clicking on the
+(Next) and <strong>ESC [ 5 ~</strong> (Prior), respectively. Similarly, clicking on the
-up and down arrows sends <strong>ESC[A</strong> (Up) and <strong>ESC[B</strong> (Down),
+up and down arrows sends <strong>ESC [ A</strong> (Up) and <strong>ESC [ B</strong> (Down),
 respectively.</p>
 <p>
 </p>
 <hr />
 <h1><a name="text_selection_and_insertion">TEXT SELECTION AND INSERTION</a></h1>
 <em>xterm</em>(1).</p>
 <dl>
 <dt><strong><a name="item_selection_3a"><strong>Selection</strong>:</a></strong><br />
 </dt>
 <dd>
-Left click at the beginning of the region, drag to the end of the
+Left click at the beginning of the region, drag to the end of the region
-region and release; Right click to extend the marked region; Left
+and release; Right click to extend the marked region; Left double-click
-double-click to select a word; Left triple-click to select the entire
+to select a word; Left triple-click to select the entire logical line
-line.
+(which can span multiple screen lines), unless modified by resource
+<strong>tripleclickwords</strong>.
 </dd>
 <dd>
 <p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys)
-(Compile: frills) will create a rectangular selection instead of a normal
+(Compile: <em>frills</em>) will create a rectangular selection instead of a normal
 one.</p>
 </dd>
 <p></p>
 <dt><strong><a name="item_insertion_3a"><strong>Insertion</strong>:</a></strong><br />
 </dt>
 <p>ISO 14755 is a standard for entering and viewing unicode characters
 and character codes using the keyboard. It consists of 4 parts. The
 first part is available rxvt-unicode has been compiled with
 <code>--enable-frills</code>, the rest is available when rxvt-unicode was compiled
 with <code>--enable-iso14755</code>.</p>
-<ol>
+<ul>
-<li><strong><a name="item_1_3a_basic_method">1: Basic method</a></strong><br />
+<li><strong><a name="item_5_2e1_3a_basic_method">5.1: Basic method</a></strong><br />
 </li>
 This allows you to enter unicode characters using their hexcode.
 <p>Start by pressing and holding both <code>Control</code> and <code>Shift</code>, then enter
 hex-digits (between one and six). Releasing <code>Control</code> and <code>Shift</code> will
 commit the character as if it were typed directly. While holding down
 address, which you cannot type. Fortunately, the card has the e-mail
 address printed as hexcodes, e.g. <code>671d 65e5</code>. You can enter this easily
 by pressing <code>Control</code> and <code>Shift</code>, followed by <code>6-7-1-D-SPACE-6-5-E-5</code>,
 followed by releasing the modifier keys.</p>
 <p></p>
-<li><strong><a name="item_2_3a_keyboard_symbols_entry_method">2: Keyboard symbols entry method</a></strong><br />
+<li><strong><a name="item_5_2e2_3a_keyboard_symbols_entry_method">5.2: Keyboard symbols entry method</a></strong><br />
 </li>
 This mode lets you input characters representing the keycap symbols of
 your keyboard, if representable in the current locale encoding.
 <p>Start by pressing <code>Control</code> and <code>Shift</code> together, then releasing
 them. The next special key (cursor keys, home etc.) you enter will not
 keycap symbol. The symbol will only be entered when the key has been
 released, otherwise pressing e.g. <code>Shift</code> would enter the symbol for
 <code>ISO Level 2 Switch</code>, although your intention might have been to enter a
 reverse tab (Shift-Tab).</p>
 <p></p>
-<li><strong><a name="item_3_3a_screen_2dselection_entry_method">3: Screen-selection entry method</a></strong><br />
+<li><strong><a name="item_5_2e3_3a_screen_2dselection_entry_method">5.3: Screen-selection entry method</a></strong><br />
 </li>
 While this is implemented already (it's basically the selection
 mechanism), it could be extended by displaying a unicode character map.
 <p></p>
-<li><strong><a name="item_4_3a_feedback_method_for_identifying_displayed_cha">4: Feedback method for identifying displayed characters for later input</a></strong><br />
+<li><strong><a name="item_5_2e4_3a_feedback_method_for_identifying_displayed">5.4: Feedback method for identifying displayed characters for later input</a></strong><br />
 </li>
 This method lets you display the unicode character code associated with
 characters already displayed.
 <p>You enter this mode by holding down <code>Control</code> and <code>Shift</code> together, then
 pressing and holding the left mouse button and moving around. The unicode
 pointer is displayed until you release <code>Control</code> and <code>Shift</code>.</p>
 <p>In addition to the hex codes it will display the font used to draw this
 character - due to implementation reasons, characters combined with
 combining characters, line drawing characters and unknown characters will
 always be drawn using the built-in support font.</p>
-<p></p></ol>
+<p></p></ul>
 <p>With respect to conformance, rxvt-unicode is supposed to be compliant to
 both scenario A and B of ISO 14755, including part 5.2.</p>
 <p>
 </p>
 <hr />
 <h1><a name="login_stamp">LOGIN STAMP</a></h1>
-<p><strong>rxvt</strong> tries to write an entry into the <em>utmp</em>(5) file so
+<p><strong>rxvt</strong> tries to write an entry into the <em>utmp</em>(5) file so that
-that it can be seen via the <em>who(1)</em> command, and can accept messages.
+it can be seen via the <em>who(1)</em> command, and can accept messages.  To
-To allow this feature, <strong>rxvt</strong> must be installed setuid root on
+allow this feature, <strong>rxvt</strong> may need to be installed setuid root
-some systems.</p>
+on some systems or setgid to root or to some other group on others.</p>
 <p>
 </p>
 <hr />
 <h1><a name="colors_and_graphics">COLORS AND GRAPHICS</a></h1>
 <p>In addition to the default foreground and background colours,
 <p></p></dl>
 <p>
 </p>
 <hr />
 <h1><a name="environment">ENVIRONMENT</a></h1>
-<p><strong>rxvt</strong> sets the environment variables <strong>TERM</strong>, <strong>COLORTERM</strong>
+<p><strong>rxvt</strong> sets and/or uses the following environment variables:</p>
-and <strong>COLORFGBG</strong>. The environment variable <strong>WINDOWID</strong> is set to the X
+<dl>
-window id number of the <strong>rxvt</strong> window and it also uses and
+<dt><strong><a name="item_term"><strong>TERM</strong></a></strong><br />
-sets the environment variable <strong>DISPLAY</strong> to specify which display
+</dt>
-terminal to use. <strong>rxvt</strong> uses the environment variables
+<dd>
-<strong>RXVTPATH</strong> and <strong>PATH</strong> to find XPM files.</p>
+Normally set to <code>rxvt-unicode</code>, unless overwritten at configure time, via
+resources or on the commandline.
+</dd>
+<p></p>
+<dt><strong><a name="item_colorterm"><strong>COLORTERM</strong></a></strong><br />
+</dt>
+<dd>
+Either <code>rxvt</code>, <code>rxvt-xpm</code>, depending on wether rxvt was
+compiled with XPM support, and optionally with the added extension
+<code>-mono</code> to indicate that rxvt-unicode runs on a monochrome screen.
+</dd>
+<p></p>
+<dt><strong><a name="item_colorfgbg"><strong>COLORFGBG</strong></a></strong><br />
+</dt>
+<dd>
+Set to a string of the form <code>fg;bg</code> or <code>fg;xpm;bg</code>, where <code>fg</code> is
+the colour code used as default foreground/text colour (or the string
+<code>default</code> to indicate that the default-colour escape sequence is to be
+used), <code>bg</code> is the colour code used as default background colour (or the
+string <code>default</code>), and <code>xpm</code> is the string <code>default</code> if rxvt
+was compiled with XPM support. Libraries like <code>ncurses</code> and <code>slang</code> can
+(and do) use this information to optimize screen output.
+</dd>
+<p></p>
+<dt><strong><a name="item_windowid"><strong>WINDOWID</strong></a></strong><br />
+</dt>
+<dd>
+Set to the (decimal) X Window ID of the rxvt window (the toplevel
+window, which usually has subwindows for the scrollbar, the terminal
+window and so on).
+</dd>
+<p></p>
+<dt><strong><a name="item_terminfo"><strong>TERMINFO</strong></a></strong><br />
+</dt>
+<dd>
+Set to the terminfo directory iff rxvt was configured with
+<code>--with-terminfo=PATH</code>.
+</dd>
+<p></p>
+<dt><strong><a name="item_display"><strong>DISPLAY</strong></a></strong><br />
+</dt>
+<dd>
+Used by rxvt to connect to the display and set to the correct
+display in it's child processes.
+</dd>
+<p></p>
+<dt><strong><a name="item_shell"><strong>SHELL</strong></a></strong><br />
+</dt>
+<dd>
+The shell to be used for command execution, defaults to <code>/bin/sh</code>.
+</dd>
+<p></p>
+<dt><strong><a name="item_rxvtpath"><strong>RXVTPATH</strong></a></strong><br />
+</dt>
+<dd>
+The path where rxvt looks for support files such as menu and xpm
+files.
+</dd>
+<p></p>
+<dt><strong><a name="item_path"><strong>PATH</strong></a></strong><br />
+</dt>
+<dd>
+Used in the same way as <a href="#item_rxvtpath"><code>RXVTPATH</code></a>.
+</dd>
+<p></p>
+<dt><strong><a name="item_rxvt_socket"><strong>RXVT_SOCKET</strong></a></strong><br />
+</dt>
+<dd>
+The unix domain socket path used by <code>rxvtc(1)</code> and
+rxvtd(1).
+</dd>
+<dd>
+<p>Default <em>$HOME/.rxvt-unicode-<em>&lt;nodename </em></em> &gt;&gt;&gt;.</p>
+</dd>
+<p></p>
+<dt><strong><a name="item_home"><strong>HOME</strong></a></strong><br />
+</dt>
+<dd>
+Used to locate the default directory for the unix domain socket for
+daemon communications and to locate various resource files (such as
+<code>.Xdefaults</code>)
+</dd>
+<p></p>
+<dt><strong><a name="item_xapplresdir"><strong>XAPPLRESDIR</strong></a></strong><br />
+</dt>
+<dd>
+Directory where various X resource files are being located.
+</dd>
+<p></p>
+<dt><strong><a name="item_xenvironment"><strong>XENVIRONMENT</strong></a></strong><br />
+</dt>
+<dd>
+If set and accessible, gives the name of a X resource file to be loaded by
+rxvt.
+</dd>
+<p></p></dl>
 <p>
 </p>
 <hr />
 <h1><a name="files">FILES</a></h1>
 <dl>
-<dt><strong><a name="item__2fetc_2futmp"><strong>/etc/utmp</strong></a></strong><br />
-</dt>
-<dd>
-System file for login records.
-</dd>
-<p></p>
 <dt><strong><a name="item__2fusr_2flib_2fx11_2frgb_2etxt"><strong>/usr/lib/X11/rgb.txt</strong></a></strong><br />
 </dt>
 <dd>
 Color names.
 </dd>
 <p></p></dl>
 <p>
 </p>
 <hr />
 <h1><a name="see_also">SEE ALSO</a></h1>
-<p>rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), <code>utmp(5)</code></p>
+<p>rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), <code>utmp(5)</code></p>
 <p>
 </p>
 <hr />
 <h1><a name="bugs">BUGS</a></h1>
 <p>Check the BUGS file for an up-to-date list.</p>
 <h1><a name="current_project_coordinator">CURRENT PROJECT COORDINATOR</a></h1>
 <dl>
 <dt><strong><a name="item_project_coordinator">Project Coordinator</a></strong><br />
 </dt>
 <dd>
-Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em>
+Marc A. Lehmann <em><a href="mailto:<rxvt-unicode@schmorp.de"><rxvt-unicode@schmorp.de</a></em>&gt;
-</dd>
-<p></p>
-<dt><strong><a name="item_web_page_maintainter">Web page maintainter</a></strong><br />
-</dt>
-<dd>
+</dd>
-Marc A. Lehmann <em><a href="mailto:rxvt@schmorp.de">rxvt@schmorp.de</a></em>
-</dd>
+<dd>
-<dd>
-<p><a href="http://software.schmorp.de/">http://software.schmorp.de/</a></p>
+<p><a href="http://software.schmorp.de/#rxvt-unicode">http://software.schmorp.de/#rxvt-unicode</a></p>
 </dd>
 <p></p></dl>
 <p>
 </p>
 <hr />
 <dd>
 Rewrote screen display and text selection routines. Project Coordinator
 (changes.txt 2.4.6 - rxvt-unicode)
 </dd>
 <p></p>
-<dt><strong><a name="item_marc_alexander_lehmann__3crxvt_40schmorp_2ede_3e">Marc Alexander Lehmann <em><a href="mailto:<rxvt@schmorp.de"><rxvt@schmorp.de</a></em>&gt;</a></strong><br />
+<dt><strong><a name="item_marc_alexander_lehmann__3crxvt_2dunicode_40schmorp">Marc Alexander Lehmann <em><a href="mailto:<rxvt-unicode@schmorp.de"><rxvt-unicode@schmorp.de</a></em>&gt;</a></strong><br />
 </dt>
 <dd>
 Forked rxvt-unicode, rewrote most of the display code and internal
 character handling to store text in unicode, improve xterm
 compatibility and apply numerous other bugfixes and extensions.

Diff Legend

-–
+Removed lines
-+
+Added lines
-<
+Changed lines
->
+Changed lines

Comparing rxvt-unicode/doc/rxvt.1.html (file contents): Revision 1.1 by root, Tue Jan 11 02:24:59 2005 UTC vs. Revision 1.23 by root, Thu Jul 7 19:37:46 2005 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.html (file contents):
Revision 1.1 by root, Tue Jan 11 02:24:59 2005 UTC vs.
Revision 1.23 by root, Thu Jul 7 19:37:46 2005 UTC