ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.12 by root, Mon Aug 16 02:09:28 2004 UTC vs.
Revision 1.236 by sf-exg, Sat Aug 16 10:51:23 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 156
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
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
145=item B<-pr> I<colour> 161=item B<-pr> I<colour>
150 166
151The mouse pointer background colour; resource B<pointerColor2>. 167The mouse pointer background colour; resource B<pointerColor2>.
152 168
153=item B<-bd> I<colour> 169=item B<-bd> I<colour>
154 170
155The colour of the border between the xterm scrollbar and the text; 171The colour of the border around the text area and between the scrollbar and the text;
156resource B<borderColor>. 172resource B<borderColor>.
157 173
158=item B<-fn> I<fontname> 174=item B<-fn> I<fontlist>
159 175
160Select the fonts to be used. This is a comma seperated list of font 176Select the fonts to be used. This is a comma separated list of font names
161names that are used in turn when trying to display Unicode characters. 177that are checked in order when trying to find glyphs for characters. The
162The first font defines the cell size for characters; other fonts might 178first font defines the cell size for characters; other fonts might be
163be smaller, but not larger. A reasonable default font list is always 179smaller, but not (in general) larger. A (hopefully) reasonable default
164appended to it. resource B<font>. 180font list is always appended to it. See resource B<font> for more details.
181
182In short, to specify an X11 core font, just specify its name or prefix it
183with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.:
185
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
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
192=item B<-fb> I<fontlist>
193
194Compile I<font-styles>: The bold font list to use when B<bold> characters
195are to be printed. See resource B<boldFont> for details.
196
197=item B<-fi> I<fontlist>
198
199Compile I<font-styles>: The italic font list to use when I<italic>
200characters are to be printed. See resource B<italicFont> for details.
201
202=item B<-fbi> I<fontlist>
203
204Compile I<font-styles>: The bold italic font list to use when B<< I<bold
205italic> >> characters are to be printed. See resource B<boldItalicFont>
206for details.
207
169=item B<-rb>|B<+rb> 208=item B<-is>|B<+is>
170 209
171Enable "real bold" support. When this option is on, bold text will be 210Compile I<font-styles>: Bold/Blink font styles imply high intensity
172displayed using the first available bold font in the font list. Bold 211foreground/background (default). See resource B<intensityStyles> for
173fonts should thus be specified in the font list after their 212details.
174corresponding regular fonts. If no bold font can be found, a regular
175font will be used. resource B<realBold>.
176 213
177=item B<-name> I<name> 214=item B<-name> I<name>
178 215
179Specify the application name under which resources are to be obtained, 216Specify the application name under which resources are to be obtained,
180rather than the default executable file name. Name should not contain 217rather than the default executable file name. Name should not contain
182 219
183=item B<-ls>|B<+ls> 220=item B<-ls>|B<+ls>
184 221
185Start as a login-shell/sub-shell; resource B<loginShell>. 222Start as a login-shell/sub-shell; resource B<loginShell>.
186 223
224=item B<-mc> I<milliseconds>
225
226Specify the maximum time between multi-click selections.
227
187=item B<-ut>|B<+ut> 228=item B<-ut>|B<+ut>
188 229
189Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 230Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
190B<utmpInhibit>. 231B<utmpInhibit>.
191 232
195B<visualBell>. 236B<visualBell>.
196 237
197=item B<-sb>|B<+sb> 238=item B<-sb>|B<+sb>
198 239
199Turn 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>.
200 250
201=item B<-si>|B<+si> 251=item B<-si>|B<+si>
202 252
203Turn on/off scroll-to-bottom on TTY output inhibit; resource 253Turn on/off scroll-to-bottom on TTY output inhibit; resource
204B<scrollTtyOutput> has opposite effect. 254B<scrollTtyOutput> has opposite effect.
212 262
213Turn on/off scrolling with the scrollback buffer as new lines appear. 263Turn on/off scrolling with the scrollback buffer as new lines appear.
214This only takes effect if B<-si> is also given; resource 264This only takes effect if B<-si> is also given; resource
215B<scrollWithBuffer>. 265B<scrollWithBuffer>.
216 266
217=item B<-sr>|B<+sr>
218
219Put scrollbar on right/left; resource B<scrollBar_right>.
220
221=item B<-st>|B<+st> 267=item B<-ptab>|B<+ptab>
222 268
223Display normal (non XTerm/NeXT) scrollbar without/with a trough; 269If enabled (default), "Horizontal Tab" characters are being stored as
224resource 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>.
225 274
226=item B<-bc>|B<+bc> 275=item B<-bc>|B<+bc>
227 276
228Blink 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>.
229 282
230=item B<-iconic> 283=item B<-iconic>
231 284
232Start iconified, if the window manager supports that option. 285Start iconified, if the window manager supports that option.
233Alternative form is B<-ic>. 286Alternative form is B<-ic>.
250 303
251=item B<-bl> 304=item B<-bl>
252 305
253Compile 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.
254if 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
255decorations; 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>.
256 327
257=item B<-lsp> I<number> 328=item B<-lsp> I<number>
258 329
259Compile I<linespace>: Lines (pixel height) to insert between each row 330Compile I<frills>: Lines (pixel height) to insert between each row of
260of 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>.
261 340
262=item B<-tn> I<termname> 341=item B<-tn> I<termname>
263 342
264This 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
265B<TERM> environment variable. This terminal type must exist in the 344B<TERM> environment variable. This terminal type must exist in the
274given on the command line. If this option is used, it must be the last 353given on the command line. If this option is used, it must be the last
275on the command-line. If there is no B<-e> option then the default is to 354on the command-line. If there is no B<-e> option then the default is to
276run the program specified by the B<SHELL> environment variable or, 355run the program specified by the B<SHELL> environment variable or,
277failing that, I<sh(1)>. 356failing that, I<sh(1)>.
278 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
279=item B<-title> I<text> 363=item B<-title> I<text>
280 364
281Window title (B<-T> still respected); the default title is the basename 365Window title (B<-T> still respected); the default title is the basename
282of 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
283application name; resource B<title>. 367application name; resource B<title>.
301 385
302Compile I<XIM>: input method name. resource B<inputMethod>. 386Compile I<XIM>: input method name. resource B<inputMethod>.
303 387
304=item B<-imlocale> I<string> 388=item B<-imlocale> I<string>
305 389
306The 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.
307de_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
308extension to be able to input japanese characters while staying in 392input extension to be able to input japanese characters while staying in
309another 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>.
310 406
311=item B<-insecure> 407=item B<-insecure>
312 408
313Enable "insecure" mode, which currently enables most of the escape 409Enable "insecure" mode, which currently enables most of the escape
314sequences that echo strings. See the resource B<insecure> for more 410sequences that echo strings. See the resource B<insecure> for more
328=item B<-ssr>|B<+ssr> 424=item B<-ssr>|B<+ssr>
329 425
330Turn on/off secondary screen scroll (default enabled); resource 426Turn on/off secondary screen scroll (default enabled); resource
331B<secondaryScroll>. 427B<secondaryScroll>.
332 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
333=item B<-xrm> I<resourcestring> 442=item B<-xrm> I<string>
334 443
335No 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>
336available 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
337some 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.
338 520
339=back 521=back
340 522
341=head1 RESOURCES (available also as long-options) 523=head1 RESOURCES
342 524
343Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 525Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
344options) compiled into your version. 526options) compiled into your version. All resources are also available as
527long-options.
345 528
346There 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
347Xresource data: using the X libraries (Xrm*-functions) or internal 530distribution do also load settings from the B<~/.Xresources> file when X
348Xresources reader (B<~/.Xdefaults>). For the first method (ie. 531starts. @@RXVT_NAME@@ will consult the following files/resources in order,
349B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 532with later settings overwriting earlier ones:
350resources using X11 tools like B<xset>. Many distribution do also load
351settings from the B<~/.Xresources> file when X starts.
352 533
353If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 534 1. app-defaults file in $XAPPLRESDIR
354lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 535 2. $HOME/.Xdefaults
355set in XAPPLOADDIR/URxvt (compile-time defined: usually 536 3. RESOURCE_MANAGER property on root-window of screen 0
356B</usr/lib/X11/app-defaults/URxvt>) and resources set in 537 4. SCREEN_RESOURCES property on root-window of the current screen
357B<~/.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
358Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 541Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
359class 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
360resources 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
361easily configured, while the class name B<URxvt> allows resources 544configured, while the class name B<URxvt> allows resources unique to
362unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 545B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
363shared between different B<@@RXVT_NAME@@> configurations. If no 546configurations. If no resources are specified, suitable defaults will
364resources are specified, suitable defaults will be used. Command-line 547be used. Command-line arguments can be used to override resource
365arguments can be used to override resource settings. The following 548settings. The following resources are supported (you might want to
366resources are allowed: 549check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
550extensions not documented here):
367 551
368=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.
369 565
370=item B<geometry:> I<geom> 566=item B<geometry:> I<geom>
371 567
372Create the window with the specified X window geometry [default 80x24]; 568Create the window with the specified X window geometry [default 80x24];
373option B<-geometry>. 569option B<-geometry>.
387Use 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
388corresponds to low-intensity (normal) colours and 8-15 corresponds to 584corresponds to low-intensity (normal) colours and 8-15 corresponds to
389high-intensity (bold = bright foreground, blink = bright background) 585high-intensity (bold = bright foreground, blink = bright background)
390colours. 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,
3913=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
392names used are listed in the B<COLORS AND GRAPHICS> section. 588names used are listed in the B<COLOURS AND GRAPHICS> section.
589
590Colours higher than 15 cannot be set using resources (yet), but can be
591changed using an escape command (see @@RXVT_NAME@@(7)).
592
593Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
59488 colour support). Colours 80-87 are evenly spaces grey steps.
393 595
394=item B<colorBD:> I<colour> 596=item B<colorBD:> I<colour>
395 597
598=item B<colorIT:> I<colour>
599
396Use the specified colour to display bold characters when the foreground 600Use the specified colour to display bold or italic characters when the
397colour is the default. This option will be ignored if B<realBold> is 601foreground colour is the default. If font styles are not available
398enabled. 602(Compile I<styles>) and this option is unset, reverse video is used instead.
399 603
400=item B<colorUL:> I<colour> 604=item B<colorUL:> I<colour>
401 605
402Use the specified colour to display underlined characters when the 606Use the specified colour to display underlined characters when the
403foreground colour is the default. 607foreground colour is the default.
404 608
405=item B<colorRV:> I<colour> 609=item B<underlineColor:> I<colour>
406 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
407Use the specified colour as the background for reverse video 616If set, use the specified colour as the background for highlighted
408characters. 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.
409 623
410=item B<cursorColor:> I<colour> 624=item B<cursorColor:> I<colour>
411 625
412Use 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
413foreground colour; option B<-cr>. 627foreground colour; option B<-cr>.
420 634
421=item B<reverseVideo:> I<boolean> 635=item B<reverseVideo:> I<boolean>
422 636
423B<True>: simulate reverse video by foreground and background colours; 637B<True>: simulate reverse video by foreground and background colours;
424option B<-rv>. B<False>: regular screen colours [default]; option 638option B<-rv>. B<False>: regular screen colours [default]; option
425B<+rv>. See note in B<COLORS AND GRAPHICS> section. 639B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
426 640
427=item B<jumpScroll:> I<boolean> 641=item B<jumpScroll:> I<boolean>
428 642
429B<True>: specify that jump scrolling should be used. When scrolling 643B<True>: specify that jump scrolling should be used. When receiving lots
430quickly, 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
431B<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>.
432 650
433=item B<inheritPixmap:> I<boolean> 651=item B<skipScroll:> I<boolean>
434 652
435B<True>: make the background inherit the parent windows' pixmap, giving 653B<True>: (the default) specify that skip scrolling should be used. When
436artificial transparency. B<False>: do not inherit the parent windows' 654receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
437pixmap. 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>.
438 662
439=item B<fading:> I<number> 663=item B<fading:> I<number>
440 664
441Fade the text by the given percentage when focus is lost. 665Fade the text by the given percentage when focus is lost; option B<-fade>.
442 666
443=item B<tintColor:> I<colour> 667=item B<fadeColor:> I<colour>
444 668
445Tint 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>.
446 671
447=item B<shading:> I<number> 672=item B<iconFile:> I<file>
448 673
449Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 674Set the application icon pixmap; option B<-icon>.
450image in addition to tinting it.
451
452=item B<fading:> I<number>
453
454Scale the tint colour by the given percentage.
455 675
456=item B<scrollColor:> I<colour> 676=item B<scrollColor:> I<colour>
457 677
458Use the specified colour for the scrollbar [default #B2B2B2]. 678Use the specified colour for the scrollbar [default #B2B2B2].
459 679
460=item B<troughColor:> I<colour> 680=item B<troughColor:> I<colour>
461 681
462Use the specified colour for the scrollbar's trough area [default 682Use the specified colour for the scrollbar's trough area [default
463#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 683#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
464 684
465=item B<backgroundPixmap:> I<file[;geom]> 685=item B<borderColor:> I<colour>
466 686
467Use the specified XPM file (note the `.xpm' extension is optional) for 687The colour of the border around the text area and between the scrollbar
468the background and also optionally specify its scaling with a geometry 688and the text.
469string B<WxH+X+Y>, in which B<"W" / "H"> specify the
470horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image
471centre (percent). A scale of 0 displays the image with tiling. A scale
472of 1 displays the image without any scaling. A scale of 2 to 9
473specifies an integer number of images in that direction. No image will
474be magnified beyond 10 times its original size. The maximum permitted
475scale is 1000. [default 0x0+50+50]
476 689
477=item B<menu:> I<file[;tag]>
478
479Read in the specified menu file (note the `.menu' extension is
480optional) and also optionally specify a starting tag to find. See the
481reference documentation for details on the syntax for the menuBar.
482
483=item B<path:> I<path>
484
485Specify the colon-delimited search path for finding files (XPM and
486menus), in addition to the paths specified by the B<RXVTPATH> and
487B<PATH> environment variables.
488
489=item B<font:> I<fontname> 690=item B<font:> I<fontlist>
490 691
491Select the fonts to be used. This is a comma seperated list of font 692Select the fonts to be used. This is a comma separated list of font names
492names that are used in turn when trying to display Unicode characters. 693that are checked in order when trying to find glyphs for characters. The
493The first font defines the cell size for characters; other fonts might 694first font defines the cell size for characters; other fonts might be
494be smaller, but not larger. A reasonable default font list is always 695smaller, but not (in general) larger. A (hopefully) reasonable default
495appended to it. option B<-fn>. 696font list is always appended to it; option B<-fn>.
496 697
497=item B<realBold:> I<boolean> 698Each font can either be a standard X11 core font (XLFD) name, with
699optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
498 700
499B<True>: Enable "real bold" support. When this option is on, bold text 701In addition, each font can be prefixed with additional hints and
500will be displayed using the first available bold font in the font list. 702specifications enclosed in square brackets (C<[]>). The only available
501Bold fonts should thus be specified in the font list after their 703hint currently is C<codeset=codeset-name>, and this is only used for Xft
502corresponding regular fonts. If no bold font can be found, a regular 704fonts.
503font will be used. option B<-rb>. B<False>: Display bold text in a
504regular font, using the color specified with B<colorBD>; option B<+rb>.
505 705
506=item B<selectstyle:> I<mode> 706For example, this font resource
507 707
508Set mouse selection style to B<old> which is 2.20, B<oldword> which is 708 URxvt.font: 9x15bold,\
509xterm style with 2.20 old word selection, or anything else which gives 709 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
510xterm style selection. 710 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
711 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
712 xft:Code2000:antialias=false
511 713
512=item B<scrollstyle:> I<mode> 714specifies five fonts to be used. The first one is C<9x15bold> (actually
715the iso8859-1 version of the second font), which is the base font (because
716it is named first) and thus defines the character cell grid to be 9 pixels
717wide and 15 pixels high.
513 718
514Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 719The second font is just used to add additional unicode characters not in
515the author's favourite.. 720the base font, likewise the third, which is unfortunately non-bold, but
721the bold version of the font does contain fewer characters, so this is a
722useful supplement.
723
724The third font is an Xft font with aliasing turned off, and the characters
725are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
726contains other characters, but we are not interested in them.
727
728The last font is a useful catch-all font that supplies most of the
729remaining unicode characters.
730
731=item B<boldFont:> I<fontlist>
732
733=item B<italicFont:> I<fontlist>
734
735=item B<boldItalicFont:> I<fontlist>
736
737The font list to use for displaying B<bold>, I<italic> or B<< I<bold
738italic> >> characters, respectively.
739
740If specified and non-empty, then the syntax is the same as for the
741B<font>-resource, and the given font list will be used as is, which makes
742it possible to substitute completely different font styles for bold and
743italic.
744
745If unset (the default), a suitable font list will be synthesized by
746"morphing" the normal text font list into the desired shape. If that is
747not possible, replacement fonts of the desired shape will be tried.
748
749If set, but empty, then this specific style is disabled and the normal
750text font will being used for the given style.
751
752=item B<intensityStyles:> I<boolean>
753
754When font styles are not enabled, or this option is enabled (B<True>,
755option B<-is>, the default), bold/blink font styles imply high
756intensity foreground/background colours. Disabling this option (B<False>,
757option B<+is>) disables this behaviour, the high intensity colours are not
758reachable.
516 759
517=item B<title:> I<string> 760=item B<title:> I<string>
518 761
519Set window title string, the default title is the command-line 762Set window title string, the default title is the command-line
520specified after the B<-e> option, if any, otherwise the application 763specified after the B<-e> option, if any, otherwise the application
529=item B<mapAlert:> I<boolean> 772=item B<mapAlert:> I<boolean>
530 773
531B<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
532de-iconify (map) on receipt of a bell character [default]. 775de-iconify (map) on receipt of a bell character [default].
533 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
534=item B<visualBell:> I<boolean> 784=item B<visualBell:> I<boolean>
535 785
536B<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>.
537B<False>: no visual bell [default]; option B<+vb>. 787B<False>: no visual bell [default]; option B<+vb>.
538 788
540 790
541B<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
542the 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
543[default]; option B<+ls>. 793[default]; option B<+ls>.
544 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
545=item B<utmpInhibit:> I<boolean> 800=item B<utmpInhibit:> I<boolean>
546 801
547B<True>: inhibit writing record into the system log file B<utmp>; 802B<True>: inhibit writing record into the system log file B<utmp>;
548option 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>
549[default]; option B<+ut>. 804[default]; option B<+ut>.
552 807
553Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 808Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
554B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 809B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
555B<Shift-Print> to include the scrollback as well. 810B<Shift-Print> to include the scrollback as well.
556 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
557=item B<scrollBar:> I<boolean> 830=item B<scrollBar:> I<boolean>
558 831
559B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 832B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
560disable the scrollbar; option B<+sb>. 833disable the scrollbar; option B<+sb>.
561 834
580B<False>: do not scroll to bottom when tty receives output; option 853B<False>: do not scroll to bottom when tty receives output; option
581B<+si>. 854B<+si>.
582 855
583=item B<scrollWithBuffer:> I<boolean> 856=item B<scrollWithBuffer:> I<boolean>
584 857
585B<True>: scroll with scrollback buffer when tty recieves new lines (and 858B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
586B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 859try to show the same lines) and B<scrollTtyOutput> is False; option
587with 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>.
588 862
589=item B<scrollTtyKeypress:> I<boolean> 863=item B<scrollTtyKeypress:> I<boolean>
590 864
591B<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
592are those which are intercepted by rxvt-unicode for special handling and 866are those which are intercepted by rxvt-unicode for special handling and
611=item B<borderLess:> I<boolean> 885=item B<borderLess:> I<boolean>
612 886
613Set 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
614WM, 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>.
615 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
616=item B<termName:> I<termname> 897=item B<termName:> I<termname>
617 898
618Specifies 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
619variable; option B<-tn>. 900variable; option B<-tn>.
620 901
621=item B<linespace:> I<number> 902=item B<lineSpace:> I<number>
622 903
623Specifies number of lines (pixel height) to insert between each row of 904Specifies number of lines (pixel height) to insert between each row of
624the display [default 0]; option B<-lsp>. 905the display [default 0]; option B<-lsp>.
625 906
626=item B<meta8:> I<boolean> 907=item B<meta8:> I<boolean>
631=item B<mouseWheelScrollPage:> I<boolean> 912=item B<mouseWheelScrollPage:> I<boolean>
632 913
633B<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
634scrolls five lines [default]. 915scrolls five lines [default].
635 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
636=item B<cursorBlink:> I<boolean> 922=item B<cursorBlink:> I<boolean>
637 923
638B<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];
639option 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>.
640 931
641=item B<pointerBlank:> I<boolean> 932=item B<pointerBlank:> I<boolean>
642 933
643B<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
644of seconds of inactivity. B<False>: the pointer is always visible 935of seconds of inactivity. B<False>: the pointer is always visible
652 943
653Mouse pointer background colour. 944Mouse pointer background colour.
654 945
655=item B<pointerBlankDelay:> I<number> 946=item B<pointerBlankDelay:> I<number>
656 947
657Specifies 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.
658 950
659=item B<backspacekey:> I<string> 951=item B<backspacekey:> I<string>
660 952
661The 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>
662or 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>
663(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
664escape sequence. 956escape sequence.
665 957
666=item B<deletekey:> I<string> 958=item B<deletekey:> I<string>
667 959
669pressed. If unset it will send the sequence traditionally associated 961pressed. If unset it will send the sequence traditionally associated
670with the B<Execute> key. 962with the B<Execute> key.
671 963
672=item B<cutchars:> I<string> 964=item B<cutchars:> I<string>
673 965
674The characters used as delimiters for double-click word selection. The 966The characters used as delimiters for double-click word selection
675built-in default: 967(whitespace delimiting is added automatically if resource is given).
676 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
677B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 977B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
678 978
679=item B<preeditType:> I<style> 979=item B<preeditType:> I<style>
680 980
681B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 981B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
682 982
684 984
685I<name> of inputMethod to use; option B<-im>. 985I<name> of inputMethod to use; option B<-im>.
686 986
687=item B<imLocale:> I<name> 987=item B<imLocale:> I<name>
688 988
689The 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.
690de_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
691extension to be able to input japanese characters while staying in 991input extension to be able to input japanese characters while staying in
692another locale. option B<-imlocale>. 992another locale; option B<-imlocale>.
693 993
694=item B<insecure> 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>.
1008
1009=item B<insecure:> I<boolean>
695 1010
696Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1011Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
697echo 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
698abused if somebody gets 8-bit-clean access to your display, wether 1013abused if somebody gets 8-bit-clean access to your display, whether
699throuh a mail client displaying mail bodies unfiltered or though 1014through a mail client displaying mail bodies unfiltered or through
700write(1). Therefore, these sequences are disabled by default. (Note 1015write(1) or any other means. Therefore, these sequences are disabled by
701that other terminals, including xterm, have these sequences 1016default. (Note that many other terminals, including xterm, have these
702enabled by default). You can enable them by setting this boolean 1017sequences enabled by default, which doesn't make it safer, though).
703resource or specifying B<-insecure> as an option. At the moment, this 1018
704enabled display-answer, locale, findfont, icon label and window title 1019You can enable them by setting this boolean resource or specifying
705requests 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.
706 1022
707=item B<modifier:> I<modifier> 1023=item B<modifier:> I<modifier>
708 1024
709Set 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>,
710B<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
714 1030
715Specify 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)
716character is passed through. It may contain escape values as described 1032character is passed through. It may contain escape values as described
717in the entry on B<keysym> following. 1033in the entry on B<keysym> following.
718 1034
719=item B<secondaryScreen:> I<bool> 1035=item B<secondaryScreen:> I<boolean>
720 1036
721Turn on/off secondary screen (default enabled). 1037Turn on/off secondary screen (default enabled).
722 1038
723=item B<secondaryScroll:> I<bool> 1039=item B<secondaryScroll:> I<boolean>
724 1040
725Turn on/off secondary screen scroll (default enabled). If the this 1041Turn on/off secondary screen scroll (default enabled). If this
726option is enabled, scrolls on the secondary screen will change the 1042option is enabled, scrolls on the secondary screen will change the
727scrollback buffer and switching to/from the secondary screen will 1043scrollback buffer and, when secondaryScreen is off, switching
728instead scroll the screen up. 1044to/from the secondary screen will instead scroll the screen up.
729 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
730=item B<keysym.>I<sym>: I<string> 1060=item B<keysym.>I<sym>: I<action>
731 1061
732Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 1062Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
733contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 1063resource name B<keysym.> cannot be omitted.
734newline, \r: return, \t: 1064
735tab, \000: octal number) or control characters (^?: delete, ^@: null, 1065Using this resource, you can map key combinations such as
736^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
737with whitespace. The intervening resource name B<keysym.> cannot be 1067string than would normally result from that combination, making the
738omitted. This resource is only available when compiled with 1068terminal scroll up or down the way you want it, or any other thing an
739KEYSYM_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-S-c: builtin-string:
1193 URxvt.keysym.C-S-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 define
1234keybindings via C<BINDING> meta comments, extensions loaded because
1235their resources/commandline switches were used, and extensions which are
1236mentioned in B<keysym> resources.
1237
1238Each extension is looked up in the library directories, loaded if
1239necessary, and bound to the current terminal instance. When the library
1240search path contains multiple extension files of the same name, then the
1241first one found will be used.
1242
1243If both of these resources are the empty string, then the perl interpreter
1244will not be initialized. The rationale for having two options is that
1245B<perl-ext-common> will be used for extensions that should be available to
1246all instances, while B<perl-ext> is used for specific instances.
1247
1248=item B<perl-eval>: I<string>
1249
1250Perl code to be evaluated when all extensions have been registered. See
1251the @@RXVT_NAME@@perl(3) manpage.
1252
1253=item B<perl-lib>: I<path>
1254
1255Colon-separated list of additional directories that hold extension
1256scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1257in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1258lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1259
1260See the @@RXVT_NAME@@perl(3) manpage.
1261
1262=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1263
1264Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1265details.
1266
1267=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1268
1269Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1270for details.
1271
1272=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1273
1274This resource is deprecated and will be removed. Use a B<keysym> resource
1275instead, e.g.:
1276
1277 URxvt.keysym.M-s: searchable-scrollback:start
1278
1279=item B<url-launcher>: I<string>
1280
1281Specifies the program to be started with a URL argument. Used by the
1282C<selection-popup> and C<matcher> perl extensions.
1283
1284=item B<transient-for>: I<windowid>
1285
1286Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1287
1288=item B<override-redirect>: I<boolean>
1289
1290Compile I<frills>: Sets override-redirect for the terminal window, making
1291it almost invisible to window managers; option B<-override-redirect>.
1292
1293=item B<iso14755:> I<boolean>
1294
1295Turn on/off ISO 14755 (default enabled).
1296
1297=item B<iso14755_52:> I<boolean>
1298
1299Turn on/off ISO 14755 5.2 mode (default enabled).
1300
1301=back
1302
1303=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1304
1305=over 4
1306
1307=item B<-pixmap> I<file[;oplist]>
1308
1309=item B<backgroundPixmap:> I<file[;oplist]>
1310
1311Compile I<pixbuf>: Use the specified image file as the window's
1312background and also optionally specify a colon separated list of
1313operations to modify it. Note that you may need to quote the C<;>
1314character when using the command line option, as C<;> is usually a
1315metacharacter in shells. Supported operations are:
1316
1317=over 4
1318
1319=item B<WxH+X+Y>
1320
1321sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1322scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1323scale of 0 disables scaling.
1324
1325=item B<op=tile>
1326
1327enables tiling
1328
1329=item B<op=keep-aspect>
1330
1331maintain the image aspect ratio when scaling
1332
1333=item B<op=root-align>
1334
1335use the position of the terminal window relative to the root window as
1336the image offset, simulating a root window background
1337
1338=back
1339
1340The default scale and position setting is C<100x100+50+50>.
1341Alternatively, a predefined set of templates can be used to achieve
1342the most common setups:
1343
1344=over 4
1345
1346=item B<style=tiled>
1347
1348the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1349
1350=item B<style=aspect-stretched>
1351
1352the image is scaled to fill the whole window maintaining the aspect
1353ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1354
1355=item B<style=stretched>
1356
1357the image is scaled to fill the whole window. Equivalent to 100x100
1358
1359=item B<style=centered>
1360
1361the image is centered with no scaling. Equivalent to 0x0+50+50
1362
1363=item B<style=root-tiled>
1364
1365the image is tiled with no scaling and using 'root' positioning.
1366Equivalent to 0x0:op=tile:op=root-align
1367
1368=back
1369
1370If multiple templates are specified the last one wins. Note that a
1371template overrides all the scale, position and operations settings.
1372
1373If used in conjunction with pseudo-transparency, the specified pixmap
1374will be blended over the transparent background using alpha-blending.
1375
1376=item B<-tr>|B<+tr>
1377
1378=item B<transparent:> I<boolean>
1379
1380Turn on/off pseudo-transparency by using the root pixmap as background.
1381
1382B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1383will be removed in future versions.
1384
1385=item B<-tint> I<colour>
1386
1387=item B<tintColor:> I<colour>
1388
1389Tint the transparent background with the given colour. Note that a
1390black tint yields a completely black image while a white tint yields
1391the image unchanged.
1392
1393=item B<-sh> I<number>
1394
1395=item B<shading:> I<number>
1396
1397Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1398A value of 100 means no shading.
1399
1400=item B<-blr> I<HxV>
1401
1402=item B<blurRadius:> I<HxV>
1403
1404Apply gaussian blur with the specified radius to the transparent
1405background. If a single number is specified, the vertical and
1406horizontal radii are considered to be the same. Setting one of the
1407radii to 1 and the other to a large number creates interesting effects
1408on some backgrounds. The maximum radius value is 128. An horizontal or
1409vertical radius of 0 disables blurring.
1410
1411=item B<path:> I<path>
1412
1413Specify the colon-delimited search path for finding background image files.
740 1414
741=back 1415=back
742 1416
743=head1 THE SCROLLBAR 1417=head1 THE SCROLLBAR
744 1418
758the normal text selection/insertion, hold either the Shift or the Meta 1432the normal text selection/insertion, hold either the Shift or the Meta
759(Alt) key while performing the desired mouse action. 1433(Alt) key while performing the desired mouse action.
760 1434
761If mouse reporting mode is active, the normal scrollbar actions are 1435If mouse reporting mode is active, the normal scrollbar actions are
762disabled -- on the assumption that we are using a fullscreen 1436disabled -- on the assumption that we are using a fullscreen
763application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1437application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
764(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1438(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
765up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), 1439up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
766respectively. 1440respectively.
767 1441
768=head1 TEXT SELECTION AND INSERTION 1442=head1 THE SELECTION: SELECTING AND PASTING TEXT
769 1443
770The behaviour of text selection and insertion mechanism is similar to 1444The behaviour of text selection and insertion/pasting mechanism is similar
771I<xterm>(1). 1445to I<xterm>(1).
772 1446
773=over 4 1447=over 4
774 1448
775=item B<Selection>: 1449=item B<Selecting>:
776 1450
777Left click at the beginning of the region, drag to the end of the 1451Left click at the beginning of the region, drag to the end of the region
778region and release; Right click to extend the marked region; Left 1452and release; Right click to extend the marked region; Left double-click
779double-click to select a word; Left triple-click to select the entire 1453to select a word; Left triple-click to select the entire logical line
780line. 1454(which can span multiple screen lines), unless modified by resource
1455B<tripleclickwords>.
781 1456
1457Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1458(Compile: I<frills>) will create a rectangular selection instead of a
1459normal one. In this mode, every selected row becomes its own line in the
1460selection, and trailing whitespace is visually underlined and removed from
1461the selection.
1462
782=item B<Insertion>: 1463=item B<Pasting>:
783 1464
784Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1465Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
785an B<@@RXVT_NAME@@> window causes the current text selection to be 1466window causes the value of the PRIMARY selection (or CLIPBOARD with the
786inserted as if it had been typed on the keyboard. 1467B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1468
1469Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1470inserted too.
1471
1472rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1473<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1474binding causes the value of the internal selection to be copied to the
1475CLIPBOARD selection, while the second binding causes the value of the
1476CLIPBOARD selection to be inserted.
787 1477
788=back 1478=back
789 1479
790=head1 CHANGING FONTS 1480=head1 CHANGING FONTS
791 1481
792Changing fonts (or font sizes, respectively) via the keypad is not yet 1482Changing fonts (or font sizes, respectively) via the keypad is not yet
793supported in rxvt-unicode. Bug me if you need this. 1483supported in rxvt-unicode. Bug me if you need this.
794 1484
795You can, however, switch fonts at runtime using escape sequences (and 1485You can, however, switch fonts at runtime using escape sequences, e.g.:
796therefore using the menubar), e.g.:
797 1486
798 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1487 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1488
1489You can use keyboard shortcuts, too:
1490
1491 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1492 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
799 1493
800rxvt-unicode will automatically re-apply these fonts to the output so far. 1494rxvt-unicode will automatically re-apply these fonts to the output so far.
801 1495
802=head1 ISO 14755 SUPPORT 1496=head1 ISO 14755 SUPPORT
803 1497
804ISO 14755 is a standard for entering and viewing unicode characters 1498ISO 14755 is a standard for entering and viewing unicode characters
805and character codes using the keyboard. It consists of 4 parts. The 1499and character codes using the keyboard. It consists of 4 parts. The
806first part is available rxvt-unicode has been compiled with 1500first part is available if rxvt-unicode has been compiled with
807C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1501C<--enable-frills>, the rest is available when rxvt-unicode was compiled
808with C<--enable-iso14755>. 1502with C<--enable-iso14755>.
809 1503
810=over 4 1504=over 4
811 1505
812=item 5.1: Basic method 1506=item * 5.1: Basic method
813 1507
814This allows you to enter unicode characters using their hexcode. 1508This allows you to enter unicode characters using their hexcode.
815 1509
816Start by pressing and holding both C<Control> and C<Shift>, then enter 1510Start by pressing and holding both C<Control> and C<Shift>, then enter
817hex-digits (between one and six). Releasing C<Control> and C<Shift> will 1511hex-digits (between one and six). Releasing C<Control> and C<Shift> will
824address, which you cannot type. Fortunately, the card has the e-mail 1518address, which you cannot type. Fortunately, the card has the e-mail
825address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily 1519address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
826by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>, 1520by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
827followed by releasing the modifier keys. 1521followed by releasing the modifier keys.
828 1522
829=item 5.2: Keyboard symbols entry method 1523=item * 5.2: Keyboard symbols entry method
830 1524
831This mode lets you input characters representing the keycap symbols of 1525This mode lets you input characters representing the keycap symbols of
832your keyboard, if representable in the current locale encoding. 1526your keyboard, if representable in the current locale encoding.
833 1527
834Start by pressing C<Control> and C<Shift> together, then releasing 1528Start by pressing C<Control> and C<Shift> together, then releasing
835them. The next special key (cursor keys, home etc.) you enter will not 1529them. The next special key (cursor keys, home etc.) you enter will not
836invoke it's usual function but instead will insert the corresponding 1530invoke its usual function but instead will insert the corresponding
837keycap symbol. The symbol will only be entered when the key has been 1531keycap symbol. The symbol will only be entered when the key has been
838released, otherwise pressing e.g. C<Shift> would enter the symbol for 1532released, otherwise pressing e.g. C<Shift> would enter the symbol for
839C<ISO Level 2 Switch>, although your intention might have beenm to enter a 1533C<ISO Level 2 Switch>, although your intention might have been to enter a
840reverse tab (Shift-Tab). 1534reverse tab (Shift-Tab).
841 1535
842=item 5.3: Screen-selection entry method 1536=item * 5.3: Screen-selection entry method
843 1537
844While this is implemented already (it's basically the selection 1538While this is implemented already (it's basically the selection
845mechanism), it could be extended by displaying a unicode character map. 1539mechanism), it could be extended by displaying a unicode character map.
846 1540
847=item 5.4: Feedback method for identifying displayed characters for later input 1541=item * 5.4: Feedback method for identifying displayed characters for later input
848 1542
849This method lets you display the unicode character code associated with 1543This method lets you display the unicode character code associated with
850characters already displayed. 1544characters already displayed.
851 1545
852You enter this mode by holding down C<Control> and C<Shift> together, then 1546You enter this mode by holding down C<Control> and C<Shift> together, then
853pressing and holding the left mouse button and moving around. The unicode 1547pressing and holding the left mouse button and moving around. The unicode
854hex code(s) (it might be a combining character) of the character under the 1548hex code(s) (it might be a combining character) of the character under the
855pointer is displayed until you release C<Control> and C<Shift>. 1549pointer is displayed until you release C<Control> and C<Shift>.
856 1550
1551In addition to the hex codes it will display the font used to draw this
1552character - due to implementation reasons, characters combined with
1553combining characters, line drawing characters and unknown characters will
1554always be drawn using the built-in support font.
1555
857=back 1556=back
858 1557
859With respect to conformance, rxvt-unicode is supposed to be compliant to 1558With respect to conformance, rxvt-unicode is supposed to be compliant to
860both scenario A and B of ISO 14755, including part 5.2. 1559both scenario A and B of ISO 14755, including part 5.2.
861 1560
862=head1 LOGIN STAMP 1561=head1 LOGIN STAMP
863 1562
864B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1563B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
865that it can be seen via the I<who(1)> command, and can accept messages. 1564it can be seen via the I<who(1)> command, and can accept messages. To
866To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on 1565allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
867some systems. 1566on some systems or setgid to root or to some other group on others.
868 1567
869=head1 COLORS AND GRAPHICS 1568=head1 COLOURS AND GRAPHICS
870 1569
871In addition to the default foreground and background colours, 1570In addition to the default foreground and background colours,
872B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1571B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
873high-intensity bold/blink versions of the same). Here is a list of the 1572high-intensity (potentially bold/blink) versions of the same, and 72 (or
874colours with their B<rgb.txt> names. 1573240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1574cube plus a 8 (24) colour greyscale ramp.
1575
1576Here is a list of the ANSI colours with their names.
875 1577
876=begin table 1578=begin table
877 1579
878 B<color0> (black) = Black 1580 B<color0> (black) = Black
879 B<color1> (red) = Red3 1581 B<color1> (red) = Red3
899It is also possible to specify the colour values of B<foreground>, 1601It is also possible to specify the colour values of B<foreground>,
900B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1602B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
901a number 0-15, as a convenient shorthand to reference the colour name of 1603a number 0-15, as a convenient shorthand to reference the colour name of
902color0-color15. 1604color0-color15.
903 1605
1606The following text gives values for the standard 88 colour mode (and
1607values for the 256 colour mode in parentheses).
1608
1609The RGB cube uses indices 16..79 (16..231) using the following formulas:
1610
1611 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1612 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1613
1614The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1615steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1616the RGB cube.
1617
1618Together, all those colours implement the 88 (256) colour xterm
1619colours. Only the first 16 can be changed using resources currently, the
1620rest can only be changed via command sequences ("escape codes").
1621
1622Applications are advised to use terminfo or command sequences to discover
1623number and RGB values of all colours (yes, you can query this...).
1624
904Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1625Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
905always swapping the foreground/background colours. This is in contrast to 1626always swapping the foreground/background colours. This is in contrast to
906I<xterm>(1) where the colours are only swapped if they have not otherwise 1627I<xterm>(1) where the colours are only swapped if they have not otherwise
907been specified. For example, 1628been specified. For example,
908 1629
1630 @@RXVT_NAME@@ -fg Black -bg White -rv
1631
1632would yield White on Black, while on I<xterm>(1) it would yield Black on
1633White.
1634
1635=head2 ALPHA CHANNEL SUPPORT
1636
1637If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1638their act together, rxvt-unicode will do its own alpha channel management:
1639
1640You can prefix any colour with an opaqueness percentage enclosed in
1641brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1642(0-100) that specifies the opacity of the colour, where C<0> is completely
1643transparent and C<100> is completely opaque. For example, C<[50]red> is a
1644half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1645is the recommended format to specify transparency values, and works with
1646all ways to specify a colour.
1647
1648For complete control, rxvt-unicode also supports
1649C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1650specifications, where the additional C<aaaa> component specifies opacity
1651(alpha) values. The minimum value of C<0000> is completely transparent,
1652while C<ffff> is completely opaque). The two example colours from
1653earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1654C<rgba:0000/ff00/0000/f332>.
1655
1656You probably need to specify B<"-depth 32">, too, to force a visual with
1657alpha channels, and have the luck that your X-server uses ARGB pixel
1658layout, as X is far from just supporting ARGB visuals out of the box, and
1659rxvt-unicode just fudges around.
1660
1661For example, the following selects an almost completely transparent black
1662background, and an almost opaque pink foreground:
1663
1664 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1665
1666When not using a background image, then the interpretation of the
1667alpha channel is up to your compositing manager (most interpret it as
1668transparency of course).
1669
1670When using a background pixmap or pseudo-transparency, then the background
1671colour will always behave as if it were completely transparent (so the
1672background image shows instead), regardless of how it was specified, while
1673other colours will either be transparent as specified (the background
1674image will show through) on servers supporting the RENDER extension, or
1675fully opaque on servers not supporting the RENDER EXTENSION.
1676
1677Please note that due to bugs in Xft, specifying alpha values might result
1678in garbage being displayed when the X-server does not support the RENDER
1679extension.
1680
1681=head1 ENVIRONMENT
1682
1683B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1684
909=over 4 1685=over 4
910 1686
911=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1687=item B<TERM>
912 1688
913would yield White on Black, while on I<xterm>(1) it would yield Black 1689Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
914on White. 1690resources or on the command line.
1691
1692=item B<COLORTERM>
1693
1694Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1695compiled with background image support, and optionally with the added
1696extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1697screen.
1698
1699=item B<COLORFGBG>
1700
1701Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1702the colour code used as default foreground/text colour (or the string
1703C<default> to indicate that the default-colour escape sequence is to be
1704used), C<bg> is the colour code used as default background colour (or the
1705string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1706was compiled with background image support. Libraries like C<ncurses>
1707and C<slang> can (and do) use this information to optimize screen output.
1708
1709=item B<WINDOWID>
1710
1711Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1712window, which usually has subwindows for the scrollbar, the terminal
1713window and so on).
1714
1715=item B<TERMINFO>
1716
1717Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1718C<--with-terminfo=PATH>.
1719
1720=item B<DISPLAY>
1721
1722Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1723display in its child processes if C<-display> isn't used to override. It
1724defaults to C<:0> if it doesn't exist.
1725
1726=item B<SHELL>
1727
1728The shell to be used for command execution, defaults to C</bin/sh>.
1729
1730=item B<RXVT_SOCKET> [I<sic>]
1731
1732The unix domain socket path used by @@RXVT_NAME@@c(1) and
1733@@RXVT_NAME@@d(1).
1734
1735Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1736
1737=item B<URXVT_PERL_LIB>
1738
1739Additional F<:>-separated library search path for perl extensions. Will be
1740searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1741directory.
1742
1743=item B<URXVT_PERL_VERBOSITY>
1744
1745See L<@@RXVT_NAME@@perl>(3).
1746
1747=item B<HOME>
1748
1749Used to locate the default directory for the unix domain socket for
1750daemon communications and to locate various resource files (such as
1751C<.Xdefaults>)
1752
1753=item B<XAPPLRESDIR>
1754
1755Directory where application-specific X resource files are located.
1756
1757=item B<XENVIRONMENT>
1758
1759If set and accessible, gives the name of a X resource file to be loaded by
1760@@RXVT_NAME@@.
915 1761
916=back 1762=back
917 1763
918=head1 FREQUENTLY ASKED QUESTIONS (FAQ) 1764=head1 FILES
919 1765
920=over 4 1766=over 4
921 1767
922=item How do I know which rxvt-unicode version I'm using? 1768=item B</usr/lib/X11/rgb.txt>
923 1769
924The version number is displayed with the usage (-h). For rxvt-unicode 1770Colour names.
925version 2.14 and later, the escape sequence C<ESC[8n> sets the window
926title to the version number.
927
928=item Rxvt-unicode does not seem to understand the selected encoding?
929
930=item Unicode does not seem to work?
931
932If you encounter strange problems like typing an accented character but
933getting two unrelated other characters or similar, or if program output is
934subtly garbled, then you should check your locale settings.
935
936Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the
937programs. Often rxvt-unicode is started in the C<C> locale, while the
938login script running within the rxvt-unicode window changes the locale to
939sth. else, e.h. C<en_GB.UTF-8>. Needless to say, this is not going to work.
940
941The best thing is to fix your startup environment, as you will likely run
942into other problems. If nothing works you can try this in your .profile.
943
944 printf '\e]701;%s\007' "$LC_CTYPE"
945
946If this doesn't work, then maybe you use a C<LC_CTYPE> specification not
947supported on your systems. Some systems have a C<locale> comamnd which
948displays this. If it displays sth. like:
949
950 locale: Cannot set LC_CTYPE to default locale: ...
951
952Then the locale you specified is not supported on your system.
953
954If nothing works and you are sure that everything is set correctly then
955you will need to remember a little known fact: Some programs just don't
956support locales :(
957
958=item Why do the characters look ugly?
959
960=item How does rxvt-unicode choose fonts?
961
962Most fonts do not contain the full range of Unicode, which is
963fine. Chances are that the font you (or the admin/package maintainer of
964your system/os) have specified does not cover all the characters you want
965to display.
966
967B<rxvt-unicode> makes a best-effort try at finding a replacement
968font. Often the result is fine, but sometimes the chosen font looks
969bad. In that case, select a font of your taste and add it to the font
970list, e.g.:
971
972 @@RXVT_NAME@@ -fn basefont,font2,font3...
973
974When rxvt-unicode sees a character, it will first look at the base
975font. If the base font does not contain the character, it will go to the
976next font, and so on.
977
978The only limitation is that all the fonts must not be larger than the base
979font, as the base font defines the principial cell size, which must be the
980same due to the way terminals work.
981
982=item Why do some chinese characters look so different than others?
983
984This is because there is a difference between script and language --
985rxvt-unicode does not know which language the text that is output
986is, as it only knows the unicode character codes. If rxvt-unicode
987first sees a japanese character, it might choose a japanese font for
988it. Subseqzuent japanese characters will take that font. Now, many chinese
989characters aren't represented in japanese fonts, so when the first
990non-japanese character comes up, rxvt-unicode will look for a chinese font
991-- unfortunately at this point, it will still use the japanese font for
992japanese characters that are also chinese.
993
994The workaround is easy: just tag a chinese font at the end of your font
995list (see the previous question). The key is to view the font list as
996a preference list: If you expect more japanese, list a japanese font
997first. If you expect more chinese, put a chinese font first.
998
999In the future it might be possible to switch preferences at runtime (the
1000internal data structure has no problem with using different fonts for
1001the same character at the same time, but no interface for this has been
1002designed yet).
1003
1004=item How does rxvt-unicode determine the encoding to use?
1005
1006=item Is there an option to switch encodings?
1007
1008Unlike some other terminals, rxvt-unicode has no encoding switch, and no
1009specific "utf-8" mode, such as xterm. In fact, it doesn't even know about
1010UTF-8 or any other encodings with respect to terminal I/O.
1011
1012The reasons is that there exists a perfectly fine mechanism for selecting
1013the encoding, doing I/O and (most important) communicating this to all
1014applications so everybody agrees on character properties such as width and
1015code number. This mechanism is the I<locale>.
1016
1017Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All
1018programs doing the same (that is, most) will automatically agree in the
1019interpretation of characters.
1020
1021Unfortunately, there is no system-independent way to select locales, nor
1022is there a standard on how locale specifiers will look like.
1023
1024On most systems, the content of the C<LC_CTYPE> environment variable
1025contains an arbitrary string which corresponds to an already-installed
1026locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>,
1027C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms
1028(i.e. C<de> or C<german>) are also common.
1029
1030Rxvt-unicode ignores all other locale categories, and except for
1031the encoding, ignores country or language-specific settings,
1032i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the same for rxvt-unicode.
1033
1034If you want to use a specific encoding you have to make sure you start
1035rxvt-unicode with the correct C<LC_CTYPE> category.
1036
1037=item Can I switch locales at runtime?
1038
1039Yes, using an escape sequence. Try sth. like this, which sets
1040rxvt-unicode's idea of C<LC_CTYPE>.
1041
1042 printf '\e]701;%s\007' ja_JP.SJIS
1043
1044See also the previous question.
1045
1046Sometimes this capability is rather handy when you want to work in one
1047locale (e.g. C<de_DE.UTF-8>) but some programs don't support UTF-8. For
1048example, I use this script to start C<xjdic>, which first switches to a
1049locale supported by xjdic and back later:
1050
1051 printf '\e]701;%s\007' ja_JP.SJIS
1052 xjdic -js
1053 printf '\e]701;%s\007' de_DE.UTF-8
1054
1055=item Can I switch the fonts at runtime?
1056
1057Yes, using an escape sequence. Try sth. like this, which has the same
1058effect as using the C<-fn> switch, and takes effect immediately:
1059
1060 printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic"
1061
1062This is useful if you e.g. work primarily with japanese (and prefer a
1063japanese font), but you have to switch to chinese temporarily, where
1064japanese fonts would only be in your way.
1065
1066You can think of this as a kind of manual ISO-2022 switching.
1067
1068=item Mouse cut/paste suddenly no longer works.
1069
1070Make sure that mouse reporting is actually turned off since killing
1071some editors prematurely may leave the mouse in mouse report mode. I've
1072heard that tcsh may use mouse reporting unless it otherwise specified. A
1073quick check is to see if cut/paste works when the Alt or Shift keys are
1074depressed. See @@RXVT_NAME@@(7)
1075
1076=item What's with this bold/blink stuff?
1077
1078If no bold colour is set via C<colorBD:>, bold will invert text using the
1079standard foreground colour.
1080
1081For the standard background colour, blinking will actually make the
1082text blink when compiled with C<--enable-blinking>. with standard
1083colours. Without C<--enable-blinking>, the blink attribute will be
1084ignored.
1085
1086On ANSI colours, bold/blink attributes are used to set high-intensity
1087foreground/background colors.
1088
1089color0-7 are the low-intensity colors.
1090
1091color8-15 are the corresponding high-intensity colors.
1092
1093=item I don't like the screen colors. How do I change them?
1094
1095You can change the screen colors at run-time using F<~/.Xdefaults>
1096resources (or as long-options).
1097
1098Here are values that are supposed to resemble a VGA screen,
1099including the murky brown that passes for low-intensity yellow:
1100
1101 Rxvt*color0: #000000
1102 Rxvt*color1: #A80000
1103 Rxvt*color2: #00A800
1104 Rxvt*color3: #A8A800
1105 Rxvt*color4: #0000A8
1106 Rxvt*color5: #A800A8
1107 Rxvt*color6: #00A8A8
1108 Rxvt*color7: #A8A8A8
1109
1110 Rxvt*color8: #000054
1111 Rxvt*color9: #FF0054
1112 Rxvt*color10: #00FF54
1113 Rxvt*color11: #FFFF54
1114 Rxvt*color12: #0000FF
1115 Rxvt*color13: #FF00FF
1116 Rxvt*color14: #00FFFF
1117 Rxvt*color15: #FFFFFF
1118
1119=item What's with the strange Backspace/Delete key behaviour?
1120
1121Assuming that the physical Backspace key corresponds to the
1122BackSpace keysym (not likely for Linux ... see the following
1123question) there are two standard values that can be used for
1124Backspace: C<^H> and C<^?>.
1125
1126Historically, either value is correct, but rxvt-unicode adopts the debian
1127policy of using C<^?> when unsure, because it's the one only only correct
1128choice :).
1129
1130Rxvt-unicode tries to inherit the current stty settings and uses the value
1131of `erase' to guess the value for backspace. If rxvt-unicode wasn't
1132started from a terminal (say, from a menu or by remote shell), then the
1133system value of `erase', which corresponds to CERASE in <termios.h>, will
1134be used (which may not be the same as your stty setting).
1135
1136For starting a new rxvt-unicode:
1137
1138 # use Backspace = ^H
1139 $ stty erase ^H
1140 $ @@RXVT_NAME@@
1141
1142 # use Backspace = ^?
1143 $ stty erase ^?
1144 $ @@RXVT_NAME@@
1145
1146Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7).
1147
1148For an existing rxvt-unicode:
1149
1150 # use Backspace = ^H
1151 $ stty erase ^H
1152 $ echo -n "^[[36h"
1153
1154 # use Backspace = ^?
1155 $ stty erase ^?
1156 $ echo -n "^[[36l"
1157
1158This helps satisfy some of the Backspace discrepancies that occur, but
1159if you use Backspace = C<^H>, make sure that the termcap/terminfo value
1160properly reflects that.
1161
1162The Delete key is a another casualty of the ill-defined Backspace problem.
1163To avoid confusion between the Backspace and Delete keys, the Delete
1164key has been assigned an escape sequence to match the vt100 for Execute
1165(ESC[3~) and is in the supplied termcap/terminfo.
1166
1167Some other Backspace problems:
1168
1169some editors use termcap/terminfo,
1170some editors (vim I'm told) expect Backspace = ^H,
1171GNU Emacs (and Emacs-like editors) use ^H for help.
1172
1173Perhaps someday this will all be resolved in a consistent manner.
1174
1175=item I don't like the key-bindings. How do I change them?
1176
1177There are some compile-time selections available via configure. Unless
1178you have run "configure" with the C<--disable-resources> option you can
1179use the `keysym' resource to alter the keystrings associated with keysym
11800xFF00 - 0xFFFF (function, cursor keys, etc).
1181
1182Here's an example for a tn3270 session started using `@@RXVT_NAME@@ -name tn3270'
1183
1184 !# ----- special uses ------:
1185 ! tn3270 login, remap function and arrow keys.
1186 tn3270*font: *clean-bold-*-*--15-*
1187
1188 ! keysym - used by rxvt only
1189 ! Delete - ^D
1190 tn3270*keysym.0xFFFF: \004
1191
1192 ! Home - ^A
1193 tn3270*keysym.0xFF50: \001
1194 ! Left - ^B
1195 tn3270*keysym.0xFF51: \002
1196 ! Up - ^P
1197 tn3270*keysym.0xFF52: \020
1198 ! Right - ^F
1199 tn3270*keysym.0xFF53: \006
1200 ! Down - ^N
1201 tn3270*keysym.0xFF54: \016
1202 ! End - ^E
1203 tn3270*keysym.0xFF57: \005
1204
1205 ! F1 - F12
1206 tn3270*keysym.0xFFBE: \e1
1207 tn3270*keysym.0xFFBF: \e2
1208 tn3270*keysym.0xFFC0: \e3
1209 tn3270*keysym.0xFFC1: \e4
1210 tn3270*keysym.0xFFC2: \e5
1211 tn3270*keysym.0xFFC3: \e6
1212 tn3270*keysym.0xFFC4: \e7
1213 tn3270*keysym.0xFFC5: \e8
1214 tn3270*keysym.0xFFC6: \e9
1215 tn3270*keysym.0xFFC7: \e0
1216 tn3270*keysym.0xFFC8: \e-
1217 tn3270*keysym.0xFFC9: \e=
1218
1219 ! map Prior/Next to F7/F8
1220 tn3270*keysym.0xFF55: \e7
1221 tn3270*keysym.0xFF56: \e8
1222
1223=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys.
1224How do I make use of them? For example, the Sun Keyboard type 4
1225has the following mappings that rxvt-unicode doesn't recognize.
1226
1227 KP_Insert == Insert
1228 F22 == Print
1229 F27 == Home
1230 F29 == Prior
1231 F33 == End
1232 F35 == Next
1233
1234Rather than have rxvt-unicode try to accomodate all the various possible keyboard
1235mappings, it is better to use `xmodmap' to remap the keys as required for
1236your particular machine.
1237
1238=item How do I distinguish if I'm running rxvt-unicode or a regular xterm?
1239I need this to decide about setting colors etc.
1240
1241rxvt and rxvt-unicode always export the variable "COLORTERM", so you can
1242check and see if that is set. Note that several programs, JED, slrn,
1243Midnight Commander automatically check this variable to decide whether or
1244not to use color.
1245
1246=item How do I set the correct, full IP address for the DISPLAY variable?
1247
1248If you've compiled rxvt-unicode with DISPLAY_IS_IP and ahve enabled
1249insecure mode then it is possible to use the following shell script
1250snippets to correctly set the display. If your version of rxvt-unicode
1251wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then
1252the COLORTERM variable can be used to distinguish rxvt-unicode from a
1253regular xterm.
1254
1255Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script
1256snippets:
1257
1258 # Bourne/Korn/POSIX family of shells:
1259 [ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know
1260 if [ ${TERM:-foo} = xterm ]; then
1261 stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not
1262 echo -n '^[Z'
1263 read term_id
1264 stty icanon echo
1265 if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then
1266 echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string
1267 read DISPLAY # set it in our local shell
1268 fi
1269 fi
1270
1271=item How do I compile the manual pages for myself?
1272
1273You need to have a recent version of perl installed as F</usr/bin/perl>,
1274one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to
1275the doc subdirectory and enter C<make alldoc>.
1276 1771
1277=back 1772=back
1278 1773
1279=head1 ENVIRONMENT 1774=head1 SEE ALSO
1280 1775
1281B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1776@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1282and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1777@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1283window id number of the B<@@RXVT_NAME@@> window and it also uses and
1284sets the environment variable B<DISPLAY> to specify which display
1285terminal to use. B<@@RXVT_NAME@@> uses the environment variables
1286B<RXVTPATH> and B<PATH> to find XPM files.
1287 1778
1288=head1 FILES 1779=head1 CURRENT PROJECT COORDINATOR
1289 1780
1290=over 4 1781=over 4
1291 1782
1292=item B</etc/utmp> 1783=item Project Coordinator
1293 1784
1294System file for login records. 1785Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1295 1786
1296=item B</usr/lib/X11/rgb.txt> 1787L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1297
1298Color names.
1299 1788
1300=back 1789=back
1301 1790
1302=head1 SEE ALSO 1791=head1 AUTHORS
1303
1304@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1305
1306=head1 BUGS
1307
1308Check the BUGS file for an up-to-date list.
1309
1310Cursor change support is not yet implemented.
1311
1312Click-and-drag doesn't work with X11 mouse report overriding.
1313
1314=head1 CURRENT PROJECT COORDINATOR
1315 1792
1316=over 4 1793=over 4
1317 1794
1318=item Project Coordinator 1795=item John Bovey
1319 1796
1320@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1797University of Kent, 1992, wrote the original Xvt.
1321 1798
1322=item Web page maintainter 1799=item Rob Nation <nation@rocket.sanders.lockheed.com>
1323 1800
1324@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@> 1801very heavily modified Xvt and came up with Rxvt
1325 1802
1326L<@@RXVT_WEBPAGE@@> 1803=item Angelo Haritsis <ah@doc.ic.ac.uk>
1804
1805wrote the Greek Keyboard Input (no longer in code)
1806
1807=item mj olesen <olesen@me.QueensU.CA>
1808
1809Wrote the menu system.
1810
1811Project Coordinator (changes.txt 2.11 to 2.21)
1812
1813=item Oezguer Kesim <kesim@math.fu-berlin.de>
1814
1815Project Coordinator (changes.txt 2.21a to 2.4.5)
1816
1817=item Geoff Wing <gcw@pobox.com>
1818
1819Rewrote screen display and text selection routines.
1820
1821Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1822
1823=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1824
1825Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1826extension, random hacks, numerous bugfixes and extensions.
1827
1828Project Coordinator (Changes 1.0 -)
1829
1830=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1831
1832pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1327 1833
1328=back 1834=back
1329 1835
1330=head1 AUTHORS
1331
1332=over 4
1333
1334=item John Bovey
1335
1336University of Kent, 1992, wrote the original Xvt.
1337
1338=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>
1339
1340very heavily modified Xvt and came up with Rxvt
1341
1342=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>
1343
1344wrote the Greek Keyboard Input (no longer in code)
1345
1346=item mj olesen L<< <olesen@me.QueensU.CA> >>
1347
1348Wrote the menu system.
1349
1350Project Coordinator (changes.txt 2.11 to 2.21)
1351
1352=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>
1353
1354Project Coordinator (changes.txt 2.21a to 2.4.5)
1355
1356=item Geoff Wing L<< <gcw@pobox.com> >>
1357
1358Rewrote screen display and text selection routines. Project Coordinator
1359(changes.txt 2.4.6 - rxvt-unicode)
1360
1361=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >>
1362
1363Forked rxvt-unicode, rewrote most of the display code and internal
1364character handling to store text in unicode, improve xterm
1365compatibility and apply numerous other bugfixes and extensions.
1366
1367Project Coordinator (Changes 1.0 -)
1368
1369=back
1370

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines