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