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.238 by sf-exg, Sat Oct 11 22:02:50 2014 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines