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

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines