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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines