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.43 by root, Sun Jan 16 19:22:16 2005 UTC vs.
Revision 1.133 by ayin, Sat Jul 28 20:15:18 2007 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines