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.54 by root, Fri Feb 11 18:55:39 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
457=item B<-embed> I<windowid>
458
459Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
460which enables applications to easily embed a terminal.
461
462Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
463shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
464quite a bit, so don't expect it to keep some specific state. It's best to
465create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
466
467The window will not be destroyed when @@RXVT_NAME@@ exits.
468
469It might be useful to know that @@RXVT_NAME@@ will not close file
470descriptors passed to it (except for stdin/out/err, of course), so you
471can use file descriptors to communicate with the programs within the
472terminal. This works regardless of whether the C<-embed> option was used or
473not.
474
475Here is a short Gtk2-perl snippet that illustrates how this option can be
476used (a longer example is in F<doc/embed>):
477
478 my $rxvt = new Gtk2::Socket;
479 $rxvt->signal_connect_after (realize => sub {
480 my $xid = $_[0]->window->get_xid;
481 system "@@RXVT_NAME@@ -embed $xid &";
482 });
483
484=item B<-pty-fd> I<file descriptor>
485
486Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
487pair but instead use the given file descriptor as the tty master. This is
488useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
489without having to run a program within it.
490
491If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
492entries and will not tinker with pty/tty permissions - you have to do that
493yourself if you want that.
494
495As an extremely special case, specifying C<-1> will completely suppress
496pty/tty operations.
497
498Here is a example in perl that illustrates how this option can be used (a
499longer example is in F<doc/pty-fd>):
500
501 use IO::Pty;
502 use Fcntl;
503
504 my $pty = new IO::Pty;
505 fcntl $pty, F_SETFD, 0; # clear close-on-exec
506 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
507 close $pty;
508
509 # now communicate with rxvt
510 my $slave = $pty->slave;
511 while (<$slave>) { print $slave "got <$_>\n" }
512
377=item B<-xrm> I<resourcestring> 513=item B<-pe> I<string>
378 514
379No effect on rxvt-unicode. Simply passes through an argument to be made 515Comma-separated list of perl extension scripts to use (or not to use) in
380available in the instance's argument list. Appears in I<WM_COMMAND> in 516this terminal instance. See resource B<perl-ext> for details.
381some window managers.
382 517
383=back 518=back
384 519
385=head1 RESOURCES (available also as long-options) 520=head1 RESOURCES (available also as long-options)
386 521
387Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 522Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
388options) compiled into your version. 523options) compiled into your version.
389 524
390There 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
391Xresource data: using the X libraries (Xrm*-functions) or internal 526distribution do also load settings from the B<~/.Xresources> file when X
392Xresources reader (B<~/.Xdefaults>). For the first method (ie. 527starts. @@RXVT_NAME@@ will consult the following files/resources in order,
393B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 528with later settings overwriting earlier ones:
394resources using X11 tools like B<xrdb>. Many distribution do also load
395settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
396will consult the following files/resources in order, with later settings
397overwriting earlier ones:
398 529
399 1. system-wide app-defaults file, either locale-dependent OR global 530 1. system-wide app-defaults file, either locale-dependent OR global
400 2. app-defaults file in $XAPPLRESDIR 531 2. app-defaults file in $XAPPLRESDIR
401 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 532 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
402 4. SCREEN_RESOURCES for the current screen 533 4. SCREEN_RESOURCES for the current screen
403 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 534 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
404 535
405If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
406lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
407set in XAPPLOADDIR/URxvt (compile-time defined: usually
408B</usr/lib/X11/app-defaults/URxvt>) and resources set in
409B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
410Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 536Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
411class 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
412resources 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
413easily configured, while the class name B<URxvt> allows resources 539configured, while the class name B<URxvt> allows resources unique to
414unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 540B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
415shared between different B<@@RXVT_NAME@@> configurations. If no 541configurations. If no resources are specified, suitable defaults will
416resources are specified, suitable defaults will be used. Command-line 542be used. Command-line arguments can be used to override resource
417arguments can be used to override resource settings. The following 543settings. The following resources are supported (you might want to
418resources are allowed: 544check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
545extensions not documented here):
419 546
420=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>.
421 553
422=item B<geometry:> I<geom> 554=item B<geometry:> I<geom>
423 555
424Create the window with the specified X window geometry [default 80x24]; 556Create the window with the specified X window geometry [default 80x24];
425option B<-geometry>. 557option B<-geometry>.
462Use the specified colour to display underlined characters when the 594Use the specified colour to display underlined characters when the
463foreground colour is the default. 595foreground colour is the default.
464 596
465=item B<colorRV:> I<colour> 597=item B<colorRV:> I<colour>
466 598
467Use the specified colour as the background for reverse video 599Use the specified colour as the background for reverse video characters
468characters. 600when OPTION_HC is disabled (--disable-frills).
469 601
470=item B<underlineColor:> I<colour> 602=item B<underlineColor:> I<colour>
471 603
472If set, use the specified colour as the colour for the underline 604If set, use the specified colour as the colour for the underline
473itself. If unset, use the foreground colour. 605itself. If unset, use the foreground colour.
489option B<-rv>. B<False>: regular screen colours [default]; option 621option B<-rv>. B<False>: regular screen colours [default]; option
490B<+rv>. See note in B<COLORS AND GRAPHICS> section. 622B<+rv>. See note in B<COLORS AND GRAPHICS> section.
491 623
492=item B<jumpScroll:> I<boolean> 624=item B<jumpScroll:> I<boolean>
493 625
494B<True>: specify that jump scrolling should be used. When scrolling 626B<True>: specify that jump scrolling should be used. When receiving lots
495quickly, 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
496B<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>.
497 645
498=item B<inheritPixmap:> I<boolean> 646=item B<inheritPixmap:> I<boolean>
499 647
500B<True>: make the background inherit the parent windows' pixmap, giving 648B<True>: make the background inherit the parent windows' pixmap, giving
501artificial transparency. B<False>: do not inherit the parent windows' 649artificial transparency. B<False>: do not inherit the parent windows'
502pixmap. 650pixmap.
503 651
652I<Please note that transparency of any kind if completely unsupported by
653the author. Don't bug him with installation questions!>
654
504=item B<fading:> I<number> 655=item B<fading:> I<number>
505 656
506Fade 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>.
507 663
508=item B<tintColor:> I<colour> 664=item B<tintColor:> I<colour>
509 665
510Tint the transparent background pixmap with the given colour. 666Tint the transparent background pixmap with the given colour; option
667B<-tint>.
511 668
512=item B<shading:> I<number> 669=item B<shading:> I<number>
513 670
514Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 671Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
515image 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>.
516 682
517=item B<scrollColor:> I<colour> 683=item B<scrollColor:> I<colour>
518 684
519Use the specified colour for the scrollbar [default #B2B2B2]. 685Use the specified colour for the scrollbar [default #B2B2B2].
520 686
521=item B<troughColor:> I<colour> 687=item B<troughColor:> I<colour>
522 688
523Use the specified colour for the scrollbar's trough area [default 689Use the specified colour for the scrollbar's trough area [default
524#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 690#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
525 691
526=item B<borderColor:> I<colour> 692=item B<borderColor:> I<colour>
527 693
528The 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
529and the text. 695and the text.
530 696
531=item B<backgroundPixmap:> I<file[;geom]> 697=item B<backgroundPixmap:> I<file[;geom]>
532 698
533Use the specified XPM file (note the `.xpm' extension is optional) for 699Use the specified image file for the background and also optionally
534the background and also optionally specify its scaling with a geometry 700specify its scaling with a geometry string B<WxH+X+Y>,
535string B<WxH+X+Y>, in which B<"W" / "H"> specify the 701in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
536horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 702and B<"X" / "Y"> locate the image centre (percent).
537centre (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
538of 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
539specifies an integer number of images in that direction. No image will 705number of images in that direction. No image will be magnified beyond
540be magnified beyond 10 times its original size. The maximum permitted 70610 times its original size. The maximum permitted scale is 1000.
541scale is 1000. [default 0x0+50+50] 707Special string of B<"auto"> used as a geometry will cause image to be
542 708automatically scaled to match window size.
543=item B<menu:> I<file[;tag]> 709If used in conjunction with B<-tr> option - specified pixmap will be
544 710blended over transparency image using either alpha-blending, or any
545Read in the specified menu file (note the `.menu' extension is 711other blending type, specified with B<-blt "type"> option.
546optional) and also optionally specify a starting tag to find. See the 712[default 0x0+50+50]
547reference documentation for details on the syntax for the menuBar.
548 713
549=item B<path:> I<path> 714=item B<path:> I<path>
550 715
551Specify the colon-delimited search path for finding files (XPM and 716Specify the colon-delimited search path for finding background image files.
552menus), in addition to the paths specified by the B<RXVTPATH> and
553B<PATH> environment variables.
554 717
555=item B<font:> I<fontlist> 718=item B<font:> I<fontlist>
556 719
557Select 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
558names that are used in turn when trying to display Unicode characters. 721that are checked in order when trying to find glyphs for characters. The
559The first font defines the cell size for characters; other fonts might 722first font defines the cell size for characters; other fonts might be
560be smaller, but not larger. A reasonable default font list is always 723smaller, but not (in general) larger. A (hopefully) reasonable default
561appended to it. option B<-fn>. 724font list is always appended to it; option B<-fn>.
562 725
563Each 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
564optional 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:>.
565 728
566In addition, each font can be prefixed with additional hints and 729In addition, each font can be prefixed with additional hints and
568hint 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
569fonts. 732fonts.
570 733
571For example, this font resource 734For example, this font resource
572 735
573 URxvt*font: 9x15bold,\ 736 URxvt.font: 9x15bold,\
574 -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,\
575 -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, \
576 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 739 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
577 xft:Code2000:antialias=false 740 xft:Code2000:antialias=false
578 741
612not possible, replacement fonts of the desired shape will be tried. 775not possible, replacement fonts of the desired shape will be tried.
613 776
614If 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
615text font will being used for the given style. 778text font will being used for the given style.
616 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
617=item B<selectstyle:> I<mode> 788=item B<selectstyle:> I<mode>
618 789
619Set 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
620xterm 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
621xterm style selection. 792gives xterm style selection. Only effective when the original (non-perl)
793selection code is in use.
622 794
623=item B<scrollstyle:> I<mode> 795=item B<scrollstyle:> I<mode>
624 796
625Set 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
626the author's favourite.. 798the author's favourite.
627 799
628=item B<title:> I<string> 800=item B<title:> I<string>
629 801
630Set window title string, the default title is the command-line 802Set window title string, the default title is the command-line
631specified after the B<-e> option, if any, otherwise the application 803specified after the B<-e> option, if any, otherwise the application
640=item B<mapAlert:> I<boolean> 812=item B<mapAlert:> I<boolean>
641 813
642B<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
643de-iconify (map) on receipt of a bell character [default]. 815de-iconify (map) on receipt of a bell character [default].
644 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
645=item B<visualBell:> I<boolean> 822=item B<visualBell:> I<boolean>
646 823
647B<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>.
648B<False>: no visual bell [default]; option B<+vb>. 825B<False>: no visual bell [default]; option B<+vb>.
649 826
663 840
664Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 841Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
665B<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
666B<Shift-Print> to include the scrollback as well. 843B<Shift-Print> to include the scrollback as well.
667 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
668=item B<scrollBar:> I<boolean> 854=item B<scrollBar:> I<boolean>
669 855
670B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 856B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
671disable the scrollbar; option B<+sb>. 857disable the scrollbar; option B<+sb>.
672 858
692B<+si>. 878B<+si>.
693 879
694=item B<scrollWithBuffer:> I<boolean> 880=item B<scrollWithBuffer:> I<boolean>
695 881
696B<True>: scroll with scrollback buffer when tty receives new lines (and 882B<True>: scroll with scrollback buffer when tty receives new lines (and
697B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 883B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
698with scrollback buffer when tty recieves new lines; option B<-sw>. 884with scrollback buffer when tty receives new lines; option B<+sw>.
699 885
700=item B<scrollTtyKeypress:> I<boolean> 886=item B<scrollTtyKeypress:> I<boolean>
701 887
702B<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
703are those which are intercepted by rxvt-unicode for special handling and 889are those which are intercepted by rxvt-unicode for special handling and
722=item B<borderLess:> I<boolean> 908=item B<borderLess:> I<boolean>
723 909
724Set 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
725WM, 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>.
726 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
727=item B<termName:> I<termname> 920=item B<termName:> I<termname>
728 921
729Specifies 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
730variable; option B<-tn>. 923variable; option B<-tn>.
731 924
732=item B<linespace:> I<number> 925=item B<lineSpace:> I<number>
733 926
734Specifies number of lines (pixel height) to insert between each row of 927Specifies number of lines (pixel height) to insert between each row of
735the display [default 0]; option B<-lsp>. 928the display [default 0]; option B<-lsp>.
736 929
737=item B<meta8:> I<boolean> 930=item B<meta8:> I<boolean>
768 961
769Mouse pointer background colour. 962Mouse pointer background colour.
770 963
771=item B<pointerBlankDelay:> I<number> 964=item B<pointerBlankDelay:> I<number>
772 965
773Specifies 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.
774 968
775=item B<backspacekey:> I<string> 969=item B<backspacekey:> I<string>
776 970
777The 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>
778or 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>
785pressed. If unset it will send the sequence traditionally associated 979pressed. If unset it will send the sequence traditionally associated
786with the B<Execute> key. 980with the B<Execute> key.
787 981
788=item B<cutchars:> I<string> 982=item B<cutchars:> I<string>
789 983
790The characters used as delimiters for double-click word selection. The 984The characters used as delimiters for double-click word selection
791built-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:
792 994
793B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 995B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
794 996
795=item B<preeditType:> I<style> 997=item B<preeditType:> I<style>
796 998
803=item B<imLocale:> I<name> 1005=item B<imLocale:> I<name>
804 1006
805The 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.
806C<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
807input extension to be able to input japanese characters while staying in 1009input extension to be able to input japanese characters while staying in
808another locale. option B<-imlocale>. 1010another locale; option B<-imlocale>.
809 1011
810=item B<imFont:> I<fontset> 1012=item B<imFont:> I<fontset>
811 1013
812Specify the font-set used for XIM styles C<OverTheSpot> or 1014Specify the font-set used for XIM styles C<OverTheSpot> or
813C<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
818 1020
819=item B<tripleclickwords:> I<boolean> 1021=item B<tripleclickwords:> I<boolean>
820 1022
821Change the meaning of triple-click selection with the left mouse 1023Change the meaning of triple-click selection with the left mouse
822button. 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
823the end of the logical line only. option B<-tcw>. 1025the end of the logical line only; option B<-tcw>.
824 1026
825=item B<insecure:> I<boolean> 1027=item B<insecure:> I<boolean>
826 1028
827Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1029Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
828echo 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
829abused if somebody gets 8-bit-clean access to your display, whether 1031abused if somebody gets 8-bit-clean access to your display, whether
830throuh a mail client displaying mail bodies unfiltered or though 1032through a mail client displaying mail bodies unfiltered or through
831write(1). Therefore, these sequences are disabled by default. (Note 1033write(1) or any other means. Therefore, these sequences are disabled by
832that other terminals, including xterm, have these sequences 1034default. (Note that many other terminals, including xterm, have these
833enabled by default). You can enable them by setting this boolean 1035sequences enabled by default, which doesn't make it safer, though).
834resource or specifying B<-insecure> as an option. At the moment, this 1036
835enabled display-answer, locale, findfont, icon label and window title 1037You can enable them by setting this boolean resource or specifying
836requests 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.
837 1040
838=item B<modifier:> I<modifier> 1041=item B<modifier:> I<modifier>
839 1042
840Set 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>,
841B<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
845 1048
846Specify 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)
847character is passed through. It may contain escape values as described 1050character is passed through. It may contain escape values as described
848in the entry on B<keysym> following. 1051in the entry on B<keysym> following.
849 1052
850=item B<secondaryScreen:> I<bool> 1053=item B<secondaryScreen:> I<boolean>
851 1054
852Turn on/off secondary screen (default enabled). 1055Turn on/off secondary screen (default enabled).
853 1056
854=item B<secondaryScroll:> I<bool> 1057=item B<secondaryScroll:> I<boolean>
855 1058
856Turn on/off secondary screen scroll (default enabled). If the this 1059Turn on/off secondary screen scroll (default enabled). If this
857option is enabled, scrolls on the secondary screen will change the 1060option is enabled, scrolls on the secondary screen will change the
858scrollback buffer and switching to/from the secondary screen will 1061scrollback buffer and switching to/from the secondary screen will
859instead 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.
860 1070
861=item B<keysym.>I<sym>: I<string> 1071=item B<keysym.>I<sym>: I<string>
862 1072
863Compile I<frills>: Associate I<string> with keysym I<sym>. The 1073Compile I<frills>: Associate I<string> with keysym I<sym>. The
864intervening resource name B<keysym.> cannot be omitted. 1074intervening resource name B<keysym.> cannot be omitted.
878searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1088searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
879omitting 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
880keysym 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
881performed in an exact manner; however, the closest match is assured. 1091performed in an exact manner; however, the closest match is assured.
882 1092
883I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1093I<string> may contain escape values (C<\n>: newline, C<\000>: octal
884C<\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.
885C<\000>: octal number) or verbatim control characters (C<^?>: delete,
886C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
887can start or end with whitespace.
888
889Please note that you need to double the C<\> when using
890C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
891use C<\033> instead of C<\e> (and so on), which will work with both Xt and
892@@RXVT_NAME@@'s own processing).
893 1095
894You 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>
895with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1097with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
896should be a character not used by the strings. 1098should be a character not used by the strings.
897 1099
898Its usage can be demonstrated by an example: 1100Its usage can be demonstrated by an example:
899 1101
900 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1102 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
910example 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>
911when Control-Meta-c is being pressed": 1113when Control-Meta-c is being pressed":
912 1114
913 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
914 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
915The 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
916the 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
917font-switching at runtime: 1145font-switching at runtime:
918 1146
919 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1147 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
922Other 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
923info): 1151info):
924 1152
925 URxvt.keysym.M-C-3: command:\033[8;25;80t 1153 URxvt.keysym.M-C-3: command:\033[8;25;80t
926 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).
927 1231
928=back 1232=back
929 1233
930=head1 THE SCROLLBAR 1234=head1 THE SCROLLBAR
931 1235
950application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1254application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
951(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1255(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
952up 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),
953respectively. 1257respectively.
954 1258
955=head1 TEXT SELECTION AND INSERTION 1259=head1 THE SELECTION: SELECTING AND PASTING TEXT
956 1260
957The behaviour of text selection and insertion mechanism is similar to 1261The behaviour of text selection and insertion/pasting mechanism is similar
958I<xterm>(1). 1262to I<xterm>(1).
959 1263
960=over 4 1264=over 4
961 1265
962=item B<Selection>: 1266=item B<Selecting>:
963 1267
964Left 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
965and release; Right click to extend the marked region; Left double-click 1269and release; Right click to extend the marked region; Left double-click
966to 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
967(which can span multiple screen lines), unless modified by resource 1271(which can span multiple screen lines), unless modified by resource
968B<tripleclickwords>. 1272B<tripleclickwords>.
969 1273
970Starting 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)
971(Compile: I<frills>) will create a rectangular selection instead of a normal 1275(Compile: I<frills>) will create a rectangular selection instead of a
972one. 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.
973 1279
974=item B<Insertion>: 1280=item B<Pasting>:
975 1281
976Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1282Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
977an B<@@RXVT_NAME@@> window causes the current text selection to be 1283window causes the value of the PRIMARY selection (or CLIPBOARD with the
978inserted 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.
979 1288
980=back 1289=back
981 1290
982=head1 CHANGING FONTS 1291=head1 CHANGING FONTS
983 1292
984Changing fonts (or font sizes, respectively) via the keypad is not yet 1293Changing fonts (or font sizes, respectively) via the keypad is not yet
985supported in rxvt-unicode. Bug me if you need this. 1294supported in rxvt-unicode. Bug me if you need this.
986 1295
987You can, however, switch fonts at runtime using escape sequences (and 1296You can, however, switch fonts at runtime using escape sequences, e.g.:
988therefore using the menubar), e.g.:
989 1297
990 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
991 1304
992rxvt-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.
993 1306
994=head1 ISO 14755 SUPPORT 1307=head1 ISO 14755 SUPPORT
995 1308
996ISO 14755 is a standard for entering and viewing unicode characters 1309ISO 14755 is a standard for entering and viewing unicode characters
997and character codes using the keyboard. It consists of 4 parts. The 1310and character codes using the keyboard. It consists of 4 parts. The
998first part is available rxvt-unicode has been compiled with 1311first part is available if rxvt-unicode has been compiled with
999C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1312C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1000with C<--enable-iso14755>. 1313with C<--enable-iso14755>.
1001 1314
1002=over 4 1315=over 4
1003 1316
1023This mode lets you input characters representing the keycap symbols of 1336This mode lets you input characters representing the keycap symbols of
1024your keyboard, if representable in the current locale encoding. 1337your keyboard, if representable in the current locale encoding.
1025 1338
1026Start by pressing C<Control> and C<Shift> together, then releasing 1339Start by pressing C<Control> and C<Shift> together, then releasing
1027them. 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
1028invoke it's usual function but instead will insert the corresponding 1341invoke its usual function but instead will insert the corresponding
1029keycap 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
1030released, otherwise pressing e.g. C<Shift> would enter the symbol for 1343released, otherwise pressing e.g. C<Shift> would enter the symbol for
1031C<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
1032reverse tab (Shift-Tab). 1345reverse tab (Shift-Tab).
1033 1346
1066=head1 COLORS AND GRAPHICS 1379=head1 COLORS AND GRAPHICS
1067 1380
1068In addition to the default foreground and background colours, 1381In addition to the default foreground and background colours,
1069B<@@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
1070high-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
1071colours with their B<rgb.txt> names. 1384colours with their names.
1072 1385
1073=begin table 1386=begin table
1074 1387
1075 B<color0> (black) = Black 1388 B<color0> (black) = Black
1076 B<color1> (red) = Red3 1389 B<color1> (red) = Red3
1096It is also possible to specify the colour values of B<foreground>, 1409It is also possible to specify the colour values of B<foreground>,
1097B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1410B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1098a 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
1099color0-color15. 1412color0-color15.
1100 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
1101Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1423Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1102always swapping the foreground/background colours. This is in contrast to 1424always swapping the foreground/background colours. This is in contrast to
1103I<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
1104been specified. For example, 1426been specified. For example,
1105 1427
1110would 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
1111on White. 1433on White.
1112 1434
1113=back 1435=back
1114 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
1115=head1 ENVIRONMENT 1461=head1 ENVIRONMENT
1116 1462
1117B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1463B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1118 1464
1119=over 4 1465=over 4
1120 1466
1121=item B<TERM> 1467=item B<TERM>
1122 1468
1123Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1469Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1124resources or on the commandline. 1470resources or on the command line.
1125 1471
1126=item B<COLORTERM> 1472=item B<COLORTERM>
1127 1473
1128Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1474Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1129compiled with XPM support, and optionally with the added extension 1475compiled with background image support, and optionally with the added
1130C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1476extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1477screen.
1131 1478
1132=item B<COLORFGBG> 1479=item B<COLORFGBG>
1133 1480
1134Set 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
1135the colour code used as default foreground/text colour (or the string 1482the colour code used as default foreground/text colour (or the string
1136C<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
1137used), 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
1138string 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@@
1139was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1486was compiled with background image support. Libraries like C<ncurses>
1140(and do) use this information to optimize screen output. 1487and C<slang> can (and do) use this information to optimize screen output.
1141 1488
1142=item B<WINDOWID> 1489=item B<WINDOWID>
1143 1490
1144Set 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
1145window, which usually has subwindows for the scrollbar, the terminal 1492window, which usually has subwindows for the scrollbar, the terminal
1151C<--with-terminfo=PATH>. 1498C<--with-terminfo=PATH>.
1152 1499
1153=item B<DISPLAY> 1500=item B<DISPLAY>
1154 1501
1155Used 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
1156display in it's child processes. 1503display in its child processes.
1157 1504
1158=item B<SHELL> 1505=item B<SHELL>
1159 1506
1160The 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>.
1161
1162=item B<RXVTPATH>
1163
1164The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1165files.
1166
1167=item B<PATH>
1168
1169Used in the same way as C<RXVTPATH>.
1170 1508
1171=item B<RXVT_SOCKET> 1509=item B<RXVT_SOCKET>
1172 1510
1173The unix domain socket path used by @@RXVT_NAME@@c(1) and 1511The unix domain socket path used by @@RXVT_NAME@@c(1) and
1174@@RXVT_NAME@@d(1). 1512@@RXVT_NAME@@d(1).
1175 1513
1176Default C<< $HOME/.rxvt-unicode-<nodename >>. 1514Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1177 1515
1178=item B<HOME> 1516=item B<HOME>
1179 1517
1180Used to locate the default directory for the unix domain socket for 1518Used to locate the default directory for the unix domain socket for
1181daemon communications and to locate various resource files (such as 1519daemon communications and to locate various resource files (such as
1202 1540
1203=back 1541=back
1204 1542
1205=head1 SEE ALSO 1543=head1 SEE ALSO
1206 1544
1207@@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)
1208
1209=head1 BUGS
1210
1211Check the BUGS file for an up-to-date list.
1212
1213Cursor change support is not yet implemented.
1214
1215Click-and-drag doesn't work with X11 mouse report overriding.
1216 1546
1217=head1 CURRENT PROJECT COORDINATOR 1547=head1 CURRENT PROJECT COORDINATOR
1218 1548
1219=over 4 1549=over 4
1220 1550
1221=item Project Coordinator 1551=item Project Coordinator
1222 1552
1223@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1553Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1224 1554
1225L<@@RXVT_WEBPAGE@@> 1555L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1226 1556
1227=back 1557=back
1228 1558
1229=head1 AUTHORS 1559=head1 AUTHORS
1230 1560
1252 1582
1253Project Coordinator (changes.txt 2.21a to 2.4.5) 1583Project Coordinator (changes.txt 2.21a to 2.4.5)
1254 1584
1255=item Geoff Wing L<< <gcw@pobox.com> >> 1585=item Geoff Wing L<< <gcw@pobox.com> >>
1256 1586
1257Rewrote screen display and text selection routines. Project Coordinator 1587Rewrote screen display and text selection routines.
1588
1258(changes.txt 2.4.6 - rxvt-unicode) 1589Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1259 1590
1260=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1591=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1261 1592
1262Forked rxvt-unicode, rewrote most of the display code and internal 1593Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1263character handling to store text in unicode, improve xterm 1594extension, random hacks, numerous bugfixes and extensions.
1264compatibility and apply numerous other bugfixes and extensions.
1265 1595
1266Project Coordinator (Changes 1.0 -) 1596Project Coordinator (Changes 1.0 -)
1267 1597
1598=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1599
1600Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1601
1268=back 1602=back
1269 1603

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines