tags allbin:
alldoc: rxvt.1.man.in rxvt.7.man.in rxvtc.1.man.in rxvtd.1.man.in rxvtperl.3.man.in \
- rxvt.1.txt rxvt.7.txt rxvtc.1.txt rxvtd.1.txt rxvtperl.3.txt \
- rxvt.1.html rxvt.7.html rxvtc.1.html rxvtd.1.html rxvtperl.3.html \
../README.configure ../README.FAQ
infocmp -C rxvt-unicode >$(srcdir)/etc/rxvt-unicode.termcap
realclean: distclean
rm -f rxvt.1.man.in rxvt.7.man.in rxvtc.1.man.in rxvtd.1.man.in rxvtperl.3.man.in
- rm -f rxvt.1.txt rxvt.7.txt rxvtc.1.txt rxvtd.1.txt rxvtperl.3.txt
- rm -f rxvt.1.html rxvt.7.html rxvtc.1.html rxvtd.1.html rxvtperl.3.html
rm -f ../README.configure ../README.FAQ
rm -f $(srcdir)/etc/rxvt-unicode.termcap
+++ /dev/null
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
-<head>
- <title>rxvt-unicode (ouR XVT, unicode)</title>
- <meta name="description" content="Pod documentation for rxvt-unicode (ouR XVT, unicode)" />
- <meta name="inputfile" content="<standard input>" />
- <meta name="outputfile" content="<standard output>" />
- <meta name="created" content="Fri Nov 23 12:34:59 2007" />
- <meta name="generator" content="Pod::Xhtml 1.57" />
-<link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head>
-<body>
-<div class="pod">
-<!-- INDEX START -->
-<h3 id="TOP">Index</h3>
-
-<ul><li><a href="#NAME">NAME</a></li>
-<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
-<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
-<li><a href="#FREQUENTLY_ASKED_QUESTIONS">FREQUENTLY ASKED QUESTIONS</a></li>
-<li><a href="#RXVT_UNICODE_VS_RXVT">RXVT-UNICODE VS. RXVT</a></li>
-<li><a href="#OPTIONS">OPTIONS</a></li>
-<li><a href="#RESOURCES_available_also_as_long_opt">RESOURCES (available also as long-options)</a></li>
-<li><a href="#THE_SCROLLBAR">THE SCROLLBAR</a></li>
-<li><a href="#MOUSE_REPORTING">MOUSE REPORTING</a></li>
-<li><a href="#THE_SELECTION_SELECTING_AND_PASTING_">THE SELECTION: SELECTING AND PASTING TEXT</a></li>
-<li><a href="#CHANGING_FONTS">CHANGING FONTS</a></li>
-<li><a href="#ISO_14755_SUPPORT">ISO 14755 SUPPORT</a></li>
-<li><a href="#LOGIN_STAMP">LOGIN STAMP</a></li>
-<li><a href="#COLORS_AND_GRAPHICS">COLORS AND GRAPHICS</a>
-<ul><li><a href="#ALPHA_CHANNEL_SUPPORT">ALPHA CHANNEL SUPPORT</a></li>
-</ul>
-</li>
-<li><a href="#ENVIRONMENT">ENVIRONMENT</a></li>
-<li><a href="#FILES">FILES</a></li>
-<li><a href="#SEE_ALSO">SEE ALSO</a></li>
-<li><a href="#CURRENT_PROJECT_COORDINATOR">CURRENT PROJECT COORDINATOR</a></li>
-<li><a href="#AUTHORS">AUTHORS</a>
-</li>
-</ul><hr />
-<!-- INDEX END -->
-
-<h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="NAME_CONTENT">
-<p>rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window system)</p>
-
-</div>
-<h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="SYNOPSIS_CONTENT">
-<p><strong>rxvt</strong> [options] [-e command [ args ]]</p>
-
-</div>
-<h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="DESCRIPTION_CONTENT">
-<p><strong>rxvt-unicode</strong>, version <strong>8.6</strong>, is a colour vt102 terminal
-emulator intended as an <i>xterm</i>(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>
-
-</div>
-<h1 id="FREQUENTLY_ASKED_QUESTIONS">FREQUENTLY ASKED QUESTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="FREQUENTLY_ASKED_QUESTIONS_CONTENT">
-<p>See rxvt(7) (try <code>man 7 rxvt</code>) for a list of
-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/rxvt-unicode/doc/rxvt.7.html">http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html</a>.</p>
-
-</div>
-<h1 id="RXVT_UNICODE_VS_RXVT">RXVT-UNICODE VS. RXVT</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="RXVT_UNICODE_VS_RXVT_CONTENT">
-<p>Unlike the original rxvt, <strong>rxvt-unicode</strong> stores all text in Unicode
-internally. That means it can store and display most scripts in the
-world. Being a terminal emulator, however, some things are very difficult,
-especially cursive scripts such as arabic, vertically written scripts
-like mongolian or scripts requiring extremely complex combining rules,
-like tibetan or devanagari. Don't expect pretty output when using these
-scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
-fine, though. A somewhat difficult case are right-to-left scripts, such
-as hebrew: <strong>rxvt-unicode</strong> adopts the view that bidirectional algorithms
-belong into the application, not the terminal emulator (too many things --
-such as cursor-movement while editing -- break otherwise), but that might
-change.</p>
-<p>If you are looking for a terminal that supports more exotic scripts, let
-me recommend <code>mlterm</code>, which is a very user friendly, lean and clean
-terminal emulator. In fact, the reason rxvt-unicode was born was solely
-because the author couldn't get <code>mlterm</code> to use one font for latin1 and
-another for japanese.</p>
-<p>Therefore another design rationale was the use of multiple fonts to
-display characters: The idea of a single unicode font which many other
-programs force onto its users never made sense to me: You should be able
-to choose any font for any script freely.</p>
-<p>Apart from that, rxvt-unicode is also much better internationalised than
-its predecessor, supports things such as XFT and ISO 14755 that are handy
-in i18n-environments, is faster, and has a lot bugs less than the original
-rxvt. This all in addition to dozens of other small improvements.</p>
-<p>It is still faithfully following the original rxvt idea of being lean
-and nice on resources: for example, you can still configure rxvt-unicode
-without most of its features to get a lean binary. It also comes with
-a client/daemon pair that lets you open any number of terminal windows
-from within a single process, which makes startup time very fast and
-drastically reduces memory usage. See rxvtd(1) (daemon) and
-rxvtc(1) (client).</p>
-<p>It also makes technical information about escape sequences (which have
-been extended) more accessible: see rxvt(7) for technical
-reference documentation (escape sequences etc.).</p>
-
-</div>
-<h1 id="OPTIONS">OPTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="OPTIONS_CONTENT">
-<p>The <strong>rxvt</strong> options (mostly a subset of <i>xterm</i>'s) are listed
-below. In keeping with the smaller-is-better philosophy, options may be
-eliminated or default values chosen at compile-time, so options and
-defaults listed may not accurately reflect the version installed on
-your system. `rxvt -h' gives a list of major compile-time options on
-the <i>Options</i> line. Option descriptions may be prefixed with which
-compile option each is dependent upon. e.g. `Compile <i>XIM</i>:' requires
-<i>XIM</i> on the <i>Options</i> line. Note: `rxvt -help' gives a list of all
-command-line options compiled into your version.</p>
-<p>Note that <strong>rxvt</strong> permits the resource name to be used as a
-long-option (--/++ option) so the potential command-line options are
-far greater than those listed. For example: `rxvt --loginShell --color1
-Orange'.</p>
-<p>The following options are available:</p>
-<dl>
- <dt><strong>-help</strong>, <strong>--help</strong></dt>
- <dd>
- <p>Print out a message describing available options.</p>
- </dd>
- <dt><strong>-display</strong> <i>displayname</i></dt>
- <dd>
- <p>Attempt to open a window on the named X display (<strong>-d</strong> still
-respected). In the absence of this option, the display specified by the
-<strong>DISPLAY</strong> environment variable is used.</p>
- </dd>
- <dt><strong>-depth</strong> <i>bitdepth</i></dt>
- <dd>
- <p>Compile <i>xft</i>: Attempt to find a visual with the given bit depth;
-resource <strong>depth</strong>.</p>
- </dd>
- <dt><strong>-geometry</strong> <i>geom</i></dt>
- <dd>
- <p>Window geometry (<strong>-g</strong> still respected); resource <strong>geometry</strong>.</p>
- </dd>
- <dt><strong>-rv</strong>|<strong>+rv</strong></dt>
- <dd>
- <p>Turn on/off simulated reverse video; resource <strong>reverseVideo</strong>.</p>
- </dd>
- <dt><strong>-j</strong>|<strong>+j</strong></dt>
- <dd>
- <p>Turn on/off jump scrolling (allow multiple lines per refresh); resource <strong>jumpScroll</strong>.</p>
- </dd>
- <dt><strong>-ss</strong>|<strong>+ss</strong></dt>
- <dd>
- <p>Turn on/off skip scrolling (allow multiple screens per refresh); resource <strong>skipScroll</strong>.</p>
- </dd>
- <dt><strong>-tr</strong>|<strong>+tr</strong></dt>
- <dd>
- <p>Turn on/off illusion of a transparent window background. Obsolete form of it is
-<strong>-ip</strong> and it should not be used anymore; resource <strong>transparent</strong>.</p>
- <p><i>Please note that old resource name of <strong>inheritPixmap</strong> is obsolete and should be
-changed to <strong>transparent</strong>. Backwards compatibility support for <strong>inheritPixmap</strong> will
-be phased out in future versions of rxvt!</i></p>
- <p><i>Please address all transparency related issues to Sasha Vasko at
-sasha@aftercode.net. Read the FAQ (man 7 rxvt)!</i></p>
- </dd>
- <dt><strong>-fade</strong> <i>number</i></dt>
- <dd>
- <p>Fade the text by the given percentage when focus is lost. Small values
-fade a little only, 100 completely replaces all colours by the fade
-colour; resource <strong>fading</strong>.</p>
- </dd>
- <dt><strong>-fadecolor</strong> <i>colour</i></dt>
- <dd>
- <p>Fade to this colour when fading is used (see <strong>-fade</strong>). The default colour
-is opaque black. resource <strong>fadeColor</strong>.</p>
- </dd>
- <dt><strong>-tint</strong> <i>colour</i></dt>
- <dd>
- <p>Tint the transparent background pixmap with the given colour when
-transparency is enabled with <strong>-tr</strong>. This only works for
-non-tiled backgrounds, currently. See also the <strong>-sh</strong> option that can be
-used to brighten or darken the image in addition to tinting it.
-Please note that certain tint colours can be applied on the server-side,
-thus yielding performance gain of two orders of magnitude. These colours are:
-blue, red, green, cyan, magenta, yellow, and those close to them. Also
-pure black and pure white colors essentially mean no tinting; resource
-<i>tintColor</i>. Example:</p>
-<pre> rxvt -tr -tint blue -sh 40
-
-</pre>
- </dd>
- <dt><strong>-sh</strong> <i>number</i></dt>
- <dd>
- <p>Darken (0 .. 100) or lighten (100 .. 200) the transparent
-background image in addition to (or instead of) tinting it;
-resource <i>shading</i>.</p>
- </dd>
- <dt><strong>-blt</strong> <i>string</i></dt>
- <dd>
- <p>Specify background blending type. If background pixmap is specified
-at the same time as transparency - such pixmap will be blended over
-transparency image, using method specified. Supported values are :
-<strong>add</strong>, <strong>alphablend</strong>, <strong>allanon</strong> - color values averaging, <strong>colorize</strong>,
-<strong>darken</strong>, <strong>diff</strong>, <strong>dissipate</strong>, <strong>hue</strong>, <strong>lighten</strong>, <strong>overlay</strong>,
-<strong>saturate</strong>, <strong>screen</strong>, <strong>sub</strong>, <strong>tint</strong>, <strong>value</strong>. The default is
-alpha-blending. Compile <i>afterimage</i>; resource <i>blendType</i>.</p>
- </dd>
- <dt><strong>-blr</strong> <i>HxV</i></dt>
- <dd>
- <p>Apply Gaussian Blur with the specified radii to the transparent
-background image. If single number is specified - both vertical and
-horizontal radii are considered to be the same. Setting one of the
-radii to 1 and another to a large number creates interesting effects
-on some backgrounds. Maximum radius value is 128. Compile <i>afterimage</i>;
-resource <i>blurRadius</i>.</p>
- </dd>
- <dt><strong>-bg</strong> <i>colour</i></dt>
- <dd>
- <p>Window background colour; resource <strong>background</strong>.</p>
- </dd>
- <dt><strong>-fg</strong> <i>colour</i></dt>
- <dd>
- <p>Window foreground colour; resource <strong>foreground</strong>.</p>
- </dd>
- <dt><strong>-pixmap</strong> <i>file[;geom[:op1][:op2][...]]</i></dt>
- <dd>
- <p>Compile <i>afterimage</i>: Specify image file for the background and also
-optionally specify its scaling with a geometry string. Note you may need to
-add quotes to avoid special shell interpretation of the <code>;</code> in the
-command-line; for more details see resource <strong>backgroundPixmap</strong>.</p>
- </dd>
- <dt><strong>-cr</strong> <i>colour</i></dt>
- <dd>
- <p>The cursor colour; resource <strong>cursorColor</strong>.</p>
- </dd>
- <dt><strong>-pr</strong> <i>colour</i></dt>
- <dd>
- <p>The mouse pointer foreground colour; resource <strong>pointerColor</strong>.</p>
- </dd>
- <dt><strong>-pr2</strong> <i>colour</i></dt>
- <dd>
- <p>The mouse pointer background colour; resource <strong>pointerColor2</strong>.</p>
- </dd>
- <dt><strong>-bd</strong> <i>colour</i></dt>
- <dd>
- <p>The colour of the border around the text area and between the scrollbar and the text;
-resource <strong>borderColor</strong>.</p>
- </dd>
- <dt><strong>-fn</strong> <i>fontlist</i></dt>
- <dd>
- <p>Select the fonts to be used. This is a comma separated list of font names
-that are checked in order when trying to find glyphs for characters. The
-first font defines the cell size for characters; other fonts might be
-smaller, but not (in general) larger. A (hopefully) reasonable default
-font list is always appended to it. See resource <strong>font</strong> for more details.</p>
- <p>In short, to specify an X11 core font, just specify its name or prefix it
-with <code>x:</code>. To specify an XFT-font, you need to prefix it with <code>xft:</code>,
-e.g.:</p>
-<pre> rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
- rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
-
-</pre>
- <p>See also the question "How does rxvt-unicode choose fonts?" in the FAQ
-section of rxvt(7).</p>
- </dd>
- <dt><strong>-fb</strong> <i>fontlist</i></dt>
- <dd>
- <p>Compile <i>font-styles</i>: The bold font list to use when <strong>bold</strong> characters
-are to be printed. See resource <strong>boldFont</strong> for details.</p>
- </dd>
- <dt><strong>-fi</strong> <i>fontlist</i></dt>
- <dd>
- <p>Compile <i>font-styles</i>: The italic font list to use when <i>italic</i>
-characters are to be printed. See resource <strong>italicFont</strong> for details.</p>
- </dd>
- <dt><strong>-fbi</strong> <i>fontlist</i></dt>
- <dd>
- <p>Compile <i>font-styles</i>: The bold italic font list to use when <strong><i>bold
-italic</i></strong> characters are to be printed. See resource <strong>boldItalicFont</strong>
-for details.</p>
- </dd>
- <dt><strong>-is</strong>|<strong>+is</strong></dt>
- <dd>
- <p>Compile <i>font-styles</i>: Bold/Italic font styles imply high intensity
-foreground/background (default). See resource <strong>intensityStyles</strong> for
-details.</p>
- </dd>
- <dt><strong>-name</strong> <i>name</i></dt>
- <dd>
- <p>Specify the application name under which resources are to be obtained,
-rather than the default executable file name. Name should not contain
-`.' or `*' characters. Also sets the icon and title name.</p>
- </dd>
- <dt><strong>-ls</strong>|<strong>+ls</strong></dt>
- <dd>
- <p>Start as a login-shell/sub-shell; resource <strong>loginShell</strong>.</p>
- </dd>
- <dt><strong>-ut</strong>|<strong>+ut</strong></dt>
- <dd>
- <p>Compile <i>utmp</i>: Inhibit/enable writing a utmp entry; resource
-<strong>utmpInhibit</strong>.</p>
- </dd>
- <dt><strong>-vb</strong>|<strong>+vb</strong></dt>
- <dd>
- <p>Turn on/off visual bell on receipt of a bell character; resource
-<strong>visualBell</strong>.</p>
- </dd>
- <dt><strong>-sb</strong>|<strong>+sb</strong></dt>
- <dd>
- <p>Turn on/off scrollbar; resource <strong>scrollBar</strong>.</p>
- </dd>
- <dt><strong>-si</strong>|<strong>+si</strong></dt>
- <dd>
- <p>Turn on/off scroll-to-bottom on TTY output inhibit; resource
-<strong>scrollTtyOutput</strong> has opposite effect.</p>
- </dd>
- <dt><strong>-sk</strong>|<strong>+sk</strong></dt>
- <dd>
- <p>Turn on/off scroll-to-bottom on keypress; resource
-<strong>scrollTtyKeypress</strong>.</p>
- </dd>
- <dt><strong>-sw</strong>|<strong>+sw</strong></dt>
- <dd>
- <p>Turn on/off scrolling with the scrollback buffer as new lines appear.
-This only takes effect if <strong>-si</strong> is also given; resource
-<strong>scrollWithBuffer</strong>.</p>
- </dd>
- <dt><strong>-sr</strong>|<strong>+sr</strong></dt>
- <dd>
- <p>Put scrollbar on right/left; resource <strong>scrollBar_right</strong>.</p>
- </dd>
- <dt><strong>-st</strong>|<strong>+st</strong></dt>
- <dd>
- <p>Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
-resource <strong>scrollBar_floating</strong>.</p>
- </dd>
- <dt><strong>-ptab</strong>|<strong>+ptab</strong></dt>
- <dd>
- <p>If enabled (default), "Horizontal Tab" characters are being stored as
-actual wide characters in the screen buffer, which makes it possible to
-select and paste them. Since a horizontal tab is a cursor movement and
-not an actual glyph, this can sometimes be visually annoying as the cursor
-on a tab character is displayed as a wide cursor; resource <strong>pastableTabs</strong>.</p>
- </dd>
- <dt><strong>-bc</strong>|<strong>+bc</strong></dt>
- <dd>
- <p>Blink the cursor; resource <strong>cursorBlink</strong>.</p>
- </dd>
- <dt><strong>-iconic</strong></dt>
- <dd>
- <p>Start iconified, if the window manager supports that option.
-Alternative form is <strong>-ic</strong>.</p>
- </dd>
- <dt><strong>-sl</strong> <i>number</i></dt>
- <dd>
- <p>Save <i>number</i> lines in the scrollback buffer. See resource entry for
-limits; resource <strong>saveLines</strong>.</p>
- </dd>
- <dt><strong>-b</strong> <i>number</i></dt>
- <dd>
- <p>Compile <i>frills</i>: Internal border of <i>number</i> pixels. See resource
-entry for limits; resource <strong>internalBorder</strong>.</p>
- </dd>
- <dt><strong>-w</strong> <i>number</i></dt>
- <dd>
- <p>Compile <i>frills</i>: External border of <i>number</i> pixels. Also, <strong>-bw</strong>
-and <strong>-borderwidth</strong>. See resource entry for limits; resource
-<strong>externalBorder</strong>.</p>
- </dd>
- <dt><strong>-bl</strong></dt>
- <dd>
- <p>Compile <i>frills</i>: Set MWM hints to request a borderless window, i.e.
-if honoured by the WM, the rxvt-unicode window will not have window
-decorations; resource <strong>borderLess</strong>.</p>
- </dd>
- <dt><strong>-override-redirect</strong></dt>
- <dd>
- <p>Compile <i>frills</i>: Sets override-redirect on the window; resource
-<strong>override-redirect</strong>.</p>
- </dd>
- <dt><strong>-sbg</strong></dt>
- <dd>
- <p>Compile <i>frills</i>: Disable the usage of the built-in block graphics/line
-drawing characters and just rely on what the specified fonts provide. Use
-this if you have a good font and want to use its block graphic glyphs;
-resource <strong>skipBuiltinGlyphs</strong>.</p>
- </dd>
- <dt><strong>-lsp</strong> <i>number</i></dt>
- <dd>
- <p>Compile <i>frills</i>: Lines (pixel height) to insert between each row of
-the display. Useful to work around font rendering problems; resource
-<strong>lineSpace</strong>.</p>
- </dd>
- <dt><strong>-tn</strong> <i>termname</i></dt>
- <dd>
- <p>This option specifies the name of the terminal type to be set in the
-<strong>TERM</strong> environment variable. This terminal type must exist in the
-<i>termcap(5)</i> database and should have <i>li#</i> and <i>co#</i> entries;
-resource <strong>termName</strong>.</p>
- </dd>
- <dt><strong>-e</strong> <i>command [arguments]</i></dt>
- <dd>
- <p>Run the command with its command-line arguments in the <strong>rxvt</strong>
-window; also sets the window title and icon name to be the basename of
-the program being executed if neither <i>-title</i> (<i>-T</i>) nor <i>-n</i> are
-given on the command line. If this option is used, it must be the last
-on the command-line. If there is no <strong>-e</strong> option then the default is to
-run the program specified by the <strong>SHELL</strong> environment variable or,
-failing that, <i>sh(1)</i>.</p>
- <p>Please note that you must specify a program with arguments. If you want to
-run shell commands, you have to specify the shell, like this:</p>
-<pre> rxvt -e sh -c "shell commands"
-
-</pre>
- </dd>
- <dt><strong>-title</strong> <i>text</i></dt>
- <dd>
- <p>Window title (<strong>-T</strong> still respected); the default title is the basename
-of the program specified after the <strong>-e</strong> option, if any, otherwise the
-application name; resource <strong>title</strong>.</p>
- </dd>
- <dt><strong>-n</strong> <i>text</i></dt>
- <dd>
- <p>Icon name; the default name is the basename of the program specified
-after the <strong>-e</strong> option, if any, otherwise the application name;
-resource <strong>iconName</strong>.</p>
- </dd>
- <dt><strong>-C</strong></dt>
- <dd>
- <p>Capture system console messages.</p>
- </dd>
- <dt><strong>-pt</strong> <i>style</i></dt>
- <dd>
- <p>Compile <i>XIM</i>: input style for input method; <strong>OverTheSpot</strong>,
-<strong>OffTheSpot</strong>, <strong>Root</strong>; resource <strong>preeditType</strong>.</p>
- </dd>
- <dt><strong>-im</strong> <i>text</i></dt>
- <dd>
- <p>Compile <i>XIM</i>: input method name. resource <strong>inputMethod</strong>.</p>
- </dd>
- <dt><strong>-imlocale</strong> <i>string</i></dt>
- <dd>
- <p>The locale to use for opening the IM. You can use an <code>LC_CTYPE</code> of e.g.
-<code>de_DE.UTF-8</code> for normal text processing but <code>ja_JP.EUC-JP</code> for the
-input extension to be able to input japanese characters while staying in
-another locale. resource <strong>imLocale</strong>.</p>
- </dd>
- <dt><strong>-imfont</strong> <i>fontset</i></dt>
- <dd>
- <p>Set the font set to use for the X Input Method, see resource <strong>imFont</strong>
-for more info.</p>
- </dd>
- <dt><strong>-tcw</strong></dt>
- <dd>
- <p>Change the meaning of triple-click selection with the left mouse
-button. Only effective when the original (non-perl) selection code is
-in-use. Instead of selecting a full line it will extend the selection the
-end of the logical line only. resource <strong>tripleclickwords</strong>.</p>
- </dd>
- <dt><strong>-insecure</strong></dt>
- <dd>
- <p>Enable "insecure" mode, which currently enables most of the escape
-sequences that echo strings. See the resource <strong>insecure</strong> for more
-info.</p>
- </dd>
- <dt><strong>-mod</strong> <i>modifier</i></dt>
- <dd>
- <p>Override detection of Meta modifier with specified key: <strong>alt</strong>,
-<strong>meta</strong>, <strong>hyper</strong>, <strong>super</strong>, <strong>mod1</strong>, <strong>mod2</strong>, <strong>mod3</strong>, <strong>mod4</strong>,
-<strong>mod5</strong>; resource <i>modifier</i>.</p>
- </dd>
- <dt><strong>-ssc</strong>|<strong>+ssc</strong></dt>
- <dd>
- <p>Turn on/off secondary screen (default enabled); resource
-<strong>secondaryScreen</strong>.</p>
- </dd>
- <dt><strong>-ssr</strong>|<strong>+ssr</strong></dt>
- <dd>
- <p>Turn on/off secondary screen scroll (default enabled); resource
-<strong>secondaryScroll</strong>.</p>
- </dd>
- <dt><strong>-hold</strong>|<strong>+hold</strong></dt>
- <dd>
- <p>Turn on/off hold window after exit support. If enabled, rxvt
-will not immediately destroy its window when the program executed within
-it exits. Instead, it will wait till it is being killed or closed by the
-user; resource <strong>hold</strong>.</p>
- </dd>
- <dt><strong>-xrm</strong> <i>string</i></dt>
- <dd>
- <p>Works like the X Toolkit option of the same name, by adding the <i>string</i>
-as if it were specified in a resource file. Resource values specified this
-way take precedence over all other resource specifications.</p>
- <p>Note that you need to use the <i>same</i> syntax as in the .Xdefaults file,
-e.g. <code>*.background: black</code>. Also note that all rxvt-specific
-options can be specified as long-options on the commandline, so use
-of <strong>-xrm</strong> is mostly limited to cases where you want to specify other
-resources (e.g. for input methods) or for compatibility with other
-programs.</p>
- </dd>
- <dt><strong>-keysym.</strong><i>sym</i> <i>string</i></dt>
- <dd>
- <p>Remap a key symbol. See resource <strong>keysym</strong>.</p>
- </dd>
- <dt><strong>-embed</strong> <i>windowid</i></dt>
- <dd>
- <p>Tells rxvt to embed its windows into an already-existing window,
-which enables applications to easily embed a terminal.</p>
- <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>
- <p>The window will not be destroyed when rxvt exits.</p>
- <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 whether the <code>-embed</code> option was used or
-not.</p>
- <p>Here is a short Gtk2-perl snippet that illustrates how this option can be
-used (a longer example is in <cite>doc/embed</cite>):</p>
-<pre> my $rxvt = new Gtk2::Socket;
- $rxvt->signal_connect_after (realize => sub {
- my $xid = $_[0]->window->get_xid;
- system "rxvt -embed $xid &";
- });
-
-</pre>
- </dd>
- <dt><strong>-pty-fd</strong> <i>file descriptor</i></dt>
- <dd>
- <p>Tells rxvt NOT to execute any commands or create a new pty/tty
-pair but instead use the given file descriptor 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.</p>
- <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>
- <p>As an extremely special case, specifying <code>-1</code> will completely suppress
-pty/tty operations.</p>
- <p>Here is a example in perl that illustrates how this option can be used (a
-longer example is in <cite>doc/pty-fd</cite>):</p>
-<pre> use IO::Pty;
- use Fcntl;
-
- my $pty = new IO::Pty;
- fcntl $pty, F_SETFD, 0; # clear close-on-exec
- system "rxvt -pty-fd " . (fileno $pty) . "&";
- close $pty;
-
- # now communicate with rxvt
- my $slave = $pty->slave;
- while (<$slave>) { print $slave "got <$_>\n" }
-
-</pre>
- </dd>
- <dt><strong>-pe</strong> <i>string</i></dt>
- <dd>
- <p>Comma-separated list of perl extension scripts to use (or not to use) in
-this terminal instance. See resource <strong>perl-ext</strong> for details.</p>
- </dd>
-</dl>
-
-</div>
-<h1 id="RESOURCES_available_also_as_long_opt">RESOURCES (available also as long-options)</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="RESOURCES_available_also_as_long_opt-2">
-<p>Note: `rxvt --help' gives a list of all resources (long
-options) compiled into your version.</p>
-<p>You can set and change the resources using X11 tools like <strong>xrdb</strong>. Many
-distribution do also load 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-<nodename>
- 6. resources specified via -xrm on the commandline
-
-</pre>
-<p>Note that when reading X resources, <strong>rxvt</strong> recognizes two class
-names: <strong>Rxvt</strong> and <strong>URxvt</strong>. The class name <strong>Rxvt</strong> allows resources
-common to both <strong>rxvt</strong> and the original <i>rxvt</i> to be easily
-configured, while the class name <strong>URxvt</strong> allows resources unique to
-<strong>rxvt</strong>, to be shared between different <strong>rxvt</strong>
-configurations. If no resources are specified, suitable defaults will
-be used. Command-line arguments can be used to override resource
-settings. The following resources are supported (you might want to
-check the rxvtperl(3) manpage for additional settings by perl
-extensions not documented here):</p>
-<dl>
- <dt><strong>depth:</strong> <i>bitdepth</i></dt>
- <dd>
- <p>Compile <i>xft</i>: Attempt to find a visual with the given bit depth;
-option <strong>-depth</strong>.</p>
- </dd>
- <dt><strong>geometry:</strong> <i>geom</i></dt>
- <dd>
- <p>Create the window with the specified X window geometry [default 80x24];
-option <strong>-geometry</strong>.</p>
- </dd>
- <dt><strong>background:</strong> <i>colour</i></dt>
- <dd>
- <p>Use the specified colour as the window's background colour [default
-White]; option <strong>-bg</strong>.</p>
- </dd>
- <dt><strong>foreground:</strong> <i>colour</i></dt>
- <dd>
- <p>Use the specified colour as the window's foreground colour [default
-Black]; option <strong>-fg</strong>.</p>
- </dd>
- <dt><strong>color</strong><i>n</i><strong>:</strong> <i>colour</i></dt>
- <dd>
- <p>Use the specified colour for the colour value <i>n</i>, where 0-7
-corresponds to low-intensity (normal) colours and 8-15 corresponds to
-high-intensity (bold = bright foreground, blink = bright background)
-colours. The canonical names are as follows: 0=black, 1=red, 2=green,
-3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
-names used are listed in the <strong>COLORS AND GRAPHICS</strong> section.</p>
- <p>Colours higher than 15 cannot be set using resources (yet), but can be
-changed using an escape command (see rxvt(7)).</p>
- <p>Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
-88 colour support). Colours 80-87 are evenly spaces grey steps.</p>
- </dd>
- <dt><strong>colorBD:</strong> <i>colour</i></dt>
- <dt><strong>colorIT:</strong> <i>colour</i></dt>
- <dd>
- <p>Use the specified colour to display bold or italic characters when the
-foreground colour is the default. If font styles are not available
-(Compile <i>styles</i>) and this option is unset, reverse video is used instead.</p>
- </dd>
- <dt><strong>colorUL:</strong> <i>colour</i></dt>
- <dd>
- <p>Use the specified colour to display underlined characters when the
-foreground colour is the default.</p>
- </dd>
- <dt><strong>colorRV:</strong> <i>colour</i></dt>
- <dd>
- <p>Use the specified colour as the background for reverse video characters
-when OPTION_HC is disabled (--disable-frills).</p>
- </dd>
- <dt><strong>underlineColor:</strong> <i>colour</i></dt>
- <dd>
- <p>If set, use the specified colour as the colour for the underline
-itself. If unset, use the foreground colour.</p>
- </dd>
- <dt><strong>cursorColor:</strong> <i>colour</i></dt>
- <dd>
- <p>Use the specified colour for the cursor. The default is to use the
-foreground colour; option <strong>-cr</strong>.</p>
- </dd>
- <dt><strong>cursorColor2:</strong> <i>colour</i></dt>
- <dd>
- <p>Use the specified colour for the colour of the cursor text. For this to
-take effect, <strong>cursorColor</strong> must also be specified. The default is to
-use the background colour.</p>
- </dd>
- <dt><strong>reverseVideo:</strong> <i>boolean</i></dt>
- <dd>
- <p><strong>True</strong>: simulate reverse video by foreground and background colours;
-option <strong>-rv</strong>. <strong>False</strong>: regular screen colours [default]; option
-<strong>+rv</strong>. See note in <strong>COLORS AND GRAPHICS</strong> section.</p>
- </dd>
- <dt><strong>jumpScroll:</strong> <i>boolean</i></dt>
- <dd>
- <p><strong>True</strong>: specify that jump scrolling should be used. When receiving lots
-of lines, rxvt will only scroll once a whole screen height of lines
-has been read, resulting in fewer updates while still displaying every
-received line; option <strong>-j</strong>.</p>
- <p><strong>False</strong>: specify that smooth scrolling should be used. rxvt will
-force a screen refresh on each new line it received; option <strong>+j</strong>.</p>
- </dd>
- <dt><strong>skipScroll:</strong> <i>boolean</i></dt>
- <dd>
- <p><strong>True</strong>: (the default) specify that skip scrolling should be used. When
-receiving lots of lines, rxvt will only scroll once in a while
-(around 60 times per second), resulting in far fewer updates. This can
-result in rxvt not ever displaying some of the lines it receives;
-option <strong>-ss</strong>.</p>
- <p><strong>False</strong>: specify that everything is to be displayed, even
-if the refresh is too fast for the human eye to read anything (or the
-monitor to display anything); option <strong>+ss</strong>.</p>
- </dd>
- <dt><strong>inheritPixmap:</strong> <i>boolean</i></dt>
- <dd>
- <p><strong>True</strong>: make the background inherit the parent windows' pixmap, giving
-artificial transparency. <strong>False</strong>: do not inherit the parent windows'
-pixmap.</p>
- <p><i>Please note that transparency of any kind if completely unsupported by
-the author. Don't bug him with installation questions!</i></p>
- </dd>
- <dt><strong>fading:</strong> <i>number</i></dt>
- <dd>
- <p>Fade the text by the given percentage when focus is lost; option <strong>-fade</strong>.</p>
- </dd>
- <dt><strong>fadeColor:</strong> <i>colour</i></dt>
- <dd>
- <p>Fade to this colour, when fading is used (see <strong>fading:</strong>). The default
-colour is black; option <strong>-fadecolor</strong>.</p>
- </dd>
- <dt><strong>tintColor:</strong> <i>colour</i></dt>
- <dd>
- <p>Tint the transparent background pixmap with the given colour; option
-<strong>-tint</strong>.</p>
- </dd>
- <dt><strong>shading:</strong> <i>number</i></dt>
- <dd>
- <p>Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
-in addition to tinting it; option <strong>-sh</strong>.</p>
- </dd>
- <dt><strong>blendType:</strong> <i>string</i></dt>
- <dd>
- <p>Specify background blending type; option <strong>-blt</strong>.</p>
- </dd>
- <dt><strong>blurRadius:</strong> <i>number</i></dt>
- <dd>
- <p>Apply Gaussian Blurr with the specified radius to the transparent
-background image; option <strong>-blr</strong>.</p>
- </dd>
- <dt><strong>scrollColor:</strong> <i>colour</i></dt>
- <dd>
- <p>Use the specified colour for the scrollbar [default #B2B2B2].</p>
- </dd>
- <dt><strong>troughColor:</strong> <i>colour</i></dt>
- <dd>
- <p>Use the specified colour for the scrollbar's trough area [default
-#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.</p>
- </dd>
- <dt><strong>borderColor:</strong> <i>colour</i></dt>
- <dd>
- <p>The colour of the border around the text area and between the scrollbar
-and the text.</p>
- </dd>
- <dt><strong>backgroundPixmap:</strong> <i>file[;geom[:op1][:op2][...]]</i></dt>
- <dd>
- <p>Use the specified image file for the background and also
-optionally specify its scaling with a geometry string <strong>WxH+X+Y</strong>,
-(default <code>0x0+50+50</code>) in which <strong>"W" / "H"</strong> specify the
-horizontal/vertical scale (percent), and <strong>"X" / "Y"</strong> locate the image
-centre (percent). A scale of 0 displays the image with tiling. A scale
-of 1 displays the image without any scaling. A scale of 2 to 9 specifies
-an integer number of images in that direction. No image will be magnified
-beyond 10 times its original size. The maximum permitted scale is 1000.
-Additional operations can be specified after colon <strong>:op1:op2...</strong>.
-Supported operations are:</p>
-<pre> tile force background image to be tiled and not scaled. Equivalent to 0x0,
- propscale will scale image keeping proportions,
- auto will scale image to match window size. Equivalent to 100x100;
- hscale will scale image horizontally to the window size;
- vscale will scale image vertically to the window size;
- scale will scale image to match window size;
- root will tile image as if it was a root window background, auto-adjusting
- whenever terminal window moves.
-
-</pre>
- <p>If used in conjunction with <strong>-tr</strong> option, the specified pixmap will be
-blended over transparency image using either alpha-blending, or any
-other blending type, specified with <strong>-blt "type"</strong> option.</p>
- </dd>
- <dt><strong>path:</strong> <i>path</i></dt>
- <dd>
- <p>Specify the colon-delimited search path for finding background image files.</p>
- </dd>
- <dt><strong>font:</strong> <i>fontlist</i></dt>
- <dd>
- <p>Select the fonts to be used. This is a comma separated list of font names
-that are checked in order when trying to find glyphs for characters. The
-first font defines the cell size for characters; other fonts might be
-smaller, but not (in general) larger. A (hopefully) reasonable default
-font list is always appended to it; option <strong>-fn</strong>.</p>
- <p>Each font can either be a standard X11 core font (XLFD) name, with
-optional prefix <code>x:</code> or a Xft font (Compile <i>xft</i>), prefixed with <code>xft:</code>.</p>
- <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
-fonts.</p>
- <p>For example, this font resource</p>
-<pre> URxvt.font: 9x15bold,\
- -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
- -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
- [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
- xft:Code2000:antialias=false
-
-</pre>
- <p>specifies five fonts to be used. The first one is <code>9x15bold</code> (actually
-the iso8859-1 version of the second font), which is the base font (because
-it is named first) and thus defines the character cell grid to be 9 pixels
-wide and 15 pixels high.</p>
- <p>The second font is just used to add additional unicode characters not in
-the base font, likewise the third, which is unfortunately non-bold, but
-the bold version of the font does contain less characters, so this is a
-useful supplement.</p>
- <p>The third font is an Xft font with aliasing turned off, and the characters
-are limited to the <strong>JIS 0208</strong> codeset (i.e. japanese kanji). The font
-contains other characters, but we are not interested in them.</p>
- <p>The last font is a useful catch-all font that supplies most of the
-remaining unicode characters.</p>
- </dd>
- <dt><strong>boldFont:</strong> <i>fontlist</i></dt>
- <dt><strong>italicFont:</strong> <i>fontlist</i></dt>
- <dt><strong>boldItalicFont:</strong> <i>fontlist</i></dt>
- <dd>
- <p>The font list to use for displaying <strong>bold</strong>, <i>italic</i> or <strong><i>bold
-italic</i></strong> characters, respectively.</p>
- <p>If specified and non-empty, then the syntax is the same as for the
-<strong>font</strong>-resource, and the given font list will be used as is, which makes
-it possible to substitute completely different font styles for bold and
-italic.</p>
- <p>If unset (the default), a suitable font list will be synthesized by
-"morphing" the normal text font list into the desired shape. If that is
-not possible, replacement fonts of the desired shape will be tried.</p>
- <p>If set, but empty, then this specific style is disabled and the normal
-text font will being used for the given style.</p>
- </dd>
- <dt><strong>intensityStyles:</strong> <i>boolean</i></dt>
- <dd>
- <p>When font styles are not enabled, or this option is enabled (<strong>True</strong>,
-option <strong>-is</strong>, the default), bold and italic font styles imply high
-intensity foreground/background colours. Disabling this option (<strong>False</strong>,
-option <strong>+is</strong>) disables this behaviour, the high intensity colours are not
-reachable.</p>
- </dd>
- <dt><strong>selectstyle:</strong> <i>mode</i></dt>
- <dd>
- <p>Set mouse selection style to <strong>old</strong> which is 2.20, <strong>oldword</strong> which
-is xterm style with 2.20 old word selection, or anything else which
-gives xterm style selection. Only effective when the original (non-perl)
-selection code is in use.</p>
- </dd>
- <dt><strong>scrollstyle:</strong> <i>mode</i></dt>
- <dd>
- <p>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.</p>
- </dd>
- <dt><strong>title:</strong> <i>string</i></dt>
- <dd>
- <p>Set window title string, the default title is the command-line
-specified after the <strong>-e</strong> option, if any, otherwise the application
-name; option <strong>-title</strong>.</p>
- </dd>
- <dt><strong>iconName:</strong> <i>string</i></dt>
- <dd>
- <p>Set the name used to label the window's icon or displayed in an icon
-manager window, it also sets the window's title unless it is explicitly
-set; option <strong>-n</strong>.</p>
- </dd>
- <dt><strong>mapAlert:</strong> <i>boolean</i></dt>
- <dd>
- <p><strong>True</strong>: de-iconify (map) on receipt of a bell character. <strong>False</strong>: no
-de-iconify (map) on receipt of a bell character [default].</p>
- </dd>
- <dt><strong>urgentOnBell:</strong> <i>boolean</i></dt>
- <dd>
- <p><strong>True</strong>: set the urgency hint for the wm on receipt of a bell character.
-<strong>False</strong>: do not set the urgency hint [default].</p>
- </dd>
- <dt><strong>visualBell:</strong> <i>boolean</i></dt>
- <dd>
- <p><strong>True</strong>: use visual bell on receipt of a bell character; option <strong>-vb</strong>.
-<strong>False</strong>: no visual bell [default]; option <strong>+vb</strong>.</p>
- </dd>
- <dt><strong>loginShell:</strong> <i>boolean</i></dt>
- <dd>
- <p><strong>True</strong>: start as a login shell by prepending a `-' to <strong>argv[0]</strong> of
-the shell; option <strong>-ls</strong>. <strong>False</strong>: start as a normal sub-shell
-[default]; option <strong>+ls</strong>.</p>
- </dd>
- <dt><strong>utmpInhibit:</strong> <i>boolean</i></dt>
- <dd>
- <p><strong>True</strong>: inhibit writing record into the system log file <strong>utmp</strong>;
-option <strong>-ut</strong>. <strong>False</strong>: write record into the system log file <strong>utmp</strong>
-[default]; option <strong>+ut</strong>.</p>
- </dd>
- <dt><strong>print-pipe:</strong> <i>string</i></dt>
- <dd>
- <p>Specify a command pipe for vt100 printer [default <i>lpr(1)</i>]. 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.</p>
- <p>The string will be interpreted as if typed into the shell as-is.</p>
- <p>Example:</p>
-<pre> URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
-
-</pre>
- <p>This creates a new file in your home directory with the screen contents
-every time you hit <code>Print</code>.</p>
- </dd>
- <dt><strong>scrollBar:</strong> <i>boolean</i></dt>
- <dd>
- <p><strong>True</strong>: enable the scrollbar [default]; option <strong>-sb</strong>. <strong>False</strong>:
-disable the scrollbar; option <strong>+sb</strong>.</p>
- </dd>
- <dt><strong>scrollBar_right:</strong> <i>boolean</i></dt>
- <dd>
- <p><strong>True</strong>: place the scrollbar on the right of the window; option <strong>-sr</strong>.
-<strong>False</strong>: place the scrollbar on the left of the window; option <strong>+sr</strong>.</p>
- </dd>
- <dt><strong>scrollBar_floating:</strong> <i>boolean</i></dt>
- <dd>
- <p><strong>True</strong>: display an rxvt scrollbar without a trough; option <strong>-st</strong>.
-<strong>False</strong>: display an rxvt scrollbar with a trough; option <strong>+st</strong>.</p>
- </dd>
- <dt><strong>scrollBar_align:</strong> <i>mode</i></dt>
- <dd>
- <p>Align the <strong>top</strong>, <strong>bottom</strong> or <strong>centre</strong> [default] of the scrollbar
-thumb with the pointer on middle button press/drag.</p>
- </dd>
- <dt><strong>scrollTtyOutput:</strong> <i>boolean</i></dt>
- <dd>
- <p><strong>True</strong>: scroll to bottom when tty receives output; option <strong>-si</strong>.
-<strong>False</strong>: do not scroll to bottom when tty receives output; option
-<strong>+si</strong>.</p>
- </dd>
- <dt><strong>scrollWithBuffer:</strong> <i>boolean</i></dt>
- <dd>
- <p><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
-with scrollback buffer when tty receives new lines; option <strong>+sw</strong>.</p>
- </dd>
- <dt><strong>scrollTtyKeypress:</strong> <i>boolean</i></dt>
- <dd>
- <p><strong>True</strong>: scroll to bottom when a non-special key is pressed. Special keys
-are those which are intercepted by rxvt-unicode for special handling and
-are not passed onto the shell; option <strong>-sk</strong>. <strong>False</strong>: do not scroll to
-bottom when a non-special key is pressed; option <strong>+sk</strong>.</p>
- </dd>
- <dt><strong>saveLines:</strong> <i>number</i></dt>
- <dd>
- <p>Save <i>number</i> lines in the scrollback buffer [default 64]. This
-resource is limited on most machines to 65535; option <strong>-sl</strong>.</p>
- </dd>
- <dt><strong>internalBorder:</strong> <i>number</i></dt>
- <dd>
- <p>Internal border of <i>number</i> pixels. This resource is limited to 100;
-option <strong>-b</strong>.</p>
- </dd>
- <dt><strong>externalBorder:</strong> <i>number</i></dt>
- <dd>
- <p>External border of <i>number</i> pixels. This resource is limited to 100;
-option <strong>-w</strong>, <strong>-bw</strong>, <strong>-borderwidth</strong>.</p>
- </dd>
- <dt><strong>borderLess:</strong> <i>boolean</i></dt>
- <dd>
- <p>Set MWM hints to request a borderless window, i.e. if honoured by the
-WM, the rxvt-unicode window will not have window decorations; option <strong>-bl</strong>.</p>
- </dd>
- <dt><strong>skipBuiltinGlyphs:</strong> <i>boolean</i></dt>
- <dd>
- <p>Compile <i>frills</i>: Disable the usage of the built-in block graphics/line
-drawing characters and just rely on what the specified fonts provide. Use
-this if you have a good font and want to use its block graphic glyphs;
-option <strong>-sbg</strong>.</p>
- </dd>
- <dt><strong>termName:</strong> <i>termname</i></dt>
- <dd>
- <p>Specifies the terminal type name to be set in the <strong>TERM</strong> environment
-variable; option <strong>-tn</strong>.</p>
- </dd>
- <dt><strong>lineSpace:</strong> <i>number</i></dt>
- <dd>
- <p>Specifies number of lines (pixel height) to insert between each row of
-the display [default 0]; option <strong>-lsp</strong>.</p>
- </dd>
- <dt><strong>meta8:</strong> <i>boolean</i></dt>
- <dd>
- <p><strong>True</strong>: handle Meta (Alt) + keypress to set the 8th bit. <strong>False</strong>:
-handle Meta (Alt) + keypress as an escape prefix [default].</p>
- </dd>
- <dt><strong>mouseWheelScrollPage:</strong> <i>boolean</i></dt>
- <dd>
- <p><strong>True</strong>: the mouse wheel scrolls a page full. <strong>False</strong>: the mouse wheel
-scrolls five lines [default].</p>
- </dd>
- <dt><strong>pastableTabs:</strong> <i>boolean</i></dt>
- <dd>
- <p><strong>True</strong>: store tabs as wide characters. <strong>False</strong>: interpret tabs as cursor
-movement only; option <code>-ptab</code>.</p>
- </dd>
- <dt><strong>cursorBlink:</strong> <i>boolean</i></dt>
- <dd>
- <p><strong>True</strong>: blink the cursor. <strong>False</strong>: do not blink the cursor [default];
-option <strong>-bc</strong>.</p>
- </dd>
- <dt><strong>pointerBlank:</strong> <i>boolean</i></dt>
- <dd>
- <p><strong>True</strong>: blank the pointer when a key is pressed or after a set number
-of seconds of inactivity. <strong>False</strong>: the pointer is always visible
-[default].</p>
- </dd>
- <dt><strong>pointerColor:</strong> <i>colour</i></dt>
- <dd>
- <p>Mouse pointer foreground colour.</p>
- </dd>
- <dt><strong>pointerColor2:</strong> <i>colour</i></dt>
- <dd>
- <p>Mouse pointer background colour.</p>
- </dd>
- <dt><strong>pointerBlankDelay:</strong> <i>number</i></dt>
- <dd>
- <p>Specifies number of seconds before blanking the pointer [default 2]. Use a
-large number (e.g. <code>987654321</code>) to effectively disable the timeout.</p>
- </dd>
- <dt><strong>backspacekey:</strong> <i>string</i></dt>
- <dd>
- <p>The string to send when the backspace key is pressed. If set to <strong>DEC</strong>
-or unset it will send <strong>Delete</strong> (code 127) or, if shifted, <strong>Backspace</strong>
-(code 8) - which can be reversed with the appropriate DEC private mode
-escape sequence.</p>
- </dd>
- <dt><strong>deletekey:</strong> <i>string</i></dt>
- <dd>
- <p>The string to send when the delete key (not the keypad delete key) is
-pressed. If unset it will send the sequence traditionally associated
-with the <strong>Execute</strong> key.</p>
- </dd>
- <dt><strong>cutchars:</strong> <i>string</i></dt>
- <dd>
- <p>The characters used as delimiters for double-click word selection
-(whitespace delimiting is added automatically if resource is given).</p>
- <p>When the perl selection extension is in use (the default if compiled
-in, see the rxvtperl(3) manpage), a suitable regex using these
-characters will be created (if the resource exists, otherwise, no regex
-will be created). In this mode, characters outside ISO-8859-1 can be used.</p>
- <p>When the selection extension is not used, only ISO-8859-1 characters can
-be used. If not specified, the built-in default is used:</p>
- <p><strong>BACKSLASH `"'&()*,;<=>?@[]^{|}</strong></p>
- </dd>
- <dt><strong>preeditType:</strong> <i>style</i></dt>
- <dd>
- <p><strong>OverTheSpot</strong>, <strong>OffTheSpot</strong>, <strong>Root</strong>; option <strong>-pt</strong>.</p>
- </dd>
- <dt><strong>inputMethod:</strong> <i>name</i></dt>
- <dd>
- <p><i>name</i> of inputMethod to use; option <strong>-im</strong>.</p>
- </dd>
- <dt><strong>imLocale:</strong> <i>name</i></dt>
- <dd>
- <p>The locale to use for opening the IM. You can use an <code>LC_CTYPE</code> of e.g.
-<code>de_DE.UTF-8</code> for normal text processing but <code>ja_JP.EUC-JP</code> for the
-input extension to be able to input japanese characters while staying in
-another locale; option <strong>-imlocale</strong>.</p>
- </dd>
- <dt><strong>imFont:</strong> <i>fontset</i></dt>
- <dd>
- <p>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>.</p>
- </dd>
- <dt><strong>tripleclickwords:</strong> <i>boolean</i></dt>
- <dd>
- <p>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>.</p>
- </dd>
- <dt><strong>insecure:</strong> <i>boolean</i></dt>
- <dd>
- <p>Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
-echo arbitrary strings like the icon name or the locale. This could be
-abused if somebody gets 8-bit-clean access to your display, whether
-through a mail client displaying mail bodies unfiltered or through
-write(1) or any other means. Therefore, these sequences are disabled by
-default. (Note that many other terminals, including xterm, have these
-sequences enabled by default, which doesn't make it safer, though).</p>
- <p>You can enable them by setting this boolean resource or specifying
-<strong>-insecure</strong> as an option. At the moment, this enables display-answer,
-locale, findfont, icon label and window title requests.</p>
- </dd>
- <dt><strong>modifier:</strong> <i>modifier</i></dt>
- <dd>
- <p>Set the key to be interpreted as the Meta key to: <strong>alt</strong>, <strong>meta</strong>,
-<strong>hyper</strong>, <strong>super</strong>, <strong>mod1</strong>, <strong>mod2</strong>, <strong>mod3</strong>, <strong>mod4</strong>, <strong>mod5</strong>; option
-<strong>-mod</strong>.</p>
- </dd>
- <dt><strong>answerbackString:</strong> <i>string</i></dt>
- <dd>
- <p>Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
-character is passed through. It may contain escape values as described
-in the entry on <strong>keysym</strong> following.</p>
- </dd>
- <dt><strong>secondaryScreen:</strong> <i>boolean</i></dt>
- <dd>
- <p>Turn on/off secondary screen (default enabled).</p>
- </dd>
- <dt><strong>secondaryScroll:</strong> <i>boolean</i></dt>
- <dd>
- <p>Turn on/off secondary screen scroll (default enabled). If this
-option is enabled, scrolls on the secondary screen will change the
-scrollback buffer and switching to/from the secondary screen will
-instead scroll the screen up.</p>
- </dd>
- <dt><strong>hold</strong>: <i>boolean</i></dt>
- <dd>
- <p>Turn on/off hold window after exit support. If enabled, rxvt
-will not immediately destroy its window when the program executed within
-it exits. Instead, it will wait till it is being killed or closed by the
-user.</p>
- </dd>
- <dt><strong>keysym.</strong><i>sym</i>: <i>string</i></dt>
- <dd>
- <p>Compile <i>frills</i>: Associate <i>string</i> with keysym <i>sym</i>. The
-intervening resource name <strong>keysym.</strong> cannot be omitted.</p>
- <p>The format of <i>sym</i> is "<i>(modifiers-)key</i>", where <i>modifiers</i> 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>
- <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>
- <p>The spellings of <i>key</i> 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 <i>key</i> by its hex
-keysym value (<strong>0x0000 - 0xFFFF</strong>). Note that the lookup of <i>sym</i>s is not
-performed in an exact manner; however, the closest match is assured.</p>
- <p><i>string</i> may contain escape values (<code>\n</code>: newline, <code>\000</code>: octal
-number), see RESOURCES in <code>man 7 X</code> for futher details.</p>
- <p>You can define a range of keysyms in one shot by providing a <i>string</i>
-with pattern <strong>list/PREFIX/MIDDLE/SUFFIX</strong>, where the delimiter `/'
-should be a character not used by the strings.</p>
- <p>Its usage can be demonstrated by an example:</p>
-<pre> URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
-
-</pre>
- <p>The above line is equivalent to the following three lines:</p>
-<pre> URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
- URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
- URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
-
-</pre>
- <p>If <i>string</i> 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>
-<pre> URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
-
-</pre>
- <p>If <i>string</i> takes the form <code>perl:STRING</code>, then the specified <strong>STRING</strong>
-is passed to the <code>on_keyboard_command</code> perl handler. See the rxvtperl(3)
-manpage. For example, the <cite>selection</cite> extension (activated via
-<code>rxvt -pe selection</code>) listens for <code>selection:rot13</code> events:</p>
-<pre> URxvt.keysym.M-C-c: perl:selection:rot13
-
-</pre>
- <p>Due the the large number of modifier combinations, a defined key mapping
-will match if at <i>at least</i> 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>
- <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>
-<pre> URxvt.keysym.Insert: <my insert key sequence>
- URxvt.keysym.S-Insert: builtin:
-
-</pre>
- <p>The first line defines a mapping for <code>Insert</code> and <i>any</i> combination
-of modifiers. The second line re-establishes the default mapping for
-<code>Shift-Insert</code>.</p>
- <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>
-<pre> URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
- URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
-
-</pre>
- <p>Other things are possible, e.g. resizing (see rxvt(7) for more
-info):</p>
-<pre> URxvt.keysym.M-C-3: command:\033[8;25;80t
- URxvt.keysym.M-C-4: command:\033[8;48;110t
-
-</pre>
- </dd>
- <dt><strong>perl-ext-common</strong>: <i>string</i></dt>
- <dt><strong>perl-ext</strong>: <i>string</i></dt>
- <dd>
- <p>Comma-separated list(s) of perl extension scripts (default: <code>default</code>) to
-use in this terminal instance; option <strong>-pe</strong>.</p>
- <p>Extension names can be prefixed with a <code>-</code> sign to prohibit using
-them. This can be useful to selectively disable some extensions loaded
-by default, or specified via the <code>perl-ext-common</code> resource. For
-example, <code>default,-selection</code> will use all the default extension except
-<code>selection</code>.</p>
- <p>Extension names can also be followed by an argument in angle brackets
-(e.g. <code>searchable-scrollback<M-s></code>, which binds the hotkey for
-searchable scrollback to Alt/Meta-s). Mentioning the same extension
-multiple times with different arguments will pass multiple arguments to
-the extension.</p>
- <p>Each extension is looked up in the library directories, loaded if
-necessary, and bound to the current terminal instance.</p>
- <p>If both of these resources are the empty string, then the perl
-interpreter will not be initialized. The idea behind two options is that
-<strong>perl-ext-common</strong> will be used for extensions that should be available to
-all instances, while <strong>perl-ext</strong> is used for specific instances.</p>
- </dd>
- <dt><strong>perl-eval</strong>: <i>string</i></dt>
- <dd>
- <p>Perl code to be evaluated when all extensions have been registered. See
-the rxvtperl(3) manpage. Due to security reasons, this resource
-will be ignored when running setuid/setgid.</p>
- </dd>
- <dt><strong>perl-lib</strong>: <i>path</i></dt>
- <dd>
- <p>Colon-separated list of additional directories that hold extension
-scripts. When looking for extensions specified by the <code>perl</code> resource,
-rxvt will first look in these directories and then in
-<cite>/opt/rxvt/lib/urxvt/perl/</cite>. Due to security reasons, this resource
-will be ignored when running setuid/setgid.</p>
- <p>See the rxvtperl(3) manpage.</p>
- </dd>
- <dt><strong>selection.pattern-<i>idx</i></strong>: <i>perl-regex</i></dt>
- <dd>
- <p>Additional selection patterns, see the rxvtperl(3) manpage for
-details.</p>
- </dd>
- <dt><strong>selection-autotransform.<i>idx</i></strong>: <i>perl-transform</i></dt>
- <dd>
- <p>Selection auto-transform patterns, see the rxvtperl(3) manpage
-for details.</p>
- </dd>
- <dt><strong>searchable-scrollback:</strong> <i>keysym</i></dt>
- <dd>
- <p>Sets the hotkey that starts the incremental scrollback buffer search
-(default: <code>M-s</code>).</p>
- </dd>
- <dt><strong>urlLauncher</strong>: <i>string</i></dt>
- <dd>
- <p>Specifies the program to be started with a URL argument. Used by the
-<code>selection-popup</code> and <code>matcher</code> perl extensions.</p>
- </dd>
- <dt><strong>transient-for</strong>: <i>windowid</i></dt>
- <dd>
- <p>Compile <i>frills</i>: Sets the WM_TRANSIENT_FOR property to the given window id.</p>
- </dd>
- <dt><strong>override-redirect</strong>: <i>boolean</i></dt>
- <dd>
- <p>Compile <i>frills</i>: Sets override-redirect for the terminal window, making
-it almost invisible to window managers; option <strong>-override-redirect</strong>.</p>
- </dd>
- <dt><strong>iso14755_52:</strong> <i>boolean</i></dt>
- <dd>
- <p>Turn on/off ISO 14755 5.2 mode (default enabled).</p>
- </dd>
-</dl>
-
-</div>
-<h1 id="THE_SCROLLBAR">THE SCROLLBAR</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="THE_SCROLLBAR_CONTENT">
-<p>Lines of text that scroll off the top of the <strong>rxvt</strong> window
-(resource: <strong>saveLines</strong>) and can be scrolled back using the scrollbar
-or by keystrokes. The normal <strong>rxvt</strong> scrollbar has arrows and
-its behaviour is fairly intuitive. The <strong>xterm-scrollbar</strong> is without
-arrows and its behaviour mimics that of <i>xterm</i></p>
-<p>Scroll down with <strong>Button1</strong> (<strong>xterm-scrollbar</strong>) or <strong>Shift-Next</strong>.
-Scroll up with <strong>Button3</strong> (<strong>xterm-scrollbar</strong>) or <strong>Shift-Prior</strong>.
-Continuous scroll with <strong>Button2</strong>.</p>
-
-</div>
-<h1 id="MOUSE_REPORTING">MOUSE REPORTING</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="MOUSE_REPORTING_CONTENT">
-<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>
-(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),
-respectively.</p>
-
-</div>
-<h1 id="THE_SELECTION_SELECTING_AND_PASTING_">THE SELECTION: SELECTING AND PASTING TEXT</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="THE_SELECTION_SELECTING_AND_PASTING_-2">
-<p>The behaviour of text selection and insertion/pasting mechanism is similar
-to <i>xterm</i>(1).</p>
-<dl>
- <dt><strong>Selecting</strong>:</dt>
- <dd>
- <p>Left click at the beginning of the region, drag to the end of the region
-and release; Right click to extend the marked region; Left double-click
-to select a word; Left triple-click to select the entire logical line
-(which can span multiple screen lines), unless modified by resource
-<strong>tripleclickwords</strong>.</p>
- <p>Starting a selection while pressing the <strong>Meta</strong> key (or <strong>Meta+Ctrl</strong> keys)
-(Compile: <i>frills</i>) will create a rectangular selection instead of a
-normal one. In this mode, every selected row becomes its own line in the
-selection, and trailing whitespace is visually underlined and removed from
-the selection.</p>
- </dd>
- <dt><strong>Pasting</strong>:</dt>
- <dd>
- <p>Pressing and releasing the Middle mouse button in an <strong>rxvt</strong>
-window causes the value of the PRIMARY selection (or CLIPBOARD with the
-<strong>Meta</strong> modifier) to be inserted as if it had been typed on the keyboard.</p>
- <p>Pressing <strong>Shift-Insert</strong> causes the value of the PRIMARY selection to be
-inserted too.</p>
- </dd>
-</dl>
-
-</div>
-<h1 id="CHANGING_FONTS">CHANGING FONTS</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="CHANGING_FONTS_CONTENT">
-<p>Changing fonts (or font sizes, respectively) via the keypad is not yet
-supported in rxvt-unicode. Bug me if you need this.</p>
-<p>You can, however, switch fonts at runtime using escape sequences, e.g.:</p>
-<pre> printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
-
-</pre>
-<p>You can use keyboard shortcuts, too:</p>
-<pre> URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
- URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
-
-</pre>
-<p>rxvt-unicode will automatically re-apply these fonts to the output so far.</p>
-
-</div>
-<h1 id="ISO_14755_SUPPORT">ISO 14755 SUPPORT</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="ISO_14755_SUPPORT_CONTENT">
-<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 if 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>
-<dl>
- <dt>* 5.1: Basic method</dt>
- <dd>
- <p>This allows you to enter unicode characters using their hexcode.</p>
- <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
-<code>Control</code> and <code>Shift</code> you can also enter multiple characters by pressing
-<code>Space</code>, which will commit the current character and lets you start a new
-one.</p>
- <p>As an example of use, imagine a business card with a japanese e-mail
-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>
- </dd>
- <dt>* 5.2: Keyboard symbols entry method</dt>
- <dd>
- <p>This mode lets you input characters representing the keycap symbols of
-your keyboard, if representable in the current locale encoding.</p>
- <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
-invoke its usual function but instead will insert the corresponding
-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>
- </dd>
- <dt>* 5.3: Screen-selection entry method</dt>
- <dd>
- <p>While this is implemented already (it's basically the selection
-mechanism), it could be extended by displaying a unicode character map.</p>
- </dd>
- <dt>* 5.4: Feedback method for identifying displayed characters for later input</dt>
- <dd>
- <p>This method lets you display the unicode character code associated with
-characters already displayed.</p>
- <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
-hex code(s) (it might be a combining character) of the character under the
-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>
- </dd>
-</dl>
-<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>
-
-</div>
-<h1 id="LOGIN_STAMP">LOGIN STAMP</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="LOGIN_STAMP_CONTENT">
-<p><strong>rxvt</strong> tries to write an entry into the <i>utmp</i>(5) file so that
-it can be seen via the <i>who(1)</i> command, and can accept messages. To
-allow this feature, <strong>rxvt</strong> may need to be installed setuid root
-on some systems or setgid to root or to some other group on others.</p>
-
-</div>
-<h1 id="COLORS_AND_GRAPHICS">COLORS AND GRAPHICS</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="COLORS_AND_GRAPHICS_CONTENT">
-<p>In addition to the default foreground and background colours,
-<strong>rxvt</strong> can display up to 16 colours (8 ANSI colours plus
-high-intensity bold/blink versions of the same). Here is a list of the
-colours with their names.</p>
-<table><tr><td>color0</td><td>(black)</td><td>= Black</td></tr><tr><td>color1</td><td>(red)</td><td>= Red3</td></tr><tr><td>color2</td><td>(green)</td><td>= Green3</td></tr><tr><td>color3</td><td>(yellow)</td><td>= Yellow3</td></tr><tr><td>color4</td><td>(blue)</td><td>= Blue3</td></tr><tr><td>color5</td><td>(magenta)</td><td>= Magenta3</td></tr><tr><td>color6</td><td>(cyan)</td><td>= Cyan3</td></tr><tr><td>color7</td><td>(white)</td><td>= AntiqueWhite</td></tr><tr><td>color8</td><td>(bright black)</td><td>= Grey25</td></tr><tr><td>color9</td><td>(bright red)</td><td>= Red</td></tr><tr><td>color10</td><td>(bright green)</td><td>= Green</td></tr><tr><td>color11</td><td>(bright yellow)</td><td>= Yellow</td></tr><tr><td>color12</td><td>(bright blue)</td><td>= Blue</td></tr><tr><td>color13</td><td>(bright magenta)</td><td>= Magenta</td></tr><tr><td>color14</td><td>(bright cyan)</td><td>= Cyan</td></tr><tr><td>color15</td><td>(bright white)</td><td>= White</td></tr><tr><td>foreground</td><td></td><td>= Black</td></tr><tr><td>background</td><td></td><td>= White</td></tr></table><p>It is also possible to specify the colour values of <strong>foreground</strong>,
-<strong>background</strong>, <strong>cursorColor</strong>, <strong>cursorColor2</strong>, <strong>colorBD</strong>, <strong>colorUL</strong> as
-a number 0-15, as a convenient shorthand to reference the colour name of
-color0-color15.</p>
-<p>In addition to the colours defined above, rxvt offers an
-additional 72 colours. The first 64 of those (with indices 16 to 79)
-consist of a 4*4*4 RGB colour cube (i.e. <i>index = r * 16 + g * 4 + b +
-16</i>), followed by 8 additional shades of gray (with indices 80 to 87).</p>
-<p>Together, all those colours implement the 88 colour xterm colours. Only
-the first 16 can be changed using resources currently, the rest can only
-be changed via command sequences ("escape codes").</p>
-<p>Note that <strong>-rv</strong> (<strong>"reverseVideo: True"</strong>) simulates reverse video by
-always swapping the foreground/background colours. This is in contrast to
-<i>xterm</i>(1) where the colours are only swapped if they have not otherwise
-been specified. For example,</p>
-<dl>
- <dt><strong>rxvt -fg Black -bg White -rv</strong></dt>
- <dd>
- <p>would yield White on Black, while on <i>xterm</i>(1) it would yield Black
-on White.</p>
- </dd>
-</dl>
-
-</div>
-<h2 id="ALPHA_CHANNEL_SUPPORT">ALPHA CHANNEL SUPPORT</h2>
-<div id="ALPHA_CHANNEL_SUPPORT_CONTENT">
-<p>If Xft support has been compiled in and as long as Xft/Xrender/X don't get
-their act together, rxvt-unicode will support <code>rgba:rrrr/gggg/bbbb/aaaa</code>
-(recommended, but <strong>MUST</strong> have 4 digits/component) colour specifications,
-in addition to the ones provided by X, where the additional A component
-specifies opacity (alpha) values. The minimum value of <code>0</code> is completely
-transparent). You can also prefix any color with <code>[percent]</code>, where
-<code>percent</code> is a decimal percentage (0-100) that specifies the opacity of
-the color, where <code>0</code> is completely transparent and <code>100</code> is completelxy
-opaque.</p>
-<p>You probably need to specify <strong>"-depth 32"</strong>, too, and have the luck that
-your X-server uses ARGB pixel layout, as X is far from just supporting
-ARGB visuals out of the box, and rxvt-unicode just fudges around.</p>
-<p>For example, the following selects an almost completely transparent red
-background, and an almost opaque pink foreground:</p>
-<pre> rxvt -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
-
-</pre>
-<p><i>Please note that transparency of any kind if completely unsupported by
-the author. Don't bug him with installation questions!</i></p>
-
-</div>
-<h1 id="ENVIRONMENT">ENVIRONMENT</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="ENVIRONMENT_CONTENT">
-<p><strong>rxvt</strong> sets and/or uses the following environment variables:</p>
-<dl>
- <dt><strong>TERM</strong></dt>
- <dd>
- <p>Normally set to <code>rxvt-unicode</code>, unless overwritten at configure time, via
-resources or on the command line.</p>
- </dd>
- <dt><strong>COLORTERM</strong></dt>
- <dd>
- <p>Either <code>rxvt</code>, <code>rxvt-xpm</code>, depending on whether rxvt was
-compiled with background image support, and optionally with the added
-extension <code>-mono</code> to indicate that rxvt-unicode runs on a monochrome
-screen.</p>
- </dd>
- <dt><strong>COLORFGBG</strong></dt>
- <dd>
- <p>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 background image support. Libraries like <code>ncurses</code>
-and <code>slang</code> can (and do) use this information to optimize screen output.</p>
- </dd>
- <dt><strong>WINDOWID</strong></dt>
- <dd>
- <p>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).</p>
- </dd>
- <dt><strong>TERMINFO</strong></dt>
- <dd>
- <p>Set to the terminfo directory iff rxvt was configured with
-<code>--with-terminfo=PATH</code>.</p>
- </dd>
- <dt><strong>DISPLAY</strong></dt>
- <dd>
- <p>Used by rxvt to connect to the display and set to the correct
-display in its child processes.</p>
- </dd>
- <dt><strong>SHELL</strong></dt>
- <dd>
- <p>The shell to be used for command execution, defaults to <code>/bin/sh</code>.</p>
- </dd>
- <dt><strong>RXVT_SOCKET</strong></dt>
- <dd>
- <p>The unix domain socket path used by rxvtc(1) and
-rxvtd(1).</p>
- <p>Default <cite>$HOME/.rxvt-unicode-<i><nodename</i></cite>.</p>
- </dd>
- <dt><strong>HOME</strong></dt>
- <dd>
- <p>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>)</p>
- </dd>
- <dt><strong>XAPPLRESDIR</strong></dt>
- <dd>
- <p>Directory where various X resource files are being located.</p>
- </dd>
- <dt><strong>XENVIRONMENT</strong></dt>
- <dd>
- <p>If set and accessible, gives the name of a X resource file to be loaded by
-rxvt.</p>
- </dd>
-</dl>
-
-</div>
-<h1 id="FILES">FILES</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="FILES_CONTENT">
-<dl>
- <dt><strong>/usr/lib/X11/rgb.txt</strong></dt>
- <dd>
- <p>Color names.</p>
- </dd>
-</dl>
-
-</div>
-<h1 id="SEE_ALSO">SEE ALSO</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="SEE_ALSO_CONTENT">
-<p>rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)</p>
-
-</div>
-<h1 id="CURRENT_PROJECT_COORDINATOR">CURRENT PROJECT COORDINATOR</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="CURRENT_PROJECT_COORDINATOR_CONTENT">
-<dl>
- <dt>Project Coordinator</dt>
- <dd>
- <p>Marc A. Lehmann <a href="#lt_rxvt_unicode_schmorp_de_gt"><rxvt-unicode@schmorp.de></a></p>
- <p><a href="http://software.schmorp.de/pkg/rxvt-unicode.html">http://software.schmorp.de/pkg/rxvt-unicode.html</a></p>
- </dd>
-</dl>
-
-</div>
-<h1 id="AUTHORS">AUTHORS</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="AUTHORS_CONTENT">
-<dl>
- <dt>John Bovey</dt>
- <dd>
- <p>University of Kent, 1992, wrote the original Xvt.</p>
- </dd>
- <dt>Rob Nation <a href="#lt_nation_rocket_sanders_lockheed_co"><nation@rocket.sanders.lockheed.com></a></dt>
- <dd>
- <p>very heavily modified Xvt and came up with Rxvt</p>
- </dd>
- <dt>Angelo Haritsis <a href="#lt_ah_doc_ic_ac_uk_gt"><ah@doc.ic.ac.uk></a></dt>
- <dd>
- <p>wrote the Greek Keyboard Input (no longer in code)</p>
- </dd>
- <dt>mj olesen <a href="#lt_olesen_me_QueensU_CA_gt"><olesen@me.QueensU.CA></a></dt>
- <dd>
- <p>Wrote the menu system.</p>
- <p>Project Coordinator (changes.txt 2.11 to 2.21)</p>
- </dd>
- <dt>Oezguer Kesim <a href="#lt_kesim_math_fu_berlin_de_gt"><kesim@math.fu-berlin.de></a></dt>
- <dd>
- <p>Project Coordinator (changes.txt 2.21a to 2.4.5)</p>
- </dd>
- <dt>Geoff Wing <a href="#lt_gcw_pobox_com_gt"><gcw@pobox.com></a></dt>
- <dd>
- <p>Rewrote screen display and text selection routines.</p>
- <p>Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)</p>
- </dd>
- <dt>Marc Alexander Lehmann <a href="#lt_rxvt_unicode_schmorp_de_gt"><rxvt-unicode@schmorp.de></a></dt>
- <dd>
- <p>Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
-extension, random hacks, numerous bugfixes and extensions.</p>
- <p>Project Coordinator (Changes 1.0 -)</p>
- </dd>
- <dt>Emanuele Giaquinta <a href="#lt_e_giaquinta_glauco_it_gt"><e.giaquinta@glauco.it></a></dt>
- <dd>
- <p>Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.</p>
- </dd>
-</dl>
-
-</div>
-</div></body>
-</html>
+++ /dev/null
-NAME
- rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window
- system)
-
-SYNOPSIS
- rxvt [options] [-e command [ args ]]
-
-DESCRIPTION
- rxvt-unicode, version 8.6, is a colour vt102 terminal emulator intended
- as an *xterm*(1) replacement for users who do not require features such
- as Tektronix 4014 emulation and toolkit-style configurability. As a
- result, rxvt-unicode uses much less swap space -- a significant
- advantage on a machine serving many X sessions.
-
-FREQUENTLY ASKED QUESTIONS
- See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions
- and answer to them and some common problems. That document is also
- accessible on the World-Wide-Web at
- <http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
-
-RXVT-UNICODE VS. RXVT
- Unlike the original rxvt, rxvt-unicode stores all text in Unicode
- internally. That means it can store and display most scripts in the
- world. Being a terminal emulator, however, some things are very
- difficult, especially cursive scripts such as arabic, vertically written
- scripts like mongolian or scripts requiring extremely complex combining
- rules, like tibetan or devanagari. Don't expect pretty output when using
- these scripts. Most other scripts, latin, cyrillic, kanji, thai etc.
- should work fine, though. A somewhat difficult case are right-to-left
- scripts, such as hebrew: rxvt-unicode adopts the view that bidirectional
- algorithms belong into the application, not the terminal emulator (too
- many things -- such as cursor-movement while editing -- break
- otherwise), but that might change.
-
- If you are looking for a terminal that supports more exotic scripts, let
- me recommend "mlterm", which is a very user friendly, lean and clean
- terminal emulator. In fact, the reason rxvt-unicode was born was solely
- because the author couldn't get "mlterm" to use one font for latin1 and
- another for japanese.
-
- Therefore another design rationale was the use of multiple fonts to
- display characters: The idea of a single unicode font which many other
- programs force onto its users never made sense to me: You should be able
- to choose any font for any script freely.
-
- Apart from that, rxvt-unicode is also much better internationalised than
- its predecessor, supports things such as XFT and ISO 14755 that are
- handy in i18n-environments, is faster, and has a lot bugs less than the
- original rxvt. This all in addition to dozens of other small
- improvements.
-
- It is still faithfully following the original rxvt idea of being lean
- and nice on resources: for example, you can still configure rxvt-unicode
- without most of its features to get a lean binary. It also comes with a
- client/daemon pair that lets you open any number of terminal windows
- from within a single process, which makes startup time very fast and
- drastically reduces memory usage. See rxvtd(1) (daemon) and rxvtc(1)
- (client).
-
- It also makes technical information about escape sequences (which have
- been extended) more accessible: see rxvt(7) for technical reference
- documentation (escape sequences etc.).
-
-OPTIONS
- The rxvt options (mostly a subset of *xterm*'s) are listed below. In
- keeping with the smaller-is-better philosophy, options may be eliminated
- or default values chosen at compile-time, so options and defaults listed
- may not accurately reflect the version installed on your system. `rxvt
- -h' gives a list of major compile-time options on the *Options* line.
- Option descriptions may be prefixed with which compile option each is
- dependent upon. e.g. `Compile *XIM*:' requires *XIM* on the *Options*
- line. Note: `rxvt -help' gives a list of all command-line options
- compiled into your version.
-
- Note that rxvt permits the resource name to be used as a long-option
- (--/++ option) so the potential command-line options are far greater
- than those listed. For example: `rxvt --loginShell --color1 Orange'.
-
- The following options are available:
-
- -help, --help
- Print out a message describing available options.
-
- -display *displayname*
- Attempt to open a window on the named X display (-d still
- respected). In the absence of this option, the display specified by
- the DISPLAY environment variable is used.
-
- -depth *bitdepth*
- Compile *xft*: Attempt to find a visual with the given bit depth;
- resource depth.
-
- -geometry *geom*
- Window geometry (-g still respected); resource geometry.
-
- -rv|+rv
- Turn on/off simulated reverse video; resource reverseVideo.
-
- -j|+j
- Turn on/off jump scrolling (allow multiple lines per refresh);
- resource jumpScroll.
-
- -ss|+ss
- Turn on/off skip scrolling (allow multiple screens per refresh);
- resource skipScroll.
-
- -tr|+tr
- Turn on/off illusion of a transparent window background. Obsolete
- form of it is -ip and it should not be used anymore; resource
- transparent.
-
- *Please note that old resource name of inheritPixmap is obsolete and
- should be changed to transparent. Backwards compatibility support
- for inheritPixmap will be phased out in future versions of rxvt!*
-
- *Please address all transparency related issues to Sasha Vasko at
- sasha@aftercode.net. Read the FAQ (man 7 rxvt)!*
-
- -fade *number*
- Fade the text by the given percentage when focus is lost. Small
- values fade a little only, 100 completely replaces all colours by
- the fade colour; resource fading.
-
- -fadecolor *colour*
- Fade to this colour when fading is used (see -fade). The default
- colour is opaque black. resource fadeColor.
-
- -tint *colour*
- Tint the transparent background pixmap with the given colour when
- transparency is enabled with -tr. This only works for non-tiled
- backgrounds, currently. See also the -sh option that can be used to
- brighten or darken the image in addition to tinting it. Please note
- that certain tint colours can be applied on the server-side, thus
- yielding performance gain of two orders of magnitude. These colours
- are: blue, red, green, cyan, magenta, yellow, and those close to
- them. Also pure black and pure white colors essentially mean no
- tinting; resource *tintColor*. Example:
-
- rxvt -tr -tint blue -sh 40
-
- -sh *number*
- Darken (0 .. 100) or lighten (100 .. 200) the transparent background
- image in addition to (or instead of) tinting it; resource *shading*.
-
- -blt *string*
- Specify background blending type. If background pixmap is specified
- at the same time as transparency - such pixmap will be blended over
- transparency image, using method specified. Supported values are :
- add, alphablend, allanon - color values averaging, colorize, darken,
- diff, dissipate, hue, lighten, overlay, saturate, screen, sub, tint,
- value. The default is alpha-blending. Compile *afterimage*; resource
- *blendType*.
-
- -blr *HxV*
- Apply Gaussian Blur with the specified radii to the transparent
- background image. If single number is specified - both vertical and
- horizontal radii are considered to be the same. Setting one of the
- radii to 1 and another to a large number creates interesting effects
- on some backgrounds. Maximum radius value is 128. Compile
- *afterimage*; resource *blurRadius*.
-
- -bg *colour*
- Window background colour; resource background.
-
- -fg *colour*
- Window foreground colour; resource foreground.
-
- -pixmap *file[;geom[:op1][:op2][...]]*
- Compile *afterimage*: Specify image file for the background and also
- optionally specify its scaling with a geometry string. Note you may
- need to add quotes to avoid special shell interpretation of the ";"
- in the command-line; for more details see resource backgroundPixmap.
-
- -cr *colour*
- The cursor colour; resource cursorColor.
-
- -pr *colour*
- The mouse pointer foreground colour; resource pointerColor.
-
- -pr2 *colour*
- The mouse pointer background colour; resource pointerColor2.
-
- -bd *colour*
- The colour of the border around the text area and between the
- scrollbar and the text; resource borderColor.
-
- -fn *fontlist*
- Select the fonts to be used. This is a comma separated list of font
- names that are checked in order when trying to find glyphs for
- characters. The first font defines the cell size for characters;
- other fonts might be smaller, but not (in general) larger. A
- (hopefully) reasonable default font list is always appended to it.
- See resource font for more details.
-
- In short, to specify an X11 core font, just specify its name or
- prefix it with "x:". To specify an XFT-font, you need to prefix it
- with "xft:", e.g.:
-
- rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
- rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
-
- See also the question "How does rxvt-unicode choose fonts?" in the
- FAQ section of rxvt(7).
-
- -fb *fontlist*
- Compile *font-styles*: The bold font list to use when bold
- characters are to be printed. See resource boldFont for details.
-
- -fi *fontlist*
- Compile *font-styles*: The italic font list to use when *italic*
- characters are to be printed. See resource italicFont for details.
-
- -fbi *fontlist*
- Compile *font-styles*: The bold italic font list to use when *bold
- italic* characters are to be printed. See resource boldItalicFont
- for details.
-
- -is|+is
- Compile *font-styles*: Bold/Italic font styles imply high intensity
- foreground/background (default). See resource intensityStyles for
- details.
-
- -name *name*
- Specify the application name under which resources are to be
- obtained, rather than the default executable file name. Name should
- not contain `.' or `*' characters. Also sets the icon and title
- name.
-
- -ls|+ls
- Start as a login-shell/sub-shell; resource loginShell.
-
- -ut|+ut
- Compile *utmp*: Inhibit/enable writing a utmp entry; resource
- utmpInhibit.
-
- -vb|+vb
- Turn on/off visual bell on receipt of a bell character; resource
- visualBell.
-
- -sb|+sb
- Turn on/off scrollbar; resource scrollBar.
-
- -si|+si
- Turn on/off scroll-to-bottom on TTY output inhibit; resource
- scrollTtyOutput has opposite effect.
-
- -sk|+sk
- Turn on/off scroll-to-bottom on keypress; resource
- scrollTtyKeypress.
-
- -sw|+sw
- Turn on/off scrolling with the scrollback buffer as new lines
- appear. This only takes effect if -si is also given; resource
- scrollWithBuffer.
-
- -sr|+sr
- Put scrollbar on right/left; resource scrollBar_right.
-
- -st|+st
- Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
- resource scrollBar_floating.
-
- -ptab|+ptab
- If enabled (default), "Horizontal Tab" characters are being stored
- as actual wide characters in the screen buffer, which makes it
- possible to select and paste them. Since a horizontal tab is a
- cursor movement and not an actual glyph, this can sometimes be
- visually annoying as the cursor on a tab character is displayed as a
- wide cursor; resource pastableTabs.
-
- -bc|+bc
- Blink the cursor; resource cursorBlink.
-
- -iconic
- Start iconified, if the window manager supports that option.
- Alternative form is -ic.
-
- -sl *number*
- Save *number* lines in the scrollback buffer. See resource entry for
- limits; resource saveLines.
-
- -b *number*
- Compile *frills*: Internal border of *number* pixels. See resource
- entry for limits; resource internalBorder.
-
- -w *number*
- Compile *frills*: External border of *number* pixels. Also, -bw and
- -borderwidth. See resource entry for limits; resource
- externalBorder.
-
- -bl Compile *frills*: Set MWM hints to request a borderless window, i.e.
- if honoured by the WM, the rxvt-unicode window will not have window
- decorations; resource borderLess.
-
- -override-redirect
- Compile *frills*: Sets override-redirect on the window; resource
- override-redirect.
-
- -sbg
- Compile *frills*: Disable the usage of the built-in block
- graphics/line drawing characters and just rely on what the specified
- fonts provide. Use this if you have a good font and want to use its
- block graphic glyphs; resource skipBuiltinGlyphs.
-
- -lsp *number*
- Compile *frills*: Lines (pixel height) to insert between each row of
- the display. Useful to work around font rendering problems; resource
- lineSpace.
-
- -tn *termname*
- This option specifies the name of the terminal type to be set in the
- TERM environment variable. This terminal type must exist in the
- *termcap(5)* database and should have *li#* and *co#* entries;
- resource termName.
-
- -e *command [arguments]*
- Run the command with its command-line arguments in the rxvt window;
- also sets the window title and icon name to be the basename of the
- program being executed if neither *-title* (*-T*) nor *-n* are given
- on the command line. If this option is used, it must be the last on
- the command-line. If there is no -e option then the default is to
- run the program specified by the SHELL environment variable or,
- failing that, *sh(1)*.
-
- Please note that you must specify a program with arguments. If you
- want to run shell commands, you have to specify the shell, like
- this:
-
- rxvt -e sh -c "shell commands"
-
- -title *text*
- Window title (-T still respected); the default title is the basename
- of the program specified after the -e option, if any, otherwise the
- application name; resource title.
-
- -n *text*
- Icon name; the default name is the basename of the program specified
- after the -e option, if any, otherwise the application name;
- resource iconName.
-
- -C Capture system console messages.
-
- -pt *style*
- Compile *XIM*: input style for input method; OverTheSpot,
- OffTheSpot, Root; resource preeditType.
-
- -im *text*
- Compile *XIM*: input method name. resource inputMethod.
-
- -imlocale *string*
- The locale to use for opening the IM. You can use an "LC_CTYPE" of
- e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for
- the input extension to be able to input japanese characters while
- staying in another locale. resource imLocale.
-
- -imfont *fontset*
- Set the font set to use for the X Input Method, see resource imFont
- for more info.
-
- -tcw
- Change the meaning of triple-click selection with the left mouse
- button. Only effective when the original (non-perl) selection code
- is in-use. Instead of selecting a full line it will extend the
- selection the end of the logical line only. resource
- tripleclickwords.
-
- -insecure
- Enable "insecure" mode, which currently enables most of the escape
- sequences that echo strings. See the resource insecure for more
- info.
-
- -mod *modifier*
- Override detection of Meta modifier with specified key: alt, meta,
- hyper, super, mod1, mod2, mod3, mod4, mod5; resource *modifier*.
-
- -ssc|+ssc
- Turn on/off secondary screen (default enabled); resource
- secondaryScreen.
-
- -ssr|+ssr
- Turn on/off secondary screen scroll (default enabled); resource
- secondaryScroll.
-
- -hold|+hold
- Turn on/off hold window after exit support. If enabled, rxvt will
- not immediately destroy its window when the program executed within
- it exits. Instead, it will wait till it is being killed or closed by
- the user; resource hold.
-
- -xrm *string*
- Works like the X Toolkit option of the same name, by adding the
- *string* as if it were specified in a resource file. Resource values
- specified this way take precedence over all other resource
- specifications.
-
- Note that you need to use the *same* syntax as in the .Xdefaults
- file, e.g. "*.background: black". Also note that all rxvt-specific
- options can be specified as long-options on the commandline, so use
- of -xrm is mostly limited to cases where you want to specify other
- resources (e.g. for input methods) or for compatibility with other
- programs.
-
- -keysym.*sym* *string*
- Remap a key symbol. See resource keysym.
-
- -embed *windowid*
- Tells rxvt to embed its windows into an already-existing window,
- which enables applications to easily embed a terminal.
-
- 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.
-
- The window will not be destroyed when rxvt exits.
-
- 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 whether the "-embed" option was
- used or not.
-
- Here is a short Gtk2-perl snippet that illustrates how this option
- can be used (a longer example is in doc/embed):
-
- my $rxvt = new Gtk2::Socket;
- $rxvt->signal_connect_after (realize => sub {
- my $xid = $_[0]->window->get_xid;
- system "rxvt -embed $xid &";
- });
-
- -pty-fd *file descriptor*
- Tells rxvt NOT to execute any commands or create a new pty/tty pair
- but instead use the given file descriptor 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.
-
- 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.
-
- As an extremely special case, specifying -1 will completely suppress
- pty/tty operations.
-
- Here is a example in perl that illustrates how this option can be
- used (a longer example is in doc/pty-fd):
-
- use IO::Pty;
- use Fcntl;
-
- my $pty = new IO::Pty;
- fcntl $pty, F_SETFD, 0; # clear close-on-exec
- system "rxvt -pty-fd " . (fileno $pty) . "&";
- close $pty;
-
- # now communicate with rxvt
- my $slave = $pty->slave;
- while (<$slave>) { print $slave "got <$_>\n" }
-
- -pe *string*
- Comma-separated list of perl extension scripts to use (or not to
- use) in this terminal instance. See resource perl-ext for details.
-
-RESOURCES (available also as long-options)
- Note: `rxvt --help' gives a list of all resources (long options)
- compiled into your version.
-
- You can set and change the resources using X11 tools like xrdb. Many
- distribution do also load settings from the ~/.Xresources file when X
- starts. rxvt will consult the following files/resources in order, with
- later settings overwriting earlier ones:
-
- 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-<nodename>
- 6. resources specified via -xrm on the commandline
-
- Note that when reading X resources, rxvt recognizes two class names:
- Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
- and the original *rxvt* to be easily configured, while the class name
- URxvt allows resources unique to rxvt, to be shared between different
- rxvt configurations. If no resources are specified, suitable defaults
- will be used. Command-line arguments can be used to override resource
- settings. The following resources are supported (you might want to check
- the rxvtperl(3) manpage for additional settings by perl extensions not
- documented here):
-
- depth: *bitdepth*
- Compile *xft*: Attempt to find a visual with the given bit depth;
- option -depth.
-
- geometry: *geom*
- Create the window with the specified X window geometry [default
- 80x24]; option -geometry.
-
- background: *colour*
- Use the specified colour as the window's background colour [default
- White]; option -bg.
-
- foreground: *colour*
- Use the specified colour as the window's foreground colour [default
- Black]; option -fg.
-
- color*n*: *colour*
- Use the specified colour for the colour value *n*, where 0-7
- corresponds to low-intensity (normal) colours and 8-15 corresponds
- to high-intensity (bold = bright foreground, blink = bright
- background) colours. The canonical names are as follows: 0=black,
- 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but
- the actual colour names used are listed in the COLORS AND GRAPHICS
- section.
-
- Colours higher than 15 cannot be set using resources (yet), but can
- be changed using an escape command (see rxvt(7)).
-
- Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm
- with 88 colour support). Colours 80-87 are evenly spaces grey steps.
-
- colorBD: *colour*
- colorIT: *colour*
- 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.
-
- colorUL: *colour*
- Use the specified colour to display underlined characters when the
- foreground colour is the default.
-
- colorRV: *colour*
- Use the specified colour as the background for reverse video
- characters when OPTION_HC is disabled (--disable-frills).
-
- underlineColor: *colour*
- If set, use the specified colour as the colour for the underline
- itself. If unset, use the foreground colour.
-
- cursorColor: *colour*
- Use the specified colour for the cursor. The default is to use the
- foreground colour; option -cr.
-
- cursorColor2: *colour*
- Use the specified colour for the colour of the cursor text. For this
- to take effect, cursorColor must also be specified. The default is
- to use the background colour.
-
- reverseVideo: *boolean*
- True: simulate reverse video by foreground and background colours;
- option -rv. False: regular screen colours [default]; option +rv. See
- note in COLORS AND GRAPHICS section.
-
- jumpScroll: *boolean*
- True: specify that jump scrolling should be used. When receiving
- lots of lines, rxvt will only scroll once a whole screen height of
- lines has been read, resulting in fewer updates while still
- displaying every received line; option -j.
-
- False: specify that smooth scrolling should be used. rxvt will force
- a screen refresh on each new line it received; option +j.
-
- skipScroll: *boolean*
- True: (the default) specify that skip scrolling should be used. When
- receiving lots of lines, rxvt will only scroll once in a while
- (around 60 times per second), resulting in far fewer updates. This
- can result in rxvt not ever displaying some of the lines it
- receives; option -ss.
-
- False: specify that everything is to be displayed, even if the
- refresh is too fast for the human eye to read anything (or the
- monitor to display anything); option +ss.
-
- inheritPixmap: *boolean*
- True: make the background inherit the parent windows' pixmap, giving
- artificial transparency. False: do not inherit the parent windows'
- pixmap.
-
- *Please note that transparency of any kind if completely unsupported
- by the author. Don't bug him with installation questions!*
-
- fading: *number*
- Fade the text by the given percentage when focus is lost; option
- -fade.
-
- fadeColor: *colour*
- Fade to this colour, when fading is used (see fading:). The default
- colour is black; option -fadecolor.
-
- tintColor: *colour*
- Tint the transparent background pixmap with the given colour; option
- -tint.
-
- shading: *number*
- Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
- image in addition to tinting it; option -sh.
-
- blendType: *string*
- Specify background blending type; option -blt.
-
- blurRadius: *number*
- Apply Gaussian Blurr with the specified radius to the transparent
- background image; option -blr.
-
- scrollColor: *colour*
- Use the specified colour for the scrollbar [default #B2B2B2].
-
- troughColor: *colour*
- Use the specified colour for the scrollbar's trough area [default
- #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
-
- borderColor: *colour*
- The colour of the border around the text area and between the
- scrollbar and the text.
-
- backgroundPixmap: *file[;geom[:op1][:op2][...]]*
- Use the specified image file for the background and also optionally
- specify its scaling with a geometry string WxH+X+Y, (default
- "0x0+50+50") in which "W" / "H" specify the horizontal/vertical
- scale (percent), and "X" / "Y" locate the image centre (percent). A
- scale of 0 displays the image with tiling. A scale of 1 displays the
- image without any scaling. A scale of 2 to 9 specifies an integer
- number of images in that direction. No image will be magnified
- beyond 10 times its original size. The maximum permitted scale is
- 1000. Additional operations can be specified after colon
- :op1:op2.... Supported operations are:
-
- tile force background image to be tiled and not scaled. Equivalent to 0x0,
- propscale will scale image keeping proportions,
- auto will scale image to match window size. Equivalent to 100x100;
- hscale will scale image horizontally to the window size;
- vscale will scale image vertically to the window size;
- scale will scale image to match window size;
- root will tile image as if it was a root window background, auto-adjusting
- whenever terminal window moves.
-
- If used in conjunction with -tr option, the specified pixmap will be
- blended over transparency image using either alpha-blending, or any
- other blending type, specified with -blt "type" option.
-
- path: *path*
- Specify the colon-delimited search path for finding background image
- files.
-
- font: *fontlist*
- Select the fonts to be used. This is a comma separated list of font
- names that are checked in order when trying to find glyphs for
- characters. The first font defines the cell size for characters;
- other fonts might be smaller, but not (in general) larger. A
- (hopefully) reasonable default font list is always appended to it;
- option -fn.
-
- Each font can either be a standard X11 core font (XLFD) name, with
- optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
- "xft:".
-
- In addition, each font can be prefixed with additional hints and
- specifications enclosed in square brackets ("[]"). The only
- available hint currently is "codeset=codeset-name", and this is only
- used for Xft fonts.
-
- For example, this font resource
-
- URxvt.font: 9x15bold,\
- -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
- -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
- [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
- xft:Code2000:antialias=false
-
- specifies five fonts to be used. The first one is "9x15bold"
- (actually the iso8859-1 version of the second font), which is the
- base font (because it is named first) and thus defines the character
- cell grid to be 9 pixels wide and 15 pixels high.
-
- The second font is just used to add additional unicode characters
- not in the base font, likewise the third, which is unfortunately
- non-bold, but the bold version of the font does contain less
- characters, so this is a useful supplement.
-
- The third font is an Xft font with aliasing turned off, and the
- characters are limited to the JIS 0208 codeset (i.e. japanese
- kanji). The font contains other characters, but we are not
- interested in them.
-
- The last font is a useful catch-all font that supplies most of the
- remaining unicode characters.
-
- boldFont: *fontlist*
- italicFont: *fontlist*
- boldItalicFont: *fontlist*
- The font list to use for displaying bold, *italic* or *bold italic*
- characters, respectively.
-
- If specified and non-empty, then the syntax is the same as for the
- font-resource, and the given font list will be used as is, which
- makes it possible to substitute completely different font styles for
- bold and italic.
-
- If unset (the default), a suitable font list will be synthesized by
- "morphing" the normal text font list into the desired shape. If that
- is not possible, replacement fonts of the desired shape will be
- tried.
-
- If set, but empty, then this specific style is disabled and the
- normal text font will being used for the given style.
-
- intensityStyles: *boolean*
- When font styles are not enabled, or this option is enabled (True,
- option -is, the default), bold and italic font styles imply high
- intensity foreground/background colours. Disabling this option
- (False, option +is) disables this behaviour, the high intensity
- colours are not reachable.
-
- selectstyle: *mode*
- Set mouse selection style to old which is 2.20, oldword which is
- xterm style with 2.20 old word selection, or anything else which
- gives xterm style selection. Only effective when the original
- (non-perl) selection code is in use.
-
- scrollstyle: *mode*
- Set scrollbar style to rxvt, plain, next or xterm. plain is the
- author's favourite.
-
- title: *string*
- Set window title string, the default title is the command-line
- specified after the -e option, if any, otherwise the application
- name; option -title.
-
- iconName: *string*
- Set the name used to label the window's icon or displayed in an icon
- manager window, it also sets the window's title unless it is
- explicitly set; option -n.
-
- mapAlert: *boolean*
- True: de-iconify (map) on receipt of a bell character. False: no
- de-iconify (map) on receipt of a bell character [default].
-
- urgentOnBell: *boolean*
- True: set the urgency hint for the wm on receipt of a bell
- character. False: do not set the urgency hint [default].
-
- visualBell: *boolean*
- True: use visual bell on receipt of a bell character; option -vb.
- False: no visual bell [default]; option +vb.
-
- loginShell: *boolean*
- True: start as a login shell by prepending a `-' to argv[0] of the
- shell; option -ls. False: start as a normal sub-shell [default];
- option +ls.
-
- utmpInhibit: *boolean*
- True: inhibit writing record into the system log file utmp; option
- -ut. False: write record into the system log file utmp [default];
- option +ut.
-
- print-pipe: *string*
- Specify a command pipe for vt100 printer [default *lpr(1)*]. Use
- Print to initiate a screen dump to the printer and Ctrl-Print or
- Shift-Print to include the scrollback as well.
-
- The string will be interpreted as if typed into the shell as-is.
-
- Example:
-
- URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
-
- This creates a new file in your home directory with the screen
- contents every time you hit "Print".
-
- scrollBar: *boolean*
- True: enable the scrollbar [default]; option -sb. False: disable the
- scrollbar; option +sb.
-
- scrollBar_right: *boolean*
- True: place the scrollbar on the right of the window; option -sr.
- False: place the scrollbar on the left of the window; option +sr.
-
- scrollBar_floating: *boolean*
- True: display an rxvt scrollbar without a trough; option -st. False:
- display an rxvt scrollbar with a trough; option +st.
-
- scrollBar_align: *mode*
- Align the top, bottom or centre [default] of the scrollbar thumb
- with the pointer on middle button press/drag.
-
- scrollTtyOutput: *boolean*
- True: scroll to bottom when tty receives output; option -si. False:
- do not scroll to bottom when tty receives output; option +si.
-
- scrollWithBuffer: *boolean*
- True: scroll with scrollback buffer when tty receives new lines (and
- scrollTtyOutput is False); option -sw. False: do not scroll with
- scrollback buffer when tty receives new lines; option +sw.
-
- scrollTtyKeypress: *boolean*
- True: scroll to bottom when a non-special key is pressed. Special
- keys are those which are intercepted by rxvt-unicode for special
- handling and are not passed onto the shell; option -sk. False: do
- not scroll to bottom when a non-special key is pressed; option +sk.
-
- saveLines: *number*
- Save *number* lines in the scrollback buffer [default 64]. This
- resource is limited on most machines to 65535; option -sl.
-
- internalBorder: *number*
- Internal border of *number* pixels. This resource is limited to 100;
- option -b.
-
- externalBorder: *number*
- External border of *number* pixels. This resource is limited to 100;
- option -w, -bw, -borderwidth.
-
- borderLess: *boolean*
- Set MWM hints to request a borderless window, i.e. if honoured by
- the WM, the rxvt-unicode window will not have window decorations;
- option -bl.
-
- skipBuiltinGlyphs: *boolean*
- Compile *frills*: Disable the usage of the built-in block
- graphics/line drawing characters and just rely on what the specified
- fonts provide. Use this if you have a good font and want to use its
- block graphic glyphs; option -sbg.
-
- termName: *termname*
- Specifies the terminal type name to be set in the TERM environment
- variable; option -tn.
-
- lineSpace: *number*
- Specifies number of lines (pixel height) to insert between each row
- of the display [default 0]; option -lsp.
-
- meta8: *boolean*
- True: handle Meta (Alt) + keypress to set the 8th bit. False: handle
- Meta (Alt) + keypress as an escape prefix [default].
-
- mouseWheelScrollPage: *boolean*
- True: the mouse wheel scrolls a page full. False: the mouse wheel
- scrolls five lines [default].
-
- pastableTabs: *boolean*
- True: store tabs as wide characters. False: interpret tabs as cursor
- movement only; option "-ptab".
-
- cursorBlink: *boolean*
- True: blink the cursor. False: do not blink the cursor [default];
- option -bc.
-
- pointerBlank: *boolean*
- True: blank the pointer when a key is pressed or after a set number
- of seconds of inactivity. False: the pointer is always visible
- [default].
-
- pointerColor: *colour*
- Mouse pointer foreground colour.
-
- pointerColor2: *colour*
- Mouse pointer background colour.
-
- pointerBlankDelay: *number*
- Specifies number of seconds before blanking the pointer [default 2].
- Use a large number (e.g. 987654321) to effectively disable the
- timeout.
-
- backspacekey: *string*
- The string to send when the backspace key is pressed. If set to DEC
- or unset it will send Delete (code 127) or, if shifted, Backspace
- (code 8) - which can be reversed with the appropriate DEC private
- mode escape sequence.
-
- deletekey: *string*
- The string to send when the delete key (not the keypad delete key)
- is pressed. If unset it will send the sequence traditionally
- associated with the Execute key.
-
- cutchars: *string*
- The characters used as delimiters for double-click word selection
- (whitespace delimiting is added automatically if resource is given).
-
- When the perl selection extension is in use (the default if compiled
- in, see the rxvtperl(3) manpage), a suitable regex using these
- characters will be created (if the resource exists, otherwise, no
- regex will be created). In this mode, characters outside ISO-8859-1
- can be used.
-
- When the selection extension is not used, only ISO-8859-1 characters
- can be used. If not specified, the built-in default is used:
-
- BACKSLASH `"'&()*,;<=>?@[]^{|}
-
- preeditType: *style*
- OverTheSpot, OffTheSpot, Root; option -pt.
-
- inputMethod: *name*
- *name* of inputMethod to use; option -im.
-
- imLocale: *name*
- The locale to use for opening the IM. You can use an "LC_CTYPE" of
- e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for
- the input extension to be able to input japanese characters while
- staying in another locale; option -imlocale.
-
- imFont: *fontset*
- Specify the font-set used for XIM styles "OverTheSpot" or
- "OffTheSpot". 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 -imfont.
-
- tripleclickwords: *boolean*
- 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 -tcw.
-
- insecure: *boolean*
- Enables "insecure" mode. Rxvt-unicode offers some escape sequences
- that echo arbitrary strings like the icon name or the locale. This
- could be abused if somebody gets 8-bit-clean access to your display,
- whether through a mail client displaying mail bodies unfiltered or
- through write(1) or any other means. Therefore, these sequences are
- disabled by default. (Note that many other terminals, including
- xterm, have these sequences enabled by default, which doesn't make
- it safer, though).
-
- You can enable them by setting this boolean resource or specifying
- -insecure as an option. At the moment, this enables display-answer,
- locale, findfont, icon label and window title requests.
-
- modifier: *modifier*
- Set the key to be interpreted as the Meta key to: alt, meta, hyper,
- super, mod1, mod2, mod3, mod4, mod5; option -mod.
-
- answerbackString: *string*
- Specify the reply rxvt-unicode sends to the shell when an ENQ
- (control-E) character is passed through. It may contain escape
- values as described in the entry on keysym following.
-
- secondaryScreen: *boolean*
- Turn on/off secondary screen (default enabled).
-
- secondaryScroll: *boolean*
- Turn on/off secondary screen scroll (default enabled). If this
- option is enabled, scrolls on the secondary screen will change the
- scrollback buffer and switching to/from the secondary screen will
- instead scroll the screen up.
-
- hold: *boolean*
- Turn on/off hold window after exit support. If enabled, rxvt will
- not immediately destroy its window when the program executed within
- it exits. Instead, it will wait till it is being killed or closed by
- the user.
-
- keysym.*sym*: *string*
- Compile *frills*: Associate *string* with keysym *sym*. The
- intervening resource name keysym. cannot be omitted.
-
- The format of *sym* is "*(modifiers-)key*", where *modifiers* can be
- any combination of ISOLevel3, AppKeypad, Control, NumLock, Shift,
- Meta, Lock, Mod1, Mod2, Mod3, Mod4, Mod5, and the abbreviated I, K,
- C, N, S, M, A, L, 1, 2, 3, 4, 5.
-
- The NumLock, Meta and ISOLevel3 modifiers are usually aliased to
- whatever modifier the NumLock key, Meta/Alt keys or ISO Level3
- Shift/AltGr keys are being mapped. AppKeypad is a synthetic modifier
- mapped to the current application keymap mode state.
-
- The spellings of *key* can be obtained by using xev(1) command or
- searching keysym macros from /usr/X11R6/include/X11/keysymdef.h and
- omitting the prefix XK_. Alternatively you can specify *key* by its
- hex keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s
- is not performed in an exact manner; however, the closest match is
- assured.
-
- *string* may contain escape values ("\n": newline, "\000": octal
- number), see RESOURCES in "man 7 X" for futher details.
-
- You can define a range of keysyms in one shot by providing a
- *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter
- `/' should be a character not used by the strings.
-
- Its usage can be demonstrated by an example:
-
- URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
-
- The above line is equivalent to the following three lines:
-
- URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
- URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
- URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
-
- If *string* takes the form of "command:STRING", the specified STRING
- is interpreted and executed as rxvt's control sequence. For example
- the following means "change the current locale to "zh_CN.GBK" when
- Control-Meta-c is being pressed":
-
- URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
-
- If *string* takes the form "perl:STRING", then the specified STRING
- is passed to the "on_keyboard_command" perl handler. See the
- rxvtperl(3) manpage. For example, the selection extension (activated
- via "rxvt -pe selection") listens for "selection:rot13" events:
-
- URxvt.keysym.M-C-c: perl:selection:rot13
-
- Due the the large number of modifier combinations, a defined key
- mapping will match if at *at least* 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 "a" will
- automatically provide definitions for "Meta-a", "Shift-a" and so on,
- unless some of those are defined mappings themselves.
-
- Unfortunately, this will override built-in key mappings. For example
- if you overwrite the "Insert" key you will disable rxvt's
- "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
- the user-defined keymap using the "builtin:" replacement:
-
- URxvt.keysym.Insert: <my insert key sequence>
- URxvt.keysym.S-Insert: builtin:
-
- The first line defines a mapping for "Insert" and *any* combination
- of modifiers. The second line re-establishes the default mapping for
- "Shift-Insert".
-
- The following example will map Control-Meta-1 and Control-Meta-2 to
- the fonts "suxuseuro" and "9x15bold", so you can have some limited
- font-switching at runtime:
-
- URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
- URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
-
- Other things are possible, e.g. resizing (see rxvt(7) for more
- info):
-
- URxvt.keysym.M-C-3: command:\033[8;25;80t
- URxvt.keysym.M-C-4: command:\033[8;48;110t
-
- perl-ext-common: *string*
- perl-ext: *string*
- Comma-separated list(s) of perl extension scripts (default:
- "default") to use in this terminal instance; option -pe.
-
- Extension names can be prefixed with a "-" sign to prohibit using
- them. This can be useful to selectively disable some extensions
- loaded by default, or specified via the "perl-ext-common" resource.
- For example, "default,-selection" will use all the default extension
- except "selection".
-
- Extension names can also be followed by an argument in angle
- brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
- for searchable scrollback to Alt/Meta-s). Mentioning the same
- extension multiple times with different arguments will pass multiple
- arguments to the extension.
-
- Each extension is looked up in the library directories, loaded if
- necessary, and bound to the current terminal instance.
-
- If both of these resources are the empty string, then the perl
- interpreter will not be initialized. The idea behind two options is
- that perl-ext-common will be used for extensions that should be
- available to all instances, while perl-ext is used for specific
- instances.
-
- perl-eval: *string*
- Perl code to be evaluated when all extensions have been registered.
- See the rxvtperl(3) manpage. Due to security reasons, this resource
- will be ignored when running setuid/setgid.
-
- perl-lib: *path*
- Colon-separated list of additional directories that hold extension
- scripts. When looking for extensions specified by the "perl"
- resource, rxvt will first look in these directories and then in
- /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
- will be ignored when running setuid/setgid.
-
- See the rxvtperl(3) manpage.
-
- selection.pattern-*idx*: *perl-regex*
- Additional selection patterns, see the rxvtperl(3) manpage for
- details.
-
- selection-autotransform.*idx*: *perl-transform*
- Selection auto-transform patterns, see the rxvtperl(3) manpage for
- details.
-
- searchable-scrollback: *keysym*
- Sets the hotkey that starts the incremental scrollback buffer search
- (default: "M-s").
-
- urlLauncher: *string*
- Specifies the program to be started with a URL argument. Used by the
- "selection-popup" and "matcher" perl extensions.
-
- transient-for: *windowid*
- Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
- window id.
-
- override-redirect: *boolean*
- Compile *frills*: Sets override-redirect for the terminal window,
- making it almost invisible to window managers; option
- -override-redirect.
-
- iso14755_52: *boolean*
- Turn on/off ISO 14755 5.2 mode (default enabled).
-
-THE SCROLLBAR
- Lines of text that scroll off the top of the rxvt window (resource:
- saveLines) and can be scrolled back using the scrollbar or by
- keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
- fairly intuitive. The xterm-scrollbar is without arrows and its
- behaviour mimics that of *xterm*
-
- Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up with
- Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with
- Button2.
-
-MOUSE REPORTING
- 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.
-
- 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 ESC [ 6 ~
- (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
- up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
-
-THE SELECTION: SELECTING AND PASTING TEXT
- The behaviour of text selection and insertion/pasting mechanism is
- similar to *xterm*(1).
-
- Selecting:
- Left click at the beginning of the region, drag to the end of the
- region and release; Right click to extend the marked region; Left
- double-click to select a word; Left triple-click to select the
- entire logical line (which can span multiple screen lines), unless
- modified by resource tripleclickwords.
-
- Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
- (Compile: *frills*) will create a rectangular selection instead of a
- normal one. In this mode, every selected row becomes its own line in
- the selection, and trailing whitespace is visually underlined and
- removed from the selection.
-
- Pasting:
- Pressing and releasing the Middle mouse button in an rxvt window
- causes the value of the PRIMARY selection (or CLIPBOARD with the
- Meta modifier) to be inserted as if it had been typed on the
- keyboard.
-
- Pressing Shift-Insert causes the value of the PRIMARY selection to
- be inserted too.
-
-CHANGING FONTS
- Changing fonts (or font sizes, respectively) via the keypad is not yet
- supported in rxvt-unicode. Bug me if you need this.
-
- You can, however, switch fonts at runtime using escape sequences, e.g.:
-
- printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
-
- You can use keyboard shortcuts, too:
-
- URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
- URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
-
- rxvt-unicode will automatically re-apply these fonts to the output so
- far.
-
-ISO 14755 SUPPORT
- 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 if rxvt-unicode has been compiled with
- "--enable-frills", the rest is available when rxvt-unicode was compiled
- with "--enable-iso14755".
-
- * 5.1: Basic method
- This allows you to enter unicode characters using their hexcode.
-
- Start by pressing and holding both "Control" and "Shift", then enter
- hex-digits (between one and six). Releasing "Control" and "Shift"
- will commit the character as if it were typed directly. While
- holding down "Control" and "Shift" you can also enter multiple
- characters by pressing "Space", which will commit the current
- character and lets you start a new one.
-
- As an example of use, imagine a business card with a japanese e-mail
- address, which you cannot type. Fortunately, the card has the e-mail
- address printed as hexcodes, e.g. "671d 65e5". You can enter this
- easily by pressing "Control" and "Shift", followed by
- "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys.
-
- * 5.2: Keyboard symbols entry method
- This mode lets you input characters representing the keycap symbols
- of your keyboard, if representable in the current locale encoding.
-
- Start by pressing "Control" and "Shift" together, then releasing
- them. The next special key (cursor keys, home etc.) you enter will
- not invoke its usual function but instead will insert the
- corresponding keycap symbol. The symbol will only be entered when
- the key has been released, otherwise pressing e.g. "Shift" would
- enter the symbol for "ISO Level 2 Switch", although your intention
- might have been to enter a reverse tab (Shift-Tab).
-
- * 5.3: Screen-selection entry method
- While this is implemented already (it's basically the selection
- mechanism), it could be extended by displaying a unicode character
- map.
-
- * 5.4: Feedback method for identifying displayed characters for later
- input
- This method lets you display the unicode character code associated
- with characters already displayed.
-
- You enter this mode by holding down "Control" and "Shift" together,
- then pressing and holding the left mouse button and moving around.
- The unicode hex code(s) (it might be a combining character) of the
- character under the pointer is displayed until you release "Control"
- and "Shift".
-
- 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.
-
- With respect to conformance, rxvt-unicode is supposed to be compliant to
- both scenario A and B of ISO 14755, including part 5.2.
-
-LOGIN STAMP
- rxvt tries to write an entry into the *utmp*(5) file so that it can be
- seen via the *who(1)* command, and can accept messages. To allow this
- feature, rxvt may need to be installed setuid root on some systems or
- setgid to root or to some other group on others.
-
-COLORS AND GRAPHICS
- In addition to the default foreground and background colours, rxvt can
- display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
- versions of the same). Here is a list of the colours with their names.
-
- color0 (black) = Black
- color1 (red) = Red3
- color2 (green) = Green3
- color3 (yellow) = Yellow3
- color4 (blue) = Blue3
- color5 (magenta) = Magenta3
- color6 (cyan) = Cyan3
- color7 (white) = AntiqueWhite
- color8 (bright black) = Grey25
- color9 (bright red) = Red
- color10 (bright green) = Green
- color11 (bright yellow) = Yellow
- color12 (bright blue) = Blue
- color13 (bright magenta) = Magenta
- color14 (bright cyan) = Cyan
- color15 (bright white) = White
- foreground = Black
- background = White
-
- It is also possible to specify the colour values of foreground,
- background, cursorColor, cursorColor2, colorBD, colorUL as a number
- 0-15, as a convenient shorthand to reference the colour name of
- color0-color15.
-
- In addition to the colours defined above, rxvt offers an additional 72
- colours. The first 64 of those (with indices 16 to 79) consist of a
- 4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed
- by 8 additional shades of gray (with indices 80 to 87).
-
- Together, all those colours implement the 88 colour xterm colours. Only
- the first 16 can be changed using resources currently, the rest can only
- be changed via command sequences ("escape codes").
-
- Note that -rv ("reverseVideo: True") simulates reverse video by always
- swapping the foreground/background colours. This is in contrast to
- *xterm*(1) where the colours are only swapped if they have not otherwise
- been specified. For example,
-
- rxvt -fg Black -bg White -rv
- would yield White on Black, while on *xterm*(1) it would yield Black
- on White.
-
- ALPHA CHANNEL SUPPORT
- If Xft support has been compiled in and as long as Xft/Xrender/X don't
- get their act together, rxvt-unicode will support
- "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
- digits/component) colour specifications, in addition to the ones
- provided by X, where the additional A component specifies opacity
- (alpha) values. The minimum value of 0 is completely transparent). You
- can also prefix any color with "[percent]", where "percent" is a decimal
- percentage (0-100) that specifies the opacity of the color, where 0 is
- completely transparent and 100 is completelxy opaque.
-
- You probably need to specify "-depth 32", too, and have the luck that
- your X-server uses ARGB pixel layout, as X is far from just supporting
- ARGB visuals out of the box, and rxvt-unicode just fudges around.
-
- For example, the following selects an almost completely transparent red
- background, and an almost opaque pink foreground:
-
- rxvt -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
-
- *Please note that transparency of any kind if completely unsupported by
- the author. Don't bug him with installation questions!*
-
-ENVIRONMENT
- rxvt sets and/or uses the following environment variables:
-
- TERM
- Normally set to "rxvt-unicode", unless overwritten at configure
- time, via resources or on the command line.
-
- COLORTERM
- Either "rxvt", "rxvt-xpm", depending on whether rxvt was compiled
- with background image support, and optionally with the added
- extension "-mono" to indicate that rxvt-unicode runs on a monochrome
- screen.
-
- COLORFGBG
- Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
- the colour code used as default foreground/text colour (or the
- string "default" to indicate that the default-colour escape sequence
- is to be used), "bg" is the colour code used as default background
- colour (or the string "default"), and "xpm" is the string "default"
- if rxvt was compiled with background image support. Libraries like
- "ncurses" and "slang" can (and do) use this information to optimize
- screen output.
-
- WINDOWID
- 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).
-
- TERMINFO
- Set to the terminfo directory iff rxvt was configured with
- "--with-terminfo=PATH".
-
- DISPLAY
- Used by rxvt to connect to the display and set to the correct
- display in its child processes.
-
- SHELL
- The shell to be used for command execution, defaults to "/bin/sh".
-
- RXVT_SOCKET
- The unix domain socket path used by rxvtc(1) and rxvtd(1).
-
- Default $HOME/.rxvt-unicode-*<nodename*.
-
- HOME
- Used to locate the default directory for the unix domain socket for
- daemon communications and to locate various resource files (such as
- ".Xdefaults")
-
- XAPPLRESDIR
- Directory where various X resource files are being located.
-
- XENVIRONMENT
- If set and accessible, gives the name of a X resource file to be
- loaded by rxvt.
-
-FILES
- /usr/lib/X11/rgb.txt
- Color names.
-
-SEE ALSO
- rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
- tty(4), utmp(5)
-
-CURRENT PROJECT COORDINATOR
- Project Coordinator
- Marc A. Lehmann <rxvt-unicode@schmorp.de>
-
- <http://software.schmorp.de/pkg/rxvt-unicode.html>
-
-AUTHORS
- John Bovey
- University of Kent, 1992, wrote the original Xvt.
-
- Rob Nation <nation@rocket.sanders.lockheed.com>
- very heavily modified Xvt and came up with Rxvt
-
- Angelo Haritsis <ah@doc.ic.ac.uk>
- wrote the Greek Keyboard Input (no longer in code)
-
- mj olesen <olesen@me.QueensU.CA>
- Wrote the menu system.
-
- Project Coordinator (changes.txt 2.11 to 2.21)
-
- Oezguer Kesim <kesim@math.fu-berlin.de>
- Project Coordinator (changes.txt 2.21a to 2.4.5)
-
- Geoff Wing <gcw@pobox.com>
- Rewrote screen display and text selection routines.
-
- Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
-
- Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
- Forked rxvt-unicode, unicode support, rewrote almost all the code,
- perl extension, random hacks, numerous bugfixes and extensions.
-
- Project Coordinator (Changes 1.0 -)
-
- Emanuele Giaquinta <e.giaquinta@glauco.it>
- Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
-
+++ /dev/null
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
-<head>
- <title>RXVT REFERENCE</title>
- <meta name="description" content="Pod documentation for RXVT REFERENCE" />
- <meta name="inputfile" content="<standard input>" />
- <meta name="outputfile" content="<standard output>" />
- <meta name="created" content="Sun Nov 25 10:35:38 2007" />
- <meta name="generator" content="Pod::Xhtml 1.57" />
-<link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head>
-<body>
-<div class="pod">
-<!-- INDEX START -->
-<h3 id="TOP">Index</h3>
-
-<ul><li><a href="#NAME">NAME</a></li>
-<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
-<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
-<li><a href="#RXVT_UNICODE_URXVT_FREQUENTLY_ASKED_">RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS</a>
-<ul><li><a href="#Meta_Features_amp_Commandline_Issues">Meta, Features & Commandline Issues</a>
-<ul><li><a href="#My_question_isn_t_answered_here_can_">My question isn't answered here, can I ask a human?</a></li>
-<li><a href="#Does_it_support_tabs_can_I_have_a_ta">Does it support tabs, can I have a tabbed rxvt-unicode?</a></li>
-<li><a href="#How_do_I_know_which_rxvt_unicode_ver">How do I know which rxvt-unicode version I'm using?</a></li>
-<li><a href="#Rxvt_unicode_uses_gobs_of_memory_how">Rxvt-unicode uses gobs of memory, how can I reduce that?</a></li>
-<li><a href="#How_can_I_start_urxvtd_in_a_race_fre">How can I start urxvtd in a race-free way?</a></li>
-<li><a href="#How_can_I_start_urxvtd_automatically">How can I start urxvtd automatically when I run urxvtc?</a></li>
-<li><a href="#How_do_I_distinguish_whether_I_m_run">How do I distinguish whether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.</a></li>
-<li><a href="#How_do_I_set_the_correct_full_IP_add">How do I set the correct, full IP address for the DISPLAY variable?</a></li>
-<li><a href="#How_do_I_compile_the_manual_pages_on">How do I compile the manual pages on my own?</a></li>
-<li><a href="#Isn_t_rxvt_unicode_supposed_to_be_sm">Isn't rxvt-unicode supposed to be small? Don't all those features bloat?</a></li>
-<li><a href="#Why_C_isn_t_that_unportable_bloated_">Why C++, isn't that unportable/bloated/uncool?</a></li>
-</ul>
-</li>
-<li><a href="#Rendering_Font_amp_Look_and_Feel_Iss">Rendering, Font & Look and Feel Issues</a>
-<ul><li><a href="#I_can_t_get_transparency_working_wha">I can't get transparency working, what am I doing wrong?</a></li>
-<li><a href="#Why_does_rxvt_unicode_sometimes_leav">Why does rxvt-unicode sometimes leave pixel droppings?</a></li>
-<li><a href="#How_can_I_keep_rxvt_unicode_from_usi">How can I keep rxvt-unicode from using reverse video so much?</a></li>
-<li><a href="#Some_programs_assume_totally_weird_c">Some programs assume totally weird colours (red instead of blue), how can I fix that?</a></li>
-<li><a href="#Can_I_switch_the_fonts_at_runtime">Can I switch the fonts at runtime?</a></li>
-<li><a href="#Why_do_italic_characters_look_as_if_">Why do italic characters look as if clipped?</a></li>
-<li><a href="#Can_I_speed_up_Xft_rendering_somehow">Can I speed up Xft rendering somehow?</a></li>
-<li><a href="#Rxvt_unicode_doesn_t_seem_to_anti_al">Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?</a></li>
-<li><a href="#What_s_with_this_bold_blink_stuff">What's with this bold/blink stuff?</a></li>
-<li><a href="#I_don_t_like_the_screen_colors_How_d">I don't like the screen colors. How do I change them?</a></li>
-<li><a href="#Why_do_some_characters_look_so_much_">Why do some characters look so much different than others?</a></li>
-<li><a href="#How_does_rxvt_unicode_choose_fonts">How does rxvt-unicode choose fonts?</a></li>
-<li><a href="#Why_do_some_chinese_characters_look_">Why do some chinese characters look so different than others?</a></li>
-<li><a href="#How_can_I_make_mplayer_display_video">How can I make mplayer display video correctly?</a></li>
-</ul>
-</li>
-<li><a href="#Keyboard_Mouse_amp_User_Interaction">Keyboard, Mouse & User Interaction</a>
-<ul><li><a href="#The_new_selection_selects_pieces_tha">The new selection selects pieces that are too big, how can I select single words?</a></li>
-<li><a href="#I_don_t_like_the_new_selection_popup">I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?</a></li>
-<li><a href="#The_cursor_moves_when_selecting_text">The cursor moves when selecting text in the current input line, how do I switch this off?</a></li>
-<li><a href="#During_rlogin_ssh_telnet_etc_session">During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?</a></li>
-<li><a href="#My_numerical_keypad_acts_weird_and_g">My numerical keypad acts weird and generates differing output?</a></li>
-<li><a href="#My_Compose_Multi_key_key_is_no_longe">My Compose (Multi_key) key is no longer working.</a></li>
-<li><a href="#I_cannot_type_code_Ctrl_Shift_2_code">I cannot type <code>Ctrl-Shift-2</code> to get an ASCII NUL character due to ISO 14755</a></li>
-<li><a href="#Mouse_cut_paste_suddenly_no_longer_w">Mouse cut/paste suddenly no longer works.</a></li>
-<li><a href="#What_s_with_the_strange_Backspace_De">What's with the strange Backspace/Delete key behaviour?</a></li>
-<li><a href="#I_don_t_like_the_key_bindings_How_do">I don't like the key-bindings. How do I change them?</a></li>
-<li><a href="#I_m_using_keyboard_model_XXX_that_ha">I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following map</a></li>
-</ul>
-</li>
-<li><a href="#Terminal_Configuration">Terminal Configuration</a>
-<ul><li><a href="#Can_I_see_a_typical_configuration">Can I see a typical configuration?</a></li>
-<li><a href="#Why_doesn_t_rxvt_unicode_read_my_res">Why doesn't rxvt-unicode read my resources?</a></li>
-<li><a href="#When_I_log_in_to_another_system_it_t">When I log-in to another system it tells me about missing terminfo data?</a></li>
-<li><a href="#code_tic_code_outputs_some_error_whe"><code>tic</code> outputs some error when compiling the terminfo entry.</a></li>
-<li><a href="#code_bash_code_s_readline_does_not_w"><code>bash</code>'s readline does not work correctly under urxvt.</a></li>
-<li><a href="#I_need_a_termcap_file_entry">I need a termcap file entry.</a></li>
-<li><a href="#Why_does_code_ls_code_no_longer_have">Why does <code>ls</code> no longer have coloured output?</a></li>
-<li><a href="#Why_doesn_t_vim_emacs_etc_use_the_88">Why doesn't vim/emacs etc. use the 88 colour mode?</a></li>
-<li><a href="#Why_doesn_t_vim_emacs_etc_make_use_o">Why doesn't vim/emacs etc. make use of italic?</a></li>
-<li><a href="#Why_are_the_secondary_screen_related">Why are the secondary screen-related options not working properly?</a></li>
-</ul>
-</li>
-<li><a href="#Encoding_Locale_Input_Method_Issues">Encoding / Locale / Input Method Issues</a>
-<ul><li><a href="#Rxvt_unicode_does_not_seem_to_unders">Rxvt-unicode does not seem to understand the selected encoding?</a></li>
-<li><a href="#Unicode_does_not_seem_to_work">Unicode does not seem to work?</a></li>
-<li><a href="#How_does_rxvt_unicode_determine_the_">How does rxvt-unicode determine the encoding to use?</a></li>
-<li><a href="#Is_there_an_option_to_switch_encodin">Is there an option to switch encodings?</a></li>
-<li><a href="#Can_I_switch_locales_at_runtime">Can I switch locales at runtime?</a></li>
-<li><a href="#I_have_problems_getting_my_input_met">I have problems getting my input method working.</a></li>
-<li><a href="#My_input_method_wants_lt_some_encodi">My input method wants <some encoding> but I want UTF-8, what can I do?</a></li>
-<li><a href="#Rxvt_unicode_crashes_when_the_X_Inpu">Rxvt-unicode crashes when the X Input Method changes or exits.</a></li>
-</ul>
-</li>
-<li><a href="#Operating_Systems_Package_Maintainin">Operating Systems / Package Maintaining</a>
-<ul><li><a href="#I_am_using_Debian_GNU_Linux_and_have">I am using Debian GNU/Linux and have a problem...</a></li>
-<li><a href="#I_am_maintaining_rxvt_unicode_for_di">I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?</a></li>
-<li><a href="#I_need_to_make_it_setuid_setgid_to_s">I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?</a></li>
-<li><a href="#I_am_on_FreeBSD_and_rxvt_unicode_doe">I am on FreeBSD and rxvt-unicode does not seem to work at all.</a></li>
-<li><a href="#How_can_I_use_rxvt_unicode_under_cyg">How can I use rxvt-unicode under cygwin?</a></li>
-<li><a href="#Character_widths_are_not_correct">Character widths are not correct.</a></li>
-</ul>
-</li>
-</ul>
-</li>
-<li><a href="#RXVT_UNICODE_TECHNICAL_REFERENCE">RXVT-UNICODE TECHNICAL REFERENCE</a>
-<ul><li><a href="#Definitions">Definitions</a></li>
-<li><a href="#Values">Values</a></li>
-<li><a href="#Escape_Sequences">Escape Sequences</a></li>
-</ul>
-</li>
-<li><a href="#CSI">CSI</a>
-<ul><li><a href="#CSI_Command_Sequence_Introducer_Sequ">CSI (Command Sequence Introducer) Sequences</a></li>
-</ul>
-</li>
-<li><a href="#ESCOBPsA">ESCOBPsA</a></li>
-<li><a href="#ESCOBPsC">ESCOBPsC</a></li>
-<li><a href="#ESCOBPsG">ESCOBPsG</a></li>
-<li><a href="#PrivateModes">PrivateModes</a>
-<ul><li><a href="#DEC_Private_Modes">DEC Private Modes</a></li>
-</ul>
-</li>
-<li><a href="#Priv66">Priv66</a></li>
-<li><a href="#XTerm">XTerm</a>
-<ul><li><a href="#XTerm_Operating_System_Commands">XTerm Operating System Commands</a></li>
-</ul>
-</li>
-<li><a href="#BACKGROUND_IMAGE">BACKGROUND IMAGE</a></li>
-<li><a href="#Mouse">Mouse</a></li>
-<li><a href="#Mouse_Reporting">Mouse Reporting</a></li>
-<li><a href="#KeyCodes">KeyCodes</a></li>
-<li><a href="#Key_Codes">Key Codes</a></li>
-<li><a href="#CONFIGURE_OPTIONS">CONFIGURE OPTIONS</a></li>
-<li><a href="#AUTHORS">AUTHORS</a>
-</li>
-</ul><hr />
-<!-- INDEX END -->
-
-<h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="NAME_CONTENT">
-<p>RXVT REFERENCE - FAQ, command sequences and other background information</p>
-
-</div>
-<h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="SYNOPSIS_CONTENT">
-<pre> # set a new font set
- printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
-
- # change the locale and tell rxvt-unicode about it
- export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
-
- # set window title
- printf '\33]2;%s\007' "new window title"
-
-</pre>
-
-</div>
-<h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="DESCRIPTION_CONTENT">
-<p>This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
-all escape sequences, and other background information.</p>
-<p>The newest version of this document is also available on the World Wide Web at
-<a href="http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html">http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html</a>.</p>
-
-</div>
-<h1 id="RXVT_UNICODE_URXVT_FREQUENTLY_ASKED_">RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="RXVT_UNICODE_URXVT_FREQUENTLY_ASKED_-2">
-
-
-
-
-
-</div>
-<h2 id="Meta_Features_amp_Commandline_Issues">Meta, Features & Commandline Issues</h2>
-<div id="Meta_Features_amp_Commandline_Issues-2">
-
-</div>
-<h3 id="My_question_isn_t_answered_here_can_">My question isn't answered here, can I ask a human?</h3>
-<div id="My_question_isn_t_answered_here_can_-2">
-<p>Before sending me mail, you could go to IRC: <code>irc.freenode.net</code>,
-channel <code>#rxvt-unicode</code> has some rxvt-unicode enthusiasts that might be
-interested in learning about new and exciting problems (but not FAQs :).</p>
-
-</div>
-<h3 id="Does_it_support_tabs_can_I_have_a_ta">Does it support tabs, can I have a tabbed rxvt-unicode?</h3>
-<div id="Does_it_support_tabs_can_I_have_a_ta-2">
-<p>Beginning with version 7.3, there is a perl extension that implements a
-simple tabbed terminal. It is installed by default, so any of these should
-give you tabs:</p>
-<pre> urxvt -pe tabbed
-
- URxvt.perl-ext-common: default,tabbed
-
-</pre>
-<p>It will also work fine with tabbing functionality of many window managers
-or similar tabbing programs, and its embedding-features allow it to be
-embedded into other programs, as witnessed by <cite>doc/rxvt-tabbed</cite> or
-the upcoming <code>Gtk2::URxvt</code> perl module, which features a tabbed urxvt
-(murxvt) terminal as an example embedding application.</p>
-
-</div>
-<h3 id="How_do_I_know_which_rxvt_unicode_ver">How do I know which rxvt-unicode version I'm using?</h3>
-<div id="How_do_I_know_which_rxvt_unicode_ver-2">
-<p>The version number is displayed with the usage (-h). Also the escape
-sequence <code>ESC [ 8 n</code> sets the window title to the version number. When
-using the urxvtc client, the version displayed is that of the
-daemon.</p>
-
-</div>
-<h3 id="Rxvt_unicode_uses_gobs_of_memory_how">Rxvt-unicode uses gobs of memory, how can I reduce that?</h3>
-<div id="Rxvt_unicode_uses_gobs_of_memory_how-2">
-<p>Rxvt-unicode tries to obey the rule of not charging you for something you
-don't use. One thing you should try is to configure out all settings that
-you don't need, for example, Xft support is a resource hog by design,
-when used. Compiling it out ensures that no Xft font will be loaded
-accidentally when rxvt-unicode tries to find a font for your characters.</p>
-<p>Also, many people (me included) like large windows and even larger
-scrollback buffers: Without <code>--enable-unicode3</code>, rxvt-unicode will use
-6 bytes per screen cell. For a 160x?? window this amounts to almost a
-kilobyte per line. A scrollback buffer of 10000 lines will then (if full)
-use 10 Megabytes of memory. With <code>--enable-unicode3</code> it gets worse, as
-rxvt-unicode then uses 8 bytes per screen cell.</p>
-
-</div>
-<h3 id="How_can_I_start_urxvtd_in_a_race_fre">How can I start urxvtd in a race-free way?</h3>
-<div id="How_can_I_start_urxvtd_in_a_race_fre-2">
-<p>Try <code>urxvtd -f -o</code>, which tells urxvtd to open the
-display, create the listening socket and then fork.</p>
-
-</div>
-<h3 id="How_can_I_start_urxvtd_automatically">How can I start urxvtd automatically when I run urxvtc?</h3>
-<div id="How_can_I_start_urxvtd_automatically-2">
-<p>If you want to start urxvtd automatically whenever you run
-urxvtc and the daemon isn't running yet, use this script:</p>
-<pre> #!/bin/sh
- urxvtc "$@"
- if [ $? -eq 2 ]; then
- urxvtd -q -o -f
- urxvtc "$@"
- fi
-
-</pre>
-<p>This tries to create a new terminal, and if fails with exit status 2,
-meaning it couldn't connect to the daemon, it will start the daemon and
-re-run the command. Subsequent invocations of the script will re-use the
-existing daemon.</p>
-
-</div>
-<h3 id="How_do_I_distinguish_whether_I_m_run">How do I distinguish whether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.</h3>
-<div id="How_do_I_distinguish_whether_I_m_run-2">
-<p>The original rxvt and rxvt-unicode always export the variable "COLORTERM",
-so you can check and see if that is set. Note that several programs, JED,
-slrn, Midnight Commander automatically check this variable to decide
-whether or not to use color.</p>
-
-</div>
-<h3 id="How_do_I_set_the_correct_full_IP_add">How do I set the correct, full IP address for the DISPLAY variable?</h3>
-<div id="How_do_I_set_the_correct_full_IP_add-2">
-<p>If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
-insecure mode then it is possible to use the following shell script
-snippets to correctly set the display. If your version of rxvt-unicode
-wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
-the COLORTERM variable can be used to distinguish rxvt-unicode from a
-regular xterm.</p>
-<p>Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
-snippets:</p>
-<pre> # Bourne/Korn/POSIX family of shells:
- [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
- if [ ${TERM:-foo} = xterm ]; then
- stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
- echo -n '^[Z'
- read term_id
- stty icanon echo
- if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
- echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
- read DISPLAY # set it in our local shell
- fi
- fi
-
-</pre>
-
-</div>
-<h3 id="How_do_I_compile_the_manual_pages_on">How do I compile the manual pages on my own?</h3>
-<div id="How_do_I_compile_the_manual_pages_on-2">
-<p>You need to have a recent version of perl installed as <cite>/usr/bin/perl</cite>,
-one that comes with <cite>pod2man</cite>, <cite>pod2text</cite> and <cite>pod2xhtml</cite> (from
-<cite>Pod::Xhtml</cite>). Then go to the doc subdirectory and enter <code>make alldoc</code>.</p>
-
-</div>
-<h3 id="Isn_t_rxvt_unicode_supposed_to_be_sm">Isn't rxvt-unicode supposed to be small? Don't all those features bloat?</h3>
-<div id="Isn_t_rxvt_unicode_supposed_to_be_sm-2">
-<p>I often get asked about this, and I think, no, they didn't cause extra
-bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
-that the urxvt binary is larger (due to some encoding tables always being
-compiled in), but it actually uses less memory (RSS) after startup. Even
-with <code>--disable-everything</code>, this comparison is a bit unfair, as many
-features unique to urxvt (locale, encoding conversion, iso14755 etc.) are
-already in use in this mode.</p>
-<pre> text data bss drs rss filename
- 98398 1664 24 15695 1824 rxvt --disable-everything
- 188985 9048 66616 18222 1788 urxvt --disable-everything
-
-</pre>
-<p>When you <code>--enable-everything</code> (which <i>is</i> unfair, as this involves xft
-and full locale/XIM support which are quite bloaty inside libX11 and my
-libc), the two diverge, but not unreasonably so.</p>
-<pre> text data bss drs rss filename
- 163431 2152 24 20123 2060 rxvt --enable-everything
- 1035683 49680 66648 29096 3680 urxvt --enable-everything
-
-</pre>
-<p>The very large size of the text section is explained by the east-asian
-encoding tables, which, if unused, take up disk space but nothing else
-and can be compiled out unless you rely on X11 core fonts that use those
-encodings. The BSS size comes from the 64k emergency buffer that my c++
-compiler allocates (but of course doesn't use unless you are out of
-memory). Also, using an xft font instead of a core font immediately adds a
-few megabytes of RSS. Xft indeed is responsible for a lot of RSS even when
-not used.</p>
-<p>Of course, due to every character using two or four bytes instead of one,
-a large scrollback buffer will ultimately make rxvt-unicode use more
-memory.</p>
-<p>Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
-still fares rather well. And compared to some monsters like gnome-terminal
-(21152k + extra 4204k in separate processes) or konsole (22200k + extra
-43180k in daemons that stay around after exit, plus half a minute of
-startup time, including the hundreds of warnings it spits out), it fares
-extremely well *g*.</p>
-
-</div>
-<h3 id="Why_C_isn_t_that_unportable_bloated_">Why C++, isn't that unportable/bloated/uncool?</h3>
-<div id="Why_C_isn_t_that_unportable_bloated_-2">
-<p>Is this a question? :) It comes up very often. The simple answer is: I had
-to write it, and C++ allowed me to write and maintain it in a fraction
-of the time and effort (which is a scarce resource for me). Put even
-shorter: It simply wouldn't exist without C++.</p>
-<p>My personal stance on this is that C++ is less portable than C, but in
-the case of rxvt-unicode this hardly matters, as its portability limits
-are defined by things like X11, pseudo terminals, locale support and unix
-domain sockets, which are all less portable than C++ itself.</p>
-<p>Regarding the bloat, see the above question: It's easy to write programs
-in C that use gobs of memory, an certainly possible to write programs in
-C++ that don't. C++ also often comes with large libraries, but this is
-not necessarily the case with GCC. Here is what rxvt links against on my
-system with a minimal config:</p>
-<pre> libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
- libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
- libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
- /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
-
-</pre>
-<p>And here is rxvt-unicode:</p>
-<pre> libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
- libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
- libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
- libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
- /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
-
-</pre>
-<p>No large bloated libraries (of course, none were linked in statically),
-except maybe libX11 :)</p>
-
-
-
-
-
-</div>
-<h2 id="Rendering_Font_amp_Look_and_Feel_Iss">Rendering, Font & Look and Feel Issues</h2>
-<div id="Rendering_Font_amp_Look_and_Feel_Iss-2">
-
-</div>
-<h3 id="I_can_t_get_transparency_working_wha">I can't get transparency working, what am I doing wrong?</h3>
-<div id="I_can_t_get_transparency_working_wha-2">
-<p>First of all, please address all transparency related issues to Sasha Vasko at
-sasha@aftercode.net and do not bug the author about it. Also, if you can't
-get it working consider it a rite of passage: ... and you failed.</p>
-<p>Here are four ways to get transparency. <strong>Do</strong> read the manpage and option
-descriptions for the programs mentioned and rxvt-unicode. Really, do it!</p>
-<p>1. Use transparent mode:</p>
-<pre> Esetroot wallpaper.jpg
- urxvt -tr -tint red -sh 40
-
-</pre>
-<p>That works. If you think it doesn't, you lack transparency and tinting
-support, or you are unable to read.</p>
-<p>2. Use a simple pixmap and emulate pseudo-transparency. This enables you
-to use effects other than tinting and shading: Just shade/tint/whatever
-your picture with gimp or any other tool:</p>
-<pre> convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
- urxvt -pixmap "background.jpg;:root"
-
-</pre>
-<p>That works. If you think it doesn't, you lack AfterImage support, or you
-are unable to read.</p>
-<p>3. Use an ARGB visual:</p>
-<pre> urxvt -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
-
-</pre>
-<p>This requires XFT support, and the support of your X-server. If that
-doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
-there yet, no matter what they claim. Rxvt-Unicode contains the necessary
-bugfixes and workarounds for Xft and Xlib to make it work, but that
-doesn't mean that your WM has the required kludges in place.</p>
-<p>4. Use xcompmgr and let it do the job:</p>
-<pre> xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
- -set _NET_WM_WINDOW_OPACITY 0xc0000000
-
-</pre>
-<p>Then click on a window you want to make transparent. Replace <code>0xc0000000</code>
-by other values to change the degree of opacity. If it doesn't work and
-your server crashes, you got to keep the pieces.</p>
-
-</div>
-<h3 id="Why_does_rxvt_unicode_sometimes_leav">Why does rxvt-unicode sometimes leave pixel droppings?</h3>
-<div id="Why_does_rxvt_unicode_sometimes_leav-2">
-<p>Most fonts were not designed for terminal use, which means that character
-size varies a lot. A font that is otherwise fine for terminal use might
-contain some characters that are simply too wide. Rxvt-unicode will avoid
-these characters. For characters that are just "a bit" too wide a special
-"careful" rendering mode is used that redraws adjacent characters.</p>
-<p>All of this requires that fonts do not lie about character sizes,
-however: Xft fonts often draw glyphs larger than their acclaimed bounding
-box, and rxvt-unicode has no way of detecting this (the correct way is to
-ask for the character bounding box, which unfortunately is wrong in these
-cases).</p>
-<p>It's not clear (to me at least), whether this is a bug in Xft, freetype,
-or the respective font. If you encounter this problem you might try using
-the <code>-lsp</code> option to give the font more height. If that doesn't work, you
-might be forced to use a different font.</p>
-<p>All of this is not a problem when using X11 core fonts, as their bounding
-box data is correct.</p>
-
-</div>
-<h3 id="How_can_I_keep_rxvt_unicode_from_usi">How can I keep rxvt-unicode from using reverse video so much?</h3>
-<div id="How_can_I_keep_rxvt_unicode_from_usi-2">
-<p>First of all, make sure you are running with the right terminal settings
-(<code>TERM=rxvt-unicode</code>), which will get rid of most of these effects. Then
-make sure you have specified colours for italic and bold, as otherwise
-rxvt-unicode might use reverse video to simulate the effect:</p>
-<pre> URxvt.colorBD: white
- URxvt.colorIT: green
-
-</pre>
-
-</div>
-<h3 id="Some_programs_assume_totally_weird_c">Some programs assume totally weird colours (red instead of blue), how can I fix that?</h3>
-<div id="Some_programs_assume_totally_weird_c-2">
-<p>For some unexplainable reason, some rare programs assume a very weird
-colour palette when confronted with a terminal with more than the standard
-8 colours (rxvt-unicode supports 88). The right fix is, of course, to fix
-these programs not to assume non-ISO colours without very good reasons.</p>
-<p>In the meantime, you can either edit your <code>rxvt-unicode</code> terminfo
-definition to only claim 8 colour support or use <code>TERM=rxvt</code>, which will
-fix colours but keep you from using other rxvt-unicode features.</p>
-
-</div>
-<h3 id="Can_I_switch_the_fonts_at_runtime">Can I switch the fonts at runtime?</h3>
-<div id="Can_I_switch_the_fonts_at_runtime_CO">
-<p>Yes, using an escape sequence. Try something like this, which has the same
-effect as using the <code>-fn</code> switch, and takes effect immediately:</p>
-<pre> printf '\33]50;%s\007' "9x15bold,xft:Kochi Gothic"
-
-</pre>
-<p>This is useful if you e.g. work primarily with japanese (and prefer a
-japanese font), but you have to switch to chinese temporarily, where
-japanese fonts would only be in your way.</p>
-<p>You can think of this as a kind of manual ISO-2022 switching.</p>
-
-</div>
-<h3 id="Why_do_italic_characters_look_as_if_">Why do italic characters look as if clipped?</h3>
-<div id="Why_do_italic_characters_look_as_if_-2">
-<p>Many fonts have difficulties with italic characters and hinting. For
-example, the otherwise very nicely hinted font <code>xft:Bitstream Vera Sans
-Mono</code> completely fails in its italic face. A workaround might be to
-enable freetype autohinting, i.e. like this:</p>
-<pre> URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
- URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
-
-</pre>
-
-</div>
-<h3 id="Can_I_speed_up_Xft_rendering_somehow">Can I speed up Xft rendering somehow?</h3>
-<div id="Can_I_speed_up_Xft_rendering_somehow-2">
-<p>Yes, the most obvious way to speed it up is to avoid Xft entirely, as
-it is simply slow. If you still want Xft fonts you might try to disable
-antialiasing (by appending <code>:antialias=false</code>), which saves lots of
-memory and also speeds up rendering considerably.</p>
-
-</div>
-<h3 id="Rxvt_unicode_doesn_t_seem_to_anti_al">Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?</h3>
-<div id="Rxvt_unicode_doesn_t_seem_to_anti_al-2">
-<p>Rxvt-unicode will use whatever you specify as a font. If it needs to
-fall back to its default font search list it will prefer X11 core
-fonts, because they are small and fast, and then use Xft fonts. It has
-antialiasing disabled for most of them, because the author thinks they
-look best that way.</p>
-<p>If you want antialiasing, you have to specify the fonts manually.</p>
-
-</div>
-<h3 id="What_s_with_this_bold_blink_stuff">What's with this bold/blink stuff?</h3>
-<div id="What_s_with_this_bold_blink_stuff_CO">
-<p>If no bold colour is set via <code>colorBD:</code>, bold will invert text using the
-standard foreground colour.</p>
-<p>For the standard background colour, blinking will actually make
-the text blink when compiled with <code>--enable-text-blink</code>. Without
-<code>--enable-text-blink</code>, the blink attribute will be ignored.</p>
-<p>On ANSI colours, bold/blink attributes are used to set high-intensity
-foreground/background colors.</p>
-<p>color0-7 are the low-intensity colors.</p>
-<p>color8-15 are the corresponding high-intensity colors.</p>
-
-</div>
-<h3 id="I_don_t_like_the_screen_colors_How_d">I don't like the screen colors. How do I change them?</h3>
-<div id="I_don_t_like_the_screen_colors_How_d-2">
-<p>You can change the screen colors at run-time using <cite>~/.Xdefaults</cite>
-resources (or as long-options).</p>
-<p>Here are values that are supposed to resemble a VGA screen,
-including the murky brown that passes for low-intensity yellow:</p>
-<pre> URxvt.color0: #000000
- URxvt.color1: #A80000
- URxvt.color2: #00A800
- URxvt.color3: #A8A800
- URxvt.color4: #0000A8
- URxvt.color5: #A800A8
- URxvt.color6: #00A8A8
- URxvt.color7: #A8A8A8
-
- URxvt.color8: #000054
- URxvt.color9: #FF0054
- URxvt.color10: #00FF54
- URxvt.color11: #FFFF54
- URxvt.color12: #0000FF
- URxvt.color13: #FF00FF
- URxvt.color14: #00FFFF
- URxvt.color15: #FFFFFF
-
-</pre>
-<p>And here is a more complete set of non-standard colors.</p>
-<pre> URxvt.cursorColor: #dc74d1
- URxvt.pointerColor: #dc74d1
- URxvt.background: #0e0e0e
- URxvt.foreground: #4ad5e1
- URxvt.color0: #000000
- URxvt.color8: #8b8f93
- URxvt.color1: #dc74d1
- URxvt.color9: #dc74d1
- URxvt.color2: #0eb8c7
- URxvt.color10: #0eb8c7
- URxvt.color3: #dfe37e
- URxvt.color11: #dfe37e
- URxvt.color5: #9e88f0
- URxvt.color13: #9e88f0
- URxvt.color6: #73f7ff
- URxvt.color14: #73f7ff
- URxvt.color7: #e1dddd
- URxvt.color15: #e1dddd
-
-</pre>
-<p>They have been described (not by me) as "pretty girly".</p>
-
-</div>
-<h3 id="Why_do_some_characters_look_so_much_">Why do some characters look so much different than others?</h3>
-<div id="Why_do_some_characters_look_so_much_-2">
-<p>See next entry.</p>
-
-</div>
-<h3 id="How_does_rxvt_unicode_choose_fonts">How does rxvt-unicode choose fonts?</h3>
-<div id="How_does_rxvt_unicode_choose_fonts_C">
-<p>Most fonts do not contain the full range of Unicode, which is
-fine. Chances are that the font you (or the admin/package maintainer of
-your system/os) have specified does not cover all the characters you want
-to display.</p>
-<p><strong>rxvt-unicode</strong> makes a best-effort try at finding a replacement
-font. Often the result is fine, but sometimes the chosen font looks
-bad/ugly/wrong. Some fonts have totally strange characters that don't
-resemble the correct glyph at all, and rxvt-unicode lacks the artificial
-intelligence to detect that a specific glyph is wrong: it has to believe
-the font that the characters it claims to contain indeed look correct.</p>
-<p>In that case, select a font of your taste and add it to the font list,
-e.g.:</p>
-<pre> urxvt -fn basefont,font2,font3...
-
-</pre>
-<p>When rxvt-unicode sees a character, it will first look at the base
-font. If the base font does not contain the character, it will go to the
-next font, and so on. Specifying your own fonts will also speed up this
-search and use less resources within rxvt-unicode and the X-server.</p>
-<p>The only limitation is that none of the fonts may be larger than the base
-font, as the base font defines the terminal character cell size, which
-must be the same due to the way terminals work.</p>
-
-</div>
-<h3 id="Why_do_some_chinese_characters_look_">Why do some chinese characters look so different than others?</h3>
-<div id="Why_do_some_chinese_characters_look_-2">
-<p>This is because there is a difference between script and language --
-rxvt-unicode does not know which language the text that is output is,
-as it only knows the unicode character codes. If rxvt-unicode first
-sees a japanese/chinese character, it might choose a japanese font for
-display. Subsequent japanese characters will use that font. Now, many
-chinese characters aren't represented in japanese fonts, so when the first
-non-japanese character comes up, rxvt-unicode will look for a chinese font
--- unfortunately at this point, it will still use the japanese font for
-chinese characters that are also in the japanese font.</p>
-<p>The workaround is easy: just tag a chinese font at the end of your font
-list (see the previous question). The key is to view the font list as
-a preference list: If you expect more japanese, list a japanese font
-first. If you expect more chinese, put a chinese font first.</p>
-<p>In the future it might be possible to switch language preferences at
-runtime (the internal data structure has no problem with using different
-fonts for the same character at the same time, but no interface for this
-has been designed yet).</p>
-<p>Until then, you might get away with switching fonts at runtime (see <a href="#Can_I_switch_the_fonts_at_runtime">Can I switch the fonts at runtime?</a> later in this document).</p>
-
-</div>
-<h3 id="How_can_I_make_mplayer_display_video">How can I make mplayer display video correctly?</h3>
-<div id="How_can_I_make_mplayer_display_video-2">
-<p>We are working on it, in the meantime, as a workaround, use something like:</p>
-<pre> urxvt -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
-
-
-
-
-</pre>
-
-</div>
-<h2 id="Keyboard_Mouse_amp_User_Interaction">Keyboard, Mouse & User Interaction</h2>
-<div id="Keyboard_Mouse_amp_User_Interaction_">
-
-</div>
-<h3 id="The_new_selection_selects_pieces_tha">The new selection selects pieces that are too big, how can I select single words?</h3>
-<div id="The_new_selection_selects_pieces_tha-2">
-<p>If you want to select e.g. alphanumeric words, you can use the following
-setting:</p>
-<pre> URxvt.selection.pattern-0: ([[:word:]]+)
-
-</pre>
-<p>If you click more than twice, the selection will be extended
-more and more.</p>
-<p>To get a selection that is very similar to the old code, try this pattern:</p>
-<pre> URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
-
-</pre>
-<p>Please also note that the <i>LeftClick Shift-LeftClik</i> combination also
-selects words like the old code.</p>
-
-</div>
-<h3 id="I_don_t_like_the_new_selection_popup">I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?</h3>
-<div id="I_don_t_like_the_new_selection_popup-2">
-<p>You can disable the perl extension completely by setting the
-<strong>perl-ext-common</strong> resource to the empty string, which also keeps
-rxvt-unicode from initialising perl, saving memory.</p>
-<p>If you only want to disable specific features, you first have to
-identify which perl extension is responsible. For this, read the section
-<strong>PREPACKAGED EXTENSIONS</strong> in the urxvtperl(3) manpage. For
-example, to disable the <strong>selection-popup</strong> and <strong>option-popup</strong>, specify
-this <strong>perl-ext-common</strong> resource:</p>
-<pre> URxvt.perl-ext-common: default,-selection-popup,-option-popup
-
-</pre>
-<p>This will keep the default extensions, but disable the two popup
-extensions. Some extensions can also be configured, for example,
-scrollback search mode is triggered by <strong>M-s</strong>. You can move it to any
-other combination either by setting the <strong>searchable-scrollback</strong> resource:</p>
-<pre> URxvt.searchable-scrollback: CM-s
-
-</pre>
-
-</div>
-<h3 id="The_cursor_moves_when_selecting_text">The cursor moves when selecting text in the current input line, how do I switch this off?</h3>
-<div id="The_cursor_moves_when_selecting_text-2">
-<p>See next entry.</p>
-
-</div>
-<h3 id="During_rlogin_ssh_telnet_etc_session">During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?</h3>
-<div id="During_rlogin_ssh_telnet_etc_session-2">
-<p>These are caused by the <code>readline</code> perl extension. Under normal
-circumstances, it will move your cursor around when you click into the
-line that contains it. It tries hard not to do this at the wrong moment,
-but when running a program that doesn't parse cursor movements or in some
-cases during rlogin sessions, it fails to detect this properly.</p>
-<p>You can permanently switch this feature off by disabling the <code>readline</code>
-extension:</p>
-<pre> URxvt.perl-ext-common: default,-readline
-
-</pre>
-
-</div>
-<h3 id="My_numerical_keypad_acts_weird_and_g">My numerical keypad acts weird and generates differing output?</h3>
-<div id="My_numerical_keypad_acts_weird_and_g-2">
-<p>Some Debian GNUL/Linux users seem to have this problem, although no
-specific details were reported so far. It is possible that this is caused
-by the wrong <code>TERM</code> setting, although the details of whether and how
-this can happen are unknown, as <code>TERM=rxvt</code> should offer a compatible
-keymap. See the answer to the previous question, and please report if that
-helped.</p>
-
-</div>
-<h3 id="My_Compose_Multi_key_key_is_no_longe">My Compose (Multi_key) key is no longer working.</h3>
-<div id="My_Compose_Multi_key_key_is_no_longe-2">
-<p>The most common causes for this are that either your locale is not set
-correctly, or you specified a <strong>preeditStyle</strong> that is not supported by
-your input method. For example, if you specified <strong>OverTheSpot</strong> and
-your input method (e.g. the default input method handling Compose keys)
-does not support this (for instance because it is not visual), then
-rxvt-unicode will continue without an input method.</p>
-<p>In this case either do not specify a <strong>preeditStyle</strong> or specify more than
-one pre-edit style, such as <strong>OverTheSpot,Root,None</strong>.</p>
-
-</div>
-<h3 id="I_cannot_type_code_Ctrl_Shift_2_code">I cannot type <code>Ctrl-Shift-2</code> to get an ASCII NUL character due to ISO 14755</h3>
-<div id="I_cannot_type_code_Ctrl_Shift_2_code-2">
-<p>Either try <code>Ctrl-2</code> alone (it often is mapped to ASCII NUL even on
-international keyboards) or simply use ISO 14755 support to your
-advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for other
-codes, too, such as <code>Ctrl-Shift-1-d</code> to type the default telnet escape
-character and so on.</p>
-
-</div>
-<h3 id="Mouse_cut_paste_suddenly_no_longer_w">Mouse cut/paste suddenly no longer works.</h3>
-<div id="Mouse_cut_paste_suddenly_no_longer_w-2">
-<p>Make sure that mouse reporting is actually turned off since killing
-some editors prematurely may leave the mouse in mouse report mode. I've
-heard that tcsh may use mouse reporting unless it otherwise specified. A
-quick check is to see if cut/paste works when the Alt or Shift keys are
-depressed.</p>
-
-</div>
-<h3 id="What_s_with_the_strange_Backspace_De">What's with the strange Backspace/Delete key behaviour?</h3>
-<div id="What_s_with_the_strange_Backspace_De-2">
-<p>Assuming that the physical Backspace key corresponds to the
-Backspace keysym (not likely for Linux ... see the following
-question) there are two standard values that can be used for
-Backspace: <code>^H</code> and <code>^?</code>.</p>
-<p>Historically, either value is correct, but rxvt-unicode adopts the debian
-policy of using <code>^?</code> when unsure, because it's the one and only correct
-choice :).</p>
-<p>Rxvt-unicode tries to inherit the current stty settings and uses the value
-of `erase' to guess the value for backspace. If rxvt-unicode wasn't
-started from a terminal (say, from a menu or by remote shell), then the
-system value of `erase', which corresponds to CERASE in <termios.h>, will
-be used (which may not be the same as your stty setting).</p>
-<p>For starting a new rxvt-unicode:</p>
-<pre> # use Backspace = ^H
- $ stty erase ^H
- $ urxvt
-
- # use Backspace = ^?
- $ stty erase ^?
- $ urxvt
-
-</pre>
-<p>Toggle with <code>ESC [ 36 h</code> / <code>ESC [ 36 l</code>.</p>
-<p>For an existing rxvt-unicode:</p>
-<pre> # use Backspace = ^H
- $ stty erase ^H
- $ echo -n "^[[36h"
-
- # use Backspace = ^?
- $ stty erase ^?
- $ echo -n "^[[36l"
-
-</pre>
-<p>This helps satisfy some of the Backspace discrepancies that occur, but
-if you use Backspace = <code>^H</code>, make sure that the termcap/terminfo value
-properly reflects that.</p>
-<p>The Delete key is a another casualty of the ill-defined Backspace problem.
-To avoid confusion between the Backspace and Delete keys, the Delete
-key has been assigned an escape sequence to match the vt100 for Execute
-(<code>ESC [ 3 ~</code>) and is in the supplied termcap/terminfo.</p>
-<p>Some other Backspace problems:</p>
-<p>some editors use termcap/terminfo,
-some editors (vim I'm told) expect Backspace = ^H,
-GNU Emacs (and Emacs-like editors) use ^H for help.</p>
-<p>Perhaps someday this will all be resolved in a consistent manner.</p>
-
-</div>
-<h3 id="I_don_t_like_the_key_bindings_How_do">I don't like the key-bindings. How do I change them?</h3>
-<div id="I_don_t_like_the_key_bindings_How_do-2">
-<p>There are some compile-time selections available via configure. Unless
-you have run "configure" with the <code>--disable-resources</code> option you can
-use the `keysym' resource to alter the keystrings associated with keysyms.</p>
-<p>Here's an example for a URxvt session started using <code>urxvt -name URxvt</code></p>
-<pre> URxvt.keysym.Home: \033[1~
- URxvt.keysym.End: \033[4~
- URxvt.keysym.C-apostrophe: \033<C-'>
- URxvt.keysym.C-slash: \033<C-/>
- URxvt.keysym.C-semicolon: \033<C-;>
- URxvt.keysym.C-grave: \033<C-`>
- URxvt.keysym.C-comma: \033<C-,>
- URxvt.keysym.C-period: \033<C-.>
- URxvt.keysym.C-0x60: \033<C-`>
- URxvt.keysym.C-Tab: \033<C-Tab>
- URxvt.keysym.C-Return: \033<C-Return>
- URxvt.keysym.S-Return: \033<S-Return>
- URxvt.keysym.S-space: \033<S-Space>
- URxvt.keysym.M-Up: \033<M-Up>
- URxvt.keysym.M-Down: \033<M-Down>
- URxvt.keysym.M-Left: \033<M-Left>
- URxvt.keysym.M-Right: \033<M-Right>
- URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
- URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
- URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
-
-</pre>
-<p>See some more examples in the documentation for the <strong>keysym</strong> resource.</p>
-
-</div>
-<h3 id="I_m_using_keyboard_model_XXX_that_ha">I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following map</h3>
-<div id="I_m_using_keyboard_model_XXX_that_ha-2">
-<pre> KP_Insert == Insert
- F22 == Print
- F27 == Home
- F29 == Prior
- F33 == End
- F35 == Next
-
-</pre>
-<p>Rather than have rxvt-unicode try to accommodate all the various possible
-keyboard mappings, it is better to use `xmodmap' to remap the keys as
-required for your particular machine.</p>
-
-
-
-
-
-</div>
-<h2 id="Terminal_Configuration">Terminal Configuration</h2>
-<div id="Terminal_Configuration_CONTENT">
-
-</div>
-<h3 id="Can_I_see_a_typical_configuration">Can I see a typical configuration?</h3>
-<div id="Can_I_see_a_typical_configuration_CO">
-<p>The default configuration tries to be xterm-like, which I don't like that
-much, but it's least surprise to regular users.</p>
-<p>As a rxvt or rxvt-unicode user, you are practically supposed to invest
-time into customising your terminal. To get you started, here is the
-author's .Xdefaults entries, with comments on what they do. It's certainly
-not <i>typical</i>, but what's typical...</p>
-<pre> URxvt.cutchars: "()*,<>[]{}|'
- URxvt.print-pipe: cat >/tmp/xxx
-
-</pre>
-<p>These are just for testing stuff.</p>
-<pre> URxvt.imLocale: ja_JP.UTF-8
- URxvt.preeditType: OnTheSpot,None
-
-</pre>
-<p>This tells rxvt-unicode to use a special locale when communicating with
-the X Input Method, and also tells it to only use the OnTheSpot pre-edit
-type, which requires the <code>xim-onthespot</code> perl extension but rewards me
-with correct-looking fonts.</p>
-<pre> URxvt.perl-lib: /root/lib/urxvt
- URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
- URxvt.selection.pattern-0: ( at .*? line \\d+)
- URxvt.selection.pattern-1: ^(/[^:]+):\
- URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
- URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
-
-</pre>
-<p>This is my perl configuration. The first two set the perl library
-directory and also tells urxvt to use a large number of extensions. I
-develop for myself mostly, so I actually use most of the extensions I
-write.</p>
-<p>The selection stuff mainly makes the selection perl-error-message aware
-and tells it to convert perl error messages into vi-commands to load the
-relevant file and go tot he error line number.</p>
-<pre> URxvt.scrollstyle: plain
- URxvt.secondaryScroll: true
-
-</pre>
-<p>As the documentation says: plain is the preferred scrollbar for the
-author. The <code>secondaryScroll</code> configures urxvt to scroll in full-screen
-apps, like screen, so lines scrolled out of screen end up in urxvt's
-scrollback buffer.</p>
-<pre> URxvt.background: #000000
- URxvt.foreground: gray90
- URxvt.color7: gray90
- URxvt.colorBD: #ffffff
- URxvt.cursorColor: #e0e080
- URxvt.throughColor: #8080f0
- URxvt.highlightColor: #f0f0f0
-
-</pre>
-<p>Some colours. Not sure which ones are being used or even non-defaults, but
-these are in my .Xdefaults. Most notably, they set foreground/background
-to light gray/black, and also make sure that the colour 7 matches the
-default foreground colour.</p>
-<pre> URxvt.underlineColor: yellow
-
-</pre>
-<p>Another colour, makes underline lines look different. Sometimes hurts, but
-is mostly a nice effect.</p>
-<pre> URxvt.geometry: 154x36
- URxvt.loginShell: false
- URxvt.meta: ignore
- URxvt.utmpInhibit: true
-
-</pre>
-<p>Uh, well, should be mostly self-explanatory. By specifying some defaults
-manually, I can quickly switch them for testing.</p>
-<pre> URxvt.saveLines: 8192
-
-</pre>
-<p>A large scrollback buffer is essential. Really.</p>
-<pre> URxvt.mapAlert: true
-
-</pre>
-<p>The only case I use it is for my IRC window, which I like to keep
-iconified till people msg me (which beeps).</p>
-<pre> URxvt.visualBell: true
-
-</pre>
-<p>The audible bell is often annoying, especially when in a crowd.</p>
-<pre> URxvt.insecure: true
-
-</pre>
-<p>Please don't hack my mutt! Ooops...</p>
-<pre> URxvt.pastableTabs: false
-
-</pre>
-<p>I once thought this is a great idea.</p>
-<pre> urxvt.font: 9x15bold,\
- -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
- -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
- [codeset=JISX0208]xft:Kochi Gothic, \
- xft:Bitstream Vera Sans Mono:autohint=true, \
- xft:Code2000:antialias=false
- urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
- urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
- urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
-
-</pre>
-<p>I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
-overwhelmed. A special note: the <code>9x15bold</code> mentioned above is actually
-the version from XFree-3.3, as XFree-4 replaced it by a totally different
-font (different glyphs for <code>;</code> and many other harmless characters),
-while the second font is actually the <code>9x15bold</code> from XFree4/XOrg. The
-bold version has less chars than the medium version, so I use it for rare
-characters, too. When editing sources with vim, I use italic for comments
-and other stuff, which looks quite good with Bitstream Vera anti-aliased.</p>
-<p>Terminus is a quite bad font (many very wrong glyphs), but for most of my
-purposes, it works, and gives a different look, as my normal (Non-bold)
-font is already bold, and I want to see a difference between bold and
-normal fonts.</p>
-<p>Please note that I used the <code>urxvt</code> instance name and not the <code>URxvt</code>
-class name. Thats because I use different configs for different purposes,
-for example, my IRC window is started with <code>-name IRC</code>, and uses these
-defaults:</p>
-<pre> IRC*title: IRC
- IRC*geometry: 87x12+535+542
- IRC*saveLines: 0
- IRC*mapAlert: true
- IRC*font: suxuseuro
- IRC*boldFont: suxuseuro
- IRC*colorBD: white
- IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
- IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
-
-</pre>
-<p><code>Alt-Shift-1</code> and <code>Alt-Shift-2</code> switch between two different font
-sizes. <code>suxuseuro</code> allows me to keep an eye (and actually read)
-stuff while keeping a very small window. If somebody pastes something
-complicated (e.g. japanese), I temporarily switch to a larger font.</p>
-<p>The above is all in my <code>.Xdefaults</code> (I don't use <code>.Xresources</code> nor
-<code>xrdb</code>). I also have some resources in a separate <code>.Xdefaults-hostname</code>
-file for different hosts, for example, on ym main desktop, I use:</p>
-<pre> URxvt.keysym.C-M-q: command:\033[3;5;5t
- URxvt.keysym.C-M-y: command:\033[3;5;606t
- URxvt.keysym.C-M-e: command:\033[3;1605;5t
- URxvt.keysym.C-M-c: command:\033[3;1605;606t
- URxvt.keysym.C-M-p: perl:test
-
-</pre>
-<p>The first for keysym definitions allow me to quickly bring some windows
-in the layout I like most. Ion users might start laughing but will stop
-immediately when I tell them that I use my own Fvwm2 module for much the
-same effect as Ion provides, and I only very rarely use the above key
-combinations :-></p>
-
-</div>
-<h3 id="Why_doesn_t_rxvt_unicode_read_my_res">Why doesn't rxvt-unicode read my resources?</h3>
-<div id="Why_doesn_t_rxvt_unicode_read_my_res-2">
-<p>Well, why, indeed? It does, in a way very similar to other X
-applications. Most importantly, this means that if you or your OS loads
-resources into the X display (the right way to do it), rxvt-unicode will
-ignore any resource files in your home directory. It will only read
-<cite>$HOME/.Xdefaults</cite> when no resources are attached to the display.</p>
-<p>If you have or use an <cite>$HOME/.Xresources</cite> file, chances are that
-resources are loaded into your X-server. In this case, you have to
-re-login after every change (or run <cite>xrdb -merge $HOME/.Xresources</cite>).</p>
-<p>Also consider the form resources have to use:</p>
-<pre> URxvt.resource: value
-
-</pre>
-<p>If you want to use another form (there are lots of different ways of
-specifying resources), make sure you understand whether and why it
-works. If unsure, use the form above.</p>
-
-</div>
-<h3 id="When_I_log_in_to_another_system_it_t">When I log-in to another system it tells me about missing terminfo data?</h3>
-<div id="When_I_log_in_to_another_system_it_t-2">
-<p>The terminal description used by rxvt-unicode is not as widely available
-as that for xterm, or even rxvt (for which the same problem often arises).</p>
-<p>The correct solution for this problem is to install the terminfo, this can
-be done like this (with ncurses' infocmp and works as user and admin):</p>
-<pre> REMOTE=remotesystem.domain
- infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
-
-</pre>
-<p>... or by installing rxvt-unicode normally on the remote system,</p>
-<p>One some systems you might need to set <code>$TERMINFO</code> to the full path of
-<cite>$HOME/.terminfo</cite> for this to work.</p>
-<p>If you cannot or do not want to do this, then you can simply set
-<code>TERM=rxvt</code> or even <code>TERM=xterm</code>, and live with the small number of
-problems arising, which includes wrong keymapping, less and different
-colours and some refresh errors in fullscreen applications. It's a nice
-quick-and-dirty workaround for rare cases, though.</p>
-<p>If you always want to do this (and are fine with the consequences) you
-can either recompile rxvt-unicode with the desired TERM value or use a
-resource to set it:</p>
-<pre> URxvt.termName: rxvt
-
-</pre>
-<p>If you don't plan to use <strong>rxvt</strong> (quite common...) you could also replace
-the rxvt terminfo file with the rxvt-unicode one and use <code>TERM=rxvt</code>.</p>
-
-</div>
-<h3 id="code_tic_code_outputs_some_error_whe"><code>tic</code> outputs some error when compiling the terminfo entry.</h3>
-<div id="code_tic_code_outputs_some_error_whe-2">
-<p>Most likely it's the empty definition for <code>enacs=</code>. Just replace it by
-<code>enacs=\E[0@</code> and try again.</p>
-
-</div>
-<h3 id="code_bash_code_s_readline_does_not_w"><code>bash</code>'s readline does not work correctly under urxvt.</h3>
-<div id="code_bash_code_s_readline_does_not_w-2">
-<p>See next entry.</p>
-
-</div>
-<h3 id="I_need_a_termcap_file_entry">I need a termcap file entry.</h3>
-<div id="I_need_a_termcap_file_entry_CONTENT">
-<p>One reason you might want this is that some distributions or operating
-systems still compile some programs using the long-obsoleted termcap
-library (Fedora Core's bash is one example) and rely on a termcap entry
-for <code>rxvt-unicode</code>.</p>
-<p>You could use rxvt's termcap entry with reasonable results in many cases.
-You can also create a termcap entry by using terminfo's infocmp program
-like this:</p>
-<pre> infocmp -C rxvt-unicode
-
-</pre>
-<p>Or you could use this termcap entry, generated by the command above:</p>
-<pre> rxvt-unicode|rxvt-unicode terminal (X Window System):\
- :am:bw:eo:km:mi:ms:xn:xo:\
- :co#80:it#8:li#24:lm#0:\
- :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
- :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
- :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
- :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
- :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
- :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
- :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
- :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
- :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
- :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
- :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
- :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
- :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
- :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
- :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
- :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
- :vs=\E[?25h:
-
-</pre>
-
-</div>
-<h3 id="Why_does_code_ls_code_no_longer_have">Why does <code>ls</code> no longer have coloured output?</h3>
-<div id="Why_does_code_ls_code_no_longer_have-2">
-<p>The <code>ls</code> in the GNU coreutils unfortunately doesn't use terminfo to
-decide whether a terminal has colour, but uses its own configuration
-file. Needless to say, <code>rxvt-unicode</code> is not in its default file (among
-with most other terminals supporting colour). Either add:</p>
-<pre> TERM rxvt-unicode
-
-</pre>
-<p>to <code>/etc/DIR_COLORS</code> or simply add:</p>
-<pre> alias ls='ls --color=auto'
-
-</pre>
-<p>to your <code>.profile</code> or <code>.bashrc</code>.</p>
-
-</div>
-<h3 id="Why_doesn_t_vim_emacs_etc_use_the_88">Why doesn't vim/emacs etc. use the 88 colour mode?</h3>
-<div id="Why_doesn_t_vim_emacs_etc_use_the_88-2">
-<p>See next entry.</p>
-
-</div>
-<h3 id="Why_doesn_t_vim_emacs_etc_make_use_o">Why doesn't vim/emacs etc. make use of italic?</h3>
-<div id="Why_doesn_t_vim_emacs_etc_make_use_o-2">
-<p>See next entry.</p>
-
-</div>
-<h3 id="Why_are_the_secondary_screen_related">Why are the secondary screen-related options not working properly?</h3>
-<div id="Why_are_the_secondary_screen_related-2">
-<p>Make sure you are using <code>TERM=rxvt-unicode</code>. Some pre-packaged
-distributions (most notably Debian GNU/Linux) break rxvt-unicode
-by setting <code>TERM</code> to <code>rxvt</code>, which doesn't have these extra
-features. Unfortunately, some of these (most notably, again, Debian
-GNU/Linux) furthermore fail to even install the <code>rxvt-unicode</code> terminfo
-file, so you will need to install it on your own (See the question <strong>When
-I log-in to another system it tells me about missing terminfo data?</strong> on
-how to do this).</p>
-
-
-
-
-
-</div>
-<h2 id="Encoding_Locale_Input_Method_Issues">Encoding / Locale / Input Method Issues</h2>
-<div id="Encoding_Locale_Input_Method_Issues_">
-
-</div>
-<h3 id="Rxvt_unicode_does_not_seem_to_unders">Rxvt-unicode does not seem to understand the selected encoding?</h3>
-<div id="Rxvt_unicode_does_not_seem_to_unders-2">
-<p>See next entry.</p>
-
-</div>
-<h3 id="Unicode_does_not_seem_to_work">Unicode does not seem to work?</h3>
-<div id="Unicode_does_not_seem_to_work_CONTEN">
-<p>If you encounter strange problems like typing an accented character but
-getting two unrelated other characters or similar, or if program output is
-subtly garbled, then you should check your locale settings.</p>
-<p>Rxvt-unicode must be started with the same <code>LC_CTYPE</code> setting as the
-programs running in it. Often rxvt-unicode is started in the <code>C</code> locale,
-while the login script running within the rxvt-unicode window changes the
-locale to something else, e.g. <code>en_GB.UTF-8</code>. Needless to say, this is
-not going to work, and is the most common cause for problems.</p>
-<p>The best thing is to fix your startup environment, as you will likely run
-into other problems. If nothing works you can try this in your .profile.</p>
-<pre> printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
-
-</pre>
-<p>If this doesn't work, then maybe you use a <code>LC_CTYPE</code> specification not
-supported on your systems. Some systems have a <code>locale</code> command which
-displays this (also, <code>perl -e0</code> can be used to check locale settings, as
-it will complain loudly if it cannot set the locale). If it displays something
-like:</p>
-<pre> locale: Cannot set LC_CTYPE to default locale: ...
-
-</pre>
-<p>Then the locale you specified is not supported on your system.</p>
-<p>If nothing works and you are sure that everything is set correctly then
-you will need to remember a little known fact: Some programs just don't
-support locales :(</p>
-
-</div>
-<h3 id="How_does_rxvt_unicode_determine_the_">How does rxvt-unicode determine the encoding to use?</h3>
-<div id="How_does_rxvt_unicode_determine_the_-2">
-<p>See next entry.</p>
-
-</div>
-<h3 id="Is_there_an_option_to_switch_encodin">Is there an option to switch encodings?</h3>
-<div id="Is_there_an_option_to_switch_encodin-2">
-<p>Unlike some other terminals, rxvt-unicode has no encoding switch, and no
-specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
-UTF-8 or any other encodings with respect to terminal I/O.</p>
-<p>The reasons is that there exists a perfectly fine mechanism for selecting
-the encoding, doing I/O and (most important) communicating this to all
-applications so everybody agrees on character properties such as width
-and code number. This mechanism is the <i>locale</i>. Applications not using
-that info will have problems (for example, <code>xterm</code> gets the width of
-characters wrong as it uses its own, locale-independent table under all
-locales).</p>
-<p>Rxvt-unicode uses the <code>LC_CTYPE</code> locale category to select encoding. All
-programs doing the same (that is, most) will automatically agree in the
-interpretation of characters.</p>
-<p>Unfortunately, there is no system-independent way to select locales, nor
-is there a standard on how locale specifiers will look like.</p>
-<p>On most systems, the content of the <code>LC_CTYPE</code> environment variable
-contains an arbitrary string which corresponds to an already-installed
-locale. Common names for locales are <code>en_US.UTF-8</code>, <code>de_DE.ISO-8859-15</code>,
-<code>ja_JP.EUC-JP</code>, i.e. <code>language_country.encoding</code>, but other forms
-(i.e. <code>de</code> or <code>german</code>) are also common.</p>
-<p>Rxvt-unicode ignores all other locale categories, and except for
-the encoding, ignores country or language-specific settings,
-i.e. <code>de_DE.UTF-8</code> and <code>ja_JP.UTF-8</code> are the normally same to
-rxvt-unicode.</p>
-<p>If you want to use a specific encoding you have to make sure you start
-rxvt-unicode with the correct <code>LC_CTYPE</code> category.</p>
-
-</div>
-<h3 id="Can_I_switch_locales_at_runtime">Can I switch locales at runtime?</h3>
-<div id="Can_I_switch_locales_at_runtime_CONT">
-<p>Yes, using an escape sequence. Try something like this, which sets
-rxvt-unicode's idea of <code>LC_CTYPE</code>.</p>
-<pre> printf '\33]701;%s\007' ja_JP.SJIS
-
-</pre>
-<p>See also the previous answer.</p>
-<p>Sometimes this capability is rather handy when you want to work in
-one locale (e.g. <code>de_DE.UTF-8</code>) but some programs don't support it
-(e.g. UTF-8). For example, I use this script to start <code>xjdic</code>, which
-first switches to a locale supported by xjdic and back later:</p>
-<pre> printf '\33]701;%s\007' ja_JP.SJIS
- xjdic -js
- printf '\33]701;%s\007' de_DE.UTF-8
-
-</pre>
-<p>You can also use xterm's <code>luit</code> program, which usually works fine, except
-for some locales where character width differs between program- and
-rxvt-unicode-locales.</p>
-
-</div>
-<h3 id="I_have_problems_getting_my_input_met">I have problems getting my input method working.</h3>
-<div id="I_have_problems_getting_my_input_met-2">
-<p>Try a search engine, as this is slightly different for every input method server.</p>
-<p>Here is a checklist:</p>
-<dl>
- <dt>- Make sure your locale <i>and</i> the imLocale are supported on your OS.</dt>
- <dd>
- <p>Try <code>locale -a</code> or check the documentation for your OS.</p>
- </dd>
- <dt>- Make sure your locale or imLocale matches a locale supported by your XIM.</dt>
- <dd>
- <p>For example, <strong>kinput2</strong> does not support UTF-8 locales, you should use
-<code>ja_JP.EUC-JP</code> or equivalent.</p>
- </dd>
- <dt>- Make sure your XIM server is actually running.</dt>
- <dt>- Make sure the <code>XMODIFIERS</code> environment variable is set correctly when <i>starting</i> rxvt-unicode.</dt>
- <dd>
- <p>When you want to use e.g. <strong>kinput2</strong>, it must be set to
-<code>@im=kinput2</code>. For <strong>scim</strong>, use <code>@im=SCIM</code>. You can see what input
-method servers are running with this command:</p>
-<pre> xprop -root XIM_SERVERS
-
-</pre>
- </dd>
- <dt></dt>
-</dl>
-
-</div>
-<h3 id="My_input_method_wants_lt_some_encodi">My input method wants <some encoding> but I want UTF-8, what can I do?</h3>
-<div id="My_input_method_wants_lt_some_encodi-2">
-<p>You can specify separate locales for the input method and the rest of the
-terminal, using the resource <code>imlocale</code>:</p>
-<pre> URxvt.imlocale: ja_JP.EUC-JP
-
-</pre>
-<p>Now you can start your terminal with <code>LC_CTYPE=ja_JP.UTF-8</code> and still
-use your input method. Please note, however, that, depending on your Xlib
-version, you may not be able to input characters outside <code>EUC-JP</code> in a
-normal way then, as your input method limits you.</p>
-
-</div>
-<h3 id="Rxvt_unicode_crashes_when_the_X_Inpu">Rxvt-unicode crashes when the X Input Method changes or exits.</h3>
-<div id="Rxvt_unicode_crashes_when_the_X_Inpu-2">
-<p>Unfortunately, this is unavoidable, as the XIM protocol is racy by
-design. Applications can avoid some crashes at the expense of memory
-leaks, and Input Methods can avoid some crashes by careful ordering at
-exit time. <strong>kinput2</strong> (and derived input methods) generally succeeds,
-while <strong>SCIM</strong> (or similar input methods) fails. In the end, however,
-crashes cannot be completely avoided even if both sides cooperate.</p>
-<p>So the only workaround is not to kill your Input Method Servers.</p>
-
-
-
-
-
-</div>
-<h2 id="Operating_Systems_Package_Maintainin">Operating Systems / Package Maintaining</h2>
-<div id="Operating_Systems_Package_Maintainin-2">
-
-</div>
-<h3 id="I_am_using_Debian_GNU_Linux_and_have">I am using Debian GNU/Linux and have a problem...</h3>
-<div id="I_am_using_Debian_GNU_Linux_and_have-2">
-<p>The Debian GNU/Linux package of rxvt-unicode in sarge contains large
-patches that considerably change the behaviour of rxvt-unicode (but
-unfortunately this notice has been removed). Before reporting a bug to
-the original rxvt-unicode author please download and install the genuine
-version (<a href="http://software.schmorp.de#rxvt-unicode">http://software.schmorp.de#rxvt-unicode</a>) and try to reproduce
-the problem. If you cannot, chances are that the problems are specific to
-Debian GNU/Linux, in which case it should be reported via the Debian Bug
-Tracking System (use <code>reportbug</code> to report the bug).</p>
-<p>For other problems that also affect the Debian package, you can and
-probably should use the Debian BTS, too, because, after all, it's also a
-bug in the Debian version and it serves as a reminder for other users that
-might encounter the same issue.</p>
-
-</div>
-<h3 id="I_am_maintaining_rxvt_unicode_for_di">I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?</h3>
-<div id="I_am_maintaining_rxvt_unicode_for_di-2">
-<p>You should build one binary with the default options. <cite>configure</cite>
-now enables most useful options, and the trend goes to making them
-runtime-switchable, too, so there is usually no drawback to enabling them,
-except higher disk and possibly memory usage. The perl interpreter should
-be enabled, as important functionality (menus, selection, likely more in
-the future) depends on it.</p>
-<p>You should not overwrite the <code>perl-ext-common</code> snd <code>perl-ext</code> resources
-system-wide (except maybe with <code>defaults</code>). This will result in useful
-behaviour. If your distribution aims at low memory, add an empty
-<code>perl-ext-common</code> resource to the app-defaults file. This will keep the
-perl interpreter disabled until the user enables it.</p>
-<p>If you can/want build more binaries, I recommend building a minimal
-one with <code>--disable-everything</code> (very useful) and a maximal one with
-<code>--enable-everything</code> (less useful, it will be very big due to a lot of
-encodings built-in that increase download times and are rarely used).</p>
-
-</div>
-<h3 id="I_need_to_make_it_setuid_setgid_to_s">I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?</h3>
-<div id="I_need_to_make_it_setuid_setgid_to_s-2">
-<p>It should be, starting with release 7.1. You are encouraged to properly
-install urxvt with privileges necessary for your OS now.</p>
-<p>When rxvt-unicode detects that it runs setuid or setgid, it will fork
-into a helper process for privileged operations (pty handling on some
-systems, utmp/wtmp/lastlog handling on others) and drop privileges
-immediately. This is much safer than most other terminals that keep
-privileges while running (but is more relevant to urxvt, as it contains
-things as perl interpreters, which might be "helpful" to attackers).</p>
-<p>This forking is done as the very first within main(), which is very early
-and reduces possible bugs to initialisation code run before main(), or
-things like the dynamic loader of your system, which should result in very
-little risk.</p>
-
-</div>
-<h3 id="I_am_on_FreeBSD_and_rxvt_unicode_doe">I am on FreeBSD and rxvt-unicode does not seem to work at all.</h3>
-<div id="I_am_on_FreeBSD_and_rxvt_unicode_doe-2">
-<p>Rxvt-unicode requires the symbol <code>__STDC_ISO_10646__</code> to be defined
-in your compile environment, or an implementation that implements it,
-whether it defines the symbol or not. <code>__STDC_ISO_10646__</code> requires that
-<strong>wchar_t</strong> is represented as unicode.</p>
-<p>As you might have guessed, FreeBSD does neither define this symbol nor
-does it support it. Instead, it uses its own internal representation of
-<strong>wchar_t</strong>. This is, of course, completely fine with respect to standards.</p>
-<p>However, that means rxvt-unicode only works in <code>POSIX</code>, <code>ISO-8859-1</code> and
-<code>UTF-8</code> locales under FreeBSD (which all use Unicode as <strong>wchar_t</strong>.</p>
-<p><code>__STDC_ISO_10646__</code> is the only sane way to support multi-language
-apps in an OS, as using a locale-dependent (and non-standardized)
-representation of <strong>wchar_t</strong> makes it impossible to convert between
-<strong>wchar_t</strong> (as used by X11 and your applications) and any other encoding
-without implementing OS-specific-wrappers for each and every locale. There
-simply are no APIs to convert <strong>wchar_t</strong> into anything except the current
-locale encoding.</p>
-<p>Some applications (such as the formidable <strong>mlterm</strong>) work around this
-by carrying their own replacement functions for character set handling
-with them, and either implementing OS-dependent hacks or doing multiple
-conversions (which is slow and unreliable in case the OS implements
-encodings slightly different than the terminal emulator).</p>
-<p>The rxvt-unicode author insists that the right way to fix this is in the
-system libraries once and for all, instead of forcing every app to carry
-complete replacements for them :)</p>
-
-</div>
-<h3 id="How_can_I_use_rxvt_unicode_under_cyg">How can I use rxvt-unicode under cygwin?</h3>
-<div id="How_can_I_use_rxvt_unicode_under_cyg-2">
-<p>rxvt-unicode should compile and run out of the box on cygwin, using
-the X11 libraries that come with cygwin. libW11 emulation is no
-longer supported (and makes no sense, either, as it only supported a
-single font). I recommend starting the X-server in <code>-multiwindow</code> or
-<code>-rootless</code> mode instead, which will result in similar look&feel as the
-old libW11 emulation.</p>
-<p>At the time of this writing, cygwin didn't seem to support any multi-byte
-encodings (you might try <code>LC_CTYPE=C-UTF-8</code>), so you are likely limited
-to 8-bit encodings.</p>
-
-</div>
-<h3 id="Character_widths_are_not_correct">Character widths are not correct.</h3>
-<div id="Character_widths_are_not_correct_CON">
-<p>urxvt uses the system wcwidth function to know the information about
-the width of characters, so on systems with incorrect locale data you
-will likely get bad results. Two notorious examples are Solaris 9,
-where single-width characters like U+2514 are reported as double-width,
-and Darwin 8, where combining chars are reported having width 1.</p>
-<p>The solution is to upgrade your system or switch to a better one. A
-possibly working workaround is to use a wcwidth implementation like</p>
-<p>http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c</p>
-
-</div>
-<h1 id="RXVT_UNICODE_TECHNICAL_REFERENCE">RXVT-UNICODE TECHNICAL REFERENCE</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="RXVT_UNICODE_TECHNICAL_REFERENCE_CON">
-<p>The rest of this document describes various technical aspects of
-<strong>rxvt-unicode</strong>. First the description of supported command sequences,
-followed by pixmap support and last by a description of all features
-selectable at <code>configure</code> time.</p>
-
-</div>
-<h2 id="Definitions">Definitions</h2>
-<div id="Definitions_CONTENT">
-<dl>
- <dt><strong><code>c</code></strong></dt>
- <dd>
- <p>The literal character c.</p>
- </dd>
- <dt><strong><code>C</code></strong></dt>
- <dd>
- <p>A single (required) character.</p>
- </dd>
- <dt><strong><code>Ps</code></strong></dt>
- <dd>
- <p>A single (usually optional) numeric parameter, composed of one or more
-digits.</p>
- </dd>
- <dt><strong><code>Pm</code></strong></dt>
- <dd>
- <p>A multiple numeric parameter composed of any number of single numeric
-parameters, separated by <code>;</code> character(s).</p>
- </dd>
- <dt><strong><code>Pt</code></strong></dt>
- <dd>
- <p>A text parameter composed of printable characters.</p>
- </dd>
-</dl>
-
-</div>
-<h2 id="Values">Values</h2>
-<div id="Values_CONTENT">
-<dl>
- <dt><strong><code>ENQ</code></strong></dt>
- <dd>
- <p>Enquiry (Ctrl-E) = Send Device Attributes (DA)
-request attributes from terminal. See <strong><code>ESC [ Ps c</code></strong>.</p>
- </dd>
- <dt><strong><code>BEL</code></strong></dt>
- <dd>
- <p>Bell (Ctrl-G)</p>
- </dd>
- <dt><strong><code>BS</code></strong></dt>
- <dd>
- <p>Backspace (Ctrl-H)</p>
- </dd>
- <dt><strong><code>TAB</code></strong></dt>
- <dd>
- <p>Horizontal Tab (HT) (Ctrl-I)</p>
- </dd>
- <dt><strong><code>LF</code></strong></dt>
- <dd>
- <p>Line Feed or New Line (NL) (Ctrl-J)</p>
- </dd>
- <dt><strong><code>VT</code></strong></dt>
- <dd>
- <p>Vertical Tab (Ctrl-K) same as <strong><code>LF</code></strong></p>
- </dd>
- <dt><strong><code>FF</code></strong></dt>
- <dd>
- <p>Form Feed or New Page (NP) (Ctrl-L) same as <strong><code>LF</code></strong></p>
- </dd>
- <dt><strong><code>CR</code></strong></dt>
- <dd>
- <p>Carriage Return (Ctrl-M)</p>
- </dd>
- <dt><strong><code>SO</code></strong></dt>
- <dd>
- <p>Shift Out (Ctrl-N), invokes the G1 character set.
-Switch to Alternate Character Set</p>
- </dd>
- <dt><strong><code>SI</code></strong></dt>
- <dd>
- <p>Shift In (Ctrl-O), invokes the G0 character set (the default).
-Switch to Standard Character Set</p>
- </dd>
- <dt><strong><code>SPC</code></strong></dt>
- <dd>
- <p>Space Character</p>
- </dd>
-</dl>
-
-</div>
-<h2 id="Escape_Sequences">Escape Sequences</h2>
-<div id="Escape_Sequences_CONTENT">
-<dl>
- <dt><strong><code>ESC # 8</code></strong></dt>
- <dd>
- <p>DEC Screen Alignment Test (DECALN)</p>
- </dd>
- <dt><strong><code>ESC 7</code></strong></dt>
- <dd>
- <p>Save Cursor (SC)</p>
- </dd>
- <dt><strong><code>ESC 8</code></strong></dt>
- <dd>
- <p>Restore Cursor</p>
- </dd>
- <dt><strong><code>ESC =</code></strong></dt>
- <dd>
- <p>Application Keypad (SMKX). See also next sequence.</p>
- </dd>
- <dt><strong><code>ESC</code></strong></dt>
- <dd>
- <p>Normal Keypad (RMKX)</p>
- <p><strong>Note:</strong> If the numeric keypad is activated, eg, <strong>Num_Lock</strong> has been
-pressed, numbers or control functions are generated by the numeric keypad
-(see Key Codes).</p>
- </dd>
- <dt><strong><code>ESC D</code></strong></dt>
- <dd>
- <p>Index (IND)</p>
- </dd>
- <dt><strong><code>ESC E</code></strong></dt>
- <dd>
- <p>Next Line (NEL)</p>
- </dd>
- <dt><strong><code>ESC H</code></strong></dt>
- <dd>
- <p>Tab Set (HTS)</p>
- </dd>
- <dt><strong><code>ESC M</code></strong></dt>
- <dd>
- <p>Reverse Index (RI)</p>
- </dd>
- <dt><strong><code>ESC N</code></strong></dt>
- <dd>
- <p>Single Shift Select of G2 Character Set (SS2): affects next character
-only <i>unimplemented</i></p>
- </dd>
- <dt><strong><code>ESC O</code></strong></dt>
- <dd>
- <p>Single Shift Select of G3 Character Set (SS3): affects next character
-only <i>unimplemented</i></p>
- </dd>
- <dt><strong><code>ESC Z</code></strong></dt>
- <dd>
- <p>Obsolete form of returns: <strong><code>ESC [ ? 1 ; 2 C</code></strong> <i>rxvt-unicode compile-time option</i></p>
- </dd>
- <dt><strong><code>ESC c</code></strong></dt>
- <dd>
- <p>Full reset (RIS)</p>
- </dd>
- <dt><strong><code>ESC n</code></strong></dt>
- <dd>
- <p>Invoke the G2 Character Set (LS2)</p>
- </dd>
- <dt><strong><code>ESC o</code></strong></dt>
- <dd>
- <p>Invoke the G3 Character Set (LS3)</p>
- </dd>
- <dt><strong><code>ESC ( C</code></strong></dt>
- <dd>
- <p>Designate G0 Character Set (ISO 2022), see below for values of <code>C</code>.</p>
- </dd>
- <dt><strong><code>ESC ) C</code></strong></dt>
- <dd>
- <p>Designate G1 Character Set (ISO 2022), see below for values of <code>C</code>.</p>
- </dd>
- <dt><strong><code>ESC * C</code></strong></dt>
- <dd>
- <p>Designate G2 Character Set (ISO 2022), see below for values of <code>C</code>.</p>
- </dd>
- <dt><strong><code>ESC + C</code></strong></dt>
- <dd>
- <p>Designate G3 Character Set (ISO 2022), see below for values of <code>C</code>.</p>
- </dd>
- <dt><strong><code>ESC $ C</code></strong></dt>
- <dd>
- <p>Designate Kanji Character Set</p>
- <p>Where <strong><code>C</code></strong> is one of:</p>
-<table><tr><td>C = 0 </td><td>DEC Special Character and Line Drawing Set</td></tr><tr><td>C = A </td><td>United Kingdom (UK)</td></tr><tr><td>C = B </td><td>United States (USASCII)</td></tr><tr><td>C = <</td><td>Multinational character set unimplemented</td></tr><tr><td>C = 5 </td><td>Finnish character set unimplemented</td></tr><tr><td>C = C </td><td>Finnish character set unimplemented</td></tr><tr><td>C = K </td><td>German character set unimplemented</td></tr></table> </dd>
-</dl>
-<p><span id="CSI">CSI</span></p>
-
-</div>
-<h2 id="CSI_Command_Sequence_Introducer_Sequ">CSI (Command Sequence Introducer) Sequences</h2>
-<div id="CSI_Command_Sequence_Introducer_Sequ-2">
-<dl>
- <dt><strong><code>ESC [ Ps @</code></strong></dt>
- <dd>
- <p>Insert <strong><code>Ps</code></strong> (Blank) Character(s) [default: 1] (ICH)<span id="ESCOBPsA">ESCOBPsA</span></p>
- </dd>
- <dt><strong><code>ESC [ Ps A</code></strong></dt>
- <dd>
- <p>Cursor Up <strong><code>Ps</code></strong> Times [default: 1] (CUU)</p>
- </dd>
- <dt><strong><code>ESC [ Ps B</code></strong></dt>
- <dd>
- <p>Cursor Down <strong><code>Ps</code></strong> Times [default: 1] (CUD)<span id="ESCOBPsC">ESCOBPsC</span></p>
- </dd>
- <dt><strong><code>ESC [ Ps C</code></strong></dt>
- <dd>
- <p>Cursor Forward <strong><code>Ps</code></strong> Times [default: 1] (CUF)</p>
- </dd>
- <dt><strong><code>ESC [ Ps D</code></strong></dt>
- <dd>
- <p>Cursor Backward <strong><code>Ps</code></strong> Times [default: 1] (CUB)</p>
- </dd>
- <dt><strong><code>ESC [ Ps E</code></strong></dt>
- <dd>
- <p>Cursor Down <strong><code>Ps</code></strong> Times [default: 1] and to first column</p>
- </dd>
- <dt><strong><code>ESC [ Ps F</code></strong></dt>
- <dd>
- <p>Cursor Up <strong><code>Ps</code></strong> Times [default: 1] and to first column<span id="ESCOBPsG">ESCOBPsG</span></p>
- </dd>
- <dt><strong><code>ESC [ Ps G</code></strong></dt>
- <dd>
- <p>Cursor to Column <strong><code>Ps</code></strong> (HPA)</p>
- </dd>
- <dt><strong><code>ESC [ Ps;Ps H</code></strong></dt>
- <dd>
- <p>Cursor Position [row;column] [default: 1;1] (CUP)</p>
- </dd>
- <dt><strong><code>ESC [ Ps I</code></strong></dt>
- <dd>
- <p>Move forward <strong><code>Ps</code></strong> tab stops [default: 1]</p>
- </dd>
- <dt><strong><code>ESC [ Ps J</code></strong></dt>
- <dd>
- <p>Erase in Display (ED)</p>
-<table><tr><td>Ps = 0</td><td>Clear Below (default)</td></tr><tr><td>Ps = 1</td><td>Clear Above</td></tr><tr><td>Ps = 2</td><td>Clear All</td></tr></table> </dd>
- <dt><strong><code>ESC [ Ps K</code></strong></dt>
- <dd>
- <p>Erase in Line (EL)</p>
-<table><tr><td>Ps = 0</td><td>Clear to Right (default)</td></tr><tr><td>Ps = 1</td><td>Clear to Left</td></tr><tr><td>Ps = 2</td><td>Clear All</td></tr></table> </dd>
- <dt><strong><code>ESC [ Ps L</code></strong></dt>
- <dd>
- <p>Insert <strong><code>Ps</code></strong> Line(s) [default: 1] (IL)</p>
- </dd>
- <dt><strong><code>ESC [ Ps M</code></strong></dt>
- <dd>
- <p>Delete <strong><code>Ps</code></strong> Line(s) [default: 1] (DL)</p>
- </dd>
- <dt><strong><code>ESC [ Ps P</code></strong></dt>
- <dd>
- <p>Delete <strong><code>Ps</code></strong> Character(s) [default: 1] (DCH)</p>
- </dd>
- <dt><strong><code>ESC [ Ps;Ps;Ps;Ps;Ps T</code></strong></dt>
- <dd>
- <p>Initiate . <i>unimplemented</i> Parameters are
-[func;startx;starty;firstrow;lastrow].</p>
- </dd>
- <dt><strong><code>ESC [ Ps W</code></strong></dt>
- <dd>
- <p>Tabulator functions</p>
-<table><tr><td>Ps = 0</td><td>Tab Set (HTS)</td></tr><tr><td>Ps = 2</td><td>Tab Clear (TBC), Clear Current Column (default)</td></tr><tr><td>Ps = 5</td><td>Tab Clear (TBC), Clear All</td></tr></table> </dd>
- <dt><strong><code>ESC [ Ps X</code></strong></dt>
- <dd>
- <p>Erase <strong><code>Ps</code></strong> Character(s) [default: 1] (ECH)</p>
- </dd>
- <dt><strong><code>ESC [ Ps Z</code></strong></dt>
- <dd>
- <p>Move backward <strong><code>Ps</code></strong> [default: 1] tab stops</p>
- </dd>
- <dt><strong><code>ESC [ Ps '</code></strong></dt>
- <dd>
- <p>See <strong><code>ESC [ Ps G</code></strong></p>
- </dd>
- <dt><strong><code>ESC [ Ps a</code></strong></dt>
- <dd>
- <p>See <strong><code>ESC [ Ps C</code></strong></p>
- </dd>
- <dt><strong><code>ESC [ Ps c</code></strong></dt>
- <dd>
- <p>Send Device Attributes (DA)
-<strong><code>Ps = 0</code></strong> (or omitted): request attributes from terminal
-returns: <strong><code>ESC [ ? 1 ; 2 c</code></strong> (``I am a VT100 with Advanced Video
-Option'')</p>
- </dd>
- <dt><strong><code>ESC [ Ps d</code></strong></dt>
- <dd>
- <p>Cursor to Line <strong><code>Ps</code></strong> (VPA)</p>
- </dd>
- <dt><strong><code>ESC [ Ps e</code></strong></dt>
- <dd>
- <p>See <strong><code>ESC [ Ps A</code></strong></p>
- </dd>
- <dt><strong><code>ESC [ Ps;Ps f</code></strong></dt>
- <dd>
- <p>Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]</p>
- </dd>
- <dt><strong><code>ESC [ Ps g</code></strong></dt>
- <dd>
- <p>Tab Clear (TBC)</p>
-<table><tr><td>Ps = 0</td><td>Clear Current Column (default)</td></tr><tr><td>Ps = 3</td><td>Clear All (TBC)</td></tr></table> </dd>
- <dt><strong><code>ESC [ Pm h</code></strong></dt>
- <dd>
- <p>Set Mode (SM). See <strong><code>ESC [ Pm l</code></strong> sequence for description of <code>Pm</code>.</p>
- </dd>
- <dt><strong><code>ESC [ Ps i</code></strong></dt>
- <dd>
- <p>Printing. See also the <code>print-pipe</code> resource.</p>
-<table><tr><td>Ps = 0</td><td>print screen (MC0)</td></tr><tr><td>Ps = 4</td><td>disable transparent print mode (MC4)</td></tr><tr><td>Ps = 5</td><td>enable transparent print mode (MC5)</td></tr></table> </dd>
- <dt><strong><code>ESC [ Pm l</code></strong></dt>
- <dd>
- <p>Reset Mode (RM)</p>
- <p>
- <dl>
- <dt><strong><code>Ps = 4</code></strong></dt>
-<table><tr><td>h</td><td>Insert Mode (SMIR)</td></tr><tr><td>l</td><td>Replace Mode (RMIR)</td></tr></table> <dt><strong><code>Ps = 20</code></strong> (partially implemented)</dt>
-<table><tr><td>h</td><td>Automatic Newline (LNM)</td></tr><tr><td>l</td><td>Normal Linefeed (LNM)</td></tr></table> </dl>
- </p>
- </dd>
- <dt><strong><code>ESC [ Pm m</code></strong></dt>
- <dd>
- <p>Character Attributes (SGR)</p>
-<table><tr><td>Ps = 0</td><td>Normal (default)</td></tr><tr><td>Ps = 1 / 21</td><td>On / Off Bold (bright fg)</td></tr><tr><td>Ps = 3 / 23</td><td>On / Off Italic</td></tr><tr><td>Ps = 4 / 24</td><td>On / Off Underline</td></tr><tr><td>Ps = 5 / 25</td><td>On / Off Slow Blink (bright bg)</td></tr><tr><td>Ps = 6 / 26</td><td>On / Off Rapid Blink (bright bg)</td></tr><tr><td>Ps = 7 / 27</td><td>On / Off Inverse</td></tr><tr><td>Ps = 8 / 27</td><td>On / Off Invisible (NYI)</td></tr><tr><td>Ps = 30 / 40</td><td>fg/bg Black</td></tr><tr><td>Ps = 31 / 41</td><td>fg/bg Red</td></tr><tr><td>Ps = 32 / 42</td><td>fg/bg Green</td></tr><tr><td>Ps = 33 / 43</td><td>fg/bg Yellow</td></tr><tr><td>Ps = 34 / 44</td><td>fg/bg Blue</td></tr><tr><td>Ps = 35 / 45</td><td>fg/bg Magenta</td></tr><tr><td>Ps = 36 / 46</td><td>fg/bg Cyan</td></tr><tr><td>Ps = 38;5 / 48;5</td><td>set fg/bg to color #m (ISO 8613-6)</td></tr><tr><td>Ps = 37 / 47</td><td>fg/bg White</td></tr><tr><td>Ps = 39 / 49</td><td>fg/bg Default</td></tr><tr><td>Ps = 90 / 100</td><td>fg/bg Bright Black</td></tr><tr><td>Ps = 91 / 101</td><td>fg/bg Bright Red</td></tr><tr><td>Ps = 92 / 102</td><td>fg/bg Bright Green</td></tr><tr><td>Ps = 93 / 103</td><td>fg/bg Bright Yellow</td></tr><tr><td>Ps = 94 / 104</td><td>fg/bg Bright Blue</td></tr><tr><td>Ps = 95 / 105</td><td>fg/bg Bright Magenta</td></tr><tr><td>Ps = 96 / 106</td><td>fg/bg Bright Cyan</td></tr><tr><td>Ps = 97 / 107</td><td>fg/bg Bright White</td></tr><tr><td>Ps = 99 / 109</td><td>fg/bg Bright Default</td></tr></table> </dd>
- <dt><strong><code>ESC [ Ps n</code></strong></dt>
- <dd>
- <p>Device Status Report (DSR)</p>
-<table><tr><td>Ps = 5</td><td>Status Report ESC [ 0 n (``OK'')</td></tr><tr><td>Ps = 6</td><td>Report Cursor Position (CPR) [row;column] as ESC [ r ; c R</td></tr><tr><td>Ps = 7</td><td>Request Display Name</td></tr><tr><td>Ps = 8</td><td>Request Version Number (place in window title)</td></tr></table> </dd>
- <dt><strong><code>ESC [ Ps;Ps r</code></strong></dt>
- <dd>
- <p>Set Scrolling Region [top;bottom]
-[default: full size of window] (CSR)</p>
- </dd>
- <dt><strong><code>ESC [ s</code></strong></dt>
- <dd>
- <p>Save Cursor (SC)</p>
- </dd>
- <dt><strong><code>ESC [ Ps;Pt t</code></strong></dt>
- <dd>
- <p>Window Operations</p>
-<table><tr><td>Ps = 1</td><td>Deiconify (map) window</td></tr><tr><td>Ps = 2</td><td>Iconify window</td></tr><tr><td>Ps = 3</td><td>ESC [ 3 ; X ; Y t Move window to (X|Y)</td></tr><tr><td>Ps = 4</td><td>ESC [ 4 ; H ; W t Resize to WxH pixels</td></tr><tr><td>Ps = 5</td><td>Raise window</td></tr><tr><td>Ps = 6</td><td>Lower window</td></tr><tr><td>Ps = 7</td><td>Refresh screen once</td></tr><tr><td>Ps = 8</td><td>ESC [ 8 ; R ; C t Resize to R rows and C columns</td></tr><tr><td>Ps = 11</td><td>Report window state (responds with Ps = 1 or Ps = 2)</td></tr><tr><td>Ps = 13</td><td>Report window position (responds with Ps = 3)</td></tr><tr><td>Ps = 14</td><td>Report window pixel size (responds with Ps = 4)</td></tr><tr><td>Ps = 18</td><td>Report window text size (responds with Ps = 7)</td></tr><tr><td>Ps = 19</td><td>Currently the same as Ps = 18, but responds with Ps = 9</td></tr><tr><td>Ps = 20</td><td>Reports icon label (ESC ] L NAME \234)</td></tr><tr><td>Ps = 21</td><td>Reports window title (ESC ] l NAME \234)</td></tr><tr><td>Ps = 24..</td><td>Set window height to Ps rows</td></tr></table> </dd>
- <dt><strong><code>ESC [ u</code></strong></dt>
- <dd>
- <p>Restore Cursor</p>
- </dd>
- <dt><strong><code>ESC [ Ps x</code></strong></dt>
- <dd>
- <p>Request Terminal Parameters (DECREQTPARM)</p>
- </dd>
-</dl>
-<p><span id="PrivateModes">PrivateModes</span></p>
-
-</div>
-<h2 id="DEC_Private_Modes">DEC Private Modes</h2>
-<div id="DEC_Private_Modes_CONTENT">
-<dl>
- <dt><strong><code>ESC [ ? Pm h</code></strong></dt>
- <dd>
- <p>DEC Private Mode Set (DECSET)</p>
- </dd>
- <dt><strong><code>ESC [ ? Pm l</code></strong></dt>
- <dd>
- <p>DEC Private Mode Reset (DECRST)</p>
- </dd>
- <dt><strong><code>ESC [ ? Pm r</code></strong></dt>
- <dd>
- <p>Restore previously saved DEC Private Mode Values.</p>
- </dd>
- <dt><strong><code>ESC [ ? Pm s</code></strong></dt>
- <dd>
- <p>Save DEC Private Mode Values.</p>
- </dd>
- <dt><strong><code>ESC [ ? Pm t</code></strong></dt>
- <dd>
- <p>Toggle DEC Private Mode Values (rxvt extension). <i>where</i></p>
- <p>
- <dl>
- <dt><strong><code>Pm = 1</code></strong> (DECCKM)</dt>
-<table><tr><td>h</td><td>Application Cursor Keys</td></tr><tr><td>l</td><td>Normal Cursor Keys</td></tr></table> <dt><strong><code>Pm = 2</code></strong> (ANSI/VT52 mode)</dt>
-<table><tr><td>h</td><td>Enter VT52 mode</td></tr><tr><td>l</td><td>Enter VT52 mode</td></tr></table> <dt><strong><code>Pm = 3</code></strong></dt>
-<table><tr><td>h</td><td>132 Column Mode (DECCOLM)</td></tr><tr><td>l</td><td>80 Column Mode (DECCOLM)</td></tr></table> <dt><strong><code>Pm = 4</code></strong></dt>
-<table><tr><td>h</td><td>Smooth (Slow) Scroll (DECSCLM)</td></tr><tr><td>l</td><td>Jump (Fast) Scroll (DECSCLM)</td></tr></table> <dt><strong><code>Pm = 5</code></strong></dt>
-<table><tr><td>h</td><td>Reverse Video (DECSCNM)</td></tr><tr><td>l</td><td>Normal Video (DECSCNM)</td></tr></table> <dt><strong><code>Pm = 6</code></strong></dt>
-<table><tr><td>h</td><td>Origin Mode (DECOM)</td></tr><tr><td>l</td><td>Normal Cursor Mode (DECOM)</td></tr></table> <dt><strong><code>Pm = 7</code></strong></dt>
-<table><tr><td>h</td><td>Wraparound Mode (DECAWM)</td></tr><tr><td>l</td><td>No Wraparound Mode (DECAWM)</td></tr></table> <dt><strong><code>Pm = 8</code></strong> <i>unimplemented</i></dt>
-<table><tr><td>h</td><td>Auto-repeat Keys (DECARM)</td></tr><tr><td>l</td><td>No Auto-repeat Keys (DECARM)</td></tr></table> <dt><strong><code>Pm = 9</code></strong> X10 XTerm</dt>
-<table><tr><td>h</td><td>Send Mouse X & Y on button press.</td></tr><tr><td>l</td><td>No mouse reporting.</td></tr></table> <dt><strong><code>Pm = 25</code></strong></dt>
-<table><tr><td>h</td><td>Visible cursor {cnorm/cvvis}</td></tr><tr><td>l</td><td>Invisible cursor {civis}</td></tr></table> <dt><strong><code>Pm = 30</code></strong></dt>
-<table><tr><td>h</td><td>scrollBar visisble</td></tr><tr><td>l</td><td>scrollBar invisisble</td></tr></table> <dt><strong><code>Pm = 35</code></strong> (<strong>rxvt</strong>)</dt>
-<table><tr><td>h</td><td>Allow XTerm Shift+key sequences</td></tr><tr><td>l</td><td>Disallow XTerm Shift+key sequences</td></tr></table> <dt><strong><code>Pm = 38</code></strong> <i>unimplemented</i></dt>
- <dd>
- <p>Enter Tektronix Mode (DECTEK)</p>
- </dd>
- <dt><strong><code>Pm = 40</code></strong></dt>
-<table><tr><td>h</td><td>Allow 80/132 Mode</td></tr><tr><td>l</td><td>Disallow 80/132 Mode</td></tr></table> <dt><strong><code>Pm = 44</code></strong> <i>unimplemented</i></dt>
-<table><tr><td>h</td><td>Turn On Margin Bell</td></tr><tr><td>l</td><td>Turn Off Margin Bell</td></tr></table> <dt><strong><code>Pm = 45</code></strong> <i>unimplemented</i></dt>
-<table><tr><td>h</td><td>Reverse-wraparound Mode</td></tr><tr><td>l</td><td>No Reverse-wraparound Mode</td></tr></table> <dt><strong><code>Pm = 46</code></strong> <i>unimplemented</i></dt>
- <dt><strong><code>Pm = 47</code></strong></dt>
-<table><tr><td>h</td><td>Use Alternate Screen Buffer</td></tr><tr><td>l</td><td>Use Normal Screen Buffer</td></tr></table> <dd>
- <p><span id="Priv66">Priv66</span></p>
- </dd>
- <dt><strong><code>Pm = 66</code></strong></dt>
-<table><tr><td>h</td><td>Application Keypad (DECPAM) == ESC =</td></tr><tr><td>l</td><td>Normal Keypad (DECPNM) == ESC ></td></tr></table> <dt><strong><code>Pm = 67</code></strong></dt>
-<table><tr><td>h</td><td>Backspace key sends BS (DECBKM)</td></tr><tr><td>l</td><td>Backspace key sends DEL</td></tr></table> <dt><strong><code>Pm = 1000</code></strong> (X11 XTerm)</dt>
-<table><tr><td>h</td><td>Send Mouse X & Y on button press and release.</td></tr><tr><td>l</td><td>No mouse reporting.</td></tr></table> <dt><strong><code>Pm = 1001</code></strong> (X11 XTerm) <i>unimplemented</i></dt>
-<table><tr><td>h</td><td>Use Hilite Mouse Tracking.</td></tr><tr><td>l</td><td>No mouse reporting.</td></tr></table> <dt><strong><code>Pm = 1002</code></strong> (X11 XTerm)</dt>
-<table><tr><td>h</td><td>Send Mouse X & Y on button press and release, and motion with a button pressed.</td></tr><tr><td>l</td><td>No mouse reporting.</td></tr></table> <dt><strong><code>Pm = 1003</code></strong> (X11 XTerm)</dt>
-<table><tr><td>h</td><td>Send Mouse X & Y on button press and release, and motion.</td></tr><tr><td>l</td><td>No mouse reporting.</td></tr></table> <dt><strong><code>Pm = 1010</code></strong> (<strong>rxvt</strong>)</dt>
-<table><tr><td>h</td><td>Don't scroll to bottom on TTY output</td></tr><tr><td>l</td><td>Scroll to bottom on TTY output</td></tr></table> <dt><strong><code>Pm = 1011</code></strong> (<strong>rxvt</strong>)</dt>
-<table><tr><td>h</td><td>Scroll to bottom when a key is pressed</td></tr><tr><td>l</td><td>Don't scroll to bottom when a key is pressed</td></tr></table> <dt><strong><code>Pm = 1021</code></strong> (<strong>rxvt</strong>)</dt>
-<table><tr><td>h</td><td>Bold/italic implies high intensity (see option -is)</td></tr><tr><td>l</td><td>Font styles have no effect on intensity (Compile styles)</td></tr></table> <dt><strong><code>Pm = 1047</code></strong></dt>
-<table><tr><td>h</td><td>Use Alternate Screen Buffer</td></tr><tr><td>l</td><td>Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it</td></tr></table> <dt><strong><code>Pm = 1048</code></strong></dt>
-<table><tr><td>h</td><td>Save cursor position</td></tr><tr><td>l</td><td>Restore cursor position</td></tr></table> <dt><strong><code>Pm = 1049</code></strong></dt>
-<table><tr><td>h</td><td>Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it</td></tr><tr><td>l</td><td>Use Normal Screen Buffer</td></tr></table> </dl>
- </p>
- </dd>
-</dl>
-<p><span id="XTerm">XTerm</span></p>
-
-</div>
-<h2 id="XTerm_Operating_System_Commands">XTerm Operating System Commands</h2>
-<div id="XTerm_Operating_System_Commands_CONT">
-<dl>
- <dt><strong><code>ESC ] Ps;Pt ST</code></strong></dt>
- <dd>
- <p>Set XTerm Parameters. 8-bit ST: 0x9c, 7-bit ST sequence: ESC \ (0x1b,
-0x5c), backwards compatible terminator BEL (0x07) is also accepted. any
-<strong>octet</strong> can be escaped by prefixing it with SYN (0x16, ^V).</p>
-<table><tr><td>Ps = 0</td><td>Change Icon Name and Window Title to Pt</td></tr><tr><td>Ps = 1</td><td>Change Icon Name to Pt</td></tr><tr><td>Ps = 2</td><td>Change Window Title to Pt</td></tr><tr><td>Ps = 3</td><td>If Pt starts with a ?, query the (STRING) property of the window and return it. If Pt contains a =, set the named property to the given value, else delete the specified property.</td></tr><tr><td>Ps = 4</td><td>Pt is a semi-colon separated sequence of one or more semi-colon separated number/name pairs, where number is an index to a colour and name is the name of a colour. Each pair causes the numbered colour to be changed to name. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white</td></tr><tr><td>Ps = 10</td><td>Change colour of text foreground to Pt (NB: may change in future)</td></tr><tr><td>Ps = 11</td><td>Change colour of text background to Pt (NB: may change in future)</td></tr><tr><td>Ps = 12</td><td>Change colour of text cursor foreground to Pt</td></tr><tr><td>Ps = 13</td><td>Change colour of mouse foreground to Pt</td></tr><tr><td>Ps = 17</td><td>Change colour of highlight characters to Pt</td></tr><tr><td>Ps = 18</td><td>Change colour of bold characters to Pt [deprecated, see 706]</td></tr><tr><td>Ps = 19</td><td>Change colour of underlined characters to Pt [deprecated, see 707]</td></tr><tr><td>Ps = 20</td><td>Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage).</td></tr><tr><td>Ps = 39</td><td>Change default foreground colour to Pt.</td></tr><tr><td>Ps = 46</td><td>Change Log File to Pt unimplemented</td></tr><tr><td>Ps = 49</td><td>Change default background colour to Pt.</td></tr><tr><td>Ps = 50</td><td>Set fontset to Pt, with the following special values of Pt (rxvt) #+n change up n #-n change down n if n is missing of 0, a value of 1 is used empty change to font0 n change to font n</td></tr><tr><td>Ps = 55</td><td>Log all scrollback buffer and all of screen to Pt</td></tr><tr><td>Ps = 701</td><td>Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills).</td></tr><tr><td>Ps = 702</td><td>Request version if Pt is ?, returning rxvt-unicode, the resource name, the major and minor version numbers, e.g. ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST.</td></tr><tr><td>Ps = 704</td><td>Change colour of italic characters to Pt</td></tr><tr><td>Ps = 705</td><td>Change background pixmap tint colour to Pt (Compile transparency).</td></tr><tr><td>Ps = 706</td><td>Change colour of bold characters to Pt</td></tr><tr><td>Ps = 707</td><td>Change colour of underlined characters to Pt</td></tr><tr><td>Ps = 710</td><td>Set normal fontset to Pt. Same as Ps = 50.</td></tr><tr><td>Ps = 711</td><td>Set bold fontset to Pt. Similar to Ps = 50 (Compile styles).</td></tr><tr><td>Ps = 712</td><td>Set italic fontset to Pt. Similar to Ps = 50 (Compile styles).</td></tr><tr><td>Ps = 713</td><td>Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles).</td></tr><tr><td>Ps = 720</td><td>Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).</td></tr><tr><td>Ps = 721</td><td>Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).</td></tr><tr><td>Ps = 777</td><td>Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl).</td></tr></table> </dd>
-</dl>
-
-</div>
-<h1 id="BACKGROUND_IMAGE">BACKGROUND IMAGE</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="BACKGROUND_IMAGE_CONTENT">
-<p>For the BACGROUND IMAGE XTerm escape sequence <strong><code>ESC ] 20 ; Pt ST</code></strong> then value
-of <strong><code>Pt</code></strong> can be the name of the background image file followed by a
-sequence of scaling/positioning commands separated by semi-colons. The
-scaling/positioning commands are as follows:</p>
-<dl>
- <dt>query scale/position</dt>
- <dd>
- <p><strong>?</strong></p>
- </dd>
- <dt>change scale and position</dt>
- <dd>
- <p><strong>WxH+X+Y</strong></p>
- <p><strong>WxH+X</strong> (== <strong>WxH+X+X</strong>)</p>
- <p><strong>WxH</strong> (same as <strong>WxH+50+50</strong>)</p>
- <p><strong>W+X+Y</strong> (same as <strong>WxW+X+Y</strong>)</p>
- <p><strong>W+X</strong> (same as <strong>WxW+X+X</strong>)</p>
- <p><strong>W</strong> (same as <strong>WxW+50+50</strong>)</p>
- </dd>
- <dt>change position (absolute)</dt>
- <dd>
- <p><strong>=+X+Y</strong></p>
- <p><strong>=+X</strong> (same as <strong>=+X+Y</strong>)</p>
- </dd>
- <dt>change position (relative)</dt>
- <dd>
- <p><strong>+X+Y</strong></p>
- <p><strong>+X</strong> (same as <strong>+X+Y</strong>)</p>
- </dd>
- <dt>rescale (relative)</dt>
- <dd>
- <p><strong>Wx0</strong> -> <strong>W *= (W/100)</strong></p>
- <p><strong>0xH</strong> -> <strong>H *= (H/100)</strong></p>
- </dd>
-</dl>
-<p>For example:</p>
-<dl>
- <dt><strong>\E]20;funky.jpg\a</strong></dt>
- <dd>
- <p>load <strong>funky.jpg</strong> as a tiled image</p>
- </dd>
- <dt><strong>\E]20;mona.jpg;100\a</strong></dt>
- <dd>
- <p>load <strong>mona.jpg</strong> with a scaling of 100%</p>
- </dd>
- <dt><strong>\E]20;;200;?\a</strong></dt>
- <dd>
- <p>rescale the current pixmap to 200% and display the image geometry in
-the title</p>
- </dd>
-</dl>
-
-</div>
-<h1 id="Mouse_Reporting">Mouse Reporting</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="Mouse_Reporting_CONTENT">
-<dl>
- <dt><strong><code>ESC [ M <b> <x> <y></code></strong></dt>
- <dd>
- <p>report mouse position</p>
- </dd>
-</dl>
-<p>The lower 2 bits of <strong><code><b></code></strong> indicate the button:</p>
-<dl>
- <dt>Button = <strong><code>(<b> - SPACE) & 3</code></strong></dt>
-<table><tr><td>0</td><td>Button1 pressed</td></tr><tr><td>1</td><td>Button2 pressed</td></tr><tr><td>2</td><td>Button3 pressed</td></tr><tr><td>3</td><td>button released (X11 mouse report)</td></tr></table></dl>
-<p>The upper bits of <strong><code><b></code></strong> indicate the modifiers when the
-button was pressed and are added together (X11 mouse report only):</p>
-<dl>
- <dt>State = <strong><code>(<b> - SPACE) & 60</code></strong></dt>
-<table><tr><td>4</td><td>Shift</td></tr><tr><td>8</td><td>Meta</td></tr><tr><td>16</td><td>Control</td></tr><tr><td>32</td><td>Double Click (rxvt extension)</td></tr></table> <dd>
- <p>Col = <strong><code><x> - SPACE</code></strong></p>
- <p>Row = <strong><code><y> - SPACE</code></strong></p>
- </dd>
-</dl>
-
-</div>
-<h1 id="Key_Codes">Key Codes</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="Key_Codes_CONTENT">
-<p>Note: <strong>Shift</strong> + <strong>F1</strong>-<strong>F10</strong> generates <strong>F11</strong>-<strong>F20</strong></p>
-<p>For the keypad, use <strong>Shift</strong> to temporarily override Application-Keypad
-setting use <strong>Num_Lock</strong> to toggle Application-Keypad setting if
-<strong>Num_Lock</strong> is off, toggle Application-Keypad setting. Also note that
-values of <strong>Home</strong>, <strong>End</strong>, <strong>Delete</strong> may have been compiled differently on
-your system.</p>
-<table><tr><td></td><td>Normal</td><td>Shift</td><td>Control</td><td>Ctrl+Shift</td></tr><tr><td>Tab</td><td>^I</td><td>ESC [ Z</td><td>^I</td><td>ESC [ Z</td></tr><tr><td>BackSpace</td><td>^H</td><td>^?</td><td>^?</td><td>^?</td></tr><tr><td>Find</td><td>ESC [ 1 ~</td><td>ESC [ 1 $</td><td>ESC [ 1 ^</td><td>ESC [ 1 @</td></tr><tr><td>Insert</td><td>ESC [ 2 ~</td><td>paste</td><td>ESC [ 2 ^</td><td>ESC [ 2 @</td></tr><tr><td>Execute</td><td>ESC [ 3 ~</td><td>ESC [ 3 $</td><td>ESC [ 3 ^</td><td>ESC [ 3 @</td></tr><tr><td>Select</td><td>ESC [ 4 ~</td><td>ESC [ 4 $</td><td>ESC [ 4 ^</td><td>ESC [ 4 @</td></tr><tr><td>Prior</td><td>ESC [ 5 ~</td><td>scroll-up</td><td>ESC [ 5 ^</td><td>ESC [ 5 @</td></tr><tr><td>Next</td><td>ESC [ 6 ~</td><td>scroll-down</td><td>ESC [ 6 ^</td><td>ESC [ 6 @</td></tr><tr><td>Home</td><td>ESC [ 7 ~</td><td>ESC [ 7 $</td><td>ESC [ 7 ^</td><td>ESC [ 7 @</td></tr><tr><td>End</td><td>ESC [ 8 ~</td><td>ESC [ 8 $</td><td>ESC [ 8 ^</td><td>ESC [ 8 @</td></tr><tr><td>Delete</td><td>ESC [ 3 ~</td><td>ESC [ 3 $</td><td>ESC [ 3 ^</td><td>ESC [ 3 @</td></tr><tr><td>F1</td><td>ESC [ 11 ~</td><td>ESC [ 23 ~</td><td>ESC [ 11 ^</td><td>ESC [ 23 ^</td></tr><tr><td>F2</td><td>ESC [ 12 ~</td><td>ESC [ 24 ~</td><td>ESC [ 12 ^</td><td>ESC [ 24 ^</td></tr><tr><td>F3</td><td>ESC [ 13 ~</td><td>ESC [ 25 ~</td><td>ESC [ 13 ^</td><td>ESC [ 25 ^</td></tr><tr><td>F4</td><td>ESC [ 14 ~</td><td>ESC [ 26 ~</td><td>ESC [ 14 ^</td><td>ESC [ 26 ^</td></tr><tr><td>F5</td><td>ESC [ 15 ~</td><td>ESC [ 28 ~</td><td>ESC [ 15 ^</td><td>ESC [ 28 ^</td></tr><tr><td>F6</td><td>ESC [ 17 ~</td><td>ESC [ 29 ~</td><td>ESC [ 17 ^</td><td>ESC [ 29 ^</td></tr><tr><td>F7</td><td>ESC [ 18 ~</td><td>ESC [ 31 ~</td><td>ESC [ 18 ^</td><td>ESC [ 31 ^</td></tr><tr><td>F8</td><td>ESC [ 19 ~</td><td>ESC [ 32 ~</td><td>ESC [ 19 ^</td><td>ESC [ 32 ^</td></tr><tr><td>F9</td><td>ESC [ 20 ~</td><td>ESC [ 33 ~</td><td>ESC [ 20 ^</td><td>ESC [ 33 ^</td></tr><tr><td>F10</td><td>ESC [ 21 ~</td><td>ESC [ 34 ~</td><td>ESC [ 21 ^</td><td>ESC [ 34 ^</td></tr><tr><td>F11</td><td>ESC [ 23 ~</td><td>ESC [ 23 $</td><td>ESC [ 23 ^</td><td>ESC [ 23 @</td></tr><tr><td>F12</td><td>ESC [ 24 ~</td><td>ESC [ 24 $</td><td>ESC [ 24 ^</td><td>ESC [ 24 @</td></tr><tr><td>F13</td><td>ESC [ 25 ~</td><td>ESC [ 25 $</td><td>ESC [ 25 ^</td><td>ESC [ 25 @</td></tr><tr><td>F14</td><td>ESC [ 26 ~</td><td>ESC [ 26 $</td><td>ESC [ 26 ^</td><td>ESC [ 26 @</td></tr><tr><td>F15 (Help)</td><td>ESC [ 28 ~</td><td>ESC [ 28 $</td><td>ESC [ 28 ^</td><td>ESC [ 28 @</td></tr><tr><td>F16 (Menu)</td><td>ESC [ 29 ~</td><td>ESC [ 29 $</td><td>ESC [ 29 ^</td><td>ESC [ 29 @</td></tr><tr><td>F17</td><td>ESC [ 31 ~</td><td>ESC [ 31 $</td><td>ESC [ 31 ^</td><td>ESC [ 31 @</td></tr><tr><td>F18</td><td>ESC [ 32 ~</td><td>ESC [ 32 $</td><td>ESC [ 32 ^</td><td>ESC [ 32 @</td></tr><tr><td>F19</td><td>ESC [ 33 ~</td><td>ESC [ 33 $</td><td>ESC [ 33 ^</td><td>ESC [ 33 @</td></tr><tr><td>F20</td><td>ESC [ 34 ~</td><td>ESC [ 34 $</td><td>ESC [ 34 ^</td><td>ESC [ 34 @</td></tr><tr><td></td><td></td><td></td><td></td><td>Application</td></tr><tr><td>Up</td><td>ESC [ A</td><td>ESC [ a</td><td>ESC O a</td><td>ESC O A</td></tr><tr><td>Down</td><td>ESC [ B</td><td>ESC [ b</td><td>ESC O b</td><td>ESC O B</td></tr><tr><td>Right</td><td>ESC [ C</td><td>ESC [ c</td><td>ESC O c</td><td>ESC O C</td></tr><tr><td>Left</td><td>ESC [ D</td><td>ESC [ d</td><td>ESC O d</td><td>ESC O D</td></tr><tr><td>KP_Enter</td><td>^M</td><td></td><td></td><td>ESC O M</td></tr><tr><td>KP_F1</td><td>ESC O P</td><td></td><td></td><td>ESC O P</td></tr><tr><td>KP_F2</td><td>ESC O Q</td><td></td><td></td><td>ESC O Q</td></tr><tr><td>KP_F3</td><td>ESC O R</td><td></td><td></td><td>ESC O R</td></tr><tr><td>KP_F4</td><td>ESC O S</td><td></td><td></td><td>ESC O S</td></tr><tr><td>XK_KP_Multiply</td><td>*</td><td></td><td></td><td>ESC O j</td></tr><tr><td>XK_KP_Add</td><td>+</td><td></td><td></td><td>ESC O k</td></tr><tr><td>XK_KP_Separator</td><td>,</td><td></td><td></td><td>ESC O l</td></tr><tr><td>XK_KP_Subtract</td><td>-</td><td></td><td></td><td>ESC O m</td></tr><tr><td>XK_KP_Decimal</td><td>.</td><td></td><td></td><td>ESC O n</td></tr><tr><td>XK_KP_Divide</td><td>/</td><td></td><td></td><td>ESC O o</td></tr><tr><td>XK_KP_0</td><td>0</td><td></td><td></td><td>ESC O p</td></tr><tr><td>XK_KP_1</td><td>1</td><td></td><td></td><td>ESC O q</td></tr><tr><td>XK_KP_2</td><td>2</td><td></td><td></td><td>ESC O r</td></tr><tr><td>XK_KP_3</td><td>3</td><td></td><td></td><td>ESC O s</td></tr><tr><td>XK_KP_4</td><td>4</td><td></td><td></td><td>ESC O t</td></tr><tr><td>XK_KP_5</td><td>5</td><td></td><td></td><td>ESC O u</td></tr><tr><td>XK_KP_6</td><td>6</td><td></td><td></td><td>ESC O v</td></tr><tr><td>XK_KP_7</td><td>7</td><td></td><td></td><td>ESC O w</td></tr><tr><td>XK_KP_8</td><td>8</td><td></td><td></td><td>ESC O x</td></tr><tr><td>XK_KP_9</td><td>9</td><td></td><td></td><td>ESC O y</td></tr></table>
-</div>
-<h1 id="CONFIGURE_OPTIONS">CONFIGURE OPTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="CONFIGURE_OPTIONS_CONTENT">
-<p>General hint: if you get compile errors, then likely your configuration
-hasn't been tested well. Either try with <code>--enable-everything</code> or use
-the default configuration (i.e. no <code>--enable-xxx</code> or <code>--disable-xxx</code>
-switches). Of course, you should always report when a combination doesn't
-work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.</p>
-<p>All</p>
-<dl>
- <dt>--enable-everything</dt>
- <dd>
- <p>Add (or remove) support for all non-multichoice options listed in "./configure
---help".</p>
- <p>You can specify this and then disable options you do not like by
-<i>following</i> this with the appropriate <code>--disable-...</code> arguments,
-or you can start with a minimal configuration by specifying
-<code>--disable-everything</code> and than adding just the <code>--enable-...</code> arguments
-you want.</p>
- </dd>
- <dt>--enable-xft (default: enabled)</dt>
- <dd>
- <p>Add support for Xft (anti-aliases, among others) fonts. Xft fonts are
-slower and require lots of memory, but as long as you don't use them, you
-don't pay for them.</p>
- </dd>
- <dt>--enable-font-styles (default: on)</dt>
- <dd>
- <p>Add support for <strong>bold</strong>, <i>italic</i> and <strong><i>bold italic</i></strong> font
-styles. The fonts can be set manually or automatically.</p>
- </dd>
- <dt>--with-codesets=NAME,... (default: all)</dt>
- <dd>
- <p>Compile in support for additional codeset (encoding) groups (<code>eu</code>, <code>vn</code>
-are always compiled in, which includes most 8-bit character sets). These
-codeset tables are used for driving X11 core fonts, they are not required
-for Xft fonts, although having them compiled in lets rxvt-unicode choose
-replacement fonts more intelligently. Compiling them in will make your
-binary bigger (all of together cost about 700kB), but it doesn't increase
-memory usage unless you use a font requiring one of these encodings.</p>
-<table><tr><td>all</td><td>all available codeset groups</td></tr><tr><td>zh</td><td>common chinese encodings</td></tr><tr><td>zh_ext</td><td>rarely used but very big chinese encodings</td></tr><tr><td>jp</td><td>common japanese encodings</td></tr><tr><td>jp_ext</td><td>rarely used but big japanese encodings</td></tr><tr><td>kr</td><td>korean encodings</td></tr></table> </dd>
- <dt>--enable-xim (default: on)</dt>
- <dd>
- <p>Add support for XIM (X Input Method) protocol. This allows using
-alternative input methods (e.g. kinput2) and will also correctly
-set up the input for people using dead keys or compose keys.</p>
- </dd>
- <dt>--enable-unicode3 (default: off)</dt>
- <dd>
- <p>Recommended to stay off unless you really need non-BMP characters.</p>
- <p>Enable direct support for displaying unicode codepoints above
-65535 (the basic multilingual page). This increases storage
-requirements per character from 2 to 4 bytes. X11 fonts do not yet
-support these extra characters, but Xft does.</p>
- <p>Please note that rxvt-unicode can store unicode code points >65535
-even without this flag, but the number of such characters is
-limited to a few thousand (shared with combining characters,
-see next switch), and right now rxvt-unicode cannot display them
-(input/output and cut&paste still work, though).</p>
- </dd>
- <dt>--enable-combining (default: on)</dt>
- <dd>
- <p>Enable automatic composition of combining characters into
-composite characters. This is required for proper viewing of text
-where accents are encoded as seperate unicode characters. This is
-done by using precomposited characters when available or creating
-new pseudo-characters when no precomposed form exists.</p>
- <p>Without --enable-unicode3, the number of additional precomposed
-characters is somewhat limited (the 6400 private use characters will be
-(ab-)used). With --enable-unicode3, no practical limit exists.</p>
- <p>This option will also enable storage (but not display) of characters
-beyond plane 0 (>65535) when --enable-unicode3 was not specified.</p>
- <p>The combining table also contains entries for arabic presentation forms,
-but these are not currently used. Bug me if you want these to be used (and
-tell me how these are to be used...).</p>
- </dd>
- <dt>--enable-fallback(=CLASS) (default: Rxvt)</dt>
- <dd>
- <p>When reading resource settings, also read settings for class CLASS. To
-disable resource fallback use --disable-fallback.</p>
- </dd>
- <dt>--with-res-name=NAME (default: urxvt)</dt>
- <dd>
- <p>Use the given name as default application name when
-reading resources. Specify --with-res-name=rxvt to replace rxvt.</p>
- </dd>
- <dt>--with-res-class=CLASS /default: URxvt)</dt>
- <dd>
- <p>Use the given class as default application class
-when reading resources. Specify --with-res-class=Rxvt to replace
-rxvt.</p>
- </dd>
- <dt>--enable-utmp (default: on)</dt>
- <dd>
- <p>Write user and tty to utmp file (used by programs like <cite>w</cite>) at
-start of rxvt execution and delete information when rxvt exits.</p>
- </dd>
- <dt>--enable-wtmp (default: on)</dt>
- <dd>
- <p>Write user and tty to wtmp file (used by programs like <cite>last</cite>) at
-start of rxvt execution and write logout when rxvt exits. This
-option requires --enable-utmp to also be specified.</p>
- </dd>
- <dt>--enable-lastlog (default: on)</dt>
- <dd>
- <p>Write user and tty to lastlog file (used by programs like
-<cite>lastlogin</cite>) at start of rxvt execution. This option requires
---enable-utmp to also be specified.</p>
- </dd>
- <dt>--enable-afterimage (default: on)</dt>
- <dd>
- <p>Add support for libAfterImage to be used for transparency and background
-images. It adds support for many file formats including JPG, PNG,
-SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep image XML
-(<a href="http://www.afterstep.org/visualdoc.php?show=asimagexml">http://www.afterstep.org/visualdoc.php?show=asimagexml</a>).</p>
- <p>This option also adds such eye candy as blending an image over the root
-background, as well as dynamic scaling and bluring of background images.</p>
- <p>Note that with this option enabled, rxvt's memory footprint might
-increase by a few megabytes even if no extra features are used (mostly due
-to third-party libraries used by libAI). Memory footprint may somewhat be
-lowered if libAfterImage is configured without support for SVG.</p>
- </dd>
- <dt>--enable-transparency (default: on)</dt>
- <dd>
- <p>Add support for backgrounds, creating illusion of transparency in the term.</p>
- </dd>
- <dt>--enable-fading (default: on)</dt>
- <dd>
- <p>Add support for fading the text when focus is lost.</p>
- </dd>
- <dt>--enable-rxvt-scroll (default: on)</dt>
- <dd>
- <p>Add support for the original rxvt scrollbar.</p>
- </dd>
- <dt>--enable-next-scroll (default: on)</dt>
- <dd>
- <p>Add support for a NeXT-like scrollbar.</p>
- </dd>
- <dt>--enable-xterm-scroll (default: on)</dt>
- <dd>
- <p>Add support for an Xterm-like scrollbar.</p>
- </dd>
- <dt>--enable-plain-scroll (default: on)</dt>
- <dd>
- <p>Add support for a very unobtrusive, plain-looking scrollbar that
-is the favourite of the rxvt-unicode author, having used it for
-many years.</p>
- </dd>
- <dt>--enable-ttygid (default: off)</dt>
- <dd>
- <p>Change tty device setting to group "tty" - only use this if
-your system uses this type of security.</p>
- </dd>
- <dt>--disable-backspace-key</dt>
- <dd>
- <p>Removes any handling of the backspace key by us - let the X server do it.</p>
- </dd>
- <dt>--disable-delete-key</dt>
- <dd>
- <p>Removes any handling of the delete key by us - let the X server
-do it.</p>
- </dd>
- <dt>--disable-resources</dt>
- <dd>
- <p>Removes any support for resource checking.</p>
- </dd>
- <dt>--disable-swapscreen</dt>
- <dd>
- <p>Remove support for secondary/swap screen.</p>
- </dd>
- <dt>--enable-frills (default: on)</dt>
- <dd>
- <p>Add support for many small features that are not essential but nice to
-have. Normally you want this, but for very small binaries you may want to
-disable this.</p>
- <p>A non-exhaustive list of features enabled by <code>--enable-frills</code> (possibly
-in combination with other switches) is:</p>
-<pre> MWM-hints
- EWMH-hints (pid, utf8 names) and protocols (ping)
- urgency hint
- seperate underline colour (-underlineColor)
- settable border widths and borderless switch (-w, -b, -bl)
- visual depth selection (-depth)
- settable extra linespacing /-lsp)
- iso-14755 5.1 (basic) support
- tripleclickwords (-tcw)
- settable insecure mode (-insecure)
- keysym remapping support
- cursor blinking and underline cursor (-cb, -uc)
- XEmbed support (-embed)
- user-pty (-pty-fd)
- hold on exit (-hold)
- compile in built-in block graphics
- skip builtin block graphics (-sbg)
- separate highlightcolor support (-hc)
-
-</pre>
- <p>It also enables some non-essential features otherwise disabled, such as:</p>
-<pre> some round-trip time optimisations
- nearest color allocation on pseudocolor screens
- UTF8_STRING support for selection
- sgr modes 90..97 and 100..107
- backindex and forwardindex escape sequences
- view change/zero scrollback escape sequences
- locale switching escape sequence
- window op and some xterm/OSC escape sequences
- rectangular selections
- trailing space removal for selections
- verbose X error handling
-
-</pre>
- </dd>
- <dt>--enable-iso14755 (default: on)</dt>
- <dd>
- <p>Enable extended ISO 14755 support (see rxvt(1), or
-<cite>doc/rxvt.1.txt</cite>). Basic support (section 5.1) is enabled by
-<code>--enable-frills</code>, while support for 5.2, 5.3 and 5.4 is enabled with
-this switch.</p>
- </dd>
- <dt>--enable-keepscrolling (default: on)</dt>
- <dd>
- <p>Add support for continual scrolling of the display when you hold
-the mouse button down on a scrollbar arrow.</p>
- </dd>
- <dt>--enable-selectionscrolling (default: on)</dt>
- <dd>
- <p>Add support for scrolling when the selection moves to the top or
-bottom of the screen.</p>
- </dd>
- <dt>--enable-mousewheel (default: on)</dt>
- <dd>
- <p>Add support for scrolling via mouse wheel or buttons 4 & 5.</p>
- </dd>
- <dt>--enable-slipwheeling (default: on)</dt>
- <dd>
- <p>Add support for continual scrolling (using the mouse wheel as an
-accelerator) while the control key is held down. This option
-requires --enable-mousewheel to also be specified.</p>
- </dd>
- <dt>--enable-smart-resize (default: off)</dt>
- <dd>
- <p>Add smart growth/shrink behaviour when resizing.
-This should keep the window corner which is closest to a corner of
-the screen in a fixed position.</p>
- </dd>
- <dt>--enable-pointer-blank (default: on)</dt>
- <dd>
- <p>Add support to have the pointer disappear when typing or inactive.</p>
- </dd>
- <dt>--enable-perl (default: on)</dt>
- <dd>
- <p>Enable an embedded perl interpreter. See the <strong>rxvtperl(3)</strong>
-manpage (<cite>doc/rxvtperl.txt</cite>) for more info on this feature, or the
-files in <cite>src/perl-ext/</cite> for the extensions that are installed by
-default. The perl interpreter that is used can be specified via the
-<code>PERL</code> environment variable when running configure. Even when compiled
-in, perl will <i>not</i> be initialised when all extensions have been disabled
-<code>-pe "" --perl-ext-common ""</code>, so it should be safe to enable from a
-resource standpoint.</p>
- </dd>
- <dt>--with-afterimage-config=DIR</dt>
- <dd>
- <p>Look for the libAfterImage config script in DIR.</p>
- </dd>
- <dt>--with-name=NAME (default: urxvt)</dt>
- <dd>
- <p>Set the basename for the installed binaries, resulting
-in <code>urxvt</code>, <code>urxvtd</code> etc.). Specify <code>--with-name=rxvt</code> to replace with
-<code>rxvt</code>.</p>
- </dd>
- <dt>--with-term=NAME (default: rxvt-unicode)</dt>
- <dd>
- <p>Change the environmental variable for the terminal to NAME.</p>
- </dd>
- <dt>--with-terminfo=PATH</dt>
- <dd>
- <p>Change the environmental variable for the path to the terminfo tree to
-PATH.</p>
- </dd>
- <dt>--with-x</dt>
- <dd>
- <p>Use the X Window System (pretty much default, eh?).</p>
- </dd>
-</dl>
-
-</div>
-<h1 id="AUTHORS">AUTHORS</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="AUTHORS_CONTENT">
-<p>Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
-reworked it from the original Rxvt documentation, which was done by Geoff
-Wing <gcw@pobox.com>, who in turn used the XTerm documentation and other
-sources.</p>
-
-</div>
-</div></body>
-</html>
+++ /dev/null
-NAME
- RXVT REFERENCE - FAQ, command sequences and other background information
-
-SYNOPSIS
- # set a new font set
- printf '\33]50;%s\007' 9x15,xft:Kochi" Mincho"
-
- # change the locale and tell rxvt-unicode about it
- export LC_CTYPE=ja_JP.EUC-JP; printf "\33]701;$LC_CTYPE\007"
-
- # set window title
- printf '\33]2;%s\007' "new window title"
-
-DESCRIPTION
- This document contains the FAQ, the RXVT TECHNICAL REFERENCE documenting
- all escape sequences, and other background information.
-
- The newest version of this document is also available on the World Wide
- Web at <http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
-
-RXVT-UNICODE/URXVT FREQUENTLY ASKED QUESTIONS
- Meta, Features & Commandline Issues
- My question isn't answered here, can I ask a human?
- Before sending me mail, you could go to IRC: "irc.freenode.net", channel
- "#rxvt-unicode" has some rxvt-unicode enthusiasts that might be
- interested in learning about new and exciting problems (but not FAQs :).
-
- Does it support tabs, can I have a tabbed rxvt-unicode?
- Beginning with version 7.3, there is a perl extension that implements a
- simple tabbed terminal. It is installed by default, so any of these
- should give you tabs:
-
- urxvt -pe tabbed
-
- URxvt.perl-ext-common: default,tabbed
-
- It will also work fine with tabbing functionality of many window
- managers or similar tabbing programs, and its embedding-features allow
- it to be embedded into other programs, as witnessed by doc/rxvt-tabbed
- or the upcoming "Gtk2::URxvt" perl module, which features a tabbed urxvt
- (murxvt) terminal as an example embedding application.
-
- How do I know which rxvt-unicode version I'm using?
- The version number is displayed with the usage (-h). Also the escape
- sequence "ESC [ 8 n" sets the window title to the version number. When
- using the urxvtc client, the version displayed is that of the daemon.
-
- Rxvt-unicode uses gobs of memory, how can I reduce that?
- Rxvt-unicode tries to obey the rule of not charging you for something
- you don't use. One thing you should try is to configure out all settings
- that you don't need, for example, Xft support is a resource hog by
- design, when used. Compiling it out ensures that no Xft font will be
- loaded accidentally when rxvt-unicode tries to find a font for your
- characters.
-
- Also, many people (me included) like large windows and even larger
- scrollback buffers: Without "--enable-unicode3", rxvt-unicode will use 6
- bytes per screen cell. For a 160x?? window this amounts to almost a
- kilobyte per line. A scrollback buffer of 10000 lines will then (if
- full) use 10 Megabytes of memory. With "--enable-unicode3" it gets
- worse, as rxvt-unicode then uses 8 bytes per screen cell.
-
- How can I start urxvtd in a race-free way?
- Try "urxvtd -f -o", which tells urxvtd to open the display, create the
- listening socket and then fork.
-
- How can I start urxvtd automatically when I run urxvtc?
- If you want to start urxvtd automatically whenever you run urxvtc and
- the daemon isn't running yet, use this script:
-
- #!/bin/sh
- urxvtc "$@"
- if [ $? -eq 2 ]; then
- urxvtd -q -o -f
- urxvtc "$@"
- fi
-
- This tries to create a new terminal, and if fails with exit status 2,
- meaning it couldn't connect to the daemon, it will start the daemon and
- re-run the command. Subsequent invocations of the script will re-use the
- existing daemon.
-
- How do I distinguish whether I'm running rxvt-unicode or a regular xterm? I need this to decide about setting colors etc.
- The original rxvt and rxvt-unicode always export the variable
- "COLORTERM", so you can check and see if that is set. Note that several
- programs, JED, slrn, Midnight Commander automatically check this
- variable to decide whether or not to use color.
-
- How do I set the correct, full IP address for the DISPLAY variable?
- If you've compiled rxvt-unicode with DISPLAY_IS_IP and have enabled
- insecure mode then it is possible to use the following shell script
- snippets to correctly set the display. If your version of rxvt-unicode
- wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets)
- then the COLORTERM variable can be used to distinguish rxvt-unicode from
- a regular xterm.
-
- Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
- snippets:
-
- # Bourne/Korn/POSIX family of shells:
- [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
- if [ ${TERM:-foo} = xterm ]; then
- stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
- echo -n '^[Z'
- read term_id
- stty icanon echo
- if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
- echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
- read DISPLAY # set it in our local shell
- fi
- fi
-
- How do I compile the manual pages on my own?
- You need to have a recent version of perl installed as /usr/bin/perl,
- one that comes with pod2man, pod2text and pod2xhtml (from Pod::Xhtml).
- Then go to the doc subdirectory and enter "make alldoc".
-
- Isn't rxvt-unicode supposed to be small? Don't all those features bloat?
- I often get asked about this, and I think, no, they didn't cause extra
- bloat. If you compare a minimal rxvt and a minimal urxvt, you can see
- that the urxvt binary is larger (due to some encoding tables always
- being compiled in), but it actually uses less memory (RSS) after
- startup. Even with "--disable-everything", this comparison is a bit
- unfair, as many features unique to urxvt (locale, encoding conversion,
- iso14755 etc.) are already in use in this mode.
-
- text data bss drs rss filename
- 98398 1664 24 15695 1824 rxvt --disable-everything
- 188985 9048 66616 18222 1788 urxvt --disable-everything
-
- When you "--enable-everything" (which *is* unfair, as this involves xft
- and full locale/XIM support which are quite bloaty inside libX11 and my
- libc), the two diverge, but not unreasonably so.
-
- text data bss drs rss filename
- 163431 2152 24 20123 2060 rxvt --enable-everything
- 1035683 49680 66648 29096 3680 urxvt --enable-everything
-
- The very large size of the text section is explained by the east-asian
- encoding tables, which, if unused, take up disk space but nothing else
- and can be compiled out unless you rely on X11 core fonts that use those
- encodings. The BSS size comes from the 64k emergency buffer that my c++
- compiler allocates (but of course doesn't use unless you are out of
- memory). Also, using an xft font instead of a core font immediately adds
- a few megabytes of RSS. Xft indeed is responsible for a lot of RSS even
- when not used.
-
- Of course, due to every character using two or four bytes instead of
- one, a large scrollback buffer will ultimately make rxvt-unicode use
- more memory.
-
- Compared to e.g. Eterm (5112k), aterm (3132k) and xterm (4680k), this
- still fares rather well. And compared to some monsters like
- gnome-terminal (21152k + extra 4204k in separate processes) or konsole
- (22200k + extra 43180k in daemons that stay around after exit, plus half
- a minute of startup time, including the hundreds of warnings it spits
- out), it fares extremely well *g*.
-
- Why C++, isn't that unportable/bloated/uncool?
- Is this a question? :) It comes up very often. The simple answer is: I
- had to write it, and C++ allowed me to write and maintain it in a
- fraction of the time and effort (which is a scarce resource for me). Put
- even shorter: It simply wouldn't exist without C++.
-
- My personal stance on this is that C++ is less portable than C, but in
- the case of rxvt-unicode this hardly matters, as its portability limits
- are defined by things like X11, pseudo terminals, locale support and
- unix domain sockets, which are all less portable than C++ itself.
-
- Regarding the bloat, see the above question: It's easy to write programs
- in C that use gobs of memory, an certainly possible to write programs in
- C++ that don't. C++ also often comes with large libraries, but this is
- not necessarily the case with GCC. Here is what rxvt links against on my
- system with a minimal config:
-
- libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
- libc.so.6 => /lib/libc.so.6 (0x00002aaaaadde000)
- libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab01d000)
- /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
-
- And here is rxvt-unicode:
-
- libX11.so.6 => /usr/X11R6/lib/libX11.so.6 (0x00002aaaaabc3000)
- libgcc_s.so.1 => /lib/libgcc_s.so.1 (0x00002aaaaada2000)
- libc.so.6 => /lib/libc.so.6 (0x00002aaaaaeb0000)
- libdl.so.2 => /lib/libdl.so.2 (0x00002aaaab0ee000)
- /lib64/ld-linux-x86-64.so.2 (0x00002aaaaaaab000)
-
- No large bloated libraries (of course, none were linked in statically),
- except maybe libX11 :)
-
- Rendering, Font & Look and Feel Issues
- I can't get transparency working, what am I doing wrong?
- First of all, please address all transparency related issues to Sasha
- Vasko at sasha@aftercode.net and do not bug the author about it. Also,
- if you can't get it working consider it a rite of passage: ... and you
- failed.
-
- Here are four ways to get transparency. Do read the manpage and option
- descriptions for the programs mentioned and rxvt-unicode. Really, do it!
-
- 1. Use transparent mode:
-
- Esetroot wallpaper.jpg
- urxvt -tr -tint red -sh 40
-
- That works. If you think it doesn't, you lack transparency and tinting
- support, or you are unable to read.
-
- 2. Use a simple pixmap and emulate pseudo-transparency. This enables you
- to use effects other than tinting and shading: Just shade/tint/whatever
- your picture with gimp or any other tool:
-
- convert wallpaper.jpg -blur 20x20 -modulate 30 background.jpg
- urxvt -pixmap "background.jpg;:root"
-
- That works. If you think it doesn't, you lack AfterImage support, or you
- are unable to read.
-
- 3. Use an ARGB visual:
-
- urxvt -depth 32 -fg grey90 -bg rgba:0000/0000/4444/cccc
-
- This requires XFT support, and the support of your X-server. If that
- doesn't work for you, blame Xorg and Keith Packard. ARGB visuals aren't
- there yet, no matter what they claim. Rxvt-Unicode contains the
- necessary bugfixes and workarounds for Xft and Xlib to make it work, but
- that doesn't mean that your WM has the required kludges in place.
-
- 4. Use xcompmgr and let it do the job:
-
- xprop -frame -f _NET_WM_WINDOW_OPACITY 32c \
- -set _NET_WM_WINDOW_OPACITY 0xc0000000
-
- Then click on a window you want to make transparent. Replace 0xc0000000
- by other values to change the degree of opacity. If it doesn't work and
- your server crashes, you got to keep the pieces.
-
- Why does rxvt-unicode sometimes leave pixel droppings?
- Most fonts were not designed for terminal use, which means that
- character size varies a lot. A font that is otherwise fine for terminal
- use might contain some characters that are simply too wide. Rxvt-unicode
- will avoid these characters. For characters that are just "a bit" too
- wide a special "careful" rendering mode is used that redraws adjacent
- characters.
-
- All of this requires that fonts do not lie about character sizes,
- however: Xft fonts often draw glyphs larger than their acclaimed
- bounding box, and rxvt-unicode has no way of detecting this (the correct
- way is to ask for the character bounding box, which unfortunately is
- wrong in these cases).
-
- It's not clear (to me at least), whether this is a bug in Xft, freetype,
- or the respective font. If you encounter this problem you might try
- using the "-lsp" option to give the font more height. If that doesn't
- work, you might be forced to use a different font.
-
- All of this is not a problem when using X11 core fonts, as their
- bounding box data is correct.
-
- How can I keep rxvt-unicode from using reverse video so much?
- First of all, make sure you are running with the right terminal settings
- ("TERM=rxvt-unicode"), which will get rid of most of these effects. Then
- make sure you have specified colours for italic and bold, as otherwise
- rxvt-unicode might use reverse video to simulate the effect:
-
- URxvt.colorBD: white
- URxvt.colorIT: green
-
- Some programs assume totally weird colours (red instead of blue), how can I fix that?
- For some unexplainable reason, some rare programs assume a very weird
- colour palette when confronted with a terminal with more than the
- standard 8 colours (rxvt-unicode supports 88). The right fix is, of
- course, to fix these programs not to assume non-ISO colours without very
- good reasons.
-
- In the meantime, you can either edit your "rxvt-unicode" terminfo
- definition to only claim 8 colour support or use "TERM=rxvt", which will
- fix colours but keep you from using other rxvt-unicode features.
-
- Can I switch the fonts at runtime?
- Yes, using an escape sequence. Try something like this, which has the
- same effect as using the "-fn" switch, and takes effect immediately:
-
- printf '\33]50;%s\007' "9x15bold,xft:Kochi Gothic"
-
- This is useful if you e.g. work primarily with japanese (and prefer a
- japanese font), but you have to switch to chinese temporarily, where
- japanese fonts would only be in your way.
-
- You can think of this as a kind of manual ISO-2022 switching.
-
- Why do italic characters look as if clipped?
- Many fonts have difficulties with italic characters and hinting. For
- example, the otherwise very nicely hinted font "xft:Bitstream Vera Sans
- Mono" completely fails in its italic face. A workaround might be to
- enable freetype autohinting, i.e. like this:
-
- URxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
- URxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
-
- Can I speed up Xft rendering somehow?
- Yes, the most obvious way to speed it up is to avoid Xft entirely, as it
- is simply slow. If you still want Xft fonts you might try to disable
- antialiasing (by appending ":antialias=false"), which saves lots of
- memory and also speeds up rendering considerably.
-
- Rxvt-unicode doesn't seem to anti-alias its fonts, what is wrong?
- Rxvt-unicode will use whatever you specify as a font. If it needs to
- fall back to its default font search list it will prefer X11 core fonts,
- because they are small and fast, and then use Xft fonts. It has
- antialiasing disabled for most of them, because the author thinks they
- look best that way.
-
- If you want antialiasing, you have to specify the fonts manually.
-
- What's with this bold/blink stuff?
- If no bold colour is set via "colorBD:", bold will invert text using the
- standard foreground colour.
-
- For the standard background colour, blinking will actually make the text
- blink when compiled with "--enable-text-blink". Without
- "--enable-text-blink", the blink attribute will be ignored.
-
- On ANSI colours, bold/blink attributes are used to set high-intensity
- foreground/background colors.
-
- color0-7 are the low-intensity colors.
-
- color8-15 are the corresponding high-intensity colors.
-
- I don't like the screen colors. How do I change them?
- You can change the screen colors at run-time using ~/.Xdefaults
- resources (or as long-options).
-
- Here are values that are supposed to resemble a VGA screen, including
- the murky brown that passes for low-intensity yellow:
-
- URxvt.color0: #000000
- URxvt.color1: #A80000
- URxvt.color2: #00A800
- URxvt.color3: #A8A800
- URxvt.color4: #0000A8
- URxvt.color5: #A800A8
- URxvt.color6: #00A8A8
- URxvt.color7: #A8A8A8
-
- URxvt.color8: #000054
- URxvt.color9: #FF0054
- URxvt.color10: #00FF54
- URxvt.color11: #FFFF54
- URxvt.color12: #0000FF
- URxvt.color13: #FF00FF
- URxvt.color14: #00FFFF
- URxvt.color15: #FFFFFF
-
- And here is a more complete set of non-standard colors.
-
- URxvt.cursorColor: #dc74d1
- URxvt.pointerColor: #dc74d1
- URxvt.background: #0e0e0e
- URxvt.foreground: #4ad5e1
- URxvt.color0: #000000
- URxvt.color8: #8b8f93
- URxvt.color1: #dc74d1
- URxvt.color9: #dc74d1
- URxvt.color2: #0eb8c7
- URxvt.color10: #0eb8c7
- URxvt.color3: #dfe37e
- URxvt.color11: #dfe37e
- URxvt.color5: #9e88f0
- URxvt.color13: #9e88f0
- URxvt.color6: #73f7ff
- URxvt.color14: #73f7ff
- URxvt.color7: #e1dddd
- URxvt.color15: #e1dddd
-
- They have been described (not by me) as "pretty girly".
-
- Why do some characters look so much different than others?
- See next entry.
-
- How does rxvt-unicode choose fonts?
- Most fonts do not contain the full range of Unicode, which is fine.
- Chances are that the font you (or the admin/package maintainer of your
- system/os) have specified does not cover all the characters you want to
- display.
-
- rxvt-unicode makes a best-effort try at finding a replacement font.
- Often the result is fine, but sometimes the chosen font looks
- bad/ugly/wrong. Some fonts have totally strange characters that don't
- resemble the correct glyph at all, and rxvt-unicode lacks the artificial
- intelligence to detect that a specific glyph is wrong: it has to believe
- the font that the characters it claims to contain indeed look correct.
-
- In that case, select a font of your taste and add it to the font list,
- e.g.:
-
- urxvt -fn basefont,font2,font3...
-
- When rxvt-unicode sees a character, it will first look at the base font.
- If the base font does not contain the character, it will go to the next
- font, and so on. Specifying your own fonts will also speed up this
- search and use less resources within rxvt-unicode and the X-server.
-
- The only limitation is that none of the fonts may be larger than the
- base font, as the base font defines the terminal character cell size,
- which must be the same due to the way terminals work.
-
- Why do some chinese characters look so different than others?
- This is because there is a difference between script and language --
- rxvt-unicode does not know which language the text that is output is, as
- it only knows the unicode character codes. If rxvt-unicode first sees a
- japanese/chinese character, it might choose a japanese font for display.
- Subsequent japanese characters will use that font. Now, many chinese
- characters aren't represented in japanese fonts, so when the first
- non-japanese character comes up, rxvt-unicode will look for a chinese
- font -- unfortunately at this point, it will still use the japanese font
- for chinese characters that are also in the japanese font.
-
- The workaround is easy: just tag a chinese font at the end of your font
- list (see the previous question). The key is to view the font list as a
- preference list: If you expect more japanese, list a japanese font
- first. If you expect more chinese, put a chinese font first.
-
- In the future it might be possible to switch language preferences at
- runtime (the internal data structure has no problem with using different
- fonts for the same character at the same time, but no interface for this
- has been designed yet).
-
- Until then, you might get away with switching fonts at runtime (see "Can
- I switch the fonts at runtime?" later in this document).
-
- How can I make mplayer display video correctly?
- We are working on it, in the meantime, as a workaround, use something
- like:
-
- urxvt -b 600 -geometry 20x1 -e sh -c 'mplayer -wid $WINDOWID file...'
-
- Keyboard, Mouse & User Interaction
- The new selection selects pieces that are too big, how can I select single words?
- If you want to select e.g. alphanumeric words, you can use the following
- setting:
-
- URxvt.selection.pattern-0: ([[:word:]]+)
-
- If you click more than twice, the selection will be extended more and
- more.
-
- To get a selection that is very similar to the old code, try this
- pattern:
-
- URxvt.selection.pattern-0: ([^"&'()*,;<=>?@[\\\\]^`{|})]+)
-
- Please also note that the *LeftClick Shift-LeftClik* combination also
- selects words like the old code.
-
- I don't like the new selection/popups/hotkeys/perl, how do I change/disable it?
- You can disable the perl extension completely by setting the
- perl-ext-common resource to the empty string, which also keeps
- rxvt-unicode from initialising perl, saving memory.
-
- If you only want to disable specific features, you first have to
- identify which perl extension is responsible. For this, read the section
- PREPACKAGED EXTENSIONS in the urxvtperl(3) manpage. For example, to
- disable the selection-popup and option-popup, specify this
- perl-ext-common resource:
-
- URxvt.perl-ext-common: default,-selection-popup,-option-popup
-
- This will keep the default extensions, but disable the two popup
- extensions. Some extensions can also be configured, for example,
- scrollback search mode is triggered by M-s. You can move it to any other
- combination either by setting the searchable-scrollback resource:
-
- URxvt.searchable-scrollback: CM-s
-
- The cursor moves when selecting text in the current input line, how do I switch this off?
- See next entry.
-
- During rlogin/ssh/telnet/etc. sessions, clicking near the cursor outputs strange escape sequences, how do I fix this?
- These are caused by the "readline" perl extension. Under normal
- circumstances, it will move your cursor around when you click into the
- line that contains it. It tries hard not to do this at the wrong moment,
- but when running a program that doesn't parse cursor movements or in
- some cases during rlogin sessions, it fails to detect this properly.
-
- You can permanently switch this feature off by disabling the "readline"
- extension:
-
- URxvt.perl-ext-common: default,-readline
-
- My numerical keypad acts weird and generates differing output?
- Some Debian GNUL/Linux users seem to have this problem, although no
- specific details were reported so far. It is possible that this is
- caused by the wrong "TERM" setting, although the details of whether and
- how this can happen are unknown, as "TERM=rxvt" should offer a
- compatible keymap. See the answer to the previous question, and please
- report if that helped.
-
- My Compose (Multi_key) key is no longer working.
- The most common causes for this are that either your locale is not set
- correctly, or you specified a preeditStyle that is not supported by your
- input method. For example, if you specified OverTheSpot and your input
- method (e.g. the default input method handling Compose keys) does not
- support this (for instance because it is not visual), then rxvt-unicode
- will continue without an input method.
-
- In this case either do not specify a preeditStyle or specify more than
- one pre-edit style, such as OverTheSpot,Root,None.
-
- I cannot type "Ctrl-Shift-2" to get an ASCII NUL character due to ISO 14755
- Either try "Ctrl-2" alone (it often is mapped to ASCII NUL even on
- international keyboards) or simply use ISO 14755 support to your
- advantage, typing <Ctrl-Shift-0> to get a ASCII NUL. This works for
- other codes, too, such as "Ctrl-Shift-1-d" to type the default telnet
- escape character and so on.
-
- Mouse cut/paste suddenly no longer works.
- Make sure that mouse reporting is actually turned off since killing some
- editors prematurely may leave the mouse in mouse report mode. I've heard
- that tcsh may use mouse reporting unless it otherwise specified. A quick
- check is to see if cut/paste works when the Alt or Shift keys are
- depressed.
-
- What's with the strange Backspace/Delete key behaviour?
- Assuming that the physical Backspace key corresponds to the Backspace
- keysym (not likely for Linux ... see the following question) there are
- two standard values that can be used for Backspace: "^H" and "^?".
-
- Historically, either value is correct, but rxvt-unicode adopts the
- debian policy of using "^?" when unsure, because it's the one and only
- correct choice :).
-
- Rxvt-unicode tries to inherit the current stty settings and uses the
- value of `erase' to guess the value for backspace. If rxvt-unicode
- wasn't started from a terminal (say, from a menu or by remote shell),
- then the system value of `erase', which corresponds to CERASE in
- <termios.h>, will be used (which may not be the same as your stty
- setting).
-
- For starting a new rxvt-unicode:
-
- # use Backspace = ^H
- $ stty erase ^H
- $ urxvt
-
- # use Backspace = ^?
- $ stty erase ^?
- $ urxvt
-
- Toggle with "ESC [ 36 h" / "ESC [ 36 l".
-
- For an existing rxvt-unicode:
-
- # use Backspace = ^H
- $ stty erase ^H
- $ echo -n "^[[36h"
-
- # use Backspace = ^?
- $ stty erase ^?
- $ echo -n "^[[36l"
-
- This helps satisfy some of the Backspace discrepancies that occur, but
- if you use Backspace = "^H", make sure that the termcap/terminfo value
- properly reflects that.
-
- The Delete key is a another casualty of the ill-defined Backspace
- problem. To avoid confusion between the Backspace and Delete keys, the
- Delete key has been assigned an escape sequence to match the vt100 for
- Execute ("ESC [ 3 ~") and is in the supplied termcap/terminfo.
-
- Some other Backspace problems:
-
- some editors use termcap/terminfo, some editors (vim I'm told) expect
- Backspace = ^H, GNU Emacs (and Emacs-like editors) use ^H for help.
-
- Perhaps someday this will all be resolved in a consistent manner.
-
- I don't like the key-bindings. How do I change them?
- There are some compile-time selections available via configure. Unless
- you have run "configure" with the "--disable-resources" option you can
- use the `keysym' resource to alter the keystrings associated with
- keysyms.
-
- Here's an example for a URxvt session started using "urxvt -name URxvt"
-
- URxvt.keysym.Home: \033[1~
- URxvt.keysym.End: \033[4~
- URxvt.keysym.C-apostrophe: \033<C-'>
- URxvt.keysym.C-slash: \033<C-/>
- URxvt.keysym.C-semicolon: \033<C-;>
- URxvt.keysym.C-grave: \033<C-`>
- URxvt.keysym.C-comma: \033<C-,>
- URxvt.keysym.C-period: \033<C-.>
- URxvt.keysym.C-0x60: \033<C-`>
- URxvt.keysym.C-Tab: \033<C-Tab>
- URxvt.keysym.C-Return: \033<C-Return>
- URxvt.keysym.S-Return: \033<S-Return>
- URxvt.keysym.S-space: \033<S-Space>
- URxvt.keysym.M-Up: \033<M-Up>
- URxvt.keysym.M-Down: \033<M-Down>
- URxvt.keysym.M-Left: \033<M-Left>
- URxvt.keysym.M-Right: \033<M-Right>
- URxvt.keysym.M-C-0: list \033<M-C- 0123456789 >
- URxvt.keysym.M-C-a: list \033<M-C- abcdefghijklmnopqrstuvwxyz >
- URxvt.keysym.F12: command:\033]701;zh_CN.GBK\007
-
- See some more examples in the documentation for the keysym resource.
-
- I'm using keyboard model XXX that has extra Prior/Next/Insert keys. How do I make use of them? For example, the Sun Keyboard type 4 has the following map
- KP_Insert == Insert
- F22 == Print
- F27 == Home
- F29 == Prior
- F33 == End
- F35 == Next
-
- Rather than have rxvt-unicode try to accommodate all the various
- possible keyboard mappings, it is better to use `xmodmap' to remap the
- keys as required for your particular machine.
-
- Terminal Configuration
- Can I see a typical configuration?
- The default configuration tries to be xterm-like, which I don't like
- that much, but it's least surprise to regular users.
-
- As a rxvt or rxvt-unicode user, you are practically supposed to invest
- time into customising your terminal. To get you started, here is the
- author's .Xdefaults entries, with comments on what they do. It's
- certainly not *typical*, but what's typical...
-
- URxvt.cutchars: "()*,<>[]{}|'
- URxvt.print-pipe: cat >/tmp/xxx
-
- These are just for testing stuff.
-
- URxvt.imLocale: ja_JP.UTF-8
- URxvt.preeditType: OnTheSpot,None
-
- This tells rxvt-unicode to use a special locale when communicating with
- the X Input Method, and also tells it to only use the OnTheSpot pre-edit
- type, which requires the "xim-onthespot" perl extension but rewards me
- with correct-looking fonts.
-
- URxvt.perl-lib: /root/lib/urxvt
- URxvt.perl-ext-common: default,selection-autotransform,selection-pastebin,xim-onthespot,remote-clipboard
- URxvt.selection.pattern-0: ( at .*? line \\d+)
- URxvt.selection.pattern-1: ^(/[^:]+):\
- URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
- URxvt.selection-autotransform.1: s/^ at (.*?) line (\\d+)$/:e \\Q$1\\E\\x0d:$2\\x0d/
-
- This is my perl configuration. The first two set the perl library
- directory and also tells urxvt to use a large number of extensions. I
- develop for myself mostly, so I actually use most of the extensions I
- write.
-
- The selection stuff mainly makes the selection perl-error-message aware
- and tells it to convert perl error messages into vi-commands to load the
- relevant file and go tot he error line number.
-
- URxvt.scrollstyle: plain
- URxvt.secondaryScroll: true
-
- As the documentation says: plain is the preferred scrollbar for the
- author. The "secondaryScroll" configures urxvt to scroll in full-screen
- apps, like screen, so lines scrolled out of screen end up in urxvt's
- scrollback buffer.
-
- URxvt.background: #000000
- URxvt.foreground: gray90
- URxvt.color7: gray90
- URxvt.colorBD: #ffffff
- URxvt.cursorColor: #e0e080
- URxvt.throughColor: #8080f0
- URxvt.highlightColor: #f0f0f0
-
- Some colours. Not sure which ones are being used or even non-defaults,
- but these are in my .Xdefaults. Most notably, they set
- foreground/background to light gray/black, and also make sure that the
- colour 7 matches the default foreground colour.
-
- URxvt.underlineColor: yellow
-
- Another colour, makes underline lines look different. Sometimes hurts,
- but is mostly a nice effect.
-
- URxvt.geometry: 154x36
- URxvt.loginShell: false
- URxvt.meta: ignore
- URxvt.utmpInhibit: true
-
- Uh, well, should be mostly self-explanatory. By specifying some defaults
- manually, I can quickly switch them for testing.
-
- URxvt.saveLines: 8192
-
- A large scrollback buffer is essential. Really.
-
- URxvt.mapAlert: true
-
- The only case I use it is for my IRC window, which I like to keep
- iconified till people msg me (which beeps).
-
- URxvt.visualBell: true
-
- The audible bell is often annoying, especially when in a crowd.
-
- URxvt.insecure: true
-
- Please don't hack my mutt! Ooops...
-
- URxvt.pastableTabs: false
-
- I once thought this is a great idea.
-
- urxvt.font: 9x15bold,\
- -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
- -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
- [codeset=JISX0208]xft:Kochi Gothic, \
- xft:Bitstream Vera Sans Mono:autohint=true, \
- xft:Code2000:antialias=false
- urxvt.boldFont: -xos4-terminus-bold-r-normal--14-140-72-72-c-80-iso8859-15
- urxvt.italicFont: xft:Bitstream Vera Sans Mono:italic:autohint=true
- urxvt.boldItalicFont: xft:Bitstream Vera Sans Mono:bold:italic:autohint=true
-
- I wrote rxvt-unicode to be able to specify fonts exactly. So don't be
- overwhelmed. A special note: the "9x15bold" mentioned above is actually
- the version from XFree-3.3, as XFree-4 replaced it by a totally
- different font (different glyphs for ";" and many other harmless
- characters), while the second font is actually the "9x15bold" from
- XFree4/XOrg. The bold version has less chars than the medium version, so
- I use it for rare characters, too. When editing sources with vim, I use
- italic for comments and other stuff, which looks quite good with
- Bitstream Vera anti-aliased.
-
- Terminus is a quite bad font (many very wrong glyphs), but for most of
- my purposes, it works, and gives a different look, as my normal
- (Non-bold) font is already bold, and I want to see a difference between
- bold and normal fonts.
-
- Please note that I used the "urxvt" instance name and not the "URxvt"
- class name. Thats because I use different configs for different
- purposes, for example, my IRC window is started with "-name IRC", and
- uses these defaults:
-
- IRC*title: IRC
- IRC*geometry: 87x12+535+542
- IRC*saveLines: 0
- IRC*mapAlert: true
- IRC*font: suxuseuro
- IRC*boldFont: suxuseuro
- IRC*colorBD: white
- IRC*keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
- IRC*keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
-
- "Alt-Shift-1" and "Alt-Shift-2" switch between two different font sizes.
- "suxuseuro" allows me to keep an eye (and actually read) stuff while
- keeping a very small window. If somebody pastes something complicated
- (e.g. japanese), I temporarily switch to a larger font.
-
- The above is all in my ".Xdefaults" (I don't use ".Xresources" nor
- "xrdb"). I also have some resources in a separate ".Xdefaults-hostname"
- file for different hosts, for example, on ym main desktop, I use:
-
- URxvt.keysym.C-M-q: command:\033[3;5;5t
- URxvt.keysym.C-M-y: command:\033[3;5;606t
- URxvt.keysym.C-M-e: command:\033[3;1605;5t
- URxvt.keysym.C-M-c: command:\033[3;1605;606t
- URxvt.keysym.C-M-p: perl:test
-
- The first for keysym definitions allow me to quickly bring some windows
- in the layout I like most. Ion users might start laughing but will stop
- immediately when I tell them that I use my own Fvwm2 module for much the
- same effect as Ion provides, and I only very rarely use the above key
- combinations :->
-
- Why doesn't rxvt-unicode read my resources?
- Well, why, indeed? It does, in a way very similar to other X
- applications. Most importantly, this means that if you or your OS loads
- resources into the X display (the right way to do it), rxvt-unicode will
- ignore any resource files in your home directory. It will only read
- $HOME/.Xdefaults when no resources are attached to the display.
-
- If you have or use an $HOME/.Xresources file, chances are that resources
- are loaded into your X-server. In this case, you have to re-login after
- every change (or run xrdb -merge $HOME/.Xresources).
-
- Also consider the form resources have to use:
-
- URxvt.resource: value
-
- If you want to use another form (there are lots of different ways of
- specifying resources), make sure you understand whether and why it
- works. If unsure, use the form above.
-
- When I log-in to another system it tells me about missing terminfo data?
- The terminal description used by rxvt-unicode is not as widely available
- as that for xterm, or even rxvt (for which the same problem often
- arises).
-
- The correct solution for this problem is to install the terminfo, this
- can be done like this (with ncurses' infocmp and works as user and
- admin):
-
- REMOTE=remotesystem.domain
- infocmp rxvt-unicode | ssh $REMOTE "mkdir -p .terminfo && cat >/tmp/ti && tic /tmp/ti"
-
- ... or by installing rxvt-unicode normally on the remote system,
-
- One some systems you might need to set $TERMINFO to the full path of
- $HOME/.terminfo for this to work.
-
- If you cannot or do not want to do this, then you can simply set
- "TERM=rxvt" or even "TERM=xterm", and live with the small number of
- problems arising, which includes wrong keymapping, less and different
- colours and some refresh errors in fullscreen applications. It's a nice
- quick-and-dirty workaround for rare cases, though.
-
- If you always want to do this (and are fine with the consequences) you
- can either recompile rxvt-unicode with the desired TERM value or use a
- resource to set it:
-
- URxvt.termName: rxvt
-
- If you don't plan to use rxvt (quite common...) you could also replace
- the rxvt terminfo file with the rxvt-unicode one and use "TERM=rxvt".
-
- "tic" outputs some error when compiling the terminfo entry.
- Most likely it's the empty definition for "enacs=". Just replace it by
- "enacs=\E[0@" and try again.
-
- "bash"'s readline does not work correctly under urxvt.
- See next entry.
-
- I need a termcap file entry.
- One reason you might want this is that some distributions or operating
- systems still compile some programs using the long-obsoleted termcap
- library (Fedora Core's bash is one example) and rely on a termcap entry
- for "rxvt-unicode".
-
- You could use rxvt's termcap entry with reasonable results in many
- cases. You can also create a termcap entry by using terminfo's infocmp
- program like this:
-
- infocmp -C rxvt-unicode
-
- Or you could use this termcap entry, generated by the command above:
-
- rxvt-unicode|rxvt-unicode terminal (X Window System):\
- :am:bw:eo:km:mi:ms:xn:xo:\
- :co#80:it#8:li#24:lm#0:\
- :AL=\E[%dL:DC=\E[%dP:DL=\E[%dM:DO=\E[%dB:IC=\E[%d@:\
- :K1=\EOw:K2=\EOu:K3=\EOy:K4=\EOq:K5=\EOs:LE=\E[%dD:\
- :RI=\E[%dC:SF=\E[%dS:SR=\E[%dT:UP=\E[%dA:ae=\E(B:al=\E[L:\
- :as=\E(0:bl=^G:cd=\E[J:ce=\E[K:cl=\E[H\E[2J:\
- :cm=\E[%i%d;%dH:cr=^M:cs=\E[%i%d;%dr:ct=\E[3g:dc=\E[P:\
- :dl=\E[M:do=^J:ec=\E[%dX:ei=\E[4l:ho=\E[H:\
- :i1=\E[?47l\E=\E[?1l:ic=\E[@:im=\E[4h:\
- :is=\E[r\E[m\E[2J\E[H\E[?7h\E[?1;3;4;6l\E[4l:\
- :k1=\E[11~:k2=\E[12~:k3=\E[13~:k4=\E[14~:k5=\E[15~:\
- :k6=\E[17~:k7=\E[18~:k8=\E[19~:k9=\E[20~:kD=\E[3~:\
- :kI=\E[2~:kN=\E[6~:kP=\E[5~:kb=\177:kd=\EOB:ke=\E[?1l\E>:\
- :kh=\E[7~:kl=\EOD:kr=\EOC:ks=\E[?1h\E=:ku=\EOA:le=^H:\
- :mb=\E[5m:md=\E[1m:me=\E[m\017:mr=\E[7m:nd=\E[C:rc=\E8:\
- :sc=\E7:se=\E[27m:sf=^J:so=\E[7m:sr=\EM:st=\EH:ta=^I:\
- :te=\E[r\E[?1049l:ti=\E[?1049h:ue=\E[24m:up=\E[A:\
- :us=\E[4m:vb=\E[?5h\E[?5l:ve=\E[?25h:vi=\E[?25l:\
- :vs=\E[?25h:
-
- Why does "ls" no longer have coloured output?
- The "ls" in the GNU coreutils unfortunately doesn't use terminfo to
- decide whether a terminal has colour, but uses its own configuration
- file. Needless to say, "rxvt-unicode" is not in its default file (among
- with most other terminals supporting colour). Either add:
-
- TERM rxvt-unicode
-
- to "/etc/DIR_COLORS" or simply add:
-
- alias ls='ls --color=auto'
-
- to your ".profile" or ".bashrc".
-
- Why doesn't vim/emacs etc. use the 88 colour mode?
- See next entry.
-
- Why doesn't vim/emacs etc. make use of italic?
- See next entry.
-
- Why are the secondary screen-related options not working properly?
- Make sure you are using "TERM=rxvt-unicode". Some pre-packaged
- distributions (most notably Debian GNU/Linux) break rxvt-unicode by
- setting "TERM" to "rxvt", which doesn't have these extra features.
- Unfortunately, some of these (most notably, again, Debian GNU/Linux)
- furthermore fail to even install the "rxvt-unicode" terminfo file, so
- you will need to install it on your own (See the question When I log-in
- to another system it tells me about missing terminfo data? on how to do
- this).
-
- Encoding / Locale / Input Method Issues
- Rxvt-unicode does not seem to understand the selected encoding?
- See next entry.
-
- Unicode does not seem to work?
- If you encounter strange problems like typing an accented character but
- getting two unrelated other characters or similar, or if program output
- is subtly garbled, then you should check your locale settings.
-
- Rxvt-unicode must be started with the same "LC_CTYPE" setting as the
- programs running in it. Often rxvt-unicode is started in the "C" locale,
- while the login script running within the rxvt-unicode window changes
- the locale to something else, e.g. "en_GB.UTF-8". Needless to say, this
- is not going to work, and is the most common cause for problems.
-
- The best thing is to fix your startup environment, as you will likely
- run into other problems. If nothing works you can try this in your
- .profile.
-
- printf '\33]701;%s\007' "$LC_CTYPE" # $LANG or $LC_ALL are worth a try, too
-
- If this doesn't work, then maybe you use a "LC_CTYPE" specification not
- supported on your systems. Some systems have a "locale" command which
- displays this (also, "perl -e0" can be used to check locale settings, as
- it will complain loudly if it cannot set the locale). If it displays
- something like:
-
- locale: Cannot set LC_CTYPE to default locale: ...
-
- Then the locale you specified is not supported on your system.
-
- If nothing works and you are sure that everything is set correctly then
- you will need to remember a little known fact: Some programs just don't
- support locales :(
-
- How does rxvt-unicode determine the encoding to use?
- See next entry.
-
- Is there an option to switch encodings?
- Unlike some other terminals, rxvt-unicode has no encoding switch, and no
- specific "utf-8" mode, such as xterm. In fact, it doesn't even know
- about UTF-8 or any other encodings with respect to terminal I/O.
-
- The reasons is that there exists a perfectly fine mechanism for
- selecting the encoding, doing I/O and (most important) communicating
- this to all applications so everybody agrees on character properties
- such as width and code number. This mechanism is the *locale*.
- Applications not using that info will have problems (for example,
- "xterm" gets the width of characters wrong as it uses its own,
- locale-independent table under all locales).
-
- Rxvt-unicode uses the "LC_CTYPE" locale category to select encoding. All
- programs doing the same (that is, most) will automatically agree in the
- interpretation of characters.
-
- Unfortunately, there is no system-independent way to select locales, nor
- is there a standard on how locale specifiers will look like.
-
- On most systems, the content of the "LC_CTYPE" environment variable
- contains an arbitrary string which corresponds to an already-installed
- locale. Common names for locales are "en_US.UTF-8", "de_DE.ISO-8859-15",
- "ja_JP.EUC-JP", i.e. "language_country.encoding", but other forms (i.e.
- "de" or "german") are also common.
-
- Rxvt-unicode ignores all other locale categories, and except for the
- encoding, ignores country or language-specific settings, i.e.
- "de_DE.UTF-8" and "ja_JP.UTF-8" are the normally same to rxvt-unicode.
-
- If you want to use a specific encoding you have to make sure you start
- rxvt-unicode with the correct "LC_CTYPE" category.
-
- Can I switch locales at runtime?
- Yes, using an escape sequence. Try something like this, which sets
- rxvt-unicode's idea of "LC_CTYPE".
-
- printf '\33]701;%s\007' ja_JP.SJIS
-
- See also the previous answer.
-
- Sometimes this capability is rather handy when you want to work in one
- locale (e.g. "de_DE.UTF-8") but some programs don't support it (e.g.
- UTF-8). For example, I use this script to start "xjdic", which first
- switches to a locale supported by xjdic and back later:
-
- printf '\33]701;%s\007' ja_JP.SJIS
- xjdic -js
- printf '\33]701;%s\007' de_DE.UTF-8
-
- You can also use xterm's "luit" program, which usually works fine,
- except for some locales where character width differs between program-
- and rxvt-unicode-locales.
-
- I have problems getting my input method working.
- Try a search engine, as this is slightly different for every input
- method server.
-
- Here is a checklist:
-
- - Make sure your locale *and* the imLocale are supported on your OS.
- Try "locale -a" or check the documentation for your OS.
-
- - Make sure your locale or imLocale matches a locale supported by your
- XIM.
- For example, kinput2 does not support UTF-8 locales, you should use
- "ja_JP.EUC-JP" or equivalent.
-
- - Make sure your XIM server is actually running.
- - Make sure the "XMODIFIERS" environment variable is set correctly when
- *starting* rxvt-unicode.
- When you want to use e.g. kinput2, it must be set to "@im=kinput2".
- For scim, use "@im=SCIM". You can see what input method servers are
- running with this command:
-
- xprop -root XIM_SERVERS
-
- *
-
- My input method wants <some encoding> but I want UTF-8, what can I do?
- You can specify separate locales for the input method and the rest of
- the terminal, using the resource "imlocale":
-
- URxvt.imlocale: ja_JP.EUC-JP
-
- Now you can start your terminal with "LC_CTYPE=ja_JP.UTF-8" and still
- use your input method. Please note, however, that, depending on your
- Xlib version, you may not be able to input characters outside "EUC-JP"
- in a normal way then, as your input method limits you.
-
- Rxvt-unicode crashes when the X Input Method changes or exits.
- Unfortunately, this is unavoidable, as the XIM protocol is racy by
- design. Applications can avoid some crashes at the expense of memory
- leaks, and Input Methods can avoid some crashes by careful ordering at
- exit time. kinput2 (and derived input methods) generally succeeds, while
- SCIM (or similar input methods) fails. In the end, however, crashes
- cannot be completely avoided even if both sides cooperate.
-
- So the only workaround is not to kill your Input Method Servers.
-
- Operating Systems / Package Maintaining
- I am using Debian GNU/Linux and have a problem...
- The Debian GNU/Linux package of rxvt-unicode in sarge contains large
- patches that considerably change the behaviour of rxvt-unicode (but
- unfortunately this notice has been removed). Before reporting a bug to
- the original rxvt-unicode author please download and install the genuine
- version (<http://software.schmorp.de#rxvt-unicode>) and try to reproduce
- the problem. If you cannot, chances are that the problems are specific
- to Debian GNU/Linux, in which case it should be reported via the Debian
- Bug Tracking System (use "reportbug" to report the bug).
-
- For other problems that also affect the Debian package, you can and
- probably should use the Debian BTS, too, because, after all, it's also a
- bug in the Debian version and it serves as a reminder for other users
- that might encounter the same issue.
-
- I am maintaining rxvt-unicode for distribution/OS XXX, any recommendation?
- You should build one binary with the default options. configure now
- enables most useful options, and the trend goes to making them
- runtime-switchable, too, so there is usually no drawback to enabling
- them, except higher disk and possibly memory usage. The perl interpreter
- should be enabled, as important functionality (menus, selection, likely
- more in the future) depends on it.
-
- You should not overwrite the "perl-ext-common" snd "perl-ext" resources
- system-wide (except maybe with "defaults"). This will result in useful
- behaviour. If your distribution aims at low memory, add an empty
- "perl-ext-common" resource to the app-defaults file. This will keep the
- perl interpreter disabled until the user enables it.
-
- If you can/want build more binaries, I recommend building a minimal one
- with "--disable-everything" (very useful) and a maximal one with
- "--enable-everything" (less useful, it will be very big due to a lot of
- encodings built-in that increase download times and are rarely used).
-
- I need to make it setuid/setgid to support utmp/ptys on my OS, is this safe?
- It should be, starting with release 7.1. You are encouraged to properly
- install urxvt with privileges necessary for your OS now.
-
- When rxvt-unicode detects that it runs setuid or setgid, it will fork
- into a helper process for privileged operations (pty handling on some
- systems, utmp/wtmp/lastlog handling on others) and drop privileges
- immediately. This is much safer than most other terminals that keep
- privileges while running (but is more relevant to urxvt, as it contains
- things as perl interpreters, which might be "helpful" to attackers).
-
- This forking is done as the very first within main(), which is very
- early and reduces possible bugs to initialisation code run before
- main(), or things like the dynamic loader of your system, which should
- result in very little risk.
-
- I am on FreeBSD and rxvt-unicode does not seem to work at all.
- Rxvt-unicode requires the symbol "__STDC_ISO_10646__" to be defined in
- your compile environment, or an implementation that implements it,
- whether it defines the symbol or not. "__STDC_ISO_10646__" requires that
- wchar_t is represented as unicode.
-
- As you might have guessed, FreeBSD does neither define this symbol nor
- does it support it. Instead, it uses its own internal representation of
- wchar_t. This is, of course, completely fine with respect to standards.
-
- However, that means rxvt-unicode only works in "POSIX", "ISO-8859-1" and
- "UTF-8" locales under FreeBSD (which all use Unicode as wchar_t.
-
- "__STDC_ISO_10646__" is the only sane way to support multi-language apps
- in an OS, as using a locale-dependent (and non-standardized)
- representation of wchar_t makes it impossible to convert between wchar_t
- (as used by X11 and your applications) and any other encoding without
- implementing OS-specific-wrappers for each and every locale. There
- simply are no APIs to convert wchar_t into anything except the current
- locale encoding.
-
- Some applications (such as the formidable mlterm) work around this by
- carrying their own replacement functions for character set handling with
- them, and either implementing OS-dependent hacks or doing multiple
- conversions (which is slow and unreliable in case the OS implements
- encodings slightly different than the terminal emulator).
-
- The rxvt-unicode author insists that the right way to fix this is in the
- system libraries once and for all, instead of forcing every app to carry
- complete replacements for them :)
-
- How can I use rxvt-unicode under cygwin?
- rxvt-unicode should compile and run out of the box on cygwin, using the
- X11 libraries that come with cygwin. libW11 emulation is no longer
- supported (and makes no sense, either, as it only supported a single
- font). I recommend starting the X-server in "-multiwindow" or
- "-rootless" mode instead, which will result in similar look&feel as the
- old libW11 emulation.
-
- At the time of this writing, cygwin didn't seem to support any
- multi-byte encodings (you might try "LC_CTYPE=C-UTF-8"), so you are
- likely limited to 8-bit encodings.
-
- Character widths are not correct.
- urxvt uses the system wcwidth function to know the information about the
- width of characters, so on systems with incorrect locale data you will
- likely get bad results. Two notorious examples are Solaris 9, where
- single-width characters like U+2514 are reported as double-width, and
- Darwin 8, where combining chars are reported having width 1.
-
- The solution is to upgrade your system or switch to a better one. A
- possibly working workaround is to use a wcwidth implementation like
-
- http://www.cl.cam.ac.uk/~mgk25/ucs/wcwidth.c
-
-RXVT-UNICODE TECHNICAL REFERENCE
- The rest of this document describes various technical aspects of
- rxvt-unicode. First the description of supported command sequences,
- followed by pixmap support and last by a description of all features
- selectable at "configure" time.
-
- Definitions
- "c" The literal character c.
-
- "C" A single (required) character.
-
- "Ps"
- A single (usually optional) numeric parameter, composed of one or
- more digits.
-
- "Pm"
- A multiple numeric parameter composed of any number of single
- numeric parameters, separated by ";" character(s).
-
- "Pt"
- A text parameter composed of printable characters.
-
- Values
- "ENQ"
- Enquiry (Ctrl-E) = Send Device Attributes (DA) request attributes
- from terminal. See "ESC [ Ps c".
-
- "BEL"
- Bell (Ctrl-G)
-
- "BS"
- Backspace (Ctrl-H)
-
- "TAB"
- Horizontal Tab (HT) (Ctrl-I)
-
- "LF"
- Line Feed or New Line (NL) (Ctrl-J)
-
- "VT"
- Vertical Tab (Ctrl-K) same as "LF"
-
- "FF"
- Form Feed or New Page (NP) (Ctrl-L) same as "LF"
-
- "CR"
- Carriage Return (Ctrl-M)
-
- "SO"
- Shift Out (Ctrl-N), invokes the G1 character set. Switch to
- Alternate Character Set
-
- "SI"
- Shift In (Ctrl-O), invokes the G0 character set (the default).
- Switch to Standard Character Set
-
- "SPC"
- Space Character
-
- Escape Sequences
- "ESC # 8"
- DEC Screen Alignment Test (DECALN)
-
- "ESC 7"
- Save Cursor (SC)
-
- "ESC 8"
- Restore Cursor
-
- "ESC ="
- Application Keypad (SMKX). See also next sequence.
-
- "ESC"
- Normal Keypad (RMKX)
-
- Note: If the numeric keypad is activated, eg, Num_Lock has been
- pressed, numbers or control functions are generated by the numeric
- keypad (see Key Codes).
-
- "ESC D"
- Index (IND)
-
- "ESC E"
- Next Line (NEL)
-
- "ESC H"
- Tab Set (HTS)
-
- "ESC M"
- Reverse Index (RI)
-
- "ESC N"
- Single Shift Select of G2 Character Set (SS2): affects next
- character only *unimplemented*
-
- "ESC O"
- Single Shift Select of G3 Character Set (SS3): affects next
- character only *unimplemented*
-
- "ESC Z"
- Obsolete form of returns: "ESC [ ? 1 ; 2 C" *rxvt-unicode
- compile-time option*
-
- "ESC c"
- Full reset (RIS)
-
- "ESC n"
- Invoke the G2 Character Set (LS2)
-
- "ESC o"
- Invoke the G3 Character Set (LS3)
-
- "ESC ( C"
- Designate G0 Character Set (ISO 2022), see below for values of "C".
-
- "ESC ) C"
- Designate G1 Character Set (ISO 2022), see below for values of "C".
-
- "ESC * C"
- Designate G2 Character Set (ISO 2022), see below for values of "C".
-
- "ESC + C"
- Designate G3 Character Set (ISO 2022), see below for values of "C".
-
- "ESC $ C"
- Designate Kanji Character Set
-
- Where "C" is one of:
-
- C = 0 DEC Special Character and Line Drawing Set
- C = A United Kingdom (UK)
- C = B United States (USASCII)
- C = < Multinational character set unimplemented
- C = 5 Finnish character set unimplemented
- C = C Finnish character set unimplemented
- C = K German character set unimplemented
-
-
-
- CSI (Command Sequence Introducer) Sequences
- "ESC [ Ps @"
- Insert "Ps" (Blank) Character(s) [default: 1] (ICH)
-
- "ESC [ Ps A"
- Cursor Up "Ps" Times [default: 1] (CUU)
-
- "ESC [ Ps B"
- Cursor Down "Ps" Times [default: 1] (CUD)
-
- "ESC [ Ps C"
- Cursor Forward "Ps" Times [default: 1] (CUF)
-
- "ESC [ Ps D"
- Cursor Backward "Ps" Times [default: 1] (CUB)
-
- "ESC [ Ps E"
- Cursor Down "Ps" Times [default: 1] and to first column
-
- "ESC [ Ps F"
- Cursor Up "Ps" Times [default: 1] and to first column
-
- "ESC [ Ps G"
- Cursor to Column "Ps" (HPA)
-
- "ESC [ Ps;Ps H"
- Cursor Position [row;column] [default: 1;1] (CUP)
-
- "ESC [ Ps I"
- Move forward "Ps" tab stops [default: 1]
-
- "ESC [ Ps J"
- Erase in Display (ED)
-
- Ps = 0 Clear Below (default)
- Ps = 1 Clear Above
- Ps = 2 Clear All
-
- "ESC [ Ps K"
- Erase in Line (EL)
-
- Ps = 0 Clear to Right (default)
- Ps = 1 Clear to Left
- Ps = 2 Clear All
-
- "ESC [ Ps L"
- Insert "Ps" Line(s) [default: 1] (IL)
-
- "ESC [ Ps M"
- Delete "Ps" Line(s) [default: 1] (DL)
-
- "ESC [ Ps P"
- Delete "Ps" Character(s) [default: 1] (DCH)
-
- "ESC [ Ps;Ps;Ps;Ps;Ps T"
- Initiate . *unimplemented* Parameters are
- [func;startx;starty;firstrow;lastrow].
-
- "ESC [ Ps W"
- Tabulator functions
-
- Ps = 0 Tab Set (HTS)
- Ps = 2 Tab Clear (TBC), Clear Current Column (default)
- Ps = 5 Tab Clear (TBC), Clear All
-
- "ESC [ Ps X"
- Erase "Ps" Character(s) [default: 1] (ECH)
-
- "ESC [ Ps Z"
- Move backward "Ps" [default: 1] tab stops
-
- "ESC [ Ps '"
- See "ESC [ Ps G"
-
- "ESC [ Ps a"
- See "ESC [ Ps C"
-
- "ESC [ Ps c"
- Send Device Attributes (DA) "Ps = 0" (or omitted): request
- attributes from terminal returns: "ESC [ ? 1 ; 2 c" (``I am a VT100
- with Advanced Video Option'')
-
- "ESC [ Ps d"
- Cursor to Line "Ps" (VPA)
-
- "ESC [ Ps e"
- See "ESC [ Ps A"
-
- "ESC [ Ps;Ps f"
- Horizontal and Vertical Position [row;column] (HVP) [default: 1;1]
-
- "ESC [ Ps g"
- Tab Clear (TBC)
-
- Ps = 0 Clear Current Column (default)
- Ps = 3 Clear All (TBC)
-
- "ESC [ Pm h"
- Set Mode (SM). See "ESC [ Pm l" sequence for description of "Pm".
-
- "ESC [ Ps i"
- Printing. See also the "print-pipe" resource.
-
- Ps = 0 print screen (MC0)
- Ps = 4 disable transparent print mode (MC4)
- Ps = 5 enable transparent print mode (MC5)
-
- "ESC [ Pm l"
- Reset Mode (RM)
-
- "Ps = 4"
- h Insert Mode (SMIR)
- l Replace Mode (RMIR)
-
- "Ps = 20" (partially implemented)
- h Automatic Newline (LNM)
- l Normal Linefeed (LNM)
-
- "ESC [ Pm m"
- Character Attributes (SGR)
-
- Ps = 0 Normal (default)
- Ps = 1 / 21 On / Off Bold (bright fg)
- Ps = 3 / 23 On / Off Italic
- Ps = 4 / 24 On / Off Underline
- Ps = 5 / 25 On / Off Slow Blink (bright bg)
- Ps = 6 / 26 On / Off Rapid Blink (bright bg)
- Ps = 7 / 27 On / Off Inverse
- Ps = 8 / 27 On / Off Invisible (NYI)
- Ps = 30 / 40 fg/bg Black
- Ps = 31 / 41 fg/bg Red
- Ps = 32 / 42 fg/bg Green
- Ps = 33 / 43 fg/bg Yellow
- Ps = 34 / 44 fg/bg Blue
- Ps = 35 / 45 fg/bg Magenta
- Ps = 36 / 46 fg/bg Cyan
- Ps = 38;5 / 48;5 set fg/bg to color #m (ISO 8613-6)
- Ps = 37 / 47 fg/bg White
- Ps = 39 / 49 fg/bg Default
- Ps = 90 / 100 fg/bg Bright Black
- Ps = 91 / 101 fg/bg Bright Red
- Ps = 92 / 102 fg/bg Bright Green
- Ps = 93 / 103 fg/bg Bright Yellow
- Ps = 94 / 104 fg/bg Bright Blue
- Ps = 95 / 105 fg/bg Bright Magenta
- Ps = 96 / 106 fg/bg Bright Cyan
- Ps = 97 / 107 fg/bg Bright White
- Ps = 99 / 109 fg/bg Bright Default
-
- "ESC [ Ps n"
- Device Status Report (DSR)
-
- Ps = 5 Status Report ESC [ 0 n (``OK'')
- Ps = 6 Report Cursor Position (CPR) [row;column] as ESC [ r ; c R
- Ps = 7 Request Display Name
- Ps = 8 Request Version Number (place in window title)
-
- "ESC [ Ps;Ps r"
- Set Scrolling Region [top;bottom] [default: full size of window]
- (CSR)
-
- "ESC [ s"
- Save Cursor (SC)
-
- "ESC [ Ps;Pt t"
- Window Operations
-
- Ps = 1 Deiconify (map) window
- Ps = 2 Iconify window
- Ps = 3 ESC [ 3 ; X ; Y t Move window to (X|Y)
- Ps = 4 ESC [ 4 ; H ; W t Resize to WxH pixels
- Ps = 5 Raise window
- Ps = 6 Lower window
- Ps = 7 Refresh screen once
- Ps = 8 ESC [ 8 ; R ; C t Resize to R rows and C columns
- Ps = 11 Report window state (responds with Ps = 1 or Ps = 2)
- Ps = 13 Report window position (responds with Ps = 3)
- Ps = 14 Report window pixel size (responds with Ps = 4)
- Ps = 18 Report window text size (responds with Ps = 7)
- Ps = 19 Currently the same as Ps = 18, but responds with Ps = 9
- Ps = 20 Reports icon label (ESC ] L NAME \234)
- Ps = 21 Reports window title (ESC ] l NAME \234)
- Ps = 24.. Set window height to Ps rows
-
- "ESC [ u"
- Restore Cursor
-
- "ESC [ Ps x"
- Request Terminal Parameters (DECREQTPARM)
-
-
-
- DEC Private Modes
- "ESC [ ? Pm h"
- DEC Private Mode Set (DECSET)
-
- "ESC [ ? Pm l"
- DEC Private Mode Reset (DECRST)
-
- "ESC [ ? Pm r"
- Restore previously saved DEC Private Mode Values.
-
- "ESC [ ? Pm s"
- Save DEC Private Mode Values.
-
- "ESC [ ? Pm t"
- Toggle DEC Private Mode Values (rxvt extension). *where*
-
- "Pm = 1" (DECCKM)
- h Application Cursor Keys
- l Normal Cursor Keys
-
- "Pm = 2" (ANSI/VT52 mode)
- h Enter VT52 mode
- l Enter VT52 mode
-
- "Pm = 3"
- h 132 Column Mode (DECCOLM)
- l 80 Column Mode (DECCOLM)
-
- "Pm = 4"
- h Smooth (Slow) Scroll (DECSCLM)
- l Jump (Fast) Scroll (DECSCLM)
-
- "Pm = 5"
- h Reverse Video (DECSCNM)
- l Normal Video (DECSCNM)
-
- "Pm = 6"
- h Origin Mode (DECOM)
- l Normal Cursor Mode (DECOM)
-
- "Pm = 7"
- h Wraparound Mode (DECAWM)
- l No Wraparound Mode (DECAWM)
-
- "Pm = 8" *unimplemented*
- h Auto-repeat Keys (DECARM)
- l No Auto-repeat Keys (DECARM)
-
- "Pm = 9" X10 XTerm
- h Send Mouse X & Y on button press.
- l No mouse reporting.
-
- "Pm = 25"
- h Visible cursor {cnorm/cvvis}
- l Invisible cursor {civis}
-
- "Pm = 30"
- h scrollBar visisble
- l scrollBar invisisble
-
- "Pm = 35" (rxvt)
- h Allow XTerm Shift+key sequences
- l Disallow XTerm Shift+key sequences
-
- "Pm = 38" *unimplemented*
- Enter Tektronix Mode (DECTEK)
-
- "Pm = 40"
- h Allow 80/132 Mode
- l Disallow 80/132 Mode
-
- "Pm = 44" *unimplemented*
- h Turn On Margin Bell
- l Turn Off Margin Bell
-
- "Pm = 45" *unimplemented*
- h Reverse-wraparound Mode
- l No Reverse-wraparound Mode
-
- "Pm = 46" *unimplemented*
- "Pm = 47"
- h Use Alternate Screen Buffer
- l Use Normal Screen Buffer
-
-
-
- "Pm = 66"
- h Application Keypad (DECPAM) == ESC =
- l Normal Keypad (DECPNM) == ESC >
-
- "Pm = 67"
- h Backspace key sends BS (DECBKM)
- l Backspace key sends DEL
-
- "Pm = 1000" (X11 XTerm)
- h Send Mouse X & Y on button press and release.
- l No mouse reporting.
-
- "Pm = 1001" (X11 XTerm) *unimplemented*
- h Use Hilite Mouse Tracking.
- l No mouse reporting.
-
- "Pm = 1002" (X11 XTerm)
- h Send Mouse X & Y on button press and release, and motion with a button pressed.
- l No mouse reporting.
-
- "Pm = 1003" (X11 XTerm)
- h Send Mouse X & Y on button press and release, and motion.
- l No mouse reporting.
-
- "Pm = 1010" (rxvt)
- h Don't scroll to bottom on TTY output
- l Scroll to bottom on TTY output
-
- "Pm = 1011" (rxvt)
- h Scroll to bottom when a key is pressed
- l Don't scroll to bottom when a key is pressed
-
- "Pm = 1021" (rxvt)
- h Bold/italic implies high intensity (see option -is)
- l Font styles have no effect on intensity (Compile styles)
-
- "Pm = 1047"
- h Use Alternate Screen Buffer
- l Use Normal Screen Buffer - clear Alternate Screen Buffer if returning from it
-
- "Pm = 1048"
- h Save cursor position
- l Restore cursor position
-
- "Pm = 1049"
- h Use Alternate Screen Buffer - clear Alternate Screen Buffer if switching to it
- l Use Normal Screen Buffer
-
-
-
- XTerm Operating System Commands
- "ESC ] Ps;Pt ST"
- Set XTerm Parameters. 8-bit ST: 0x9c, 7-bit ST sequence: ESC \
- (0x1b, 0x5c), backwards compatible terminator BEL (0x07) is also
- accepted. any octet can be escaped by prefixing it with SYN (0x16,
- ^V).
-
- Ps = 0 Change Icon Name and Window Title to Pt
- Ps = 1 Change Icon Name to Pt
- Ps = 2 Change Window Title to Pt
- Ps = 3 If Pt starts with a ?, query the (STRING) property of the window and return it. If Pt contains a =, set the named property to the given value, else delete the specified property.
- Ps = 4 Pt is a semi-colon separated sequence of one or more semi-colon separated number/name pairs, where number is an index to a colour and name is the name of a colour. Each pair causes the numbered colour to be changed to name. Numbers 0-7 corresponds to low-intensity (normal) colours and 8-15 corresponds to high-intensity colours. 0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white
- Ps = 10 Change colour of text foreground to Pt (NB: may change in future)
- Ps = 11 Change colour of text background to Pt (NB: may change in future)
- Ps = 12 Change colour of text cursor foreground to Pt
- Ps = 13 Change colour of mouse foreground to Pt
- Ps = 17 Change colour of highlight characters to Pt
- Ps = 18 Change colour of bold characters to Pt [deprecated, see 706]
- Ps = 19 Change colour of underlined characters to Pt [deprecated, see 707]
- Ps = 20 Change background pixmap parameters (see section BACKGROUND IMAGE) (Compile AfterImage).
- Ps = 39 Change default foreground colour to Pt.
- Ps = 46 Change Log File to Pt unimplemented
- Ps = 49 Change default background colour to Pt.
- Ps = 50 Set fontset to Pt, with the following special values of Pt (rxvt) #+n change up n #-n change down n if n is missing of 0, a value of 1 is used empty change to font0 n change to font n
- Ps = 55 Log all scrollback buffer and all of screen to Pt
- Ps = 701 Change current locale to Pt, or, if Pt is ?, return the current locale (Compile frills).
- Ps = 702 Request version if Pt is ?, returning rxvt-unicode, the resource name, the major and minor version numbers, e.g. ESC ] 702 ; rxvt-unicode ; urxvt ; 7 ; 4 ST.
- Ps = 704 Change colour of italic characters to Pt
- Ps = 705 Change background pixmap tint colour to Pt (Compile transparency).
- Ps = 706 Change colour of bold characters to Pt
- Ps = 707 Change colour of underlined characters to Pt
- Ps = 710 Set normal fontset to Pt. Same as Ps = 50.
- Ps = 711 Set bold fontset to Pt. Similar to Ps = 50 (Compile styles).
- Ps = 712 Set italic fontset to Pt. Similar to Ps = 50 (Compile styles).
- Ps = 713 Set bold-italic fontset to Pt. Similar to Ps = 50 (Compile styles).
- Ps = 720 Move viewing window up by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
- Ps = 721 Move viewing window down by Pt lines, or clear scrollback buffer if Pt = 0 (Compile frills).
- Ps = 777 Call the perl extension with the given string, which should be of the form extension:parameters (Compile perl).
-
-BACKGROUND IMAGE
- For the BACGROUND IMAGE XTerm escape sequence "ESC ] 20 ; Pt ST" then
- value of "Pt" can be the name of the background image file followed by a
- sequence of scaling/positioning commands separated by semi-colons. The
- scaling/positioning commands are as follows:
-
- query scale/position
- ?
-
- change scale and position
- WxH+X+Y
-
- WxH+X (== WxH+X+X)
-
- WxH (same as WxH+50+50)
-
- W+X+Y (same as WxW+X+Y)
-
- W+X (same as WxW+X+X)
-
- W (same as WxW+50+50)
-
- change position (absolute)
- =+X+Y
-
- =+X (same as =+X+Y)
-
- change position (relative)
- +X+Y
-
- +X (same as +X+Y)
-
- rescale (relative)
- Wx0 -> W *= (W/100)
-
- 0xH -> H *= (H/100)
-
- For example:
-
- \E]20;funky.jpg\a
- load funky.jpg as a tiled image
-
- \E]20;mona.jpg;100\a
- load mona.jpg with a scaling of 100%
-
- \E]20;;200;?\a
- rescale the current pixmap to 200% and display the image geometry in
- the title
-
-Mouse Reporting
- "ESC [ M <b> <x> <y>"
- report mouse position
-
- The lower 2 bits of "<b>" indicate the button:
-
- Button = "(<b> - SPACE) & 3"
- 0 Button1 pressed
- 1 Button2 pressed
- 2 Button3 pressed
- 3 button released (X11 mouse report)
-
- The upper bits of "<b>" indicate the modifiers when the button was
- pressed and are added together (X11 mouse report only):
-
- State = "(<b> - SPACE) & 60"
- 4 Shift
- 8 Meta
- 16 Control
- 32 Double Click (rxvt extension)
-
- Col = "<x> - SPACE"
-
- Row = "<y> - SPACE"
-
-Key Codes
- Note: Shift + F1-F10 generates F11-F20
-
- For the keypad, use Shift to temporarily override Application-Keypad
- setting use Num_Lock to toggle Application-Keypad setting if Num_Lock is
- off, toggle Application-Keypad setting. Also note that values of Home,
- End, Delete may have been compiled differently on your system.
-
- Normal Shift Control Ctrl+Shift
- Tab ^I ESC [ Z ^I ESC [ Z
- BackSpace ^H ^? ^? ^?
- Find ESC [ 1 ~ ESC [ 1 $ ESC [ 1 ^ ESC [ 1 @
- Insert ESC [ 2 ~ paste ESC [ 2 ^ ESC [ 2 @
- Execute ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @
- Select ESC [ 4 ~ ESC [ 4 $ ESC [ 4 ^ ESC [ 4 @
- Prior ESC [ 5 ~ scroll-up ESC [ 5 ^ ESC [ 5 @
- Next ESC [ 6 ~ scroll-down ESC [ 6 ^ ESC [ 6 @
- Home ESC [ 7 ~ ESC [ 7 $ ESC [ 7 ^ ESC [ 7 @
- End ESC [ 8 ~ ESC [ 8 $ ESC [ 8 ^ ESC [ 8 @
- Delete ESC [ 3 ~ ESC [ 3 $ ESC [ 3 ^ ESC [ 3 @
- F1 ESC [ 11 ~ ESC [ 23 ~ ESC [ 11 ^ ESC [ 23 ^
- F2 ESC [ 12 ~ ESC [ 24 ~ ESC [ 12 ^ ESC [ 24 ^
- F3 ESC [ 13 ~ ESC [ 25 ~ ESC [ 13 ^ ESC [ 25 ^
- F4 ESC [ 14 ~ ESC [ 26 ~ ESC [ 14 ^ ESC [ 26 ^
- F5 ESC [ 15 ~ ESC [ 28 ~ ESC [ 15 ^ ESC [ 28 ^
- F6 ESC [ 17 ~ ESC [ 29 ~ ESC [ 17 ^ ESC [ 29 ^
- F7 ESC [ 18 ~ ESC [ 31 ~ ESC [ 18 ^ ESC [ 31 ^
- F8 ESC [ 19 ~ ESC [ 32 ~ ESC [ 19 ^ ESC [ 32 ^
- F9 ESC [ 20 ~ ESC [ 33 ~ ESC [ 20 ^ ESC [ 33 ^
- F10 ESC [ 21 ~ ESC [ 34 ~ ESC [ 21 ^ ESC [ 34 ^
- F11 ESC [ 23 ~ ESC [ 23 $ ESC [ 23 ^ ESC [ 23 @
- F12 ESC [ 24 ~ ESC [ 24 $ ESC [ 24 ^ ESC [ 24 @
- F13 ESC [ 25 ~ ESC [ 25 $ ESC [ 25 ^ ESC [ 25 @
- F14 ESC [ 26 ~ ESC [ 26 $ ESC [ 26 ^ ESC [ 26 @
- F15 (Help) ESC [ 28 ~ ESC [ 28 $ ESC [ 28 ^ ESC [ 28 @
- F16 (Menu) ESC [ 29 ~ ESC [ 29 $ ESC [ 29 ^ ESC [ 29 @
- F17 ESC [ 31 ~ ESC [ 31 $ ESC [ 31 ^ ESC [ 31 @
- F18 ESC [ 32 ~ ESC [ 32 $ ESC [ 32 ^ ESC [ 32 @
- F19 ESC [ 33 ~ ESC [ 33 $ ESC [ 33 ^ ESC [ 33 @
- F20 ESC [ 34 ~ ESC [ 34 $ ESC [ 34 ^ ESC [ 34 @
- Application
- Up ESC [ A ESC [ a ESC O a ESC O A
- Down ESC [ B ESC [ b ESC O b ESC O B
- Right ESC [ C ESC [ c ESC O c ESC O C
- Left ESC [ D ESC [ d ESC O d ESC O D
- KP_Enter ^M ESC O M
- KP_F1 ESC O P ESC O P
- KP_F2 ESC O Q ESC O Q
- KP_F3 ESC O R ESC O R
- KP_F4 ESC O S ESC O S
- XK_KP_Multiply * ESC O j
- XK_KP_Add + ESC O k
- XK_KP_Separator , ESC O l
- XK_KP_Subtract - ESC O m
- XK_KP_Decimal . ESC O n
- XK_KP_Divide / ESC O o
- XK_KP_0 0 ESC O p
- XK_KP_1 1 ESC O q
- XK_KP_2 2 ESC O r
- XK_KP_3 3 ESC O s
- XK_KP_4 4 ESC O t
- XK_KP_5 5 ESC O u
- XK_KP_6 6 ESC O v
- XK_KP_7 7 ESC O w
- XK_KP_8 8 ESC O x
- XK_KP_9 9 ESC O y
-
-CONFIGURE OPTIONS
- General hint: if you get compile errors, then likely your configuration
- hasn't been tested well. Either try with "--enable-everything" or use
- the default configuration (i.e. no "--enable-xxx" or "--disable-xxx"
- switches). Of course, you should always report when a combination
- doesn't work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
-
- All
-
- --enable-everything
- Add (or remove) support for all non-multichoice options listed in
- "./configure --help".
-
- You can specify this and then disable options you do not like by
- *following* this with the appropriate "--disable-..." arguments, or
- you can start with a minimal configuration by specifying
- "--disable-everything" and than adding just the "--enable-..."
- arguments you want.
-
- --enable-xft (default: enabled)
- Add support for Xft (anti-aliases, among others) fonts. Xft fonts
- are slower and require lots of memory, but as long as you don't use
- them, you don't pay for them.
-
- --enable-font-styles (default: on)
- Add support for bold, *italic* and *bold italic* font styles. The
- fonts can be set manually or automatically.
-
- --with-codesets=NAME,... (default: all)
- Compile in support for additional codeset (encoding) groups ("eu",
- "vn" are always compiled in, which includes most 8-bit character
- sets). These codeset tables are used for driving X11 core fonts,
- they are not required for Xft fonts, although having them compiled
- in lets rxvt-unicode choose replacement fonts more intelligently.
- Compiling them in will make your binary bigger (all of together cost
- about 700kB), but it doesn't increase memory usage unless you use a
- font requiring one of these encodings.
-
- all all available codeset groups
- zh common chinese encodings
- zh_ext rarely used but very big chinese encodings
- jp common japanese encodings
- jp_ext rarely used but big japanese encodings
- kr korean encodings
-
- --enable-xim (default: on)
- Add support for XIM (X Input Method) protocol. This allows using
- alternative input methods (e.g. kinput2) and will also correctly set
- up the input for people using dead keys or compose keys.
-
- --enable-unicode3 (default: off)
- Recommended to stay off unless you really need non-BMP characters.
-
- Enable direct support for displaying unicode codepoints above 65535
- (the basic multilingual page). This increases storage requirements
- per character from 2 to 4 bytes. X11 fonts do not yet support these
- extra characters, but Xft does.
-
- Please note that rxvt-unicode can store unicode code points >65535
- even without this flag, but the number of such characters is limited
- to a few thousand (shared with combining characters, see next
- switch), and right now rxvt-unicode cannot display them
- (input/output and cut&paste still work, though).
-
- --enable-combining (default: on)
- Enable automatic composition of combining characters into composite
- characters. This is required for proper viewing of text where
- accents are encoded as seperate unicode characters. This is done by
- using precomposited characters when available or creating new
- pseudo-characters when no precomposed form exists.
-
- Without --enable-unicode3, the number of additional precomposed
- characters is somewhat limited (the 6400 private use characters will
- be (ab-)used). With --enable-unicode3, no practical limit exists.
-
- This option will also enable storage (but not display) of characters
- beyond plane 0 (>65535) when --enable-unicode3 was not specified.
-
- The combining table also contains entries for arabic presentation
- forms, but these are not currently used. Bug me if you want these to
- be used (and tell me how these are to be used...).
-
- --enable-fallback(=CLASS) (default: Rxvt)
- When reading resource settings, also read settings for class CLASS.
- To disable resource fallback use --disable-fallback.
-
- --with-res-name=NAME (default: urxvt)
- Use the given name as default application name when reading
- resources. Specify --with-res-name=rxvt to replace rxvt.
-
- --with-res-class=CLASS /default: URxvt)
- Use the given class as default application class when reading
- resources. Specify --with-res-class=Rxvt to replace rxvt.
-
- --enable-utmp (default: on)
- Write user and tty to utmp file (used by programs like w) at start
- of rxvt execution and delete information when rxvt exits.
-
- --enable-wtmp (default: on)
- Write user and tty to wtmp file (used by programs like last) at
- start of rxvt execution and write logout when rxvt exits. This
- option requires --enable-utmp to also be specified.
-
- --enable-lastlog (default: on)
- Write user and tty to lastlog file (used by programs like lastlogin)
- at start of rxvt execution. This option requires --enable-utmp to
- also be specified.
-
- --enable-afterimage (default: on)
- Add support for libAfterImage to be used for transparency and
- background images. It adds support for many file formats including
- JPG, PNG, SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep
- image XML
- (<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
-
- This option also adds such eye candy as blending an image over the
- root background, as well as dynamic scaling and bluring of
- background images.
-
- Note that with this option enabled, rxvt's memory footprint might
- increase by a few megabytes even if no extra features are used
- (mostly due to third-party libraries used by libAI). Memory
- footprint may somewhat be lowered if libAfterImage is configured
- without support for SVG.
-
- --enable-transparency (default: on)
- Add support for backgrounds, creating illusion of transparency in
- the term.
-
- --enable-fading (default: on)
- Add support for fading the text when focus is lost.
-
- --enable-rxvt-scroll (default: on)
- Add support for the original rxvt scrollbar.
-
- --enable-next-scroll (default: on)
- Add support for a NeXT-like scrollbar.
-
- --enable-xterm-scroll (default: on)
- Add support for an Xterm-like scrollbar.
-
- --enable-plain-scroll (default: on)
- Add support for a very unobtrusive, plain-looking scrollbar that is
- the favourite of the rxvt-unicode author, having used it for many
- years.
-
- --enable-ttygid (default: off)
- Change tty device setting to group "tty" - only use this if your
- system uses this type of security.
-
- --disable-backspace-key
- Removes any handling of the backspace key by us - let the X server
- do it.
-
- --disable-delete-key
- Removes any handling of the delete key by us - let the X server do
- it.
-
- --disable-resources
- Removes any support for resource checking.
-
- --disable-swapscreen
- Remove support for secondary/swap screen.
-
- --enable-frills (default: on)
- Add support for many small features that are not essential but nice
- to have. Normally you want this, but for very small binaries you may
- want to disable this.
-
- A non-exhaustive list of features enabled by "--enable-frills"
- (possibly in combination with other switches) is:
-
- MWM-hints
- EWMH-hints (pid, utf8 names) and protocols (ping)
- urgency hint
- seperate underline colour (-underlineColor)
- settable border widths and borderless switch (-w, -b, -bl)
- visual depth selection (-depth)
- settable extra linespacing /-lsp)
- iso-14755 5.1 (basic) support
- tripleclickwords (-tcw)
- settable insecure mode (-insecure)
- keysym remapping support
- cursor blinking and underline cursor (-cb, -uc)
- XEmbed support (-embed)
- user-pty (-pty-fd)
- hold on exit (-hold)
- compile in built-in block graphics
- skip builtin block graphics (-sbg)
- separate highlightcolor support (-hc)
-
- It also enables some non-essential features otherwise disabled, such
- as:
-
- some round-trip time optimisations
- nearest color allocation on pseudocolor screens
- UTF8_STRING support for selection
- sgr modes 90..97 and 100..107
- backindex and forwardindex escape sequences
- view change/zero scrollback escape sequences
- locale switching escape sequence
- window op and some xterm/OSC escape sequences
- rectangular selections
- trailing space removal for selections
- verbose X error handling
-
- --enable-iso14755 (default: on)
- Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt).
- Basic support (section 5.1) is enabled by "--enable-frills", while
- support for 5.2, 5.3 and 5.4 is enabled with this switch.
-
- --enable-keepscrolling (default: on)
- Add support for continual scrolling of the display when you hold the
- mouse button down on a scrollbar arrow.
-
- --enable-selectionscrolling (default: on)
- Add support for scrolling when the selection moves to the top or
- bottom of the screen.
-
- --enable-mousewheel (default: on)
- Add support for scrolling via mouse wheel or buttons 4 & 5.
-
- --enable-slipwheeling (default: on)
- Add support for continual scrolling (using the mouse wheel as an
- accelerator) while the control key is held down. This option
- requires --enable-mousewheel to also be specified.
-
- --enable-smart-resize (default: off)
- Add smart growth/shrink behaviour when resizing. This should keep
- the window corner which is closest to a corner of the screen in a
- fixed position.
-
- --enable-pointer-blank (default: on)
- Add support to have the pointer disappear when typing or inactive.
-
- --enable-perl (default: on)
- Enable an embedded perl interpreter. See the rxvtperl(3) manpage
- (doc/rxvtperl.txt) for more info on this feature, or the files in
- src/perl-ext/ for the extensions that are installed by default. The
- perl interpreter that is used can be specified via the "PERL"
- environment variable when running configure. Even when compiled in,
- perl will *not* be initialised when all extensions have been
- disabled "-pe "" --perl-ext-common """, so it should be safe to
- enable from a resource standpoint.
-
- --with-afterimage-config=DIR
- Look for the libAfterImage config script in DIR.
-
- --with-name=NAME (default: urxvt)
- Set the basename for the installed binaries, resulting in "urxvt",
- "urxvtd" etc.). Specify "--with-name=rxvt" to replace with "rxvt".
-
- --with-term=NAME (default: rxvt-unicode)
- Change the environmental variable for the terminal to NAME.
-
- --with-terminfo=PATH
- Change the environmental variable for the path to the terminfo tree
- to PATH.
-
- --with-x
- Use the X Window System (pretty much default, eh?).
-
-AUTHORS
- Marc Lehmann <rxvt@schmorp.de> converted this document to pod and
- reworked it from the original Rxvt documentation, which was done by
- Geoff Wing <gcw@pobox.com>, who in turn used the XTerm documentation and
- other sources.
-
+++ /dev/null
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
-<head>
- <title>urxvtc</title>
- <meta name="description" content="Pod documentation for urxvtc" />
- <meta name="inputfile" content="<standard input>" />
- <meta name="outputfile" content="<standard output>" />
- <meta name="created" content="Sat Oct 27 14:07:34 2007" />
- <meta name="generator" content="Pod::Xhtml 1.57" />
-<link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head>
-<body>
-<div class="pod">
-<!-- INDEX START -->
-<h3 id="TOP">Index</h3>
-
-<ul><li><a href="#NAME">NAME</a></li>
-<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
-<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
-<li><a href="#OPTIONS">OPTIONS</a></li>
-<li><a href="#EXIT_STATUS">EXIT STATUS</a></li>
-<li><a href="#ENVIRONMENT">ENVIRONMENT</a></li>
-<li><a href="#SEE_ALSO">SEE ALSO</a>
-</li>
-</ul><hr />
-<!-- INDEX END -->
-
-<h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="NAME_CONTENT">
-<p>urxvtc - control the urxvtd daemon</p>
-
-</div>
-<h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="SYNOPSIS_CONTENT">
-<p><strong>urxvtc</strong> [same options as for urxvt]</p>
-
-</div>
-<h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="DESCRIPTION_CONTENT">
-<p>This manpage describes the <strong>urxvtc</strong> client program. It connects
-to the <strong>urxvtd</strong> daemon and requests a new terminal window. It
-takes the same arguments as the <strong>urxvt</strong> program. The environment
-will also be respected. Currently, it always returns immediately after
-contacting the daemon.</p>
-
-</div>
-<h1 id="OPTIONS">OPTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="OPTIONS_CONTENT">
-<p>All options that are valid for <strong>urxvt</strong> are valid for
-<strong>urxvtc</strong>, too. Please note that options are interpreted in the
-context of the daemon process. However, as current working directory,
-process environment and any file descriptor (e.g. for <code>-pty-fd</code>) are
-preserved, this rarely makes a difference.</p>
-
-</div>
-<h1 id="EXIT_STATUS">EXIT STATUS</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="EXIT_STATUS_CONTENT">
-<p>If everything went well, urxvtc returns with an exit status of <code>0</code>.
-If contacting the daemon fails, it exits with the exit status <code>2</code>. In all other error
-cases it returns with status <code>1</code>.</p>
-<p>This can be used to implement auto-starting behaviour, by checking for an
-exit status of <code>2</code>, running <code>urxvtd -f -q</code> and retrying the call
-to urxvtc, like this:</p>
-<pre> #!/bin/sh
- urxvtc "$@"
- if [ $? -eq 2 ]; then
- urxvtd -q -o -f
- urxvtc "$@"
- fi
-
-</pre>
-
-</div>
-<h1 id="ENVIRONMENT">ENVIRONMENT</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="ENVIRONMENT_CONTENT">
-<p>All environment variables of the current process will be made available
-to the new instance, and will be interpreted as if <strong>urxvt</strong> were
-started directly.</p>
-<dl>
- <dt><strong>RXVT_SOCKET</strong></dt>
- <dd>
- <p>Both urxvtc and urxvtd use the environment variable
-<cite>RXVT_SOCKET</cite> to create a listening socket and to contact the
-urxvtd, respectively. If the variable is missing,
-<cite>$HOME/.rxvt-unicode-<i><nodename></i></cite> is used. The variable must
-specify the absolute path of the socket to create.</p>
- </dd>
-</dl>
-
-</div>
-<h1 id="SEE_ALSO">SEE ALSO</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="SEE_ALSO_CONTENT">
-<p>urxvt(7), urxvtd(1)</p>
-
-</div>
-</div></body>
-</html>
+++ /dev/null
-NAME
- urxvtc - control the urxvtd daemon
-
-SYNOPSIS
- urxvtc [same options as for urxvt]
-
-DESCRIPTION
- This manpage describes the urxvtc client program. It connects to the
- urxvtd daemon and requests a new terminal window. It takes the same
- arguments as the urxvt program. The environment will also be respected.
- Currently, it always returns immediately after contacting the daemon.
-
-OPTIONS
- All options that are valid for urxvt are valid for urxvtc, too. Please
- note that options are interpreted in the context of the daemon process.
- However, as current working directory, process environment and any file
- descriptor (e.g. for "-pty-fd") are preserved, this rarely makes a
- difference.
-
-EXIT STATUS
- If everything went well, urxvtc returns with an exit status of 0. If
- contacting the daemon fails, it exits with the exit status 2. In all
- other error cases it returns with status 1.
-
- This can be used to implement auto-starting behaviour, by checking for
- an exit status of 2, running "urxvtd -f -q" and retrying the call to
- urxvtc, like this:
-
- #!/bin/sh
- urxvtc "$@"
- if [ $? -eq 2 ]; then
- urxvtd -q -o -f
- urxvtc "$@"
- fi
-
-ENVIRONMENT
- All environment variables of the current process will be made available
- to the new instance, and will be interpreted as if urxvt were started
- directly.
-
- RXVT_SOCKET
- Both urxvtc and urxvtd use the environment variable RXVT_SOCKET to
- create a listening socket and to contact the urxvtd, respectively.
- If the variable is missing, $HOME/.rxvt-unicode-*<nodename>* is
- used. The variable must specify the absolute path of the socket to
- create.
-
-SEE ALSO
- urxvt(7), urxvtd(1)
-
+++ /dev/null
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
-<head>
- <title>urxvtd</title>
- <meta name="description" content="Pod documentation for urxvtd" />
- <meta name="inputfile" content="<standard input>" />
- <meta name="outputfile" content="<standard output>" />
- <meta name="created" content="Sat Oct 27 14:07:34 2007" />
- <meta name="generator" content="Pod::Xhtml 1.57" />
-<link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head>
-<body>
-<div class="pod">
-<!-- INDEX START -->
-<h3 id="TOP">Index</h3>
-
-<ul><li><a href="#NAME">NAME</a></li>
-<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
-<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
-<li><a href="#OPTIONS">OPTIONS</a></li>
-<li><a href="#EXAMPLES">EXAMPLES</a></li>
-<li><a href="#ENVIRONMENT">ENVIRONMENT</a></li>
-<li><a href="#SEE_ALSO">SEE ALSO</a>
-</li>
-</ul><hr />
-<!-- INDEX END -->
-
-<h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="NAME_CONTENT">
-<p>urxvtd - urxvt terminal daemon</p>
-
-</div>
-<h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="SYNOPSIS_CONTENT">
-<p><strong>urxvtd</strong> [-q|--quiet] [-o|--opendisplay] [-f|--fork]</p>
-<p><strong>urxvtd</strong> -q -o -f # for .xsession use</p>
-
-</div>
-<h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="DESCRIPTION_CONTENT">
-<p>This manpage describes the urxvtd daemon, which is the same vt102
-terminal emulator as urxvt, but runs as a daemon that can open
-multiple terminal windows within the same process.</p>
-<p>You can run it from your X startup scripts, for example, although it is
-not dependent on a working DISPLAY and, in fact, can open windows on
-multiple X displays on the same time.</p>
-<p>Advantages of running a urxvt daemon include faster creation time
-for terminal windows and a lot of saved memory.</p>
-<p>The disadvantage is a possible impact on stability - if the
-main program crashes, all processes in the terminal windows are
-terminated. For example, as there is no way to cleanly react to abnormal
-connection closes, <code>xkill</code> and server resets/restarts will kill the
-<strong>urxvtd</strong> instance including all windows it has opened.</p>
-
-</div>
-<h1 id="OPTIONS">OPTIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="OPTIONS_CONTENT">
-<p><strong>urxvtd</strong> currently understands a few options only. Bundling of
-options is not yet supported.</p>
-<dl>
- <dt><strong>-q</strong>, <strong>--quiet</strong></dt>
- <dd>
- <p>Normally, <strong>urxvtd</strong> outputs the message <code>rxvt-unicode daemon
-listening on <path></code> after binding to its control socket. This option
-will suppress this message (errors and warnings will still be logged).</p>
- </dd>
- <dt><strong>-o</strong>, <strong>--opendisplay</strong></dt>
- <dd>
- <p>This forces <strong>urxvtd</strong> to open a connection to the current
-<code>$DISPLAY</code> and keep it open.</p>
- <p>This is useful if you want to bind an instance of <strong>urxvtd</strong> to
-the lifetime of a specific display/server. If the server does a reset,
-<strong>urxvtd</strong> will be killed automatically.</p>
- </dd>
- <dt><strong>-f</strong>, <strong>--fork</strong></dt>
- <dd>
- <p>This makes <strong>urxvtd</strong> fork after it has bound itself to its control
-socket.</p>
- </dd>
-</dl>
-
-</div>
-<h1 id="EXAMPLES">EXAMPLES</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="EXAMPLES_CONTENT">
-<p>This is a useful invocation of <strong>urxvtd</strong> in a <cite>.xsession</cite>-style
-script:</p>
-<pre> urxvtd -q -f -o
-
-</pre>
-<p>This waits till the control socket is available, opens the current display
-and forks into the background. When you log-out, the server is reset and
-<strong>urxvtd</strong> is killed.</p>
-
-</div>
-<h1 id="ENVIRONMENT">ENVIRONMENT</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="ENVIRONMENT_CONTENT">
-<dl>
- <dt><strong>RXVT_SOCKET</strong></dt>
- <dd>
- <p>Both <strong>urxvtc</strong> and <strong>urxvtd</strong> use the environment
-variable <cite>RXVT_SOCKET</cite> to create a listening socket and to contact
-the urxvtd, respectively. If the variable is missing,
-<cite>$HOME/.rxvt-unicode-<i><nodename></i></cite> is used. The variable must
-specify the absolute path of the socket to create.</p>
- </dd>
- <dt><strong>DISPLAY</strong></dt>
- <dd>
- <p>Only used when the <code>--opendisplay</code> option is specified. Must contain a
-valid X display name.</p>
- </dd>
-</dl>
-
-</div>
-<h1 id="SEE_ALSO">SEE ALSO</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="SEE_ALSO_CONTENT">
-<p>urxvt(7), urxvtc(1)
-</p>
-
-</div>
-</div></body>
-</html>
+++ /dev/null
-NAME
- urxvtd - urxvt terminal daemon
-
-SYNOPSIS
- urxvtd [-q|--quiet] [-o|--opendisplay] [-f|--fork]
-
- urxvtd -q -o -f # for .xsession use
-
-DESCRIPTION
- This manpage describes the urxvtd daemon, which is the same vt102
- terminal emulator as urxvt, but runs as a daemon that can open multiple
- terminal windows within the same process.
-
- You can run it from your X startup scripts, for example, although it is
- not dependent on a working DISPLAY and, in fact, can open windows on
- multiple X displays on the same time.
-
- Advantages of running a urxvt daemon include faster creation time for
- terminal windows and a lot of saved memory.
-
- The disadvantage is a possible impact on stability - if the main program
- crashes, all processes in the terminal windows are terminated. For
- example, as there is no way to cleanly react to abnormal connection
- closes, "xkill" and server resets/restarts will kill the urxvtd instance
- including all windows it has opened.
-
-OPTIONS
- urxvtd currently understands a few options only. Bundling of options is
- not yet supported.
-
- -q, --quiet
- Normally, urxvtd outputs the message "rxvt-unicode daemon listening
- on <path>" after binding to its control socket. This option will
- suppress this message (errors and warnings will still be logged).
-
- -o, --opendisplay
- This forces urxvtd to open a connection to the current $DISPLAY and
- keep it open.
-
- This is useful if you want to bind an instance of urxvtd to the
- lifetime of a specific display/server. If the server does a reset,
- urxvtd will be killed automatically.
-
- -f, --fork
- This makes urxvtd fork after it has bound itself to its control
- socket.
-
-EXAMPLES
- This is a useful invocation of urxvtd in a .xsession-style script:
-
- urxvtd -q -f -o
-
- This waits till the control socket is available, opens the current
- display and forks into the background. When you log-out, the server is
- reset and urxvtd is killed.
-
-ENVIRONMENT
- RXVT_SOCKET
- Both urxvtc and urxvtd use the environment variable RXVT_SOCKET to
- create a listening socket and to contact the urxvtd, respectively.
- If the variable is missing, $HOME/.rxvt-unicode-*<nodename>* is
- used. The variable must specify the absolute path of the socket to
- create.
-
- DISPLAY
- Only used when the "--opendisplay" option is specified. Must contain
- a valid X display name.
-
-SEE ALSO
- urxvt(7), urxvtc(1)
-
+++ /dev/null
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
-<head>
- <title>rxvtperl</title>
- <meta name="description" content="Pod documentation for rxvtperl" />
- <meta name="inputfile" content="<standard input>" />
- <meta name="outputfile" content="<standard output>" />
- <meta name="created" content="Mon Nov 19 14:38:45 2007" />
- <meta name="generator" content="Pod::Xhtml 1.57" />
-<link rel="stylesheet" href="http://res.tst.eu/pod.css"/></head>
-<body>
-<div class="pod">
-<!-- INDEX START -->
-<h3 id="TOP">Index</h3>
-
-<ul><li><a href="#NAME">NAME</a></li>
-<li><a href="#SYNOPSIS">SYNOPSIS</a></li>
-<li><a href="#DESCRIPTION">DESCRIPTION</a></li>
-<li><a href="#PREPACKAGED_EXTENSIONS">PREPACKAGED EXTENSIONS</a></li>
-<li><a href="#API_DOCUMENTATION">API DOCUMENTATION</a>
-<ul><li><a href="#General_API_Considerations">General API Considerations</a></li>
-<li><a href="#Extension_Objects">Extension Objects</a></li>
-<li><a href="#Hooks">Hooks</a></li>
-<li><a href="#Variables_in_the_code_urxvt_code_Pac">Variables in the <code>urxvt</code> Package</a></li>
-<li><a href="#Functions_in_the_code_urxvt_code_Pac">Functions in the <code>urxvt</code> Package</a></li>
-<li><a href="#RENDITION">RENDITION</a></li>
-<li><a href="#The_code_urxvt_anyevent_code_Class">The <code>urxvt::anyevent</code> Class</a></li>
-<li><a href="#The_code_urxvt_term_code_Class">The <code>urxvt::term</code> Class</a></li>
-<li><a href="#The_code_urxvt_popup_code_Class">The <code>urxvt::popup</code> Class</a></li>
-<li><a href="#The_code_urxvt_timer_code_Class">The <code>urxvt::timer</code> Class</a></li>
-<li><a href="#The_code_urxvt_iow_code_Class">The <code>urxvt::iow</code> Class</a></li>
-<li><a href="#The_code_urxvt_iw_code_Class">The <code>urxvt::iw</code> Class</a></li>
-<li><a href="#The_code_urxvt_pw_code_Class">The <code>urxvt::pw</code> Class</a></li>
-</ul>
-</li>
-<li><a href="#ENVIRONMENT">ENVIRONMENT</a>
-<ul><li><a href="#URXVT_PERL_VERBOSITY">URXVT_PERL_VERBOSITY</a></li>
-</ul>
-</li>
-<li><a href="#AUTHOR">AUTHOR</a>
-</li>
-</ul><hr />
-<!-- INDEX END -->
-
-<h1 id="NAME">NAME</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="NAME_CONTENT">
-<p>rxvtperl - rxvt-unicode's embedded perl interpreter</p>
-
-</div>
-<h1 id="SYNOPSIS">SYNOPSIS</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="SYNOPSIS_CONTENT">
-<pre> # create a file grab_test in $HOME:
-
- sub on_sel_grab {
- warn "you selected ", $_[0]->selection;
- ()
- }
-
- # start a rxvt using it:
-
- rxvt --perl-lib $HOME -pe grab_test
-
-</pre>
-
-</div>
-<h1 id="DESCRIPTION">DESCRIPTION</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="DESCRIPTION_CONTENT">
-<p>Every time a terminal object gets created, extension scripts specified via
-the <code>perl</code> resource are loaded and associated with it.</p>
-<p>Scripts are compiled in a 'use strict' and 'use utf8' environment, and
-thus must be encoded as UTF-8.</p>
-<p>Each script will only ever be loaded once, even in rxvtd, where
-scripts will be shared (but not enabled) for all terminals.</p>
-<p>You can disable the embedded perl interpreter by setting both "perl-ext"
-and "perl-ext-common" resources to the empty string.</p>
-
-</div>
-<h1 id="PREPACKAGED_EXTENSIONS">PREPACKAGED EXTENSIONS</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="PREPACKAGED_EXTENSIONS_CONTENT">
-<p>This section describes the extensions delivered with this release. You can
-find them in <cite>/opt/rxvt/lib/urxvt/perl/</cite>.</p>
-<p>You can activate them like this:</p>
-<pre> rxvt -pe <extensionname>
-
-</pre>
-<p>Or by adding them to the resource for extensions loaded by default:</p>
-<pre> URxvt.perl-ext-common: default,selection-autotransform
-
-</pre>
-<dl>
- <dt>selection (enabled by default)</dt>
- <dd>
- <p>(More) intelligent selection. This extension tries to be more intelligent
-when the user extends selections (double-click and further clicks). Right
-now, it tries to select words, urls and complete shell-quoted
-arguments, which is very convenient, too, if your <cite>ls</cite> supports
-<code>--quoting-style=shell</code>.</p>
- <p>A double-click usually selects the word under the cursor, further clicks
-will enlarge the selection.</p>
- <p>The selection works by trying to match a number of regexes and displaying
-them in increasing order of length. You can add your own regexes by
-specifying resources of the form:</p>
-<pre> URxvt.selection.pattern-0: perl-regex
- URxvt.selection.pattern-1: perl-regex
- ...
-
-</pre>
- <p>The index number (0, 1...) must not have any holes, and each regex must
-contain at least one pair of capturing parentheses, which will be used for
-the match. For example, the following adds a regex that matches everything
-between two vertical bars:</p>
-<pre> URxvt.selection.pattern-0: \\|([^|]+)\\|
-
-</pre>
- <p>Another example: Programs I use often output "absolute path: " at the
-beginning of a line when they process multiple files. The following
-pattern matches the filename (note, there is a single space at the very
-end):</p>
-<pre> URxvt.selection.pattern-0: ^(/[^:]+):\
-
-</pre>
- <p>You can look at the source of the selection extension to see more
-interesting uses, such as parsing a line from beginning to end.</p>
- <p>This extension also offers following bindable keyboard commands:</p>
- <p>
- <dl>
- <dt>rot13</dt>
- <dd>
- <p>Rot-13 the selection when activated. Used via keyboard trigger:</p>
-<pre> URxvt.keysym.C-M-r: perl:selection:rot13
-
-</pre>
- </dd>
- </dl>
- </p>
- </dd>
- <dt>option-popup (enabled by default)</dt>
- <dd>
- <p>Binds a popup menu to Ctrl-Button2 that lets you toggle (some) options at
-runtime.</p>
- <p>Other extensions can extend this popup menu by pushing a code reference
-onto <code>@{ $term-</code>{option_popup_hook} }>, which gets called whenever the
-popup is being displayed.</p>
- <p>Its sole argument is the popup menu, which can be modified. It should
-either return nothing or a string, the initial boolean value and a code
-reference. The string will be used as button text and the code reference
-will be called when the toggle changes, with the new boolean value as
-first argument.</p>
- <p>The following will add an entry <code>myoption</code> that changes
-<code>$self-</code>{myoption}>:</p>
-<pre> push @{ $self->{term}{option_popup_hook} }, sub {
- ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
- };
-
-</pre>
- </dd>
- <dt>selection-popup (enabled by default)</dt>
- <dd>
- <p>Binds a popup menu to Ctrl-Button3 that lets you convert the selection
-text into various other formats/action (such as uri unescaping, perl
-evaluation, web-browser starting etc.), depending on content.</p>
- <p>Other extensions can extend this popup menu by pushing a code reference
-onto <code>@{ $term-</code>{selection_popup_hook} }>, which gets called whenever the
-popup is being displayed.</p>
- <p>Its sole argument is the popup menu, which can be modified. The selection
-is in <code>$_</code>, which can be used to decide whether to add something or not.
-It should either return nothing or a string and a code reference. The
-string will be used as button text and the code reference will be called
-when the button gets activated and should transform <code>$_</code>.</p>
- <p>The following will add an entry <code>a to b</code> that transforms all <code>a</code>s in
-the selection to <code>b</code>s, but only if the selection currently contains any
-<code>a</code>s:</p>
-<pre> push @{ $self->{term}{selection_popup_hook} }, sub {
- /a/ ? ("a to b" => sub { s/a/b/g }
- : ()
- };
-
-</pre>
- </dd>
- <dt>searchable-scrollback<hotkey> (enabled by default)</dt>
- <dd>
- <p>Adds regex search functionality to the scrollback buffer, triggered
-by a hotkey (default: <code>M-s</code>). While in search mode, normal terminal
-input/output is suspended and a regex is displayed at the bottom of the
-screen.</p>
- <p>Inputting characters appends them to the regex and continues incremental
-search. <code>BackSpace</code> removes a character from the regex, <code>Up</code> and <code>Down</code>
-search upwards/downwards in the scrollback buffer, <code>End</code> jumps to the
-bottom. <code>Escape</code> leaves search mode and returns to the point where search
-was started, while <code>Enter</code> or <code>Return</code> stay at the current position and
-additionally stores the first match in the current line into the primary
-selection if the <code>Shift</code> modifier is active.</p>
- <p>The regex defaults to "(?i)", resulting in a case-insensitive search. To
-get a case-sensitive search you can delete this prefix using <code>BackSpace</code>
-or simply use an uppercase character which removes the "(?i)" prefix.</p>
- <p>See <cite>perlre</cite> for more info about perl regular expression syntax.</p>
- </dd>
- <dt>readline (enabled by default)</dt>
- <dd>
- <p>A support package that tries to make editing with readline easier. At
-the moment, it reacts to clicking shift-left mouse button by trying to
-move the text cursor to this position. It does so by generating as many
-cursor-left or cursor-right keypresses as required (the this only works
-for programs that correctly support wide characters).</p>
- <p>To avoid too many false positives, this is only done when:</p>
- <p>
- <dl>
- <dt>- the tty is in ICANON state.</dt>
- <dt>- the text cursor is visible.</dt>
- <dt>- the primary screen is currently being displayed.</dt>
- <dt>- the mouse is on the same (multi-row-) line as the text cursor.</dt>
- </dl>
- </p>
- <p>The normal selection mechanism isn't disabled, so quick successive clicks
-might interfere with selection creation in harmless ways.</p>
- </dd>
- <dt>selection-autotransform</dt>
- <dd>
- <p>This selection allows you to do automatic transforms on a selection
-whenever a selection is made.</p>
- <p>It works by specifying perl snippets (most useful is a single <code>s///</code>
-operator) that modify <code>$_</code> as resources:</p>
-<pre> URxvt.selection-autotransform.0: transform
- URxvt.selection-autotransform.1: transform
- ...
-
-</pre>
- <p>For example, the following will transform selections of the form
-<code>filename:number</code>, often seen in compiler messages, into <code>vi +$filename
-$word</code>:</p>
-<pre> URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
-
-</pre>
- <p>And this example matches the same,but replaces it with vi-commands you can
-paste directly into your (vi :) editor:</p>
-<pre> URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
-
-</pre>
- <p>Of course, this can be modified to suit your needs and your editor :)</p>
- <p>To expand the example above to typical perl error messages ("XXX at
-FILENAME line YYY."), you need a slightly more elaborate solution:</p>
-<pre> URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
- URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
-
-</pre>
- <p>The first line tells the selection code to treat the unchanging part of
-every error message as a selection pattern, and the second line transforms
-the message into vi commands to load the file.</p>
- </dd>
- <dt>tabbed</dt>
- <dd>
- <p>This transforms the terminal into a tabbar with additional terminals, that
-is, it implements what is commonly referred to as "tabbed terminal". The topmost line
-displays a "[NEW]" button, which, when clicked, will add a new tab, followed by one
-button per tab.</p>
- <p>Clicking a button will activate that tab. Pressing <strong>Shift-Left</strong> and
-<strong>Shift-Right</strong> will switch to the tab left or right of the current one,
-while <strong>Shift-Down</strong> creates a new tab.</p>
- <p>The tabbar itself can be configured similarly to a normal terminal, but
-with a resource class of <code>URxvt.tabbed</code>. In addition, it supports the
-following four resources (shown with defaults):</p>
-<pre> URxvt.tabbed.tabbar-fg: <colour-index, default 3>
- URxvt.tabbed.tabbar-bg: <colour-index, default 0>
- URxvt.tabbed.tab-fg: <colour-index, default 0>
- URxvt.tabbed.tab-bg: <colour-index, default 1>
-
-</pre>
- <p>See <i>COLOR AND GRAPHICS</i> in the rxvt(1) manpage for valid
-indices.</p>
- </dd>
- <dt>matcher</dt>
- <dd>
- <p>Uses per-line display filtering (<code>on_line_update</code>) to underline text
-matching a certain pattern and make it clickable. When clicked with the
-mouse button specified in the <code>matcher.button</code> resource (default 2, or
-middle), the program specified in the <code>matcher.launcher</code> resource
-(default, the <code>urlLauncher</code> resource, <code>sensible-browser</code>) will be started
-with the matched text as first argument. The default configuration is
-suitable for matching URLs and launching a web browser, like the
-former "mark-urls" extension.</p>
- <p>The default pattern to match URLs can be overridden with the
-<code>matcher.pattern.0</code> resource, and additional patterns can be specified
-with numbered patterns, in a manner similar to the "selection" extension.
-The launcher can also be overridden on a per-pattern basis.</p>
- <p>It is possible to activate the most recently seen match from the keyboard.
-Simply bind a keysym to "perl:matcher" as seen in the example below.</p>
- <p>Example configuration:</p>
-<pre> URxvt.perl-ext: default,matcher
- URxvt.urlLauncher: sensible-browser
- URxvt.keysym.C-Delete: perl:matcher
- URxvt.matcher.button: 1
- URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
- URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
- URxvt.matcher.launcher.2: gvim +$2 $1
-
-</pre>
- </dd>
- <dt>xim-onthespot</dt>
- <dd>
- <p>This (experimental) perl extension implements OnTheSpot editing. It does
-not work perfectly, and some input methods don't seem to work well with
-OnTheSpot editing in general, but it seems to work at least for SCIM and
-kinput2.</p>
- <p>You enable it by specifying this extension and a preedit style of
-<code>OnTheSpot</code>, i.e.:</p>
-<pre> rxvt -pt OnTheSpot -pe xim-onthespot
-
-</pre>
- </dd>
- <dt>kuake<hotkey></dt>
- <dd>
- <p>A very primitive quake-console-like extension. It was inspired by a
-description of how the programs <code>kuake</code> and <code>yakuake</code> work: Whenever the
-user presses a global accelerator key (by default <code>F10</code>), the terminal
-will show or hide itself. Another press of the accelerator key will hide
-or show it again.</p>
- <p>Initially, the window will not be shown when using this extension.</p>
- <p>This is useful if you need a single terminal that is not using any desktop
-space most of the time but is quickly available at the press of a key.</p>
- <p>The accelerator key is grabbed regardless of any modifiers, so this
-extension will actually grab a physical key just for this function.</p>
- <p>If you want a quake-like animation, tell your window manager to do so
-(fvwm can do it).</p>
- </dd>
- <dt>block-graphics-to-ascii</dt>
- <dd>
- <p>A not very useful example of filtering all text output to the terminal
-by replacing all line-drawing characters (U+2500 .. U+259F) by a
-similar-looking ascii character.</p>
- </dd>
- <dt>digital-clock</dt>
- <dd>
- <p>Displays a digital clock using the built-in overlay.</p>
- </dd>
- <dt>remote-clipboard</dt>
- <dd>
- <p>Somewhat of a misnomer, this extension adds two menu entries to the
-selection popup that allows one to run external commands to store the
-selection somewhere and fetch it again.</p>
- <p>We use it to implement a "distributed selection mechanism", which just
-means that one command uploads the file to a remote server, and another
-reads it.</p>
- <p>The commands can be set using the <code>URxvt.remote-selection.store</code> and
-<code>URxvt.remote-selection.fetch</code> resources. The first should read the
-selection to store from STDIN (always in UTF-8), the second should provide
-the selection data on STDOUT (also in UTF-8).</p>
- <p>The defaults (which are likely useless to you) use rsh and cat:</p>
-<pre> URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
- URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
-
-</pre>
- </dd>
- <dt>selection-pastebin</dt>
- <dd>
- <p>This is a little rarely useful extension that Uploads the selection as
-textfile to a remote site (or does other things). (The implementation is
-not currently secure for use in a multiuser environment as it writes to
-<cite>/tmp</cite> directly.).</p>
- <p>It listens to the <code>selection-pastebin:remote-pastebin</code> keyboard command,
-i.e.</p>
-<pre> URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
-
-</pre>
- <p>Pressing this combination runs a command with <code>%</code> replaced by the name of
-the textfile. This command can be set via a resource:</p>
-<pre> URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
-
-</pre>
- <p>And the default is likely not useful to anybody but the few people around
-here :)</p>
- <p>The name of the textfile is the hex encoded md5 sum of the selection, so
-the same content should lead to the same filename.</p>
- <p>After a successful upload the selection will be replaced by the text given
-in the <code>selection-pastebin-url</code> resource (again, the % is the placeholder
-for the filename):</p>
-<pre> URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
-
-</pre>
- <p><i>Note to xrdb users:</i> xrdb uses the C preprocessor, which might interpret
-the double <code>/</code> characters as comment start. Use <code>\057\057</code> instead,
-which works regardless of wether xrdb is used to parse the resource file
-or not.</p>
- </dd>
- <dt>example-refresh-hooks</dt>
- <dd>
- <p>Displays a very simple digital clock in the upper right corner of the
-window. Illustrates overwriting the refresh callbacks to create your own
-overlays or changes.</p>
- </dd>
-</dl>
-
-</div>
-<h1 id="API_DOCUMENTATION">API DOCUMENTATION</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="API_DOCUMENTATION_CONTENT">
-
-</div>
-<h2 id="General_API_Considerations">General API Considerations</h2>
-<div id="General_API_Considerations_CONTENT">
-<p>All objects (such as terminals, time watchers etc.) are typical
-reference-to-hash objects. The hash can be used to store anything you
-like. All members starting with an underscore (such as <code>_ptr</code> or
-<code>_hook</code>) are reserved for internal uses and <strong>MUST NOT</strong> be accessed or
-modified).</p>
-<p>When objects are destroyed on the C++ side, the perl object hashes are
-emptied, so its best to store related objects such as time watchers and
-the like inside the terminal object so they get destroyed as soon as the
-terminal is destroyed.</p>
-<p>Argument names also often indicate the type of a parameter. Here are some
-hints on what they mean:</p>
-<dl>
- <dt>$text</dt>
- <dd>
- <p>Rxvt-unicodes special way of encoding text, where one "unicode" character
-always represents one screen cell. See <cite>ROW_t</cite> for a discussion of this format.</p>
- </dd>
- <dt>$string</dt>
- <dd>
- <p>A perl text string, with an emphasis on <i>text</i>. It can store all unicode
-characters and is to be distinguished with text encoded in a specific
-encoding (often locale-specific) and binary data.</p>
- </dd>
- <dt>$octets</dt>
- <dd>
- <p>Either binary data or - more common - a text string encoded in a
-locale-specific way.</p>
- </dd>
-</dl>
-
-</div>
-<h2 id="Extension_Objects">Extension Objects</h2>
-<div id="Extension_Objects_CONTENT">
-<p>Every perl extension is a perl class. A separate perl object is created
-for each terminal, and each terminal has its own set of extenion objects,
-which are passed as the first parameter to hooks. So extensions can use
-their <code>$self</code> object without having to think about clashes with other
-extensions or other terminals, with the exception of methods and members
-that begin with an underscore character <code>_</code>: these are reserved for
-internal use.</p>
-<p>Although it isn't a <code>urxvt::term</code> object, you can call all methods of the
-<code>urxvt::term</code> class on this object.</p>
-<p>It has the following methods and data members:</p>
-<dl>
- <dt>$urxvt_term = $self->{term}</dt>
- <dd>
- <p>Returns the <code>urxvt::term</code> object associated with this instance of the
-extension. This member <i>must not</i> be changed in any way.</p>
- </dd>
- <dt>$self->enable ($hook_name => $cb, [$hook_name => $cb..])</dt>
- <dd>
- <p>Dynamically enable the given hooks (named without the <code>on_</code> prefix) for
-this extension, replacing any previous hook. This is useful when you want
-to overwrite time-critical hooks only temporarily.</p>
- </dd>
- <dt>$self->disable ($hook_name[, $hook_name..])</dt>
- <dd>
- <p>Dynamically disable the given hooks.</p>
- </dd>
-</dl>
-
-</div>
-<h2 id="Hooks">Hooks</h2>
-<div id="Hooks_CONTENT">
-<p>The following subroutines can be declared in extension files, and will be
-called whenever the relevant event happens.</p>
-<p>The first argument passed to them is an extension object as described in
-the in the <code>Extension Objects</code> section.</p>
-<p><strong>All</strong> of these hooks must return a boolean value. If any of the called
-hooks returns true, then the event counts as being <i>consumed</i>, and the
-relevant action might not be carried out by the C++ code.</p>
-<p><i>When in doubt, return a false value (preferably <code>()</code>).</i></p>
-<dl>
- <dt>on_init $term</dt>
- <dd>
- <p>Called after a new terminal object has been initialized, but before
-windows are created or the command gets run. Most methods are unsafe to
-call or deliver senseless data, as terminal size and other characteristics
-have not yet been determined. You can safely query and change resources
-and options, though. For many purposes the <code>on_start</code> hook is a better
-place.</p>
- </dd>
- <dt>on_start $term</dt>
- <dd>
- <p>Called at the very end of initialisation of a new terminal, just before
-trying to map (display) the toplevel and returning to the main loop.</p>
- </dd>
- <dt>on_destroy $term</dt>
- <dd>
- <p>Called whenever something tries to destroy terminal, when the terminal is
-still fully functional (not for long, though).</p>
- </dd>
- <dt>on_reset $term</dt>
- <dd>
- <p>Called after the screen is "reset" for any reason, such as resizing or
-control sequences. Here is where you can react on changes to size-related
-variables.</p>
- </dd>
- <dt>on_child_start $term, $pid</dt>
- <dd>
- <p>Called just after the child process has been <code>fork</code>ed.</p>
- </dd>
- <dt>on_child_exit $term, $status</dt>
- <dd>
- <p>Called just after the child process has exited. <code>$status</code> is the status
-from <code>waitpid</code>.</p>
- </dd>
- <dt>on_sel_make $term, $eventtime</dt>
- <dd>
- <p>Called whenever a selection has been made by the user, but before the
-selection text is copied, so changes to the beginning, end or type of the
-selection will be honored.</p>
- <p>Returning a true value aborts selection making by urxvt, in which case you
-have to make a selection yourself by calling <code>$term->selection_grab</code>.</p>
- </dd>
- <dt>on_sel_grab $term, $eventtime</dt>
- <dd>
- <p>Called whenever a selection has been copied, but before the selection is
-requested from the server. The selection text can be queried and changed
-by calling <code>$term->selection</code>.</p>
- <p>Returning a true value aborts selection grabbing. It will still be highlighted.</p>
- </dd>
- <dt>on_sel_extend $term</dt>
- <dd>
- <p>Called whenever the user tries to extend the selection (e.g. with a double
-click) and is either supposed to return false (normal operation), or
-should extend the selection itself and return true to suppress the built-in
-processing. This can happen multiple times, as long as the callback
-returns true, it will be called on every further click by the user and is
-supposed to enlarge the selection more and more, if possible.</p>
- <p>See the <cite>selection</cite> example extension.</p>
- </dd>
- <dt>on_view_change $term, $offset</dt>
- <dd>
- <p>Called whenever the view offset changes, i.e. the user or program
-scrolls. Offset <code>0</code> means display the normal terminal, positive values
-show this many lines of scrollback.</p>
- </dd>
- <dt>on_scroll_back $term, $lines, $saved</dt>
- <dd>
- <p>Called whenever lines scroll out of the terminal area into the scrollback
-buffer. <code>$lines</code> is the number of lines scrolled out and may be larger
-than the scroll back buffer or the terminal.</p>
- <p>It is called before lines are scrolled out (so rows 0 .. min ($lines - 1,
-$nrow - 1) represent the lines to be scrolled out). <code>$saved</code> is the total
-number of lines that will be in the scrollback buffer.</p>
- </dd>
- <dt>on_osc_seq $term, $op, $args</dt>
- <dd>
- <p>Called on every OSC sequence and can be used to suppress it or modify its
-behaviour. The default should be to return an empty list. A true value
-suppresses execution of the request completely. Make sure you don't get
-confused by recursive invocations when you output an osc sequence within
-this callback.</p>
- <p><code>on_osc_seq_perl</code> should be used for new behaviour.</p>
- </dd>
- <dt>on_osc_seq_perl $term, $string</dt>
- <dd>
- <p>Called whenever the <strong>ESC ] 777 ; string ST</strong> command sequence (OSC =
-operating system command) is processed. Cursor position and other state
-information is up-to-date when this happens. For interoperability, the
-string should start with the extension name and a colon, to distinguish
-it from commands for other extensions, and this might be enforced in the
-future.</p>
- <p>Be careful not ever to trust (in a security sense) the data you receive,
-as its source can not easily be controlled (e-mail content, messages from
-other users on the same system etc.).</p>
- </dd>
- <dt>on_add_lines $term, $string</dt>
- <dd>
- <p>Called whenever text is about to be output, with the text as argument. You
-can filter/change and output the text yourself by returning a true value
-and calling <code>$term->scr_add_lines</code> yourself. Please note that this
-might be very slow, however, as your hook is called for <strong>all</strong> text being
-output.</p>
- </dd>
- <dt>on_tt_write $term, $octets</dt>
- <dd>
- <p>Called whenever some data is written to the tty/pty and can be used to
-suppress or filter tty input.</p>
- </dd>
- <dt>on_line_update $term, $row</dt>
- <dd>
- <p>Called whenever a line was updated or changed. Can be used to filter
-screen output (e.g. underline urls or other useless stuff). Only lines
-that are being shown will be filtered, and, due to performance reasons,
-not always immediately.</p>
- <p>The row number is always the topmost row of the line if the line spans
-multiple rows.</p>
- <p>Please note that, if you change the line, then the hook might get called
-later with the already-modified line (e.g. if unrelated parts change), so
-you cannot just toggle rendition bits, but only set them.</p>
- </dd>
- <dt>on_refresh_begin $term</dt>
- <dd>
- <p>Called just before the screen gets redrawn. Can be used for overlay
-or similar effects by modify terminal contents in refresh_begin, and
-restoring them in refresh_end. The built-in overlay and selection display
-code is run after this hook, and takes precedence.</p>
- </dd>
- <dt>on_refresh_end $term</dt>
- <dd>
- <p>Called just after the screen gets redrawn. See <code>on_refresh_begin</code>.</p>
- </dd>
- <dt>on_user_command $term, $string</dt>
- <dd>
- <p>Called whenever a user-configured event is being activated (e.g. via
-a <code>perl:string</code> action bound to a key, see description of the <strong>keysym</strong>
-resource in the rxvt(1) manpage).</p>
- <p>The event is simply the action string. This interface is assumed to change
-slightly in the future.</p>
- </dd>
- <dt>on_resize_all_windows $tern, $new_width, $new_height</dt>
- <dd>
- <p>Called just after the new window size has been calculated, but before
-windows are actually being resized or hints are being set. If this hook
-returns TRUE, setting of the window hints is being skipped.</p>
- </dd>
- <dt>on_x_event $term, $event</dt>
- <dd>
- <p>Called on every X event received on the vt window (and possibly other
-windows). Should only be used as a last resort. Most event structure
-members are not passed.</p>
- </dd>
- <dt>on_root_event $term, $event</dt>
- <dd>
- <p>Like <code>on_x_event</code>, but is called for events on the root window.</p>
- </dd>
- <dt>on_focus_in $term</dt>
- <dd>
- <p>Called whenever the window gets the keyboard focus, before rxvt-unicode
-does focus in processing.</p>
- </dd>
- <dt>on_focus_out $term</dt>
- <dd>
- <p>Called whenever the window loses keyboard focus, before rxvt-unicode does
-focus out processing.</p>
- </dd>
- <dt>on_configure_notify $term, $event</dt>
- <dt>on_property_notify $term, $event</dt>
- <dt>on_key_press $term, $event, $keysym, $octets</dt>
- <dt>on_key_release $term, $event, $keysym</dt>
- <dt>on_button_press $term, $event</dt>
- <dt>on_button_release $term, $event</dt>
- <dt>on_motion_notify $term, $event</dt>
- <dt>on_map_notify $term, $event</dt>
- <dt>on_unmap_notify $term, $event</dt>
- <dd>
- <p>Called whenever the corresponding X event is received for the terminal If
-the hook returns true, then the even will be ignored by rxvt-unicode.</p>
- <p>The event is a hash with most values as named by Xlib (see the XEvent
-manpage), with the additional members <code>row</code> and <code>col</code>, which are the
-(real, not screen-based) row and column under the mouse cursor.</p>
- <p><code>on_key_press</code> additionally receives the string rxvt-unicode would
-output, if any, in locale-specific encoding.</p>
- <p>subwindow.</p>
- </dd>
- <dt>on_client_message $term, $event</dt>
- <dt>on_wm_protocols $term, $event</dt>
- <dt>on_wm_delete_window $term, $event</dt>
- <dd>
- <p>Called when various types of ClientMessage events are received (all with
-format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).</p>
- </dd>
-</dl>
-
-</div>
-<h2 id="Variables_in_the_code_urxvt_code_Pac">Variables in the <code>urxvt</code> Package</h2>
-<div id="Variables_in_the_code_urxvt_code_Pac-2">
-<dl>
- <dt>$urxvt::LIBDIR</dt>
- <dd>
- <p>The rxvt-unicode library directory, where, among other things, the perl
-modules and scripts are stored.</p>
- </dd>
- <dt>$urxvt::RESCLASS, $urxvt::RESCLASS</dt>
- <dd>
- <p>The resource class and name rxvt-unicode uses to look up X resources.</p>
- </dd>
- <dt>$urxvt::RXVTNAME</dt>
- <dd>
- <p>The basename of the installed binaries, usually <code>urxvt</code>.</p>
- </dd>
- <dt>$urxvt::TERM</dt>
- <dd>
- <p>The current terminal. This variable stores the current <code>urxvt::term</code>
-object, whenever a callback/hook is executing.</p>
- </dd>
- <dt>@urxvt::TERM_INIT</dt>
- <dd>
- <p>All code references in this array will be called as methods of the next newly
-created <code>urxvt::term</code> object (during the <code>on_init</code> phase). The array
-gets cleared before the code references that were in it are being executed,
-so references can push themselves onto it again if they so desire.</p>
- <p>This complements to the perl-eval command line option, but gets executed
-first.</p>
- </dd>
- <dt>@urxvt::TERM_EXT</dt>
- <dd>
- <p>Works similar to <code>@TERM_INIT</code>, but contains perl package/class names, which
-get registered as normal extensions after calling the hooks in <code>@TERM_INIT</code>
-but before other extensions. Gets cleared just like <code>@TERM_INIT</code>.</p>
- </dd>
-</dl>
-
-</div>
-<h2 id="Functions_in_the_code_urxvt_code_Pac">Functions in the <code>urxvt</code> Package</h2>
-<div id="Functions_in_the_code_urxvt_code_Pac-2">
-<dl>
- <dt>urxvt::fatal $errormessage</dt>
- <dd>
- <p>Fatally aborts execution with the given error message. Avoid at all
-costs! The only time this is acceptable is when the terminal process
-starts up.</p>
- </dd>
- <dt>urxvt::warn $string</dt>
- <dd>
- <p>Calls <code>rxvt_warn</code> with the given string which should not include a
-newline. The module also overwrites the <code>warn</code> builtin with a function
-that calls this function.</p>
- <p>Using this function has the advantage that its output ends up in the
-correct place, e.g. on stderr of the connecting urxvtc client.</p>
- <p>Messages have a size limit of 1023 bytes currently.</p>
- </dd>
- <dt>@terms = urxvt::termlist</dt>
- <dd>
- <p>Returns all urxvt::term objects that exist in this process, regardless of
-whether they are started, being destroyed etc., so be careful. Only term
-objects that have perl extensions attached will be returned (because there
-is no urxvt::term objet associated with others).</p>
- </dd>
- <dt>$time = urxvt::NOW</dt>
- <dd>
- <p>Returns the "current time" (as per the event loop).</p>
- </dd>
- <dt>urxvt::CurrentTime</dt>
- <dt>urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask,
-Mod3Mask, Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask,
-Button4Mask, Button5Mask, AnyModifier</dt>
- <dt>urxvt::NoEventMask, KeyPressMask, KeyReleaseMask,
-ButtonPressMask, ButtonReleaseMask, EnterWindowMask, LeaveWindowMask,
-PointerMotionMask, PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
-Button3MotionMask, Button4MotionMask, Button5MotionMask, ButtonMotionMask,
-KeymapStateMask, ExposureMask, VisibilityChangeMask, StructureNotifyMask,
-ResizeRedirectMask, SubstructureNotifyMask, SubstructureRedirectMask,
-FocusChangeMask, PropertyChangeMask, ColormapChangeMask, OwnerGrabButtonMask</dt>
- <dt>urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
-EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
-GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
-UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
-ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
-CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
-SelectionNotify, ColormapNotify, ClientMessage, MappingNotify</dt>
- <dd>
- <p>Various constants for use in X calls and event processing.</p>
- </dd>
-</dl>
-
-</div>
-<h2 id="RENDITION">RENDITION</h2>
-<div id="RENDITION_CONTENT">
-<p>Rendition bitsets contain information about colour, font, font styles and
-similar information for each screen cell.</p>
-<p>The following "macros" deal with changes in rendition sets. You should
-never just create a bitset, you should always modify an existing one,
-as they contain important information required for correct operation of
-rxvt-unicode.</p>
-<dl>
- <dt>$rend = urxvt::DEFAULT_RSTYLE</dt>
- <dd>
- <p>Returns the default rendition, as used when the terminal is starting up or
-being reset. Useful as a base to start when creating renditions.</p>
- </dd>
- <dt>$rend = urxvt::OVERLAY_RSTYLE</dt>
- <dd>
- <p>Return the rendition mask used for overlays by default.</p>
- </dd>
- <dt>$rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline</dt>
- <dd>
- <p>Return the bit that enabled bold, italic, blink, reverse-video and
-underline, respectively. To enable such a style, just logically OR it into
-the bitset.</p>
- </dd>
- <dt>$foreground = urxvt::GET_BASEFG $rend</dt>
- <dt>$background = urxvt::GET_BASEBG $rend</dt>
- <dd>
- <p>Return the foreground/background colour index, respectively.</p>
- </dd>
- <dt>$rend = urxvt::SET_FGCOLOR $rend, $new_colour</dt>
- <dt>$rend = urxvt::SET_BGCOLOR $rend, $new_colour</dt>
- <dt>$rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg</dt>
- <dd>
- <p>Replace the foreground/background colour in the rendition mask with the
-specified one.</p>
- </dd>
- <dt>$value = urxvt::GET_CUSTOM $rend</dt>
- <dd>
- <p>Return the "custom" value: Every rendition has 5 bits for use by
-extensions. They can be set and changed as you like and are initially
-zero.</p>
- </dd>
- <dt>$rend = urxvt::SET_CUSTOM $rend, $new_value</dt>
- <dd>
- <p>Change the custom value.</p>
- </dd>
-</dl>
-
-</div>
-<h2 id="The_code_urxvt_anyevent_code_Class">The <code>urxvt::anyevent</code> Class</h2>
-<div id="The_code_urxvt_anyevent_code_Class_C">
-<p>The sole purpose of this class is to deliver an interface to the
-<code>AnyEvent</code> module - any module using it will work inside urxvt without
-further programming. The only exception is that you cannot wait on
-condition variables, but non-blocking condvar use is ok. What this means
-is that you cannot use blocking APIs, but the non-blocking variant should
-work.</p>
-
-</div>
-<h2 id="The_code_urxvt_term_code_Class">The <code>urxvt::term</code> Class</h2>
-<div id="The_code_urxvt_term_code_Class_CONTE">
-<dl>
- <dt>$term = new urxvt::term $envhashref, $rxvtname, [arg...]</dt>
- <dd>
- <p>Creates a new terminal, very similar as if you had started it with system
-<code>$rxvtname, arg...</code>. <code>$envhashref</code> must be a reference to a <code>%ENV</code>-like
-hash which defines the environment of the new terminal.</p>
- <p>Croaks (and probably outputs an error message) if the new instance
-couldn't be created. Returns <code>undef</code> if the new instance didn't
-initialise perl, and the terminal object otherwise. The <code>init</code> and
-<code>start</code> hooks will be called before this call returns, and are free to
-refer to global data (which is race free).</p>
- </dd>
- <dt>$term->destroy</dt>
- <dd>
- <p>Destroy the terminal object (close the window, free resources
-etc.). Please note that rxvt will not exit as long as any event
-watchers (timers, io watchers) are still active.</p>
- </dd>
- <dt>$term->exec_async ($cmd[, @args])</dt>
- <dd>
- <p>Works like the combination of the <code>fork</code>/<code>exec</code> builtins, which executes
-("starts") programs in the background. This function takes care of setting
-the user environment before exec'ing the command (e.g. <code>PATH</code>) and should
-be preferred over explicit calls to <code>exec</code> or <code>system</code>.</p>
- <p>Returns the pid of the subprocess or <code>undef</code> on error.</p>
- </dd>
- <dt>$isset = $term->option ($optval[, $set])</dt>
- <dd>
- <p>Returns true if the option specified by <code>$optval</code> is enabled, and
-optionally change it. All option values are stored by name in the hash
-<code>%urxvt::OPTION</code>. Options not enabled in this binary are not in the hash.</p>
- <p>Here is a likely non-exhaustive list of option names, please see the
-source file <cite>/src/optinc.h</cite> to see the actual list:</p>
-<pre> borderLess console cursorBlink cursorUnderline hold iconic insecure
- intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
- override-redirect pastableTabs pointerBlank reverseVideo scrollBar
- scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
- scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
- transparent tripleclickwords utmpInhibit visualBell
-
-</pre>
- </dd>
- <dt>$value = $term->resource ($name[, $newval])</dt>
- <dd>
- <p>Returns the current resource value associated with a given name and
-optionally sets a new value. Setting values is most useful in the <code>init</code>
-hook. Unset resources are returned and accepted as <code>undef</code>.</p>
- <p>The new value must be properly encoded to a suitable character encoding
-before passing it to this method. Similarly, the returned value may need
-to be converted from the used encoding to text.</p>
- <p>Resource names are as defined in <cite>src/rsinc.h</cite>. Colours can be specified
-as resource names of the form <code>color+<index></code>, e.g. <code>color+5</code>. (will
-likely change).</p>
- <p>Please note that resource strings will currently only be freed when the
-terminal is destroyed, so changing options frequently will eat memory.</p>
- <p>Here is a likely non-exhaustive list of resource names, not all of which
-are supported in every build, please see the source file <cite>/src/rsinc.h</cite>
-to see the actual list:</p>
-<pre> answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
- borderLess color cursorBlink cursorUnderline cutchars delete_key
- display_name embed ext_bwidth fade font geometry hold iconName
- imFont imLocale inputMethod insecure int_bwidth intensityStyles
- italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
- mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
- perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
- preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
- scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
- scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
- secondaryScreen secondaryScroll selectstyle shade term_name title
- transient_for transparent transparent_all tripleclickwords utmpInhibit
- visualBell
-
-</pre>
- </dd>
- <dt>$value = $term->x_resource ($pattern)</dt>
- <dd>
- <p>Returns the X-Resource for the given pattern, excluding the program or
-class name, i.e. <code>$term->x_resource ("boldFont")</code> should return the
-same value as used by this instance of rxvt-unicode. Returns <code>undef</code> if no
-resource with that pattern exists.</p>
- <p>This method should only be called during the <code>on_start</code> hook, as there is
-only one resource database per display, and later invocations might return
-the wrong resources.</p>
- </dd>
- <dt>$success = $term->parse_keysym ($keysym_spec, $command_string)</dt>
- <dd>
- <p>Adds a keymap translation exactly as specified via a resource. See the
-<code>keysym</code> resource in the rxvt(1) manpage.</p>
- </dd>
- <dt>$rend = $term->rstyle ([$new_rstyle])</dt>
- <dd>
- <p>Return and optionally change the current rendition. Text that is output by
-the terminal application will use this style.</p>
- </dd>
- <dt>($row, $col) = $term->screen_cur ([$row, $col])</dt>
- <dd>
- <p>Return the current coordinates of the text cursor position and optionally
-set it (which is usually bad as applications don't expect that).</p>
- </dd>
- <dt>($row, $col) = $term->selection_mark ([$row, $col])</dt>
- <dt>($row, $col) = $term->selection_beg ([$row, $col])</dt>
- <dt>($row, $col) = $term->selection_end ([$row, $col])</dt>
- <dd>
- <p>Return the current values of the selection mark, begin or end positions,
-and optionally set them to new values.</p>
- </dd>
- <dt>$term->selection_make ($eventtime[, $rectangular])</dt>
- <dd>
- <p>Tries to make a selection as set by <code>selection_beg</code> and
-<code>selection_end</code>. If <code>$rectangular</code> is true (default: false), a
-rectangular selection will be made. This is the prefered function to make
-a selection.</p>
- </dd>
- <dt>$success = $term->selection_grab ($eventtime)</dt>
- <dd>
- <p>Try to request the primary selection text from the server (for example, as
-set by the next method). No visual feedback will be given. This function
-is mostly useful from within <code>on_sel_grab</code> hooks.</p>
- </dd>
- <dt>$oldtext = $term->selection ([$newtext])</dt>
- <dd>
- <p>Return the current selection text and optionally replace it by <code>$newtext</code>.</p>
- </dd>
- <dt>$term->overlay_simple ($x, $y, $text)</dt>
- <dd>
- <p>Create a simple multi-line overlay box. See the next method for details.</p>
- </dd>
- <dt>$term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])</dt>
- <dd>
- <p>Create a new (empty) overlay at the given position with the given
-width/height. <code>$rstyle</code> defines the initial rendition style
-(default: <code>OVERLAY_RSTYLE</code>).</p>
- <p>If <code>$border</code> is <code>2</code> (default), then a decorative border will be put
-around the box.</p>
- <p>If either <code>$x</code> or <code>$y</code> is negative, then this is counted from the
-right/bottom side, respectively.</p>
- <p>This method returns an urxvt::overlay object. The overlay will be visible
-as long as the perl object is referenced.</p>
- <p>The methods currently supported on <code>urxvt::overlay</code> objects are:</p>
- <p>
- <dl>
- <dt>$overlay->set ($x, $y, $text, $rend)</dt>
- <dd>
- <p>Similar to <code>$term->ROW_t</code> and <code>$term->ROW_r</code> in that it puts
-text in rxvt-unicode's special encoding and an array of rendition values
-at a specific position inside the overlay.</p>
- </dd>
- <dt>$overlay->hide</dt>
- <dd>
- <p>If visible, hide the overlay, but do not destroy it.</p>
- </dd>
- <dt>$overlay->show</dt>
- <dd>
- <p>If hidden, display the overlay again.</p>
- </dd>
- </dl>
- </p>
- </dd>
- <dt>$popup = $term->popup ($event)</dt>
- <dd>
- <p>Creates a new <code>urxvt::popup</code> object that implements a popup menu. The
-<code>$event</code> <i>must</i> be the event causing the menu to pop up (a button event,
-currently).</p>
- </dd>
- <dt>$cellwidth = $term->strwidth ($string)</dt>
- <dd>
- <p>Returns the number of screen-cells this string would need. Correctly
-accounts for wide and combining characters.</p>
- </dd>
- <dt>$octets = $term->locale_encode ($string)</dt>
- <dd>
- <p>Convert the given text string into the corresponding locale encoding.</p>
- </dd>
- <dt>$string = $term->locale_decode ($octets)</dt>
- <dd>
- <p>Convert the given locale-encoded octets into a perl string.</p>
- </dd>
- <dt>$term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])</dt>
- <dd>
- <p>XORs the rendition values in the given span with the provided value
-(default: <code>RS_RVid</code>), which <i>MUST NOT</i> contain font styles. Useful in
-refresh hooks to provide effects similar to the selection.</p>
- </dd>
- <dt>$term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[, $rstyle2]])</dt>
- <dd>
- <p>Similar to <code>scr_xor_span</code>, but xors a rectangle instead. Trailing
-whitespace will additionally be xored with the <code>$rstyle2</code>, which defaults
-to <code>RS_RVid | RS_Uline</code>, which removes reverse video again and underlines
-it instead. Both styles <i>MUST NOT</i> contain font styles.</p>
- </dd>
- <dt>$term->scr_bell</dt>
- <dd>
- <p>Ring the bell!</p>
- </dd>
- <dt>$term->scr_add_lines ($string)</dt>
- <dd>
- <p>Write the given text string to the screen, as if output by the application
-running inside the terminal. It may not contain command sequences (escape
-codes), but is free to use line feeds, carriage returns and tabs. The
-string is a normal text string, not in locale-dependent encoding.</p>
- <p>Normally its not a good idea to use this function, as programs might be
-confused by changes in cursor position or scrolling. Its useful inside a
-<code>on_add_lines</code> hook, though.</p>
- </dd>
- <dt>$term->scr_change_screen ($screen)</dt>
- <dd>
- <p>Switch to given screen - 0 primary, 1 secondary.</p>
- </dd>
- <dt>$term->cmd_parse ($octets)</dt>
- <dd>
- <p>Similar to <code>scr_add_lines</code>, but the argument must be in the
-locale-specific encoding of the terminal and can contain command sequences
-(escape codes) that will be interpreted.</p>
- </dd>
- <dt>$term->tt_write ($octets)</dt>
- <dd>
- <p>Write the octets given in <code>$data</code> to the tty (i.e. as program input). To
-pass characters instead of octets, you should convert your strings first
-to the locale-specific encoding using <code>$term->locale_encode</code>.</p>
- </dd>
- <dt>$old_events = $term->pty_ev_events ([$new_events])</dt>
- <dd>
- <p>Replaces the event mask of the pty watcher by the given event mask. Can
-be used to suppress input and output handling to the pty/tty. See the
-description of <code>urxvt::timer->events</code>. Make sure to always restore
-the previous value.</p>
- </dd>
- <dt>$fd = $term->pty_fd</dt>
- <dd>
- <p>Returns the master file descriptor for the pty in use, or <code>-1</code> if no pty
-is used.</p>
- </dd>
- <dt>$windowid = $term->parent</dt>
- <dd>
- <p>Return the window id of the toplevel window.</p>
- </dd>
- <dt>$windowid = $term->vt</dt>
- <dd>
- <p>Return the window id of the terminal window.</p>
- </dd>
- <dt>$term->vt_emask_add ($x_event_mask)</dt>
- <dd>
- <p>Adds the specified events to the vt event mask. Useful e.g. when you want
-to receive pointer events all the times:</p>
-<pre> $term->vt_emask_add (urxvt::PointerMotionMask);
-
-</pre>
- </dd>
- <dt>$term->focus_in</dt>
- <dt>$term->focus_out</dt>
- <dt>$term->key_press ($state, $keycode[, $time])</dt>
- <dt>$term->key_release ($state, $keycode[, $time])</dt>
- <dd>
- <p>Deliver various fake events to to terminal.</p>
- </dd>
- <dt>$window_width = $term->width</dt>
- <dt>$window_height = $term->height</dt>
- <dt>$font_width = $term->fwidth</dt>
- <dt>$font_height = $term->fheight</dt>
- <dt>$font_ascent = $term->fbase</dt>
- <dt>$terminal_rows = $term->nrow</dt>
- <dt>$terminal_columns = $term->ncol</dt>
- <dt>$has_focus = $term->focus</dt>
- <dt>$is_mapped = $term->mapped</dt>
- <dt>$max_scrollback = $term->saveLines</dt>
- <dt>$nrow_plus_saveLines = $term->total_rows</dt>
- <dt>$topmost_scrollback_row = $term->top_row</dt>
- <dd>
- <p>Return various integers describing terminal characteristics.</p>
- </dd>
- <dt>$x_display = $term->display_id</dt>
- <dd>
- <p>Return the DISPLAY used by rxvt-unicode.</p>
- </dd>
- <dt>$lc_ctype = $term->locale</dt>
- <dd>
- <p>Returns the LC_CTYPE category string used by this rxvt-unicode.</p>
- </dd>
- <dt>$env = $term->env</dt>
- <dd>
- <p>Returns a copy of the environment in effect for the terminal as a hashref
-similar to <code>\%ENV</code>.</p>
- </dd>
- <dt>@envv = $term->envv</dt>
- <dd>
- <p>Returns the environment as array of strings of the form <code>VAR=VALUE</code>.</p>
- </dd>
- <dt>@argv = $term->argv</dt>
- <dd>
- <p>Return the argument vector as this terminal, similar to @ARGV, but
-includes the program name as first element.</p>
- </dd>
- <dt>$modifiermask = $term->ModLevel3Mask</dt>
- <dt>$modifiermask = $term->ModMetaMask</dt>
- <dt>$modifiermask = $term->ModNumLockMask</dt>
- <dd>
- <p>Return the modifier masks corresponding to the "ISO Level 3 Shift" (often
-AltGr), the meta key (often Alt) and the num lock key, if applicable.</p>
- </dd>
- <dt>$screen = $term->current_screen</dt>
- <dd>
- <p>Returns the currently displayed screen (0 primary, 1 secondary).</p>
- </dd>
- <dt>$cursor_is_hidden = $term->hidden_cursor</dt>
- <dd>
- <p>Returns whether the cursor is currently hidden or not.</p>
- </dd>
- <dt>$view_start = $term->view_start ([$newvalue])</dt>
- <dd>
- <p>Returns the row number of the topmost displayed line. Maximum value is
-<code>0</code>, which displays the normal terminal contents. Lower values scroll
-this many lines into the scrollback buffer.</p>
- </dd>
- <dt>$term->want_refresh</dt>
- <dd>
- <p>Requests a screen refresh. At the next opportunity, rxvt-unicode will
-compare the on-screen display with its stored representation. If they
-differ, it redraws the differences.</p>
- <p>Used after changing terminal contents to display them.</p>
- </dd>
- <dt>$text = $term->ROW_t ($row_number[, $new_text[, $start_col]])</dt>
- <dd>
- <p>Returns the text of the entire row with number <code>$row_number</code>. Row <code>0</code>
-is the topmost terminal line, row <code>$term->$ncol-1</code> is the bottommost
-terminal line. The scrollback buffer starts at line <code>-1</code> and extends to
-line <code>-$term->nsaved</code>. Nothing will be returned if a nonexistent line
-is requested.</p>
- <p>If <code>$new_text</code> is specified, it will replace characters in the current
-line, starting at column <code>$start_col</code> (default <code>0</code>), which is useful
-to replace only parts of a line. The font index in the rendition will
-automatically be updated.</p>
- <p><code>$text</code> is in a special encoding: tabs and wide characters that use more
-than one cell when displayed are padded with <code>$urxvt::NOCHAR</code> (chr 65535)
-characters. Characters with combining characters and other characters that
-do not fit into the normal tetx encoding will be replaced with characters
-in the private use area.</p>
- <p>You have to obey this encoding when changing text. The advantage is
-that <code>substr</code> and similar functions work on screen cells and not on
-characters.</p>
- <p>The methods <code>$term->special_encode</code> and <code>$term->special_decode</code>
-can be used to convert normal strings into this encoding and vice versa.</p>
- </dd>
- <dt>$rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])</dt>
- <dd>
- <p>Like <code>$term->ROW_t</code>, but returns an arrayref with rendition
-bitsets. Rendition bitsets contain information about colour, font, font
-styles and similar information. See also <code>$term->ROW_t</code>.</p>
- <p>When setting rendition, the font mask will be ignored.</p>
- <p>See the section on RENDITION, above.</p>
- </dd>
- <dt>$length = $term->ROW_l ($row_number[, $new_length])</dt>
- <dd>
- <p>Returns the number of screen cells that are in use ("the line
-length"). Unlike the urxvt core, this returns <code>$term->ncol</code> if the
-line is joined with the following one.</p>
- </dd>
- <dt>$bool = $term->is_longer ($row_number)</dt>
- <dd>
- <p>Returns true if the row is part of a multiple-row logical "line" (i.e.
-joined with the following row), which means all characters are in use
-and it is continued on the next row (and possibly a continuation of the
-previous row(s)).</p>
- </dd>
- <dt>$line = $term->line ($row_number)</dt>
- <dd>
- <p>Create and return a new <code>urxvt::line</code> object that stores information
-about the logical line that row <code>$row_number</code> is part of. It supports the
-following methods:</p>
- <p>
- <dl>
- <dt>$text = $line->t ([$new_text])</dt>
- <dd>
- <p>Returns or replaces the full text of the line, similar to <code>ROW_t</code></p>
- </dd>
- <dt>$rend = $line->r ([$new_rend])</dt>
- <dd>
- <p>Returns or replaces the full rendition array of the line, similar to <code>ROW_r</code></p>
- </dd>
- <dt>$length = $line->l</dt>
- <dd>
- <p>Returns the length of the line in cells, similar to <code>ROW_l</code>.</p>
- </dd>
- <dt>$rownum = $line->beg</dt>
- <dt>$rownum = $line->end</dt>
- <dd>
- <p>Return the row number of the first/last row of the line, respectively.</p>
- </dd>
- <dt>$offset = $line->offset_of ($row, $col)</dt>
- <dd>
- <p>Returns the character offset of the given row|col pair within the logical
-line. Works for rows outside the line, too, and returns corresponding
-offsets outside the string.</p>
- </dd>
- <dt>($row, $col) = $line->coord_of ($offset)</dt>
- <dd>
- <p>Translates a string offset into terminal coordinates again.</p>
- </dd>
- </dl>
- </p>
- </dd>
- <dt>$text = $term->special_encode $string</dt>
- <dd>
- <p>Converts a perl string into the special encoding used by rxvt-unicode,
-where one character corresponds to one screen cell. See
-<code>$term->ROW_t</code> for details.</p>
- </dd>
- <dt>$string = $term->special_decode $text</dt>
- <dd>
- <p>Converts rxvt-unicodes text representation into a perl string. See
-<code>$term->ROW_t</code> for details.</p>
- </dd>
- <dt>$success = $term->grab_button ($button, $modifiermask[, $window = $term->vt])</dt>
- <dt>$term->ungrab_button ($button, $modifiermask[, $window = $term->vt])</dt>
- <dd>
- <p>Register/unregister a synchronous button grab. See the XGrabButton
-manpage.</p>
- </dd>
- <dt>$success = $term->grab ($eventtime[, $sync])</dt>
- <dd>
- <p>Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
-synchronous (<code>$sync</code> is true). Also remembers the grab timestamp.</p>
- </dd>
- <dt>$term->allow_events_async</dt>
- <dd>
- <p>Calls XAllowEvents with AsyncBoth for the most recent grab.</p>
- </dd>
- <dt>$term->allow_events_sync</dt>
- <dd>
- <p>Calls XAllowEvents with SyncBoth for the most recent grab.</p>
- </dd>
- <dt>$term->allow_events_replay</dt>
- <dd>
- <p>Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for the most
-recent grab.</p>
- </dd>
- <dt>$term->ungrab</dt>
- <dd>
- <p>Calls XUngrab for the most recent grab. Is called automatically on
-evaluation errors, as it is better to lose the grab in the error case as
-the session.</p>
- </dd>
- <dt>$atom = $term->XInternAtom ($atom_name[, $only_if_exists])</dt>
- <dt>$atom_name = $term->XGetAtomName ($atom)</dt>
- <dt>@atoms = $term->XListProperties ($window)</dt>
- <dt>($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)</dt>
- <dt>$term->XChangeWindowProperty ($window, $property, $type, $format, $octets)</dt>
- <dt>$term->XDeleteProperty ($window, $property)</dt>
- <dt>$window = $term->DefaultRootWindow</dt>
- <dt>$term->XReparentWindow ($window, $parent, [$x, $y])</dt>
- <dt>$term->XMapWindow ($window)</dt>
- <dt>$term->XUnmapWindow ($window)</dt>
- <dt>$term->XMoveResizeWindow ($window, $x, $y, $width, $height)</dt>
- <dt>($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x, $y)</dt>
- <dt>$term->XChangeInput ($window, $add_events[, $del_events])</dt>
- <dd>
- <p>Various X or X-related functions. The <code>$term</code> object only serves as
-the source of the display, otherwise those functions map more-or-less
-directory onto the X functions of the same name.</p>
- </dd>
-</dl>
-
-</div>
-<h2 id="The_code_urxvt_popup_code_Class">The <code>urxvt::popup</code> Class</h2>
-<div id="The_code_urxvt_popup_code_Class_CONT">
-<dl>
- <dt>$popup->add_title ($title)</dt>
- <dd>
- <p>Adds a non-clickable title to the popup.</p>
- </dd>
- <dt>$popup->add_separator ([$sepchr])</dt>
- <dd>
- <p>Creates a separator, optionally using the character given as <code>$sepchr</code>.</p>
- </dd>
- <dt>$popup->add_button ($text, $cb)</dt>
- <dd>
- <p>Adds a clickable button to the popup. <code>$cb</code> is called whenever it is
-selected.</p>
- </dd>
- <dt>$popup->add_toggle ($text, $initial_value, $cb)</dt>
- <dd>
- <p>Adds a toggle/checkbox item to the popup. The callback gets called
-whenever it gets toggled, with a boolean indicating its new value as its
-first argument.</p>
- </dd>
- <dt>$popup->show</dt>
- <dd>
- <p>Displays the popup (which is initially hidden).</p>
- </dd>
-</dl>
-
-</div>
-<h2 id="The_code_urxvt_timer_code_Class">The <code>urxvt::timer</code> Class</h2>
-<div id="The_code_urxvt_timer_code_Class_CONT">
-<p>This class implements timer watchers/events. Time is represented as a
-fractional number of seconds since the epoch. Example:</p>
-<pre> $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
- $term->{timer} = urxvt::timer
- ->new
- ->interval (1)
- ->cb (sub {
- $term->{overlay}->set (0, 0,
- sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
- });
-
-</pre>
-<dl>
- <dt>$timer = new urxvt::timer</dt>
- <dd>
- <p>Create a new timer object in started state. It is scheduled to fire
-immediately.</p>
- </dd>
- <dt>$timer = $timer->cb (sub { my ($timer) = @_; ... })</dt>
- <dd>
- <p>Set the callback to be called when the timer triggers.</p>
- </dd>
- <dt>$tstamp = $timer->at</dt>
- <dd>
- <p>Return the time this watcher will fire next.</p>
- </dd>
- <dt>$timer = $timer->set ($tstamp)</dt>
- <dd>
- <p>Set the time the event is generated to $tstamp.</p>
- </dd>
- <dt>$timer = $timer->interval ($interval)</dt>
- <dd>
- <p>Normally (and when <code>$interval</code> is <code>0</code>), the timer will automatically
-stop after it has fired once. If <code>$interval</code> is non-zero, then the timer
-is automatically rescheduled at the given intervals.</p>
- </dd>
- <dt>$timer = $timer->start</dt>
- <dd>
- <p>Start the timer.</p>
- </dd>
- <dt>$timer = $timer->start ($tstamp)</dt>
- <dd>
- <p>Set the event trigger time to <code>$tstamp</code> and start the timer.</p>
- </dd>
- <dt>$timer = $timer->after ($delay)</dt>
- <dd>
- <p>Like <code>start</code>, but sets the expiry timer to c<urxvt::NOW + $delay>.</p>
- </dd>
- <dt>$timer = $timer->stop</dt>
- <dd>
- <p>Stop the timer.</p>
- </dd>
-</dl>
-
-</div>
-<h2 id="The_code_urxvt_iow_code_Class">The <code>urxvt::iow</code> Class</h2>
-<div id="The_code_urxvt_iow_code_Class_CONTEN">
-<p>This class implements io watchers/events. Example:</p>
-<pre> $term->{socket} = ...
- $term->{iow} = urxvt::iow
- ->new
- ->fd (fileno $term->{socket})
- ->events (urxvt::EV_READ)
- ->start
- ->cb (sub {
- my ($iow, $revents) = @_;
- # $revents must be 1 here, no need to check
- sysread $term->{socket}, my $buf, 8192
- or end-of-file;
- });
-
-
-
-
-</pre>
-<dl>
- <dt>$iow = new urxvt::iow</dt>
- <dd>
- <p>Create a new io watcher object in stopped state.</p>
- </dd>
- <dt>$iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })</dt>
- <dd>
- <p>Set the callback to be called when io events are triggered. <code>$reventmask</code>
-is a bitset as described in the <code>events</code> method.</p>
- </dd>
- <dt>$iow = $iow->fd ($fd)</dt>
- <dd>
- <p>Set the file descriptor (not handle) to watch.</p>
- </dd>
- <dt>$iow = $iow->events ($eventmask)</dt>
- <dd>
- <p>Set the event mask to watch. The only allowed values are
-<code>urxvt::EV_READ</code> and <code>urxvt::EV_WRITE</code>, which might be ORed
-together, or <code>urxvt::EV_NONE</code>.</p>
- </dd>
- <dt>$iow = $iow->start</dt>
- <dd>
- <p>Start watching for requested events on the given handle.</p>
- </dd>
- <dt>$iow = $iow->stop</dt>
- <dd>
- <p>Stop watching for events on the given file handle.</p>
- </dd>
-</dl>
-
-</div>
-<h2 id="The_code_urxvt_iw_code_Class">The <code>urxvt::iw</code> Class</h2>
-<div id="The_code_urxvt_iw_code_Class_CONTENT">
-<p>This class implements idle watchers, that get called automatically when
-the process is idle. They should return as fast as possible, after doing
-some useful work.</p>
-<dl>
- <dt>$iw = new urxvt::iw</dt>
- <dd>
- <p>Create a new idle watcher object in stopped state.</p>
- </dd>
- <dt>$iw = $iw->cb (sub { my ($iw) = @_; ... })</dt>
- <dd>
- <p>Set the callback to be called when the watcher triggers.</p>
- </dd>
- <dt>$timer = $timer->start</dt>
- <dd>
- <p>Start the watcher.</p>
- </dd>
- <dt>$timer = $timer->stop</dt>
- <dd>
- <p>Stop the watcher.</p>
- </dd>
-</dl>
-
-</div>
-<h2 id="The_code_urxvt_pw_code_Class">The <code>urxvt::pw</code> Class</h2>
-<div id="The_code_urxvt_pw_code_Class_CONTENT">
-<p>This class implements process watchers. They create an event whenever a
-process exits, after which they stop automatically.</p>
-<pre> my $pid = fork;
- ...
- $term->{pw} = urxvt::pw
- ->new
- ->start ($pid)
- ->cb (sub {
- my ($pw, $exit_status) = @_;
- ...
- });
-
-</pre>
-<dl>
- <dt>$pw = new urxvt::pw</dt>
- <dd>
- <p>Create a new process watcher in stopped state.</p>
- </dd>
- <dt>$pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })</dt>
- <dd>
- <p>Set the callback to be called when the timer triggers.</p>
- </dd>
- <dt>$pw = $timer->start ($pid)</dt>
- <dd>
- <p>Tells the watcher to start watching for process <code>$pid</code>.</p>
- </dd>
- <dt>$pw = $pw->stop</dt>
- <dd>
- <p>Stop the watcher.</p>
- </dd>
-</dl>
-
-</div>
-<h1 id="ENVIRONMENT">ENVIRONMENT</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="ENVIRONMENT_CONTENT">
-
-</div>
-<h2 id="URXVT_PERL_VERBOSITY">URXVT_PERL_VERBOSITY</h2>
-<div id="URXVT_PERL_VERBOSITY_CONTENT">
-<p>This variable controls the verbosity level of the perl extension. Higher
-numbers indicate more verbose output.</p>
-<dl>
- <dt>== 0 - fatal messages</dt>
- <dt>>= 3 - script loading and management</dt>
- <dt>>=10 - all called hooks</dt>
- <dt>>=11 - hook return values</dt>
-</dl>
-
-</div>
-<h1 id="AUTHOR">AUTHOR</h1><p><a href="#TOP" class="toplink">Top</a></p>
-<div id="AUTHOR_CONTENT">
-<pre> Marc Lehmann <pcg@goof.com>
- http://software.schmorp.de/pkg/rxvt-unicode
-
-</pre>
-
-</div>
-</div></body>
-</html>
+++ /dev/null
-NAME
- rxvtperl - rxvt-unicode's embedded perl interpreter
-
-SYNOPSIS
- # create a file grab_test in $HOME:
-
- sub on_sel_grab {
- warn "you selected ", $_[0]->selection;
- ()
- }
-
- # start a rxvt using it:
-
- rxvt --perl-lib $HOME -pe grab_test
-
-DESCRIPTION
- Every time a terminal object gets created, extension scripts specified
- via the "perl" resource are loaded and associated with it.
-
- Scripts are compiled in a 'use strict' and 'use utf8' environment, and
- thus must be encoded as UTF-8.
-
- Each script will only ever be loaded once, even in rxvtd, where scripts
- will be shared (but not enabled) for all terminals.
-
- You can disable the embedded perl interpreter by setting both "perl-ext"
- and "perl-ext-common" resources to the empty string.
-
-PREPACKAGED EXTENSIONS
- This section describes the extensions delivered with this release. You
- can find them in /opt/rxvt/lib/urxvt/perl/.
-
- You can activate them like this:
-
- rxvt -pe <extensionname>
-
- Or by adding them to the resource for extensions loaded by default:
-
- URxvt.perl-ext-common: default,selection-autotransform
-
- selection (enabled by default)
- (More) intelligent selection. This extension tries to be more
- intelligent when the user extends selections (double-click and
- further clicks). Right now, it tries to select words, urls and
- complete shell-quoted arguments, which is very convenient, too, if
- your ls supports "--quoting-style=shell".
-
- A double-click usually selects the word under the cursor, further
- clicks will enlarge the selection.
-
- The selection works by trying to match a number of regexes and
- displaying them in increasing order of length. You can add your own
- regexes by specifying resources of the form:
-
- URxvt.selection.pattern-0: perl-regex
- URxvt.selection.pattern-1: perl-regex
- ...
-
- The index number (0, 1...) must not have any holes, and each regex
- must contain at least one pair of capturing parentheses, which will
- be used for the match. For example, the following adds a regex that
- matches everything between two vertical bars:
-
- URxvt.selection.pattern-0: \\|([^|]+)\\|
-
- Another example: Programs I use often output "absolute path: " at
- the beginning of a line when they process multiple files. The
- following pattern matches the filename (note, there is a single
- space at the very end):
-
- URxvt.selection.pattern-0: ^(/[^:]+):\
-
- You can look at the source of the selection extension to see more
- interesting uses, such as parsing a line from beginning to end.
-
- This extension also offers following bindable keyboard commands:
-
- rot13
- Rot-13 the selection when activated. Used via keyboard trigger:
-
- URxvt.keysym.C-M-r: perl:selection:rot13
-
- option-popup (enabled by default)
- Binds a popup menu to Ctrl-Button2 that lets you toggle (some)
- options at runtime.
-
- Other extensions can extend this popup menu by pushing a code
- reference onto "@{ $term-"{option_popup_hook} }>, which gets called
- whenever the popup is being displayed.
-
- Its sole argument is the popup menu, which can be modified. It
- should either return nothing or a string, the initial boolean value
- and a code reference. The string will be used as button text and the
- code reference will be called when the toggle changes, with the new
- boolean value as first argument.
-
- The following will add an entry "myoption" that changes
- "$self-"{myoption}>:
-
- push @{ $self->{term}{option_popup_hook} }, sub {
- ("my option" => $myoption, sub { $self->{myoption} = $_[0] })
- };
-
- selection-popup (enabled by default)
- Binds a popup menu to Ctrl-Button3 that lets you convert the
- selection text into various other formats/action (such as uri
- unescaping, perl evaluation, web-browser starting etc.), depending
- on content.
-
- Other extensions can extend this popup menu by pushing a code
- reference onto "@{ $term-"{selection_popup_hook} }>, which gets
- called whenever the popup is being displayed.
-
- Its sole argument is the popup menu, which can be modified. The
- selection is in $_, which can be used to decide whether to add
- something or not. It should either return nothing or a string and a
- code reference. The string will be used as button text and the code
- reference will be called when the button gets activated and should
- transform $_.
-
- The following will add an entry "a to b" that transforms all "a"s in
- the selection to "b"s, but only if the selection currently contains
- any "a"s:
-
- push @{ $self->{term}{selection_popup_hook} }, sub {
- /a/ ? ("a to b" => sub { s/a/b/g }
- : ()
- };
-
- searchable-scrollback<hotkey> (enabled by default)
- Adds regex search functionality to the scrollback buffer, triggered
- by a hotkey (default: "M-s"). While in search mode, normal terminal
- input/output is suspended and a regex is displayed at the bottom of
- the screen.
-
- Inputting characters appends them to the regex and continues
- incremental search. "BackSpace" removes a character from the regex,
- "Up" and "Down" search upwards/downwards in the scrollback buffer,
- "End" jumps to the bottom. "Escape" leaves search mode and returns
- to the point where search was started, while "Enter" or "Return"
- stay at the current position and additionally stores the first match
- in the current line into the primary selection if the "Shift"
- modifier is active.
-
- The regex defaults to "(?i)", resulting in a case-insensitive
- search. To get a case-sensitive search you can delete this prefix
- using "BackSpace" or simply use an uppercase character which removes
- the "(?i)" prefix.
-
- See perlre for more info about perl regular expression syntax.
-
- readline (enabled by default)
- A support package that tries to make editing with readline easier.
- At the moment, it reacts to clicking shift-left mouse button by
- trying to move the text cursor to this position. It does so by
- generating as many cursor-left or cursor-right keypresses as
- required (the this only works for programs that correctly support
- wide characters).
-
- To avoid too many false positives, this is only done when:
-
- - the tty is in ICANON state.
- - the text cursor is visible.
- - the primary screen is currently being displayed.
- - the mouse is on the same (multi-row-) line as the text cursor.
-
- The normal selection mechanism isn't disabled, so quick successive
- clicks might interfere with selection creation in harmless ways.
-
- selection-autotransform
- This selection allows you to do automatic transforms on a selection
- whenever a selection is made.
-
- It works by specifying perl snippets (most useful is a single "s///"
- operator) that modify $_ as resources:
-
- URxvt.selection-autotransform.0: transform
- URxvt.selection-autotransform.1: transform
- ...
-
- For example, the following will transform selections of the form
- "filename:number", often seen in compiler messages, into "vi
- +$filename $word":
-
- URxvt.selection-autotransform.0: s/^([^:[:space:]]+):(\\d+):?$/vi +$2 \\Q$1\\E\\x0d/
-
- And this example matches the same,but replaces it with vi-commands
- you can paste directly into your (vi :) editor:
-
- URxvt.selection-autotransform.0: s/^([^:[:space:]]+(\\d+):?$/:e \\Q$1\\E\\x0d:$2\\x0d/
-
- Of course, this can be modified to suit your needs and your editor
- :)
-
- To expand the example above to typical perl error messages ("XXX at
- FILENAME line YYY."), you need a slightly more elaborate solution:
-
- URxvt.selection.pattern-0: ( at .*? line \\d+[,.])
- URxvt.selection-autotransform.0: s/^ at (.*?) line (\\d+)[,.]$/:e \\Q$1\E\\x0d:$2\\x0d/
-
- The first line tells the selection code to treat the unchanging part
- of every error message as a selection pattern, and the second line
- transforms the message into vi commands to load the file.
-
- tabbed
- This transforms the terminal into a tabbar with additional
- terminals, that is, it implements what is commonly referred to as
- "tabbed terminal". The topmost line displays a "[NEW]" button,
- which, when clicked, will add a new tab, followed by one button per
- tab.
-
- Clicking a button will activate that tab. Pressing Shift-Left and
- Shift-Right will switch to the tab left or right of the current one,
- while Shift-Down creates a new tab.
-
- The tabbar itself can be configured similarly to a normal terminal,
- but with a resource class of "URxvt.tabbed". In addition, it
- supports the following four resources (shown with defaults):
-
- URxvt.tabbed.tabbar-fg: <colour-index, default 3>
- URxvt.tabbed.tabbar-bg: <colour-index, default 0>
- URxvt.tabbed.tab-fg: <colour-index, default 0>
- URxvt.tabbed.tab-bg: <colour-index, default 1>
-
- See *COLOR AND GRAPHICS* in the rxvt(1) manpage for valid indices.
-
- matcher
- Uses per-line display filtering ("on_line_update") to underline text
- matching a certain pattern and make it clickable. When clicked with
- the mouse button specified in the "matcher.button" resource (default
- 2, or middle), the program specified in the "matcher.launcher"
- resource (default, the "urlLauncher" resource, "sensible-browser")
- will be started with the matched text as first argument. The default
- configuration is suitable for matching URLs and launching a web
- browser, like the former "mark-urls" extension.
-
- The default pattern to match URLs can be overridden with the
- "matcher.pattern.0" resource, and additional patterns can be
- specified with numbered patterns, in a manner similar to the
- "selection" extension. The launcher can also be overridden on a
- per-pattern basis.
-
- It is possible to activate the most recently seen match from the
- keyboard. Simply bind a keysym to "perl:matcher" as seen in the
- example below.
-
- Example configuration:
-
- URxvt.perl-ext: default,matcher
- URxvt.urlLauncher: sensible-browser
- URxvt.keysym.C-Delete: perl:matcher
- URxvt.matcher.button: 1
- URxvt.matcher.pattern.1: \\bwww\\.[\\w-]+\\.[\\w./?&@#-]*[\\w/-]
- URxvt.matcher.pattern.2: \\B(/\\S+?):(\\d+)(?=:|$)
- URxvt.matcher.launcher.2: gvim +$2 $1
-
- xim-onthespot
- This (experimental) perl extension implements OnTheSpot editing. It
- does not work perfectly, and some input methods don't seem to work
- well with OnTheSpot editing in general, but it seems to work at
- least for SCIM and kinput2.
-
- You enable it by specifying this extension and a preedit style of
- "OnTheSpot", i.e.:
-
- rxvt -pt OnTheSpot -pe xim-onthespot
-
- kuake<hotkey>
- A very primitive quake-console-like extension. It was inspired by a
- description of how the programs "kuake" and "yakuake" work: Whenever
- the user presses a global accelerator key (by default "F10"), the
- terminal will show or hide itself. Another press of the accelerator
- key will hide or show it again.
-
- Initially, the window will not be shown when using this extension.
-
- This is useful if you need a single terminal that is not using any
- desktop space most of the time but is quickly available at the press
- of a key.
-
- The accelerator key is grabbed regardless of any modifiers, so this
- extension will actually grab a physical key just for this function.
-
- If you want a quake-like animation, tell your window manager to do
- so (fvwm can do it).
-
- block-graphics-to-ascii
- A not very useful example of filtering all text output to the
- terminal by replacing all line-drawing characters (U+2500 .. U+259F)
- by a similar-looking ascii character.
-
- digital-clock
- Displays a digital clock using the built-in overlay.
-
- remote-clipboard
- Somewhat of a misnomer, this extension adds two menu entries to the
- selection popup that allows one to run external commands to store
- the selection somewhere and fetch it again.
-
- We use it to implement a "distributed selection mechanism", which
- just means that one command uploads the file to a remote server, and
- another reads it.
-
- The commands can be set using the "URxvt.remote-selection.store" and
- "URxvt.remote-selection.fetch" resources. The first should read the
- selection to store from STDIN (always in UTF-8), the second should
- provide the selection data on STDOUT (also in UTF-8).
-
- The defaults (which are likely useless to you) use rsh and cat:
-
- URxvt.remote-selection.store: rsh ruth 'cat >/tmp/distributed-selection'
- URxvt.remote-selection.fetch: rsh ruth 'cat /tmp/distributed-selection'
-
- selection-pastebin
- This is a little rarely useful extension that Uploads the selection
- as textfile to a remote site (or does other things). (The
- implementation is not currently secure for use in a multiuser
- environment as it writes to /tmp directly.).
-
- It listens to the "selection-pastebin:remote-pastebin" keyboard
- command, i.e.
-
- URxvt.keysym.C-M-e: perl:selection-pastebin:remote-pastebin
-
- Pressing this combination runs a command with "%" replaced by the
- name of the textfile. This command can be set via a resource:
-
- URxvt.selection-pastebin.cmd: rsync -apP % ruth:/var/www/www.ta-sa.org/files/txt/.
-
- And the default is likely not useful to anybody but the few people
- around here :)
-
- The name of the textfile is the hex encoded md5 sum of the
- selection, so the same content should lead to the same filename.
-
- After a successful upload the selection will be replaced by the text
- given in the "selection-pastebin-url" resource (again, the % is the
- placeholder for the filename):
-
- URxvt.selection-pastebin.url: http://www.ta-sa.org/files/txt/%
-
- *Note to xrdb users:* xrdb uses the C preprocessor, which might
- interpret the double "/" characters as comment start. Use "\057\057"
- instead, which works regardless of wether xrdb is used to parse the
- resource file or not.
-
- example-refresh-hooks
- Displays a very simple digital clock in the upper right corner of
- the window. Illustrates overwriting the refresh callbacks to create
- your own overlays or changes.
-
-API DOCUMENTATION
- General API Considerations
- All objects (such as terminals, time watchers etc.) are typical
- reference-to-hash objects. The hash can be used to store anything you
- like. All members starting with an underscore (such as "_ptr" or
- "_hook") are reserved for internal uses and MUST NOT be accessed or
- modified).
-
- When objects are destroyed on the C++ side, the perl object hashes are
- emptied, so its best to store related objects such as time watchers and
- the like inside the terminal object so they get destroyed as soon as the
- terminal is destroyed.
-
- Argument names also often indicate the type of a parameter. Here are
- some hints on what they mean:
-
- $text
- Rxvt-unicodes special way of encoding text, where one "unicode"
- character always represents one screen cell. See ROW_t for a
- discussion of this format.
-
- $string
- A perl text string, with an emphasis on *text*. It can store all
- unicode characters and is to be distinguished with text encoded in a
- specific encoding (often locale-specific) and binary data.
-
- $octets
- Either binary data or - more common - a text string encoded in a
- locale-specific way.
-
- Extension Objects
- Every perl extension is a perl class. A separate perl object is created
- for each terminal, and each terminal has its own set of extenion
- objects, which are passed as the first parameter to hooks. So extensions
- can use their $self object without having to think about clashes with
- other extensions or other terminals, with the exception of methods and
- members that begin with an underscore character "_": these are reserved
- for internal use.
-
- Although it isn't a "urxvt::term" object, you can call all methods of
- the "urxvt::term" class on this object.
-
- It has the following methods and data members:
-
- $urxvt_term = $self->{term}
- Returns the "urxvt::term" object associated with this instance of
- the extension. This member *must not* be changed in any way.
-
- $self->enable ($hook_name => $cb, [$hook_name => $cb..])
- Dynamically enable the given hooks (named without the "on_" prefix)
- for this extension, replacing any previous hook. This is useful when
- you want to overwrite time-critical hooks only temporarily.
-
- $self->disable ($hook_name[, $hook_name..])
- Dynamically disable the given hooks.
-
- Hooks
- The following subroutines can be declared in extension files, and will
- be called whenever the relevant event happens.
-
- The first argument passed to them is an extension object as described in
- the in the "Extension Objects" section.
-
- All of these hooks must return a boolean value. If any of the called
- hooks returns true, then the event counts as being *consumed*, and the
- relevant action might not be carried out by the C++ code.
-
- *When in doubt, return a false value (preferably "()").*
-
- on_init $term
- Called after a new terminal object has been initialized, but before
- windows are created or the command gets run. Most methods are unsafe
- to call or deliver senseless data, as terminal size and other
- characteristics have not yet been determined. You can safely query
- and change resources and options, though. For many purposes the
- "on_start" hook is a better place.
-
- on_start $term
- Called at the very end of initialisation of a new terminal, just
- before trying to map (display) the toplevel and returning to the
- main loop.
-
- on_destroy $term
- Called whenever something tries to destroy terminal, when the
- terminal is still fully functional (not for long, though).
-
- on_reset $term
- Called after the screen is "reset" for any reason, such as resizing
- or control sequences. Here is where you can react on changes to
- size-related variables.
-
- on_child_start $term, $pid
- Called just after the child process has been "fork"ed.
-
- on_child_exit $term, $status
- Called just after the child process has exited. $status is the
- status from "waitpid".
-
- on_sel_make $term, $eventtime
- Called whenever a selection has been made by the user, but before
- the selection text is copied, so changes to the beginning, end or
- type of the selection will be honored.
-
- Returning a true value aborts selection making by urxvt, in which
- case you have to make a selection yourself by calling
- "$term->selection_grab".
-
- on_sel_grab $term, $eventtime
- Called whenever a selection has been copied, but before the
- selection is requested from the server. The selection text can be
- queried and changed by calling "$term->selection".
-
- Returning a true value aborts selection grabbing. It will still be
- highlighted.
-
- on_sel_extend $term
- Called whenever the user tries to extend the selection (e.g. with a
- double click) and is either supposed to return false (normal
- operation), or should extend the selection itself and return true to
- suppress the built-in processing. This can happen multiple times, as
- long as the callback returns true, it will be called on every
- further click by the user and is supposed to enlarge the selection
- more and more, if possible.
-
- See the selection example extension.
-
- on_view_change $term, $offset
- Called whenever the view offset changes, i.e. the user or program
- scrolls. Offset 0 means display the normal terminal, positive values
- show this many lines of scrollback.
-
- on_scroll_back $term, $lines, $saved
- Called whenever lines scroll out of the terminal area into the
- scrollback buffer. $lines is the number of lines scrolled out and
- may be larger than the scroll back buffer or the terminal.
-
- It is called before lines are scrolled out (so rows 0 .. min ($lines
- - 1, $nrow - 1) represent the lines to be scrolled out). $saved is
- the total number of lines that will be in the scrollback buffer.
-
- on_osc_seq $term, $op, $args
- Called on every OSC sequence and can be used to suppress it or
- modify its behaviour. The default should be to return an empty list.
- A true value suppresses execution of the request completely. Make
- sure you don't get confused by recursive invocations when you output
- an osc sequence within this callback.
-
- "on_osc_seq_perl" should be used for new behaviour.
-
- on_osc_seq_perl $term, $string
- Called whenever the ESC ] 777 ; string ST command sequence (OSC =
- operating system command) is processed. Cursor position and other
- state information is up-to-date when this happens. For
- interoperability, the string should start with the extension name
- and a colon, to distinguish it from commands for other extensions,
- and this might be enforced in the future.
-
- Be careful not ever to trust (in a security sense) the data you
- receive, as its source can not easily be controlled (e-mail content,
- messages from other users on the same system etc.).
-
- on_add_lines $term, $string
- Called whenever text is about to be output, with the text as
- argument. You can filter/change and output the text yourself by
- returning a true value and calling "$term->scr_add_lines" yourself.
- Please note that this might be very slow, however, as your hook is
- called for all text being output.
-
- on_tt_write $term, $octets
- Called whenever some data is written to the tty/pty and can be used
- to suppress or filter tty input.
-
- on_line_update $term, $row
- Called whenever a line was updated or changed. Can be used to filter
- screen output (e.g. underline urls or other useless stuff). Only
- lines that are being shown will be filtered, and, due to performance
- reasons, not always immediately.
-
- The row number is always the topmost row of the line if the line
- spans multiple rows.
-
- Please note that, if you change the line, then the hook might get
- called later with the already-modified line (e.g. if unrelated parts
- change), so you cannot just toggle rendition bits, but only set
- them.
-
- on_refresh_begin $term
- Called just before the screen gets redrawn. Can be used for overlay
- or similar effects by modify terminal contents in refresh_begin, and
- restoring them in refresh_end. The built-in overlay and selection
- display code is run after this hook, and takes precedence.
-
- on_refresh_end $term
- Called just after the screen gets redrawn. See "on_refresh_begin".
-
- on_user_command $term, $string
- Called whenever a user-configured event is being activated (e.g. via
- a "perl:string" action bound to a key, see description of the keysym
- resource in the rxvt(1) manpage).
-
- The event is simply the action string. This interface is assumed to
- change slightly in the future.
-
- on_resize_all_windows $tern, $new_width, $new_height
- Called just after the new window size has been calculated, but
- before windows are actually being resized or hints are being set. If
- this hook returns TRUE, setting of the window hints is being
- skipped.
-
- on_x_event $term, $event
- Called on every X event received on the vt window (and possibly
- other windows). Should only be used as a last resort. Most event
- structure members are not passed.
-
- on_root_event $term, $event
- Like "on_x_event", but is called for events on the root window.
-
- on_focus_in $term
- Called whenever the window gets the keyboard focus, before
- rxvt-unicode does focus in processing.
-
- on_focus_out $term
- Called whenever the window loses keyboard focus, before rxvt-unicode
- does focus out processing.
-
- on_configure_notify $term, $event
- on_property_notify $term, $event
- on_key_press $term, $event, $keysym, $octets
- on_key_release $term, $event, $keysym
- on_button_press $term, $event
- on_button_release $term, $event
- on_motion_notify $term, $event
- on_map_notify $term, $event
- on_unmap_notify $term, $event
- Called whenever the corresponding X event is received for the
- terminal If the hook returns true, then the even will be ignored by
- rxvt-unicode.
-
- The event is a hash with most values as named by Xlib (see the
- XEvent manpage), with the additional members "row" and "col", which
- are the (real, not screen-based) row and column under the mouse
- cursor.
-
- "on_key_press" additionally receives the string rxvt-unicode would
- output, if any, in locale-specific encoding.
-
- subwindow.
-
- on_client_message $term, $event
- on_wm_protocols $term, $event
- on_wm_delete_window $term, $event
- Called when various types of ClientMessage events are received (all
- with format=32, WM_PROTOCOLS or WM_PROTOCOLS:WM_DELETE_WINDOW).
-
- Variables in the "urxvt" Package
- $urxvt::LIBDIR
- The rxvt-unicode library directory, where, among other things, the
- perl modules and scripts are stored.
-
- $urxvt::RESCLASS, $urxvt::RESCLASS
- The resource class and name rxvt-unicode uses to look up X
- resources.
-
- $urxvt::RXVTNAME
- The basename of the installed binaries, usually "urxvt".
-
- $urxvt::TERM
- The current terminal. This variable stores the current "urxvt::term"
- object, whenever a callback/hook is executing.
-
- @urxvt::TERM_INIT
- All code references in this array will be called as methods of the
- next newly created "urxvt::term" object (during the "on_init"
- phase). The array gets cleared before the code references that were
- in it are being executed, so references can push themselves onto it
- again if they so desire.
-
- This complements to the perl-eval command line option, but gets
- executed first.
-
- @urxvt::TERM_EXT
- Works similar to @TERM_INIT, but contains perl package/class names,
- which get registered as normal extensions after calling the hooks in
- @TERM_INIT but before other extensions. Gets cleared just like
- @TERM_INIT.
-
- Functions in the "urxvt" Package
- urxvt::fatal $errormessage
- Fatally aborts execution with the given error message. Avoid at all
- costs! The only time this is acceptable is when the terminal process
- starts up.
-
- urxvt::warn $string
- Calls "rxvt_warn" with the given string which should not include a
- newline. The module also overwrites the "warn" builtin with a
- function that calls this function.
-
- Using this function has the advantage that its output ends up in the
- correct place, e.g. on stderr of the connecting urxvtc client.
-
- Messages have a size limit of 1023 bytes currently.
-
- @terms = urxvt::termlist
- Returns all urxvt::term objects that exist in this process,
- regardless of whether they are started, being destroyed etc., so be
- careful. Only term objects that have perl extensions attached will
- be returned (because there is no urxvt::term objet associated with
- others).
-
- $time = urxvt::NOW
- Returns the "current time" (as per the event loop).
-
- urxvt::CurrentTime
- urxvt::ShiftMask, LockMask, ControlMask, Mod1Mask, Mod2Mask, Mod3Mask,
- Mod4Mask, Mod5Mask, Button1Mask, Button2Mask, Button3Mask, Button4Mask,
- Button5Mask, AnyModifier
- urxvt::NoEventMask, KeyPressMask, KeyReleaseMask, ButtonPressMask,
- ButtonReleaseMask, EnterWindowMask, LeaveWindowMask, PointerMotionMask,
- PointerMotionHintMask, Button1MotionMask, Button2MotionMask,
- Button3MotionMask, Button4MotionMask, Button5MotionMask,
- ButtonMotionMask, KeymapStateMask, ExposureMask, VisibilityChangeMask,
- StructureNotifyMask, ResizeRedirectMask, SubstructureNotifyMask,
- SubstructureRedirectMask, FocusChangeMask, PropertyChangeMask,
- ColormapChangeMask, OwnerGrabButtonMask
- urxvt::KeyPress, KeyRelease, ButtonPress, ButtonRelease, MotionNotify,
- EnterNotify, LeaveNotify, FocusIn, FocusOut, KeymapNotify, Expose,
- GraphicsExpose, NoExpose, VisibilityNotify, CreateNotify, DestroyNotify,
- UnmapNotify, MapNotify, MapRequest, ReparentNotify, ConfigureNotify,
- ConfigureRequest, GravityNotify, ResizeRequest, CirculateNotify,
- CirculateRequest, PropertyNotify, SelectionClear, SelectionRequest,
- SelectionNotify, ColormapNotify, ClientMessage, MappingNotify
- Various constants for use in X calls and event processing.
-
- RENDITION
- Rendition bitsets contain information about colour, font, font styles
- and similar information for each screen cell.
-
- The following "macros" deal with changes in rendition sets. You should
- never just create a bitset, you should always modify an existing one, as
- they contain important information required for correct operation of
- rxvt-unicode.
-
- $rend = urxvt::DEFAULT_RSTYLE
- Returns the default rendition, as used when the terminal is starting
- up or being reset. Useful as a base to start when creating
- renditions.
-
- $rend = urxvt::OVERLAY_RSTYLE
- Return the rendition mask used for overlays by default.
-
- $rendbit = urxvt::RS_Bold, RS_Italic, RS_Blink, RS_RVid, RS_Uline
- Return the bit that enabled bold, italic, blink, reverse-video and
- underline, respectively. To enable such a style, just logically OR
- it into the bitset.
-
- $foreground = urxvt::GET_BASEFG $rend
- $background = urxvt::GET_BASEBG $rend
- Return the foreground/background colour index, respectively.
-
- $rend = urxvt::SET_FGCOLOR $rend, $new_colour
- $rend = urxvt::SET_BGCOLOR $rend, $new_colour
- $rend = urxvt::SET_COLOR $rend, $new_fg, $new_bg
- Replace the foreground/background colour in the rendition mask with
- the specified one.
-
- $value = urxvt::GET_CUSTOM $rend
- Return the "custom" value: Every rendition has 5 bits for use by
- extensions. They can be set and changed as you like and are
- initially zero.
-
- $rend = urxvt::SET_CUSTOM $rend, $new_value
- Change the custom value.
-
- The "urxvt::anyevent" Class
- The sole purpose of this class is to deliver an interface to the
- "AnyEvent" module - any module using it will work inside urxvt without
- further programming. The only exception is that you cannot wait on
- condition variables, but non-blocking condvar use is ok. What this means
- is that you cannot use blocking APIs, but the non-blocking variant
- should work.
-
- The "urxvt::term" Class
- $term = new urxvt::term $envhashref, $rxvtname, [arg...]
- Creates a new terminal, very similar as if you had started it with
- system "$rxvtname, arg...". $envhashref must be a reference to a
- %ENV-like hash which defines the environment of the new terminal.
-
- Croaks (and probably outputs an error message) if the new instance
- couldn't be created. Returns "undef" if the new instance didn't
- initialise perl, and the terminal object otherwise. The "init" and
- "start" hooks will be called before this call returns, and are free
- to refer to global data (which is race free).
-
- $term->destroy
- Destroy the terminal object (close the window, free resources etc.).
- Please note that rxvt will not exit as long as any event watchers
- (timers, io watchers) are still active.
-
- $term->exec_async ($cmd[, @args])
- Works like the combination of the "fork"/"exec" builtins, which
- executes ("starts") programs in the background. This function takes
- care of setting the user environment before exec'ing the command
- (e.g. "PATH") and should be preferred over explicit calls to "exec"
- or "system".
-
- Returns the pid of the subprocess or "undef" on error.
-
- $isset = $term->option ($optval[, $set])
- Returns true if the option specified by $optval is enabled, and
- optionally change it. All option values are stored by name in the
- hash %urxvt::OPTION. Options not enabled in this binary are not in
- the hash.
-
- Here is a likely non-exhaustive list of option names, please see the
- source file /src/optinc.h to see the actual list:
-
- borderLess console cursorBlink cursorUnderline hold iconic insecure
- intensityStyles jumpScroll loginShell mapAlert meta8 mouseWheelScrollPage
- override-redirect pastableTabs pointerBlank reverseVideo scrollBar
- scrollBar_floating scrollBar_right scrollTtyKeypress scrollTtyOutput
- scrollWithBuffer secondaryScreen secondaryScroll skipBuiltinGlyphs
- transparent tripleclickwords utmpInhibit visualBell
-
- $value = $term->resource ($name[, $newval])
- Returns the current resource value associated with a given name and
- optionally sets a new value. Setting values is most useful in the
- "init" hook. Unset resources are returned and accepted as "undef".
-
- The new value must be properly encoded to a suitable character
- encoding before passing it to this method. Similarly, the returned
- value may need to be converted from the used encoding to text.
-
- Resource names are as defined in src/rsinc.h. Colours can be
- specified as resource names of the form "color+<index>", e.g.
- "color+5". (will likely change).
-
- Please note that resource strings will currently only be freed when
- the terminal is destroyed, so changing options frequently will eat
- memory.
-
- Here is a likely non-exhaustive list of resource names, not all of
- which are supported in every build, please see the source file
- /src/rsinc.h to see the actual list:
-
- answerbackstring backgroundPixmap backspace_key boldFont boldItalicFont
- borderLess color cursorBlink cursorUnderline cutchars delete_key
- display_name embed ext_bwidth fade font geometry hold iconName
- imFont imLocale inputMethod insecure int_bwidth intensityStyles
- italicFont jumpScroll lineSpace loginShell mapAlert meta8 modifier
- mouseWheelScrollPage name override_redirect pastableTabs path perl_eval
- perl_ext_1 perl_ext_2 perl_lib pointerBlank pointerBlankDelay
- preeditType print_pipe pty_fd reverseVideo saveLines scrollBar
- scrollBar_align scrollBar_floating scrollBar_right scrollBar_thickness
- scrollTtyKeypress scrollTtyOutput scrollWithBuffer scrollstyle
- secondaryScreen secondaryScroll selectstyle shade term_name title
- transient_for transparent transparent_all tripleclickwords utmpInhibit
- visualBell
-
- $value = $term->x_resource ($pattern)
- Returns the X-Resource for the given pattern, excluding the program
- or class name, i.e. "$term->x_resource ("boldFont")" should return
- the same value as used by this instance of rxvt-unicode. Returns
- "undef" if no resource with that pattern exists.
-
- This method should only be called during the "on_start" hook, as
- there is only one resource database per display, and later
- invocations might return the wrong resources.
-
- $success = $term->parse_keysym ($keysym_spec, $command_string)
- Adds a keymap translation exactly as specified via a resource. See
- the "keysym" resource in the rxvt(1) manpage.
-
- $rend = $term->rstyle ([$new_rstyle])
- Return and optionally change the current rendition. Text that is
- output by the terminal application will use this style.
-
- ($row, $col) = $term->screen_cur ([$row, $col])
- Return the current coordinates of the text cursor position and
- optionally set it (which is usually bad as applications don't expect
- that).
-
- ($row, $col) = $term->selection_mark ([$row, $col])
- ($row, $col) = $term->selection_beg ([$row, $col])
- ($row, $col) = $term->selection_end ([$row, $col])
- Return the current values of the selection mark, begin or end
- positions, and optionally set them to new values.
-
- $term->selection_make ($eventtime[, $rectangular])
- Tries to make a selection as set by "selection_beg" and
- "selection_end". If $rectangular is true (default: false), a
- rectangular selection will be made. This is the prefered function to
- make a selection.
-
- $success = $term->selection_grab ($eventtime)
- Try to request the primary selection text from the server (for
- example, as set by the next method). No visual feedback will be
- given. This function is mostly useful from within "on_sel_grab"
- hooks.
-
- $oldtext = $term->selection ([$newtext])
- Return the current selection text and optionally replace it by
- $newtext.
-
- $term->overlay_simple ($x, $y, $text)
- Create a simple multi-line overlay box. See the next method for
- details.
-
- $term->overlay ($x, $y, $width, $height[, $rstyle[, $border]])
- Create a new (empty) overlay at the given position with the given
- width/height. $rstyle defines the initial rendition style (default:
- "OVERLAY_RSTYLE").
-
- If $border is 2 (default), then a decorative border will be put
- around the box.
-
- If either $x or $y is negative, then this is counted from the
- right/bottom side, respectively.
-
- This method returns an urxvt::overlay object. The overlay will be
- visible as long as the perl object is referenced.
-
- The methods currently supported on "urxvt::overlay" objects are:
-
- $overlay->set ($x, $y, $text, $rend)
- Similar to "$term->ROW_t" and "$term->ROW_r" in that it puts
- text in rxvt-unicode's special encoding and an array of
- rendition values at a specific position inside the overlay.
-
- $overlay->hide
- If visible, hide the overlay, but do not destroy it.
-
- $overlay->show
- If hidden, display the overlay again.
-
- $popup = $term->popup ($event)
- Creates a new "urxvt::popup" object that implements a popup menu.
- The $event *must* be the event causing the menu to pop up (a button
- event, currently).
-
- $cellwidth = $term->strwidth ($string)
- Returns the number of screen-cells this string would need. Correctly
- accounts for wide and combining characters.
-
- $octets = $term->locale_encode ($string)
- Convert the given text string into the corresponding locale
- encoding.
-
- $string = $term->locale_decode ($octets)
- Convert the given locale-encoded octets into a perl string.
-
- $term->scr_xor_span ($beg_row, $beg_col, $end_row, $end_col[, $rstyle])
- XORs the rendition values in the given span with the provided value
- (default: "RS_RVid"), which *MUST NOT* contain font styles. Useful
- in refresh hooks to provide effects similar to the selection.
-
- $term->scr_xor_rect ($beg_row, $beg_col, $end_row, $end_col[, $rstyle1[,
- $rstyle2]])
- Similar to "scr_xor_span", but xors a rectangle instead. Trailing
- whitespace will additionally be xored with the $rstyle2, which
- defaults to "RS_RVid | RS_Uline", which removes reverse video again
- and underlines it instead. Both styles *MUST NOT* contain font
- styles.
-
- $term->scr_bell
- Ring the bell!
-
- $term->scr_add_lines ($string)
- Write the given text string to the screen, as if output by the
- application running inside the terminal. It may not contain command
- sequences (escape codes), but is free to use line feeds, carriage
- returns and tabs. The string is a normal text string, not in
- locale-dependent encoding.
-
- Normally its not a good idea to use this function, as programs might
- be confused by changes in cursor position or scrolling. Its useful
- inside a "on_add_lines" hook, though.
-
- $term->scr_change_screen ($screen)
- Switch to given screen - 0 primary, 1 secondary.
-
- $term->cmd_parse ($octets)
- Similar to "scr_add_lines", but the argument must be in the
- locale-specific encoding of the terminal and can contain command
- sequences (escape codes) that will be interpreted.
-
- $term->tt_write ($octets)
- Write the octets given in $data to the tty (i.e. as program input).
- To pass characters instead of octets, you should convert your
- strings first to the locale-specific encoding using
- "$term->locale_encode".
-
- $old_events = $term->pty_ev_events ([$new_events])
- Replaces the event mask of the pty watcher by the given event mask.
- Can be used to suppress input and output handling to the pty/tty.
- See the description of "urxvt::timer->events". Make sure to always
- restore the previous value.
-
- $fd = $term->pty_fd
- Returns the master file descriptor for the pty in use, or -1 if no
- pty is used.
-
- $windowid = $term->parent
- Return the window id of the toplevel window.
-
- $windowid = $term->vt
- Return the window id of the terminal window.
-
- $term->vt_emask_add ($x_event_mask)
- Adds the specified events to the vt event mask. Useful e.g. when you
- want to receive pointer events all the times:
-
- $term->vt_emask_add (urxvt::PointerMotionMask);
-
- $term->focus_in
- $term->focus_out
- $term->key_press ($state, $keycode[, $time])
- $term->key_release ($state, $keycode[, $time])
- Deliver various fake events to to terminal.
-
- $window_width = $term->width
- $window_height = $term->height
- $font_width = $term->fwidth
- $font_height = $term->fheight
- $font_ascent = $term->fbase
- $terminal_rows = $term->nrow
- $terminal_columns = $term->ncol
- $has_focus = $term->focus
- $is_mapped = $term->mapped
- $max_scrollback = $term->saveLines
- $nrow_plus_saveLines = $term->total_rows
- $topmost_scrollback_row = $term->top_row
- Return various integers describing terminal characteristics.
-
- $x_display = $term->display_id
- Return the DISPLAY used by rxvt-unicode.
-
- $lc_ctype = $term->locale
- Returns the LC_CTYPE category string used by this rxvt-unicode.
-
- $env = $term->env
- Returns a copy of the environment in effect for the terminal as a
- hashref similar to "\%ENV".
-
- @envv = $term->envv
- Returns the environment as array of strings of the form "VAR=VALUE".
-
- @argv = $term->argv
- Return the argument vector as this terminal, similar to @ARGV, but
- includes the program name as first element.
-
- $modifiermask = $term->ModLevel3Mask
- $modifiermask = $term->ModMetaMask
- $modifiermask = $term->ModNumLockMask
- Return the modifier masks corresponding to the "ISO Level 3 Shift"
- (often AltGr), the meta key (often Alt) and the num lock key, if
- applicable.
-
- $screen = $term->current_screen
- Returns the currently displayed screen (0 primary, 1 secondary).
-
- $cursor_is_hidden = $term->hidden_cursor
- Returns whether the cursor is currently hidden or not.
-
- $view_start = $term->view_start ([$newvalue])
- Returns the row number of the topmost displayed line. Maximum value
- is 0, which displays the normal terminal contents. Lower values
- scroll this many lines into the scrollback buffer.
-
- $term->want_refresh
- Requests a screen refresh. At the next opportunity, rxvt-unicode
- will compare the on-screen display with its stored representation.
- If they differ, it redraws the differences.
-
- Used after changing terminal contents to display them.
-
- $text = $term->ROW_t ($row_number[, $new_text[, $start_col]])
- Returns the text of the entire row with number $row_number. Row 0 is
- the topmost terminal line, row "$term->$ncol-1" is the bottommost
- terminal line. The scrollback buffer starts at line -1 and extends
- to line "-$term->nsaved". Nothing will be returned if a nonexistent
- line is requested.
-
- If $new_text is specified, it will replace characters in the current
- line, starting at column $start_col (default 0), which is useful to
- replace only parts of a line. The font index in the rendition will
- automatically be updated.
-
- $text is in a special encoding: tabs and wide characters that use
- more than one cell when displayed are padded with $urxvt::NOCHAR
- (chr 65535) characters. Characters with combining characters and
- other characters that do not fit into the normal tetx encoding will
- be replaced with characters in the private use area.
-
- You have to obey this encoding when changing text. The advantage is
- that "substr" and similar functions work on screen cells and not on
- characters.
-
- The methods "$term->special_encode" and "$term->special_decode" can
- be used to convert normal strings into this encoding and vice versa.
-
- $rend = $term->ROW_r ($row_number[, $new_rend[, $start_col]])
- Like "$term->ROW_t", but returns an arrayref with rendition bitsets.
- Rendition bitsets contain information about colour, font, font
- styles and similar information. See also "$term->ROW_t".
-
- When setting rendition, the font mask will be ignored.
-
- See the section on RENDITION, above.
-
- $length = $term->ROW_l ($row_number[, $new_length])
- Returns the number of screen cells that are in use ("the line
- length"). Unlike the urxvt core, this returns "$term->ncol" if the
- line is joined with the following one.
-
- $bool = $term->is_longer ($row_number)
- Returns true if the row is part of a multiple-row logical "line"
- (i.e. joined with the following row), which means all characters are
- in use and it is continued on the next row (and possibly a
- continuation of the previous row(s)).
-
- $line = $term->line ($row_number)
- Create and return a new "urxvt::line" object that stores information
- about the logical line that row $row_number is part of. It supports
- the following methods:
-
- $text = $line->t ([$new_text])
- Returns or replaces the full text of the line, similar to
- "ROW_t"
-
- $rend = $line->r ([$new_rend])
- Returns or replaces the full rendition array of the line,
- similar to "ROW_r"
-
- $length = $line->l
- Returns the length of the line in cells, similar to "ROW_l".
-
- $rownum = $line->beg
- $rownum = $line->end
- Return the row number of the first/last row of the line,
- respectively.
-
- $offset = $line->offset_of ($row, $col)
- Returns the character offset of the given row|col pair within
- the logical line. Works for rows outside the line, too, and
- returns corresponding offsets outside the string.
-
- ($row, $col) = $line->coord_of ($offset)
- Translates a string offset into terminal coordinates again.
-
- $text = $term->special_encode $string
- Converts a perl string into the special encoding used by
- rxvt-unicode, where one character corresponds to one screen cell.
- See "$term->ROW_t" for details.
-
- $string = $term->special_decode $text
- Converts rxvt-unicodes text representation into a perl string. See
- "$term->ROW_t" for details.
-
- $success = $term->grab_button ($button, $modifiermask[, $window =
- $term->vt])
- $term->ungrab_button ($button, $modifiermask[, $window = $term->vt])
- Register/unregister a synchronous button grab. See the XGrabButton
- manpage.
-
- $success = $term->grab ($eventtime[, $sync])
- Calls XGrabPointer and XGrabKeyboard in asynchronous (default) or
- synchronous ($sync is true). Also remembers the grab timestamp.
-
- $term->allow_events_async
- Calls XAllowEvents with AsyncBoth for the most recent grab.
-
- $term->allow_events_sync
- Calls XAllowEvents with SyncBoth for the most recent grab.
-
- $term->allow_events_replay
- Calls XAllowEvents with both ReplayPointer and ReplayKeyboard for
- the most recent grab.
-
- $term->ungrab
- Calls XUngrab for the most recent grab. Is called automatically on
- evaluation errors, as it is better to lose the grab in the error
- case as the session.
-
- $atom = $term->XInternAtom ($atom_name[, $only_if_exists])
- $atom_name = $term->XGetAtomName ($atom)
- @atoms = $term->XListProperties ($window)
- ($type,$format,$octets) = $term->XGetWindowProperty ($window, $property)
- $term->XChangeWindowProperty ($window, $property, $type, $format,
- $octets)
- $term->XDeleteProperty ($window, $property)
- $window = $term->DefaultRootWindow
- $term->XReparentWindow ($window, $parent, [$x, $y])
- $term->XMapWindow ($window)
- $term->XUnmapWindow ($window)
- $term->XMoveResizeWindow ($window, $x, $y, $width, $height)
- ($x, $y, $child_window) = $term->XTranslateCoordinates ($src, $dst, $x,
- $y)
- $term->XChangeInput ($window, $add_events[, $del_events])
- Various X or X-related functions. The $term object only serves as
- the source of the display, otherwise those functions map
- more-or-less directory onto the X functions of the same name.
-
- The "urxvt::popup" Class
- $popup->add_title ($title)
- Adds a non-clickable title to the popup.
-
- $popup->add_separator ([$sepchr])
- Creates a separator, optionally using the character given as
- $sepchr.
-
- $popup->add_button ($text, $cb)
- Adds a clickable button to the popup. $cb is called whenever it is
- selected.
-
- $popup->add_toggle ($text, $initial_value, $cb)
- Adds a toggle/checkbox item to the popup. The callback gets called
- whenever it gets toggled, with a boolean indicating its new value as
- its first argument.
-
- $popup->show
- Displays the popup (which is initially hidden).
-
- The "urxvt::timer" Class
- This class implements timer watchers/events. Time is represented as a
- fractional number of seconds since the epoch. Example:
-
- $term->{overlay} = $term->overlay (-1, 0, 8, 1, urxvt::OVERLAY_RSTYLE, 0);
- $term->{timer} = urxvt::timer
- ->new
- ->interval (1)
- ->cb (sub {
- $term->{overlay}->set (0, 0,
- sprintf "%2d:%02d:%02d", (localtime urxvt::NOW)[2,1,0]);
- });
-
- $timer = new urxvt::timer
- Create a new timer object in started state. It is scheduled to fire
- immediately.
-
- $timer = $timer->cb (sub { my ($timer) = @_; ... })
- Set the callback to be called when the timer triggers.
-
- $tstamp = $timer->at
- Return the time this watcher will fire next.
-
- $timer = $timer->set ($tstamp)
- Set the time the event is generated to $tstamp.
-
- $timer = $timer->interval ($interval)
- Normally (and when $interval is 0), the timer will automatically
- stop after it has fired once. If $interval is non-zero, then the
- timer is automatically rescheduled at the given intervals.
-
- $timer = $timer->start
- Start the timer.
-
- $timer = $timer->start ($tstamp)
- Set the event trigger time to $tstamp and start the timer.
-
- $timer = $timer->after ($delay)
- Like "start", but sets the expiry timer to c<urxvt::NOW + $delay>.
-
- $timer = $timer->stop
- Stop the timer.
-
- The "urxvt::iow" Class
- This class implements io watchers/events. Example:
-
- $term->{socket} = ...
- $term->{iow} = urxvt::iow
- ->new
- ->fd (fileno $term->{socket})
- ->events (urxvt::EV_READ)
- ->start
- ->cb (sub {
- my ($iow, $revents) = @_;
- # $revents must be 1 here, no need to check
- sysread $term->{socket}, my $buf, 8192
- or end-of-file;
- });
-
- $iow = new urxvt::iow
- Create a new io watcher object in stopped state.
-
- $iow = $iow->cb (sub { my ($iow, $reventmask) = @_; ... })
- Set the callback to be called when io events are triggered.
- $reventmask is a bitset as described in the "events" method.
-
- $iow = $iow->fd ($fd)
- Set the file descriptor (not handle) to watch.
-
- $iow = $iow->events ($eventmask)
- Set the event mask to watch. The only allowed values are
- "urxvt::EV_READ" and "urxvt::EV_WRITE", which might be ORed
- together, or "urxvt::EV_NONE".
-
- $iow = $iow->start
- Start watching for requested events on the given handle.
-
- $iow = $iow->stop
- Stop watching for events on the given file handle.
-
- The "urxvt::iw" Class
- This class implements idle watchers, that get called automatically when
- the process is idle. They should return as fast as possible, after doing
- some useful work.
-
- $iw = new urxvt::iw
- Create a new idle watcher object in stopped state.
-
- $iw = $iw->cb (sub { my ($iw) = @_; ... })
- Set the callback to be called when the watcher triggers.
-
- $timer = $timer->start
- Start the watcher.
-
- $timer = $timer->stop
- Stop the watcher.
-
- The "urxvt::pw" Class
- This class implements process watchers. They create an event whenever a
- process exits, after which they stop automatically.
-
- my $pid = fork;
- ...
- $term->{pw} = urxvt::pw
- ->new
- ->start ($pid)
- ->cb (sub {
- my ($pw, $exit_status) = @_;
- ...
- });
-
- $pw = new urxvt::pw
- Create a new process watcher in stopped state.
-
- $pw = $pw->cb (sub { my ($pw, $exit_status) = @_; ... })
- Set the callback to be called when the timer triggers.
-
- $pw = $timer->start ($pid)
- Tells the watcher to start watching for process $pid.
-
- $pw = $pw->stop
- Stop the watcher.
-
-ENVIRONMENT
- URXVT_PERL_VERBOSITY
- This variable controls the verbosity level of the perl extension. Higher
- numbers indicate more verbose output.
-
- == 0 - fatal messages
- >= 3 - script loading and management
- >=10 - all called hooks
- >=11 - hook return values
-
-AUTHOR
- Marc Lehmann <pcg@goof.com>
- http://software.schmorp.de/pkg/rxvt-unicode
-
projects / dana / urxvt.git / commitdiff