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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines