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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines