ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.man.in
Revision: 1.120
Committed: Fri May 14 13:47:43 2021 UTC (3 years, 2 months ago) by root
Branch: MAIN
Changes since 1.119: +49 -130 lines
Log Message:
*** empty log message ***

File Contents

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