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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines