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.236 by sf-exg, Sat Aug 16 10:51:23 2014 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
17This document is also available on the World-Wide-Web at
18L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
19
20=head1 FREQUENTLY ASKED QUESTIONS
21
22See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
23frequently asked questions and answer to them and some common
24problems. That document is also accessible on the World-Wide-Web at
25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
26
27=head1 RXVT-UNICODE VS. RXVT
28
29Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
30internally. That means it can store and display most scripts in the
31world. Being a terminal emulator, however, some things are very difficult,
32especially cursive scripts such as arabic, vertically written scripts
33like mongolian or scripts requiring extremely complex combining rules,
34like tibetan or devanagari. Don't expect pretty output when using these
35scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
36fine, though. A somewhat difficult case are right-to-left scripts, such
37as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
38belong in the application, not the terminal emulator (too many things --
39such as cursor-movement while editing -- break otherwise), but that might
40change.
41
42If you are looking for a terminal that supports more exotic scripts, let
43me recommend C<mlterm>, which is a very user friendly, lean and clean
44terminal emulator. In fact, the reason rxvt-unicode was born was solely
45because the author couldn't get C<mlterm> to use one font for latin1 and
46another for japanese.
47
48Therefore another design rationale was the use of multiple fonts to
49display characters: The idea of a single unicode font which many other
50programs force onto its users never made sense to me: You should be able
51to choose any font for any script freely.
52
53Apart from that, rxvt-unicode is also much better internationalised than
54its predecessor, supports things such as XFT and ISO 14755 that are handy
55in i18n-environments, is faster, and has a lot bugs less than the original
56rxvt. This all in addition to dozens of other small improvements.
57
58It is still faithfully following the original rxvt idea of being lean
59and nice on resources: for example, you can still configure rxvt-unicode
60without most of its features to get a lean binary. It also comes with
61a client/daemon pair that lets you open any number of terminal windows
62from within a single process, which makes startup time very fast and
63drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
64@@RXVT_NAME@@c(1) (client).
65
66It also makes technical information about escape sequences (which have
67been extended) more accessible: see @@RXVT_NAME@@(7) for technical
68reference documentation (escape sequences etc.).
69
17=head1 OPTIONS 70=head1 OPTIONS
18 71
19The B<@@RXVTNAME@@> options (mostly a subset of I<xterm>'s) are listed 72The 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 73below. In keeping with the smaller-is-better philosophy, options may be
21eliminated or default values chosen at compile-time, so options and 74eliminated or default values chosen at compile-time, so options and
22defaults listed may not accurately reflect the version installed on 75defaults listed may not accurately reflect the version installed on
23your system. `rxvt -h' gives a list of major compile-time options on 76your system. `@@RXVT_NAME@@ -h' gives a list of major compile-time options on
24the I<Options> line. Option descriptions may be prefixed with which 77the I<Options> line. Option descriptions may be prefixed with which
25compile option each is dependent upon. e.g. `Compile I<XIM>:' requires 78compile 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 79I<XIM> on the I<Options> line. Note: `@@RXVT_NAME@@ -help' gives a list of all
27command-line options compiled into your version. 80command-line options compiled into your version.
28 81
29Note that B<@@RXVTNAME@@> permits the resource name to be used as a 82Note that B<@@RXVT_NAME@@> permits the resource name to be used as a
30long-option (--/++ option) so the potential command-line options are 83long-option (--/++ option) so the potential command-line options are
31far greater than those listed. For example: `rxvt --loginShell --color1 84far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1
32Orange'. 85Orange'.
33 86
34The following options are available: 87The following options are available:
35 88
36=over 4 89=over 4
39 92
40Print out a message describing available options. 93Print out a message describing available options.
41 94
42=item B<-display> I<displayname> 95=item B<-display> I<displayname>
43 96
44Attempt to open a window on the named X display (B<-d> still 97Attempt to open a window on the named X display (the older form B<-d>
45respected). In the absence of this option, the display specified by the 98is still respected. but deprecated). In the absence of this option, the
46B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
100
101=item B<-depth> I<bitdepth>
102
103Compile I<frills>: Attempt to find a visual with the given bit depth;
104resource B<depth>.
105
106[Please note that many X servers (and libXft) are buggy with
107respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out]
110
111=item B<-visual> I<visualID>
112
113Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible
114visual ids).
47 115
48=item B<-geometry> I<geom> 116=item B<-geometry> I<geom>
49 117
50Window geometry (B<-g> still respected); resource B<geometry>. 118Window geometry (B<-g> still respected); resource B<geometry>.
51 119
53 121
54Turn on/off simulated reverse video; resource B<reverseVideo>. 122Turn on/off simulated reverse video; resource B<reverseVideo>.
55 123
56=item B<-j>|B<+j> 124=item B<-j>|B<+j>
57 125
58Turn on/off jump scrolling; resource B<jumpScroll>. 126Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
59 127
60=item B<-ip>|B<+ip> 128=item B<-ss>|B<+ss>
61 129
62Turn on/off inheriting parent window's pixmap. Alternative form is 130Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
63B<-tr>; resource B<inheritPixmap>.
64 131
65=item B<-fade> I<number> 132=item B<-fade> I<number>
66 133
67Fade the text by the given percentage when focus is lost. 134Fade the text by the given percentage when focus is lost. Small values
135fade a little only, 100 completely replaces all colours by the fade
136colour; resource B<fading>.
68 137
69=item B<-tint> I<colour> 138=item B<-fadecolor> I<colour>
70 139
71Tint the transparent background pixmap with the given colour when 140Fade to this colour when fading is used (see B<-fade>). The default colour
72transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> 141is opaque black. resource B<fadeColor>.
73option that can be used to brighten or darken the image in addition to
74tinting it.
75 142
76=item B<-sh> 143=item B<-icon> I<file>
77 144
78I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 145Compile I<pixbuf>: Use the specified image as application icon. This
79background image in addition to tinting it (i.e. B<-tint> must be 146is used by many window managers, taskbars and pagers to represent the
80specified, too). 147application window; resource I<iconFile>.
81 148
82=item B<-bg> I<colour> 149=item B<-bg> I<colour>
83 150
84Window background colour; resource B<background>. 151Window background colour; resource B<background>.
85 152
86=item B<-fg> I<colour> 153=item B<-fg> I<colour>
87 154
88Window foreground colour; resource B<foreground>. 155Window foreground colour; resource B<foreground>.
89 156
90=item B<-pixmap> I<file[;geom]>
91
92Compile I<XPM>: Specify XPM file for the background and also optionally
93specify its scaling with a geometry string. Note you may need to add
94quotes to avoid special shell interpretation of the `;' in the
95command-line; resource B<backgroundPixmap>.
96
97=item B<-cr> I<colour> 157=item B<-cr> I<colour>
98 158
99The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
100 160
101=item B<-pr> I<colour> 161=item B<-pr> I<colour>
106 166
107The mouse pointer background colour; resource B<pointerColor2>. 167The mouse pointer background colour; resource B<pointerColor2>.
108 168
109=item B<-bd> I<colour> 169=item B<-bd> I<colour>
110 170
111The colour of the border between the xterm scrollbar and the text; 171The colour of the border around the text area and between the scrollbar and the text;
112resource B<borderColor>. 172resource B<borderColor>.
113 173
114=item B<-fn> I<fontname> 174=item B<-fn> I<fontlist>
115 175
116Select the fonts to be used. This is a comma seperated list of font 176Select 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. 177that are checked in order when trying to find glyphs for characters. The
118The first font defines the cell size for characters; other fonts might 178first font defines the cell size for characters; other fonts might be
119be smaller, but not larger. A reasonable default font list is always 179smaller, but not (in general) larger. A (hopefully) reasonable default
120appended to it. resource B<font>. 180font list is always appended to it. See resource B<font> for more details.
121 181
182In short, to specify an X11 core font, just specify its name or prefix it
183with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.:
185
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
188
189See also the question "How does rxvt-unicode choose fonts?" in the FAQ
190section of @@RXVT_NAME@@(7).
191
192=item B<-fb> I<fontlist>
193
194Compile I<font-styles>: The bold font list to use when B<bold> characters
195are to be printed. See resource B<boldFont> for details.
196
197=item B<-fi> I<fontlist>
198
199Compile I<font-styles>: The italic font list to use when I<italic>
200characters are to be printed. See resource B<italicFont> for details.
201
202=item B<-fbi> I<fontlist>
203
204Compile I<font-styles>: The bold italic font list to use when B<< I<bold
205italic> >> characters are to be printed. See resource B<boldItalicFont>
206for details.
207
122=item B<-rb>|B<+rb> 208=item B<-is>|B<+is>
123 209
124Enable "real bold" support. When this option is on, bold text will be 210Compile I<font-styles>: Bold/Blink font styles imply high intensity
125displayed using the first available bold font in the font list. Bold 211foreground/background (default). See resource B<intensityStyles> for
126fonts should thus be specified in the font list after their 212details.
127corresponding regular fonts. If no bold font can be found, a regular
128font will be used. resource B<realBold>.
129 213
130=item B<-name> I<name> 214=item B<-name> I<name>
131 215
132Specify the application name under which resources are to be obtained, 216Specify the application name under which resources are to be obtained,
133rather than the default executable file name. Name should not contain 217rather than the default executable file name. Name should not contain
135 219
136=item B<-ls>|B<+ls> 220=item B<-ls>|B<+ls>
137 221
138Start as a login-shell/sub-shell; resource B<loginShell>. 222Start as a login-shell/sub-shell; resource B<loginShell>.
139 223
224=item B<-mc> I<milliseconds>
225
226Specify the maximum time between multi-click selections.
227
140=item B<-ut>|B<+ut> 228=item B<-ut>|B<+ut>
141 229
142Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 230Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
143B<utmpInhibit>. 231B<utmpInhibit>.
144 232
148B<visualBell>. 236B<visualBell>.
149 237
150=item B<-sb>|B<+sb> 238=item B<-sb>|B<+sb>
151 239
152Turn on/off scrollbar; resource B<scrollBar>. 240Turn on/off scrollbar; resource B<scrollBar>.
241
242=item B<-sr>|B<+sr>
243
244Put scrollbar on right/left; resource B<scrollBar_right>.
245
246=item B<-st>|B<+st>
247
248Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
249resource B<scrollBar_floating>.
153 250
154=item B<-si>|B<+si> 251=item B<-si>|B<+si>
155 252
156Turn on/off scroll-to-bottom on TTY output inhibit; resource 253Turn on/off scroll-to-bottom on TTY output inhibit; resource
157B<scrollTtyOutput> has opposite effect. 254B<scrollTtyOutput> has opposite effect.
165 262
166Turn on/off scrolling with the scrollback buffer as new lines appear. 263Turn on/off scrolling with the scrollback buffer as new lines appear.
167This only takes effect if B<-si> is also given; resource 264This only takes effect if B<-si> is also given; resource
168B<scrollWithBuffer>. 265B<scrollWithBuffer>.
169 266
170=item B<-sr>|B<+sr>
171
172Put scrollbar on right/left; resource B<scrollBar_right>.
173
174=item B<-st>|B<+st> 267=item B<-ptab>|B<+ptab>
175 268
176Display normal (non XTerm/NeXT) scrollbar without/with a trough; 269If enabled (default), "Horizontal Tab" characters are being stored as
177resource B<scrollBar_floating>. 270actual wide characters in the screen buffer, which makes it possible to
271select and paste them. Since a horizontal tab is a cursor movement and
272not an actual glyph, this can sometimes be visually annoying as the cursor
273on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
178 274
179=item B<-bc>|B<+bc> 275=item B<-bc>|B<+bc>
180 276
181Blink the cursor; resource B<cursorBlink>. 277Blink the cursor; resource B<cursorBlink>.
278
279=item B<-uc>|B<+uc>
280
281Make the cursor underlined; resource B<cursorUnderline>.
182 282
183=item B<-iconic> 283=item B<-iconic>
184 284
185Start iconified, if the window manager supports that option. 285Start iconified, if the window manager supports that option.
186Alternative form is B<-ic>. 286Alternative form is B<-ic>.
202B<externalBorder>. 302B<externalBorder>.
203 303
204=item B<-bl> 304=item B<-bl>
205 305
206Compile I<frills>: Set MWM hints to request a borderless window, i.e. 306Compile I<frills>: Set MWM hints to request a borderless window, i.e.
207if honoured by the WM, the rxvt window will not have window 307if honoured by the WM, the rxvt-unicode window will not have window
208decorations; resource B<borderLess>. 308decorations; resource B<borderLess>. If the window manager does not
309support MWM hints (e.g. kwin), enables override-redirect mode.
310
311=item B<-override-redirect>
312
313Compile I<frills>: Sets override-redirect on the window; resource
314B<override-redirect>.
315
316=item B<-dockapp>
317
318Sets the initial state of the window to WithdrawnState, which makes
319window managers that support this extension treat it as a dockapp.
320
321=item B<-sbg>
322
323Compile I<frills>: Disable the usage of the built-in block graphics/line
324drawing characters and just rely on what the specified fonts provide. Use
325this if you have a good font and want to use its block graphic glyphs;
326resource B<skipBuiltinGlyphs>.
209 327
210=item B<-lsp> I<number> 328=item B<-lsp> I<number>
211 329
212Compile I<linespace>: Lines (pixel height) to insert between each row 330Compile I<frills>: Lines (pixel height) to insert between each row of
213of the display; resource B<linespace>. 331the display. Useful to work around font rendering problems; resource
332B<lineSpace>.
333
334=item B<-letsp> I<number>
335
336Compile I<frills>: Amount to adjust the computed character width by
337to control overall letter spacing. Negative values will tighten up the
338letter spacing, positive values will space letters out more. Useful to
339work around odd font metrics; resource B<letterSpace>.
214 340
215=item B<-tn> I<termname> 341=item B<-tn> I<termname>
216 342
217This option specifies the name of the terminal type to be set in the 343This option specifies the name of the terminal type to be set in the
218B<TERM> environment variable. This terminal type must exist in the 344B<TERM> environment variable. This terminal type must exist in the
219I<termcap(5)> database and should have I<li#> and I<co#> entries; 345I<termcap(5)> database and should have I<li#> and I<co#> entries;
220resource B<termName>. 346resource B<termName>.
221 347
222=item B<-e> I<command [arguments]> 348=item B<-e> I<command [arguments]>
223 349
224Run the command with its command-line arguments in the B<@@RXVTNAME@@> 350Run 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 351window; 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 352the 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 353given 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 354on 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, 355run the program specified by the B<SHELL> environment variable or,
230failing that, I<sh(1)>. 356failing that, I<sh(1)>.
231 357
358Please note that you must specify a program with arguments. If you want to
359run shell commands, you have to specify the shell, like this:
360
361 @@RXVT_NAME@@ -e sh -c "shell commands"
362
232=item B<-title> I<text> 363=item B<-title> I<text>
233 364
234Window title (B<-T> still respected); the default title is the basename 365Window title (B<-T> still respected); the default title is the basename
235of the program specified after the B<-e> option, if any, otherwise the 366of the program specified after the B<-e> option, if any, otherwise the
236application name; resource B<title>. 367application name; resource B<title>.
254 385
255Compile I<XIM>: input method name. resource B<inputMethod>. 386Compile I<XIM>: input method name. resource B<inputMethod>.
256 387
257=item B<-imlocale> I<string> 388=item B<-imlocale> I<string>
258 389
259The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 390The 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 391C<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 392input extension to be able to input japanese characters while staying in
262another locale. 393another locale. resource B<imLocale>.
394
395=item B<-imfont> I<fontset>
396
397Set the font set to use for the X Input Method, see resource B<imFont>
398for more info.
399
400=item B<-tcw>
401
402Change the meaning of triple-click selection with the left mouse
403button. Only effective when the original (non-perl) selection code is
404in-use. Instead of selecting a full line it will extend the selection to
405the end of the logical line only. resource B<tripleclickwords>.
263 406
264=item B<-insecure> 407=item B<-insecure>
265 408
266Enable "insecure" mode, which currently enables most of the escape 409Enable "insecure" mode, which currently enables most of the escape
267sequences that echo strings. See the resource B<insecure> for more 410sequences that echo strings. See the resource B<insecure> for more
281=item B<-ssr>|B<+ssr> 424=item B<-ssr>|B<+ssr>
282 425
283Turn on/off secondary screen scroll (default enabled); resource 426Turn on/off secondary screen scroll (default enabled); resource
284B<secondaryScroll>. 427B<secondaryScroll>.
285 428
429=item B<-hold>|B<+hold>
430
431Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
432will not immediately destroy its window when the program executed within
433it exits. Instead, it will wait till it is being killed or closed by the
434user; resource B<hold>.
435
436=item B<-cd> I<path>
437
438Sets the working directory for the shell (or the command specified via
439B<-e>). The I<path> must be an absolute path and it must exist for
440@@RXVT_NAME@@ to start; resource B<chdir>.
441
286=item B<-xrm> I<resourcestring> 442=item B<-xrm> I<string>
287 443
288No effect on rxvt. Simply passes through an argument to be made 444Works like the X Toolkit option of the same name, by adding the I<string>
289available in the instance's argument list. Appears in I<WM_COMMAND> in 445as if it were specified in a resource file. Resource values specified this
290some window managers. 446way take precedence over all other resource specifications.
447
448Note that you need to use the I<same> syntax as in the .Xdefaults file,
449e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
450options can be specified as long-options on the commandline, so use
451of B<-xrm> is mostly limited to cases where you want to specify other
452resources (e.g. for input methods) or for compatibility with other
453programs.
454
455=item B<-keysym.>I<sym> I<string>
456
457Remap a key symbol. See resource B<keysym>.
458
459=item B<-embed> I<windowid>
460
461Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
462which enables applications to easily embed a terminal.
463
464Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
465shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
466quite a bit, so don't expect it to keep some specific state. It's best to
467create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
468
469The window will not be destroyed when @@RXVT_NAME@@ exits.
470
471It might be useful to know that @@RXVT_NAME@@ will not close file
472descriptors passed to it (except for stdin/out/err, of course), so you
473can use file descriptors to communicate with the programs within the
474terminal. This works regardless of whether the C<-embed> option was used or
475not.
476
477Here is a short Gtk2-perl snippet that illustrates how this option can be
478used (a longer example is in F<doc/embed>):
479
480 my $rxvt = new Gtk2::Socket;
481 $rxvt->signal_connect_after (realize => sub {
482 my $xid = $_[0]->window->get_xid;
483 system "@@RXVT_NAME@@ -embed $xid &";
484 });
485
486=item B<-pty-fd> I<file descriptor>
487
488Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
489pair but instead use the given file descriptor as the tty master. This is
490useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
491without having to run a program within it.
492
493If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
494entries and will not tinker with pty/tty permissions - you have to do that
495yourself if you want that.
496
497As an extremely special case, specifying C<-1> will completely suppress
498pty/tty operations, which is probably only useful in conjunction with some
499perl extension that manages the terminal.
500
501Here is a example in perl that illustrates how this option can be used (a
502longer example is in F<doc/pty-fd>):
503
504 use IO::Pty;
505 use Fcntl;
506
507 my $pty = new IO::Pty;
508 fcntl $pty, F_SETFD, 0; # clear close-on-exec
509 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
510 close $pty;
511
512 # now communicate with rxvt
513 my $slave = $pty->slave;
514 while (<$slave>) { print $slave "got <$_>\n" }
515
516=item B<-pe> I<string>
517
518Comma-separated list of perl extension scripts to use (or not to use) in
519this terminal instance. See resource B<perl-ext> for details.
291 520
292=back 521=back
293 522
294=head1 RESOURCES (available also as long-options) 523=head1 RESOURCES
295 524
296Note: `@@RXVTNAME@@ --help' gives a list of all resources (long 525Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
297options) compiled into your version. 526options) compiled into your version. All resources are also available as
527long-options.
298 528
299There are two different methods that @@RXVTNAME@@ can use to get the 529You can set and change the resources using X11 tools like B<xrdb>. Many
300Xresource data: using the X libraries (Xrm*-functions) or internal 530distribution do also load settings from the B<~/.Xresources> file when X
301Xresources reader (B<~/.Xdefaults>). For the first method (ie. 531starts. @@RXVT_NAME@@ will consult the following files/resources in order,
302B<@@RXVTNAME@@ -h> lists B<XGetDefaults>), you can set and change the 532with 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 533
306If compiled with internal Xresources support (i.e. B<@@RXVTNAME@@ -h> 534 1. app-defaults file in $XAPPLRESDIR
307lists B<.Xdefaults>) then B<@@RXVTNAME@@> accepts application defaults 535 2. $HOME/.Xdefaults
308set in XAPPLOADDIR/URxvt (compile-time defined: usually 536 3. RESOURCE_MANAGER property on root-window of screen 0
309B</usr/lib/X11/app-defaults/URxvt>) and resources set in 537 4. SCREEN_RESOURCES property on root-window of the current screen
310B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist. 538 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
539 6. resources specified via -xrm on the commandline
540
311Note that when reading X resources, B<@@RXVTNAME@@> recognizes two 541Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
312class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 542names: 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 543common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
314easily configured, while the class name B<URxvt> allows resources 544configured, while the class name B<URxvt> allows resources unique to
315unique to B<@@RXVTNAME@@>, notably colours and key-handling, to be 545B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
316shared between different B<@@RXVTNAME@@> configurations. If no 546configurations. If no resources are specified, suitable defaults will
317resources are specified, suitable defaults will be used. Command-line 547be used. Command-line arguments can be used to override resource
318arguments can be used to override resource settings. The following 548settings. The following resources are supported (you might want to
319resources are allowed: 549check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
550extensions not documented here):
320 551
321=over 4 552=over 4
553
554=item B<depth:> I<bitdepth>
555
556Compile I<xft>: Attempt to find a visual with the given bit depth;
557option B<-depth>.
558
559=item B<buffered:> I<boolean>
560
561Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
562On some card/driver combination enabling it slightly decreases
563performance, on most it greatly helps it. The slowdown is small, so it
564should normally be enabled.
322 565
323=item B<geometry:> I<geom> 566=item B<geometry:> I<geom>
324 567
325Create the window with the specified X window geometry [default 80x24]; 568Create the window with the specified X window geometry [default 80x24];
326option B<-geometry>. 569option B<-geometry>.
340Use the specified colour for the colour value I<n>, where 0-7 583Use the specified colour for the colour value I<n>, where 0-7
341corresponds to low-intensity (normal) colours and 8-15 corresponds to 584corresponds to low-intensity (normal) colours and 8-15 corresponds to
342high-intensity (bold = bright foreground, blink = bright background) 585high-intensity (bold = bright foreground, blink = bright background)
343colours. The canonical names are as follows: 0=black, 1=red, 2=green, 586colours. 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 5873=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
345names used are listed in the B<COLORS AND GRAPHICS> section. 588names used are listed in the B<COLOURS AND GRAPHICS> section.
589
590Colours higher than 15 cannot be set using resources (yet), but can be
591changed using an escape command (see @@RXVT_NAME@@(7)).
592
593Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
59488 colour support). Colours 80-87 are evenly spaces grey steps.
346 595
347=item B<colorBD:> I<colour> 596=item B<colorBD:> I<colour>
348 597
598=item B<colorIT:> I<colour>
599
349Use the specified colour to display bold characters when the foreground 600Use the specified colour to display bold or italic characters when the
350colour is the default. This option will be ignored if B<realBold> is 601foreground colour is the default. If font styles are not available
351enabled. 602(Compile I<styles>) and this option is unset, reverse video is used instead.
352 603
353=item B<colorUL:> I<colour> 604=item B<colorUL:> I<colour>
354 605
355Use the specified colour to display underlined characters when the 606Use the specified colour to display underlined characters when the
356foreground colour is the default. 607foreground colour is the default.
357 608
358=item B<colorRV:> I<colour> 609=item B<underlineColor:> I<colour>
359 610
611If set, use the specified colour as the colour for the underline
612itself. If unset, use the foreground colour.
613
614=item B<highlightColor:> I<colour>
615
360Use the specified colour as the background for reverse video 616If set, use the specified colour as the background for highlighted
361characters. 617characters. If unset, use reverse video.
618
619=item B<highlightTextColor:> I<colour>
620
621If set and highlightColor is set, use the specified colour as the
622foreground for highlighted characters.
362 623
363=item B<cursorColor:> I<colour> 624=item B<cursorColor:> I<colour>
364 625
365Use the specified colour for the cursor. The default is to use the 626Use the specified colour for the cursor. The default is to use the
366foreground colour; option B<-cr>. 627foreground colour; option B<-cr>.
373 634
374=item B<reverseVideo:> I<boolean> 635=item B<reverseVideo:> I<boolean>
375 636
376B<True>: simulate reverse video by foreground and background colours; 637B<True>: simulate reverse video by foreground and background colours;
377option B<-rv>. B<False>: regular screen colours [default]; option 638option B<-rv>. B<False>: regular screen colours [default]; option
378B<+rv>. See note in B<COLORS AND GRAPHICS> section. 639B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
379 640
380=item B<jumpScroll:> I<boolean> 641=item B<jumpScroll:> I<boolean>
381 642
382B<True>: specify that jump scrolling should be used. When scrolling 643B<True>: specify that jump scrolling should be used. When receiving lots
383quickly, fewer screen updates are performed [default]; option B<-j>. 644of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
645has been read, resulting in fewer updates while still displaying every
646received line; option B<-j>.
647
384B<False>: specify that smooth scrolling should be used; option B<+j>. 648B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
649force a screen refresh on each new line it received; option B<+j>.
385 650
386=item B<inheritPixmap:> I<boolean> 651=item B<skipScroll:> I<boolean>
387 652
388B<True>: make the background inherit the parent windows' pixmap, giving 653B<True>: (the default) specify that skip scrolling should be used. When
389artificial transparency. B<False>: do not inherit the parent windows' 654receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
390pixmap. 655(around 60 times per second), resulting in far fewer updates. This can
656result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
657option B<-ss>.
658
659B<False>: specify that everything is to be displayed, even
660if the refresh is too fast for the human eye to read anything (or the
661monitor to display anything); option B<+ss>.
391 662
392=item B<fading:> I<number> 663=item B<fading:> I<number>
393 664
394Fade the text by the given percentage when focus is lost. 665Fade the text by the given percentage when focus is lost; option B<-fade>.
395 666
396=item B<tintColor:> I<colour> 667=item B<fadeColor:> I<colour>
397 668
398Tint the transparent background pixmap with the given colour. 669Fade to this colour, when fading is used (see B<fading:>). The default
670colour is black; option B<-fadecolor>.
399 671
400=item B<shading:> I<number> 672=item B<iconFile:> I<file>
401 673
402Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 674Set the application icon pixmap; option B<-icon>.
403image in addition to tinting it.
404
405=item B<fading:> I<number>
406
407Scale the tint colour by the given percentage.
408 675
409=item B<scrollColor:> I<colour> 676=item B<scrollColor:> I<colour>
410 677
411Use the specified colour for the scrollbar [default #B2B2B2]. 678Use the specified colour for the scrollbar [default #B2B2B2].
412 679
413=item B<troughColor:> I<colour> 680=item B<troughColor:> I<colour>
414 681
415Use the specified colour for the scrollbar's trough area [default 682Use the specified colour for the scrollbar's trough area [default
416#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 683#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
417 684
418=item B<backgroundPixmap:> I<file[;geom]> 685=item B<borderColor:> I<colour>
419 686
420Use the specified XPM file (note the `.xpm' extension is optional) for 687The colour of the border around the text area and between the scrollbar
421the background and also optionally specify its scaling with a geometry 688and the text.
422string B<WxH+X+Y>, in which B<"W" / "H"> specify the
423horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image
424centre (percent). A scale of 0 displays the image with tiling. A scale
425of 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
427be magnified beyond 10 times its original size. The maximum permitted
428scale is 1000. [default 0x0+50+50]
429 689
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>
437
438Specify the colon-delimited search path for finding files (XPM and
439menus), in addition to the paths specified by the B<RXVTPATH> and
440B<PATH> environment variables.
441
442=item B<font:> I<fontname> 690=item B<font:> I<fontlist>
443 691
444Select the fonts to be used. This is a comma seperated list of font 692Select 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. 693that are checked in order when trying to find glyphs for characters. The
446The first font defines the cell size for characters; other fonts might 694first font defines the cell size for characters; other fonts might be
447be smaller, but not larger. A reasonable default font list is always 695smaller, but not (in general) larger. A (hopefully) reasonable default
448appended to it. option B<-fn>. 696font list is always appended to it; option B<-fn>.
449 697
450=item B<realBold:> I<boolean> 698Each font can either be a standard X11 core font (XLFD) name, with
699optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
451 700
452B<True>: Enable "real bold" support. When this option is on, bold text 701In addition, each font can be prefixed with additional hints and
453will be displayed using the first available bold font in the font list. 702specifications enclosed in square brackets (C<[]>). The only available
454Bold fonts should thus be specified in the font list after their 703hint 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 704fonts.
456font will be used. option B<-rb>. B<False>: Display bold text in a
457regular font, using the color specified with B<colorBD>; option B<+rb>.
458 705
459=item B<selectstyle:> I<mode> 706For example, this font resource
460 707
461Set mouse selection style to B<old> which is 2.20, B<oldword> which is 708 URxvt.font: 9x15bold,\
462xterm style with 2.20 old word selection, or anything else which gives 709 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
463xterm style selection. 710 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
711 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
712 xft:Code2000:antialias=false
464 713
465=item B<scrollstyle:> I<mode> 714specifies five fonts to be used. The first one is C<9x15bold> (actually
715the iso8859-1 version of the second font), which is the base font (because
716it is named first) and thus defines the character cell grid to be 9 pixels
717wide and 15 pixels high.
466 718
467Set scrollbar style to B<@@RXVTNAME@@>, B<rxvt>, B<plain>, B<next> or 719The second font is just used to add additional unicode characters not in
468B<xterm> 720the base font, likewise the third, which is unfortunately non-bold, but
721the bold version of the font does contain fewer characters, so this is a
722useful supplement.
723
724The third font is an Xft font with aliasing turned off, and the characters
725are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
726contains other characters, but we are not interested in them.
727
728The last font is a useful catch-all font that supplies most of the
729remaining unicode characters.
730
731=item B<boldFont:> I<fontlist>
732
733=item B<italicFont:> I<fontlist>
734
735=item B<boldItalicFont:> I<fontlist>
736
737The font list to use for displaying B<bold>, I<italic> or B<< I<bold
738italic> >> characters, respectively.
739
740If specified and non-empty, then the syntax is the same as for the
741B<font>-resource, and the given font list will be used as is, which makes
742it possible to substitute completely different font styles for bold and
743italic.
744
745If unset (the default), a suitable font list will be synthesized by
746"morphing" the normal text font list into the desired shape. If that is
747not possible, replacement fonts of the desired shape will be tried.
748
749If set, but empty, then this specific style is disabled and the normal
750text font will being used for the given style.
751
752=item B<intensityStyles:> I<boolean>
753
754When font styles are not enabled, or this option is enabled (B<True>,
755option B<-is>, the default), bold/blink font styles imply high
756intensity foreground/background colours. Disabling this option (B<False>,
757option B<+is>) disables this behaviour, the high intensity colours are not
758reachable.
469 759
470=item B<title:> I<string> 760=item B<title:> I<string>
471 761
472Set window title string, the default title is the command-line 762Set window title string, the default title is the command-line
473specified after the B<-e> option, if any, otherwise the application 763specified after the B<-e> option, if any, otherwise the application
482=item B<mapAlert:> I<boolean> 772=item B<mapAlert:> I<boolean>
483 773
484B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 774B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
485de-iconify (map) on receipt of a bell character [default]. 775de-iconify (map) on receipt of a bell character [default].
486 776
777=item B<urgentOnBell:> I<boolean>
778
779B<True>: set the urgency hint for the wm on receipt of a bell character.
780B<False>: do not set the urgency hint [default].
781
782@@RXVT_NAME@@ resets the urgency hint on every focus change.
783
487=item B<visualBell:> I<boolean> 784=item B<visualBell:> I<boolean>
488 785
489B<True>: use visual bell on receipt of a bell character; option B<-vb>. 786B<True>: use visual bell on receipt of a bell character; option B<-vb>.
490B<False>: no visual bell [default]; option B<+vb>. 787B<False>: no visual bell [default]; option B<+vb>.
491 788
493 790
494B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 791B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
495the shell; option B<-ls>. B<False>: start as a normal sub-shell 792the shell; option B<-ls>. B<False>: start as a normal sub-shell
496[default]; option B<+ls>. 793[default]; option B<+ls>.
497 794
795=item B<multiClickTime:> I<number>
796
797Specify the maximum time in milliseconds between multi-click select
798events. The default is 500 milliseconds; option B<-mc>.
799
498=item B<utmpInhibit:> I<boolean> 800=item B<utmpInhibit:> I<boolean>
499 801
500B<True>: inhibit writing record into the system log file B<utmp>; 802B<True>: inhibit writing record into the system log file B<utmp>;
501option B<-ut>. B<False>: write record into the system log file B<utmp> 803option B<-ut>. B<False>: write record into the system log file B<utmp>
502[default]; option B<+ut>. 804[default]; option B<+ut>.
505 807
506Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 808Specify 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 809B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
508B<Shift-Print> to include the scrollback as well. 810B<Shift-Print> to include the scrollback as well.
509 811
812The string will be interpreted as if typed into the shell as-is.
813
814Example:
815
816 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
817
818This creates a new file in your home directory with the screen contents
819every time you hit C<Print>.
820
821=item B<scrollstyle:> I<mode>
822
823Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
824the author's favourite.
825
826=item B<thickness:> I<number>
827
828Set the scrollbar width in pixels.
829
510=item B<scrollBar:> I<boolean> 830=item B<scrollBar:> I<boolean>
511 831
512B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 832B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
513disable the scrollbar; option B<+sb>. 833disable the scrollbar; option B<+sb>.
514 834
527Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar 847Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar
528thumb with the pointer on middle button press/drag. 848thumb with the pointer on middle button press/drag.
529 849
530=item B<scrollTtyOutput:> I<boolean> 850=item B<scrollTtyOutput:> I<boolean>
531 851
532B<True>: scroll to bottom when tty receives output; option B<+si>. 852B<True>: scroll to bottom when tty receives output; option B<-si>.
533B<False>: do not scroll to bottom when tty receives output; option 853B<False>: do not scroll to bottom when tty receives output; option
534B<-si>. 854B<+si>.
535 855
536=item B<scrollWithBuffer:> I<boolean> 856=item B<scrollWithBuffer:> I<boolean>
537 857
538B<True>: scroll with scrollback buffer when tty recieves new lines (and 858B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
539B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 859try to show the same lines) and B<scrollTtyOutput> is False; option
540with scrollback buffer when tty recieves new lines; option B<-sw>. 860B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
861new lines; option B<+sw>.
541 862
542=item B<scrollTtyKeypress:> I<boolean> 863=item B<scrollTtyKeypress:> I<boolean>
543 864
544B<True>: scroll to bottom when a non-special key is pressed. Special 865B<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 866are 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 867are 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>. 868bottom 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 869
559=item B<saveLines:> I<number> 870=item B<saveLines:> I<number>
560 871
561Save I<number> lines in the scrollback buffer [default 64]. This 872Save I<number> lines in the scrollback buffer [default 64]. This
562resource is limited on most machines to 65535; option B<-sl>. 873resource is limited on most machines to 65535; option B<-sl>.
572option B<-w>, B<-bw>, B<-borderwidth>. 883option B<-w>, B<-bw>, B<-borderwidth>.
573 884
574=item B<borderLess:> I<boolean> 885=item B<borderLess:> I<boolean>
575 886
576Set MWM hints to request a borderless window, i.e. if honoured by the 887Set 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>. 888WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
889
890=item B<skipBuiltinGlyphs:> I<boolean>
891
892Compile I<frills>: Disable the usage of the built-in block graphics/line
893drawing characters and just rely on what the specified fonts provide. Use
894this if you have a good font and want to use its block graphic glyphs;
895option B<-sbg>.
578 896
579=item B<termName:> I<termname> 897=item B<termName:> I<termname>
580 898
581Specifies the terminal type name to be set in the B<TERM> environment 899Specifies the terminal type name to be set in the B<TERM> environment
582variable; option B<-tn>. 900variable; option B<-tn>.
583 901
584=item B<linespace:> I<number> 902=item B<lineSpace:> I<number>
585 903
586Specifies number of lines (pixel height) to insert between each row of 904Specifies number of lines (pixel height) to insert between each row of
587the display [default 0]; option B<-lsp>. 905the display [default 0]; option B<-lsp>.
588 906
589=item B<meta8:> I<boolean> 907=item B<meta8:> I<boolean>
594=item B<mouseWheelScrollPage:> I<boolean> 912=item B<mouseWheelScrollPage:> I<boolean>
595 913
596B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel 914B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
597scrolls five lines [default]. 915scrolls five lines [default].
598 916
917=item B<pastableTabs:> I<boolean>
918
919B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
920movement only; option C<-ptab>.
921
599=item B<cursorBlink:> I<boolean> 922=item B<cursorBlink:> I<boolean>
600 923
601B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 924B<True>: blink the cursor. B<False>: do not blink the cursor [default];
602option B<-bc>. 925option B<-bc>.
926
927=item B<cursorUnderline:> I<boolean>
928
929B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
930option B<-uc>.
603 931
604=item B<pointerBlank:> I<boolean> 932=item B<pointerBlank:> I<boolean>
605 933
606B<True>: blank the pointer when a key is pressed or after a set number 934B<True>: blank the pointer when a key is pressed or after a set number
607of seconds of inactivity. B<False>: the pointer is always visible 935of seconds of inactivity. B<False>: the pointer is always visible
615 943
616Mouse pointer background colour. 944Mouse pointer background colour.
617 945
618=item B<pointerBlankDelay:> I<number> 946=item B<pointerBlankDelay:> I<number>
619 947
620Specifies number of seconds before blanking the pointer [default 2]. 948Specifies number of seconds before blanking the pointer [default 2]. Use a
949large number (e.g. C<987654321>) to effectively disable the timeout.
621 950
622=item B<backspacekey:> I<string> 951=item B<backspacekey:> I<string>
623 952
624The string to send when the backspace key is pressed. If set to B<DEC> 953The 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> 954or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
626(code 8) - which can be reversed with the appropriate DEC private mode 955(code 8) - which can be reversed with the appropriate DEC private mode
627escape sequence. 956escape sequence.
628 957
629=item B<deletekey:> I<string> 958=item B<deletekey:> I<string>
630 959
632pressed. If unset it will send the sequence traditionally associated 961pressed. If unset it will send the sequence traditionally associated
633with the B<Execute> key. 962with the B<Execute> key.
634 963
635=item B<cutchars:> I<string> 964=item B<cutchars:> I<string>
636 965
637The characters used as delimiters for double-click word selection. The 966The characters used as delimiters for double-click word selection
638built-in default: 967(whitespace delimiting is added automatically if resource is given).
639 968
969When the perl selection extension is in use (the default if compiled
970in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
971characters will be created (if the resource exists, otherwise, no regex
972will be created). In this mode, characters outside ISO-8859-1 can be used.
973
974When the selection extension is not used, only ISO-8859-1 characters can
975be used. If not specified, the built-in default is used:
976
640B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 977B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
641 978
642=item B<preeditType:> I<style> 979=item B<preeditType:> I<style>
643 980
644B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 981B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
645 982
647 984
648I<name> of inputMethod to use; option B<-im>. 985I<name> of inputMethod to use; option B<-im>.
649 986
650=item B<imLocale:> I<name> 987=item B<imLocale:> I<name>
651 988
652The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 989The 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 990C<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 991input extension to be able to input japanese characters while staying in
655another locale. option B<-imlocale>. 992another locale; option B<-imlocale>.
656 993
657=item B<insecure> 994=item B<imFont:> I<fontset>
995
996Specify the font-set used for XIM styles C<OverTheSpot> or
997C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
998by commas), i.e. it's not in the same format as the other font lists used
999in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
1000found, preferably one or two pixels differing in size to the base font.
1001option B<-imfont>.
1002
1003=item B<tripleclickwords:> I<boolean>
1004
1005Change the meaning of triple-click selection with the left mouse
1006button. Instead of selecting a full line it will extend the selection to
1007the end of the logical line only; option B<-tcw>.
1008
1009=item B<insecure:> I<boolean>
658 1010
659Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1011Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
660echo arbitrary strings like the icon name or the locale. This could be 1012echo arbitrary strings like the icon name or the locale. This could be
661abused if somebody gets 8-bit-clean access to your display, wether 1013abused if somebody gets 8-bit-clean access to your display, whether
662throuh a mail client displaying mail bodies unfiltered or though 1014through a mail client displaying mail bodies unfiltered or through
663write(1). Therefore, these sequences are disabled by default. (Note 1015write(1) or any other means. Therefore, these sequences are disabled by
664that other terminals, including xterm, have these sequences 1016default. (Note that many other terminals, including xterm, have these
665enabled by default). You can enable them by setting this boolean 1017sequences enabled by default, which doesn't make it safer, though).
666resource or specifying B<-insecure> as an option. At the moment, this 1018
667enabled display-answer, locale, findfont, icon label and window title 1019You can enable them by setting this boolean resource or specifying
668requests as well as dynamic menubar dispatch. 1020B<-insecure> as an option. At the moment, this enables display-answer,
1021locale, findfont, icon label and window title requests.
669 1022
670=item B<modifier:> I<modifier> 1023=item B<modifier:> I<modifier>
671 1024
672Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 1025Set 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 1026B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
674B<-mod>. 1027B<-mod>.
675 1028
676=item B<answerbackString:> I<string> 1029=item B<answerbackString:> I<string>
677 1030
678Specify the reply rxvt sends to the shell when an ENQ (control-E) 1031Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
679character is passed through. It may contain escape values as described 1032character is passed through. It may contain escape values as described
680in the entry on B<keysym> following. 1033in the entry on B<keysym> following.
681 1034
682=item B<secondaryScreen:> I<bool> 1035=item B<secondaryScreen:> I<boolean>
683 1036
684Turn on/off secondary screen (default enabled). 1037Turn on/off secondary screen (default enabled).
685 1038
686=item B<secondaryScroll:> I<bool> 1039=item B<secondaryScroll:> I<boolean>
687 1040
688Turn on/off secondary screen scroll (default enabled). If the this 1041Turn on/off secondary screen scroll (default enabled). If this
689option is enabled, scrolls on the secondary screen will change the 1042option is enabled, scrolls on the secondary screen will change the
690scrollback buffer and switching to/from the secondary screen will 1043scrollback buffer and, when secondaryScreen is off, switching
691instead scroll the screen up. 1044to/from the secondary screen will instead scroll the screen up.
692 1045
1046=item B<hold>: I<boolean>
1047
1048Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1049will not immediately destroy its window when the program executed within
1050it exits. Instead, it will wait till it is being killed or closed by the
1051user.
1052
1053=item B<chdir>: I<path>
1054
1055Sets the working directory for the shell (or the command specified via
1056B<-e>). The I<path> must be an absolute path and it must exist for
1057@@RXVT_NAME@@ to start. If it isn't specified then the current working
1058directory will be used; option B<-cd>.
1059
693=item B<keysym.>I<sym>: I<string> 1060=item B<keysym.>I<sym>: I<action>
694 1061
695Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 1062Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
696contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 1063resource name B<keysym.> cannot be omitted.
697newline, \r: return, \t: 1064
698tab, \000: octal number) or control characters (^?: delete, ^@: null, 1065Using this resource, you can map key combinations such as
699^A ...) and may enclosed with double quotes so that it can start or end 1066C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
700with whitespace. The intervening resource name B<keysym.> cannot be 1067string than would normally result from that combination, making the
701omitted. This resource is only available when compiled with 1068terminal scroll up or down the way you want it, or any other thing an
702KEYSYM_RESOURCE. 1069extension might provide.
1070
1071The key combination that triggers the action, I<sym>, has the following format:
1072
1073 (modifiers-)key
1074
1075Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
1076B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
1077B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
1078B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1079
1080The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1081whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1082keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1083current application keymap mode state.
1084
1085Due the the large number of modifier combinations, a key mapping will
1086match if I<at least> the specified identifiers are being set, and no other
1087key mappings with those and more bits are being defined. That means that
1088defining a mapping for C<a> will automatically provide definitions for
1089C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1090themselves. See the C<builtin:> action, below, for a way to work around
1091this when this is a problem.
1092
1093The spelling of I<key> depends on your implementation of X. An easy way to
1094find a key name is to use the B<xev>(1) command. You can find a list by
1095looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1096the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1097value (B<0x0000 - 0xFFFF>).
1098
1099As with any resource value, the I<action> string may contain backslash
1100escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1101number), see RESOURCES in C<man 7 X> for further details.
1102
1103An action starts with an action prefix that selects a certain type
1104of action, followed by a colon. An action string without colons is
1105interpreted as a literal string to pass to the tty (as if it was
1106prefixed with C<string:>).
1107
1108The following action prefixes are known - extensions can provide
1109additional prefixes:
1110
1111=over 4
1112
1113=item string:STRING
1114
1115If the I<action> starts with C<string:> (or otherwise contains no colons),
1116then the remaining C<STRING> will be passed to the program running in the
1117terminal. For example, you could replace whatever Shift-Tab outputs by the
1118string C<echo rm -rf /> followed by a newline:
1119
1120 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1121
1122This could in theory be used to completely redefine your keymap.
1123
1124=item command:STRING
1125
1126If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1127is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1128the opposite of C<string:> - instead of sending it to the program running
1129in the terminal, it will be treated as if it were program output). This is
1130most useful to feed command sequences into @@RXVT_NAME@@.
1131
1132For example the following means "change the current locale to C<zh_CN.GBK>
1133when Control-Meta-c is being pressed":
1134
1135 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1136
1137The following example will map Control-Meta-1 and Control-Meta-2 to
1138the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1139font-switching at runtime:
1140
1141 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1142 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1143
1144Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1145info):
1146
1147 URxvt.keysym.M-C-3: command:\033[8;25;80t
1148 URxvt.keysym.M-C-4: command:\033[8;48;110t
1149
1150=item builtin:
1151
1152The builtin action is the action that @@RXVT_NAME@@ would execute if no
1153key binding existed for the key combination. The obvious use is to undo
1154the effect of existing bindings. The not so obvious use is to reinstate
1155bindings when another binding overrides too many modifiers.
1156
1157For example if you overwrite the C<Insert> key you will disable
1158@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1159"holes" into the user-defined keymap using the C<builtin:> replacement:
1160
1161 URxvt.keysym.Insert: <my insert key sequence>
1162 URxvt.keysym.S-Insert: builtin:
1163
1164The first line defines a mapping for C<Insert> and I<any> combination
1165of modifiers. The second line re-establishes the default mapping for
1166C<Shift-Insert>.
1167
1168=item builtin-string:
1169
1170This action is mainly useful to restore string mappings for keys that
1171have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1172difficult to explain - basically, this action will send the string to the
1173application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1174action for it.
1175
1176An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1177selection when you press C<Shift-Insert>. With the following bindings, it
1178would instead emit the (undocumented, but what applications running in the
1179terminal might expect) sequence C<ESC [ 2 $> instead:
1180
1181 URxvt.keysym.S-Insert: builtin-string:
1182 URxvt.keysym.C-S-Insert: builtin:
1183
1184The first line disables the paste functionality for that key
1185combination, and the second reinstates the default behaviour for
1186C<Control-Shift-Insert>, which would otherwise be overridden.
1187
1188Similarly, to let applications gain access to the C<C-M-c> (copy to
1189clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1190this:
1191
1192 URxvt.keysym.C-S-c: builtin-string:
1193 URxvt.keysym.C-S-v: builtin-string:
1194
1195=item EXTENSION:STRING
1196
1197An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)
1198extension of the same name. The extension will be loaded automatically if
1199necessary.
1200
1201Not all extensions define key actions, but popular extensions that do
1202include the I<selection> and I<matcher> extensions (documented in their
1203own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1204respectively).
1205
1206From the silly examples department, this will rot13-"encrypt"
1207@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1208keyboards:
1209
1210 URxvt.keysym.M-C-c: selection:rot13
1211
1212=item perl:STRING *DEPRECATED*
1213
1214This is a deprecated way of passing key mappings to perl extensions. It is
1215still supported, but should not be used anymore.
703 1216
704=back 1217=back
705 1218
1219=item B<perl-ext-common>: I<string>
1220
1221=item B<perl-ext>: I<string>
1222
1223Comma-separated list(s) of perl extension scripts (default: C<default>) to
1224use in this terminal instance; option B<-pe>.
1225
1226Extension names can be prefixed with a C<-> sign to prohibit using
1227them. This can be useful to selectively disable some extensions loaded
1228by default, or specified via the C<perl-ext-common> resource. For
1229example, C<default,-selection> will use all the default extensions except
1230C<selection>.
1231
1232The default set includes the C<selection>, C<option-popup>,
1233C<selection-popup> and C<readline> extensions, any extensions that define
1234keybindings via C<BINDING> meta comments, extensions loaded because
1235their resources/commandline switches were used, and extensions which are
1236mentioned in B<keysym> resources.
1237
1238Each extension is looked up in the library directories, loaded if
1239necessary, and bound to the current terminal instance. When the library
1240search path contains multiple extension files of the same name, then the
1241first one found will be used.
1242
1243If both of these resources are the empty string, then the perl interpreter
1244will not be initialized. The rationale for having two options is that
1245B<perl-ext-common> will be used for extensions that should be available to
1246all instances, while B<perl-ext> is used for specific instances.
1247
1248=item B<perl-eval>: I<string>
1249
1250Perl code to be evaluated when all extensions have been registered. See
1251the @@RXVT_NAME@@perl(3) manpage.
1252
1253=item B<perl-lib>: I<path>
1254
1255Colon-separated list of additional directories that hold extension
1256scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1257in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1258lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1259
1260See the @@RXVT_NAME@@perl(3) manpage.
1261
1262=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1263
1264Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1265details.
1266
1267=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1268
1269Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1270for details.
1271
1272=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1273
1274This resource is deprecated and will be removed. Use a B<keysym> resource
1275instead, e.g.:
1276
1277 URxvt.keysym.M-s: searchable-scrollback:start
1278
1279=item B<url-launcher>: I<string>
1280
1281Specifies the program to be started with a URL argument. Used by the
1282C<selection-popup> and C<matcher> perl extensions.
1283
1284=item B<transient-for>: I<windowid>
1285
1286Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1287
1288=item B<override-redirect>: I<boolean>
1289
1290Compile I<frills>: Sets override-redirect for the terminal window, making
1291it almost invisible to window managers; option B<-override-redirect>.
1292
1293=item B<iso14755:> I<boolean>
1294
1295Turn on/off ISO 14755 (default enabled).
1296
1297=item B<iso14755_52:> I<boolean>
1298
1299Turn on/off ISO 14755 5.2 mode (default enabled).
1300
1301=back
1302
1303=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1304
1305=over 4
1306
1307=item B<-pixmap> I<file[;oplist]>
1308
1309=item B<backgroundPixmap:> I<file[;oplist]>
1310
1311Compile I<pixbuf>: Use the specified image file as the window's
1312background and also optionally specify a colon separated list of
1313operations to modify it. Note that you may need to quote the C<;>
1314character when using the command line option, as C<;> is usually a
1315metacharacter in shells. Supported operations are:
1316
1317=over 4
1318
1319=item B<WxH+X+Y>
1320
1321sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1322scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1323scale of 0 disables scaling.
1324
1325=item B<op=tile>
1326
1327enables tiling
1328
1329=item B<op=keep-aspect>
1330
1331maintain the image aspect ratio when scaling
1332
1333=item B<op=root-align>
1334
1335use the position of the terminal window relative to the root window as
1336the image offset, simulating a root window background
1337
1338=back
1339
1340The default scale and position setting is C<100x100+50+50>.
1341Alternatively, a predefined set of templates can be used to achieve
1342the most common setups:
1343
1344=over 4
1345
1346=item B<style=tiled>
1347
1348the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1349
1350=item B<style=aspect-stretched>
1351
1352the image is scaled to fill the whole window maintaining the aspect
1353ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1354
1355=item B<style=stretched>
1356
1357the image is scaled to fill the whole window. Equivalent to 100x100
1358
1359=item B<style=centered>
1360
1361the image is centered with no scaling. Equivalent to 0x0+50+50
1362
1363=item B<style=root-tiled>
1364
1365the image is tiled with no scaling and using 'root' positioning.
1366Equivalent to 0x0:op=tile:op=root-align
1367
1368=back
1369
1370If multiple templates are specified the last one wins. Note that a
1371template overrides all the scale, position and operations settings.
1372
1373If used in conjunction with pseudo-transparency, the specified pixmap
1374will be blended over the transparent background using alpha-blending.
1375
1376=item B<-tr>|B<+tr>
1377
1378=item B<transparent:> I<boolean>
1379
1380Turn on/off pseudo-transparency by using the root pixmap as background.
1381
1382B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1383will be removed in future versions.
1384
1385=item B<-tint> I<colour>
1386
1387=item B<tintColor:> I<colour>
1388
1389Tint the transparent background with the given colour. Note that a
1390black tint yields a completely black image while a white tint yields
1391the image unchanged.
1392
1393=item B<-sh> I<number>
1394
1395=item B<shading:> I<number>
1396
1397Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1398A value of 100 means no shading.
1399
1400=item B<-blr> I<HxV>
1401
1402=item B<blurRadius:> I<HxV>
1403
1404Apply gaussian blur with the specified radius to the transparent
1405background. If a single number is specified, the vertical and
1406horizontal radii are considered to be the same. Setting one of the
1407radii to 1 and the other to a large number creates interesting effects
1408on some backgrounds. The maximum radius value is 128. An horizontal or
1409vertical radius of 0 disables blurring.
1410
1411=item B<path:> I<path>
1412
1413Specify the colon-delimited search path for finding background image files.
1414
1415=back
1416
706=head1 THE SCROLLBAR 1417=head1 THE SCROLLBAR
707 1418
708Lines of text that scroll off the top of the B<@@RXVTNAME@@> window 1419Lines 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 1420(resource: B<saveLines>) and can be scrolled back using the scrollbar
710or by keystrokes. The normal B<@@RXVTNAME@@> scrollbar has arrows and 1421or by keystrokes. The normal B<@@RXVT_NAME@@> scrollbar has arrows and
711its behaviour is fairly intuitive. The B<xterm-scrollbar> is without 1422its behaviour is fairly intuitive. The B<xterm-scrollbar> is without
712arrows and its behaviour mimics that of I<xterm> 1423arrows and its behaviour mimics that of I<xterm>
713 1424
714Scroll down with B<Button1> (B<xterm-scrollbar>) or B<Shift-Next>. 1425Scroll down with B<Button1> (B<xterm-scrollbar>) or B<Shift-Next>.
715Scroll up with B<Button3> (B<xterm-scrollbar>) or B<Shift-Prior>. 1426Scroll up with B<Button3> (B<xterm-scrollbar>) or B<Shift-Prior>.
721the normal text selection/insertion, hold either the Shift or the Meta 1432the normal text selection/insertion, hold either the Shift or the Meta
722(Alt) key while performing the desired mouse action. 1433(Alt) key while performing the desired mouse action.
723 1434
724If mouse reporting mode is active, the normal scrollbar actions are 1435If mouse reporting mode is active, the normal scrollbar actions are
725disabled -- on the assumption that we are using a fullscreen 1436disabled -- on the assumption that we are using a fullscreen
726application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1437application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
727(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1438(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), 1439up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
729respectively. 1440respectively.
730 1441
731=head1 TEXT SELECTION AND INSERTION 1442=head1 THE SELECTION: SELECTING AND PASTING TEXT
732 1443
733The behaviour of text selection and insertion mechanism is similar to 1444The behaviour of text selection and insertion/pasting mechanism is similar
734I<xterm>(1). 1445to I<xterm>(1).
735 1446
736=over 4 1447=over 4
737 1448
738=item B<Selection>: 1449=item B<Selecting>:
739 1450
740Left click at the beginning of the region, drag to the end of the 1451Left 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 1452and release; Right click to extend the marked region; Left double-click
742double-click to select a word; Left triple-click to select the entire 1453to select a word; Left triple-click to select the entire logical line
743line. 1454(which can span multiple screen lines), unless modified by resource
1455B<tripleclickwords>.
744 1456
1457Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1458(Compile: I<frills>) will create a rectangular selection instead of a
1459normal one. In this mode, every selected row becomes its own line in the
1460selection, and trailing whitespace is visually underlined and removed from
1461the selection.
1462
745=item B<Insertion>: 1463=item B<Pasting>:
746 1464
747Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1465Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
748an B<@@RXVTNAME@@> window causes the current text selection to be 1466window causes the value of the PRIMARY selection (or CLIPBOARD with the
749inserted as if it had been typed on the keyboard. 1467B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1468
1469Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1470inserted too.
1471
1472rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1473<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1474binding causes the value of the internal selection to be copied to the
1475CLIPBOARD selection, while the second binding causes the value of the
1476CLIPBOARD selection to be inserted.
750 1477
751=back 1478=back
752 1479
753=head1 CHANGING FONTS 1480=head1 CHANGING FONTS
754 1481
755You can change fonts on-the-fly, which is to say cycle through the 1482Changing 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 1483supported in rxvt-unicode. Bug me if you need this.
757B<Shift-KP_Subtract>. Or, alternatively (if enabled) with 1484
758B<@@HOTKEY@@-@@BIGFONT@@> and B<@@HOTKEY@@-@@SMALLFONT@@>, where the 1485You can, however, switch fonts at runtime using escape sequences, e.g.:
759actual key can be selected using resources 1486
760B<smallfont_key>/B<bigfont_key>. 1487 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1488
1489You can use keyboard shortcuts, too:
1490
1491 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1492 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1493
1494rxvt-unicode will automatically re-apply these fonts to the output so far.
1495
1496=head1 ISO 14755 SUPPORT
1497
1498ISO 14755 is a standard for entering and viewing unicode characters
1499and character codes using the keyboard. It consists of 4 parts. The
1500first part is available if rxvt-unicode has been compiled with
1501C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1502with C<--enable-iso14755>.
1503
1504=over 4
1505
1506=item * 5.1: Basic method
1507
1508This allows you to enter unicode characters using their hexcode.
1509
1510Start by pressing and holding both C<Control> and C<Shift>, then enter
1511hex-digits (between one and six). Releasing C<Control> and C<Shift> will
1512commit the character as if it were typed directly. While holding down
1513C<Control> and C<Shift> you can also enter multiple characters by pressing
1514C<Space>, which will commit the current character and lets you start a new
1515one.
1516
1517As an example of use, imagine a business card with a japanese e-mail
1518address, which you cannot type. Fortunately, the card has the e-mail
1519address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
1520by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
1521followed by releasing the modifier keys.
1522
1523=item * 5.2: Keyboard symbols entry method
1524
1525This mode lets you input characters representing the keycap symbols of
1526your keyboard, if representable in the current locale encoding.
1527
1528Start by pressing C<Control> and C<Shift> together, then releasing
1529them. The next special key (cursor keys, home etc.) you enter will not
1530invoke its usual function but instead will insert the corresponding
1531keycap symbol. The symbol will only be entered when the key has been
1532released, otherwise pressing e.g. C<Shift> would enter the symbol for
1533C<ISO Level 2 Switch>, although your intention might have been to enter a
1534reverse tab (Shift-Tab).
1535
1536=item * 5.3: Screen-selection entry method
1537
1538While this is implemented already (it's basically the selection
1539mechanism), it could be extended by displaying a unicode character map.
1540
1541=item * 5.4: Feedback method for identifying displayed characters for later input
1542
1543This method lets you display the unicode character code associated with
1544characters already displayed.
1545
1546You enter this mode by holding down C<Control> and C<Shift> together, then
1547pressing and holding the left mouse button and moving around. The unicode
1548hex code(s) (it might be a combining character) of the character under the
1549pointer is displayed until you release C<Control> and C<Shift>.
1550
1551In addition to the hex codes it will display the font used to draw this
1552character - due to implementation reasons, characters combined with
1553combining characters, line drawing characters and unknown characters will
1554always be drawn using the built-in support font.
1555
1556=back
1557
1558With respect to conformance, rxvt-unicode is supposed to be compliant to
1559both scenario A and B of ISO 14755, including part 5.2.
761 1560
762=head1 LOGIN STAMP 1561=head1 LOGIN STAMP
763 1562
764B<@@RXVTNAME@@> tries to write an entry into the I<utmp>(5) file so 1563B<@@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. 1564it 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 1565allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
767some systems. 1566on some systems or setgid to root or to some other group on others.
768 1567
769=head1 COLORS AND GRAPHICS 1568=head1 COLOURS AND GRAPHICS
770 1569
771In addition to the default foreground and background colours, 1570In addition to the default foreground and background colours,
772B<@@RXVTNAME@@> can display up to 16 colours (8 ANSI colours plus 1571B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
773high-intensity bold/blink versions of the same). Here is a list of the 1572high-intensity (potentially bold/blink) versions of the same, and 72 (or
774colours with their B<rgb.txt> names. 1573240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1574cube plus a 8 (24) colour greyscale ramp.
1575
1576Here is a list of the ANSI colours with their names.
775 1577
776=begin table 1578=begin table
777 1579
778 B<color0> (black) = Black 1580 B<color0> (black) = Black
779 B<color1> (red) = Red3 1581 B<color1> (red) = Red3
799It is also possible to specify the colour values of B<foreground>, 1601It is also possible to specify the colour values of B<foreground>,
800B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1602B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
801a number 0-15, as a convenient shorthand to reference the colour name of 1603a number 0-15, as a convenient shorthand to reference the colour name of
802color0-color15. 1604color0-color15.
803 1605
1606The following text gives values for the standard 88 colour mode (and
1607values for the 256 colour mode in parentheses).
1608
1609The RGB cube uses indices 16..79 (16..231) using the following formulas:
1610
1611 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1612 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1613
1614The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1615steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1616the RGB cube.
1617
1618Together, all those colours implement the 88 (256) colour xterm
1619colours. Only the first 16 can be changed using resources currently, the
1620rest can only be changed via command sequences ("escape codes").
1621
1622Applications are advised to use terminfo or command sequences to discover
1623number and RGB values of all colours (yes, you can query this...).
1624
804Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1625Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
805always swapping the foreground/background colours. This is in contrast to 1626always swapping the foreground/background colours. This is in contrast to
806I<xterm>(1) where the colours are only swapped if they have not otherwise 1627I<xterm>(1) where the colours are only swapped if they have not otherwise
807been specified. For example, 1628been specified. For example,
808 1629
1630 @@RXVT_NAME@@ -fg Black -bg White -rv
1631
1632would yield White on Black, while on I<xterm>(1) it would yield Black on
1633White.
1634
1635=head2 ALPHA CHANNEL SUPPORT
1636
1637If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1638their act together, rxvt-unicode will do its own alpha channel management:
1639
1640You can prefix any colour with an opaqueness percentage enclosed in
1641brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1642(0-100) that specifies the opacity of the colour, where C<0> is completely
1643transparent and C<100> is completely opaque. For example, C<[50]red> is a
1644half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1645is the recommended format to specify transparency values, and works with
1646all ways to specify a colour.
1647
1648For complete control, rxvt-unicode also supports
1649C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1650specifications, where the additional C<aaaa> component specifies opacity
1651(alpha) values. The minimum value of C<0000> is completely transparent,
1652while C<ffff> is completely opaque). The two example colours from
1653earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1654C<rgba:0000/ff00/0000/f332>.
1655
1656You probably need to specify B<"-depth 32">, too, to force a visual with
1657alpha channels, and have the luck that your X-server uses ARGB pixel
1658layout, as X is far from just supporting ARGB visuals out of the box, and
1659rxvt-unicode just fudges around.
1660
1661For example, the following selects an almost completely transparent black
1662background, and an almost opaque pink foreground:
1663
1664 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1665
1666When not using a background image, then the interpretation of the
1667alpha channel is up to your compositing manager (most interpret it as
1668transparency of course).
1669
1670When using a background pixmap or pseudo-transparency, then the background
1671colour will always behave as if it were completely transparent (so the
1672background image shows instead), regardless of how it was specified, while
1673other colours will either be transparent as specified (the background
1674image will show through) on servers supporting the RENDER extension, or
1675fully opaque on servers not supporting the RENDER EXTENSION.
1676
1677Please note that due to bugs in Xft, specifying alpha values might result
1678in garbage being displayed when the X-server does not support the RENDER
1679extension.
1680
1681=head1 ENVIRONMENT
1682
1683B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1684
809=over 4 1685=over 4
810 1686
811=item B<rxvt -fg Black -bg White -rv> 1687=item B<TERM>
812 1688
813would yield White on Black, while on I<xterm>(1) it would yield Black 1689Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
814on White. 1690resources or on the command line.
1691
1692=item B<COLORTERM>
1693
1694Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1695compiled with background image support, and optionally with the added
1696extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1697screen.
1698
1699=item B<COLORFGBG>
1700
1701Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1702the colour code used as default foreground/text colour (or the string
1703C<default> to indicate that the default-colour escape sequence is to be
1704used), C<bg> is the colour code used as default background colour (or the
1705string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1706was compiled with background image support. Libraries like C<ncurses>
1707and C<slang> can (and do) use this information to optimize screen output.
1708
1709=item B<WINDOWID>
1710
1711Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1712window, which usually has subwindows for the scrollbar, the terminal
1713window and so on).
1714
1715=item B<TERMINFO>
1716
1717Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1718C<--with-terminfo=PATH>.
1719
1720=item B<DISPLAY>
1721
1722Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1723display in its child processes if C<-display> isn't used to override. It
1724defaults to C<:0> if it doesn't exist.
1725
1726=item B<SHELL>
1727
1728The shell to be used for command execution, defaults to C</bin/sh>.
1729
1730=item B<RXVT_SOCKET> [I<sic>]
1731
1732The unix domain socket path used by @@RXVT_NAME@@c(1) and
1733@@RXVT_NAME@@d(1).
1734
1735Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1736
1737=item B<URXVT_PERL_LIB>
1738
1739Additional F<:>-separated library search path for perl extensions. Will be
1740searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1741directory.
1742
1743=item B<URXVT_PERL_VERBOSITY>
1744
1745See L<@@RXVT_NAME@@perl>(3).
1746
1747=item B<HOME>
1748
1749Used to locate the default directory for the unix domain socket for
1750daemon communications and to locate various resource files (such as
1751C<.Xdefaults>)
1752
1753=item B<XAPPLRESDIR>
1754
1755Directory where application-specific X resource files are located.
1756
1757=item B<XENVIRONMENT>
1758
1759If set and accessible, gives the name of a X resource file to be loaded by
1760@@RXVT_NAME@@.
815 1761
816=back 1762=back
817 1763
818=head1 ENVIRONMENT
819
820B<@@RXVTNAME@@> sets the environment variables B<TERM>, B<COLORTERM>
821and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X
822window id number of the B<@@RXVTNAME@@> window and it also uses and
823sets the environment variable B<DISPLAY> to specify which display
824terminal to use. B<@@RXVTNAME@@> uses the environment variables
825B<RXVTPATH> and B<PATH> to find XPM files.
826
827=head1 FILES 1764=head1 FILES
828 1765
829=over 4 1766=over 4
830 1767
831=item B</etc/utmp>
832
833System file for login records.
834
835=item B</usr/lib/X11/rgb.txt> 1768=item B</usr/lib/X11/rgb.txt>
836 1769
837Color names. 1770Colour names.
838 1771
839=back 1772=back
840 1773
841=head1 SEEALSO 1774=head1 SEE ALSO
842 1775
843I<xterm>(1), I<sh>(1), I<resize>(1), I<X>(1), I<pty>(4), I<tty>(4), I<utmp>(5) 1776@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
844 1777@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
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 1778
859=head1 CURRENT PROJECT COORDINATOR 1779=head1 CURRENT PROJECT COORDINATOR
860 1780
861=over 4 1781=over 4
862 1782
863=item Project Coordinator 1783=item Project Coordinator
864 1784
865@@RXVTMAINT@@ L<@@RXVTMAINTEMAIL@@> 1785Marc A. Lehmann <rxvt-unicode@schmorp.de>.
866 1786
867=item Web page maintainter 1787L<http://software.schmorp.de/pkg/rxvt-unicode.html>
868
869@@RXVTWEBMAINT@@ L<@@RXVTWEBMAINTEMAIL@@>
870
871L<@@RXVTWEBPAGE@@>(@@RXVTWEBPAGE@@)
872 1788
873=back 1789=back
874 1790
875=head1 AUTHORS 1791=head1 AUTHORS
876 1792
878 1794
879=item John Bovey 1795=item John Bovey
880 1796
881University of Kent, 1992, wrote the original Xvt. 1797University of Kent, 1992, wrote the original Xvt.
882 1798
883=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1799=item Rob Nation <nation@rocket.sanders.lockheed.com>
884 1800
885very heavily modified Xvt and came up with Rxvt 1801very heavily modified Xvt and came up with Rxvt
886 1802
887=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1803=item Angelo Haritsis <ah@doc.ic.ac.uk>
888 1804
889wrote the Greek Keyboard Input (no longer in code) 1805wrote the Greek Keyboard Input (no longer in code)
890 1806
891=item mj olesen L<< <olesen@me.QueensU.CA> >> 1807=item mj olesen <olesen@me.QueensU.CA>
892 1808
893Wrote the menu system. 1809Wrote the menu system.
894 1810
895Project Coordinator (changes.txt 2.11 to 2.21) 1811Project Coordinator (changes.txt 2.11 to 2.21)
896 1812
897=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1813=item Oezguer Kesim <kesim@math.fu-berlin.de>
898 1814
899Project Coordinator (changes.txt 2.21a to 2.4.5) 1815Project Coordinator (changes.txt 2.21a to 2.4.5)
900 1816
901=item Geoff Wing L<< <gcw@pobox.com> >> 1817=item Geoff Wing <gcw@pobox.com>
902 1818
903Rewrote screen display and text selection routines. Project Coordinator 1819Rewrote screen display and text selection routines.
1820
904(changes.txt 2.4.6 - rxvt-unicode) 1821Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
905 1822
906=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1823=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
907 1824
908Forked rxvt-unicode, rewrote most of the display code and internal 1825Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
909character handling to store text in unicode, improve xterm 1826extension, random hacks, numerous bugfixes and extensions.
910compatibility and apply numerous other bugfixes and extensions.
911 1827
912Project Coordinator (Changes 1.0 -) 1828Project Coordinator (Changes 1.0 -)
913 1829
1830=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1831
1832pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1833
914=back 1834=back
915 1835

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines