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.51 by root, Fri Jan 20 22:49:33 2006 UTC vs.
Revision 1.78 by root, Mon Dec 24 08:00:16 2007 UTC

1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3 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-20" "7.1" "RXVT-UNICODE" 132.TH @@RXVT_NAME@@ 1 "2007-12-24" "8.9" "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
214.IP "\fB\-display\fR \fIdisplayname\fR" 4 217.IP "\fB\-display\fR \fIdisplayname\fR" 4
215.IX Item "-display displayname" 218.IX Item "-display displayname"
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.
222.IP "\fB\-depth\fR \fIbitdepth\fR" 4
223.IX Item "-depth bitdepth"
224Compile \fIxft\fR: Attempt to find a visual with the given bit depth;
225resource \fBdepth\fR.
219.IP "\fB\-geometry\fR \fIgeom\fR" 4 226.IP "\fB\-geometry\fR \fIgeom\fR" 4
220.IX Item "-geometry geom" 227.IX Item "-geometry geom"
221Window geometry (\fB\-g\fR still respected); resource \fBgeometry\fR. 228Window geometry (\fB\-g\fR still respected); resource \fBgeometry\fR.
222.IP "\fB\-rv\fR|\fB+rv\fR" 4 229.IP "\fB\-rv\fR|\fB+rv\fR" 4
223.IX Item "-rv|+rv" 230.IX Item "-rv|+rv"
224Turn on/off simulated reverse video; resource \fBreverseVideo\fR. 231Turn on/off simulated reverse video; resource \fBreverseVideo\fR.
225.IP "\fB\-j\fR|\fB+j\fR" 4 232.IP "\fB\-j\fR|\fB+j\fR" 4
226.IX Item "-j|+j" 233.IX Item "-j|+j"
227Turn on/off jump scrolling; resource \fBjumpScroll\fR. 234Turn on/off jump scrolling (allow multiple lines per refresh); resource \fBjumpScroll\fR.
228.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
229.IX Item "-ip|+ip | -tr|+tr" 239.IX Item "-tr|+tr"
230Turn on/off inheriting parent window's pixmap. Alternative form is 240Turn on/off illusion of a transparent window background; resource \fBtransparent\fR.
231\&\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
232.IP "\fB\-fade\fR \fInumber\fR" 4 247.IP "\fB\-fade\fR \fInumber\fR" 4
233.IX Item "-fade number" 248.IX Item "-fade number"
234Fade 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
235fade a little only, 100 completely replaces all colours by the fade 250fade a little only, 100 completely replaces all colours by the fade
236colour; resource \fBfading\fR. 251colour; resource \fBfading\fR.
237.IP "\fB\-fadecolor\fR \fIcolour\fR" 4 252.IP "\fB\-fadecolor\fR \fIcolour\fR" 4
238.IX Item "-fadecolor colour" 253.IX Item "-fadecolor colour"
239Fade 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
240is black. resource \fBfadeColor\fR. 255is opaque black. resource \fBfadeColor\fR.
241.IP "\fB\-tint\fR \fIcolour\fR" 4 256.IP "\fB\-tint\fR \fIcolour\fR" 4
242.IX Item "-tint colour" 257.IX Item "-tint colour"
243Tint the transparent background pixmap with the given colour when 258Tint the transparent background pixmap with the given colour when
244transparency 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
245non-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
246used 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
247\&\fItintColor\fR. Example: 266\&\fItintColor\fR. Example:
248.Sp 267.Sp
249.Vb 1 268.Vb 1
250\& @@RXVT_NAME@@ -tr -tint blue -sh 40 269\& @@RXVT_NAME@@ -tr -tint blue -sh 40
251.Ve 270.Ve
252.IP "\fB\-sh\fR" 4 271.IP "\fB\-sh\fR \fInumber\fR" 4
253.IX Item "-sh" 272.IX Item "-sh number"
254\&\fInumber\fR Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent 273Darken (0 .. 100) or lighten (100 .. 200) the transparent
255background image in addition to tinting it (i.e. \fB\-tint\fR must be 274background image in addition to (or instead of) tinting it;
256specified, 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.
257.IP "\fB\-bg\fR \fIcolour\fR" 4 293.IP "\fB\-bg\fR \fIcolour\fR" 4
258.IX Item "-bg colour" 294.IX Item "-bg colour"
259Window background colour; resource \fBbackground\fR. 295Window background colour; resource \fBbackground\fR.
260.IP "\fB\-fg\fR \fIcolour\fR" 4 296.IP "\fB\-fg\fR \fIcolour\fR" 4
261.IX Item "-fg colour" 297.IX Item "-fg colour"
262Window foreground colour; resource \fBforeground\fR. 298Window foreground colour; resource \fBforeground\fR.
263.IP "\fB\-pixmap\fR \fIfile[;geom]\fR" 4 299.IP "\fB\-pixmap\fR \fIfile[;geom[:op1][:op2][...]]\fR" 4
264.IX Item "-pixmap file[;geom]" 300.IX Item "-pixmap file[;geom[:op1][:op2][...]]"
265Compile \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
266specify its scaling with a geometry string. Note you may need to 302optionally specify its scaling with a geometry string. Note you may need to
267add 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
268command\-line; resource \fBbackgroundPixmap\fR. 304command\-line; for more details see resource \fBbackgroundPixmap\fR.
269.IP "\fB\-cr\fR \fIcolour\fR" 4 305.IP "\fB\-cr\fR \fIcolour\fR" 4
270.IX Item "-cr colour" 306.IX Item "-cr colour"
271The cursor colour; resource \fBcursorColor\fR. 307The cursor colour; resource \fBcursorColor\fR.
272.IP "\fB\-pr\fR \fIcolour\fR" 4 308.IP "\fB\-pr\fR \fIcolour\fR" 4
273.IX Item "-pr colour" 309.IX Item "-pr colour"
285that 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
286first font defines the cell size for characters; other fonts might be 322first font defines the cell size for characters; other fonts might be
287smaller, but not (in general) larger. A (hopefully) reasonable default 323smaller, but not (in general) larger. A (hopefully) reasonable default
288font 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.
289.Sp 325.Sp
290In 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
291with \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,
292e.g.: 328e.g.:
293.Sp 329.Sp
294.Vb 2 330.Vb 2
295\& @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 331\& @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
311Compile \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
312italic\fB\fR characters are to be printed. See resource \fBboldItalicFont\fR 348italic\fB\fR characters are to be printed. See resource \fBboldItalicFont\fR
313for details. 349for details.
314.IP "\fB\-is\fR|\fB+is\fR" 4 350.IP "\fB\-is\fR|\fB+is\fR" 4
315.IX Item "-is|+is" 351.IX Item "-is|+is"
316Compile \fIfont-styles\fR: Bold/Italic font styles imply high intensity 352Compile \fIfont-styles\fR: Bold/Blink font styles imply high intensity
317foreground/background (default). See resource \fBintensityStyles\fR for 353foreground/background (default). See resource \fBintensityStyles\fR for
318details. 354details.
319.IP "\fB\-name\fR \fIname\fR" 4 355.IP "\fB\-name\fR \fIname\fR" 4
320.IX Item "-name name" 356.IX Item "-name name"
321Specify the application name under which resources are to be obtained, 357Specify the application name under which resources are to be obtained,
399resource \fBskipBuiltinGlyphs\fR. 435resource \fBskipBuiltinGlyphs\fR.
400.IP "\fB\-lsp\fR \fInumber\fR" 4 436.IP "\fB\-lsp\fR \fInumber\fR" 4
401.IX Item "-lsp number" 437.IX Item "-lsp number"
402Compile \fIfrills\fR: Lines (pixel height) to insert between each row of 438Compile \fIfrills\fR: Lines (pixel height) to insert between each row of
403the display. Useful to work around font rendering problems; resource 439the display. Useful to work around font rendering problems; resource
404\&\fBlinespace\fR. 440\&\fBlineSpace\fR.
405.IP "\fB\-tn\fR \fItermname\fR" 4 441.IP "\fB\-tn\fR \fItermname\fR" 4
406.IX Item "-tn termname" 442.IX Item "-tn termname"
407This 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
408\&\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
409\&\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;
455Set 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
456for more info. 492for more info.
457.IP "\fB\-tcw\fR" 4 493.IP "\fB\-tcw\fR" 4
458.IX Item "-tcw" 494.IX Item "-tcw"
459Change 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
460button. 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
461end of the logical line only. resource \fBtripleclickwords\fR. 498the end of the logical line only. resource \fBtripleclickwords\fR.
462.IP "\fB\-insecure\fR" 4 499.IP "\fB\-insecure\fR" 4
463.IX Item "-insecure" 500.IX Item "-insecure"
464Enable \*(L"insecure\*(R" mode, which currently enables most of the escape 501Enable \*(L"insecure\*(R" mode, which currently enables most of the escape
465sequences that echo strings. See the resource \fBinsecure\fR for more 502sequences that echo strings. See the resource \fBinsecure\fR for more
466info. 503info.
481.IX Item "-hold|+hold" 518.IX Item "-hold|+hold"
482Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 519Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
483will not immediately destroy its window when the program executed within 520will not immediately destroy its window when the program executed within
484it 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
485user; 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.
486.IP "\fB\-keysym.\fR\fIsym\fR \fIstring\fR" 4 535.IP "\fB\-keysym.\fR\fIsym\fR \fIstring\fR" 4
487.IX Item "-keysym.sym string" 536.IX Item "-keysym.sym string"
488Remap a key symbol. See resource \fBkeysym\fR. 537Remap a key symbol. See resource \fBkeysym\fR.
489.IP "\fB\-embed\fR \fIwindowid\fR" 4 538.IP "\fB\-embed\fR \fIwindowid\fR" 4
490.IX Item "-embed windowid" 539.IX Item "-embed windowid"
491Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 540Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
492which enables applications to easily embed a terminal. 541which enables applications to easily embed a terminal.
493.Sp 542.Sp
494Right 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
495shouldn'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
496quite 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
499The window will not be destroyed when @@RXVT_NAME@@ exits. 548The window will not be destroyed when @@RXVT_NAME@@ exits.
500.Sp 549.Sp
501It 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
502descriptors 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
503can use file descriptors to communicate with the programs within the 552can use file descriptors to communicate with the programs within the
504terminal. 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
505not. 554not.
506.Sp 555.Sp
507Here 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
508used (a longer example is in \fIdoc/embed\fR): 557used (a longer example is in \fIdoc/embed\fR):
509.Sp 558.Sp
515\& }); 564\& });
516.Ve 565.Ve
517.IP "\fB\-pty\-fd\fR \fIfile descriptor\fR" 4 566.IP "\fB\-pty\-fd\fR \fIfile descriptor\fR" 4
518.IX Item "-pty-fd file descriptor" 567.IX Item "-pty-fd file descriptor"
519Tells @@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
520pair 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
521useful 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
522without having to run a program within it. 571without having to run a program within it.
523.Sp 572.Sp
524If 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
525entries 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
526yourself if you want that. 575yourself if you want that.
527.Sp 576.Sp
528As 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
529pty/tty operations. 578pty/tty operations, which is probably only useful in conjunction with some
579perl extension that manages the terminal.
530.Sp 580.Sp
531Here 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
532longer example is in \fIdoc/pty\-fd\fR): 582longer example is in \fIdoc/pty\-fd\fR):
533.Sp 583.Sp
534.Vb 2 584.Vb 2
550.Ve 600.Ve
551.IP "\fB\-pe\fR \fIstring\fR" 4 601.IP "\fB\-pe\fR \fIstring\fR" 4
552.IX Item "-pe string" 602.IX Item "-pe string"
553Comma-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
554this terminal instance. See resource \fBperl-ext\fR for details. 604this terminal instance. See resource \fBperl-ext\fR for details.
555.SH "RESOURCES (available also as long\-options)" 605.SH "RESOURCES"
556.IX Header "RESOURCES (available also as long-options)" 606.IX Header "RESOURCES"
557Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long 607Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long
558options) compiled into your version. 608options) compiled into your version. All resources are also available as
609long\-options.
559.PP 610.PP
560You 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
561distribution 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
562starts. @@RXVT_NAME@@ will consult the following files/resources in order, 613starts. @@RXVT_NAME@@ will consult the following files/resources in order,
563with later settings overwriting earlier ones: 614with later settings overwriting earlier ones:
564.PP 615.PP
565.Vb 5 616.Vb 6
566\& 1. system-wide app-defaults file, either locale-dependent OR global 617\& 1. system-wide app-defaults file, either locale-dependent OR global
567\& 2. app-defaults file in $XAPPLRESDIR 618\& 2. app-defaults file in $XAPPLRESDIR
568\& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 619\& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
569\& 4. SCREEN_RESOURCES for the current screen 620\& 4. SCREEN_RESOURCES for the current screen
570\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 621\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
622\& 6. resources specified via -xrm on the commandline
571.Ve 623.Ve
572.PP 624.PP
573Note 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
574names: \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
575common 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
578configurations. If no resources are specified, suitable defaults will 630configurations. If no resources are specified, suitable defaults will
579be used. Command-line arguments can be used to override resource 631be used. Command-line arguments can be used to override resource
580settings. The following resources are supported (you might want to 632settings. The following resources are supported (you might want to
581check 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
582extensions not documented here): 634extensions not documented here):
635.IP "\fBdepth:\fR \fIbitdepth\fR" 4
636.IX Item "depth: bitdepth"
637Compile \fIxft\fR: Attempt to find a visual with the given bit depth;
638option \fB\-depth\fR.
583.IP "\fBgeometry:\fR \fIgeom\fR" 4 639.IP "\fBgeometry:\fR \fIgeom\fR" 4
584.IX Item "geometry: geom" 640.IX Item "geometry: geom"
585Create the window with the specified X window geometry [default 80x24]; 641Create the window with the specified X window geometry [default 80x24];
586option \fB\-geometry\fR. 642option \fB\-geometry\fR.
587.IP "\fBbackground:\fR \fIcolour\fR" 4 643.IP "\fBbackground:\fR \fIcolour\fR" 4
619.IX Item "colorUL: colour" 675.IX Item "colorUL: colour"
620Use the specified colour to display underlined characters when the 676Use the specified colour to display underlined characters when the
621foreground colour is the default. 677foreground colour is the default.
622.IP "\fBcolorRV:\fR \fIcolour\fR" 4 678.IP "\fBcolorRV:\fR \fIcolour\fR" 4
623.IX Item "colorRV: colour" 679.IX Item "colorRV: colour"
624Use the specified colour as the background for reverse video 680Use the specified colour as the background for reverse video characters
625characters. 681when \s-1OPTION_HC\s0 is disabled (\-\-disable\-frills).
626.IP "\fBunderlineColor:\fR \fIcolour\fR" 4 682.IP "\fBunderlineColor:\fR \fIcolour\fR" 4
627.IX Item "underlineColor: colour" 683.IX Item "underlineColor: colour"
628If set, use the specified colour as the colour for the underline 684If set, use the specified colour as the colour for the underline
629itself. If unset, use the foreground colour. 685itself. If unset, use the foreground colour.
630.IP "\fBcursorColor:\fR \fIcolour\fR" 4 686.IP "\fBcursorColor:\fR \fIcolour\fR" 4
641\&\fBTrue\fR: simulate reverse video by foreground and background colours; 697\&\fBTrue\fR: simulate reverse video by foreground and background colours;
642option \fB\-rv\fR. \fBFalse\fR: regular screen colours [default]; option 698option \fB\-rv\fR. \fBFalse\fR: regular screen colours [default]; option
643\&\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.
644.IP "\fBjumpScroll:\fR \fIboolean\fR" 4 700.IP "\fBjumpScroll:\fR \fIboolean\fR" 4
645.IX Item "jumpScroll: boolean" 701.IX Item "jumpScroll: boolean"
646\&\fBTrue\fR: specify that jump scrolling should be used. When scrolling 702\&\fBTrue\fR: specify that jump scrolling should be used. When receiving lots
647quickly, 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
648\&\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.
649.IP "\fBinheritPixmap:\fR \fIboolean\fR" 4 720.IP "\fBtransparent:\fR \fIboolean\fR" 4
650.IX Item "inheritPixmap: boolean" 721.IX Item "transparent: boolean"
651\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving 722Turn on/off illusion of a transparent window background.
652artificial transparency. \fBFalse\fR: do not inherit the parent windows' 723.Sp
653pixmap. 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
654.IP "\fBfading:\fR \fInumber\fR" 4 729.IP "\fBfading:\fR \fInumber\fR" 4
655.IX Item "fading: number" 730.IX Item "fading: number"
656Fade 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.
657.IP "\fBfadeColor:\fR \fIcolour\fR" 4 732.IP "\fBfadeColor:\fR \fIcolour\fR" 4
658.IX Item "fadeColor: colour" 733.IX Item "fadeColor: colour"
662.IX Item "tintColor: colour" 737.IX Item "tintColor: colour"
663Tint the transparent background pixmap with the given colour; option 738Tint the transparent background pixmap with the given colour; option
664\&\fB\-tint\fR. 739\&\fB\-tint\fR.
665.IP "\fBshading:\fR \fInumber\fR" 4 740.IP "\fBshading:\fR \fInumber\fR" 4
666.IX Item "shading: number" 741.IX Item "shading: number"
667Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background 742Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background image
668image 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.
669.IP "\fBscrollColor:\fR \fIcolour\fR" 4 751.IP "\fBscrollColor:\fR \fIcolour\fR" 4
670.IX Item "scrollColor: colour" 752.IX Item "scrollColor: colour"
671Use the specified colour for the scrollbar [default #B2B2B2]. 753Use the specified colour for the scrollbar [default #B2B2B2].
672.IP "\fBtroughColor:\fR \fIcolour\fR" 4 754.IP "\fBtroughColor:\fR \fIcolour\fR" 4
673.IX Item "troughColor: colour" 755.IX Item "troughColor: colour"
675#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar. 757#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
676.IP "\fBborderColor:\fR \fIcolour\fR" 4 758.IP "\fBborderColor:\fR \fIcolour\fR" 4
677.IX Item "borderColor: colour" 759.IX Item "borderColor: colour"
678The 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
679and the text. 761and the text.
680.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4 762.IP "\fBbackgroundPixmap:\fR \fIfile[;geom[:op1][:op2][...]]\fR" 4
681.IX Item "backgroundPixmap: file[;geom]" 763.IX Item "backgroundPixmap: file[;geom[:op1][:op2][...]]"
682Use the specified \s-1XPM\s0 file (note the `.xpm' extension is optional) for 764Use the specified image file for the background and also
683the background and also optionally specify its scaling with a geometry 765optionally specify its scaling with a geometry string \fBWxH+X+Y\fR,
684string \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
685horizontal/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
686centre (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
687of 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
688specifies an integer number of images in that direction. No image will 770an integer number of images in that direction. No image will be magnified
689be magnified beyond 10 times its original size. The maximum permitted 771beyond 10 times its original size. The maximum permitted scale is 1000.
690scale 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.
691.IP "\fBpath:\fR \fIpath\fR" 4 789.IP "\fBpath:\fR \fIpath\fR" 4
692.IX Item "path: path" 790.IX Item "path: path"
693Specify the colon-delimited search path for finding \s-1XPM\s0 files. 791Specify the colon-delimited search path for finding background image files.
694.IP "\fBfont:\fR \fIfontlist\fR" 4 792.IP "\fBfont:\fR \fIfontlist\fR" 4
695.IX Item "font: fontlist" 793.IX Item "font: fontlist"
696Select 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
697that 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
698first font defines the cell size for characters; other fonts might be 796first font defines the cell size for characters; other fonts might be
756If 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
757text font will being used for the given style. 855text font will being used for the given style.
758.IP "\fBintensityStyles:\fR \fIboolean\fR" 4 856.IP "\fBintensityStyles:\fR \fIboolean\fR" 4
759.IX Item "intensityStyles: boolean" 857.IX Item "intensityStyles: boolean"
760When 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,
761option \fB\-is\fR, the default), bold and italic font styles imply high 859option \fB\-is\fR, the default), bold/blink font styles imply high
762intensity foreground/backround colours. Disabling this option (\fBFalse\fR, 860intensity foreground/background colours. Disabling this option (\fBFalse\fR,
763option \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
764reachable. 862reachable.
765.IP "\fBselectstyle:\fR \fImode\fR" 4
766.IX Item "selectstyle: mode"
767Set mouse selection style to \fBold\fR which is 2.20, \fBoldword\fR which is
768xterm style with 2.20 old word selection, or anything else which gives
769xterm style selection.
770.IP "\fBscrollstyle:\fR \fImode\fR" 4 863.IP "\fBscrollstyle:\fR \fImode\fR" 4
771.IX Item "scrollstyle: mode" 864.IX Item "scrollstyle: mode"
772Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is 865Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is
773the author's favourite. 866the author's favourite.
774.IP "\fBtitle:\fR \fIstring\fR" 4 867.IP "\fBtitle:\fR \fIstring\fR" 4
783set; option \fB\-n\fR. 876set; option \fB\-n\fR.
784.IP "\fBmapAlert:\fR \fIboolean\fR" 4 877.IP "\fBmapAlert:\fR \fIboolean\fR" 4
785.IX Item "mapAlert: boolean" 878.IX Item "mapAlert: boolean"
786\&\fBTrue\fR: de-iconify (map) on receipt of a bell character. \fBFalse\fR: no 879\&\fBTrue\fR: de-iconify (map) on receipt of a bell character. \fBFalse\fR: no
787de-iconify (map) on receipt of a bell character [default]. 880de-iconify (map) on receipt of a bell character [default].
881.IP "\fBurgentOnBell:\fR \fIboolean\fR" 4
882.IX Item "urgentOnBell: boolean"
883\&\fBTrue\fR: set the urgency hint for the wm on receipt of a bell character.
884\&\fBFalse\fR: do not set the urgency hint [default].
788.IP "\fBvisualBell:\fR \fIboolean\fR" 4 885.IP "\fBvisualBell:\fR \fIboolean\fR" 4
789.IX Item "visualBell: boolean" 886.IX Item "visualBell: boolean"
790\&\fBTrue\fR: use visual bell on receipt of a bell character; option \fB\-vb\fR. 887\&\fBTrue\fR: use visual bell on receipt of a bell character; option \fB\-vb\fR.
791\&\fBFalse\fR: no visual bell [default]; option \fB+vb\fR. 888\&\fBFalse\fR: no visual bell [default]; option \fB+vb\fR.
792.IP "\fBloginShell:\fR \fIboolean\fR" 4 889.IP "\fBloginShell:\fR \fIboolean\fR" 4
812.Vb 1 909.Vb 1
813\& URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 910\& URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
814.Ve 911.Ve
815.Sp 912.Sp
816This creates a new file in your home directory with the screen contents 913This creates a new file in your home directory with the screen contents
817everytime you hit \f(CW\*(C`Print\*(C'\fR. 914every time you hit \f(CW\*(C`Print\*(C'\fR.
818.IP "\fBscrollBar:\fR \fIboolean\fR" 4 915.IP "\fBscrollBar:\fR \fIboolean\fR" 4
819.IX Item "scrollBar: boolean" 916.IX Item "scrollBar: boolean"
820\&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR: 917\&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR:
821disable the scrollbar; option \fB+sb\fR. 918disable the scrollbar; option \fB+sb\fR.
822.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4 919.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4
838\&\fB+si\fR. 935\&\fB+si\fR.
839.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4 936.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4
840.IX Item "scrollWithBuffer: boolean" 937.IX Item "scrollWithBuffer: boolean"
841\&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and 938\&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and
842\&\fBscrollTtyOutput\fR is False); option \fB\-sw\fR. \fBFalse\fR: do not scroll 939\&\fBscrollTtyOutput\fR is False); option \fB\-sw\fR. \fBFalse\fR: do not scroll
843with scrollback buffer when tty recieves new lines; option \fB+sw\fR. 940with scrollback buffer when tty receives new lines; option \fB+sw\fR.
844.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4 941.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4
845.IX Item "scrollTtyKeypress: boolean" 942.IX Item "scrollTtyKeypress: boolean"
846\&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys 943\&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys
847are those which are intercepted by rxvt-unicode for special handling and 944are those which are intercepted by rxvt-unicode for special handling and
848are not passed onto the shell; option \fB\-sk\fR. \fBFalse\fR: do not scroll to 945are not passed onto the shell; option \fB\-sk\fR. \fBFalse\fR: do not scroll to
871option \fB\-sbg\fR. 968option \fB\-sbg\fR.
872.IP "\fBtermName:\fR \fItermname\fR" 4 969.IP "\fBtermName:\fR \fItermname\fR" 4
873.IX Item "termName: termname" 970.IX Item "termName: termname"
874Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment 971Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment
875variable; option \fB\-tn\fR. 972variable; option \fB\-tn\fR.
876.IP "\fBlinespace:\fR \fInumber\fR" 4 973.IP "\fBlineSpace:\fR \fInumber\fR" 4
877.IX Item "linespace: number" 974.IX Item "lineSpace: number"
878Specifies number of lines (pixel height) to insert between each row of 975Specifies number of lines (pixel height) to insert between each row of
879the display [default 0]; option \fB\-lsp\fR. 976the display [default 0]; option \fB\-lsp\fR.
880.IP "\fBmeta8:\fR \fIboolean\fR" 4 977.IP "\fBmeta8:\fR \fIboolean\fR" 4
881.IX Item "meta8: boolean" 978.IX Item "meta8: boolean"
882\&\fBTrue\fR: handle Meta (Alt) + keypress to set the 8th bit. \fBFalse\fR: 979\&\fBTrue\fR: handle Meta (Alt) + keypress to set the 8th bit. \fBFalse\fR:
919The string to send when the delete key (not the keypad delete key) is 1016The string to send when the delete key (not the keypad delete key) is
920pressed. If unset it will send the sequence traditionally associated 1017pressed. If unset it will send the sequence traditionally associated
921with the \fBExecute\fR key. 1018with the \fBExecute\fR key.
922.IP "\fBcutchars:\fR \fIstring\fR" 4 1019.IP "\fBcutchars:\fR \fIstring\fR" 4
923.IX Item "cutchars: string" 1020.IX Item "cutchars: string"
924The characters used as delimiters for double-click word selection. The 1021The characters used as delimiters for double-click word selection
925built-in default: 1022(whitespace delimiting is added automatically if resource is given).
926.Sp 1023.Sp
1024When the perl selection extension is in use (the default if compiled
1025in, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage), a suitable regex using these
1026characters will be created (if the resource exists, otherwise, no regex
1027will be created). In this mode, characters outside \s-1ISO\-8859\-1\s0 can be used.
1028.Sp
1029When the selection extension is not used, only \s-1ISO\-8859\-1\s0 characters can
1030be used. If not specified, the built-in default is used:
1031.Sp
927\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]{|}\fR 1032\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]^{|}\fR
928.IP "\fBpreeditType:\fR \fIstyle\fR" 4 1033.IP "\fBpreeditType:\fR \fIstyle\fR" 4
929.IX Item "preeditType: style" 1034.IX Item "preeditType: style"
930\&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR. 1035\&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR.
931.IP "\fBinputMethod:\fR \fIname\fR" 4 1036.IP "\fBinputMethod:\fR \fIname\fR" 4
932.IX Item "inputMethod: name" 1037.IX Item "inputMethod: name"
976.IP "\fBsecondaryScreen:\fR \fIboolean\fR" 4 1081.IP "\fBsecondaryScreen:\fR \fIboolean\fR" 4
977.IX Item "secondaryScreen: boolean" 1082.IX Item "secondaryScreen: boolean"
978Turn on/off secondary screen (default enabled). 1083Turn on/off secondary screen (default enabled).
979.IP "\fBsecondaryScroll:\fR \fIboolean\fR" 4 1084.IP "\fBsecondaryScroll:\fR \fIboolean\fR" 4
980.IX Item "secondaryScroll: boolean" 1085.IX Item "secondaryScroll: boolean"
981Turn on/off secondary screen scroll (default enabled). If the this 1086Turn on/off secondary screen scroll (default enabled). If this
982option is enabled, scrolls on the secondary screen will change the 1087option is enabled, scrolls on the secondary screen will change the
983scrollback buffer and switching to/from the secondary screen will 1088scrollback buffer and switching to/from the secondary screen will
984instead scroll the screen up. 1089instead scroll the screen up.
985.IP "\fBhold\fR: \fIboolean\fR" 4 1090.IP "\fBhold\fR: \fIboolean\fR" 4
986.IX Item "hold: boolean" 1091.IX Item "hold: boolean"
1008searching keysym macros from \fB/usr/X11R6/include/X11/keysymdef.h\fR and 1113searching keysym macros from \fB/usr/X11R6/include/X11/keysymdef.h\fR and
1009omitting the prefix \fB\s-1XK_\s0\fR. Alternatively you can specify \fIkey\fR by its hex 1114omitting the prefix \fB\s-1XK_\s0\fR. Alternatively you can specify \fIkey\fR by its hex
1010keysym value (\fB0x0000 \- 0xFFFF\fR). Note that the lookup of \fIsym\fRs is not 1115keysym value (\fB0x0000 \- 0xFFFF\fR). Note that the lookup of \fIsym\fRs is not
1011performed in an exact manner; however, the closest match is assured. 1116performed in an exact manner; however, the closest match is assured.
1012.Sp 1117.Sp
1013\&\fIstring\fR may contain escape values (\f(CW\*(C`\ea\*(C'\fR: bell, \f(CW\*(C`\eb\*(C'\fR: backspace, 1118\&\fIstring\fR may contain escape values (\f(CW\*(C`\en\*(C'\fR: newline, \f(CW\*(C`\e000\*(C'\fR: octal
1014\&\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, 1119number), see \s-1RESOURCES\s0 in \f(CW\*(C`man 7 X\*(C'\fR for futher details.
1015\&\f(CW\*(C`\e000\*(C'\fR: octal number) or verbatim control characters (\f(CW\*(C`^?\*(C'\fR: delete,
1016\&\f(CW\*(C`^@\*(C'\fR: null, \f(CW\*(C`^A\*(C'\fR ...) and may be enclosed with double quotes so that it
1017can start or end with whitespace.
1018.Sp
1019Please note that you need to double the \f(CW\*(C`\e\*(C'\fR in resource files, as
1020Xlib itself does it's own de-escaping (you can use \f(CW\*(C`\e033\*(C'\fR instead of
1021\&\f(CW\*(C`\ee\*(C'\fR (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1022processing).
1023.Sp 1120.Sp
1024You can define a range of keysyms in one shot by providing a \fIstring\fR 1121You can define a range of keysyms in one shot by providing a \fIstring\fR
1025with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/' 1122with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimiter `/'
1026should be a character not used by the strings. 1123should be a character not used by the strings.
1027.Sp 1124.Sp
1028Its usage can be demonstrated by an example: 1125Its usage can be demonstrated by an example:
1029.Sp 1126.Sp
1030.Vb 1 1127.Vb 1
1109example, \f(CW\*(C`default,\-selection\*(C'\fR will use all the default extension except 1206example, \f(CW\*(C`default,\-selection\*(C'\fR will use all the default extension except
1110\&\f(CW\*(C`selection\*(C'\fR. 1207\&\f(CW\*(C`selection\*(C'\fR.
1111.Sp 1208.Sp
1112Extension names can also be followed by an argument in angle brackets 1209Extension names can also be followed by an argument in angle brackets
1113(e.g. \f(CW\*(C`searchable\-scrollback<M\-s>\*(C'\fR, which binds the hotkey for 1210(e.g. \f(CW\*(C`searchable\-scrollback<M\-s>\*(C'\fR, which binds the hotkey for
1114searchable scorllback to Alt/Meta\-s). Mentioning the same extension 1211searchable scrollback to Alt/Meta\-s). Mentioning the same extension
1115multiple times with different arguments will pass multiple arguments to 1212multiple times with different arguments will pass multiple arguments to
1116the extension. 1213the extension.
1117.Sp 1214.Sp
1118Each extension is looked up in the library directories, loaded if 1215Each extension is looked up in the library directories, loaded if
1119necessary, and bound to the current terminal instance. 1216necessary, and bound to the current terminal instance.
1149Sets the hotkey that starts the incremental scrollback buffer search 1246Sets the hotkey that starts the incremental scrollback buffer search
1150(default: \f(CW\*(C`M\-s\*(C'\fR). 1247(default: \f(CW\*(C`M\-s\*(C'\fR).
1151.IP "\fBurlLauncher\fR: \fIstring\fR" 4 1248.IP "\fBurlLauncher\fR: \fIstring\fR" 4
1152.IX Item "urlLauncher: string" 1249.IX Item "urlLauncher: string"
1153Specifies the program to be started with a \s-1URL\s0 argument. Used by the 1250Specifies the program to be started with a \s-1URL\s0 argument. Used by the
1154\&\f(CW\*(C`selection\-popup\*(C'\fR and \f(CW\*(C`mark\-urls\*(C'\fR perl extensions. 1251\&\f(CW\*(C`selection\-popup\*(C'\fR and \f(CW\*(C`matcher\*(C'\fR perl extensions.
1155.IP "\fBtransient-for\fR: \fIwindowid\fR" 4 1252.IP "\fBtransient-for\fR: \fIwindowid\fR" 4
1156.IX Item "transient-for: windowid" 1253.IX Item "transient-for: windowid"
1157Compile \fIfrills\fR: Sets the \s-1WM_TRANSIENT_FOR\s0 property to the given window id. 1254Compile \fIfrills\fR: Sets the \s-1WM_TRANSIENT_FOR\s0 property to the given window id.
1158.IP "\fBoverride-redirect\fR: \fIboolean\fR" 4 1255.IP "\fBoverride-redirect\fR: \fIboolean\fR" 4
1159.IX Item "override-redirect: boolean" 1256.IX Item "override-redirect: boolean"
1160Compile \fIfrills\fR: Sets override-redirect for the terminal window, making 1257Compile \fIfrills\fR: Sets override-redirect for the terminal window, making
1161it almost invisible to window managers; option \fB\-override\-redirect\fR. 1258it almost invisible to window managers; option \fB\-override\-redirect\fR.
1259.IP "\fBiso14755_52:\fR \fIboolean\fR" 4
1260.IX Item "iso14755_52: boolean"
1261Turn on/off \s-1ISO\s0 14755 5.2 mode (default enabled).
1162.SH "THE SCROLLBAR" 1262.SH "THE SCROLLBAR"
1163.IX Header "THE SCROLLBAR" 1263.IX Header "THE SCROLLBAR"
1164Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window 1264Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window
1165(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar 1265(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar
1166or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and 1266or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and
1180disabled \*(-- on the assumption that we are using a fullscreen 1280disabled \*(-- on the assumption that we are using a fullscreen
1181application. Instead, pressing Button1 and Button3 sends \fB\s-1ESC\s0 [ 6 ~\fR 1281application. Instead, pressing Button1 and Button3 sends \fB\s-1ESC\s0 [ 6 ~\fR
1182(Next) and \fB\s-1ESC\s0 [ 5 ~\fR (Prior), respectively. Similarly, clicking on the 1282(Next) and \fB\s-1ESC\s0 [ 5 ~\fR (Prior), respectively. Similarly, clicking on the
1183up and down arrows sends \fB\s-1ESC\s0 [ A\fR (Up) and \fB\s-1ESC\s0 [ B\fR (Down), 1283up and down arrows sends \fB\s-1ESC\s0 [ A\fR (Up) and \fB\s-1ESC\s0 [ B\fR (Down),
1184respectively. 1284respectively.
1185.SH "TEXT SELECTION AND INSERTION" 1285.SH "THE SELECTION: SELECTING AND PASTING TEXT"
1186.IX Header "TEXT SELECTION AND INSERTION" 1286.IX Header "THE SELECTION: SELECTING AND PASTING TEXT"
1187The behaviour of text selection and insertion mechanism is similar to 1287The behaviour of text selection and insertion/pasting mechanism is similar
1188\&\fIxterm\fR(1). 1288to \fIxterm\fR(1).
1189.IP "\fBSelection\fR:" 4 1289.IP "\fBSelecting\fR:" 4
1190.IX Item "Selection:" 1290.IX Item "Selecting:"
1191Left click at the beginning of the region, drag to the end of the region 1291Left click at the beginning of the region, drag to the end of the region
1192and release; Right click to extend the marked region; Left double-click 1292and release; Right click to extend the marked region; Left double-click
1193to select a word; Left triple-click to select the entire logical line 1293to select a word; Left triple-click to select the entire logical line
1194(which can span multiple screen lines), unless modified by resource 1294(which can span multiple screen lines), unless modified by resource
1195\&\fBtripleclickwords\fR. 1295\&\fBtripleclickwords\fR.
1197Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys) 1297Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys)
1198(Compile: \fIfrills\fR) will create a rectangular selection instead of a 1298(Compile: \fIfrills\fR) will create a rectangular selection instead of a
1199normal one. In this mode, every selected row becomes its own line in the 1299normal one. In this mode, every selected row becomes its own line in the
1200selection, and trailing whitespace is visually underlined and removed from 1300selection, and trailing whitespace is visually underlined and removed from
1201the selection. 1301the selection.
1202.IP "\fBInsertion\fR:" 4 1302.IP "\fBPasting\fR:" 4
1203.IX Item "Insertion:" 1303.IX Item "Pasting:"
1204Pressing and releasing the Middle mouse button in an \fB@@RXVT_NAME@@\fR window 1304Pressing and releasing the Middle mouse button in an \fB@@RXVT_NAME@@\fR
1205causes the value of the \s-1PRIMARY\s0 selection (Shift for \s-1CLIPBOARD\s0) to be inserted 1305window causes the value of the \s-1PRIMARY\s0 selection (or \s-1CLIPBOARD\s0 with the
1206as if it had been typed on the keyboard. 1306\&\fBMeta\fR modifier) to be inserted as if it had been typed on the keyboard.
1307.Sp
1207\&\fBShift-Insert\fR causes the value of the \s-1PRIMARY\s0 selection to be inserted too. 1308Pressing \fBShift-Insert\fR causes the value of the \s-1PRIMARY\s0 selection to be
1309inserted too.
1208.SH "CHANGING FONTS" 1310.SH "CHANGING FONTS"
1209.IX Header "CHANGING FONTS" 1311.IX Header "CHANGING FONTS"
1210Changing fonts (or font sizes, respectively) via the keypad is not yet 1312Changing fonts (or font sizes, respectively) via the keypad is not yet
1211supported in rxvt\-unicode. Bug me if you need this. 1313supported in rxvt\-unicode. Bug me if you need this.
1212.PP 1314.PP
1226rxvt-unicode will automatically re-apply these fonts to the output so far. 1328rxvt-unicode will automatically re-apply these fonts to the output so far.
1227.SH "ISO 14755 SUPPORT" 1329.SH "ISO 14755 SUPPORT"
1228.IX Header "ISO 14755 SUPPORT" 1330.IX Header "ISO 14755 SUPPORT"
1229\&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters 1331\&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters
1230and character codes using the keyboard. It consists of 4 parts. The 1332and character codes using the keyboard. It consists of 4 parts. The
1231first part is available rxvt-unicode has been compiled with 1333first part is available if rxvt-unicode has been compiled with
1232\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled 1334\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled
1233with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR. 1335with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR.
1234.IP "* 5.1: Basic method" 4 1336.IP "* 5.1: Basic method" 4
1235.IX Item "5.1: Basic method" 1337.IX Item "5.1: Basic method"
1236This allows you to enter unicode characters using their hexcode. 1338This allows you to enter unicode characters using their hexcode.
1252This mode lets you input characters representing the keycap symbols of 1354This mode lets you input characters representing the keycap symbols of
1253your keyboard, if representable in the current locale encoding. 1355your keyboard, if representable in the current locale encoding.
1254.Sp 1356.Sp
1255Start by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then releasing 1357Start by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then releasing
1256them. The next special key (cursor keys, home etc.) you enter will not 1358them. The next special key (cursor keys, home etc.) you enter will not
1257invoke it's usual function but instead will insert the corresponding 1359invoke its usual function but instead will insert the corresponding
1258keycap symbol. The symbol will only be entered when the key has been 1360keycap symbol. The symbol will only be entered when the key has been
1259released, otherwise pressing e.g. \f(CW\*(C`Shift\*(C'\fR would enter the symbol for 1361released, otherwise pressing e.g. \f(CW\*(C`Shift\*(C'\fR would enter the symbol for
1260\&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a 1362\&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a
1261reverse tab (Shift\-Tab). 1363reverse tab (Shift\-Tab).
1262.IP "* 5.3: Screen-selection entry method" 4 1364.IP "* 5.3: Screen-selection entry method" 4
1289.SH "COLORS AND GRAPHICS" 1391.SH "COLORS AND GRAPHICS"
1290.IX Header "COLORS AND GRAPHICS" 1392.IX Header "COLORS AND GRAPHICS"
1291In addition to the default foreground and background colours, 1393In addition to the default foreground and background colours,
1292\&\fB@@RXVT_NAME@@\fR can display up to 16 colours (8 \s-1ANSI\s0 colours plus 1394\&\fB@@RXVT_NAME@@\fR can display up to 16 colours (8 \s-1ANSI\s0 colours plus
1293high-intensity bold/blink versions of the same). Here is a list of the 1395high-intensity bold/blink versions of the same). Here is a list of the
1294colours with their \fBrgb.txt\fR names. 1396colours with their names.
1295.TS 1397.TS
1296l l l . 1398l l l .
1297color0 (black) = Black 1399color0 (black) = Black
1298color1 (red) = Red3 1400color1 (red) = Red3
1299color2 (green) = Green3 1401color2 (green) = Green3
1318It is also possible to specify the colour values of \fBforeground\fR, 1420It is also possible to specify the colour values of \fBforeground\fR,
1319\&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as 1421\&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as
1320a number 0\-15, as a convenient shorthand to reference the colour name of 1422a number 0\-15, as a convenient shorthand to reference the colour name of
1321color0\-color15. 1423color0\-color15.
1322.PP 1424.PP
1425In addition to the colours defined above, @@RXVT_NAME@@ offers an
1426additional 72 colours. The first 64 of those (with indices 16 to 79)
1427consist of a 4*4*4 \s-1RGB\s0 colour cube (i.e. \fIindex = r * 16 + g * 4 + b +
142816\fR), followed by 8 additional shades of gray (with indices 80 to 87).
1429.PP
1430Together, all those colours implement the 88 colour xterm colours. Only
1431the first 16 can be changed using resources currently, the rest can only
1432be changed via command sequences (\*(L"escape codes\*(R").
1433.PP
1323Note that \fB\-rv\fR (\fB\*(L"reverseVideo: True\*(R"\fR) simulates reverse video by 1434Note that \fB\-rv\fR (\fB\*(L"reverseVideo: True\*(R"\fR) simulates reverse video by
1324always swapping the foreground/background colours. This is in contrast to 1435always swapping the foreground/background colours. This is in contrast to
1325\&\fIxterm\fR(1) where the colours are only swapped if they have not otherwise 1436\&\fIxterm\fR(1) where the colours are only swapped if they have not otherwise
1326been specified. For example, 1437been specified. For example,
1327.IP "\fB@@RXVT_NAME@@ \-fg Black \-bg White \-rv\fR" 4 1438.IP "\fB@@RXVT_NAME@@ \-fg Black \-bg White \-rv\fR" 4
1328.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv" 1439.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv"
1329would yield White on Black, while on \fIxterm\fR(1) it would yield Black 1440would yield White on Black, while on \fIxterm\fR(1) it would yield Black
1330on White. 1441on White.
1442.Sh "\s-1ALPHA\s0 \s-1CHANNEL\s0 \s-1SUPPORT\s0"
1443.IX Subsection "ALPHA CHANNEL SUPPORT"
1444If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1445their act together, rxvt-unicode will support \f(CW\*(C`rgba:rrrr/gggg/bbbb/aaaa\*(C'\fR
1446(recommended, but \fB\s-1MUST\s0\fR have 4 digits/component) colour specifications,
1447in addition to the ones provided by X, where the additional A component
1448specifies opacity (alpha) values. The minimum value of \f(CW0\fR is completely
1449transparent). You can also prefix any color with \f(CW\*(C`[percent]\*(C'\fR, where
1450\&\f(CW\*(C`percent\*(C'\fR is a decimal percentage (0\-100) that specifies the opacity of
1451the color, where \f(CW0\fR is completely transparent and \f(CW100\fR is completelxy
1452opaque.
1453.PP
1454You probably need to specify \fB\*(L"\-depth 32\*(R"\fR, too, and have the luck that
1455your X\-server uses \s-1ARGB\s0 pixel layout, as X is far from just supporting
1456\&\s-1ARGB\s0 visuals out of the box, and rxvt-unicode just fudges around.
1457.PP
1458For example, the following selects an almost completely transparent red
1459background, and an almost opaque pink foreground:
1460.PP
1461.Vb 1
1462\& @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1463.Ve
1464.PP
1465\&\fIPlease note that transparency of any kind if completely unsupported by
1466the author. Don't bug him with installation questions!\fR
1331.SH "ENVIRONMENT" 1467.SH "ENVIRONMENT"
1332.IX Header "ENVIRONMENT" 1468.IX Header "ENVIRONMENT"
1333\&\fB@@RXVT_NAME@@\fR sets and/or uses the following environment variables: 1469\&\fB@@RXVT_NAME@@\fR sets and/or uses the following environment variables:
1334.IP "\fB\s-1TERM\s0\fR" 4 1470.IP "\fB\s-1TERM\s0\fR" 4
1335.IX Item "TERM" 1471.IX Item "TERM"
1336Normally set to \f(CW\*(C`rxvt\-unicode\*(C'\fR, unless overwritten at configure time, via 1472Normally set to \f(CW\*(C`rxvt\-unicode\*(C'\fR, unless overwritten at configure time, via
1337resources or on the commandline. 1473resources or on the command line.
1338.IP "\fB\s-1COLORTERM\s0\fR" 4 1474.IP "\fB\s-1COLORTERM\s0\fR" 4
1339.IX Item "COLORTERM" 1475.IX Item "COLORTERM"
1340Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on wether @@RXVT_NAME@@ was 1476Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on whether @@RXVT_NAME@@ was
1341compiled with \s-1XPM\s0 support, and optionally with the added extension 1477compiled with background image support, and optionally with the added
1342\&\f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome screen. 1478extension \f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome
1479screen.
1343.IP "\fB\s-1COLORFGBG\s0\fR" 4 1480.IP "\fB\s-1COLORFGBG\s0\fR" 4
1344.IX Item "COLORFGBG" 1481.IX Item "COLORFGBG"
1345Set 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 1482Set 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
1346the colour code used as default foreground/text colour (or the string 1483the colour code used as default foreground/text colour (or the string
1347\&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be 1484\&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be
1348used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the 1485used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the
1349string \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@@ 1486string \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@@
1350was compiled with \s-1XPM\s0 support. Libraries like \f(CW\*(C`ncurses\*(C'\fR and \f(CW\*(C`slang\*(C'\fR can 1487was compiled with background image support. Libraries like \f(CW\*(C`ncurses\*(C'\fR
1351(and do) use this information to optimize screen output. 1488and \f(CW\*(C`slang\*(C'\fR can (and do) use this information to optimize screen output.
1352.IP "\fB\s-1WINDOWID\s0\fR" 4 1489.IP "\fB\s-1WINDOWID\s0\fR" 4
1353.IX Item "WINDOWID" 1490.IX Item "WINDOWID"
1354Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel 1491Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel
1355window, which usually has subwindows for the scrollbar, the terminal 1492window, which usually has subwindows for the scrollbar, the terminal
1356window and so on). 1493window and so on).
1359Set to the terminfo directory iff @@RXVT_NAME@@ was configured with 1496Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1360\&\f(CW\*(C`\-\-with\-terminfo=PATH\*(C'\fR. 1497\&\f(CW\*(C`\-\-with\-terminfo=PATH\*(C'\fR.
1361.IP "\fB\s-1DISPLAY\s0\fR" 4 1498.IP "\fB\s-1DISPLAY\s0\fR" 4
1362.IX Item "DISPLAY" 1499.IX Item "DISPLAY"
1363Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1500Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1364display in it's child processes. 1501display in its child processes.
1365.IP "\fB\s-1SHELL\s0\fR" 4 1502.IP "\fB\s-1SHELL\s0\fR" 4
1366.IX Item "SHELL" 1503.IX Item "SHELL"
1367The shell to be used for command execution, defaults to \f(CW\*(C`/bin/sh\*(C'\fR. 1504The shell to be used for command execution, defaults to \f(CW\*(C`/bin/sh\*(C'\fR.
1368.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4 1505.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
1369.IX Item "RXVT_SOCKET" 1506.IX Item "RXVT_SOCKET"
1395.IX Header "CURRENT PROJECT COORDINATOR" 1532.IX Header "CURRENT PROJECT COORDINATOR"
1396.IP "Project Coordinator" 4 1533.IP "Project Coordinator" 4
1397.IX Item "Project Coordinator" 1534.IX Item "Project Coordinator"
1398Marc A. Lehmann <rxvt\-unicode@schmorp.de> 1535Marc A. Lehmann <rxvt\-unicode@schmorp.de>
1399.Sp 1536.Sp
1400<http://software.schmorp.de/#rxvt\-unicode> 1537<http://software.schmorp.de/pkg/rxvt\-unicode.html>
1401.SH "AUTHORS" 1538.SH "AUTHORS"
1402.IX Header "AUTHORS" 1539.IX Header "AUTHORS"
1403.IP "John Bovey" 4 1540.IP "John Bovey" 4
1404.IX Item "John Bovey" 1541.IX Item "John Bovey"
1405University of Kent, 1992, wrote the original Xvt. 1542University of Kent, 1992, wrote the original Xvt.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines