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