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.1 by root, Thu Aug 12 20:42:12 2004 UTC vs.
Revision 1.242 by sf-exg, Fri Dec 26 21:49:11 2014 UTC

2 2
3rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window system) 3rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window system)
4 4
5=head1 SYNOPSIS 5=head1 SYNOPSIS
6 6
7B<@@RXVTNAME@@> [options] [-e command [ args ]] 7B<@@RXVT_NAME@@> [options] [-e command [ args ]]
8 8
9=head1 DESCRIPTION 9=head1 DESCRIPTION
10 10
11B<rxvt-unicode>, version B<@@RXVTVERSION@@>, is a colour vt102 terminal 11B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal
12emulator intended as an I<xterm>(1) replacement for users who do not 12emulator intended as an I<xterm>(1) replacement for users who do not
13require features such as Tektronix 4014 emulation and toolkit-style 13require features such as Tektronix 4014 emulation and toolkit-style
14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16 16
17This document is also available on the World-Wide-Web at
18L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
19
20=head1 FREQUENTLY ASKED QUESTIONS
21
22See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
23frequently asked questions and answer to them and some common
24problems. That document is also accessible on the World-Wide-Web at
25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
26
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.).
69
17=head1 OPTIONS 70=head1 OPTIONS
18 71
19The B<@@RXVTNAME@@> options (mostly a subset of I<xterm>'s) are listed 72The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
20below. In keeping with the smaller-is-better philosophy, options may be 73below. In keeping with the smaller-is-better philosophy, options may be
21eliminated or default values chosen at compile-time, so options and 74eliminated or default values chosen at compile-time, so options and
22defaults listed may not accurately reflect the version installed on 75defaults listed may not accurately reflect the version installed on
23your system. `rxvt -h' gives a list of major compile-time options on 76your system. `@@RXVT_NAME@@ -h' gives a list of major compile-time options on
24the I<Options> line. Option descriptions may be prefixed with which 77the I<Options> line. Option descriptions may be prefixed with which
25compile option each is dependent upon. e.g. `Compile I<XIM>:' requires 78compile option each is dependent upon. e.g. `Compile I<XIM>:' requires
26I<XIM> on the I<Options> line. Note: `rxvt -help' gives a list of all 79I<XIM> on the I<Options> line. Note: `@@RXVT_NAME@@ -help' gives a list of all
27command-line options compiled into your version. 80command-line options compiled into your version.
28 81
29Note that B<@@RXVTNAME@@> permits the resource name to be used as a 82Note that B<@@RXVT_NAME@@> permits the resource name to be used as a
30long-option (--/++ option) so the potential command-line options are 83long-option (--/++ option) so the potential command-line options are
31far greater than those listed. For example: `rxvt --loginShell --color1 84far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1
32Orange'. 85Orange'.
33 86
34The following options are available: 87The following options are available:
35 88
36=over 4 89=over 4
39 92
40Print out a message describing available options. 93Print out a message describing available options.
41 94
42=item B<-display> I<displayname> 95=item B<-display> I<displayname>
43 96
44Attempt 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>
45respected). In the absence of this option, the display specified by the 98is still respected. but deprecated). In the absence of this option, the
46B<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
114possible visual ids) instead of the default, and also allocate a private
115colormap. All visual types except for DirectColor are supported.
47 116
48=item B<-geometry> I<geom> 117=item B<-geometry> I<geom>
49 118
50Window geometry (B<-g> still respected); resource B<geometry>. 119Window geometry (B<-g> still respected); resource B<geometry>.
51 120
53 122
54Turn on/off simulated reverse video; resource B<reverseVideo>. 123Turn on/off simulated reverse video; resource B<reverseVideo>.
55 124
56=item B<-j>|B<+j> 125=item B<-j>|B<+j>
57 126
58Turn on/off jump scrolling; resource B<jumpScroll>. 127Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
59 128
60=item B<-ip>|B<+ip> 129=item B<-ss>|B<+ss>
61 130
62Turn on/off inheriting parent window's pixmap. Alternative form is 131Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
63B<-tr>; resource B<inheritPixmap>.
64 132
65=item B<-fade> I<number> 133=item B<-fade> I<number>
66 134
67Fade the text by the given percentage when focus is lost. 135Fade the text by the given percentage when focus is lost. Small values
136fade a little only, 100 completely replaces all colours by the fade
137colour; resource B<fading>.
68 138
69=item B<-tint> I<colour> 139=item B<-fadecolor> I<colour>
70 140
71Tint the transparent background pixmap with the given colour when 141Fade to this colour when fading is used (see B<-fade>). The default colour
72transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> 142is opaque black. resource B<fadeColor>.
73option that can be used to brighten or darken the image in addition to
74tinting it.
75 143
76=item B<-sh> 144=item B<-icon> I<file>
77 145
78I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 146Compile I<pixbuf>: Use the specified image as application icon. This
79background image in addition to tinting it (i.e. B<-tint> must be 147is used by many window managers, taskbars and pagers to represent the
80specified, too). 148application window; resource I<iconFile>.
81 149
82=item B<-bg> I<colour> 150=item B<-bg> I<colour>
83 151
84Window background colour; resource B<background>. 152Window background colour; resource B<background>.
85 153
86=item B<-fg> I<colour> 154=item B<-fg> I<colour>
87 155
88Window foreground colour; resource B<foreground>. 156Window foreground colour; resource B<foreground>.
89 157
90=item B<-pixmap> I<file[;geom]>
91
92Compile I<XPM>: Specify XPM file for the background and also optionally
93specify its scaling with a geometry string. Note you may need to add
94quotes to avoid special shell interpretation of the `;' in the
95command-line; resource B<backgroundPixmap>.
96
97=item B<-cr> I<colour> 158=item B<-cr> I<colour>
98 159
99The cursor colour; resource B<cursorColor>. 160The cursor colour; resource B<cursorColor>.
100 161
101=item B<-pr> I<colour> 162=item B<-pr> I<colour>
106 167
107The mouse pointer background colour; resource B<pointerColor2>. 168The mouse pointer background colour; resource B<pointerColor2>.
108 169
109=item B<-bd> I<colour> 170=item B<-bd> I<colour>
110 171
111The colour of the border between the xterm scrollbar and the text; 172The colour of the border around the text area and between the scrollbar and the text;
112resource B<borderColor>. 173resource B<borderColor>.
113 174
114=item B<-fn> I<fontname> 175=item B<-fn> I<fontlist>
115 176
116Select the fonts to be used. This is a comma seperated list of font 177Select the fonts to be used. This is a comma separated list of font names
117names that are used in turn when trying to display Unicode characters. 178that are checked in order when trying to find glyphs for characters. The
118The first font defines the cell size for characters; other fonts might 179first font defines the cell size for characters; other fonts might be
119be smaller, but not larger. A reasonable default font list is always 180smaller, but not (in general) larger. A (hopefully) reasonable default
120appended to it. resource B<font>. 181font list is always appended to it. See resource B<font> for more details.
121 182
183In short, to specify an X11 core font, just specify its name or prefix it
184with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
185e.g.:
186
187 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
188 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
189
190See also the question "How does rxvt-unicode choose fonts?" in the FAQ
191section of @@RXVT_NAME@@(7).
192
193=item B<-fb> I<fontlist>
194
195Compile I<font-styles>: The bold font list to use when B<bold> characters
196are to be printed. See resource B<boldFont> for details.
197
198=item B<-fi> I<fontlist>
199
200Compile I<font-styles>: The italic font list to use when I<italic>
201characters are to be printed. See resource B<italicFont> for details.
202
203=item B<-fbi> I<fontlist>
204
205Compile I<font-styles>: The bold italic font list to use when B<< I<bold
206italic> >> characters are to be printed. See resource B<boldItalicFont>
207for details.
208
122=item B<-rb>|B<+rb> 209=item B<-is>|B<+is>
123 210
124Enable "real bold" support. When this option is on, bold text will be 211Compile I<font-styles>: Bold/Blink font styles imply high intensity
125displayed using the first available bold font in the font list. Bold 212foreground/background (default). See resource B<intensityStyles> for
126fonts should thus be specified in the font list after their 213details.
127corresponding regular fonts. If no bold font can be found, a regular
128font will be used. resource B<realBold>.
129 214
130=item B<-name> I<name> 215=item B<-name> I<name>
131 216
132Specify the application name under which resources are to be obtained, 217Specify the application name under which resources are to be obtained,
133rather than the default executable file name. Name should not contain 218rather than the default executable file name. Name should not contain
135 220
136=item B<-ls>|B<+ls> 221=item B<-ls>|B<+ls>
137 222
138Start as a login-shell/sub-shell; resource B<loginShell>. 223Start as a login-shell/sub-shell; resource B<loginShell>.
139 224
225=item B<-mc> I<milliseconds>
226
227Specify the maximum time between multi-click selections.
228
140=item B<-ut>|B<+ut> 229=item B<-ut>|B<+ut>
141 230
142Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 231Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
143B<utmpInhibit>. 232B<utmpInhibit>.
144 233
148B<visualBell>. 237B<visualBell>.
149 238
150=item B<-sb>|B<+sb> 239=item B<-sb>|B<+sb>
151 240
152Turn on/off scrollbar; resource B<scrollBar>. 241Turn on/off scrollbar; resource B<scrollBar>.
242
243=item B<-sr>|B<+sr>
244
245Put scrollbar on right/left; resource B<scrollBar_right>.
246
247=item B<-st>|B<+st>
248
249Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
250resource B<scrollBar_floating>.
153 251
154=item B<-si>|B<+si> 252=item B<-si>|B<+si>
155 253
156Turn on/off scroll-to-bottom on TTY output inhibit; resource 254Turn on/off scroll-to-bottom on TTY output inhibit; resource
157B<scrollTtyOutput> has opposite effect. 255B<scrollTtyOutput> has opposite effect.
165 263
166Turn on/off scrolling with the scrollback buffer as new lines appear. 264Turn on/off scrolling with the scrollback buffer as new lines appear.
167This only takes effect if B<-si> is also given; resource 265This only takes effect if B<-si> is also given; resource
168B<scrollWithBuffer>. 266B<scrollWithBuffer>.
169 267
170=item B<-sr>|B<+sr>
171
172Put scrollbar on right/left; resource B<scrollBar_right>.
173
174=item B<-st>|B<+st> 268=item B<-ptab>|B<+ptab>
175 269
176Display normal (non XTerm/NeXT) scrollbar without/with a trough; 270If enabled (default), "Horizontal Tab" characters are being stored as
177resource B<scrollBar_floating>. 271actual wide characters in the screen buffer, which makes it possible to
272select and paste them. Since a horizontal tab is a cursor movement and
273not an actual glyph, this can sometimes be visually annoying as the cursor
274on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
178 275
179=item B<-bc>|B<+bc> 276=item B<-bc>|B<+bc>
180 277
181Blink the cursor; resource B<cursorBlink>. 278Blink the cursor; resource B<cursorBlink>.
279
280=item B<-uc>|B<+uc>
281
282Make the cursor underlined; resource B<cursorUnderline>.
182 283
183=item B<-iconic> 284=item B<-iconic>
184 285
185Start iconified, if the window manager supports that option. 286Start iconified, if the window manager supports that option.
186Alternative form is B<-ic>. 287Alternative form is B<-ic>.
202B<externalBorder>. 303B<externalBorder>.
203 304
204=item B<-bl> 305=item B<-bl>
205 306
206Compile I<frills>: Set MWM hints to request a borderless window, i.e. 307Compile I<frills>: Set MWM hints to request a borderless window, i.e.
207if honoured by the WM, the rxvt window will not have window 308if honoured by the WM, the rxvt-unicode window will not have window
208decorations; resource B<borderLess>. 309decorations; resource B<borderLess>. If the window manager does not
310support MWM hints (e.g. kwin), enables override-redirect mode.
311
312=item B<-override-redirect>
313
314Compile I<frills>: Sets override-redirect on the window; resource
315B<override-redirect>.
316
317=item B<-dockapp>
318
319Sets the initial state of the window to WithdrawnState, which makes
320window managers that support this extension treat it as a dockapp.
321
322=item B<-sbg>
323
324Compile I<frills>: Disable the usage of the built-in block graphics/line
325drawing characters and just rely on what the specified fonts provide. Use
326this if you have a good font and want to use its block graphic glyphs;
327resource B<skipBuiltinGlyphs>.
209 328
210=item B<-lsp> I<number> 329=item B<-lsp> I<number>
211 330
212Compile I<linespace>: Lines (pixel height) to insert between each row 331Compile I<frills>: Lines (pixel height) to insert between each row of
213of the display; resource B<linespace>. 332the display. Useful to work around font rendering problems; resource
333B<lineSpace>.
334
335=item B<-letsp> I<number>
336
337Compile I<frills>: Amount to adjust the computed character width by
338to control overall letter spacing. Negative values will tighten up the
339letter spacing, positive values will space letters out more. Useful to
340work around odd font metrics; resource B<letterSpace>.
214 341
215=item B<-tn> I<termname> 342=item B<-tn> I<termname>
216 343
217This option specifies the name of the terminal type to be set in the 344This option specifies the name of the terminal type to be set in the
218B<TERM> environment variable. This terminal type must exist in the 345B<TERM> environment variable. This terminal type must exist in the
219I<termcap(5)> database and should have I<li#> and I<co#> entries; 346I<termcap(5)> database and should have I<li#> and I<co#> entries;
220resource B<termName>. 347resource B<termName>.
221 348
222=item B<-e> I<command [arguments]> 349=item B<-e> I<command [arguments]>
223 350
224Run the command with its command-line arguments in the B<@@RXVTNAME@@> 351Run the command with its command-line arguments in the B<@@RXVT_NAME@@>
225window; also sets the window title and icon name to be the basename of 352window; also sets the window title and icon name to be the basename of
226the program being executed if neither I<-title> (I<-T>) nor I<-n> are 353the program being executed if neither I<-title> (I<-T>) nor I<-n> are
227given on the command line. If this option is used, it must be the last 354given on the command line. If this option is used, it must be the last
228on the command-line. If there is no B<-e> option then the default is to 355on the command-line. If there is no B<-e> option then the default is to
229run the program specified by the B<SHELL> environment variable or, 356run the program specified by the B<SHELL> environment variable or,
230failing that, I<sh(1)>. 357failing that, I<sh(1)>.
231 358
359Please note that you must specify a program with arguments. If you want to
360run shell commands, you have to specify the shell, like this:
361
362 @@RXVT_NAME@@ -e sh -c "shell commands"
363
232=item B<-title> I<text> 364=item B<-title> I<text>
233 365
234Window title (B<-T> still respected); the default title is the basename 366Window title (B<-T> still respected); the default title is the basename
235of the program specified after the B<-e> option, if any, otherwise the 367of the program specified after the B<-e> option, if any, otherwise the
236application name; resource B<title>. 368application name; resource B<title>.
254 386
255Compile I<XIM>: input method name. resource B<inputMethod>. 387Compile I<XIM>: input method name. resource B<inputMethod>.
256 388
257=item B<-imlocale> I<string> 389=item B<-imlocale> I<string>
258 390
259The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 391The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
260de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 392C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
261extension to be able to input japanese characters while staying in 393input extension to be able to input japanese characters while staying in
262another locale. 394another locale. resource B<imLocale>.
395
396=item B<-imfont> I<fontset>
397
398Set the font set to use for the X Input Method, see resource B<imFont>
399for more info.
400
401=item B<-tcw>
402
403Change the meaning of triple-click selection with the left mouse
404button. Only effective when the original (non-perl) selection code is
405in-use. Instead of selecting a full line it will extend the selection to
406the end of the logical line only. resource B<tripleclickwords>.
263 407
264=item B<-insecure> 408=item B<-insecure>
265 409
266Enable "insecure" mode, which currently enables most of the escape 410Enable "insecure" mode, which currently enables most of the escape
267sequences that echo strings. See the resource B<insecure> for more 411sequences that echo strings. See the resource B<insecure> for more
281=item B<-ssr>|B<+ssr> 425=item B<-ssr>|B<+ssr>
282 426
283Turn on/off secondary screen scroll (default enabled); resource 427Turn on/off secondary screen scroll (default enabled); resource
284B<secondaryScroll>. 428B<secondaryScroll>.
285 429
430=item B<-hold>|B<+hold>
431
432Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
433will not immediately destroy its window when the program executed within
434it exits. Instead, it will wait till it is being killed or closed by the
435user; resource B<hold>.
436
437=item B<-cd> I<path>
438
439Sets the working directory for the shell (or the command specified via
440B<-e>). The I<path> must be an absolute path and it must exist for
441@@RXVT_NAME@@ to start; resource B<chdir>.
442
286=item B<-xrm> I<resourcestring> 443=item B<-xrm> I<string>
287 444
288No effect on rxvt. Simply passes through an argument to be made 445Works like the X Toolkit option of the same name, by adding the I<string>
289available in the instance's argument list. Appears in I<WM_COMMAND> in 446as if it were specified in a resource file. Resource values specified this
290some window managers. 447way take precedence over all other resource specifications.
448
449Note that you need to use the I<same> syntax as in the .Xdefaults file,
450e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
451options can be specified as long-options on the commandline, so use
452of B<-xrm> is mostly limited to cases where you want to specify other
453resources (e.g. for input methods) or for compatibility with other
454programs.
455
456=item B<-keysym.>I<sym> I<string>
457
458Remap a key symbol. See resource B<keysym>.
459
460=item B<-embed> I<windowid>
461
462Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
463which enables applications to easily embed a terminal.
464
465Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
466shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
467quite a bit, so don't expect it to keep some specific state. It's best to
468create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
469
470The window will not be destroyed when @@RXVT_NAME@@ exits.
471
472It might be useful to know that @@RXVT_NAME@@ will not close file
473descriptors passed to it (except for stdin/out/err, of course), so you
474can use file descriptors to communicate with the programs within the
475terminal. This works regardless of whether the C<-embed> option was used or
476not.
477
478Here is a short Gtk2-perl snippet that illustrates how this option can be
479used (a longer example is in F<doc/embed>):
480
481 my $rxvt = new Gtk2::Socket;
482 $rxvt->signal_connect_after (realize => sub {
483 my $xid = $_[0]->window->get_xid;
484 system "@@RXVT_NAME@@ -embed $xid &";
485 });
486
487=item B<-pty-fd> I<file descriptor>
488
489Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
490pair but instead use the given file descriptor as the tty master. This is
491useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
492without having to run a program within it.
493
494If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
495entries and will not tinker with pty/tty permissions - you have to do that
496yourself if you want that.
497
498As an extremely special case, specifying C<-1> will completely suppress
499pty/tty operations, which is probably only useful in conjunction with some
500perl extension that manages the terminal.
501
502Here is a example in perl that illustrates how this option can be used (a
503longer example is in F<doc/pty-fd>):
504
505 use IO::Pty;
506 use Fcntl;
507
508 my $pty = new IO::Pty;
509 fcntl $pty, F_SETFD, 0; # clear close-on-exec
510 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
511 close $pty;
512
513 # now communicate with rxvt
514 my $slave = $pty->slave;
515 while (<$slave>) { print $slave "got <$_>\n" }
516
517=item B<-pe> I<string>
518
519Comma-separated list of perl extension scripts to use (or not to use) in
520this terminal instance. See resource B<perl-ext> for details.
291 521
292=back 522=back
293 523
294=head1 RESOURCES (available also as long-options) 524=head1 RESOURCES
295 525
296Note: `@@RXVTNAME@@ --help' gives a list of all resources (long 526Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
297options) compiled into your version. 527options) compiled into your version. All resources are also available as
528long-options.
298 529
299There are two different methods that @@RXVTNAME@@ can use to get the 530You can set and change the resources using X11 tools like B<xrdb>. Many
300Xresource data: using the X libraries (Xrm*-functions) or internal 531distribution do also load settings from the B<~/.Xresources> file when X
301Xresources reader (B<~/.Xdefaults>). For the first method (ie. 532starts. @@RXVT_NAME@@ will consult the following files/resources in order,
302B<@@RXVTNAME@@ -h> lists B<XGetDefaults>), you can set and change the 533with later settings overwriting earlier ones:
303resources using X11 tools like B<xset>. Many distribution do also load
304settings from the B<~/.Xresources> file when X starts.
305 534
306If compiled with internal Xresources support (i.e. B<@@RXVTNAME@@ -h> 535 1. app-defaults file in $XAPPLRESDIR
307lists B<.Xdefaults>) then B<@@RXVTNAME@@> accepts application defaults 536 2. $HOME/.Xdefaults
308set in XAPPLOADDIR/URxvt (compile-time defined: usually 537 3. RESOURCE_MANAGER property on root-window of screen 0
309B</usr/lib/X11/app-defaults/URxvt>) and resources set in 538 4. SCREEN_RESOURCES property on root-window of the current screen
310B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist. 539 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
540 6. resources specified via -xrm on the commandline
541
311Note that when reading X resources, B<@@RXVTNAME@@> recognizes two 542Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
312class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 543names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
313resources common to both B<@@RXVTNAME@@> and the original I<rxvt> to be 544common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
314easily configured, while the class name B<URxvt> allows resources 545configured, while the class name B<URxvt> allows resources unique to
315unique to B<@@RXVTNAME@@>, notably colours and key-handling, to be 546B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
316shared between different B<@@RXVTNAME@@> configurations. If no 547configurations. If no resources are specified, suitable defaults will
317resources are specified, suitable defaults will be used. Command-line 548be used. Command-line arguments can be used to override resource
318arguments can be used to override resource settings. The following 549settings. The following resources are supported (you might want to
319resources are allowed: 550check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
551extensions not documented here):
320 552
321=over 4 553=over 4
554
555=item B<depth:> I<bitdepth>
556
557Compile I<xft>: Attempt to find a visual with the given bit depth;
558option B<-depth>.
559
560=item B<buffered:> I<boolean>
561
562Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
563On some card/driver combination enabling it slightly decreases
564performance, on most it greatly helps it. The slowdown is small, so it
565should normally be enabled.
322 566
323=item B<geometry:> I<geom> 567=item B<geometry:> I<geom>
324 568
325Create the window with the specified X window geometry [default 80x24]; 569Create the window with the specified X window geometry [default 80x24];
326option B<-geometry>. 570option B<-geometry>.
340Use the specified colour for the colour value I<n>, where 0-7 584Use the specified colour for the colour value I<n>, where 0-7
341corresponds to low-intensity (normal) colours and 8-15 corresponds to 585corresponds to low-intensity (normal) colours and 8-15 corresponds to
342high-intensity (bold = bright foreground, blink = bright background) 586high-intensity (bold = bright foreground, blink = bright background)
343colours. The canonical names are as follows: 0=black, 1=red, 2=green, 587colours. The canonical names are as follows: 0=black, 1=red, 2=green,
3443=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 5883=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
345names used are listed in the B<COLORS AND GRAPHICS> section. 589names used are listed in the B<COLOURS AND GRAPHICS> section.
590
591Colours higher than 15 cannot be set using resources (yet), but can be
592changed using an escape command (see @@RXVT_NAME@@(7)).
593
594Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
59588 colour support). Colours 80-87 are evenly spaces grey steps.
346 596
347=item B<colorBD:> I<colour> 597=item B<colorBD:> I<colour>
348 598
599=item B<colorIT:> I<colour>
600
349Use the specified colour to display bold characters when the foreground 601Use the specified colour to display bold or italic characters when the
350colour is the default. This option will be ignored if B<realBold> is 602foreground colour is the default. If font styles are not available
351enabled. 603(Compile I<styles>) and this option is unset, reverse video is used instead.
352 604
353=item B<colorUL:> I<colour> 605=item B<colorUL:> I<colour>
354 606
355Use the specified colour to display underlined characters when the 607Use the specified colour to display underlined characters when the
356foreground colour is the default. 608foreground colour is the default.
357 609
358=item B<colorRV:> I<colour> 610=item B<underlineColor:> I<colour>
359 611
612If set, use the specified colour as the colour for the underline
613itself. If unset, use the foreground colour.
614
615=item B<highlightColor:> I<colour>
616
360Use the specified colour as the background for reverse video 617If set, use the specified colour as the background for highlighted
361characters. 618characters. If unset, use reverse video.
619
620=item B<highlightTextColor:> I<colour>
621
622If set and highlightColor is set, use the specified colour as the
623foreground for highlighted characters.
362 624
363=item B<cursorColor:> I<colour> 625=item B<cursorColor:> I<colour>
364 626
365Use the specified colour for the cursor. The default is to use the 627Use the specified colour for the cursor. The default is to use the
366foreground colour; option B<-cr>. 628foreground colour; option B<-cr>.
373 635
374=item B<reverseVideo:> I<boolean> 636=item B<reverseVideo:> I<boolean>
375 637
376B<True>: simulate reverse video by foreground and background colours; 638B<True>: simulate reverse video by foreground and background colours;
377option B<-rv>. B<False>: regular screen colours [default]; option 639option B<-rv>. B<False>: regular screen colours [default]; option
378B<+rv>. See note in B<COLORS AND GRAPHICS> section. 640B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
379 641
380=item B<jumpScroll:> I<boolean> 642=item B<jumpScroll:> I<boolean>
381 643
382B<True>: specify that jump scrolling should be used. When scrolling 644B<True>: specify that jump scrolling should be used. When receiving lots
383quickly, fewer screen updates are performed [default]; option B<-j>. 645of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
646has been read, resulting in fewer updates while still displaying every
647received line; option B<-j>.
648
384B<False>: specify that smooth scrolling should be used; option B<+j>. 649B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
650force a screen refresh on each new line it received; option B<+j>.
385 651
386=item B<inheritPixmap:> I<boolean> 652=item B<skipScroll:> I<boolean>
387 653
388B<True>: make the background inherit the parent windows' pixmap, giving 654B<True>: (the default) specify that skip scrolling should be used. When
389artificial transparency. B<False>: do not inherit the parent windows' 655receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
390pixmap. 656(around 60 times per second), resulting in far fewer updates. This can
657result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
658option B<-ss>.
659
660B<False>: specify that everything is to be displayed, even
661if the refresh is too fast for the human eye to read anything (or the
662monitor to display anything); option B<+ss>.
391 663
392=item B<fading:> I<number> 664=item B<fading:> I<number>
393 665
394Fade the text by the given percentage when focus is lost. 666Fade the text by the given percentage when focus is lost; option B<-fade>.
395 667
396=item B<tintColor:> I<colour> 668=item B<fadeColor:> I<colour>
397 669
398Tint the transparent background pixmap with the given colour. 670Fade to this colour, when fading is used (see B<fading:>). The default
671colour is black; option B<-fadecolor>.
399 672
400=item B<shading:> I<number> 673=item B<iconFile:> I<file>
401 674
402Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 675Set the application icon pixmap; option B<-icon>.
403image in addition to tinting it.
404
405=item B<fading:> I<number>
406
407Scale the tint colour by the given percentage.
408 676
409=item B<scrollColor:> I<colour> 677=item B<scrollColor:> I<colour>
410 678
411Use the specified colour for the scrollbar [default #B2B2B2]. 679Use the specified colour for the scrollbar [default #B2B2B2].
412 680
413=item B<troughColor:> I<colour> 681=item B<troughColor:> I<colour>
414 682
415Use the specified colour for the scrollbar's trough area [default 683Use the specified colour for the scrollbar's trough area [default
416#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 684#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
417 685
418=item B<backgroundPixmap:> I<file[;geom]> 686=item B<borderColor:> I<colour>
419 687
420Use the specified XPM file (note the `.xpm' extension is optional) for 688The colour of the border around the text area and between the scrollbar
421the background and also optionally specify its scaling with a geometry 689and the text.
422string B<WxH+X+Y>, in which B<"W" / "H"> specify the
423horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image
424centre (percent). A scale of 0 displays the image with tiling. A scale
425of 1 displays the image without any scaling. A scale of 2 to 9
426specifies an integer number of images in that direction. No image will
427be magnified beyond 10 times its original size. The maximum permitted
428scale is 1000. [default 0x0+50+50]
429 690
430=item B<menu:> I<file[;tag]>
431
432Read in the specified menu file (note the `.menu' extension is
433optional) and also optionally specify a starting tag to find. See the
434reference documentation for details on the syntax for the menuBar.
435
436=item B<path:> I<path>
437
438Specify the colon-delimited search path for finding files (XPM and
439menus), in addition to the paths specified by the B<RXVTPATH> and
440B<PATH> environment variables.
441
442=item B<font:> I<fontname> 691=item B<font:> I<fontlist>
443 692
444Select the fonts to be used. This is a comma seperated list of font 693Select the fonts to be used. This is a comma separated list of font names
445names that are used in turn when trying to display Unicode characters. 694that are checked in order when trying to find glyphs for characters. The
446The first font defines the cell size for characters; other fonts might 695first font defines the cell size for characters; other fonts might be
447be smaller, but not larger. A reasonable default font list is always 696smaller, but not (in general) larger. A (hopefully) reasonable default
448appended to it. option B<-fn>. 697font list is always appended to it; option B<-fn>.
449 698
450=item B<realBold:> I<boolean> 699Each font can either be a standard X11 core font (XLFD) name, with
700optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
451 701
452B<True>: Enable "real bold" support. When this option is on, bold text 702In addition, each font can be prefixed with additional hints and
453will be displayed using the first available bold font in the font list. 703specifications enclosed in square brackets (C<[]>). The only available
454Bold fonts should thus be specified in the font list after their 704hint currently is C<codeset=codeset-name>, and this is only used for Xft
455corresponding regular fonts. If no bold font can be found, a regular 705fonts.
456font will be used. option B<-rb>. B<False>: Display bold text in a
457regular font, using the color specified with B<colorBD>; option B<+rb>.
458 706
459=item B<selectstyle:> I<mode> 707For example, this font resource
460 708
461Set mouse selection style to B<old> which is 2.20, B<oldword> which is 709 URxvt.font: 9x15bold,\
462xterm style with 2.20 old word selection, or anything else which gives 710 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
463xterm style selection. 711 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
712 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
713 xft:Code2000:antialias=false
464 714
465=item B<scrollstyle:> I<mode> 715specifies five fonts to be used. The first one is C<9x15bold> (actually
716the iso8859-1 version of the second font), which is the base font (because
717it is named first) and thus defines the character cell grid to be 9 pixels
718wide and 15 pixels high.
466 719
467Set scrollbar style to B<@@RXVTNAME@@>, B<rxvt>, B<plain>, B<next> or 720The second font is just used to add additional unicode characters not in
468B<xterm> 721the base font, likewise the third, which is unfortunately non-bold, but
722the bold version of the font does contain fewer characters, so this is a
723useful supplement.
724
725The third font is an Xft font with aliasing turned off, and the characters
726are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
727contains other characters, but we are not interested in them.
728
729The last font is a useful catch-all font that supplies most of the
730remaining unicode characters.
731
732=item B<boldFont:> I<fontlist>
733
734=item B<italicFont:> I<fontlist>
735
736=item B<boldItalicFont:> I<fontlist>
737
738The font list to use for displaying B<bold>, I<italic> or B<< I<bold
739italic> >> characters, respectively.
740
741If specified and non-empty, then the syntax is the same as for the
742B<font>-resource, and the given font list will be used as is, which makes
743it possible to substitute completely different font styles for bold and
744italic.
745
746If unset (the default), a suitable font list will be synthesized by
747"morphing" the normal text font list into the desired shape. If that is
748not possible, replacement fonts of the desired shape will be tried.
749
750If set, but empty, then this specific style is disabled and the normal
751text font will being used for the given style.
752
753=item B<intensityStyles:> I<boolean>
754
755When font styles are not enabled, or this option is enabled (B<True>,
756option B<-is>, the default), bold/blink font styles imply high
757intensity foreground/background colours. Disabling this option (B<False>,
758option B<+is>) disables this behaviour, the high intensity colours are not
759reachable.
469 760
470=item B<title:> I<string> 761=item B<title:> I<string>
471 762
472Set window title string, the default title is the command-line 763Set window title string, the default title is the command-line
473specified after the B<-e> option, if any, otherwise the application 764specified after the B<-e> option, if any, otherwise the application
482=item B<mapAlert:> I<boolean> 773=item B<mapAlert:> I<boolean>
483 774
484B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 775B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
485de-iconify (map) on receipt of a bell character [default]. 776de-iconify (map) on receipt of a bell character [default].
486 777
778=item B<urgentOnBell:> I<boolean>
779
780B<True>: set the urgency hint for the wm on receipt of a bell character.
781B<False>: do not set the urgency hint [default].
782
783@@RXVT_NAME@@ resets the urgency hint on every focus change.
784
487=item B<visualBell:> I<boolean> 785=item B<visualBell:> I<boolean>
488 786
489B<True>: use visual bell on receipt of a bell character; option B<-vb>. 787B<True>: use visual bell on receipt of a bell character; option B<-vb>.
490B<False>: no visual bell [default]; option B<+vb>. 788B<False>: no visual bell [default]; option B<+vb>.
491 789
493 791
494B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 792B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
495the shell; option B<-ls>. B<False>: start as a normal sub-shell 793the shell; option B<-ls>. B<False>: start as a normal sub-shell
496[default]; option B<+ls>. 794[default]; option B<+ls>.
497 795
796=item B<multiClickTime:> I<number>
797
798Specify the maximum time in milliseconds between multi-click select
799events. The default is 500 milliseconds; option B<-mc>.
800
498=item B<utmpInhibit:> I<boolean> 801=item B<utmpInhibit:> I<boolean>
499 802
500B<True>: inhibit writing record into the system log file B<utmp>; 803B<True>: inhibit writing record into the system log file B<utmp>;
501option B<-ut>. B<False>: write record into the system log file B<utmp> 804option B<-ut>. B<False>: write record into the system log file B<utmp>
502[default]; option B<+ut>. 805[default]; option B<+ut>.
505 808
506Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 809Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
507B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 810B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
508B<Shift-Print> to include the scrollback as well. 811B<Shift-Print> to include the scrollback as well.
509 812
813The string will be interpreted as if typed into the shell as-is.
814
815Example:
816
817 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
818
819This creates a new file in your home directory with the screen contents
820every time you hit C<Print>.
821
822=item B<scrollstyle:> I<mode>
823
824Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
825the author's favourite.
826
827=item B<thickness:> I<number>
828
829Set the scrollbar width in pixels.
830
510=item B<scrollBar:> I<boolean> 831=item B<scrollBar:> I<boolean>
511 832
512B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 833B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
513disable the scrollbar; option B<+sb>. 834disable the scrollbar; option B<+sb>.
514 835
527Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar 848Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar
528thumb with the pointer on middle button press/drag. 849thumb with the pointer on middle button press/drag.
529 850
530=item B<scrollTtyOutput:> I<boolean> 851=item B<scrollTtyOutput:> I<boolean>
531 852
532B<True>: scroll to bottom when tty receives output; option B<+si>. 853B<True>: scroll to bottom when tty receives output; option B<-si>.
533B<False>: do not scroll to bottom when tty receives output; option 854B<False>: do not scroll to bottom when tty receives output; option
534B<-si>. 855B<+si>.
535 856
536=item B<scrollWithBuffer:> I<boolean> 857=item B<scrollWithBuffer:> I<boolean>
537 858
538B<True>: scroll with scrollback buffer when tty recieves new lines (and 859B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
539B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 860try to show the same lines) and B<scrollTtyOutput> is False; option
540with scrollback buffer when tty recieves new lines; option B<-sw>. 861B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
862new lines; option B<+sw>.
541 863
542=item B<scrollTtyKeypress:> I<boolean> 864=item B<scrollTtyKeypress:> I<boolean>
543 865
544B<True>: scroll to bottom when a non-special key is pressed. Special 866B<True>: scroll to bottom when a non-special key is pressed. Special keys
545keys are those which are intercepted by rxvt for special handling and 867are those which are intercepted by rxvt-unicode for special handling and
546are not passed onto the shell; option B<-sk>. B<False>: do not scroll 868are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
547to bottom when a non-special key is pressed; option B<+sk>. 869bottom when a non-special key is pressed; option B<+sk>.
548
549=item B<smallfont_key:> I<keysym>
550
551If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a smaller font
552[default B<@@HOTKEY@@-@@SMALLFONT@@>]
553
554=item B<bigfont_key:> I<keysym>
555
556If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a bigger font
557[default B<@@HOTKEY@@-@@BIGFONT@@>]
558 870
559=item B<saveLines:> I<number> 871=item B<saveLines:> I<number>
560 872
561Save I<number> lines in the scrollback buffer [default 64]. This 873Save I<number> lines in the scrollback buffer [default 64]. This
562resource is limited on most machines to 65535; option B<-sl>. 874resource is limited on most machines to 65535; option B<-sl>.
572option B<-w>, B<-bw>, B<-borderwidth>. 884option B<-w>, B<-bw>, B<-borderwidth>.
573 885
574=item B<borderLess:> I<boolean> 886=item B<borderLess:> I<boolean>
575 887
576Set MWM hints to request a borderless window, i.e. if honoured by the 888Set MWM hints to request a borderless window, i.e. if honoured by the
577WM, the rxvt window will not have window decorations; option B<-bl>. 889WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
890
891=item B<skipBuiltinGlyphs:> I<boolean>
892
893Compile I<frills>: Disable the usage of the built-in block graphics/line
894drawing characters and just rely on what the specified fonts provide. Use
895this if you have a good font and want to use its block graphic glyphs;
896option B<-sbg>.
578 897
579=item B<termName:> I<termname> 898=item B<termName:> I<termname>
580 899
581Specifies the terminal type name to be set in the B<TERM> environment 900Specifies the terminal type name to be set in the B<TERM> environment
582variable; option B<-tn>. 901variable; option B<-tn>.
583 902
584=item B<linespace:> I<number> 903=item B<lineSpace:> I<number>
585 904
586Specifies number of lines (pixel height) to insert between each row of 905Specifies number of lines (pixel height) to insert between each row of
587the display [default 0]; option B<-lsp>. 906the display [default 0]; option B<-lsp>.
588 907
589=item B<meta8:> I<boolean> 908=item B<meta8:> I<boolean>
594=item B<mouseWheelScrollPage:> I<boolean> 913=item B<mouseWheelScrollPage:> I<boolean>
595 914
596B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel 915B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
597scrolls five lines [default]. 916scrolls five lines [default].
598 917
918=item B<pastableTabs:> I<boolean>
919
920B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
921movement only; option C<-ptab>.
922
599=item B<cursorBlink:> I<boolean> 923=item B<cursorBlink:> I<boolean>
600 924
601B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 925B<True>: blink the cursor. B<False>: do not blink the cursor [default];
602option B<-bc>. 926option B<-bc>.
927
928=item B<cursorUnderline:> I<boolean>
929
930B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
931option B<-uc>.
603 932
604=item B<pointerBlank:> I<boolean> 933=item B<pointerBlank:> I<boolean>
605 934
606B<True>: blank the pointer when a key is pressed or after a set number 935B<True>: blank the pointer when a key is pressed or after a set number
607of seconds of inactivity. B<False>: the pointer is always visible 936of seconds of inactivity. B<False>: the pointer is always visible
615 944
616Mouse pointer background colour. 945Mouse pointer background colour.
617 946
618=item B<pointerBlankDelay:> I<number> 947=item B<pointerBlankDelay:> I<number>
619 948
620Specifies number of seconds before blanking the pointer [default 2]. 949Specifies number of seconds before blanking the pointer [default 2]. Use a
950large number (e.g. C<987654321>) to effectively disable the timeout.
621 951
622=item B<backspacekey:> I<string> 952=item B<backspacekey:> I<string>
623 953
624The string to send when the backspace key is pressed. If set to B<DEC> 954The string to send when the backspace key is pressed. If set to B<DEC>
625or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 955or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
626(code 8) - which can be reversed with the appropriate DEC private mode 956(code 8) - which can be reversed with the appropriate DEC private mode
627escape sequence. 957escape sequence.
628 958
629=item B<deletekey:> I<string> 959=item B<deletekey:> I<string>
630 960
632pressed. If unset it will send the sequence traditionally associated 962pressed. If unset it will send the sequence traditionally associated
633with the B<Execute> key. 963with the B<Execute> key.
634 964
635=item B<cutchars:> I<string> 965=item B<cutchars:> I<string>
636 966
637The characters used as delimiters for double-click word selection. The 967The characters used as delimiters for double-click word selection
638built-in default: 968(whitespace delimiting is added automatically if resource is given).
639 969
970When the perl selection extension is in use (the default if compiled
971in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
972characters will be created (if the resource exists, otherwise, no regex
973will be created). In this mode, characters outside ISO-8859-1 can be used.
974
975When the selection extension is not used, only ISO-8859-1 characters can
976be used. If not specified, the built-in default is used:
977
640B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 978B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
641 979
642=item B<preeditType:> I<style> 980=item B<preeditType:> I<style>
643 981
644B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 982B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
645 983
647 985
648I<name> of inputMethod to use; option B<-im>. 986I<name> of inputMethod to use; option B<-im>.
649 987
650=item B<imLocale:> I<name> 988=item B<imLocale:> I<name>
651 989
652The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 990The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
653de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 991C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
654extension to be able to input japanese characters while staying in 992input extension to be able to input japanese characters while staying in
655another locale. option B<-imlocale>. 993another locale; option B<-imlocale>.
656 994
657=item B<insecure> 995=item B<imFont:> I<fontset>
996
997Specify the font-set used for XIM styles C<OverTheSpot> or
998C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
999by commas), i.e. it's not in the same format as the other font lists used
1000in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
1001found, preferably one or two pixels differing in size to the base font.
1002option B<-imfont>.
1003
1004=item B<tripleclickwords:> I<boolean>
1005
1006Change the meaning of triple-click selection with the left mouse
1007button. Instead of selecting a full line it will extend the selection to
1008the end of the logical line only; option B<-tcw>.
1009
1010=item B<insecure:> I<boolean>
658 1011
659Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1012Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
660echo arbitrary strings like the icon name or the locale. This could be 1013echo arbitrary strings like the icon name or the locale. This could be
661abused if somebody gets 8-bit-clean access to your display, wether 1014abused if somebody gets 8-bit-clean access to your display, whether
662throuh a mail client displaying mail bodies unfiltered or though 1015through a mail client displaying mail bodies unfiltered or through
663write(1). Therefore, these sequences are disabled by default. (Note 1016write(1) or any other means. Therefore, these sequences are disabled by
664that other terminals, including xterm, have these sequences 1017default. (Note that many other terminals, including xterm, have these
665enabled by default). You can enable them by setting this boolean 1018sequences enabled by default, which doesn't make it safer, though).
666resource or specifying B<-insecure> as an option. At the moment, this 1019
667enabled display-answer, locale, findfont, icon label and window title 1020You can enable them by setting this boolean resource or specifying
668requests as well as dynamic menubar dispatch. 1021B<-insecure> as an option. At the moment, this enables display-answer,
1022locale, findfont, icon label and window title requests.
669 1023
670=item B<modifier:> I<modifier> 1024=item B<modifier:> I<modifier>
671 1025
672Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 1026Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
673B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 1027B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
674B<-mod>. 1028B<-mod>.
675 1029
676=item B<answerbackString:> I<string> 1030=item B<answerbackString:> I<string>
677 1031
678Specify the reply rxvt sends to the shell when an ENQ (control-E) 1032Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
679character is passed through. It may contain escape values as described 1033character is passed through. It may contain escape values as described
680in the entry on B<keysym> following. 1034in the entry on B<keysym> following.
681 1035
682=item B<secondaryScreen:> I<bool> 1036=item B<secondaryScreen:> I<boolean>
683 1037
684Turn on/off secondary screen (default enabled). 1038Turn on/off secondary screen (default enabled).
685 1039
686=item B<secondaryScroll:> I<bool> 1040=item B<secondaryScroll:> I<boolean>
687 1041
688Turn on/off secondary screen scroll (default enabled). If the this 1042Turn on/off secondary screen scroll (default enabled). If this
689option is enabled, scrolls on the secondary screen will change the 1043option is enabled, scrolls on the secondary screen will change the
690scrollback buffer and switching to/from the secondary screen will 1044scrollback buffer and, when secondaryScreen is off, switching
691instead scroll the screen up. 1045to/from the secondary screen will instead scroll the screen up.
692 1046
1047=item B<hold>: I<boolean>
1048
1049Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1050will not immediately destroy its window when the program executed within
1051it exits. Instead, it will wait till it is being killed or closed by the
1052user.
1053
1054=item B<chdir>: I<path>
1055
1056Sets the working directory for the shell (or the command specified via
1057B<-e>). The I<path> must be an absolute path and it must exist for
1058@@RXVT_NAME@@ to start. If it isn't specified then the current working
1059directory will be used; option B<-cd>.
1060
693=item B<keysym.>I<sym>: I<string> 1061=item B<keysym.>I<sym>: I<action>
694 1062
695Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 1063Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
696contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 1064resource name B<keysym.> cannot be omitted.
697newline, \r: return, \t: 1065
698tab, \000: octal number) or control characters (^?: delete, ^@: null, 1066Using this resource, you can map key combinations such as
699^A ...) and may enclosed with double quotes so that it can start or end 1067C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
700with whitespace. The intervening resource name B<keysym.> cannot be 1068string than would normally result from that combination, making the
701omitted. This resource is only available when compiled with 1069terminal scroll up or down the way you want it, or any other thing an
702KEYSYM_RESOURCE. 1070extension might provide.
1071
1072The key combination that triggers the action, I<sym>, has the following format:
1073
1074 (modifiers-)key
1075
1076Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
1077B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
1078B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
1079B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1080
1081The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1082whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1083keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1084current application keymap mode state.
1085
1086Due the the large number of modifier combinations, a key mapping will
1087match if I<at least> the specified identifiers are being set, and no other
1088key mappings with those and more bits are being defined. That means that
1089defining a mapping for C<a> will automatically provide definitions for
1090C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1091themselves. See the C<builtin:> action, below, for a way to work around
1092this when this is a problem.
1093
1094The spelling of I<key> depends on your implementation of X. An easy way to
1095find a key name is to use the B<xev>(1) command. You can find a list by
1096looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1097the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1098value (B<0x0000 - 0xFFFF>).
1099
1100As with any resource value, the I<action> string may contain backslash
1101escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1102number), see RESOURCES in C<man 7 X> for further details.
1103
1104An action starts with an action prefix that selects a certain type
1105of action, followed by a colon. An action string without colons is
1106interpreted as a literal string to pass to the tty (as if it was
1107prefixed with C<string:>).
1108
1109The following action prefixes are known - extensions can provide
1110additional prefixes:
1111
1112=over 4
1113
1114=item string:STRING
1115
1116If the I<action> starts with C<string:> (or otherwise contains no colons),
1117then the remaining C<STRING> will be passed to the program running in the
1118terminal. For example, you could replace whatever Shift-Tab outputs by the
1119string C<echo rm -rf /> followed by a newline:
1120
1121 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1122
1123This could in theory be used to completely redefine your keymap.
1124
1125In addition, for actions of this type, you can define a range of
1126keysyms in one shot by loading the C<keysym-list> perl extension and
1127providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1128the delimiter `/' should be a character not used by the strings.
1129
1130Its usage can be demonstrated by an example:
1131
1132 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1133
1134The above line is equivalent to the following three lines:
1135
1136 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1137 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1138 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1139
1140=item command:STRING
1141
1142If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1143is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1144the opposite of C<string:> - instead of sending it to the program running
1145in the terminal, it will be treated as if it were program output). This is
1146most useful to feed command sequences into @@RXVT_NAME@@.
1147
1148For example the following means "change the current locale to C<zh_CN.GBK>
1149when Control-Meta-c is being pressed":
1150
1151 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1152
1153The following example will map Control-Meta-1 and Control-Meta-2 to
1154the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1155font-switching at runtime:
1156
1157 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1158 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1159
1160Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1161info):
1162
1163 URxvt.keysym.M-C-3: command:\033[8;25;80t
1164 URxvt.keysym.M-C-4: command:\033[8;48;110t
1165
1166=item builtin:
1167
1168The builtin action is the action that @@RXVT_NAME@@ would execute if no
1169key binding existed for the key combination. The obvious use is to undo
1170the effect of existing bindings. The not so obvious use is to reinstate
1171bindings when another binding overrides too many modifiers.
1172
1173For example if you overwrite the C<Insert> key you will disable
1174@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1175"holes" into the user-defined keymap using the C<builtin:> replacement:
1176
1177 URxvt.keysym.Insert: <my insert key sequence>
1178 URxvt.keysym.S-Insert: builtin:
1179
1180The first line defines a mapping for C<Insert> and I<any> combination
1181of modifiers. The second line re-establishes the default mapping for
1182C<Shift-Insert>.
1183
1184=item builtin-string:
1185
1186This action is mainly useful to restore string mappings for keys that
1187have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1188difficult to explain - basically, this action will send the string to the
1189application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1190action for it.
1191
1192An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1193selection when you press C<Shift-Insert>. With the following bindings, it
1194would instead emit the (undocumented, but what applications running in the
1195terminal might expect) sequence C<ESC [ 2 $> instead:
1196
1197 URxvt.keysym.S-Insert: builtin-string:
1198 URxvt.keysym.C-S-Insert: builtin:
1199
1200The first line disables the paste functionality for that key
1201combination, and the second reinstates the default behaviour for
1202C<Control-Shift-Insert>, which would otherwise be overridden.
1203
1204Similarly, to let applications gain access to the C<C-M-c> (copy to
1205clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1206this:
1207
1208 URxvt.keysym.C-M-c: builtin-string:
1209 URxvt.keysym.C-M-v: builtin-string:
1210
1211=item EXTENSION:STRING
1212
1213An action of this form invokes the action B<STRING>, if any, provided
1214by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1215be loaded automatically if necessary.
1216
1217Not all extensions define actions, but popular extensions that do
1218include the I<selection> and I<matcher> extensions (documented in their
1219own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1220respectively).
1221
1222From the silly examples department, this will rot13-"encrypt"
1223@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1224keyboards:
1225
1226 URxvt.keysym.M-C-c: selection:rot13
1227
1228=item perl:STRING *DEPRECATED*
1229
1230This is a deprecated way of invoking commands provided by perl
1231extensions. It is still supported, but should not be used anymore.
703 1232
704=back 1233=back
705 1234
1235=item B<perl-ext-common>: I<string>
1236
1237=item B<perl-ext>: I<string>
1238
1239Comma-separated list(s) of perl extension scripts (default: C<default>) to
1240use in this terminal instance; option B<-pe>.
1241
1242Extension names can be prefixed with a C<-> sign to prohibit using
1243them. This can be useful to selectively disable some extensions loaded
1244by default, or specified via the C<perl-ext-common> resource. For
1245example, C<default,-selection> will use all the default extensions except
1246C<selection>.
1247
1248The default set includes the C<selection>, C<option-popup>,
1249C<selection-popup>, C<readline> and C<searchable-scrollback>
1250extensions, and extensions which are 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.
1431
1432=back
1433
706=head1 THE SCROLLBAR 1434=head1 THE SCROLLBAR
707 1435
708Lines of text that scroll off the top of the B<@@RXVTNAME@@> window 1436Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
709(resource: B<saveLines>) and can be scrolled back using the scrollbar 1437(resource: B<saveLines>) and can be scrolled back using the scrollbar
710or by keystrokes. The normal B<@@RXVTNAME@@> scrollbar has arrows and 1438or by keystrokes. The normal B<@@RXVT_NAME@@> scrollbar has arrows and
711its behaviour is fairly intuitive. The B<xterm-scrollbar> is without 1439its behaviour is fairly intuitive. The B<xterm-scrollbar> is without
712arrows and its behaviour mimics that of I<xterm> 1440arrows and its behaviour mimics that of I<xterm>
713 1441
714Scroll down with B<Button1> (B<xterm-scrollbar>) or B<Shift-Next>. 1442Scroll down with B<Button1> (B<xterm-scrollbar>) or B<Shift-Next>.
715Scroll up with B<Button3> (B<xterm-scrollbar>) or B<Shift-Prior>. 1443Scroll up with B<Button3> (B<xterm-scrollbar>) or B<Shift-Prior>.
721the normal text selection/insertion, hold either the Shift or the Meta 1449the normal text selection/insertion, hold either the Shift or the Meta
722(Alt) key while performing the desired mouse action. 1450(Alt) key while performing the desired mouse action.
723 1451
724If mouse reporting mode is active, the normal scrollbar actions are 1452If mouse reporting mode is active, the normal scrollbar actions are
725disabled -- on the assumption that we are using a fullscreen 1453disabled -- on the assumption that we are using a fullscreen
726application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1454application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
727(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1455(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
728up 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),
729respectively. 1457respectively.
730 1458
731=head1 TEXT SELECTION AND INSERTION 1459=head1 THE SELECTION: SELECTING AND PASTING TEXT
732 1460
733The behaviour of text selection and insertion mechanism is similar to 1461The behaviour of text selection and insertion/pasting mechanism is similar
734I<xterm>(1). 1462to I<xterm>(1).
735 1463
736=over 4 1464=over 4
737 1465
738=item B<Selection>: 1466=item B<Selecting>:
739 1467
740Left 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
741region and release; Right click to extend the marked region; Left 1469and release; Right click to extend the marked region; Left double-click
742double-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
743line. 1471(which can span multiple screen lines), unless modified by resource
1472B<tripleclickwords>.
744 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
745=item B<Insertion>: 1480=item B<Pasting>:
746 1481
747Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1482Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
748an B<@@RXVTNAME@@> window causes the current text selection to be 1483window causes the value of the PRIMARY selection (or CLIPBOARD with the
749inserted 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.
750 1494
751=back 1495=back
752 1496
753=head1 CHANGING FONTS 1497=head1 CHANGING FONTS
754 1498
755You 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
756default font and others of various sizes, by using B<Shift-KP_Add> and 1500supported in rxvt-unicode. Bug me if you need this.
757B<Shift-KP_Subtract>. Or, alternatively (if enabled) with 1501
758B<@@HOTKEY@@-@@BIGFONT@@> and B<@@HOTKEY@@-@@SMALLFONT@@>, where the 1502You can, however, switch fonts at runtime using escape sequences, e.g.:
759actual key can be selected using resources 1503
760B<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.
1512
1513=head1 ISO 14755 SUPPORT
1514
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>.
1520
1521=over 4
1522
1523=item * 5.1: Basic method
1524
1525This allows you to enter unicode characters using their hexcode.
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.
761 1577
762=head1 LOGIN STAMP 1578=head1 LOGIN STAMP
763 1579
764B<@@RXVTNAME@@> 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
765that 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
766To allow this feature, B<@@RXVTNAME@@> must be installed setuid root on 1582allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
767some systems. 1583on some systems or setgid to root or to some other group on others.
768 1584
769=head1 COLORS AND GRAPHICS 1585=head1 COLOURS AND GRAPHICS
770 1586
771In addition to the default foreground and background colours, 1587In addition to the default foreground and background colours,
772B<@@RXVTNAME@@> can display up to 16 colours (8 ANSI colours plus 1588B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
773high-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
774colours 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.
775 1594
776=begin table 1595=begin table
777 1596
778 B<color0> (black) = Black 1597 B<color0> (black) = Black
779 B<color1> (red) = Red3 1598 B<color1> (red) = Red3
799It is also possible to specify the colour values of B<foreground>, 1618It is also possible to specify the colour values of B<foreground>,
800B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1619B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
801a 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
802color0-color15. 1621color0-color15.
803 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
804Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1642Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
805always swapping the foreground/background colours. This is in contrast to 1643always swapping the foreground/background colours. This is in contrast to
806I<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
807been specified. For example, 1645been specified. For example,
808 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
809=over 4 1702=over 4
810 1703
811=item B<rxvt -fg Black -bg White -rv> 1704=item B<TERM>
812 1705
813would 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
814on 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@@.
815 1778
816=back 1779=back
817 1780
818=head1 ENVIRONMENT
819
820B<@@RXVTNAME@@> sets the environment variables B<TERM>, B<COLORTERM>
821and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X
822window id number of the B<@@RXVTNAME@@> window and it also uses and
823sets the environment variable B<DISPLAY> to specify which display
824terminal to use. B<@@RXVTNAME@@> uses the environment variables
825B<RXVTPATH> and B<PATH> to find XPM files.
826
827=head1 FILES 1781=head1 FILES
828 1782
829=over 4 1783=over 4
830 1784
831=item B</etc/utmp>
832
833System file for login records.
834
835=item B</usr/lib/X11/rgb.txt> 1785=item B</usr/lib/X11/rgb.txt>
836 1786
837Color names. 1787Colour names.
838 1788
839=back 1789=back
840 1790
841=head1 SEEALSO 1791=head1 SEE ALSO
842 1792
843I<xterm>(1), I<sh>(1), I<resize>(1), I<X>(1), I<pty>(4), I<tty>(4), I<utmp>(5) 1793@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
844 1794@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
845See rxvtRef.html rxvtRef.txt for detailed information on recognized escape sequences and menuBar syntax, etc.
846
847=head1 BUGS
848
849Check the BUGS file for an up-to-date list.
850
851Cursor change support is not yet implemented.
852
853Click-and-drag doesn't work with X11 mouse report overriding.
854
855=head1 FTP LOCATION
856
857rxvt-+@@RXVTVERSION@@.tar.gz can be found at the following ftp sites L<@@RXVTFTPSITE@@>(@@RXVTFTPSITE@@)
858 1795
859=head1 CURRENT PROJECT COORDINATOR 1796=head1 CURRENT PROJECT COORDINATOR
860 1797
861=over 4 1798=over 4
862 1799
863=item Project Coordinator 1800=item Project Coordinator
864 1801
865@@RXVTMAINT@@ L<@@RXVTMAINTEMAIL@@> 1802Marc A. Lehmann <rxvt-unicode@schmorp.de>.
866 1803
867=item Web page maintainter 1804L<http://software.schmorp.de/pkg/rxvt-unicode.html>
868
869@@RXVTWEBMAINT@@ L<@@RXVTWEBMAINTEMAIL@@>
870
871L<@@RXVTWEBPAGE@@>(@@RXVTWEBPAGE@@)
872 1805
873=back 1806=back
874 1807
875=head1 AUTHORS 1808=head1 AUTHORS
876 1809
878 1811
879=item John Bovey 1812=item John Bovey
880 1813
881University of Kent, 1992, wrote the original Xvt. 1814University of Kent, 1992, wrote the original Xvt.
882 1815
883=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1816=item Rob Nation <nation@rocket.sanders.lockheed.com>
884 1817
885very heavily modified Xvt and came up with Rxvt 1818very heavily modified Xvt and came up with Rxvt
886 1819
887=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1820=item Angelo Haritsis <ah@doc.ic.ac.uk>
888 1821
889wrote the Greek Keyboard Input (no longer in code) 1822wrote the Greek Keyboard Input (no longer in code)
890 1823
891=item mj olesen L<< <olesen@me.QueensU.CA> >> 1824=item mj olesen <olesen@me.QueensU.CA>
892 1825
893Wrote the menu system. 1826Wrote the menu system.
894 1827
895Project Coordinator (changes.txt 2.11 to 2.21) 1828Project Coordinator (changes.txt 2.11 to 2.21)
896 1829
897=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1830=item Oezguer Kesim <kesim@math.fu-berlin.de>
898 1831
899Project Coordinator (changes.txt 2.21a to 2.4.5) 1832Project Coordinator (changes.txt 2.21a to 2.4.5)
900 1833
901=item Geoff Wing L<< <gcw@pobox.com> >> 1834=item Geoff Wing <gcw@pobox.com>
902 1835
903Rewrote screen display and text selection routines. Project Coordinator 1836Rewrote screen display and text selection routines.
1837
904(changes.txt 2.4.6 - rxvt-unicode) 1838Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
905 1839
906=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1840=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
907 1841
908Forked rxvt-unicode, rewrote most of the display code and internal 1842Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
909character handling to store text in unicode, improve xterm 1843extension, random hacks, numerous bugfixes and extensions.
910compatibility and apply numerous other bugfixes and extensions.
911 1844
912Project Coordinator (Changes 1.0 -) 1845Project Coordinator (Changes 1.0 -)
913 1846
1847=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1848
1849pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1850
914=back 1851=back
915 1852

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines