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.3 by root, Mon Jan 17 01:44:51 2005 UTC vs.
Revision 1.115 by root, Sat Apr 26 14:31:44 2014 UTC

1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 1.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sh \" Subsection heading
6.br
7.if t .Sp
8.ne 5
9.PP
10\fB\\$1\fR
11.PP
12..
13.de Sp \" Vertical space (when we can't use .PP) 5.de Sp \" Vertical space (when we can't use .PP)
14.if t .sp .5v 6.if t .sp .5v
15.if n .sp 7.if n .sp
16.. 8..
17.de Vb \" Begin verbatim text 9.de Vb \" Begin verbatim text
23.ft R 15.ft R
24.fi 16.fi
25.. 17..
26.\" Set up some character translations and predefined strings. \*(-- will 18.\" Set up some character translations and predefined strings. \*(-- will
27.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left 19.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28.\" double quote, and \*(R" will give a right double quote. | will give a 20.\" double quote, and \*(R" will give a right double quote. \*(C+ will
29.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to 21.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' 22.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31.\" expand to `' in nroff, nothing in troff, for use with C<>. 23.\" nothing in troff, for use with C<>.
32.tr \(*W-|\(bv\*(Tr 24.tr \(*W-
33.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' 25.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34.ie n \{\ 26.ie n \{\
35. ds -- \(*W- 27. ds -- \(*W-
36. ds PI pi 28. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch 29. 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 30. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" "" 31. ds L" ""
40. ds R" "" 32. ds R" ""
41. ds C` 33. ds C` ""
42. ds C' 34. ds C' ""
43'br\} 35'br\}
44.el\{\ 36.el\{\
45. ds -- \|\(em\| 37. ds -- \|\(em\|
46. ds PI \(*p 38. ds PI \(*p
47. ds L" `` 39. ds L" ``
48. ds R" '' 40. ds R" ''
41. ds C`
42. ds C'
49'br\} 43'br\}
50.\" 44.\"
45.\" Escape single quotes in literal strings from groff's Unicode transform.
46.ie \n(.g .ds Aq \(aq
47.el .ds Aq '
48.\"
51.\" If the F register is turned on, we'll generate index entries on stderr for 49.\" If the F register is turned on, we'll generate index entries on stderr for
52.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index 50.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
53.\" entries marked with X<> in POD. Of course, you'll have to process the 51.\" entries marked with X<> in POD. Of course, you'll have to process the
54.\" output yourself in some meaningful fashion. 52.\" output yourself in some meaningful fashion.
55.if \nF \{\ 53.\"
54.\" Avoid warning from groff about undefined register 'F'.
56. de IX 55.de IX
57. tm Index:\\$1\t\\n%\t"\\$2"
58.. 56..
59. nr % 0 57.nr rF 0
60. rr F 58.if \n(.g .if rF .nr rF 1
59.if (\n(rF:(\n(.g==0)) \{
60. if \nF \{
61. de IX
62. tm Index:\\$1\t\\n%\t"\\$2"
63..
64. if !\nF==2 \{
65. nr % 0
66. nr F 2
67. \}
68. \}
61.\} 69.\}
62.\" 70.rr rF
63.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64.\" way too many mistakes in technical documents.
65.hy 0
66.if n .na
67.\" 71.\"
68.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). 72.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69.\" Fear. Run. Save yourself. No user-serviceable parts. 73.\" Fear. Run. Save yourself. No user-serviceable parts.
70. \" fudge factors for nroff and troff 74. \" fudge factors for nroff and troff
71.if n \{\ 75.if n \{\
126. ds Ae AE 130. ds Ae AE
127.\} 131.\}
128.rm #[ #] #H #V #F C 132.rm #[ #] #H #V #F C
129.\" ======================================================================== 133.\" ========================================================================
130.\" 134.\"
131.IX Title "rxvt 1" 135.IX Title "@@RXVT_NAME@@ 1"
132.TH rxvt 1 "2005-01-17" "4.8" "RXVT-UNICODE" 136.TH @@RXVT_NAME@@ 1 "2014-04-26" "@@RXVT_VERSION@@" "RXVT-UNICODE"
137.\" For nroff, turn off justification. Always turn off hyphenation; it makes
138.\" way too many mistakes in technical documents.
139.if n .ad l
140.nh
133.SH "NAME" 141.SH "NAME"
134rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system) 142rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system)
135.SH "SYNOPSIS" 143.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 144.IX Header "SYNOPSIS"
137\&\fB@@RXVT_NAME@@\fR [options] [\-e command [ args ]] 145\&\fB@@RXVT_NAME@@\fR [options] [\-e command [ args ]]
140\&\fBrxvt-unicode\fR, version \fB@@RXVT_VERSION@@\fR, is a colour vt102 terminal 148\&\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 149emulator intended as an \fIxterm\fR(1) replacement for users who do not
142require features such as Tektronix 4014 emulation and toolkit-style 150require features such as Tektronix 4014 emulation and toolkit-style
143configurability. As a result, \fBrxvt-unicode\fR uses much less swap space \*(-- 151configurability. As a result, \fBrxvt-unicode\fR uses much less swap space \*(--
144a significant advantage on a machine serving many X sessions. 152a significant advantage on a machine serving many X sessions.
153.PP
154This document is also available on the World-Wide-Web at
155<http://pod.tst.eu/http://cvs.schmorp.de/rxvt\-unicode/doc/rxvt.1.pod>.
145.SH "FREQUENTLY ASKED QUESTIONS" 156.SH "FREQUENTLY ASKED QUESTIONS"
146.IX Header "FREQUENTLY ASKED QUESTIONS" 157.IX Header "FREQUENTLY ASKED QUESTIONS"
147See @@RXVT_NAME@@(7) (try \f(CW\*(C`man 7 @@RXVT_NAME@@\*(C'\fR) for a list of frequently 158See @@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. 159frequently asked questions and answer to them and some common
160problems. That document is also accessible on the World-Wide-Web at
161<http://pod.tst.eu/http://cvs.schmorp.de/rxvt\-unicode/doc/rxvt.7.pod>.
149.SH "RXVT-UNICODE VS. RXVT" 162.SH "RXVT-UNICODE VS. RXVT"
150.IX Header "RXVT-UNICODE VS. RXVT" 163.IX Header "RXVT-UNICODE VS. RXVT"
151Unlike the original rxvt, \fBrxvt-unicode\fR stores all text in Unicode 164Unlike the original rxvt, \fBrxvt-unicode\fR stores all text in Unicode
152internally. That means it can store and display most scripts in the 165internally. That means it can store and display most scripts in the
153world. Being a terminal emulator, however, some things are very difficult, 166world. Being a terminal emulator, however, some things are very difficult,
154especially cursive scripts such as arabic, vertically written scripts 167especially cursive scripts such as arabic, vertically written scripts
155like mongolian or scripts requiring extremely complex combining rules, 168like mongolian or scripts requiring extremely complex combining rules,
156like tibetan or devenagari. Don't expect pretty output when using these 169like tibetan or devanagari. Don't expect pretty output when using these
157scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 170scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
158fine, though. A somewhat difficult case are left-to-right scripts, such 171fine, though. A somewhat difficult case are right-to-left scripts, such
159as hebrew: \fBrxvt-unicode\fR adopts the view that bidirectional algorithms 172as hebrew: \fBrxvt-unicode\fR adopts the view that bidirectional algorithms
160belong into the application, not the terminal emulator (too many things \*(-- 173belong in the application, not the terminal emulator (too many things \*(--
161such as cursor-movement while editing \*(-- break otherwise), but that might 174such as cursor-movement while editing \*(-- break otherwise), but that might
162change. 175change.
163.PP 176.PP
164If you are looking for a terminal that supports more exotic scripts, let 177If 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 178me 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 179terminal 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 180because the author couldn't get \f(CW\*(C`mlterm\*(C'\fR to use one font for latin1 and
168another for japanese. 181another for japanese.
169.PP 182.PP
170Therefore another design rationale was the use of multiple fonts to 183Therefore another design rationale was the use of multiple fonts to
171display characters: The idea of a single unicode font which many other 184display 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 185programs force onto its users never made sense to me: You should be able
173to choose any font for any script freely. 186to choose any font for any script freely.
174.PP 187.PP
175Apart from that, rxvt-unicode is also much better internationalised than 188Apart 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 189its predecessor, supports things such as \s-1XFT\s0 and \s-1ISO 14755\s0 that are handy
177in i18n\-environments, is faster, and has a lot less bugs than the original 190in i18n\-environments, is faster, and has a lot bugs less than the original
178rxvt. This all in addition to dozens of other small improvements. 191rxvt. This all in addition to dozens of other small improvements.
179.PP 192.PP
180It is still faithfully following the original rxvt idea of being lean 193It is still faithfully following the original rxvt idea of being lean
181and nice on resources: for example, you can still configure rxvt-unicode 194and 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 195without 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 196a client/daemon pair that lets you open any number of terminal windows
184from within a single process, which makes startup time very fast and 197from within a single process, which makes startup time very fast and
185drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 198drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
186@@RXVT_NAME@@c(1) (client). 199@@RXVT_NAME@@c(1) (client).
187.PP 200.PP
188It also makes technical information about escape sequences (which have 201It also makes technical information about escape sequences (which have
189been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 202been extended) more accessible: see @@RXVT_NAME@@(7) for technical
190reference documentation (escape sequences etc.). 203reference documentation (escape sequences etc.).
191.SH "OPTIONS" 204.SH "OPTIONS"
192.IX Header "OPTIONS" 205.IX Header "OPTIONS"
193The \fB@@RXVT_NAME@@\fR options (mostly a subset of \fIxterm\fR's) are listed 206The \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 207below. In keeping with the smaller-is-better philosophy, options may be
195eliminated or default values chosen at compile\-time, so options and 208eliminated or default values chosen at compile-time, so options and
196defaults listed may not accurately reflect the version installed on 209defaults listed may not accurately reflect the version installed on
197your system. `@@RXVT_NAME@@ \-h' gives a list of major compile-time options on 210your system. `@@RXVT_NAME@@ \-h' gives a list of major compile-time options on
198the \fIOptions\fR line. Option descriptions may be prefixed with which 211the \fIOptions\fR line. Option descriptions may be prefixed with which
199compile option each is dependent upon. e.g. `Compile \fI\s-1XIM\s0\fR:' requires 212compile option each is dependent upon. e.g. `Compile \fI\s-1XIM\s0\fR:' requires
200\&\fI\s-1XIM\s0\fR on the \fIOptions\fR line. Note: `@@RXVT_NAME@@ \-help' gives a list of all 213\&\fI\s-1XIM\s0\fR on the \fIOptions\fR line. Note: `@@RXVT_NAME@@ \-help' gives a list of all
209.IP "\fB\-help\fR, \fB\-\-help\fR" 4 222.IP "\fB\-help\fR, \fB\-\-help\fR" 4
210.IX Item "-help, --help" 223.IX Item "-help, --help"
211Print out a message describing available options. 224Print out a message describing available options.
212.IP "\fB\-display\fR \fIdisplayname\fR" 4 225.IP "\fB\-display\fR \fIdisplayname\fR" 4
213.IX Item "-display displayname" 226.IX Item "-display displayname"
214Attempt to open a window on the named X display (\fB\-d\fR still 227Attempt to open a window on the named X display (the older form \fB\-d\fR
215respected). In the absence of this option, the display specified by the 228is still respected. but deprecated). In the absence of this option, the
216\&\fB\s-1DISPLAY\s0\fR environment variable is used. 229display specified by the \fB\s-1DISPLAY\s0\fR environment variable is used.
230.IP "\fB\-depth\fR \fIbitdepth\fR" 4
231.IX Item "-depth bitdepth"
232Compile \fIfrills\fR: Attempt to find a visual with the given bit depth;
233resource \fBdepth\fR.
234.Sp
235[Please note that many X servers (and libXft) are buggy with
236respect to \f(CW\*(C`\-depth 32\*(C'\fR and/or alpha channels, and will cause all sorts
237of graphical corruption. This is harmless, but we can't do anything about
238this, so watch out]
239.IP "\fB\-visual\fR \fIvisualID\fR" 4
240.IX Item "-visual visualID"
241Compile \fIfrills\fR: Use the given visual (see e.g. \f(CW\*(C`xdpyinfo\*(C'\fR for possible
242visual ids).
217.IP "\fB\-geometry\fR \fIgeom\fR" 4 243.IP "\fB\-geometry\fR \fIgeom\fR" 4
218.IX Item "-geometry geom" 244.IX Item "-geometry geom"
219Window geometry (\fB\-g\fR still respected); resource \fBgeometry\fR. 245Window geometry (\fB\-g\fR still respected); resource \fBgeometry\fR.
220.IP "\fB\-rv\fR|\fB+rv\fR" 4 246.IP "\fB\-rv\fR|\fB+rv\fR" 4
221.IX Item "-rv|+rv" 247.IX Item "-rv|+rv"
222Turn on/off simulated reverse video; resource \fBreverseVideo\fR. 248Turn on/off simulated reverse video; resource \fBreverseVideo\fR.
223.IP "\fB\-j\fR|\fB+j\fR" 4 249.IP "\fB\-j\fR|\fB+j\fR" 4
224.IX Item "-j|+j" 250.IX Item "-j|+j"
225Turn on/off jump scrolling; resource \fBjumpScroll\fR. 251Turn on/off jump scrolling (allow multiple lines per refresh); resource \fBjumpScroll\fR.
226.IP "\fB\-ip\fR|\fB+ip\fR" 4 252.IP "\fB\-ss\fR|\fB+ss\fR" 4
227.IX Item "-ip|+ip" 253.IX Item "-ss|+ss"
228Turn on/off inheriting parent window's pixmap. Alternative form is 254Turn on/off skip scrolling (allow multiple screens per refresh); resource \fBskipScroll\fR.
229\&\fB\-tr\fR; resource \fBinheritPixmap\fR.
230.IP "\fB\-fade\fR \fInumber\fR" 4 255.IP "\fB\-fade\fR \fInumber\fR" 4
231.IX Item "-fade number" 256.IX Item "-fade number"
232Fade the text by the given percentage when focus is lost. resource \fBfading\fR. 257Fade the text by the given percentage when focus is lost. Small values
258fade a little only, 100 completely replaces all colours by the fade
259colour; resource \fBfading\fR.
233.IP "\fB\-tint\fR \fIcolour\fR" 4 260.IP "\fB\-fadecolor\fR \fIcolour\fR" 4
234.IX Item "-tint colour" 261.IX Item "-fadecolor colour"
235Tint the transparent background pixmap with the given colour when 262Fade to this colour when fading is used (see \fB\-fade\fR). The default colour
236transparency is enabled with \fB\-tr\fR or \fB\-ip\fR. See also the \fB\-sh\fR 263is opaque black. resource \fBfadeColor\fR.
237option that can be used to brighten or darken the image in addition to 264.IP "\fB\-icon\fR \fIfile\fR" 4
238tinting it. 265.IX Item "-icon file"
239.IP "\fB\-sh\fR" 4 266Compile \fIpixbuf\fR: Use the specified image as application icon. This
240.IX Item "-sh" 267is used by many window managers, taskbars and pagers to represent the
241\&\fInumber\fR Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent 268application window; resource \fIiconFile\fR.
242background image in addition to tinting it (i.e. \fB\-tint\fR must be
243specified, too, e.g. \f(CW\*(C`\-tint white\*(C'\fR).
244.IP "\fB\-bg\fR \fIcolour\fR" 4 269.IP "\fB\-bg\fR \fIcolour\fR" 4
245.IX Item "-bg colour" 270.IX Item "-bg colour"
246Window background colour; resource \fBbackground\fR. 271Window background colour; resource \fBbackground\fR.
247.IP "\fB\-fg\fR \fIcolour\fR" 4 272.IP "\fB\-fg\fR \fIcolour\fR" 4
248.IX Item "-fg colour" 273.IX Item "-fg colour"
249Window foreground colour; resource \fBforeground\fR. 274Window foreground colour; resource \fBforeground\fR.
250.IP "\fB\-pixmap\fR \fIfile[;geom]\fR" 4
251.IX Item "-pixmap file[;geom]"
252Compile \fI\s-1XPM\s0\fR: Specify \s-1XPM\s0 file for the background and also optionally
253specify 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
255command\-line; resource \fBbackgroundPixmap\fR.
256.IP "\fB\-cr\fR \fIcolour\fR" 4 275.IP "\fB\-cr\fR \fIcolour\fR" 4
257.IX Item "-cr colour" 276.IX Item "-cr colour"
258The cursor colour; resource \fBcursorColor\fR. 277The cursor colour; resource \fBcursorColor\fR.
259.IP "\fB\-pr\fR \fIcolour\fR" 4 278.IP "\fB\-pr\fR \fIcolour\fR" 4
260.IX Item "-pr colour" 279.IX Item "-pr colour"
267The colour of the border around the text area and between the scrollbar and the text; 286The colour of the border around the text area and between the scrollbar and the text;
268resource \fBborderColor\fR. 287resource \fBborderColor\fR.
269.IP "\fB\-fn\fR \fIfontlist\fR" 4 288.IP "\fB\-fn\fR \fIfontlist\fR" 4
270.IX Item "-fn fontlist" 289.IX Item "-fn fontlist"
271Select the fonts to be used. This is a comma separated list of font names 290Select 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 291that are checked in order when trying to find glyphs for characters. The
273first font defines the cell size for characters; other fonts might be 292first font defines the cell size for characters; other fonts might be
274smaller, but not (in general) larger. A (hopefully) reasonable default 293smaller, but not (in general) larger. A (hopefully) reasonable default
275font list is always appended to it. See resource \fBfont\fR for more details. 294font list is always appended to it. See resource \fBfont\fR for more details.
276.Sp 295.Sp
277In short, to specify an X11 core font, just specify it's name or prefix it 296In 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, 297with \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.: 298e.g.:
280.Sp 299.Sp
281.Vb 2 300.Vb 2
282\& @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 301\& @@RXVT_NAME@@ \-fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
283\& @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 302\& @@RXVT_NAME@@ \-fn "9x15bold,xft:Bitstream Vera Sans Mono"
284.Ve 303.Ve
285.Sp 304.Sp
286See also the question \*(L"How does rxvt-unicode choose fonts?\*(R" in the \s-1FAQ\s0 305See also the question \*(L"How does rxvt-unicode choose fonts?\*(R" in the \s-1FAQ\s0
287section of @@RXVT_NAME@@(7). 306section of @@RXVT_NAME@@(7).
288.IP "\fB\-fb\fR \fIfontlist\fR" 4 307.IP "\fB\-fb\fR \fIfontlist\fR" 4
289.IX Item "-fb fontlist" 308.IX Item "-fb fontlist"
290Compile font\-styles: The bold font list to use when bold characters are to 309Compile \fIfont-styles\fR: The bold font list to use when \fBbold\fR characters
291be printed. See resource \fBboldFont\fR for details. 310are to be printed. See resource \fBboldFont\fR for details.
292.IP "\fB\-fi\fR \fIfontlist\fR" 4 311.IP "\fB\-fi\fR \fIfontlist\fR" 4
293.IX Item "-fi fontlist" 312.IX Item "-fi fontlist"
294Compile font\-styles: The italic font list to use when bold characters are to 313Compile \fIfont-styles\fR: The italic font list to use when \fIitalic\fR
295be printed. See resource \fBitalicFont\fR for details. 314characters are to be printed. See resource \fBitalicFont\fR for details.
296.IP "\fB\-fbi\fR \fIfontlist\fR" 4 315.IP "\fB\-fbi\fR \fIfontlist\fR" 4
297.IX Item "-fbi fontlist" 316.IX Item "-fbi fontlist"
298Compile font\-styles: The bold italic font list to use when bold characters are to 317Compile \fIfont-styles\fR: The bold italic font list to use when \fB\f(BIbold
299be printed. See resource \fBboldItalicFont\fR for details. 318italic\fB\fR characters are to be printed. See resource \fBboldItalicFont\fR
319for details.
320.IP "\fB\-is\fR|\fB+is\fR" 4
321.IX Item "-is|+is"
322Compile \fIfont-styles\fR: Bold/Blink font styles imply high intensity
323foreground/background (default). See resource \fBintensityStyles\fR for
324details.
300.IP "\fB\-name\fR \fIname\fR" 4 325.IP "\fB\-name\fR \fIname\fR" 4
301.IX Item "-name name" 326.IX Item "-name name"
302Specify the application name under which resources are to be obtained, 327Specify the application name under which resources are to be obtained,
303rather than the default executable file name. Name should not contain 328rather than the default executable file name. Name should not contain
304`.' or `*' characters. Also sets the icon and title name. 329`.' or `*' characters. Also sets the icon and title name.
314Turn on/off visual bell on receipt of a bell character; resource 339Turn on/off visual bell on receipt of a bell character; resource
315\&\fBvisualBell\fR. 340\&\fBvisualBell\fR.
316.IP "\fB\-sb\fR|\fB+sb\fR" 4 341.IP "\fB\-sb\fR|\fB+sb\fR" 4
317.IX Item "-sb|+sb" 342.IX Item "-sb|+sb"
318Turn on/off scrollbar; resource \fBscrollBar\fR. 343Turn on/off scrollbar; resource \fBscrollBar\fR.
344.IP "\fB\-sr\fR|\fB+sr\fR" 4
345.IX Item "-sr|+sr"
346Put scrollbar on right/left; resource \fBscrollBar_right\fR.
347.IP "\fB\-st\fR|\fB+st\fR" 4
348.IX Item "-st|+st"
349Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
350resource \fBscrollBar_floating\fR.
319.IP "\fB\-si\fR|\fB+si\fR" 4 351.IP "\fB\-si\fR|\fB+si\fR" 4
320.IX Item "-si|+si" 352.IX Item "-si|+si"
321Turn on/off scroll-to-bottom on \s-1TTY\s0 output inhibit; resource 353Turn on/off scroll-to-bottom on \s-1TTY\s0 output inhibit; resource
322\&\fBscrollTtyOutput\fR has opposite effect. 354\&\fBscrollTtyOutput\fR has opposite effect.
323.IP "\fB\-sk\fR|\fB+sk\fR" 4 355.IP "\fB\-sk\fR|\fB+sk\fR" 4
327.IP "\fB\-sw\fR|\fB+sw\fR" 4 359.IP "\fB\-sw\fR|\fB+sw\fR" 4
328.IX Item "-sw|+sw" 360.IX Item "-sw|+sw"
329Turn on/off scrolling with the scrollback buffer as new lines appear. 361Turn on/off scrolling with the scrollback buffer as new lines appear.
330This only takes effect if \fB\-si\fR is also given; resource 362This only takes effect if \fB\-si\fR is also given; resource
331\&\fBscrollWithBuffer\fR. 363\&\fBscrollWithBuffer\fR.
332.IP "\fB\-sr\fR|\fB+sr\fR" 4
333.IX Item "-sr|+sr"
334Put scrollbar on right/left; resource \fBscrollBar_right\fR.
335.IP "\fB\-st\fR|\fB+st\fR" 4
336.IX Item "-st|+st"
337Display normal (non XTerm/NeXT) scrollbar without/with a trough;
338resource \fBscrollBar_floating\fR.
339.IP "\fB\-ptab\fR|\fB+ptab\fR" 4 364.IP "\fB\-ptab\fR|\fB+ptab\fR" 4
340.IX Item "-ptab|+ptab" 365.IX Item "-ptab|+ptab"
341If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as 366If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as
342actual wide characters in the screen buffer, which makes it possible to 367actual wide characters in the screen buffer, which makes it possible to
343select and paste them. Since a horizontal tab is a cursor movement and 368select and paste them. Since a horizontal tab is a cursor movement and
344not an actual glyph, this can sometimes be visually annoying as the cursor 369not an actual glyph, this can sometimes be visually annoying as the cursor
345on a tab character is displayed as a wide cursor; resource \fBpastableTabs\fR. 370on a tab character is displayed as a wide cursor; resource \fBpastableTabs\fR.
346.IP "\fB\-bc\fR|\fB+bc\fR" 4 371.IP "\fB\-bc\fR|\fB+bc\fR" 4
347.IX Item "-bc|+bc" 372.IX Item "-bc|+bc"
348Blink the cursor; resource \fBcursorBlink\fR. 373Blink the cursor; resource \fBcursorBlink\fR.
374.IP "\fB\-uc\fR|\fB+uc\fR" 4
375.IX Item "-uc|+uc"
376Make the cursor underlined; resource \fBcursorUnderline\fR.
349.IP "\fB\-iconic\fR" 4 377.IP "\fB\-iconic\fR" 4
350.IX Item "-iconic" 378.IX Item "-iconic"
351Start iconified, if the window manager supports that option. 379Start iconified, if the window manager supports that option.
352Alternative form is \fB\-ic\fR. 380Alternative form is \fB\-ic\fR.
353.IP "\fB\-sl\fR \fInumber\fR" 4 381.IP "\fB\-sl\fR \fInumber\fR" 4
364and \fB\-borderwidth\fR. See resource entry for limits; resource 392and \fB\-borderwidth\fR. See resource entry for limits; resource
365\&\fBexternalBorder\fR. 393\&\fBexternalBorder\fR.
366.IP "\fB\-bl\fR" 4 394.IP "\fB\-bl\fR" 4
367.IX Item "-bl" 395.IX Item "-bl"
368Compile \fIfrills\fR: Set \s-1MWM\s0 hints to request a borderless window, i.e. 396Compile \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 397if honoured by the \s-1WM,\s0 the rxvt-unicode window will not have window
370decorations; resource \fBborderLess\fR. 398decorations; resource \fBborderLess\fR. If the window manager does not
399support \s-1MWM\s0 hints (e.g. kwin), enables override-redirect mode.
400.IP "\fB\-override\-redirect\fR" 4
401.IX Item "-override-redirect"
402Compile \fIfrills\fR: Sets override-redirect on the window; resource
403\&\fBoverride-redirect\fR.
404.IP "\fB\-sbg\fR" 4
405.IX Item "-sbg"
406Compile \fIfrills\fR: Disable the usage of the built-in block graphics/line
407drawing characters and just rely on what the specified fonts provide. Use
408this if you have a good font and want to use its block graphic glyphs;
409resource \fBskipBuiltinGlyphs\fR.
371.IP "\fB\-lsp\fR \fInumber\fR" 4 410.IP "\fB\-lsp\fR \fInumber\fR" 4
372.IX Item "-lsp number" 411.IX Item "-lsp number"
373Compile \fIfrills\fR: Lines (pixel height) to insert between each row of 412Compile \fIfrills\fR: Lines (pixel height) to insert between each row of
374the display. Useful to work around font rendering problems; resource 413the display. Useful to work around font rendering problems; resource
375\&\fBlinespace\fR. 414\&\fBlineSpace\fR.
415.IP "\fB\-letsp\fR \fInumber\fR" 4
416.IX Item "-letsp number"
417Compile \fIfrills\fR: Amount to adjust the computed character width by
418to control overall letter spacing. Negative values will tighten up the
419letter spacing, positive values will space letters out more. Useful to
420work around odd font metrics; resource \fBletterSpace\fR.
376.IP "\fB\-tn\fR \fItermname\fR" 4 421.IP "\fB\-tn\fR \fItermname\fR" 4
377.IX Item "-tn termname" 422.IX Item "-tn termname"
378This option specifies the name of the terminal type to be set in the 423This 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 424\&\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; 425\&\fI\fItermcap\fI\|(5)\fR database and should have \fIli#\fR and \fIco#\fR entries;
383.IX Item "-e command [arguments]" 428.IX Item "-e command [arguments]"
384Run the command with its command-line arguments in the \fB@@RXVT_NAME@@\fR 429Run the command with its command-line arguments in the \fB@@RXVT_NAME@@\fR
385window; also sets the window title and icon name to be the basename of 430window; also sets the window title and icon name to be the basename of
386the program being executed if neither \fI\-title\fR (\fI\-T\fR) nor \fI\-n\fR are 431the 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 432given 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 433on 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, 434run the program specified by the \fB\s-1SHELL\s0\fR environment variable or,
390failing that, \fI\fIsh\fI\|(1)\fR. 435failing that, \fI\fIsh\fI\|(1)\fR.
436.Sp
437Please note that you must specify a program with arguments. If you want to
438run shell commands, you have to specify the shell, like this:
439.Sp
440.Vb 1
441\& @@RXVT_NAME@@ \-e sh \-c "shell commands"
442.Ve
391.IP "\fB\-title\fR \fItext\fR" 4 443.IP "\fB\-title\fR \fItext\fR" 4
392.IX Item "-title text" 444.IX Item "-title text"
393Window title (\fB\-T\fR still respected); the default title is the basename 445Window 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 446of the program specified after the \fB\-e\fR option, if any, otherwise the
395application name; resource \fBtitle\fR. 447application name; resource \fBtitle\fR.
408.IP "\fB\-im\fR \fItext\fR" 4 460.IP "\fB\-im\fR \fItext\fR" 4
409.IX Item "-im text" 461.IX Item "-im text"
410Compile \fI\s-1XIM\s0\fR: input method name. resource \fBinputMethod\fR. 462Compile \fI\s-1XIM\s0\fR: input method name. resource \fBinputMethod\fR.
411.IP "\fB\-imlocale\fR \fIstring\fR" 4 463.IP "\fB\-imlocale\fR \fIstring\fR" 4
412.IX Item "-imlocale string" 464.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. 465The 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 466\&\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 467input extension to be able to input japanese characters while staying in
416another locale. 468another locale. resource \fBimLocale\fR.
469.IP "\fB\-imfont\fR \fIfontset\fR" 4
470.IX Item "-imfont fontset"
471Set the font set to use for the X Input Method, see resource \fBimFont\fR
472for more info.
473.IP "\fB\-tcw\fR" 4
474.IX Item "-tcw"
475Change the meaning of triple-click selection with the left mouse
476button. Only effective when the original (non-perl) selection code is
477in-use. Instead of selecting a full line it will extend the selection to
478the end of the logical line only. resource \fBtripleclickwords\fR.
417.IP "\fB\-insecure\fR" 4 479.IP "\fB\-insecure\fR" 4
418.IX Item "-insecure" 480.IX Item "-insecure"
419Enable \*(L"insecure\*(R" mode, which currently enables most of the escape 481Enable \*(L"insecure\*(R" mode, which currently enables most of the escape
420sequences that echo strings. See the resource \fBinsecure\fR for more 482sequences that echo strings. See the resource \fBinsecure\fR for more
421info. 483info.
430\&\fBsecondaryScreen\fR. 492\&\fBsecondaryScreen\fR.
431.IP "\fB\-ssr\fR|\fB+ssr\fR" 4 493.IP "\fB\-ssr\fR|\fB+ssr\fR" 4
432.IX Item "-ssr|+ssr" 494.IX Item "-ssr|+ssr"
433Turn on/off secondary screen scroll (default enabled); resource 495Turn on/off secondary screen scroll (default enabled); resource
434\&\fBsecondaryScroll\fR. 496\&\fBsecondaryScroll\fR.
497.IP "\fB\-hold\fR|\fB+hold\fR" 4
498.IX Item "-hold|+hold"
499Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
500will not immediately destroy its window when the program executed within
501it exits. Instead, it will wait till it is being killed or closed by the
502user; resource \fBhold\fR.
503.IP "\fB\-cd\fR \fIpath\fR" 4
504.IX Item "-cd path"
505Sets the working directory for the shell (or the command specified via
506\&\fB\-e\fR). The \fIpath\fR must be an absolute path and it must exist for
507@@RXVT_NAME@@ to start; resource \fBchdir\fR.
435.IP "\fB\-xrm\fR \fIresourcestring\fR" 4 508.IP "\fB\-xrm\fR \fIstring\fR" 4
436.IX Item "-xrm resourcestring" 509.IX Item "-xrm string"
437No effect on rxvt\-unicode. Simply passes through an argument to be made 510Works 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 511as if it were specified in a resource file. Resource values specified this
439some window managers. 512way take precedence over all other resource specifications.
440.SH "RESOURCES (available also as long\-options)" 513.Sp
441.IX Header "RESOURCES (available also as long-options)" 514Note that you need to use the \fIsame\fR syntax as in the .Xdefaults file,
515e.g. \f(CW\*(C`*.background: black\*(C'\fR. Also note that all @@RXVT_NAME@@\-specific
516options can be specified as long-options on the commandline, so use
517of \fB\-xrm\fR is mostly limited to cases where you want to specify other
518resources (e.g. for input methods) or for compatibility with other
519programs.
520.IP "\fB\-keysym.\fR\fIsym\fR \fIstring\fR" 4
521.IX Item "-keysym.sym string"
522Remap a key symbol. See resource \fBkeysym\fR.
523.IP "\fB\-embed\fR \fIwindowid\fR" 4
524.IX Item "-embed windowid"
525Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
526which enables applications to easily embed a terminal.
527.Sp
528Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
529shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
530quite a bit, so don't expect it to keep some specific state. It's best to
531create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
532.Sp
533The window will not be destroyed when @@RXVT_NAME@@ exits.
534.Sp
535It might be useful to know that @@RXVT_NAME@@ will not close file
536descriptors passed to it (except for stdin/out/err, of course), so you
537can use file descriptors to communicate with the programs within the
538terminal. This works regardless of whether the \f(CW\*(C`\-embed\*(C'\fR option was used or
539not.
540.Sp
541Here is a short Gtk2\-perl snippet that illustrates how this option can be
542used (a longer example is in \fIdoc/embed\fR):
543.Sp
544.Vb 5
545\& my $rxvt = new Gtk2::Socket;
546\& $rxvt\->signal_connect_after (realize => sub {
547\& my $xid = $_[0]\->window\->get_xid;
548\& system "@@RXVT_NAME@@ \-embed $xid &";
549\& });
550.Ve
551.IP "\fB\-pty\-fd\fR \fIfile descriptor\fR" 4
552.IX Item "-pty-fd file descriptor"
553Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty
554pair but instead use the given file descriptor as the tty master. This is
555useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
556without having to run a program within it.
557.Sp
558If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
559entries and will not tinker with pty/tty permissions \- you have to do that
560yourself if you want that.
561.Sp
562As an extremely special case, specifying \f(CW\*(C`\-1\*(C'\fR will completely suppress
563pty/tty operations, which is probably only useful in conjunction with some
564perl extension that manages the terminal.
565.Sp
566Here is a example in perl that illustrates how this option can be used (a
567longer example is in \fIdoc/pty\-fd\fR):
568.Sp
569.Vb 2
570\& use IO::Pty;
571\& use Fcntl;
572\&
573\& my $pty = new IO::Pty;
574\& fcntl $pty, F_SETFD, 0; # clear close\-on\-exec
575\& system "@@RXVT_NAME@@ \-pty\-fd " . (fileno $pty) . "&";
576\& close $pty;
577\&
578\& # now communicate with rxvt
579\& my $slave = $pty\->slave;
580\& while (<$slave>) { print $slave "got <$_>\en" }
581.Ve
582.IP "\fB\-pe\fR \fIstring\fR" 4
583.IX Item "-pe string"
584Comma-separated list of perl extension scripts to use (or not to use) in
585this terminal instance. See resource \fBperl-ext\fR for details.
586.SH "RESOURCES"
587.IX Header "RESOURCES"
442Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long 588Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long
443options) compiled into your version. 589options) compiled into your version. All resources are also available as
590long-options.
444.PP 591.PP
445There are two different methods that @@RXVT_NAME@@ can use to get the 592You can set and change the resources using X11 tools like \fBxrdb\fR. Many
446Xresource data: using the X libraries (Xrm*\-functions) or internal 593distribution do also load settings from the \fB~/.Xresources\fR file when X
447Xresources reader (\fB~/.Xdefaults\fR). For the first method (ie. 594starts. @@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 595with 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 596.PP
452If compiled with internal Xresources support (i.e. \fB@@RXVT_NAME@@ \-h\fR 597.Vb 6
453lists \fB.Xdefaults\fR) then \fB@@RXVT_NAME@@\fR accepts application defaults 598\& 1. app\-defaults file in $XAPPLRESDIR
454set in XAPPLOADDIR/URxvt (compile\-time defined: usually 599\& 2. $HOME/.Xdefaults
455\&\fB/usr/lib/X11/app\-defaults/URxvt\fR) and resources set in 600\& 3. RESOURCE_MANAGER property on root\-window of screen 0
456\&\fB~/.Xdefaults\fR, or \fB~/.Xresources\fR if \fB~/.Xdefaults\fR does not exist. 601\& 4. SCREEN_RESOURCES property on root\-window of the current screen
602\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults\-<nodename>
603\& 6. resources specified via \-xrm on the commandline
604.Ve
605.PP
457Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two 606Note 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 607names: \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 608common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be easily
460easily configured, while the class name \fBURxvt\fR allows resources 609configured, while the class name \fBURxvt\fR allows resources unique to
461unique to \fB@@RXVT_NAME@@\fR, notably colours and key\-handling, to be 610\&\fB@@RXVT_NAME@@\fR, to be shared between different \fB@@RXVT_NAME@@\fR
462shared between different \fB@@RXVT_NAME@@\fR configurations. If no 611configurations. If no resources are specified, suitable defaults will
463resources are specified, suitable defaults will be used. Command-line 612be used. Command-line arguments can be used to override resource
464arguments can be used to override resource settings. The following 613settings. The following resources are supported (you might want to
465resources are allowed: 614check the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for additional settings by perl
615extensions not documented here):
616.IP "\fBdepth:\fR \fIbitdepth\fR" 4
617.IX Item "depth: bitdepth"
618Compile \fIxft\fR: Attempt to find a visual with the given bit depth;
619option \fB\-depth\fR.
620.IP "\fBbuffered:\fR \fIboolean\fR" 4
621.IX Item "buffered: boolean"
622Compile \fIxft\fR: Turn on/off double-buffering for xft (default enabled).
623On some card/driver combination enabling it slightly decreases
624performance, on most it greatly helps it. The slowdown is small, so it
625should normally be enabled.
466.IP "\fBgeometry:\fR \fIgeom\fR" 4 626.IP "\fBgeometry:\fR \fIgeom\fR" 4
467.IX Item "geometry: geom" 627.IX Item "geometry: geom"
468Create the window with the specified X window geometry [default 80x24]; 628Create the window with the specified X window geometry [default 80x24];
469option \fB\-geometry\fR. 629option \fB\-geometry\fR.
470.IP "\fBbackground:\fR \fIcolour\fR" 4 630.IP "\fBbackground:\fR \fIcolour\fR" 4
480Use the specified colour for the colour value \fIn\fR, where 0\-7 640Use the specified colour for the colour value \fIn\fR, where 0\-7
481corresponds to low-intensity (normal) colours and 8\-15 corresponds to 641corresponds to low-intensity (normal) colours and 8\-15 corresponds to
482high-intensity (bold = bright foreground, blink = bright background) 642high-intensity (bold = bright foreground, blink = bright background)
483colours. The canonical names are as follows: 0=black, 1=red, 2=green, 643colours. The canonical names are as follows: 0=black, 1=red, 2=green,
4843=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 6443=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
485names used are listed in the \fB\s-1COLORS\s0 \s-1AND\s0 \s-1GRAPHICS\s0\fR section. 645names used are listed in the \fB\s-1COLOURS AND GRAPHICS\s0\fR section.
486.Sp 646.Sp
487Colours higher than 15 cannot be set using resources (yet), but can be 647Colours higher than 15 cannot be set using resources (yet), but can be
488changed using an escape command (see @@RXVT_NAME@@(7)). 648changed using an escape command (see @@RXVT_NAME@@(7)).
489.Sp 649.Sp
490Colours 16\-79 form a standard 4x4x4 colour cube (the same as xterm with 650Colours 16\-79 form a standard 4x4x4 colour cube (the same as xterm with
500(Compile \fIstyles\fR) and this option is unset, reverse video is used instead. 660(Compile \fIstyles\fR) and this option is unset, reverse video is used instead.
501.IP "\fBcolorUL:\fR \fIcolour\fR" 4 661.IP "\fBcolorUL:\fR \fIcolour\fR" 4
502.IX Item "colorUL: colour" 662.IX Item "colorUL: colour"
503Use the specified colour to display underlined characters when the 663Use the specified colour to display underlined characters when the
504foreground colour is the default. 664foreground colour is the default.
505.IP "\fBcolorRV:\fR \fIcolour\fR" 4
506.IX Item "colorRV: colour"
507Use the specified colour as the background for reverse video
508characters.
509.IP "\fBunderlineColor:\fR \fIcolour\fR" 4 665.IP "\fBunderlineColor:\fR \fIcolour\fR" 4
510.IX Item "underlineColor: colour" 666.IX Item "underlineColor: colour"
511If set, use the specified colour as the colour for the underline 667If set, use the specified colour as the colour for the underline
512itself. If unset, use the foreground colour. 668itself. If unset, use the foreground colour.
669.IP "\fBhighlightColor:\fR \fIcolour\fR" 4
670.IX Item "highlightColor: colour"
671If set, use the specified colour as the background for highlighted
672characters. If unset, use reverse video.
673.IP "\fBhighlightTextColor:\fR \fIcolour\fR" 4
674.IX Item "highlightTextColor: colour"
675If set and highlightColor is set, use the specified colour as the
676foreground for highlighted characters.
513.IP "\fBcursorColor:\fR \fIcolour\fR" 4 677.IP "\fBcursorColor:\fR \fIcolour\fR" 4
514.IX Item "cursorColor: colour" 678.IX Item "cursorColor: colour"
515Use the specified colour for the cursor. The default is to use the 679Use the specified colour for the cursor. The default is to use the
516foreground colour; option \fB\-cr\fR. 680foreground colour; option \fB\-cr\fR.
517.IP "\fBcursorColor2:\fR \fIcolour\fR" 4 681.IP "\fBcursorColor2:\fR \fIcolour\fR" 4
521use the background colour. 685use the background colour.
522.IP "\fBreverseVideo:\fR \fIboolean\fR" 4 686.IP "\fBreverseVideo:\fR \fIboolean\fR" 4
523.IX Item "reverseVideo: boolean" 687.IX Item "reverseVideo: boolean"
524\&\fBTrue\fR: simulate reverse video by foreground and background colours; 688\&\fBTrue\fR: simulate reverse video by foreground and background colours;
525option \fB\-rv\fR. \fBFalse\fR: regular screen colours [default]; option 689option \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. 690\&\fB+rv\fR. See note in \fB\s-1COLOURS AND GRAPHICS\s0\fR section.
527.IP "\fBjumpScroll:\fR \fIboolean\fR" 4 691.IP "\fBjumpScroll:\fR \fIboolean\fR" 4
528.IX Item "jumpScroll: boolean" 692.IX Item "jumpScroll: boolean"
529\&\fBTrue\fR: specify that jump scrolling should be used. When scrolling 693\&\fBTrue\fR: specify that jump scrolling should be used. When receiving lots
530quickly, fewer screen updates are performed [default]; option \fB\-j\fR. 694of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
695has been read, resulting in fewer updates while still displaying every
696received line; option \fB\-j\fR.
697.Sp
531\&\fBFalse\fR: specify that smooth scrolling should be used; option \fB+j\fR. 698\&\fBFalse\fR: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
699force a screen refresh on each new line it received; option \fB+j\fR.
532.IP "\fBinheritPixmap:\fR \fIboolean\fR" 4 700.IP "\fBskipScroll:\fR \fIboolean\fR" 4
533.IX Item "inheritPixmap: boolean" 701.IX Item "skipScroll: boolean"
534\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving 702\&\fBTrue\fR: (the default) specify that skip scrolling should be used. When
535artificial transparency. \fBFalse\fR: do not inherit the parent windows' 703receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
536pixmap. 704(around 60 times per second), resulting in far fewer updates. This can
705result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
706option \fB\-ss\fR.
707.Sp
708\&\fBFalse\fR: specify that everything is to be displayed, even
709if the refresh is too fast for the human eye to read anything (or the
710monitor to display anything); option \fB+ss\fR.
537.IP "\fBfading:\fR \fInumber\fR" 4 711.IP "\fBfading:\fR \fInumber\fR" 4
538.IX Item "fading: number" 712.IX Item "fading: number"
539Fade the text by the given percentage when focus is lost. 713Fade the text by the given percentage when focus is lost; option \fB\-fade\fR.
540.IP "\fBtintColor:\fR \fIcolour\fR" 4 714.IP "\fBfadeColor:\fR \fIcolour\fR" 4
541.IX Item "tintColor: colour" 715.IX Item "fadeColor: colour"
542Tint the transparent background pixmap with the given colour. 716Fade to this colour, when fading is used (see \fBfading:\fR). The default
543.IP "\fBshading:\fR \fInumber\fR" 4 717colour is black; option \fB\-fadecolor\fR.
544.IX Item "shading: number" 718.IP "\fBiconFile:\fR \fIfile\fR" 4
545Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background 719.IX Item "iconFile: file"
546image in addition to tinting it. 720Set the application icon pixmap; option \fB\-icon\fR.
547.IP "\fBscrollColor:\fR \fIcolour\fR" 4 721.IP "\fBscrollColor:\fR \fIcolour\fR" 4
548.IX Item "scrollColor: colour" 722.IX Item "scrollColor: colour"
549Use the specified colour for the scrollbar [default #B2B2B2]. 723Use the specified colour for the scrollbar [default #B2B2B2].
550.IP "\fBtroughColor:\fR \fIcolour\fR" 4 724.IP "\fBtroughColor:\fR \fIcolour\fR" 4
551.IX Item "troughColor: colour" 725.IX Item "troughColor: colour"
552Use the specified colour for the scrollbar's trough area [default 726Use the specified colour for the scrollbar's trough area [default
553#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 727#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
554.IP "\fBborderColor:\fR \fIcolour\fR" 4 728.IP "\fBborderColor:\fR \fIcolour\fR" 4
555.IX Item "borderColor: colour" 729.IX Item "borderColor: colour"
556The colour of the border around the text area and between the scrollbar 730The colour of the border around the text area and between the scrollbar
557and the text. 731and the text.
558.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4
559.IX Item "backgroundPixmap: file[;geom]"
560Use the specified \s-1XPM\s0 file (note the `.xpm' extension is optional) for
561the background and also optionally specify its scaling with a geometry
562string \fBWxH+X+Y\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
564centre (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
566specifies an integer number of images in that direction. No image will
567be magnified beyond 10 times its original size. The maximum permitted
568scale is 1000. [default 0x0+50+50]
569.IP "\fBmenu:\fR \fIfile[;tag]\fR" 4
570.IX Item "menu: file[;tag]"
571Read in the specified menu file (note the `.menu' extension is
572optional) and also optionally specify a starting tag to find. See the
573reference documentation for details on the syntax for the menuBar.
574.IP "\fBpath:\fR \fIpath\fR" 4
575.IX Item "path: path"
576Specify the colon-delimited search path for finding files (\s-1XPM\s0 and
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 732.IP "\fBfont:\fR \fIfontlist\fR" 4
580.IX Item "font: fontlist" 733.IX Item "font: fontlist"
581Select the fonts to be used. This is a comma separated list of font 734Select 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. 735that are checked in order when trying to find glyphs for characters. The
583The first font defines the cell size for characters; other fonts might 736first font defines the cell size for characters; other fonts might be
584be smaller, but not larger. A reasonable default font list is always 737smaller, but not (in general) larger. A (hopefully) reasonable default
585appended to it. option \fB\-fn\fR. 738font list is always appended to it; option \fB\-fn\fR.
586.Sp 739.Sp
587Each font can either be a standard X11 core font (\s-1XLFD\s0) name, with 740Each 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. 741optional prefix \f(CW\*(C`x:\*(C'\fR or a Xft font (Compile \fIxft\fR), prefixed with \f(CW\*(C`xft:\*(C'\fR.
589.Sp 742.Sp
590In addition, each font can be prefixed with additional hints and 743In addition, each font can be prefixed with additional hints and
593fonts. 746fonts.
594.Sp 747.Sp
595For example, this font resource 748For example, this font resource
596.Sp 749.Sp
597.Vb 5 750.Vb 5
598\& URxvt*font: 9x15bold,\e 751\& URxvt.font: 9x15bold,\e
599\& -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\e 752\& \-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 753\& \-misc\-fixed\-medium\-r\-normal\-\-15\-140\-75\-75\-c\-90\-iso10646\-1, \e
601\& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e 754\& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e
602\& xft:Code2000:antialias=false 755\& xft:Code2000:antialias=false
603.Ve 756.Ve
604.Sp 757.Sp
605specifies five fonts to be used. The first one is \f(CW\*(C`9x15bold\*(C'\fR (actually 758specifies five fonts to be used. The first one is \f(CW\*(C`9x15bold\*(C'\fR (actually
606the iso8859\-1 version of the second font), which is the base font (because 759the iso8859\-1 version of the second font), which is the base font (because
607it is named first) and thus defines the character cell grid to be 9 pixels 760it is named first) and thus defines the character cell grid to be 9 pixels
608wide and 15 pixels high. 761wide and 15 pixels high.
609.Sp 762.Sp
610The second font is just used to add additional unicode characters not in 763The second font is just used to add additional unicode characters not in
611the base font, likewise the third, which is unfortunately non\-bold, but 764the base font, likewise the third, which is unfortunately non-bold, but
612the bold version of the font does contain less characters, so this is a 765the bold version of the font does contain fewer characters, so this is a
613useful supplement. 766useful supplement.
614.Sp 767.Sp
615The third font is an Xft font with aliasing turned off, and the characters 768The third font is an Xft font with aliasing turned off, and the characters
616are limited to the \fB\s-1JIS\s0 0208\fR codeset (i.e. japanese kanji). The font 769are limited to the \fB\s-1JIS 0208\s0\fR codeset (i.e. japanese kanji). The font
617contains other characters, but we are not interested in them. 770contains other characters, but we are not interested in them.
618.Sp 771.Sp
619The last font is a useful catch-all font that supplies most of the 772The last font is a useful catch-all font that supplies most of the
620remaining unicode characters. 773remaining unicode characters.
621.IP "\fBboldFont:\fR \fIfontlist\fR" 4 774.IP "\fBboldFont:\fR \fIfontlist\fR" 4
627.IX Item "boldItalicFont: fontlist" 780.IX Item "boldItalicFont: fontlist"
628.PD 781.PD
629The font list to use for displaying \fBbold\fR, \fIitalic\fR or \fB\f(BIbold 782The font list to use for displaying \fBbold\fR, \fIitalic\fR or \fB\f(BIbold
630italic\fB\fR characters, respectively. 783italic\fB\fR characters, respectively.
631.Sp 784.Sp
632If specified and non\-empty, then the syntax is the same as for the 785If specified and non-empty, then the syntax is the same as for the
633\&\fBfont\fR\-resource, and the given font list will be used as is, which makes 786\&\fBfont\fR\-resource, and the given font list will be used as is, which makes
634it possible to substitute completely different font styles for bold and 787it possible to substitute completely different font styles for bold and
635italic. 788italic.
636.Sp 789.Sp
637If unset (the default), a suitable font list will be synthesized by 790If unset (the default), a suitable font list will be synthesized by
638\&\*(L"morphing\*(R" the normal text font list into the desired shape. If that is 791\&\*(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. 792not possible, replacement fonts of the desired shape will be tried.
640.Sp 793.Sp
641If set, but empty, then this specific style is disabled and the normal 794If set, but empty, then this specific style is disabled and the normal
642text font will being used for the given style. 795text font will being used for the given style.
643.IP "\fBselectstyle:\fR \fImode\fR" 4 796.IP "\fBintensityStyles:\fR \fIboolean\fR" 4
644.IX Item "selectstyle: mode" 797.IX Item "intensityStyles: boolean"
645Set mouse selection style to \fBold\fR which is 2.20, \fBoldword\fR which is 798When font styles are not enabled, or this option is enabled (\fBTrue\fR,
646xterm style with 2.20 old word selection, or anything else which gives 799option \fB\-is\fR, the default), bold/blink font styles imply high
647xterm style selection. 800intensity foreground/background colours. Disabling this option (\fBFalse\fR,
648.IP "\fBscrollstyle:\fR \fImode\fR" 4 801option \fB+is\fR) disables this behaviour, the high intensity colours are not
649.IX Item "scrollstyle: mode" 802reachable.
650Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is
651the author's favourite..
652.IP "\fBtitle:\fR \fIstring\fR" 4 803.IP "\fBtitle:\fR \fIstring\fR" 4
653.IX Item "title: string" 804.IX Item "title: string"
654Set window title string, the default title is the command-line 805Set window title string, the default title is the command-line
655specified after the \fB\-e\fR option, if any, otherwise the application 806specified after the \fB\-e\fR option, if any, otherwise the application
656name; option \fB\-title\fR. 807name; option \fB\-title\fR.
661set; option \fB\-n\fR. 812set; option \fB\-n\fR.
662.IP "\fBmapAlert:\fR \fIboolean\fR" 4 813.IP "\fBmapAlert:\fR \fIboolean\fR" 4
663.IX Item "mapAlert: boolean" 814.IX Item "mapAlert: boolean"
664\&\fBTrue\fR: de-iconify (map) on receipt of a bell character. \fBFalse\fR: no 815\&\fBTrue\fR: de-iconify (map) on receipt of a bell character. \fBFalse\fR: no
665de-iconify (map) on receipt of a bell character [default]. 816de-iconify (map) on receipt of a bell character [default].
817.IP "\fBurgentOnBell:\fR \fIboolean\fR" 4
818.IX Item "urgentOnBell: boolean"
819\&\fBTrue\fR: set the urgency hint for the wm on receipt of a bell character.
820\&\fBFalse\fR: do not set the urgency hint [default].
821.Sp
822@@RXVT_NAME@@ resets the urgency hint on every focus change.
666.IP "\fBvisualBell:\fR \fIboolean\fR" 4 823.IP "\fBvisualBell:\fR \fIboolean\fR" 4
667.IX Item "visualBell: boolean" 824.IX Item "visualBell: boolean"
668\&\fBTrue\fR: use visual bell on receipt of a bell character; option \fB\-vb\fR. 825\&\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. 826\&\fBFalse\fR: no visual bell [default]; option \fB+vb\fR.
670.IP "\fBloginShell:\fR \fIboolean\fR" 4 827.IP "\fBloginShell:\fR \fIboolean\fR" 4
675.IP "\fButmpInhibit:\fR \fIboolean\fR" 4 832.IP "\fButmpInhibit:\fR \fIboolean\fR" 4
676.IX Item "utmpInhibit: boolean" 833.IX Item "utmpInhibit: boolean"
677\&\fBTrue\fR: inhibit writing record into the system log file \fButmp\fR; 834\&\fBTrue\fR: inhibit writing record into the system log file \fButmp\fR;
678option \fB\-ut\fR. \fBFalse\fR: write record into the system log file \fButmp\fR 835option \fB\-ut\fR. \fBFalse\fR: write record into the system log file \fButmp\fR
679[default]; option \fB+ut\fR. 836[default]; option \fB+ut\fR.
680.IP "\fBprint\-pipe:\fR \fIstring\fR" 4 837.IP "\fBprint-pipe:\fR \fIstring\fR" 4
681.IX Item "print-pipe: string" 838.IX Item "print-pipe: string"
682Specify a command pipe for vt100 printer [default \fI\fIlpr\fI\|(1)\fR]. Use 839Specify 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 840\&\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. 841\&\fBShift-Print\fR to include the scrollback as well.
842.Sp
843The string will be interpreted as if typed into the shell as-is.
844.Sp
845Example:
846.Sp
847.Vb 1
848\& URxvt.print\-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
849.Ve
850.Sp
851This creates a new file in your home directory with the screen contents
852every time you hit \f(CW\*(C`Print\*(C'\fR.
853.IP "\fBscrollstyle:\fR \fImode\fR" 4
854.IX Item "scrollstyle: mode"
855Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is
856the author's favourite.
857.IP "\fBthickness:\fR \fInumber\fR" 4
858.IX Item "thickness: number"
859Set the scrollbar width in pixels.
685.IP "\fBscrollBar:\fR \fIboolean\fR" 4 860.IP "\fBscrollBar:\fR \fIboolean\fR" 4
686.IX Item "scrollBar: boolean" 861.IX Item "scrollBar: boolean"
687\&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR: 862\&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR:
688disable the scrollbar; option \fB+sb\fR. 863disable the scrollbar; option \fB+sb\fR.
689.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4 864.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4
703\&\fBTrue\fR: scroll to bottom when tty receives output; option \fB\-si\fR. 878\&\fBTrue\fR: scroll to bottom when tty receives output; option \fB\-si\fR.
704\&\fBFalse\fR: do not scroll to bottom when tty receives output; option 879\&\fBFalse\fR: do not scroll to bottom when tty receives output; option
705\&\fB+si\fR. 880\&\fB+si\fR.
706.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4 881.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4
707.IX Item "scrollWithBuffer: boolean" 882.IX Item "scrollWithBuffer: boolean"
708\&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and 883\&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (i.e.
709\&\fBscrollTtyOutput\fR is False); option \fB+sw\fR. \fBFalse\fR: do not scroll 884try to show the same lines) and \fBscrollTtyOutput\fR is False; option
710with scrollback buffer when tty recieves new lines; option \fB\-sw\fR. 885\&\fB\-sw\fR. \fBFalse\fR: do not scroll with scrollback buffer when tty receives
886new lines; option \fB+sw\fR.
711.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4 887.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4
712.IX Item "scrollTtyKeypress: boolean" 888.IX Item "scrollTtyKeypress: boolean"
713\&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys 889\&\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 890are 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 891are not passed onto the shell; option \fB\-sk\fR. \fBFalse\fR: do not scroll to
727External border of \fInumber\fR pixels. This resource is limited to 100; 903External border of \fInumber\fR pixels. This resource is limited to 100;
728option \fB\-w\fR, \fB\-bw\fR, \fB\-borderwidth\fR. 904option \fB\-w\fR, \fB\-bw\fR, \fB\-borderwidth\fR.
729.IP "\fBborderLess:\fR \fIboolean\fR" 4 905.IP "\fBborderLess:\fR \fIboolean\fR" 4
730.IX Item "borderLess: boolean" 906.IX Item "borderLess: boolean"
731Set \s-1MWM\s0 hints to request a borderless window, i.e. if honoured by the 907Set \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. 908\&\s-1WM,\s0 the rxvt-unicode window will not have window decorations; option \fB\-bl\fR.
909.IP "\fBskipBuiltinGlyphs:\fR \fIboolean\fR" 4
910.IX Item "skipBuiltinGlyphs: boolean"
911Compile \fIfrills\fR: Disable the usage of the built-in block graphics/line
912drawing characters and just rely on what the specified fonts provide. Use
913this if you have a good font and want to use its block graphic glyphs;
914option \fB\-sbg\fR.
733.IP "\fBtermName:\fR \fItermname\fR" 4 915.IP "\fBtermName:\fR \fItermname\fR" 4
734.IX Item "termName: termname" 916.IX Item "termName: termname"
735Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment 917Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment
736variable; option \fB\-tn\fR. 918variable; option \fB\-tn\fR.
737.IP "\fBlinespace:\fR \fInumber\fR" 4 919.IP "\fBlineSpace:\fR \fInumber\fR" 4
738.IX Item "linespace: number" 920.IX Item "lineSpace: number"
739Specifies number of lines (pixel height) to insert between each row of 921Specifies number of lines (pixel height) to insert between each row of
740the display [default 0]; option \fB\-lsp\fR. 922the display [default 0]; option \fB\-lsp\fR.
741.IP "\fBmeta8:\fR \fIboolean\fR" 4 923.IP "\fBmeta8:\fR \fIboolean\fR" 4
742.IX Item "meta8: boolean" 924.IX Item "meta8: boolean"
743\&\fBTrue\fR: handle Meta (Alt) + keypress to set the 8th bit. \fBFalse\fR: 925\&\fBTrue\fR: handle Meta (Alt) + keypress to set the 8th bit. \fBFalse\fR:
752movement only; option \f(CW\*(C`\-ptab\*(C'\fR. 934movement only; option \f(CW\*(C`\-ptab\*(C'\fR.
753.IP "\fBcursorBlink:\fR \fIboolean\fR" 4 935.IP "\fBcursorBlink:\fR \fIboolean\fR" 4
754.IX Item "cursorBlink: boolean" 936.IX Item "cursorBlink: boolean"
755\&\fBTrue\fR: blink the cursor. \fBFalse\fR: do not blink the cursor [default]; 937\&\fBTrue\fR: blink the cursor. \fBFalse\fR: do not blink the cursor [default];
756option \fB\-bc\fR. 938option \fB\-bc\fR.
939.IP "\fBcursorUnderline:\fR \fIboolean\fR" 4
940.IX Item "cursorUnderline: boolean"
941\&\fBTrue\fR: Make the cursor underlined. \fBFalse\fR: Make the cursor a box [default];
942option \fB\-uc\fR.
757.IP "\fBpointerBlank:\fR \fIboolean\fR" 4 943.IP "\fBpointerBlank:\fR \fIboolean\fR" 4
758.IX Item "pointerBlank: boolean" 944.IX Item "pointerBlank: boolean"
759\&\fBTrue\fR: blank the pointer when a key is pressed or after a set number 945\&\fBTrue\fR: blank the pointer when a key is pressed or after a set number
760of seconds of inactivity. \fBFalse\fR: the pointer is always visible 946of seconds of inactivity. \fBFalse\fR: the pointer is always visible
761[default]. 947[default].
765.IP "\fBpointerColor2:\fR \fIcolour\fR" 4 951.IP "\fBpointerColor2:\fR \fIcolour\fR" 4
766.IX Item "pointerColor2: colour" 952.IX Item "pointerColor2: colour"
767Mouse pointer background colour. 953Mouse pointer background colour.
768.IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4 954.IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4
769.IX Item "pointerBlankDelay: number" 955.IX Item "pointerBlankDelay: number"
770Specifies number of seconds before blanking the pointer [default 2]. 956Specifies number of seconds before blanking the pointer [default 2]. Use a
957large number (e.g. \f(CW987654321\fR) to effectively disable the timeout.
771.IP "\fBbackspacekey:\fR \fIstring\fR" 4 958.IP "\fBbackspacekey:\fR \fIstring\fR" 4
772.IX Item "backspacekey: string" 959.IX Item "backspacekey: string"
773The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR 960The 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 961or unset it will send \fBDelete\fR (code 127) or, with control, \fBBackspace\fR
775(code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode 962(code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode
776escape sequence. 963escape sequence.
777.IP "\fBdeletekey:\fR \fIstring\fR" 4 964.IP "\fBdeletekey:\fR \fIstring\fR" 4
778.IX Item "deletekey: string" 965.IX Item "deletekey: string"
779The string to send when the delete key (not the keypad delete key) is 966The string to send when the delete key (not the keypad delete key) is
780pressed. If unset it will send the sequence traditionally associated 967pressed. If unset it will send the sequence traditionally associated
781with the \fBExecute\fR key. 968with the \fBExecute\fR key.
782.IP "\fBcutchars:\fR \fIstring\fR" 4 969.IP "\fBcutchars:\fR \fIstring\fR" 4
783.IX Item "cutchars: string" 970.IX Item "cutchars: string"
784The characters used as delimiters for double-click word selection. The 971The characters used as delimiters for double-click word selection
785built-in default: 972(whitespace delimiting is added automatically if resource is given).
786.Sp 973.Sp
974When the perl selection extension is in use (the default if compiled
975in, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage), a suitable regex using these
976characters will be created (if the resource exists, otherwise, no regex
977will be created). In this mode, characters outside \s-1ISO\-8859\-1\s0 can be used.
978.Sp
979When the selection extension is not used, only \s-1ISO\-8859\-1\s0 characters can
980be used. If not specified, the built-in default is used:
981.Sp
787\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]{|}\fR 982\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]^{|}\fR
788.IP "\fBpreeditType:\fR \fIstyle\fR" 4 983.IP "\fBpreeditType:\fR \fIstyle\fR" 4
789.IX Item "preeditType: style" 984.IX Item "preeditType: style"
790\&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR. 985\&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR.
791.IP "\fBinputMethod:\fR \fIname\fR" 4 986.IP "\fBinputMethod:\fR \fIname\fR" 4
792.IX Item "inputMethod: name" 987.IX Item "inputMethod: name"
793\&\fIname\fR of inputMethod to use; option \fB\-im\fR. 988\&\fIname\fR of inputMethod to use; option \fB\-im\fR.
794.IP "\fBimLocale:\fR \fIname\fR" 4 989.IP "\fBimLocale:\fR \fIname\fR" 4
795.IX Item "imLocale: name" 990.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. 991The 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 992\&\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 993input extension to be able to input japanese characters while staying in
799another locale. option \fB\-imlocale\fR. 994another locale; option \fB\-imlocale\fR.
995.IP "\fBimFont:\fR \fIfontset\fR" 4
996.IX Item "imFont: fontset"
997Specify the font-set used for \s-1XIM\s0 styles \f(CW\*(C`OverTheSpot\*(C'\fR or
998\&\f(CW\*(C`OffTheSpot\*(C'\fR. It must be a standard X font set (\s-1XLFD\s0 patterns separated
999by commas), i.e. it's not in the same format as the other font lists used
1000in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
1001found, preferably one or two pixels differing in size to the base font.
1002option \fB\-imfont\fR.
1003.IP "\fBtripleclickwords:\fR \fIboolean\fR" 4
1004.IX Item "tripleclickwords: boolean"
1005Change the meaning of triple-click selection with the left mouse
1006button. Instead of selecting a full line it will extend the selection to
1007the end of the logical line only; option \fB\-tcw\fR.
800.IP "\fBinsecure:\fR \fIboolean\fR" 4 1008.IP "\fBinsecure:\fR \fIboolean\fR" 4
801.IX Item "insecure: boolean" 1009.IX Item "insecure: boolean"
802Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that 1010Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that
803echo arbitrary strings like the icon name or the locale. This could be 1011echo arbitrary strings like the icon name or the locale. This could be
804abused if somebody gets 8\-bit\-clean access to your display, whether 1012abused if somebody gets 8\-bit\-clean access to your display, whether
805throuh a mail client displaying mail bodies unfiltered or though 1013through a mail client displaying mail bodies unfiltered or through
806\&\fIwrite\fR\|(1). Therefore, these sequences are disabled by default. (Note 1014\&\fIwrite\fR\|(1) or any other means. Therefore, these sequences are disabled by
807that other terminals, including xterm, have these sequences 1015default. (Note that many other terminals, including xterm, have these
808enabled by default). You can enable them by setting this boolean 1016sequences enabled by default, which doesn't make it safer, though).
809resource or specifying \fB\-insecure\fR as an option. At the moment, this 1017.Sp
810enabled display\-answer, locale, findfont, icon label and window title 1018You can enable them by setting this boolean resource or specifying
811requests as well as dynamic menubar dispatch. 1019\&\fB\-insecure\fR as an option. At the moment, this enables display-answer,
1020locale, findfont, icon label and window title requests.
812.IP "\fBmodifier:\fR \fImodifier\fR" 4 1021.IP "\fBmodifier:\fR \fImodifier\fR" 4
813.IX Item "modifier: modifier" 1022.IX Item "modifier: modifier"
814Set the key to be interpreted as the Meta key to: \fBalt\fR, \fBmeta\fR, 1023Set 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 1024\&\fBhyper\fR, \fBsuper\fR, \fBmod1\fR, \fBmod2\fR, \fBmod3\fR, \fBmod4\fR, \fBmod5\fR; option
816\&\fB\-mod\fR. 1025\&\fB\-mod\fR.
817.IP "\fBanswerbackString:\fR \fIstring\fR" 4 1026.IP "\fBanswerbackString:\fR \fIstring\fR" 4
818.IX Item "answerbackString: string" 1027.IX Item "answerbackString: string"
819Specify the reply rxvt-unicode sends to the shell when an \s-1ENQ\s0 (control\-E) 1028Specify 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 1029character is passed through. It may contain escape values as described
821in the entry on \fBkeysym\fR following. 1030in the entry on \fBkeysym\fR following.
822.IP "\fBsecondaryScreen:\fR \fIbool\fR" 4 1031.IP "\fBsecondaryScreen:\fR \fIboolean\fR" 4
823.IX Item "secondaryScreen: bool" 1032.IX Item "secondaryScreen: boolean"
824Turn on/off secondary screen (default enabled). 1033Turn on/off secondary screen (default enabled).
825.IP "\fBsecondaryScroll:\fR \fIbool\fR" 4 1034.IP "\fBsecondaryScroll:\fR \fIboolean\fR" 4
826.IX Item "secondaryScroll: bool" 1035.IX Item "secondaryScroll: boolean"
827Turn on/off secondary screen scroll (default enabled). If the this 1036Turn on/off secondary screen scroll (default enabled). If this
828option is enabled, scrolls on the secondary screen will change the 1037option is enabled, scrolls on the secondary screen will change the
829scrollback buffer and switching to/from the secondary screen will 1038scrollback buffer and, when secondaryScreen is off, switching
830instead scroll the screen up. 1039to/from the secondary screen will instead scroll the screen up.
1040.IP "\fBhold\fR: \fIboolean\fR" 4
1041.IX Item "hold: boolean"
1042Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1043will not immediately destroy its window when the program executed within
1044it exits. Instead, it will wait till it is being killed or closed by the
1045user.
1046.IP "\fBchdir\fR: \fIpath\fR" 4
1047.IX Item "chdir: path"
1048Sets the working directory for the shell (or the command specified via
1049\&\fB\-e\fR). The \fIpath\fR must be an absolute path and it must exist for
1050@@RXVT_NAME@@ to start. If it isn't specified then the current working
1051directory will be used; option \fB\-cd\fR.
831.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4 1052.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4
832.IX Item "keysym.sym: string" 1053.IX Item "keysym.sym: string"
833Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The 1054Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The
834intervening resource name \fBkeysym.\fR cannot be omitted. 1055intervening resource name \fBkeysym.\fR cannot be omitted.
835.Sp 1056.Sp
839and the abbreviated \fBI\fR, \fBK\fR, \fBC\fR, \fBN\fR, \fBS\fR, \fBM\fR, \fBA\fR, \fBL\fR, \fB1\fR, 1060and 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. 1061\&\fB2\fR, \fB3\fR, \fB4\fR, \fB5\fR.
841.Sp 1062.Sp
842The \fBNumLock\fR, \fBMeta\fR and \fBISOLevel3\fR modifiers are usually aliased to 1063The \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 1064whatever 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 1065keys are being mapped. \fBAppKeypad\fR is a synthetic modifier mapped to the
845current application keymap mode state. 1066current application keymap mode state.
846.Sp 1067.Sp
847The spellings of \fIkey\fR can be obtained by using \fBxev\fR(1) command or 1068The 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 1069searching 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 1070omitting 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 1071keysym value (\fB0x0000 \- 0xFFFF\fR). Note that the lookup of \fIsym\fRs is not
851performed in an exact manner; however, the closest match is assured. 1072performed in an exact manner; however, the closest match is assured.
852.Sp 1073.Sp
853\&\fIstring\fR may contain escape values (\f(CW\*(C`\ea\*(C'\fR: bell, \f(CW\*(C`\eb\*(C'\fR: backspace, 1074\&\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, 1075number), see \s-1RESOURCES\s0 in \f(CW\*(C`man 7 X\*(C'\fR for further 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 1076.Sp
859You can define a range of keysyms in one shot by providing a \fIstring\fR 1077You can define a range of keysyms in one shot by
1078loading the \f(CW\*(C`keysym\-list\*(C'\fR perl extension and providing a \fIstring\fR
860with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/' 1079with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimiter `/'
861should be a character not used by the strings. 1080should be a character not used by the strings.
862.Sp 1081.Sp
863Its usage can be demonstrated by an example: 1082Its usage can be demonstrated by an example:
864.Sp 1083.Sp
865.Vb 1 1084.Vb 1
866\& URxvt.keysym.M-C-0x61: list|\ee<M-C-|abc|> 1085\& URxvt.keysym.M\-C\-0x61: list|\e033<|abc|>
867.Ve 1086.Ve
868.Sp 1087.Sp
869The above line is equivalent to the following three lines: 1088The above line is equivalent to the following three lines:
870.Sp 1089.Sp
871.Vb 3 1090.Vb 3
872\& URxvt.keysym.Meta-Control-0x61: \ee<M-C-a> 1091\& URxvt.keysym.Meta\-Control\-0x61: \e033<a>
873\& URxvt.keysym.Meta-Control-0x62: \ee<M-C-b> 1092\& URxvt.keysym.Meta\-Control\-0x62: \e033<b>
874\& URxvt.keysym.Meta-Control-0x63: \ee<M-C-c> 1093\& URxvt.keysym.Meta\-Control\-0x63: \e033<c>
875.Ve 1094.Ve
876.Sp 1095.Sp
877If \fIstring\fR takes the form of \f(CW\*(C`proto:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR is 1096If \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, 1097is 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 1098example 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. 1099when Control-Meta-c is being pressed":
1100.Sp
1101.Vb 1
1102\& URxvt.keysym.M\-C\-c: command:\e033]701;zh_CN.GBK\e007
1103.Ve
1104.Sp
1105If \fIstring\fR takes the form \f(CW\*(C`perl:STRING\*(C'\fR, then the specified \fB\s-1STRING\s0\fR
1106is passed to the \f(CW\*(C`on_user_command\*(C'\fR perl handler. See the @@RXVT_NAME@@\fIperl\fR\|(3)
1107manpage. For example, the \fIselection\fR extension (activated via
1108\&\f(CW\*(C`@@RXVT_NAME@@ \-pe selection\*(C'\fR) listens for \f(CW\*(C`selection:rot13\*(C'\fR events:
1109.Sp
1110.Vb 1
1111\& URxvt.keysym.M\-C\-c: perl:selection:rot13
1112.Ve
1113.Sp
1114Due the the large number of modifier combinations, a defined key mapping
1115will match if \fIat least\fR the specified identifiers are being set, and
1116no other key mappings with those and more bits are being defined. That
1117means that defining a key map for \f(CW\*(C`a\*(C'\fR will automatically provide
1118definitions for \f(CW\*(C`Meta\-a\*(C'\fR, \f(CW\*(C`Shift\-a\*(C'\fR and so on, unless some of those are defined
1119mappings themselves.
1120.Sp
1121Unfortunately, this will override built-in key mappings. For example
1122if you overwrite the \f(CW\*(C`Insert\*(C'\fR key you will disable @@RXVT_NAME@@'s
1123\&\f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke \*(L"holes\*(R" into the
1124user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement:
1125.Sp
1126.Vb 2
1127\& URxvt.keysym.Insert: <my insert key sequence>
1128\& URxvt.keysym.S\-Insert: builtin:
1129.Ve
1130.Sp
1131The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination
1132of modifiers. The second line re-establishes the default mapping for
1133\&\f(CW\*(C`Shift\-Insert\*(C'\fR.
1134.Sp
1135The following example will map Control\-Meta\-1 and Control\-Meta\-2 to
1136the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited
1137font-switching at runtime:
1138.Sp
1139.Vb 2
1140\& URxvt.keysym.M\-C\-1: command:\e033]50;suxuseuro\e007
1141\& URxvt.keysym.M\-C\-2: command:\e033]50;9x15bold\e007
1142.Ve
1143.Sp
1144Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1145info):
1146.Sp
1147.Vb 2
1148\& URxvt.keysym.M\-C\-3: command:\e033[8;25;80t
1149\& URxvt.keysym.M\-C\-4: command:\e033[8;48;110t
1150.Ve
1151.IP "\fBperl-ext-common\fR: \fIstring\fR" 4
1152.IX Item "perl-ext-common: string"
1153.PD 0
1154.IP "\fBperl-ext\fR: \fIstring\fR" 4
1155.IX Item "perl-ext: string"
1156.PD
1157Comma-separated list(s) of perl extension scripts (default: \f(CW\*(C`default\*(C'\fR) to
1158use in this terminal instance; option \fB\-pe\fR.
1159.Sp
1160Extension names can be prefixed with a \f(CW\*(C`\-\*(C'\fR sign to prohibit using
1161them. This can be useful to selectively disable some extensions loaded
1162by default, or specified via the \f(CW\*(C`perl\-ext\-common\*(C'\fR resource. For
1163example, \f(CW\*(C`default,\-selection\*(C'\fR will use all the default extension except
1164\&\f(CW\*(C`selection\*(C'\fR.
1165.Sp
1166Extension names can also be followed by an argument in angle brackets
1167(e.g. \f(CW\*(C`searchable\-scrollback<M\-s>\*(C'\fR, which binds the hotkey for
1168searchable scrollback to Alt/Meta\-s). Mentioning the same extension
1169multiple times with different arguments will pass multiple arguments to
1170the extension.
1171.Sp
1172Each extension is looked up in the library directories, loaded if
1173necessary, and bound to the current terminal instance.
1174.Sp
1175If both of these resources are the empty string, then the perl
1176interpreter will not be initialized. The idea behind two options is that
1177\&\fBperl-ext-common\fR will be used for extensions that should be available to
1178all instances, while \fBperl-ext\fR is used for specific instances.
1179.IP "\fBperl-eval\fR: \fIstring\fR" 4
1180.IX Item "perl-eval: string"
1181Perl code to be evaluated when all extensions have been registered. See
1182the @@RXVT_NAME@@\fIperl\fR\|(3) manpage.
1183.IP "\fBperl-lib\fR: \fIpath\fR" 4
1184.IX Item "perl-lib: path"
1185Colon-separated list of additional directories that hold extension
1186scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1187in these directories, then in \f(CW$URXVT_PERL_LIB\fR, \fI\f(CI$HOME\fI/.urxvt/ext\fR and
1188lastly in \fI@@RXVT_LIBDIR@@/urxvt/perl/\fR.
1189.Sp
1190See the @@RXVT_NAME@@\fIperl\fR\|(3) manpage.
1191.IP "\fBselection.pattern\-\f(BIidx\fB\fR: \fIperl-regex\fR" 4
1192.IX Item "selection.pattern-idx: perl-regex"
1193Additional selection patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for
1194details.
1195.IP "\fBselection-autotransform.\f(BIidx\fB\fR: \fIperl-transform\fR" 4
1196.IX Item "selection-autotransform.idx: perl-transform"
1197Selection auto-transform patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage
1198for details.
1199.IP "\fBsearchable-scrollback:\fR \fIkeysym\fR" 4
1200.IX Item "searchable-scrollback: keysym"
1201Sets the hotkey that starts the incremental scrollback buffer search
1202(default: \f(CW\*(C`M\-s\*(C'\fR).
1203.IP "\fBurl-launcher\fR: \fIstring\fR" 4
1204.IX Item "url-launcher: string"
1205Specifies the program to be started with a \s-1URL\s0 argument. Used by the
1206\&\f(CW\*(C`selection\-popup\*(C'\fR and \f(CW\*(C`matcher\*(C'\fR perl extensions.
1207.IP "\fBtransient-for\fR: \fIwindowid\fR" 4
1208.IX Item "transient-for: windowid"
1209Compile \fIfrills\fR: Sets the \s-1WM_TRANSIENT_FOR\s0 property to the given window id.
1210.IP "\fBoverride-redirect\fR: \fIboolean\fR" 4
1211.IX Item "override-redirect: boolean"
1212Compile \fIfrills\fR: Sets override-redirect for the terminal window, making
1213it almost invisible to window managers; option \fB\-override\-redirect\fR.
1214.IP "\fBiso14755:\fR \fIboolean\fR" 4
1215.IX Item "iso14755: boolean"
1216Turn on/off \s-1ISO 14755 \s0(default enabled).
1217.IP "\fBiso14755_52:\fR \fIboolean\fR" 4
1218.IX Item "iso14755_52: boolean"
1219Turn on/off \s-1ISO 14755 5.2\s0 mode (default enabled).
1220.SH "BACKGROUND IMAGE OPTIONS AND RESOURCES"
1221.IX Header "BACKGROUND IMAGE OPTIONS AND RESOURCES"
1222.IP "\fB\-pixmap\fR \fIfile[;oplist]\fR" 4
1223.IX Item "-pixmap file[;oplist]"
1224.PD 0
1225.IP "\fBbackgroundPixmap:\fR \fIfile[;oplist]\fR" 4
1226.IX Item "backgroundPixmap: file[;oplist]"
1227.PD
1228Compile \fIpixbuf\fR: Use the specified image file as the window's
1229background and also optionally specify a colon separated list of
1230operations to modify it. Note that you may need to quote the \f(CW\*(C`;\*(C'\fR
1231character when using the command line option, as \f(CW\*(C`;\*(C'\fR is usually a
1232metacharacter in shells. Supported operations are:
1233.RS 4
1234.IP "\fBWxH+X+Y\fR" 4
1235.IX Item "WxH+X+Y"
1236sets scale and position. \fB\*(L"W\*(R" / \*(L"H\*(R"\fR specify the horizontal/vertical
1237scale (percent), and \fB\*(L"X\*(R" / \*(L"Y\*(R"\fR locate the image centre (percent). A
1238scale of 0 disables scaling.
1239.IP "\fBop=tile\fR" 4
1240.IX Item "op=tile"
1241enables tiling
1242.IP "\fBop=keep\-aspect\fR" 4
1243.IX Item "op=keep-aspect"
1244maintain the image aspect ratio when scaling
1245.IP "\fBop=root\-align\fR" 4
1246.IX Item "op=root-align"
1247use the position of the terminal window relative to the root window as
1248the image offset, simulating a root window background
1249.RE
1250.RS 4
1251.Sp
1252The default scale and position setting is \f(CW\*(C`100x100+50+50\*(C'\fR.
1253Alternatively, a predefined set of templates can be used to achieve
1254the most common setups:
1255.IP "\fBstyle=tiled\fR" 4
1256.IX Item "style=tiled"
1257the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1258.IP "\fBstyle=aspect\-stretched\fR" 4
1259.IX Item "style=aspect-stretched"
1260the image is scaled to fill the whole window maintaining the aspect
1261ratio and centered. Equivalent to 100x100+50+50:op=keep\-aspect
1262.IP "\fBstyle=stretched\fR" 4
1263.IX Item "style=stretched"
1264the image is scaled to fill the whole window. Equivalent to 100x100
1265.IP "\fBstyle=centered\fR" 4
1266.IX Item "style=centered"
1267the image is centered with no scaling. Equivalent to 0x0+50+50
1268.IP "\fBstyle=root\-tiled\fR" 4
1269.IX Item "style=root-tiled"
1270the image is tiled with no scaling and using 'root' positioning.
1271Equivalent to 0x0:op=tile:op=root\-align
1272.RE
1273.RS 4
1274.Sp
1275If multiple templates are specified the last one wins. Note that a
1276template overrides all the scale, position and operations settings.
1277.Sp
1278If used in conjunction with pseudo-transparency, the specified pixmap
1279will be blended over the transparent background using alpha-blending.
1280.RE
1281.IP "\fB\-tr\fR|\fB+tr\fR" 4
1282.IX Item "-tr|+tr"
1283.PD 0
1284.IP "\fBtransparent:\fR \fIboolean\fR" 4
1285.IX Item "transparent: boolean"
1286.PD
1287Turn on/off pseudo-transparency by using the root pixmap as background.
1288.Sp
1289\&\fB\-ip\fR (\fBinheritPixmap\fR) is still accepted as an obsolete alias but
1290will be removed in future versions.
1291.IP "\fB\-tint\fR \fIcolour\fR" 4
1292.IX Item "-tint colour"
1293.PD 0
1294.IP "\fBtintColor:\fR \fIcolour\fR" 4
1295.IX Item "tintColor: colour"
1296.PD
1297Tint the transparent background with the given colour. Note that a
1298black tint yields a completely black image while a white tint yields
1299the image unchanged.
1300.IP "\fB\-sh\fR \fInumber\fR" 4
1301.IX Item "-sh number"
1302.PD 0
1303.IP "\fBshading:\fR \fInumber\fR" 4
1304.IX Item "shading: number"
1305.PD
1306Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1307A value of 100 means no shading.
1308.IP "\fB\-blr\fR \fIHxV\fR" 4
1309.IX Item "-blr HxV"
1310.PD 0
1311.IP "\fBblurRadius:\fR \fIHxV\fR" 4
1312.IX Item "blurRadius: HxV"
1313.PD
1314Apply gaussian blur with the specified radius to the transparent
1315background. If a single number is specified, the vertical and
1316horizontal radii are considered to be the same. Setting one of the
1317radii to 1 and the other to a large number creates interesting effects
1318on some backgrounds. The maximum radius value is 128. An horizontal or
1319vertical radius of 0 disables blurring.
1320.IP "\fBpath:\fR \fIpath\fR" 4
1321.IX Item "path: path"
1322Specify the colon-delimited search path for finding background image files.
881.SH "THE SCROLLBAR" 1323.SH "THE SCROLLBAR"
882.IX Header "THE SCROLLBAR" 1324.IX Header "THE SCROLLBAR"
883Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window 1325Lines 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 1326(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar
885or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and 1327or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and
895the normal text selection/insertion, hold either the Shift or the Meta 1337the normal text selection/insertion, hold either the Shift or the Meta
896(Alt) key while performing the desired mouse action. 1338(Alt) key while performing the desired mouse action.
897.PP 1339.PP
898If mouse reporting mode is active, the normal scrollbar actions are 1340If mouse reporting mode is active, the normal scrollbar actions are
899disabled \*(-- on the assumption that we are using a fullscreen 1341disabled \*(-- on the assumption that we are using a fullscreen
900application. Instead, pressing Button1 and Button3 sends \fBESC[6~\fR 1342application. Instead, pressing Button1 and Button3 sends \fB\s-1ESC\s0 [ 6 ~\fR
901(Next) and \fBESC[5~\fR (Prior), respectively. Similarly, clicking on the 1343(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), 1344up and down arrows sends \fB\s-1ESC\s0 [ A\fR (Up) and \fB\s-1ESC\s0 [ B\fR (Down),
903respectively. 1345respectively.
904.SH "TEXT SELECTION AND INSERTION" 1346.SH "THE SELECTION: SELECTING AND PASTING TEXT"
905.IX Header "TEXT SELECTION AND INSERTION" 1347.IX Header "THE SELECTION: SELECTING AND PASTING TEXT"
906The behaviour of text selection and insertion mechanism is similar to 1348The behaviour of text selection and insertion/pasting mechanism is similar
907\&\fIxterm\fR(1). 1349to \fIxterm\fR(1).
908.IP "\fBSelection\fR:" 4 1350.IP "\fBSelecting\fR:" 4
909.IX Item "Selection:" 1351.IX Item "Selecting:"
910Left click at the beginning of the region, drag to the end of the 1352Left 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 1353and release; Right click to extend the marked region; Left double-click
912double-click to select a word; Left triple-click to select the entire 1354to select a word; Left triple-click to select the entire logical line
913line. 1355(which can span multiple screen lines), unless modified by resource
1356\&\fBtripleclickwords\fR.
914.Sp 1357.Sp
915Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys) 1358Starting 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 1359(Compile: \fIfrills\fR) will create a rectangular selection instead of a
917one. 1360normal one. In this mode, every selected row becomes its own line in the
1361selection, and trailing whitespace is visually underlined and removed from
1362the selection.
918.IP "\fBInsertion\fR:" 4 1363.IP "\fBPasting\fR:" 4
919.IX Item "Insertion:" 1364.IX Item "Pasting:"
920Pressing and releasing the Middle mouse button (or \fBShift-Insert\fR) in 1365Pressing 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 1366window 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. 1367\&\fBMeta\fR modifier) to be inserted as if it had been typed on the keyboard.
1368.Sp
1369Pressing \fBShift-Insert\fR causes the value of the \s-1PRIMARY\s0 selection to be
1370inserted too.
1371.Sp
1372rxvt-unicode also provides the bindings \fBCtrl-Meta-c\fR and
1373<Ctrl\-Meta\-v> to interact with the \s-1CLIPBOARD\s0 selection. The first
1374binding causes the value of the internal selection to be copied to the
1375\&\s-1CLIPBOARD\s0 selection, while the second binding causes the value of the
1376\&\s-1CLIPBOARD\s0 selection to be inserted.
923.SH "CHANGING FONTS" 1377.SH "CHANGING FONTS"
924.IX Header "CHANGING FONTS" 1378.IX Header "CHANGING FONTS"
925Changing fonts (or font sizes, respectively) via the keypad is not yet 1379Changing fonts (or font sizes, respectively) via the keypad is not yet
926supported in rxvt\-unicode. Bug me if you need this. 1380supported in rxvt-unicode. Bug me if you need this.
927.PP 1381.PP
928You can, however, switch fonts at runtime using escape sequences (and 1382You can, however, switch fonts at runtime using escape sequences, e.g.:
929therefore using the menubar), e.g.:
930.PP 1383.PP
931.Vb 1 1384.Vb 1
932\& printf '\ee]701;%s\e007' "9x15bold,xft:Kochi Gothic" 1385\& printf \*(Aq\ee]710;%s\e007\*(Aq "9x15bold,xft:Kochi Gothic"
1386.Ve
1387.PP
1388You can use keyboard shortcuts, too:
1389.PP
1390.Vb 2
1391\& URxvt.keysym.M\-C\-1: command:\e033]710;suxuseuro\e007\e033]711;suxuseuro\e007
1392\& URxvt.keysym.M\-C\-2: command:\e033]710;9x15bold\e007\e033]711;9x15bold\e007
933.Ve 1393.Ve
934.PP 1394.PP
935rxvt-unicode will automatically re-apply these fonts to the output so far. 1395rxvt-unicode will automatically re-apply these fonts to the output so far.
936.SH "ISO 14755 SUPPORT" 1396.SH "ISO 14755 SUPPORT"
937.IX Header "ISO 14755 SUPPORT" 1397.IX Header "ISO 14755 SUPPORT"
938\&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters 1398\&\s-1ISO 14755\s0 is a standard for entering and viewing unicode characters
939and character codes using the keyboard. It consists of 4 parts. The 1399and character codes using the keyboard. It consists of 4 parts. The
940first part is available rxvt-unicode has been compiled with 1400first 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 1401\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled
942with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR. 1402with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR.
1403.IP "\(bu" 4
943.IP "5.1: Basic method" 4 14045.1: Basic method
944.IX Item "5.1: Basic method" 1405.Sp
945This allows you to enter unicode characters using their hexcode. 1406This allows you to enter unicode characters using their hexcode.
946.Sp 1407.Sp
947Start by pressing and holding both \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, then enter 1408Start 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 1409hex-digits (between one and six). Releasing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR will
949commit the character as if it were typed directly. While holding down 1410commit the character as if it were typed directly. While holding down
954As an example of use, imagine a business card with a japanese e\-mail 1415As 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 1416address, 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 1417address 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, 1418by 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. 1419followed by releasing the modifier keys.
1420.IP "\(bu" 4
959.IP "5.2: Keyboard symbols entry method" 4 14215.2: Keyboard symbols entry method
960.IX Item "5.2: Keyboard symbols entry method" 1422.Sp
961This mode lets you input characters representing the keycap symbols of 1423This mode lets you input characters representing the keycap symbols of
962your keyboard, if representable in the current locale encoding. 1424your keyboard, if representable in the current locale encoding.
963.Sp 1425.Sp
964Start by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then releasing 1426Start 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 1427them. The next special key (cursor keys, home etc.) you enter will not
966invoke it's usual function but instead will insert the corresponding 1428invoke its usual function but instead will insert the corresponding
967keycap symbol. The symbol will only be entered when the key has been 1429keycap 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 1430released, 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 1431\&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a
970reverse tab (Shift\-Tab). 1432reverse tab (Shift-Tab).
1433.IP "\(bu" 4
971.IP "5.3: Screen-selection entry method" 4 14345.3: Screen-selection entry method
972.IX Item "5.3: Screen-selection entry method" 1435.Sp
973While this is implemented already (it's basically the selection 1436While this is implemented already (it's basically the selection
974mechanism), it could be extended by displaying a unicode character map. 1437mechanism), it could be extended by displaying a unicode character map.
1438.IP "\(bu" 4
975.IP "5.4: Feedback method for identifying displayed characters for later input" 4 14395.4: Feedback method for identifying displayed characters for later input
976.IX Item "5.4: Feedback method for identifying displayed characters for later input" 1440.Sp
977This method lets you display the unicode character code associated with 1441This method lets you display the unicode character code associated with
978characters already displayed. 1442characters already displayed.
979.Sp 1443.Sp
980You enter this mode by holding down \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then 1444You enter this mode by holding down \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then
981pressing and holding the left mouse button and moving around. The unicode 1445pressing and holding the left mouse button and moving around. The unicode
986character \- due to implementation reasons, characters combined with 1450character \- due to implementation reasons, characters combined with
987combining characters, line drawing characters and unknown characters will 1451combining characters, line drawing characters and unknown characters will
988always be drawn using the built-in support font. 1452always be drawn using the built-in support font.
989.PP 1453.PP
990With respect to conformance, rxvt-unicode is supposed to be compliant to 1454With 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. 1455both scenario A and B of \s-1ISO 14755,\s0 including part 5.2.
992.SH "LOGIN STAMP" 1456.SH "LOGIN STAMP"
993.IX Header "LOGIN STAMP" 1457.IX Header "LOGIN STAMP"
994\&\fB@@RXVT_NAME@@\fR tries to write an entry into the \fIutmp\fR(5) file so 1458\&\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. 1459it 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 1460allow this feature, \fB@@RXVT_NAME@@\fR may need to be installed setuid root
997some systems. 1461on some systems or setgid to root or to some other group on others.
998.SH "COLORS AND GRAPHICS" 1462.SH "COLOURS AND GRAPHICS"
999.IX Header "COLORS AND GRAPHICS" 1463.IX Header "COLOURS AND GRAPHICS"
1000In addition to the default foreground and background colours, 1464In 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 1465\&\fB@@RXVT_NAME@@\fR can display up to 88/256 colours: 8 \s-1ANSI\s0 colours plus
1002high-intensity bold/blink versions of the same). Here is a list of the 1466high-intensity (potentially bold/blink) versions of the same, and 72 (or
1003colours with their \fBrgb.txt\fR names. 1467240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour \s-1RGB\s0
1468cube plus a 8 (24) colour greyscale ramp.
1469.PP
1470Here is a list of the \s-1ANSI\s0 colours with their names.
1004.TS 1471.TS
1005l l l . 1472l l l .
1006color0 (black) = Black 1473color0 (black) = Black
1007color1 (red) = Red3 1474color1 (red) = Red3
1008color2 (green) = Green3 1475color2 (green) = Green3
1020color14 (bright cyan) = Cyan 1487color14 (bright cyan) = Cyan
1021color15 (bright white) = White 1488color15 (bright white) = White
1022foreground = Black 1489foreground = Black
1023background = White 1490background = White
1024.TE 1491.TE
1025
1026.PP 1492.PP
1027It is also possible to specify the colour values of \fBforeground\fR, 1493It is also possible to specify the colour values of \fBforeground\fR,
1028\&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as 1494\&\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 1495a number 0\-15, as a convenient shorthand to reference the colour name of
1030color0\-color15. 1496color0\-color15.
1031.PP 1497.PP
1498The following text gives values for the standard 88 colour mode (and
1499values for the 256 colour mode in parentheses).
1500.PP
1501The \s-1RGB\s0 cube uses indices 16..79 (16..231) using the following formulas:
1502.PP
1503.Vb 2
1504\& index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1505\& index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1506.Ve
1507.PP
1508The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1509steps (1/26 to 25/26 in 1/26 steps) \- black and white are already part of
1510the \s-1RGB\s0 cube.
1511.PP
1512Together, all those colours implement the 88 (256) colour xterm
1513colours. Only the first 16 can be changed using resources currently, the
1514rest can only be changed via command sequences (\*(L"escape codes\*(R").
1515.PP
1516Applications are advised to use terminfo or command sequences to discover
1517number and \s-1RGB\s0 values of all colours (yes, you can query this...).
1518.PP
1032Note that \fB\-rv\fR (\fB\*(L"reverseVideo: True\*(R"\fR) simulates reverse video by 1519Note 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 1520always 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 1521\&\fIxterm\fR(1) where the colours are only swapped if they have not otherwise
1035been specified. For example, 1522been specified. For example,
1523.PP
1524.Vb 1
1036.IP "\fB@@RXVT_NAME@@ \-fg Black \-bg White \-rv\fR" 4 1525\& @@RXVT_NAME@@ \-fg Black \-bg White \-rv
1037.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv" 1526.Ve
1527.PP
1038would yield White on Black, while on \fIxterm\fR(1) it would yield Black 1528would yield White on Black, while on \fIxterm\fR(1) it would yield Black on
1039on White. 1529White.
1530.SS "\s-1ALPHA CHANNEL SUPPORT\s0"
1531.IX Subsection "ALPHA CHANNEL SUPPORT"
1532If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1533their act together, rxvt-unicode will do its own alpha channel management:
1534.PP
1535You can prefix any colour with an opaqueness percentage enclosed in
1536brackets, i.e. \f(CW\*(C`[percent]\*(C'\fR, where \f(CW\*(C`percent\*(C'\fR is a decimal percentage
1537(0\-100) that specifies the opacity of the colour, where \f(CW0\fR is completely
1538transparent and \f(CW100\fR is completely opaque. For example, \f(CW\*(C`[50]red\*(C'\fR is a
1539half-transparent red, while \f(CW\*(C`[95]#00ff00\*(C'\fR is an almost opaque green. This
1540is the recommended format to specify transparency values, and works with
1541all ways to specify a colour.
1542.PP
1543For complete control, rxvt-unicode also supports
1544\&\f(CW\*(C`rgba:rrrr/gggg/bbbb/aaaa\*(C'\fR (exactly four hex digits/component) colour
1545specifications, where the additional \f(CW\*(C`aaaa\*(C'\fR component specifies opacity
1546(alpha) values. The minimum value of \f(CW0000\fR is completely transparent,
1547while \f(CW\*(C`ffff\*(C'\fR is completely opaque). The two example colours from
1548earlier could also be specified as \f(CW\*(C`rgba:ff00/0000/0000/8000\*(C'\fR and
1549\&\f(CW\*(C`rgba:0000/ff00/0000/f332\*(C'\fR.
1550.PP
1551You probably need to specify \fB\*(L"\-depth 32\*(R"\fR, too, to force a visual with
1552alpha channels, and have the luck that your X\-server uses \s-1ARGB\s0 pixel
1553layout, as X is far from just supporting \s-1ARGB\s0 visuals out of the box, and
1554rxvt-unicode just fudges around.
1555.PP
1556For example, the following selects an almost completely transparent black
1557background, and an almost opaque pink foreground:
1558.PP
1559.Vb 1
1560\& @@RXVT_NAME@@ \-depth 32 \-bg rgba:0000/0000/0000/4444 \-fg "[80]pink"
1561.Ve
1562.PP
1563When not using a background image, then the interpretation of the
1564alpha channel is up to your compositing manager (most interpret it as
1565transparency of course).
1566.PP
1567When using a background pixmap or pseudo-transparency, then the background
1568colour will always behave as if it were completely transparent (so the
1569background image shows instead), regardless of how it was specified, while
1570other colours will either be transparent as specified (the background
1571image will show through) on servers supporting the \s-1RENDER\s0 extension, or
1572fully opaque on servers not supporting the \s-1RENDER EXTENSION.\s0
1573.PP
1574Please note that due to bugs in Xft, specifying alpha values might result
1575in garbage being displayed when the X\-server does not support the \s-1RENDER\s0
1576extension.
1040.SH "ENVIRONMENT" 1577.SH "ENVIRONMENT"
1041.IX Header "ENVIRONMENT" 1578.IX Header "ENVIRONMENT"
1042\&\fB@@RXVT_NAME@@\fR sets the environment variables \fB\s-1TERM\s0\fR, \fB\s-1COLORTERM\s0\fR 1579\&\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 1580.IP "\fB\s-1TERM\s0\fR" 4
1044window id number of the \fB@@RXVT_NAME@@\fR window and it also uses and 1581.IX Item "TERM"
1045sets the environment variable \fB\s-1DISPLAY\s0\fR to specify which display 1582Normally 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 1583resources or on the command line.
1047\&\fB\s-1RXVTPATH\s0\fR and \fB\s-1PATH\s0\fR to find \s-1XPM\s0 files. 1584.IP "\fB\s-1COLORTERM\s0\fR" 4
1585.IX Item "COLORTERM"
1586Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on whether @@RXVT_NAME@@ was
1587compiled with background image support, and optionally with the added
1588extension \f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome
1589screen.
1590.IP "\fB\s-1COLORFGBG\s0\fR" 4
1591.IX Item "COLORFGBG"
1592Set 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
1593the colour code used as default foreground/text colour (or the string
1594\&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be
1595used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the
1596string \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@@
1597was compiled with background image support. Libraries like \f(CW\*(C`ncurses\*(C'\fR
1598and \f(CW\*(C`slang\*(C'\fR can (and do) use this information to optimize screen output.
1599.IP "\fB\s-1WINDOWID\s0\fR" 4
1600.IX Item "WINDOWID"
1601Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel
1602window, which usually has subwindows for the scrollbar, the terminal
1603window and so on).
1604.IP "\fB\s-1TERMINFO\s0\fR" 4
1605.IX Item "TERMINFO"
1606Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1607\&\f(CW\*(C`\-\-with\-terminfo=PATH\*(C'\fR.
1608.IP "\fB\s-1DISPLAY\s0\fR" 4
1609.IX Item "DISPLAY"
1610Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1611display in its child processes if \f(CW\*(C`\-display\*(C'\fR isn't used to override. It
1612defaults to \f(CW\*(C`:0\*(C'\fR if it doesn't exist.
1613.IP "\fB\s-1SHELL\s0\fR" 4
1614.IX Item "SHELL"
1615The shell to be used for command execution, defaults to \f(CW\*(C`/bin/sh\*(C'\fR.
1616.IP "\fB\s-1RXVT_SOCKET\s0\fR [\fIsic\fR]" 4
1617.IX Item "RXVT_SOCKET [sic]"
1618The unix domain socket path used by @@RXVT_NAME@@c(1) and
1619@@RXVT_NAME@@d(1).
1620.Sp
1621Default \fI\f(CI$HOME\fI/.urxvt/urxvtd\-\fI<nodename>\fI\fR.
1622.IP "\fB\s-1URXVT_PERL_LIB\s0\fR" 4
1623.IX Item "URXVT_PERL_LIB"
1624Additional \fI:\fR\-separated library search path for perl extensions. Will be
1625searched after \fB\-perl\-lib\fR but before \fI~/.urxvt/ext\fR and the system library
1626directory.
1627.IP "\fB\s-1URXVT_PERL_VERBOSITY\s0\fR" 4
1628.IX Item "URXVT_PERL_VERBOSITY"
1629See @@RXVT_NAME@@perl(3).
1630.IP "\fB\s-1HOME\s0\fR" 4
1631.IX Item "HOME"
1632Used to locate the default directory for the unix domain socket for
1633daemon communications and to locate various resource files (such as
1634\&\f(CW\*(C`.Xdefaults\*(C'\fR)
1635.IP "\fB\s-1XAPPLRESDIR\s0\fR" 4
1636.IX Item "XAPPLRESDIR"
1637Directory where application-specific X resource files are located.
1638.IP "\fB\s-1XENVIRONMENT\s0\fR" 4
1639.IX Item "XENVIRONMENT"
1640If set and accessible, gives the name of a X resource file to be loaded by
1641@@RXVT_NAME@@.
1048.SH "FILES" 1642.SH "FILES"
1049.IX Header "FILES" 1643.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 1644.IP "\fB/usr/lib/X11/rgb.txt\fR" 4
1054.IX Item "/usr/lib/X11/rgb.txt" 1645.IX Item "/usr/lib/X11/rgb.txt"
1055Color names. 1646Colour names.
1056.SH "SEE ALSO" 1647.SH "SEE ALSO"
1057.IX Header "SEE ALSO" 1648.IX Header "SEE ALSO"
1649@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@\-\fIextensions\fR\|(1),
1058@@RXVT_NAME@@(7), \fIxterm\fR\|(1), \fIsh\fR\|(1), \fIresize\fR\|(1), X(1), \fIpty\fR\|(4), \fItty\fR\|(4), \fIutmp\fR\|(5) 1650@@RXVT_NAME@@\fIperl\fR\|(3), \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" 1651.SH "CURRENT PROJECT COORDINATOR"
1067.IX Header "CURRENT PROJECT COORDINATOR" 1652.IX Header "CURRENT PROJECT COORDINATOR"
1068.IP "Project Coordinator" 4 1653.IP "Project Coordinator" 4
1069.IX Item "Project Coordinator" 1654.IX Item "Project Coordinator"
1070@@RXVT_MAINT@@ @@RXVT_MAINTEMAIL@@ 1655Marc 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 1656.Sp
1075@@RXVT_WEBPAGE@@ 1657<http://software.schmorp.de/pkg/rxvt\-unicode.html>
1076.SH "AUTHORS" 1658.SH "AUTHORS"
1077.IX Header "AUTHORS" 1659.IX Header "AUTHORS"
1078.IP "John Bovey" 4 1660.IP "John Bovey" 4
1079.IX Item "John Bovey" 1661.IX Item "John Bovey"
1080University of Kent, 1992, wrote the original Xvt. 1662University of Kent, 1992, wrote the original Xvt.
1092.IP "Oezguer Kesim <kesim@math.fu\-berlin.de>" 4 1674.IP "Oezguer Kesim <kesim@math.fu\-berlin.de>" 4
1093.IX Item "Oezguer Kesim <kesim@math.fu-berlin.de>" 1675.IX Item "Oezguer Kesim <kesim@math.fu-berlin.de>"
1094Project Coordinator (changes.txt 2.21a to 2.4.5) 1676Project Coordinator (changes.txt 2.21a to 2.4.5)
1095.IP "Geoff Wing <gcw@pobox.com>" 4 1677.IP "Geoff Wing <gcw@pobox.com>" 4
1096.IX Item "Geoff Wing <gcw@pobox.com>" 1678.IX Item "Geoff Wing <gcw@pobox.com>"
1097Rewrote screen display and text selection routines. Project Coordinator 1679Rewrote screen display and text selection routines.
1680.Sp
1098(changes.txt 2.4.6 \- rxvt\-unicode) 1681Project Coordinator (changes.txt 2.4.6 \- rxvt-unicode)
1099.IP "Marc Alexander Lehmann <rxvt@schmorp.de>" 4 1682.IP "Marc Alexander Lehmann <rxvt\-unicode@schmorp.de>" 4
1100.IX Item "Marc Alexander Lehmann <rxvt@schmorp.de>" 1683.IX Item "Marc Alexander Lehmann <rxvt-unicode@schmorp.de>"
1101Forked rxvt\-unicode, rewrote most of the display code and internal 1684Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1102character handling to store text in unicode, improve xterm 1685extension, random hacks, numerous bugfixes and extensions.
1103compatibility and apply numerous other bugfixes and extensions.
1104.Sp 1686.Sp
1105Project Coordinator (Changes 1.0 \-) 1687Project Coordinator (Changes 1.0 \-)
1688.IP "Emanuele Giaquinta <emanuele.giaquinta@gmail.com>" 4
1689.IX Item "Emanuele Giaquinta <emanuele.giaquinta@gmail.com>"
1690pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines