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.43 by root, Sun Jan 16 19:22:16 2005 UTC vs.
Revision 1.230 by sf-exg, Mon Apr 28 16:00:34 2014 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines