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.69 by root, Tue Oct 25 19:04:45 2005 UTC vs.
Revision 1.151 by root, Wed Dec 12 19:55:55 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines