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.133 by ayin, Sat Jul 28 20:15:18 2007 UTC

11B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal 11B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal
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
17=head1 FREQUENTLY ASKED QUESTIONS
18
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
16 23
17=head1 RXVT-UNICODE VS. RXVT 24=head1 RXVT-UNICODE VS. RXVT
18 25
19Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
20internally. That means it can store and display most scripts in the 27internally. That means it can store and display most scripts in the
21world. Being a terminal emulator, however, some things are very difficult, 28world. Being a terminal emulator, however, some things are very difficult,
22especially cursive scripts such as arabic, vertically written scripts 29especially cursive scripts such as arabic, vertically written scripts
23like mongolian or scripts requiring extremely complex combining rules, 30like mongolian or scripts requiring extremely complex combining rules,
24like tibetan or devenagari. Don't expect pretty output when using these 31like tibetan or devenagari. Don't expect pretty output when using these
25scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
26fine, though. A somewhat difficult case are left-to-right scripts, such 33fine, though. A somewhat difficult case are right-to-left scripts, such
27as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
28belong into the application, not the terminal emulator (too many things -- 35belong into the application, not the terminal emulator (too many things --
29such as cursor-movement while editing -- break othwerwise), but that might 36such as cursor-movement while editing -- break otherwise), but that might
30change. 37change.
31 38
32If you are looking for a terminal that supports more exotic scripts, let 39If you are looking for a terminal that supports more exotic scripts, let
33me recommend C<mlterm>, which is a very userfriendly, lean and clean 40me recommend C<mlterm>, which is a very user friendly, lean and clean
34terminal emulator. In fact, the reason rxvt-unicode was born was solely 41terminal 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 42because the author couldn't get C<mlterm> to use one font for latin1 and
36another for japanese. 43another for japanese.
37 44
38Therefore another design rationale was the use of multiple fonts to 45Therefore another design rationale was the use of multiple fonts to
39display characters: The idea of a single unicode font which many other 46display 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 47programs force onto its users never made sense to me: You should be able
41to choose any font for any script freely. 48to choose any font for any script freely.
42 49
43Apart from that, rxvt-unicode is also much better internationalised than 50Apart from that, rxvt-unicode is also much better internationalised than
44it's predecessor, supports things such as XFT and ISO 14755 that are handy 51its 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 52in i18n-environments, is faster, and has a lot bugs less than the original
46rxvt. This all in addition to dozens of other small improvements. 53rxvt. This all in addition to dozens of other small improvements.
47 54
48It is still faithfully following the original rxvt idea of being lean 55It is still faithfully following the original rxvt idea of being lean
49and nice on resources: for example, you can still configure rxvt-unicode 56and 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 57without 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 58a client/daemon pair that lets you open any number of terminal windows
52from within a single process, which makes startup time very fast and 59from within a single process, which makes startup time very fast and
53drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
54@@RXVT_NAME@@c(1) (client). 61@@RXVT_NAME@@c(1) (client).
55 62
56It also makes technical information about escape sequences (which have 63It also makes technical information about escape sequences (which have
57been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 64been extended) more accessible: see @@RXVT_NAME@@(7) for technical
58reference documentation (escape sequences etc.) and the FAQ section at the 65reference documentation (escape sequences etc.).
59end of this document.
60 66
61=head1 OPTIONS 67=head1 OPTIONS
62 68
63The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed 69The 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 70below. In keeping with the smaller-is-better philosophy, options may be
87 93
88Attempt to open a window on the named X display (B<-d> still 94Attempt to open a window on the named X display (B<-d> still
89respected). In the absence of this option, the display specified by the 95respected). In the absence of this option, the display specified by the
90B<DISPLAY> environment variable is used. 96B<DISPLAY> environment variable is used.
91 97
98=item B<-depth> I<bitdepth>
99
100Compile I<xft>: Attempt to find a visual with the given bit depth;
101resource B<depth>.
102
92=item B<-geometry> I<geom> 103=item B<-geometry> I<geom>
93 104
94Window geometry (B<-g> still respected); resource B<geometry>. 105Window geometry (B<-g> still respected); resource B<geometry>.
95 106
96=item B<-rv>|B<+rv> 107=item B<-rv>|B<+rv>
97 108
98Turn on/off simulated reverse video; resource B<reverseVideo>. 109Turn on/off simulated reverse video; resource B<reverseVideo>.
99 110
100=item B<-j>|B<+j> 111=item B<-j>|B<+j>
101 112
102Turn on/off jump scrolling; resource B<jumpScroll>. 113Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
103 114
104=item B<-ip>|B<+ip> 115=item B<-ss>|B<+ss>
116
117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118
119=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
105 120
106Turn on/off inheriting parent window's pixmap. Alternative form is 121Turn on/off inheriting parent window's pixmap. Alternative form is
107B<-tr>; resource B<inheritPixmap>. 122B<-tr>; resource B<inheritPixmap>.
108 123
124I<Please note that transparency of any kind if completely unsupported by
125the author. Don't bug him with installation questions! Read the FAQ (man 7
126@@RXVT_NAME@@)!>
127
109=item B<-fade> I<number> 128=item B<-fade> I<number>
110 129
111Fade the text by the given percentage when focus is lost. 130Fade the text by the given percentage when focus is lost. Small values
131fade a little only, 100 completely replaces all colours by the fade
132colour; resource B<fading>.
133
134=item B<-fadecolor> I<colour>
135
136Fade to this colour when fading is used (see B<-fade>). The default colour
137is opaque black. resource B<fadeColor>.
112 138
113=item B<-tint> I<colour> 139=item B<-tint> I<colour>
114 140
115Tint the transparent background pixmap with the given colour when 141Tint the transparent background pixmap with the given colour when
116transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> 142transparency is enabled with B<-tr> or B<-ip>. This only works for
117option that can be used to brighten or darken the image in addition to 143non-tiled backgrounds, currently. See also the B<-sh> option that can be
118tinting it. 144used to brighten or darken the image in addition to tinting it; resource
145I<tintColor>. Example:
119 146
120=item B<-sh> 147 @@RXVT_NAME@@ -tr -tint blue -sh 40
121 148
149=item B<-sh> I<number>
150
122I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 151Darken (0 .. 100) or lighten (-1 .. -100) the transparent
123background image in addition to tinting it (i.e. B<-tint> must be 152background image in addition to (or instead of) tinting it;
124specified, too). 153resource I<shading>.
154
155=item B<-blt> I<string>
156
157Specify background blending type. If background pixmap is specified
158at the same time as transparency - such pixmap will be blended over
159transparency image, using method specified. Supported values are :
160B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
161B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
162B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
163alpha-blending; resource I<blendType>.
164
165=item B<-blr> I<number>
166
167Apply Gaussian Blur with the specified radius to the transparent
168background image; resource I<blurRadius>.
125 169
126=item B<-bg> I<colour> 170=item B<-bg> I<colour>
127 171
128Window background colour; resource B<background>. 172Window background colour; resource B<background>.
129 173
131 175
132Window foreground colour; resource B<foreground>. 176Window foreground colour; resource B<foreground>.
133 177
134=item B<-pixmap> I<file[;geom]> 178=item B<-pixmap> I<file[;geom]>
135 179
136Compile I<XPM>: Specify XPM file for the background and also optionally 180Compile I<afterimage>: Specify image file for the background and also
137specify its scaling with a geometry string. Note you may need to add 181optionally specify its scaling with a geometry string. Note you may need to
138quotes to avoid special shell interpretation of the `;' in the 182add quotes to avoid special shell interpretation of the C<;> in the
139command-line; resource B<backgroundPixmap>. 183command-line; for more details see resource B<backgroundPixmap>.
140 184
141=item B<-cr> I<colour> 185=item B<-cr> I<colour>
142 186
143The cursor colour; resource B<cursorColor>. 187The cursor colour; resource B<cursorColor>.
144 188
156resource B<borderColor>. 200resource B<borderColor>.
157 201
158=item B<-fn> I<fontlist> 202=item B<-fn> I<fontlist>
159 203
160Select the fonts to be used. This is a comma separated list of font names 204Select 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 205that are checked in order when trying to find glyphs for characters. The
162first font defines the cell size for characters; other fonts might be 206first font defines the cell size for characters; other fonts might be
163smaller, but not (in general) larger. A reasonable default font list is 207smaller, but not (in general) larger. A (hopefully) reasonable default
164always appended to it. See resource B<font> for details. 208font list is always appended to it. See resource B<font> for more details.
209
210In short, to specify an X11 core font, just specify its name or prefix it
211with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
212e.g.:
213
214 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
215 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
165 216
166See also the question "How does rxvt-unicode choose fonts?" in the FAQ 217See also the question "How does rxvt-unicode choose fonts?" in the FAQ
167section. 218section of @@RXVT_NAME@@(7).
168 219
169=item B<-fb> I<fontlist> 220=item B<-fb> I<fontlist>
170 221
171Compile font-styles: The bold font list to use when bold characters are to 222Compile I<font-styles>: The bold font list to use when B<bold> characters
172be printed. See resource B<boldFont> for details. 223are to be printed. See resource B<boldFont> for details.
173 224
174=item B<-fi> I<fontlist> 225=item B<-fi> I<fontlist>
175 226
176Compile font-styles: The italic font list to use when bold characters are to 227Compile I<font-styles>: The italic font list to use when I<italic>
177be printed. See resource B<italicFont> for details. 228characters are to be printed. See resource B<italicFont> for details.
178 229
179=item B<-fbi> I<fontlist> 230=item B<-fbi> I<fontlist>
180 231
181Compile font-styles: The bold italic font list to use when bold characters are to 232Compile I<font-styles>: The bold italic font list to use when B<< I<bold
182be printed. See resource B<boldItalicFont> for details. 233italic> >> characters are to be printed. See resource B<boldItalicFont>
234for details.
235
236=item B<-is>|B<+is>
237
238Compile I<font-styles>: Bold/Italic font styles imply high intensity
239foreground/background (default). See resource B<intensityStyles> for
240details.
183 241
184=item B<-name> I<name> 242=item B<-name> I<name>
185 243
186Specify the application name under which resources are to be obtained, 244Specify the application name under which resources are to be obtained,
187rather than the default executable file name. Name should not contain 245rather than the default executable file name. Name should not contain
225 283
226Put scrollbar on right/left; resource B<scrollBar_right>. 284Put scrollbar on right/left; resource B<scrollBar_right>.
227 285
228=item B<-st>|B<+st> 286=item B<-st>|B<+st>
229 287
230Display normal (non XTerm/NeXT) scrollbar without/with a trough; 288Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
231resource B<scrollBar_floating>. 289resource B<scrollBar_floating>.
290
291=item B<-ptab>|B<+ptab>
292
293If enabled (default), "Horizontal Tab" characters are being stored as
294actual wide characters in the screen buffer, which makes it possible to
295select and paste them. Since a horizontal tab is a cursor movement and
296not an actual glyph, this can sometimes be visually annoying as the cursor
297on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
232 298
233=item B<-bc>|B<+bc> 299=item B<-bc>|B<+bc>
234 300
235Blink the cursor; resource B<cursorBlink>. 301Blink the cursor; resource B<cursorBlink>.
236 302
259 325
260Compile I<frills>: Set MWM hints to request a borderless window, i.e. 326Compile 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 327if honoured by the WM, the rxvt-unicode window will not have window
262decorations; resource B<borderLess>. 328decorations; resource B<borderLess>.
263 329
330=item B<-override-redirect>
331
332Compile I<frills>: Sets override-redirect on the window; resource
333B<override-redirect>.
334
335=item B<-sbg>
336
337Compile I<frills>: Disable the usage of the built-in block graphics/line
338drawing characters and just rely on what the specified fonts provide. Use
339this if you have a good font and want to use its block graphic glyphs;
340resource B<skipBuiltinGlyphs>.
341
264=item B<-lsp> I<number> 342=item B<-lsp> I<number>
265 343
266Compile I<linespace>: Lines (pixel height) to insert between each row 344Compile I<frills>: Lines (pixel height) to insert between each row of
267of the display; resource B<linespace>. 345the display. Useful to work around font rendering problems; resource
346B<linespace>.
268 347
269=item B<-tn> I<termname> 348=item B<-tn> I<termname>
270 349
271This option specifies the name of the terminal type to be set in the 350This option specifies the name of the terminal type to be set in the
272B<TERM> environment variable. This terminal type must exist in the 351B<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 360given 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 361on 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, 362run the program specified by the B<SHELL> environment variable or,
284failing that, I<sh(1)>. 363failing that, I<sh(1)>.
285 364
365Please note that you must specify a program with arguments. If you want to
366run shell commands, you have to specify the shell, like this:
367
368 @@RXVT_NAME@@ -e sh -c "shell commands"
369
286=item B<-title> I<text> 370=item B<-title> I<text>
287 371
288Window title (B<-T> still respected); the default title is the basename 372Window title (B<-T> still respected); the default title is the basename
289of the program specified after the B<-e> option, if any, otherwise the 373of the program specified after the B<-e> option, if any, otherwise the
290application name; resource B<title>. 374application name; resource B<title>.
308 392
309Compile I<XIM>: input method name. resource B<inputMethod>. 393Compile I<XIM>: input method name. resource B<inputMethod>.
310 394
311=item B<-imlocale> I<string> 395=item B<-imlocale> I<string>
312 396
313The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 397The 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 398C<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 399input extension to be able to input japanese characters while staying in
316another locale. 400another locale. resource B<imLocale>.
401
402=item B<-imfont> I<fontset>
403
404Set the font set to use for the X Input Method, see resource B<imFont>
405for more info.
406
407=item B<-tcw>
408
409Change the meaning of triple-click selection with the left mouse
410button. Only effective when the original (non-perl) selection code is
411in-use. Instead of selecting a full line it will extend the selection the
412end of the logical line only. resource B<tripleclickwords>.
317 413
318=item B<-insecure> 414=item B<-insecure>
319 415
320Enable "insecure" mode, which currently enables most of the escape 416Enable "insecure" mode, which currently enables most of the escape
321sequences that echo strings. See the resource B<insecure> for more 417sequences that echo strings. See the resource B<insecure> for more
335=item B<-ssr>|B<+ssr> 431=item B<-ssr>|B<+ssr>
336 432
337Turn on/off secondary screen scroll (default enabled); resource 433Turn on/off secondary screen scroll (default enabled); resource
338B<secondaryScroll>. 434B<secondaryScroll>.
339 435
436=item B<-hold>|B<+hold>
437
438Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
439will not immediately destroy its window when the program executed within
440it exits. Instead, it will wait till it is being killed or closed by the
441user; resource B<hold>.
442
443=item B<-keysym.>I<sym> I<string>
444
445Remap a key symbol. See resource B<keysym>.
446
447=item B<-embed> I<windowid>
448
449Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
450which enables applications to easily embed a terminal.
451
452Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
453shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
454quite a bit, so don't expect it to keep some specific state. It's best to
455create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
456
457The window will not be destroyed when @@RXVT_NAME@@ exits.
458
459It might be useful to know that @@RXVT_NAME@@ will not close file
460descriptors passed to it (except for stdin/out/err, of course), so you
461can use file descriptors to communicate with the programs within the
462terminal. This works regardless of whether the C<-embed> option was used or
463not.
464
465Here is a short Gtk2-perl snippet that illustrates how this option can be
466used (a longer example is in F<doc/embed>):
467
468 my $rxvt = new Gtk2::Socket;
469 $rxvt->signal_connect_after (realize => sub {
470 my $xid = $_[0]->window->get_xid;
471 system "@@RXVT_NAME@@ -embed $xid &";
472 });
473
474=item B<-pty-fd> I<file descriptor>
475
476Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
477pair but instead use the given file descriptor as the tty master. This is
478useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
479without having to run a program within it.
480
481If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
482entries and will not tinker with pty/tty permissions - you have to do that
483yourself if you want that.
484
485As an extremely special case, specifying C<-1> will completely suppress
486pty/tty operations.
487
488Here is a example in perl that illustrates how this option can be used (a
489longer example is in F<doc/pty-fd>):
490
491 use IO::Pty;
492 use Fcntl;
493
494 my $pty = new IO::Pty;
495 fcntl $pty, F_SETFD, 0; # clear close-on-exec
496 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
497 close $pty;
498
499 # now communicate with rxvt
500 my $slave = $pty->slave;
501 while (<$slave>) { print $slave "got <$_>\n" }
502
340=item B<-xrm> I<resourcestring> 503=item B<-pe> I<string>
341 504
342No effect on rxvt-unicode. Simply passes through an argument to be made 505Comma-separated list of perl extension scripts to use (or not to use) in
343available in the instance's argument list. Appears in I<WM_COMMAND> in 506this terminal instance. See resource B<perl-ext> for details.
344some window managers.
345 507
346=back 508=back
347 509
348=head1 RESOURCES (available also as long-options) 510=head1 RESOURCES (available also as long-options)
349 511
350Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 512Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
351options) compiled into your version. 513options) compiled into your version.
352 514
353There are two different methods that @@RXVT_NAME@@ can use to get the 515You can set and change the resources using X11 tools like B<xrdb>. Many
354Xresource data: using the X libraries (Xrm*-functions) or internal 516distribution do also load settings from the B<~/.Xresources> file when X
355Xresources reader (B<~/.Xdefaults>). For the first method (ie. 517starts. @@RXVT_NAME@@ will consult the following files/resources in order,
356B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 518with 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 519
360If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 520 1. system-wide app-defaults file, either locale-dependent OR global
361lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 521 2. app-defaults file in $XAPPLRESDIR
362set in XAPPLOADDIR/URxvt (compile-time defined: usually 522 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
363B</usr/lib/X11/app-defaults/URxvt>) and resources set in 523 4. SCREEN_RESOURCES for the current screen
364B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist. 524 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
525
365Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 526Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
366class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 527names: 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 528common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
368easily configured, while the class name B<URxvt> allows resources 529configured, while the class name B<URxvt> allows resources unique to
369unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 530B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
370shared between different B<@@RXVT_NAME@@> configurations. If no 531configurations. If no resources are specified, suitable defaults will
371resources are specified, suitable defaults will be used. Command-line 532be used. Command-line arguments can be used to override resource
372arguments can be used to override resource settings. The following 533settings. The following resources are supported (you might want to
373resources are allowed: 534check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
535extensions not documented here):
374 536
375=over 4 537=over 4
538
539=item B<depth:> I<bitdepth>
540
541Compile I<xft>: Attempt to find a visual with the given bit depth;
542option B<-depth>.
376 543
377=item B<geometry:> I<geom> 544=item B<geometry:> I<geom>
378 545
379Create the window with the specified X window geometry [default 80x24]; 546Create the window with the specified X window geometry [default 80x24];
380option B<-geometry>. 547option B<-geometry>.
408 575
409=item B<colorIT:> I<colour> 576=item B<colorIT:> I<colour>
410 577
411Use the specified colour to display bold or italic characters when the 578Use the specified colour to display bold or italic characters when the
412foreground colour is the default. If font styles are not available 579foreground colour is the default. If font styles are not available
413(Compile styles) and this option is unset, reverse video is used instead. 580(Compile I<styles>) and this option is unset, reverse video is used instead.
414 581
415=item B<colorUL:> I<colour> 582=item B<colorUL:> I<colour>
416 583
417Use the specified colour to display underlined characters when the 584Use the specified colour to display underlined characters when the
418foreground colour is the default. 585foreground colour is the default.
419 586
420=item B<colorRV:> I<colour> 587=item B<colorRV:> I<colour>
421 588
422Use the specified colour as the background for reverse video 589Use the specified colour as the background for reverse video characters
423characters. 590when OPTION_HC is disabled (--disable-frills).
591
592=item B<underlineColor:> I<colour>
593
594If set, use the specified colour as the colour for the underline
595itself. If unset, use the foreground colour.
424 596
425=item B<cursorColor:> I<colour> 597=item B<cursorColor:> I<colour>
426 598
427Use the specified colour for the cursor. The default is to use the 599Use the specified colour for the cursor. The default is to use the
428foreground colour; option B<-cr>. 600foreground colour; option B<-cr>.
439option B<-rv>. B<False>: regular screen colours [default]; option 611option B<-rv>. B<False>: regular screen colours [default]; option
440B<+rv>. See note in B<COLORS AND GRAPHICS> section. 612B<+rv>. See note in B<COLORS AND GRAPHICS> section.
441 613
442=item B<jumpScroll:> I<boolean> 614=item B<jumpScroll:> I<boolean>
443 615
444B<True>: specify that jump scrolling should be used. When scrolling 616B<True>: specify that jump scrolling should be used. When receiving lots
445quickly, fewer screen updates are performed [default]; option B<-j>. 617of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
618has been read, resulting in fewer updates while still displaying every
619received line; option B<-j>.
620
446B<False>: specify that smooth scrolling should be used; option B<+j>. 621B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
622force a screen refresh on each new line it received; option B<+j>.
623
624=item B<skipScroll:> I<boolean>
625
626B<True>: (the default) specify that skip scrolling should be used. When
627receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
628(around 60 times per second), resulting in far fewer updates. This can
629result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
630option B<-ss>.
631
632B<False>: specify that everything is to be displayed, even
633if the refresh is too fast for the human eye to read anything (or the
634monitor to display anything); option B<+ss>.
447 635
448=item B<inheritPixmap:> I<boolean> 636=item B<inheritPixmap:> I<boolean>
449 637
450B<True>: make the background inherit the parent windows' pixmap, giving 638B<True>: make the background inherit the parent windows' pixmap, giving
451artificial transparency. B<False>: do not inherit the parent windows' 639artificial transparency. B<False>: do not inherit the parent windows'
452pixmap. 640pixmap.
453 641
642I<Please note that transparency of any kind if completely unsupported by
643the author. Don't bug him with installation questions!>
644
454=item B<fading:> I<number> 645=item B<fading:> I<number>
455 646
456Fade the text by the given percentage when focus is lost. 647Fade the text by the given percentage when focus is lost; option B<-fade>.
648
649=item B<fadeColor:> I<colour>
650
651Fade to this colour, when fading is used (see B<fading:>). The default
652colour is black; option B<-fadecolor>.
457 653
458=item B<tintColor:> I<colour> 654=item B<tintColor:> I<colour>
459 655
460Tint the transparent background pixmap with the given colour. 656Tint the transparent background pixmap with the given colour; option
657B<-tint>.
461 658
462=item B<shading:> I<number> 659=item B<shading:> I<number>
463 660
464Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 661Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
465image in addition to tinting it. 662in addition to tinting it; option B<-sh>.
466 663
664=item B<blendType:> I<string>
665
666Specify background blending type; option B<-blt>.
667
467=item B<fading:> I<number> 668=item B<blurRadius:> I<number>
468 669
469Scale the tint colour by the given percentage. 670Apply Gaussian Blurr with the specified radius to the transparent
671background image; option B<-blr>.
470 672
471=item B<scrollColor:> I<colour> 673=item B<scrollColor:> I<colour>
472 674
473Use the specified colour for the scrollbar [default #B2B2B2]. 675Use the specified colour for the scrollbar [default #B2B2B2].
474 676
475=item B<troughColor:> I<colour> 677=item B<troughColor:> I<colour>
476 678
477Use the specified colour for the scrollbar's trough area [default 679Use the specified colour for the scrollbar's trough area [default
478#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 680#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
479 681
480=item B<borderColor:> I<colour> 682=item B<borderColor:> I<colour>
481 683
482The colour of the border around the text area and between the scrollbar 684The colour of the border around the text area and between the scrollbar
483and the text. 685and the text.
484 686
485=item B<backgroundPixmap:> I<file[;geom]> 687=item B<backgroundPixmap:> I<file[;geom]>
486 688
487Use the specified XPM file (note the `.xpm' extension is optional) for 689Use the specified image file for the background and also optionally
488the background and also optionally specify its scaling with a geometry 690specify its scaling with a geometry string B<WxH+X+Y>,
489string B<WxH+X+Y>, in which B<"W" / "H"> specify the 691in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
490horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 692and B<"X" / "Y"> locate the image centre (percent).
491centre (percent). A scale of 0 displays the image with tiling. A scale 693A scale of 0 displays the image with tiling. A scale of 1 displays the
492of 1 displays the image without any scaling. A scale of 2 to 9 694image without any scaling. A scale of 2 to 9 specifies an integer
493specifies an integer number of images in that direction. No image will 695number of images in that direction. No image will be magnified beyond
494be magnified beyond 10 times its original size. The maximum permitted 69610 times its original size. The maximum permitted scale is 1000.
495scale is 1000. [default 0x0+50+50] 697Special string of B<"auto"> used as a geometry will cause image to be
496 698automatically scaled to match window size.
497=item B<menu:> I<file[;tag]> 699If used in conjunction with B<-tr> option - specified pixmap will be
498 700blended over transparency image using either alpha-blending, or any
499Read in the specified menu file (note the `.menu' extension is 701other blending type, specified with B<-blt "type"> option.
500optional) and also optionally specify a starting tag to find. See the 702[default 0x0+50+50]
501reference documentation for details on the syntax for the menuBar.
502 703
503=item B<path:> I<path> 704=item B<path:> I<path>
504 705
505Specify the colon-delimited search path for finding files (XPM and 706Specify the colon-delimited search path for finding XPM files.
506menus), in addition to the paths specified by the B<RXVTPATH> and
507B<PATH> environment variables.
508 707
509=item B<font:> I<fontlist> 708=item B<font:> I<fontlist>
510 709
511Select the fonts to be used. This is a comma separated list of font 710Select 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. 711that are checked in order when trying to find glyphs for characters. The
513The first font defines the cell size for characters; other fonts might 712first font defines the cell size for characters; other fonts might be
514be smaller, but not larger. A reasonable default font list is always 713smaller, but not (in general) larger. A (hopefully) reasonable default
515appended to it. option B<-fn>. 714font list is always appended to it; option B<-fn>.
516 715
517Each font can either be a standard X11 core font (XLFD) name, with 716Each 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:>. 717optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
519 718
520In addition, each font can be prefixed with additional hints and 719In addition, each font can be prefixed with additional hints and
521specifications enclosed in square brackets (C<[]>). The only available 720specifications enclosed in square brackets (C<[]>). The only available
522hint currently is C<codeset=codeset-name>, and this is only used for Xft 721hint currently is C<codeset=codeset-name>, and this is only used for Xft
523fonts. 722fonts.
524 723
525For example, this font resource 724For example, this font resource
526 725
527 URxvt*font: 9x15bold,\ 726 URxvt.font: 9x15bold,\
528 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 727 -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, \ 728 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
530 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 729 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
531 xft:Code2000:antialias=false 730 xft:Code2000:antialias=false
532 731
533specifies five fonts to be used. The first one is C<9x15bold> (actually 732specifies 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 733the 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 734it is named first) and thus defines the character cell grid to be 9 pixels
536wide and 15 pixels high. 735wide and 15 pixels high.
537 736
538the second font is just used to add additional unicode characters not in 737The second font is just used to add additional unicode characters not in
539the base font, likewise the third, which is unfortunately non-bold, but 738the 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 739the bold version of the font does contain less characters, so this is a
541useful supplement. 740useful supplement.
542 741
543The third font is an Xft font with aliasing turned off, and the characters 742The third font is an Xft font with aliasing turned off, and the characters
566not possible, replacement fonts of the desired shape will be tried. 765not possible, replacement fonts of the desired shape will be tried.
567 766
568If set, but empty, then this specific style is disabled and the normal 767If set, but empty, then this specific style is disabled and the normal
569text font will being used for the given style. 768text font will being used for the given style.
570 769
770=item B<intensityStyles:> I<boolean>
771
772When font styles are not enabled, or this option is enabled (B<True>,
773option B<-is>, the default), bold and italic font styles imply high
774intensity foreground/background colours. Disabling this option (B<False>,
775option B<+is>) disables this behaviour, the high intensity colours are not
776reachable.
777
571=item B<selectstyle:> I<mode> 778=item B<selectstyle:> I<mode>
572 779
573Set mouse selection style to B<old> which is 2.20, B<oldword> which is 780Set mouse selection style to B<old> which is 2.20, B<oldword> which
574xterm style with 2.20 old word selection, or anything else which gives 781is xterm style with 2.20 old word selection, or anything else which
575xterm style selection. 782gives xterm style selection. Only effective when the original (non-perl)
783selection code is in use.
576 784
577=item B<scrollstyle:> I<mode> 785=item B<scrollstyle:> I<mode>
578 786
579Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 787Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
580the author's favourite.. 788the author's favourite.
581 789
582=item B<title:> I<string> 790=item B<title:> I<string>
583 791
584Set window title string, the default title is the command-line 792Set window title string, the default title is the command-line
585specified after the B<-e> option, if any, otherwise the application 793specified after the B<-e> option, if any, otherwise the application
594=item B<mapAlert:> I<boolean> 802=item B<mapAlert:> I<boolean>
595 803
596B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 804B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
597de-iconify (map) on receipt of a bell character [default]. 805de-iconify (map) on receipt of a bell character [default].
598 806
807=item B<urgentOnBell:> I<boolean>
808
809B<True>: set the urgency hint for the wm on receipt of a bell character.
810B<False>: do not set the urgency hint [default].
811
599=item B<visualBell:> I<boolean> 812=item B<visualBell:> I<boolean>
600 813
601B<True>: use visual bell on receipt of a bell character; option B<-vb>. 814B<True>: use visual bell on receipt of a bell character; option B<-vb>.
602B<False>: no visual bell [default]; option B<+vb>. 815B<False>: no visual bell [default]; option B<+vb>.
603 816
617 830
618Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 831Specify 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 832B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
620B<Shift-Print> to include the scrollback as well. 833B<Shift-Print> to include the scrollback as well.
621 834
835The string will be interpreted as if typed into the shell as-is.
836
837Example:
838
839 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
840
841This creates a new file in your home directory with the screen contents
842every time you hit C<Print>.
843
622=item B<scrollBar:> I<boolean> 844=item B<scrollBar:> I<boolean>
623 845
624B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 846B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
625disable the scrollbar; option B<+sb>. 847disable the scrollbar; option B<+sb>.
626 848
645B<False>: do not scroll to bottom when tty receives output; option 867B<False>: do not scroll to bottom when tty receives output; option
646B<+si>. 868B<+si>.
647 869
648=item B<scrollWithBuffer:> I<boolean> 870=item B<scrollWithBuffer:> I<boolean>
649 871
650B<True>: scroll with scrollback buffer when tty recieves new lines (and 872B<True>: scroll with scrollback buffer when tty receives new lines (and
651B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 873B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
652with scrollback buffer when tty recieves new lines; option B<-sw>. 874with scrollback buffer when tty receives new lines; option B<+sw>.
653 875
654=item B<scrollTtyKeypress:> I<boolean> 876=item B<scrollTtyKeypress:> I<boolean>
655 877
656B<True>: scroll to bottom when a non-special key is pressed. Special keys 878B<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 879are those which are intercepted by rxvt-unicode for special handling and
676=item B<borderLess:> I<boolean> 898=item B<borderLess:> I<boolean>
677 899
678Set MWM hints to request a borderless window, i.e. if honoured by the 900Set 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>. 901WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
680 902
903=item B<skipBuiltinGlyphs:> I<boolean>
904
905Compile I<frills>: Disable the usage of the built-in block graphics/line
906drawing characters and just rely on what the specified fonts provide. Use
907this if you have a good font and want to use its block graphic glyphs;
908option B<-sbg>.
909
681=item B<termName:> I<termname> 910=item B<termName:> I<termname>
682 911
683Specifies the terminal type name to be set in the B<TERM> environment 912Specifies the terminal type name to be set in the B<TERM> environment
684variable; option B<-tn>. 913variable; option B<-tn>.
685 914
695 924
696=item B<mouseWheelScrollPage:> I<boolean> 925=item B<mouseWheelScrollPage:> I<boolean>
697 926
698B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel 927B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
699scrolls five lines [default]. 928scrolls five lines [default].
929
930=item B<pastableTabs:> I<boolean>
931
932B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
933movement only; option C<-ptab>.
700 934
701=item B<cursorBlink:> I<boolean> 935=item B<cursorBlink:> I<boolean>
702 936
703B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 937B<True>: blink the cursor. B<False>: do not blink the cursor [default];
704option B<-bc>. 938option B<-bc>.
717 951
718Mouse pointer background colour. 952Mouse pointer background colour.
719 953
720=item B<pointerBlankDelay:> I<number> 954=item B<pointerBlankDelay:> I<number>
721 955
722Specifies number of seconds before blanking the pointer [default 2]. 956Specifies number of seconds before blanking the pointer [default 2]. Use a
957large number (e.g. C<987654321>) to effectively disable the timeout.
723 958
724=item B<backspacekey:> I<string> 959=item B<backspacekey:> I<string>
725 960
726The string to send when the backspace key is pressed. If set to B<DEC> 961The 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> 962or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
734pressed. If unset it will send the sequence traditionally associated 969pressed. If unset it will send the sequence traditionally associated
735with the B<Execute> key. 970with the B<Execute> key.
736 971
737=item B<cutchars:> I<string> 972=item B<cutchars:> I<string>
738 973
739The characters used as delimiters for double-click word selection. The 974The characters used as delimiters for double-click word selection
740built-in default: 975(whitespace delimiting is added automatically if resource is given).
976
977When the perl selection extension is in use (the default if compiled
978in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
979characters will be created (if the resource exists, otherwise, no regex
980will be created). In this mode, characters outside ISO-8859-1 can be used.
981
982When the selection extension is not used, only ISO-8859-1 characters can
983be used. If not specified, the built-in default is used:
741 984
742B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 985B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
743 986
744=item B<preeditType:> I<style> 987=item B<preeditType:> I<style>
745 988
749 992
750I<name> of inputMethod to use; option B<-im>. 993I<name> of inputMethod to use; option B<-im>.
751 994
752=item B<imLocale:> I<name> 995=item B<imLocale:> I<name>
753 996
754The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 997The 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 998C<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 999input extension to be able to input japanese characters while staying in
757another locale. option B<-imlocale>. 1000another locale; option B<-imlocale>.
1001
1002=item B<imFont:> I<fontset>
1003
1004Specify the font-set used for XIM styles C<OverTheSpot> or
1005C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
1006by commas), i.e. it's not in the same format as the other font lists used
1007in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
1008found, preferably one or two pixels differing in size to the base font.
1009option B<-imfont>.
1010
1011=item B<tripleclickwords:> I<boolean>
1012
1013Change the meaning of triple-click selection with the left mouse
1014button. Instead of selecting a full line it will extend the selection to
1015the end of the logical line only; option B<-tcw>.
758 1016
759=item B<insecure:> I<boolean> 1017=item B<insecure:> I<boolean>
760 1018
761Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1019Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
762echo arbitrary strings like the icon name or the locale. This could be 1020echo arbitrary strings like the icon name or the locale. This could be
763abused if somebody gets 8-bit-clean access to your display, wether 1021abused if somebody gets 8-bit-clean access to your display, whether
764throuh a mail client displaying mail bodies unfiltered or though 1022through a mail client displaying mail bodies unfiltered or through
765write(1). Therefore, these sequences are disabled by default. (Note 1023write(1) or any other means. Therefore, these sequences are disabled by
766that other terminals, including xterm, have these sequences 1024default. (Note that many other terminals, including xterm, have these
767enabled by default). You can enable them by setting this boolean 1025sequences enabled by default, which doesn't make it safer, though).
768resource or specifying B<-insecure> as an option. At the moment, this 1026
769enabled display-answer, locale, findfont, icon label and window title 1027You can enable them by setting this boolean resource or specifying
770requests as well as dynamic menubar dispatch. 1028B<-insecure> as an option. At the moment, this enables display-answer,
1029locale, findfont, icon label and window title requests.
771 1030
772=item B<modifier:> I<modifier> 1031=item B<modifier:> I<modifier>
773 1032
774Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 1033Set 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 1034B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
779 1038
780Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1039Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
781character is passed through. It may contain escape values as described 1040character is passed through. It may contain escape values as described
782in the entry on B<keysym> following. 1041in the entry on B<keysym> following.
783 1042
784=item B<secondaryScreen:> I<bool> 1043=item B<secondaryScreen:> I<boolean>
785 1044
786Turn on/off secondary screen (default enabled). 1045Turn on/off secondary screen (default enabled).
787 1046
788=item B<secondaryScroll:> I<bool> 1047=item B<secondaryScroll:> I<boolean>
789 1048
790Turn on/off secondary screen scroll (default enabled). If the this 1049Turn on/off secondary screen scroll (default enabled). If this
791option is enabled, scrolls on the secondary screen will change the 1050option is enabled, scrolls on the secondary screen will change the
792scrollback buffer and switching to/from the secondary screen will 1051scrollback buffer and switching to/from the secondary screen will
793instead scroll the screen up. 1052instead scroll the screen up.
794 1053
1054=item B<hold>: I<boolean>
1055
1056Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1057will not immediately destroy its window when the program executed within
1058it exits. Instead, it will wait till it is being killed or closed by the
1059user.
1060
795=item B<keysym.>I<sym>: I<string> 1061=item B<keysym.>I<sym>: I<string>
796 1062
797Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 1063Compile I<frills>: Associate I<string> with keysym I<sym>. The
798contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 1064intervening resource name B<keysym.> cannot be omitted.
799newline, \r: return, \t: 1065
1066The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
1067any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
1068B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
1069and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
1070B<2>, B<3>, B<4>, B<5>.
1071
1072The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1073whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1074keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1075current application keymap mode state.
1076
1077The spellings of I<key> can be obtained by using B<xev>(1) command or
1078searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1079omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1080keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1081performed in an exact manner; however, the closest match is assured.
1082
1083I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
1084C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
800tab, \000: octal number) or control characters (^?: delete, ^@: null, 1085C<\000>: octal number) or verbatim control characters (C<^?>: delete,
801^A ...) and may enclosed with double quotes so that it can start or end 1086C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
802with whitespace. The intervening resource name B<keysym.> cannot be 1087can start or end with whitespace. B<This feature is deprecated and will
803omitted. This resource is only available when compiled with 1088be removed>.
804KEYSYM_RESOURCE. 1089
1090Please note that you need to double the C<\> in resource files, as
1091Xlib itself does its own de-escaping (you can use C<\033> instead of
1092C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1093processing).
1094
1095You can define a range of keysyms in one shot by providing a I<string>
1096with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1097should be a character not used by the strings.
1098
1099Its usage can be demonstrated by an example:
1100
1101 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1102
1103The above line is equivalent to the following three lines:
1104
1105 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
1106 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
1107 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
1108
1109If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1110is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1111example the following means "change the current locale to C<zh_CN.GBK>
1112when Control-Meta-c is being pressed":
1113
1114 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1115
1116If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1117is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1118manpage. For example, the F<selection> extension (activated via
1119C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1120
1121 URxvt.keysym.M-C-c: perl:selection:rot13
1122
1123Due the the large number of modifier combinations, a defined key mapping
1124will match if at I<at least> the specified identifiers are being set, and
1125no other key mappings with those and more bits are being defined. That
1126means that defining a key map for C<a> will automatically provide
1127definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1128mappings themselves.
1129
1130Unfortunately, this will override built-in key mappings. For example
1131if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1132C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1133user-defined keymap using the C<builtin:> replacement:
1134
1135 URxvt.keysym.Insert: <my insert key sequence>
1136 URxvt.keysym.S-Insert: builtin:
1137
1138The first line defines a mapping for C<Insert> and I<any> combination
1139of modifiers. The second line re-establishes the default mapping for
1140C<Shift-Insert>.
1141
1142The following example will map Control-Meta-1 and Control-Meta-2 to
1143the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1144font-switching at runtime:
1145
1146 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1147 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1148
1149Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1150info):
1151
1152 URxvt.keysym.M-C-3: command:\033[8;25;80t
1153 URxvt.keysym.M-C-4: command:\033[8;48;110t
1154
1155=item B<perl-ext-common>: I<string>
1156
1157=item B<perl-ext>: I<string>
1158
1159Comma-separated list(s) of perl extension scripts (default: C<default>) to
1160use in this terminal instance; option B<-pe>.
1161
1162Extension names can be prefixed with a C<-> sign to prohibit using
1163them. This can be useful to selectively disable some extensions loaded
1164by default, or specified via the C<perl-ext-common> resource. For
1165example, C<default,-selection> will use all the default extension except
1166C<selection>.
1167
1168Extension names can also be followed by an argument in angle brackets
1169(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1170searchable scrollback to Alt/Meta-s). Mentioning the same extension
1171multiple times with different arguments will pass multiple arguments to
1172the extension.
1173
1174Each extension is looked up in the library directories, loaded if
1175necessary, and bound to the current terminal instance.
1176
1177If both of these resources are the empty string, then the perl
1178interpreter will not be initialized. The idea behind two options is that
1179B<perl-ext-common> will be used for extensions that should be available to
1180all instances, while B<perl-ext> is used for specific instances.
1181
1182=item B<perl-eval>: I<string>
1183
1184Perl code to be evaluated when all extensions have been registered. See
1185the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1186will be ignored when running setuid/setgid.
1187
1188=item B<perl-lib>: I<path>
1189
1190Colon-separated list of additional directories that hold extension
1191scripts. When looking for extensions specified by the C<perl> resource,
1192@@RXVT_NAME@@ will first look in these directories and then in
1193F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1194will be ignored when running setuid/setgid.
1195
1196See the @@RXVT_NAME@@perl(3) manpage.
1197
1198=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1199
1200Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1201details.
1202
1203=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1204
1205Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1206for details.
1207
1208=item B<searchable-scrollback:> I<keysym>
1209
1210Sets the hotkey that starts the incremental scrollback buffer search
1211(default: C<M-s>).
1212
1213=item B<urlLauncher>: I<string>
1214
1215Specifies the program to be started with a URL argument. Used by the
1216C<selection-popup> and C<matcher> perl extensions.
1217
1218=item B<transient-for>: I<windowid>
1219
1220Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1221
1222=item B<override-redirect>: I<boolean>
1223
1224Compile I<frills>: Sets override-redirect for the terminal window, making
1225it almost invisible to window managers; option B<-override-redirect>.
1226
1227=item B<iso14755_52:> I<boolean>
1228
1229Turn on/off ISO 14755 5.2 mode (default enabled).
805 1230
806=back 1231=back
807 1232
808=head1 THE SCROLLBAR 1233=head1 THE SCROLLBAR
809 1234
823the normal text selection/insertion, hold either the Shift or the Meta 1248the normal text selection/insertion, hold either the Shift or the Meta
824(Alt) key while performing the desired mouse action. 1249(Alt) key while performing the desired mouse action.
825 1250
826If mouse reporting mode is active, the normal scrollbar actions are 1251If mouse reporting mode is active, the normal scrollbar actions are
827disabled -- on the assumption that we are using a fullscreen 1252disabled -- on the assumption that we are using a fullscreen
828application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1253application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
829(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1254(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), 1255up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
831respectively. 1256respectively.
832 1257
833=head1 TEXT SELECTION AND INSERTION 1258=head1 THE SELECTION: SELECTING AND PASTING TEXT
834 1259
835The behaviour of text selection and insertion mechanism is similar to 1260The behaviour of text selection and insertion/pasting mechanism is similar
836I<xterm>(1). 1261to I<xterm>(1).
837 1262
838=over 4 1263=over 4
839 1264
840=item B<Selection>: 1265=item B<Selecting>:
841 1266
842Left click at the beginning of the region, drag to the end of the 1267Left 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 1268and release; Right click to extend the marked region; Left double-click
844double-click to select a word; Left triple-click to select the entire 1269to select a word; Left triple-click to select the entire logical line
845line. 1270(which can span multiple screen lines), unless modified by resource
1271B<tripleclickwords>.
846 1272
1273Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1274(Compile: I<frills>) will create a rectangular selection instead of a
1275normal one. In this mode, every selected row becomes its own line in the
1276selection, and trailing whitespace is visually underlined and removed from
1277the selection.
1278
847=item B<Insertion>: 1279=item B<Pasting>:
848 1280
849Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1281Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
850an B<@@RXVT_NAME@@> window causes the current text selection to be 1282window causes the value of the PRIMARY selection (or CLIPBOARD with the
851inserted as if it had been typed on the keyboard. 1283B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1284
1285Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1286inserted too.
852 1287
853=back 1288=back
854 1289
855=head1 CHANGING FONTS 1290=head1 CHANGING FONTS
856 1291
857Changing fonts (or font sizes, respectively) via the keypad is not yet 1292Changing fonts (or font sizes, respectively) via the keypad is not yet
858supported in rxvt-unicode. Bug me if you need this. 1293supported in rxvt-unicode. Bug me if you need this.
859 1294
860You can, however, switch fonts at runtime using escape sequences (and 1295You can, however, switch fonts at runtime using escape sequences, e.g.:
861therefore using the menubar), e.g.:
862 1296
863 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1297 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1298
1299You can use keyboard shortcuts, too:
1300
1301 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1302 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
864 1303
865rxvt-unicode will automatically re-apply these fonts to the output so far. 1304rxvt-unicode will automatically re-apply these fonts to the output so far.
866 1305
867=head1 ISO 14755 SUPPORT 1306=head1 ISO 14755 SUPPORT
868 1307
869ISO 14755 is a standard for entering and viewing unicode characters 1308ISO 14755 is a standard for entering and viewing unicode characters
870and character codes using the keyboard. It consists of 4 parts. The 1309and character codes using the keyboard. It consists of 4 parts. The
871first part is available rxvt-unicode has been compiled with 1310first part is available if rxvt-unicode has been compiled with
872C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1311C<--enable-frills>, the rest is available when rxvt-unicode was compiled
873with C<--enable-iso14755>. 1312with C<--enable-iso14755>.
874 1313
875=over 4 1314=over 4
876 1315
877=item 5.1: Basic method 1316=item * 5.1: Basic method
878 1317
879This allows you to enter unicode characters using their hexcode. 1318This allows you to enter unicode characters using their hexcode.
880 1319
881Start by pressing and holding both C<Control> and C<Shift>, then enter 1320Start 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 1321hex-digits (between one and six). Releasing C<Control> and C<Shift> will
889address, which you cannot type. Fortunately, the card has the e-mail 1328address, 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 1329address 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>, 1330by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
892followed by releasing the modifier keys. 1331followed by releasing the modifier keys.
893 1332
894=item 5.2: Keyboard symbols entry method 1333=item * 5.2: Keyboard symbols entry method
895 1334
896This mode lets you input characters representing the keycap symbols of 1335This mode lets you input characters representing the keycap symbols of
897your keyboard, if representable in the current locale encoding. 1336your keyboard, if representable in the current locale encoding.
898 1337
899Start by pressing C<Control> and C<Shift> together, then releasing 1338Start by pressing C<Control> and C<Shift> together, then releasing
900them. The next special key (cursor keys, home etc.) you enter will not 1339them. The next special key (cursor keys, home etc.) you enter will not
901invoke it's usual function but instead will insert the corresponding 1340invoke its usual function but instead will insert the corresponding
902keycap symbol. The symbol will only be entered when the key has been 1341keycap symbol. The symbol will only be entered when the key has been
903released, otherwise pressing e.g. C<Shift> would enter the symbol for 1342released, 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 1343C<ISO Level 2 Switch>, although your intention might have been to enter a
905reverse tab (Shift-Tab). 1344reverse tab (Shift-Tab).
906 1345
907=item 5.3: Screen-selection entry method 1346=item * 5.3: Screen-selection entry method
908 1347
909While this is implemented already (it's basically the selection 1348While this is implemented already (it's basically the selection
910mechanism), it could be extended by displaying a unicode character map. 1349mechanism), it could be extended by displaying a unicode character map.
911 1350
912=item 5.4: Feedback method for identifying displayed characters for later input 1351=item * 5.4: Feedback method for identifying displayed characters for later input
913 1352
914This method lets you display the unicode character code associated with 1353This method lets you display the unicode character code associated with
915characters already displayed. 1354characters already displayed.
916 1355
917You enter this mode by holding down C<Control> and C<Shift> together, then 1356You 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 1368With respect to conformance, rxvt-unicode is supposed to be compliant to
930both scenario A and B of ISO 14755, including part 5.2. 1369both scenario A and B of ISO 14755, including part 5.2.
931 1370
932=head1 LOGIN STAMP 1371=head1 LOGIN STAMP
933 1372
934B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1373B<@@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. 1374it 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 1375allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
937some systems. 1376on some systems or setgid to root or to some other group on others.
938 1377
939=head1 COLORS AND GRAPHICS 1378=head1 COLORS AND GRAPHICS
940 1379
941In addition to the default foreground and background colours, 1380In addition to the default foreground and background colours,
942B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1381B<@@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 1382high-intensity bold/blink versions of the same). Here is a list of the
944colours with their B<rgb.txt> names. 1383colours with their names.
945 1384
946=begin table 1385=begin table
947 1386
948 B<color0> (black) = Black 1387 B<color0> (black) = Black
949 B<color1> (red) = Red3 1388 B<color1> (red) = Red3
969It is also possible to specify the colour values of B<foreground>, 1408It is also possible to specify the colour values of B<foreground>,
970B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1409B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
971a number 0-15, as a convenient shorthand to reference the colour name of 1410a number 0-15, as a convenient shorthand to reference the colour name of
972color0-color15. 1411color0-color15.
973 1412
1413In addition to the colours defined above, @@RXVT_NAME@@ offers an
1414additional 72 colours. The first 64 of those (with indices 16 to 79)
1415consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
141616>), followed by 8 additional shades of gray (with indices 80 to 87).
1417
1418Together, all those colours implement the 88 colour xterm colours. Only
1419the first 16 can be changed using resources currently, the rest can only
1420be changed via command sequences ("escape codes").
1421
974Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1422Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
975always swapping the foreground/background colours. This is in contrast to 1423always swapping the foreground/background colours. This is in contrast to
976I<xterm>(1) where the colours are only swapped if they have not otherwise 1424I<xterm>(1) where the colours are only swapped if they have not otherwise
977been specified. For example, 1425been specified. For example,
978 1426
983would yield White on Black, while on I<xterm>(1) it would yield Black 1431would yield White on Black, while on I<xterm>(1) it would yield Black
984on White. 1432on White.
985 1433
986=back 1434=back
987 1435
988=head1 FREQUENTLY ASKED QUESTIONS (FAQ) 1436=head2 ALPHA CHANNEL SUPPORT
1437
1438If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1439their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1440(recommended, but B<MUST> have 4 digits/component) colour specifications,
1441in addition to the ones provided by X, where the additional A component
1442specifies opacity (alpha) values. The minimum value of C<0> is completely
1443transparent). You can also prefix any color with C<[percent]>, where
1444C<percent> is a decimal percentage (0-100) that specifies the opacity of
1445the color, where C<0> is completely transparent and C<100> is completelxy
1446opaque.
1447
1448You probably need to specify B<"-depth 32">, too, and have the luck that
1449your X-server uses ARGB pixel layout, as X is far from just supporting
1450ARGB visuals out of the box, and rxvt-unicode just fudges around.
1451
1452For example, the following selects an almost completely transparent red
1453background, and an almost opaque pink foreground:
1454
1455 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1456
1457I<Please note that transparency of any kind if completely unsupported by
1458the author. Don't bug him with installation questions!>
1459
1460=head1 ENVIRONMENT
1461
1462B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
989 1463
990=over 4 1464=over 4
991 1465
992=item How do I know which rxvt-unicode version I'm using? 1466=item B<TERM>
993 1467
994The version number is displayed with the usage (-h). Also the escape 1468Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
995sequence C<ESC[8n> sets the window title to the version number. 1469resources or on the command line.
996 1470
997=item When I log-in to another system it tells me about missing terminfo data? 1471=item B<COLORTERM>
998 1472
999The terminal description used by rxvt-unicode is not as widely available 1473Either 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). 1474compiled with XPM support, and optionally with the added extension
1475C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1001 1476
1002The correct solution for this problem is to install the terminfo, this can be done 1477=item B<COLORFGBG>
1003like this:
1004 1478
1005 infocmp rxvt-unicode >rxvt.unicode.tic 1479Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1006 scp rxvt-unicode.tic remotesystem: 1480the colour code used as default foreground/text colour (or the string
1007 ssh remotesystem tic rxvt-unicode.tic 1481C<default> to indicate that the default-colour escape sequence is to be
1008 1482used), C<bg> is the colour code used as default background colour (or the
1009... or by installing rxvt-unicode normally on the remote system, 1483string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1484was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1485(and do) use this information to optimize screen output.
1010 1486
1011If you cannot or do not want to do this, then you can simply set 1487=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 1488
1017If you always want to do this you can either recompile rxvt-unicode with 1489Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1018the desired TERM value or use a resource to set it: 1490window, which usually has subwindows for the scrollbar, the terminal
1491window and so on).
1019 1492
1020 URxvt.termName: rxvt 1493=item B<TERMINFO>
1021 1494
1022=item How can I configure rxvt-unicode so that it looks similar to the original rxvt? 1495Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1496C<--with-terminfo=PATH>.
1023 1497
1024Felix von Leitner says that these two lines, in your F<.Xdefaults>, will make rxvt-unicode 1498=item B<DISPLAY>
1025behave similar to the original rxvt:
1026 1499
1027 URxvt.font: -misc-fixed-medium-r-semicondensed--13-120-75-75-c-60-iso8859-1 1500Used 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 1501display in its child processes.
1029 1502
1030=item Rxvt-unicode does not seem to understand the selected encoding? 1503=item B<SHELL>
1031 1504
1032=item Unicode does not seem to work? 1505The shell to be used for command execution, defaults to C</bin/sh>.
1033 1506
1034If you encounter strange problems like typing an accented character but 1507=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 1508
1038Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the 1509The unix domain socket path used by @@RXVT_NAME@@c(1) and
1039programs. Often rxvt-unicode is started in the C<C> locale, while the 1510@@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 1511
1043The best thing is to fix your startup environment, as you will likely run 1512Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1044into other problems. If nothing works you can try this in your .profile.
1045 1513
1046 printf '\e]701;%s\007' "$LC_CTYPE" 1514=item B<HOME>
1047 1515
1048If this doesn't work, then maybe you use a C<LC_CTYPE> specification not 1516Used to locate the default directory for the unix domain socket for
1049supported on your systems. Some systems have a C<locale> comamnd which 1517daemon communications and to locate various resource files (such as
1050displays this. If it displays sth. like: 1518C<.Xdefaults>)
1051 1519
1052 locale: Cannot set LC_CTYPE to default locale: ... 1520=item B<XAPPLRESDIR>
1053 1521
1054Then the locale you specified is not supported on your system. 1522Directory where various X resource files are being located.
1055 1523
1056If nothing works and you are sure that everything is set correctly then 1524=item B<XENVIRONMENT>
1057you will need to remember a little known fact: Some programs just don't
1058support locales :(
1059 1525
1060=item Why do the characters look ugly? 1526If 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@@ 1527@@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 1528
1461=back 1529=back
1462 1530
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 1531=head1 FILES
1473 1532
1474=over 4 1533=over 4
1475 1534
1476=item B</etc/utmp>
1477
1478System file for login records.
1479
1480=item B</usr/lib/X11/rgb.txt> 1535=item B</usr/lib/X11/rgb.txt>
1481 1536
1482Color names. 1537Color names.
1483 1538
1484=back 1539=back
1485 1540
1486=head1 SEE ALSO 1541=head1 SEE ALSO
1487 1542
1488@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1543@@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 1544
1498=head1 CURRENT PROJECT COORDINATOR 1545=head1 CURRENT PROJECT COORDINATOR
1499 1546
1500=over 4 1547=over 4
1501 1548
1502=item Project Coordinator 1549=item Project Coordinator
1503 1550
1504@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1551Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1505 1552
1506=item Web page maintainter 1553L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1507
1508@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1509
1510L<@@RXVT_WEBPAGE@@>
1511 1554
1512=back 1555=back
1513 1556
1514=head1 AUTHORS 1557=head1 AUTHORS
1515 1558
1537 1580
1538Project Coordinator (changes.txt 2.21a to 2.4.5) 1581Project Coordinator (changes.txt 2.21a to 2.4.5)
1539 1582
1540=item Geoff Wing L<< <gcw@pobox.com> >> 1583=item Geoff Wing L<< <gcw@pobox.com> >>
1541 1584
1542Rewrote screen display and text selection routines. Project Coordinator 1585Rewrote screen display and text selection routines.
1586
1543(changes.txt 2.4.6 - rxvt-unicode) 1587Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1544 1588
1545=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1589=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1546 1590
1547Forked rxvt-unicode, rewrote most of the display code and internal 1591Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1548character handling to store text in unicode, improve xterm 1592extension, random hacks, numerous bugfixes and extensions.
1549compatibility and apply numerous other bugfixes and extensions.
1550 1593
1551Project Coordinator (Changes 1.0 -) 1594Project Coordinator (Changes 1.0 -)
1552 1595
1596=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1597
1598Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1599
1553=back 1600=back
1554 1601

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines