3 rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window system)
7 B<@@RXVT_NAME@@> [options] [-e command [ args ]]
11 B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal
12 emulator intended as an I<xterm>(1) replacement for users who do not
13 require features such as Tektronix 4014 emulation and toolkit-style
14 configurability. As a result, B<rxvt-unicode> uses much less swap space --
15 a significant advantage on a machine serving many X sessions.
17 This document is also available on the World-Wide-Web at
18 L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
20 =head1 FREQUENTLY ASKED QUESTIONS
22 See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
23 frequently asked questions and answer to them and some common
24 problems. That document is also accessible on the World-Wide-Web at
25 L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
27 =head1 RXVT-UNICODE VS. RXVT
29 Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
30 internally. That means it can store and display most scripts in the
31 world. Being a terminal emulator, however, some things are very difficult,
32 especially cursive scripts such as arabic, vertically written scripts
33 like mongolian or scripts requiring extremely complex combining rules,
34 like tibetan or devanagari. Don't expect pretty output when using these
35 scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
36 fine, though. A somewhat difficult case are right-to-left scripts, such
37 as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
38 belong in the application, not the terminal emulator (too many things --
39 such as cursor-movement while editing -- break otherwise), but that might
42 If you are looking for a terminal that supports more exotic scripts, let
43 me recommend C<mlterm>, which is a very user friendly, lean and clean
44 terminal emulator. In fact, the reason rxvt-unicode was born was solely
45 because the author couldn't get C<mlterm> to use one font for latin1 and
48 Therefore another design rationale was the use of multiple fonts to
49 display characters: The idea of a single unicode font which many other
50 programs force onto its users never made sense to me: You should be able
51 to choose any font for any script freely.
53 Apart from that, rxvt-unicode is also much better internationalised than
54 its predecessor, supports things such as XFT and ISO 14755 that are handy
55 in i18n-environments, is faster, and has a lot bugs less than the original
56 rxvt. This all in addition to dozens of other small improvements.
58 It is still faithfully following the original rxvt idea of being lean
59 and nice on resources: for example, you can still configure rxvt-unicode
60 without most of its features to get a lean binary. It also comes with
61 a client/daemon pair that lets you open any number of terminal windows
62 from within a single process, which makes startup time very fast and
63 drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
64 @@RXVT_NAME@@c(1) (client).
66 It also makes technical information about escape sequences (which have
67 been extended) more accessible: see @@RXVT_NAME@@(7) for technical
68 reference documentation (escape sequences etc.).
72 The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
73 below. In keeping with the smaller-is-better philosophy, options may be
74 eliminated or default values chosen at compile-time, so options and
75 defaults listed may not accurately reflect the version installed on
76 your system. `@@RXVT_NAME@@ -h' gives a list of major compile-time options on
77 the I<Options> line. Option descriptions may be prefixed with which
78 compile option each is dependent upon. e.g. `Compile I<XIM>:' requires
79 I<XIM> on the I<Options> line. Note: `@@RXVT_NAME@@ -help' gives a list of all
80 command-line options compiled into your version.
82 Note that B<@@RXVT_NAME@@> permits the resource name to be used as a
83 long-option (--/++ option) so the potential command-line options are
84 far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1
87 The following options are available:
91 =item B<-help>, B<--help>
93 Print out a message describing available options.
95 =item B<-display> I<displayname>
97 Attempt to open a window on the named X display (the older form B<-d>
98 is still respected. but deprecated). In the absence of this option, the
99 display specified by the B<DISPLAY> environment variable is used.
101 =item B<-depth> I<bitdepth>
103 Compile I<xft>: Attempt to find a visual with the given bit depth;
106 [Please note that many X servers (and libXft) are buggy with
107 respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108 of graphical corruption. This is harmless, but we can't do anything about
111 =item B<-geometry> I<geom>
113 Window geometry (B<-g> still respected); resource B<geometry>.
117 Turn on/off simulated reverse video; resource B<reverseVideo>.
121 Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
125 Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
129 Turn on/off illusion of a transparent window background; resource B<transparent>.
131 B<-ip> is still accepted as an obsolete alias but will be removed in
134 I<Please address all transparency related issues to Sasha Vasko at
135 sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
137 =item B<-fade> I<number>
139 Fade the text by the given percentage when focus is lost. Small values
140 fade a little only, 100 completely replaces all colours by the fade
141 colour; resource B<fading>.
143 =item B<-fadecolor> I<colour>
145 Fade to this colour when fading is used (see B<-fade>). The default colour
146 is opaque black. resource B<fadeColor>.
148 =item B<-tint> I<colour>
150 Tint the transparent background pixmap with the given colour when
151 transparency is enabled with B<-tr>. This only works for
152 non-tiled backgrounds, currently. See also the B<-sh> option that can be
153 used to brighten or darken the image in addition to tinting it.
154 Please note that certain tint colours can be applied on the server-side,
155 thus yielding performance gain of two orders of magnitude. These colours are:
156 blue, red, green, cyan, magenta, yellow, and those close to them. Also
157 pure black and pure white colors essentially mean no tinting; resource
158 I<tintColor>. Example:
160 @@RXVT_NAME@@ -tr -tint blue -sh 40
162 =item B<-sh> I<number>
164 Darken (0 .. 100) or lighten (100 .. 200) the transparent
165 background image in addition to (or instead of) tinting it;
168 =item B<-blt> I<string>
170 Specify background blending type. If background pixmap is specified
171 at the same time as transparency - such pixmap will be blended over
172 transparency image, using method specified. Supported values are :
173 B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
174 B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175 B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176 alpha-blending. Compile I<afterimage>; resource I<blendType>.
180 Apply Gaussian Blur with the specified radii to the transparent
181 background image. If single number is specified - both vertical and
182 horizontal radii are considered to be the same. Setting one of the
183 radii to 1 and another to a large number creates interesting effects
184 on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
185 resource I<blurRadius>.
187 =item B<-icon> I<file>
189 Compile I<afterimage>: Use the specified image as application icon. This
190 is used by many window managers, taskbars and pagers to represent the
191 application window; resource I<iconFile>.
193 =item B<-bg> I<colour>
195 Window background colour; resource B<background>.
197 =item B<-fg> I<colour>
199 Window foreground colour; resource B<foreground>.
201 =item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
203 Compile I<afterimage>: Specify image file for the background and also
204 optionally specify its scaling with a geometry string. Note you may need to
205 add quotes to avoid special shell interpretation of the C<;> in the
206 command-line; for more details see resource B<backgroundPixmap>.
208 =item B<-cr> I<colour>
210 The cursor colour; resource B<cursorColor>.
212 =item B<-pr> I<colour>
214 The mouse pointer foreground colour; resource B<pointerColor>.
216 =item B<-pr2> I<colour>
218 The mouse pointer background colour; resource B<pointerColor2>.
220 =item B<-bd> I<colour>
222 The colour of the border around the text area and between the scrollbar and the text;
223 resource B<borderColor>.
225 =item B<-fn> I<fontlist>
227 Select the fonts to be used. This is a comma separated list of font names
228 that are checked in order when trying to find glyphs for characters. The
229 first font defines the cell size for characters; other fonts might be
230 smaller, but not (in general) larger. A (hopefully) reasonable default
231 font list is always appended to it. See resource B<font> for more details.
233 In short, to specify an X11 core font, just specify its name or prefix it
234 with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
237 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
238 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
240 See also the question "How does rxvt-unicode choose fonts?" in the FAQ
241 section of @@RXVT_NAME@@(7).
243 =item B<-fb> I<fontlist>
245 Compile I<font-styles>: The bold font list to use when B<bold> characters
246 are to be printed. See resource B<boldFont> for details.
248 =item B<-fi> I<fontlist>
250 Compile I<font-styles>: The italic font list to use when I<italic>
251 characters are to be printed. See resource B<italicFont> for details.
253 =item B<-fbi> I<fontlist>
255 Compile I<font-styles>: The bold italic font list to use when B<< I<bold
256 italic> >> characters are to be printed. See resource B<boldItalicFont>
261 Compile I<font-styles>: Bold/Blink font styles imply high intensity
262 foreground/background (default). See resource B<intensityStyles> for
265 =item B<-name> I<name>
267 Specify the application name under which resources are to be obtained,
268 rather than the default executable file name. Name should not contain
269 `.' or `*' characters. Also sets the icon and title name.
273 Start as a login-shell/sub-shell; resource B<loginShell>.
277 Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
282 Turn on/off visual bell on receipt of a bell character; resource
287 Turn on/off scrollbar; resource B<scrollBar>.
291 Put scrollbar on right/left; resource B<scrollBar_right>.
295 Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
296 resource B<scrollBar_floating>.
300 Turn on/off scroll-to-bottom on TTY output inhibit; resource
301 B<scrollTtyOutput> has opposite effect.
305 Turn on/off scroll-to-bottom on keypress; resource
306 B<scrollTtyKeypress>.
310 Turn on/off scrolling with the scrollback buffer as new lines appear.
311 This only takes effect if B<-si> is also given; resource
314 =item B<-ptab>|B<+ptab>
316 If enabled (default), "Horizontal Tab" characters are being stored as
317 actual wide characters in the screen buffer, which makes it possible to
318 select and paste them. Since a horizontal tab is a cursor movement and
319 not an actual glyph, this can sometimes be visually annoying as the cursor
320 on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
324 Blink the cursor; resource B<cursorBlink>.
328 Make the cursor underlined; resource B<cursorUnderline>.
332 Start iconified, if the window manager supports that option.
333 Alternative form is B<-ic>.
335 =item B<-sl> I<number>
337 Save I<number> lines in the scrollback buffer. See resource entry for
338 limits; resource B<saveLines>.
340 =item B<-b> I<number>
342 Compile I<frills>: Internal border of I<number> pixels. See resource
343 entry for limits; resource B<internalBorder>.
345 =item B<-w> I<number>
347 Compile I<frills>: External border of I<number> pixels. Also, B<-bw>
348 and B<-borderwidth>. See resource entry for limits; resource
353 Compile I<frills>: Set MWM hints to request a borderless window, i.e.
354 if honoured by the WM, the rxvt-unicode window will not have window
355 decorations; resource B<borderLess>. If the window manager does not
356 support MWM hints (e.g. kwin), enables override-redirect mode.
358 =item B<-override-redirect>
360 Compile I<frills>: Sets override-redirect on the window; resource
361 B<override-redirect>.
365 Compile I<frills>: Disable the usage of the built-in block graphics/line
366 drawing characters and just rely on what the specified fonts provide. Use
367 this if you have a good font and want to use its block graphic glyphs;
368 resource B<skipBuiltinGlyphs>.
370 =item B<-lsp> I<number>
372 Compile I<frills>: Lines (pixel height) to insert between each row of
373 the display. Useful to work around font rendering problems; resource
376 =item B<-letsp> I<number>
378 Compile I<frills>: Amount to adjust the computed character width by
379 to control overall letter spacing. Negative values will tighten up the
380 letter spacing, positive values will space letters out more. Useful to
381 work around odd font metrics; resource B<letterSpace>.
383 =item B<-tn> I<termname>
385 This option specifies the name of the terminal type to be set in the
386 B<TERM> environment variable. This terminal type must exist in the
387 I<termcap(5)> database and should have I<li#> and I<co#> entries;
388 resource B<termName>.
390 =item B<-e> I<command [arguments]>
392 Run the command with its command-line arguments in the B<@@RXVT_NAME@@>
393 window; also sets the window title and icon name to be the basename of
394 the program being executed if neither I<-title> (I<-T>) nor I<-n> are
395 given on the command line. If this option is used, it must be the last
396 on the command-line. If there is no B<-e> option then the default is to
397 run the program specified by the B<SHELL> environment variable or,
398 failing that, I<sh(1)>.
400 Please note that you must specify a program with arguments. If you want to
401 run shell commands, you have to specify the shell, like this:
403 @@RXVT_NAME@@ -e sh -c "shell commands"
405 =item B<-title> I<text>
407 Window title (B<-T> still respected); the default title is the basename
408 of the program specified after the B<-e> option, if any, otherwise the
409 application name; resource B<title>.
413 Icon name; the default name is the basename of the program specified
414 after the B<-e> option, if any, otherwise the application name;
415 resource B<iconName>.
419 Capture system console messages.
421 =item B<-pt> I<style>
423 Compile I<XIM>: input style for input method; B<OverTheSpot>,
424 B<OffTheSpot>, B<Root>; resource B<preeditType>.
428 Compile I<XIM>: input method name. resource B<inputMethod>.
430 =item B<-imlocale> I<string>
432 The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
433 C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
434 input extension to be able to input japanese characters while staying in
435 another locale. resource B<imLocale>.
437 =item B<-imfont> I<fontset>
439 Set the font set to use for the X Input Method, see resource B<imFont>
444 Change the meaning of triple-click selection with the left mouse
445 button. Only effective when the original (non-perl) selection code is
446 in-use. Instead of selecting a full line it will extend the selection to
447 the end of the logical line only. resource B<tripleclickwords>.
451 Enable "insecure" mode, which currently enables most of the escape
452 sequences that echo strings. See the resource B<insecure> for more
455 =item B<-mod> I<modifier>
457 Override detection of Meta modifier with specified key: B<alt>,
458 B<meta>, B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>,
459 B<mod5>; resource I<modifier>.
461 =item B<-ssc>|B<+ssc>
463 Turn on/off secondary screen (default enabled); resource
466 =item B<-ssr>|B<+ssr>
468 Turn on/off secondary screen scroll (default enabled); resource
471 =item B<-hold>|B<+hold>
473 Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
474 will not immediately destroy its window when the program executed within
475 it exits. Instead, it will wait till it is being killed or closed by the
476 user; resource B<hold>.
480 Sets the working directory for the shell (or the command specified via
481 B<-e>). The I<path> must be an absolute path and it must exist for
482 @@RXVT_NAME@@ to start; resource B<chdir>.
484 =item B<-xrm> I<string>
486 Works like the X Toolkit option of the same name, by adding the I<string>
487 as if it were specified in a resource file. Resource values specified this
488 way take precedence over all other resource specifications.
490 Note that you need to use the I<same> syntax as in the .Xdefaults file,
491 e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
492 options can be specified as long-options on the commandline, so use
493 of B<-xrm> is mostly limited to cases where you want to specify other
494 resources (e.g. for input methods) or for compatibility with other
497 =item B<-keysym.>I<sym> I<string>
499 Remap a key symbol. See resource B<keysym>.
501 =item B<-embed> I<windowid>
503 Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
504 which enables applications to easily embed a terminal.
506 Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
507 shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
508 quite a bit, so don't expect it to keep some specific state. It's best to
509 create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
511 The window will not be destroyed when @@RXVT_NAME@@ exits.
513 It might be useful to know that @@RXVT_NAME@@ will not close file
514 descriptors passed to it (except for stdin/out/err, of course), so you
515 can use file descriptors to communicate with the programs within the
516 terminal. This works regardless of whether the C<-embed> option was used or
519 Here is a short Gtk2-perl snippet that illustrates how this option can be
520 used (a longer example is in F<doc/embed>):
522 my $rxvt = new Gtk2::Socket;
523 $rxvt->signal_connect_after (realize => sub {
524 my $xid = $_[0]->window->get_xid;
525 system "@@RXVT_NAME@@ -embed $xid &";
528 =item B<-pty-fd> I<file descriptor>
530 Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
531 pair but instead use the given file descriptor as the tty master. This is
532 useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
533 without having to run a program within it.
535 If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
536 entries and will not tinker with pty/tty permissions - you have to do that
537 yourself if you want that.
539 As an extremely special case, specifying C<-1> will completely suppress
540 pty/tty operations, which is probably only useful in conjunction with some
541 perl extension that manages the terminal.
543 Here is a example in perl that illustrates how this option can be used (a
544 longer example is in F<doc/pty-fd>):
549 my $pty = new IO::Pty;
550 fcntl $pty, F_SETFD, 0; # clear close-on-exec
551 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
554 # now communicate with rxvt
555 my $slave = $pty->slave;
556 while (<$slave>) { print $slave "got <$_>\n" }
558 =item B<-pe> I<string>
560 Comma-separated list of perl extension scripts to use (or not to use) in
561 this terminal instance. See resource B<perl-ext> for details.
567 Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
568 options) compiled into your version. All resources are also available as
571 You can set and change the resources using X11 tools like B<xrdb>. Many
572 distribution do also load settings from the B<~/.Xresources> file when X
573 starts. @@RXVT_NAME@@ will consult the following files/resources in order,
574 with later settings overwriting earlier ones:
576 1. system-wide app-defaults file, either locale-dependent OR global
577 2. app-defaults file in $XAPPLRESDIR
578 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
579 4. SCREEN_RESOURCES for the current screen
580 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
581 6. resources specified via -xrm on the commandline
583 Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
584 names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
585 common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
586 configured, while the class name B<URxvt> allows resources unique to
587 B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
588 configurations. If no resources are specified, suitable defaults will
589 be used. Command-line arguments can be used to override resource
590 settings. The following resources are supported (you might want to
591 check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
592 extensions not documented here):
596 =item B<depth:> I<bitdepth>
598 Compile I<xft>: Attempt to find a visual with the given bit depth;
601 =item B<buffered:> I<boolean>
603 Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
604 On some card/driver combination enabling it slightly decreases
605 performance, on most it greatly helps it. The slowdown is small, so it
606 should normally be enabled.
608 =item B<geometry:> I<geom>
610 Create the window with the specified X window geometry [default 80x24];
613 =item B<background:> I<colour>
615 Use the specified colour as the window's background colour [default
616 White]; option B<-bg>.
618 =item B<foreground:> I<colour>
620 Use the specified colour as the window's foreground colour [default
621 Black]; option B<-fg>.
623 =item B<color>I<n>B<:> I<colour>
625 Use the specified colour for the colour value I<n>, where 0-7
626 corresponds to low-intensity (normal) colours and 8-15 corresponds to
627 high-intensity (bold = bright foreground, blink = bright background)
628 colours. The canonical names are as follows: 0=black, 1=red, 2=green,
629 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
630 names used are listed in the B<COLORS AND GRAPHICS> section.
632 Colours higher than 15 cannot be set using resources (yet), but can be
633 changed using an escape command (see @@RXVT_NAME@@(7)).
635 Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
636 88 colour support). Colours 80-87 are evenly spaces grey steps.
638 =item B<colorBD:> I<colour>
640 =item B<colorIT:> I<colour>
642 Use the specified colour to display bold or italic characters when the
643 foreground colour is the default. If font styles are not available
644 (Compile I<styles>) and this option is unset, reverse video is used instead.
646 =item B<colorUL:> I<colour>
648 Use the specified colour to display underlined characters when the
649 foreground colour is the default.
651 =item B<colorRV:> I<colour>
653 Use the specified colour as the background for reverse video characters
654 when OPTION_HC is disabled (--disable-frills).
656 =item B<underlineColor:> I<colour>
658 If set, use the specified colour as the colour for the underline
659 itself. If unset, use the foreground colour.
661 =item B<cursorColor:> I<colour>
663 Use the specified colour for the cursor. The default is to use the
664 foreground colour; option B<-cr>.
666 =item B<cursorColor2:> I<colour>
668 Use the specified colour for the colour of the cursor text. For this to
669 take effect, B<cursorColor> must also be specified. The default is to
670 use the background colour.
672 =item B<reverseVideo:> I<boolean>
674 B<True>: simulate reverse video by foreground and background colours;
675 option B<-rv>. B<False>: regular screen colours [default]; option
676 B<+rv>. See note in B<COLORS AND GRAPHICS> section.
678 =item B<jumpScroll:> I<boolean>
680 B<True>: specify that jump scrolling should be used. When receiving lots
681 of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
682 has been read, resulting in fewer updates while still displaying every
683 received line; option B<-j>.
685 B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
686 force a screen refresh on each new line it received; option B<+j>.
688 =item B<skipScroll:> I<boolean>
690 B<True>: (the default) specify that skip scrolling should be used. When
691 receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
692 (around 60 times per second), resulting in far fewer updates. This can
693 result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
696 B<False>: specify that everything is to be displayed, even
697 if the refresh is too fast for the human eye to read anything (or the
698 monitor to display anything); option B<+ss>.
700 =item B<transparent:> I<boolean>
702 Turn on/off illusion of a transparent window background.
704 B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
707 I<Please address all transparency related issues to Sasha Vasko at
708 sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
710 =item B<fading:> I<number>
712 Fade the text by the given percentage when focus is lost; option B<-fade>.
714 =item B<fadeColor:> I<colour>
716 Fade to this colour, when fading is used (see B<fading:>). The default
717 colour is black; option B<-fadecolor>.
719 =item B<tintColor:> I<colour>
721 Tint the transparent background pixmap with the given colour; option
724 =item B<shading:> I<number>
726 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
727 in addition to tinting it; option B<-sh>.
729 =item B<blendType:> I<string>
731 Specify background blending type; option B<-blt>.
733 =item B<blurRadius:> I<number>
735 Apply gaussian blur with the specified radius to the transparent
736 background image; option B<-blr>.
738 =item B<iconFile:> I<file>
740 Set the application icon pixmap; option B<-icon>.
742 =item B<scrollColor:> I<colour>
744 Use the specified colour for the scrollbar [default #B2B2B2].
746 =item B<troughColor:> I<colour>
748 Use the specified colour for the scrollbar's trough area [default
749 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
751 =item B<borderColor:> I<colour>
753 The colour of the border around the text area and between the scrollbar
756 =item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
758 Use the specified image file for the background and also
759 optionally specify its scaling with a geometry string B<WxH+X+Y>,
760 (default C<0x0+50+50>) in which B<"W" / "H"> specify the
761 horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
762 centre (percent). A scale of 0 displays the image with tiling. A scale
763 of 1 displays the image without any scaling. A scale of 2 to 9 specifies
764 an integer number of images in that direction. No image will be magnified
765 beyond 10 times its original size. The maximum permitted scale is 1000.
766 Additional operations can be specified after colon B<:op1:op2...>.
767 Supported operations are:
769 tile force background image to be tiled and not scaled. Equivalent to 0x0
770 propscale will scale image keeping proportions
771 auto will scale image to match window size. Equivalent to 100x100
772 hscale will scale image horizontally to the window size
773 vscale will scale image vertically to the window size
774 scale will scale image to match window size
775 root will tile image as if it was a root window background, auto-adjusting
776 whenever terminal window moves
778 If used in conjunction with B<-tr> option, the specified pixmap will be
779 blended over transparency image using either alpha-blending, or any
780 other blending type, specified with B<-blt "type"> option.
782 =item B<path:> I<path>
784 Specify the colon-delimited search path for finding background image files.
786 =item B<font:> I<fontlist>
788 Select the fonts to be used. This is a comma separated list of font names
789 that are checked in order when trying to find glyphs for characters. The
790 first font defines the cell size for characters; other fonts might be
791 smaller, but not (in general) larger. A (hopefully) reasonable default
792 font list is always appended to it; option B<-fn>.
794 Each font can either be a standard X11 core font (XLFD) name, with
795 optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
797 In addition, each font can be prefixed with additional hints and
798 specifications enclosed in square brackets (C<[]>). The only available
799 hint currently is C<codeset=codeset-name>, and this is only used for Xft
802 For example, this font resource
804 URxvt.font: 9x15bold,\
805 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
806 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
807 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
808 xft:Code2000:antialias=false
810 specifies five fonts to be used. The first one is C<9x15bold> (actually
811 the iso8859-1 version of the second font), which is the base font (because
812 it is named first) and thus defines the character cell grid to be 9 pixels
813 wide and 15 pixels high.
815 The second font is just used to add additional unicode characters not in
816 the base font, likewise the third, which is unfortunately non-bold, but
817 the bold version of the font does contain fewer characters, so this is a
820 The third font is an Xft font with aliasing turned off, and the characters
821 are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
822 contains other characters, but we are not interested in them.
824 The last font is a useful catch-all font that supplies most of the
825 remaining unicode characters.
827 =item B<boldFont:> I<fontlist>
829 =item B<italicFont:> I<fontlist>
831 =item B<boldItalicFont:> I<fontlist>
833 The font list to use for displaying B<bold>, I<italic> or B<< I<bold
834 italic> >> characters, respectively.
836 If specified and non-empty, then the syntax is the same as for the
837 B<font>-resource, and the given font list will be used as is, which makes
838 it possible to substitute completely different font styles for bold and
841 If unset (the default), a suitable font list will be synthesized by
842 "morphing" the normal text font list into the desired shape. If that is
843 not possible, replacement fonts of the desired shape will be tried.
845 If set, but empty, then this specific style is disabled and the normal
846 text font will being used for the given style.
848 =item B<intensityStyles:> I<boolean>
850 When font styles are not enabled, or this option is enabled (B<True>,
851 option B<-is>, the default), bold/blink font styles imply high
852 intensity foreground/background colours. Disabling this option (B<False>,
853 option B<+is>) disables this behaviour, the high intensity colours are not
856 =item B<title:> I<string>
858 Set window title string, the default title is the command-line
859 specified after the B<-e> option, if any, otherwise the application
860 name; option B<-title>.
862 =item B<iconName:> I<string>
864 Set the name used to label the window's icon or displayed in an icon
865 manager window, it also sets the window's title unless it is explicitly
868 =item B<mapAlert:> I<boolean>
870 B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
871 de-iconify (map) on receipt of a bell character [default].
873 =item B<urgentOnBell:> I<boolean>
875 B<True>: set the urgency hint for the wm on receipt of a bell character.
876 B<False>: do not set the urgency hint [default].
878 @@RXVT_NAME@@ resets the urgency hint on every focus change.
880 =item B<visualBell:> I<boolean>
882 B<True>: use visual bell on receipt of a bell character; option B<-vb>.
883 B<False>: no visual bell [default]; option B<+vb>.
885 =item B<loginShell:> I<boolean>
887 B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
888 the shell; option B<-ls>. B<False>: start as a normal sub-shell
889 [default]; option B<+ls>.
891 =item B<utmpInhibit:> I<boolean>
893 B<True>: inhibit writing record into the system log file B<utmp>;
894 option B<-ut>. B<False>: write record into the system log file B<utmp>
895 [default]; option B<+ut>.
897 =item B<print-pipe:> I<string>
899 Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
900 B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
901 B<Shift-Print> to include the scrollback as well.
903 The string will be interpreted as if typed into the shell as-is.
907 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
909 This creates a new file in your home directory with the screen contents
910 every time you hit C<Print>.
912 =item B<scrollstyle:> I<mode>
914 Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
915 the author's favourite.
917 =item B<scrollBar:> I<boolean>
919 B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
920 disable the scrollbar; option B<+sb>.
922 =item B<scrollBar_right:> I<boolean>
924 B<True>: place the scrollbar on the right of the window; option B<-sr>.
925 B<False>: place the scrollbar on the left of the window; option B<+sr>.
927 =item B<scrollBar_floating:> I<boolean>
929 B<True>: display an rxvt scrollbar without a trough; option B<-st>.
930 B<False>: display an rxvt scrollbar with a trough; option B<+st>.
932 =item B<scrollBar_align:> I<mode>
934 Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar
935 thumb with the pointer on middle button press/drag.
937 =item B<scrollTtyOutput:> I<boolean>
939 B<True>: scroll to bottom when tty receives output; option B<-si>.
940 B<False>: do not scroll to bottom when tty receives output; option
943 =item B<scrollWithBuffer:> I<boolean>
945 B<True>: scroll with scrollback buffer when tty receives new lines (and
946 B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
947 with scrollback buffer when tty receives new lines; option B<+sw>.
949 =item B<scrollTtyKeypress:> I<boolean>
951 B<True>: scroll to bottom when a non-special key is pressed. Special keys
952 are those which are intercepted by rxvt-unicode for special handling and
953 are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
954 bottom when a non-special key is pressed; option B<+sk>.
956 =item B<saveLines:> I<number>
958 Save I<number> lines in the scrollback buffer [default 64]. This
959 resource is limited on most machines to 65535; option B<-sl>.
961 =item B<internalBorder:> I<number>
963 Internal border of I<number> pixels. This resource is limited to 100;
966 =item B<externalBorder:> I<number>
968 External border of I<number> pixels. This resource is limited to 100;
969 option B<-w>, B<-bw>, B<-borderwidth>.
971 =item B<borderLess:> I<boolean>
973 Set MWM hints to request a borderless window, i.e. if honoured by the
974 WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
976 =item B<skipBuiltinGlyphs:> I<boolean>
978 Compile I<frills>: Disable the usage of the built-in block graphics/line
979 drawing characters and just rely on what the specified fonts provide. Use
980 this if you have a good font and want to use its block graphic glyphs;
983 =item B<termName:> I<termname>
985 Specifies the terminal type name to be set in the B<TERM> environment
986 variable; option B<-tn>.
988 =item B<lineSpace:> I<number>
990 Specifies number of lines (pixel height) to insert between each row of
991 the display [default 0]; option B<-lsp>.
993 =item B<meta8:> I<boolean>
995 B<True>: handle Meta (Alt) + keypress to set the 8th bit. B<False>:
996 handle Meta (Alt) + keypress as an escape prefix [default].
998 =item B<mouseWheelScrollPage:> I<boolean>
1000 B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
1001 scrolls five lines [default].
1003 =item B<pastableTabs:> I<boolean>
1005 B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
1006 movement only; option C<-ptab>.
1008 =item B<cursorBlink:> I<boolean>
1010 B<True>: blink the cursor. B<False>: do not blink the cursor [default];
1013 =item B<cursorUnderline:> I<boolean>
1015 B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
1018 =item B<pointerBlank:> I<boolean>
1020 B<True>: blank the pointer when a key is pressed or after a set number
1021 of seconds of inactivity. B<False>: the pointer is always visible
1024 =item B<pointerColor:> I<colour>
1026 Mouse pointer foreground colour.
1028 =item B<pointerColor2:> I<colour>
1030 Mouse pointer background colour.
1032 =item B<pointerBlankDelay:> I<number>
1034 Specifies number of seconds before blanking the pointer [default 2]. Use a
1035 large number (e.g. C<987654321>) to effectively disable the timeout.
1037 =item B<backspacekey:> I<string>
1039 The string to send when the backspace key is pressed. If set to B<DEC>
1040 or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
1041 (code 8) - which can be reversed with the appropriate DEC private mode
1044 =item B<deletekey:> I<string>
1046 The string to send when the delete key (not the keypad delete key) is
1047 pressed. If unset it will send the sequence traditionally associated
1048 with the B<Execute> key.
1050 =item B<cutchars:> I<string>
1052 The characters used as delimiters for double-click word selection
1053 (whitespace delimiting is added automatically if resource is given).
1055 When the perl selection extension is in use (the default if compiled
1056 in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
1057 characters will be created (if the resource exists, otherwise, no regex
1058 will be created). In this mode, characters outside ISO-8859-1 can be used.
1060 When the selection extension is not used, only ISO-8859-1 characters can
1061 be used. If not specified, the built-in default is used:
1063 B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
1065 =item B<preeditType:> I<style>
1067 B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1069 =item B<inputMethod:> I<name>
1071 I<name> of inputMethod to use; option B<-im>.
1073 =item B<imLocale:> I<name>
1075 The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
1076 C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
1077 input extension to be able to input japanese characters while staying in
1078 another locale; option B<-imlocale>.
1080 =item B<imFont:> I<fontset>
1082 Specify the font-set used for XIM styles C<OverTheSpot> or
1083 C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
1084 by commas), i.e. it's not in the same format as the other font lists used
1085 in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
1086 found, preferably one or two pixels differing in size to the base font.
1089 =item B<tripleclickwords:> I<boolean>
1091 Change the meaning of triple-click selection with the left mouse
1092 button. Instead of selecting a full line it will extend the selection to
1093 the end of the logical line only; option B<-tcw>.
1095 =item B<insecure:> I<boolean>
1097 Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
1098 echo arbitrary strings like the icon name or the locale. This could be
1099 abused if somebody gets 8-bit-clean access to your display, whether
1100 through a mail client displaying mail bodies unfiltered or through
1101 write(1) or any other means. Therefore, these sequences are disabled by
1102 default. (Note that many other terminals, including xterm, have these
1103 sequences enabled by default, which doesn't make it safer, though).
1105 You can enable them by setting this boolean resource or specifying
1106 B<-insecure> as an option. At the moment, this enables display-answer,
1107 locale, findfont, icon label and window title requests.
1109 =item B<modifier:> I<modifier>
1111 Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
1112 B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
1115 =item B<answerbackString:> I<string>
1117 Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
1118 character is passed through. It may contain escape values as described
1119 in the entry on B<keysym> following.
1121 =item B<secondaryScreen:> I<boolean>
1123 Turn on/off secondary screen (default enabled).
1125 =item B<secondaryScroll:> I<boolean>
1127 Turn on/off secondary screen scroll (default enabled). If this
1128 option is enabled, scrolls on the secondary screen will change the
1129 scrollback buffer and, when secondaryScreen is off, switching
1130 to/from the secondary screen will instead scroll the screen up.
1132 =item B<hold>: I<boolean>
1134 Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1135 will not immediately destroy its window when the program executed within
1136 it exits. Instead, it will wait till it is being killed or closed by the
1139 =item B<chdir>: I<path>
1141 Sets the working directory for the shell (or the command specified via
1142 B<-e>). The I<path> must be an absolute path and it must exist for
1143 @@RXVT_NAME@@ to start. If it isn't specified then the current working
1144 directory will be used; option B<-cd>.
1146 =item B<keysym.>I<sym>: I<string>
1148 Compile I<frills>: Associate I<string> with keysym I<sym>. The
1149 intervening resource name B<keysym.> cannot be omitted.
1151 The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
1152 any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
1153 B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
1154 and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
1155 B<2>, B<3>, B<4>, B<5>.
1157 The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1158 whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1159 keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1160 current application keymap mode state.
1162 The spellings of I<key> can be obtained by using B<xev>(1) command or
1163 searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1164 omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1165 keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1166 performed in an exact manner; however, the closest match is assured.
1168 I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1169 number), see RESOURCES in C<man 7 X> for futher details.
1171 You can define a range of keysyms in one shot by providing a I<string>
1172 with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1173 should be a character not used by the strings.
1175 Its usage can be demonstrated by an example:
1177 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1179 The above line is equivalent to the following three lines:
1181 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
1182 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
1183 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
1185 If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1186 is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1187 example the following means "change the current locale to C<zh_CN.GBK>
1188 when Control-Meta-c is being pressed":
1190 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1192 If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1193 is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1194 manpage. For example, the F<selection> extension (activated via
1195 C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1197 URxvt.keysym.M-C-c: perl:selection:rot13
1199 Due the the large number of modifier combinations, a defined key mapping
1200 will match if at I<at least> the specified identifiers are being set, and
1201 no other key mappings with those and more bits are being defined. That
1202 means that defining a key map for C<a> will automatically provide
1203 definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1204 mappings themselves.
1206 Unfortunately, this will override built-in key mappings. For example
1207 if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1208 C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1209 user-defined keymap using the C<builtin:> replacement:
1211 URxvt.keysym.Insert: <my insert key sequence>
1212 URxvt.keysym.S-Insert: builtin:
1214 The first line defines a mapping for C<Insert> and I<any> combination
1215 of modifiers. The second line re-establishes the default mapping for
1218 The following example will map Control-Meta-1 and Control-Meta-2 to
1219 the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1220 font-switching at runtime:
1222 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1223 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1225 Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1228 URxvt.keysym.M-C-3: command:\033[8;25;80t
1229 URxvt.keysym.M-C-4: command:\033[8;48;110t
1231 =item B<perl-ext-common>: I<string>
1233 =item B<perl-ext>: I<string>
1235 Comma-separated list(s) of perl extension scripts (default: C<default>) to
1236 use in this terminal instance; option B<-pe>.
1238 Extension names can be prefixed with a C<-> sign to prohibit using
1239 them. This can be useful to selectively disable some extensions loaded
1240 by default, or specified via the C<perl-ext-common> resource. For
1241 example, C<default,-selection> will use all the default extension except
1244 Extension names can also be followed by an argument in angle brackets
1245 (e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1246 searchable scrollback to Alt/Meta-s). Mentioning the same extension
1247 multiple times with different arguments will pass multiple arguments to
1250 Each extension is looked up in the library directories, loaded if
1251 necessary, and bound to the current terminal instance.
1253 If both of these resources are the empty string, then the perl
1254 interpreter will not be initialized. The idea behind two options is that
1255 B<perl-ext-common> will be used for extensions that should be available to
1256 all instances, while B<perl-ext> is used for specific instances.
1258 =item B<perl-eval>: I<string>
1260 Perl code to be evaluated when all extensions have been registered. See
1261 the @@RXVT_NAME@@perl(3) manpage.
1263 =item B<perl-lib>: I<path>
1265 Colon-separated list of additional directories that hold extension
1266 scripts. When looking for extensions specified by the C<perl> resource,
1267 @@RXVT_NAME@@ will first look in these directories and then in
1268 F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1270 See the @@RXVT_NAME@@perl(3) manpage.
1272 =item B<< selection.pattern-I<idx> >>: I<perl-regex>
1274 Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1277 =item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1279 Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1282 =item B<searchable-scrollback:> I<keysym>
1284 Sets the hotkey that starts the incremental scrollback buffer search
1287 =item B<urlLauncher>: I<string>
1289 Specifies the program to be started with a URL argument. Used by the
1290 C<selection-popup> and C<matcher> perl extensions.
1292 =item B<transient-for>: I<windowid>
1294 Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1296 =item B<override-redirect>: I<boolean>
1298 Compile I<frills>: Sets override-redirect for the terminal window, making
1299 it almost invisible to window managers; option B<-override-redirect>.
1301 =item B<iso14755:> I<boolean>
1303 Turn on/off ISO 14755 (default enabled).
1305 =item B<iso14755_52:> I<boolean>
1307 Turn on/off ISO 14755 5.2 mode (default enabled).
1311 =head1 THE SCROLLBAR
1313 Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
1314 (resource: B<saveLines>) and can be scrolled back using the scrollbar
1315 or by keystrokes. The normal B<@@RXVT_NAME@@> scrollbar has arrows and
1316 its behaviour is fairly intuitive. The B<xterm-scrollbar> is without
1317 arrows and its behaviour mimics that of I<xterm>
1319 Scroll down with B<Button1> (B<xterm-scrollbar>) or B<Shift-Next>.
1320 Scroll up with B<Button3> (B<xterm-scrollbar>) or B<Shift-Prior>.
1321 Continuous scroll with B<Button2>.
1323 =head1 MOUSE REPORTING
1325 To temporarily override mouse reporting, for either the scrollbar or
1326 the normal text selection/insertion, hold either the Shift or the Meta
1327 (Alt) key while performing the desired mouse action.
1329 If mouse reporting mode is active, the normal scrollbar actions are
1330 disabled -- on the assumption that we are using a fullscreen
1331 application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1332 (Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1333 up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1336 =head1 THE SELECTION: SELECTING AND PASTING TEXT
1338 The behaviour of text selection and insertion/pasting mechanism is similar
1345 Left click at the beginning of the region, drag to the end of the region
1346 and release; Right click to extend the marked region; Left double-click
1347 to select a word; Left triple-click to select the entire logical line
1348 (which can span multiple screen lines), unless modified by resource
1349 B<tripleclickwords>.
1351 Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1352 (Compile: I<frills>) will create a rectangular selection instead of a
1353 normal one. In this mode, every selected row becomes its own line in the
1354 selection, and trailing whitespace is visually underlined and removed from
1359 Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1360 window causes the value of the PRIMARY selection (or CLIPBOARD with the
1361 B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1363 Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1368 =head1 CHANGING FONTS
1370 Changing fonts (or font sizes, respectively) via the keypad is not yet
1371 supported in rxvt-unicode. Bug me if you need this.
1373 You can, however, switch fonts at runtime using escape sequences, e.g.:
1375 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1377 You can use keyboard shortcuts, too:
1379 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1380 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1382 rxvt-unicode will automatically re-apply these fonts to the output so far.
1384 =head1 ISO 14755 SUPPORT
1386 ISO 14755 is a standard for entering and viewing unicode characters
1387 and character codes using the keyboard. It consists of 4 parts. The
1388 first part is available if rxvt-unicode has been compiled with
1389 C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1390 with C<--enable-iso14755>.
1394 =item * 5.1: Basic method
1396 This allows you to enter unicode characters using their hexcode.
1398 Start by pressing and holding both C<Control> and C<Shift>, then enter
1399 hex-digits (between one and six). Releasing C<Control> and C<Shift> will
1400 commit the character as if it were typed directly. While holding down
1401 C<Control> and C<Shift> you can also enter multiple characters by pressing
1402 C<Space>, which will commit the current character and lets you start a new
1405 As an example of use, imagine a business card with a japanese e-mail
1406 address, which you cannot type. Fortunately, the card has the e-mail
1407 address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
1408 by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
1409 followed by releasing the modifier keys.
1411 =item * 5.2: Keyboard symbols entry method
1413 This mode lets you input characters representing the keycap symbols of
1414 your keyboard, if representable in the current locale encoding.
1416 Start by pressing C<Control> and C<Shift> together, then releasing
1417 them. The next special key (cursor keys, home etc.) you enter will not
1418 invoke its usual function but instead will insert the corresponding
1419 keycap symbol. The symbol will only be entered when the key has been
1420 released, otherwise pressing e.g. C<Shift> would enter the symbol for
1421 C<ISO Level 2 Switch>, although your intention might have been to enter a
1422 reverse tab (Shift-Tab).
1424 =item * 5.3: Screen-selection entry method
1426 While this is implemented already (it's basically the selection
1427 mechanism), it could be extended by displaying a unicode character map.
1429 =item * 5.4: Feedback method for identifying displayed characters for later input
1431 This method lets you display the unicode character code associated with
1432 characters already displayed.
1434 You enter this mode by holding down C<Control> and C<Shift> together, then
1435 pressing and holding the left mouse button and moving around. The unicode
1436 hex code(s) (it might be a combining character) of the character under the
1437 pointer is displayed until you release C<Control> and C<Shift>.
1439 In addition to the hex codes it will display the font used to draw this
1440 character - due to implementation reasons, characters combined with
1441 combining characters, line drawing characters and unknown characters will
1442 always be drawn using the built-in support font.
1446 With respect to conformance, rxvt-unicode is supposed to be compliant to
1447 both scenario A and B of ISO 14755, including part 5.2.
1451 B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1452 it can be seen via the I<who(1)> command, and can accept messages. To
1453 allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1454 on some systems or setgid to root or to some other group on others.
1456 =head1 COLORS AND GRAPHICS
1458 In addition to the default foreground and background colours,
1459 B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1460 high-intensity bold/blink versions of the same). Here is a list of the
1461 colours with their names.
1465 B<color0> (black) = Black
1466 B<color1> (red) = Red3
1467 B<color2> (green) = Green3
1468 B<color3> (yellow) = Yellow3
1469 B<color4> (blue) = Blue3
1470 B<color5> (magenta) = Magenta3
1471 B<color6> (cyan) = Cyan3
1472 B<color7> (white) = AntiqueWhite
1473 B<color8> (bright black) = Grey25
1474 B<color9> (bright red) = Red
1475 B<color10> (bright green) = Green
1476 B<color11> (bright yellow) = Yellow
1477 B<color12> (bright blue) = Blue
1478 B<color13> (bright magenta) = Magenta
1479 B<color14> (bright cyan) = Cyan
1480 B<color15> (bright white) = White
1481 B<foreground> = Black
1482 B<background> = White
1486 It is also possible to specify the colour values of B<foreground>,
1487 B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1488 a number 0-15, as a convenient shorthand to reference the colour name of
1491 In addition to the colours defined above, @@RXVT_NAME@@ offers an
1492 additional 72 colours. The first 64 of those (with indices 16 to 79)
1493 consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1494 16>), followed by 8 additional shades of gray (with indices 80 to 87).
1496 Together, all those colours implement the 88 colour xterm colours. Only
1497 the first 16 can be changed using resources currently, the rest can only
1498 be changed via command sequences ("escape codes").
1500 Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1501 always swapping the foreground/background colours. This is in contrast to
1502 I<xterm>(1) where the colours are only swapped if they have not otherwise
1503 been specified. For example,
1505 @@RXVT_NAME@@ -fg Black -bg White -rv
1507 would yield White on Black, while on I<xterm>(1) it would yield Black on
1510 =head2 ALPHA CHANNEL SUPPORT
1512 If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1513 their act together, rxvt-unicode will do it's own alpha channel management:
1515 You can prefix any color with an opaquenes percentage enclosed in
1516 brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1517 (0-100) that specifies the opacity of the color, where C<0> is completely
1518 transparent and C<100> is completely opaque. For example, C<[50]red> is a
1519 half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1520 is the recommended format to specify transparency values, and works with
1521 all ways to specify a colour.
1523 For complete control, rxvt-unicode also supports
1524 C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1525 specifications, where the additional C<aaaa> component specifies opacity
1526 (alpha) values. The minimum value of C<0000> is completely transparent,
1527 while C<ffff> is completely opaque). The two example colours from
1528 earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1529 C<rgba:0000/ff00/0000/f332>.
1531 You probably need to specify B<"-depth 32">, too, to force a visual with
1532 alpha channels, and have the luck that your X-server uses ARGB pixel
1533 layout, as X is far from just supporting ARGB visuals out of the box, and
1534 rxvt-unicode just fudges around.
1536 For example, the following selects an almost completely transparent black
1537 background, and an almost opaque pink foreground:
1539 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1541 When not using a background image, then the interpretation of the
1542 alpha channel is up to your compositing manager (most interpret it as
1543 transparency of course).
1545 When using a background pixmap or pseudo-transparency, then the background
1546 colour will always behave as if it were completely transparent (so the
1547 background image shows instead), regardless of how it was specified, while
1548 other colours will either be transparent as specified (the background
1549 image will show through) on servers supporting the RENDER extension, or
1550 fully opaque on servers not supporting the RENDER EXTENSION.
1552 Please note that due to bugs in Xft, specifying alpha values might result
1553 in garbage being displayed when the X-server does not support the RENDER
1558 B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1564 Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1565 resources or on the command line.
1569 Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1570 compiled with background image support, and optionally with the added
1571 extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1576 Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1577 the colour code used as default foreground/text colour (or the string
1578 C<default> to indicate that the default-colour escape sequence is to be
1579 used), C<bg> is the colour code used as default background colour (or the
1580 string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1581 was compiled with background image support. Libraries like C<ncurses>
1582 and C<slang> can (and do) use this information to optimize screen output.
1586 Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1587 window, which usually has subwindows for the scrollbar, the terminal
1592 Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1593 C<--with-terminfo=PATH>.
1597 Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1598 display in its child processes if C<-display> isn't used to override. It
1599 defaults to C<:0> if it doesn't exist.
1603 The shell to be used for command execution, defaults to C</bin/sh>.
1605 =item B<RXVT_SOCKET>
1607 The unix domain socket path used by @@RXVT_NAME@@c(1) and
1610 Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1614 Used to locate the default directory for the unix domain socket for
1615 daemon communications and to locate various resource files (such as
1618 =item B<XAPPLRESDIR>
1620 Directory where various X resource files are being located.
1622 =item B<XENVIRONMENT>
1624 If set and accessible, gives the name of a X resource file to be loaded by
1633 =item B</usr/lib/X11/rgb.txt>
1641 @@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1643 =head1 CURRENT PROJECT COORDINATOR
1647 =item Project Coordinator
1649 Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1651 L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1661 University of Kent, 1992, wrote the original Xvt.
1663 =item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>
1665 very heavily modified Xvt and came up with Rxvt
1667 =item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>
1669 wrote the Greek Keyboard Input (no longer in code)
1671 =item mj olesen L<< <olesen@me.QueensU.CA> >>
1673 Wrote the menu system.
1675 Project Coordinator (changes.txt 2.11 to 2.21)
1677 =item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>
1679 Project Coordinator (changes.txt 2.21a to 2.4.5)
1681 =item Geoff Wing L<< <gcw@pobox.com> >>
1683 Rewrote screen display and text selection routines.
1685 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1687 =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1689 Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1690 extension, random hacks, numerous bugfixes and extensions.
1692 Project Coordinator (Changes 1.0 -)
1694 =item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1696 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.