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.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.119 by root, Mon Aug 7 16:04:29 2006 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines