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.2 by root, Thu Aug 12 21:30:14 2004 UTC vs.
Revision 1.114 by root, Thu Jul 6 19:43:21 2006 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines