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.213 by sf-exg, Sat Feb 4 21:47:06 2012 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<-blr> I<HxV>
156
157Apply Gaussian Blur with the specified radii to the transparent
158background. If a single number is specified, the vertical and
159horizontal radii are considered to be the same. Setting one of the
160radii to 1 and the other to a large number creates interesting effects
161on some backgrounds. The maximum radius value is 128. An horizontal or
162vertical radius of 0 disables blurring;
163resource I<blurRadius>.
164
165=item B<-icon> I<file>
166
167Compile I<pixbuf>: Use the specified image as application icon. This
168is used by many window managers, taskbars and pagers to represent the
169application window; resource I<iconFile>.
146 170
147=item B<-bg> I<colour> 171=item B<-bg> I<colour>
148 172
149Window background colour; resource B<background>. 173Window background colour; resource B<background>.
150 174
151=item B<-fg> I<colour> 175=item B<-fg> I<colour>
152 176
153Window foreground colour; resource B<foreground>. 177Window foreground colour; resource B<foreground>.
154 178
155=item B<-pixmap> I<file[;geom]> 179=item B<-pixmap> I<file[;oplist]>
156 180
157Compile I<XPM>: Specify XPM file for the background and also optionally 181Compile I<pixbuf>: Specify image file for the background and also
158specify its scaling with a geometry string. Note you may need to 182optionally specify a list of operations to modify it. Note you may need to
159add quotes to avoid special shell interpretation of the C<;> in the 183add quotes to avoid special shell interpretation of the C<;> in the
160command-line; resource B<backgroundPixmap>. 184command-line; for more details see resource B<backgroundPixmap>.
161 185
162=item B<-cr> I<colour> 186=item B<-cr> I<colour>
163 187
164The cursor colour; resource B<cursorColor>. 188The cursor colour; resource B<cursorColor>.
165 189
182that are checked in order when trying to find glyphs for characters. The 206that are checked in order when trying to find glyphs for characters. The
183first font defines the cell size for characters; other fonts might be 207first font defines the cell size for characters; other fonts might be
184smaller, but not (in general) larger. A (hopefully) reasonable default 208smaller, but not (in general) larger. A (hopefully) reasonable default
185font list is always appended to it. See resource B<font> for more details. 209font list is always appended to it. See resource B<font> for more details.
186 210
187In short, to specify an X11 core font, just specify it's name or prefix it 211In 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:>, 212with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
189e.g.: 213e.g.:
190 214
191 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 215 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
192 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 216 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
210italic> >> characters are to be printed. See resource B<boldItalicFont> 234italic> >> characters are to be printed. See resource B<boldItalicFont>
211for details. 235for details.
212 236
213=item B<-is>|B<+is> 237=item B<-is>|B<+is>
214 238
215Compile I<font-styles>: Bold/Italic font styles imply high intensity 239Compile I<font-styles>: Bold/Blink font styles imply high intensity
216foreground/background (default). See resource B<intensityStyles> for 240foreground/background (default). See resource B<intensityStyles> for
217details. 241details.
218 242
219=item B<-name> I<name> 243=item B<-name> I<name>
220 244
238 262
239=item B<-sb>|B<+sb> 263=item B<-sb>|B<+sb>
240 264
241Turn on/off scrollbar; resource B<scrollBar>. 265Turn on/off scrollbar; resource B<scrollBar>.
242 266
267=item B<-sr>|B<+sr>
268
269Put scrollbar on right/left; resource B<scrollBar_right>.
270
271=item B<-st>|B<+st>
272
273Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
274resource B<scrollBar_floating>.
275
243=item B<-si>|B<+si> 276=item B<-si>|B<+si>
244 277
245Turn on/off scroll-to-bottom on TTY output inhibit; resource 278Turn on/off scroll-to-bottom on TTY output inhibit; resource
246B<scrollTtyOutput> has opposite effect. 279B<scrollTtyOutput> has opposite effect.
247 280
253=item B<-sw>|B<+sw> 286=item B<-sw>|B<+sw>
254 287
255Turn on/off scrolling with the scrollback buffer as new lines appear. 288Turn on/off scrolling with the scrollback buffer as new lines appear.
256This only takes effect if B<-si> is also given; resource 289This only takes effect if B<-si> is also given; resource
257B<scrollWithBuffer>. 290B<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 291
268=item B<-ptab>|B<+ptab> 292=item B<-ptab>|B<+ptab>
269 293
270If enabled (default), "Horizontal Tab" characters are being stored as 294If enabled (default), "Horizontal Tab" characters are being stored as
271actual wide characters in the screen buffer, which makes it possible to 295actual wide characters in the screen buffer, which makes it possible to
275 299
276=item B<-bc>|B<+bc> 300=item B<-bc>|B<+bc>
277 301
278Blink the cursor; resource B<cursorBlink>. 302Blink the cursor; resource B<cursorBlink>.
279 303
304=item B<-uc>|B<+uc>
305
306Make the cursor underlined; resource B<cursorUnderline>.
307
280=item B<-iconic> 308=item B<-iconic>
281 309
282Start iconified, if the window manager supports that option. 310Start iconified, if the window manager supports that option.
283Alternative form is B<-ic>. 311Alternative form is B<-ic>.
284 312
300 328
301=item B<-bl> 329=item B<-bl>
302 330
303Compile I<frills>: Set MWM hints to request a borderless window, i.e. 331Compile 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 332if honoured by the WM, the rxvt-unicode window will not have window
305decorations; resource B<borderLess>. 333decorations; resource B<borderLess>. If the window manager does not
334support MWM hints (e.g. kwin), enables override-redirect mode.
306 335
307=item B<-override-redirect> 336=item B<-override-redirect>
308 337
309Compile I<frills>: Sets override-redirect on the window; resource 338Compile I<frills>: Sets override-redirect on the window; resource
310B<override-redirect>. 339B<override-redirect>.
318 347
319=item B<-lsp> I<number> 348=item B<-lsp> I<number>
320 349
321Compile I<frills>: Lines (pixel height) to insert between each row of 350Compile I<frills>: Lines (pixel height) to insert between each row of
322the display. Useful to work around font rendering problems; resource 351the display. Useful to work around font rendering problems; resource
323B<linespace>. 352B<lineSpace>.
353
354=item B<-letsp> I<number>
355
356Compile I<frills>: Amount to adjust the computed character width by
357to control overall letter spacing. Negative values will tighten up the
358letter spacing, positive values will space letters out more. Useful to
359work around odd font metrics; resource B<letterSpace>.
324 360
325=item B<-tn> I<termname> 361=item B<-tn> I<termname>
326 362
327This option specifies the name of the terminal type to be set in the 363This option specifies the name of the terminal type to be set in the
328B<TERM> environment variable. This terminal type must exist in the 364B<TERM> environment variable. This terminal type must exist in the
382for more info. 418for more info.
383 419
384=item B<-tcw> 420=item B<-tcw>
385 421
386Change the meaning of triple-click selection with the left mouse 422Change the meaning of triple-click selection with the left mouse
423button. Only effective when the original (non-perl) selection code is
387button. Instead of selecting a full line it will extend the selection the 424in-use. Instead of selecting a full line it will extend the selection to
388end of the logical line only. resource B<tripleclickwords>. 425the end of the logical line only. resource B<tripleclickwords>.
389 426
390=item B<-insecure> 427=item B<-insecure>
391 428
392Enable "insecure" mode, which currently enables most of the escape 429Enable "insecure" mode, which currently enables most of the escape
393sequences that echo strings. See the resource B<insecure> for more 430sequences that echo strings. See the resource B<insecure> for more
414Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 451Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
415will not immediately destroy its window when the program executed within 452will 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 453it exits. Instead, it will wait till it is being killed or closed by the
417user; resource B<hold>. 454user; resource B<hold>.
418 455
456=item B<-cd> I<path>
457
458Sets the working directory for the shell (or the command specified via
459B<-e>). The I<path> must be an absolute path and it must exist for
460@@RXVT_NAME@@ to start; resource B<chdir>.
461
462=item B<-xrm> I<string>
463
464Works like the X Toolkit option of the same name, by adding the I<string>
465as if it were specified in a resource file. Resource values specified this
466way take precedence over all other resource specifications.
467
468Note that you need to use the I<same> syntax as in the .Xdefaults file,
469e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
470options can be specified as long-options on the commandline, so use
471of B<-xrm> is mostly limited to cases where you want to specify other
472resources (e.g. for input methods) or for compatibility with other
473programs.
474
419=item B<-keysym.>I<sym> I<string> 475=item B<-keysym.>I<sym> I<string>
420 476
421Remap a key symbol. See resource B<keysym>. 477Remap a key symbol. See resource B<keysym>.
422 478
423=item B<-embed> I<windowid> 479=item B<-embed> I<windowid>
424 480
425Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 481Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
426which enables applications to easily embed a terminal. 482which enables applications to easily embed a terminal.
427 483
428Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 484Right 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 485shouldn'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 486quite 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. 489The window will not be destroyed when @@RXVT_NAME@@ exits.
434 490
435It might be useful to know that @@RXVT_NAME@@ will not close file 491It 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 492descriptors passed to it (except for stdin/out/err, of course), so you
437can use file descriptors to communicate with the programs within the 493can use file descriptors to communicate with the programs within the
438terminal. This works regardless of wether the C<-embed> option was used or 494terminal. This works regardless of whether the C<-embed> option was used or
439not. 495not.
440 496
441Here is a short Gtk2-perl snippet that illustrates how this option can be 497Here is a short Gtk2-perl snippet that illustrates how this option can be
442used (a longer example is in F<doc/embed>): 498used (a longer example is in F<doc/embed>):
443 499
448 }); 504 });
449 505
450=item B<-pty-fd> I<file descriptor> 506=item B<-pty-fd> I<file descriptor>
451 507
452Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 508Tells @@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 509pair 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 510useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
455without having to run a program within it. 511without having to run a program within it.
456 512
457If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 513If 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 514entries and will not tinker with pty/tty permissions - you have to do that
459yourself if you want that. 515yourself if you want that.
460 516
461As an extremely special case, specifying C<-1> will completely suppress 517As an extremely special case, specifying C<-1> will completely suppress
462pty/tty operations. 518pty/tty operations, which is probably only useful in conjunction with some
519perl extension that manages the terminal.
463 520
464Here is a example in perl that illustrates how this option can be used (a 521Here is a example in perl that illustrates how this option can be used (a
465longer example is in F<doc/pty-fd>): 522longer example is in F<doc/pty-fd>):
466 523
467 use IO::Pty; 524 use IO::Pty;
481Comma-separated list of perl extension scripts to use (or not to use) in 538Comma-separated list of perl extension scripts to use (or not to use) in
482this terminal instance. See resource B<perl-ext> for details. 539this terminal instance. See resource B<perl-ext> for details.
483 540
484=back 541=back
485 542
486=head1 RESOURCES (available also as long-options) 543=head1 RESOURCES
487 544
488Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 545Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
489options) compiled into your version. 546options) compiled into your version. All resources are also available as
547long-options.
490 548
491You can set and change the resources using X11 tools like B<xrdb>. Many 549You 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 550distribution do also load settings from the B<~/.Xresources> file when X
493starts. @@RXVT_NAME@@ will consult the following files/resources in order, 551starts. @@RXVT_NAME@@ will consult the following files/resources in order,
494with later settings overwriting earlier ones: 552with later settings overwriting earlier ones:
495 553
496 1. system-wide app-defaults file, either locale-dependent OR global
497 2. app-defaults file in $XAPPLRESDIR 554 1. app-defaults file in $XAPPLRESDIR
555 2. $HOME/.Xdefaults
498 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 556 3. RESOURCE_MANAGER property on root-window of screen 0
499 4. SCREEN_RESOURCES for the current screen 557 4. SCREEN_RESOURCES property on root-window of the current screen
500 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 558 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
559 6. resources specified via -xrm on the commandline
501 560
502Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 561Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
503names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 562names: 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 563common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
505configured, while the class name B<URxvt> allows resources unique to 564configured, while the class name B<URxvt> allows resources unique to
512 571
513=over 4 572=over 4
514 573
515=item B<depth:> I<bitdepth> 574=item B<depth:> I<bitdepth>
516 575
517Compile I<frills>: Attempt to find a visual with the given bit depth; 576Compile I<xft>: Attempt to find a visual with the given bit depth;
518option B<-depth>. 577option B<-depth>.
578
579=item B<buffered:> I<boolean>
580
581Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
582On some card/driver combination enabling it slightly decreases
583performance, on most it greatly helps it. The slowdown is small, so it
584should normally be enabled.
519 585
520=item B<geometry:> I<geom> 586=item B<geometry:> I<geom>
521 587
522Create the window with the specified X window geometry [default 80x24]; 588Create the window with the specified X window geometry [default 80x24];
523option B<-geometry>. 589option B<-geometry>.
537Use the specified colour for the colour value I<n>, where 0-7 603Use the specified colour for the colour value I<n>, where 0-7
538corresponds to low-intensity (normal) colours and 8-15 corresponds to 604corresponds to low-intensity (normal) colours and 8-15 corresponds to
539high-intensity (bold = bright foreground, blink = bright background) 605high-intensity (bold = bright foreground, blink = bright background)
540colours. The canonical names are as follows: 0=black, 1=red, 2=green, 606colours. 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 6073=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
542names used are listed in the B<COLORS AND GRAPHICS> section. 608names used are listed in the B<COLOURS AND GRAPHICS> section.
543 609
544Colours higher than 15 cannot be set using resources (yet), but can be 610Colours higher than 15 cannot be set using resources (yet), but can be
545changed using an escape command (see @@RXVT_NAME@@(7)). 611changed using an escape command (see @@RXVT_NAME@@(7)).
546 612
547Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 613Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
558=item B<colorUL:> I<colour> 624=item B<colorUL:> I<colour>
559 625
560Use the specified colour to display underlined characters when the 626Use the specified colour to display underlined characters when the
561foreground colour is the default. 627foreground colour is the default.
562 628
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> 629=item B<underlineColor:> I<colour>
569 630
570If set, use the specified colour as the colour for the underline 631If set, use the specified colour as the colour for the underline
571itself. If unset, use the foreground colour. 632itself. If unset, use the foreground colour.
633
634=item B<highlightColor:> I<colour>
635
636If set, use the specified colour as the background for highlighted
637characters. If unset, use reverse video.
638
639=item B<highlightTextColor:> I<colour>
640
641If set and highlightColor is set, use the specified colour as the
642foreground for highlighted characters.
572 643
573=item B<cursorColor:> I<colour> 644=item B<cursorColor:> I<colour>
574 645
575Use the specified colour for the cursor. The default is to use the 646Use the specified colour for the cursor. The default is to use the
576foreground colour; option B<-cr>. 647foreground colour; option B<-cr>.
583 654
584=item B<reverseVideo:> I<boolean> 655=item B<reverseVideo:> I<boolean>
585 656
586B<True>: simulate reverse video by foreground and background colours; 657B<True>: simulate reverse video by foreground and background colours;
587option B<-rv>. B<False>: regular screen colours [default]; option 658option B<-rv>. B<False>: regular screen colours [default]; option
588B<+rv>. See note in B<COLORS AND GRAPHICS> section. 659B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
589 660
590=item B<jumpScroll:> I<boolean> 661=item B<jumpScroll:> I<boolean>
591 662
592B<True>: specify that jump scrolling should be used. When scrolling 663B<True>: specify that jump scrolling should be used. When receiving lots
593quickly, 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
594B<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>.
595 670
596=item B<inheritPixmap:> I<boolean> 671=item B<skipScroll:> I<boolean>
597 672
598B<True>: make the background inherit the parent windows' pixmap, giving 673B<True>: (the default) specify that skip scrolling should be used. When
599artificial transparency. B<False>: do not inherit the parent windows' 674receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
600pixmap. 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 pseudo-transparency by using the root pixmap as background.
686
687B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
688future versions.
601 689
602=item B<fading:> I<number> 690=item B<fading:> I<number>
603 691
604Fade the text by the given percentage when focus is lost; option B<-fade>. 692Fade the text by the given percentage when focus is lost; option B<-fade>.
605 693
608Fade to this colour, when fading is used (see B<fading:>). The default 696Fade to this colour, when fading is used (see B<fading:>). The default
609colour is black; option B<-fadecolor>. 697colour is black; option B<-fadecolor>.
610 698
611=item B<tintColor:> I<colour> 699=item B<tintColor:> I<colour>
612 700
613Tint the transparent background pixmap with the given colour; option 701Tint the transparent background with the given colour. If the RENDER
614B<-tint>. 702extension is not available only black, red, green, yellow, blue,
703magenta, cyan and white tints can be performed server-side. Note that
704a black tint yields a completely black image while a white tint yields
705the image unchanged; option B<-tint>.
615 706
616=item B<shading:> I<number> 707=item B<shading:> I<number>
617 708
618Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 709Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
619image in addition to tinting it. 710A value of 100 means no shading; 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 blur with the specified radius to the transparent
719background; option B<-blr>.
720
721=item B<iconFile:> I<file>
722
723Set the application icon pixmap; option B<-icon>.
620 724
621=item B<scrollColor:> I<colour> 725=item B<scrollColor:> I<colour>
622 726
623Use the specified colour for the scrollbar [default #B2B2B2]. 727Use the specified colour for the scrollbar [default #B2B2B2].
624 728
630=item B<borderColor:> I<colour> 734=item B<borderColor:> I<colour>
631 735
632The colour of the border around the text area and between the scrollbar 736The colour of the border around the text area and between the scrollbar
633and the text. 737and the text.
634 738
635=item B<backgroundPixmap:> I<file[;geom]> 739=item B<backgroundPixmap:> I<file[;oplist]>
636 740
637Use the specified XPM file (note the `.xpm' extension is optional) for 741Use the specified image file for the background and also
638the background and also optionally specify its scaling with a geometry 742optionally specify a colon separated list of operations to modify it.
639string B<WxH+X+Y>, in which B<"W" / "H"> specify the 743Supported operations are:
640horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 744
641centre (percent). A scale of 0 displays the image with tiling. A scale 745=over 4
642of 1 displays the image without any scaling. A scale of 2 to 9 746
643specifies an integer number of images in that direction. No image will 747=item B<WxH+X+Y>
644be magnified beyond 10 times its original size. The maximum permitted 748
645scale is 1000. [default 0x0+50+50] 749sets scale and position. B<"W" / "H"> specify the horizontal/vertical
750scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
751scale of 0 disables scaling. The maximum permitted scale is 1000.
752
753=item B<op=tile>
754
755enables tiling
756
757=item B<op=keep-aspect>
758
759maintain the image aspect ratio when scaling
760
761=item B<op=root-align>
762
763use the position of the terminal window relative to the root window as
764the image offset, simulating a root window background
765
766=back
767
768The default scale and position setting is C<100x100+50+50>.
769Alternatively, a predefined set of templates can be used to achieve
770the most common setups:
771
772=over 4
773
774=item B<style=tiled>
775
776the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
777
778=item B<style=aspect-stretched>
779
780the image is scaled to fill the whole window maintaining the aspect
781ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
782
783=item B<style=stretched>
784
785the image is scaled to fill the whole window. Equivalent to 100x100
786
787=item B<style=centered>
788
789the image is centered with no scaling. Equivalent to 0x0+50+50
790
791=item B<style=root-tiled>
792
793the image is tiled with no scaling and using 'root' positioning.
794Equivalent to 0x0:op=tile:op=root-align
795
796=back
797
798If multiple templates are specified the last one wins. Note that a
799template overrides all the scale, position and operations settings.
800
801If used in conjunction with B<-tr> option, the specified pixmap will be
802blended over the transparent background using alpha-blending.
646 803
647=item B<path:> I<path> 804=item B<path:> I<path>
648 805
649Specify the colon-delimited search path for finding XPM files. 806Specify the colon-delimited search path for finding background image files.
650 807
651=item B<font:> I<fontlist> 808=item B<font:> I<fontlist>
652 809
653Select the fonts to be used. This is a comma separated list of font names 810Select 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 811that 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 834it is named first) and thus defines the character cell grid to be 9 pixels
678wide and 15 pixels high. 835wide and 15 pixels high.
679 836
680The second font is just used to add additional unicode characters not in 837The second font is just used to add additional unicode characters not in
681the base font, likewise the third, which is unfortunately non-bold, but 838the 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 839the bold version of the font does contain fewer characters, so this is a
683useful supplement. 840useful supplement.
684 841
685The third font is an Xft font with aliasing turned off, and the characters 842The 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 843are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
687contains other characters, but we are not interested in them. 844contains other characters, but we are not interested in them.
711text font will being used for the given style. 868text font will being used for the given style.
712 869
713=item B<intensityStyles:> I<boolean> 870=item B<intensityStyles:> I<boolean>
714 871
715When font styles are not enabled, or this option is enabled (B<True>, 872When font styles are not enabled, or this option is enabled (B<True>,
716option B<-is>, the default), bold and italic font styles imply high 873option B<-is>, the default), bold/blink font styles imply high
717intensity foreground/backround colours. Disabling this option (B<False>, 874intensity foreground/background colours. Disabling this option (B<False>,
718option B<+is>) disables this behaviour, the high intensity colours are not 875option B<+is>) disables this behaviour, the high intensity colours are not
719reachable. 876reachable.
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 877
732=item B<title:> I<string> 878=item B<title:> I<string>
733 879
734Set window title string, the default title is the command-line 880Set window title string, the default title is the command-line
735specified after the B<-e> option, if any, otherwise the application 881specified after the B<-e> option, if any, otherwise the application
744=item B<mapAlert:> I<boolean> 890=item B<mapAlert:> I<boolean>
745 891
746B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 892B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
747de-iconify (map) on receipt of a bell character [default]. 893de-iconify (map) on receipt of a bell character [default].
748 894
895=item B<urgentOnBell:> I<boolean>
896
897B<True>: set the urgency hint for the wm on receipt of a bell character.
898B<False>: do not set the urgency hint [default].
899
900@@RXVT_NAME@@ resets the urgency hint on every focus change.
901
749=item B<visualBell:> I<boolean> 902=item B<visualBell:> I<boolean>
750 903
751B<True>: use visual bell on receipt of a bell character; option B<-vb>. 904B<True>: use visual bell on receipt of a bell character; option B<-vb>.
752B<False>: no visual bell [default]; option B<+vb>. 905B<False>: no visual bell [default]; option B<+vb>.
753 906
774Example: 927Example:
775 928
776 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 929 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
777 930
778This creates a new file in your home directory with the screen contents 931This creates a new file in your home directory with the screen contents
779everytime you hit C<Print>. 932every time you hit C<Print>.
933
934=item B<scrollstyle:> I<mode>
935
936Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
937the author's favourite.
938
939=item B<thickness:> I<number>
940
941Set the scrollbar width in pixels.
780 942
781=item B<scrollBar:> I<boolean> 943=item B<scrollBar:> I<boolean>
782 944
783B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 945B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
784disable the scrollbar; option B<+sb>. 946disable the scrollbar; option B<+sb>.
804B<False>: do not scroll to bottom when tty receives output; option 966B<False>: do not scroll to bottom when tty receives output; option
805B<+si>. 967B<+si>.
806 968
807=item B<scrollWithBuffer:> I<boolean> 969=item B<scrollWithBuffer:> I<boolean>
808 970
809B<True>: scroll with scrollback buffer when tty receives new lines (and 971B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
810B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 972try to show the same lines) and B<scrollTtyOutput> is False; option
811with scrollback buffer when tty recieves new lines; option B<+sw>. 973B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
974new lines; option B<+sw>.
812 975
813=item B<scrollTtyKeypress:> I<boolean> 976=item B<scrollTtyKeypress:> I<boolean>
814 977
815B<True>: scroll to bottom when a non-special key is pressed. Special keys 978B<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 979are those which are intercepted by rxvt-unicode for special handling and
847=item B<termName:> I<termname> 1010=item B<termName:> I<termname>
848 1011
849Specifies the terminal type name to be set in the B<TERM> environment 1012Specifies the terminal type name to be set in the B<TERM> environment
850variable; option B<-tn>. 1013variable; option B<-tn>.
851 1014
852=item B<linespace:> I<number> 1015=item B<lineSpace:> I<number>
853 1016
854Specifies number of lines (pixel height) to insert between each row of 1017Specifies number of lines (pixel height) to insert between each row of
855the display [default 0]; option B<-lsp>. 1018the display [default 0]; option B<-lsp>.
856 1019
857=item B<meta8:> I<boolean> 1020=item B<meta8:> I<boolean>
871 1034
872=item B<cursorBlink:> I<boolean> 1035=item B<cursorBlink:> I<boolean>
873 1036
874B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1037B<True>: blink the cursor. B<False>: do not blink the cursor [default];
875option B<-bc>. 1038option B<-bc>.
1039
1040=item B<cursorUnderline:> I<boolean>
1041
1042B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1043option B<-uc>.
876 1044
877=item B<pointerBlank:> I<boolean> 1045=item B<pointerBlank:> I<boolean>
878 1046
879B<True>: blank the pointer when a key is pressed or after a set number 1047B<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 1048of seconds of inactivity. B<False>: the pointer is always visible
894large number (e.g. C<987654321>) to effectively disable the timeout. 1062large number (e.g. C<987654321>) to effectively disable the timeout.
895 1063
896=item B<backspacekey:> I<string> 1064=item B<backspacekey:> I<string>
897 1065
898The string to send when the backspace key is pressed. If set to B<DEC> 1066The 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> 1067or 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 1068(code 8) - which can be reversed with the appropriate DEC private mode
901escape sequence. 1069escape sequence.
902 1070
903=item B<deletekey:> I<string> 1071=item B<deletekey:> I<string>
904 1072
909=item B<cutchars:> I<string> 1077=item B<cutchars:> I<string>
910 1078
911The characters used as delimiters for double-click word selection 1079The characters used as delimiters for double-click word selection
912(whitespace delimiting is added automatically if resource is given). 1080(whitespace delimiting is added automatically if resource is given).
913 1081
914When the selection extension is in use (the default if compiled in, see 1082When the perl selection extension is in use (the default if compiled
915the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters 1083in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
916will be created (if the resource exists, otherwise, no regex will be 1084characters will be created (if the resource exists, otherwise, no regex
917created). In this mode, characters outside ISO-8859-1 can be used. 1085will be created). In this mode, characters outside ISO-8859-1 can be used.
918 1086
919When the selection extension is not used, only ISO-8859-1 characters can 1087When the selection extension is not used, only ISO-8859-1 characters can
920be used. If not specified, the built-in default is used: 1088be used. If not specified, the built-in default is used:
921 1089
922B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1090B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
923 1091
924=item B<preeditType:> I<style> 1092=item B<preeditType:> I<style>
925 1093
926B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1094B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
927 1095
981 1149
982Turn on/off secondary screen (default enabled). 1150Turn on/off secondary screen (default enabled).
983 1151
984=item B<secondaryScroll:> I<boolean> 1152=item B<secondaryScroll:> I<boolean>
985 1153
986Turn on/off secondary screen scroll (default enabled). If the this 1154Turn on/off secondary screen scroll (default enabled). If this
987option is enabled, scrolls on the secondary screen will change the 1155option is enabled, scrolls on the secondary screen will change the
988scrollback buffer and switching to/from the secondary screen will 1156scrollback buffer and, when secondaryScreen is off, switching
989instead scroll the screen up. 1157to/from the secondary screen will instead scroll the screen up.
990 1158
991=item B<hold>: I<boolean> 1159=item B<hold>: I<boolean>
992 1160
993Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1161Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
994will not immediately destroy its window when the program executed within 1162will 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 1163it exits. Instead, it will wait till it is being killed or closed by the
996user. 1164user.
1165
1166=item B<chdir>: I<path>
1167
1168Sets the working directory for the shell (or the command specified via
1169B<-e>). The I<path> must be an absolute path and it must exist for
1170@@RXVT_NAME@@ to start. If it isn't specified then the current working
1171directory will be used; option B<-cd>.
997 1172
998=item B<keysym.>I<sym>: I<string> 1173=item B<keysym.>I<sym>: I<string>
999 1174
1000Compile I<frills>: Associate I<string> with keysym I<sym>. The 1175Compile I<frills>: Associate I<string> with keysym I<sym>. The
1001intervening resource name B<keysym.> cannot be omitted. 1176intervening resource name B<keysym.> cannot be omitted.
1015searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1190searching 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 1191omitting 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 1192keysym 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. 1193performed in an exact manner; however, the closest match is assured.
1019 1194
1020I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1195I<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, 1196number), 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 1197
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
1031You can define a range of keysyms in one shot by providing a I<string> 1198You can define a range of keysyms in one shot by
1199loading the C<keysym-list> perl extension and providing a I<string>
1032with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1200with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1033should be a character not used by the strings. 1201should be a character not used by the strings.
1034 1202
1035Its usage can be demonstrated by an example: 1203Its usage can be demonstrated by an example:
1036 1204
1037 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1205 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1038 1206
1039The above line is equivalent to the following three lines: 1207The above line is equivalent to the following three lines:
1040 1208
1041 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1209 URxvt.keysym.Meta-Control-0x61: \033<a>
1042 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1210 URxvt.keysym.Meta-Control-0x62: \033<b>
1043 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1211 URxvt.keysym.Meta-Control-0x63: \033<c>
1044 1212
1045If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1213If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1046is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1214is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1047example the following means "change the current locale to C<zh_CN.GBK> 1215example the following means "change the current locale to C<zh_CN.GBK>
1048when Control-Meta-c is being pressed": 1216when Control-Meta-c is being pressed":
1049 1217
1050 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1218 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1051 1219
1052If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1220If 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) 1221is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1054manpage. For example, the F<selection> extension (activated via 1222manpage. For example, the F<selection> extension (activated via
1055C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1223C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1056 1224
1057 URxvt.keysym.M-C-c: perl:selection:rot13 1225 URxvt.keysym.M-C-c: perl:selection:rot13
1058 1226
1059Due the the large number of modifier combinations, a defined key mapping 1227Due 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 1228will 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 1229no other key mappings with those and more bits are being defined. That
1062means that defining a key map for C<a> will automatically provide 1230means 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 1231definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1064mappings themselves. 1232mappings themselves.
1065 1233
1101example, C<default,-selection> will use all the default extension except 1269example, C<default,-selection> will use all the default extension except
1102C<selection>. 1270C<selection>.
1103 1271
1104Extension names can also be followed by an argument in angle brackets 1272Extension names can also be followed by an argument in angle brackets
1105(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1273(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1106searchable scorllback to Alt/Meta-s). Mentioning the same extension 1274searchable scrollback to Alt/Meta-s). Mentioning the same extension
1107multiple times with different arguments will pass multiple arguments to 1275multiple times with different arguments will pass multiple arguments to
1108the extension. 1276the extension.
1109 1277
1110Each extension is looked up in the library directories, loaded if 1278Each extension is looked up in the library directories, loaded if
1111necessary, and bound to the current terminal instance. 1279necessary, and bound to the current terminal instance.
1116all instances, while B<perl-ext> is used for specific instances. 1284all instances, while B<perl-ext> is used for specific instances.
1117 1285
1118=item B<perl-eval>: I<string> 1286=item B<perl-eval>: I<string>
1119 1287
1120Perl code to be evaluated when all extensions have been registered. See 1288Perl code to be evaluated when all extensions have been registered. See
1121the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1289the @@RXVT_NAME@@perl(3) manpage.
1122will be ignored when running setuid/setgid.
1123 1290
1124=item B<perl-lib>: I<path> 1291=item B<perl-lib>: I<path>
1125 1292
1126Colon-separated list of additional directories that hold extension 1293Colon-separated list of additional directories that hold extension
1127scripts. When looking for extensions specified by the C<perl> resource, 1294scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1128@@RXVT_NAME@@ will first look in these directories and then in 1295look in these directories, then in $HOME/.urxvt/ext and lastly in
1129F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1296F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1130will be ignored when running setuid/setgid.
1131 1297
1132See the @@RXVT_NAME@@perl(3) manpage. 1298See the @@RXVT_NAME@@perl(3) manpage.
1133 1299
1134=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1300=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1135 1301
1147(default: C<M-s>). 1313(default: C<M-s>).
1148 1314
1149=item B<urlLauncher>: I<string> 1315=item B<urlLauncher>: I<string>
1150 1316
1151Specifies the program to be started with a URL argument. Used by the 1317Specifies the program to be started with a URL argument. Used by the
1152C<selection-popup> and C<mark-urls> perl extensions. 1318C<selection-popup> and C<matcher> perl extensions.
1153 1319
1154=item B<transient-for>: I<windowid> 1320=item B<transient-for>: I<windowid>
1155 1321
1156Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. 1322Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1157 1323
1158=item B<override-redirect>: I<boolean> 1324=item B<override-redirect>: I<boolean>
1159 1325
1160Compile I<frills>: Sets override-redirect for the terminal window, making 1326Compile I<frills>: Sets override-redirect for the terminal window, making
1161it almost invisible to window managers; option B<-override-redirect>. 1327it almost invisible to window managers; option B<-override-redirect>.
1328
1329=item B<iso14755:> I<boolean>
1330
1331Turn on/off ISO 14755 (default enabled).
1332
1333=item B<iso14755_52:> I<boolean>
1334
1335Turn on/off ISO 14755 5.2 mode (default enabled).
1162 1336
1163=back 1337=back
1164 1338
1165=head1 THE SCROLLBAR 1339=head1 THE SCROLLBAR
1166 1340
1185application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1359application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1186(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1360(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), 1361up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1188respectively. 1362respectively.
1189 1363
1190=head1 TEXT SELECTION AND INSERTION 1364=head1 THE SELECTION: SELECTING AND PASTING TEXT
1191 1365
1192The behaviour of text selection and insertion mechanism is similar to 1366The behaviour of text selection and insertion/pasting mechanism is similar
1193I<xterm>(1). 1367to I<xterm>(1).
1194 1368
1195=over 4 1369=over 4
1196 1370
1197=item B<Selection>: 1371=item B<Selecting>:
1198 1372
1199Left click at the beginning of the region, drag to the end of the region 1373Left 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 1374and release; Right click to extend the marked region; Left double-click
1201to select a word; Left triple-click to select the entire logical line 1375to select a word; Left triple-click to select the entire logical line
1202(which can span multiple screen lines), unless modified by resource 1376(which can span multiple screen lines), unless modified by resource
1206(Compile: I<frills>) will create a rectangular selection instead of a 1380(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 1381normal one. In this mode, every selected row becomes its own line in the
1208selection, and trailing whitespace is visually underlined and removed from 1382selection, and trailing whitespace is visually underlined and removed from
1209the selection. 1383the selection.
1210 1384
1211=item B<Insertion>: 1385=item B<Pasting>:
1212 1386
1213Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> 1387Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1214window causes the value of the PRIMARY selection (or CLIPBOARD with the 1388window 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. 1389B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1216 1390
1217Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1391Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1218inserted too. 1392inserted too.
1219 1393
1220=back 1394=back
1237 1411
1238=head1 ISO 14755 SUPPORT 1412=head1 ISO 14755 SUPPORT
1239 1413
1240ISO 14755 is a standard for entering and viewing unicode characters 1414ISO 14755 is a standard for entering and viewing unicode characters
1241and character codes using the keyboard. It consists of 4 parts. The 1415and character codes using the keyboard. It consists of 4 parts. The
1242first part is available rxvt-unicode has been compiled with 1416first part is available if rxvt-unicode has been compiled with
1243C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1417C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1244with C<--enable-iso14755>. 1418with C<--enable-iso14755>.
1245 1419
1246=over 4 1420=over 4
1247 1421
1267This mode lets you input characters representing the keycap symbols of 1441This mode lets you input characters representing the keycap symbols of
1268your keyboard, if representable in the current locale encoding. 1442your keyboard, if representable in the current locale encoding.
1269 1443
1270Start by pressing C<Control> and C<Shift> together, then releasing 1444Start by pressing C<Control> and C<Shift> together, then releasing
1271them. The next special key (cursor keys, home etc.) you enter will not 1445them. The next special key (cursor keys, home etc.) you enter will not
1272invoke it's usual function but instead will insert the corresponding 1446invoke its usual function but instead will insert the corresponding
1273keycap symbol. The symbol will only be entered when the key has been 1447keycap symbol. The symbol will only be entered when the key has been
1274released, otherwise pressing e.g. C<Shift> would enter the symbol for 1448released, 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 1449C<ISO Level 2 Switch>, although your intention might have been to enter a
1276reverse tab (Shift-Tab). 1450reverse tab (Shift-Tab).
1277 1451
1305B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1479B<@@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 1480it 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 1481allow 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. 1482on some systems or setgid to root or to some other group on others.
1309 1483
1310=head1 COLORS AND GRAPHICS 1484=head1 COLOURS AND GRAPHICS
1311 1485
1312In addition to the default foreground and background colours, 1486In addition to the default foreground and background colours,
1313B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1487B<@@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 1488high-intensity (potentially bold/blink) versions of the same, and 72 (or
1315colours with their names. 1489240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1490cube plus a 8 (24) colour greyscale ramp.
1491
1492Here is a list of the ANSI colours with their names.
1316 1493
1317=begin table 1494=begin table
1318 1495
1319 B<color0> (black) = Black 1496 B<color0> (black) = Black
1320 B<color1> (red) = Red3 1497 B<color1> (red) = Red3
1340It is also possible to specify the colour values of B<foreground>, 1517It is also possible to specify the colour values of B<foreground>,
1341B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1518B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1342a number 0-15, as a convenient shorthand to reference the colour name of 1519a number 0-15, as a convenient shorthand to reference the colour name of
1343color0-color15. 1520color0-color15.
1344 1521
1345If Xft support has been compiled in and as long as Xft/Xrender don't get 1522The following text gives values for the standard 88 colour mode (and
1346their act together, rxvt-unicode will support C<#ARGB>, C<#AARRGGBB> 1523values for the 256 colour mode in parentheses).
1347and C<#AAAARRRRGGGGBBBB> colour specifications, in addition to the ones 1524
1348provided by X, where the additional A component specifies alpha (opacity) 1525The RGB cube uses indices 16..79 (16..231) using the following formulas:
1349values (0 is completely transparent and the maximum is opaque). You 1526
1350probably need to specify B<"-depth 32">, too, as X is far from just 1527 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1351supporting ARGB visuals out of the box. 1528 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1529
1530The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1531steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1532the RGB cube.
1533
1534Together, all those colours implement the 88 (256) colour xterm
1535colours. Only the first 16 can be changed using resources currently, the
1536rest can only be changed via command sequences ("escape codes").
1537
1538Applications are advised to use terminfo or command sequences to discover
1539number and RGB values of all colours (yes, you can query this...).
1352 1540
1353Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1541Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1354always swapping the foreground/background colours. This is in contrast to 1542always swapping the foreground/background colours. This is in contrast to
1355I<xterm>(1) where the colours are only swapped if they have not otherwise 1543I<xterm>(1) where the colours are only swapped if they have not otherwise
1356been specified. For example, 1544been specified. For example,
1357 1545
1546 @@RXVT_NAME@@ -fg Black -bg White -rv
1547
1548would yield White on Black, while on I<xterm>(1) it would yield Black on
1549White.
1550
1551=head2 ALPHA CHANNEL SUPPORT
1552
1553If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1554their act together, rxvt-unicode will do its own alpha channel management:
1555
1556You can prefix any colour with an opaqueness percentage enclosed in
1557brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1558(0-100) that specifies the opacity of the colour, where C<0> is completely
1559transparent and C<100> is completely opaque. For example, C<[50]red> is a
1560half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1561is the recommended format to specify transparency values, and works with
1562all ways to specify a colour.
1563
1564For complete control, rxvt-unicode also supports
1565C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1566specifications, where the additional C<aaaa> component specifies opacity
1567(alpha) values. The minimum value of C<0000> is completely transparent,
1568while C<ffff> is completely opaque). The two example colours from
1569earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1570C<rgba:0000/ff00/0000/f332>.
1571
1572You probably need to specify B<"-depth 32">, too, to force a visual with
1573alpha channels, and have the luck that your X-server uses ARGB pixel
1574layout, as X is far from just supporting ARGB visuals out of the box, and
1575rxvt-unicode just fudges around.
1576
1577For example, the following selects an almost completely transparent black
1578background, and an almost opaque pink foreground:
1579
1580 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1581
1582When not using a background image, then the interpretation of the
1583alpha channel is up to your compositing manager (most interpret it as
1584transparency of course).
1585
1586When using a background pixmap or pseudo-transparency, then the background
1587colour will always behave as if it were completely transparent (so the
1588background image shows instead), regardless of how it was specified, while
1589other colours will either be transparent as specified (the background
1590image will show through) on servers supporting the RENDER extension, or
1591fully opaque on servers not supporting the RENDER EXTENSION.
1592
1593Please note that due to bugs in Xft, specifying alpha values might result
1594in garbage being displayed when the X-server does not support the RENDER
1595extension.
1596
1597=head1 ENVIRONMENT
1598
1599B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1600
1358=over 4 1601=over 4
1359 1602
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> 1603=item B<TERM>
1374 1604
1375Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1605Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1376resources or on the commandline. 1606resources or on the command line.
1377 1607
1378=item B<COLORTERM> 1608=item B<COLORTERM>
1379 1609
1380Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1610Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1381compiled with XPM support, and optionally with the added extension 1611compiled with background image support, and optionally with the added
1382C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1612extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1613screen.
1383 1614
1384=item B<COLORFGBG> 1615=item B<COLORFGBG>
1385 1616
1386Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1617Set 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 1618the colour code used as default foreground/text colour (or the string
1388C<default> to indicate that the default-colour escape sequence is to be 1619C<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 1620used), 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@@ 1621string 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 1622was compiled with background image support. Libraries like C<ncurses>
1392(and do) use this information to optimize screen output. 1623and C<slang> can (and do) use this information to optimize screen output.
1393 1624
1394=item B<WINDOWID> 1625=item B<WINDOWID>
1395 1626
1396Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1627Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1397window, which usually has subwindows for the scrollbar, the terminal 1628window, which usually has subwindows for the scrollbar, the terminal
1403C<--with-terminfo=PATH>. 1634C<--with-terminfo=PATH>.
1404 1635
1405=item B<DISPLAY> 1636=item B<DISPLAY>
1406 1637
1407Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1638Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1408display in it's child processes. 1639display in its child processes if C<-display> isn't used to override. It
1640defaults to C<:0> if it doesn't exist.
1409 1641
1410=item B<SHELL> 1642=item B<SHELL>
1411 1643
1412The shell to be used for command execution, defaults to C</bin/sh>. 1644The shell to be used for command execution, defaults to C</bin/sh>.
1413 1645
1414=item B<RXVT_SOCKET> 1646=item B<RXVT_SOCKET>
1415 1647
1416The unix domain socket path used by @@RXVT_NAME@@c(1) and 1648The unix domain socket path used by @@RXVT_NAME@@c(1) and
1417@@RXVT_NAME@@d(1). 1649@@RXVT_NAME@@d(1).
1418 1650
1419Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1651Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1420 1652
1421=item B<HOME> 1653=item B<HOME>
1422 1654
1423Used to locate the default directory for the unix domain socket for 1655Used to locate the default directory for the unix domain socket for
1424daemon communications and to locate various resource files (such as 1656daemon communications and to locate various resource files (such as
1425C<.Xdefaults>) 1657C<.Xdefaults>)
1426 1658
1427=item B<XAPPLRESDIR> 1659=item B<XAPPLRESDIR>
1428 1660
1429Directory where various X resource files are being located. 1661Directory where application-specific X resource files are located.
1430 1662
1431=item B<XENVIRONMENT> 1663=item B<XENVIRONMENT>
1432 1664
1433If set and accessible, gives the name of a X resource file to be loaded by 1665If set and accessible, gives the name of a X resource file to be loaded by
1434@@RXVT_NAME@@. 1666@@RXVT_NAME@@.
1439 1671
1440=over 4 1672=over 4
1441 1673
1442=item B</usr/lib/X11/rgb.txt> 1674=item B</usr/lib/X11/rgb.txt>
1443 1675
1444Color names. 1676Colour names.
1445 1677
1446=back 1678=back
1447 1679
1448=head1 SEE ALSO 1680=head1 SEE ALSO
1449 1681
1455 1687
1456=item Project Coordinator 1688=item Project Coordinator
1457 1689
1458Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1690Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1459 1691
1460L<http://software.schmorp.de/#rxvt-unicode> 1692L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1461 1693
1462=back 1694=back
1463 1695
1464=head1 AUTHORS 1696=head1 AUTHORS
1465 1697
1488Project Coordinator (changes.txt 2.21a to 2.4.5) 1720Project Coordinator (changes.txt 2.21a to 2.4.5)
1489 1721
1490=item Geoff Wing L<< <gcw@pobox.com> >> 1722=item Geoff Wing L<< <gcw@pobox.com> >>
1491 1723
1492Rewrote screen display and text selection routines. 1724Rewrote screen display and text selection routines.
1493 1725
1494Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1726Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1495 1727
1496=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1728=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1497 1729
1498Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1730Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1500 1732
1501Project Coordinator (Changes 1.0 -) 1733Project Coordinator (Changes 1.0 -)
1502 1734
1503=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1735=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1504 1736
1505Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1737pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1506 1738
1507=back 1739=back
1508 1740

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines