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.60 by root, Thu Feb 17 15:13:47 2005 UTC vs.
Revision 1.139 by ayin, Wed Oct 17 13:53:42 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
387The window will not be destroyed when @@RXVT_NAME@@ exits. 462The window will not be destroyed when @@RXVT_NAME@@ exits.
388 463
389It 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
390descriptors 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
391can use file descriptors to communicate with the programs within the 466can use file descriptors to communicate with the programs within the
392terminal. 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
393not. 468not.
394 469
395Here is a short Gtk2-perl snippet that illustrates how this option can be 470Here is a short Gtk2-perl snippet that illustrates how this option can be
396used (a longer example is in F<doc/embed>): 471used (a longer example is in F<doc/embed>):
397 472
398 my $rxvt = new Gtk2::DrawingArea; 473 my $rxvt = new Gtk2::Socket;
399 $...->add ($rxvt); # important to add it somewhere first 474 $rxvt->signal_connect_after (realize => sub {
400 $rxvt->realize; # now it can be realized
401 my $xid = $rxvt->window->get_xid; 475 my $xid = $_[0]->window->get_xid;
402
403 system "@@RXVT_NAME@@ -embed $xid &"; 476 system "@@RXVT_NAME@@ -embed $xid &";
477 });
404 478
405=item B<-pty-fd> I<fileno> 479=item B<-pty-fd> I<file descriptor>
406 480
407Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 481Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
408pair but instead use the given filehandle as the tty master. This is 482pair but instead use the given file descriptor as the tty master. This is
409useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 483useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
410without having to run a program within it. 484without having to run a program within it.
411 485
412If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 486If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
413entries and will not tinker with pty/tty permissions - you have to do that 487entries and will not tinker with pty/tty permissions - you have to do that
414yourself if you want that. 488yourself if you want that.
489
490As an extremely special case, specifying C<-1> will completely suppress
491pty/tty operations.
415 492
416Here is a example in perl that illustrates how this option can be used (a 493Here is a example in perl that illustrates how this option can be used (a
417longer example is in F<doc/pty-fd>): 494longer example is in F<doc/pty-fd>):
418 495
419 use IO::Pty; 496 use IO::Pty;
426 503
427 # now communicate with rxvt 504 # now communicate with rxvt
428 my $slave = $pty->slave; 505 my $slave = $pty->slave;
429 while (<$slave>) { print $slave "got <$_>\n" } 506 while (<$slave>) { print $slave "got <$_>\n" }
430 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.
512
431=back 513=back
432 514
433=head1 RESOURCES (available also as long-options) 515=head1 RESOURCES (available also as long-options)
434 516
435Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 517Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
436options) compiled into your version. 518options) compiled into your version.
437 519
438There 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
439Xresource data: using the X libraries (Xrm*-functions) or internal 521distribution do also load settings from the B<~/.Xresources> file when X
440Xresources reader (B<~/.Xdefaults>). For the first method (ie. 522starts. @@RXVT_NAME@@ will consult the following files/resources in order,
441B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 523with later settings overwriting earlier ones:
442resources using X11 tools like B<xrdb>. Many distribution do also load
443settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
444will consult the following files/resources in order, with later settings
445overwriting earlier ones:
446 524
447 1. system-wide app-defaults file, either locale-dependent OR global 525 1. system-wide app-defaults file, either locale-dependent OR global
448 2. app-defaults file in $XAPPLRESDIR 526 2. app-defaults file in $XAPPLRESDIR
449 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 527 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
450 4. SCREEN_RESOURCES for the current screen 528 4. SCREEN_RESOURCES for the current screen
451 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 529 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
452 530
453If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
454lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
455set in XAPPLOADDIR/URxvt (compile-time defined: usually
456B</usr/lib/X11/app-defaults/URxvt>) and resources set in
457B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
458Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 531Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
459class 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
460resources 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
461easily configured, while the class name B<URxvt> allows resources 534configured, while the class name B<URxvt> allows resources unique to
462unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 535B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
463shared between different B<@@RXVT_NAME@@> configurations. If no 536configurations. If no resources are specified, suitable defaults will
464resources are specified, suitable defaults will be used. Command-line 537be used. Command-line arguments can be used to override resource
465arguments can be used to override resource settings. The following 538settings. The following resources are supported (you might want to
466resources are allowed: 539check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
540extensions not documented here):
467 541
468=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>.
469 548
470=item B<geometry:> I<geom> 549=item B<geometry:> I<geom>
471 550
472Create the window with the specified X window geometry [default 80x24]; 551Create the window with the specified X window geometry [default 80x24];
473option B<-geometry>. 552option B<-geometry>.
510Use the specified colour to display underlined characters when the 589Use the specified colour to display underlined characters when the
511foreground colour is the default. 590foreground colour is the default.
512 591
513=item B<colorRV:> I<colour> 592=item B<colorRV:> I<colour>
514 593
515Use the specified colour as the background for reverse video 594Use the specified colour as the background for reverse video characters
516characters. 595when OPTION_HC is disabled (--disable-frills).
517 596
518=item B<underlineColor:> I<colour> 597=item B<underlineColor:> I<colour>
519 598
520If set, use the specified colour as the colour for the underline 599If set, use the specified colour as the colour for the underline
521itself. If unset, use the foreground colour. 600itself. If unset, use the foreground colour.
537option B<-rv>. B<False>: regular screen colours [default]; option 616option B<-rv>. B<False>: regular screen colours [default]; option
538B<+rv>. See note in B<COLORS AND GRAPHICS> section. 617B<+rv>. See note in B<COLORS AND GRAPHICS> section.
539 618
540=item B<jumpScroll:> I<boolean> 619=item B<jumpScroll:> I<boolean>
541 620
542B<True>: specify that jump scrolling should be used. When scrolling 621B<True>: specify that jump scrolling should be used. When receiving lots
543quickly, 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
544B<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>.
545 640
546=item B<inheritPixmap:> I<boolean> 641=item B<inheritPixmap:> I<boolean>
547 642
548B<True>: make the background inherit the parent windows' pixmap, giving 643B<True>: make the background inherit the parent windows' pixmap, giving
549artificial transparency. B<False>: do not inherit the parent windows' 644artificial transparency. B<False>: do not inherit the parent windows'
550pixmap. 645pixmap.
551 646
647I<Please note that transparency of any kind if completely unsupported by
648the author. Don't bug him with installation questions!>
649
552=item B<fading:> I<number> 650=item B<fading:> I<number>
553 651
554Fade 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>.
555 658
556=item B<tintColor:> I<colour> 659=item B<tintColor:> I<colour>
557 660
558Tint the transparent background pixmap with the given colour. 661Tint the transparent background pixmap with the given colour; option
662B<-tint>.
559 663
560=item B<shading:> I<number> 664=item B<shading:> I<number>
561 665
562Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 666Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
563image 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>.
564 677
565=item B<scrollColor:> I<colour> 678=item B<scrollColor:> I<colour>
566 679
567Use the specified colour for the scrollbar [default #B2B2B2]. 680Use the specified colour for the scrollbar [default #B2B2B2].
568 681
569=item B<troughColor:> I<colour> 682=item B<troughColor:> I<colour>
570 683
571Use the specified colour for the scrollbar's trough area [default 684Use the specified colour for the scrollbar's trough area [default
572#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 685#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
573 686
574=item B<borderColor:> I<colour> 687=item B<borderColor:> I<colour>
575 688
576The 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
577and the text. 690and the text.
578 691
579=item B<backgroundPixmap:> I<file[;geom]> 692=item B<backgroundPixmap:> I<file[;geom]>
580 693
581Use the specified XPM file (note the `.xpm' extension is optional) for 694Use the specified image file for the background and also optionally
582the background and also optionally specify its scaling with a geometry 695specify its scaling with a geometry string B<WxH+X+Y>,
583string B<WxH+X+Y>, in which B<"W" / "H"> specify the 696in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
584horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 697and B<"X" / "Y"> locate the image centre (percent).
585centre (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
586of 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
587specifies an integer number of images in that direction. No image will 700number of images in that direction. No image will be magnified beyond
588be magnified beyond 10 times its original size. The maximum permitted 70110 times its original size. The maximum permitted scale is 1000.
589scale is 1000. [default 0x0+50+50] 702Special string of B<"auto"> used as a geometry will cause image to be
590 703automatically scaled to match window size.
591=item B<menu:> I<file[;tag]> 704If used in conjunction with B<-tr> option - specified pixmap will be
592 705blended over transparency image using either alpha-blending, or any
593Read in the specified menu file (note the `.menu' extension is 706other blending type, specified with B<-blt "type"> option.
594optional) and also optionally specify a starting tag to find. See the 707[default 0x0+50+50]
595reference documentation for details on the syntax for the menuBar.
596 708
597=item B<path:> I<path> 709=item B<path:> I<path>
598 710
599Specify the colon-delimited search path for finding files (XPM and 711Specify the colon-delimited search path for finding background image files.
600menus), in addition to the paths specified by the B<RXVTPATH> and
601B<PATH> environment variables.
602 712
603=item B<font:> I<fontlist> 713=item B<font:> I<fontlist>
604 714
605Select 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
606names that are used in turn when trying to display Unicode characters. 716that are checked in order when trying to find glyphs for characters. The
607The first font defines the cell size for characters; other fonts might 717first font defines the cell size for characters; other fonts might be
608be smaller, but not larger. A reasonable default font list is always 718smaller, but not (in general) larger. A (hopefully) reasonable default
609appended to it. option B<-fn>. 719font list is always appended to it; option B<-fn>.
610 720
611Each 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
612optional 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:>.
613 723
614In addition, each font can be prefixed with additional hints and 724In addition, each font can be prefixed with additional hints and
616hint 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
617fonts. 727fonts.
618 728
619For example, this font resource 729For example, this font resource
620 730
621 URxvt*font: 9x15bold,\ 731 URxvt.font: 9x15bold,\
622 -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,\
623 -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, \
624 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 734 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
625 xft:Code2000:antialias=false 735 xft:Code2000:antialias=false
626 736
660not possible, replacement fonts of the desired shape will be tried. 770not possible, replacement fonts of the desired shape will be tried.
661 771
662If 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
663text font will being used for the given style. 773text font will being used for the given style.
664 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
665=item B<selectstyle:> I<mode> 783=item B<selectstyle:> I<mode>
666 784
667Set 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
668xterm 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
669xterm style selection. 787gives xterm style selection. Only effective when the original (non-perl)
788selection code is in use.
670 789
671=item B<scrollstyle:> I<mode> 790=item B<scrollstyle:> I<mode>
672 791
673Set 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
674the author's favourite.. 793the author's favourite.
675 794
676=item B<title:> I<string> 795=item B<title:> I<string>
677 796
678Set window title string, the default title is the command-line 797Set window title string, the default title is the command-line
679specified after the B<-e> option, if any, otherwise the application 798specified after the B<-e> option, if any, otherwise the application
688=item B<mapAlert:> I<boolean> 807=item B<mapAlert:> I<boolean>
689 808
690B<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
691de-iconify (map) on receipt of a bell character [default]. 810de-iconify (map) on receipt of a bell character [default].
692 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
693=item B<visualBell:> I<boolean> 817=item B<visualBell:> I<boolean>
694 818
695B<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>.
696B<False>: no visual bell [default]; option B<+vb>. 820B<False>: no visual bell [default]; option B<+vb>.
697 821
711 835
712Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 836Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
713B<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
714B<Shift-Print> to include the scrollback as well. 838B<Shift-Print> to include the scrollback as well.
715 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
716=item B<scrollBar:> I<boolean> 849=item B<scrollBar:> I<boolean>
717 850
718B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 851B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
719disable the scrollbar; option B<+sb>. 852disable the scrollbar; option B<+sb>.
720 853
741 874
742=item B<scrollWithBuffer:> I<boolean> 875=item B<scrollWithBuffer:> I<boolean>
743 876
744B<True>: scroll with scrollback buffer when tty receives new lines (and 877B<True>: scroll with scrollback buffer when tty receives new lines (and
745B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 878B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
746with scrollback buffer when tty recieves new lines; option B<+sw>. 879with scrollback buffer when tty receives new lines; option B<+sw>.
747 880
748=item B<scrollTtyKeypress:> I<boolean> 881=item B<scrollTtyKeypress:> I<boolean>
749 882
750B<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
751are those which are intercepted by rxvt-unicode for special handling and 884are those which are intercepted by rxvt-unicode for special handling and
770=item B<borderLess:> I<boolean> 903=item B<borderLess:> I<boolean>
771 904
772Set 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
773WM, 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>.
774 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
775=item B<termName:> I<termname> 915=item B<termName:> I<termname>
776 916
777Specifies 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
778variable; option B<-tn>. 918variable; option B<-tn>.
779 919
780=item B<linespace:> I<number> 920=item B<lineSpace:> I<number>
781 921
782Specifies number of lines (pixel height) to insert between each row of 922Specifies number of lines (pixel height) to insert between each row of
783the display [default 0]; option B<-lsp>. 923the display [default 0]; option B<-lsp>.
784 924
785=item B<meta8:> I<boolean> 925=item B<meta8:> I<boolean>
816 956
817Mouse pointer background colour. 957Mouse pointer background colour.
818 958
819=item B<pointerBlankDelay:> I<number> 959=item B<pointerBlankDelay:> I<number>
820 960
821Specifies 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.
822 963
823=item B<backspacekey:> I<string> 964=item B<backspacekey:> I<string>
824 965
825The 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>
826or 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>
833pressed. If unset it will send the sequence traditionally associated 974pressed. If unset it will send the sequence traditionally associated
834with the B<Execute> key. 975with the B<Execute> key.
835 976
836=item B<cutchars:> I<string> 977=item B<cutchars:> I<string>
837 978
838The characters used as delimiters for double-click word selection. The 979The characters used as delimiters for double-click word selection
839built-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:
840 989
841B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 990B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
842 991
843=item B<preeditType:> I<style> 992=item B<preeditType:> I<style>
844 993
851=item B<imLocale:> I<name> 1000=item B<imLocale:> I<name>
852 1001
853The 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.
854C<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
855input extension to be able to input japanese characters while staying in 1004input extension to be able to input japanese characters while staying in
856another locale. option B<-imlocale>. 1005another locale; option B<-imlocale>.
857 1006
858=item B<imFont:> I<fontset> 1007=item B<imFont:> I<fontset>
859 1008
860Specify the font-set used for XIM styles C<OverTheSpot> or 1009Specify the font-set used for XIM styles C<OverTheSpot> or
861C<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
866 1015
867=item B<tripleclickwords:> I<boolean> 1016=item B<tripleclickwords:> I<boolean>
868 1017
869Change the meaning of triple-click selection with the left mouse 1018Change the meaning of triple-click selection with the left mouse
870button. 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
871the end of the logical line only. option B<-tcw>. 1020the end of the logical line only; option B<-tcw>.
872 1021
873=item B<insecure:> I<boolean> 1022=item B<insecure:> I<boolean>
874 1023
875Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1024Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
876echo 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
877abused if somebody gets 8-bit-clean access to your display, whether 1026abused if somebody gets 8-bit-clean access to your display, whether
878throuh a mail client displaying mail bodies unfiltered or though 1027through a mail client displaying mail bodies unfiltered or through
879write(1). Therefore, these sequences are disabled by default. (Note 1028write(1) or any other means. Therefore, these sequences are disabled by
880that other terminals, including xterm, have these sequences 1029default. (Note that many other terminals, including xterm, have these
881enabled by default). You can enable them by setting this boolean 1030sequences enabled by default, which doesn't make it safer, though).
882resource or specifying B<-insecure> as an option. At the moment, this 1031
883enabled display-answer, locale, findfont, icon label and window title 1032You can enable them by setting this boolean resource or specifying
884requests 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.
885 1035
886=item B<modifier:> I<modifier> 1036=item B<modifier:> I<modifier>
887 1037
888Set 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>,
889B<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
893 1043
894Specify 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)
895character is passed through. It may contain escape values as described 1045character is passed through. It may contain escape values as described
896in the entry on B<keysym> following. 1046in the entry on B<keysym> following.
897 1047
898=item B<secondaryScreen:> I<bool> 1048=item B<secondaryScreen:> I<boolean>
899 1049
900Turn on/off secondary screen (default enabled). 1050Turn on/off secondary screen (default enabled).
901 1051
902=item B<secondaryScroll:> I<bool> 1052=item B<secondaryScroll:> I<boolean>
903 1053
904Turn on/off secondary screen scroll (default enabled). If the this 1054Turn on/off secondary screen scroll (default enabled). If this
905option is enabled, scrolls on the secondary screen will change the 1055option is enabled, scrolls on the secondary screen will change the
906scrollback buffer and switching to/from the secondary screen will 1056scrollback buffer and switching to/from the secondary screen will
907instead 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.
908 1065
909=item B<keysym.>I<sym>: I<string> 1066=item B<keysym.>I<sym>: I<string>
910 1067
911Compile I<frills>: Associate I<string> with keysym I<sym>. The 1068Compile I<frills>: Associate I<string> with keysym I<sym>. The
912intervening resource name B<keysym.> cannot be omitted. 1069intervening resource name B<keysym.> cannot be omitted.
926searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1083searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
927omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1084omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
928keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1085keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
929performed in an exact manner; however, the closest match is assured. 1086performed in an exact manner; however, the closest match is assured.
930 1087
931I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1088I<string> may contain escape values (C<\n>: newline, C<\000>: octal
932C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1089number), see RESOURCES in C<man 7 X> for futher details.
933C<\000>: octal number) or verbatim control characters (C<^?>: delete,
934C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
935can start or end with whitespace.
936
937Please note that you need to double the C<\> when using
938C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
939use C<\033> instead of C<\e> (and so on), which will work with both Xt and
940@@RXVT_NAME@@'s own processing).
941 1090
942You can define a range of keysyms in one shot by providing a I<string> 1091You can define a range of keysyms in one shot by providing a I<string>
943with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1092with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
944should be a character not used by the strings. 1093should be a character not used by the strings.
945 1094
946Its usage can be demonstrated by an example: 1095Its usage can be demonstrated by an example:
947 1096
948 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1097 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
958example the following means "change the current locale to C<zh_CN.GBK> 1107example the following means "change the current locale to C<zh_CN.GBK>
959when Control-Meta-c is being pressed": 1108when Control-Meta-c is being pressed":
960 1109
961 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1110 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
962 1111
1112If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1113is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1114manpage. For example, the F<selection> extension (activated via
1115C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1116
1117 URxvt.keysym.M-C-c: perl:selection:rot13
1118
1119Due the the large number of modifier combinations, a defined key mapping
1120will match if at I<at least> the specified identifiers are being set, and
1121no other key mappings with those and more bits are being defined. That
1122means that defining a key map for C<a> will automatically provide
1123definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1124mappings themselves.
1125
1126Unfortunately, this will override built-in key mappings. For example
1127if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1128C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1129user-defined keymap using the C<builtin:> replacement:
1130
1131 URxvt.keysym.Insert: <my insert key sequence>
1132 URxvt.keysym.S-Insert: builtin:
1133
1134The first line defines a mapping for C<Insert> and I<any> combination
1135of modifiers. The second line re-establishes the default mapping for
1136C<Shift-Insert>.
1137
963The following example will map Control-Meta-1 and Control-Meta-2 to 1138The following example will map Control-Meta-1 and Control-Meta-2 to
964the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited 1139the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
965font-switching at runtime: 1140font-switching at runtime:
966 1141
967 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1142 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
970Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1145Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
971info): 1146info):
972 1147
973 URxvt.keysym.M-C-3: command:\033[8;25;80t 1148 URxvt.keysym.M-C-3: command:\033[8;25;80t
974 URxvt.keysym.M-C-4: command:\033[8;48;110t 1149 URxvt.keysym.M-C-4: command:\033[8;48;110t
1150
1151=item B<perl-ext-common>: I<string>
1152
1153=item B<perl-ext>: I<string>
1154
1155Comma-separated list(s) of perl extension scripts (default: C<default>) to
1156use in this terminal instance; option B<-pe>.
1157
1158Extension names can be prefixed with a C<-> sign to prohibit using
1159them. This can be useful to selectively disable some extensions loaded
1160by default, or specified via the C<perl-ext-common> resource. For
1161example, C<default,-selection> will use all the default extension except
1162C<selection>.
1163
1164Extension names can also be followed by an argument in angle brackets
1165(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1166searchable scrollback to Alt/Meta-s). Mentioning the same extension
1167multiple times with different arguments will pass multiple arguments to
1168the extension.
1169
1170Each extension is looked up in the library directories, loaded if
1171necessary, and bound to the current terminal instance.
1172
1173If both of these resources are the empty string, then the perl
1174interpreter will not be initialized. The idea behind two options is that
1175B<perl-ext-common> will be used for extensions that should be available to
1176all instances, while B<perl-ext> is used for specific instances.
1177
1178=item B<perl-eval>: I<string>
1179
1180Perl code to be evaluated when all extensions have been registered. See
1181the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1182will be ignored when running setuid/setgid.
1183
1184=item B<perl-lib>: I<path>
1185
1186Colon-separated list of additional directories that hold extension
1187scripts. When looking for extensions specified by the C<perl> resource,
1188@@RXVT_NAME@@ will first look in these directories and then in
1189F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1190will be ignored when running setuid/setgid.
1191
1192See the @@RXVT_NAME@@perl(3) manpage.
1193
1194=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1195
1196Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1197details.
1198
1199=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1200
1201Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1202for details.
1203
1204=item B<searchable-scrollback:> I<keysym>
1205
1206Sets the hotkey that starts the incremental scrollback buffer search
1207(default: C<M-s>).
1208
1209=item B<urlLauncher>: I<string>
1210
1211Specifies the program to be started with a URL argument. Used by the
1212C<selection-popup> and C<matcher> perl extensions.
1213
1214=item B<transient-for>: I<windowid>
1215
1216Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1217
1218=item B<override-redirect>: I<boolean>
1219
1220Compile I<frills>: Sets override-redirect for the terminal window, making
1221it almost invisible to window managers; option B<-override-redirect>.
1222
1223=item B<iso14755_52:> I<boolean>
1224
1225Turn on/off ISO 14755 5.2 mode (default enabled).
975 1226
976=back 1227=back
977 1228
978=head1 THE SCROLLBAR 1229=head1 THE SCROLLBAR
979 1230
998application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1249application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
999(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1250(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1000up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1251up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1001respectively. 1252respectively.
1002 1253
1003=head1 TEXT SELECTION AND INSERTION 1254=head1 THE SELECTION: SELECTING AND PASTING TEXT
1004 1255
1005The behaviour of text selection and insertion mechanism is similar to 1256The behaviour of text selection and insertion/pasting mechanism is similar
1006I<xterm>(1). 1257to I<xterm>(1).
1007 1258
1008=over 4 1259=over 4
1009 1260
1010=item B<Selection>: 1261=item B<Selecting>:
1011 1262
1012Left click at the beginning of the region, drag to the end of the region 1263Left click at the beginning of the region, drag to the end of the region
1013and release; Right click to extend the marked region; Left double-click 1264and release; Right click to extend the marked region; Left double-click
1014to select a word; Left triple-click to select the entire logical line 1265to select a word; Left triple-click to select the entire logical line
1015(which can span multiple screen lines), unless modified by resource 1266(which can span multiple screen lines), unless modified by resource
1016B<tripleclickwords>. 1267B<tripleclickwords>.
1017 1268
1018Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1269Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1019(Compile: I<frills>) will create a rectangular selection instead of a normal 1270(Compile: I<frills>) will create a rectangular selection instead of a
1020one. 1271normal one. In this mode, every selected row becomes its own line in the
1272selection, and trailing whitespace is visually underlined and removed from
1273the selection.
1021 1274
1022=item B<Insertion>: 1275=item B<Pasting>:
1023 1276
1024Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1277Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1025an B<@@RXVT_NAME@@> window causes the current text selection to be 1278window causes the value of the PRIMARY selection (or CLIPBOARD with the
1026inserted as if it had been typed on the keyboard. 1279B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1280
1281Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1282inserted too.
1027 1283
1028=back 1284=back
1029 1285
1030=head1 CHANGING FONTS 1286=head1 CHANGING FONTS
1031 1287
1032Changing fonts (or font sizes, respectively) via the keypad is not yet 1288Changing fonts (or font sizes, respectively) via the keypad is not yet
1033supported in rxvt-unicode. Bug me if you need this. 1289supported in rxvt-unicode. Bug me if you need this.
1034 1290
1035You can, however, switch fonts at runtime using escape sequences (and 1291You can, however, switch fonts at runtime using escape sequences, e.g.:
1036therefore using the menubar), e.g.:
1037 1292
1038 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1293 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1294
1295You can use keyboard shortcuts, too:
1296
1297 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1298 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1039 1299
1040rxvt-unicode will automatically re-apply these fonts to the output so far. 1300rxvt-unicode will automatically re-apply these fonts to the output so far.
1041 1301
1042=head1 ISO 14755 SUPPORT 1302=head1 ISO 14755 SUPPORT
1043 1303
1044ISO 14755 is a standard for entering and viewing unicode characters 1304ISO 14755 is a standard for entering and viewing unicode characters
1045and character codes using the keyboard. It consists of 4 parts. The 1305and character codes using the keyboard. It consists of 4 parts. The
1046first part is available rxvt-unicode has been compiled with 1306first part is available if rxvt-unicode has been compiled with
1047C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1307C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1048with C<--enable-iso14755>. 1308with C<--enable-iso14755>.
1049 1309
1050=over 4 1310=over 4
1051 1311
1071This mode lets you input characters representing the keycap symbols of 1331This mode lets you input characters representing the keycap symbols of
1072your keyboard, if representable in the current locale encoding. 1332your keyboard, if representable in the current locale encoding.
1073 1333
1074Start by pressing C<Control> and C<Shift> together, then releasing 1334Start by pressing C<Control> and C<Shift> together, then releasing
1075them. The next special key (cursor keys, home etc.) you enter will not 1335them. The next special key (cursor keys, home etc.) you enter will not
1076invoke it's usual function but instead will insert the corresponding 1336invoke its usual function but instead will insert the corresponding
1077keycap symbol. The symbol will only be entered when the key has been 1337keycap symbol. The symbol will only be entered when the key has been
1078released, otherwise pressing e.g. C<Shift> would enter the symbol for 1338released, otherwise pressing e.g. C<Shift> would enter the symbol for
1079C<ISO Level 2 Switch>, although your intention might have been to enter a 1339C<ISO Level 2 Switch>, although your intention might have been to enter a
1080reverse tab (Shift-Tab). 1340reverse tab (Shift-Tab).
1081 1341
1114=head1 COLORS AND GRAPHICS 1374=head1 COLORS AND GRAPHICS
1115 1375
1116In addition to the default foreground and background colours, 1376In addition to the default foreground and background colours,
1117B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1377B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1118high-intensity bold/blink versions of the same). Here is a list of the 1378high-intensity bold/blink versions of the same). Here is a list of the
1119colours with their B<rgb.txt> names. 1379colours with their names.
1120 1380
1121=begin table 1381=begin table
1122 1382
1123 B<color0> (black) = Black 1383 B<color0> (black) = Black
1124 B<color1> (red) = Red3 1384 B<color1> (red) = Red3
1144It is also possible to specify the colour values of B<foreground>, 1404It is also possible to specify the colour values of B<foreground>,
1145B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1405B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1146a number 0-15, as a convenient shorthand to reference the colour name of 1406a number 0-15, as a convenient shorthand to reference the colour name of
1147color0-color15. 1407color0-color15.
1148 1408
1409In addition to the colours defined above, @@RXVT_NAME@@ offers an
1410additional 72 colours. The first 64 of those (with indices 16 to 79)
1411consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
141216>), followed by 8 additional shades of gray (with indices 80 to 87).
1413
1414Together, all those colours implement the 88 colour xterm colours. Only
1415the first 16 can be changed using resources currently, the rest can only
1416be changed via command sequences ("escape codes").
1417
1149Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1418Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1150always swapping the foreground/background colours. This is in contrast to 1419always swapping the foreground/background colours. This is in contrast to
1151I<xterm>(1) where the colours are only swapped if they have not otherwise 1420I<xterm>(1) where the colours are only swapped if they have not otherwise
1152been specified. For example, 1421been specified. For example,
1153 1422
1158would yield White on Black, while on I<xterm>(1) it would yield Black 1427would yield White on Black, while on I<xterm>(1) it would yield Black
1159on White. 1428on White.
1160 1429
1161=back 1430=back
1162 1431
1432=head2 ALPHA CHANNEL SUPPORT
1433
1434If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1435their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1436(recommended, but B<MUST> have 4 digits/component) colour specifications,
1437in addition to the ones provided by X, where the additional A component
1438specifies opacity (alpha) values. The minimum value of C<0> is completely
1439transparent). You can also prefix any color with C<[percent]>, where
1440C<percent> is a decimal percentage (0-100) that specifies the opacity of
1441the color, where C<0> is completely transparent and C<100> is completelxy
1442opaque.
1443
1444You probably need to specify B<"-depth 32">, too, and have the luck that
1445your X-server uses ARGB pixel layout, as X is far from just supporting
1446ARGB visuals out of the box, and rxvt-unicode just fudges around.
1447
1448For example, the following selects an almost completely transparent red
1449background, and an almost opaque pink foreground:
1450
1451 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1452
1453I<Please note that transparency of any kind if completely unsupported by
1454the author. Don't bug him with installation questions!>
1455
1163=head1 ENVIRONMENT 1456=head1 ENVIRONMENT
1164 1457
1165B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1458B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1166 1459
1167=over 4 1460=over 4
1168 1461
1169=item B<TERM> 1462=item B<TERM>
1170 1463
1171Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1464Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1172resources or on the commandline. 1465resources or on the command line.
1173 1466
1174=item B<COLORTERM> 1467=item B<COLORTERM>
1175 1468
1176Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1469Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1177compiled with XPM support, and optionally with the added extension 1470compiled with background image support, and optionally with the added
1178C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1471extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1472screen.
1179 1473
1180=item B<COLORFGBG> 1474=item B<COLORFGBG>
1181 1475
1182Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1476Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1183the colour code used as default foreground/text colour (or the string 1477the colour code used as default foreground/text colour (or the string
1184C<default> to indicate that the default-colour escape sequence is to be 1478C<default> to indicate that the default-colour escape sequence is to be
1185used), C<bg> is the colour code used as default background colour (or the 1479used), C<bg> is the colour code used as default background colour (or the
1186string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1480string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1187was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1481was compiled with background image support. Libraries like C<ncurses>
1188(and do) use this information to optimize screen output. 1482and C<slang> can (and do) use this information to optimize screen output.
1189 1483
1190=item B<WINDOWID> 1484=item B<WINDOWID>
1191 1485
1192Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1486Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1193window, which usually has subwindows for the scrollbar, the terminal 1487window, which usually has subwindows for the scrollbar, the terminal
1199C<--with-terminfo=PATH>. 1493C<--with-terminfo=PATH>.
1200 1494
1201=item B<DISPLAY> 1495=item B<DISPLAY>
1202 1496
1203Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1497Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1204display in it's child processes. 1498display in its child processes.
1205 1499
1206=item B<SHELL> 1500=item B<SHELL>
1207 1501
1208The shell to be used for command execution, defaults to C</bin/sh>. 1502The shell to be used for command execution, defaults to C</bin/sh>.
1209
1210=item B<RXVTPATH>
1211
1212The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1213files.
1214
1215=item B<PATH>
1216
1217Used in the same way as C<RXVTPATH>.
1218 1503
1219=item B<RXVT_SOCKET> 1504=item B<RXVT_SOCKET>
1220 1505
1221The unix domain socket path used by @@RXVT_NAME@@c(1) and 1506The unix domain socket path used by @@RXVT_NAME@@c(1) and
1222@@RXVT_NAME@@d(1). 1507@@RXVT_NAME@@d(1).
1223 1508
1224Default C<< $HOME/.rxvt-unicode-<nodename >>. 1509Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1225 1510
1226=item B<HOME> 1511=item B<HOME>
1227 1512
1228Used to locate the default directory for the unix domain socket for 1513Used to locate the default directory for the unix domain socket for
1229daemon communications and to locate various resource files (such as 1514daemon communications and to locate various resource files (such as
1250 1535
1251=back 1536=back
1252 1537
1253=head1 SEE ALSO 1538=head1 SEE ALSO
1254 1539
1255@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1540@@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)
1256
1257=head1 BUGS
1258
1259Check the BUGS file for an up-to-date list.
1260
1261Cursor change support is not yet implemented.
1262
1263Click-and-drag doesn't work with X11 mouse report overriding.
1264 1541
1265=head1 CURRENT PROJECT COORDINATOR 1542=head1 CURRENT PROJECT COORDINATOR
1266 1543
1267=over 4 1544=over 4
1268 1545
1269=item Project Coordinator 1546=item Project Coordinator
1270 1547
1271Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1548Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1272 1549
1273L<http://software.schmorp.de/#rxvt-unicode> 1550L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1274 1551
1275=back 1552=back
1276 1553
1277=head1 AUTHORS 1554=head1 AUTHORS
1278 1555
1300 1577
1301Project Coordinator (changes.txt 2.21a to 2.4.5) 1578Project Coordinator (changes.txt 2.21a to 2.4.5)
1302 1579
1303=item Geoff Wing L<< <gcw@pobox.com> >> 1580=item Geoff Wing L<< <gcw@pobox.com> >>
1304 1581
1305Rewrote screen display and text selection routines. Project Coordinator 1582Rewrote screen display and text selection routines.
1583
1306(changes.txt 2.4.6 - rxvt-unicode) 1584Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1307 1585
1308=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1586=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1309 1587
1310Forked rxvt-unicode, rewrote most of the display code and internal 1588Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1311character handling to store text in unicode, improve xterm 1589extension, random hacks, numerous bugfixes and extensions.
1312compatibility and apply numerous other bugfixes and extensions.
1313 1590
1314Project Coordinator (Changes 1.0 -) 1591Project Coordinator (Changes 1.0 -)
1315 1592
1593=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1594
1595Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1596
1316=back 1597=back
1317 1598

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines