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.4 by root, Tue Jan 18 01:27:09 2005 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
… …
36. ds PI pi 36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch 37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch 38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" "" 39. ds L" ""
40. ds R" "" 40. ds R" ""
41. ds C` 41. ds C` ""
42. ds C' 42. ds C' ""
43'br\} 43'br\}
44.el\{\ 44.el\{\
45. ds -- \|\(em\| 45. ds -- \|\(em\|
46. ds PI \(*p 46. ds PI \(*p
47. ds L" `` 47. ds L" ``
… …
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 "2005-01-18" "4.8" "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 frequently 150See @@RXVT_NAME@@(7) (try \f(CW\*(C`man 7 @@RXVT_NAME@@\*(C'\fR) for a list of
148asked questions and answer to them and some common problems. 151frequently asked questions and answer to them and some common
152problems. That document is also accessible on the World-Wide-Web at
153<http://pod.tst.eu/http://cvs.schmorp.de/rxvt\-unicode/doc/rxvt.7.pod>.
149.SH "RXVT-UNICODE VS. RXVT" 154.SH "RXVT-UNICODE VS. RXVT"
150.IX Header "RXVT-UNICODE VS. RXVT" 155.IX Header "RXVT-UNICODE VS. RXVT"
151Unlike the original rxvt, \fBrxvt-unicode\fR stores all text in Unicode 156Unlike the original rxvt, \fBrxvt-unicode\fR stores all text in Unicode
152internally. That means it can store and display most scripts in the 157internally. That means it can store and display most scripts in the
153world. Being a terminal emulator, however, some things are very difficult, 158world. Being a terminal emulator, however, some things are very difficult,
154especially cursive scripts such as arabic, vertically written scripts 159especially cursive scripts such as arabic, vertically written scripts
155like mongolian or scripts requiring extremely complex combining rules, 160like mongolian or scripts requiring extremely complex combining rules,
156like tibetan or devenagari. Don't expect pretty output when using these 161like tibetan or devanagari. Don't expect pretty output when using these
157scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 162scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
158fine, though. A somewhat difficult case are left-to-right scripts, such 163fine, though. A somewhat difficult case are right-to-left scripts, such
159as hebrew: \fBrxvt-unicode\fR adopts the view that bidirectional algorithms 164as hebrew: \fBrxvt-unicode\fR adopts the view that bidirectional algorithms
160belong into the application, not the terminal emulator (too many things \*(-- 165belong in the application, not the terminal emulator (too many things \*(--
161such as cursor-movement while editing \*(-- break otherwise), but that might 166such as cursor-movement while editing \*(-- break otherwise), but that might
162change. 167change.
163.PP 168.PP
164If 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
165me 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
166terminal emulator. In fact, the reason rxvt-unicode was born was solely 171terminal emulator. In fact, the reason rxvt-unicode was born was solely
167because 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
168another for japanese. 173another for japanese.
169.PP 174.PP
170Therefore another design rationale was the use of multiple fonts to 175Therefore another design rationale was the use of multiple fonts to
171display characters: The idea of a single unicode font which many other 176display characters: The idea of a single unicode font which many other
172programs 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
173to choose any font for any script freely. 178to choose any font for any script freely.
174.PP 179.PP
175Apart from that, rxvt-unicode is also much better internationalised than 180Apart from that, rxvt-unicode is also much better internationalised than
176it'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
177in 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
178rxvt. This all in addition to dozens of other small improvements. 183rxvt. This all in addition to dozens of other small improvements.
179.PP 184.PP
180It is still faithfully following the original rxvt idea of being lean 185It is still faithfully following the original rxvt idea of being lean
181and nice on resources: for example, you can still configure rxvt-unicode 186and nice on resources: for example, you can still configure rxvt-unicode
182without 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
183a 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
184from within a single process, which makes startup time very fast and 189from within a single process, which makes startup time very fast and
185drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 190drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
186@@RXVT_NAME@@c(1) (client). 191@@RXVT_NAME@@c(1) (client).
187.PP 192.PP
188It also makes technical information about escape sequences (which have 193It also makes technical information about escape sequences (which have
189been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 194been extended) more accessible: see @@RXVT_NAME@@(7) for technical
190reference documentation (escape sequences etc.). 195reference documentation (escape sequences etc.).
191.SH "OPTIONS" 196.SH "OPTIONS"
192.IX Header "OPTIONS" 197.IX Header "OPTIONS"
193The \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
194below. In keeping with the smaller-is-better philosophy, options may be 199below. In keeping with the smaller-is-better philosophy, options may be
… …
212.IP "\fB\-display\fR \fIdisplayname\fR" 4 217.IP "\fB\-display\fR \fIdisplayname\fR" 4
213.IX Item "-display displayname" 218.IX Item "-display displayname"
214Attempt 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
215respected). In the absence of this option, the display specified by the 220respected). In the absence of this option, the display specified by the
216\&\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.
217.IP "\fB\-geometry\fR \fIgeom\fR" 4 226.IP "\fB\-geometry\fR \fIgeom\fR" 4
218.IX Item "-geometry geom" 227.IX Item "-geometry geom"
219Window geometry (\fB\-g\fR still respected); resource \fBgeometry\fR. 228Window geometry (\fB\-g\fR still respected); resource \fBgeometry\fR.
220.IP "\fB\-rv\fR|\fB+rv\fR" 4 229.IP "\fB\-rv\fR|\fB+rv\fR" 4
221.IX Item "-rv|+rv" 230.IX Item "-rv|+rv"
222Turn on/off simulated reverse video; resource \fBreverseVideo\fR. 231Turn on/off simulated reverse video; resource \fBreverseVideo\fR.
223.IP "\fB\-j\fR|\fB+j\fR" 4 232.IP "\fB\-j\fR|\fB+j\fR" 4
224.IX Item "-j|+j" 233.IX Item "-j|+j"
225Turn on/off jump scrolling; resource \fBjumpScroll\fR. 234Turn on/off jump scrolling (allow multiple lines per refresh); resource \fBjumpScroll\fR.
226.IP "\fB\-ip\fR|\fB+ip\fR" 4 235.IP "\fB\-ss\fR|\fB+ss\fR" 4
227.IX Item "-ip|+ip" 236.IX Item "-ss|+ss"
228Turn on/off inheriting parent window's pixmap. Alternative form is 237Turn on/off skip scrolling (allow multiple screens per refresh); resource \fBskipScroll\fR.
229\&\fB\-tr\fR; resource \fBinheritPixmap\fR. 238.IP "\fB\-tr\fR|\fB+tr\fR" 4
239.IX Item "-tr|+tr"
240Turn on/off illusion of a transparent window background; resource \fBtransparent\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
230.IP "\fB\-fade\fR \fInumber\fR" 4 247.IP "\fB\-fade\fR \fInumber\fR" 4
231.IX Item "-fade number" 248.IX Item "-fade number"
232Fade the text by the given percentage when focus is lost. resource \fBfading\fR. 249Fade the text by the given percentage when focus is lost. Small values
250fade a little only, 100 completely replaces all colours by the fade
251colour; resource \fBfading\fR.
252.IP "\fB\-fadecolor\fR \fIcolour\fR" 4
253.IX Item "-fadecolor colour"
254Fade to this colour when fading is used (see \fB\-fade\fR). The default colour
255is opaque black. resource \fBfadeColor\fR.
233.IP "\fB\-tint\fR \fIcolour\fR" 4 256.IP "\fB\-tint\fR \fIcolour\fR" 4
234.IX Item "-tint colour" 257.IX Item "-tint colour"
235Tint the transparent background pixmap with the given colour when 258Tint the transparent background pixmap with the given colour when
236transparency is enabled with \fB\-tr\fR or \fB\-ip\fR. See also the \fB\-sh\fR 259transparency is enabled with \fB\-tr\fR. This only works for
260non-tiled backgrounds, currently. See also the \fB\-sh\fR option that can be
237option that can be used to brighten or darken the image in addition to 261used to brighten or darken the image in addition to tinting it.
238tinting it. 262Please note that certain tint colours can be applied on the server\-side,
239.IP "\fB\-sh\fR" 4 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
266\&\fItintColor\fR. Example:
267.Sp
268.Vb 1
269\& @@RXVT_NAME@@ -tr -tint blue -sh 40
270.Ve
271.IP "\fB\-sh\fR \fInumber\fR" 4
240.IX Item "-sh" 272.IX Item "-sh number"
241\&\fInumber\fR Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent 273Darken (0 .. 100) or lighten (100 .. 200) the transparent
242background image in addition to tinting it (i.e. \fB\-tint\fR must be 274background image in addition to (or instead of) tinting it;
243specified, 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.
244.IP "\fB\-bg\fR \fIcolour\fR" 4 293.IP "\fB\-bg\fR \fIcolour\fR" 4
245.IX Item "-bg colour" 294.IX Item "-bg colour"
246Window background colour; resource \fBbackground\fR. 295Window background colour; resource \fBbackground\fR.
247.IP "\fB\-fg\fR \fIcolour\fR" 4 296.IP "\fB\-fg\fR \fIcolour\fR" 4
248.IX Item "-fg colour" 297.IX Item "-fg colour"
249Window foreground colour; resource \fBforeground\fR. 298Window foreground colour; resource \fBforeground\fR.
250.IP "\fB\-pixmap\fR \fIfile[;geom]\fR" 4 299.IP "\fB\-pixmap\fR \fIfile[;geom[:op1][:op2][...]]\fR" 4
251.IX Item "-pixmap file[;geom]" 300.IX Item "-pixmap file[;geom[:op1][:op2][...]]"
252Compile \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
253specify its scaling with a geometry string. Note you may need to 302optionally specify its scaling with a geometry string. Note you may need to
254add 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
255command\-line; resource \fBbackgroundPixmap\fR. 304command\-line; for more details see resource \fBbackgroundPixmap\fR.
256.IP "\fB\-cr\fR \fIcolour\fR" 4 305.IP "\fB\-cr\fR \fIcolour\fR" 4
257.IX Item "-cr colour" 306.IX Item "-cr colour"
258The cursor colour; resource \fBcursorColor\fR. 307The cursor colour; resource \fBcursorColor\fR.
259.IP "\fB\-pr\fR \fIcolour\fR" 4 308.IP "\fB\-pr\fR \fIcolour\fR" 4
260.IX Item "-pr colour" 309.IX Item "-pr colour"
… …
267The colour of the border around the text area and between the scrollbar and the text; 316The colour of the border around the text area and between the scrollbar and the text;
268resource \fBborderColor\fR. 317resource \fBborderColor\fR.
269.IP "\fB\-fn\fR \fIfontlist\fR" 4 318.IP "\fB\-fn\fR \fIfontlist\fR" 4
270.IX Item "-fn fontlist" 319.IX Item "-fn fontlist"
271Select the fonts to be used. This is a comma separated list of font names 320Select the fonts to be used. This is a comma separated list of font names
272that are used in turn when trying to display Unicode characters. The 321that are checked in order when trying to find glyphs for characters. The
273first font defines the cell size for characters; other fonts might be 322first font defines the cell size for characters; other fonts might be
274smaller, but not (in general) larger. A (hopefully) reasonable default 323smaller, but not (in general) larger. A (hopefully) reasonable default
275font 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.
276.Sp 325.Sp
277In 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
278with \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,
279e.g.: 328e.g.:
280.Sp 329.Sp
281.Vb 2 330.Vb 2
282\& @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 331\& @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
… …
285.Sp 334.Sp
286See also the question \*(L"How does rxvt-unicode choose fonts?\*(R" in the \s-1FAQ\s0 335See also the question \*(L"How does rxvt-unicode choose fonts?\*(R" in the \s-1FAQ\s0
287section of @@RXVT_NAME@@(7). 336section of @@RXVT_NAME@@(7).
288.IP "\fB\-fb\fR \fIfontlist\fR" 4 337.IP "\fB\-fb\fR \fIfontlist\fR" 4
289.IX Item "-fb fontlist" 338.IX Item "-fb fontlist"
290Compile font\-styles: The bold font list to use when bold characters are to 339Compile \fIfont-styles\fR: The bold font list to use when \fBbold\fR characters
291be printed. See resource \fBboldFont\fR for details. 340are to be printed. See resource \fBboldFont\fR for details.
292.IP "\fB\-fi\fR \fIfontlist\fR" 4 341.IP "\fB\-fi\fR \fIfontlist\fR" 4
293.IX Item "-fi fontlist" 342.IX Item "-fi fontlist"
294Compile font\-styles: The italic font list to use when bold characters are to 343Compile \fIfont-styles\fR: The italic font list to use when \fIitalic\fR
295be printed. See resource \fBitalicFont\fR for details. 344characters are to be printed. See resource \fBitalicFont\fR for details.
296.IP "\fB\-fbi\fR \fIfontlist\fR" 4 345.IP "\fB\-fbi\fR \fIfontlist\fR" 4
297.IX Item "-fbi fontlist" 346.IX Item "-fbi fontlist"
298Compile font\-styles: The bold italic font list to use when bold characters are to 347Compile \fIfont-styles\fR: The bold italic font list to use when \fB\f(BIbold
299be printed. See resource \fBboldItalicFont\fR for details. 348italic\fB\fR characters are to be printed. See resource \fBboldItalicFont\fR
349for details.
350.IP "\fB\-is\fR|\fB+is\fR" 4
351.IX Item "-is|+is"
352Compile \fIfont-styles\fR: Bold/Blink font styles imply high intensity
353foreground/background (default). See resource \fBintensityStyles\fR for
354details.
300.IP "\fB\-name\fR \fIname\fR" 4 355.IP "\fB\-name\fR \fIname\fR" 4
301.IX Item "-name name" 356.IX Item "-name name"
302Specify the application name under which resources are to be obtained, 357Specify the application name under which resources are to be obtained,
303rather than the default executable file name. Name should not contain 358rather than the default executable file name. Name should not contain
304`.' or `*' characters. Also sets the icon and title name. 359`.' or `*' characters. Also sets the icon and title name.
… …
332.IP "\fB\-sr\fR|\fB+sr\fR" 4 387.IP "\fB\-sr\fR|\fB+sr\fR" 4
333.IX Item "-sr|+sr" 388.IX Item "-sr|+sr"
334Put scrollbar on right/left; resource \fBscrollBar_right\fR. 389Put scrollbar on right/left; resource \fBscrollBar_right\fR.
335.IP "\fB\-st\fR|\fB+st\fR" 4 390.IP "\fB\-st\fR|\fB+st\fR" 4
336.IX Item "-st|+st" 391.IX Item "-st|+st"
337Display normal (non XTerm/NeXT) scrollbar without/with a trough; 392Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
338resource \fBscrollBar_floating\fR. 393resource \fBscrollBar_floating\fR.
339.IP "\fB\-ptab\fR|\fB+ptab\fR" 4 394.IP "\fB\-ptab\fR|\fB+ptab\fR" 4
340.IX Item "-ptab|+ptab" 395.IX Item "-ptab|+ptab"
341If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as 396If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as
342actual wide characters in the screen buffer, which makes it possible to 397actual wide characters in the screen buffer, which makes it possible to
… …
366.IP "\fB\-bl\fR" 4 421.IP "\fB\-bl\fR" 4
367.IX Item "-bl" 422.IX Item "-bl"
368Compile \fIfrills\fR: Set \s-1MWM\s0 hints to request a borderless window, i.e. 423Compile \fIfrills\fR: Set \s-1MWM\s0 hints to request a borderless window, i.e.
369if honoured by the \s-1WM\s0, the rxvt-unicode window will not have window 424if honoured by the \s-1WM\s0, the rxvt-unicode window will not have window
370decorations; resource \fBborderLess\fR. 425decorations; resource \fBborderLess\fR.
426.IP "\fB\-override\-redirect\fR" 4
427.IX Item "-override-redirect"
428Compile \fIfrills\fR: Sets override-redirect on the window; resource
429\&\fBoverride-redirect\fR.
430.IP "\fB\-sbg\fR" 4
431.IX Item "-sbg"
432Compile \fIfrills\fR: Disable the usage of the built-in block graphics/line
433drawing characters and just rely on what the specified fonts provide. Use
434this if you have a good font and want to use its block graphic glyphs;
435resource \fBskipBuiltinGlyphs\fR.
371.IP "\fB\-lsp\fR \fInumber\fR" 4 436.IP "\fB\-lsp\fR \fInumber\fR" 4
372.IX Item "-lsp number" 437.IX Item "-lsp number"
373Compile \fIfrills\fR: Lines (pixel height) to insert between each row of 438Compile \fIfrills\fR: Lines (pixel height) to insert between each row of
374the display. Useful to work around font rendering problems; resource 439the display. Useful to work around font rendering problems; resource
375\&\fBlinespace\fR. 440\&\fBlineSpace\fR.
376.IP "\fB\-tn\fR \fItermname\fR" 4 441.IP "\fB\-tn\fR \fItermname\fR" 4
377.IX Item "-tn termname" 442.IX Item "-tn termname"
378This 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
379\&\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
380\&\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;
… …
386the program being executed if neither \fI\-title\fR (\fI\-T\fR) nor \fI\-n\fR are 451the program being executed if neither \fI\-title\fR (\fI\-T\fR) nor \fI\-n\fR are
387given on the command line. If this option is used, it must be the last 452given on the command line. If this option is used, it must be the last
388on the command\-line. If there is no \fB\-e\fR option then the default is to 453on the command\-line. If there is no \fB\-e\fR option then the default is to
389run the program specified by the \fB\s-1SHELL\s0\fR environment variable or, 454run the program specified by the \fB\s-1SHELL\s0\fR environment variable or,
390failing that, \fI\fIsh\fI\|(1)\fR. 455failing that, \fI\fIsh\fI\|(1)\fR.
456.Sp
457Please note that you must specify a program with arguments. If you want to
458run shell commands, you have to specify the shell, like this:
459.Sp
460.Vb 1
461\& @@RXVT_NAME@@ -e sh -c "shell commands"
462.Ve
391.IP "\fB\-title\fR \fItext\fR" 4 463.IP "\fB\-title\fR \fItext\fR" 4
392.IX Item "-title text" 464.IX Item "-title text"
393Window title (\fB\-T\fR still respected); the default title is the basename 465Window title (\fB\-T\fR still respected); the default title is the basename
394of the program specified after the \fB\-e\fR option, if any, otherwise the 466of the program specified after the \fB\-e\fR option, if any, otherwise the
395application name; resource \fBtitle\fR. 467application name; resource \fBtitle\fR.
… …
408.IP "\fB\-im\fR \fItext\fR" 4 480.IP "\fB\-im\fR \fItext\fR" 4
409.IX Item "-im text" 481.IX Item "-im text"
410Compile \fI\s-1XIM\s0\fR: input method name. resource \fBinputMethod\fR. 482Compile \fI\s-1XIM\s0\fR: input method name. resource \fBinputMethod\fR.
411.IP "\fB\-imlocale\fR \fIstring\fR" 4 483.IP "\fB\-imlocale\fR \fIstring\fR" 4
412.IX Item "-imlocale string" 484.IX Item "-imlocale string"
413The locale to use for opening the \s-1IM\s0. You can use an \s-1LC_CTYPE\s0 of e.g. 485The locale to use for opening the \s-1IM\s0. You can use an \f(CW\*(C`LC_CTYPE\*(C'\fR of e.g.
414de_DE.UTF\-8 for normal text processing but ja_JP.EUC\-JP for the input 486\&\f(CW\*(C`de_DE.UTF\-8\*(C'\fR for normal text processing but \f(CW\*(C`ja_JP.EUC\-JP\*(C'\fR for the
415extension to be able to input japanese characters while staying in 487input extension to be able to input japanese characters while staying in
416another locale. 488another locale. resource \fBimLocale\fR.
489.IP "\fB\-imfont\fR \fIfontset\fR" 4
490.IX Item "-imfont fontset"
491Set the font set to use for the X Input Method, see resource \fBimFont\fR
492for more info.
493.IP "\fB\-tcw\fR" 4
494.IX Item "-tcw"
495Change the meaning of triple-click selection with the left mouse
496button. Only effective when the original (non\-perl) selection code is
497in\-use. Instead of selecting a full line it will extend the selection to
498the end of the logical line only. resource \fBtripleclickwords\fR.
417.IP "\fB\-insecure\fR" 4 499.IP "\fB\-insecure\fR" 4
418.IX Item "-insecure" 500.IX Item "-insecure"
419Enable \*(L"insecure\*(R" mode, which currently enables most of the escape 501Enable \*(L"insecure\*(R" mode, which currently enables most of the escape
420sequences that echo strings. See the resource \fBinsecure\fR for more 502sequences that echo strings. See the resource \fBinsecure\fR for more
421info. 503info.
… …
430\&\fBsecondaryScreen\fR. 512\&\fBsecondaryScreen\fR.
431.IP "\fB\-ssr\fR|\fB+ssr\fR" 4 513.IP "\fB\-ssr\fR|\fB+ssr\fR" 4
432.IX Item "-ssr|+ssr" 514.IX Item "-ssr|+ssr"
433Turn on/off secondary screen scroll (default enabled); resource 515Turn on/off secondary screen scroll (default enabled); resource
434\&\fBsecondaryScroll\fR. 516\&\fBsecondaryScroll\fR.
517.IP "\fB\-hold\fR|\fB+hold\fR" 4
518.IX Item "-hold|+hold"
519Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
520will not immediately destroy its window when the program executed within
521it exits. Instead, it will wait till it is being killed or closed by the
522user; resource \fBhold\fR.
435.IP "\fB\-xrm\fR \fIresourcestring\fR" 4 523.IP "\fB\-xrm\fR \fIstring\fR" 4
436.IX Item "-xrm resourcestring" 524.IX Item "-xrm string"
437No effect on rxvt\-unicode. Simply passes through an argument to be made 525Works like the X Toolkit option of the same name, by adding the \fIstring\fR
438available in the instance's argument list. Appears in \fI\s-1WM_COMMAND\s0\fR in 526as if it were specified in a resource file. Resource values specified this
439some window managers. 527way take precedence over all other resource specifications.
440.SH "RESOURCES (available also as long\-options)" 528.Sp
441.IX Header "RESOURCES (available also as long-options)" 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.
535.IP "\fB\-keysym.\fR\fIsym\fR \fIstring\fR" 4
536.IX Item "-keysym.sym string"
537Remap a key symbol. See resource \fBkeysym\fR.
538.IP "\fB\-embed\fR \fIwindowid\fR" 4
539.IX Item "-embed windowid"
540Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
541which enables applications to easily embed a terminal.
542.Sp
543Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
544shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
545quite a bit, so don't expect it to keep some specific state. It's best to
546create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
547.Sp
548The window will not be destroyed when @@RXVT_NAME@@ exits.
549.Sp
550It might be useful to know that @@RXVT_NAME@@ will not close file
551descriptors passed to it (except for stdin/out/err, of course), so you
552can use file descriptors to communicate with the programs within the
553terminal. This works regardless of whether the \f(CW\*(C`\-embed\*(C'\fR option was used or
554not.
555.Sp
556Here is a short Gtk2\-perl snippet that illustrates how this option can be
557used (a longer example is in \fIdoc/embed\fR):
558.Sp
559.Vb 5
560\& my $rxvt = new Gtk2::Socket;
561\& $rxvt->signal_connect_after (realize => sub {
562\& my $xid = $_[0]->window->get_xid;
563\& system "@@RXVT_NAME@@ -embed $xid &";
564\& });
565.Ve
566.IP "\fB\-pty\-fd\fR \fIfile descriptor\fR" 4
567.IX Item "-pty-fd file descriptor"
568Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty
569pair but instead use the given file descriptor as the tty master. This is
570useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
571without having to run a program within it.
572.Sp
573If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
574entries and will not tinker with pty/tty permissions \- you have to do that
575yourself if you want that.
576.Sp
577As an extremely special case, specifying \f(CW\*(C`\-1\*(C'\fR will completely suppress
578pty/tty operations, which is probably only useful in conjunction with some
579perl extension that manages the terminal.
580.Sp
581Here is a example in perl that illustrates how this option can be used (a
582longer example is in \fIdoc/pty\-fd\fR):
583.Sp
584.Vb 2
585\& use IO::Pty;
586\& use Fcntl;
587.Ve
588.Sp
589.Vb 4
590\& my $pty = new IO::Pty;
591\& fcntl $pty, F_SETFD, 0; # clear close-on-exec
592\& system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
593\& close $pty;
594.Ve
595.Sp
596.Vb 3
597\& # now communicate with rxvt
598\& my $slave = $pty->slave;
599\& while (<$slave>) { print $slave "got <$_>\en" }
600.Ve
601.IP "\fB\-pe\fR \fIstring\fR" 4
602.IX Item "-pe string"
603Comma-separated list of perl extension scripts to use (or not to use) in
604this terminal instance. See resource \fBperl-ext\fR for details.
605.SH "RESOURCES"
606.IX Header "RESOURCES"
442Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long 607Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long
443options) compiled into your version. 608options) compiled into your version. All resources are also available as
609long\-options.
444.PP 610.PP
445There are two different methods that @@RXVT_NAME@@ can use to get the 611You can set and change the resources using X11 tools like \fBxrdb\fR. Many
446Xresource data: using the X libraries (Xrm*\-functions) or internal 612distribution do also load settings from the \fB~/.Xresources\fR file when X
447Xresources reader (\fB~/.Xdefaults\fR). For the first method (ie. 613starts. @@RXVT_NAME@@ will consult the following files/resources in order,
448\&\fB@@RXVT_NAME@@ \-h\fR lists \fBXGetDefaults\fR), you can set and change the 614with later settings overwriting earlier ones:
449resources using X11 tools like \fBxset\fR. Many distribution do also load
450settings from the \fB~/.Xresources\fR file when X starts.
451.PP 615.PP
452If compiled with internal Xresources support (i.e. \fB@@RXVT_NAME@@ \-h\fR 616.Vb 6
453lists \fB.Xdefaults\fR) then \fB@@RXVT_NAME@@\fR accepts application defaults 617\& 1. system-wide app-defaults file, either locale-dependent OR global
454set in XAPPLOADDIR/URxvt (compile\-time defined: usually 618\& 2. app-defaults file in $XAPPLRESDIR
455\&\fB/usr/lib/X11/app\-defaults/URxvt\fR) and resources set in 619\& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
456\&\fB~/.Xdefaults\fR, or \fB~/.Xresources\fR if \fB~/.Xdefaults\fR does not exist. 620\& 4. SCREEN_RESOURCES for the current screen
621\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
622\& 6. resources specified via -xrm on the commandline
623.Ve
624.PP
457Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two 625Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two class
458class names: \fBXTerm\fR and \fBURxvt\fR. The class name \fBRxvt\fR allows 626names: \fBRxvt\fR and \fBURxvt\fR. The class name \fBRxvt\fR allows resources
459resources common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be 627common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be easily
460easily configured, while the class name \fBURxvt\fR allows resources 628configured, while the class name \fBURxvt\fR allows resources unique to
461unique to \fB@@RXVT_NAME@@\fR, notably colours and key\-handling, to be 629\&\fB@@RXVT_NAME@@\fR, to be shared between different \fB@@RXVT_NAME@@\fR
462shared between different \fB@@RXVT_NAME@@\fR configurations. If no 630configurations. If no resources are specified, suitable defaults will
463resources are specified, suitable defaults will be used. Command-line 631be used. Command-line arguments can be used to override resource
464arguments can be used to override resource settings. The following 632settings. The following resources are supported (you might want to
465resources are allowed: 633check the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for additional settings by perl
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.
466.IP "\fBgeometry:\fR \fIgeom\fR" 4 639.IP "\fBgeometry:\fR \fIgeom\fR" 4
467.IX Item "geometry: geom" 640.IX Item "geometry: geom"
468Create the window with the specified X window geometry [default 80x24]; 641Create the window with the specified X window geometry [default 80x24];
469option \fB\-geometry\fR. 642option \fB\-geometry\fR.
470.IP "\fBbackground:\fR \fIcolour\fR" 4 643.IP "\fBbackground:\fR \fIcolour\fR" 4
… …
502.IX Item "colorUL: colour" 675.IX Item "colorUL: colour"
503Use the specified colour to display underlined characters when the 676Use the specified colour to display underlined characters when the
504foreground colour is the default. 677foreground colour is the default.
505.IP "\fBcolorRV:\fR \fIcolour\fR" 4 678.IP "\fBcolorRV:\fR \fIcolour\fR" 4
506.IX Item "colorRV: colour" 679.IX Item "colorRV: colour"
507Use the specified colour as the background for reverse video 680Use the specified colour as the background for reverse video characters
508characters. 681when \s-1OPTION_HC\s0 is disabled (\-\-disable\-frills).
509.IP "\fBunderlineColor:\fR \fIcolour\fR" 4 682.IP "\fBunderlineColor:\fR \fIcolour\fR" 4
510.IX Item "underlineColor: colour" 683.IX Item "underlineColor: colour"
511If set, use the specified colour as the colour for the underline 684If set, use the specified colour as the colour for the underline
512itself. If unset, use the foreground colour. 685itself. If unset, use the foreground colour.
513.IP "\fBcursorColor:\fR \fIcolour\fR" 4 686.IP "\fBcursorColor:\fR \fIcolour\fR" 4
… …
524\&\fBTrue\fR: simulate reverse video by foreground and background colours; 697\&\fBTrue\fR: simulate reverse video by foreground and background colours;
525option \fB\-rv\fR. \fBFalse\fR: regular screen colours [default]; option 698option \fB\-rv\fR. \fBFalse\fR: regular screen colours [default]; option
526\&\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.
527.IP "\fBjumpScroll:\fR \fIboolean\fR" 4 700.IP "\fBjumpScroll:\fR \fIboolean\fR" 4
528.IX Item "jumpScroll: boolean" 701.IX Item "jumpScroll: boolean"
529\&\fBTrue\fR: specify that jump scrolling should be used. When scrolling 702\&\fBTrue\fR: specify that jump scrolling should be used. When receiving lots
530quickly, 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
531\&\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.
532.IP "\fBinheritPixmap:\fR \fIboolean\fR" 4 720.IP "\fBtransparent:\fR \fIboolean\fR" 4
533.IX Item "inheritPixmap: boolean" 721.IX Item "transparent: boolean"
534\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving 722Turn on/off illusion of a transparent window background.
535artificial transparency. \fBFalse\fR: do not inherit the parent windows' 723.Sp
536pixmap. 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
537.IP "\fBfading:\fR \fInumber\fR" 4 729.IP "\fBfading:\fR \fInumber\fR" 4
538.IX Item "fading: number" 730.IX Item "fading: number"
539Fade the text by the given percentage when focus is lost. 731Fade the text by the given percentage when focus is lost; option \fB\-fade\fR.
732.IP "\fBfadeColor:\fR \fIcolour\fR" 4
733.IX Item "fadeColor: colour"
734Fade to this colour, when fading is used (see \fBfading:\fR). The default
735colour is black; option \fB\-fadecolor\fR.
540.IP "\fBtintColor:\fR \fIcolour\fR" 4 736.IP "\fBtintColor:\fR \fIcolour\fR" 4
541.IX Item "tintColor: colour" 737.IX Item "tintColor: colour"
542Tint the transparent background pixmap with the given colour. 738Tint the transparent background pixmap with the given colour; option
739\&\fB\-tint\fR.
543.IP "\fBshading:\fR \fInumber\fR" 4 740.IP "\fBshading:\fR \fInumber\fR" 4
544.IX Item "shading: number" 741.IX Item "shading: number"
545Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background 742Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background image
546image 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.
547.IP "\fBscrollColor:\fR \fIcolour\fR" 4 751.IP "\fBscrollColor:\fR \fIcolour\fR" 4
548.IX Item "scrollColor: colour" 752.IX Item "scrollColor: colour"
549Use the specified colour for the scrollbar [default #B2B2B2]. 753Use the specified colour for the scrollbar [default #B2B2B2].
550.IP "\fBtroughColor:\fR \fIcolour\fR" 4 754.IP "\fBtroughColor:\fR \fIcolour\fR" 4
551.IX Item "troughColor: colour" 755.IX Item "troughColor: colour"
552Use the specified colour for the scrollbar's trough area [default 756Use the specified colour for the scrollbar's trough area [default
553#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 757#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
554.IP "\fBborderColor:\fR \fIcolour\fR" 4 758.IP "\fBborderColor:\fR \fIcolour\fR" 4
555.IX Item "borderColor: colour" 759.IX Item "borderColor: colour"
556The 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
557and the text. 761and the text.
558.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4 762.IP "\fBbackgroundPixmap:\fR \fIfile[;geom[:op1][:op2][...]]\fR" 4
559.IX Item "backgroundPixmap: file[;geom]" 763.IX Item "backgroundPixmap: file[;geom[:op1][:op2][...]]"
560Use the specified \s-1XPM\s0 file (note the `.xpm' extension is optional) for 764Use the specified image file for the background and also
561the background and also optionally specify its scaling with a geometry 765optionally specify its scaling with a geometry string \fBWxH+X+Y\fR,
562string \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
563horizontal/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
564centre (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
565of 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
566specifies an integer number of images in that direction. No image will 770an integer number of images in that direction. No image will be magnified
567be magnified beyond 10 times its original size. The maximum permitted 771beyond 10 times its original size. The maximum permitted scale is 1000.
568scale is 1000. [default 0x0+50+50] 772Additional operations can be specified after colon \fB:op1:op2...\fR.
569.IP "\fBmenu:\fR \fIfile[;tag]\fR" 4 773Supported operations are:
570.IX Item "menu: file[;tag]" 774.Sp
571Read in the specified menu file (note the `.menu' extension is 775.Vb 8
572optional) and also optionally specify a starting tag to find. See the 776\& tile force background image to be tiled and not scaled. Equivalent to 0x0,
573reference documentation for details on the syntax for the menuBar. 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.
574.IP "\fBpath:\fR \fIpath\fR" 4 789.IP "\fBpath:\fR \fIpath\fR" 4
575.IX Item "path: path" 790.IX Item "path: path"
576Specify the colon-delimited search path for finding files (\s-1XPM\s0 and 791Specify the colon-delimited search path for finding background image files.
577menus), in addition to the paths specified by the \fB\s-1RXVTPATH\s0\fR and
578\&\fB\s-1PATH\s0\fR environment variables.
579.IP "\fBfont:\fR \fIfontlist\fR" 4 792.IP "\fBfont:\fR \fIfontlist\fR" 4
580.IX Item "font: fontlist" 793.IX Item "font: fontlist"
581Select the fonts to be used. This is a comma separated list of font 794Select the fonts to be used. This is a comma separated list of font names
582names that are used in turn when trying to display Unicode characters. 795that are checked in order when trying to find glyphs for characters. The
583The first font defines the cell size for characters; other fonts might 796first font defines the cell size for characters; other fonts might be
584be smaller, but not larger. A reasonable default font list is always 797smaller, but not (in general) larger. A (hopefully) reasonable default
585appended to it. option \fB\-fn\fR. 798font list is always appended to it; option \fB\-fn\fR.
586.Sp 799.Sp
587Each font can either be a standard X11 core font (\s-1XLFD\s0) name, with 800Each font can either be a standard X11 core font (\s-1XLFD\s0) name, with
588optional prefix \f(CW\*(C`x:\*(C'\fR or a Xft font (Compile \fIxft\fR), prefixed with \f(CW\*(C`xft:\*(C'\fR. 801optional prefix \f(CW\*(C`x:\*(C'\fR or a Xft font (Compile \fIxft\fR), prefixed with \f(CW\*(C`xft:\*(C'\fR.
589.Sp 802.Sp
590In addition, each font can be prefixed with additional hints and 803In addition, each font can be prefixed with additional hints and
… …
593fonts. 806fonts.
594.Sp 807.Sp
595For example, this font resource 808For example, this font resource
596.Sp 809.Sp
597.Vb 5 810.Vb 5
598\& URxvt*font: 9x15bold,\e 811\& URxvt.font: 9x15bold,\e
599\& -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\e 812\& -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\e
600\& -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \e 813\& -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \e
601\& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e 814\& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e
602\& xft:Code2000:antialias=false 815\& xft:Code2000:antialias=false
603.Ve 816.Ve
… …
638\&\*(L"morphing\*(R" the normal text font list into the desired shape. If that is 851\&\*(L"morphing\*(R" the normal text font list into the desired shape. If that is
639not possible, replacement fonts of the desired shape will be tried. 852not possible, replacement fonts of the desired shape will be tried.
640.Sp 853.Sp
641If 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
642text font will being used for the given style. 855text font will being used for the given style.
856.IP "\fBintensityStyles:\fR \fIboolean\fR" 4
857.IX Item "intensityStyles: boolean"
858When font styles are not enabled, or this option is enabled (\fBTrue\fR,
859option \fB\-is\fR, the default), bold/blink font styles imply high
860intensity foreground/background colours. Disabling this option (\fBFalse\fR,
861option \fB+is\fR) disables this behaviour, the high intensity colours are not
862reachable.
643.IP "\fBselectstyle:\fR \fImode\fR" 4 863.IP "\fBselectstyle:\fR \fImode\fR" 4
644.IX Item "selectstyle: mode" 864.IX Item "selectstyle: mode"
645Set 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
646xterm 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
647xterm style selection. 867gives xterm style selection. Only effective when the original (non\-perl)
868selection code is in use.
648.IP "\fBscrollstyle:\fR \fImode\fR" 4 869.IP "\fBscrollstyle:\fR \fImode\fR" 4
649.IX Item "scrollstyle: mode" 870.IX Item "scrollstyle: mode"
650Set 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
651the author's favourite.. 872the author's favourite.
652.IP "\fBtitle:\fR \fIstring\fR" 4 873.IP "\fBtitle:\fR \fIstring\fR" 4
653.IX Item "title: string" 874.IX Item "title: string"
654Set window title string, the default title is the command-line 875Set window title string, the default title is the command-line
655specified after the \fB\-e\fR option, if any, otherwise the application 876specified after the \fB\-e\fR option, if any, otherwise the application
656name; option \fB\-title\fR. 877name; option \fB\-title\fR.
… …
661set; option \fB\-n\fR. 882set; option \fB\-n\fR.
662.IP "\fBmapAlert:\fR \fIboolean\fR" 4 883.IP "\fBmapAlert:\fR \fIboolean\fR" 4
663.IX Item "mapAlert: boolean" 884.IX Item "mapAlert: boolean"
664\&\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
665de-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].
666.IP "\fBvisualBell:\fR \fIboolean\fR" 4 891.IP "\fBvisualBell:\fR \fIboolean\fR" 4
667.IX Item "visualBell: boolean" 892.IX Item "visualBell: boolean"
668\&\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.
669\&\fBFalse\fR: no visual bell [default]; option \fB+vb\fR. 894\&\fBFalse\fR: no visual bell [default]; option \fB+vb\fR.
670.IP "\fBloginShell:\fR \fIboolean\fR" 4 895.IP "\fBloginShell:\fR \fIboolean\fR" 4
… …
680.IP "\fBprint\-pipe:\fR \fIstring\fR" 4 905.IP "\fBprint\-pipe:\fR \fIstring\fR" 4
681.IX Item "print-pipe: string" 906.IX Item "print-pipe: string"
682Specify a command pipe for vt100 printer [default \fI\fIlpr\fI\|(1)\fR]. Use 907Specify a command pipe for vt100 printer [default \fI\fIlpr\fI\|(1)\fR]. Use
683\&\fBPrint\fR to initiate a screen dump to the printer and \fBCtrl-Print\fR or 908\&\fBPrint\fR to initiate a screen dump to the printer and \fBCtrl-Print\fR or
684\&\fBShift-Print\fR to include the scrollback as well. 909\&\fBShift-Print\fR to include the scrollback as well.
910.Sp
911The string will be interpreted as if typed into the shell as\-is.
912.Sp
913Example:
914.Sp
915.Vb 1
916\& URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
917.Ve
918.Sp
919This creates a new file in your home directory with the screen contents
920every time you hit \f(CW\*(C`Print\*(C'\fR.
685.IP "\fBscrollBar:\fR \fIboolean\fR" 4 921.IP "\fBscrollBar:\fR \fIboolean\fR" 4
686.IX Item "scrollBar: boolean" 922.IX Item "scrollBar: boolean"
687\&\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:
688disable the scrollbar; option \fB+sb\fR. 924disable the scrollbar; option \fB+sb\fR.
689.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4 925.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4
… …
704\&\fBFalse\fR: do not scroll to bottom when tty receives output; option 940\&\fBFalse\fR: do not scroll to bottom when tty receives output; option
705\&\fB+si\fR. 941\&\fB+si\fR.
706.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4 942.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4
707.IX Item "scrollWithBuffer: boolean" 943.IX Item "scrollWithBuffer: boolean"
708\&\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
709\&\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
710with scrollback buffer when tty recieves new lines; option \fB\-sw\fR. 946with scrollback buffer when tty receives new lines; option \fB+sw\fR.
711.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4 947.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4
712.IX Item "scrollTtyKeypress: boolean" 948.IX Item "scrollTtyKeypress: boolean"
713\&\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
714are those which are intercepted by rxvt-unicode for special handling and 950are those which are intercepted by rxvt-unicode for special handling and
715are 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
… …
728option \fB\-w\fR, \fB\-bw\fR, \fB\-borderwidth\fR. 964option \fB\-w\fR, \fB\-bw\fR, \fB\-borderwidth\fR.
729.IP "\fBborderLess:\fR \fIboolean\fR" 4 965.IP "\fBborderLess:\fR \fIboolean\fR" 4
730.IX Item "borderLess: boolean" 966.IX Item "borderLess: boolean"
731Set \s-1MWM\s0 hints to request a borderless window, i.e. if honoured by the 967Set \s-1MWM\s0 hints to request a borderless window, i.e. if honoured by the
732\&\s-1WM\s0, the rxvt-unicode window will not have window decorations; option \fB\-bl\fR. 968\&\s-1WM\s0, the rxvt-unicode window will not have window decorations; option \fB\-bl\fR.
969.IP "\fBskipBuiltinGlyphs:\fR \fIboolean\fR" 4
970.IX Item "skipBuiltinGlyphs: boolean"
971Compile \fIfrills\fR: Disable the usage of the built-in block graphics/line
972drawing characters and just rely on what the specified fonts provide. Use
973this if you have a good font and want to use its block graphic glyphs;
974option \fB\-sbg\fR.
733.IP "\fBtermName:\fR \fItermname\fR" 4 975.IP "\fBtermName:\fR \fItermname\fR" 4
734.IX Item "termName: termname" 976.IX Item "termName: termname"
735Specifies 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
736variable; option \fB\-tn\fR. 978variable; option \fB\-tn\fR.
737.IP "\fBlinespace:\fR \fInumber\fR" 4 979.IP "\fBlineSpace:\fR \fInumber\fR" 4
738.IX Item "linespace: number" 980.IX Item "lineSpace: number"
739Specifies number of lines (pixel height) to insert between each row of 981Specifies number of lines (pixel height) to insert between each row of
740the display [default 0]; option \fB\-lsp\fR. 982the display [default 0]; option \fB\-lsp\fR.
741.IP "\fBmeta8:\fR \fIboolean\fR" 4 983.IP "\fBmeta8:\fR \fIboolean\fR" 4
742.IX Item "meta8: boolean" 984.IX Item "meta8: boolean"
743\&\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:
… …
765.IP "\fBpointerColor2:\fR \fIcolour\fR" 4 1007.IP "\fBpointerColor2:\fR \fIcolour\fR" 4
766.IX Item "pointerColor2: colour" 1008.IX Item "pointerColor2: colour"
767Mouse pointer background colour. 1009Mouse pointer background colour.
768.IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4 1010.IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4
769.IX Item "pointerBlankDelay: number" 1011.IX Item "pointerBlankDelay: number"
770Specifies number of seconds before blanking the pointer [default 2]. 1012Specifies number of seconds before blanking the pointer [default 2]. Use a
1013large number (e.g. \f(CW987654321\fR) to effectively disable the timeout.
771.IP "\fBbackspacekey:\fR \fIstring\fR" 4 1014.IP "\fBbackspacekey:\fR \fIstring\fR" 4
772.IX Item "backspacekey: string" 1015.IX Item "backspacekey: string"
773The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR 1016The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR
774or unset it will send \fBDelete\fR (code 127) or, if shifted, \fBBackspace\fR 1017or unset it will send \fBDelete\fR (code 127) or, if shifted, \fBBackspace\fR
775(code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode 1018(code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode
… …
779The string to send when the delete key (not the keypad delete key) is 1022The string to send when the delete key (not the keypad delete key) is
780pressed. If unset it will send the sequence traditionally associated 1023pressed. If unset it will send the sequence traditionally associated
781with the \fBExecute\fR key. 1024with the \fBExecute\fR key.
782.IP "\fBcutchars:\fR \fIstring\fR" 4 1025.IP "\fBcutchars:\fR \fIstring\fR" 4
783.IX Item "cutchars: string" 1026.IX Item "cutchars: string"
784The characters used as delimiters for double-click word selection. The 1027The characters used as delimiters for double-click word selection
785built-in default: 1028(whitespace delimiting is added automatically if resource is given).
786.Sp 1029.Sp
1030When the perl selection extension is in use (the default if compiled
1031in, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage), a suitable regex using these
1032characters will be created (if the resource exists, otherwise, no regex
1033will be created). In this mode, characters outside \s-1ISO\-8859\-1\s0 can be used.
1034.Sp
1035When the selection extension is not used, only \s-1ISO\-8859\-1\s0 characters can
1036be used. If not specified, the built-in default is used:
1037.Sp
787\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]{|}\fR 1038\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]^{|}\fR
788.IP "\fBpreeditType:\fR \fIstyle\fR" 4 1039.IP "\fBpreeditType:\fR \fIstyle\fR" 4
789.IX Item "preeditType: style" 1040.IX Item "preeditType: style"
790\&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR. 1041\&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR.
791.IP "\fBinputMethod:\fR \fIname\fR" 4 1042.IP "\fBinputMethod:\fR \fIname\fR" 4
792.IX Item "inputMethod: name" 1043.IX Item "inputMethod: name"
793\&\fIname\fR of inputMethod to use; option \fB\-im\fR. 1044\&\fIname\fR of inputMethod to use; option \fB\-im\fR.
794.IP "\fBimLocale:\fR \fIname\fR" 4 1045.IP "\fBimLocale:\fR \fIname\fR" 4
795.IX Item "imLocale: name" 1046.IX Item "imLocale: name"
796The locale to use for opening the \s-1IM\s0. You can use an \s-1LC_CTYPE\s0 of e.g. 1047The locale to use for opening the \s-1IM\s0. You can use an \f(CW\*(C`LC_CTYPE\*(C'\fR of e.g.
797de_DE.UTF\-8 for normal text processing but ja_JP.EUC\-JP for the input 1048\&\f(CW\*(C`de_DE.UTF\-8\*(C'\fR for normal text processing but \f(CW\*(C`ja_JP.EUC\-JP\*(C'\fR for the
798extension to be able to input japanese characters while staying in 1049input extension to be able to input japanese characters while staying in
799another locale. option \fB\-imlocale\fR. 1050another locale; option \fB\-imlocale\fR.
1051.IP "\fBimFont:\fR \fIfontset\fR" 4
1052.IX Item "imFont: fontset"
1053Specify the font-set used for \s-1XIM\s0 styles \f(CW\*(C`OverTheSpot\*(C'\fR or
1054\&\f(CW\*(C`OffTheSpot\*(C'\fR. It must be a standard X font set (\s-1XLFD\s0 patterns separated
1055by commas), i.e. it's not in the same format as the other font lists used
1056in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
1057found, preferably one or two pixels differing in size to the base font.
1058option \fB\-imfont\fR.
1059.IP "\fBtripleclickwords:\fR \fIboolean\fR" 4
1060.IX Item "tripleclickwords: boolean"
1061Change the meaning of triple-click selection with the left mouse
1062button. Instead of selecting a full line it will extend the selection to
1063the end of the logical line only; option \fB\-tcw\fR.
800.IP "\fBinsecure:\fR \fIboolean\fR" 4 1064.IP "\fBinsecure:\fR \fIboolean\fR" 4
801.IX Item "insecure: boolean" 1065.IX Item "insecure: boolean"
802Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that 1066Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that
803echo arbitrary strings like the icon name or the locale. This could be 1067echo arbitrary strings like the icon name or the locale. This could be
804abused if somebody gets 8\-bit\-clean access to your display, whether 1068abused if somebody gets 8\-bit\-clean access to your display, whether
805throuh a mail client displaying mail bodies unfiltered or though 1069through a mail client displaying mail bodies unfiltered or through
806\&\fIwrite\fR\|(1). Therefore, these sequences are disabled by default. (Note 1070\&\fIwrite\fR\|(1) or any other means. Therefore, these sequences are disabled by
807that other terminals, including xterm, have these sequences 1071default. (Note that many other terminals, including xterm, have these
808enabled by default). You can enable them by setting this boolean 1072sequences enabled by default, which doesn't make it safer, though).
809resource or specifying \fB\-insecure\fR as an option. At the moment, this 1073.Sp
810enabled display\-answer, locale, findfont, icon label and window title 1074You can enable them by setting this boolean resource or specifying
811requests as well as dynamic menubar dispatch. 1075\&\fB\-insecure\fR as an option. At the moment, this enables display\-answer,
1076locale, findfont, icon label and window title requests.
812.IP "\fBmodifier:\fR \fImodifier\fR" 4 1077.IP "\fBmodifier:\fR \fImodifier\fR" 4
813.IX Item "modifier: modifier" 1078.IX Item "modifier: modifier"
814Set the key to be interpreted as the Meta key to: \fBalt\fR, \fBmeta\fR, 1079Set the key to be interpreted as the Meta key to: \fBalt\fR, \fBmeta\fR,
815\&\fBhyper\fR, \fBsuper\fR, \fBmod1\fR, \fBmod2\fR, \fBmod3\fR, \fBmod4\fR, \fBmod5\fR; option 1080\&\fBhyper\fR, \fBsuper\fR, \fBmod1\fR, \fBmod2\fR, \fBmod3\fR, \fBmod4\fR, \fBmod5\fR; option
816\&\fB\-mod\fR. 1081\&\fB\-mod\fR.
817.IP "\fBanswerbackString:\fR \fIstring\fR" 4 1082.IP "\fBanswerbackString:\fR \fIstring\fR" 4
818.IX Item "answerbackString: string" 1083.IX Item "answerbackString: string"
819Specify the reply rxvt-unicode sends to the shell when an \s-1ENQ\s0 (control\-E) 1084Specify the reply rxvt-unicode sends to the shell when an \s-1ENQ\s0 (control\-E)
820character is passed through. It may contain escape values as described 1085character is passed through. It may contain escape values as described
821in the entry on \fBkeysym\fR following. 1086in the entry on \fBkeysym\fR following.
822.IP "\fBsecondaryScreen:\fR \fIbool\fR" 4 1087.IP "\fBsecondaryScreen:\fR \fIboolean\fR" 4
823.IX Item "secondaryScreen: bool" 1088.IX Item "secondaryScreen: boolean"
824Turn on/off secondary screen (default enabled). 1089Turn on/off secondary screen (default enabled).
825.IP "\fBsecondaryScroll:\fR \fIbool\fR" 4 1090.IP "\fBsecondaryScroll:\fR \fIboolean\fR" 4
826.IX Item "secondaryScroll: bool" 1091.IX Item "secondaryScroll: boolean"
827Turn on/off secondary screen scroll (default enabled). If the this 1092Turn on/off secondary screen scroll (default enabled). If this
828option is enabled, scrolls on the secondary screen will change the 1093option is enabled, scrolls on the secondary screen will change the
829scrollback buffer and switching to/from the secondary screen will 1094scrollback buffer and switching to/from the secondary screen will
830instead scroll the screen up. 1095instead scroll the screen up.
1096.IP "\fBhold\fR: \fIboolean\fR" 4
1097.IX Item "hold: boolean"
1098Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1099will not immediately destroy its window when the program executed within
1100it exits. Instead, it will wait till it is being killed or closed by the
1101user.
831.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4 1102.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4
832.IX Item "keysym.sym: string" 1103.IX Item "keysym.sym: string"
833Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The 1104Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The
834intervening resource name \fBkeysym.\fR cannot be omitted. 1105intervening resource name \fBkeysym.\fR cannot be omitted.
835.Sp 1106.Sp
… …
839and the abbreviated \fBI\fR, \fBK\fR, \fBC\fR, \fBN\fR, \fBS\fR, \fBM\fR, \fBA\fR, \fBL\fR, \fB1\fR, 1110and the abbreviated \fBI\fR, \fBK\fR, \fBC\fR, \fBN\fR, \fBS\fR, \fBM\fR, \fBA\fR, \fBL\fR, \fB1\fR,
840\&\fB2\fR, \fB3\fR, \fB4\fR, \fB5\fR. 1111\&\fB2\fR, \fB3\fR, \fB4\fR, \fB5\fR.
841.Sp 1112.Sp
842The \fBNumLock\fR, \fBMeta\fR and \fBISOLevel3\fR modifiers are usually aliased to 1113The \fBNumLock\fR, \fBMeta\fR and \fBISOLevel3\fR modifiers are usually aliased to
843whatever modifier the NumLock key, Meta/Alt keys or \s-1ISO\s0 Level3 Shift/AltGr 1114whatever modifier the NumLock key, Meta/Alt keys or \s-1ISO\s0 Level3 Shift/AltGr
844keys are being mapped. \fBAppKeypad\fR is a artificial modifier mapped to the 1115keys are being mapped. \fBAppKeypad\fR is a synthetic modifier mapped to the
845current application keymap mode state. 1116current application keymap mode state.
846.Sp 1117.Sp
847The spellings of \fIkey\fR can be obtained by using \fBxev\fR(1) command or 1118The spellings of \fIkey\fR can be obtained by using \fBxev\fR(1) command or
848searching 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
849omitting 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
850keysym 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
851performed in an exact manner; however, the closest match is assured. 1122performed in an exact manner; however, the closest match is assured.
852.Sp 1123.Sp
853\&\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
854\&\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.
855\&\f(CW\*(C`\e000\*(C'\fR: octal number) or verbatim control characters (\f(CW\*(C`^?\*(C'\fR: delete,
856\&\f(CW\*(C`^@\*(C'\fR: null, \f(CW\*(C`^A\*(C'\fR ...) and may be enclosed with double quotes so that it
857can start or end with whitespace.
858.Sp 1126.Sp
859You 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
860with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/' 1128with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimiter `/'
861should be a character not used by the strings. 1129should be a character not used by the strings.
862.Sp 1130.Sp
863Its usage can be demonstrated by an example: 1131Its usage can be demonstrated by an example:
864.Sp 1132.Sp
865.Vb 1 1133.Vb 1
866\& URxvt.keysym.M-C-0x61: list|\ee<M-C-|abc|> 1134\& URxvt.keysym.M-C-0x61: list|\e033<M-C-|abc|>
867.Ve 1135.Ve
868.Sp 1136.Sp
869The above line is equivalent to the following three lines: 1137The above line is equivalent to the following three lines:
870.Sp 1138.Sp
871.Vb 3 1139.Vb 3
872\& URxvt.keysym.Meta-Control-0x61: \ee<M-C-a> 1140\& URxvt.keysym.Meta-Control-0x61: \e033<M-C-a>
873\& URxvt.keysym.Meta-Control-0x62: \ee<M-C-b> 1141\& URxvt.keysym.Meta-Control-0x62: \e033<M-C-b>
874\& URxvt.keysym.Meta-Control-0x63: \ee<M-C-c> 1142\& URxvt.keysym.Meta-Control-0x63: \e033<M-C-c>
875.Ve 1143.Ve
876.Sp 1144.Sp
877If \fIstring\fR takes the form of \f(CW\*(C`proto:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR is 1145If \fIstring\fR takes the form of \f(CW\*(C`command:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR
878interpreted and executed as @@RXVT_NAME@@'s control sequence. For example, 1146is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
879\&\f(CW\*(C`proto:\e033]701;zh_CN.GBK\e007\*(C'\fR means: change the current locale to 1147example the following means "change the current locale to \f(CW\*(C`zh_CN.GBK\*(C'\fR
880\&\f(CW\*(C`zh_CN.GBK\*(C'\fR. 1148when Control-Meta-c is being pressed":
1149.Sp
1150.Vb 1
1151\& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007
1152.Ve
1153.Sp
1154If \fIstring\fR takes the form \f(CW\*(C`perl:STRING\*(C'\fR, then the specified \fB\s-1STRING\s0\fR
1155is passed to the \f(CW\*(C`on_keyboard_command\*(C'\fR perl handler. See the @@RXVT_NAME@@\fIperl\fR\|(3)
1156manpage. For example, the \fIselection\fR extension (activated via
1157\&\f(CW\*(C`@@RXVT_NAME@@ \-pe selection\*(C'\fR) listens for \f(CW\*(C`selection:rot13\*(C'\fR events:
1158.Sp
1159.Vb 1
1160\& URxvt.keysym.M-C-c: perl:selection:rot13
1161.Ve
1162.Sp
1163Due the the large number of modifier combinations, a defined key mapping
1164will match if at \fIat least\fR the specified identifiers are being set, and
1165no other key mappings with those and more bits are being defined. That
1166means that defining a key map for \f(CW\*(C`a\*(C'\fR will automatically provide
1167definitions for \f(CW\*(C`Meta\-a\*(C'\fR, \f(CW\*(C`Shift\-a\*(C'\fR and so on, unless some of those are defined
1168mappings themselves.
1169.Sp
1170Unfortunately, this will override built-in key mappings. For example
1171if you overwrite the \f(CW\*(C`Insert\*(C'\fR key you will disable @@RXVT_NAME@@'s
1172\&\f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke \*(L"holes\*(R" into the
1173user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement:
1174.Sp
1175.Vb 2
1176\& URxvt.keysym.Insert: <my insert key sequence>
1177\& URxvt.keysym.S-Insert: builtin:
1178.Ve
1179.Sp
1180The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination
1181of modifiers. The second line re-establishes the default mapping for
1182\&\f(CW\*(C`Shift\-Insert\*(C'\fR.
1183.Sp
1184The following example will map Control\-Meta\-1 and Control\-Meta\-2 to
1185the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited
1186font-switching at runtime:
1187.Sp
1188.Vb 2
1189\& URxvt.keysym.M-C-1: command:\e033]50;suxuseuro\e007
1190\& URxvt.keysym.M-C-2: command:\e033]50;9x15bold\e007
1191.Ve
1192.Sp
1193Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1194info):
1195.Sp
1196.Vb 2
1197\& URxvt.keysym.M-C-3: command:\e033[8;25;80t
1198\& URxvt.keysym.M-C-4: command:\e033[8;48;110t
1199.Ve
1200.IP "\fBperl-ext-common\fR: \fIstring\fR" 4
1201.IX Item "perl-ext-common: string"
1202.PD 0
1203.IP "\fBperl-ext\fR: \fIstring\fR" 4
1204.IX Item "perl-ext: string"
1205.PD
1206Comma-separated list(s) of perl extension scripts (default: \f(CW\*(C`default\*(C'\fR) to
1207use in this terminal instance; option \fB\-pe\fR.
1208.Sp
1209Extension names can be prefixed with a \f(CW\*(C`\-\*(C'\fR sign to prohibit using
1210them. This can be useful to selectively disable some extensions loaded
1211by default, or specified via the \f(CW\*(C`perl\-ext\-common\*(C'\fR resource. For
1212example, \f(CW\*(C`default,\-selection\*(C'\fR will use all the default extension except
1213\&\f(CW\*(C`selection\*(C'\fR.
1214.Sp
1215Extension names can also be followed by an argument in angle brackets
1216(e.g. \f(CW\*(C`searchable\-scrollback<M\-s>\*(C'\fR, which binds the hotkey for
1217searchable scrollback to Alt/Meta\-s). Mentioning the same extension
1218multiple times with different arguments will pass multiple arguments to
1219the extension.
1220.Sp
1221Each extension is looked up in the library directories, loaded if
1222necessary, and bound to the current terminal instance.
1223.Sp
1224If both of these resources are the empty string, then the perl
1225interpreter will not be initialized. The idea behind two options is that
1226\&\fBperl-ext-common\fR will be used for extensions that should be available to
1227all instances, while \fBperl-ext\fR is used for specific instances.
1228.IP "\fBperl-eval\fR: \fIstring\fR" 4
1229.IX Item "perl-eval: string"
1230Perl code to be evaluated when all extensions have been registered. See
1231the @@RXVT_NAME@@\fIperl\fR\|(3) manpage. Due to security reasons, this resource
1232will be ignored when running setuid/setgid.
1233.IP "\fBperl-lib\fR: \fIpath\fR" 4
1234.IX Item "perl-lib: path"
1235Colon-separated list of additional directories that hold extension
1236scripts. When looking for extensions specified by the \f(CW\*(C`perl\*(C'\fR resource,
1237@@RXVT_NAME@@ will first look in these directories and then in
1238\&\fI@@RXVT_LIBDIR@@/urxvt/perl/\fR. Due to security reasons, this resource
1239will be ignored when running setuid/setgid.
1240.Sp
1241See the @@RXVT_NAME@@\fIperl\fR\|(3) manpage.
1242.IP "\fBselection.pattern\-\f(BIidx\fB\fR: \fIperl-regex\fR" 4
1243.IX Item "selection.pattern-idx: perl-regex"
1244Additional selection patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for
1245details.
1246.IP "\fBselection\-autotransform.\f(BIidx\fB\fR: \fIperl-transform\fR" 4
1247.IX Item "selection-autotransform.idx: perl-transform"
1248Selection auto-transform patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage
1249for details.
1250.IP "\fBsearchable\-scrollback:\fR \fIkeysym\fR" 4
1251.IX Item "searchable-scrollback: keysym"
1252Sets the hotkey that starts the incremental scrollback buffer search
1253(default: \f(CW\*(C`M\-s\*(C'\fR).
1254.IP "\fBurlLauncher\fR: \fIstring\fR" 4
1255.IX Item "urlLauncher: string"
1256Specifies the program to be started with a \s-1URL\s0 argument. Used by the
1257\&\f(CW\*(C`selection\-popup\*(C'\fR and \f(CW\*(C`matcher\*(C'\fR perl extensions.
1258.IP "\fBtransient-for\fR: \fIwindowid\fR" 4
1259.IX Item "transient-for: windowid"
1260Compile \fIfrills\fR: Sets the \s-1WM_TRANSIENT_FOR\s0 property to the given window id.
1261.IP "\fBoverride-redirect\fR: \fIboolean\fR" 4
1262.IX Item "override-redirect: boolean"
1263Compile \fIfrills\fR: Sets override-redirect for the terminal window, making
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).
881.SH "THE SCROLLBAR" 1268.SH "THE SCROLLBAR"
882.IX Header "THE SCROLLBAR" 1269.IX Header "THE SCROLLBAR"
883Lines 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
884(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar 1271(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar
885or 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
… …
895the normal text selection/insertion, hold either the Shift or the Meta 1282the normal text selection/insertion, hold either the Shift or the Meta
896(Alt) key while performing the desired mouse action. 1283(Alt) key while performing the desired mouse action.
897.PP 1284.PP
898If mouse reporting mode is active, the normal scrollbar actions are 1285If mouse reporting mode is active, the normal scrollbar actions are
899disabled \*(-- on the assumption that we are using a fullscreen 1286disabled \*(-- on the assumption that we are using a fullscreen
900application. Instead, pressing Button1 and Button3 sends \fBESC[6~\fR 1287application. Instead, pressing Button1 and Button3 sends \fB\s-1ESC\s0 [ 6 ~\fR
901(Next) and \fBESC[5~\fR (Prior), respectively. Similarly, clicking on the 1288(Next) and \fB\s-1ESC\s0 [ 5 ~\fR (Prior), respectively. Similarly, clicking on the
902up and down arrows sends \fBESC[A\fR (Up) and \fBESC[B\fR (Down), 1289up and down arrows sends \fB\s-1ESC\s0 [ A\fR (Up) and \fB\s-1ESC\s0 [ B\fR (Down),
903respectively. 1290respectively.
904.SH "TEXT SELECTION AND INSERTION" 1291.SH "THE SELECTION: SELECTING AND PASTING TEXT"
905.IX Header "TEXT SELECTION AND INSERTION" 1292.IX Header "THE SELECTION: SELECTING AND PASTING TEXT"
906The behaviour of text selection and insertion mechanism is similar to 1293The behaviour of text selection and insertion/pasting mechanism is similar
907\&\fIxterm\fR(1). 1294to \fIxterm\fR(1).
908.IP "\fBSelection\fR:" 4 1295.IP "\fBSelecting\fR:" 4
909.IX Item "Selection:" 1296.IX Item "Selecting:"
910Left click at the beginning of the region, drag to the end of the 1297Left click at the beginning of the region, drag to the end of the region
911region and release; Right click to extend the marked region; Left 1298and release; Right click to extend the marked region; Left double-click
912double-click to select a word; Left triple-click to select the entire 1299to select a word; Left triple-click to select the entire logical line
913line. 1300(which can span multiple screen lines), unless modified by resource
1301\&\fBtripleclickwords\fR.
914.Sp 1302.Sp
915Starting 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)
916(Compile: \fIfrills\fR) will create a rectangular selection instead of a normal 1304(Compile: \fIfrills\fR) will create a rectangular selection instead of a
917one. 1305normal one. In this mode, every selected row becomes its own line in the
1306selection, and trailing whitespace is visually underlined and removed from
1307the selection.
918.IP "\fBInsertion\fR:" 4 1308.IP "\fBPasting\fR:" 4
919.IX Item "Insertion:" 1309.IX Item "Pasting:"
920Pressing and releasing the Middle mouse button (or \fBShift-Insert\fR) in 1310Pressing and releasing the Middle mouse button in an \fB@@RXVT_NAME@@\fR
921an \fB@@RXVT_NAME@@\fR window causes the current text selection to be 1311window causes the value of the \s-1PRIMARY\s0 selection (or \s-1CLIPBOARD\s0 with the
922inserted 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.
1313.Sp
1314Pressing \fBShift-Insert\fR causes the value of the \s-1PRIMARY\s0 selection to be
1315inserted too.
923.SH "CHANGING FONTS" 1316.SH "CHANGING FONTS"
924.IX Header "CHANGING FONTS" 1317.IX Header "CHANGING FONTS"
925Changing fonts (or font sizes, respectively) via the keypad is not yet 1318Changing fonts (or font sizes, respectively) via the keypad is not yet
926supported in rxvt\-unicode. Bug me if you need this. 1319supported in rxvt\-unicode. Bug me if you need this.
927.PP 1320.PP
928You can, however, switch fonts at runtime using escape sequences (and 1321You can, however, switch fonts at runtime using escape sequences, e.g.:
929therefore using the menubar), e.g.:
930.PP 1322.PP
931.Vb 1 1323.Vb 1
932\& printf '\ee]701;%s\e007' "9x15bold,xft:Kochi Gothic" 1324\& printf '\ee]710;%s\e007' "9x15bold,xft:Kochi Gothic"
1325.Ve
1326.PP
1327You can use keyboard shortcuts, too:
1328.PP
1329.Vb 2
1330\& URxvt.keysym.M-C-1: command:\e033]710;suxuseuro\e007\e033]711;suxuseuro\e007
1331\& URxvt.keysym.M-C-2: command:\e033]710;9x15bold\e007\e033]711;9x15bold\e007
933.Ve 1332.Ve
934.PP 1333.PP
935rxvt-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.
936.SH "ISO 14755 SUPPORT" 1335.SH "ISO 14755 SUPPORT"
937.IX Header "ISO 14755 SUPPORT" 1336.IX Header "ISO 14755 SUPPORT"
938\&\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
939and character codes using the keyboard. It consists of 4 parts. The 1338and character codes using the keyboard. It consists of 4 parts. The
940first part is available rxvt-unicode has been compiled with 1339first part is available if rxvt-unicode has been compiled with
941\&\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
942with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR. 1341with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR.
943.IP "5.1: Basic method" 4 1342.IP "* 5.1: Basic method" 4
944.IX Item "5.1: Basic method" 1343.IX Item "5.1: Basic method"
945This allows you to enter unicode characters using their hexcode. 1344This allows you to enter unicode characters using their hexcode.
946.Sp 1345.Sp
947Start by pressing and holding both \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, then enter 1346Start by pressing and holding both \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, then enter
948hex-digits (between one and six). Releasing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR will 1347hex-digits (between one and six). Releasing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR will
… …
954As an example of use, imagine a business card with a japanese e\-mail 1353As an example of use, imagine a business card with a japanese e\-mail
955address, which you cannot type. Fortunately, the card has the e\-mail 1354address, which you cannot type. Fortunately, the card has the e\-mail
956address printed as hexcodes, e.g. \f(CW\*(C`671d 65e5\*(C'\fR. You can enter this easily 1355address printed as hexcodes, e.g. \f(CW\*(C`671d 65e5\*(C'\fR. You can enter this easily
957by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, followed by \f(CW\*(C`6\-7\-1\-D\-SPACE\-6\-5\-E\-5\*(C'\fR, 1356by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, followed by \f(CW\*(C`6\-7\-1\-D\-SPACE\-6\-5\-E\-5\*(C'\fR,
958followed by releasing the modifier keys. 1357followed by releasing the modifier keys.
959.IP "5.2: Keyboard symbols entry method" 4 1358.IP "* 5.2: Keyboard symbols entry method" 4
960.IX Item "5.2: Keyboard symbols entry method" 1359.IX Item "5.2: Keyboard symbols entry method"
961This mode lets you input characters representing the keycap symbols of 1360This mode lets you input characters representing the keycap symbols of
962your keyboard, if representable in the current locale encoding. 1361your keyboard, if representable in the current locale encoding.
963.Sp 1362.Sp
964Start 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
965them. 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
966invoke it's usual function but instead will insert the corresponding 1365invoke its usual function but instead will insert the corresponding
967keycap 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
968released, 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
969\&\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
970reverse tab (Shift\-Tab). 1369reverse tab (Shift\-Tab).
971.IP "5.3: Screen-selection entry method" 4 1370.IP "* 5.3: Screen-selection entry method" 4
972.IX Item "5.3: Screen-selection entry method" 1371.IX Item "5.3: Screen-selection entry method"
973While this is implemented already (it's basically the selection 1372While this is implemented already (it's basically the selection
974mechanism), it could be extended by displaying a unicode character map. 1373mechanism), it could be extended by displaying a unicode character map.
975.IP "5.4: Feedback method for identifying displayed characters for later input" 4 1374.IP "* 5.4: Feedback method for identifying displayed characters for later input" 4
976.IX Item "5.4: Feedback method for identifying displayed characters for later input" 1375.IX Item "5.4: Feedback method for identifying displayed characters for later input"
977This method lets you display the unicode character code associated with 1376This method lets you display the unicode character code associated with
978characters already displayed. 1377characters already displayed.
979.Sp 1378.Sp
980You enter this mode by holding down \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then 1379You enter this mode by holding down \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then
… …
989.PP 1388.PP
990With respect to conformance, rxvt-unicode is supposed to be compliant to 1389With respect to conformance, rxvt-unicode is supposed to be compliant to
991both scenario A and B of \s-1ISO\s0 14755, including part 5.2. 1390both scenario A and B of \s-1ISO\s0 14755, including part 5.2.
992.SH "LOGIN STAMP" 1391.SH "LOGIN STAMP"
993.IX Header "LOGIN STAMP" 1392.IX Header "LOGIN STAMP"
994\&\fB@@RXVT_NAME@@\fR tries to write an entry into the \fIutmp\fR(5) file so 1393\&\fB@@RXVT_NAME@@\fR tries to write an entry into the \fIutmp\fR(5) file so that
995that it can be seen via the \fI\fIwho\fI\|(1)\fR command, and can accept messages. 1394it can be seen via the \fI\fIwho\fI\|(1)\fR command, and can accept messages. To
996To allow this feature, \fB@@RXVT_NAME@@\fR must be installed setuid root on 1395allow this feature, \fB@@RXVT_NAME@@\fR may need to be installed setuid root
997some systems. 1396on some systems or setgid to root or to some other group on others.
998.SH "COLORS AND GRAPHICS" 1397.SH "COLORS AND GRAPHICS"
999.IX Header "COLORS AND GRAPHICS" 1398.IX Header "COLORS AND GRAPHICS"
1000In addition to the default foreground and background colours, 1399In addition to the default foreground and background colours,
1001\&\fB@@RXVT_NAME@@\fR can display up to 16 colours (8 \s-1ANSI\s0 colours plus 1400\&\fB@@RXVT_NAME@@\fR can display up to 16 colours (8 \s-1ANSI\s0 colours plus
1002high-intensity bold/blink versions of the same). Here is a list of the 1401high-intensity bold/blink versions of the same). Here is a list of the
1003colours with their \fBrgb.txt\fR names. 1402colours with their names.
1004.TS 1403.TS
1005l l l . 1404l l l .
1006color0 (black) = Black 1405color0 (black) = Black
1007color1 (red) = Red3 1406color1 (red) = Red3
1008color2 (green) = Green3 1407color2 (green) = Green3
… …
1027It is also possible to specify the colour values of \fBforeground\fR, 1426It is also possible to specify the colour values of \fBforeground\fR,
1028\&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as 1427\&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as
1029a 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
1030color0\-color15. 1429color0\-color15.
1031.PP 1430.PP
1431In addition to the colours defined above, @@RXVT_NAME@@ offers an
1432additional 72 colours. The first 64 of those (with indices 16 to 79)
1433consist of a 4*4*4 \s-1RGB\s0 colour cube (i.e. \fIindex = r * 16 + g * 4 + b +
143416\fR), followed by 8 additional shades of gray (with indices 80 to 87).
1435.PP
1436Together, all those colours implement the 88 colour xterm colours. Only
1437the first 16 can be changed using resources currently, the rest can only
1438be changed via command sequences (\*(L"escape codes\*(R").
1439.PP
1032Note 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
1033always swapping the foreground/background colours. This is in contrast to 1441always swapping the foreground/background colours. This is in contrast to
1034\&\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
1035been specified. For example, 1443been specified. For example,
1036.IP "\fB@@RXVT_NAME@@ \-fg Black \-bg White \-rv\fR" 4 1444.IP "\fB@@RXVT_NAME@@ \-fg Black \-bg White \-rv\fR" 4
1037.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv" 1445.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv"
1038would 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
1039on 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
1040.SH "ENVIRONMENT" 1473.SH "ENVIRONMENT"
1041.IX Header "ENVIRONMENT" 1474.IX Header "ENVIRONMENT"
1042\&\fB@@RXVT_NAME@@\fR sets the environment variables \fB\s-1TERM\s0\fR, \fB\s-1COLORTERM\s0\fR 1475\&\fB@@RXVT_NAME@@\fR sets and/or uses the following environment variables:
1043and \fB\s-1COLORFGBG\s0\fR. The environment variable \fB\s-1WINDOWID\s0\fR is set to the X 1476.IP "\fB\s-1TERM\s0\fR" 4
1044window id number of the \fB@@RXVT_NAME@@\fR window and it also uses and 1477.IX Item "TERM"
1045sets the environment variable \fB\s-1DISPLAY\s0\fR to specify which display 1478Normally set to \f(CW\*(C`rxvt\-unicode\*(C'\fR, unless overwritten at configure time, via
1046terminal to use. \fB@@RXVT_NAME@@\fR uses the environment variables 1479resources or on the command line.
1047\&\fB\s-1RXVTPATH\s0\fR and \fB\s-1PATH\s0\fR to find \s-1XPM\s0 files. 1480.IP "\fB\s-1COLORTERM\s0\fR" 4
1481.IX Item "COLORTERM"
1482Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on whether @@RXVT_NAME@@ was
1483compiled with background image support, and optionally with the added
1484extension \f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome
1485screen.
1486.IP "\fB\s-1COLORFGBG\s0\fR" 4
1487.IX Item "COLORFGBG"
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
1489the colour code used as default foreground/text colour (or the string
1490\&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be
1491used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the
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@@
1493was compiled with background image support. Libraries like \f(CW\*(C`ncurses\*(C'\fR
1494and \f(CW\*(C`slang\*(C'\fR can (and do) use this information to optimize screen output.
1495.IP "\fB\s-1WINDOWID\s0\fR" 4
1496.IX Item "WINDOWID"
1497Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel
1498window, which usually has subwindows for the scrollbar, the terminal
1499window and so on).
1500.IP "\fB\s-1TERMINFO\s0\fR" 4
1501.IX Item "TERMINFO"
1502Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1503\&\f(CW\*(C`\-\-with\-terminfo=PATH\*(C'\fR.
1504.IP "\fB\s-1DISPLAY\s0\fR" 4
1505.IX Item "DISPLAY"
1506Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1507display in its child processes.
1508.IP "\fB\s-1SHELL\s0\fR" 4
1509.IX Item "SHELL"
1510The shell to be used for command execution, defaults to \f(CW\*(C`/bin/sh\*(C'\fR.
1511.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
1512.IX Item "RXVT_SOCKET"
1513The unix domain socket path used by @@RXVT_NAME@@c(1) and
1514@@RXVT_NAME@@d(1).
1515.Sp
1516Default \fI$HOME/.rxvt\-unicode\-\fI<nodename\fI\fR.
1517.IP "\fB\s-1HOME\s0\fR" 4
1518.IX Item "HOME"
1519Used to locate the default directory for the unix domain socket for
1520daemon communications and to locate various resource files (such as
1521\&\f(CW\*(C`.Xdefaults\*(C'\fR)
1522.IP "\fB\s-1XAPPLRESDIR\s0\fR" 4
1523.IX Item "XAPPLRESDIR"
1524Directory where various X resource files are being located.
1525.IP "\fB\s-1XENVIRONMENT\s0\fR" 4
1526.IX Item "XENVIRONMENT"
1527If set and accessible, gives the name of a X resource file to be loaded by
1528@@RXVT_NAME@@.
1048.SH "FILES" 1529.SH "FILES"
1049.IX Header "FILES" 1530.IX Header "FILES"
1050.IP "\fB/etc/utmp\fR" 4
1051.IX Item "/etc/utmp"
1052System file for login records.
1053.IP "\fB/usr/lib/X11/rgb.txt\fR" 4 1531.IP "\fB/usr/lib/X11/rgb.txt\fR" 4
1054.IX Item "/usr/lib/X11/rgb.txt" 1532.IX Item "/usr/lib/X11/rgb.txt"
1055Color names. 1533Color names.
1056.SH "SEE ALSO" 1534.SH "SEE ALSO"
1057.IX Header "SEE ALSO" 1535.IX Header "SEE ALSO"
1058@@RXVT_NAME@@(7), \fIxterm\fR\|(1), \fIsh\fR\|(1), \fIresize\fR\|(1), X(1), \fIpty\fR\|(4), \fItty\fR\|(4), \fIutmp\fR\|(5) 1536@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), \fIxterm\fR\|(1), \fIsh\fR\|(1), \fIresize\fR\|(1), X(1), \fIpty\fR\|(4), \fItty\fR\|(4), \fIutmp\fR\|(5)
1059.SH "BUGS"
1060.IX Header "BUGS"
1061Check the \s-1BUGS\s0 file for an up-to-date list.
1062.PP
1063Cursor change support is not yet implemented.
1064.PP
1065Click-and-drag doesn't work with X11 mouse report overriding.
1066.SH "CURRENT PROJECT COORDINATOR" 1537.SH "CURRENT PROJECT COORDINATOR"
1067.IX Header "CURRENT PROJECT COORDINATOR" 1538.IX Header "CURRENT PROJECT COORDINATOR"
1068.IP "Project Coordinator" 4 1539.IP "Project Coordinator" 4
1069.IX Item "Project Coordinator" 1540.IX Item "Project Coordinator"
1070@@RXVT_MAINT@@ @@RXVT_MAINTEMAIL@@ 1541Marc A. Lehmann <rxvt\-unicode@schmorp.de>
1071.IP "Web page maintainter" 4
1072.IX Item "Web page maintainter"
1073@@RXVT_WEBMAINT@@ @@RXVT_WEBMAINTEMAIL@@
1074.Sp 1542.Sp
1075@@RXVT_WEBPAGE@@ 1543<http://software.schmorp.de/pkg/rxvt\-unicode.html>
1076.SH "AUTHORS" 1544.SH "AUTHORS"
1077.IX Header "AUTHORS" 1545.IX Header "AUTHORS"
1078.IP "John Bovey" 4 1546.IP "John Bovey" 4
1079.IX Item "John Bovey" 1547.IX Item "John Bovey"
1080University of Kent, 1992, wrote the original Xvt. 1548University of Kent, 1992, wrote the original Xvt.
… …
1092.IP "Oezguer Kesim <kesim@math.fu\-berlin.de>" 4 1560.IP "Oezguer Kesim <kesim@math.fu\-berlin.de>" 4
1093.IX Item "Oezguer Kesim <kesim@math.fu-berlin.de>" 1561.IX Item "Oezguer Kesim <kesim@math.fu-berlin.de>"
1094Project Coordinator (changes.txt 2.21a to 2.4.5) 1562Project Coordinator (changes.txt 2.21a to 2.4.5)
1095.IP "Geoff Wing <gcw@pobox.com>" 4 1563.IP "Geoff Wing <gcw@pobox.com>" 4
1096.IX Item "Geoff Wing <gcw@pobox.com>" 1564.IX Item "Geoff Wing <gcw@pobox.com>"
1097Rewrote screen display and text selection routines. Project Coordinator 1565Rewrote screen display and text selection routines.
1566.Sp
1098(changes.txt 2.4.6 \- rxvt\-unicode) 1567Project Coordinator (changes.txt 2.4.6 \- rxvt\-unicode)
1099.IP "Marc Alexander Lehmann <rxvt@schmorp.de>" 4 1568.IP "Marc Alexander Lehmann <rxvt\-unicode@schmorp.de>" 4
1100.IX Item "Marc Alexander Lehmann <rxvt@schmorp.de>" 1569.IX Item "Marc Alexander Lehmann <rxvt-unicode@schmorp.de>"
1101Forked rxvt\-unicode, rewrote most of the display code and internal 1570Forked rxvt\-unicode, unicode support, rewrote almost all the code, perl
1102character handling to store text in unicode, improve xterm 1571extension, random hacks, numerous bugfixes and extensions.
1103compatibility and apply numerous other bugfixes and extensions.
1104.Sp 1572.Sp
1105Project Coordinator (Changes 1.0 \-) 1573Project Coordinator (Changes 1.0 \-)
1574.IP "Emanuele Giaquinta <e.giaquinta@glauco.it>" 4
1575.IX Item "Emanuele Giaquinta <e.giaquinta@glauco.it>"
1576Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.

Diff Legend

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