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.57 by root, Mon Feb 14 18:50:57 2005 UTC vs.
Revision 1.154 by ayin, Fri Dec 14 09:06:36 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines