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.70 by root, Tue Oct 25 19:41:21 2005 UTC vs.
Revision 1.153 by root, Wed Dec 12 19:57:13 2007 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
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 (B<-d> still
95respected). In the absence of this option, the display specified by the 98respected). In the absence of this option, the display specified by the
96B<DISPLAY> environment variable is used. 99B<DISPLAY> environment variable is used.
97 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
98=item B<-geometry> I<geom> 106=item B<-geometry> I<geom>
99 107
100Window geometry (B<-g> still respected); resource B<geometry>. 108Window geometry (B<-g> still respected); resource B<geometry>.
101 109
102=item B<-rv>|B<+rv> 110=item B<-rv>|B<+rv>
103 111
104Turn on/off simulated reverse video; resource B<reverseVideo>. 112Turn on/off simulated reverse video; resource B<reverseVideo>.
105 113
106=item B<-j>|B<+j> 114=item B<-j>|B<+j>
107 115
108Turn on/off jump scrolling; resource B<jumpScroll>. 116Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109 117
110=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 118=item B<-ss>|B<+ss>
111 119
112Turn on/off inheriting parent window's pixmap. Alternative form is 120Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
113B<-tr>; resource B<inheritPixmap>. 121
122=item B<-tr>|B<+tr>
123
124Turn on/off illusion of a transparent window background; resource B<transparent>.
125
126B<-ip> is still accepted as an obsolete alias but will be removed in
127future versions.
128
129I<Please address all transparency related issues to Sasha Vasko at
130sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
114 131
115=item B<-fade> I<number> 132=item B<-fade> I<number>
116 133
117Fade the text by the given percentage when focus is lost. Small values 134Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade 135fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>. 136colour; resource B<fading>.
120 137
121=item B<-fadecolor> I<colour> 138=item B<-fadecolor> I<colour>
122 139
123Fade to this colour when fading is used (see B<-fade>). The default colour 140Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>. 141is opaque black. resource B<fadeColor>.
125 142
126=item B<-tint> I<colour> 143=item B<-tint> I<colour>
127 144
128Tint the transparent background pixmap with the given colour when 145Tint the transparent background pixmap with the given colour when
129transparency is enabled with B<-tr> or B<-ip>. This only works for 146transparency is enabled with B<-tr>. This only works for
130non-tiled backgrounds, currently. See also the B<-sh> option that can be 147non-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 148used to brighten or darken the image in addition to tinting it.
149Please note that certain tint colours can be applied on the server-side,
150thus yielding performance gain of two orders of magnitude. These colours are:
151blue, red, green, cyan, magenta, yellow, and those close to them. Also
152pure black and pure white colors essentially mean no tinting; resource
132I<tintColor>. Example: 153I<tintColor>. Example:
133 154
134 @@RXVT_NAME@@ -tr -tint blue -sh 40 155 @@RXVT_NAME@@ -tr -tint blue -sh 40
135 156
136=item B<-sh> 157=item B<-sh> I<number>
137 158
138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 159Darken (0 .. 100) or lighten (100 .. 200) the transparent
139background image in addition to tinting it (i.e. B<-tint> must be 160background image in addition to (or instead of) tinting it;
140specified, too, e.g. C<-tint white>). 161resource I<shading>.
162
163=item B<-blt> I<string>
164
165Specify background blending type. If background pixmap is specified
166at the same time as transparency - such pixmap will be blended over
167transparency image, using method specified. Supported values are :
168B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
169B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
170B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
171alpha-blending. Compile I<afterimage>; resource I<blendType>.
172
173=item B<-blr> I<HxV>
174
175Apply Gaussian Blur with the specified radii to the transparent
176background image. If single number is specified - both vertical and
177horizontal radii are considered to be the same. Setting one of the
178radii to 1 and another to a large number creates interesting effects
179on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
180resource I<blurRadius>.
141 181
142=item B<-bg> I<colour> 182=item B<-bg> I<colour>
143 183
144Window background colour; resource B<background>. 184Window background colour; resource B<background>.
145 185
146=item B<-fg> I<colour> 186=item B<-fg> I<colour>
147 187
148Window foreground colour; resource B<foreground>. 188Window foreground colour; resource B<foreground>.
149 189
150=item B<-pixmap> I<file[;geom]> 190=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
151 191
152Compile I<XPM>: Specify XPM file for the background and also optionally 192Compile I<afterimage>: Specify image file for the background and also
153specify its scaling with a geometry string. Note you may need to 193optionally specify its scaling with a geometry string. Note you may need to
154add quotes to avoid special shell interpretation of the C<;> in the 194add quotes to avoid special shell interpretation of the C<;> in the
155command-line; resource B<backgroundPixmap>. 195command-line; for more details see resource B<backgroundPixmap>.
156 196
157=item B<-cr> I<colour> 197=item B<-cr> I<colour>
158 198
159The cursor colour; resource B<cursorColor>. 199The cursor colour; resource B<cursorColor>.
160 200
172resource B<borderColor>. 212resource B<borderColor>.
173 213
174=item B<-fn> I<fontlist> 214=item B<-fn> I<fontlist>
175 215
176Select the fonts to be used. This is a comma separated list of font names 216Select the fonts to be used. This is a comma separated list of font names
177that are used in turn when trying to display Unicode characters. The 217that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 218first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 219smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 220font list is always appended to it. See resource B<font> for more details.
181 221
182In short, to specify an X11 core font, just specify it's name or prefix it 222In 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:>, 223with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.: 224e.g.:
185 225
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 226 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 227 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
189See also the question "How does rxvt-unicode choose fonts?" in the FAQ 229See also the question "How does rxvt-unicode choose fonts?" in the FAQ
190section of @@RXVT_NAME@@(7). 230section of @@RXVT_NAME@@(7).
191 231
192=item B<-fb> I<fontlist> 232=item B<-fb> I<fontlist>
193 233
194Compile font-styles: The bold font list to use when bold characters are to 234Compile I<font-styles>: The bold font list to use when B<bold> characters
195be printed. See resource B<boldFont> for details. 235are to be printed. See resource B<boldFont> for details.
196 236
197=item B<-fi> I<fontlist> 237=item B<-fi> I<fontlist>
198 238
199Compile font-styles: The italic font list to use when bold characters are to 239Compile I<font-styles>: The italic font list to use when I<italic>
200be printed. See resource B<italicFont> for details. 240characters are to be printed. See resource B<italicFont> for details.
201 241
202=item B<-fbi> I<fontlist> 242=item B<-fbi> I<fontlist>
203 243
204Compile font-styles: The bold italic font list to use when bold characters are to 244Compile I<font-styles>: The bold italic font list to use when B<< I<bold
205be printed. See resource B<boldItalicFont> for details. 245italic> >> characters are to be printed. See resource B<boldItalicFont>
246for details.
247
248=item B<-is>|B<+is>
249
250Compile I<font-styles>: Bold/Italic font styles imply high intensity
251foreground/background (default). See resource B<intensityStyles> for
252details.
206 253
207=item B<-name> I<name> 254=item B<-name> I<name>
208 255
209Specify the application name under which resources are to be obtained, 256Specify the application name under which resources are to be obtained,
210rather than the default executable file name. Name should not contain 257rather than the default executable file name. Name should not contain
290 337
291Compile I<frills>: Set MWM hints to request a borderless window, i.e. 338Compile I<frills>: Set MWM hints to request a borderless window, i.e.
292if honoured by the WM, the rxvt-unicode window will not have window 339if honoured by the WM, the rxvt-unicode window will not have window
293decorations; resource B<borderLess>. 340decorations; resource B<borderLess>.
294 341
342=item B<-override-redirect>
343
344Compile I<frills>: Sets override-redirect on the window; resource
345B<override-redirect>.
346
347=item B<-sbg>
348
349Compile I<frills>: Disable the usage of the built-in block graphics/line
350drawing characters and just rely on what the specified fonts provide. Use
351this if you have a good font and want to use its block graphic glyphs;
352resource B<skipBuiltinGlyphs>.
353
295=item B<-lsp> I<number> 354=item B<-lsp> I<number>
296 355
297Compile I<frills>: Lines (pixel height) to insert between each row of 356Compile I<frills>: Lines (pixel height) to insert between each row of
298the display. Useful to work around font rendering problems; resource 357the display. Useful to work around font rendering problems; resource
299B<linespace>. 358B<lineSpace>.
300 359
301=item B<-tn> I<termname> 360=item B<-tn> I<termname>
302 361
303This option specifies the name of the terminal type to be set in the 362This option specifies the name of the terminal type to be set in the
304B<TERM> environment variable. This terminal type must exist in the 363B<TERM> environment variable. This terminal type must exist in the
313given on the command line. If this option is used, it must be the last 372given on the command line. If this option is used, it must be the last
314on the command-line. If there is no B<-e> option then the default is to 373on the command-line. If there is no B<-e> option then the default is to
315run the program specified by the B<SHELL> environment variable or, 374run the program specified by the B<SHELL> environment variable or,
316failing that, I<sh(1)>. 375failing that, I<sh(1)>.
317 376
377Please note that you must specify a program with arguments. If you want to
378run shell commands, you have to specify the shell, like this:
379
380 @@RXVT_NAME@@ -e sh -c "shell commands"
381
318=item B<-title> I<text> 382=item B<-title> I<text>
319 383
320Window title (B<-T> still respected); the default title is the basename 384Window title (B<-T> still respected); the default title is the basename
321of the program specified after the B<-e> option, if any, otherwise the 385of the program specified after the B<-e> option, if any, otherwise the
322application name; resource B<title>. 386application name; resource B<title>.
353for more info. 417for more info.
354 418
355=item B<-tcw> 419=item B<-tcw>
356 420
357Change the meaning of triple-click selection with the left mouse 421Change the meaning of triple-click selection with the left mouse
422button. Only effective when the original (non-perl) selection code is
358button. Instead of selecting a full line it will extend the selection the 423in-use. Instead of selecting a full line it will extend the selection to
359end of the logical line only. resource B<tripleclickwords>. 424the end of the logical line only. resource B<tripleclickwords>.
360 425
361=item B<-insecure> 426=item B<-insecure>
362 427
363Enable "insecure" mode, which currently enables most of the escape 428Enable "insecure" mode, which currently enables most of the escape
364sequences that echo strings. See the resource B<insecure> for more 429sequences that echo strings. See the resource B<insecure> for more
378=item B<-ssr>|B<+ssr> 443=item B<-ssr>|B<+ssr>
379 444
380Turn on/off secondary screen scroll (default enabled); resource 445Turn on/off secondary screen scroll (default enabled); resource
381B<secondaryScroll>. 446B<secondaryScroll>.
382 447
448=item B<-hold>|B<+hold>
449
450Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
451will not immediately destroy its window when the program executed within
452it exits. Instead, it will wait till it is being killed or closed by the
453user; resource B<hold>.
454
455=item B<-xrm> I<string>
456
457Works like the X Toolkit option of the same name, by adding the I<string>
458as if it were specified in a resource file. Resource values specified this
459way take precedence over all other resource specifications.
460
461Note that you need to use the I<same> syntax as in the .Xdefaults file,
462e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
463options can be specified as long-options on the commandline, so use
464of B<-xrm> is mostly limited to cases where you want to specify other
465resources (e.g. for input methods) or for compatibility with other
466programs.
467
383=item B<-keysym.>I<sym> I<string> 468=item B<-keysym.>I<sym> I<string>
384 469
385Remap a key symbol. See resource B<keysym>. 470Remap a key symbol. See resource B<keysym>.
386 471
387=item B<-embed> I<windowid> 472=item B<-embed> I<windowid>
388 473
389Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 474Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
390which enables applications to easily embed a terminal. 475which enables applications to easily embed a terminal.
391 476
392Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 477Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
393shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 478shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
394quite a bit, so don't expect it to keep some specific state. It's best to 479quite a bit, so don't expect it to keep some specific state. It's best to
397The window will not be destroyed when @@RXVT_NAME@@ exits. 482The window will not be destroyed when @@RXVT_NAME@@ exits.
398 483
399It might be useful to know that @@RXVT_NAME@@ will not close file 484It might be useful to know that @@RXVT_NAME@@ will not close file
400descriptors passed to it (except for stdin/out/err, of course), so you 485descriptors passed to it (except for stdin/out/err, of course), so you
401can use file descriptors to communicate with the programs within the 486can use file descriptors to communicate with the programs within the
402terminal. This works regardless of wether the C<-embed> option was used or 487terminal. This works regardless of whether the C<-embed> option was used or
403not. 488not.
404 489
405Here is a short Gtk2-perl snippet that illustrates how this option can be 490Here is a short Gtk2-perl snippet that illustrates how this option can be
406used (a longer example is in F<doc/embed>): 491used (a longer example is in F<doc/embed>):
407 492
409 $rxvt->signal_connect_after (realize => sub { 494 $rxvt->signal_connect_after (realize => sub {
410 my $xid = $_[0]->window->get_xid; 495 my $xid = $_[0]->window->get_xid;
411 system "@@RXVT_NAME@@ -embed $xid &"; 496 system "@@RXVT_NAME@@ -embed $xid &";
412 }); 497 });
413 498
414=item B<-pty-fd> I<fileno> 499=item B<-pty-fd> I<file descriptor>
415 500
416Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 501Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
417pair but instead use the given filehandle as the tty master. This is 502pair but instead use the given file descriptor as the tty master. This is
418useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 503useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
419without having to run a program within it. 504without having to run a program within it.
420 505
421If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 506If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
422entries and will not tinker with pty/tty permissions - you have to do that 507entries and will not tinker with pty/tty permissions - you have to do that
423yourself if you want that. 508yourself if you want that.
509
510As an extremely special case, specifying C<-1> will completely suppress
511pty/tty operations, which is probably only useful in conjunction with some
512perl extension that manages the terminal.
424 513
425Here is a example in perl that illustrates how this option can be used (a 514Here is a example in perl that illustrates how this option can be used (a
426longer example is in F<doc/pty-fd>): 515longer example is in F<doc/pty-fd>):
427 516
428 use IO::Pty; 517 use IO::Pty;
435 524
436 # now communicate with rxvt 525 # now communicate with rxvt
437 my $slave = $pty->slave; 526 my $slave = $pty->slave;
438 while (<$slave>) { print $slave "got <$_>\n" } 527 while (<$slave>) { print $slave "got <$_>\n" }
439 528
529=item B<-pe> I<string>
530
531Comma-separated list of perl extension scripts to use (or not to use) in
532this terminal instance. See resource B<perl-ext> for details.
533
440=back 534=back
441 535
442=head1 RESOURCES (available also as long-options) 536=head1 RESOURCES
443 537
444Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 538Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
445options) compiled into your version. 539options) compiled into your version. All resources are also available as
540long-options.
446 541
447There are two different methods that @@RXVT_NAME@@ can use to get the 542You can set and change the resources using X11 tools like B<xrdb>. Many
448Xresource data: using the X libraries (Xrm*-functions) or internal 543distribution do also load settings from the B<~/.Xresources> file when X
449Xresources reader (B<~/.Xdefaults>). For the first method (ie. 544starts. @@RXVT_NAME@@ will consult the following files/resources in order,
450B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 545with later settings overwriting earlier ones:
451resources using X11 tools like B<xrdb>. Many distribution do also load
452settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
453will consult the following files/resources in order, with later settings
454overwriting earlier ones:
455 546
456 1. system-wide app-defaults file, either locale-dependent OR global 547 1. system-wide app-defaults file, either locale-dependent OR global
457 2. app-defaults file in $XAPPLRESDIR 548 2. app-defaults file in $XAPPLRESDIR
458 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 549 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
459 4. SCREEN_RESOURCES for the current screen 550 4. SCREEN_RESOURCES for the current screen
460 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 551 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
552 6. resources specified via -xrm on the commandline
461 553
462If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
463lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
464set in XAPPLOADDIR/URxvt (compile-time defined: usually
465B</usr/lib/X11/app-defaults/URxvt>) and resources set in
466B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
467Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 554Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
468class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 555names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
469resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 556common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
470easily configured, while the class name B<URxvt> allows resources 557configured, while the class name B<URxvt> allows resources unique to
471unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 558B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
472shared between different B<@@RXVT_NAME@@> configurations. If no 559configurations. If no resources are specified, suitable defaults will
473resources are specified, suitable defaults will be used. Command-line 560be used. Command-line arguments can be used to override resource
474arguments can be used to override resource settings. The following 561settings. The following resources are supported (you might want to
475resources are allowed: 562check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
563extensions not documented here):
476 564
477=over 4 565=over 4
566
567=item B<depth:> I<bitdepth>
568
569Compile I<xft>: Attempt to find a visual with the given bit depth;
570option B<-depth>.
478 571
479=item B<geometry:> I<geom> 572=item B<geometry:> I<geom>
480 573
481Create the window with the specified X window geometry [default 80x24]; 574Create the window with the specified X window geometry [default 80x24];
482option B<-geometry>. 575option B<-geometry>.
519Use the specified colour to display underlined characters when the 612Use the specified colour to display underlined characters when the
520foreground colour is the default. 613foreground colour is the default.
521 614
522=item B<colorRV:> I<colour> 615=item B<colorRV:> I<colour>
523 616
524Use the specified colour as the background for reverse video 617Use the specified colour as the background for reverse video characters
525characters. 618when OPTION_HC is disabled (--disable-frills).
526 619
527=item B<underlineColor:> I<colour> 620=item B<underlineColor:> I<colour>
528 621
529If set, use the specified colour as the colour for the underline 622If set, use the specified colour as the colour for the underline
530itself. If unset, use the foreground colour. 623itself. If unset, use the foreground colour.
546option B<-rv>. B<False>: regular screen colours [default]; option 639option B<-rv>. B<False>: regular screen colours [default]; option
547B<+rv>. See note in B<COLORS AND GRAPHICS> section. 640B<+rv>. See note in B<COLORS AND GRAPHICS> section.
548 641
549=item B<jumpScroll:> I<boolean> 642=item B<jumpScroll:> I<boolean>
550 643
551B<True>: specify that jump scrolling should be used. When scrolling 644B<True>: specify that jump scrolling should be used. When receiving lots
552quickly, fewer screen updates are performed [default]; option B<-j>. 645of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
646has been read, resulting in fewer updates while still displaying every
647received line; option B<-j>.
648
553B<False>: specify that smooth scrolling should be used; option B<+j>. 649B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
650force a screen refresh on each new line it received; option B<+j>.
554 651
555=item B<inheritPixmap:> I<boolean> 652=item B<skipScroll:> I<boolean>
556 653
557B<True>: make the background inherit the parent windows' pixmap, giving 654B<True>: (the default) specify that skip scrolling should be used. When
558artificial transparency. B<False>: do not inherit the parent windows' 655receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
559pixmap. 656(around 60 times per second), resulting in far fewer updates. This can
657result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
658option B<-ss>.
659
660B<False>: specify that everything is to be displayed, even
661if the refresh is too fast for the human eye to read anything (or the
662monitor to display anything); option B<+ss>.
663
664=item B<transparent:> I<boolean>
665
666Turn on/off illusion of a transparent window background.
667
668B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
669future versions.
670
671I<Please address all transparency related issues to Sasha Vasko at
672sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
560 673
561=item B<fading:> I<number> 674=item B<fading:> I<number>
562 675
563Fade the text by the given percentage when focus is lost; option B<-fade>. 676Fade the text by the given percentage when focus is lost; option B<-fade>.
564 677
572Tint the transparent background pixmap with the given colour; option 685Tint the transparent background pixmap with the given colour; option
573B<-tint>. 686B<-tint>.
574 687
575=item B<shading:> I<number> 688=item B<shading:> I<number>
576 689
577Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 690Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
578image in addition to tinting it. 691in addition to tinting it; option B<-sh>.
692
693=item B<blendType:> I<string>
694
695Specify background blending type; option B<-blt>.
696
697=item B<blurRadius:> I<number>
698
699Apply Gaussian Blurr with the specified radius to the transparent
700background image; option B<-blr>.
579 701
580=item B<scrollColor:> I<colour> 702=item B<scrollColor:> I<colour>
581 703
582Use the specified colour for the scrollbar [default #B2B2B2]. 704Use the specified colour for the scrollbar [default #B2B2B2].
583 705
589=item B<borderColor:> I<colour> 711=item B<borderColor:> I<colour>
590 712
591The colour of the border around the text area and between the scrollbar 713The colour of the border around the text area and between the scrollbar
592and the text. 714and the text.
593 715
594=item B<backgroundPixmap:> I<file[;geom]> 716=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
595 717
596Use the specified XPM file (note the `.xpm' extension is optional) for 718Use the specified image file for the background and also
597the background and also optionally specify its scaling with a geometry 719optionally specify its scaling with a geometry string B<WxH+X+Y>,
598string B<WxH+X+Y>, in which B<"W" / "H"> specify the 720(default C<0x0+50+50>) in which B<"W" / "H"> specify the
599horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 721horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
600centre (percent). A scale of 0 displays the image with tiling. A scale 722centre (percent). A scale of 0 displays the image with tiling. A scale
601of 1 displays the image without any scaling. A scale of 2 to 9 723of 1 displays the image without any scaling. A scale of 2 to 9 specifies
602specifies an integer number of images in that direction. No image will 724an integer number of images in that direction. No image will be magnified
603be magnified beyond 10 times its original size. The maximum permitted 725beyond 10 times its original size. The maximum permitted scale is 1000.
604scale is 1000. [default 0x0+50+50] 726Additional operations can be specified after colon B<:op1:op2...>.
727Supported operations are:
605 728
606=item B<menu:> I<file[;tag]> 729 tile force background image to be tiled and not scaled. Equivalent to 0x0,
730 propscale will scale image keeping proportions,
731 auto will scale image to match window size. Equivalent to 100x100;
732 hscale will scale image horizontally to the window size;
733 vscale will scale image vertically to the window size;
734 scale will scale image to match window size;
735 root will tile image as if it was a root window background, auto-adjusting
736 whenever terminal window moves.
607 737
608Read in the specified menu file (note the `.menu' extension is 738If used in conjunction with B<-tr> option, the specified pixmap will be
609optional) and also optionally specify a starting tag to find. See the 739blended over transparency image using either alpha-blending, or any
610reference documentation for details on the syntax for the menuBar. 740other blending type, specified with B<-blt "type"> option.
611 741
612=item B<path:> I<path> 742=item B<path:> I<path>
613 743
614Specify the colon-delimited search path for finding files (XPM and 744Specify the colon-delimited search path for finding background image files.
615menus), in addition to the paths specified by the B<RXVTPATH> and
616B<PATH> environment variables.
617 745
618=item B<font:> I<fontlist> 746=item B<font:> I<fontlist>
619 747
620Select the fonts to be used. This is a comma separated list of font 748Select the fonts to be used. This is a comma separated list of font names
621names that are used in turn when trying to display Unicode characters. 749that are checked in order when trying to find glyphs for characters. The
622The first font defines the cell size for characters; other fonts might 750first font defines the cell size for characters; other fonts might be
623be smaller, but not larger. A reasonable default font list is always 751smaller, but not (in general) larger. A (hopefully) reasonable default
624appended to it. option B<-fn>. 752font list is always appended to it; option B<-fn>.
625 753
626Each font can either be a standard X11 core font (XLFD) name, with 754Each font can either be a standard X11 core font (XLFD) name, with
627optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 755optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
628 756
629In addition, each font can be prefixed with additional hints and 757In addition, each font can be prefixed with additional hints and
631hint currently is C<codeset=codeset-name>, and this is only used for Xft 759hint currently is C<codeset=codeset-name>, and this is only used for Xft
632fonts. 760fonts.
633 761
634For example, this font resource 762For example, this font resource
635 763
636 URxvt*font: 9x15bold,\ 764 URxvt.font: 9x15bold,\
637 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 765 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
638 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 766 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
639 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 767 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
640 xft:Code2000:antialias=false 768 xft:Code2000:antialias=false
641 769
675not possible, replacement fonts of the desired shape will be tried. 803not possible, replacement fonts of the desired shape will be tried.
676 804
677If set, but empty, then this specific style is disabled and the normal 805If set, but empty, then this specific style is disabled and the normal
678text font will being used for the given style. 806text font will being used for the given style.
679 807
808=item B<intensityStyles:> I<boolean>
809
810When font styles are not enabled, or this option is enabled (B<True>,
811option B<-is>, the default), bold and italic font styles imply high
812intensity foreground/background colours. Disabling this option (B<False>,
813option B<+is>) disables this behaviour, the high intensity colours are not
814reachable.
815
680=item B<selectstyle:> I<mode> 816=item B<selectstyle:> I<mode>
681 817
682Set mouse selection style to B<old> which is 2.20, B<oldword> which is 818Set mouse selection style to B<old> which is 2.20, B<oldword> which
683xterm style with 2.20 old word selection, or anything else which gives 819is xterm style with 2.20 old word selection, or anything else which
684xterm style selection. 820gives xterm style selection. Only effective when the original (non-perl)
821selection code is in use.
685 822
686=item B<scrollstyle:> I<mode> 823=item B<scrollstyle:> I<mode>
687 824
688Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 825Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
689the author's favourite. 826the author's favourite.
703=item B<mapAlert:> I<boolean> 840=item B<mapAlert:> I<boolean>
704 841
705B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 842B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
706de-iconify (map) on receipt of a bell character [default]. 843de-iconify (map) on receipt of a bell character [default].
707 844
845=item B<urgentOnBell:> I<boolean>
846
847B<True>: set the urgency hint for the wm on receipt of a bell character.
848B<False>: do not set the urgency hint [default].
849
708=item B<visualBell:> I<boolean> 850=item B<visualBell:> I<boolean>
709 851
710B<True>: use visual bell on receipt of a bell character; option B<-vb>. 852B<True>: use visual bell on receipt of a bell character; option B<-vb>.
711B<False>: no visual bell [default]; option B<+vb>. 853B<False>: no visual bell [default]; option B<+vb>.
712 854
730 872
731The string will be interpreted as if typed into the shell as-is. 873The string will be interpreted as if typed into the shell as-is.
732 874
733Example: 875Example:
734 876
735 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 877 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
736 878
737This creates a new file in your home directory with the screen contents 879This creates a new file in your home directory with the screen contents
738everytime you hit C<Print>. 880every time you hit C<Print>.
739 881
740=item B<scrollBar:> I<boolean> 882=item B<scrollBar:> I<boolean>
741 883
742B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 884B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
743disable the scrollbar; option B<+sb>. 885disable the scrollbar; option B<+sb>.
765 907
766=item B<scrollWithBuffer:> I<boolean> 908=item B<scrollWithBuffer:> I<boolean>
767 909
768B<True>: scroll with scrollback buffer when tty receives new lines (and 910B<True>: scroll with scrollback buffer when tty receives new lines (and
769B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 911B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
770with scrollback buffer when tty recieves new lines; option B<+sw>. 912with scrollback buffer when tty receives new lines; option B<+sw>.
771 913
772=item B<scrollTtyKeypress:> I<boolean> 914=item B<scrollTtyKeypress:> I<boolean>
773 915
774B<True>: scroll to bottom when a non-special key is pressed. Special keys 916B<True>: scroll to bottom when a non-special key is pressed. Special keys
775are those which are intercepted by rxvt-unicode for special handling and 917are those which are intercepted by rxvt-unicode for special handling and
794=item B<borderLess:> I<boolean> 936=item B<borderLess:> I<boolean>
795 937
796Set MWM hints to request a borderless window, i.e. if honoured by the 938Set MWM hints to request a borderless window, i.e. if honoured by the
797WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 939WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
798 940
941=item B<skipBuiltinGlyphs:> I<boolean>
942
943Compile I<frills>: Disable the usage of the built-in block graphics/line
944drawing characters and just rely on what the specified fonts provide. Use
945this if you have a good font and want to use its block graphic glyphs;
946option B<-sbg>.
947
799=item B<termName:> I<termname> 948=item B<termName:> I<termname>
800 949
801Specifies the terminal type name to be set in the B<TERM> environment 950Specifies the terminal type name to be set in the B<TERM> environment
802variable; option B<-tn>. 951variable; option B<-tn>.
803 952
804=item B<linespace:> I<number> 953=item B<lineSpace:> I<number>
805 954
806Specifies number of lines (pixel height) to insert between each row of 955Specifies number of lines (pixel height) to insert between each row of
807the display [default 0]; option B<-lsp>. 956the display [default 0]; option B<-lsp>.
808 957
809=item B<meta8:> I<boolean> 958=item B<meta8:> I<boolean>
858pressed. If unset it will send the sequence traditionally associated 1007pressed. If unset it will send the sequence traditionally associated
859with the B<Execute> key. 1008with the B<Execute> key.
860 1009
861=item B<cutchars:> I<string> 1010=item B<cutchars:> I<string>
862 1011
863The characters used as delimiters for double-click word selection. The 1012The characters used as delimiters for double-click word selection
864built-in default: 1013(whitespace delimiting is added automatically if resource is given).
865 1014
1015When the perl selection extension is in use (the default if compiled
1016in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
1017characters will be created (if the resource exists, otherwise, no regex
1018will be created). In this mode, characters outside ISO-8859-1 can be used.
1019
1020When the selection extension is not used, only ISO-8859-1 characters can
1021be used. If not specified, the built-in default is used:
1022
866B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1023B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
867 1024
868=item B<preeditType:> I<style> 1025=item B<preeditType:> I<style>
869 1026
870B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1027B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
871 1028
876=item B<imLocale:> I<name> 1033=item B<imLocale:> I<name>
877 1034
878The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 1035The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
879C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the 1036C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
880input extension to be able to input japanese characters while staying in 1037input extension to be able to input japanese characters while staying in
881another locale. option B<-imlocale>. 1038another locale; option B<-imlocale>.
882 1039
883=item B<imFont:> I<fontset> 1040=item B<imFont:> I<fontset>
884 1041
885Specify the font-set used for XIM styles C<OverTheSpot> or 1042Specify the font-set used for XIM styles C<OverTheSpot> or
886C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 1043C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
891 1048
892=item B<tripleclickwords:> I<boolean> 1049=item B<tripleclickwords:> I<boolean>
893 1050
894Change the meaning of triple-click selection with the left mouse 1051Change the meaning of triple-click selection with the left mouse
895button. Instead of selecting a full line it will extend the selection to 1052button. Instead of selecting a full line it will extend the selection to
896the end of the logical line only. option B<-tcw>. 1053the end of the logical line only; option B<-tcw>.
897 1054
898=item B<insecure:> I<boolean> 1055=item B<insecure:> I<boolean>
899 1056
900Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1057Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
901echo arbitrary strings like the icon name or the locale. This could be 1058echo arbitrary strings like the icon name or the locale. This could be
902abused if somebody gets 8-bit-clean access to your display, whether 1059abused if somebody gets 8-bit-clean access to your display, whether
903throuh a mail client displaying mail bodies unfiltered or though 1060through a mail client displaying mail bodies unfiltered or through
904write(1). Therefore, these sequences are disabled by default. (Note 1061write(1) or any other means. Therefore, these sequences are disabled by
905that other terminals, including xterm, have these sequences 1062default. (Note that many other terminals, including xterm, have these
906enabled by default). You can enable them by setting this boolean 1063sequences enabled by default, which doesn't make it safer, though).
907resource or specifying B<-insecure> as an option. At the moment, this 1064
908enabled display-answer, locale, findfont, icon label and window title 1065You can enable them by setting this boolean resource or specifying
909requests as well as dynamic menubar dispatch. 1066B<-insecure> as an option. At the moment, this enables display-answer,
1067locale, findfont, icon label and window title requests.
910 1068
911=item B<modifier:> I<modifier> 1069=item B<modifier:> I<modifier>
912 1070
913Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 1071Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
914B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 1072B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
918 1076
919Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1077Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
920character is passed through. It may contain escape values as described 1078character is passed through. It may contain escape values as described
921in the entry on B<keysym> following. 1079in the entry on B<keysym> following.
922 1080
923=item B<secondaryScreen:> I<bool> 1081=item B<secondaryScreen:> I<boolean>
924 1082
925Turn on/off secondary screen (default enabled). 1083Turn on/off secondary screen (default enabled).
926 1084
927=item B<secondaryScroll:> I<bool> 1085=item B<secondaryScroll:> I<boolean>
928 1086
929Turn on/off secondary screen scroll (default enabled). If the this 1087Turn on/off secondary screen scroll (default enabled). If this
930option is enabled, scrolls on the secondary screen will change the 1088option is enabled, scrolls on the secondary screen will change the
931scrollback buffer and switching to/from the secondary screen will 1089scrollback buffer and switching to/from the secondary screen will
932instead scroll the screen up. 1090instead scroll the screen up.
1091
1092=item B<hold>: I<boolean>
1093
1094Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1095will not immediately destroy its window when the program executed within
1096it exits. Instead, it will wait till it is being killed or closed by the
1097user.
933 1098
934=item B<keysym.>I<sym>: I<string> 1099=item B<keysym.>I<sym>: I<string>
935 1100
936Compile I<frills>: Associate I<string> with keysym I<sym>. The 1101Compile I<frills>: Associate I<string> with keysym I<sym>. The
937intervening resource name B<keysym.> cannot be omitted. 1102intervening resource name B<keysym.> cannot be omitted.
951searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1116searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
952omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1117omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
953keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1118keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
954performed in an exact manner; however, the closest match is assured. 1119performed in an exact manner; however, the closest match is assured.
955 1120
956I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1121I<string> may contain escape values (C<\n>: newline, C<\000>: octal
957C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1122number), see RESOURCES in C<man 7 X> for futher details.
958C<\000>: octal number) or verbatim control characters (C<^?>: delete,
959C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
960can start or end with whitespace.
961
962Please note that you need to double the C<\> when using
963C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
964use C<\033> instead of C<\e> (and so on), which will work with both Xt and
965@@RXVT_NAME@@'s own processing).
966 1123
967You can define a range of keysyms in one shot by providing a I<string> 1124You can define a range of keysyms in one shot by providing a I<string>
968with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1125with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
969should be a character not used by the strings. 1126should be a character not used by the strings.
970 1127
971Its usage can be demonstrated by an example: 1128Its usage can be demonstrated by an example:
972 1129
973 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1130 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
982is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1139is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
983example the following means "change the current locale to C<zh_CN.GBK> 1140example the following means "change the current locale to C<zh_CN.GBK>
984when Control-Meta-c is being pressed": 1141when Control-Meta-c is being pressed":
985 1142
986 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1143 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1144
1145If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1146is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1147manpage. For example, the F<selection> extension (activated via
1148C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1149
1150 URxvt.keysym.M-C-c: perl:selection:rot13
987 1151
988Due the the large number of modifier combinations, a defined key mapping 1152Due the the large number of modifier combinations, a defined key mapping
989will match if at I<at least> the specified identifiers are being set, and 1153will match if at I<at least> the specified identifiers are being set, and
990no other key mappings with those and more bits are being defined. That 1154no other key mappings with those and more bits are being defined. That
991means that defining a key map for C<a> will automatically provide 1155means that defining a key map for C<a> will automatically provide
1015info): 1179info):
1016 1180
1017 URxvt.keysym.M-C-3: command:\033[8;25;80t 1181 URxvt.keysym.M-C-3: command:\033[8;25;80t
1018 URxvt.keysym.M-C-4: command:\033[8;48;110t 1182 URxvt.keysym.M-C-4: command:\033[8;48;110t
1019 1183
1184=item B<perl-ext-common>: I<string>
1185
1186=item B<perl-ext>: I<string>
1187
1188Comma-separated list(s) of perl extension scripts (default: C<default>) to
1189use in this terminal instance; option B<-pe>.
1190
1191Extension names can be prefixed with a C<-> sign to prohibit using
1192them. This can be useful to selectively disable some extensions loaded
1193by default, or specified via the C<perl-ext-common> resource. For
1194example, C<default,-selection> will use all the default extension except
1195C<selection>.
1196
1197Extension names can also be followed by an argument in angle brackets
1198(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1199searchable scrollback to Alt/Meta-s). Mentioning the same extension
1200multiple times with different arguments will pass multiple arguments to
1201the extension.
1202
1203Each extension is looked up in the library directories, loaded if
1204necessary, and bound to the current terminal instance.
1205
1206If both of these resources are the empty string, then the perl
1207interpreter will not be initialized. The idea behind two options is that
1208B<perl-ext-common> will be used for extensions that should be available to
1209all instances, while B<perl-ext> is used for specific instances.
1210
1211=item B<perl-eval>: I<string>
1212
1213Perl code to be evaluated when all extensions have been registered. See
1214the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1215will be ignored when running setuid/setgid.
1216
1217=item B<perl-lib>: I<path>
1218
1219Colon-separated list of additional directories that hold extension
1220scripts. When looking for extensions specified by the C<perl> resource,
1221@@RXVT_NAME@@ will first look in these directories and then in
1222F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1223will be ignored when running setuid/setgid.
1224
1225See the @@RXVT_NAME@@perl(3) manpage.
1226
1227=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1228
1229Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1230details.
1231
1232=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1233
1234Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1235for details.
1236
1237=item B<searchable-scrollback:> I<keysym>
1238
1239Sets the hotkey that starts the incremental scrollback buffer search
1240(default: C<M-s>).
1241
1242=item B<urlLauncher>: I<string>
1243
1244Specifies the program to be started with a URL argument. Used by the
1245C<selection-popup> and C<matcher> perl extensions.
1246
1247=item B<transient-for>: I<windowid>
1248
1249Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1250
1251=item B<override-redirect>: I<boolean>
1252
1253Compile I<frills>: Sets override-redirect for the terminal window, making
1254it almost invisible to window managers; option B<-override-redirect>.
1255
1256=item B<iso14755_52:> I<boolean>
1257
1258Turn on/off ISO 14755 5.2 mode (default enabled).
1259
1020=back 1260=back
1021 1261
1022=head1 THE SCROLLBAR 1262=head1 THE SCROLLBAR
1023 1263
1024Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1264Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
1042application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1282application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1043(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1283(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1044up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1284up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1045respectively. 1285respectively.
1046 1286
1047=head1 TEXT SELECTION AND INSERTION 1287=head1 THE SELECTION: SELECTING AND PASTING TEXT
1048 1288
1049The behaviour of text selection and insertion mechanism is similar to 1289The behaviour of text selection and insertion/pasting mechanism is similar
1050I<xterm>(1). 1290to I<xterm>(1).
1051 1291
1052=over 4 1292=over 4
1053 1293
1054=item B<Selection>: 1294=item B<Selecting>:
1055 1295
1056Left click at the beginning of the region, drag to the end of the region 1296Left click at the beginning of the region, drag to the end of the region
1057and release; Right click to extend the marked region; Left double-click 1297and release; Right click to extend the marked region; Left double-click
1058to select a word; Left triple-click to select the entire logical line 1298to select a word; Left triple-click to select the entire logical line
1059(which can span multiple screen lines), unless modified by resource 1299(which can span multiple screen lines), unless modified by resource
1060B<tripleclickwords>. 1300B<tripleclickwords>.
1061 1301
1062Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1302Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1063(Compile: I<frills>) will create a rectangular selection instead of a normal 1303(Compile: I<frills>) will create a rectangular selection instead of a
1064one. 1304normal one. In this mode, every selected row becomes its own line in the
1305selection, and trailing whitespace is visually underlined and removed from
1306the selection.
1065 1307
1066=item B<Insertion>: 1308=item B<Pasting>:
1067 1309
1068Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1310Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1069an B<@@RXVT_NAME@@> window causes the current text selection to be 1311window causes the value of the PRIMARY selection (or CLIPBOARD with the
1070inserted as if it had been typed on the keyboard. 1312B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1313
1314Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1315inserted too.
1071 1316
1072=back 1317=back
1073 1318
1074=head1 CHANGING FONTS 1319=head1 CHANGING FONTS
1075 1320
1076Changing fonts (or font sizes, respectively) via the keypad is not yet 1321Changing fonts (or font sizes, respectively) via the keypad is not yet
1077supported in rxvt-unicode. Bug me if you need this. 1322supported in rxvt-unicode. Bug me if you need this.
1078 1323
1079You can, however, switch fonts at runtime using escape sequences (and 1324You can, however, switch fonts at runtime using escape sequences, e.g.:
1080therefore using the menubar), e.g.:
1081 1325
1082 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1326 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1327
1328You can use keyboard shortcuts, too:
1329
1330 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1331 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1083 1332
1084rxvt-unicode will automatically re-apply these fonts to the output so far. 1333rxvt-unicode will automatically re-apply these fonts to the output so far.
1085 1334
1086=head1 ISO 14755 SUPPORT 1335=head1 ISO 14755 SUPPORT
1087 1336
1088ISO 14755 is a standard for entering and viewing unicode characters 1337ISO 14755 is a standard for entering and viewing unicode characters
1089and character codes using the keyboard. It consists of 4 parts. The 1338and character codes using the keyboard. It consists of 4 parts. The
1090first part is available rxvt-unicode has been compiled with 1339first part is available if rxvt-unicode has been compiled with
1091C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1340C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1092with C<--enable-iso14755>. 1341with C<--enable-iso14755>.
1093 1342
1094=over 4 1343=over 4
1095 1344
1115This mode lets you input characters representing the keycap symbols of 1364This mode lets you input characters representing the keycap symbols of
1116your keyboard, if representable in the current locale encoding. 1365your keyboard, if representable in the current locale encoding.
1117 1366
1118Start by pressing C<Control> and C<Shift> together, then releasing 1367Start by pressing C<Control> and C<Shift> together, then releasing
1119them. The next special key (cursor keys, home etc.) you enter will not 1368them. The next special key (cursor keys, home etc.) you enter will not
1120invoke it's usual function but instead will insert the corresponding 1369invoke its usual function but instead will insert the corresponding
1121keycap symbol. The symbol will only be entered when the key has been 1370keycap symbol. The symbol will only be entered when the key has been
1122released, otherwise pressing e.g. C<Shift> would enter the symbol for 1371released, otherwise pressing e.g. C<Shift> would enter the symbol for
1123C<ISO Level 2 Switch>, although your intention might have been to enter a 1372C<ISO Level 2 Switch>, although your intention might have been to enter a
1124reverse tab (Shift-Tab). 1373reverse tab (Shift-Tab).
1125 1374
1158=head1 COLORS AND GRAPHICS 1407=head1 COLORS AND GRAPHICS
1159 1408
1160In addition to the default foreground and background colours, 1409In addition to the default foreground and background colours,
1161B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1410B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1162high-intensity bold/blink versions of the same). Here is a list of the 1411high-intensity bold/blink versions of the same). Here is a list of the
1163colours with their B<rgb.txt> names. 1412colours with their names.
1164 1413
1165=begin table 1414=begin table
1166 1415
1167 B<color0> (black) = Black 1416 B<color0> (black) = Black
1168 B<color1> (red) = Red3 1417 B<color1> (red) = Red3
1188It is also possible to specify the colour values of B<foreground>, 1437It is also possible to specify the colour values of B<foreground>,
1189B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1438B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1190a number 0-15, as a convenient shorthand to reference the colour name of 1439a number 0-15, as a convenient shorthand to reference the colour name of
1191color0-color15. 1440color0-color15.
1192 1441
1442In addition to the colours defined above, @@RXVT_NAME@@ offers an
1443additional 72 colours. The first 64 of those (with indices 16 to 79)
1444consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
144516>), followed by 8 additional shades of gray (with indices 80 to 87).
1446
1447Together, all those colours implement the 88 colour xterm colours. Only
1448the first 16 can be changed using resources currently, the rest can only
1449be changed via command sequences ("escape codes").
1450
1193Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1451Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1194always swapping the foreground/background colours. This is in contrast to 1452always swapping the foreground/background colours. This is in contrast to
1195I<xterm>(1) where the colours are only swapped if they have not otherwise 1453I<xterm>(1) where the colours are only swapped if they have not otherwise
1196been specified. For example, 1454been specified. For example,
1197 1455
1202would yield White on Black, while on I<xterm>(1) it would yield Black 1460would yield White on Black, while on I<xterm>(1) it would yield Black
1203on White. 1461on White.
1204 1462
1205=back 1463=back
1206 1464
1465=head2 ALPHA CHANNEL SUPPORT
1466
1467If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1468their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1469(recommended, but B<MUST> have 4 digits/component) colour specifications,
1470in addition to the ones provided by X, where the additional A component
1471specifies opacity (alpha) values. The minimum value of C<0> is completely
1472transparent). You can also prefix any color with C<[percent]>, where
1473C<percent> is a decimal percentage (0-100) that specifies the opacity of
1474the color, where C<0> is completely transparent and C<100> is completelxy
1475opaque.
1476
1477You probably need to specify B<"-depth 32">, too, and have the luck that
1478your X-server uses ARGB pixel layout, as X is far from just supporting
1479ARGB visuals out of the box, and rxvt-unicode just fudges around.
1480
1481For example, the following selects an almost completely transparent red
1482background, and an almost opaque pink foreground:
1483
1484 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1485
1486I<Please note that transparency of any kind if completely unsupported by
1487the author. Don't bug him with installation questions!>
1488
1207=head1 ENVIRONMENT 1489=head1 ENVIRONMENT
1208 1490
1209B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1491B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1210 1492
1211=over 4 1493=over 4
1212 1494
1213=item B<TERM> 1495=item B<TERM>
1214 1496
1215Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1497Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1216resources or on the commandline. 1498resources or on the command line.
1217 1499
1218=item B<COLORTERM> 1500=item B<COLORTERM>
1219 1501
1220Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1502Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1221compiled with XPM support, and optionally with the added extension 1503compiled with background image support, and optionally with the added
1222C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1504extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1505screen.
1223 1506
1224=item B<COLORFGBG> 1507=item B<COLORFGBG>
1225 1508
1226Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1509Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1227the colour code used as default foreground/text colour (or the string 1510the colour code used as default foreground/text colour (or the string
1228C<default> to indicate that the default-colour escape sequence is to be 1511C<default> to indicate that the default-colour escape sequence is to be
1229used), C<bg> is the colour code used as default background colour (or the 1512used), C<bg> is the colour code used as default background colour (or the
1230string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1513string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1231was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1514was compiled with background image support. Libraries like C<ncurses>
1232(and do) use this information to optimize screen output. 1515and C<slang> can (and do) use this information to optimize screen output.
1233 1516
1234=item B<WINDOWID> 1517=item B<WINDOWID>
1235 1518
1236Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1519Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1237window, which usually has subwindows for the scrollbar, the terminal 1520window, which usually has subwindows for the scrollbar, the terminal
1243C<--with-terminfo=PATH>. 1526C<--with-terminfo=PATH>.
1244 1527
1245=item B<DISPLAY> 1528=item B<DISPLAY>
1246 1529
1247Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1530Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1248display in it's child processes. 1531display in its child processes.
1249 1532
1250=item B<SHELL> 1533=item B<SHELL>
1251 1534
1252The shell to be used for command execution, defaults to C</bin/sh>. 1535The shell to be used for command execution, defaults to C</bin/sh>.
1253
1254=item B<RXVTPATH>
1255
1256The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1257files.
1258
1259=item B<PATH>
1260
1261Used in the same way as C<RXVTPATH>.
1262 1536
1263=item B<RXVT_SOCKET> 1537=item B<RXVT_SOCKET>
1264 1538
1265The unix domain socket path used by @@RXVT_NAME@@c(1) and 1539The unix domain socket path used by @@RXVT_NAME@@c(1) and
1266@@RXVT_NAME@@d(1). 1540@@RXVT_NAME@@d(1).
1296 1570
1297=head1 SEE ALSO 1571=head1 SEE ALSO
1298 1572
1299@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1573@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1300 1574
1301=head1 BUGS
1302
1303Check the BUGS file for an up-to-date list.
1304
1305Cursor change support is not yet implemented.
1306
1307Click-and-drag doesn't work with X11 mouse report overriding.
1308
1309=head1 CURRENT PROJECT COORDINATOR 1575=head1 CURRENT PROJECT COORDINATOR
1310 1576
1311=over 4 1577=over 4
1312 1578
1313=item Project Coordinator 1579=item Project Coordinator
1314 1580
1315Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1581Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1316 1582
1317L<http://software.schmorp.de/#rxvt-unicode> 1583L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1318 1584
1319=back 1585=back
1320 1586
1321=head1 AUTHORS 1587=head1 AUTHORS
1322 1588
1344 1610
1345Project Coordinator (changes.txt 2.21a to 2.4.5) 1611Project Coordinator (changes.txt 2.21a to 2.4.5)
1346 1612
1347=item Geoff Wing L<< <gcw@pobox.com> >> 1613=item Geoff Wing L<< <gcw@pobox.com> >>
1348 1614
1349Rewrote screen display and text selection routines. Project Coordinator 1615Rewrote screen display and text selection routines.
1616
1350(changes.txt 2.4.6 - rxvt-unicode) 1617Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1351 1618
1352=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1619=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1353 1620
1354Forked rxvt-unicode, rewrote most of the display code and internal 1621Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1355character handling to store text in unicode, improve xterm 1622extension, random hacks, numerous bugfixes and extensions.
1356compatibility and apply numerous other bugfixes and extensions.
1357 1623
1358Project Coordinator (Changes 1.0 -) 1624Project Coordinator (Changes 1.0 -)
1359 1625
1626=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1627
1628Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1629
1360=back 1630=back
1361 1631

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines