ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.man.in
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.man.in (file contents):
Revision 1.55 by root, Sun Jan 29 21:45:47 2006 UTC vs.
Revision 1.76 by root, Sat Dec 15 19:10:11 2007 UTC

1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.35
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sh \" Subsection heading 5.de Sh \" Subsection heading
6.br 6.br
126. ds Ae AE 126. ds Ae AE
127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title "rxvt 1" 131.IX Title "@@RXVT_NAME@@ 1"
132.TH rxvt 1 "2006-01-29" "7.4" "RXVT-UNICODE" 132.TH @@RXVT_NAME@@ 1 "2007-12-15" "8.7" "RXVT-UNICODE"
133.SH "NAME" 133.SH "NAME"
134rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system) 134rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system)
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137\&\fB@@RXVT_NAME@@\fR [options] [\-e command [ args ]] 137\&\fB@@RXVT_NAME@@\fR [options] [\-e command [ args ]]
140\&\fBrxvt-unicode\fR, version \fB@@RXVT_VERSION@@\fR, is a colour vt102 terminal 140\&\fBrxvt-unicode\fR, version \fB@@RXVT_VERSION@@\fR, is a colour vt102 terminal
141emulator intended as an \fIxterm\fR(1) replacement for users who do not 141emulator intended as an \fIxterm\fR(1) replacement for users who do not
142require features such as Tektronix 4014 emulation and toolkit-style 142require features such as Tektronix 4014 emulation and toolkit-style
143configurability. As a result, \fBrxvt-unicode\fR uses much less swap space \*(-- 143configurability. As a result, \fBrxvt-unicode\fR uses much less swap space \*(--
144a significant advantage on a machine serving many X sessions. 144a significant advantage on a machine serving many X sessions.
145.PP
146This document is also available on the World-Wide-Web at
147<http://pod.tst.eu/http://cvs.schmorp.de/rxvt\-unicode/doc/rxvt.1.pod>.
145.SH "FREQUENTLY ASKED QUESTIONS" 148.SH "FREQUENTLY ASKED QUESTIONS"
146.IX Header "FREQUENTLY ASKED QUESTIONS" 149.IX Header "FREQUENTLY ASKED QUESTIONS"
147See @@RXVT_NAME@@(7) (try \f(CW\*(C`man 7 @@RXVT_NAME@@\*(C'\fR) for a list of 150See @@RXVT_NAME@@(7) (try \f(CW\*(C`man 7 @@RXVT_NAME@@\*(C'\fR) for a list of
148frequently asked questions and answer to them and some common 151frequently asked questions and answer to them and some common
149problems. That document is also accessible on the World-Wide-Web at 152problems. That document is also accessible on the World-Wide-Web at
150<http://cvs.schmorp.de/browse/*checkout*/rxvt\-unicode/doc/rxvt.7.html>. 153<http://pod.tst.eu/http://cvs.schmorp.de/rxvt\-unicode/doc/rxvt.7.pod>.
151.SH "RXVT-UNICODE VS. RXVT" 154.SH "RXVT-UNICODE VS. RXVT"
152.IX Header "RXVT-UNICODE VS. RXVT" 155.IX Header "RXVT-UNICODE VS. RXVT"
153Unlike the original rxvt, \fBrxvt-unicode\fR stores all text in Unicode 156Unlike the original rxvt, \fBrxvt-unicode\fR stores all text in Unicode
154internally. That means it can store and display most scripts in the 157internally. That means it can store and display most scripts in the
155world. Being a terminal emulator, however, some things are very difficult, 158world. Being a terminal emulator, however, some things are very difficult,
156especially cursive scripts such as arabic, vertically written scripts 159especially cursive scripts such as arabic, vertically written scripts
157like mongolian or scripts requiring extremely complex combining rules, 160like mongolian or scripts requiring extremely complex combining rules,
158like tibetan or devenagari. Don't expect pretty output when using these 161like tibetan or devanagari. Don't expect pretty output when using these
159scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 162scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
160fine, though. A somewhat difficult case are left-to-right scripts, such 163fine, though. A somewhat difficult case are right-to-left scripts, such
161as hebrew: \fBrxvt-unicode\fR adopts the view that bidirectional algorithms 164as hebrew: \fBrxvt-unicode\fR adopts the view that bidirectional algorithms
162belong into the application, not the terminal emulator (too many things \*(-- 165belong in the application, not the terminal emulator (too many things \*(--
163such as cursor-movement while editing \*(-- break otherwise), but that might 166such as cursor-movement while editing \*(-- break otherwise), but that might
164change. 167change.
165.PP 168.PP
166If you are looking for a terminal that supports more exotic scripts, let 169If you are looking for a terminal that supports more exotic scripts, let
167me recommend \f(CW\*(C`mlterm\*(C'\fR, which is a very userfriendly, lean and clean 170me recommend \f(CW\*(C`mlterm\*(C'\fR, which is a very user friendly, lean and clean
168terminal emulator. In fact, the reason rxvt-unicode was born was solely 171terminal emulator. In fact, the reason rxvt-unicode was born was solely
169because the author couldn't get \f(CW\*(C`mlterm\*(C'\fR to use one font for latin1 and 172because the author couldn't get \f(CW\*(C`mlterm\*(C'\fR to use one font for latin1 and
170another for japanese. 173another for japanese.
171.PP 174.PP
172Therefore another design rationale was the use of multiple fonts to 175Therefore another design rationale was the use of multiple fonts to
173display characters: The idea of a single unicode font which many other 176display characters: The idea of a single unicode font which many other
174programs force onto it's users never made sense to me: You should be able 177programs force onto its users never made sense to me: You should be able
175to choose any font for any script freely. 178to choose any font for any script freely.
176.PP 179.PP
177Apart from that, rxvt-unicode is also much better internationalised than 180Apart from that, rxvt-unicode is also much better internationalised than
178it's predecessor, supports things such as \s-1XFT\s0 and \s-1ISO\s0 14755 that are handy 181its predecessor, supports things such as \s-1XFT\s0 and \s-1ISO\s0 14755 that are handy
179in i18n\-environments, is faster, and has a lot less bugs than the original 182in i18n\-environments, is faster, and has a lot bugs less than the original
180rxvt. This all in addition to dozens of other small improvements. 183rxvt. This all in addition to dozens of other small improvements.
181.PP 184.PP
182It is still faithfully following the original rxvt idea of being lean 185It is still faithfully following the original rxvt idea of being lean
183and nice on resources: for example, you can still configure rxvt-unicode 186and nice on resources: for example, you can still configure rxvt-unicode
184without most of it's features to get a lean binary. It also comes with 187without most of its features to get a lean binary. It also comes with
185a client/daemon pair that lets you open any number of terminal windows 188a client/daemon pair that lets you open any number of terminal windows
186from within a single process, which makes startup time very fast and 189from within a single process, which makes startup time very fast and
187drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 190drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
188@@RXVT_NAME@@c(1) (client). 191@@RXVT_NAME@@c(1) (client).
189.PP 192.PP
190It also makes technical information about escape sequences (which have 193It also makes technical information about escape sequences (which have
191been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 194been extended) more accessible: see @@RXVT_NAME@@(7) for technical
192reference documentation (escape sequences etc.). 195reference documentation (escape sequences etc.).
193.SH "OPTIONS" 196.SH "OPTIONS"
194.IX Header "OPTIONS" 197.IX Header "OPTIONS"
195The \fB@@RXVT_NAME@@\fR options (mostly a subset of \fIxterm\fR's) are listed 198The \fB@@RXVT_NAME@@\fR options (mostly a subset of \fIxterm\fR's) are listed
196below. In keeping with the smaller-is-better philosophy, options may be 199below. In keeping with the smaller-is-better philosophy, options may be
216Attempt to open a window on the named X display (\fB\-d\fR still 219Attempt to open a window on the named X display (\fB\-d\fR still
217respected). In the absence of this option, the display specified by the 220respected). In the absence of this option, the display specified by the
218\&\fB\s-1DISPLAY\s0\fR environment variable is used. 221\&\fB\s-1DISPLAY\s0\fR environment variable is used.
219.IP "\fB\-depth\fR \fIbitdepth\fR" 4 222.IP "\fB\-depth\fR \fIbitdepth\fR" 4
220.IX Item "-depth bitdepth" 223.IX Item "-depth bitdepth"
221Compile \fIfrills\fR: Attempt to find a visual with the given bit depth; 224Compile \fIxft\fR: Attempt to find a visual with the given bit depth;
222resource \fBdepth\fR. 225resource \fBdepth\fR.
223.IP "\fB\-geometry\fR \fIgeom\fR" 4 226.IP "\fB\-geometry\fR \fIgeom\fR" 4
224.IX Item "-geometry geom" 227.IX Item "-geometry geom"
225Window geometry (\fB\-g\fR still respected); resource \fBgeometry\fR. 228Window geometry (\fB\-g\fR still respected); resource \fBgeometry\fR.
226.IP "\fB\-rv\fR|\fB+rv\fR" 4 229.IP "\fB\-rv\fR|\fB+rv\fR" 4
227.IX Item "-rv|+rv" 230.IX Item "-rv|+rv"
228Turn on/off simulated reverse video; resource \fBreverseVideo\fR. 231Turn on/off simulated reverse video; resource \fBreverseVideo\fR.
229.IP "\fB\-j\fR|\fB+j\fR" 4 232.IP "\fB\-j\fR|\fB+j\fR" 4
230.IX Item "-j|+j" 233.IX Item "-j|+j"
231Turn on/off jump scrolling; resource \fBjumpScroll\fR. 234Turn on/off jump scrolling (allow multiple lines per refresh); resource \fBjumpScroll\fR.
232.IP "\fB\-ip\fR|\fB+ip\fR | \fB\-tr\fR|\fB+tr\fR" 4 235.IP "\fB\-ss\fR|\fB+ss\fR" 4
236.IX Item "-ss|+ss"
237Turn on/off skip scrolling (allow multiple screens per refresh); resource \fBskipScroll\fR.
238.IP "\fB\-tr\fR|\fB+tr\fR" 4
233.IX Item "-ip|+ip | -tr|+tr" 239.IX Item "-tr|+tr"
234Turn on/off inheriting parent window's pixmap. Alternative form is 240Turn on/off illusion of a transparent window background; resource \fBtransparent\fR.
235\&\fB\-tr\fR; resource \fBinheritPixmap\fR. 241.Sp
242\&\fB\-ip\fR is still accepted as an obsolete alias but will be removed in
243future versions.
244.Sp
245\&\fIPlease address all transparency related issues to Sasha Vasko at
246sasha@aftercode.net. Read the \s-1FAQ\s0 (man 7 @@RXVT_NAME@@)!\fR
236.IP "\fB\-fade\fR \fInumber\fR" 4 247.IP "\fB\-fade\fR \fInumber\fR" 4
237.IX Item "-fade number" 248.IX Item "-fade number"
238Fade the text by the given percentage when focus is lost. Small values 249Fade the text by the given percentage when focus is lost. Small values
239fade a little only, 100 completely replaces all colours by the fade 250fade a little only, 100 completely replaces all colours by the fade
240colour; resource \fBfading\fR. 251colour; resource \fBfading\fR.
241.IP "\fB\-fadecolor\fR \fIcolour\fR" 4 252.IP "\fB\-fadecolor\fR \fIcolour\fR" 4
242.IX Item "-fadecolor colour" 253.IX Item "-fadecolor colour"
243Fade to this colour when fading is used (see \fB\-fade\fR). The default colour 254Fade to this colour when fading is used (see \fB\-fade\fR). The default colour
244is black. resource \fBfadeColor\fR. 255is opaque black. resource \fBfadeColor\fR.
245.IP "\fB\-tint\fR \fIcolour\fR" 4 256.IP "\fB\-tint\fR \fIcolour\fR" 4
246.IX Item "-tint colour" 257.IX Item "-tint colour"
247Tint the transparent background pixmap with the given colour when 258Tint the transparent background pixmap with the given colour when
248transparency is enabled with \fB\-tr\fR or \fB\-ip\fR. This only works for 259transparency is enabled with \fB\-tr\fR. This only works for
249non-tiled backgrounds, currently. See also the \fB\-sh\fR option that can be 260non-tiled backgrounds, currently. See also the \fB\-sh\fR option that can be
250used to brighten or darken the image in addition to tinting it; resource 261used to brighten or darken the image in addition to tinting it.
262Please note that certain tint colours can be applied on the server\-side,
263thus yielding performance gain of two orders of magnitude. These colours are:
264blue, red, green, cyan, magenta, yellow, and those close to them. Also
265pure black and pure white colors essentially mean no tinting; resource
251\&\fItintColor\fR. Example: 266\&\fItintColor\fR. Example:
252.Sp 267.Sp
253.Vb 1 268.Vb 1
254\& @@RXVT_NAME@@ -tr -tint blue -sh 40 269\& @@RXVT_NAME@@ -tr -tint blue -sh 40
255.Ve 270.Ve
256.IP "\fB\-sh\fR" 4 271.IP "\fB\-sh\fR \fInumber\fR" 4
257.IX Item "-sh" 272.IX Item "-sh number"
258\&\fInumber\fR Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent 273Darken (0 .. 100) or lighten (100 .. 200) the transparent
259background image in addition to tinting it (i.e. \fB\-tint\fR must be 274background image in addition to (or instead of) tinting it;
260specified, too, e.g. \f(CW\*(C`\-tint white\*(C'\fR). 275resource \fIshading\fR.
276.IP "\fB\-blt\fR \fIstring\fR" 4
277.IX Item "-blt string"
278Specify background blending type. If background pixmap is specified
279at the same time as transparency \- such pixmap will be blended over
280transparency image, using method specified. Supported values are :
281\&\fBadd\fR, \fBalphablend\fR, \fBallanon\fR \- color values averaging, \fBcolorize\fR,
282\&\fBdarken\fR, \fBdiff\fR, \fBdissipate\fR, \fBhue\fR, \fBlighten\fR, \fBoverlay\fR,
283\&\fBsaturate\fR, \fBscreen\fR, \fBsub\fR, \fBtint\fR, \fBvalue\fR. The default is
284alpha\-blending. Compile \fIafterimage\fR; resource \fIblendType\fR.
285.IP "\fB\-blr\fR \fIHxV\fR" 4
286.IX Item "-blr HxV"
287Apply Gaussian Blur with the specified radii to the transparent
288background image. If single number is specified \- both vertical and
289horizontal radii are considered to be the same. Setting one of the
290radii to 1 and another to a large number creates interesting effects
291on some backgrounds. Maximum radius value is 128. Compile \fIafterimage\fR;
292resource \fIblurRadius\fR.
261.IP "\fB\-bg\fR \fIcolour\fR" 4 293.IP "\fB\-bg\fR \fIcolour\fR" 4
262.IX Item "-bg colour" 294.IX Item "-bg colour"
263Window background colour; resource \fBbackground\fR. 295Window background colour; resource \fBbackground\fR.
264.IP "\fB\-fg\fR \fIcolour\fR" 4 296.IP "\fB\-fg\fR \fIcolour\fR" 4
265.IX Item "-fg colour" 297.IX Item "-fg colour"
266Window foreground colour; resource \fBforeground\fR. 298Window foreground colour; resource \fBforeground\fR.
267.IP "\fB\-pixmap\fR \fIfile[;geom]\fR" 4 299.IP "\fB\-pixmap\fR \fIfile[;geom[:op1][:op2][...]]\fR" 4
268.IX Item "-pixmap file[;geom]" 300.IX Item "-pixmap file[;geom[:op1][:op2][...]]"
269Compile \fI\s-1XPM\s0\fR: Specify \s-1XPM\s0 file for the background and also optionally 301Compile \fIafterimage\fR: Specify image file for the background and also
270specify its scaling with a geometry string. Note you may need to 302optionally specify its scaling with a geometry string. Note you may need to
271add quotes to avoid special shell interpretation of the \f(CW\*(C`;\*(C'\fR in the 303add quotes to avoid special shell interpretation of the \f(CW\*(C`;\*(C'\fR in the
272command\-line; resource \fBbackgroundPixmap\fR. 304command\-line; for more details see resource \fBbackgroundPixmap\fR.
273.IP "\fB\-cr\fR \fIcolour\fR" 4 305.IP "\fB\-cr\fR \fIcolour\fR" 4
274.IX Item "-cr colour" 306.IX Item "-cr colour"
275The cursor colour; resource \fBcursorColor\fR. 307The cursor colour; resource \fBcursorColor\fR.
276.IP "\fB\-pr\fR \fIcolour\fR" 4 308.IP "\fB\-pr\fR \fIcolour\fR" 4
277.IX Item "-pr colour" 309.IX Item "-pr colour"
289that are checked in order when trying to find glyphs for characters. The 321that are checked in order when trying to find glyphs for characters. The
290first font defines the cell size for characters; other fonts might be 322first font defines the cell size for characters; other fonts might be
291smaller, but not (in general) larger. A (hopefully) reasonable default 323smaller, but not (in general) larger. A (hopefully) reasonable default
292font list is always appended to it. See resource \fBfont\fR for more details. 324font list is always appended to it. See resource \fBfont\fR for more details.
293.Sp 325.Sp
294In short, to specify an X11 core font, just specify it's name or prefix it 326In short, to specify an X11 core font, just specify its name or prefix it
295with \f(CW\*(C`x:\*(C'\fR. To specify an XFT\-font, you need to prefix it with \f(CW\*(C`xft:\*(C'\fR, 327with \f(CW\*(C`x:\*(C'\fR. To specify an XFT\-font, you need to prefix it with \f(CW\*(C`xft:\*(C'\fR,
296e.g.: 328e.g.:
297.Sp 329.Sp
298.Vb 2 330.Vb 2
299\& @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 331\& @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
315Compile \fIfont-styles\fR: The bold italic font list to use when \fB\f(BIbold 347Compile \fIfont-styles\fR: The bold italic font list to use when \fB\f(BIbold
316italic\fB\fR characters are to be printed. See resource \fBboldItalicFont\fR 348italic\fB\fR characters are to be printed. See resource \fBboldItalicFont\fR
317for details. 349for details.
318.IP "\fB\-is\fR|\fB+is\fR" 4 350.IP "\fB\-is\fR|\fB+is\fR" 4
319.IX Item "-is|+is" 351.IX Item "-is|+is"
320Compile \fIfont-styles\fR: Bold/Italic font styles imply high intensity 352Compile \fIfont-styles\fR: Bold/Blink font styles imply high intensity
321foreground/background (default). See resource \fBintensityStyles\fR for 353foreground/background (default). See resource \fBintensityStyles\fR for
322details. 354details.
323.IP "\fB\-name\fR \fIname\fR" 4 355.IP "\fB\-name\fR \fIname\fR" 4
324.IX Item "-name name" 356.IX Item "-name name"
325Specify the application name under which resources are to be obtained, 357Specify the application name under which resources are to be obtained,
403resource \fBskipBuiltinGlyphs\fR. 435resource \fBskipBuiltinGlyphs\fR.
404.IP "\fB\-lsp\fR \fInumber\fR" 4 436.IP "\fB\-lsp\fR \fInumber\fR" 4
405.IX Item "-lsp number" 437.IX Item "-lsp number"
406Compile \fIfrills\fR: Lines (pixel height) to insert between each row of 438Compile \fIfrills\fR: Lines (pixel height) to insert between each row of
407the display. Useful to work around font rendering problems; resource 439the display. Useful to work around font rendering problems; resource
408\&\fBlinespace\fR. 440\&\fBlineSpace\fR.
409.IP "\fB\-tn\fR \fItermname\fR" 4 441.IP "\fB\-tn\fR \fItermname\fR" 4
410.IX Item "-tn termname" 442.IX Item "-tn termname"
411This option specifies the name of the terminal type to be set in the 443This option specifies the name of the terminal type to be set in the
412\&\fB\s-1TERM\s0\fR environment variable. This terminal type must exist in the 444\&\fB\s-1TERM\s0\fR environment variable. This terminal type must exist in the
413\&\fI\fItermcap\fI\|(5)\fR database and should have \fIli#\fR and \fIco#\fR entries; 445\&\fI\fItermcap\fI\|(5)\fR database and should have \fIli#\fR and \fIco#\fR entries;
459Set the font set to use for the X Input Method, see resource \fBimFont\fR 491Set the font set to use for the X Input Method, see resource \fBimFont\fR
460for more info. 492for more info.
461.IP "\fB\-tcw\fR" 4 493.IP "\fB\-tcw\fR" 4
462.IX Item "-tcw" 494.IX Item "-tcw"
463Change the meaning of triple-click selection with the left mouse 495Change the meaning of triple-click selection with the left mouse
496button. Only effective when the original (non\-perl) selection code is
464button. Instead of selecting a full line it will extend the selection the 497in\-use. Instead of selecting a full line it will extend the selection to
465end of the logical line only. resource \fBtripleclickwords\fR. 498the end of the logical line only. resource \fBtripleclickwords\fR.
466.IP "\fB\-insecure\fR" 4 499.IP "\fB\-insecure\fR" 4
467.IX Item "-insecure" 500.IX Item "-insecure"
468Enable \*(L"insecure\*(R" mode, which currently enables most of the escape 501Enable \*(L"insecure\*(R" mode, which currently enables most of the escape
469sequences that echo strings. See the resource \fBinsecure\fR for more 502sequences that echo strings. See the resource \fBinsecure\fR for more
470info. 503info.
485.IX Item "-hold|+hold" 518.IX Item "-hold|+hold"
486Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 519Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
487will not immediately destroy its window when the program executed within 520will not immediately destroy its window when the program executed within
488it exits. Instead, it will wait till it is being killed or closed by the 521it exits. Instead, it will wait till it is being killed or closed by the
489user; resource \fBhold\fR. 522user; resource \fBhold\fR.
523.IP "\fB\-xrm\fR \fIstring\fR" 4
524.IX Item "-xrm string"
525Works like the X Toolkit option of the same name, by adding the \fIstring\fR
526as if it were specified in a resource file. Resource values specified this
527way take precedence over all other resource specifications.
528.Sp
529Note that you need to use the \fIsame\fR syntax as in the .Xdefaults file,
530e.g. \f(CW\*(C`*.background: black\*(C'\fR. Also note that all @@RXVT_NAME@@\-specific
531options can be specified as long-options on the commandline, so use
532of \fB\-xrm\fR is mostly limited to cases where you want to specify other
533resources (e.g. for input methods) or for compatibility with other
534programs.
490.IP "\fB\-keysym.\fR\fIsym\fR \fIstring\fR" 4 535.IP "\fB\-keysym.\fR\fIsym\fR \fIstring\fR" 4
491.IX Item "-keysym.sym string" 536.IX Item "-keysym.sym string"
492Remap a key symbol. See resource \fBkeysym\fR. 537Remap a key symbol. See resource \fBkeysym\fR.
493.IP "\fB\-embed\fR \fIwindowid\fR" 4 538.IP "\fB\-embed\fR \fIwindowid\fR" 4
494.IX Item "-embed windowid" 539.IX Item "-embed windowid"
495Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 540Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
496which enables applications to easily embed a terminal. 541which enables applications to easily embed a terminal.
497.Sp 542.Sp
498Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 543Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
499shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 544shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
500quite a bit, so don't expect it to keep some specific state. It's best to 545quite a bit, so don't expect it to keep some specific state. It's best to
503The window will not be destroyed when @@RXVT_NAME@@ exits. 548The window will not be destroyed when @@RXVT_NAME@@ exits.
504.Sp 549.Sp
505It might be useful to know that @@RXVT_NAME@@ will not close file 550It might be useful to know that @@RXVT_NAME@@ will not close file
506descriptors passed to it (except for stdin/out/err, of course), so you 551descriptors passed to it (except for stdin/out/err, of course), so you
507can use file descriptors to communicate with the programs within the 552can use file descriptors to communicate with the programs within the
508terminal. This works regardless of wether the \f(CW\*(C`\-embed\*(C'\fR option was used or 553terminal. This works regardless of whether the \f(CW\*(C`\-embed\*(C'\fR option was used or
509not. 554not.
510.Sp 555.Sp
511Here is a short Gtk2\-perl snippet that illustrates how this option can be 556Here is a short Gtk2\-perl snippet that illustrates how this option can be
512used (a longer example is in \fIdoc/embed\fR): 557used (a longer example is in \fIdoc/embed\fR):
513.Sp 558.Sp
519\& }); 564\& });
520.Ve 565.Ve
521.IP "\fB\-pty\-fd\fR \fIfile descriptor\fR" 4 566.IP "\fB\-pty\-fd\fR \fIfile descriptor\fR" 4
522.IX Item "-pty-fd file descriptor" 567.IX Item "-pty-fd file descriptor"
523Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty 568Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty
524pair but instead use the given filehandle as the tty master. This is 569pair but instead use the given file descriptor as the tty master. This is
525useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 570useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
526without having to run a program within it. 571without having to run a program within it.
527.Sp 572.Sp
528If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 573If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
529entries and will not tinker with pty/tty permissions \- you have to do that 574entries and will not tinker with pty/tty permissions \- you have to do that
530yourself if you want that. 575yourself if you want that.
531.Sp 576.Sp
532As an extremely special case, specifying \f(CW\*(C`\-1\*(C'\fR will completely suppress 577As an extremely special case, specifying \f(CW\*(C`\-1\*(C'\fR will completely suppress
533pty/tty operations. 578pty/tty operations, which is probably only useful in conjunction with some
579perl extension that manages the terminal.
534.Sp 580.Sp
535Here is a example in perl that illustrates how this option can be used (a 581Here is a example in perl that illustrates how this option can be used (a
536longer example is in \fIdoc/pty\-fd\fR): 582longer example is in \fIdoc/pty\-fd\fR):
537.Sp 583.Sp
538.Vb 2 584.Vb 2
554.Ve 600.Ve
555.IP "\fB\-pe\fR \fIstring\fR" 4 601.IP "\fB\-pe\fR \fIstring\fR" 4
556.IX Item "-pe string" 602.IX Item "-pe string"
557Comma-separated list of perl extension scripts to use (or not to use) in 603Comma-separated list of perl extension scripts to use (or not to use) in
558this terminal instance. See resource \fBperl-ext\fR for details. 604this terminal instance. See resource \fBperl-ext\fR for details.
559.SH "RESOURCES (available also as long\-options)" 605.SH "RESOURCES"
560.IX Header "RESOURCES (available also as long-options)" 606.IX Header "RESOURCES"
561Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long 607Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long
562options) compiled into your version. 608options) compiled into your version. All resources are also available as
609long\-options.
563.PP 610.PP
564You can set and change the resources using X11 tools like \fBxrdb\fR. Many 611You can set and change the resources using X11 tools like \fBxrdb\fR. Many
565distribution do also load settings from the \fB~/.Xresources\fR file when X 612distribution do also load settings from the \fB~/.Xresources\fR file when X
566starts. @@RXVT_NAME@@ will consult the following files/resources in order, 613starts. @@RXVT_NAME@@ will consult the following files/resources in order,
567with later settings overwriting earlier ones: 614with later settings overwriting earlier ones:
568.PP 615.PP
569.Vb 5 616.Vb 6
570\& 1. system-wide app-defaults file, either locale-dependent OR global 617\& 1. system-wide app-defaults file, either locale-dependent OR global
571\& 2. app-defaults file in $XAPPLRESDIR 618\& 2. app-defaults file in $XAPPLRESDIR
572\& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 619\& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
573\& 4. SCREEN_RESOURCES for the current screen 620\& 4. SCREEN_RESOURCES for the current screen
574\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 621\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
622\& 6. resources specified via -xrm on the commandline
575.Ve 623.Ve
576.PP 624.PP
577Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two class 625Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two class
578names: \fBRxvt\fR and \fBURxvt\fR. The class name \fBRxvt\fR allows resources 626names: \fBRxvt\fR and \fBURxvt\fR. The class name \fBRxvt\fR allows resources
579common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be easily 627common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be easily
584settings. The following resources are supported (you might want to 632settings. The following resources are supported (you might want to
585check the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for additional settings by perl 633check the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for additional settings by perl
586extensions not documented here): 634extensions not documented here):
587.IP "\fBdepth:\fR \fIbitdepth\fR" 4 635.IP "\fBdepth:\fR \fIbitdepth\fR" 4
588.IX Item "depth: bitdepth" 636.IX Item "depth: bitdepth"
589Compile \fIfrills\fR: Attempt to find a visual with the given bit depth; 637Compile \fIxft\fR: Attempt to find a visual with the given bit depth;
590option \fB\-depth\fR. 638option \fB\-depth\fR.
591.IP "\fBgeometry:\fR \fIgeom\fR" 4 639.IP "\fBgeometry:\fR \fIgeom\fR" 4
592.IX Item "geometry: geom" 640.IX Item "geometry: geom"
593Create the window with the specified X window geometry [default 80x24]; 641Create the window with the specified X window geometry [default 80x24];
594option \fB\-geometry\fR. 642option \fB\-geometry\fR.
627.IX Item "colorUL: colour" 675.IX Item "colorUL: colour"
628Use the specified colour to display underlined characters when the 676Use the specified colour to display underlined characters when the
629foreground colour is the default. 677foreground colour is the default.
630.IP "\fBcolorRV:\fR \fIcolour\fR" 4 678.IP "\fBcolorRV:\fR \fIcolour\fR" 4
631.IX Item "colorRV: colour" 679.IX Item "colorRV: colour"
632Use the specified colour as the background for reverse video 680Use the specified colour as the background for reverse video characters
633characters. 681when \s-1OPTION_HC\s0 is disabled (\-\-disable\-frills).
634.IP "\fBunderlineColor:\fR \fIcolour\fR" 4 682.IP "\fBunderlineColor:\fR \fIcolour\fR" 4
635.IX Item "underlineColor: colour" 683.IX Item "underlineColor: colour"
636If set, use the specified colour as the colour for the underline 684If set, use the specified colour as the colour for the underline
637itself. If unset, use the foreground colour. 685itself. If unset, use the foreground colour.
638.IP "\fBcursorColor:\fR \fIcolour\fR" 4 686.IP "\fBcursorColor:\fR \fIcolour\fR" 4
649\&\fBTrue\fR: simulate reverse video by foreground and background colours; 697\&\fBTrue\fR: simulate reverse video by foreground and background colours;
650option \fB\-rv\fR. \fBFalse\fR: regular screen colours [default]; option 698option \fB\-rv\fR. \fBFalse\fR: regular screen colours [default]; option
651\&\fB+rv\fR. See note in \fB\s-1COLORS\s0 \s-1AND\s0 \s-1GRAPHICS\s0\fR section. 699\&\fB+rv\fR. See note in \fB\s-1COLORS\s0 \s-1AND\s0 \s-1GRAPHICS\s0\fR section.
652.IP "\fBjumpScroll:\fR \fIboolean\fR" 4 700.IP "\fBjumpScroll:\fR \fIboolean\fR" 4
653.IX Item "jumpScroll: boolean" 701.IX Item "jumpScroll: boolean"
654\&\fBTrue\fR: specify that jump scrolling should be used. When scrolling 702\&\fBTrue\fR: specify that jump scrolling should be used. When receiving lots
655quickly, fewer screen updates are performed [default]; option \fB\-j\fR. 703of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
704has been read, resulting in fewer updates while still displaying every
705received line; option \fB\-j\fR.
706.Sp
656\&\fBFalse\fR: specify that smooth scrolling should be used; option \fB+j\fR. 707\&\fBFalse\fR: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
708force a screen refresh on each new line it received; option \fB+j\fR.
709.IP "\fBskipScroll:\fR \fIboolean\fR" 4
710.IX Item "skipScroll: boolean"
711\&\fBTrue\fR: (the default) specify that skip scrolling should be used. When
712receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
713(around 60 times per second), resulting in far fewer updates. This can
714result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
715option \fB\-ss\fR.
716.Sp
717\&\fBFalse\fR: specify that everything is to be displayed, even
718if the refresh is too fast for the human eye to read anything (or the
719monitor to display anything); option \fB+ss\fR.
657.IP "\fBinheritPixmap:\fR \fIboolean\fR" 4 720.IP "\fBtransparent:\fR \fIboolean\fR" 4
658.IX Item "inheritPixmap: boolean" 721.IX Item "transparent: boolean"
659\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving 722Turn on/off illusion of a transparent window background.
660artificial transparency. \fBFalse\fR: do not inherit the parent windows' 723.Sp
661pixmap. 724\&\fBinheritPixmap\fR is still accepted as an obsolete alias but will be removed in
725future versions.
726.Sp
727\&\fIPlease address all transparency related issues to Sasha Vasko at
728sasha@aftercode.net. Read the \s-1FAQ\s0 (man 7 @@RXVT_NAME@@)!\fR
662.IP "\fBfading:\fR \fInumber\fR" 4 729.IP "\fBfading:\fR \fInumber\fR" 4
663.IX Item "fading: number" 730.IX Item "fading: number"
664Fade the text by the given percentage when focus is lost; option \fB\-fade\fR. 731Fade the text by the given percentage when focus is lost; option \fB\-fade\fR.
665.IP "\fBfadeColor:\fR \fIcolour\fR" 4 732.IP "\fBfadeColor:\fR \fIcolour\fR" 4
666.IX Item "fadeColor: colour" 733.IX Item "fadeColor: colour"
670.IX Item "tintColor: colour" 737.IX Item "tintColor: colour"
671Tint the transparent background pixmap with the given colour; option 738Tint the transparent background pixmap with the given colour; option
672\&\fB\-tint\fR. 739\&\fB\-tint\fR.
673.IP "\fBshading:\fR \fInumber\fR" 4 740.IP "\fBshading:\fR \fInumber\fR" 4
674.IX Item "shading: number" 741.IX Item "shading: number"
675Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background 742Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background image
676image in addition to tinting it. 743in addition to tinting it; option \fB\-sh\fR.
744.IP "\fBblendType:\fR \fIstring\fR" 4
745.IX Item "blendType: string"
746Specify background blending type; option \fB\-blt\fR.
747.IP "\fBblurRadius:\fR \fInumber\fR" 4
748.IX Item "blurRadius: number"
749Apply Gaussian Blurr with the specified radius to the transparent
750background image; option \fB\-blr\fR.
677.IP "\fBscrollColor:\fR \fIcolour\fR" 4 751.IP "\fBscrollColor:\fR \fIcolour\fR" 4
678.IX Item "scrollColor: colour" 752.IX Item "scrollColor: colour"
679Use the specified colour for the scrollbar [default #B2B2B2]. 753Use the specified colour for the scrollbar [default #B2B2B2].
680.IP "\fBtroughColor:\fR \fIcolour\fR" 4 754.IP "\fBtroughColor:\fR \fIcolour\fR" 4
681.IX Item "troughColor: colour" 755.IX Item "troughColor: colour"
683#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar. 757#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
684.IP "\fBborderColor:\fR \fIcolour\fR" 4 758.IP "\fBborderColor:\fR \fIcolour\fR" 4
685.IX Item "borderColor: colour" 759.IX Item "borderColor: colour"
686The colour of the border around the text area and between the scrollbar 760The colour of the border around the text area and between the scrollbar
687and the text. 761and the text.
688.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4 762.IP "\fBbackgroundPixmap:\fR \fIfile[;geom[:op1][:op2][...]]\fR" 4
689.IX Item "backgroundPixmap: file[;geom]" 763.IX Item "backgroundPixmap: file[;geom[:op1][:op2][...]]"
690Use the specified \s-1XPM\s0 file (note the `.xpm' extension is optional) for 764Use the specified image file for the background and also
691the background and also optionally specify its scaling with a geometry 765optionally specify its scaling with a geometry string \fBWxH+X+Y\fR,
692string \fBWxH+X+Y\fR, in which \fB\*(L"W\*(R" / \*(L"H\*(R"\fR specify the 766(default \f(CW\*(C`0x0+50+50\*(C'\fR) in which \fB\*(L"W\*(R" / \*(L"H\*(R"\fR specify the
693horizontal/vertical scale (percent) and \fB\*(L"X\*(R" / \*(L"Y\*(R"\fR locate the image 767horizontal/vertical scale (percent), and \fB\*(L"X\*(R" / \*(L"Y\*(R"\fR locate the image
694centre (percent). A scale of 0 displays the image with tiling. A scale 768centre (percent). A scale of 0 displays the image with tiling. A scale
695of 1 displays the image without any scaling. A scale of 2 to 9 769of 1 displays the image without any scaling. A scale of 2 to 9 specifies
696specifies an integer number of images in that direction. No image will 770an integer number of images in that direction. No image will be magnified
697be magnified beyond 10 times its original size. The maximum permitted 771beyond 10 times its original size. The maximum permitted scale is 1000.
698scale is 1000. [default 0x0+50+50] 772Additional operations can be specified after colon \fB:op1:op2...\fR.
773Supported operations are:
774.Sp
775.Vb 8
776\& tile force background image to be tiled and not scaled. Equivalent to 0x0,
777\& propscale will scale image keeping proportions,
778\& auto will scale image to match window size. Equivalent to 100x100;
779\& hscale will scale image horizontally to the window size;
780\& vscale will scale image vertically to the window size;
781\& scale will scale image to match window size;
782\& root will tile image as if it was a root window background, auto-adjusting
783\& whenever terminal window moves.
784.Ve
785.Sp
786If used in conjunction with \fB\-tr\fR option, the specified pixmap will be
787blended over transparency image using either alpha\-blending, or any
788other blending type, specified with \fB\-blt \*(L"type\*(R"\fR option.
699.IP "\fBpath:\fR \fIpath\fR" 4 789.IP "\fBpath:\fR \fIpath\fR" 4
700.IX Item "path: path" 790.IX Item "path: path"
701Specify the colon-delimited search path for finding \s-1XPM\s0 files. 791Specify the colon-delimited search path for finding background image files.
702.IP "\fBfont:\fR \fIfontlist\fR" 4 792.IP "\fBfont:\fR \fIfontlist\fR" 4
703.IX Item "font: fontlist" 793.IX Item "font: fontlist"
704Select the fonts to be used. This is a comma separated list of font names 794Select the fonts to be used. This is a comma separated list of font names
705that are checked in order when trying to find glyphs for characters. The 795that are checked in order when trying to find glyphs for characters. The
706first font defines the cell size for characters; other fonts might be 796first font defines the cell size for characters; other fonts might be
764If set, but empty, then this specific style is disabled and the normal 854If set, but empty, then this specific style is disabled and the normal
765text font will being used for the given style. 855text font will being used for the given style.
766.IP "\fBintensityStyles:\fR \fIboolean\fR" 4 856.IP "\fBintensityStyles:\fR \fIboolean\fR" 4
767.IX Item "intensityStyles: boolean" 857.IX Item "intensityStyles: boolean"
768When font styles are not enabled, or this option is enabled (\fBTrue\fR, 858When font styles are not enabled, or this option is enabled (\fBTrue\fR,
769option \fB\-is\fR, the default), bold and italic font styles imply high 859option \fB\-is\fR, the default), bold/blink font styles imply high
770intensity foreground/backround colours. Disabling this option (\fBFalse\fR, 860intensity foreground/background colours. Disabling this option (\fBFalse\fR,
771option \fB+is\fR) disables this behaviour, the high intensity colours are not 861option \fB+is\fR) disables this behaviour, the high intensity colours are not
772reachable. 862reachable.
773.IP "\fBselectstyle:\fR \fImode\fR" 4 863.IP "\fBselectstyle:\fR \fImode\fR" 4
774.IX Item "selectstyle: mode" 864.IX Item "selectstyle: mode"
775Set mouse selection style to \fBold\fR which is 2.20, \fBoldword\fR which is 865Set mouse selection style to \fBold\fR which is 2.20, \fBoldword\fR which
776xterm style with 2.20 old word selection, or anything else which gives 866is xterm style with 2.20 old word selection, or anything else which
777xterm style selection. 867gives xterm style selection. Only effective when the original (non\-perl)
868selection code is in use.
778.IP "\fBscrollstyle:\fR \fImode\fR" 4 869.IP "\fBscrollstyle:\fR \fImode\fR" 4
779.IX Item "scrollstyle: mode" 870.IX Item "scrollstyle: mode"
780Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is 871Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is
781the author's favourite. 872the author's favourite.
782.IP "\fBtitle:\fR \fIstring\fR" 4 873.IP "\fBtitle:\fR \fIstring\fR" 4
791set; option \fB\-n\fR. 882set; option \fB\-n\fR.
792.IP "\fBmapAlert:\fR \fIboolean\fR" 4 883.IP "\fBmapAlert:\fR \fIboolean\fR" 4
793.IX Item "mapAlert: boolean" 884.IX Item "mapAlert: boolean"
794\&\fBTrue\fR: de-iconify (map) on receipt of a bell character. \fBFalse\fR: no 885\&\fBTrue\fR: de-iconify (map) on receipt of a bell character. \fBFalse\fR: no
795de-iconify (map) on receipt of a bell character [default]. 886de-iconify (map) on receipt of a bell character [default].
887.IP "\fBurgentOnBell:\fR \fIboolean\fR" 4
888.IX Item "urgentOnBell: boolean"
889\&\fBTrue\fR: set the urgency hint for the wm on receipt of a bell character.
890\&\fBFalse\fR: do not set the urgency hint [default].
796.IP "\fBvisualBell:\fR \fIboolean\fR" 4 891.IP "\fBvisualBell:\fR \fIboolean\fR" 4
797.IX Item "visualBell: boolean" 892.IX Item "visualBell: boolean"
798\&\fBTrue\fR: use visual bell on receipt of a bell character; option \fB\-vb\fR. 893\&\fBTrue\fR: use visual bell on receipt of a bell character; option \fB\-vb\fR.
799\&\fBFalse\fR: no visual bell [default]; option \fB+vb\fR. 894\&\fBFalse\fR: no visual bell [default]; option \fB+vb\fR.
800.IP "\fBloginShell:\fR \fIboolean\fR" 4 895.IP "\fBloginShell:\fR \fIboolean\fR" 4
820.Vb 1 915.Vb 1
821\& URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 916\& URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
822.Ve 917.Ve
823.Sp 918.Sp
824This creates a new file in your home directory with the screen contents 919This creates a new file in your home directory with the screen contents
825everytime you hit \f(CW\*(C`Print\*(C'\fR. 920every time you hit \f(CW\*(C`Print\*(C'\fR.
826.IP "\fBscrollBar:\fR \fIboolean\fR" 4 921.IP "\fBscrollBar:\fR \fIboolean\fR" 4
827.IX Item "scrollBar: boolean" 922.IX Item "scrollBar: boolean"
828\&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR: 923\&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR:
829disable the scrollbar; option \fB+sb\fR. 924disable the scrollbar; option \fB+sb\fR.
830.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4 925.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4
846\&\fB+si\fR. 941\&\fB+si\fR.
847.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4 942.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4
848.IX Item "scrollWithBuffer: boolean" 943.IX Item "scrollWithBuffer: boolean"
849\&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and 944\&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and
850\&\fBscrollTtyOutput\fR is False); option \fB\-sw\fR. \fBFalse\fR: do not scroll 945\&\fBscrollTtyOutput\fR is False); option \fB\-sw\fR. \fBFalse\fR: do not scroll
851with scrollback buffer when tty recieves new lines; option \fB+sw\fR. 946with scrollback buffer when tty receives new lines; option \fB+sw\fR.
852.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4 947.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4
853.IX Item "scrollTtyKeypress: boolean" 948.IX Item "scrollTtyKeypress: boolean"
854\&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys 949\&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys
855are those which are intercepted by rxvt-unicode for special handling and 950are those which are intercepted by rxvt-unicode for special handling and
856are not passed onto the shell; option \fB\-sk\fR. \fBFalse\fR: do not scroll to 951are not passed onto the shell; option \fB\-sk\fR. \fBFalse\fR: do not scroll to
879option \fB\-sbg\fR. 974option \fB\-sbg\fR.
880.IP "\fBtermName:\fR \fItermname\fR" 4 975.IP "\fBtermName:\fR \fItermname\fR" 4
881.IX Item "termName: termname" 976.IX Item "termName: termname"
882Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment 977Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment
883variable; option \fB\-tn\fR. 978variable; option \fB\-tn\fR.
884.IP "\fBlinespace:\fR \fInumber\fR" 4 979.IP "\fBlineSpace:\fR \fInumber\fR" 4
885.IX Item "linespace: number" 980.IX Item "lineSpace: number"
886Specifies number of lines (pixel height) to insert between each row of 981Specifies number of lines (pixel height) to insert between each row of
887the display [default 0]; option \fB\-lsp\fR. 982the display [default 0]; option \fB\-lsp\fR.
888.IP "\fBmeta8:\fR \fIboolean\fR" 4 983.IP "\fBmeta8:\fR \fIboolean\fR" 4
889.IX Item "meta8: boolean" 984.IX Item "meta8: boolean"
890\&\fBTrue\fR: handle Meta (Alt) + keypress to set the 8th bit. \fBFalse\fR: 985\&\fBTrue\fR: handle Meta (Alt) + keypress to set the 8th bit. \fBFalse\fR:
930.IP "\fBcutchars:\fR \fIstring\fR" 4 1025.IP "\fBcutchars:\fR \fIstring\fR" 4
931.IX Item "cutchars: string" 1026.IX Item "cutchars: string"
932The characters used as delimiters for double-click word selection 1027The characters used as delimiters for double-click word selection
933(whitespace delimiting is added automatically if resource is given). 1028(whitespace delimiting is added automatically if resource is given).
934.Sp 1029.Sp
935When the selection extension is in use (the default if compiled in, see 1030When the perl selection extension is in use (the default if compiled
936the @@RXVT_NAME@@\fIperl\fR\|(3) manpage), a suitable regex using these characters 1031in, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage), a suitable regex using these
937will be created (if the resource exists, otherwise, no regex will be 1032characters will be created (if the resource exists, otherwise, no regex
938created). In this mode, characters outside \s-1ISO\-8859\-1\s0 can be used. 1033will be created). In this mode, characters outside \s-1ISO\-8859\-1\s0 can be used.
939.Sp 1034.Sp
940When the selection extension is not used, only \s-1ISO\-8859\-1\s0 characters can 1035When the selection extension is not used, only \s-1ISO\-8859\-1\s0 characters can
941be used. If not specified, the built-in default is used: 1036be used. If not specified, the built-in default is used:
942.Sp 1037.Sp
943\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]{|}\fR 1038\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]^{|}\fR
944.IP "\fBpreeditType:\fR \fIstyle\fR" 4 1039.IP "\fBpreeditType:\fR \fIstyle\fR" 4
945.IX Item "preeditType: style" 1040.IX Item "preeditType: style"
946\&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR. 1041\&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR.
947.IP "\fBinputMethod:\fR \fIname\fR" 4 1042.IP "\fBinputMethod:\fR \fIname\fR" 4
948.IX Item "inputMethod: name" 1043.IX Item "inputMethod: name"
992.IP "\fBsecondaryScreen:\fR \fIboolean\fR" 4 1087.IP "\fBsecondaryScreen:\fR \fIboolean\fR" 4
993.IX Item "secondaryScreen: boolean" 1088.IX Item "secondaryScreen: boolean"
994Turn on/off secondary screen (default enabled). 1089Turn on/off secondary screen (default enabled).
995.IP "\fBsecondaryScroll:\fR \fIboolean\fR" 4 1090.IP "\fBsecondaryScroll:\fR \fIboolean\fR" 4
996.IX Item "secondaryScroll: boolean" 1091.IX Item "secondaryScroll: boolean"
997Turn on/off secondary screen scroll (default enabled). If the this 1092Turn on/off secondary screen scroll (default enabled). If this
998option is enabled, scrolls on the secondary screen will change the 1093option is enabled, scrolls on the secondary screen will change the
999scrollback buffer and switching to/from the secondary screen will 1094scrollback buffer and switching to/from the secondary screen will
1000instead scroll the screen up. 1095instead scroll the screen up.
1001.IP "\fBhold\fR: \fIboolean\fR" 4 1096.IP "\fBhold\fR: \fIboolean\fR" 4
1002.IX Item "hold: boolean" 1097.IX Item "hold: boolean"
1024searching keysym macros from \fB/usr/X11R6/include/X11/keysymdef.h\fR and 1119searching keysym macros from \fB/usr/X11R6/include/X11/keysymdef.h\fR and
1025omitting the prefix \fB\s-1XK_\s0\fR. Alternatively you can specify \fIkey\fR by its hex 1120omitting the prefix \fB\s-1XK_\s0\fR. Alternatively you can specify \fIkey\fR by its hex
1026keysym value (\fB0x0000 \- 0xFFFF\fR). Note that the lookup of \fIsym\fRs is not 1121keysym value (\fB0x0000 \- 0xFFFF\fR). Note that the lookup of \fIsym\fRs is not
1027performed in an exact manner; however, the closest match is assured. 1122performed in an exact manner; however, the closest match is assured.
1028.Sp 1123.Sp
1029\&\fIstring\fR may contain escape values (\f(CW\*(C`\ea\*(C'\fR: bell, \f(CW\*(C`\eb\*(C'\fR: backspace, 1124\&\fIstring\fR may contain escape values (\f(CW\*(C`\en\*(C'\fR: newline, \f(CW\*(C`\e000\*(C'\fR: octal
1030\&\f(CW\*(C`\ee\*(C'\fR, \f(CW\*(C`\eE\*(C'\fR: escape, \f(CW\*(C`\en\*(C'\fR: newline, \f(CW\*(C`\er\*(C'\fR: carriage return, \f(CW\*(C`\et\*(C'\fR: tab, 1125number), see \s-1RESOURCES\s0 in \f(CW\*(C`man 7 X\*(C'\fR for futher details.
1031\&\f(CW\*(C`\e000\*(C'\fR: octal number) or verbatim control characters (\f(CW\*(C`^?\*(C'\fR: delete,
1032\&\f(CW\*(C`^@\*(C'\fR: null, \f(CW\*(C`^A\*(C'\fR ...) and may be enclosed with double quotes so that it
1033can start or end with whitespace.
1034.Sp
1035Please note that you need to double the \f(CW\*(C`\e\*(C'\fR in resource files, as
1036Xlib itself does it's own de-escaping (you can use \f(CW\*(C`\e033\*(C'\fR instead of
1037\&\f(CW\*(C`\ee\*(C'\fR (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1038processing).
1039.Sp 1126.Sp
1040You can define a range of keysyms in one shot by providing a \fIstring\fR 1127You can define a range of keysyms in one shot by providing a \fIstring\fR
1041with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/' 1128with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimiter `/'
1042should be a character not used by the strings. 1129should be a character not used by the strings.
1043.Sp 1130.Sp
1044Its usage can be demonstrated by an example: 1131Its usage can be demonstrated by an example:
1045.Sp 1132.Sp
1046.Vb 1 1133.Vb 1
1125example, \f(CW\*(C`default,\-selection\*(C'\fR will use all the default extension except 1212example, \f(CW\*(C`default,\-selection\*(C'\fR will use all the default extension except
1126\&\f(CW\*(C`selection\*(C'\fR. 1213\&\f(CW\*(C`selection\*(C'\fR.
1127.Sp 1214.Sp
1128Extension names can also be followed by an argument in angle brackets 1215Extension names can also be followed by an argument in angle brackets
1129(e.g. \f(CW\*(C`searchable\-scrollback<M\-s>\*(C'\fR, which binds the hotkey for 1216(e.g. \f(CW\*(C`searchable\-scrollback<M\-s>\*(C'\fR, which binds the hotkey for
1130searchable scorllback to Alt/Meta\-s). Mentioning the same extension 1217searchable scrollback to Alt/Meta\-s). Mentioning the same extension
1131multiple times with different arguments will pass multiple arguments to 1218multiple times with different arguments will pass multiple arguments to
1132the extension. 1219the extension.
1133.Sp 1220.Sp
1134Each extension is looked up in the library directories, loaded if 1221Each extension is looked up in the library directories, loaded if
1135necessary, and bound to the current terminal instance. 1222necessary, and bound to the current terminal instance.
1165Sets the hotkey that starts the incremental scrollback buffer search 1252Sets the hotkey that starts the incremental scrollback buffer search
1166(default: \f(CW\*(C`M\-s\*(C'\fR). 1253(default: \f(CW\*(C`M\-s\*(C'\fR).
1167.IP "\fBurlLauncher\fR: \fIstring\fR" 4 1254.IP "\fBurlLauncher\fR: \fIstring\fR" 4
1168.IX Item "urlLauncher: string" 1255.IX Item "urlLauncher: string"
1169Specifies the program to be started with a \s-1URL\s0 argument. Used by the 1256Specifies the program to be started with a \s-1URL\s0 argument. Used by the
1170\&\f(CW\*(C`selection\-popup\*(C'\fR and \f(CW\*(C`mark\-urls\*(C'\fR perl extensions. 1257\&\f(CW\*(C`selection\-popup\*(C'\fR and \f(CW\*(C`matcher\*(C'\fR perl extensions.
1171.IP "\fBtransient-for\fR: \fIwindowid\fR" 4 1258.IP "\fBtransient-for\fR: \fIwindowid\fR" 4
1172.IX Item "transient-for: windowid" 1259.IX Item "transient-for: windowid"
1173Compile \fIfrills\fR: Sets the \s-1WM_TRANSIENT_FOR\s0 property to the given window id. 1260Compile \fIfrills\fR: Sets the \s-1WM_TRANSIENT_FOR\s0 property to the given window id.
1174.IP "\fBoverride-redirect\fR: \fIboolean\fR" 4 1261.IP "\fBoverride-redirect\fR: \fIboolean\fR" 4
1175.IX Item "override-redirect: boolean" 1262.IX Item "override-redirect: boolean"
1176Compile \fIfrills\fR: Sets override-redirect for the terminal window, making 1263Compile \fIfrills\fR: Sets override-redirect for the terminal window, making
1177it almost invisible to window managers; option \fB\-override\-redirect\fR. 1264it almost invisible to window managers; option \fB\-override\-redirect\fR.
1265.IP "\fBiso14755_52:\fR \fIboolean\fR" 4
1266.IX Item "iso14755_52: boolean"
1267Turn on/off \s-1ISO\s0 14755 5.2 mode (default enabled).
1178.SH "THE SCROLLBAR" 1268.SH "THE SCROLLBAR"
1179.IX Header "THE SCROLLBAR" 1269.IX Header "THE SCROLLBAR"
1180Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window 1270Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window
1181(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar 1271(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar
1182or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and 1272or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and
1196disabled \*(-- on the assumption that we are using a fullscreen 1286disabled \*(-- on the assumption that we are using a fullscreen
1197application. Instead, pressing Button1 and Button3 sends \fB\s-1ESC\s0 [ 6 ~\fR 1287application. Instead, pressing Button1 and Button3 sends \fB\s-1ESC\s0 [ 6 ~\fR
1198(Next) and \fB\s-1ESC\s0 [ 5 ~\fR (Prior), respectively. Similarly, clicking on the 1288(Next) and \fB\s-1ESC\s0 [ 5 ~\fR (Prior), respectively. Similarly, clicking on the
1199up and down arrows sends \fB\s-1ESC\s0 [ A\fR (Up) and \fB\s-1ESC\s0 [ B\fR (Down), 1289up and down arrows sends \fB\s-1ESC\s0 [ A\fR (Up) and \fB\s-1ESC\s0 [ B\fR (Down),
1200respectively. 1290respectively.
1201.SH "TEXT SELECTION AND INSERTION" 1291.SH "THE SELECTION: SELECTING AND PASTING TEXT"
1202.IX Header "TEXT SELECTION AND INSERTION" 1292.IX Header "THE SELECTION: SELECTING AND PASTING TEXT"
1203The behaviour of text selection and insertion mechanism is similar to 1293The behaviour of text selection and insertion/pasting mechanism is similar
1204\&\fIxterm\fR(1). 1294to \fIxterm\fR(1).
1205.IP "\fBSelection\fR:" 4 1295.IP "\fBSelecting\fR:" 4
1206.IX Item "Selection:" 1296.IX Item "Selecting:"
1207Left click at the beginning of the region, drag to the end of the region 1297Left click at the beginning of the region, drag to the end of the region
1208and release; Right click to extend the marked region; Left double-click 1298and release; Right click to extend the marked region; Left double-click
1209to select a word; Left triple-click to select the entire logical line 1299to select a word; Left triple-click to select the entire logical line
1210(which can span multiple screen lines), unless modified by resource 1300(which can span multiple screen lines), unless modified by resource
1211\&\fBtripleclickwords\fR. 1301\&\fBtripleclickwords\fR.
1213Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys) 1303Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys)
1214(Compile: \fIfrills\fR) will create a rectangular selection instead of a 1304(Compile: \fIfrills\fR) will create a rectangular selection instead of a
1215normal one. In this mode, every selected row becomes its own line in the 1305normal one. In this mode, every selected row becomes its own line in the
1216selection, and trailing whitespace is visually underlined and removed from 1306selection, and trailing whitespace is visually underlined and removed from
1217the selection. 1307the selection.
1218.IP "\fBInsertion\fR:" 4 1308.IP "\fBPasting\fR:" 4
1219.IX Item "Insertion:" 1309.IX Item "Pasting:"
1220Pressing and releasing the Middle mouse button in an \fB@@RXVT_NAME@@\fR 1310Pressing and releasing the Middle mouse button in an \fB@@RXVT_NAME@@\fR
1221window causes the value of the \s-1PRIMARY\s0 selection (or \s-1CLIPBOARD\s0 with the 1311window causes the value of the \s-1PRIMARY\s0 selection (or \s-1CLIPBOARD\s0 with the
1222Meta modifier) to be inserted as if it had been typed on the keyboard. 1312\&\fBMeta\fR modifier) to be inserted as if it had been typed on the keyboard.
1223.Sp 1313.Sp
1224Pressing \fBShift-Insert\fR causes the value of the \s-1PRIMARY\s0 selection to be 1314Pressing \fBShift-Insert\fR causes the value of the \s-1PRIMARY\s0 selection to be
1225inserted too. 1315inserted too.
1226.SH "CHANGING FONTS" 1316.SH "CHANGING FONTS"
1227.IX Header "CHANGING FONTS" 1317.IX Header "CHANGING FONTS"
1244rxvt-unicode will automatically re-apply these fonts to the output so far. 1334rxvt-unicode will automatically re-apply these fonts to the output so far.
1245.SH "ISO 14755 SUPPORT" 1335.SH "ISO 14755 SUPPORT"
1246.IX Header "ISO 14755 SUPPORT" 1336.IX Header "ISO 14755 SUPPORT"
1247\&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters 1337\&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters
1248and character codes using the keyboard. It consists of 4 parts. The 1338and character codes using the keyboard. It consists of 4 parts. The
1249first part is available rxvt-unicode has been compiled with 1339first part is available if rxvt-unicode has been compiled with
1250\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled 1340\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled
1251with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR. 1341with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR.
1252.IP "* 5.1: Basic method" 4 1342.IP "* 5.1: Basic method" 4
1253.IX Item "5.1: Basic method" 1343.IX Item "5.1: Basic method"
1254This allows you to enter unicode characters using their hexcode. 1344This allows you to enter unicode characters using their hexcode.
1270This mode lets you input characters representing the keycap symbols of 1360This mode lets you input characters representing the keycap symbols of
1271your keyboard, if representable in the current locale encoding. 1361your keyboard, if representable in the current locale encoding.
1272.Sp 1362.Sp
1273Start by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then releasing 1363Start by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then releasing
1274them. The next special key (cursor keys, home etc.) you enter will not 1364them. The next special key (cursor keys, home etc.) you enter will not
1275invoke it's usual function but instead will insert the corresponding 1365invoke its usual function but instead will insert the corresponding
1276keycap symbol. The symbol will only be entered when the key has been 1366keycap symbol. The symbol will only be entered when the key has been
1277released, otherwise pressing e.g. \f(CW\*(C`Shift\*(C'\fR would enter the symbol for 1367released, otherwise pressing e.g. \f(CW\*(C`Shift\*(C'\fR would enter the symbol for
1278\&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a 1368\&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a
1279reverse tab (Shift\-Tab). 1369reverse tab (Shift\-Tab).
1280.IP "* 5.3: Screen-selection entry method" 4 1370.IP "* 5.3: Screen-selection entry method" 4
1336It is also possible to specify the colour values of \fBforeground\fR, 1426It is also possible to specify the colour values of \fBforeground\fR,
1337\&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as 1427\&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as
1338a number 0\-15, as a convenient shorthand to reference the colour name of 1428a number 0\-15, as a convenient shorthand to reference the colour name of
1339color0\-color15. 1429color0\-color15.
1340.PP 1430.PP
1341If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1431In addition to the colours defined above, @@RXVT_NAME@@ offers an
1342their act together, rxvt-unicode will support \f(CW\*(C`rgba:rrrr/gggg/bbbb/aaaa\*(C'\fR 1432additional 72 colours. The first 64 of those (with indices 16 to 79)
1343(recommended, but \fB\s-1MUST\s0\fR have 4 digits/component), \f(CW\*(C`#ARGB\*(C'\fR, \f(CW\*(C`#AARRGGBB\*(C'\fR 1433consist of a 4*4*4 \s-1RGB\s0 colour cube (i.e. \fIindex = r * 16 + g * 4 + b +
1344and \f(CW\*(C`#AAAARRRRGGGGBBBB\*(C'\fR colour specifications, in addition to the ones 143416\fR), followed by 8 additional shades of gray (with indices 80 to 87).
1345provided by X, where the additional A component specifies alpha (opacity) 1435.PP
1346values (0 is completely transparent and the maximum is opaque). You 1436Together, all those colours implement the 88 colour xterm colours. Only
1347probably need to specify \fB\*(L"\-depth 32\*(R"\fR, too, and have the luck that your 1437the first 16 can be changed using resources currently, the rest can only
1348X\-server uses \s-1ARGB\s0 pixel layout, as X is far from just supporting \s-1ARGB\s0 1438be changed via command sequences (\*(L"escape codes\*(R").
1349visuals out of the box, and rxvt-unicode just fudges around.
1350.PP 1439.PP
1351Note that \fB\-rv\fR (\fB\*(L"reverseVideo: True\*(R"\fR) simulates reverse video by 1440Note that \fB\-rv\fR (\fB\*(L"reverseVideo: True\*(R"\fR) simulates reverse video by
1352always swapping the foreground/background colours. This is in contrast to 1441always swapping the foreground/background colours. This is in contrast to
1353\&\fIxterm\fR(1) where the colours are only swapped if they have not otherwise 1442\&\fIxterm\fR(1) where the colours are only swapped if they have not otherwise
1354been specified. For example, 1443been specified. For example,
1355.IP "\fB@@RXVT_NAME@@ \-fg Black \-bg White \-rv\fR" 4 1444.IP "\fB@@RXVT_NAME@@ \-fg Black \-bg White \-rv\fR" 4
1356.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv" 1445.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv"
1357would yield White on Black, while on \fIxterm\fR(1) it would yield Black 1446would yield White on Black, while on \fIxterm\fR(1) it would yield Black
1358on White. 1447on White.
1448.Sh "\s-1ALPHA\s0 \s-1CHANNEL\s0 \s-1SUPPORT\s0"
1449.IX Subsection "ALPHA CHANNEL SUPPORT"
1450If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1451their act together, rxvt-unicode will support \f(CW\*(C`rgba:rrrr/gggg/bbbb/aaaa\*(C'\fR
1452(recommended, but \fB\s-1MUST\s0\fR have 4 digits/component) colour specifications,
1453in addition to the ones provided by X, where the additional A component
1454specifies opacity (alpha) values. The minimum value of \f(CW0\fR is completely
1455transparent). You can also prefix any color with \f(CW\*(C`[percent]\*(C'\fR, where
1456\&\f(CW\*(C`percent\*(C'\fR is a decimal percentage (0\-100) that specifies the opacity of
1457the color, where \f(CW0\fR is completely transparent and \f(CW100\fR is completelxy
1458opaque.
1459.PP
1460You probably need to specify \fB\*(L"\-depth 32\*(R"\fR, too, and have the luck that
1461your X\-server uses \s-1ARGB\s0 pixel layout, as X is far from just supporting
1462\&\s-1ARGB\s0 visuals out of the box, and rxvt-unicode just fudges around.
1463.PP
1464For example, the following selects an almost completely transparent red
1465background, and an almost opaque pink foreground:
1466.PP
1467.Vb 1
1468\& @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1469.Ve
1470.PP
1471\&\fIPlease note that transparency of any kind if completely unsupported by
1472the author. Don't bug him with installation questions!\fR
1359.SH "ENVIRONMENT" 1473.SH "ENVIRONMENT"
1360.IX Header "ENVIRONMENT" 1474.IX Header "ENVIRONMENT"
1361\&\fB@@RXVT_NAME@@\fR sets and/or uses the following environment variables: 1475\&\fB@@RXVT_NAME@@\fR sets and/or uses the following environment variables:
1362.IP "\fB\s-1TERM\s0\fR" 4 1476.IP "\fB\s-1TERM\s0\fR" 4
1363.IX Item "TERM" 1477.IX Item "TERM"
1364Normally set to \f(CW\*(C`rxvt\-unicode\*(C'\fR, unless overwritten at configure time, via 1478Normally set to \f(CW\*(C`rxvt\-unicode\*(C'\fR, unless overwritten at configure time, via
1365resources or on the commandline. 1479resources or on the command line.
1366.IP "\fB\s-1COLORTERM\s0\fR" 4 1480.IP "\fB\s-1COLORTERM\s0\fR" 4
1367.IX Item "COLORTERM" 1481.IX Item "COLORTERM"
1368Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on wether @@RXVT_NAME@@ was 1482Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on whether @@RXVT_NAME@@ was
1369compiled with \s-1XPM\s0 support, and optionally with the added extension 1483compiled with background image support, and optionally with the added
1370\&\f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome screen. 1484extension \f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome
1485screen.
1371.IP "\fB\s-1COLORFGBG\s0\fR" 4 1486.IP "\fB\s-1COLORFGBG\s0\fR" 4
1372.IX Item "COLORFGBG" 1487.IX Item "COLORFGBG"
1373Set to a string of the form \f(CW\*(C`fg;bg\*(C'\fR or \f(CW\*(C`fg;xpm;bg\*(C'\fR, where \f(CW\*(C`fg\*(C'\fR is 1488Set to a string of the form \f(CW\*(C`fg;bg\*(C'\fR or \f(CW\*(C`fg;xpm;bg\*(C'\fR, where \f(CW\*(C`fg\*(C'\fR is
1374the colour code used as default foreground/text colour (or the string 1489the colour code used as default foreground/text colour (or the string
1375\&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be 1490\&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be
1376used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the 1491used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the
1377string \f(CW\*(C`default\*(C'\fR), and \f(CW\*(C`xpm\*(C'\fR is the string \f(CW\*(C`default\*(C'\fR if @@RXVT_NAME@@ 1492string \f(CW\*(C`default\*(C'\fR), and \f(CW\*(C`xpm\*(C'\fR is the string \f(CW\*(C`default\*(C'\fR if @@RXVT_NAME@@
1378was compiled with \s-1XPM\s0 support. Libraries like \f(CW\*(C`ncurses\*(C'\fR and \f(CW\*(C`slang\*(C'\fR can 1493was compiled with background image support. Libraries like \f(CW\*(C`ncurses\*(C'\fR
1379(and do) use this information to optimize screen output. 1494and \f(CW\*(C`slang\*(C'\fR can (and do) use this information to optimize screen output.
1380.IP "\fB\s-1WINDOWID\s0\fR" 4 1495.IP "\fB\s-1WINDOWID\s0\fR" 4
1381.IX Item "WINDOWID" 1496.IX Item "WINDOWID"
1382Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel 1497Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel
1383window, which usually has subwindows for the scrollbar, the terminal 1498window, which usually has subwindows for the scrollbar, the terminal
1384window and so on). 1499window and so on).
1387Set to the terminfo directory iff @@RXVT_NAME@@ was configured with 1502Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1388\&\f(CW\*(C`\-\-with\-terminfo=PATH\*(C'\fR. 1503\&\f(CW\*(C`\-\-with\-terminfo=PATH\*(C'\fR.
1389.IP "\fB\s-1DISPLAY\s0\fR" 4 1504.IP "\fB\s-1DISPLAY\s0\fR" 4
1390.IX Item "DISPLAY" 1505.IX Item "DISPLAY"
1391Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1506Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1392display in it's child processes. 1507display in its child processes.
1393.IP "\fB\s-1SHELL\s0\fR" 4 1508.IP "\fB\s-1SHELL\s0\fR" 4
1394.IX Item "SHELL" 1509.IX Item "SHELL"
1395The shell to be used for command execution, defaults to \f(CW\*(C`/bin/sh\*(C'\fR. 1510The shell to be used for command execution, defaults to \f(CW\*(C`/bin/sh\*(C'\fR.
1396.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4 1511.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
1397.IX Item "RXVT_SOCKET" 1512.IX Item "RXVT_SOCKET"
1423.IX Header "CURRENT PROJECT COORDINATOR" 1538.IX Header "CURRENT PROJECT COORDINATOR"
1424.IP "Project Coordinator" 4 1539.IP "Project Coordinator" 4
1425.IX Item "Project Coordinator" 1540.IX Item "Project Coordinator"
1426Marc A. Lehmann <rxvt\-unicode@schmorp.de> 1541Marc A. Lehmann <rxvt\-unicode@schmorp.de>
1427.Sp 1542.Sp
1428<http://software.schmorp.de/#rxvt\-unicode> 1543<http://software.schmorp.de/pkg/rxvt\-unicode.html>
1429.SH "AUTHORS" 1544.SH "AUTHORS"
1430.IX Header "AUTHORS" 1545.IX Header "AUTHORS"
1431.IP "John Bovey" 4 1546.IP "John Bovey" 4
1432.IX Item "John Bovey" 1547.IX Item "John Bovey"
1433University of Kent, 1992, wrote the original Xvt. 1548University of Kent, 1992, wrote the original Xvt.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines