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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines