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.5 by root, Sat Aug 14 03:00:32 2004 UTC vs.
Revision 1.202 by sf-exg, Thu Aug 11 08:37:17 2011 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines