ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.man.in
Revision: 1.117
Committed: Wed Dec 31 14:01:02 2014 UTC (9 years, 6 months ago) by root
Branch: MAIN
Changes since 1.116: +30 -40 lines
Log Message:
9.21

File Contents

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