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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines