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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.56 by root, Mon Feb 14 18:47:54 2005 UTC vs.
Revision 1.235 by mikachu, Tue Jul 29 13:50:05 2014 UTC

12emulator intended as an I<xterm>(1) replacement for users who do not 12emulator intended as an I<xterm>(1) replacement for users who do not
13require features such as Tektronix 4014 emulation and toolkit-style 13require features such as Tektronix 4014 emulation and toolkit-style
14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16 16
17This document is also available on the World-Wide-Web at
18L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
19
17=head1 FREQUENTLY ASKED QUESTIONS 20=head1 FREQUENTLY ASKED QUESTIONS
18 21
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 22See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 23frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 24problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23 26
24=head1 RXVT-UNICODE VS. RXVT 27=head1 RXVT-UNICODE VS. RXVT
25 28
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 29Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 30internally. That means it can store and display most scripts in the
28world. Being a terminal emulator, however, some things are very difficult, 31world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts 32especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules, 33like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. Don't expect pretty output when using these 34like tibetan or devanagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 35scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are left-to-right scripts, such 36fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 37as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 38belong in the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 39such as cursor-movement while editing -- break otherwise), but that might
37change. 40change.
38 41
39If you are looking for a terminal that supports more exotic scripts, let 42If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very userfriendly, lean and clean 43me recommend C<mlterm>, which is a very user friendly, lean and clean
41terminal emulator. In fact, the reason rxvt-unicode was born was solely 44terminal emulator. In fact, the reason rxvt-unicode was born was solely
42because the author couldn't get C<mlterm> to use one font for latin1 and 45because the author couldn't get C<mlterm> to use one font for latin1 and
43another for japanese. 46another for japanese.
44 47
45Therefore another design rationale was the use of multiple fonts to 48Therefore another design rationale was the use of multiple fonts to
46display characters: The idea of a single unicode font which many other 49display characters: The idea of a single unicode font which many other
47programs force onto it's users never made sense to me: You should be able 50programs force onto its users never made sense to me: You should be able
48to choose any font for any script freely. 51to choose any font for any script freely.
49 52
50Apart from that, rxvt-unicode is also much better internationalised than 53Apart from that, rxvt-unicode is also much better internationalised than
51it's predecessor, supports things such as XFT and ISO 14755 that are handy 54its predecessor, supports things such as XFT and ISO 14755 that are handy
52in i18n-environments, is faster, and has a lot less bugs than the original 55in i18n-environments, is faster, and has a lot bugs less than the original
53rxvt. This all in addition to dozens of other small improvements. 56rxvt. This all in addition to dozens of other small improvements.
54 57
55It is still faithfully following the original rxvt idea of being lean 58It is still faithfully following the original rxvt idea of being lean
56and nice on resources: for example, you can still configure rxvt-unicode 59and nice on resources: for example, you can still configure rxvt-unicode
57without most of it's features to get a lean binary. It also comes with 60without most of its features to get a lean binary. It also comes with
58a client/daemon pair that lets you open any number of terminal windows 61a client/daemon pair that lets you open any number of terminal windows
59from within a single process, which makes startup time very fast and 62from within a single process, which makes startup time very fast and
60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 63drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61@@RXVT_NAME@@c(1) (client). 64@@RXVT_NAME@@c(1) (client).
62 65
63It also makes technical information about escape sequences (which have 66It also makes technical information about escape sequences (which have
64been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 67been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65reference documentation (escape sequences etc.). 68reference documentation (escape sequences etc.).
66 69
67=head1 OPTIONS 70=head1 OPTIONS
68 71
69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed 72The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
89 92
90Print out a message describing available options. 93Print out a message describing available options.
91 94
92=item B<-display> I<displayname> 95=item B<-display> I<displayname>
93 96
94Attempt to open a window on the named X display (B<-d> still 97Attempt to open a window on the named X display (the older form B<-d>
95respected). In the absence of this option, the display specified by the 98is still respected. but deprecated). In the absence of this option, the
96B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
100
101=item B<-depth> I<bitdepth>
102
103Compile I<frills>: Attempt to find a visual with the given bit depth;
104resource B<depth>.
105
106[Please note that many X servers (and libXft) are buggy with
107respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out]
110
111=item B<-visual> I<visualID>
112
113Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible
114visual ids).
97 115
98=item B<-geometry> I<geom> 116=item B<-geometry> I<geom>
99 117
100Window geometry (B<-g> still respected); resource B<geometry>. 118Window geometry (B<-g> still respected); resource B<geometry>.
101 119
103 121
104Turn on/off simulated reverse video; resource B<reverseVideo>. 122Turn on/off simulated reverse video; resource B<reverseVideo>.
105 123
106=item B<-j>|B<+j> 124=item B<-j>|B<+j>
107 125
108Turn on/off jump scrolling; resource B<jumpScroll>. 126Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109 127
110=item B<-ip>|B<+ip> 128=item B<-ss>|B<+ss>
111 129
112Turn on/off inheriting parent window's pixmap. Alternative form is 130Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
113B<-tr>; resource B<inheritPixmap>.
114 131
115=item B<-fade> I<number> 132=item B<-fade> I<number>
116 133
117Fade the text by the given percentage when focus is lost. resource B<fading>. 134Fade the text by the given percentage when focus is lost. Small values
135fade a little only, 100 completely replaces all colours by the fade
136colour; resource B<fading>.
118 137
119=item B<-tint> I<colour> 138=item B<-fadecolor> I<colour>
120 139
121Tint the transparent background pixmap with the given colour when 140Fade to this colour when fading is used (see B<-fade>). The default colour
122transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> 141is opaque black. resource B<fadeColor>.
123option that can be used to brighten or darken the image in addition to
124tinting it.
125 142
126=item B<-sh> 143=item B<-icon> I<file>
127 144
128I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 145Compile I<pixbuf>: Use the specified image as application icon. This
129background image in addition to tinting it (i.e. B<-tint> must be 146is used by many window managers, taskbars and pagers to represent the
130specified, too, e.g. C<-tint white>). 147application window; resource I<iconFile>.
131 148
132=item B<-bg> I<colour> 149=item B<-bg> I<colour>
133 150
134Window background colour; resource B<background>. 151Window background colour; resource B<background>.
135 152
136=item B<-fg> I<colour> 153=item B<-fg> I<colour>
137 154
138Window foreground colour; resource B<foreground>. 155Window foreground colour; resource B<foreground>.
139
140=item B<-pixmap> I<file[;geom]>
141
142Compile I<XPM>: Specify XPM file for the background and also optionally
143specify its scaling with a geometry string. Note you may need to
144add quotes to avoid special shell interpretation of the C<;> in the
145command-line; resource B<backgroundPixmap>.
146 156
147=item B<-cr> I<colour> 157=item B<-cr> I<colour>
148 158
149The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
150 160
162resource B<borderColor>. 172resource B<borderColor>.
163 173
164=item B<-fn> I<fontlist> 174=item B<-fn> I<fontlist>
165 175
166Select the fonts to be used. This is a comma separated list of font names 176Select the fonts to be used. This is a comma separated list of font names
167that are used in turn when trying to display Unicode characters. The 177that are checked in order when trying to find glyphs for characters. The
168first font defines the cell size for characters; other fonts might be 178first font defines the cell size for characters; other fonts might be
169smaller, but not (in general) larger. A (hopefully) reasonable default 179smaller, but not (in general) larger. A (hopefully) reasonable default
170font list is always appended to it. See resource B<font> for more details. 180font list is always appended to it. See resource B<font> for more details.
171 181
172In short, to specify an X11 core font, just specify it's name or prefix it 182In short, to specify an X11 core font, just specify its name or prefix it
173with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, 183with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
174e.g.: 184e.g.:
175 185
176 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
177 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
179See also the question "How does rxvt-unicode choose fonts?" in the FAQ 189See also the question "How does rxvt-unicode choose fonts?" in the FAQ
180section of @@RXVT_NAME@@(7). 190section of @@RXVT_NAME@@(7).
181 191
182=item B<-fb> I<fontlist> 192=item B<-fb> I<fontlist>
183 193
184Compile font-styles: The bold font list to use when bold characters are to 194Compile I<font-styles>: The bold font list to use when B<bold> characters
185be printed. See resource B<boldFont> for details. 195are to be printed. See resource B<boldFont> for details.
186 196
187=item B<-fi> I<fontlist> 197=item B<-fi> I<fontlist>
188 198
189Compile font-styles: The italic font list to use when bold characters are to 199Compile I<font-styles>: The italic font list to use when I<italic>
190be printed. See resource B<italicFont> for details. 200characters are to be printed. See resource B<italicFont> for details.
191 201
192=item B<-fbi> I<fontlist> 202=item B<-fbi> I<fontlist>
193 203
194Compile font-styles: The bold italic font list to use when bold characters are to 204Compile I<font-styles>: The bold italic font list to use when B<< I<bold
195be printed. See resource B<boldItalicFont> for details. 205italic> >> characters are to be printed. See resource B<boldItalicFont>
206for details.
207
208=item B<-is>|B<+is>
209
210Compile I<font-styles>: Bold/Blink font styles imply high intensity
211foreground/background (default). See resource B<intensityStyles> for
212details.
196 213
197=item B<-name> I<name> 214=item B<-name> I<name>
198 215
199Specify the application name under which resources are to be obtained, 216Specify the application name under which resources are to be obtained,
200rather than the default executable file name. Name should not contain 217rather than the default executable file name. Name should not contain
216 233
217=item B<-sb>|B<+sb> 234=item B<-sb>|B<+sb>
218 235
219Turn on/off scrollbar; resource B<scrollBar>. 236Turn on/off scrollbar; resource B<scrollBar>.
220 237
238=item B<-sr>|B<+sr>
239
240Put scrollbar on right/left; resource B<scrollBar_right>.
241
242=item B<-st>|B<+st>
243
244Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
245resource B<scrollBar_floating>.
246
221=item B<-si>|B<+si> 247=item B<-si>|B<+si>
222 248
223Turn on/off scroll-to-bottom on TTY output inhibit; resource 249Turn on/off scroll-to-bottom on TTY output inhibit; resource
224B<scrollTtyOutput> has opposite effect. 250B<scrollTtyOutput> has opposite effect.
225 251
231=item B<-sw>|B<+sw> 257=item B<-sw>|B<+sw>
232 258
233Turn on/off scrolling with the scrollback buffer as new lines appear. 259Turn on/off scrolling with the scrollback buffer as new lines appear.
234This only takes effect if B<-si> is also given; resource 260This only takes effect if B<-si> is also given; resource
235B<scrollWithBuffer>. 261B<scrollWithBuffer>.
236
237=item B<-sr>|B<+sr>
238
239Put scrollbar on right/left; resource B<scrollBar_right>.
240
241=item B<-st>|B<+st>
242
243Display normal (non XTerm/NeXT) scrollbar without/with a trough;
244resource B<scrollBar_floating>.
245 262
246=item B<-ptab>|B<+ptab> 263=item B<-ptab>|B<+ptab>
247 264
248If enabled (default), "Horizontal Tab" characters are being stored as 265If enabled (default), "Horizontal Tab" characters are being stored as
249actual wide characters in the screen buffer, which makes it possible to 266actual wide characters in the screen buffer, which makes it possible to
253 270
254=item B<-bc>|B<+bc> 271=item B<-bc>|B<+bc>
255 272
256Blink the cursor; resource B<cursorBlink>. 273Blink the cursor; resource B<cursorBlink>.
257 274
275=item B<-uc>|B<+uc>
276
277Make the cursor underlined; resource B<cursorUnderline>.
278
258=item B<-iconic> 279=item B<-iconic>
259 280
260Start iconified, if the window manager supports that option. 281Start iconified, if the window manager supports that option.
261Alternative form is B<-ic>. 282Alternative form is B<-ic>.
262 283
278 299
279=item B<-bl> 300=item B<-bl>
280 301
281Compile I<frills>: Set MWM hints to request a borderless window, i.e. 302Compile I<frills>: Set MWM hints to request a borderless window, i.e.
282if honoured by the WM, the rxvt-unicode window will not have window 303if honoured by the WM, the rxvt-unicode window will not have window
283decorations; resource B<borderLess>. 304decorations; resource B<borderLess>. If the window manager does not
305support MWM hints (e.g. kwin), enables override-redirect mode.
306
307=item B<-override-redirect>
308
309Compile I<frills>: Sets override-redirect on the window; resource
310B<override-redirect>.
311
312=item B<-dockapp>
313
314Sets the initial state of the window to WithdrawnState, which makes
315window managers that support this extension treat it as a dockapp.
316
317=item B<-sbg>
318
319Compile I<frills>: Disable the usage of the built-in block graphics/line
320drawing characters and just rely on what the specified fonts provide. Use
321this if you have a good font and want to use its block graphic glyphs;
322resource B<skipBuiltinGlyphs>.
284 323
285=item B<-lsp> I<number> 324=item B<-lsp> I<number>
286 325
287Compile I<frills>: Lines (pixel height) to insert between each row of 326Compile I<frills>: Lines (pixel height) to insert between each row of
288the display. Useful to work around font rendering problems; resource 327the display. Useful to work around font rendering problems; resource
289B<linespace>. 328B<lineSpace>.
329
330=item B<-letsp> I<number>
331
332Compile I<frills>: Amount to adjust the computed character width by
333to control overall letter spacing. Negative values will tighten up the
334letter spacing, positive values will space letters out more. Useful to
335work around odd font metrics; resource B<letterSpace>.
290 336
291=item B<-tn> I<termname> 337=item B<-tn> I<termname>
292 338
293This option specifies the name of the terminal type to be set in the 339This option specifies the name of the terminal type to be set in the
294B<TERM> environment variable. This terminal type must exist in the 340B<TERM> environment variable. This terminal type must exist in the
303given on the command line. If this option is used, it must be the last 349given on the command line. If this option is used, it must be the last
304on the command-line. If there is no B<-e> option then the default is to 350on the command-line. If there is no B<-e> option then the default is to
305run the program specified by the B<SHELL> environment variable or, 351run the program specified by the B<SHELL> environment variable or,
306failing that, I<sh(1)>. 352failing that, I<sh(1)>.
307 353
354Please note that you must specify a program with arguments. If you want to
355run shell commands, you have to specify the shell, like this:
356
357 @@RXVT_NAME@@ -e sh -c "shell commands"
358
308=item B<-title> I<text> 359=item B<-title> I<text>
309 360
310Window title (B<-T> still respected); the default title is the basename 361Window title (B<-T> still respected); the default title is the basename
311of the program specified after the B<-e> option, if any, otherwise the 362of the program specified after the B<-e> option, if any, otherwise the
312application name; resource B<title>. 363application name; resource B<title>.
343for more info. 394for more info.
344 395
345=item B<-tcw> 396=item B<-tcw>
346 397
347Change the meaning of triple-click selection with the left mouse 398Change the meaning of triple-click selection with the left mouse
399button. Only effective when the original (non-perl) selection code is
348button. Instead of selecting a full line it will extend the selection the 400in-use. Instead of selecting a full line it will extend the selection to
349end of the logical line only. resource B<tripleclickwords>. 401the end of the logical line only. resource B<tripleclickwords>.
350 402
351=item B<-insecure> 403=item B<-insecure>
352 404
353Enable "insecure" mode, which currently enables most of the escape 405Enable "insecure" mode, which currently enables most of the escape
354sequences that echo strings. See the resource B<insecure> for more 406sequences that echo strings. See the resource B<insecure> for more
368=item B<-ssr>|B<+ssr> 420=item B<-ssr>|B<+ssr>
369 421
370Turn on/off secondary screen scroll (default enabled); resource 422Turn on/off secondary screen scroll (default enabled); resource
371B<secondaryScroll>. 423B<secondaryScroll>.
372 424
425=item B<-hold>|B<+hold>
426
427Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
428will not immediately destroy its window when the program executed within
429it exits. Instead, it will wait till it is being killed or closed by the
430user; resource B<hold>.
431
432=item B<-cd> I<path>
433
434Sets the working directory for the shell (or the command specified via
435B<-e>). The I<path> must be an absolute path and it must exist for
436@@RXVT_NAME@@ to start; resource B<chdir>.
437
438=item B<-xrm> I<string>
439
440Works like the X Toolkit option of the same name, by adding the I<string>
441as if it were specified in a resource file. Resource values specified this
442way take precedence over all other resource specifications.
443
444Note that you need to use the I<same> syntax as in the .Xdefaults file,
445e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
446options can be specified as long-options on the commandline, so use
447of B<-xrm> is mostly limited to cases where you want to specify other
448resources (e.g. for input methods) or for compatibility with other
449programs.
450
373=item B<-keysym.>I<sym>: I<string> 451=item B<-keysym.>I<sym> I<string>
374 452
375Remap a key symbol. See resource B<keysym>. 453Remap a key symbol. See resource B<keysym>.
376 454
377=item B<-embed>: I<windowid> 455=item B<-embed> I<windowid>
378 456
379Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 457Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
380which enables applications to easily embed a terminal. 458which enables applications to easily embed a terminal.
381 459
382Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 460Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
383shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 461shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
384quite a bit, so don't expect it to keep some specific state. It's best to 462quite a bit, so don't expect it to keep some specific state. It's best to
385create an extra subwindow for @@RXVT_NAME@@ and leave it alone. 463create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
386 464
465The window will not be destroyed when @@RXVT_NAME@@ exits.
466
387It might be useful to know that @@RXVT_NAME@@ will not close file 467It might be useful to know that @@RXVT_NAME@@ will not close file
388descriptors passed to it (except for stdin/out/err, of course), so you 468descriptors passed to it (except for stdin/out/err, of course), so you
389can use file descriptors to communicate with the programs within the 469can use file descriptors to communicate with the programs within the
390terminal. This works regardless of wether the C<-embed> option was used or 470terminal. This works regardless of whether the C<-embed> option was used or
391not. 471not.
392 472
473Here is a short Gtk2-perl snippet that illustrates how this option can be
474used (a longer example is in F<doc/embed>):
475
476 my $rxvt = new Gtk2::Socket;
477 $rxvt->signal_connect_after (realize => sub {
478 my $xid = $_[0]->window->get_xid;
479 system "@@RXVT_NAME@@ -embed $xid &";
480 });
481
482=item B<-pty-fd> I<file descriptor>
483
484Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
485pair but instead use the given file descriptor as the tty master. This is
486useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
487without having to run a program within it.
488
489If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
490entries and will not tinker with pty/tty permissions - you have to do that
491yourself if you want that.
492
493As an extremely special case, specifying C<-1> will completely suppress
494pty/tty operations, which is probably only useful in conjunction with some
495perl extension that manages the terminal.
496
497Here is a example in perl that illustrates how this option can be used (a
498longer example is in F<doc/pty-fd>):
499
500 use IO::Pty;
501 use Fcntl;
502
503 my $pty = new IO::Pty;
504 fcntl $pty, F_SETFD, 0; # clear close-on-exec
505 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
506 close $pty;
507
508 # now communicate with rxvt
509 my $slave = $pty->slave;
510 while (<$slave>) { print $slave "got <$_>\n" }
511
512=item B<-pe> I<string>
513
514Comma-separated list of perl extension scripts to use (or not to use) in
515this terminal instance. See resource B<perl-ext> for details.
516
393=back 517=back
394 518
395=head1 RESOURCES (available also as long-options) 519=head1 RESOURCES
396 520
397Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 521Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
398options) compiled into your version. 522options) compiled into your version. All resources are also available as
523long-options.
399 524
400There are two different methods that @@RXVT_NAME@@ can use to get the 525You can set and change the resources using X11 tools like B<xrdb>. Many
401Xresource data: using the X libraries (Xrm*-functions) or internal 526distribution do also load settings from the B<~/.Xresources> file when X
402Xresources reader (B<~/.Xdefaults>). For the first method (ie. 527starts. @@RXVT_NAME@@ will consult the following files/resources in order,
403B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 528with later settings overwriting earlier ones:
404resources using X11 tools like B<xrdb>. Many distribution do also load
405settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
406will consult the following files/resources in order, with later settings
407overwriting earlier ones:
408 529
409 1. system-wide app-defaults file, either locale-dependent OR global
410 2. app-defaults file in $XAPPLRESDIR 530 1. app-defaults file in $XAPPLRESDIR
531 2. $HOME/.Xdefaults
411 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 532 3. RESOURCE_MANAGER property on root-window of screen 0
412 4. SCREEN_RESOURCES for the current screen 533 4. SCREEN_RESOURCES property on root-window of the current screen
413 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 534 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
535 6. resources specified via -xrm on the commandline
414 536
415If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
416lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
417set in XAPPLOADDIR/URxvt (compile-time defined: usually
418B</usr/lib/X11/app-defaults/URxvt>) and resources set in
419B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
420Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 537Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
421class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 538names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
422resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 539common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
423easily configured, while the class name B<URxvt> allows resources 540configured, while the class name B<URxvt> allows resources unique to
424unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 541B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
425shared between different B<@@RXVT_NAME@@> configurations. If no 542configurations. If no resources are specified, suitable defaults will
426resources are specified, suitable defaults will be used. Command-line 543be used. Command-line arguments can be used to override resource
427arguments can be used to override resource settings. The following 544settings. The following resources are supported (you might want to
428resources are allowed: 545check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
546extensions not documented here):
429 547
430=over 4 548=over 4
549
550=item B<depth:> I<bitdepth>
551
552Compile I<xft>: Attempt to find a visual with the given bit depth;
553option B<-depth>.
554
555=item B<buffered:> I<boolean>
556
557Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
558On some card/driver combination enabling it slightly decreases
559performance, on most it greatly helps it. The slowdown is small, so it
560should normally be enabled.
431 561
432=item B<geometry:> I<geom> 562=item B<geometry:> I<geom>
433 563
434Create the window with the specified X window geometry [default 80x24]; 564Create the window with the specified X window geometry [default 80x24];
435option B<-geometry>. 565option B<-geometry>.
449Use the specified colour for the colour value I<n>, where 0-7 579Use the specified colour for the colour value I<n>, where 0-7
450corresponds to low-intensity (normal) colours and 8-15 corresponds to 580corresponds to low-intensity (normal) colours and 8-15 corresponds to
451high-intensity (bold = bright foreground, blink = bright background) 581high-intensity (bold = bright foreground, blink = bright background)
452colours. The canonical names are as follows: 0=black, 1=red, 2=green, 582colours. The canonical names are as follows: 0=black, 1=red, 2=green,
4533=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 5833=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
454names used are listed in the B<COLORS AND GRAPHICS> section. 584names used are listed in the B<COLOURS AND GRAPHICS> section.
455 585
456Colours higher than 15 cannot be set using resources (yet), but can be 586Colours higher than 15 cannot be set using resources (yet), but can be
457changed using an escape command (see @@RXVT_NAME@@(7)). 587changed using an escape command (see @@RXVT_NAME@@(7)).
458 588
459Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 589Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
470=item B<colorUL:> I<colour> 600=item B<colorUL:> I<colour>
471 601
472Use the specified colour to display underlined characters when the 602Use the specified colour to display underlined characters when the
473foreground colour is the default. 603foreground colour is the default.
474 604
475=item B<colorRV:> I<colour>
476
477Use the specified colour as the background for reverse video
478characters.
479
480=item B<underlineColor:> I<colour> 605=item B<underlineColor:> I<colour>
481 606
482If set, use the specified colour as the colour for the underline 607If set, use the specified colour as the colour for the underline
483itself. If unset, use the foreground colour. 608itself. If unset, use the foreground colour.
609
610=item B<highlightColor:> I<colour>
611
612If set, use the specified colour as the background for highlighted
613characters. If unset, use reverse video.
614
615=item B<highlightTextColor:> I<colour>
616
617If set and highlightColor is set, use the specified colour as the
618foreground for highlighted characters.
484 619
485=item B<cursorColor:> I<colour> 620=item B<cursorColor:> I<colour>
486 621
487Use the specified colour for the cursor. The default is to use the 622Use the specified colour for the cursor. The default is to use the
488foreground colour; option B<-cr>. 623foreground colour; option B<-cr>.
495 630
496=item B<reverseVideo:> I<boolean> 631=item B<reverseVideo:> I<boolean>
497 632
498B<True>: simulate reverse video by foreground and background colours; 633B<True>: simulate reverse video by foreground and background colours;
499option B<-rv>. B<False>: regular screen colours [default]; option 634option B<-rv>. B<False>: regular screen colours [default]; option
500B<+rv>. See note in B<COLORS AND GRAPHICS> section. 635B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
501 636
502=item B<jumpScroll:> I<boolean> 637=item B<jumpScroll:> I<boolean>
503 638
504B<True>: specify that jump scrolling should be used. When scrolling 639B<True>: specify that jump scrolling should be used. When receiving lots
505quickly, fewer screen updates are performed [default]; option B<-j>. 640of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
641has been read, resulting in fewer updates while still displaying every
642received line; option B<-j>.
643
506B<False>: specify that smooth scrolling should be used; option B<+j>. 644B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
645force a screen refresh on each new line it received; option B<+j>.
507 646
508=item B<inheritPixmap:> I<boolean> 647=item B<skipScroll:> I<boolean>
509 648
510B<True>: make the background inherit the parent windows' pixmap, giving 649B<True>: (the default) specify that skip scrolling should be used. When
511artificial transparency. B<False>: do not inherit the parent windows' 650receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
512pixmap. 651(around 60 times per second), resulting in far fewer updates. This can
652result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
653option B<-ss>.
654
655B<False>: specify that everything is to be displayed, even
656if the refresh is too fast for the human eye to read anything (or the
657monitor to display anything); option B<+ss>.
513 658
514=item B<fading:> I<number> 659=item B<fading:> I<number>
515 660
516Fade the text by the given percentage when focus is lost. 661Fade the text by the given percentage when focus is lost; option B<-fade>.
517 662
518=item B<tintColor:> I<colour> 663=item B<fadeColor:> I<colour>
519 664
520Tint the transparent background pixmap with the given colour. 665Fade to this colour, when fading is used (see B<fading:>). The default
666colour is black; option B<-fadecolor>.
521 667
522=item B<shading:> I<number> 668=item B<iconFile:> I<file>
523 669
524Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 670Set the application icon pixmap; option B<-icon>.
525image in addition to tinting it.
526 671
527=item B<scrollColor:> I<colour> 672=item B<scrollColor:> I<colour>
528 673
529Use the specified colour for the scrollbar [default #B2B2B2]. 674Use the specified colour for the scrollbar [default #B2B2B2].
530 675
531=item B<troughColor:> I<colour> 676=item B<troughColor:> I<colour>
532 677
533Use the specified colour for the scrollbar's trough area [default 678Use the specified colour for the scrollbar's trough area [default
534#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 679#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
535 680
536=item B<borderColor:> I<colour> 681=item B<borderColor:> I<colour>
537 682
538The colour of the border around the text area and between the scrollbar 683The colour of the border around the text area and between the scrollbar
539and the text. 684and the text.
540 685
541=item B<backgroundPixmap:> I<file[;geom]>
542
543Use the specified XPM file (note the `.xpm' extension is optional) for
544the background and also optionally specify its scaling with a geometry
545string B<WxH+X+Y>, in which B<"W" / "H"> specify the
546horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image
547centre (percent). A scale of 0 displays the image with tiling. A scale
548of 1 displays the image without any scaling. A scale of 2 to 9
549specifies an integer number of images in that direction. No image will
550be magnified beyond 10 times its original size. The maximum permitted
551scale is 1000. [default 0x0+50+50]
552
553=item B<menu:> I<file[;tag]>
554
555Read in the specified menu file (note the `.menu' extension is
556optional) and also optionally specify a starting tag to find. See the
557reference documentation for details on the syntax for the menuBar.
558
559=item B<path:> I<path>
560
561Specify the colon-delimited search path for finding files (XPM and
562menus), in addition to the paths specified by the B<RXVTPATH> and
563B<PATH> environment variables.
564
565=item B<font:> I<fontlist> 686=item B<font:> I<fontlist>
566 687
567Select the fonts to be used. This is a comma separated list of font 688Select the fonts to be used. This is a comma separated list of font names
568names that are used in turn when trying to display Unicode characters. 689that are checked in order when trying to find glyphs for characters. The
569The first font defines the cell size for characters; other fonts might 690first font defines the cell size for characters; other fonts might be
570be smaller, but not larger. A reasonable default font list is always 691smaller, but not (in general) larger. A (hopefully) reasonable default
571appended to it. option B<-fn>. 692font list is always appended to it; option B<-fn>.
572 693
573Each font can either be a standard X11 core font (XLFD) name, with 694Each font can either be a standard X11 core font (XLFD) name, with
574optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 695optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
575 696
576In addition, each font can be prefixed with additional hints and 697In addition, each font can be prefixed with additional hints and
578hint currently is C<codeset=codeset-name>, and this is only used for Xft 699hint currently is C<codeset=codeset-name>, and this is only used for Xft
579fonts. 700fonts.
580 701
581For example, this font resource 702For example, this font resource
582 703
583 URxvt*font: 9x15bold,\ 704 URxvt.font: 9x15bold,\
584 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 705 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
585 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 706 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
586 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 707 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
587 xft:Code2000:antialias=false 708 xft:Code2000:antialias=false
588 709
591it is named first) and thus defines the character cell grid to be 9 pixels 712it is named first) and thus defines the character cell grid to be 9 pixels
592wide and 15 pixels high. 713wide and 15 pixels high.
593 714
594The second font is just used to add additional unicode characters not in 715The second font is just used to add additional unicode characters not in
595the base font, likewise the third, which is unfortunately non-bold, but 716the base font, likewise the third, which is unfortunately non-bold, but
596the bold version of the font does contain less characters, so this is a 717the bold version of the font does contain fewer characters, so this is a
597useful supplement. 718useful supplement.
598 719
599The third font is an Xft font with aliasing turned off, and the characters 720The third font is an Xft font with aliasing turned off, and the characters
600are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 721are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
601contains other characters, but we are not interested in them. 722contains other characters, but we are not interested in them.
622not possible, replacement fonts of the desired shape will be tried. 743not possible, replacement fonts of the desired shape will be tried.
623 744
624If set, but empty, then this specific style is disabled and the normal 745If set, but empty, then this specific style is disabled and the normal
625text font will being used for the given style. 746text font will being used for the given style.
626 747
627=item B<selectstyle:> I<mode> 748=item B<intensityStyles:> I<boolean>
628 749
629Set mouse selection style to B<old> which is 2.20, B<oldword> which is 750When font styles are not enabled, or this option is enabled (B<True>,
630xterm style with 2.20 old word selection, or anything else which gives 751option B<-is>, the default), bold/blink font styles imply high
631xterm style selection. 752intensity foreground/background colours. Disabling this option (B<False>,
632 753option B<+is>) disables this behaviour, the high intensity colours are not
633=item B<scrollstyle:> I<mode> 754reachable.
634
635Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
636the author's favourite..
637 755
638=item B<title:> I<string> 756=item B<title:> I<string>
639 757
640Set window title string, the default title is the command-line 758Set window title string, the default title is the command-line
641specified after the B<-e> option, if any, otherwise the application 759specified after the B<-e> option, if any, otherwise the application
650=item B<mapAlert:> I<boolean> 768=item B<mapAlert:> I<boolean>
651 769
652B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 770B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
653de-iconify (map) on receipt of a bell character [default]. 771de-iconify (map) on receipt of a bell character [default].
654 772
773=item B<urgentOnBell:> I<boolean>
774
775B<True>: set the urgency hint for the wm on receipt of a bell character.
776B<False>: do not set the urgency hint [default].
777
778@@RXVT_NAME@@ resets the urgency hint on every focus change.
779
655=item B<visualBell:> I<boolean> 780=item B<visualBell:> I<boolean>
656 781
657B<True>: use visual bell on receipt of a bell character; option B<-vb>. 782B<True>: use visual bell on receipt of a bell character; option B<-vb>.
658B<False>: no visual bell [default]; option B<+vb>. 783B<False>: no visual bell [default]; option B<+vb>.
659 784
673 798
674Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 799Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
675B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 800B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
676B<Shift-Print> to include the scrollback as well. 801B<Shift-Print> to include the scrollback as well.
677 802
803The string will be interpreted as if typed into the shell as-is.
804
805Example:
806
807 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
808
809This creates a new file in your home directory with the screen contents
810every time you hit C<Print>.
811
812=item B<scrollstyle:> I<mode>
813
814Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
815the author's favourite.
816
817=item B<thickness:> I<number>
818
819Set the scrollbar width in pixels.
820
678=item B<scrollBar:> I<boolean> 821=item B<scrollBar:> I<boolean>
679 822
680B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 823B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
681disable the scrollbar; option B<+sb>. 824disable the scrollbar; option B<+sb>.
682 825
701B<False>: do not scroll to bottom when tty receives output; option 844B<False>: do not scroll to bottom when tty receives output; option
702B<+si>. 845B<+si>.
703 846
704=item B<scrollWithBuffer:> I<boolean> 847=item B<scrollWithBuffer:> I<boolean>
705 848
706B<True>: scroll with scrollback buffer when tty receives new lines (and 849B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
707B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 850try to show the same lines) and B<scrollTtyOutput> is False; option
708with scrollback buffer when tty recieves new lines; option B<-sw>. 851B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
852new lines; option B<+sw>.
709 853
710=item B<scrollTtyKeypress:> I<boolean> 854=item B<scrollTtyKeypress:> I<boolean>
711 855
712B<True>: scroll to bottom when a non-special key is pressed. Special keys 856B<True>: scroll to bottom when a non-special key is pressed. Special keys
713are those which are intercepted by rxvt-unicode for special handling and 857are those which are intercepted by rxvt-unicode for special handling and
732=item B<borderLess:> I<boolean> 876=item B<borderLess:> I<boolean>
733 877
734Set MWM hints to request a borderless window, i.e. if honoured by the 878Set MWM hints to request a borderless window, i.e. if honoured by the
735WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 879WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
736 880
881=item B<skipBuiltinGlyphs:> I<boolean>
882
883Compile I<frills>: Disable the usage of the built-in block graphics/line
884drawing characters and just rely on what the specified fonts provide. Use
885this if you have a good font and want to use its block graphic glyphs;
886option B<-sbg>.
887
737=item B<termName:> I<termname> 888=item B<termName:> I<termname>
738 889
739Specifies the terminal type name to be set in the B<TERM> environment 890Specifies the terminal type name to be set in the B<TERM> environment
740variable; option B<-tn>. 891variable; option B<-tn>.
741 892
742=item B<linespace:> I<number> 893=item B<lineSpace:> I<number>
743 894
744Specifies number of lines (pixel height) to insert between each row of 895Specifies number of lines (pixel height) to insert between each row of
745the display [default 0]; option B<-lsp>. 896the display [default 0]; option B<-lsp>.
746 897
747=item B<meta8:> I<boolean> 898=item B<meta8:> I<boolean>
761 912
762=item B<cursorBlink:> I<boolean> 913=item B<cursorBlink:> I<boolean>
763 914
764B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 915B<True>: blink the cursor. B<False>: do not blink the cursor [default];
765option B<-bc>. 916option B<-bc>.
917
918=item B<cursorUnderline:> I<boolean>
919
920B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
921option B<-uc>.
766 922
767=item B<pointerBlank:> I<boolean> 923=item B<pointerBlank:> I<boolean>
768 924
769B<True>: blank the pointer when a key is pressed or after a set number 925B<True>: blank the pointer when a key is pressed or after a set number
770of seconds of inactivity. B<False>: the pointer is always visible 926of seconds of inactivity. B<False>: the pointer is always visible
778 934
779Mouse pointer background colour. 935Mouse pointer background colour.
780 936
781=item B<pointerBlankDelay:> I<number> 937=item B<pointerBlankDelay:> I<number>
782 938
783Specifies number of seconds before blanking the pointer [default 2]. 939Specifies number of seconds before blanking the pointer [default 2]. Use a
940large number (e.g. C<987654321>) to effectively disable the timeout.
784 941
785=item B<backspacekey:> I<string> 942=item B<backspacekey:> I<string>
786 943
787The string to send when the backspace key is pressed. If set to B<DEC> 944The string to send when the backspace key is pressed. If set to B<DEC>
788or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 945or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
789(code 8) - which can be reversed with the appropriate DEC private mode 946(code 8) - which can be reversed with the appropriate DEC private mode
790escape sequence. 947escape sequence.
791 948
792=item B<deletekey:> I<string> 949=item B<deletekey:> I<string>
793 950
795pressed. If unset it will send the sequence traditionally associated 952pressed. If unset it will send the sequence traditionally associated
796with the B<Execute> key. 953with the B<Execute> key.
797 954
798=item B<cutchars:> I<string> 955=item B<cutchars:> I<string>
799 956
800The characters used as delimiters for double-click word selection. The 957The characters used as delimiters for double-click word selection
801built-in default: 958(whitespace delimiting is added automatically if resource is given).
802 959
960When the perl selection extension is in use (the default if compiled
961in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
962characters will be created (if the resource exists, otherwise, no regex
963will be created). In this mode, characters outside ISO-8859-1 can be used.
964
965When the selection extension is not used, only ISO-8859-1 characters can
966be used. If not specified, the built-in default is used:
967
803B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 968B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
804 969
805=item B<preeditType:> I<style> 970=item B<preeditType:> I<style>
806 971
807B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 972B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
808 973
813=item B<imLocale:> I<name> 978=item B<imLocale:> I<name>
814 979
815The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 980The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
816C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the 981C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
817input extension to be able to input japanese characters while staying in 982input extension to be able to input japanese characters while staying in
818another locale. option B<-imlocale>. 983another locale; option B<-imlocale>.
819 984
820=item B<imFont:> I<fontset> 985=item B<imFont:> I<fontset>
821 986
822Specify the font-set used for XIM styles C<OverTheSpot> or 987Specify the font-set used for XIM styles C<OverTheSpot> or
823C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 988C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
828 993
829=item B<tripleclickwords:> I<boolean> 994=item B<tripleclickwords:> I<boolean>
830 995
831Change the meaning of triple-click selection with the left mouse 996Change the meaning of triple-click selection with the left mouse
832button. Instead of selecting a full line it will extend the selection to 997button. Instead of selecting a full line it will extend the selection to
833the end of the logical line only. option B<-tcw>. 998the end of the logical line only; option B<-tcw>.
834 999
835=item B<insecure:> I<boolean> 1000=item B<insecure:> I<boolean>
836 1001
837Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1002Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
838echo arbitrary strings like the icon name or the locale. This could be 1003echo arbitrary strings like the icon name or the locale. This could be
839abused if somebody gets 8-bit-clean access to your display, whether 1004abused if somebody gets 8-bit-clean access to your display, whether
840throuh a mail client displaying mail bodies unfiltered or though 1005through a mail client displaying mail bodies unfiltered or through
841write(1). Therefore, these sequences are disabled by default. (Note 1006write(1) or any other means. Therefore, these sequences are disabled by
842that other terminals, including xterm, have these sequences 1007default. (Note that many other terminals, including xterm, have these
843enabled by default). You can enable them by setting this boolean 1008sequences enabled by default, which doesn't make it safer, though).
844resource or specifying B<-insecure> as an option. At the moment, this 1009
845enabled display-answer, locale, findfont, icon label and window title 1010You can enable them by setting this boolean resource or specifying
846requests as well as dynamic menubar dispatch. 1011B<-insecure> as an option. At the moment, this enables display-answer,
1012locale, findfont, icon label and window title requests.
847 1013
848=item B<modifier:> I<modifier> 1014=item B<modifier:> I<modifier>
849 1015
850Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 1016Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
851B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 1017B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
855 1021
856Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1022Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
857character is passed through. It may contain escape values as described 1023character is passed through. It may contain escape values as described
858in the entry on B<keysym> following. 1024in the entry on B<keysym> following.
859 1025
860=item B<secondaryScreen:> I<bool> 1026=item B<secondaryScreen:> I<boolean>
861 1027
862Turn on/off secondary screen (default enabled). 1028Turn on/off secondary screen (default enabled).
863 1029
864=item B<secondaryScroll:> I<bool> 1030=item B<secondaryScroll:> I<boolean>
865 1031
866Turn on/off secondary screen scroll (default enabled). If the this 1032Turn on/off secondary screen scroll (default enabled). If this
867option is enabled, scrolls on the secondary screen will change the 1033option is enabled, scrolls on the secondary screen will change the
868scrollback buffer and switching to/from the secondary screen will 1034scrollback buffer and, when secondaryScreen is off, switching
869instead scroll the screen up. 1035to/from the secondary screen will instead scroll the screen up.
870 1036
1037=item B<hold>: I<boolean>
1038
1039Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1040will not immediately destroy its window when the program executed within
1041it exits. Instead, it will wait till it is being killed or closed by the
1042user.
1043
1044=item B<chdir>: I<path>
1045
1046Sets the working directory for the shell (or the command specified via
1047B<-e>). The I<path> must be an absolute path and it must exist for
1048@@RXVT_NAME@@ to start. If it isn't specified then the current working
1049directory will be used; option B<-cd>.
1050
871=item B<keysym.>I<sym>: I<string> 1051=item B<keysym.>I<sym>: I<action>
872 1052
873Compile I<frills>: Associate I<string> with keysym I<sym>. The 1053Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
874intervening resource name B<keysym.> cannot be omitted. 1054resource name B<keysym.> cannot be omitted.
875 1055
876The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1056Using this resource, you can map key combinations such as
877any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1057C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
878B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, 1058string than would normally result from that combination, making the
879and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 1059terminal scroll up or down the way you want it, or any other thing an
880B<2>, B<3>, B<4>, B<5>. 1060extension might provide.
1061
1062The key combination that triggers the action, I<sym>, has the following format:
1063
1064 (modifiers-)key
1065
1066Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
1067B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
1068B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
1069B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
881 1070
882The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1071The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
883whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1072whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
884keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1073keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
885current application keymap mode state. 1074current application keymap mode state.
886 1075
887The spellings of I<key> can be obtained by using B<xev>(1) command or 1076Due the the large number of modifier combinations, a key mapping will
888searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1077match if I<at least> the specified identifiers are being set, and no other
1078key mappings with those and more bits are being defined. That means that
1079defining a mapping for C<a> will automatically provide definitions for
1080C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1081themselves. See the C<builtin:> action, below, for a way to work around
1082this when this is a problem.
1083
1084The spelling of I<key> depends on your implementation of X. An easy way to
1085find a key name is to use the B<xev>(1) command. You can find a list by
1086looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
889omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1087the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
890keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1088value (B<0x0000 - 0xFFFF>).
891performed in an exact manner; however, the closest match is assured.
892 1089
893I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1090As with any resource value, the I<action> string may contain backslash
894C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1091escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
895C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1092number), see RESOURCES in C<man 7 X> for further details.
896C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
897can start or end with whitespace.
898 1093
899Please note that you need to double the C<\> when using 1094An action starts with an action prefix that selects a certain type
900C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can 1095of action, followed by a colon. An action string without colons is
901use C<\033> instead of C<\e> (and so on), which will work with both Xt and 1096interpreted as a literal string to pass to the tty (as if it was
902@@RXVT_NAME@@'s own processing). 1097prefixed with C<string:>).
903 1098
904You can define a range of keysyms in one shot by providing a I<string> 1099The following action prefixes are known - extensions can provide
905with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1100additional prefixes:
906should be a character not used by the strings.
907 1101
908Its usage can be demonstrated by an example: 1102=over 4
909 1103
910 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1104=item string:STRING
911 1105
912The above line is equivalent to the following three lines: 1106If the I<action> starts with C<string:> (or otherwise contains no colons),
1107then the remaining C<STRING> will be passed to the program running in the
1108terminal. For example, you could replace whatever Shift-Tab outputs by the
1109string C<echo rm -rf /> followed by a newline:
913 1110
914 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1111 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
915 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
916 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
917 1112
1113This could in theory be used to completely redefine your keymap.
1114
1115=item command:STRING
1116
918If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1117If I<action> takes the form of C<command:STRING>, the specified B<STRING>
919is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1118is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1119the opposite of C<string:> - instead of sending it to the program running
1120in the terminal, it will be treated as if it were program output). This is
1121most useful to feed command sequences into @@RXVT_NAME@@.
1122
920example the following means "change the current locale to C<zh_CN.GBK> 1123For example the following means "change the current locale to C<zh_CN.GBK>
921when Control-Meta-c is being pressed": 1124when Control-Meta-c is being pressed":
922 1125
923 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1126 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
924 1127
925The following example will map Control-Meta-1 and Control-Meta-2 to 1128The following example will map Control-Meta-1 and Control-Meta-2 to
932Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1135Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
933info): 1136info):
934 1137
935 URxvt.keysym.M-C-3: command:\033[8;25;80t 1138 URxvt.keysym.M-C-3: command:\033[8;25;80t
936 URxvt.keysym.M-C-4: command:\033[8;48;110t 1139 URxvt.keysym.M-C-4: command:\033[8;48;110t
1140
1141=item builtin:
1142
1143The builtin action is the action that @@RXVT_NAME@@ would execute if no
1144key binding existed for the key combination. The obvious use is to undo
1145the effect of existing bindings. The not so obvious use is to reinstate
1146bindings when another binding overrides too many modifiers.
1147
1148For example if you overwrite the C<Insert> key you will disable
1149@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1150"holes" into the user-defined keymap using the C<builtin:> replacement:
1151
1152 URxvt.keysym.Insert: <my insert key sequence>
1153 URxvt.keysym.S-Insert: builtin:
1154
1155The first line defines a mapping for C<Insert> and I<any> combination
1156of modifiers. The second line re-establishes the default mapping for
1157C<Shift-Insert>.
1158
1159=item builtin-string:
1160
1161This action is mainly useful to restore string mappings for keys that
1162have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1163difficult to explain - basically, this action will send the string to the
1164application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1165action for it.
1166
1167An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1168selection when you press C<Shift-Insert>. With the following bindings, it
1169would instead emit the (undocumented, but what applications running in the
1170terminal might expect) sequence C<ESC [ 2 $> instead:
1171
1172 URxvt.keysym.S-Insert: builtin-string:
1173 URxvt.keysym.C-S-Insert: builtin:
1174
1175The first line disables the paste functionality for that key
1176combination, and the second reinstates the default behaviour for
1177C<Control-Shift-Insert>, which would otherwise be overridden.
1178
1179Similarly, to let applications gain access to the C<C-M-c> (copy to
1180clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1181this:
1182
1183 URxvt.keysym.C-S-c: builtin-string:
1184 URxvt.keysym.C-S-v: builtin-string:
1185
1186=item EXTENSION:STRING
1187
1188An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)
1189extension of the same name. The extension will be loaded automatically if
1190necessary.
1191
1192Not all extensions define key actions, but popular extensions that do
1193include the I<selection> and I<matcher> extensions (documented in their
1194own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1195respectively).
1196
1197From the silly examples department, this will rot13-"encrypt"
1198@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1199keyboards:
1200
1201 URxvt.keysym.M-C-c: selection:rot13
1202
1203=item perl:STRING *DEPRECATED*
1204
1205This is a deprecated way of passing key mappings to perl extensions. It is
1206still supported, but should not be used anymore.
1207
1208=back
1209
1210=item B<perl-ext-common>: I<string>
1211
1212=item B<perl-ext>: I<string>
1213
1214Comma-separated list(s) of perl extension scripts (default: C<default>) to
1215use in this terminal instance; option B<-pe>.
1216
1217Extension names can be prefixed with a C<-> sign to prohibit using
1218them. This can be useful to selectively disable some extensions loaded
1219by default, or specified via the C<perl-ext-common> resource. For
1220example, C<default,-selection> will use all the default extensions except
1221C<selection>.
1222
1223The default set includes the C<selection>, C<option-popup>,
1224C<selection-popup> and C<readline> extensions, any extensions that define
1225keybindings via C<BINDING> meta comments, extensions loaded because
1226their resources/commandline switches were used, and extensions which are
1227mentioned in B<keysym> resources.
1228
1229Each extension is looked up in the library directories, loaded if
1230necessary, and bound to the current terminal instance. When the library
1231search path contains multiple extension files of the same name, then the
1232first one found will be used.
1233
1234If both of these resources are the empty string, then the perl interpreter
1235will not be initialized. The rationale for having two options is that
1236B<perl-ext-common> will be used for extensions that should be available to
1237all instances, while B<perl-ext> is used for specific instances.
1238
1239=item B<perl-eval>: I<string>
1240
1241Perl code to be evaluated when all extensions have been registered. See
1242the @@RXVT_NAME@@perl(3) manpage.
1243
1244=item B<perl-lib>: I<path>
1245
1246Colon-separated list of additional directories that hold extension
1247scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1248in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1249lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1250
1251See the @@RXVT_NAME@@perl(3) manpage.
1252
1253=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1254
1255Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1256details.
1257
1258=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1259
1260Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1261for details.
1262
1263=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1264
1265This resource is deprecated and will be removed. Use a B<keysym> resource
1266instead, e.g.:
1267
1268 URxvt.keysym.M-s: searchable-scrollback:start
1269
1270=item B<url-launcher>: I<string>
1271
1272Specifies the program to be started with a URL argument. Used by the
1273C<selection-popup> and C<matcher> perl extensions.
1274
1275=item B<transient-for>: I<windowid>
1276
1277Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1278
1279=item B<override-redirect>: I<boolean>
1280
1281Compile I<frills>: Sets override-redirect for the terminal window, making
1282it almost invisible to window managers; option B<-override-redirect>.
1283
1284=item B<iso14755:> I<boolean>
1285
1286Turn on/off ISO 14755 (default enabled).
1287
1288=item B<iso14755_52:> I<boolean>
1289
1290Turn on/off ISO 14755 5.2 mode (default enabled).
1291
1292=back
1293
1294=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1295
1296=over 4
1297
1298=item B<-pixmap> I<file[;oplist]>
1299
1300=item B<backgroundPixmap:> I<file[;oplist]>
1301
1302Compile I<pixbuf>: Use the specified image file as the window's
1303background and also optionally specify a colon separated list of
1304operations to modify it. Note that you may need to quote the C<;>
1305character when using the command line option, as C<;> is usually a
1306metacharacter in shells. Supported operations are:
1307
1308=over 4
1309
1310=item B<WxH+X+Y>
1311
1312sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1313scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1314scale of 0 disables scaling.
1315
1316=item B<op=tile>
1317
1318enables tiling
1319
1320=item B<op=keep-aspect>
1321
1322maintain the image aspect ratio when scaling
1323
1324=item B<op=root-align>
1325
1326use the position of the terminal window relative to the root window as
1327the image offset, simulating a root window background
1328
1329=back
1330
1331The default scale and position setting is C<100x100+50+50>.
1332Alternatively, a predefined set of templates can be used to achieve
1333the most common setups:
1334
1335=over 4
1336
1337=item B<style=tiled>
1338
1339the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1340
1341=item B<style=aspect-stretched>
1342
1343the image is scaled to fill the whole window maintaining the aspect
1344ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1345
1346=item B<style=stretched>
1347
1348the image is scaled to fill the whole window. Equivalent to 100x100
1349
1350=item B<style=centered>
1351
1352the image is centered with no scaling. Equivalent to 0x0+50+50
1353
1354=item B<style=root-tiled>
1355
1356the image is tiled with no scaling and using 'root' positioning.
1357Equivalent to 0x0:op=tile:op=root-align
1358
1359=back
1360
1361If multiple templates are specified the last one wins. Note that a
1362template overrides all the scale, position and operations settings.
1363
1364If used in conjunction with pseudo-transparency, the specified pixmap
1365will be blended over the transparent background using alpha-blending.
1366
1367=item B<-tr>|B<+tr>
1368
1369=item B<transparent:> I<boolean>
1370
1371Turn on/off pseudo-transparency by using the root pixmap as background.
1372
1373B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1374will be removed in future versions.
1375
1376=item B<-tint> I<colour>
1377
1378=item B<tintColor:> I<colour>
1379
1380Tint the transparent background with the given colour. Note that a
1381black tint yields a completely black image while a white tint yields
1382the image unchanged.
1383
1384=item B<-sh> I<number>
1385
1386=item B<shading:> I<number>
1387
1388Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1389A value of 100 means no shading.
1390
1391=item B<-blr> I<HxV>
1392
1393=item B<blurRadius:> I<HxV>
1394
1395Apply gaussian blur with the specified radius to the transparent
1396background. If a single number is specified, the vertical and
1397horizontal radii are considered to be the same. Setting one of the
1398radii to 1 and the other to a large number creates interesting effects
1399on some backgrounds. The maximum radius value is 128. An horizontal or
1400vertical radius of 0 disables blurring.
1401
1402=item B<path:> I<path>
1403
1404Specify the colon-delimited search path for finding background image files.
937 1405
938=back 1406=back
939 1407
940=head1 THE SCROLLBAR 1408=head1 THE SCROLLBAR
941 1409
960application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1428application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
961(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1429(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
962up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1430up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
963respectively. 1431respectively.
964 1432
965=head1 TEXT SELECTION AND INSERTION 1433=head1 THE SELECTION: SELECTING AND PASTING TEXT
966 1434
967The behaviour of text selection and insertion mechanism is similar to 1435The behaviour of text selection and insertion/pasting mechanism is similar
968I<xterm>(1). 1436to I<xterm>(1).
969 1437
970=over 4 1438=over 4
971 1439
972=item B<Selection>: 1440=item B<Selecting>:
973 1441
974Left click at the beginning of the region, drag to the end of the region 1442Left click at the beginning of the region, drag to the end of the region
975and release; Right click to extend the marked region; Left double-click 1443and release; Right click to extend the marked region; Left double-click
976to select a word; Left triple-click to select the entire logical line 1444to select a word; Left triple-click to select the entire logical line
977(which can span multiple screen lines), unless modified by resource 1445(which can span multiple screen lines), unless modified by resource
978B<tripleclickwords>. 1446B<tripleclickwords>.
979 1447
980Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1448Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
981(Compile: I<frills>) will create a rectangular selection instead of a normal 1449(Compile: I<frills>) will create a rectangular selection instead of a
982one. 1450normal one. In this mode, every selected row becomes its own line in the
1451selection, and trailing whitespace is visually underlined and removed from
1452the selection.
983 1453
984=item B<Insertion>: 1454=item B<Pasting>:
985 1455
986Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1456Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
987an B<@@RXVT_NAME@@> window causes the current text selection to be 1457window causes the value of the PRIMARY selection (or CLIPBOARD with the
988inserted as if it had been typed on the keyboard. 1458B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1459
1460Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1461inserted too.
1462
1463rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1464<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1465binding causes the value of the internal selection to be copied to the
1466CLIPBOARD selection, while the second binding causes the value of the
1467CLIPBOARD selection to be inserted.
989 1468
990=back 1469=back
991 1470
992=head1 CHANGING FONTS 1471=head1 CHANGING FONTS
993 1472
994Changing fonts (or font sizes, respectively) via the keypad is not yet 1473Changing fonts (or font sizes, respectively) via the keypad is not yet
995supported in rxvt-unicode. Bug me if you need this. 1474supported in rxvt-unicode. Bug me if you need this.
996 1475
997You can, however, switch fonts at runtime using escape sequences (and 1476You can, however, switch fonts at runtime using escape sequences, e.g.:
998therefore using the menubar), e.g.:
999 1477
1000 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1478 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1479
1480You can use keyboard shortcuts, too:
1481
1482 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1483 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1001 1484
1002rxvt-unicode will automatically re-apply these fonts to the output so far. 1485rxvt-unicode will automatically re-apply these fonts to the output so far.
1003 1486
1004=head1 ISO 14755 SUPPORT 1487=head1 ISO 14755 SUPPORT
1005 1488
1006ISO 14755 is a standard for entering and viewing unicode characters 1489ISO 14755 is a standard for entering and viewing unicode characters
1007and character codes using the keyboard. It consists of 4 parts. The 1490and character codes using the keyboard. It consists of 4 parts. The
1008first part is available rxvt-unicode has been compiled with 1491first part is available if rxvt-unicode has been compiled with
1009C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1492C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1010with C<--enable-iso14755>. 1493with C<--enable-iso14755>.
1011 1494
1012=over 4 1495=over 4
1013 1496
1033This mode lets you input characters representing the keycap symbols of 1516This mode lets you input characters representing the keycap symbols of
1034your keyboard, if representable in the current locale encoding. 1517your keyboard, if representable in the current locale encoding.
1035 1518
1036Start by pressing C<Control> and C<Shift> together, then releasing 1519Start by pressing C<Control> and C<Shift> together, then releasing
1037them. The next special key (cursor keys, home etc.) you enter will not 1520them. The next special key (cursor keys, home etc.) you enter will not
1038invoke it's usual function but instead will insert the corresponding 1521invoke its usual function but instead will insert the corresponding
1039keycap symbol. The symbol will only be entered when the key has been 1522keycap symbol. The symbol will only be entered when the key has been
1040released, otherwise pressing e.g. C<Shift> would enter the symbol for 1523released, otherwise pressing e.g. C<Shift> would enter the symbol for
1041C<ISO Level 2 Switch>, although your intention might have been to enter a 1524C<ISO Level 2 Switch>, although your intention might have been to enter a
1042reverse tab (Shift-Tab). 1525reverse tab (Shift-Tab).
1043 1526
1071B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1554B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1072it can be seen via the I<who(1)> command, and can accept messages. To 1555it can be seen via the I<who(1)> command, and can accept messages. To
1073allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1556allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1074on some systems or setgid to root or to some other group on others. 1557on some systems or setgid to root or to some other group on others.
1075 1558
1076=head1 COLORS AND GRAPHICS 1559=head1 COLOURS AND GRAPHICS
1077 1560
1078In addition to the default foreground and background colours, 1561In addition to the default foreground and background colours,
1079B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1562B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1080high-intensity bold/blink versions of the same). Here is a list of the 1563high-intensity (potentially bold/blink) versions of the same, and 72 (or
1081colours with their B<rgb.txt> names. 1564240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1565cube plus a 8 (24) colour greyscale ramp.
1566
1567Here is a list of the ANSI colours with their names.
1082 1568
1083=begin table 1569=begin table
1084 1570
1085 B<color0> (black) = Black 1571 B<color0> (black) = Black
1086 B<color1> (red) = Red3 1572 B<color1> (red) = Red3
1106It is also possible to specify the colour values of B<foreground>, 1592It is also possible to specify the colour values of B<foreground>,
1107B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1593B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1108a number 0-15, as a convenient shorthand to reference the colour name of 1594a number 0-15, as a convenient shorthand to reference the colour name of
1109color0-color15. 1595color0-color15.
1110 1596
1597The following text gives values for the standard 88 colour mode (and
1598values for the 256 colour mode in parentheses).
1599
1600The RGB cube uses indices 16..79 (16..231) using the following formulas:
1601
1602 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1603 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1604
1605The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1606steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1607the RGB cube.
1608
1609Together, all those colours implement the 88 (256) colour xterm
1610colours. Only the first 16 can be changed using resources currently, the
1611rest can only be changed via command sequences ("escape codes").
1612
1613Applications are advised to use terminfo or command sequences to discover
1614number and RGB values of all colours (yes, you can query this...).
1615
1111Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1616Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1112always swapping the foreground/background colours. This is in contrast to 1617always swapping the foreground/background colours. This is in contrast to
1113I<xterm>(1) where the colours are only swapped if they have not otherwise 1618I<xterm>(1) where the colours are only swapped if they have not otherwise
1114been specified. For example, 1619been specified. For example,
1115 1620
1621 @@RXVT_NAME@@ -fg Black -bg White -rv
1622
1623would yield White on Black, while on I<xterm>(1) it would yield Black on
1624White.
1625
1626=head2 ALPHA CHANNEL SUPPORT
1627
1628If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1629their act together, rxvt-unicode will do its own alpha channel management:
1630
1631You can prefix any colour with an opaqueness percentage enclosed in
1632brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1633(0-100) that specifies the opacity of the colour, where C<0> is completely
1634transparent and C<100> is completely opaque. For example, C<[50]red> is a
1635half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1636is the recommended format to specify transparency values, and works with
1637all ways to specify a colour.
1638
1639For complete control, rxvt-unicode also supports
1640C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1641specifications, where the additional C<aaaa> component specifies opacity
1642(alpha) values. The minimum value of C<0000> is completely transparent,
1643while C<ffff> is completely opaque). The two example colours from
1644earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1645C<rgba:0000/ff00/0000/f332>.
1646
1647You probably need to specify B<"-depth 32">, too, to force a visual with
1648alpha channels, and have the luck that your X-server uses ARGB pixel
1649layout, as X is far from just supporting ARGB visuals out of the box, and
1650rxvt-unicode just fudges around.
1651
1652For example, the following selects an almost completely transparent black
1653background, and an almost opaque pink foreground:
1654
1655 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1656
1657When not using a background image, then the interpretation of the
1658alpha channel is up to your compositing manager (most interpret it as
1659transparency of course).
1660
1661When using a background pixmap or pseudo-transparency, then the background
1662colour will always behave as if it were completely transparent (so the
1663background image shows instead), regardless of how it was specified, while
1664other colours will either be transparent as specified (the background
1665image will show through) on servers supporting the RENDER extension, or
1666fully opaque on servers not supporting the RENDER EXTENSION.
1667
1668Please note that due to bugs in Xft, specifying alpha values might result
1669in garbage being displayed when the X-server does not support the RENDER
1670extension.
1671
1672=head1 ENVIRONMENT
1673
1674B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1675
1116=over 4 1676=over 4
1117 1677
1118=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1119
1120would yield White on Black, while on I<xterm>(1) it would yield Black
1121on White.
1122
1123=back
1124
1125=head1 ENVIRONMENT
1126
1127B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1128
1129=over 4
1130
1131=item B<TERM> 1678=item B<TERM>
1132 1679
1133Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1680Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1134resources or on the commandline. 1681resources or on the command line.
1135 1682
1136=item B<COLORTERM> 1683=item B<COLORTERM>
1137 1684
1138Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1685Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1139compiled with XPM support, and optionally with the added extension 1686compiled with background image support, and optionally with the added
1140C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1687extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1688screen.
1141 1689
1142=item B<COLORFGBG> 1690=item B<COLORFGBG>
1143 1691
1144Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1692Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1145the colour code used as default foreground/text colour (or the string 1693the colour code used as default foreground/text colour (or the string
1146C<default> to indicate that the default-colour escape sequence is to be 1694C<default> to indicate that the default-colour escape sequence is to be
1147used), C<bg> is the colour code used as default background colour (or the 1695used), C<bg> is the colour code used as default background colour (or the
1148string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1696string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1149was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1697was compiled with background image support. Libraries like C<ncurses>
1150(and do) use this information to optimize screen output. 1698and C<slang> can (and do) use this information to optimize screen output.
1151 1699
1152=item B<WINDOWID> 1700=item B<WINDOWID>
1153 1701
1154Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1702Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1155window, which usually has subwindows for the scrollbar, the terminal 1703window, which usually has subwindows for the scrollbar, the terminal
1161C<--with-terminfo=PATH>. 1709C<--with-terminfo=PATH>.
1162 1710
1163=item B<DISPLAY> 1711=item B<DISPLAY>
1164 1712
1165Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1713Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1166display in it's child processes. 1714display in its child processes if C<-display> isn't used to override. It
1715defaults to C<:0> if it doesn't exist.
1167 1716
1168=item B<SHELL> 1717=item B<SHELL>
1169 1718
1170The shell to be used for command execution, defaults to C</bin/sh>. 1719The shell to be used for command execution, defaults to C</bin/sh>.
1171 1720
1172=item B<RXVTPATH>
1173
1174The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1175files.
1176
1177=item B<PATH>
1178
1179Used in the same way as C<RXVTPATH>.
1180
1181=item B<RXVT_SOCKET> 1721=item B<RXVT_SOCKET> [I<sic>]
1182 1722
1183The unix domain socket path used by @@RXVT_NAME@@c(1) and 1723The unix domain socket path used by @@RXVT_NAME@@c(1) and
1184@@RXVT_NAME@@d(1). 1724@@RXVT_NAME@@d(1).
1185 1725
1186Default C<< $HOME/.rxvt-unicode-<nodename >>. 1726Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1727
1728=item B<URXVT_PERL_LIB>
1729
1730Additional F<:>-separated library search path for perl extensions. Will be
1731searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1732directory.
1733
1734=item B<URXVT_PERL_VERBOSITY>
1735
1736See L<@@RXVT_NAME@@perl>(3).
1187 1737
1188=item B<HOME> 1738=item B<HOME>
1189 1739
1190Used to locate the default directory for the unix domain socket for 1740Used to locate the default directory for the unix domain socket for
1191daemon communications and to locate various resource files (such as 1741daemon communications and to locate various resource files (such as
1192C<.Xdefaults>) 1742C<.Xdefaults>)
1193 1743
1194=item B<XAPPLRESDIR> 1744=item B<XAPPLRESDIR>
1195 1745
1196Directory where various X resource files are being located. 1746Directory where application-specific X resource files are located.
1197 1747
1198=item B<XENVIRONMENT> 1748=item B<XENVIRONMENT>
1199 1749
1200If set and accessible, gives the name of a X resource file to be loaded by 1750If set and accessible, gives the name of a X resource file to be loaded by
1201@@RXVT_NAME@@. 1751@@RXVT_NAME@@.
1206 1756
1207=over 4 1757=over 4
1208 1758
1209=item B</usr/lib/X11/rgb.txt> 1759=item B</usr/lib/X11/rgb.txt>
1210 1760
1211Color names. 1761Colour names.
1212 1762
1213=back 1763=back
1214 1764
1215=head1 SEE ALSO 1765=head1 SEE ALSO
1216 1766
1767@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1217@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1768@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1218
1219=head1 BUGS
1220
1221Check the BUGS file for an up-to-date list.
1222
1223Cursor change support is not yet implemented.
1224
1225Click-and-drag doesn't work with X11 mouse report overriding.
1226 1769
1227=head1 CURRENT PROJECT COORDINATOR 1770=head1 CURRENT PROJECT COORDINATOR
1228 1771
1229=over 4 1772=over 4
1230 1773
1231=item Project Coordinator 1774=item Project Coordinator
1232 1775
1233Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1776Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1234 1777
1235L<http://software.schmorp.de/#rxvt-unicode> 1778L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1236 1779
1237=back 1780=back
1238 1781
1239=head1 AUTHORS 1782=head1 AUTHORS
1240 1783
1242 1785
1243=item John Bovey 1786=item John Bovey
1244 1787
1245University of Kent, 1992, wrote the original Xvt. 1788University of Kent, 1992, wrote the original Xvt.
1246 1789
1247=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1790=item Rob Nation <nation@rocket.sanders.lockheed.com>
1248 1791
1249very heavily modified Xvt and came up with Rxvt 1792very heavily modified Xvt and came up with Rxvt
1250 1793
1251=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1794=item Angelo Haritsis <ah@doc.ic.ac.uk>
1252 1795
1253wrote the Greek Keyboard Input (no longer in code) 1796wrote the Greek Keyboard Input (no longer in code)
1254 1797
1255=item mj olesen L<< <olesen@me.QueensU.CA> >> 1798=item mj olesen <olesen@me.QueensU.CA>
1256 1799
1257Wrote the menu system. 1800Wrote the menu system.
1258 1801
1259Project Coordinator (changes.txt 2.11 to 2.21) 1802Project Coordinator (changes.txt 2.11 to 2.21)
1260 1803
1261=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1804=item Oezguer Kesim <kesim@math.fu-berlin.de>
1262 1805
1263Project Coordinator (changes.txt 2.21a to 2.4.5) 1806Project Coordinator (changes.txt 2.21a to 2.4.5)
1264 1807
1265=item Geoff Wing L<< <gcw@pobox.com> >> 1808=item Geoff Wing <gcw@pobox.com>
1266 1809
1267Rewrote screen display and text selection routines. Project Coordinator 1810Rewrote screen display and text selection routines.
1811
1268(changes.txt 2.4.6 - rxvt-unicode) 1812Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1269 1813
1270=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1814=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1271 1815
1272Forked rxvt-unicode, rewrote most of the display code and internal 1816Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1273character handling to store text in unicode, improve xterm 1817extension, random hacks, numerous bugfixes and extensions.
1274compatibility and apply numerous other bugfixes and extensions.
1275 1818
1276Project Coordinator (Changes 1.0 -) 1819Project Coordinator (Changes 1.0 -)
1277 1820
1821=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1822
1823pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1824
1278=back 1825=back
1279 1826

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines