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.90 by root, Mon Jan 9 01:36:56 2006 UTC vs.
Revision 1.232 by root, Sun May 18 18:19:10 2014 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines