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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines