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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines