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.59 by root, Thu Feb 17 15:07:48 2005 UTC vs.
Revision 1.133 by ayin, Sat Jul 28 20:15:18 2007 UTC

17=head1 FREQUENTLY ASKED QUESTIONS 17=head1 FREQUENTLY ASKED QUESTIONS
18 18
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 20frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 21problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 22L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
23 23
24=head1 RXVT-UNICODE VS. RXVT 24=head1 RXVT-UNICODE VS. RXVT
25 25
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 27internally. That means it can store and display most scripts in the
28world. Being a terminal emulator, however, some things are very difficult, 28world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts 29especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules, 30like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. Don't expect pretty output when using these 31like tibetan or devenagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are left-to-right scripts, such 33fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 35belong into the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 36such as cursor-movement while editing -- break otherwise), but that might
37change. 37change.
38 38
39If you are looking for a terminal that supports more exotic scripts, let 39If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very userfriendly, lean and clean 40me recommend C<mlterm>, which is a very user friendly, lean and clean
41terminal emulator. In fact, the reason rxvt-unicode was born was solely 41terminal 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 42because the author couldn't get C<mlterm> to use one font for latin1 and
43another for japanese. 43another for japanese.
44 44
45Therefore another design rationale was the use of multiple fonts to 45Therefore another design rationale was the use of multiple fonts to
46display characters: The idea of a single unicode font which many other 46display 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 47programs force onto its users never made sense to me: You should be able
48to choose any font for any script freely. 48to choose any font for any script freely.
49 49
50Apart from that, rxvt-unicode is also much better internationalised than 50Apart from that, rxvt-unicode is also much better internationalised than
51it's predecessor, supports things such as XFT and ISO 14755 that are handy 51its 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 52in i18n-environments, is faster, and has a lot bugs less than the original
53rxvt. This all in addition to dozens of other small improvements. 53rxvt. This all in addition to dozens of other small improvements.
54 54
55It is still faithfully following the original rxvt idea of being lean 55It is still faithfully following the original rxvt idea of being lean
56and nice on resources: for example, you can still configure rxvt-unicode 56and 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 57without 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 58a client/daemon pair that lets you open any number of terminal windows
59from within a single process, which makes startup time very fast and 59from within a single process, which makes startup time very fast and
60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61@@RXVT_NAME@@c(1) (client). 61@@RXVT_NAME@@c(1) (client).
62 62
63It also makes technical information about escape sequences (which have 63It also makes technical information about escape sequences (which have
64been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 64been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65reference documentation (escape sequences etc.). 65reference documentation (escape sequences etc.).
66 66
67=head1 OPTIONS 67=head1 OPTIONS
68 68
69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed 69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
93 93
94Attempt to open a window on the named X display (B<-d> still 94Attempt to open a window on the named X display (B<-d> still
95respected). In the absence of this option, the display specified by the 95respected). In the absence of this option, the display specified by the
96B<DISPLAY> environment variable is used. 96B<DISPLAY> environment variable is used.
97 97
98=item B<-depth> I<bitdepth>
99
100Compile I<xft>: Attempt to find a visual with the given bit depth;
101resource B<depth>.
102
98=item B<-geometry> I<geom> 103=item B<-geometry> I<geom>
99 104
100Window geometry (B<-g> still respected); resource B<geometry>. 105Window geometry (B<-g> still respected); resource B<geometry>.
101 106
102=item B<-rv>|B<+rv> 107=item B<-rv>|B<+rv>
103 108
104Turn on/off simulated reverse video; resource B<reverseVideo>. 109Turn on/off simulated reverse video; resource B<reverseVideo>.
105 110
106=item B<-j>|B<+j> 111=item B<-j>|B<+j>
107 112
108Turn on/off jump scrolling; resource B<jumpScroll>. 113Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109 114
110=item B<-ip>|B<+ip> 115=item B<-ss>|B<+ss>
116
117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118
119=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
111 120
112Turn on/off inheriting parent window's pixmap. Alternative form is 121Turn on/off inheriting parent window's pixmap. Alternative form is
113B<-tr>; resource B<inheritPixmap>. 122B<-tr>; resource B<inheritPixmap>.
114 123
124I<Please note that transparency of any kind if completely unsupported by
125the author. Don't bug him with installation questions! Read the FAQ (man 7
126@@RXVT_NAME@@)!>
127
115=item B<-fade> I<number> 128=item B<-fade> I<number>
116 129
117Fade the text by the given percentage when focus is lost. resource B<fading>. 130Fade the text by the given percentage when focus is lost. Small values
131fade a little only, 100 completely replaces all colours by the fade
132colour; resource B<fading>.
133
134=item B<-fadecolor> I<colour>
135
136Fade to this colour when fading is used (see B<-fade>). The default colour
137is opaque black. resource B<fadeColor>.
118 138
119=item B<-tint> I<colour> 139=item B<-tint> I<colour>
120 140
121Tint the transparent background pixmap with the given colour when 141Tint the transparent background pixmap with the given colour when
122transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> 142transparency is enabled with B<-tr> or B<-ip>. This only works for
123option that can be used to brighten or darken the image in addition to 143non-tiled backgrounds, currently. See also the B<-sh> option that can be
124tinting it. 144used to brighten or darken the image in addition to tinting it; resource
145I<tintColor>. Example:
125 146
126=item B<-sh> 147 @@RXVT_NAME@@ -tr -tint blue -sh 40
127 148
149=item B<-sh> I<number>
150
128I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 151Darken (0 .. 100) or lighten (-1 .. -100) the transparent
129background image in addition to tinting it (i.e. B<-tint> must be 152background image in addition to (or instead of) tinting it;
130specified, too, e.g. C<-tint white>). 153resource I<shading>.
154
155=item B<-blt> I<string>
156
157Specify background blending type. If background pixmap is specified
158at the same time as transparency - such pixmap will be blended over
159transparency image, using method specified. Supported values are :
160B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
161B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
162B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
163alpha-blending; resource I<blendType>.
164
165=item B<-blr> I<number>
166
167Apply Gaussian Blur with the specified radius to the transparent
168background image; resource I<blurRadius>.
131 169
132=item B<-bg> I<colour> 170=item B<-bg> I<colour>
133 171
134Window background colour; resource B<background>. 172Window background colour; resource B<background>.
135 173
137 175
138Window foreground colour; resource B<foreground>. 176Window foreground colour; resource B<foreground>.
139 177
140=item B<-pixmap> I<file[;geom]> 178=item B<-pixmap> I<file[;geom]>
141 179
142Compile I<XPM>: Specify XPM file for the background and also optionally 180Compile I<afterimage>: Specify image file for the background and also
143specify its scaling with a geometry string. Note you may need to 181optionally specify its scaling with a geometry string. Note you may need to
144add quotes to avoid special shell interpretation of the C<;> in the 182add quotes to avoid special shell interpretation of the C<;> in the
145command-line; resource B<backgroundPixmap>. 183command-line; for more details see resource B<backgroundPixmap>.
146 184
147=item B<-cr> I<colour> 185=item B<-cr> I<colour>
148 186
149The cursor colour; resource B<cursorColor>. 187The cursor colour; resource B<cursorColor>.
150 188
162resource B<borderColor>. 200resource B<borderColor>.
163 201
164=item B<-fn> I<fontlist> 202=item B<-fn> I<fontlist>
165 203
166Select the fonts to be used. This is a comma separated list of font names 204Select the fonts to be used. This is a comma separated list of font names
167that are used in turn when trying to display Unicode characters. The 205that are checked in order when trying to find glyphs for characters. The
168first font defines the cell size for characters; other fonts might be 206first font defines the cell size for characters; other fonts might be
169smaller, but not (in general) larger. A (hopefully) reasonable default 207smaller, but not (in general) larger. A (hopefully) reasonable default
170font list is always appended to it. See resource B<font> for more details. 208font list is always appended to it. See resource B<font> for more details.
171 209
172In short, to specify an X11 core font, just specify it's name or prefix it 210In short, to specify an X11 core font, just specify its name or prefix it
173with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, 211with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
174e.g.: 212e.g.:
175 213
176 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 214 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
177 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 215 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
179See also the question "How does rxvt-unicode choose fonts?" in the FAQ 217See also the question "How does rxvt-unicode choose fonts?" in the FAQ
180section of @@RXVT_NAME@@(7). 218section of @@RXVT_NAME@@(7).
181 219
182=item B<-fb> I<fontlist> 220=item B<-fb> I<fontlist>
183 221
184Compile font-styles: The bold font list to use when bold characters are to 222Compile I<font-styles>: The bold font list to use when B<bold> characters
185be printed. See resource B<boldFont> for details. 223are to be printed. See resource B<boldFont> for details.
186 224
187=item B<-fi> I<fontlist> 225=item B<-fi> I<fontlist>
188 226
189Compile font-styles: The italic font list to use when bold characters are to 227Compile I<font-styles>: The italic font list to use when I<italic>
190be printed. See resource B<italicFont> for details. 228characters are to be printed. See resource B<italicFont> for details.
191 229
192=item B<-fbi> I<fontlist> 230=item B<-fbi> I<fontlist>
193 231
194Compile font-styles: The bold italic font list to use when bold characters are to 232Compile I<font-styles>: The bold italic font list to use when B<< I<bold
195be printed. See resource B<boldItalicFont> for details. 233italic> >> characters are to be printed. See resource B<boldItalicFont>
234for details.
235
236=item B<-is>|B<+is>
237
238Compile I<font-styles>: Bold/Italic font styles imply high intensity
239foreground/background (default). See resource B<intensityStyles> for
240details.
196 241
197=item B<-name> I<name> 242=item B<-name> I<name>
198 243
199Specify the application name under which resources are to be obtained, 244Specify the application name under which resources are to be obtained,
200rather than the default executable file name. Name should not contain 245rather than the default executable file name. Name should not contain
238 283
239Put scrollbar on right/left; resource B<scrollBar_right>. 284Put scrollbar on right/left; resource B<scrollBar_right>.
240 285
241=item B<-st>|B<+st> 286=item B<-st>|B<+st>
242 287
243Display normal (non XTerm/NeXT) scrollbar without/with a trough; 288Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
244resource B<scrollBar_floating>. 289resource B<scrollBar_floating>.
245 290
246=item B<-ptab>|B<+ptab> 291=item B<-ptab>|B<+ptab>
247 292
248If enabled (default), "Horizontal Tab" characters are being stored as 293If enabled (default), "Horizontal Tab" characters are being stored as
279=item B<-bl> 324=item B<-bl>
280 325
281Compile I<frills>: Set MWM hints to request a borderless window, i.e. 326Compile I<frills>: Set MWM hints to request a borderless window, i.e.
282if honoured by the WM, the rxvt-unicode window will not have window 327if honoured by the WM, the rxvt-unicode window will not have window
283decorations; resource B<borderLess>. 328decorations; resource B<borderLess>.
329
330=item B<-override-redirect>
331
332Compile I<frills>: Sets override-redirect on the window; resource
333B<override-redirect>.
334
335=item B<-sbg>
336
337Compile I<frills>: Disable the usage of the built-in block graphics/line
338drawing characters and just rely on what the specified fonts provide. Use
339this if you have a good font and want to use its block graphic glyphs;
340resource B<skipBuiltinGlyphs>.
284 341
285=item B<-lsp> I<number> 342=item B<-lsp> I<number>
286 343
287Compile I<frills>: Lines (pixel height) to insert between each row of 344Compile I<frills>: Lines (pixel height) to insert between each row of
288the display. Useful to work around font rendering problems; resource 345the display. Useful to work around font rendering problems; resource
303given on the command line. If this option is used, it must be the last 360given on the command line. If this option is used, it must be the last
304on the command-line. If there is no B<-e> option then the default is to 361on the command-line. If there is no B<-e> option then the default is to
305run the program specified by the B<SHELL> environment variable or, 362run the program specified by the B<SHELL> environment variable or,
306failing that, I<sh(1)>. 363failing that, I<sh(1)>.
307 364
365Please note that you must specify a program with arguments. If you want to
366run shell commands, you have to specify the shell, like this:
367
368 @@RXVT_NAME@@ -e sh -c "shell commands"
369
308=item B<-title> I<text> 370=item B<-title> I<text>
309 371
310Window title (B<-T> still respected); the default title is the basename 372Window title (B<-T> still respected); the default title is the basename
311of the program specified after the B<-e> option, if any, otherwise the 373of the program specified after the B<-e> option, if any, otherwise the
312application name; resource B<title>. 374application name; resource B<title>.
343for more info. 405for more info.
344 406
345=item B<-tcw> 407=item B<-tcw>
346 408
347Change the meaning of triple-click selection with the left mouse 409Change the meaning of triple-click selection with the left mouse
410button. Only effective when the original (non-perl) selection code is
348button. Instead of selecting a full line it will extend the selection the 411in-use. Instead of selecting a full line it will extend the selection the
349end of the logical line only. resource B<tripleclickwords>. 412end of the logical line only. resource B<tripleclickwords>.
350 413
351=item B<-insecure> 414=item B<-insecure>
352 415
353Enable "insecure" mode, which currently enables most of the escape 416Enable "insecure" mode, which currently enables most of the escape
368=item B<-ssr>|B<+ssr> 431=item B<-ssr>|B<+ssr>
369 432
370Turn on/off secondary screen scroll (default enabled); resource 433Turn on/off secondary screen scroll (default enabled); resource
371B<secondaryScroll>. 434B<secondaryScroll>.
372 435
436=item B<-hold>|B<+hold>
437
438Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
439will not immediately destroy its window when the program executed within
440it exits. Instead, it will wait till it is being killed or closed by the
441user; resource B<hold>.
442
373=item B<-keysym.>I<sym> I<string> 443=item B<-keysym.>I<sym> I<string>
374 444
375Remap a key symbol. See resource B<keysym>. 445Remap a key symbol. See resource B<keysym>.
376 446
377=item B<-embed> I<windowid> 447=item B<-embed> I<windowid>
378 448
379Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 449Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
380which enables applications to easily embed a terminal. 450which enables applications to easily embed a terminal.
381 451
382Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 452Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
383shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 453shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
384quite a bit, so don't expect it to keep some specific state. It's best to 454quite a bit, so don't expect it to keep some specific state. It's best to
387The window will not be destroyed when @@RXVT_NAME@@ exits. 457The window will not be destroyed when @@RXVT_NAME@@ exits.
388 458
389It might be useful to know that @@RXVT_NAME@@ will not close file 459It might be useful to know that @@RXVT_NAME@@ will not close file
390descriptors passed to it (except for stdin/out/err, of course), so you 460descriptors passed to it (except for stdin/out/err, of course), so you
391can use file descriptors to communicate with the programs within the 461can use file descriptors to communicate with the programs within the
392terminal. This works regardless of wether the C<-embed> option was used or 462terminal. This works regardless of whether the C<-embed> option was used or
393not. 463not.
394 464
395Here is a short Gtk2-perl snippet that illustrates how this option can be 465Here is a short Gtk2-perl snippet that illustrates how this option can be
396used (a longer example is in F<doc/embed>): 466used (a longer example is in F<doc/embed>):
397 467
398 my $rxvt = new Gtk2::DrawingArea; 468 my $rxvt = new Gtk2::Socket;
399 $...->add ($rxvt); # important to add it somewhere first 469 $rxvt->signal_connect_after (realize => sub {
400 $rxvt->realize; # now it can be realized
401 my $xid = $rxvt->window->get_xid; 470 my $xid = $_[0]->window->get_xid;
402
403 system "@@RXVT_NAME@@ -embed $xid &"; 471 system "@@RXVT_NAME@@ -embed $xid &";
472 });
404 473
405=item B<-pty-fd> I<fileno> 474=item B<-pty-fd> I<file descriptor>
406 475
407Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 476Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
408pair but instead use the given filehandle as the tty master. This is 477pair but instead use the given file descriptor as the tty master. This is
409useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 478useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
410without having to run a program within it. 479without having to run a program within it.
411 480
412If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 481If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
413entries and will not tinker with pty/tty permissions - you have to do that 482entries and will not tinker with pty/tty permissions - you have to do that
414yourself if you want that. 483yourself if you want that.
415 484
485As an extremely special case, specifying C<-1> will completely suppress
486pty/tty operations.
487
416Here is a example in perl that illustrates how this option can be used (a 488Here is a example in perl that illustrates how this option can be used (a
417longer example is in F<doc/pty-fd>): 489longer example is in F<doc/pty-fd>):
418 490
419 use IO::Pty; 491 use IO::Pty;
420 use Fcntl; 492 use Fcntl;
421 493
422 my $pty = new IO::Pty; 494 my $pty = new IO::Pty;
423 fcntl $pty, F_SETFD, 0; # clear close-on-exec 495 fcntl $pty, F_SETFD, 0; # clear close-on-exec
424
425 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&"; 496 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
497 close $pty;
426 498
427 # now communicate with rxvt 499 # now communicate with rxvt
428 my $slave = $pty->slave; 500 my $slave = $pty->slave;
429 while (<$slave>) { print $slave "got <$_>\n" } 501 while (<$slave>) { print $slave "got <$_>\n" }
430 502
503=item B<-pe> I<string>
504
505Comma-separated list of perl extension scripts to use (or not to use) in
506this terminal instance. See resource B<perl-ext> for details.
507
431=back 508=back
432 509
433=head1 RESOURCES (available also as long-options) 510=head1 RESOURCES (available also as long-options)
434 511
435Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 512Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
436options) compiled into your version. 513options) compiled into your version.
437 514
438There are two different methods that @@RXVT_NAME@@ can use to get the 515You can set and change the resources using X11 tools like B<xrdb>. Many
439Xresource data: using the X libraries (Xrm*-functions) or internal 516distribution do also load settings from the B<~/.Xresources> file when X
440Xresources reader (B<~/.Xdefaults>). For the first method (ie. 517starts. @@RXVT_NAME@@ will consult the following files/resources in order,
441B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 518with later settings overwriting earlier ones:
442resources using X11 tools like B<xrdb>. Many distribution do also load
443settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
444will consult the following files/resources in order, with later settings
445overwriting earlier ones:
446 519
447 1. system-wide app-defaults file, either locale-dependent OR global 520 1. system-wide app-defaults file, either locale-dependent OR global
448 2. app-defaults file in $XAPPLRESDIR 521 2. app-defaults file in $XAPPLRESDIR
449 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 522 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
450 4. SCREEN_RESOURCES for the current screen 523 4. SCREEN_RESOURCES for the current screen
451 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 524 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
452 525
453If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
454lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
455set in XAPPLOADDIR/URxvt (compile-time defined: usually
456B</usr/lib/X11/app-defaults/URxvt>) and resources set in
457B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
458Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 526Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
459class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 527names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
460resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 528common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
461easily configured, while the class name B<URxvt> allows resources 529configured, while the class name B<URxvt> allows resources unique to
462unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 530B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
463shared between different B<@@RXVT_NAME@@> configurations. If no 531configurations. If no resources are specified, suitable defaults will
464resources are specified, suitable defaults will be used. Command-line 532be used. Command-line arguments can be used to override resource
465arguments can be used to override resource settings. The following 533settings. The following resources are supported (you might want to
466resources are allowed: 534check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
535extensions not documented here):
467 536
468=over 4 537=over 4
538
539=item B<depth:> I<bitdepth>
540
541Compile I<xft>: Attempt to find a visual with the given bit depth;
542option B<-depth>.
469 543
470=item B<geometry:> I<geom> 544=item B<geometry:> I<geom>
471 545
472Create the window with the specified X window geometry [default 80x24]; 546Create the window with the specified X window geometry [default 80x24];
473option B<-geometry>. 547option B<-geometry>.
510Use the specified colour to display underlined characters when the 584Use the specified colour to display underlined characters when the
511foreground colour is the default. 585foreground colour is the default.
512 586
513=item B<colorRV:> I<colour> 587=item B<colorRV:> I<colour>
514 588
515Use the specified colour as the background for reverse video 589Use the specified colour as the background for reverse video characters
516characters. 590when OPTION_HC is disabled (--disable-frills).
517 591
518=item B<underlineColor:> I<colour> 592=item B<underlineColor:> I<colour>
519 593
520If set, use the specified colour as the colour for the underline 594If set, use the specified colour as the colour for the underline
521itself. If unset, use the foreground colour. 595itself. If unset, use the foreground colour.
537option B<-rv>. B<False>: regular screen colours [default]; option 611option B<-rv>. B<False>: regular screen colours [default]; option
538B<+rv>. See note in B<COLORS AND GRAPHICS> section. 612B<+rv>. See note in B<COLORS AND GRAPHICS> section.
539 613
540=item B<jumpScroll:> I<boolean> 614=item B<jumpScroll:> I<boolean>
541 615
542B<True>: specify that jump scrolling should be used. When scrolling 616B<True>: specify that jump scrolling should be used. When receiving lots
543quickly, fewer screen updates are performed [default]; option B<-j>. 617of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
618has been read, resulting in fewer updates while still displaying every
619received line; option B<-j>.
620
544B<False>: specify that smooth scrolling should be used; option B<+j>. 621B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
622force a screen refresh on each new line it received; option B<+j>.
623
624=item B<skipScroll:> I<boolean>
625
626B<True>: (the default) specify that skip scrolling should be used. When
627receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
628(around 60 times per second), resulting in far fewer updates. This can
629result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
630option B<-ss>.
631
632B<False>: specify that everything is to be displayed, even
633if the refresh is too fast for the human eye to read anything (or the
634monitor to display anything); option B<+ss>.
545 635
546=item B<inheritPixmap:> I<boolean> 636=item B<inheritPixmap:> I<boolean>
547 637
548B<True>: make the background inherit the parent windows' pixmap, giving 638B<True>: make the background inherit the parent windows' pixmap, giving
549artificial transparency. B<False>: do not inherit the parent windows' 639artificial transparency. B<False>: do not inherit the parent windows'
550pixmap. 640pixmap.
551 641
642I<Please note that transparency of any kind if completely unsupported by
643the author. Don't bug him with installation questions!>
644
552=item B<fading:> I<number> 645=item B<fading:> I<number>
553 646
554Fade the text by the given percentage when focus is lost. 647Fade the text by the given percentage when focus is lost; option B<-fade>.
648
649=item B<fadeColor:> I<colour>
650
651Fade to this colour, when fading is used (see B<fading:>). The default
652colour is black; option B<-fadecolor>.
555 653
556=item B<tintColor:> I<colour> 654=item B<tintColor:> I<colour>
557 655
558Tint the transparent background pixmap with the given colour. 656Tint the transparent background pixmap with the given colour; option
657B<-tint>.
559 658
560=item B<shading:> I<number> 659=item B<shading:> I<number>
561 660
562Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 661Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
563image in addition to tinting it. 662in addition to tinting it; option B<-sh>.
663
664=item B<blendType:> I<string>
665
666Specify background blending type; option B<-blt>.
667
668=item B<blurRadius:> I<number>
669
670Apply Gaussian Blurr with the specified radius to the transparent
671background image; option B<-blr>.
564 672
565=item B<scrollColor:> I<colour> 673=item B<scrollColor:> I<colour>
566 674
567Use the specified colour for the scrollbar [default #B2B2B2]. 675Use the specified colour for the scrollbar [default #B2B2B2].
568 676
569=item B<troughColor:> I<colour> 677=item B<troughColor:> I<colour>
570 678
571Use the specified colour for the scrollbar's trough area [default 679Use the specified colour for the scrollbar's trough area [default
572#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 680#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
573 681
574=item B<borderColor:> I<colour> 682=item B<borderColor:> I<colour>
575 683
576The colour of the border around the text area and between the scrollbar 684The colour of the border around the text area and between the scrollbar
577and the text. 685and the text.
578 686
579=item B<backgroundPixmap:> I<file[;geom]> 687=item B<backgroundPixmap:> I<file[;geom]>
580 688
581Use the specified XPM file (note the `.xpm' extension is optional) for 689Use the specified image file for the background and also optionally
582the background and also optionally specify its scaling with a geometry 690specify its scaling with a geometry string B<WxH+X+Y>,
583string B<WxH+X+Y>, in which B<"W" / "H"> specify the 691in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
584horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 692and B<"X" / "Y"> locate the image centre (percent).
585centre (percent). A scale of 0 displays the image with tiling. A scale 693A scale of 0 displays the image with tiling. A scale of 1 displays the
586of 1 displays the image without any scaling. A scale of 2 to 9 694image without any scaling. A scale of 2 to 9 specifies an integer
587specifies an integer number of images in that direction. No image will 695number of images in that direction. No image will be magnified beyond
588be magnified beyond 10 times its original size. The maximum permitted 69610 times its original size. The maximum permitted scale is 1000.
589scale is 1000. [default 0x0+50+50] 697Special string of B<"auto"> used as a geometry will cause image to be
590 698automatically scaled to match window size.
591=item B<menu:> I<file[;tag]> 699If used in conjunction with B<-tr> option - specified pixmap will be
592 700blended over transparency image using either alpha-blending, or any
593Read in the specified menu file (note the `.menu' extension is 701other blending type, specified with B<-blt "type"> option.
594optional) and also optionally specify a starting tag to find. See the 702[default 0x0+50+50]
595reference documentation for details on the syntax for the menuBar.
596 703
597=item B<path:> I<path> 704=item B<path:> I<path>
598 705
599Specify the colon-delimited search path for finding files (XPM and 706Specify the colon-delimited search path for finding XPM files.
600menus), in addition to the paths specified by the B<RXVTPATH> and
601B<PATH> environment variables.
602 707
603=item B<font:> I<fontlist> 708=item B<font:> I<fontlist>
604 709
605Select the fonts to be used. This is a comma separated list of font 710Select the fonts to be used. This is a comma separated list of font names
606names that are used in turn when trying to display Unicode characters. 711that are checked in order when trying to find glyphs for characters. The
607The first font defines the cell size for characters; other fonts might 712first font defines the cell size for characters; other fonts might be
608be smaller, but not larger. A reasonable default font list is always 713smaller, but not (in general) larger. A (hopefully) reasonable default
609appended to it. option B<-fn>. 714font list is always appended to it; option B<-fn>.
610 715
611Each font can either be a standard X11 core font (XLFD) name, with 716Each font can either be a standard X11 core font (XLFD) name, with
612optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 717optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
613 718
614In addition, each font can be prefixed with additional hints and 719In addition, each font can be prefixed with additional hints and
616hint currently is C<codeset=codeset-name>, and this is only used for Xft 721hint currently is C<codeset=codeset-name>, and this is only used for Xft
617fonts. 722fonts.
618 723
619For example, this font resource 724For example, this font resource
620 725
621 URxvt*font: 9x15bold,\ 726 URxvt.font: 9x15bold,\
622 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 727 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
623 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 728 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
624 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 729 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
625 xft:Code2000:antialias=false 730 xft:Code2000:antialias=false
626 731
660not possible, replacement fonts of the desired shape will be tried. 765not possible, replacement fonts of the desired shape will be tried.
661 766
662If set, but empty, then this specific style is disabled and the normal 767If set, but empty, then this specific style is disabled and the normal
663text font will being used for the given style. 768text font will being used for the given style.
664 769
770=item B<intensityStyles:> I<boolean>
771
772When font styles are not enabled, or this option is enabled (B<True>,
773option B<-is>, the default), bold and italic font styles imply high
774intensity foreground/background colours. Disabling this option (B<False>,
775option B<+is>) disables this behaviour, the high intensity colours are not
776reachable.
777
665=item B<selectstyle:> I<mode> 778=item B<selectstyle:> I<mode>
666 779
667Set mouse selection style to B<old> which is 2.20, B<oldword> which is 780Set mouse selection style to B<old> which is 2.20, B<oldword> which
668xterm style with 2.20 old word selection, or anything else which gives 781is xterm style with 2.20 old word selection, or anything else which
669xterm style selection. 782gives xterm style selection. Only effective when the original (non-perl)
783selection code is in use.
670 784
671=item B<scrollstyle:> I<mode> 785=item B<scrollstyle:> I<mode>
672 786
673Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 787Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
674the author's favourite.. 788the author's favourite.
675 789
676=item B<title:> I<string> 790=item B<title:> I<string>
677 791
678Set window title string, the default title is the command-line 792Set window title string, the default title is the command-line
679specified after the B<-e> option, if any, otherwise the application 793specified after the B<-e> option, if any, otherwise the application
688=item B<mapAlert:> I<boolean> 802=item B<mapAlert:> I<boolean>
689 803
690B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 804B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
691de-iconify (map) on receipt of a bell character [default]. 805de-iconify (map) on receipt of a bell character [default].
692 806
807=item B<urgentOnBell:> I<boolean>
808
809B<True>: set the urgency hint for the wm on receipt of a bell character.
810B<False>: do not set the urgency hint [default].
811
693=item B<visualBell:> I<boolean> 812=item B<visualBell:> I<boolean>
694 813
695B<True>: use visual bell on receipt of a bell character; option B<-vb>. 814B<True>: use visual bell on receipt of a bell character; option B<-vb>.
696B<False>: no visual bell [default]; option B<+vb>. 815B<False>: no visual bell [default]; option B<+vb>.
697 816
711 830
712Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 831Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
713B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 832B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
714B<Shift-Print> to include the scrollback as well. 833B<Shift-Print> to include the scrollback as well.
715 834
835The string will be interpreted as if typed into the shell as-is.
836
837Example:
838
839 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
840
841This creates a new file in your home directory with the screen contents
842every time you hit C<Print>.
843
716=item B<scrollBar:> I<boolean> 844=item B<scrollBar:> I<boolean>
717 845
718B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 846B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
719disable the scrollbar; option B<+sb>. 847disable the scrollbar; option B<+sb>.
720 848
741 869
742=item B<scrollWithBuffer:> I<boolean> 870=item B<scrollWithBuffer:> I<boolean>
743 871
744B<True>: scroll with scrollback buffer when tty receives new lines (and 872B<True>: scroll with scrollback buffer when tty receives new lines (and
745B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 873B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
746with scrollback buffer when tty recieves new lines; option B<+sw>. 874with scrollback buffer when tty receives new lines; option B<+sw>.
747 875
748=item B<scrollTtyKeypress:> I<boolean> 876=item B<scrollTtyKeypress:> I<boolean>
749 877
750B<True>: scroll to bottom when a non-special key is pressed. Special keys 878B<True>: scroll to bottom when a non-special key is pressed. Special keys
751are those which are intercepted by rxvt-unicode for special handling and 879are those which are intercepted by rxvt-unicode for special handling and
770=item B<borderLess:> I<boolean> 898=item B<borderLess:> I<boolean>
771 899
772Set MWM hints to request a borderless window, i.e. if honoured by the 900Set MWM hints to request a borderless window, i.e. if honoured by the
773WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 901WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
774 902
903=item B<skipBuiltinGlyphs:> I<boolean>
904
905Compile I<frills>: Disable the usage of the built-in block graphics/line
906drawing characters and just rely on what the specified fonts provide. Use
907this if you have a good font and want to use its block graphic glyphs;
908option B<-sbg>.
909
775=item B<termName:> I<termname> 910=item B<termName:> I<termname>
776 911
777Specifies the terminal type name to be set in the B<TERM> environment 912Specifies the terminal type name to be set in the B<TERM> environment
778variable; option B<-tn>. 913variable; option B<-tn>.
779 914
816 951
817Mouse pointer background colour. 952Mouse pointer background colour.
818 953
819=item B<pointerBlankDelay:> I<number> 954=item B<pointerBlankDelay:> I<number>
820 955
821Specifies number of seconds before blanking the pointer [default 2]. 956Specifies number of seconds before blanking the pointer [default 2]. Use a
957large number (e.g. C<987654321>) to effectively disable the timeout.
822 958
823=item B<backspacekey:> I<string> 959=item B<backspacekey:> I<string>
824 960
825The string to send when the backspace key is pressed. If set to B<DEC> 961The string to send when the backspace key is pressed. If set to B<DEC>
826or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 962or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
833pressed. If unset it will send the sequence traditionally associated 969pressed. If unset it will send the sequence traditionally associated
834with the B<Execute> key. 970with the B<Execute> key.
835 971
836=item B<cutchars:> I<string> 972=item B<cutchars:> I<string>
837 973
838The characters used as delimiters for double-click word selection. The 974The characters used as delimiters for double-click word selection
839built-in default: 975(whitespace delimiting is added automatically if resource is given).
976
977When the perl selection extension is in use (the default if compiled
978in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
979characters will be created (if the resource exists, otherwise, no regex
980will be created). In this mode, characters outside ISO-8859-1 can be used.
981
982When the selection extension is not used, only ISO-8859-1 characters can
983be used. If not specified, the built-in default is used:
840 984
841B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 985B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
842 986
843=item B<preeditType:> I<style> 987=item B<preeditType:> I<style>
844 988
851=item B<imLocale:> I<name> 995=item B<imLocale:> I<name>
852 996
853The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 997The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
854C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the 998C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
855input extension to be able to input japanese characters while staying in 999input extension to be able to input japanese characters while staying in
856another locale. option B<-imlocale>. 1000another locale; option B<-imlocale>.
857 1001
858=item B<imFont:> I<fontset> 1002=item B<imFont:> I<fontset>
859 1003
860Specify the font-set used for XIM styles C<OverTheSpot> or 1004Specify the font-set used for XIM styles C<OverTheSpot> or
861C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 1005C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
866 1010
867=item B<tripleclickwords:> I<boolean> 1011=item B<tripleclickwords:> I<boolean>
868 1012
869Change the meaning of triple-click selection with the left mouse 1013Change the meaning of triple-click selection with the left mouse
870button. Instead of selecting a full line it will extend the selection to 1014button. Instead of selecting a full line it will extend the selection to
871the end of the logical line only. option B<-tcw>. 1015the end of the logical line only; option B<-tcw>.
872 1016
873=item B<insecure:> I<boolean> 1017=item B<insecure:> I<boolean>
874 1018
875Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1019Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
876echo arbitrary strings like the icon name or the locale. This could be 1020echo arbitrary strings like the icon name or the locale. This could be
877abused if somebody gets 8-bit-clean access to your display, whether 1021abused if somebody gets 8-bit-clean access to your display, whether
878throuh a mail client displaying mail bodies unfiltered or though 1022through a mail client displaying mail bodies unfiltered or through
879write(1). Therefore, these sequences are disabled by default. (Note 1023write(1) or any other means. Therefore, these sequences are disabled by
880that other terminals, including xterm, have these sequences 1024default. (Note that many other terminals, including xterm, have these
881enabled by default). You can enable them by setting this boolean 1025sequences enabled by default, which doesn't make it safer, though).
882resource or specifying B<-insecure> as an option. At the moment, this 1026
883enabled display-answer, locale, findfont, icon label and window title 1027You can enable them by setting this boolean resource or specifying
884requests as well as dynamic menubar dispatch. 1028B<-insecure> as an option. At the moment, this enables display-answer,
1029locale, findfont, icon label and window title requests.
885 1030
886=item B<modifier:> I<modifier> 1031=item B<modifier:> I<modifier>
887 1032
888Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 1033Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
889B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 1034B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
893 1038
894Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1039Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
895character is passed through. It may contain escape values as described 1040character is passed through. It may contain escape values as described
896in the entry on B<keysym> following. 1041in the entry on B<keysym> following.
897 1042
898=item B<secondaryScreen:> I<bool> 1043=item B<secondaryScreen:> I<boolean>
899 1044
900Turn on/off secondary screen (default enabled). 1045Turn on/off secondary screen (default enabled).
901 1046
902=item B<secondaryScroll:> I<bool> 1047=item B<secondaryScroll:> I<boolean>
903 1048
904Turn on/off secondary screen scroll (default enabled). If the this 1049Turn on/off secondary screen scroll (default enabled). If this
905option is enabled, scrolls on the secondary screen will change the 1050option is enabled, scrolls on the secondary screen will change the
906scrollback buffer and switching to/from the secondary screen will 1051scrollback buffer and switching to/from the secondary screen will
907instead scroll the screen up. 1052instead scroll the screen up.
1053
1054=item B<hold>: I<boolean>
1055
1056Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1057will not immediately destroy its window when the program executed within
1058it exits. Instead, it will wait till it is being killed or closed by the
1059user.
908 1060
909=item B<keysym.>I<sym>: I<string> 1061=item B<keysym.>I<sym>: I<string>
910 1062
911Compile I<frills>: Associate I<string> with keysym I<sym>. The 1063Compile I<frills>: Associate I<string> with keysym I<sym>. The
912intervening resource name B<keysym.> cannot be omitted. 1064intervening resource name B<keysym.> cannot be omitted.
930 1082
931I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1083I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
932C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1084C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
933C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1085C<\000>: octal number) or verbatim control characters (C<^?>: delete,
934C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1086C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
935can start or end with whitespace. 1087can start or end with whitespace. B<This feature is deprecated and will
1088be removed>.
936 1089
937Please note that you need to double the C<\> when using 1090Please note that you need to double the C<\> in resource files, as
938C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can 1091Xlib itself does its own de-escaping (you can use C<\033> instead of
939use C<\033> instead of C<\e> (and so on), which will work with both Xt and 1092C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
940@@RXVT_NAME@@'s own processing). 1093processing).
941 1094
942You can define a range of keysyms in one shot by providing a I<string> 1095You can define a range of keysyms in one shot by providing a I<string>
943with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1096with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
944should be a character not used by the strings. 1097should be a character not used by the strings.
945 1098
946Its usage can be demonstrated by an example: 1099Its usage can be demonstrated by an example:
947 1100
948 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1101 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
958example the following means "change the current locale to C<zh_CN.GBK> 1111example the following means "change the current locale to C<zh_CN.GBK>
959when Control-Meta-c is being pressed": 1112when Control-Meta-c is being pressed":
960 1113
961 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1114 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
962 1115
1116If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1117is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1118manpage. For example, the F<selection> extension (activated via
1119C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1120
1121 URxvt.keysym.M-C-c: perl:selection:rot13
1122
1123Due the the large number of modifier combinations, a defined key mapping
1124will match if at I<at least> the specified identifiers are being set, and
1125no other key mappings with those and more bits are being defined. That
1126means that defining a key map for C<a> will automatically provide
1127definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1128mappings themselves.
1129
1130Unfortunately, this will override built-in key mappings. For example
1131if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1132C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1133user-defined keymap using the C<builtin:> replacement:
1134
1135 URxvt.keysym.Insert: <my insert key sequence>
1136 URxvt.keysym.S-Insert: builtin:
1137
1138The first line defines a mapping for C<Insert> and I<any> combination
1139of modifiers. The second line re-establishes the default mapping for
1140C<Shift-Insert>.
1141
963The following example will map Control-Meta-1 and Control-Meta-2 to 1142The following example will map Control-Meta-1 and Control-Meta-2 to
964the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited 1143the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
965font-switching at runtime: 1144font-switching at runtime:
966 1145
967 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1146 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
970Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1149Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
971info): 1150info):
972 1151
973 URxvt.keysym.M-C-3: command:\033[8;25;80t 1152 URxvt.keysym.M-C-3: command:\033[8;25;80t
974 URxvt.keysym.M-C-4: command:\033[8;48;110t 1153 URxvt.keysym.M-C-4: command:\033[8;48;110t
1154
1155=item B<perl-ext-common>: I<string>
1156
1157=item B<perl-ext>: I<string>
1158
1159Comma-separated list(s) of perl extension scripts (default: C<default>) to
1160use in this terminal instance; option B<-pe>.
1161
1162Extension names can be prefixed with a C<-> sign to prohibit using
1163them. This can be useful to selectively disable some extensions loaded
1164by default, or specified via the C<perl-ext-common> resource. For
1165example, C<default,-selection> will use all the default extension except
1166C<selection>.
1167
1168Extension names can also be followed by an argument in angle brackets
1169(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1170searchable scrollback to Alt/Meta-s). Mentioning the same extension
1171multiple times with different arguments will pass multiple arguments to
1172the extension.
1173
1174Each extension is looked up in the library directories, loaded if
1175necessary, and bound to the current terminal instance.
1176
1177If both of these resources are the empty string, then the perl
1178interpreter will not be initialized. The idea behind two options is that
1179B<perl-ext-common> will be used for extensions that should be available to
1180all instances, while B<perl-ext> is used for specific instances.
1181
1182=item B<perl-eval>: I<string>
1183
1184Perl code to be evaluated when all extensions have been registered. See
1185the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1186will be ignored when running setuid/setgid.
1187
1188=item B<perl-lib>: I<path>
1189
1190Colon-separated list of additional directories that hold extension
1191scripts. When looking for extensions specified by the C<perl> resource,
1192@@RXVT_NAME@@ will first look in these directories and then in
1193F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1194will be ignored when running setuid/setgid.
1195
1196See the @@RXVT_NAME@@perl(3) manpage.
1197
1198=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1199
1200Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1201details.
1202
1203=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1204
1205Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1206for details.
1207
1208=item B<searchable-scrollback:> I<keysym>
1209
1210Sets the hotkey that starts the incremental scrollback buffer search
1211(default: C<M-s>).
1212
1213=item B<urlLauncher>: I<string>
1214
1215Specifies the program to be started with a URL argument. Used by the
1216C<selection-popup> and C<matcher> perl extensions.
1217
1218=item B<transient-for>: I<windowid>
1219
1220Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1221
1222=item B<override-redirect>: I<boolean>
1223
1224Compile I<frills>: Sets override-redirect for the terminal window, making
1225it almost invisible to window managers; option B<-override-redirect>.
1226
1227=item B<iso14755_52:> I<boolean>
1228
1229Turn on/off ISO 14755 5.2 mode (default enabled).
975 1230
976=back 1231=back
977 1232
978=head1 THE SCROLLBAR 1233=head1 THE SCROLLBAR
979 1234
998application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1253application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
999(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1254(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1000up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1255up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1001respectively. 1256respectively.
1002 1257
1003=head1 TEXT SELECTION AND INSERTION 1258=head1 THE SELECTION: SELECTING AND PASTING TEXT
1004 1259
1005The behaviour of text selection and insertion mechanism is similar to 1260The behaviour of text selection and insertion/pasting mechanism is similar
1006I<xterm>(1). 1261to I<xterm>(1).
1007 1262
1008=over 4 1263=over 4
1009 1264
1010=item B<Selection>: 1265=item B<Selecting>:
1011 1266
1012Left click at the beginning of the region, drag to the end of the region 1267Left click at the beginning of the region, drag to the end of the region
1013and release; Right click to extend the marked region; Left double-click 1268and release; Right click to extend the marked region; Left double-click
1014to select a word; Left triple-click to select the entire logical line 1269to select a word; Left triple-click to select the entire logical line
1015(which can span multiple screen lines), unless modified by resource 1270(which can span multiple screen lines), unless modified by resource
1016B<tripleclickwords>. 1271B<tripleclickwords>.
1017 1272
1018Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1273Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1019(Compile: I<frills>) will create a rectangular selection instead of a normal 1274(Compile: I<frills>) will create a rectangular selection instead of a
1020one. 1275normal one. In this mode, every selected row becomes its own line in the
1276selection, and trailing whitespace is visually underlined and removed from
1277the selection.
1021 1278
1022=item B<Insertion>: 1279=item B<Pasting>:
1023 1280
1024Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1281Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1025an B<@@RXVT_NAME@@> window causes the current text selection to be 1282window causes the value of the PRIMARY selection (or CLIPBOARD with the
1026inserted as if it had been typed on the keyboard. 1283B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1284
1285Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1286inserted too.
1027 1287
1028=back 1288=back
1029 1289
1030=head1 CHANGING FONTS 1290=head1 CHANGING FONTS
1031 1291
1032Changing fonts (or font sizes, respectively) via the keypad is not yet 1292Changing fonts (or font sizes, respectively) via the keypad is not yet
1033supported in rxvt-unicode. Bug me if you need this. 1293supported in rxvt-unicode. Bug me if you need this.
1034 1294
1035You can, however, switch fonts at runtime using escape sequences (and 1295You can, however, switch fonts at runtime using escape sequences, e.g.:
1036therefore using the menubar), e.g.:
1037 1296
1038 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1297 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1298
1299You can use keyboard shortcuts, too:
1300
1301 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1302 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1039 1303
1040rxvt-unicode will automatically re-apply these fonts to the output so far. 1304rxvt-unicode will automatically re-apply these fonts to the output so far.
1041 1305
1042=head1 ISO 14755 SUPPORT 1306=head1 ISO 14755 SUPPORT
1043 1307
1044ISO 14755 is a standard for entering and viewing unicode characters 1308ISO 14755 is a standard for entering and viewing unicode characters
1045and character codes using the keyboard. It consists of 4 parts. The 1309and character codes using the keyboard. It consists of 4 parts. The
1046first part is available rxvt-unicode has been compiled with 1310first part is available if rxvt-unicode has been compiled with
1047C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1311C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1048with C<--enable-iso14755>. 1312with C<--enable-iso14755>.
1049 1313
1050=over 4 1314=over 4
1051 1315
1071This mode lets you input characters representing the keycap symbols of 1335This mode lets you input characters representing the keycap symbols of
1072your keyboard, if representable in the current locale encoding. 1336your keyboard, if representable in the current locale encoding.
1073 1337
1074Start by pressing C<Control> and C<Shift> together, then releasing 1338Start by pressing C<Control> and C<Shift> together, then releasing
1075them. The next special key (cursor keys, home etc.) you enter will not 1339them. The next special key (cursor keys, home etc.) you enter will not
1076invoke it's usual function but instead will insert the corresponding 1340invoke its usual function but instead will insert the corresponding
1077keycap symbol. The symbol will only be entered when the key has been 1341keycap symbol. The symbol will only be entered when the key has been
1078released, otherwise pressing e.g. C<Shift> would enter the symbol for 1342released, otherwise pressing e.g. C<Shift> would enter the symbol for
1079C<ISO Level 2 Switch>, although your intention might have been to enter a 1343C<ISO Level 2 Switch>, although your intention might have been to enter a
1080reverse tab (Shift-Tab). 1344reverse tab (Shift-Tab).
1081 1345
1114=head1 COLORS AND GRAPHICS 1378=head1 COLORS AND GRAPHICS
1115 1379
1116In addition to the default foreground and background colours, 1380In addition to the default foreground and background colours,
1117B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1381B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1118high-intensity bold/blink versions of the same). Here is a list of the 1382high-intensity bold/blink versions of the same). Here is a list of the
1119colours with their B<rgb.txt> names. 1383colours with their names.
1120 1384
1121=begin table 1385=begin table
1122 1386
1123 B<color0> (black) = Black 1387 B<color0> (black) = Black
1124 B<color1> (red) = Red3 1388 B<color1> (red) = Red3
1144It is also possible to specify the colour values of B<foreground>, 1408It is also possible to specify the colour values of B<foreground>,
1145B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1409B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1146a number 0-15, as a convenient shorthand to reference the colour name of 1410a number 0-15, as a convenient shorthand to reference the colour name of
1147color0-color15. 1411color0-color15.
1148 1412
1413In addition to the colours defined above, @@RXVT_NAME@@ offers an
1414additional 72 colours. The first 64 of those (with indices 16 to 79)
1415consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
141616>), followed by 8 additional shades of gray (with indices 80 to 87).
1417
1418Together, all those colours implement the 88 colour xterm colours. Only
1419the first 16 can be changed using resources currently, the rest can only
1420be changed via command sequences ("escape codes").
1421
1149Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1422Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1150always swapping the foreground/background colours. This is in contrast to 1423always swapping the foreground/background colours. This is in contrast to
1151I<xterm>(1) where the colours are only swapped if they have not otherwise 1424I<xterm>(1) where the colours are only swapped if they have not otherwise
1152been specified. For example, 1425been specified. For example,
1153 1426
1158would yield White on Black, while on I<xterm>(1) it would yield Black 1431would yield White on Black, while on I<xterm>(1) it would yield Black
1159on White. 1432on White.
1160 1433
1161=back 1434=back
1162 1435
1436=head2 ALPHA CHANNEL SUPPORT
1437
1438If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1439their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1440(recommended, but B<MUST> have 4 digits/component) colour specifications,
1441in addition to the ones provided by X, where the additional A component
1442specifies opacity (alpha) values. The minimum value of C<0> is completely
1443transparent). You can also prefix any color with C<[percent]>, where
1444C<percent> is a decimal percentage (0-100) that specifies the opacity of
1445the color, where C<0> is completely transparent and C<100> is completelxy
1446opaque.
1447
1448You probably need to specify B<"-depth 32">, too, and have the luck that
1449your X-server uses ARGB pixel layout, as X is far from just supporting
1450ARGB visuals out of the box, and rxvt-unicode just fudges around.
1451
1452For example, the following selects an almost completely transparent red
1453background, and an almost opaque pink foreground:
1454
1455 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1456
1457I<Please note that transparency of any kind if completely unsupported by
1458the author. Don't bug him with installation questions!>
1459
1163=head1 ENVIRONMENT 1460=head1 ENVIRONMENT
1164 1461
1165B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1462B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1166 1463
1167=over 4 1464=over 4
1168 1465
1169=item B<TERM> 1466=item B<TERM>
1170 1467
1171Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1468Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1172resources or on the commandline. 1469resources or on the command line.
1173 1470
1174=item B<COLORTERM> 1471=item B<COLORTERM>
1175 1472
1176Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1473Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1177compiled with XPM support, and optionally with the added extension 1474compiled with XPM support, and optionally with the added extension
1178C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1475C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1179 1476
1180=item B<COLORFGBG> 1477=item B<COLORFGBG>
1181 1478
1199C<--with-terminfo=PATH>. 1496C<--with-terminfo=PATH>.
1200 1497
1201=item B<DISPLAY> 1498=item B<DISPLAY>
1202 1499
1203Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1500Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1204display in it's child processes. 1501display in its child processes.
1205 1502
1206=item B<SHELL> 1503=item B<SHELL>
1207 1504
1208The shell to be used for command execution, defaults to C</bin/sh>. 1505The shell to be used for command execution, defaults to C</bin/sh>.
1209
1210=item B<RXVTPATH>
1211
1212The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1213files.
1214
1215=item B<PATH>
1216
1217Used in the same way as C<RXVTPATH>.
1218 1506
1219=item B<RXVT_SOCKET> 1507=item B<RXVT_SOCKET>
1220 1508
1221The unix domain socket path used by @@RXVT_NAME@@c(1) and 1509The unix domain socket path used by @@RXVT_NAME@@c(1) and
1222@@RXVT_NAME@@d(1). 1510@@RXVT_NAME@@d(1).
1223 1511
1224Default C<< $HOME/.rxvt-unicode-<nodename >>. 1512Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1225 1513
1226=item B<HOME> 1514=item B<HOME>
1227 1515
1228Used to locate the default directory for the unix domain socket for 1516Used to locate the default directory for the unix domain socket for
1229daemon communications and to locate various resource files (such as 1517daemon communications and to locate various resource files (such as
1250 1538
1251=back 1539=back
1252 1540
1253=head1 SEE ALSO 1541=head1 SEE ALSO
1254 1542
1255@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1543@@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)
1256
1257=head1 BUGS
1258
1259Check the BUGS file for an up-to-date list.
1260
1261Cursor change support is not yet implemented.
1262
1263Click-and-drag doesn't work with X11 mouse report overriding.
1264 1544
1265=head1 CURRENT PROJECT COORDINATOR 1545=head1 CURRENT PROJECT COORDINATOR
1266 1546
1267=over 4 1547=over 4
1268 1548
1269=item Project Coordinator 1549=item Project Coordinator
1270 1550
1271Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1551Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1272 1552
1273L<http://software.schmorp.de/#rxvt-unicode> 1553L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1274 1554
1275=back 1555=back
1276 1556
1277=head1 AUTHORS 1557=head1 AUTHORS
1278 1558
1300 1580
1301Project Coordinator (changes.txt 2.21a to 2.4.5) 1581Project Coordinator (changes.txt 2.21a to 2.4.5)
1302 1582
1303=item Geoff Wing L<< <gcw@pobox.com> >> 1583=item Geoff Wing L<< <gcw@pobox.com> >>
1304 1584
1305Rewrote screen display and text selection routines. Project Coordinator 1585Rewrote screen display and text selection routines.
1586
1306(changes.txt 2.4.6 - rxvt-unicode) 1587Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1307 1588
1308=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1589=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1309 1590
1310Forked rxvt-unicode, rewrote most of the display code and internal 1591Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1311character handling to store text in unicode, improve xterm 1592extension, random hacks, numerous bugfixes and extensions.
1312compatibility and apply numerous other bugfixes and extensions.
1313 1593
1314Project Coordinator (Changes 1.0 -) 1594Project Coordinator (Changes 1.0 -)
1315 1595
1596=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1597
1598Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1599
1316=back 1600=back
1317 1601

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines