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.99 by root, Wed Jan 18 19:43:51 2006 UTC vs.
Revision 1.165 by root, Thu Oct 2 17:06:50 2008 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<xft>: 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]
97 110
98=item B<-geometry> I<geom> 111=item B<-geometry> I<geom>
99 112
100Window geometry (B<-g> still respected); resource B<geometry>. 113Window geometry (B<-g> still respected); resource B<geometry>.
101 114
103 116
104Turn on/off simulated reverse video; resource B<reverseVideo>. 117Turn on/off simulated reverse video; resource B<reverseVideo>.
105 118
106=item B<-j>|B<+j> 119=item B<-j>|B<+j>
107 120
108Turn on/off jump scrolling; resource B<jumpScroll>. 121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109 122
110=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 123=item B<-ss>|B<+ss>
111 124
112Turn on/off inheriting parent window's pixmap. Alternative form is 125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
113B<-tr>; resource B<inheritPixmap>. 126
127=item B<-tr>|B<+tr>
128
129Turn on/off illusion of a transparent window background; resource B<transparent>.
130
131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions.
133
134I<Please address all transparency related issues to Sasha Vasko at
135sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
114 136
115=item B<-fade> I<number> 137=item B<-fade> I<number>
116 138
117Fade the text by the given percentage when focus is lost. Small values 139Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade 140fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>. 141colour; resource B<fading>.
120 142
121=item B<-fadecolor> I<colour> 143=item B<-fadecolor> I<colour>
122 144
123Fade to this colour when fading is used (see B<-fade>). The default colour 145Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>. 146is opaque black. resource B<fadeColor>.
125 147
126=item B<-tint> I<colour> 148=item B<-tint> I<colour>
127 149
128Tint the transparent background pixmap with the given colour when 150Tint the transparent background pixmap with the given colour when
129transparency is enabled with B<-tr> or B<-ip>. This only works for 151transparency is enabled with B<-tr>. This only works for
130non-tiled backgrounds, currently. See also the B<-sh> option that can be 152non-tiled backgrounds, currently. See also the B<-sh> option that can be
131used to brighten or darken the image in addition to tinting it; resource 153used to brighten or darken the image in addition to tinting it.
154Please note that certain tint colours can be applied on the server-side,
155thus yielding performance gain of two orders of magnitude. These colours are:
156blue, red, green, cyan, magenta, yellow, and those close to them. Also
157pure black and pure white colors essentially mean no tinting; resource
132I<tintColor>. Example: 158I<tintColor>. Example:
133 159
134 @@RXVT_NAME@@ -tr -tint blue -sh 40 160 @@RXVT_NAME@@ -tr -tint blue -sh 40
135 161
136=item B<-sh> 162=item B<-sh> I<number>
137 163
138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 164Darken (0 .. 100) or lighten (100 .. 200) the transparent
139background image in addition to tinting it (i.e. B<-tint> must be 165background image in addition to (or instead of) tinting it;
140specified, too, e.g. C<-tint white>). 166resource I<shading>.
167
168=item B<-blt> I<string>
169
170Specify background blending type. If background pixmap is specified
171at the same time as transparency - such pixmap will be blended over
172transparency image, using method specified. Supported values are :
173B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176alpha-blending. Compile I<afterimage>; resource I<blendType>.
177
178=item B<-blr> I<HxV>
179
180Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and
182horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
185resource I<blurRadius>.
141 186
142=item B<-bg> I<colour> 187=item B<-bg> I<colour>
143 188
144Window background colour; resource B<background>. 189Window background colour; resource B<background>.
145 190
146=item B<-fg> I<colour> 191=item B<-fg> I<colour>
147 192
148Window foreground colour; resource B<foreground>. 193Window foreground colour; resource B<foreground>.
149 194
150=item B<-pixmap> I<file[;geom]> 195=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
151 196
152Compile I<XPM>: Specify XPM file for the background and also optionally 197Compile I<afterimage>: Specify image file for the background and also
153specify its scaling with a geometry string. Note you may need to 198optionally specify its scaling with a geometry string. Note you may need to
154add quotes to avoid special shell interpretation of the C<;> in the 199add quotes to avoid special shell interpretation of the C<;> in the
155command-line; resource B<backgroundPixmap>. 200command-line; for more details see resource B<backgroundPixmap>.
156 201
157=item B<-cr> I<colour> 202=item B<-cr> I<colour>
158 203
159The cursor colour; resource B<cursorColor>. 204The cursor colour; resource B<cursorColor>.
160 205
177that are checked in order when trying to find glyphs for characters. The 222that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 223first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 224smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 225font list is always appended to it. See resource B<font> for more details.
181 226
182In short, to specify an X11 core font, just specify it's name or prefix it 227In 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:>, 228with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.: 229e.g.:
185 230
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 231 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 232 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
205italic> >> characters are to be printed. See resource B<boldItalicFont> 250italic> >> characters are to be printed. See resource B<boldItalicFont>
206for details. 251for details.
207 252
208=item B<-is>|B<+is> 253=item B<-is>|B<+is>
209 254
210Compile I<font-styles>: Bold/Italic font styles imply high intensity 255Compile I<font-styles>: Bold/Blink font styles imply high intensity
211foreground/background (default). See resource B<intensityStyles> for 256foreground/background (default). See resource B<intensityStyles> for
212details. 257details.
213 258
214=item B<-name> I<name> 259=item B<-name> I<name>
215 260
233 278
234=item B<-sb>|B<+sb> 279=item B<-sb>|B<+sb>
235 280
236Turn on/off scrollbar; resource B<scrollBar>. 281Turn on/off scrollbar; resource B<scrollBar>.
237 282
283=item B<-sr>|B<+sr>
284
285Put scrollbar on right/left; resource B<scrollBar_right>.
286
287=item B<-st>|B<+st>
288
289Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
290resource B<scrollBar_floating>.
291
238=item B<-si>|B<+si> 292=item B<-si>|B<+si>
239 293
240Turn on/off scroll-to-bottom on TTY output inhibit; resource 294Turn on/off scroll-to-bottom on TTY output inhibit; resource
241B<scrollTtyOutput> has opposite effect. 295B<scrollTtyOutput> has opposite effect.
242 296
248=item B<-sw>|B<+sw> 302=item B<-sw>|B<+sw>
249 303
250Turn on/off scrolling with the scrollback buffer as new lines appear. 304Turn on/off scrolling with the scrollback buffer as new lines appear.
251This only takes effect if B<-si> is also given; resource 305This only takes effect if B<-si> is also given; resource
252B<scrollWithBuffer>. 306B<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 307
263=item B<-ptab>|B<+ptab> 308=item B<-ptab>|B<+ptab>
264 309
265If enabled (default), "Horizontal Tab" characters are being stored as 310If enabled (default), "Horizontal Tab" characters are being stored as
266actual wide characters in the screen buffer, which makes it possible to 311actual wide characters in the screen buffer, which makes it possible to
295 340
296=item B<-bl> 341=item B<-bl>
297 342
298Compile I<frills>: Set MWM hints to request a borderless window, i.e. 343Compile 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 344if honoured by the WM, the rxvt-unicode window will not have window
300decorations; resource B<borderLess>. 345decorations; resource B<borderLess>. If the window manager does not
346support MWM hints (e.g. kwin), enables override-redirect mode.
301 347
302=item B<-override-redirect> 348=item B<-override-redirect>
303 349
304Compile I<frills>: Sets override-redirect on the window; resource 350Compile I<frills>: Sets override-redirect on the window; resource
305B<override-redirect>. 351B<override-redirect>.
313 359
314=item B<-lsp> I<number> 360=item B<-lsp> I<number>
315 361
316Compile I<frills>: Lines (pixel height) to insert between each row of 362Compile I<frills>: Lines (pixel height) to insert between each row of
317the display. Useful to work around font rendering problems; resource 363the display. Useful to work around font rendering problems; resource
318B<linespace>. 364B<lineSpace>.
319 365
320=item B<-tn> I<termname> 366=item B<-tn> I<termname>
321 367
322This option specifies the name of the terminal type to be set in the 368This option specifies the name of the terminal type to be set in the
323B<TERM> environment variable. This terminal type must exist in the 369B<TERM> environment variable. This terminal type must exist in the
377for more info. 423for more info.
378 424
379=item B<-tcw> 425=item B<-tcw>
380 426
381Change the meaning of triple-click selection with the left mouse 427Change the meaning of triple-click selection with the left mouse
428button. Only effective when the original (non-perl) selection code is
382button. Instead of selecting a full line it will extend the selection the 429in-use. Instead of selecting a full line it will extend the selection to
383end of the logical line only. resource B<tripleclickwords>. 430the end of the logical line only. resource B<tripleclickwords>.
384 431
385=item B<-insecure> 432=item B<-insecure>
386 433
387Enable "insecure" mode, which currently enables most of the escape 434Enable "insecure" mode, which currently enables most of the escape
388sequences that echo strings. See the resource B<insecure> for more 435sequences that echo strings. See the resource B<insecure> for more
409Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 456Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
410will not immediately destroy its window when the program executed within 457will not immediately destroy its window when the program executed within
411it exits. Instead, it will wait till it is being killed or closed by the 458it exits. Instead, it will wait till it is being killed or closed by the
412user; resource B<hold>. 459user; resource B<hold>.
413 460
461=item B<-cd> I<path>
462
463Sets the working directory for the shell (or the command specified via
464B<-e>). The I<path> must be an absolute path and it must exist for
465@@RXVT_NAME@@ to start; resource B<chdir>.
466
467=item B<-xrm> I<string>
468
469Works like the X Toolkit option of the same name, by adding the I<string>
470as if it were specified in a resource file. Resource values specified this
471way take precedence over all other resource specifications.
472
473Note that you need to use the I<same> syntax as in the .Xdefaults file,
474e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
475options can be specified as long-options on the commandline, so use
476of B<-xrm> is mostly limited to cases where you want to specify other
477resources (e.g. for input methods) or for compatibility with other
478programs.
479
414=item B<-keysym.>I<sym> I<string> 480=item B<-keysym.>I<sym> I<string>
415 481
416Remap a key symbol. See resource B<keysym>. 482Remap a key symbol. See resource B<keysym>.
417 483
418=item B<-embed> I<windowid> 484=item B<-embed> I<windowid>
419 485
420Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 486Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
421which enables applications to easily embed a terminal. 487which enables applications to easily embed a terminal.
422 488
423Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 489Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
424shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 490shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
425quite a bit, so don't expect it to keep some specific state. It's best to 491quite a bit, so don't expect it to keep some specific state. It's best to
428The window will not be destroyed when @@RXVT_NAME@@ exits. 494The window will not be destroyed when @@RXVT_NAME@@ exits.
429 495
430It might be useful to know that @@RXVT_NAME@@ will not close file 496It might be useful to know that @@RXVT_NAME@@ will not close file
431descriptors passed to it (except for stdin/out/err, of course), so you 497descriptors passed to it (except for stdin/out/err, of course), so you
432can use file descriptors to communicate with the programs within the 498can use file descriptors to communicate with the programs within the
433terminal. This works regardless of wether the C<-embed> option was used or 499terminal. This works regardless of whether the C<-embed> option was used or
434not. 500not.
435 501
436Here is a short Gtk2-perl snippet that illustrates how this option can be 502Here is a short Gtk2-perl snippet that illustrates how this option can be
437used (a longer example is in F<doc/embed>): 503used (a longer example is in F<doc/embed>):
438 504
443 }); 509 });
444 510
445=item B<-pty-fd> I<file descriptor> 511=item B<-pty-fd> I<file descriptor>
446 512
447Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 513Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
448pair but instead use the given filehandle as the tty master. This is 514pair but instead use the given file descriptor as the tty master. This is
449useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 515useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
450without having to run a program within it. 516without having to run a program within it.
451 517
452If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 518If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
453entries and will not tinker with pty/tty permissions - you have to do that 519entries and will not tinker with pty/tty permissions - you have to do that
454yourself if you want that. 520yourself if you want that.
455 521
456As an extremely special case, specifying C<-1> will completely suppress 522As an extremely special case, specifying C<-1> will completely suppress
457pty/tty operations. 523pty/tty operations, which is probably only useful in conjunction with some
524perl extension that manages the terminal.
458 525
459Here is a example in perl that illustrates how this option can be used (a 526Here is a example in perl that illustrates how this option can be used (a
460longer example is in F<doc/pty-fd>): 527longer example is in F<doc/pty-fd>):
461 528
462 use IO::Pty; 529 use IO::Pty;
476Comma-separated list of perl extension scripts to use (or not to use) in 543Comma-separated list of perl extension scripts to use (or not to use) in
477this terminal instance. See resource B<perl-ext> for details. 544this terminal instance. See resource B<perl-ext> for details.
478 545
479=back 546=back
480 547
481=head1 RESOURCES (available also as long-options) 548=head1 RESOURCES
482 549
483Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 550Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
484options) compiled into your version. 551options) compiled into your version. All resources are also available as
552long-options.
485 553
486You can set and change the resources using X11 tools like B<xrdb>. Many 554You can set and change the resources using X11 tools like B<xrdb>. Many
487distribution do also load settings from the B<~/.Xresources> file when X 555distribution do also load settings from the B<~/.Xresources> file when X
488starts. @@RXVT_NAME@@ will consult the following files/resources in order, 556starts. @@RXVT_NAME@@ will consult the following files/resources in order,
489with later settings overwriting earlier ones: 557with later settings overwriting earlier ones:
491 1. system-wide app-defaults file, either locale-dependent OR global 559 1. system-wide app-defaults file, either locale-dependent OR global
492 2. app-defaults file in $XAPPLRESDIR 560 2. app-defaults file in $XAPPLRESDIR
493 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 561 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
494 4. SCREEN_RESOURCES for the current screen 562 4. SCREEN_RESOURCES for the current screen
495 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 563 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
564 6. resources specified via -xrm on the commandline
496 565
497Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 566Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
498names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 567names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
499common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily 568common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
500configured, while the class name B<URxvt> allows resources unique to 569configured, while the class name B<URxvt> allows resources unique to
505check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 574check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
506extensions not documented here): 575extensions not documented here):
507 576
508=over 4 577=over 4
509 578
579=item B<depth:> I<bitdepth>
580
581Compile I<xft>: Attempt to find a visual with the given bit depth;
582option B<-depth>.
583
584=item B<buffered:> I<boolean>
585
586Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
587On some card/driver combination enabling it slightly decreases
588performance, on most it greatly helps it. The slowdown is small, so it
589should normally be enabled.
590
510=item B<geometry:> I<geom> 591=item B<geometry:> I<geom>
511 592
512Create the window with the specified X window geometry [default 80x24]; 593Create the window with the specified X window geometry [default 80x24];
513option B<-geometry>. 594option B<-geometry>.
514 595
550Use the specified colour to display underlined characters when the 631Use the specified colour to display underlined characters when the
551foreground colour is the default. 632foreground colour is the default.
552 633
553=item B<colorRV:> I<colour> 634=item B<colorRV:> I<colour>
554 635
555Use the specified colour as the background for reverse video 636Use the specified colour as the background for reverse video characters
556characters. 637when OPTION_HC is disabled (--disable-frills).
557 638
558=item B<underlineColor:> I<colour> 639=item B<underlineColor:> I<colour>
559 640
560If set, use the specified colour as the colour for the underline 641If set, use the specified colour as the colour for the underline
561itself. If unset, use the foreground colour. 642itself. If unset, use the foreground colour.
577option B<-rv>. B<False>: regular screen colours [default]; option 658option B<-rv>. B<False>: regular screen colours [default]; option
578B<+rv>. See note in B<COLORS AND GRAPHICS> section. 659B<+rv>. See note in B<COLORS AND GRAPHICS> section.
579 660
580=item B<jumpScroll:> I<boolean> 661=item B<jumpScroll:> I<boolean>
581 662
582B<True>: specify that jump scrolling should be used. When scrolling 663B<True>: specify that jump scrolling should be used. When receiving lots
583quickly, fewer screen updates are performed [default]; option B<-j>. 664of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
665has been read, resulting in fewer updates while still displaying every
666received line; option B<-j>.
667
584B<False>: specify that smooth scrolling should be used; option B<+j>. 668B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
669force a screen refresh on each new line it received; option B<+j>.
585 670
586=item B<inheritPixmap:> I<boolean> 671=item B<skipScroll:> I<boolean>
587 672
588B<True>: make the background inherit the parent windows' pixmap, giving 673B<True>: (the default) specify that skip scrolling should be used. When
589artificial transparency. B<False>: do not inherit the parent windows' 674receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
590pixmap. 675(around 60 times per second), resulting in far fewer updates. This can
676result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
677option B<-ss>.
678
679B<False>: specify that everything is to be displayed, even
680if the refresh is too fast for the human eye to read anything (or the
681monitor to display anything); option B<+ss>.
682
683=item B<transparent:> I<boolean>
684
685Turn on/off illusion of a transparent window background.
686
687B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
688future versions.
689
690I<Please address all transparency related issues to Sasha Vasko at
691sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
591 692
592=item B<fading:> I<number> 693=item B<fading:> I<number>
593 694
594Fade the text by the given percentage when focus is lost; option B<-fade>. 695Fade the text by the given percentage when focus is lost; option B<-fade>.
595 696
603Tint the transparent background pixmap with the given colour; option 704Tint the transparent background pixmap with the given colour; option
604B<-tint>. 705B<-tint>.
605 706
606=item B<shading:> I<number> 707=item B<shading:> I<number>
607 708
608Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 709Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
609image in addition to tinting it. 710in addition to tinting it; option B<-sh>.
711
712=item B<blendType:> I<string>
713
714Specify background blending type; option B<-blt>.
715
716=item B<blurRadius:> I<number>
717
718Apply Gaussian Blurr with the specified radius to the transparent
719background image; option B<-blr>.
610 720
611=item B<scrollColor:> I<colour> 721=item B<scrollColor:> I<colour>
612 722
613Use the specified colour for the scrollbar [default #B2B2B2]. 723Use the specified colour for the scrollbar [default #B2B2B2].
614 724
620=item B<borderColor:> I<colour> 730=item B<borderColor:> I<colour>
621 731
622The colour of the border around the text area and between the scrollbar 732The colour of the border around the text area and between the scrollbar
623and the text. 733and the text.
624 734
625=item B<backgroundPixmap:> I<file[;geom]> 735=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
626 736
627Use the specified XPM file (note the `.xpm' extension is optional) for 737Use the specified image file for the background and also
628the background and also optionally specify its scaling with a geometry 738optionally specify its scaling with a geometry string B<WxH+X+Y>,
629string B<WxH+X+Y>, in which B<"W" / "H"> specify the 739(default C<0x0+50+50>) in which B<"W" / "H"> specify the
630horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 740horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
631centre (percent). A scale of 0 displays the image with tiling. A scale 741centre (percent). A scale of 0 displays the image with tiling. A scale
632of 1 displays the image without any scaling. A scale of 2 to 9 742of 1 displays the image without any scaling. A scale of 2 to 9 specifies
633specifies an integer number of images in that direction. No image will 743an integer number of images in that direction. No image will be magnified
634be magnified beyond 10 times its original size. The maximum permitted 744beyond 10 times its original size. The maximum permitted scale is 1000.
635scale is 1000. [default 0x0+50+50] 745Additional operations can be specified after colon B<:op1:op2...>.
746Supported operations are:
747
748 tile force background image to be tiled and not scaled. Equivalent to 0x0
749 propscale will scale image keeping proportions
750 auto will scale image to match window size. Equivalent to 100x100
751 hscale will scale image horizontally to the window size
752 vscale will scale image vertically to the window size
753 scale will scale image to match window size
754 root will tile image as if it was a root window background, auto-adjusting
755 whenever terminal window moves
756
757If used in conjunction with B<-tr> option, the specified pixmap will be
758blended over transparency image using either alpha-blending, or any
759other blending type, specified with B<-blt "type"> option.
636 760
637=item B<path:> I<path> 761=item B<path:> I<path>
638 762
639Specify the colon-delimited search path for finding XPM files. 763Specify the colon-delimited search path for finding background image files.
640 764
641=item B<font:> I<fontlist> 765=item B<font:> I<fontlist>
642 766
643Select the fonts to be used. This is a comma separated list of font names 767Select the fonts to be used. This is a comma separated list of font names
644that are checked in order when trying to find glyphs for characters. The 768that are checked in order when trying to find glyphs for characters. The
701text font will being used for the given style. 825text font will being used for the given style.
702 826
703=item B<intensityStyles:> I<boolean> 827=item B<intensityStyles:> I<boolean>
704 828
705When font styles are not enabled, or this option is enabled (B<True>, 829When font styles are not enabled, or this option is enabled (B<True>,
706option B<-is>, the default), bold and italic font styles imply high 830option B<-is>, the default), bold/blink font styles imply high
707intensity foreground/backround colours. Disabling this option (B<False>, 831intensity foreground/background colours. Disabling this option (B<False>,
708option B<+is>) disables this behaviour, the high intensity colours are not 832option B<+is>) disables this behaviour, the high intensity colours are not
709reachable. 833reachable.
710
711=item B<selectstyle:> I<mode>
712
713Set mouse selection style to B<old> which is 2.20, B<oldword> which is
714xterm style with 2.20 old word selection, or anything else which gives
715xterm style selection.
716
717=item B<scrollstyle:> I<mode>
718
719Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
720the author's favourite.
721 834
722=item B<title:> I<string> 835=item B<title:> I<string>
723 836
724Set window title string, the default title is the command-line 837Set window title string, the default title is the command-line
725specified after the B<-e> option, if any, otherwise the application 838specified after the B<-e> option, if any, otherwise the application
734=item B<mapAlert:> I<boolean> 847=item B<mapAlert:> I<boolean>
735 848
736B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 849B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
737de-iconify (map) on receipt of a bell character [default]. 850de-iconify (map) on receipt of a bell character [default].
738 851
852=item B<urgentOnBell:> I<boolean>
853
854B<True>: set the urgency hint for the wm on receipt of a bell character.
855B<False>: do not set the urgency hint [default].
856
739=item B<visualBell:> I<boolean> 857=item B<visualBell:> I<boolean>
740 858
741B<True>: use visual bell on receipt of a bell character; option B<-vb>. 859B<True>: use visual bell on receipt of a bell character; option B<-vb>.
742B<False>: no visual bell [default]; option B<+vb>. 860B<False>: no visual bell [default]; option B<+vb>.
743 861
764Example: 882Example:
765 883
766 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 884 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
767 885
768This creates a new file in your home directory with the screen contents 886This creates a new file in your home directory with the screen contents
769everytime you hit C<Print>. 887every time you hit C<Print>.
888
889=item B<scrollstyle:> I<mode>
890
891Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
892the author's favourite.
770 893
771=item B<scrollBar:> I<boolean> 894=item B<scrollBar:> I<boolean>
772 895
773B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 896B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
774disable the scrollbar; option B<+sb>. 897disable the scrollbar; option B<+sb>.
796 919
797=item B<scrollWithBuffer:> I<boolean> 920=item B<scrollWithBuffer:> I<boolean>
798 921
799B<True>: scroll with scrollback buffer when tty receives new lines (and 922B<True>: scroll with scrollback buffer when tty receives new lines (and
800B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 923B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
801with scrollback buffer when tty recieves new lines; option B<+sw>. 924with scrollback buffer when tty receives new lines; option B<+sw>.
802 925
803=item B<scrollTtyKeypress:> I<boolean> 926=item B<scrollTtyKeypress:> I<boolean>
804 927
805B<True>: scroll to bottom when a non-special key is pressed. Special keys 928B<True>: scroll to bottom when a non-special key is pressed. Special keys
806are those which are intercepted by rxvt-unicode for special handling and 929are those which are intercepted by rxvt-unicode for special handling and
837=item B<termName:> I<termname> 960=item B<termName:> I<termname>
838 961
839Specifies the terminal type name to be set in the B<TERM> environment 962Specifies the terminal type name to be set in the B<TERM> environment
840variable; option B<-tn>. 963variable; option B<-tn>.
841 964
842=item B<linespace:> I<number> 965=item B<lineSpace:> I<number>
843 966
844Specifies number of lines (pixel height) to insert between each row of 967Specifies number of lines (pixel height) to insert between each row of
845the display [default 0]; option B<-lsp>. 968the display [default 0]; option B<-lsp>.
846 969
847=item B<meta8:> I<boolean> 970=item B<meta8:> I<boolean>
896pressed. If unset it will send the sequence traditionally associated 1019pressed. If unset it will send the sequence traditionally associated
897with the B<Execute> key. 1020with the B<Execute> key.
898 1021
899=item B<cutchars:> I<string> 1022=item B<cutchars:> I<string>
900 1023
901The characters used as delimiters for double-click word selection. The 1024The characters used as delimiters for double-click word selection
902built-in default: 1025(whitespace delimiting is added automatically if resource is given).
903 1026
1027When the perl selection extension is in use (the default if compiled
1028in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
1029characters will be created (if the resource exists, otherwise, no regex
1030will be created). In this mode, characters outside ISO-8859-1 can be used.
1031
1032When the selection extension is not used, only ISO-8859-1 characters can
1033be used. If not specified, the built-in default is used:
1034
904B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1035B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
905 1036
906=item B<preeditType:> I<style> 1037=item B<preeditType:> I<style>
907 1038
908B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1039B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
909 1040
963 1094
964Turn on/off secondary screen (default enabled). 1095Turn on/off secondary screen (default enabled).
965 1096
966=item B<secondaryScroll:> I<boolean> 1097=item B<secondaryScroll:> I<boolean>
967 1098
968Turn on/off secondary screen scroll (default enabled). If the this 1099Turn on/off secondary screen scroll (default enabled). If this
969option is enabled, scrolls on the secondary screen will change the 1100option is enabled, scrolls on the secondary screen will change the
970scrollback buffer and switching to/from the secondary screen will 1101scrollback buffer and, when secondaryScreen is off, switching
971instead scroll the screen up. 1102to/from the secondary screen will instead scroll the screen up.
972 1103
973=item B<hold>: I<boolean> 1104=item B<hold>: I<boolean>
974 1105
975Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1106Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
976will not immediately destroy its window when the program executed within 1107will not immediately destroy its window when the program executed within
977it exits. Instead, it will wait till it is being killed or closed by the 1108it exits. Instead, it will wait till it is being killed or closed by the
978user. 1109user.
1110
1111=item B<chdir>: I<path>
1112
1113Sets the working directory for the shell (or the command specified via
1114B<-e>). The I<path> must be an absolute path and it must exist for
1115@@RXVT_NAME@@ to start. If it isn't specified then the current working
1116directory will be used; option B<-cd>.
979 1117
980=item B<keysym.>I<sym>: I<string> 1118=item B<keysym.>I<sym>: I<string>
981 1119
982Compile I<frills>: Associate I<string> with keysym I<sym>. The 1120Compile I<frills>: Associate I<string> with keysym I<sym>. The
983intervening resource name B<keysym.> cannot be omitted. 1121intervening resource name B<keysym.> cannot be omitted.
997searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1135searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
998omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1136omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
999keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1137keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1000performed in an exact manner; however, the closest match is assured. 1138performed in an exact manner; however, the closest match is assured.
1001 1139
1002I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1140I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1003C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1141number), see RESOURCES in C<man 7 X> for futher details.
1004C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1005C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1006can start or end with whitespace.
1007
1008Please note that you need to double the C<\> in resource files, as
1009Xlib itself does it's own de-escaping (you can use C<\033> instead of
1010C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1011processing).
1012 1142
1013You can define a range of keysyms in one shot by providing a I<string> 1143You can define a range of keysyms in one shot by providing a I<string>
1014with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1144with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1015should be a character not used by the strings. 1145should be a character not used by the strings.
1016 1146
1017Its usage can be demonstrated by an example: 1147Its usage can be demonstrated by an example:
1018 1148
1019 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1149 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1083example, C<default,-selection> will use all the default extension except 1213example, C<default,-selection> will use all the default extension except
1084C<selection>. 1214C<selection>.
1085 1215
1086Extension names can also be followed by an argument in angle brackets 1216Extension names can also be followed by an argument in angle brackets
1087(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1217(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1088searchable scorllback to Alt/Meta-s). Mentioning the same extension 1218searchable scrollback to Alt/Meta-s). Mentioning the same extension
1089multiple times with different arguments will pass multiple arguments to 1219multiple times with different arguments will pass multiple arguments to
1090the extension. 1220the extension.
1091 1221
1092Each extension is looked up in the library directories, loaded if 1222Each extension is looked up in the library directories, loaded if
1093necessary, and bound to the current terminal instance. 1223necessary, and bound to the current terminal instance.
1129(default: C<M-s>). 1259(default: C<M-s>).
1130 1260
1131=item B<urlLauncher>: I<string> 1261=item B<urlLauncher>: I<string>
1132 1262
1133Specifies the program to be started with a URL argument. Used by the 1263Specifies the program to be started with a URL argument. Used by the
1134C<selection-popup> and C<mark-urls> perl extensions. 1264C<selection-popup> and C<matcher> perl extensions.
1135 1265
1136=item B<transient-for>: I<windowid> 1266=item B<transient-for>: I<windowid>
1137 1267
1138Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. 1268Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1139 1269
1140=item B<override-redirect>: I<boolean> 1270=item B<override-redirect>: I<boolean>
1141 1271
1142Compile I<frills>: Sets override-redirect for the terminal window, making 1272Compile I<frills>: Sets override-redirect for the terminal window, making
1143it almost invisible to window managers; option B<-override-redirect>. 1273it almost invisible to window managers; option B<-override-redirect>.
1274
1275=item B<iso14755_52:> I<boolean>
1276
1277Turn on/off ISO 14755 5.2 mode (default enabled).
1144 1278
1145=back 1279=back
1146 1280
1147=head1 THE SCROLLBAR 1281=head1 THE SCROLLBAR
1148 1282
1167application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1301application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1168(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1302(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1169up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1303up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1170respectively. 1304respectively.
1171 1305
1172=head1 TEXT SELECTION AND INSERTION 1306=head1 THE SELECTION: SELECTING AND PASTING TEXT
1173 1307
1174The behaviour of text selection and insertion mechanism is similar to 1308The behaviour of text selection and insertion/pasting mechanism is similar
1175I<xterm>(1). 1309to I<xterm>(1).
1176 1310
1177=over 4 1311=over 4
1178 1312
1179=item B<Selection>: 1313=item B<Selecting>:
1180 1314
1181Left click at the beginning of the region, drag to the end of the region 1315Left click at the beginning of the region, drag to the end of the region
1182and release; Right click to extend the marked region; Left double-click 1316and release; Right click to extend the marked region; Left double-click
1183to select a word; Left triple-click to select the entire logical line 1317to select a word; Left triple-click to select the entire logical line
1184(which can span multiple screen lines), unless modified by resource 1318(which can span multiple screen lines), unless modified by resource
1188(Compile: I<frills>) will create a rectangular selection instead of a 1322(Compile: I<frills>) will create a rectangular selection instead of a
1189normal one. In this mode, every selected row becomes its own line in the 1323normal one. In this mode, every selected row becomes its own line in the
1190selection, and trailing whitespace is visually underlined and removed from 1324selection, and trailing whitespace is visually underlined and removed from
1191the selection. 1325the selection.
1192 1326
1193=item B<Insertion>: 1327=item B<Pasting>:
1194 1328
1195Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1329Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1196an B<@@RXVT_NAME@@> window causes the current text selection to be 1330window causes the value of the PRIMARY selection (or CLIPBOARD with the
1197inserted as if it had been typed on the keyboard. 1331B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1332
1333Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1334inserted too.
1198 1335
1199=back 1336=back
1200 1337
1201=head1 CHANGING FONTS 1338=head1 CHANGING FONTS
1202 1339
1216 1353
1217=head1 ISO 14755 SUPPORT 1354=head1 ISO 14755 SUPPORT
1218 1355
1219ISO 14755 is a standard for entering and viewing unicode characters 1356ISO 14755 is a standard for entering and viewing unicode characters
1220and character codes using the keyboard. It consists of 4 parts. The 1357and character codes using the keyboard. It consists of 4 parts. The
1221first part is available rxvt-unicode has been compiled with 1358first part is available if rxvt-unicode has been compiled with
1222C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1359C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1223with C<--enable-iso14755>. 1360with C<--enable-iso14755>.
1224 1361
1225=over 4 1362=over 4
1226 1363
1246This mode lets you input characters representing the keycap symbols of 1383This mode lets you input characters representing the keycap symbols of
1247your keyboard, if representable in the current locale encoding. 1384your keyboard, if representable in the current locale encoding.
1248 1385
1249Start by pressing C<Control> and C<Shift> together, then releasing 1386Start by pressing C<Control> and C<Shift> together, then releasing
1250them. The next special key (cursor keys, home etc.) you enter will not 1387them. The next special key (cursor keys, home etc.) you enter will not
1251invoke it's usual function but instead will insert the corresponding 1388invoke its usual function but instead will insert the corresponding
1252keycap symbol. The symbol will only be entered when the key has been 1389keycap symbol. The symbol will only be entered when the key has been
1253released, otherwise pressing e.g. C<Shift> would enter the symbol for 1390released, otherwise pressing e.g. C<Shift> would enter the symbol for
1254C<ISO Level 2 Switch>, although your intention might have been to enter a 1391C<ISO Level 2 Switch>, although your intention might have been to enter a
1255reverse tab (Shift-Tab). 1392reverse tab (Shift-Tab).
1256 1393
1289=head1 COLORS AND GRAPHICS 1426=head1 COLORS AND GRAPHICS
1290 1427
1291In addition to the default foreground and background colours, 1428In addition to the default foreground and background colours,
1292B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1429B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1293high-intensity bold/blink versions of the same). Here is a list of the 1430high-intensity bold/blink versions of the same). Here is a list of the
1294colours with their B<rgb.txt> names. 1431colours with their names.
1295 1432
1296=begin table 1433=begin table
1297 1434
1298 B<color0> (black) = Black 1435 B<color0> (black) = Black
1299 B<color1> (red) = Red3 1436 B<color1> (red) = Red3
1319It is also possible to specify the colour values of B<foreground>, 1456It is also possible to specify the colour values of B<foreground>,
1320B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1457B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1321a number 0-15, as a convenient shorthand to reference the colour name of 1458a number 0-15, as a convenient shorthand to reference the colour name of
1322color0-color15. 1459color0-color15.
1323 1460
1461In addition to the colours defined above, @@RXVT_NAME@@ offers an
1462additional 72 colours. The first 64 of those (with indices 16 to 79)
1463consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
146416>), followed by 8 additional shades of gray (with indices 80 to 87).
1465
1466Together, all those colours implement the 88 colour xterm colours. Only
1467the first 16 can be changed using resources currently, the rest can only
1468be changed via command sequences ("escape codes").
1469
1324Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1470Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1325always swapping the foreground/background colours. This is in contrast to 1471always swapping the foreground/background colours. This is in contrast to
1326I<xterm>(1) where the colours are only swapped if they have not otherwise 1472I<xterm>(1) where the colours are only swapped if they have not otherwise
1327been specified. For example, 1473been specified. For example,
1328 1474
1333would yield White on Black, while on I<xterm>(1) it would yield Black 1479would yield White on Black, while on I<xterm>(1) it would yield Black
1334on White. 1480on White.
1335 1481
1336=back 1482=back
1337 1483
1484=head2 ALPHA CHANNEL SUPPORT
1485
1486If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1487their act together, rxvt-unicode will do it's own alpha channel management:
1488
1489You can prefix any color with an opaquenes percentage enclosed in
1490brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1491(0-100) that specifies the opacity of the color, where C<0> is completely
1492transparent and C<100> is completely opaque. For example, C<[50]red> is a
1493half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1494is the recommended format to specify transparency values, and works with
1495all ways to specify a colour.
1496
1497For complete control, rxvt-unicode also supports
1498C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1499specifications, where the additional C<aaaa> component specifies opacity
1500(alpha) values. The minimum value of C<0000> is completely transparent,
1501while C<ffff> is completely opaque). The two example colours from
1502earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1503C<rgba:0000/ff00/0000/f332>.
1504
1505You probably need to specify B<"-depth 32">, too, to force a visual with
1506alpha channels, and have the luck that your X-server uses ARGB pixel
1507layout, as X is far from just supporting ARGB visuals out of the box, and
1508rxvt-unicode just fudges around.
1509
1510For example, the following selects an almost completely transparent black
1511background, and an almost opaque pink foreground:
1512
1513 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1514
1515When not using a background image, then the interpretation of the
1516alpha channel is up to your compositing manager (most interpret it as
1517transparency of course).
1518
1519When using a background pixmap or pseudo-transparency, then the background
1520colour will always behave as if it were completely transparent (so the
1521background image shows instead), regardless of how it was specified, while
1522other colours will either be transparent as specified (the background
1523image will show through) on servers supporting the RENDER extension, or
1524fully opaque on servers not supporting the RENDER EXTENSION.
1525
1526Please note that due to bugs in Xft, specifying alpha values might result
1527in garbage being displayed when the X-server does not support the RENDER
1528extension.
1529
1338=head1 ENVIRONMENT 1530=head1 ENVIRONMENT
1339 1531
1340B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1532B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1341 1533
1342=over 4 1534=over 4
1343 1535
1344=item B<TERM> 1536=item B<TERM>
1345 1537
1346Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1538Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1347resources or on the commandline. 1539resources or on the command line.
1348 1540
1349=item B<COLORTERM> 1541=item B<COLORTERM>
1350 1542
1351Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1543Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1352compiled with XPM support, and optionally with the added extension 1544compiled with background image support, and optionally with the added
1353C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1545extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1546screen.
1354 1547
1355=item B<COLORFGBG> 1548=item B<COLORFGBG>
1356 1549
1357Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1550Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1358the colour code used as default foreground/text colour (or the string 1551the colour code used as default foreground/text colour (or the string
1359C<default> to indicate that the default-colour escape sequence is to be 1552C<default> to indicate that the default-colour escape sequence is to be
1360used), C<bg> is the colour code used as default background colour (or the 1553used), C<bg> is the colour code used as default background colour (or the
1361string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1554string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1362was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1555was compiled with background image support. Libraries like C<ncurses>
1363(and do) use this information to optimize screen output. 1556and C<slang> can (and do) use this information to optimize screen output.
1364 1557
1365=item B<WINDOWID> 1558=item B<WINDOWID>
1366 1559
1367Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1560Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1368window, which usually has subwindows for the scrollbar, the terminal 1561window, which usually has subwindows for the scrollbar, the terminal
1374C<--with-terminfo=PATH>. 1567C<--with-terminfo=PATH>.
1375 1568
1376=item B<DISPLAY> 1569=item B<DISPLAY>
1377 1570
1378Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1571Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1379display in it's child processes. 1572display in its child processes if C<-display> isn't used to override. It
1573defaults to C<:0> if it doesn't exist.
1380 1574
1381=item B<SHELL> 1575=item B<SHELL>
1382 1576
1383The shell to be used for command execution, defaults to C</bin/sh>. 1577The shell to be used for command execution, defaults to C</bin/sh>.
1384 1578
1426 1620
1427=item Project Coordinator 1621=item Project Coordinator
1428 1622
1429Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1623Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1430 1624
1431L<http://software.schmorp.de/#rxvt-unicode> 1625L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1432 1626
1433=back 1627=back
1434 1628
1435=head1 AUTHORS 1629=head1 AUTHORS
1436 1630
1458 1652
1459Project Coordinator (changes.txt 2.21a to 2.4.5) 1653Project Coordinator (changes.txt 2.21a to 2.4.5)
1460 1654
1461=item Geoff Wing L<< <gcw@pobox.com> >> 1655=item Geoff Wing L<< <gcw@pobox.com> >>
1462 1656
1463Rewrote screen display and text selection routines. Project Coordinator 1657Rewrote screen display and text selection routines.
1658
1464(changes.txt 2.4.6 - rxvt-unicode) 1659Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1465 1660
1466=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1661=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1467 1662
1468Forked rxvt-unicode, rewrote most of the display code and internal 1663Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1469character handling to store text in unicode, improve xterm 1664extension, random hacks, numerous bugfixes and extensions.
1470compatibility and apply numerous other bugfixes and extensions.
1471 1665
1472Project Coordinator (Changes 1.0 -) 1666Project Coordinator (Changes 1.0 -)
1473 1667
1668=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1669
1670Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1671
1474=back 1672=back
1475 1673

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines