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.107 by root, Sun Jan 29 20:51:27 2006 UTC vs.
Revision 1.199 by sf-exg, Tue Aug 9 21:48:00 2011 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.
97 100
98=item B<-depth> I<bitdepth> 101=item B<-depth> I<bitdepth>
99 102
100Compile I<frills>: Attempt to find a visual with the given bit depth; 103Compile I<xft>: Attempt to find a visual with the given bit depth;
101resource B<depth>. 104resource B<depth>.
102 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
103=item B<-geometry> I<geom> 111=item B<-geometry> I<geom>
104 112
105Window geometry (B<-g> still respected); resource B<geometry>. 113Window geometry (B<-g> still respected); resource B<geometry>.
106 114
107=item B<-rv>|B<+rv> 115=item B<-rv>|B<+rv>
108 116
109Turn on/off simulated reverse video; resource B<reverseVideo>. 117Turn on/off simulated reverse video; resource B<reverseVideo>.
110 118
111=item B<-j>|B<+j> 119=item B<-j>|B<+j>
112 120
113Turn on/off jump scrolling; resource B<jumpScroll>. 121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114 122
115=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 123=item B<-ss>|B<+ss>
116 124
117Turn on/off inheriting parent window's pixmap. Alternative form is 125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118B<-tr>; resource B<inheritPixmap>. 126
127=item B<-tr>|B<+tr>
128
129Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
130
131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions.
119 133
120=item B<-fade> I<number> 134=item B<-fade> I<number>
121 135
122Fade the text by the given percentage when focus is lost. Small values 136Fade the text by the given percentage when focus is lost. Small values
123fade a little only, 100 completely replaces all colours by the fade 137fade a little only, 100 completely replaces all colours by the fade
124colour; resource B<fading>. 138colour; resource B<fading>.
125 139
126=item B<-fadecolor> I<colour> 140=item B<-fadecolor> I<colour>
127 141
128Fade to this colour when fading is used (see B<-fade>). The default colour 142Fade to this colour when fading is used (see B<-fade>). The default colour
129is black. resource B<fadeColor>. 143is opaque black. resource B<fadeColor>.
130 144
131=item B<-tint> I<colour> 145=item B<-tint> I<colour>
132 146
133Tint the transparent background pixmap with the given colour when 147Tint the transparent background with the given colour;
134transparency is enabled with B<-tr> or B<-ip>. This only works for 148resource I<tintColor>.
135non-tiled backgrounds, currently. See also the B<-sh> option that can be
136used to brighten or darken the image in addition to tinting it; resource
137I<tintColor>. Example:
138 149
139 @@RXVT_NAME@@ -tr -tint blue -sh 40 150=item B<-sh> I<number>
140 151
141=item B<-sh>
142
143I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 152Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
144background image in addition to tinting it (i.e. B<-tint> must be 153A value of 100 means no shading; resource I<shading>.
145specified, too, e.g. C<-tint white>). 154
155=item B<-blt> I<string>
156
157Specify background blending type. If background pixmap is specified
158at the same time as transparency - such pixmap will be blended over
159the transparent background, using the method specified. Supported values are:
160B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
161B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
162B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
163alpha-blending. Compile I<afterimage>; resource I<blendType>.
164
165=item B<-blr> I<HxV>
166
167Apply Gaussian Blur with the specified radii to the transparent
168background. If a single number is specified - both vertical and
169horizontal radii are considered to be the same. Setting one of the
170radii to 1 and another to a large number creates interesting effects
171on some backgrounds. Maximum radius value is 128;
172resource I<blurRadius>.
173
174=item B<-icon> I<file>
175
176Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
177is used by many window managers, taskbars and pagers to represent the
178application window; resource I<iconFile>.
146 179
147=item B<-bg> I<colour> 180=item B<-bg> I<colour>
148 181
149Window background colour; resource B<background>. 182Window background colour; resource B<background>.
150 183
151=item B<-fg> I<colour> 184=item B<-fg> I<colour>
152 185
153Window foreground colour; resource B<foreground>. 186Window foreground colour; resource B<foreground>.
154 187
155=item B<-pixmap> I<file[;geom]> 188=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
156 189
157Compile I<XPM>: Specify XPM file for the background and also optionally 190Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
158specify its scaling with a geometry string. Note you may need to 191optionally specify its scaling with a geometry string. Note you may need to
159add quotes to avoid special shell interpretation of the C<;> in the 192add quotes to avoid special shell interpretation of the C<;> in the
160command-line; resource B<backgroundPixmap>. 193command-line; for more details see resource B<backgroundPixmap>.
161 194
162=item B<-cr> I<colour> 195=item B<-cr> I<colour>
163 196
164The cursor colour; resource B<cursorColor>. 197The cursor colour; resource B<cursorColor>.
165 198
182that are checked in order when trying to find glyphs for characters. The 215that are checked in order when trying to find glyphs for characters. The
183first font defines the cell size for characters; other fonts might be 216first font defines the cell size for characters; other fonts might be
184smaller, but not (in general) larger. A (hopefully) reasonable default 217smaller, but not (in general) larger. A (hopefully) reasonable default
185font list is always appended to it. See resource B<font> for more details. 218font list is always appended to it. See resource B<font> for more details.
186 219
187In short, to specify an X11 core font, just specify it's name or prefix it 220In short, to specify an X11 core font, just specify its name or prefix it
188with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, 221with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
189e.g.: 222e.g.:
190 223
191 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 224 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
192 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 225 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
210italic> >> characters are to be printed. See resource B<boldItalicFont> 243italic> >> characters are to be printed. See resource B<boldItalicFont>
211for details. 244for details.
212 245
213=item B<-is>|B<+is> 246=item B<-is>|B<+is>
214 247
215Compile I<font-styles>: Bold/Italic font styles imply high intensity 248Compile I<font-styles>: Bold/Blink font styles imply high intensity
216foreground/background (default). See resource B<intensityStyles> for 249foreground/background (default). See resource B<intensityStyles> for
217details. 250details.
218 251
219=item B<-name> I<name> 252=item B<-name> I<name>
220 253
238 271
239=item B<-sb>|B<+sb> 272=item B<-sb>|B<+sb>
240 273
241Turn on/off scrollbar; resource B<scrollBar>. 274Turn on/off scrollbar; resource B<scrollBar>.
242 275
276=item B<-sr>|B<+sr>
277
278Put scrollbar on right/left; resource B<scrollBar_right>.
279
280=item B<-st>|B<+st>
281
282Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
283resource B<scrollBar_floating>.
284
243=item B<-si>|B<+si> 285=item B<-si>|B<+si>
244 286
245Turn on/off scroll-to-bottom on TTY output inhibit; resource 287Turn on/off scroll-to-bottom on TTY output inhibit; resource
246B<scrollTtyOutput> has opposite effect. 288B<scrollTtyOutput> has opposite effect.
247 289
253=item B<-sw>|B<+sw> 295=item B<-sw>|B<+sw>
254 296
255Turn on/off scrolling with the scrollback buffer as new lines appear. 297Turn on/off scrolling with the scrollback buffer as new lines appear.
256This only takes effect if B<-si> is also given; resource 298This only takes effect if B<-si> is also given; resource
257B<scrollWithBuffer>. 299B<scrollWithBuffer>.
258
259=item B<-sr>|B<+sr>
260
261Put scrollbar on right/left; resource B<scrollBar_right>.
262
263=item B<-st>|B<+st>
264
265Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
266resource B<scrollBar_floating>.
267 300
268=item B<-ptab>|B<+ptab> 301=item B<-ptab>|B<+ptab>
269 302
270If enabled (default), "Horizontal Tab" characters are being stored as 303If enabled (default), "Horizontal Tab" characters are being stored as
271actual wide characters in the screen buffer, which makes it possible to 304actual wide characters in the screen buffer, which makes it possible to
275 308
276=item B<-bc>|B<+bc> 309=item B<-bc>|B<+bc>
277 310
278Blink the cursor; resource B<cursorBlink>. 311Blink the cursor; resource B<cursorBlink>.
279 312
313=item B<-uc>|B<+uc>
314
315Make the cursor underlined; resource B<cursorUnderline>.
316
280=item B<-iconic> 317=item B<-iconic>
281 318
282Start iconified, if the window manager supports that option. 319Start iconified, if the window manager supports that option.
283Alternative form is B<-ic>. 320Alternative form is B<-ic>.
284 321
300 337
301=item B<-bl> 338=item B<-bl>
302 339
303Compile I<frills>: Set MWM hints to request a borderless window, i.e. 340Compile I<frills>: Set MWM hints to request a borderless window, i.e.
304if honoured by the WM, the rxvt-unicode window will not have window 341if honoured by the WM, the rxvt-unicode window will not have window
305decorations; resource B<borderLess>. 342decorations; resource B<borderLess>. If the window manager does not
343support MWM hints (e.g. kwin), enables override-redirect mode.
306 344
307=item B<-override-redirect> 345=item B<-override-redirect>
308 346
309Compile I<frills>: Sets override-redirect on the window; resource 347Compile I<frills>: Sets override-redirect on the window; resource
310B<override-redirect>. 348B<override-redirect>.
318 356
319=item B<-lsp> I<number> 357=item B<-lsp> I<number>
320 358
321Compile I<frills>: Lines (pixel height) to insert between each row of 359Compile I<frills>: Lines (pixel height) to insert between each row of
322the display. Useful to work around font rendering problems; resource 360the display. Useful to work around font rendering problems; resource
323B<linespace>. 361B<lineSpace>.
362
363=item B<-letsp> I<number>
364
365Compile I<frills>: Amount to adjust the computed character width by
366to control overall letter spacing. Negative values will tighten up the
367letter spacing, positive values will space letters out more. Useful to
368work around odd font metrics; resource B<letterSpace>.
324 369
325=item B<-tn> I<termname> 370=item B<-tn> I<termname>
326 371
327This option specifies the name of the terminal type to be set in the 372This option specifies the name of the terminal type to be set in the
328B<TERM> environment variable. This terminal type must exist in the 373B<TERM> environment variable. This terminal type must exist in the
382for more info. 427for more info.
383 428
384=item B<-tcw> 429=item B<-tcw>
385 430
386Change the meaning of triple-click selection with the left mouse 431Change the meaning of triple-click selection with the left mouse
432button. Only effective when the original (non-perl) selection code is
387button. Instead of selecting a full line it will extend the selection the 433in-use. Instead of selecting a full line it will extend the selection to
388end of the logical line only. resource B<tripleclickwords>. 434the end of the logical line only. resource B<tripleclickwords>.
389 435
390=item B<-insecure> 436=item B<-insecure>
391 437
392Enable "insecure" mode, which currently enables most of the escape 438Enable "insecure" mode, which currently enables most of the escape
393sequences that echo strings. See the resource B<insecure> for more 439sequences that echo strings. See the resource B<insecure> for more
414Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 460Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
415will not immediately destroy its window when the program executed within 461will not immediately destroy its window when the program executed within
416it exits. Instead, it will wait till it is being killed or closed by the 462it exits. Instead, it will wait till it is being killed or closed by the
417user; resource B<hold>. 463user; resource B<hold>.
418 464
465=item B<-cd> I<path>
466
467Sets the working directory for the shell (or the command specified via
468B<-e>). The I<path> must be an absolute path and it must exist for
469@@RXVT_NAME@@ to start; resource B<chdir>.
470
471=item B<-xrm> I<string>
472
473Works like the X Toolkit option of the same name, by adding the I<string>
474as if it were specified in a resource file. Resource values specified this
475way take precedence over all other resource specifications.
476
477Note that you need to use the I<same> syntax as in the .Xdefaults file,
478e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
479options can be specified as long-options on the commandline, so use
480of B<-xrm> is mostly limited to cases where you want to specify other
481resources (e.g. for input methods) or for compatibility with other
482programs.
483
419=item B<-keysym.>I<sym> I<string> 484=item B<-keysym.>I<sym> I<string>
420 485
421Remap a key symbol. See resource B<keysym>. 486Remap a key symbol. See resource B<keysym>.
422 487
423=item B<-embed> I<windowid> 488=item B<-embed> I<windowid>
424 489
425Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 490Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
426which enables applications to easily embed a terminal. 491which enables applications to easily embed a terminal.
427 492
428Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 493Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
429shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 494shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
430quite a bit, so don't expect it to keep some specific state. It's best to 495quite a bit, so don't expect it to keep some specific state. It's best to
433The window will not be destroyed when @@RXVT_NAME@@ exits. 498The window will not be destroyed when @@RXVT_NAME@@ exits.
434 499
435It might be useful to know that @@RXVT_NAME@@ will not close file 500It might be useful to know that @@RXVT_NAME@@ will not close file
436descriptors passed to it (except for stdin/out/err, of course), so you 501descriptors passed to it (except for stdin/out/err, of course), so you
437can use file descriptors to communicate with the programs within the 502can use file descriptors to communicate with the programs within the
438terminal. This works regardless of wether the C<-embed> option was used or 503terminal. This works regardless of whether the C<-embed> option was used or
439not. 504not.
440 505
441Here is a short Gtk2-perl snippet that illustrates how this option can be 506Here is a short Gtk2-perl snippet that illustrates how this option can be
442used (a longer example is in F<doc/embed>): 507used (a longer example is in F<doc/embed>):
443 508
448 }); 513 });
449 514
450=item B<-pty-fd> I<file descriptor> 515=item B<-pty-fd> I<file descriptor>
451 516
452Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 517Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
453pair but instead use the given filehandle as the tty master. This is 518pair but instead use the given file descriptor as the tty master. This is
454useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 519useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
455without having to run a program within it. 520without having to run a program within it.
456 521
457If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 522If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
458entries and will not tinker with pty/tty permissions - you have to do that 523entries and will not tinker with pty/tty permissions - you have to do that
459yourself if you want that. 524yourself if you want that.
460 525
461As an extremely special case, specifying C<-1> will completely suppress 526As an extremely special case, specifying C<-1> will completely suppress
462pty/tty operations. 527pty/tty operations, which is probably only useful in conjunction with some
528perl extension that manages the terminal.
463 529
464Here is a example in perl that illustrates how this option can be used (a 530Here is a example in perl that illustrates how this option can be used (a
465longer example is in F<doc/pty-fd>): 531longer example is in F<doc/pty-fd>):
466 532
467 use IO::Pty; 533 use IO::Pty;
481Comma-separated list of perl extension scripts to use (or not to use) in 547Comma-separated list of perl extension scripts to use (or not to use) in
482this terminal instance. See resource B<perl-ext> for details. 548this terminal instance. See resource B<perl-ext> for details.
483 549
484=back 550=back
485 551
486=head1 RESOURCES (available also as long-options) 552=head1 RESOURCES
487 553
488Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 554Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
489options) compiled into your version. 555options) compiled into your version. All resources are also available as
556long-options.
490 557
491You can set and change the resources using X11 tools like B<xrdb>. Many 558You can set and change the resources using X11 tools like B<xrdb>. Many
492distribution do also load settings from the B<~/.Xresources> file when X 559distribution do also load settings from the B<~/.Xresources> file when X
493starts. @@RXVT_NAME@@ will consult the following files/resources in order, 560starts. @@RXVT_NAME@@ will consult the following files/resources in order,
494with later settings overwriting earlier ones: 561with later settings overwriting earlier ones:
495 562
496 1. system-wide app-defaults file, either locale-dependent OR global
497 2. app-defaults file in $XAPPLRESDIR 563 1. app-defaults file in $XAPPLRESDIR
564 2. $HOME/.Xdefaults
498 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 565 3. RESOURCE_MANAGER property on root-window of screen 0
499 4. SCREEN_RESOURCES for the current screen 566 4. SCREEN_RESOURCES property on root-window of the current screen
500 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 567 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
568 6. resources specified via -xrm on the commandline
501 569
502Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 570Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
503names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 571names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
504common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily 572common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
505configured, while the class name B<URxvt> allows resources unique to 573configured, while the class name B<URxvt> allows resources unique to
512 580
513=over 4 581=over 4
514 582
515=item B<depth:> I<bitdepth> 583=item B<depth:> I<bitdepth>
516 584
517Compile I<frills>: Attempt to find a visual with the given bit depth; 585Compile I<xft>: Attempt to find a visual with the given bit depth;
518option B<-depth>. 586option B<-depth>.
587
588=item B<buffered:> I<boolean>
589
590Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
591On some card/driver combination enabling it slightly decreases
592performance, on most it greatly helps it. The slowdown is small, so it
593should normally be enabled.
519 594
520=item B<geometry:> I<geom> 595=item B<geometry:> I<geom>
521 596
522Create the window with the specified X window geometry [default 80x24]; 597Create the window with the specified X window geometry [default 80x24];
523option B<-geometry>. 598option B<-geometry>.
537Use the specified colour for the colour value I<n>, where 0-7 612Use the specified colour for the colour value I<n>, where 0-7
538corresponds to low-intensity (normal) colours and 8-15 corresponds to 613corresponds to low-intensity (normal) colours and 8-15 corresponds to
539high-intensity (bold = bright foreground, blink = bright background) 614high-intensity (bold = bright foreground, blink = bright background)
540colours. The canonical names are as follows: 0=black, 1=red, 2=green, 615colours. The canonical names are as follows: 0=black, 1=red, 2=green,
5413=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 6163=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
542names used are listed in the B<COLORS AND GRAPHICS> section. 617names used are listed in the B<COLOURS AND GRAPHICS> section.
543 618
544Colours higher than 15 cannot be set using resources (yet), but can be 619Colours higher than 15 cannot be set using resources (yet), but can be
545changed using an escape command (see @@RXVT_NAME@@(7)). 620changed using an escape command (see @@RXVT_NAME@@(7)).
546 621
547Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 622Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
558=item B<colorUL:> I<colour> 633=item B<colorUL:> I<colour>
559 634
560Use the specified colour to display underlined characters when the 635Use the specified colour to display underlined characters when the
561foreground colour is the default. 636foreground colour is the default.
562 637
563=item B<colorRV:> I<colour>
564
565Use the specified colour as the background for reverse video
566characters.
567
568=item B<underlineColor:> I<colour> 638=item B<underlineColor:> I<colour>
569 639
570If set, use the specified colour as the colour for the underline 640If set, use the specified colour as the colour for the underline
571itself. If unset, use the foreground colour. 641itself. If unset, use the foreground colour.
642
643=item B<highlightColor:> I<colour>
644
645If set, use the specified colour as the background for highlighted
646characters. If unset, use reverse video.
647
648=item B<highlightTextColor:> I<colour>
649
650If set and highlightColor is set, use the specified colour as the
651foreground for highlighted characters.
572 652
573=item B<cursorColor:> I<colour> 653=item B<cursorColor:> I<colour>
574 654
575Use the specified colour for the cursor. The default is to use the 655Use the specified colour for the cursor. The default is to use the
576foreground colour; option B<-cr>. 656foreground colour; option B<-cr>.
583 663
584=item B<reverseVideo:> I<boolean> 664=item B<reverseVideo:> I<boolean>
585 665
586B<True>: simulate reverse video by foreground and background colours; 666B<True>: simulate reverse video by foreground and background colours;
587option B<-rv>. B<False>: regular screen colours [default]; option 667option B<-rv>. B<False>: regular screen colours [default]; option
588B<+rv>. See note in B<COLORS AND GRAPHICS> section. 668B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
589 669
590=item B<jumpScroll:> I<boolean> 670=item B<jumpScroll:> I<boolean>
591 671
592B<True>: specify that jump scrolling should be used. When scrolling 672B<True>: specify that jump scrolling should be used. When receiving lots
593quickly, fewer screen updates are performed [default]; option B<-j>. 673of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
674has been read, resulting in fewer updates while still displaying every
675received line; option B<-j>.
676
594B<False>: specify that smooth scrolling should be used; option B<+j>. 677B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
678force a screen refresh on each new line it received; option B<+j>.
595 679
596=item B<inheritPixmap:> I<boolean> 680=item B<skipScroll:> I<boolean>
597 681
598B<True>: make the background inherit the parent windows' pixmap, giving 682B<True>: (the default) specify that skip scrolling should be used. When
599artificial transparency. B<False>: do not inherit the parent windows' 683receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
600pixmap. 684(around 60 times per second), resulting in far fewer updates. This can
685result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
686option B<-ss>.
687
688B<False>: specify that everything is to be displayed, even
689if the refresh is too fast for the human eye to read anything (or the
690monitor to display anything); option B<+ss>.
691
692=item B<transparent:> I<boolean>
693
694Turn on/off pseudo-transparency by using the root pixmap as background.
695
696B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
697future versions.
601 698
602=item B<fading:> I<number> 699=item B<fading:> I<number>
603 700
604Fade the text by the given percentage when focus is lost; option B<-fade>. 701Fade the text by the given percentage when focus is lost; option B<-fade>.
605 702
608Fade to this colour, when fading is used (see B<fading:>). The default 705Fade to this colour, when fading is used (see B<fading:>). The default
609colour is black; option B<-fadecolor>. 706colour is black; option B<-fadecolor>.
610 707
611=item B<tintColor:> I<colour> 708=item B<tintColor:> I<colour>
612 709
613Tint the transparent background pixmap with the given colour; option 710Tint the transparent background with the given colour. If the RENDER
614B<-tint>. 711extension is not available only black, red, green, yellow, blue,
712magenta, cyan and white tints can be performed server-side. Note that
713a black tint yields a completely black image while a white tint yields
714the image unchanged; option B<-tint>.
615 715
616=item B<shading:> I<number> 716=item B<shading:> I<number>
617 717
618Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 718Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
619image in addition to tinting it. 719A value of 100 means no shading; option B<-sh>.
720
721=item B<blendType:> I<string>
722
723Specify background blending type; option B<-blt>.
724
725=item B<blurRadius:> I<number>
726
727Apply gaussian blur with the specified radius to the transparent
728background; option B<-blr>.
729
730=item B<iconFile:> I<file>
731
732Set the application icon pixmap; option B<-icon>.
620 733
621=item B<scrollColor:> I<colour> 734=item B<scrollColor:> I<colour>
622 735
623Use the specified colour for the scrollbar [default #B2B2B2]. 736Use the specified colour for the scrollbar [default #B2B2B2].
624 737
630=item B<borderColor:> I<colour> 743=item B<borderColor:> I<colour>
631 744
632The colour of the border around the text area and between the scrollbar 745The colour of the border around the text area and between the scrollbar
633and the text. 746and the text.
634 747
635=item B<backgroundPixmap:> I<file[;geom]> 748=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
636 749
637Use the specified XPM file (note the `.xpm' extension is optional) for 750Use the specified image file for the background and also
638the background and also optionally specify its scaling with a geometry 751optionally specify its scaling with a geometry string B<WxH+X+Y>,
639string B<WxH+X+Y>, in which B<"W" / "H"> specify the 752(default C<100x100+50+50>) in which B<"W" / "H"> specify the
640horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 753horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
641centre (percent). A scale of 0 displays the image with tiling. A scale 754centre (percent). A scale of 0 disables scaling.
642of 1 displays the image without any scaling. A scale of 2 to 9 755The maximum permitted scale is 1000.
643specifies an integer number of images in that direction. No image will 756Additional operations can be specified after colon B<:op1:op2...>.
644be magnified beyond 10 times its original size. The maximum permitted 757Supported operations are:
645scale is 1000. [default 0x0+50+50] 758
759 tile will tile image
760 propscale will scale image keeping proportions
761 hscale will scale image horizontally to the window size
762 vscale will scale image vertically to the window size
763 scale will scale image to match window size
764 root will tile image as if it was a root window background, auto-adjusting
765 whenever terminal window moves
766
767If used in conjunction with B<-tr> option, the specified pixmap will be
768blended over the transparent background using alpha-blending. If I<afterimage>
769support has been compiled in it is possible to choose other blending
770types with B<-blt "type"> option.
646 771
647=item B<path:> I<path> 772=item B<path:> I<path>
648 773
649Specify the colon-delimited search path for finding XPM files. 774Specify the colon-delimited search path for finding background image files.
650 775
651=item B<font:> I<fontlist> 776=item B<font:> I<fontlist>
652 777
653Select the fonts to be used. This is a comma separated list of font names 778Select the fonts to be used. This is a comma separated list of font names
654that are checked in order when trying to find glyphs for characters. The 779that are checked in order when trying to find glyphs for characters. The
677it is named first) and thus defines the character cell grid to be 9 pixels 802it is named first) and thus defines the character cell grid to be 9 pixels
678wide and 15 pixels high. 803wide and 15 pixels high.
679 804
680The second font is just used to add additional unicode characters not in 805The second font is just used to add additional unicode characters not in
681the base font, likewise the third, which is unfortunately non-bold, but 806the base font, likewise the third, which is unfortunately non-bold, but
682the bold version of the font does contain less characters, so this is a 807the bold version of the font does contain fewer characters, so this is a
683useful supplement. 808useful supplement.
684 809
685The third font is an Xft font with aliasing turned off, and the characters 810The third font is an Xft font with aliasing turned off, and the characters
686are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 811are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
687contains other characters, but we are not interested in them. 812contains other characters, but we are not interested in them.
711text font will being used for the given style. 836text font will being used for the given style.
712 837
713=item B<intensityStyles:> I<boolean> 838=item B<intensityStyles:> I<boolean>
714 839
715When font styles are not enabled, or this option is enabled (B<True>, 840When font styles are not enabled, or this option is enabled (B<True>,
716option B<-is>, the default), bold and italic font styles imply high 841option B<-is>, the default), bold/blink font styles imply high
717intensity foreground/backround colours. Disabling this option (B<False>, 842intensity foreground/background colours. Disabling this option (B<False>,
718option B<+is>) disables this behaviour, the high intensity colours are not 843option B<+is>) disables this behaviour, the high intensity colours are not
719reachable. 844reachable.
720
721=item B<selectstyle:> I<mode>
722
723Set mouse selection style to B<old> which is 2.20, B<oldword> which is
724xterm style with 2.20 old word selection, or anything else which gives
725xterm style selection.
726
727=item B<scrollstyle:> I<mode>
728
729Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
730the author's favourite.
731 845
732=item B<title:> I<string> 846=item B<title:> I<string>
733 847
734Set window title string, the default title is the command-line 848Set window title string, the default title is the command-line
735specified after the B<-e> option, if any, otherwise the application 849specified after the B<-e> option, if any, otherwise the application
744=item B<mapAlert:> I<boolean> 858=item B<mapAlert:> I<boolean>
745 859
746B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 860B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
747de-iconify (map) on receipt of a bell character [default]. 861de-iconify (map) on receipt of a bell character [default].
748 862
863=item B<urgentOnBell:> I<boolean>
864
865B<True>: set the urgency hint for the wm on receipt of a bell character.
866B<False>: do not set the urgency hint [default].
867
868@@RXVT_NAME@@ resets the urgency hint on every focus change.
869
749=item B<visualBell:> I<boolean> 870=item B<visualBell:> I<boolean>
750 871
751B<True>: use visual bell on receipt of a bell character; option B<-vb>. 872B<True>: use visual bell on receipt of a bell character; option B<-vb>.
752B<False>: no visual bell [default]; option B<+vb>. 873B<False>: no visual bell [default]; option B<+vb>.
753 874
774Example: 895Example:
775 896
776 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 897 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
777 898
778This creates a new file in your home directory with the screen contents 899This creates a new file in your home directory with the screen contents
779everytime you hit C<Print>. 900every time you hit C<Print>.
901
902=item B<scrollstyle:> I<mode>
903
904Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
905the author's favourite.
906
907=item B<thickness:> I<number>
908
909Set the scrollbar width in pixels.
780 910
781=item B<scrollBar:> I<boolean> 911=item B<scrollBar:> I<boolean>
782 912
783B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 913B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
784disable the scrollbar; option B<+sb>. 914disable the scrollbar; option B<+sb>.
804B<False>: do not scroll to bottom when tty receives output; option 934B<False>: do not scroll to bottom when tty receives output; option
805B<+si>. 935B<+si>.
806 936
807=item B<scrollWithBuffer:> I<boolean> 937=item B<scrollWithBuffer:> I<boolean>
808 938
809B<True>: scroll with scrollback buffer when tty receives new lines (and 939B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
810B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 940try to show the same lines) and B<scrollTtyOutput> is False; option
811with scrollback buffer when tty recieves new lines; option B<+sw>. 941B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
942new lines; option B<+sw>.
812 943
813=item B<scrollTtyKeypress:> I<boolean> 944=item B<scrollTtyKeypress:> I<boolean>
814 945
815B<True>: scroll to bottom when a non-special key is pressed. Special keys 946B<True>: scroll to bottom when a non-special key is pressed. Special keys
816are those which are intercepted by rxvt-unicode for special handling and 947are those which are intercepted by rxvt-unicode for special handling and
847=item B<termName:> I<termname> 978=item B<termName:> I<termname>
848 979
849Specifies the terminal type name to be set in the B<TERM> environment 980Specifies the terminal type name to be set in the B<TERM> environment
850variable; option B<-tn>. 981variable; option B<-tn>.
851 982
852=item B<linespace:> I<number> 983=item B<lineSpace:> I<number>
853 984
854Specifies number of lines (pixel height) to insert between each row of 985Specifies number of lines (pixel height) to insert between each row of
855the display [default 0]; option B<-lsp>. 986the display [default 0]; option B<-lsp>.
856 987
857=item B<meta8:> I<boolean> 988=item B<meta8:> I<boolean>
871 1002
872=item B<cursorBlink:> I<boolean> 1003=item B<cursorBlink:> I<boolean>
873 1004
874B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1005B<True>: blink the cursor. B<False>: do not blink the cursor [default];
875option B<-bc>. 1006option B<-bc>.
1007
1008=item B<cursorUnderline:> I<boolean>
1009
1010B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1011option B<-uc>.
876 1012
877=item B<pointerBlank:> I<boolean> 1013=item B<pointerBlank:> I<boolean>
878 1014
879B<True>: blank the pointer when a key is pressed or after a set number 1015B<True>: blank the pointer when a key is pressed or after a set number
880of seconds of inactivity. B<False>: the pointer is always visible 1016of seconds of inactivity. B<False>: the pointer is always visible
894large number (e.g. C<987654321>) to effectively disable the timeout. 1030large number (e.g. C<987654321>) to effectively disable the timeout.
895 1031
896=item B<backspacekey:> I<string> 1032=item B<backspacekey:> I<string>
897 1033
898The string to send when the backspace key is pressed. If set to B<DEC> 1034The string to send when the backspace key is pressed. If set to B<DEC>
899or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 1035or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
900(code 8) - which can be reversed with the appropriate DEC private mode 1036(code 8) - which can be reversed with the appropriate DEC private mode
901escape sequence. 1037escape sequence.
902 1038
903=item B<deletekey:> I<string> 1039=item B<deletekey:> I<string>
904 1040
909=item B<cutchars:> I<string> 1045=item B<cutchars:> I<string>
910 1046
911The characters used as delimiters for double-click word selection 1047The characters used as delimiters for double-click word selection
912(whitespace delimiting is added automatically if resource is given). 1048(whitespace delimiting is added automatically if resource is given).
913 1049
914When the selection extension is in use (the default if compiled in, see 1050When the perl selection extension is in use (the default if compiled
915the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters 1051in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
916will be created (if the resource exists, otherwise, no regex will be 1052characters will be created (if the resource exists, otherwise, no regex
917created). In this mode, characters outside ISO-8859-1 can be used. 1053will be created). In this mode, characters outside ISO-8859-1 can be used.
918 1054
919When the selection extension is not used, only ISO-8859-1 characters can 1055When the selection extension is not used, only ISO-8859-1 characters can
920be used. If not specified, the built-in default is used: 1056be used. If not specified, the built-in default is used:
921 1057
922B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1058B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
923 1059
924=item B<preeditType:> I<style> 1060=item B<preeditType:> I<style>
925 1061
926B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1062B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
927 1063
981 1117
982Turn on/off secondary screen (default enabled). 1118Turn on/off secondary screen (default enabled).
983 1119
984=item B<secondaryScroll:> I<boolean> 1120=item B<secondaryScroll:> I<boolean>
985 1121
986Turn on/off secondary screen scroll (default enabled). If the this 1122Turn on/off secondary screen scroll (default enabled). If this
987option is enabled, scrolls on the secondary screen will change the 1123option is enabled, scrolls on the secondary screen will change the
988scrollback buffer and switching to/from the secondary screen will 1124scrollback buffer and, when secondaryScreen is off, switching
989instead scroll the screen up. 1125to/from the secondary screen will instead scroll the screen up.
990 1126
991=item B<hold>: I<boolean> 1127=item B<hold>: I<boolean>
992 1128
993Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1129Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
994will not immediately destroy its window when the program executed within 1130will not immediately destroy its window when the program executed within
995it exits. Instead, it will wait till it is being killed or closed by the 1131it exits. Instead, it will wait till it is being killed or closed by the
996user. 1132user.
1133
1134=item B<chdir>: I<path>
1135
1136Sets the working directory for the shell (or the command specified via
1137B<-e>). The I<path> must be an absolute path and it must exist for
1138@@RXVT_NAME@@ to start. If it isn't specified then the current working
1139directory will be used; option B<-cd>.
997 1140
998=item B<keysym.>I<sym>: I<string> 1141=item B<keysym.>I<sym>: I<string>
999 1142
1000Compile I<frills>: Associate I<string> with keysym I<sym>. The 1143Compile I<frills>: Associate I<string> with keysym I<sym>. The
1001intervening resource name B<keysym.> cannot be omitted. 1144intervening resource name B<keysym.> cannot be omitted.
1015searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1158searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1016omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1159omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1017keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1160keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1018performed in an exact manner; however, the closest match is assured. 1161performed in an exact manner; however, the closest match is assured.
1019 1162
1020I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1163I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1021C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1164number), see RESOURCES in C<man 7 X> for further details.
1022C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1023C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1024can start or end with whitespace.
1025
1026Please note that you need to double the C<\> in resource files, as
1027Xlib itself does it's own de-escaping (you can use C<\033> instead of
1028C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1029processing).
1030 1165
1031You can define a range of keysyms in one shot by providing a I<string> 1166You can define a range of keysyms in one shot by providing a I<string>
1032with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1167with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1033should be a character not used by the strings. 1168should be a character not used by the strings.
1034 1169
1035Its usage can be demonstrated by an example: 1170Its usage can be demonstrated by an example:
1036 1171
1037 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1172 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1038 1173
1039The above line is equivalent to the following three lines: 1174The above line is equivalent to the following three lines:
1040 1175
1041 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1176 URxvt.keysym.Meta-Control-0x61: \033<a>
1042 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1177 URxvt.keysym.Meta-Control-0x62: \033<b>
1043 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1178 URxvt.keysym.Meta-Control-0x63: \033<c>
1044 1179
1045If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1180If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1046is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1181is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1047example the following means "change the current locale to C<zh_CN.GBK> 1182example the following means "change the current locale to C<zh_CN.GBK>
1048when Control-Meta-c is being pressed": 1183when Control-Meta-c is being pressed":
1049 1184
1050 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1185 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1051 1186
1052If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1187If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1053is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1188is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1054manpage. For example, the F<selection> extension (activated via 1189manpage. For example, the F<selection> extension (activated via
1055C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1190C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1056 1191
1057 URxvt.keysym.M-C-c: perl:selection:rot13 1192 URxvt.keysym.M-C-c: perl:selection:rot13
1058 1193
1059Due the the large number of modifier combinations, a defined key mapping 1194Due the the large number of modifier combinations, a defined key mapping
1060will match if at I<at least> the specified identifiers are being set, and 1195will match if I<at least> the specified identifiers are being set, and
1061no other key mappings with those and more bits are being defined. That 1196no other key mappings with those and more bits are being defined. That
1062means that defining a key map for C<a> will automatically provide 1197means that defining a key map for C<a> will automatically provide
1063definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined 1198definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1064mappings themselves. 1199mappings themselves.
1065 1200
1101example, C<default,-selection> will use all the default extension except 1236example, C<default,-selection> will use all the default extension except
1102C<selection>. 1237C<selection>.
1103 1238
1104Extension names can also be followed by an argument in angle brackets 1239Extension names can also be followed by an argument in angle brackets
1105(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1240(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1106searchable scorllback to Alt/Meta-s). Mentioning the same extension 1241searchable scrollback to Alt/Meta-s). Mentioning the same extension
1107multiple times with different arguments will pass multiple arguments to 1242multiple times with different arguments will pass multiple arguments to
1108the extension. 1243the extension.
1109 1244
1110Each extension is looked up in the library directories, loaded if 1245Each extension is looked up in the library directories, loaded if
1111necessary, and bound to the current terminal instance. 1246necessary, and bound to the current terminal instance.
1116all instances, while B<perl-ext> is used for specific instances. 1251all instances, while B<perl-ext> is used for specific instances.
1117 1252
1118=item B<perl-eval>: I<string> 1253=item B<perl-eval>: I<string>
1119 1254
1120Perl code to be evaluated when all extensions have been registered. See 1255Perl code to be evaluated when all extensions have been registered. See
1121the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1256the @@RXVT_NAME@@perl(3) manpage.
1122will be ignored when running setuid/setgid.
1123 1257
1124=item B<perl-lib>: I<path> 1258=item B<perl-lib>: I<path>
1125 1259
1126Colon-separated list of additional directories that hold extension 1260Colon-separated list of additional directories that hold extension
1127scripts. When looking for extensions specified by the C<perl> resource, 1261scripts. When looking for extensions specified by the C<perl> resource,
1128@@RXVT_NAME@@ will first look in these directories and then in 1262@@RXVT_NAME@@ will first look in these directories and then in
1129F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1263F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1130will be ignored when running setuid/setgid.
1131 1264
1132See the @@RXVT_NAME@@perl(3) manpage. 1265See the @@RXVT_NAME@@perl(3) manpage.
1133 1266
1134=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1267=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1135 1268
1147(default: C<M-s>). 1280(default: C<M-s>).
1148 1281
1149=item B<urlLauncher>: I<string> 1282=item B<urlLauncher>: I<string>
1150 1283
1151Specifies the program to be started with a URL argument. Used by the 1284Specifies the program to be started with a URL argument. Used by the
1152C<selection-popup> and C<mark-urls> perl extensions. 1285C<selection-popup> and C<matcher> perl extensions.
1153 1286
1154=item B<transient-for>: I<windowid> 1287=item B<transient-for>: I<windowid>
1155 1288
1156Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. 1289Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1157 1290
1158=item B<override-redirect>: I<boolean> 1291=item B<override-redirect>: I<boolean>
1159 1292
1160Compile I<frills>: Sets override-redirect for the terminal window, making 1293Compile I<frills>: Sets override-redirect for the terminal window, making
1161it almost invisible to window managers; option B<-override-redirect>. 1294it almost invisible to window managers; option B<-override-redirect>.
1295
1296=item B<iso14755:> I<boolean>
1297
1298Turn on/off ISO 14755 (default enabled).
1299
1300=item B<iso14755_52:> I<boolean>
1301
1302Turn on/off ISO 14755 5.2 mode (default enabled).
1162 1303
1163=back 1304=back
1164 1305
1165=head1 THE SCROLLBAR 1306=head1 THE SCROLLBAR
1166 1307
1185application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1326application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1186(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1327(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1187up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1328up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1188respectively. 1329respectively.
1189 1330
1190=head1 TEXT SELECTION AND INSERTION 1331=head1 THE SELECTION: SELECTING AND PASTING TEXT
1191 1332
1192The behaviour of text selection and insertion mechanism is similar to 1333The behaviour of text selection and insertion/pasting mechanism is similar
1193I<xterm>(1). 1334to I<xterm>(1).
1194 1335
1195=over 4 1336=over 4
1196 1337
1197=item B<Selection>: 1338=item B<Selecting>:
1198 1339
1199Left click at the beginning of the region, drag to the end of the region 1340Left click at the beginning of the region, drag to the end of the region
1200and release; Right click to extend the marked region; Left double-click 1341and release; Right click to extend the marked region; Left double-click
1201to select a word; Left triple-click to select the entire logical line 1342to select a word; Left triple-click to select the entire logical line
1202(which can span multiple screen lines), unless modified by resource 1343(which can span multiple screen lines), unless modified by resource
1206(Compile: I<frills>) will create a rectangular selection instead of a 1347(Compile: I<frills>) will create a rectangular selection instead of a
1207normal one. In this mode, every selected row becomes its own line in the 1348normal one. In this mode, every selected row becomes its own line in the
1208selection, and trailing whitespace is visually underlined and removed from 1349selection, and trailing whitespace is visually underlined and removed from
1209the selection. 1350the selection.
1210 1351
1211=item B<Insertion>: 1352=item B<Pasting>:
1212 1353
1213Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> 1354Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1214window causes the value of the PRIMARY selection (or CLIPBOARD with the 1355window causes the value of the PRIMARY selection (or CLIPBOARD with the
1215Meta modifier) to be inserted as if it had been typed on the keyboard. 1356B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1216 1357
1217Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1358Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1218inserted too. 1359inserted too.
1219 1360
1220=back 1361=back
1237 1378
1238=head1 ISO 14755 SUPPORT 1379=head1 ISO 14755 SUPPORT
1239 1380
1240ISO 14755 is a standard for entering and viewing unicode characters 1381ISO 14755 is a standard for entering and viewing unicode characters
1241and character codes using the keyboard. It consists of 4 parts. The 1382and character codes using the keyboard. It consists of 4 parts. The
1242first part is available rxvt-unicode has been compiled with 1383first part is available if rxvt-unicode has been compiled with
1243C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1384C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1244with C<--enable-iso14755>. 1385with C<--enable-iso14755>.
1245 1386
1246=over 4 1387=over 4
1247 1388
1267This mode lets you input characters representing the keycap symbols of 1408This mode lets you input characters representing the keycap symbols of
1268your keyboard, if representable in the current locale encoding. 1409your keyboard, if representable in the current locale encoding.
1269 1410
1270Start by pressing C<Control> and C<Shift> together, then releasing 1411Start by pressing C<Control> and C<Shift> together, then releasing
1271them. The next special key (cursor keys, home etc.) you enter will not 1412them. The next special key (cursor keys, home etc.) you enter will not
1272invoke it's usual function but instead will insert the corresponding 1413invoke its usual function but instead will insert the corresponding
1273keycap symbol. The symbol will only be entered when the key has been 1414keycap symbol. The symbol will only be entered when the key has been
1274released, otherwise pressing e.g. C<Shift> would enter the symbol for 1415released, otherwise pressing e.g. C<Shift> would enter the symbol for
1275C<ISO Level 2 Switch>, although your intention might have been to enter a 1416C<ISO Level 2 Switch>, although your intention might have been to enter a
1276reverse tab (Shift-Tab). 1417reverse tab (Shift-Tab).
1277 1418
1305B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1446B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1306it can be seen via the I<who(1)> command, and can accept messages. To 1447it can be seen via the I<who(1)> command, and can accept messages. To
1307allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1448allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1308on some systems or setgid to root or to some other group on others. 1449on some systems or setgid to root or to some other group on others.
1309 1450
1310=head1 COLORS AND GRAPHICS 1451=head1 COLOURS AND GRAPHICS
1311 1452
1312In addition to the default foreground and background colours, 1453In addition to the default foreground and background colours,
1313B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1454B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1314high-intensity bold/blink versions of the same). Here is a list of the 1455high-intensity (potentially bold/blink) versions of the same, and 72 (or
1315colours with their names. 1456240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1457cube plus a 8 (24) colour greyscale ramp.
1458
1459Here is a list of the ANSI colours with their names.
1316 1460
1317=begin table 1461=begin table
1318 1462
1319 B<color0> (black) = Black 1463 B<color0> (black) = Black
1320 B<color1> (red) = Red3 1464 B<color1> (red) = Red3
1340It is also possible to specify the colour values of B<foreground>, 1484It is also possible to specify the colour values of B<foreground>,
1341B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1485B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1342a number 0-15, as a convenient shorthand to reference the colour name of 1486a number 0-15, as a convenient shorthand to reference the colour name of
1343color0-color15. 1487color0-color15.
1344 1488
1345If Xft support has been compiled in and as long as Xft/Xrender don't get 1489The following text gives values for the standard 88 colour mode (and
1346their act together, rxvt-unicode will support C<#ARGB>, C<#AARRGGBB> 1490values for the 256 colour mode in parentheses).
1347and C<#AAAARRRRGGGGBBBB> colour specifications, in addition to the ones 1491
1348provided by X, where the additional A component specifies alpha (opacity) 1492The RGB cube uses indices 16..79 (16..231) using the following formulas:
1349values (0 is completely transparent and the maximum is opaque). You 1493
1350probably need to specify B<"-depth 32">, too, as X is far from just 1494 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1351supporting ARGB visuals out of the box. 1495 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1496
1497The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1498steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1499the RGB cube.
1500
1501Together, all those colours implement the 88 (256) colour xterm
1502colours. Only the first 16 can be changed using resources currently, the
1503rest can only be changed via command sequences ("escape codes").
1504
1505Applications are advised to use terminfo or command sequences to discover
1506number and RGB values of all colours (yes, you can query this...).
1352 1507
1353Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1508Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1354always swapping the foreground/background colours. This is in contrast to 1509always swapping the foreground/background colours. This is in contrast to
1355I<xterm>(1) where the colours are only swapped if they have not otherwise 1510I<xterm>(1) where the colours are only swapped if they have not otherwise
1356been specified. For example, 1511been specified. For example,
1357 1512
1513 @@RXVT_NAME@@ -fg Black -bg White -rv
1514
1515would yield White on Black, while on I<xterm>(1) it would yield Black on
1516White.
1517
1518=head2 ALPHA CHANNEL SUPPORT
1519
1520If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1521their act together, rxvt-unicode will do it's own alpha channel management:
1522
1523You can prefix any colour with an opaqueness percentage enclosed in
1524brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1525(0-100) that specifies the opacity of the colour, where C<0> is completely
1526transparent and C<100> is completely opaque. For example, C<[50]red> is a
1527half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1528is the recommended format to specify transparency values, and works with
1529all ways to specify a colour.
1530
1531For complete control, rxvt-unicode also supports
1532C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1533specifications, where the additional C<aaaa> component specifies opacity
1534(alpha) values. The minimum value of C<0000> is completely transparent,
1535while C<ffff> is completely opaque). The two example colours from
1536earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1537C<rgba:0000/ff00/0000/f332>.
1538
1539You probably need to specify B<"-depth 32">, too, to force a visual with
1540alpha channels, and have the luck that your X-server uses ARGB pixel
1541layout, as X is far from just supporting ARGB visuals out of the box, and
1542rxvt-unicode just fudges around.
1543
1544For example, the following selects an almost completely transparent black
1545background, and an almost opaque pink foreground:
1546
1547 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1548
1549When not using a background image, then the interpretation of the
1550alpha channel is up to your compositing manager (most interpret it as
1551transparency of course).
1552
1553When using a background pixmap or pseudo-transparency, then the background
1554colour will always behave as if it were completely transparent (so the
1555background image shows instead), regardless of how it was specified, while
1556other colours will either be transparent as specified (the background
1557image will show through) on servers supporting the RENDER extension, or
1558fully opaque on servers not supporting the RENDER EXTENSION.
1559
1560Please note that due to bugs in Xft, specifying alpha values might result
1561in garbage being displayed when the X-server does not support the RENDER
1562extension.
1563
1564=head1 ENVIRONMENT
1565
1566B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1567
1358=over 4 1568=over 4
1359 1569
1360=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1361
1362would yield White on Black, while on I<xterm>(1) it would yield Black
1363on White.
1364
1365=back
1366
1367=head1 ENVIRONMENT
1368
1369B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1370
1371=over 4
1372
1373=item B<TERM> 1570=item B<TERM>
1374 1571
1375Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1572Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1376resources or on the commandline. 1573resources or on the command line.
1377 1574
1378=item B<COLORTERM> 1575=item B<COLORTERM>
1379 1576
1380Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1577Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1381compiled with XPM support, and optionally with the added extension 1578compiled with background image support, and optionally with the added
1382C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1579extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1580screen.
1383 1581
1384=item B<COLORFGBG> 1582=item B<COLORFGBG>
1385 1583
1386Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1584Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1387the colour code used as default foreground/text colour (or the string 1585the colour code used as default foreground/text colour (or the string
1388C<default> to indicate that the default-colour escape sequence is to be 1586C<default> to indicate that the default-colour escape sequence is to be
1389used), C<bg> is the colour code used as default background colour (or the 1587used), C<bg> is the colour code used as default background colour (or the
1390string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1588string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1391was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1589was compiled with background image support. Libraries like C<ncurses>
1392(and do) use this information to optimize screen output. 1590and C<slang> can (and do) use this information to optimize screen output.
1393 1591
1394=item B<WINDOWID> 1592=item B<WINDOWID>
1395 1593
1396Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1594Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1397window, which usually has subwindows for the scrollbar, the terminal 1595window, which usually has subwindows for the scrollbar, the terminal
1403C<--with-terminfo=PATH>. 1601C<--with-terminfo=PATH>.
1404 1602
1405=item B<DISPLAY> 1603=item B<DISPLAY>
1406 1604
1407Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1605Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1408display in it's child processes. 1606display in its child processes if C<-display> isn't used to override. It
1607defaults to C<:0> if it doesn't exist.
1409 1608
1410=item B<SHELL> 1609=item B<SHELL>
1411 1610
1412The shell to be used for command execution, defaults to C</bin/sh>. 1611The shell to be used for command execution, defaults to C</bin/sh>.
1413 1612
1414=item B<RXVT_SOCKET> 1613=item B<RXVT_SOCKET>
1415 1614
1416The unix domain socket path used by @@RXVT_NAME@@c(1) and 1615The unix domain socket path used by @@RXVT_NAME@@c(1) and
1417@@RXVT_NAME@@d(1). 1616@@RXVT_NAME@@d(1).
1418 1617
1419Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1618Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>.
1420 1619
1421=item B<HOME> 1620=item B<HOME>
1422 1621
1423Used to locate the default directory for the unix domain socket for 1622Used to locate the default directory for the unix domain socket for
1424daemon communications and to locate various resource files (such as 1623daemon communications and to locate various resource files (such as
1425C<.Xdefaults>) 1624C<.Xdefaults>)
1426 1625
1427=item B<XAPPLRESDIR> 1626=item B<XAPPLRESDIR>
1428 1627
1429Directory where various X resource files are being located. 1628Directory where application-specific X resource files are located.
1430 1629
1431=item B<XENVIRONMENT> 1630=item B<XENVIRONMENT>
1432 1631
1433If set and accessible, gives the name of a X resource file to be loaded by 1632If set and accessible, gives the name of a X resource file to be loaded by
1434@@RXVT_NAME@@. 1633@@RXVT_NAME@@.
1439 1638
1440=over 4 1639=over 4
1441 1640
1442=item B</usr/lib/X11/rgb.txt> 1641=item B</usr/lib/X11/rgb.txt>
1443 1642
1444Color names. 1643Colour names.
1445 1644
1446=back 1645=back
1447 1646
1448=head1 SEE ALSO 1647=head1 SEE ALSO
1449 1648
1455 1654
1456=item Project Coordinator 1655=item Project Coordinator
1457 1656
1458Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1657Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1459 1658
1460L<http://software.schmorp.de/#rxvt-unicode> 1659L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1461 1660
1462=back 1661=back
1463 1662
1464=head1 AUTHORS 1663=head1 AUTHORS
1465 1664
1488Project Coordinator (changes.txt 2.21a to 2.4.5) 1687Project Coordinator (changes.txt 2.21a to 2.4.5)
1489 1688
1490=item Geoff Wing L<< <gcw@pobox.com> >> 1689=item Geoff Wing L<< <gcw@pobox.com> >>
1491 1690
1492Rewrote screen display and text selection routines. 1691Rewrote screen display and text selection routines.
1493 1692
1494Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1693Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1495 1694
1496=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1695=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1497 1696
1498Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1697Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1500 1699
1501Project Coordinator (Changes 1.0 -) 1700Project Coordinator (Changes 1.0 -)
1502 1701
1503=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1702=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1504 1703
1505Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1704pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1506 1705
1507=back 1706=back
1508 1707

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines