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.141 by sasha, Mon Oct 29 13:40:41 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines