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.4 by root, Fri Aug 13 03:47:09 2004 UTC vs.
Revision 1.240 by sf-exg, Mon Oct 13 17:05:32 2014 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines