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.97 by root, Mon Jan 16 15:07:27 2006 UTC vs.
Revision 1.185 by sf-exg, Mon Oct 4 07:18:23 2010 UTC

12emulator intended as an I<xterm>(1) replacement for users who do not 12emulator intended as an I<xterm>(1) replacement for users who do not
13require features such as Tektronix 4014 emulation and toolkit-style 13require features such as Tektronix 4014 emulation and toolkit-style
14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16 16
17This document is also available on the World-Wide-Web at
18L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
19
17=head1 FREQUENTLY ASKED QUESTIONS 20=head1 FREQUENTLY ASKED QUESTIONS
18 21
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 22See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 23frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 24problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23 26
24=head1 RXVT-UNICODE VS. RXVT 27=head1 RXVT-UNICODE VS. RXVT
25 28
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 29Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 30internally. That means it can store and display most scripts in the
28world. Being a terminal emulator, however, some things are very difficult, 31world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts 32especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules, 33like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. Don't expect pretty output when using these 34like tibetan or devanagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 35scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are left-to-right scripts, such 36fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 37as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 38belong in the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 39such as cursor-movement while editing -- break otherwise), but that might
37change. 40change.
38 41
39If you are looking for a terminal that supports more exotic scripts, let 42If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very userfriendly, lean and clean 43me recommend C<mlterm>, which is a very user friendly, lean and clean
41terminal emulator. In fact, the reason rxvt-unicode was born was solely 44terminal emulator. In fact, the reason rxvt-unicode was born was solely
42because the author couldn't get C<mlterm> to use one font for latin1 and 45because the author couldn't get C<mlterm> to use one font for latin1 and
43another for japanese. 46another for japanese.
44 47
45Therefore another design rationale was the use of multiple fonts to 48Therefore another design rationale was the use of multiple fonts to
46display characters: The idea of a single unicode font which many other 49display characters: The idea of a single unicode font which many other
47programs force onto it's users never made sense to me: You should be able 50programs force onto its users never made sense to me: You should be able
48to choose any font for any script freely. 51to choose any font for any script freely.
49 52
50Apart from that, rxvt-unicode is also much better internationalised than 53Apart from that, rxvt-unicode is also much better internationalised than
51it's predecessor, supports things such as XFT and ISO 14755 that are handy 54its predecessor, supports things such as XFT and ISO 14755 that are handy
52in i18n-environments, is faster, and has a lot less bugs than the original 55in i18n-environments, is faster, and has a lot bugs less than the original
53rxvt. This all in addition to dozens of other small improvements. 56rxvt. This all in addition to dozens of other small improvements.
54 57
55It is still faithfully following the original rxvt idea of being lean 58It is still faithfully following the original rxvt idea of being lean
56and nice on resources: for example, you can still configure rxvt-unicode 59and nice on resources: for example, you can still configure rxvt-unicode
57without most of it's features to get a lean binary. It also comes with 60without most of its features to get a lean binary. It also comes with
58a client/daemon pair that lets you open any number of terminal windows 61a client/daemon pair that lets you open any number of terminal windows
59from within a single process, which makes startup time very fast and 62from within a single process, which makes startup time very fast and
60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 63drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61@@RXVT_NAME@@c(1) (client). 64@@RXVT_NAME@@c(1) (client).
62 65
63It also makes technical information about escape sequences (which have 66It also makes technical information about escape sequences (which have
64been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 67been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65reference documentation (escape sequences etc.). 68reference documentation (escape sequences etc.).
66 69
67=head1 OPTIONS 70=head1 OPTIONS
68 71
69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed 72The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
89 92
90Print out a message describing available options. 93Print out a message describing available options.
91 94
92=item B<-display> I<displayname> 95=item B<-display> I<displayname>
93 96
94Attempt to open a window on the named X display (B<-d> still 97Attempt to open a window on the named X display (the older form B<-d>
95respected). In the absence of this option, the display specified by the 98is still respected. but deprecated). In the absence of this option, the
96B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
100
101=item B<-depth> I<bitdepth>
102
103Compile I<xft>: Attempt to find a visual with the given bit depth;
104resource B<depth>.
105
106[Please note that many X servers (and libXft) are buggy with
107respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out]
97 110
98=item B<-geometry> I<geom> 111=item B<-geometry> I<geom>
99 112
100Window geometry (B<-g> still respected); resource B<geometry>. 113Window geometry (B<-g> still respected); resource B<geometry>.
101 114
103 116
104Turn on/off simulated reverse video; resource B<reverseVideo>. 117Turn on/off simulated reverse video; resource B<reverseVideo>.
105 118
106=item B<-j>|B<+j> 119=item B<-j>|B<+j>
107 120
108Turn on/off jump scrolling; resource B<jumpScroll>. 121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109 122
110=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 123=item B<-ss>|B<+ss>
111 124
112Turn on/off inheriting parent window's pixmap. Alternative form is 125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
113B<-tr>; resource B<inheritPixmap>. 126
127=item B<-tr>|B<+tr>
128
129Turn on/off illusion of a transparent window background; resource B<transparent>.
130
131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions.
133
134I<Please address all transparency related issues to Sasha Vasko at
135sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
114 136
115=item B<-fade> I<number> 137=item B<-fade> I<number>
116 138
117Fade the text by the given percentage when focus is lost. Small values 139Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade 140fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>. 141colour; resource B<fading>.
120 142
121=item B<-fadecolor> I<colour> 143=item B<-fadecolor> I<colour>
122 144
123Fade to this colour when fading is used (see B<-fade>). The default colour 145Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>. 146is opaque black. resource B<fadeColor>.
125 147
126=item B<-tint> I<colour> 148=item B<-tint> I<colour>
127 149
128Tint the transparent background pixmap with the given colour when 150Tint the transparent background pixmap with the given colour when
129transparency is enabled with B<-tr> or B<-ip>. This only works for 151transparency is enabled with B<-tr>. This only works for
130non-tiled backgrounds, currently. See also the B<-sh> option that can be 152non-tiled backgrounds, currently. See also the B<-sh> option that can be
131used to brighten or darken the image in addition to tinting it; resource 153used to brighten or darken the image in addition to tinting it.
154Please note that certain tint colours can be applied on the server-side,
155thus yielding performance gain of two orders of magnitude. These colours are:
156blue, red, green, cyan, magenta, yellow, and those close to them. Also
157pure black and pure white colours essentially mean no tinting; resource
132I<tintColor>. Example: 158I<tintColor>. Example:
133 159
134 @@RXVT_NAME@@ -tr -tint blue -sh 40 160 @@RXVT_NAME@@ -tr -tint blue -sh 40
135 161
136=item B<-sh> 162=item B<-sh> I<number>
137 163
138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 164Darken (0 .. 100) or lighten (100 .. 200) the transparent
139background image in addition to tinting it (i.e. B<-tint> must be 165background image in addition to (or instead of) tinting it;
140specified, too, e.g. C<-tint white>). 166resource I<shading>.
167
168=item B<-blt> I<string>
169
170Specify background blending type. If background pixmap is specified
171at the same time as transparency - such pixmap will be blended over
172transparency image, using method specified. Supported values are :
173B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176alpha-blending. Compile I<afterimage>; resource I<blendType>.
177
178=item B<-blr> I<HxV>
179
180Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and
182horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
185resource I<blurRadius>.
186
187=item B<-icon> I<file>
188
189Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
190is used by many window managers, taskbars and pagers to represent the
191application window; resource I<iconFile>.
141 192
142=item B<-bg> I<colour> 193=item B<-bg> I<colour>
143 194
144Window background colour; resource B<background>. 195Window background colour; resource B<background>.
145 196
146=item B<-fg> I<colour> 197=item B<-fg> I<colour>
147 198
148Window foreground colour; resource B<foreground>. 199Window foreground colour; resource B<foreground>.
149 200
150=item B<-pixmap> I<file[;geom]> 201=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
151 202
152Compile I<XPM>: Specify XPM file for the background and also optionally 203Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
153specify its scaling with a geometry string. Note you may need to 204optionally specify its scaling with a geometry string. Note you may need to
154add quotes to avoid special shell interpretation of the C<;> in the 205add quotes to avoid special shell interpretation of the C<;> in the
155command-line; resource B<backgroundPixmap>. 206command-line; for more details see resource B<backgroundPixmap>.
156 207
157=item B<-cr> I<colour> 208=item B<-cr> I<colour>
158 209
159The cursor colour; resource B<cursorColor>. 210The cursor colour; resource B<cursorColor>.
160 211
177that are checked in order when trying to find glyphs for characters. The 228that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 229first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 230smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 231font list is always appended to it. See resource B<font> for more details.
181 232
182In short, to specify an X11 core font, just specify it's name or prefix it 233In 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:>, 234with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.: 235e.g.:
185 236
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 237 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 238 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
205italic> >> characters are to be printed. See resource B<boldItalicFont> 256italic> >> characters are to be printed. See resource B<boldItalicFont>
206for details. 257for details.
207 258
208=item B<-is>|B<+is> 259=item B<-is>|B<+is>
209 260
210Compile I<font-styles>: Bold/Italic font styles imply high intensity 261Compile I<font-styles>: Bold/Blink font styles imply high intensity
211foreground/background (default). See resource B<intensityStyles> for 262foreground/background (default). See resource B<intensityStyles> for
212details. 263details.
213 264
214=item B<-name> I<name> 265=item B<-name> I<name>
215 266
233 284
234=item B<-sb>|B<+sb> 285=item B<-sb>|B<+sb>
235 286
236Turn on/off scrollbar; resource B<scrollBar>. 287Turn on/off scrollbar; resource B<scrollBar>.
237 288
289=item B<-sr>|B<+sr>
290
291Put scrollbar on right/left; resource B<scrollBar_right>.
292
293=item B<-st>|B<+st>
294
295Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
296resource B<scrollBar_floating>.
297
238=item B<-si>|B<+si> 298=item B<-si>|B<+si>
239 299
240Turn on/off scroll-to-bottom on TTY output inhibit; resource 300Turn on/off scroll-to-bottom on TTY output inhibit; resource
241B<scrollTtyOutput> has opposite effect. 301B<scrollTtyOutput> has opposite effect.
242 302
248=item B<-sw>|B<+sw> 308=item B<-sw>|B<+sw>
249 309
250Turn on/off scrolling with the scrollback buffer as new lines appear. 310Turn on/off scrolling with the scrollback buffer as new lines appear.
251This only takes effect if B<-si> is also given; resource 311This only takes effect if B<-si> is also given; resource
252B<scrollWithBuffer>. 312B<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 313
263=item B<-ptab>|B<+ptab> 314=item B<-ptab>|B<+ptab>
264 315
265If enabled (default), "Horizontal Tab" characters are being stored as 316If enabled (default), "Horizontal Tab" characters are being stored as
266actual wide characters in the screen buffer, which makes it possible to 317actual wide characters in the screen buffer, which makes it possible to
270 321
271=item B<-bc>|B<+bc> 322=item B<-bc>|B<+bc>
272 323
273Blink the cursor; resource B<cursorBlink>. 324Blink the cursor; resource B<cursorBlink>.
274 325
326=item B<-uc>|B<+uc>
327
328Make the cursor underlined; resource B<cursorUnderline>.
329
275=item B<-iconic> 330=item B<-iconic>
276 331
277Start iconified, if the window manager supports that option. 332Start iconified, if the window manager supports that option.
278Alternative form is B<-ic>. 333Alternative form is B<-ic>.
279 334
295 350
296=item B<-bl> 351=item B<-bl>
297 352
298Compile I<frills>: Set MWM hints to request a borderless window, i.e. 353Compile 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 354if honoured by the WM, the rxvt-unicode window will not have window
300decorations; resource B<borderLess>. 355decorations; resource B<borderLess>. If the window manager does not
356support MWM hints (e.g. kwin), enables override-redirect mode.
357
358=item B<-override-redirect>
359
360Compile I<frills>: Sets override-redirect on the window; resource
361B<override-redirect>.
301 362
302=item B<-sbg> 363=item B<-sbg>
303 364
304Compile I<frills>: Disable the usage of the built-in block graphics/line 365Compile I<frills>: Disable the usage of the built-in block graphics/line
305drawing characters and just rely on what the specified fonts provide. Use 366drawing characters and just rely on what the specified fonts provide. Use
308 369
309=item B<-lsp> I<number> 370=item B<-lsp> I<number>
310 371
311Compile I<frills>: Lines (pixel height) to insert between each row of 372Compile I<frills>: Lines (pixel height) to insert between each row of
312the display. Useful to work around font rendering problems; resource 373the display. Useful to work around font rendering problems; resource
313B<linespace>. 374B<lineSpace>.
375
376=item B<-letsp> I<number>
377
378Compile I<frills>: Amount to adjust the computed character width by
379to control overall letter spacing. Negative values will tighten up the
380letter spacing, positive values will space letters out more. Useful to
381work around odd font metrics; resource B<letterSpace>.
314 382
315=item B<-tn> I<termname> 383=item B<-tn> I<termname>
316 384
317This option specifies the name of the terminal type to be set in the 385This option specifies the name of the terminal type to be set in the
318B<TERM> environment variable. This terminal type must exist in the 386B<TERM> environment variable. This terminal type must exist in the
372for more info. 440for more info.
373 441
374=item B<-tcw> 442=item B<-tcw>
375 443
376Change the meaning of triple-click selection with the left mouse 444Change the meaning of triple-click selection with the left mouse
445button. Only effective when the original (non-perl) selection code is
377button. Instead of selecting a full line it will extend the selection the 446in-use. Instead of selecting a full line it will extend the selection to
378end of the logical line only. resource B<tripleclickwords>. 447the end of the logical line only. resource B<tripleclickwords>.
379 448
380=item B<-insecure> 449=item B<-insecure>
381 450
382Enable "insecure" mode, which currently enables most of the escape 451Enable "insecure" mode, which currently enables most of the escape
383sequences that echo strings. See the resource B<insecure> for more 452sequences that echo strings. See the resource B<insecure> for more
404Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 473Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
405will not immediately destroy its window when the program executed within 474will 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 475it exits. Instead, it will wait till it is being killed or closed by the
407user; resource B<hold>. 476user; resource B<hold>.
408 477
478=item B<-cd> I<path>
479
480Sets the working directory for the shell (or the command specified via
481B<-e>). The I<path> must be an absolute path and it must exist for
482@@RXVT_NAME@@ to start; resource B<chdir>.
483
484=item B<-xrm> I<string>
485
486Works like the X Toolkit option of the same name, by adding the I<string>
487as if it were specified in a resource file. Resource values specified this
488way take precedence over all other resource specifications.
489
490Note that you need to use the I<same> syntax as in the .Xdefaults file,
491e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
492options can be specified as long-options on the commandline, so use
493of B<-xrm> is mostly limited to cases where you want to specify other
494resources (e.g. for input methods) or for compatibility with other
495programs.
496
409=item B<-keysym.>I<sym> I<string> 497=item B<-keysym.>I<sym> I<string>
410 498
411Remap a key symbol. See resource B<keysym>. 499Remap a key symbol. See resource B<keysym>.
412 500
413=item B<-embed> I<windowid> 501=item B<-embed> I<windowid>
414 502
415Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 503Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
416which enables applications to easily embed a terminal. 504which enables applications to easily embed a terminal.
417 505
418Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 506Right 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 507shouldn'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 508quite 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. 511The window will not be destroyed when @@RXVT_NAME@@ exits.
424 512
425It might be useful to know that @@RXVT_NAME@@ will not close file 513It 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 514descriptors passed to it (except for stdin/out/err, of course), so you
427can use file descriptors to communicate with the programs within the 515can use file descriptors to communicate with the programs within the
428terminal. This works regardless of wether the C<-embed> option was used or 516terminal. This works regardless of whether the C<-embed> option was used or
429not. 517not.
430 518
431Here is a short Gtk2-perl snippet that illustrates how this option can be 519Here is a short Gtk2-perl snippet that illustrates how this option can be
432used (a longer example is in F<doc/embed>): 520used (a longer example is in F<doc/embed>):
433 521
438 }); 526 });
439 527
440=item B<-pty-fd> I<file descriptor> 528=item B<-pty-fd> I<file descriptor>
441 529
442Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 530Tells @@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 531pair 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 532useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445without having to run a program within it. 533without having to run a program within it.
446 534
447If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 535If 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 536entries and will not tinker with pty/tty permissions - you have to do that
449yourself if you want that. 537yourself if you want that.
450 538
451As an extremely special case, specifying C<-1> will completely suppress 539As an extremely special case, specifying C<-1> will completely suppress
452pty/tty operations. 540pty/tty operations, which is probably only useful in conjunction with some
541perl extension that manages the terminal.
453 542
454Here is a example in perl that illustrates how this option can be used (a 543Here is a example in perl that illustrates how this option can be used (a
455longer example is in F<doc/pty-fd>): 544longer example is in F<doc/pty-fd>):
456 545
457 use IO::Pty; 546 use IO::Pty;
471Comma-separated list of perl extension scripts to use (or not to use) in 560Comma-separated list of perl extension scripts to use (or not to use) in
472this terminal instance. See resource B<perl-ext> for details. 561this terminal instance. See resource B<perl-ext> for details.
473 562
474=back 563=back
475 564
476=head1 RESOURCES (available also as long-options) 565=head1 RESOURCES
477 566
478Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 567Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
479options) compiled into your version. 568options) compiled into your version. All resources are also available as
569long-options.
480 570
481You can set and change the resources using X11 tools like B<xrdb>. Many 571You can set and change the resources using X11 tools like B<xrdb>. Many
482distribution do also load settings from the B<~/.Xresources> file when X 572distribution do also load settings from the B<~/.Xresources> file when X
483starts. @@RXVT_NAME@@ will consult the following files/resources in order, 573starts. @@RXVT_NAME@@ will consult the following files/resources in order,
484with later settings overwriting earlier ones: 574with later settings overwriting earlier ones:
486 1. system-wide app-defaults file, either locale-dependent OR global 576 1. system-wide app-defaults file, either locale-dependent OR global
487 2. app-defaults file in $XAPPLRESDIR 577 2. app-defaults file in $XAPPLRESDIR
488 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 578 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
489 4. SCREEN_RESOURCES for the current screen 579 4. SCREEN_RESOURCES for the current screen
490 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 580 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
581 6. resources specified via -xrm on the commandline
491 582
492Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 583Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
493names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 584names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
494common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily 585common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
495configured, while the class name B<URxvt> allows resources unique to 586configured, while the class name B<URxvt> allows resources unique to
500check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 591check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
501extensions not documented here): 592extensions not documented here):
502 593
503=over 4 594=over 4
504 595
596=item B<depth:> I<bitdepth>
597
598Compile I<xft>: Attempt to find a visual with the given bit depth;
599option B<-depth>.
600
601=item B<buffered:> I<boolean>
602
603Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
604On some card/driver combination enabling it slightly decreases
605performance, on most it greatly helps it. The slowdown is small, so it
606should normally be enabled.
607
505=item B<geometry:> I<geom> 608=item B<geometry:> I<geom>
506 609
507Create the window with the specified X window geometry [default 80x24]; 610Create the window with the specified X window geometry [default 80x24];
508option B<-geometry>. 611option B<-geometry>.
509 612
522Use the specified colour for the colour value I<n>, where 0-7 625Use the specified colour for the colour value I<n>, where 0-7
523corresponds to low-intensity (normal) colours and 8-15 corresponds to 626corresponds to low-intensity (normal) colours and 8-15 corresponds to
524high-intensity (bold = bright foreground, blink = bright background) 627high-intensity (bold = bright foreground, blink = bright background)
525colours. The canonical names are as follows: 0=black, 1=red, 2=green, 628colours. The canonical names are as follows: 0=black, 1=red, 2=green,
5263=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 6293=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
527names used are listed in the B<COLORS AND GRAPHICS> section. 630names used are listed in the B<COLOURS AND GRAPHICS> section.
528 631
529Colours higher than 15 cannot be set using resources (yet), but can be 632Colours higher than 15 cannot be set using resources (yet), but can be
530changed using an escape command (see @@RXVT_NAME@@(7)). 633changed using an escape command (see @@RXVT_NAME@@(7)).
531 634
532Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 635Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
543=item B<colorUL:> I<colour> 646=item B<colorUL:> I<colour>
544 647
545Use the specified colour to display underlined characters when the 648Use the specified colour to display underlined characters when the
546foreground colour is the default. 649foreground colour is the default.
547 650
548=item B<colorRV:> I<colour>
549
550Use the specified colour as the background for reverse video
551characters.
552
553=item B<underlineColor:> I<colour> 651=item B<underlineColor:> I<colour>
554 652
555If set, use the specified colour as the colour for the underline 653If set, use the specified colour as the colour for the underline
556itself. If unset, use the foreground colour. 654itself. If unset, use the foreground colour.
655
656=item B<highlightColor:> I<colour>
657
658If set, use the specified colour as the background for highlighted
659characters. If unset, use reverse video.
660
661=item B<highlightTextColor:> I<colour>
662
663If set and highlightColor is set, use the specified colour as the
664foreground for highlighted characters.
557 665
558=item B<cursorColor:> I<colour> 666=item B<cursorColor:> I<colour>
559 667
560Use the specified colour for the cursor. The default is to use the 668Use the specified colour for the cursor. The default is to use the
561foreground colour; option B<-cr>. 669foreground colour; option B<-cr>.
568 676
569=item B<reverseVideo:> I<boolean> 677=item B<reverseVideo:> I<boolean>
570 678
571B<True>: simulate reverse video by foreground and background colours; 679B<True>: simulate reverse video by foreground and background colours;
572option B<-rv>. B<False>: regular screen colours [default]; option 680option B<-rv>. B<False>: regular screen colours [default]; option
573B<+rv>. See note in B<COLORS AND GRAPHICS> section. 681B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
574 682
575=item B<jumpScroll:> I<boolean> 683=item B<jumpScroll:> I<boolean>
576 684
577B<True>: specify that jump scrolling should be used. When scrolling 685B<True>: specify that jump scrolling should be used. When receiving lots
578quickly, fewer screen updates are performed [default]; option B<-j>. 686of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
687has been read, resulting in fewer updates while still displaying every
688received line; option B<-j>.
689
579B<False>: specify that smooth scrolling should be used; option B<+j>. 690B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
691force a screen refresh on each new line it received; option B<+j>.
580 692
581=item B<inheritPixmap:> I<boolean> 693=item B<skipScroll:> I<boolean>
582 694
583B<True>: make the background inherit the parent windows' pixmap, giving 695B<True>: (the default) specify that skip scrolling should be used. When
584artificial transparency. B<False>: do not inherit the parent windows' 696receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
585pixmap. 697(around 60 times per second), resulting in far fewer updates. This can
698result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
699option B<-ss>.
700
701B<False>: specify that everything is to be displayed, even
702if the refresh is too fast for the human eye to read anything (or the
703monitor to display anything); option B<+ss>.
704
705=item B<transparent:> I<boolean>
706
707Turn on/off illusion of a transparent window background.
708
709B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
710future versions.
711
712I<Please address all transparency related issues to Sasha Vasko at
713sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
586 714
587=item B<fading:> I<number> 715=item B<fading:> I<number>
588 716
589Fade the text by the given percentage when focus is lost; option B<-fade>. 717Fade the text by the given percentage when focus is lost; option B<-fade>.
590 718
598Tint the transparent background pixmap with the given colour; option 726Tint the transparent background pixmap with the given colour; option
599B<-tint>. 727B<-tint>.
600 728
601=item B<shading:> I<number> 729=item B<shading:> I<number>
602 730
603Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 731Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
604image in addition to tinting it. 732in addition to tinting it; option B<-sh>.
733
734=item B<blendType:> I<string>
735
736Specify background blending type; option B<-blt>.
737
738=item B<blurRadius:> I<number>
739
740Apply gaussian blur with the specified radius to the transparent
741background image; option B<-blr>.
742
743=item B<iconFile:> I<file>
744
745Set the application icon pixmap; option B<-icon>.
605 746
606=item B<scrollColor:> I<colour> 747=item B<scrollColor:> I<colour>
607 748
608Use the specified colour for the scrollbar [default #B2B2B2]. 749Use the specified colour for the scrollbar [default #B2B2B2].
609 750
615=item B<borderColor:> I<colour> 756=item B<borderColor:> I<colour>
616 757
617The colour of the border around the text area and between the scrollbar 758The colour of the border around the text area and between the scrollbar
618and the text. 759and the text.
619 760
620=item B<backgroundPixmap:> I<file[;geom]> 761=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
621 762
622Use the specified XPM file (note the `.xpm' extension is optional) for 763Use the specified image file for the background and also
623the background and also optionally specify its scaling with a geometry 764optionally specify its scaling with a geometry string B<WxH+X+Y>,
624string B<WxH+X+Y>, in which B<"W" / "H"> specify the 765(default C<100x100+50+50>) in which B<"W" / "H"> specify the
625horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 766horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
626centre (percent). A scale of 0 displays the image with tiling. A scale 767centre (percent). A scale of 0 displays the image with tiling.
627of 1 displays the image without any scaling. A scale of 2 to 9 768The maximum permitted scale is 1000.
628specifies an integer number of images in that direction. No image will 769Additional operations can be specified after colon B<:op1:op2...>.
629be magnified beyond 10 times its original size. The maximum permitted 770Supported operations are:
630scale is 1000. [default 0x0+50+50] 771
772 tile force background image to be tiled and not scaled. Equivalent to 0x0
773 propscale will scale image keeping proportions
774 auto will scale image to match window size. Equivalent to 100x100
775 hscale will scale image horizontally to the window size
776 vscale will scale image vertically to the window size
777 scale will scale image to match window size
778 root will tile image as if it was a root window background, auto-adjusting
779 whenever terminal window moves
780
781If used in conjunction with B<-tr> option, the specified pixmap will be
782blended over transparency image using either alpha-blending, or any
783other blending type, specified with B<-blt "type"> option.
631 784
632=item B<path:> I<path> 785=item B<path:> I<path>
633 786
634Specify the colon-delimited search path for finding XPM files. 787Specify the colon-delimited search path for finding background image files.
635 788
636=item B<font:> I<fontlist> 789=item B<font:> I<fontlist>
637 790
638Select the fonts to be used. This is a comma separated list of font names 791Select the fonts to be used. This is a comma separated list of font names
639that are checked in order when trying to find glyphs for characters. The 792that are checked in order when trying to find glyphs for characters. The
662it is named first) and thus defines the character cell grid to be 9 pixels 815it is named first) and thus defines the character cell grid to be 9 pixels
663wide and 15 pixels high. 816wide and 15 pixels high.
664 817
665The second font is just used to add additional unicode characters not in 818The second font is just used to add additional unicode characters not in
666the base font, likewise the third, which is unfortunately non-bold, but 819the base font, likewise the third, which is unfortunately non-bold, but
667the bold version of the font does contain less characters, so this is a 820the bold version of the font does contain fewer characters, so this is a
668useful supplement. 821useful supplement.
669 822
670The third font is an Xft font with aliasing turned off, and the characters 823The third font is an Xft font with aliasing turned off, and the characters
671are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 824are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
672contains other characters, but we are not interested in them. 825contains other characters, but we are not interested in them.
696text font will being used for the given style. 849text font will being used for the given style.
697 850
698=item B<intensityStyles:> I<boolean> 851=item B<intensityStyles:> I<boolean>
699 852
700When font styles are not enabled, or this option is enabled (B<True>, 853When font styles are not enabled, or this option is enabled (B<True>,
701option B<-is>, the default), bold and italic font styles imply high 854option B<-is>, the default), bold/blink font styles imply high
702intensity foreground/backround colours. Disabling this option (B<False>, 855intensity foreground/background colours. Disabling this option (B<False>,
703option B<+is>) disables this behaviour, the high intensity colours are not 856option B<+is>) disables this behaviour, the high intensity colours are not
704reachable. 857reachable.
705
706=item B<selectstyle:> I<mode>
707
708Set mouse selection style to B<old> which is 2.20, B<oldword> which is
709xterm style with 2.20 old word selection, or anything else which gives
710xterm style selection.
711
712=item B<scrollstyle:> I<mode>
713
714Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
715the author's favourite.
716 858
717=item B<title:> I<string> 859=item B<title:> I<string>
718 860
719Set window title string, the default title is the command-line 861Set window title string, the default title is the command-line
720specified after the B<-e> option, if any, otherwise the application 862specified after the B<-e> option, if any, otherwise the application
729=item B<mapAlert:> I<boolean> 871=item B<mapAlert:> I<boolean>
730 872
731B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 873B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
732de-iconify (map) on receipt of a bell character [default]. 874de-iconify (map) on receipt of a bell character [default].
733 875
876=item B<urgentOnBell:> I<boolean>
877
878B<True>: set the urgency hint for the wm on receipt of a bell character.
879B<False>: do not set the urgency hint [default].
880
881@@RXVT_NAME@@ resets the urgency hint on every focus change.
882
734=item B<visualBell:> I<boolean> 883=item B<visualBell:> I<boolean>
735 884
736B<True>: use visual bell on receipt of a bell character; option B<-vb>. 885B<True>: use visual bell on receipt of a bell character; option B<-vb>.
737B<False>: no visual bell [default]; option B<+vb>. 886B<False>: no visual bell [default]; option B<+vb>.
738 887
759Example: 908Example:
760 909
761 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 910 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
762 911
763This creates a new file in your home directory with the screen contents 912This creates a new file in your home directory with the screen contents
764everytime you hit C<Print>. 913every time you hit C<Print>.
914
915=item B<scrollstyle:> I<mode>
916
917Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
918the author's favourite.
765 919
766=item B<scrollBar:> I<boolean> 920=item B<scrollBar:> I<boolean>
767 921
768B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 922B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
769disable the scrollbar; option B<+sb>. 923disable the scrollbar; option B<+sb>.
791 945
792=item B<scrollWithBuffer:> I<boolean> 946=item B<scrollWithBuffer:> I<boolean>
793 947
794B<True>: scroll with scrollback buffer when tty receives new lines (and 948B<True>: scroll with scrollback buffer when tty receives new lines (and
795B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 949B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
796with scrollback buffer when tty recieves new lines; option B<+sw>. 950with scrollback buffer when tty receives new lines; option B<+sw>.
797 951
798=item B<scrollTtyKeypress:> I<boolean> 952=item B<scrollTtyKeypress:> I<boolean>
799 953
800B<True>: scroll to bottom when a non-special key is pressed. Special keys 954B<True>: scroll to bottom when a non-special key is pressed. Special keys
801are those which are intercepted by rxvt-unicode for special handling and 955are those which are intercepted by rxvt-unicode for special handling and
832=item B<termName:> I<termname> 986=item B<termName:> I<termname>
833 987
834Specifies the terminal type name to be set in the B<TERM> environment 988Specifies the terminal type name to be set in the B<TERM> environment
835variable; option B<-tn>. 989variable; option B<-tn>.
836 990
837=item B<linespace:> I<number> 991=item B<lineSpace:> I<number>
838 992
839Specifies number of lines (pixel height) to insert between each row of 993Specifies number of lines (pixel height) to insert between each row of
840the display [default 0]; option B<-lsp>. 994the display [default 0]; option B<-lsp>.
841 995
842=item B<meta8:> I<boolean> 996=item B<meta8:> I<boolean>
856 1010
857=item B<cursorBlink:> I<boolean> 1011=item B<cursorBlink:> I<boolean>
858 1012
859B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 1013B<True>: blink the cursor. B<False>: do not blink the cursor [default];
860option B<-bc>. 1014option B<-bc>.
1015
1016=item B<cursorUnderline:> I<boolean>
1017
1018B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1019option B<-uc>.
861 1020
862=item B<pointerBlank:> I<boolean> 1021=item B<pointerBlank:> I<boolean>
863 1022
864B<True>: blank the pointer when a key is pressed or after a set number 1023B<True>: blank the pointer when a key is pressed or after a set number
865of seconds of inactivity. B<False>: the pointer is always visible 1024of seconds of inactivity. B<False>: the pointer is always visible
879large number (e.g. C<987654321>) to effectively disable the timeout. 1038large number (e.g. C<987654321>) to effectively disable the timeout.
880 1039
881=item B<backspacekey:> I<string> 1040=item B<backspacekey:> I<string>
882 1041
883The string to send when the backspace key is pressed. If set to B<DEC> 1042The string to send when the backspace key is pressed. If set to B<DEC>
884or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 1043or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
885(code 8) - which can be reversed with the appropriate DEC private mode 1044(code 8) - which can be reversed with the appropriate DEC private mode
886escape sequence. 1045escape sequence.
887 1046
888=item B<deletekey:> I<string> 1047=item B<deletekey:> I<string>
889 1048
891pressed. If unset it will send the sequence traditionally associated 1050pressed. If unset it will send the sequence traditionally associated
892with the B<Execute> key. 1051with the B<Execute> key.
893 1052
894=item B<cutchars:> I<string> 1053=item B<cutchars:> I<string>
895 1054
896The characters used as delimiters for double-click word selection. The 1055The characters used as delimiters for double-click word selection
897built-in default: 1056(whitespace delimiting is added automatically if resource is given).
898 1057
1058When the perl selection extension is in use (the default if compiled
1059in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
1060characters will be created (if the resource exists, otherwise, no regex
1061will be created). In this mode, characters outside ISO-8859-1 can be used.
1062
1063When the selection extension is not used, only ISO-8859-1 characters can
1064be used. If not specified, the built-in default is used:
1065
899B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1066B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
900 1067
901=item B<preeditType:> I<style> 1068=item B<preeditType:> I<style>
902 1069
903B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1070B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
904 1071
952 1119
953Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1120Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
954character is passed through. It may contain escape values as described 1121character is passed through. It may contain escape values as described
955in the entry on B<keysym> following. 1122in the entry on B<keysym> following.
956 1123
957=item B<secondaryScreen:> I<bool> 1124=item B<secondaryScreen:> I<boolean>
958 1125
959Turn on/off secondary screen (default enabled). 1126Turn on/off secondary screen (default enabled).
960 1127
961=item B<secondaryScroll:> I<bool> 1128=item B<secondaryScroll:> I<boolean>
962 1129
963Turn on/off secondary screen scroll (default enabled). If the this 1130Turn on/off secondary screen scroll (default enabled). If this
964option is enabled, scrolls on the secondary screen will change the 1131option is enabled, scrolls on the secondary screen will change the
965scrollback buffer and switching to/from the secondary screen will 1132scrollback buffer and, when secondaryScreen is off, switching
966instead scroll the screen up. 1133to/from the secondary screen will instead scroll the screen up.
967 1134
968=item B<hold>: I<bool> 1135=item B<hold>: I<boolean>
969 1136
970Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1137Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
971will not immediately destroy its window when the program executed within 1138will not immediately destroy its window when the program executed within
972it exits. Instead, it will wait till it is being killed or closed by the 1139it exits. Instead, it will wait till it is being killed or closed by the
973user. 1140user.
1141
1142=item B<chdir>: I<path>
1143
1144Sets the working directory for the shell (or the command specified via
1145B<-e>). The I<path> must be an absolute path and it must exist for
1146@@RXVT_NAME@@ to start. If it isn't specified then the current working
1147directory will be used; option B<-cd>.
974 1148
975=item B<keysym.>I<sym>: I<string> 1149=item B<keysym.>I<sym>: I<string>
976 1150
977Compile I<frills>: Associate I<string> with keysym I<sym>. The 1151Compile I<frills>: Associate I<string> with keysym I<sym>. The
978intervening resource name B<keysym.> cannot be omitted. 1152intervening resource name B<keysym.> cannot be omitted.
992searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1166searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
993omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1167omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
994keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1168keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
995performed in an exact manner; however, the closest match is assured. 1169performed in an exact manner; however, the closest match is assured.
996 1170
997I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1171I<string> may contain escape values (C<\n>: newline, C<\000>: octal
998C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1172number), see RESOURCES in C<man 7 X> for further details.
999C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1000C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1001can start or end with whitespace.
1002
1003Please note that you need to double the C<\> in resource files, as
1004Xlib itself does it's own de-escaping (you can use C<\033> instead of
1005C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1006processing).
1007 1173
1008You can define a range of keysyms in one shot by providing a I<string> 1174You can define a range of keysyms in one shot by providing a I<string>
1009with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1175with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1010should be a character not used by the strings. 1176should be a character not used by the strings.
1011 1177
1012Its usage can be demonstrated by an example: 1178Its usage can be demonstrated by an example:
1013 1179
1014 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1180 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1025when Control-Meta-c is being pressed": 1191when Control-Meta-c is being pressed":
1026 1192
1027 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1193 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1028 1194
1029If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1195If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1030is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1196is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1031manpage. For example, the F<selection> extension (activated via 1197manpage. For example, the F<selection> extension (activated via
1032C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1198C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1033 1199
1034 URxvt.keysym.M-C-c: perl:selection:rot13 1200 URxvt.keysym.M-C-c: perl:selection:rot13
1035 1201
1036Due the the large number of modifier combinations, a defined key mapping 1202Due the the large number of modifier combinations, a defined key mapping
1037will match if at I<at least> the specified identifiers are being set, and 1203will match if I<at least> the specified identifiers are being set, and
1038no other key mappings with those and more bits are being defined. That 1204no other key mappings with those and more bits are being defined. That
1039means that defining a key map for C<a> will automatically provide 1205means that defining a key map for C<a> will automatically provide
1040definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined 1206definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1041mappings themselves. 1207mappings themselves.
1042 1208
1078example, C<default,-selection> will use all the default extension except 1244example, C<default,-selection> will use all the default extension except
1079C<selection>. 1245C<selection>.
1080 1246
1081Extension names can also be followed by an argument in angle brackets 1247Extension names can also be followed by an argument in angle brackets
1082(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1248(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1083searchable scorllback to Alt/Meta-s). Mentioning the same extension 1249searchable scrollback to Alt/Meta-s). Mentioning the same extension
1084multiple times with different arguments will pass multiple arguments to 1250multiple times with different arguments will pass multiple arguments to
1085the extension. 1251the extension.
1086 1252
1087Each extension is looked up in the library directories, loaded if 1253Each extension is looked up in the library directories, loaded if
1088necessary, and bound to the current terminal instance. 1254necessary, and bound to the current terminal instance.
1093all instances, while B<perl-ext> is used for specific instances. 1259all instances, while B<perl-ext> is used for specific instances.
1094 1260
1095=item B<perl-eval>: I<string> 1261=item B<perl-eval>: I<string>
1096 1262
1097Perl code to be evaluated when all extensions have been registered. See 1263Perl code to be evaluated when all extensions have been registered. See
1098the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1264the @@RXVT_NAME@@perl(3) manpage.
1099will be ignored when running setuid/setgid.
1100 1265
1101=item B<perl-lib>: I<path> 1266=item B<perl-lib>: I<path>
1102 1267
1103Colon-separated list of additional directories that hold extension 1268Colon-separated list of additional directories that hold extension
1104scripts. When looking for extensions specified by the C<perl> resource, 1269scripts. When looking for extensions specified by the C<perl> resource,
1105@@RXVT_NAME@@ will first look in these directories and then in 1270@@RXVT_NAME@@ will first look in these directories and then in
1106F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1271F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1107will be ignored when running setuid/setgid.
1108 1272
1109See the @@RXVT_NAME@@perl(3) manpage. 1273See the @@RXVT_NAME@@perl(3) manpage.
1110 1274
1111=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1275=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1112 1276
1124(default: C<M-s>). 1288(default: C<M-s>).
1125 1289
1126=item B<urlLauncher>: I<string> 1290=item B<urlLauncher>: I<string>
1127 1291
1128Specifies the program to be started with a URL argument. Used by the 1292Specifies the program to be started with a URL argument. Used by the
1129C<selection-popup> and C<mark-urls> perl extensions. 1293C<selection-popup> and C<matcher> perl extensions.
1130 1294
1131=item B<transient-for>: I<windowid> 1295=item B<transient-for>: I<windowid>
1132 1296
1133Sets the WM_TRANSIENT_FOR property to the given window iw. 1297Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1298
1299=item B<override-redirect>: I<boolean>
1300
1301Compile I<frills>: Sets override-redirect for the terminal window, making
1302it almost invisible to window managers; option B<-override-redirect>.
1303
1304=item B<iso14755:> I<boolean>
1305
1306Turn on/off ISO 14755 (default enabled).
1307
1308=item B<iso14755_52:> I<boolean>
1309
1310Turn on/off ISO 14755 5.2 mode (default enabled).
1134 1311
1135=back 1312=back
1136 1313
1137=head1 THE SCROLLBAR 1314=head1 THE SCROLLBAR
1138 1315
1157application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1334application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1158(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1335(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1159up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1336up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1160respectively. 1337respectively.
1161 1338
1162=head1 TEXT SELECTION AND INSERTION 1339=head1 THE SELECTION: SELECTING AND PASTING TEXT
1163 1340
1164The behaviour of text selection and insertion mechanism is similar to 1341The behaviour of text selection and insertion/pasting mechanism is similar
1165I<xterm>(1). 1342to I<xterm>(1).
1166 1343
1167=over 4 1344=over 4
1168 1345
1169=item B<Selection>: 1346=item B<Selecting>:
1170 1347
1171Left click at the beginning of the region, drag to the end of the region 1348Left click at the beginning of the region, drag to the end of the region
1172and release; Right click to extend the marked region; Left double-click 1349and release; Right click to extend the marked region; Left double-click
1173to select a word; Left triple-click to select the entire logical line 1350to select a word; Left triple-click to select the entire logical line
1174(which can span multiple screen lines), unless modified by resource 1351(which can span multiple screen lines), unless modified by resource
1178(Compile: I<frills>) will create a rectangular selection instead of a 1355(Compile: I<frills>) will create a rectangular selection instead of a
1179normal one. In this mode, every selected row becomes its own line in the 1356normal one. In this mode, every selected row becomes its own line in the
1180selection, and trailing whitespace is visually underlined and removed from 1357selection, and trailing whitespace is visually underlined and removed from
1181the selection. 1358the selection.
1182 1359
1183=item B<Insertion>: 1360=item B<Pasting>:
1184 1361
1185Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1362Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1186an B<@@RXVT_NAME@@> window causes the current text selection to be 1363window causes the value of the PRIMARY selection (or CLIPBOARD with the
1187inserted as if it had been typed on the keyboard. 1364B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1365
1366Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1367inserted too.
1188 1368
1189=back 1369=back
1190 1370
1191=head1 CHANGING FONTS 1371=head1 CHANGING FONTS
1192 1372
1206 1386
1207=head1 ISO 14755 SUPPORT 1387=head1 ISO 14755 SUPPORT
1208 1388
1209ISO 14755 is a standard for entering and viewing unicode characters 1389ISO 14755 is a standard for entering and viewing unicode characters
1210and character codes using the keyboard. It consists of 4 parts. The 1390and character codes using the keyboard. It consists of 4 parts. The
1211first part is available rxvt-unicode has been compiled with 1391first part is available if rxvt-unicode has been compiled with
1212C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1392C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1213with C<--enable-iso14755>. 1393with C<--enable-iso14755>.
1214 1394
1215=over 4 1395=over 4
1216 1396
1236This mode lets you input characters representing the keycap symbols of 1416This mode lets you input characters representing the keycap symbols of
1237your keyboard, if representable in the current locale encoding. 1417your keyboard, if representable in the current locale encoding.
1238 1418
1239Start by pressing C<Control> and C<Shift> together, then releasing 1419Start by pressing C<Control> and C<Shift> together, then releasing
1240them. The next special key (cursor keys, home etc.) you enter will not 1420them. The next special key (cursor keys, home etc.) you enter will not
1241invoke it's usual function but instead will insert the corresponding 1421invoke its usual function but instead will insert the corresponding
1242keycap symbol. The symbol will only be entered when the key has been 1422keycap symbol. The symbol will only be entered when the key has been
1243released, otherwise pressing e.g. C<Shift> would enter the symbol for 1423released, otherwise pressing e.g. C<Shift> would enter the symbol for
1244C<ISO Level 2 Switch>, although your intention might have been to enter a 1424C<ISO Level 2 Switch>, although your intention might have been to enter a
1245reverse tab (Shift-Tab). 1425reverse tab (Shift-Tab).
1246 1426
1274B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1454B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1275it can be seen via the I<who(1)> command, and can accept messages. To 1455it can be seen via the I<who(1)> command, and can accept messages. To
1276allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1456allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1277on some systems or setgid to root or to some other group on others. 1457on some systems or setgid to root or to some other group on others.
1278 1458
1279=head1 COLORS AND GRAPHICS 1459=head1 COLOURS AND GRAPHICS
1280 1460
1281In addition to the default foreground and background colours, 1461In addition to the default foreground and background colours,
1282B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1462B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1283high-intensity bold/blink versions of the same). Here is a list of the 1463high-intensity (potentially bold/blink) versions of the same, and 72 (or
1284colours with their B<rgb.txt> names. 1464240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1465cube plus a 8 (24) colour greyscale ramp.
1466
1467Here is a list of the ANSI colours with their names.
1285 1468
1286=begin table 1469=begin table
1287 1470
1288 B<color0> (black) = Black 1471 B<color0> (black) = Black
1289 B<color1> (red) = Red3 1472 B<color1> (red) = Red3
1309It is also possible to specify the colour values of B<foreground>, 1492It is also possible to specify the colour values of B<foreground>,
1310B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1493B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1311a number 0-15, as a convenient shorthand to reference the colour name of 1494a number 0-15, as a convenient shorthand to reference the colour name of
1312color0-color15. 1495color0-color15.
1313 1496
1497The following text gives values for the standard 88 colour mode (and
1498values for the 256 colour mode in parentheses).
1499
1500The RGB cube uses indices 16..79 (16..231) using the following formulas:
1501
1502 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1503 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1504
1505The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1506steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1507the RGB cube.
1508
1509Together, all those colours implement the 88 (256) colour xterm
1510colours. Only the first 16 can be changed using resources currently, the
1511rest can only be changed via command sequences ("escape codes").
1512
1513Applications are advised to use terminfo or command sequences to discover
1514number and RGB values of all colours (yes, you can query this...).
1515
1314Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1516Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1315always swapping the foreground/background colours. This is in contrast to 1517always swapping the foreground/background colours. This is in contrast to
1316I<xterm>(1) where the colours are only swapped if they have not otherwise 1518I<xterm>(1) where the colours are only swapped if they have not otherwise
1317been specified. For example, 1519been specified. For example,
1318 1520
1521 @@RXVT_NAME@@ -fg Black -bg White -rv
1522
1523would yield White on Black, while on I<xterm>(1) it would yield Black on
1524White.
1525
1526=head2 ALPHA CHANNEL SUPPORT
1527
1528If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1529their act together, rxvt-unicode will do it's own alpha channel management:
1530
1531You can prefix any colour with an opaqueness percentage enclosed in
1532brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1533(0-100) that specifies the opacity of the colour, where C<0> is completely
1534transparent and C<100> is completely opaque. For example, C<[50]red> is a
1535half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1536is the recommended format to specify transparency values, and works with
1537all ways to specify a colour.
1538
1539For complete control, rxvt-unicode also supports
1540C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1541specifications, where the additional C<aaaa> component specifies opacity
1542(alpha) values. The minimum value of C<0000> is completely transparent,
1543while C<ffff> is completely opaque). The two example colours from
1544earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1545C<rgba:0000/ff00/0000/f332>.
1546
1547You probably need to specify B<"-depth 32">, too, to force a visual with
1548alpha channels, and have the luck that your X-server uses ARGB pixel
1549layout, as X is far from just supporting ARGB visuals out of the box, and
1550rxvt-unicode just fudges around.
1551
1552For example, the following selects an almost completely transparent black
1553background, and an almost opaque pink foreground:
1554
1555 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1556
1557When not using a background image, then the interpretation of the
1558alpha channel is up to your compositing manager (most interpret it as
1559transparency of course).
1560
1561When using a background pixmap or pseudo-transparency, then the background
1562colour will always behave as if it were completely transparent (so the
1563background image shows instead), regardless of how it was specified, while
1564other colours will either be transparent as specified (the background
1565image will show through) on servers supporting the RENDER extension, or
1566fully opaque on servers not supporting the RENDER EXTENSION.
1567
1568Please note that due to bugs in Xft, specifying alpha values might result
1569in garbage being displayed when the X-server does not support the RENDER
1570extension.
1571
1572=head1 ENVIRONMENT
1573
1574B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1575
1319=over 4 1576=over 4
1320 1577
1321=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1322
1323would yield White on Black, while on I<xterm>(1) it would yield Black
1324on White.
1325
1326=back
1327
1328=head1 ENVIRONMENT
1329
1330B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1331
1332=over 4
1333
1334=item B<TERM> 1578=item B<TERM>
1335 1579
1336Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1580Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1337resources or on the commandline. 1581resources or on the command line.
1338 1582
1339=item B<COLORTERM> 1583=item B<COLORTERM>
1340 1584
1341Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1585Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1342compiled with XPM support, and optionally with the added extension 1586compiled with background image support, and optionally with the added
1343C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1587extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1588screen.
1344 1589
1345=item B<COLORFGBG> 1590=item B<COLORFGBG>
1346 1591
1347Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1592Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1348the colour code used as default foreground/text colour (or the string 1593the colour code used as default foreground/text colour (or the string
1349C<default> to indicate that the default-colour escape sequence is to be 1594C<default> to indicate that the default-colour escape sequence is to be
1350used), C<bg> is the colour code used as default background colour (or the 1595used), C<bg> is the colour code used as default background colour (or the
1351string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1596string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1352was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1597was compiled with background image support. Libraries like C<ncurses>
1353(and do) use this information to optimize screen output. 1598and C<slang> can (and do) use this information to optimize screen output.
1354 1599
1355=item B<WINDOWID> 1600=item B<WINDOWID>
1356 1601
1357Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1602Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1358window, which usually has subwindows for the scrollbar, the terminal 1603window, which usually has subwindows for the scrollbar, the terminal
1364C<--with-terminfo=PATH>. 1609C<--with-terminfo=PATH>.
1365 1610
1366=item B<DISPLAY> 1611=item B<DISPLAY>
1367 1612
1368Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1613Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1369display in it's child processes. 1614display in its child processes if C<-display> isn't used to override. It
1615defaults to C<:0> if it doesn't exist.
1370 1616
1371=item B<SHELL> 1617=item B<SHELL>
1372 1618
1373The shell to be used for command execution, defaults to C</bin/sh>. 1619The shell to be used for command execution, defaults to C</bin/sh>.
1374
1375=item B<RXVTPATH>
1376
1377The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1378files.
1379
1380=item B<PATH>
1381
1382Used in the same way as C<RXVTPATH>.
1383 1620
1384=item B<RXVT_SOCKET> 1621=item B<RXVT_SOCKET>
1385 1622
1386The unix domain socket path used by @@RXVT_NAME@@c(1) and 1623The unix domain socket path used by @@RXVT_NAME@@c(1) and
1387@@RXVT_NAME@@d(1). 1624@@RXVT_NAME@@d(1).
1409 1646
1410=over 4 1647=over 4
1411 1648
1412=item B</usr/lib/X11/rgb.txt> 1649=item B</usr/lib/X11/rgb.txt>
1413 1650
1414Color names. 1651Colour names.
1415 1652
1416=back 1653=back
1417 1654
1418=head1 SEE ALSO 1655=head1 SEE ALSO
1419 1656
1425 1662
1426=item Project Coordinator 1663=item Project Coordinator
1427 1664
1428Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1665Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1429 1666
1430L<http://software.schmorp.de/#rxvt-unicode> 1667L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1431 1668
1432=back 1669=back
1433 1670
1434=head1 AUTHORS 1671=head1 AUTHORS
1435 1672
1457 1694
1458Project Coordinator (changes.txt 2.21a to 2.4.5) 1695Project Coordinator (changes.txt 2.21a to 2.4.5)
1459 1696
1460=item Geoff Wing L<< <gcw@pobox.com> >> 1697=item Geoff Wing L<< <gcw@pobox.com> >>
1461 1698
1462Rewrote screen display and text selection routines. Project Coordinator 1699Rewrote screen display and text selection routines.
1700
1463(changes.txt 2.4.6 - rxvt-unicode) 1701Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1464 1702
1465=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1703=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1466 1704
1467Forked rxvt-unicode, rewrote most of the display code and internal 1705Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1468character handling to store text in unicode, improve xterm 1706extension, random hacks, numerous bugfixes and extensions.
1469compatibility and apply numerous other bugfixes and extensions.
1470 1707
1471Project Coordinator (Changes 1.0 -) 1708Project Coordinator (Changes 1.0 -)
1472 1709
1710=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1711
1712Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1713
1473=back 1714=back
1474 1715

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines