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.104 by root, Wed Jan 25 13:24:45 2006 UTC vs.
Revision 1.215 by sf-exg, Sun May 20 16:34:42 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.
100
101=item B<-depth> I<bitdepth>
102
103Compile I<xft>: Attempt to find a visual with the given bit depth;
104resource B<depth>.
105
106[Please note that many X servers (and libXft) are buggy with
107respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out]
97 110
98=item B<-geometry> I<geom> 111=item B<-geometry> I<geom>
99 112
100Window geometry (B<-g> still respected); resource B<geometry>. 113Window geometry (B<-g> still respected); resource B<geometry>.
101 114
103 116
104Turn on/off simulated reverse video; resource B<reverseVideo>. 117Turn on/off simulated reverse video; resource B<reverseVideo>.
105 118
106=item B<-j>|B<+j> 119=item B<-j>|B<+j>
107 120
108Turn on/off jump scrolling; resource B<jumpScroll>. 121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109 122
110=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 123=item B<-ss>|B<+ss>
111 124
112Turn on/off inheriting parent window's pixmap. Alternative form is 125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
113B<-tr>; resource B<inheritPixmap>. 126
127=item B<-tr>|B<+tr>
128
129Turn on/off 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.
114 133
115=item B<-fade> I<number> 134=item B<-fade> I<number>
116 135
117Fade 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
118fade a little only, 100 completely replaces all colours by the fade 137fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>. 138colour; resource B<fading>.
120 139
121=item B<-fadecolor> I<colour> 140=item B<-fadecolor> I<colour>
122 141
123Fade 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
124is black. resource B<fadeColor>. 143is opaque black. resource B<fadeColor>.
125 144
126=item B<-tint> I<colour> 145=item B<-tint> I<colour>
127 146
128Tint the transparent background pixmap with the given colour when 147Tint the transparent background with the given colour;
129transparency is enabled with B<-tr> or B<-ip>. This only works for 148resource I<tintColor>.
130non-tiled backgrounds, currently. See also the B<-sh> option that can be
131used to brighten or darken the image in addition to tinting it; resource
132I<tintColor>. Example:
133 149
134 @@RXVT_NAME@@ -tr -tint blue -sh 40 150=item B<-sh> I<number>
135 151
136=item B<-sh>
137
138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 152Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
139background image in addition to tinting it (i.e. B<-tint> must be 153A value of 100 means no shading; resource I<shading>.
140specified, 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>.
141 170
142=item B<-bg> I<colour> 171=item B<-bg> I<colour>
143 172
144Window background colour; resource B<background>. 173Window background colour; resource B<background>.
145 174
146=item B<-fg> I<colour> 175=item B<-fg> I<colour>
147 176
148Window foreground colour; resource B<foreground>. 177Window foreground colour; resource B<foreground>.
149 178
150=item B<-pixmap> I<file[;geom]> 179=item B<-pixmap> I<file[;oplist]>
151 180
152Compile I<XPM>: Specify XPM file for the background and also optionally 181Compile I<pixbuf>: Specify image file for the background and also
153specify 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
154add quotes to avoid special shell interpretation of the C<;> in the 183add quotes to avoid special shell interpretation of the C<;> in the
155command-line; resource B<backgroundPixmap>. 184command-line; for more details see resource B<backgroundPixmap>.
156 185
157=item B<-cr> I<colour> 186=item B<-cr> I<colour>
158 187
159The cursor colour; resource B<cursorColor>. 188The cursor colour; resource B<cursorColor>.
160 189
177that 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
178first font defines the cell size for characters; other fonts might be 207first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 208smaller, but not (in general) larger. A (hopefully) reasonable default
180font 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.
181 210
182In 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
183with 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:>,
184e.g.: 213e.g.:
185 214
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 215 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 216 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
205italic> >> characters are to be printed. See resource B<boldItalicFont> 234italic> >> characters are to be printed. See resource B<boldItalicFont>
206for details. 235for details.
207 236
208=item B<-is>|B<+is> 237=item B<-is>|B<+is>
209 238
210Compile I<font-styles>: Bold/Italic font styles imply high intensity 239Compile I<font-styles>: Bold/Blink font styles imply high intensity
211foreground/background (default). See resource B<intensityStyles> for 240foreground/background (default). See resource B<intensityStyles> for
212details. 241details.
213 242
214=item B<-name> I<name> 243=item B<-name> I<name>
215 244
233 262
234=item B<-sb>|B<+sb> 263=item B<-sb>|B<+sb>
235 264
236Turn on/off scrollbar; resource B<scrollBar>. 265Turn on/off scrollbar; resource B<scrollBar>.
237 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
238=item B<-si>|B<+si> 276=item B<-si>|B<+si>
239 277
240Turn on/off scroll-to-bottom on TTY output inhibit; resource 278Turn on/off scroll-to-bottom on TTY output inhibit; resource
241B<scrollTtyOutput> has opposite effect. 279B<scrollTtyOutput> has opposite effect.
242 280
248=item B<-sw>|B<+sw> 286=item B<-sw>|B<+sw>
249 287
250Turn on/off scrolling with the scrollback buffer as new lines appear. 288Turn on/off scrolling with the scrollback buffer as new lines appear.
251This only takes effect if B<-si> is also given; resource 289This only takes effect if B<-si> is also given; resource
252B<scrollWithBuffer>. 290B<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 291
263=item B<-ptab>|B<+ptab> 292=item B<-ptab>|B<+ptab>
264 293
265If enabled (default), "Horizontal Tab" characters are being stored as 294If enabled (default), "Horizontal Tab" characters are being stored as
266actual wide characters in the screen buffer, which makes it possible to 295actual wide characters in the screen buffer, which makes it possible to
270 299
271=item B<-bc>|B<+bc> 300=item B<-bc>|B<+bc>
272 301
273Blink the cursor; resource B<cursorBlink>. 302Blink the cursor; resource B<cursorBlink>.
274 303
304=item B<-uc>|B<+uc>
305
306Make the cursor underlined; resource B<cursorUnderline>.
307
275=item B<-iconic> 308=item B<-iconic>
276 309
277Start iconified, if the window manager supports that option. 310Start iconified, if the window manager supports that option.
278Alternative form is B<-ic>. 311Alternative form is B<-ic>.
279 312
295 328
296=item B<-bl> 329=item B<-bl>
297 330
298Compile 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.
299if 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
300decorations; resource B<borderLess>. 333decorations; resource B<borderLess>. If the window manager does not
334support MWM hints (e.g. kwin), enables override-redirect mode.
301 335
302=item B<-override-redirect> 336=item B<-override-redirect>
303 337
304Compile I<frills>: Sets override-redirect on the window; resource 338Compile I<frills>: Sets override-redirect on the window; resource
305B<override-redirect>. 339B<override-redirect>.
313 347
314=item B<-lsp> I<number> 348=item B<-lsp> I<number>
315 349
316Compile I<frills>: Lines (pixel height) to insert between each row of 350Compile I<frills>: Lines (pixel height) to insert between each row of
317the display. Useful to work around font rendering problems; resource 351the display. Useful to work around font rendering problems; resource
318B<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>.
319 360
320=item B<-tn> I<termname> 361=item B<-tn> I<termname>
321 362
322This 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
323B<TERM> environment variable. This terminal type must exist in the 364B<TERM> environment variable. This terminal type must exist in the
377for more info. 418for more info.
378 419
379=item B<-tcw> 420=item B<-tcw>
380 421
381Change 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
382button. 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
383end of the logical line only. resource B<tripleclickwords>. 425the end of the logical line only. resource B<tripleclickwords>.
384 426
385=item B<-insecure> 427=item B<-insecure>
386 428
387Enable "insecure" mode, which currently enables most of the escape 429Enable "insecure" mode, which currently enables most of the escape
388sequences that echo strings. See the resource B<insecure> for more 430sequences that echo strings. See the resource B<insecure> for more
409Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 451Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
410will not immediately destroy its window when the program executed within 452will not immediately destroy its window when the program executed within
411it exits. Instead, it will wait till it is being killed or closed by the 453it exits. Instead, it will wait till it is being killed or closed by the
412user; resource B<hold>. 454user; resource B<hold>.
413 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
414=item B<-keysym.>I<sym> I<string> 475=item B<-keysym.>I<sym> I<string>
415 476
416Remap a key symbol. See resource B<keysym>. 477Remap a key symbol. See resource B<keysym>.
417 478
418=item B<-embed> I<windowid> 479=item B<-embed> I<windowid>
419 480
420Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 481Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
421which enables applications to easily embed a terminal. 482which enables applications to easily embed a terminal.
422 483
423Right 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
424shouldn'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
425quite 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
428The window will not be destroyed when @@RXVT_NAME@@ exits. 489The window will not be destroyed when @@RXVT_NAME@@ exits.
429 490
430It 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
431descriptors 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
432can use file descriptors to communicate with the programs within the 493can use file descriptors to communicate with the programs within the
433terminal. 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
434not. 495not.
435 496
436Here 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
437used (a longer example is in F<doc/embed>): 498used (a longer example is in F<doc/embed>):
438 499
443 }); 504 });
444 505
445=item B<-pty-fd> I<file descriptor> 506=item B<-pty-fd> I<file descriptor>
446 507
447Tells @@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
448pair 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
449useful 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
450without having to run a program within it. 511without having to run a program within it.
451 512
452If 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
453entries 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
454yourself if you want that. 515yourself if you want that.
455 516
456As an extremely special case, specifying C<-1> will completely suppress 517As an extremely special case, specifying C<-1> will completely suppress
457pty/tty operations. 518pty/tty operations, which is probably only useful in conjunction with some
519perl extension that manages the terminal.
458 520
459Here 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
460longer example is in F<doc/pty-fd>): 522longer example is in F<doc/pty-fd>):
461 523
462 use IO::Pty; 524 use IO::Pty;
476Comma-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
477this terminal instance. See resource B<perl-ext> for details. 539this terminal instance. See resource B<perl-ext> for details.
478 540
479=back 541=back
480 542
481=head1 RESOURCES (available also as long-options) 543=head1 RESOURCES
482 544
483Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 545Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
484options) compiled into your version. 546options) compiled into your version. All resources are also available as
547long-options.
485 548
486You 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
487distribution do also load settings from the B<~/.Xresources> file when X 550distribution do also load settings from the B<~/.Xresources> file when X
488starts. @@RXVT_NAME@@ will consult the following files/resources in order, 551starts. @@RXVT_NAME@@ will consult the following files/resources in order,
489with later settings overwriting earlier ones: 552with later settings overwriting earlier ones:
490 553
491 1. system-wide app-defaults file, either locale-dependent OR global
492 2. app-defaults file in $XAPPLRESDIR 554 1. app-defaults file in $XAPPLRESDIR
555 2. $HOME/.Xdefaults
493 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 556 3. RESOURCE_MANAGER property on root-window of screen 0
494 4. SCREEN_RESOURCES for the current screen 557 4. SCREEN_RESOURCES property on root-window of the current screen
495 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 558 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
559 6. resources specified via -xrm on the commandline
496 560
497Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 561Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
498names: 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
499common 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
500configured, while the class name B<URxvt> allows resources unique to 564configured, while the class name B<URxvt> allows resources unique to
505check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 569check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
506extensions not documented here): 570extensions not documented here):
507 571
508=over 4 572=over 4
509 573
574=item B<depth:> I<bitdepth>
575
576Compile I<xft>: Attempt to find a visual with the given bit 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.
585
510=item B<geometry:> I<geom> 586=item B<geometry:> I<geom>
511 587
512Create the window with the specified X window geometry [default 80x24]; 588Create the window with the specified X window geometry [default 80x24];
513option B<-geometry>. 589option B<-geometry>.
514 590
527Use 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
528corresponds to low-intensity (normal) colours and 8-15 corresponds to 604corresponds to low-intensity (normal) colours and 8-15 corresponds to
529high-intensity (bold = bright foreground, blink = bright background) 605high-intensity (bold = bright foreground, blink = bright background)
530colours. 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,
5313=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
532names used are listed in the B<COLORS AND GRAPHICS> section. 608names used are listed in the B<COLOURS AND GRAPHICS> section.
533 609
534Colours 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
535changed using an escape command (see @@RXVT_NAME@@(7)). 611changed using an escape command (see @@RXVT_NAME@@(7)).
536 612
537Colours 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
548=item B<colorUL:> I<colour> 624=item B<colorUL:> I<colour>
549 625
550Use the specified colour to display underlined characters when the 626Use the specified colour to display underlined characters when the
551foreground colour is the default. 627foreground colour is the default.
552 628
553=item B<colorRV:> I<colour>
554
555Use the specified colour as the background for reverse video
556characters.
557
558=item B<underlineColor:> I<colour> 629=item B<underlineColor:> I<colour>
559 630
560If set, use the specified colour as the colour for the underline 631If set, use the specified colour as the colour for the underline
561itself. 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.
562 643
563=item B<cursorColor:> I<colour> 644=item B<cursorColor:> I<colour>
564 645
565Use 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
566foreground colour; option B<-cr>. 647foreground colour; option B<-cr>.
573 654
574=item B<reverseVideo:> I<boolean> 655=item B<reverseVideo:> I<boolean>
575 656
576B<True>: simulate reverse video by foreground and background colours; 657B<True>: simulate reverse video by foreground and background colours;
577option B<-rv>. B<False>: regular screen colours [default]; option 658option B<-rv>. B<False>: regular screen colours [default]; option
578B<+rv>. See note in B<COLORS AND GRAPHICS> section. 659B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
579 660
580=item B<jumpScroll:> I<boolean> 661=item B<jumpScroll:> I<boolean>
581 662
582B<True>: specify that jump scrolling should be used. When scrolling 663B<True>: specify that jump scrolling should be used. When receiving lots
583quickly, fewer screen updates are performed [default]; option B<-j>. 664of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
665has been read, resulting in fewer updates while still displaying every
666received line; option B<-j>.
667
584B<False>: specify that smooth scrolling should be used; option B<+j>. 668B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
669force a screen refresh on each new line it received; option B<+j>.
585 670
586=item B<inheritPixmap:> I<boolean> 671=item B<skipScroll:> I<boolean>
587 672
588B<True>: make the background inherit the parent windows' pixmap, giving 673B<True>: (the default) specify that skip scrolling should be used. When
589artificial transparency. B<False>: do not inherit the parent windows' 674receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
590pixmap. 675(around 60 times per second), resulting in far fewer updates. This can
676result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
677option B<-ss>.
678
679B<False>: specify that everything is to be displayed, even
680if the refresh is too fast for the human eye to read anything (or the
681monitor to display anything); option B<+ss>.
682
683=item B<transparent:> I<boolean>
684
685Turn on/off 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.
591 689
592=item B<fading:> I<number> 690=item B<fading:> I<number>
593 691
594Fade 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>.
595 693
598Fade 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
599colour is black; option B<-fadecolor>. 697colour is black; option B<-fadecolor>.
600 698
601=item B<tintColor:> I<colour> 699=item B<tintColor:> I<colour>
602 700
603Tint the transparent background pixmap with the given colour; option 701Tint the transparent background with the given colour. If the RENDER
604B<-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>.
605 706
606=item B<shading:> I<number> 707=item B<shading:> I<number>
607 708
608Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 709Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
609image in addition to tinting it. 710A value of 100 means no shading; option B<-sh>.
711
712=item B<blurRadius:> I<number>
713
714Apply gaussian blur with the specified radius to the transparent
715background; option B<-blr>.
716
717=item B<iconFile:> I<file>
718
719Set the application icon pixmap; option B<-icon>.
610 720
611=item B<scrollColor:> I<colour> 721=item B<scrollColor:> I<colour>
612 722
613Use the specified colour for the scrollbar [default #B2B2B2]. 723Use the specified colour for the scrollbar [default #B2B2B2].
614 724
620=item B<borderColor:> I<colour> 730=item B<borderColor:> I<colour>
621 731
622The colour of the border around the text area and between the scrollbar 732The colour of the border around the text area and between the scrollbar
623and the text. 733and the text.
624 734
625=item B<backgroundPixmap:> I<file[;geom]> 735=item B<backgroundPixmap:> I<file[;oplist]>
626 736
627Use the specified XPM file (note the `.xpm' extension is optional) for 737Use the specified image file for the background and also
628the background and also optionally specify its scaling with a geometry 738optionally specify a colon separated list of operations to modify it.
629string B<WxH+X+Y>, in which B<"W" / "H"> specify the 739Supported operations are:
630horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 740
631centre (percent). A scale of 0 displays the image with tiling. A scale 741=over 4
632of 1 displays the image without any scaling. A scale of 2 to 9 742
633specifies an integer number of images in that direction. No image will 743=item B<WxH+X+Y>
634be magnified beyond 10 times its original size. The maximum permitted 744
635scale is 1000. [default 0x0+50+50] 745sets scale and position. B<"W" / "H"> specify the horizontal/vertical
746scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
747scale of 0 disables scaling.
748
749=item B<op=tile>
750
751enables tiling
752
753=item B<op=keep-aspect>
754
755maintain the image aspect ratio when scaling
756
757=item B<op=root-align>
758
759use the position of the terminal window relative to the root window as
760the image offset, simulating a root window background
761
762=back
763
764The default scale and position setting is C<100x100+50+50>.
765Alternatively, a predefined set of templates can be used to achieve
766the most common setups:
767
768=over 4
769
770=item B<style=tiled>
771
772the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
773
774=item B<style=aspect-stretched>
775
776the image is scaled to fill the whole window maintaining the aspect
777ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
778
779=item B<style=stretched>
780
781the image is scaled to fill the whole window. Equivalent to 100x100
782
783=item B<style=centered>
784
785the image is centered with no scaling. Equivalent to 0x0+50+50
786
787=item B<style=root-tiled>
788
789the image is tiled with no scaling and using 'root' positioning.
790Equivalent to 0x0:op=tile:op=root-align
791
792=back
793
794If multiple templates are specified the last one wins. Note that a
795template overrides all the scale, position and operations settings.
796
797If used in conjunction with B<-tr> option, the specified pixmap will be
798blended over the transparent background using alpha-blending.
636 799
637=item B<path:> I<path> 800=item B<path:> I<path>
638 801
639Specify the colon-delimited search path for finding XPM files. 802Specify the colon-delimited search path for finding background image files.
640 803
641=item B<font:> I<fontlist> 804=item B<font:> I<fontlist>
642 805
643Select the fonts to be used. This is a comma separated list of font names 806Select the fonts to be used. This is a comma separated list of font names
644that are checked in order when trying to find glyphs for characters. The 807that are checked in order when trying to find glyphs for characters. The
667it is named first) and thus defines the character cell grid to be 9 pixels 830it is named first) and thus defines the character cell grid to be 9 pixels
668wide and 15 pixels high. 831wide and 15 pixels high.
669 832
670The second font is just used to add additional unicode characters not in 833The second font is just used to add additional unicode characters not in
671the base font, likewise the third, which is unfortunately non-bold, but 834the base font, likewise the third, which is unfortunately non-bold, but
672the bold version of the font does contain less characters, so this is a 835the bold version of the font does contain fewer characters, so this is a
673useful supplement. 836useful supplement.
674 837
675The third font is an Xft font with aliasing turned off, and the characters 838The third font is an Xft font with aliasing turned off, and the characters
676are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 839are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
677contains other characters, but we are not interested in them. 840contains other characters, but we are not interested in them.
701text font will being used for the given style. 864text font will being used for the given style.
702 865
703=item B<intensityStyles:> I<boolean> 866=item B<intensityStyles:> I<boolean>
704 867
705When font styles are not enabled, or this option is enabled (B<True>, 868When font styles are not enabled, or this option is enabled (B<True>,
706option B<-is>, the default), bold and italic font styles imply high 869option B<-is>, the default), bold/blink font styles imply high
707intensity foreground/backround colours. Disabling this option (B<False>, 870intensity foreground/background colours. Disabling this option (B<False>,
708option B<+is>) disables this behaviour, the high intensity colours are not 871option B<+is>) disables this behaviour, the high intensity colours are not
709reachable. 872reachable.
710
711=item B<selectstyle:> I<mode>
712
713Set mouse selection style to B<old> which is 2.20, B<oldword> which is
714xterm style with 2.20 old word selection, or anything else which gives
715xterm style selection.
716
717=item B<scrollstyle:> I<mode>
718
719Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
720the author's favourite.
721 873
722=item B<title:> I<string> 874=item B<title:> I<string>
723 875
724Set window title string, the default title is the command-line 876Set window title string, the default title is the command-line
725specified after the B<-e> option, if any, otherwise the application 877specified after the B<-e> option, if any, otherwise the application
734=item B<mapAlert:> I<boolean> 886=item B<mapAlert:> I<boolean>
735 887
736B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 888B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
737de-iconify (map) on receipt of a bell character [default]. 889de-iconify (map) on receipt of a bell character [default].
738 890
891=item B<urgentOnBell:> I<boolean>
892
893B<True>: set the urgency hint for the wm on receipt of a bell character.
894B<False>: do not set the urgency hint [default].
895
896@@RXVT_NAME@@ resets the urgency hint on every focus change.
897
739=item B<visualBell:> I<boolean> 898=item B<visualBell:> I<boolean>
740 899
741B<True>: use visual bell on receipt of a bell character; option B<-vb>. 900B<True>: use visual bell on receipt of a bell character; option B<-vb>.
742B<False>: no visual bell [default]; option B<+vb>. 901B<False>: no visual bell [default]; option B<+vb>.
743 902
764Example: 923Example:
765 924
766 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 925 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
767 926
768This creates a new file in your home directory with the screen contents 927This creates a new file in your home directory with the screen contents
769everytime you hit C<Print>. 928every time you hit C<Print>.
929
930=item B<scrollstyle:> I<mode>
931
932Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
933the author's favourite.
934
935=item B<thickness:> I<number>
936
937Set the scrollbar width in pixels.
770 938
771=item B<scrollBar:> I<boolean> 939=item B<scrollBar:> I<boolean>
772 940
773B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 941B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
774disable the scrollbar; option B<+sb>. 942disable the scrollbar; option B<+sb>.
794B<False>: do not scroll to bottom when tty receives output; option 962B<False>: do not scroll to bottom when tty receives output; option
795B<+si>. 963B<+si>.
796 964
797=item B<scrollWithBuffer:> I<boolean> 965=item B<scrollWithBuffer:> I<boolean>
798 966
799B<True>: scroll with scrollback buffer when tty receives new lines (and 967B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
800B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 968try to show the same lines) and B<scrollTtyOutput> is False; option
801with scrollback buffer when tty recieves new lines; option B<+sw>. 969B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
970new lines; option B<+sw>.
802 971
803=item B<scrollTtyKeypress:> I<boolean> 972=item B<scrollTtyKeypress:> I<boolean>
804 973
805B<True>: scroll to bottom when a non-special key is pressed. Special keys 974B<True>: scroll to bottom when a non-special key is pressed. Special keys
806are those which are intercepted by rxvt-unicode for special handling and 975are those which are intercepted by rxvt-unicode for special handling and
837=item B<termName:> I<termname> 1006=item B<termName:> I<termname>
838 1007
839Specifies the terminal type name to be set in the B<TERM> environment 1008Specifies the terminal type name to be set in the B<TERM> environment
840variable; option B<-tn>. 1009variable; option B<-tn>.
841 1010
842=item B<linespace:> I<number> 1011=item B<lineSpace:> I<number>
843 1012
844Specifies number of lines (pixel height) to insert between each row of 1013Specifies number of lines (pixel height) to insert between each row of
845the display [default 0]; option B<-lsp>. 1014the display [default 0]; option B<-lsp>.
846 1015
847=item B<meta8:> I<boolean> 1016=item B<meta8:> I<boolean>
861 1030
862=item B<cursorBlink:> I<boolean> 1031=item B<cursorBlink:> I<boolean>
863 1032
864B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1033B<True>: blink the cursor. B<False>: do not blink the cursor [default];
865option B<-bc>. 1034option B<-bc>.
1035
1036=item B<cursorUnderline:> I<boolean>
1037
1038B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1039option B<-uc>.
866 1040
867=item B<pointerBlank:> I<boolean> 1041=item B<pointerBlank:> I<boolean>
868 1042
869B<True>: blank the pointer when a key is pressed or after a set number 1043B<True>: blank the pointer when a key is pressed or after a set number
870of seconds of inactivity. B<False>: the pointer is always visible 1044of seconds of inactivity. B<False>: the pointer is always visible
884large number (e.g. C<987654321>) to effectively disable the timeout. 1058large number (e.g. C<987654321>) to effectively disable the timeout.
885 1059
886=item B<backspacekey:> I<string> 1060=item B<backspacekey:> I<string>
887 1061
888The string to send when the backspace key is pressed. If set to B<DEC> 1062The string to send when the backspace key is pressed. If set to B<DEC>
889or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 1063or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
890(code 8) - which can be reversed with the appropriate DEC private mode 1064(code 8) - which can be reversed with the appropriate DEC private mode
891escape sequence. 1065escape sequence.
892 1066
893=item B<deletekey:> I<string> 1067=item B<deletekey:> I<string>
894 1068
896pressed. If unset it will send the sequence traditionally associated 1070pressed. If unset it will send the sequence traditionally associated
897with the B<Execute> key. 1071with the B<Execute> key.
898 1072
899=item B<cutchars:> I<string> 1073=item B<cutchars:> I<string>
900 1074
901The characters used as delimiters for double-click word selection. 1075The characters used as delimiters for double-click word selection
1076(whitespace delimiting is added automatically if resource is given).
902 1077
903When the selection extension is in use (the default if compiled in, see 1078When the perl selection extension is in use (the default if compiled
904the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters 1079in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
905will be created (if the resource exists, otherwise, no regex will be 1080characters will be created (if the resource exists, otherwise, no regex
906created). In this mode, characters outside ISO-8859-1 can be used. 1081will be created). In this mode, characters outside ISO-8859-1 can be used.
907 1082
908When the selection extension is not used, only ISO-8859-1 characters can 1083When the selection extension is not used, only ISO-8859-1 characters can
909be used. If not specified, the built-in default is used: 1084be used. If not specified, the built-in default is used:
910 1085
911B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1086B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
912 1087
913=item B<preeditType:> I<style> 1088=item B<preeditType:> I<style>
914 1089
915B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1090B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
916 1091
970 1145
971Turn on/off secondary screen (default enabled). 1146Turn on/off secondary screen (default enabled).
972 1147
973=item B<secondaryScroll:> I<boolean> 1148=item B<secondaryScroll:> I<boolean>
974 1149
975Turn on/off secondary screen scroll (default enabled). If the this 1150Turn on/off secondary screen scroll (default enabled). If this
976option is enabled, scrolls on the secondary screen will change the 1151option is enabled, scrolls on the secondary screen will change the
977scrollback buffer and switching to/from the secondary screen will 1152scrollback buffer and, when secondaryScreen is off, switching
978instead scroll the screen up. 1153to/from the secondary screen will instead scroll the screen up.
979 1154
980=item B<hold>: I<boolean> 1155=item B<hold>: I<boolean>
981 1156
982Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1157Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
983will not immediately destroy its window when the program executed within 1158will not immediately destroy its window when the program executed within
984it exits. Instead, it will wait till it is being killed or closed by the 1159it exits. Instead, it will wait till it is being killed or closed by the
985user. 1160user.
1161
1162=item B<chdir>: I<path>
1163
1164Sets the working directory for the shell (or the command specified via
1165B<-e>). The I<path> must be an absolute path and it must exist for
1166@@RXVT_NAME@@ to start. If it isn't specified then the current working
1167directory will be used; option B<-cd>.
986 1168
987=item B<keysym.>I<sym>: I<string> 1169=item B<keysym.>I<sym>: I<string>
988 1170
989Compile I<frills>: Associate I<string> with keysym I<sym>. The 1171Compile I<frills>: Associate I<string> with keysym I<sym>. The
990intervening resource name B<keysym.> cannot be omitted. 1172intervening resource name B<keysym.> cannot be omitted.
1004searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1186searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1005omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1187omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1006keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1188keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1007performed in an exact manner; however, the closest match is assured. 1189performed in an exact manner; however, the closest match is assured.
1008 1190
1009I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1191I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1010C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1192number), see RESOURCES in C<man 7 X> for further details.
1011C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1012C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1013can start or end with whitespace.
1014 1193
1015Please note that you need to double the C<\> in resource files, as
1016Xlib itself does it's own de-escaping (you can use C<\033> instead of
1017C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1018processing).
1019
1020You can define a range of keysyms in one shot by providing a I<string> 1194You can define a range of keysyms in one shot by
1195loading the C<keysym-list> perl extension and providing a I<string>
1021with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1196with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1022should be a character not used by the strings. 1197should be a character not used by the strings.
1023 1198
1024Its usage can be demonstrated by an example: 1199Its usage can be demonstrated by an example:
1025 1200
1026 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1201 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1027 1202
1028The above line is equivalent to the following three lines: 1203The above line is equivalent to the following three lines:
1029 1204
1030 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1205 URxvt.keysym.Meta-Control-0x61: \033<a>
1031 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1206 URxvt.keysym.Meta-Control-0x62: \033<b>
1032 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1207 URxvt.keysym.Meta-Control-0x63: \033<c>
1033 1208
1034If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1209If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1035is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1210is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1036example the following means "change the current locale to C<zh_CN.GBK> 1211example the following means "change the current locale to C<zh_CN.GBK>
1037when Control-Meta-c is being pressed": 1212when Control-Meta-c is being pressed":
1038 1213
1039 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1214 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1040 1215
1041If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1216If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1042is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1217is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1043manpage. For example, the F<selection> extension (activated via 1218manpage. For example, the F<selection> extension (activated via
1044C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1219C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1045 1220
1046 URxvt.keysym.M-C-c: perl:selection:rot13 1221 URxvt.keysym.M-C-c: perl:selection:rot13
1047 1222
1048Due the the large number of modifier combinations, a defined key mapping 1223Due the the large number of modifier combinations, a defined key mapping
1049will match if at I<at least> the specified identifiers are being set, and 1224will match if I<at least> the specified identifiers are being set, and
1050no other key mappings with those and more bits are being defined. That 1225no other key mappings with those and more bits are being defined. That
1051means that defining a key map for C<a> will automatically provide 1226means that defining a key map for C<a> will automatically provide
1052definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined 1227definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1053mappings themselves. 1228mappings themselves.
1054 1229
1090example, C<default,-selection> will use all the default extension except 1265example, C<default,-selection> will use all the default extension except
1091C<selection>. 1266C<selection>.
1092 1267
1093Extension names can also be followed by an argument in angle brackets 1268Extension names can also be followed by an argument in angle brackets
1094(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1269(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1095searchable scorllback to Alt/Meta-s). Mentioning the same extension 1270searchable scrollback to Alt/Meta-s). Mentioning the same extension
1096multiple times with different arguments will pass multiple arguments to 1271multiple times with different arguments will pass multiple arguments to
1097the extension. 1272the extension.
1098 1273
1099Each extension is looked up in the library directories, loaded if 1274Each extension is looked up in the library directories, loaded if
1100necessary, and bound to the current terminal instance. 1275necessary, and bound to the current terminal instance.
1105all instances, while B<perl-ext> is used for specific instances. 1280all instances, while B<perl-ext> is used for specific instances.
1106 1281
1107=item B<perl-eval>: I<string> 1282=item B<perl-eval>: I<string>
1108 1283
1109Perl code to be evaluated when all extensions have been registered. See 1284Perl code to be evaluated when all extensions have been registered. See
1110the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1285the @@RXVT_NAME@@perl(3) manpage.
1111will be ignored when running setuid/setgid.
1112 1286
1113=item B<perl-lib>: I<path> 1287=item B<perl-lib>: I<path>
1114 1288
1115Colon-separated list of additional directories that hold extension 1289Colon-separated list of additional directories that hold extension
1116scripts. When looking for extensions specified by the C<perl> resource, 1290scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1117@@RXVT_NAME@@ will first look in these directories and then in 1291look in these directories, then in $HOME/.urxvt/ext and lastly in
1118F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1292F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1119will be ignored when running setuid/setgid.
1120 1293
1121See the @@RXVT_NAME@@perl(3) manpage. 1294See the @@RXVT_NAME@@perl(3) manpage.
1122 1295
1123=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1296=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1124 1297
1136(default: C<M-s>). 1309(default: C<M-s>).
1137 1310
1138=item B<urlLauncher>: I<string> 1311=item B<urlLauncher>: I<string>
1139 1312
1140Specifies the program to be started with a URL argument. Used by the 1313Specifies the program to be started with a URL argument. Used by the
1141C<selection-popup> and C<mark-urls> perl extensions. 1314C<selection-popup> and C<matcher> perl extensions.
1142 1315
1143=item B<transient-for>: I<windowid> 1316=item B<transient-for>: I<windowid>
1144 1317
1145Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. 1318Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1146 1319
1147=item B<override-redirect>: I<boolean> 1320=item B<override-redirect>: I<boolean>
1148 1321
1149Compile I<frills>: Sets override-redirect for the terminal window, making 1322Compile I<frills>: Sets override-redirect for the terminal window, making
1150it almost invisible to window managers; option B<-override-redirect>. 1323it almost invisible to window managers; option B<-override-redirect>.
1324
1325=item B<iso14755:> I<boolean>
1326
1327Turn on/off ISO 14755 (default enabled).
1328
1329=item B<iso14755_52:> I<boolean>
1330
1331Turn on/off ISO 14755 5.2 mode (default enabled).
1151 1332
1152=back 1333=back
1153 1334
1154=head1 THE SCROLLBAR 1335=head1 THE SCROLLBAR
1155 1336
1174application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1355application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1175(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1356(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1176up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1357up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1177respectively. 1358respectively.
1178 1359
1179=head1 TEXT SELECTION AND INSERTION 1360=head1 THE SELECTION: SELECTING AND PASTING TEXT
1180 1361
1181The behaviour of text selection and insertion mechanism is similar to 1362The behaviour of text selection and insertion/pasting mechanism is similar
1182I<xterm>(1). 1363to I<xterm>(1).
1183 1364
1184=over 4 1365=over 4
1185 1366
1186=item B<Selection>: 1367=item B<Selecting>:
1187 1368
1188Left click at the beginning of the region, drag to the end of the region 1369Left click at the beginning of the region, drag to the end of the region
1189and release; Right click to extend the marked region; Left double-click 1370and release; Right click to extend the marked region; Left double-click
1190to select a word; Left triple-click to select the entire logical line 1371to select a word; Left triple-click to select the entire logical line
1191(which can span multiple screen lines), unless modified by resource 1372(which can span multiple screen lines), unless modified by resource
1195(Compile: I<frills>) will create a rectangular selection instead of a 1376(Compile: I<frills>) will create a rectangular selection instead of a
1196normal one. In this mode, every selected row becomes its own line in the 1377normal one. In this mode, every selected row becomes its own line in the
1197selection, and trailing whitespace is visually underlined and removed from 1378selection, and trailing whitespace is visually underlined and removed from
1198the selection. 1379the selection.
1199 1380
1200=item B<Insertion>: 1381=item B<Pasting>:
1201 1382
1202Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> 1383Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1203window causes the value of the PRIMARY selection (or CLIPBOARD with the 1384window causes the value of the PRIMARY selection (or CLIPBOARD with the
1204Meta modifier) to be inserted as if it had been typed on the keyboard. 1385B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1205 1386
1206Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1387Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1207inserted too. 1388inserted too.
1208 1389
1209=back 1390=back
1226 1407
1227=head1 ISO 14755 SUPPORT 1408=head1 ISO 14755 SUPPORT
1228 1409
1229ISO 14755 is a standard for entering and viewing unicode characters 1410ISO 14755 is a standard for entering and viewing unicode characters
1230and character codes using the keyboard. It consists of 4 parts. The 1411and character codes using the keyboard. It consists of 4 parts. The
1231first part is available rxvt-unicode has been compiled with 1412first part is available if rxvt-unicode has been compiled with
1232C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1413C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1233with C<--enable-iso14755>. 1414with C<--enable-iso14755>.
1234 1415
1235=over 4 1416=over 4
1236 1417
1256This mode lets you input characters representing the keycap symbols of 1437This mode lets you input characters representing the keycap symbols of
1257your keyboard, if representable in the current locale encoding. 1438your keyboard, if representable in the current locale encoding.
1258 1439
1259Start by pressing C<Control> and C<Shift> together, then releasing 1440Start by pressing C<Control> and C<Shift> together, then releasing
1260them. The next special key (cursor keys, home etc.) you enter will not 1441them. The next special key (cursor keys, home etc.) you enter will not
1261invoke it's usual function but instead will insert the corresponding 1442invoke its usual function but instead will insert the corresponding
1262keycap symbol. The symbol will only be entered when the key has been 1443keycap symbol. The symbol will only be entered when the key has been
1263released, otherwise pressing e.g. C<Shift> would enter the symbol for 1444released, otherwise pressing e.g. C<Shift> would enter the symbol for
1264C<ISO Level 2 Switch>, although your intention might have been to enter a 1445C<ISO Level 2 Switch>, although your intention might have been to enter a
1265reverse tab (Shift-Tab). 1446reverse tab (Shift-Tab).
1266 1447
1294B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1475B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1295it can be seen via the I<who(1)> command, and can accept messages. To 1476it can be seen via the I<who(1)> command, and can accept messages. To
1296allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1477allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1297on some systems or setgid to root or to some other group on others. 1478on some systems or setgid to root or to some other group on others.
1298 1479
1299=head1 COLORS AND GRAPHICS 1480=head1 COLOURS AND GRAPHICS
1300 1481
1301In addition to the default foreground and background colours, 1482In addition to the default foreground and background colours,
1302B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1483B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1303high-intensity bold/blink versions of the same). Here is a list of the 1484high-intensity (potentially bold/blink) versions of the same, and 72 (or
1304colours with their B<rgb.txt> names. 1485240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1486cube plus a 8 (24) colour greyscale ramp.
1487
1488Here is a list of the ANSI colours with their names.
1305 1489
1306=begin table 1490=begin table
1307 1491
1308 B<color0> (black) = Black 1492 B<color0> (black) = Black
1309 B<color1> (red) = Red3 1493 B<color1> (red) = Red3
1329It is also possible to specify the colour values of B<foreground>, 1513It is also possible to specify the colour values of B<foreground>,
1330B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1514B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1331a number 0-15, as a convenient shorthand to reference the colour name of 1515a number 0-15, as a convenient shorthand to reference the colour name of
1332color0-color15. 1516color0-color15.
1333 1517
1518The following text gives values for the standard 88 colour mode (and
1519values for the 256 colour mode in parentheses).
1520
1521The RGB cube uses indices 16..79 (16..231) using the following formulas:
1522
1523 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1524 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1525
1526The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1527steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1528the RGB cube.
1529
1530Together, all those colours implement the 88 (256) colour xterm
1531colours. Only the first 16 can be changed using resources currently, the
1532rest can only be changed via command sequences ("escape codes").
1533
1534Applications are advised to use terminfo or command sequences to discover
1535number and RGB values of all colours (yes, you can query this...).
1536
1334Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1537Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1335always swapping the foreground/background colours. This is in contrast to 1538always swapping the foreground/background colours. This is in contrast to
1336I<xterm>(1) where the colours are only swapped if they have not otherwise 1539I<xterm>(1) where the colours are only swapped if they have not otherwise
1337been specified. For example, 1540been specified. For example,
1338 1541
1542 @@RXVT_NAME@@ -fg Black -bg White -rv
1543
1544would yield White on Black, while on I<xterm>(1) it would yield Black on
1545White.
1546
1547=head2 ALPHA CHANNEL SUPPORT
1548
1549If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1550their act together, rxvt-unicode will do its own alpha channel management:
1551
1552You can prefix any colour with an opaqueness percentage enclosed in
1553brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1554(0-100) that specifies the opacity of the colour, where C<0> is completely
1555transparent and C<100> is completely opaque. For example, C<[50]red> is a
1556half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1557is the recommended format to specify transparency values, and works with
1558all ways to specify a colour.
1559
1560For complete control, rxvt-unicode also supports
1561C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1562specifications, where the additional C<aaaa> component specifies opacity
1563(alpha) values. The minimum value of C<0000> is completely transparent,
1564while C<ffff> is completely opaque). The two example colours from
1565earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1566C<rgba:0000/ff00/0000/f332>.
1567
1568You probably need to specify B<"-depth 32">, too, to force a visual with
1569alpha channels, and have the luck that your X-server uses ARGB pixel
1570layout, as X is far from just supporting ARGB visuals out of the box, and
1571rxvt-unicode just fudges around.
1572
1573For example, the following selects an almost completely transparent black
1574background, and an almost opaque pink foreground:
1575
1576 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1577
1578When not using a background image, then the interpretation of the
1579alpha channel is up to your compositing manager (most interpret it as
1580transparency of course).
1581
1582When using a background pixmap or pseudo-transparency, then the background
1583colour will always behave as if it were completely transparent (so the
1584background image shows instead), regardless of how it was specified, while
1585other colours will either be transparent as specified (the background
1586image will show through) on servers supporting the RENDER extension, or
1587fully opaque on servers not supporting the RENDER EXTENSION.
1588
1589Please note that due to bugs in Xft, specifying alpha values might result
1590in garbage being displayed when the X-server does not support the RENDER
1591extension.
1592
1593=head1 ENVIRONMENT
1594
1595B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1596
1339=over 4 1597=over 4
1340 1598
1341=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1342
1343would yield White on Black, while on I<xterm>(1) it would yield Black
1344on White.
1345
1346=back
1347
1348=head1 ENVIRONMENT
1349
1350B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1351
1352=over 4
1353
1354=item B<TERM> 1599=item B<TERM>
1355 1600
1356Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1601Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1357resources or on the commandline. 1602resources or on the command line.
1358 1603
1359=item B<COLORTERM> 1604=item B<COLORTERM>
1360 1605
1361Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1606Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1362compiled with XPM support, and optionally with the added extension 1607compiled with background image support, and optionally with the added
1363C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1608extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1609screen.
1364 1610
1365=item B<COLORFGBG> 1611=item B<COLORFGBG>
1366 1612
1367Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1613Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1368the colour code used as default foreground/text colour (or the string 1614the colour code used as default foreground/text colour (or the string
1369C<default> to indicate that the default-colour escape sequence is to be 1615C<default> to indicate that the default-colour escape sequence is to be
1370used), C<bg> is the colour code used as default background colour (or the 1616used), C<bg> is the colour code used as default background colour (or the
1371string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1617string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1372was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1618was compiled with background image support. Libraries like C<ncurses>
1373(and do) use this information to optimize screen output. 1619and C<slang> can (and do) use this information to optimize screen output.
1374 1620
1375=item B<WINDOWID> 1621=item B<WINDOWID>
1376 1622
1377Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1623Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1378window, which usually has subwindows for the scrollbar, the terminal 1624window, which usually has subwindows for the scrollbar, the terminal
1384C<--with-terminfo=PATH>. 1630C<--with-terminfo=PATH>.
1385 1631
1386=item B<DISPLAY> 1632=item B<DISPLAY>
1387 1633
1388Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1634Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1389display in it's child processes. 1635display in its child processes if C<-display> isn't used to override. It
1636defaults to C<:0> if it doesn't exist.
1390 1637
1391=item B<SHELL> 1638=item B<SHELL>
1392 1639
1393The shell to be used for command execution, defaults to C</bin/sh>. 1640The shell to be used for command execution, defaults to C</bin/sh>.
1394 1641
1395=item B<RXVT_SOCKET> 1642=item B<RXVT_SOCKET>
1396 1643
1397The unix domain socket path used by @@RXVT_NAME@@c(1) and 1644The unix domain socket path used by @@RXVT_NAME@@c(1) and
1398@@RXVT_NAME@@d(1). 1645@@RXVT_NAME@@d(1).
1399 1646
1400Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1647Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1401 1648
1402=item B<HOME> 1649=item B<HOME>
1403 1650
1404Used to locate the default directory for the unix domain socket for 1651Used to locate the default directory for the unix domain socket for
1405daemon communications and to locate various resource files (such as 1652daemon communications and to locate various resource files (such as
1406C<.Xdefaults>) 1653C<.Xdefaults>)
1407 1654
1408=item B<XAPPLRESDIR> 1655=item B<XAPPLRESDIR>
1409 1656
1410Directory where various X resource files are being located. 1657Directory where application-specific X resource files are located.
1411 1658
1412=item B<XENVIRONMENT> 1659=item B<XENVIRONMENT>
1413 1660
1414If set and accessible, gives the name of a X resource file to be loaded by 1661If set and accessible, gives the name of a X resource file to be loaded by
1415@@RXVT_NAME@@. 1662@@RXVT_NAME@@.
1420 1667
1421=over 4 1668=over 4
1422 1669
1423=item B</usr/lib/X11/rgb.txt> 1670=item B</usr/lib/X11/rgb.txt>
1424 1671
1425Color names. 1672Colour names.
1426 1673
1427=back 1674=back
1428 1675
1429=head1 SEE ALSO 1676=head1 SEE ALSO
1430 1677
1436 1683
1437=item Project Coordinator 1684=item Project Coordinator
1438 1685
1439Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1686Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1440 1687
1441L<http://software.schmorp.de/#rxvt-unicode> 1688L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1442 1689
1443=back 1690=back
1444 1691
1445=head1 AUTHORS 1692=head1 AUTHORS
1446 1693
1469Project Coordinator (changes.txt 2.21a to 2.4.5) 1716Project Coordinator (changes.txt 2.21a to 2.4.5)
1470 1717
1471=item Geoff Wing L<< <gcw@pobox.com> >> 1718=item Geoff Wing L<< <gcw@pobox.com> >>
1472 1719
1473Rewrote screen display and text selection routines. 1720Rewrote screen display and text selection routines.
1474 1721
1475Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1722Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1476 1723
1477=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1724=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1478 1725
1479Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1726Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1481 1728
1482Project Coordinator (Changes 1.0 -) 1729Project Coordinator (Changes 1.0 -)
1483 1730
1484=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1731=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1485 1732
1486Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1733pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1487 1734
1488=back 1735=back
1489 1736

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines