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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines