1urxvt(1) RXVT-UNICODE urxvt(1)
2
6 rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window
7 system)
8
10 urxvt [options] [-e command [ args ]]
11
13 rxvt-unicode, version 9.02, is a colour vt102 terminal emulator
14 intended as an xterm(1) replacement for users who do not require
15 features such as Tektronix 4014 emulation and toolkit-style
16 configurability. As a result, rxvt-unicode uses much less swap space --
17 a significant advantage on a machine serving many X sessions.
18 This document is also available on the World-Wide-Web at
20 <http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
21
23 See urxvt(7) (try "man 7 urxvt") for a list of frequently asked
24 questions and answer to them and some common problems. That document is
25 also accessible on the World-Wide-Web at
26 <http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
27
29 Unlike the original rxvt, 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
32 difficult, especially cursive scripts such as arabic, vertically
33 written scripts like mongolian or scripts requiring extremely complex
34 combining rules, like tibetan or devanagari. Don't expect pretty output
35 when using these scripts. Most other scripts, latin, cyrillic, kanji,
36 thai etc. should work fine, though. A somewhat difficult case are
37 right-to-left scripts, such as hebrew: rxvt-unicode adopts the view
38 that bidirectional algorithms belong in the application, not the
39 terminal emulator (too many things -- such as cursor-movement while
40 editing -- break otherwise), but that might change.
41 If you are looking for a terminal that supports more exotic scripts,
43 let me recommend "mlterm", which is a very user friendly, lean and
44 clean terminal emulator. In fact, the reason rxvt-unicode was born was
45 solely because the author couldn't get "mlterm" to use one font for
46 latin1 and another for japanese.
47 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
51 able to choose any font for any script freely.
52 Apart from that, rxvt-unicode is also much better internationalised
54 than its predecessor, supports things such as XFT and ISO 14755 that
55 are handy in i18n-environments, is faster, and has a lot bugs less than
56 the original rxvt. This all in addition to dozens of other small
57 improvements.
58 It is still faithfully following the original rxvt idea of being lean
60 and nice on resources: for example, you can still configure rxvt-
61 unicode without most of its features to get a lean binary. It also
62 comes with a client/daemon pair that lets you open any number of
63 terminal windows from within a single process, which makes startup time
64 very fast and drastically reduces memory usage. See urxvtd(1) (daemon)
65 and urxvtc(1) (client).
66 It also makes technical information about escape sequences (which have
68 been extended) more accessible: see urxvt(7) for technical reference
69 documentation (escape sequences etc.).
70
72 The urxvt options (mostly a subset of xterm's) are listed below. In
73 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. `urxvt -h' gives a list of major compile-time options on
77 the Options line. Option descriptions may be prefixed with which
78 compile option each is dependent upon. e.g. `Compile XIM:' requires XIM
79 on the Options line. Note: `urxvt -help' gives a list of all command-
80 line options compiled into your version.
81 Note that urxvt permits the resource name to be used as a long-option
83 (--/++ option) so the potential command-line options are far greater
84 than those listed. For example: `urxvt --loginShell --color1 Orange'.
85 The following options are available:
87 -help, --help
89 Print out a message describing available options.
90 -display displayname
92 Attempt to open a window on the named X display (-d still
93 respected). In the absence of this option, the display specified by
94 the DISPLAY environment variable is used.
95 -depth bitdepth
97 Compile xft: Attempt to find a visual with the given bit depth;
98 resource depth.
99 [Please note that many X servers (and libXft) are buggy with
101 respect to "-depth 32" and/or alpha channels, and will cause all
102 sorts of graphical corruption. This is harmless, but we can't do
103 anything about this, so watch out]
104 -geometry geom
106 Window geometry (-g still respected); resource geometry.
107 -rv|+rv
109 Turn on/off simulated reverse video; resource reverseVideo.
110 -j|+j
112 Turn on/off jump scrolling (allow multiple lines per refresh);
113 resource jumpScroll.
114 -ss|+ss
116 Turn on/off skip scrolling (allow multiple screens per refresh);
117 resource skipScroll.
118 -tr|+tr
120 Turn on/off illusion of a transparent window background; resource
121 transparent.
122 -ip is still accepted as an obsolete alias but will be removed in
124 future versions.
125 Please address all transparency related issues to Sasha Vasko at
127 sasha@aftercode.net. Read the FAQ (man 7 urxvt)!
128 -fade number
130 Fade the text by the given percentage when focus is lost. Small
131 values fade a little only, 100 completely replaces all colours by
132 the fade colour; resource fading.
133 -fadecolor colour
135 Fade to this colour when fading is used (see -fade). The default
136 colour is opaque black. resource fadeColor.
137 -tint colour
139 Tint the transparent background pixmap with the given colour when
140 transparency is enabled with -tr. This only works for non-tiled
141 backgrounds, currently. See also the -sh option that can be used to
142 brighten or darken the image in addition to tinting it. Please
143 note that certain tint colours can be applied on the server-side,
144 thus yielding performance gain of two orders of magnitude. These
145 colours are: blue, red, green, cyan, magenta, yellow, and those
146 close to them. Also pure black and pure white colors essentially
147 mean no tinting; resource tintColor. Example:
148 urxvt -tr -tint blue -sh 40
150 -sh number
152 Darken (0 .. 100) or lighten (100 .. 200) the transparent
153 background image in addition to (or instead of) tinting it;
154 resource shading.
155 -blt string
157 Specify background blending type. If background pixmap is specified
158 at the same time as transparency - such pixmap will be blended over
159 transparency image, using method specified. Supported values are :
160 add, alphablend, allanon - color values averaging, colorize,
161 darken, diff, dissipate, hue, lighten, overlay, saturate, screen,
162 sub, tint, value. The default is alpha-blending. Compile
163 afterimage; resource blendType.
164 -blr HxV
166 Apply Gaussian Blur with the specified radii to the transparent
167 background image. If single number is specified - both vertical and
168 horizontal radii are considered to be the same. Setting one of the
169 radii to 1 and another to a large number creates interesting
170 effects on some backgrounds. Maximum radius value is 128. Compile
171 afterimage; resource blurRadius.
172 -bg colour
174 Window background colour; resource background.
175 -fg colour
177 Window foreground colour; resource foreground.
178 -pixmap file[;geom[:op1][:op2][...]]
180 Compile afterimage: Specify image file for the background and also
181 optionally specify its scaling with a geometry string. Note you may
182 need to add quotes to avoid special shell interpretation of the ";"
183 in the command-line; for more details see resource
184 backgroundPixmap.
185 -cr colour
187 The cursor colour; resource cursorColor.
188 -pr colour
190 The mouse pointer foreground colour; resource pointerColor.
191 -pr2 colour
193 The mouse pointer background colour; resource pointerColor2.
194 -bd colour
196 The colour of the border around the text area and between the
197 scrollbar and the text; resource borderColor.
198 -fn fontlist
200 Select the fonts to be used. This is a comma separated list of font
201 names that are checked in order when trying to find glyphs for
202 characters. The first font defines the cell size for characters;
203 other fonts might be smaller, but not (in general) larger. A
204 (hopefully) reasonable default font list is always appended to it.
205 See resource font for more details.
206 In short, to specify an X11 core font, just specify its name or
208 prefix it with "x:". To specify an XFT-font, you need to prefix it
209 with "xft:", e.g.:
210 urxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
212 urxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
213 See also the question "How does rxvt-unicode choose fonts?" in the
215 FAQ section of urxvt(7).
216 -fb fontlist
218 Compile font-styles: The bold font list to use when bold characters
219 are to be printed. See resource boldFont for details.
220 -fi fontlist
222 Compile font-styles: The italic font list to use when italic
223 characters are to be printed. See resource italicFont for details.
224 -fbi fontlist
226 Compile font-styles: The bold italic font list to use when bold
227 italic characters are to be printed. See resource boldItalicFont
228 for details.
229 -is|+is
231 Compile font-styles: Bold/Blink font styles imply high intensity
232 foreground/background (default). See resource intensityStyles for
233 details.
234 -name name
236 Specify the application name under which resources are to be
237 obtained, rather than the default executable file name. Name should
238 not contain `.' or `*' characters. Also sets the icon and title
239 name.
240 -ls|+ls
242 Start as a login-shell/sub-shell; resource loginShell.
243 -ut|+ut
245 Compile utmp: Inhibit/enable writing a utmp entry; resource
246 utmpInhibit.
247 -vb|+vb
249 Turn on/off visual bell on receipt of a bell character; resource
250 visualBell.
251 -sb|+sb
253 Turn on/off scrollbar; resource scrollBar.
254 -sr|+sr
256 Put scrollbar on right/left; resource scrollBar_right.
257 -st|+st
259 Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
260 resource scrollBar_floating.
261 -si|+si
263 Turn on/off scroll-to-bottom on TTY output inhibit; resource
264 scrollTtyOutput has opposite effect.
265 -sk|+sk
267 Turn on/off scroll-to-bottom on keypress; resource
268 scrollTtyKeypress.
269 -sw|+sw
271 Turn on/off scrolling with the scrollback buffer as new lines
272 appear. This only takes effect if -si is also given; resource
273 scrollWithBuffer.
274 -ptab|+ptab
276 If enabled (default), "Horizontal Tab" characters are being stored
277 as actual wide characters in the screen buffer, which makes it
278 possible to select and paste them. Since a horizontal tab is a
279 cursor movement and not an actual glyph, this can sometimes be
280 visually annoying as the cursor on a tab character is displayed as
281 a wide cursor; resource pastableTabs.
282 -bc|+bc
284 Blink the cursor; resource cursorBlink.
285 -iconic
287 Start iconified, if the window manager supports that option.
288 Alternative form is -ic.
289 -sl number
291 Save number lines in the scrollback buffer. See resource entry for
292 limits; resource saveLines.
293 -b number
295 Compile frills: Internal border of number pixels. See resource
296 entry for limits; resource internalBorder.
297 -w number
299 Compile frills: External border of number pixels. Also, -bw and
300 -borderwidth. See resource entry for limits; resource
301 externalBorder.
302 -bl Compile frills: Set MWM hints to request a borderless window, i.e.
304 if honoured by the WM, the rxvt-unicode window will not have window
305 decorations; resource borderLess.
306 -override-redirect
308 Compile frills: Sets override-redirect on the window; resource
309 override-redirect.
310 -sbg
312 Compile frills: Disable the usage of the built-in block
313 graphics/line drawing characters and just rely on what the
314 specified fonts provide. Use this if you have a good font and want
315 to use its block graphic glyphs; resource skipBuiltinGlyphs.
316 -lsp number
318 Compile frills: Lines (pixel height) to insert between each row of
319 the display. Useful to work around font rendering problems;
320 resource lineSpace.
321 -tn termname
323 This option specifies the name of the terminal type to be set in
324 the TERM environment variable. This terminal type must exist in the
325 termcap(5) database and should have li# and co# entries; resource
326 termName.
327 -e command [arguments]
329 Run the command with its command-line arguments in the urxvt
330 window; also sets the window title and icon name to be the basename
331 of the program being executed if neither -title (-T) nor -n are
332 given on the command line. If this option is used, it must be the
333 last on the command-line. If there is no -e option then the default
334 is to run the program specified by the SHELL environment variable
335 or, failing that, sh(1).
336 Please note that you must specify a program with arguments. If you
338 want to run shell commands, you have to specify the shell, like
339 this:
340 urxvt -e sh -c "shell commands"
342 -title text
344 Window title (-T still respected); the default title is the
345 basename of the program specified after the -e option, if any,
346 otherwise the application name; resource title.
347 -n text
349 Icon name; the default name is the basename of the program
350 specified after the -e option, if any, otherwise the application
351 name; resource iconName.
352 -C Capture system console messages.
354 -pt style
356 Compile XIM: input style for input method; OverTheSpot, OffTheSpot,
357 Root; resource preeditType.
358 -im text
360 Compile XIM: input method name. resource inputMethod.
361 -imlocale string
363 The locale to use for opening the IM. You can use an "LC_CTYPE" of
364 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP"
365 for the input extension to be able to input japanese characters
366 while staying in another locale. resource imLocale.
367 -imfont fontset
369 Set the font set to use for the X Input Method, see resource imFont
370 for more info.
371 -tcw
373 Change the meaning of triple-click selection with the left mouse
374 button. Only effective when the original (non-perl) selection code
375 is in-use. Instead of selecting a full line it will extend the
376 selection to the end of the logical line only. resource
377 tripleclickwords.
378 -insecure
380 Enable "insecure" mode, which currently enables most of the escape
381 sequences that echo strings. See the resource insecure for more
382 info.
383 -mod modifier
385 Override detection of Meta modifier with specified key: alt, meta,
386 hyper, super, mod1, mod2, mod3, mod4, mod5; resource modifier.
387 -ssc|+ssc
389 Turn on/off secondary screen (default enabled); resource
390 secondaryScreen.
391 -ssr|+ssr
393 Turn on/off secondary screen scroll (default enabled); resource
394 secondaryScroll.
395 -hold|+hold
397 Turn on/off hold window after exit support. If enabled, urxvt will
398 not immediately destroy its window when the program executed within
399 it exits. Instead, it will wait till it is being killed or closed
400 by the user; resource hold.
401 -xrm string
403 Works like the X Toolkit option of the same name, by adding the
404 string as if it were specified in a resource file. Resource values
405 specified this way take precedence over all other resource
406 specifications.
407 Note that you need to use the same syntax as in the .Xdefaults
409 file, e.g. "*.background: black". Also note that all urxvt-specific
410 options can be specified as long-options on the commandline, so use
411 of -xrm is mostly limited to cases where you want to specify other
412 resources (e.g. for input methods) or for compatibility with other
413 programs.
414 -keysym.sym string
416 Remap a key symbol. See resource keysym.
417 -embed windowid
419 Tells urxvt to embed its windows into an already-existing window,
420 which enables applications to easily embed a terminal.
421 Right now, urxvt will first unmap/map the specified window, so it
423 shouldn't be a top-level window. urxvt will also reconfigure it
424 quite a bit, so don't expect it to keep some specific state. It's
425 best to create an extra subwindow for urxvt and leave it alone.
426 The window will not be destroyed when urxvt exits.
428 It might be useful to know that urxvt will not close file
430 descriptors passed to it (except for stdin/out/err, of course), so
431 you can use file descriptors to communicate with the programs
432 within the terminal. This works regardless of whether the "-embed"
433 option was used or not.
434 Here is a short Gtk2-perl snippet that illustrates how this option
436 can be used (a longer example is in doc/embed):
437 my $rxvt = new Gtk2::Socket;
439 $rxvt->signal_connect_after (realize => sub {
440 my $xid = $_[0]->window->get_xid;
441 system "urxvt -embed $xid &";
442 });
443 -pty-fd file descriptor
445 Tells urxvt NOT to execute any commands or create a new pty/tty
446 pair but instead use the given file descriptor as the tty master.
447 This is useful if you want to drive urxvt as a generic terminal
448 emulator without having to run a program within it.
449 If this switch is given, urxvt will not create any utmp/wtmp
451 entries and will not tinker with pty/tty permissions - you have to
452 do that yourself if you want that.
453 As an extremely special case, specifying "-1" will completely
455 suppress pty/tty operations, which is probably only useful in
456 conjunction with some perl extension that manages the terminal.
457 Here is a example in perl that illustrates how this option can be
459 used (a longer example is in doc/pty-fd):
460 use IO::Pty;
462 use Fcntl;
463 my $pty = new IO::Pty;
465 fcntl $pty, F_SETFD, 0; # clear close-on-exec
466 system "urxvt -pty-fd " . (fileno $pty) . "&";
467 close $pty;
468 # now communicate with rxvt
470 my $slave = $pty->slave;
471 while (<$slave>) { print $slave "got <$_>\n" }
472 -pe string
474 Comma-separated list of perl extension scripts to use (or not to
475 use) in this terminal instance. See resource perl-ext for details.
476
478 Note: `urxvt --help' gives a list of all resources (long options)
479 compiled into your version. All resources are also available as long-
480 options.
481 You can set and change the resources using X11 tools like xrdb. Many
483 distribution do also load settings from the ~/.Xresources file when X
484 starts. urxvt will consult the following files/resources in order, with
485 later settings overwriting earlier ones:
486 1. system-wide app-defaults file, either locale-dependent OR global
488 2. app-defaults file in $XAPPLRESDIR
489 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
490 4. SCREEN_RESOURCES for the current screen
491 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
492 6. resources specified via -xrm on the commandline
493 Note that when reading X resources, urxvt recognizes two class names:
495 Rxvt and URxvt. The class name Rxvt allows resources common to both
496 urxvt and the original rxvt to be easily configured, while the class
497 name URxvt allows resources unique to urxvt, to be shared between
498 different urxvt configurations. If no resources are specified, suitable
499 defaults will be used. Command-line arguments can be used to override
500 resource settings. The following resources are supported (you might
501 want to check the urxvtperl(3) manpage for additional settings by perl
502 extensions not documented here):
503 depth: bitdepth
505 Compile xft: Attempt to find a visual with the given bit depth;
506 option -depth.
507 buffered: boolean
509 Compile xft: Turn on/off double-buffering for xft (default
510 enabled). On some card/driver combination enabling it slightly
511 decreases performance, on most it greatly helps it. The slowdown is
512 small, so it should normally be enabled.
513 geometry: geom
515 Create the window with the specified X window geometry [default
516 80x24]; option -geometry.
517 background: colour
519 Use the specified colour as the window's background colour [default
520 White]; option -bg.
521 foreground: colour
523 Use the specified colour as the window's foreground colour [default
524 Black]; option -fg.
525 colorn: colour
527 Use the specified colour for the colour value n, where 0-7
528 corresponds to low-intensity (normal) colours and 8-15 corresponds
529 to high-intensity (bold = bright foreground, blink = bright
530 background) colours. The canonical names are as follows: 0=black,
531 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but
532 the actual colour names used are listed in the COLORS AND GRAPHICS
533 section.
534 Colours higher than 15 cannot be set using resources (yet), but can
536 be changed using an escape command (see urxvt(7)).
537 Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm
539 with 88 colour support). Colours 80-87 are evenly spaces grey
540 steps.
541 colorBD: colour
543 colorIT: colour
544 Use the specified colour to display bold or italic characters when
545 the foreground colour is the default. If font styles are not
546 available (Compile styles) and this option is unset, reverse video
547 is used instead.
548 colorUL: colour
550 Use the specified colour to display underlined characters when the
551 foreground colour is the default.
552 colorRV: colour
554 Use the specified colour as the background for reverse video
555 characters when OPTION_HC is disabled (--disable-frills).
556 underlineColor: colour
558 If set, use the specified colour as the colour for the underline
559 itself. If unset, use the foreground colour.
560 cursorColor: colour
562 Use the specified colour for the cursor. The default is to use the
563 foreground colour; option -cr.
564 cursorColor2: colour
566 Use the specified colour for the colour of the cursor text. For
567 this to take effect, cursorColor must also be specified. The
568 default is to use the background colour.
569 reverseVideo: boolean
571 True: simulate reverse video by foreground and background colours;
572 option -rv. False: regular screen colours [default]; option +rv.
573 See note in COLORS AND GRAPHICS section.
574 jumpScroll: boolean
576 True: specify that jump scrolling should be used. When receiving
577 lots of lines, urxvt will only scroll once a whole screen height of
578 lines has been read, resulting in fewer updates while still
579 displaying every received line; option -j.
580 False: specify that smooth scrolling should be used. urxvt will
582 force a screen refresh on each new line it received; option +j.
583 skipScroll: boolean
585 True: (the default) specify that skip scrolling should be used.
586 When receiving lots of lines, urxvt will only scroll once in a
587 while (around 60 times per second), resulting in far fewer updates.
588 This can result in urxvt not ever displaying some of the lines it
589 receives; option -ss.
590 False: specify that everything is to be displayed, even if the
592 refresh is too fast for the human eye to read anything (or the
593 monitor to display anything); option +ss.
594 transparent: boolean
596 Turn on/off illusion of a transparent window background.
597 inheritPixmap is still accepted as an obsolete alias but will be
599 removed in future versions.
600 Please address all transparency related issues to Sasha Vasko at
602 sasha@aftercode.net. Read the FAQ (man 7 urxvt)!
603 fading: number
605 Fade the text by the given percentage when focus is lost; option
606 -fade.
607 fadeColor: colour
609 Fade to this colour, when fading is used (see fading:). The default
610 colour is black; option -fadecolor.
611 tintColor: colour
613 Tint the transparent background pixmap with the given colour;
614 option -tint.
615 shading: number
617 Darken (0 .. 100) or lighten (-1 .. -100) the transparent
618 background image in addition to tinting it; option -sh.
619 blendType: string
621 Specify background blending type; option -blt.
622 blurRadius: number
624 Apply Gaussian Blurr with the specified radius to the transparent
625 background image; option -blr.
626 scrollColor: colour
628 Use the specified colour for the scrollbar [default #B2B2B2].
629 troughColor: colour
631 Use the specified colour for the scrollbar's trough area [default
632 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
633 borderColor: colour
635 The colour of the border around the text area and between the
636 scrollbar and the text.
637 backgroundPixmap: file[;geom[:op1][:op2][...]]
639 Use the specified image file for the background and also optionally
640 specify its scaling with a geometry string WxH+X+Y, (default
641 "0x0+50+50") in which "W" / "H" specify the horizontal/vertical
642 scale (percent), and "X" / "Y" locate the image centre (percent).
643 A scale of 0 displays the image with tiling. A scale of 1 displays
644 the image without any scaling. A scale of 2 to 9 specifies an
645 integer number of images in that direction. No image will be
646 magnified beyond 10 times its original size. The maximum permitted
647 scale is 1000. Additional operations can be specified after colon
648 :op1:op2.... Supported operations are:
649 tile force background image to be tiled and not scaled. Equivalent to 0x0
651 propscale will scale image keeping proportions
652 auto will scale image to match window size. Equivalent to 100x100
653 hscale will scale image horizontally to the window size
654 vscale will scale image vertically to the window size
655 scale will scale image to match window size
656 root will tile image as if it was a root window background, auto-adjusting
657 whenever terminal window moves
658 If used in conjunction with -tr option, the specified pixmap will
660 be blended over transparency image using either alpha-blending, or
661 any other blending type, specified with -blt "type" option.
662 path: path
664 Specify the colon-delimited search path for finding background
665 image files.
666 font: fontlist
668 Select the fonts to be used. This is a comma separated list of font
669 names that are checked in order when trying to find glyphs for
670 characters. The first font defines the cell size for characters;
671 other fonts might be smaller, but not (in general) larger. A
672 (hopefully) reasonable default font list is always appended to it;
673 option -fn.
674 Each font can either be a standard X11 core font (XLFD) name, with
676 optional prefix "x:" or a Xft font (Compile xft), prefixed with
677 "xft:".
678 In addition, each font can be prefixed with additional hints and
680 specifications enclosed in square brackets ("[]"). The only
681 available hint currently is "codeset=codeset-name", and this is
682 only used for Xft fonts.
683 For example, this font resource
685 URxvt.font: 9x15bold,\
687 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
688 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
689 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
690 xft:Code2000:antialias=false
691 specifies five fonts to be used. The first one is "9x15bold"
693 (actually the iso8859-1 version of the second font), which is the
694 base font (because it is named first) and thus defines the
695 character cell grid to be 9 pixels wide and 15 pixels high.
696 The second font is just used to add additional unicode characters
698 not in the base font, likewise the third, which is unfortunately
699 non-bold, but the bold version of the font does contain less
700 characters, so this is a useful supplement.
701 The third font is an Xft font with aliasing turned off, and the
703 characters are limited to the JIS 0208 codeset (i.e. japanese
704 kanji). The font contains other characters, but we are not
705 interested in them.
706 The last font is a useful catch-all font that supplies most of the
708 remaining unicode characters.
709 boldFont: fontlist
711 italicFont: fontlist
712 boldItalicFont: fontlist
713 The font list to use for displaying bold, italic or bold italic
714 characters, respectively.
715 If specified and non-empty, then the syntax is the same as for the
717 font-resource, and the given font list will be used as is, which
718 makes it possible to substitute completely different font styles
719 for bold and italic.
720 If unset (the default), a suitable font list will be synthesized by
722 "morphing" the normal text font list into the desired shape. If
723 that is not possible, replacement fonts of the desired shape will
724 be tried.
725 If set, but empty, then this specific style is disabled and the
727 normal text font will being used for the given style.
728 intensityStyles: boolean
730 When font styles are not enabled, or this option is enabled (True,
731 option -is, the default), bold/blink font styles imply high
732 intensity foreground/background colours. Disabling this option
733 (False, option +is) disables this behaviour, the high intensity
734 colours are not reachable.
735 title: string
737 Set window title string, the default title is the command-line
738 specified after the -e option, if any, otherwise the application
739 name; option -title.
740 iconName: string
742 Set the name used to label the window's icon or displayed in an
743 icon manager window, it also sets the window's title unless it is
744 explicitly set; option -n.
745 mapAlert: boolean
747 True: de-iconify (map) on receipt of a bell character. False: no
748 de-iconify (map) on receipt of a bell character [default].
749 urgentOnBell: boolean
751 True: set the urgency hint for the wm on receipt of a bell
752 character. False: do not set the urgency hint [default].
753 visualBell: boolean
755 True: use visual bell on receipt of a bell character; option -vb.
756 False: no visual bell [default]; option +vb.
757 loginShell: boolean
759 True: start as a login shell by prepending a `-' to argv[0] of the
760 shell; option -ls. False: start as a normal sub-shell [default];
761 option +ls.
762 utmpInhibit: boolean
764 True: inhibit writing record into the system log file utmp; option
765 -ut. False: write record into the system log file utmp [default];
766 option +ut.
767 print-pipe: string
769 Specify a command pipe for vt100 printer [default lpr(1)]. Use
770 Print to initiate a screen dump to the printer and Ctrl-Print or
771 Shift-Print to include the scrollback as well.
772 The string will be interpreted as if typed into the shell as-is.
774 Example:
776 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
778 This creates a new file in your home directory with the screen
780 contents every time you hit "Print".
781 scrollstyle: mode
783 Set scrollbar style to rxvt, plain, next or xterm. plain is the
784 author's favourite.
785 scrollBar: boolean
787 True: enable the scrollbar [default]; option -sb. False: disable
788 the scrollbar; option +sb.
789 scrollBar_right: boolean
791 True: place the scrollbar on the right of the window; option -sr.
792 False: place the scrollbar on the left of the window; option +sr.
793 scrollBar_floating: boolean
795 True: display an rxvt scrollbar without a trough; option -st.
796 False: display an rxvt scrollbar with a trough; option +st.
797 scrollBar_align: mode
799 Align the top, bottom or centre [default] of the scrollbar thumb
800 with the pointer on middle button press/drag.
801 scrollTtyOutput: boolean
803 True: scroll to bottom when tty receives output; option -si.
804 False: do not scroll to bottom when tty receives output; option
805 +si.
806 scrollWithBuffer: boolean
808 True: scroll with scrollback buffer when tty receives new lines
809 (and scrollTtyOutput is False); option -sw. False: do not scroll
810 with scrollback buffer when tty receives new lines; option +sw.
811 scrollTtyKeypress: boolean
813 True: scroll to bottom when a non-special key is pressed. Special
814 keys are those which are intercepted by rxvt-unicode for special
815 handling and are not passed onto the shell; option -sk. False: do
816 not scroll to bottom when a non-special key is pressed; option +sk.
817 saveLines: number
819 Save number lines in the scrollback buffer [default 64]. This
820 resource is limited on most machines to 65535; option -sl.
821 internalBorder: number
823 Internal border of number pixels. This resource is limited to 100;
824 option -b.
825 externalBorder: number
827 External border of number pixels. This resource is limited to 100;
828 option -w, -bw, -borderwidth.
829 borderLess: boolean
831 Set MWM hints to request a borderless window, i.e. if honoured by
832 the WM, the rxvt-unicode window will not have window decorations;
833 option -bl.
834 skipBuiltinGlyphs: boolean
836 Compile frills: Disable the usage of the built-in block
837 graphics/line drawing characters and just rely on what the
838 specified fonts provide. Use this if you have a good font and want
839 to use its block graphic glyphs; option -sbg.
840 termName: termname
842 Specifies the terminal type name to be set in the TERM environment
843 variable; option -tn.
844 lineSpace: number
846 Specifies number of lines (pixel height) to insert between each row
847 of the display [default 0]; option -lsp.
848 meta8: boolean
850 True: handle Meta (Alt) + keypress to set the 8th bit. False:
851 handle Meta (Alt) + keypress as an escape prefix [default].
852 mouseWheelScrollPage: boolean
854 True: the mouse wheel scrolls a page full. False: the mouse wheel
855 scrolls five lines [default].
856 pastableTabs: boolean
858 True: store tabs as wide characters. False: interpret tabs as
859 cursor movement only; option "-ptab".
860 cursorBlink: boolean
862 True: blink the cursor. False: do not blink the cursor [default];
863 option -bc.
864 pointerBlank: boolean
866 True: blank the pointer when a key is pressed or after a set number
867 of seconds of inactivity. False: the pointer is always visible
868 [default].
869 pointerColor: colour
871 Mouse pointer foreground colour.
872 pointerColor2: colour
874 Mouse pointer background colour.
875 pointerBlankDelay: number
877 Specifies number of seconds before blanking the pointer [default
878 2]. Use a large number (e.g. 987654321) to effectively disable the
879 timeout.
880 backspacekey: string
882 The string to send when the backspace key is pressed. If set to DEC
883 or unset it will send Delete (code 127) or, if shifted, Backspace
884 (code 8) - which can be reversed with the appropriate DEC private
885 mode escape sequence.
886 deletekey: string
888 The string to send when the delete key (not the keypad delete key)
889 is pressed. If unset it will send the sequence traditionally
890 associated with the Execute key.
891 cutchars: string
893 The characters used as delimiters for double-click word selection
894 (whitespace delimiting is added automatically if resource is
895 given).
896 When the perl selection extension is in use (the default if
898 compiled in, see the urxvtperl(3) manpage), a suitable regex using
899 these characters will be created (if the resource exists,
900 otherwise, no regex will be created). In this mode, characters
901 outside ISO-8859-1 can be used.
902 When the selection extension is not used, only ISO-8859-1
904 characters can be used. If not specified, the built-in default is
905 used:
906 BACKSLASH `"'&()*,;<=>?@[]^{|}
908 preeditType: style
910 OverTheSpot, OffTheSpot, Root; option -pt.
911 inputMethod: name
913 name of inputMethod to use; option -im.
914 imLocale: name
916 The locale to use for opening the IM. You can use an "LC_CTYPE" of
917 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP"
918 for the input extension to be able to input japanese characters
919 while staying in another locale; option -imlocale.
920 imFont: fontset
922 Specify the font-set used for XIM styles "OverTheSpot" or
923 "OffTheSpot". It must be a standard X font set (XLFD patterns
924 separated by commas), i.e. it's not in the same format as the other
925 font lists used in urxvt. The default will be set-up to chose *any*
926 suitable found found, preferably one or two pixels differing in
927 size to the base font. option -imfont.
928 tripleclickwords: boolean
930 Change the meaning of triple-click selection with the left mouse
931 button. Instead of selecting a full line it will extend the
932 selection to the end of the logical line only; option -tcw.
933 insecure: boolean
935 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
936 that echo arbitrary strings like the icon name or the locale. This
937 could be abused if somebody gets 8-bit-clean access to your
938 display, whether through a mail client displaying mail bodies
939 unfiltered or through write(1) or any other means. Therefore, these
940 sequences are disabled by default. (Note that many other terminals,
941 including xterm, have these sequences enabled by default, which
942 doesn't make it safer, though).
943 You can enable them by setting this boolean resource or specifying
945 -insecure as an option. At the moment, this enables display-answer,
946 locale, findfont, icon label and window title requests.
947 modifier: modifier
949 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
950 super, mod1, mod2, mod3, mod4, mod5; option -mod.
951 answerbackString: string
953 Specify the reply rxvt-unicode sends to the shell when an ENQ
954 (control-E) character is passed through. It may contain escape
955 values as described in the entry on keysym following.
956 secondaryScreen: boolean
958 Turn on/off secondary screen (default enabled).
959 secondaryScroll: boolean
961 Turn on/off secondary screen scroll (default enabled). If this
962 option is enabled, scrolls on the secondary screen will change the
963 scrollback buffer and switching to/from the secondary screen will
964 instead scroll the screen up.
965 hold: boolean
967 Turn on/off hold window after exit support. If enabled, urxvt will
968 not immediately destroy its window when the program executed within
969 it exits. Instead, it will wait till it is being killed or closed
970 by the user.
971 keysym.sym: string
973 Compile frills: Associate string with keysym sym. The intervening
974 resource name keysym. cannot be omitted.
975 The format of sym is "(modifiers-)key", where modifiers can be any
977 combination of ISOLevel3, AppKeypad, Control, NumLock, Shift, Meta,
978 Lock, Mod1, Mod2, Mod3, Mod4, Mod5, and the abbreviated I, K, C, N,
979 S, M, A, L, 1, 2, 3, 4, 5.
980 The NumLock, Meta and ISOLevel3 modifiers are usually aliased to
982 whatever modifier the NumLock key, Meta/Alt keys or ISO Level3
983 Shift/AltGr keys are being mapped. AppKeypad is a synthetic
984 modifier mapped to the current application keymap mode state.
985 The spellings of key can be obtained by using xev(1) command or
987 searching keysym macros from /usr/X11R6/include/X11/keysymdef.h and
988 omitting the prefix XK_. Alternatively you can specify key by its
989 hex keysym value (0x0000 - 0xFFFF). Note that the lookup of syms is
990 not performed in an exact manner; however, the closest match is
991 assured.
992 string may contain escape values ("\n": newline, "\000": octal
994 number), see RESOURCES in "man 7 X" for futher details.
995 You can define a range of keysyms in one shot by providing a string
997 with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter `/'
998 should be a character not used by the strings.
999 Its usage can be demonstrated by an example:
1001 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1003 The above line is equivalent to the following three lines:
1005 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
1007 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
1008 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
1009 If string takes the form of "command:STRING", the specified STRING
1011 is interpreted and executed as urxvt's control sequence. For
1012 example the following means "change the current locale to
1013 "zh_CN.GBK" when Control-Meta-c is being pressed":
1014 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1016 If string takes the form "perl:STRING", then the specified STRING
1018 is passed to the "on_keyboard_command" perl handler. See the
1019 urxvtperl(3) manpage. For example, the selection extension
1020 (activated via "urxvt -pe selection") listens for "selection:rot13"
1021 events:
1022 URxvt.keysym.M-C-c: perl:selection:rot13
1024 Due the the large number of modifier combinations, a defined key
1026 mapping will match if at at least the specified identifiers are
1027 being set, and no other key mappings with those and more bits are
1028 being defined. That means that defining a key map for "a" will
1029 automatically provide definitions for "Meta-a", "Shift-a" and so
1030 on, unless some of those are defined mappings themselves.
1031 Unfortunately, this will override built-in key mappings. For
1033 example if you overwrite the "Insert" key you will disable urxvt's
1034 "Shift-Insert" mapping. To re-enable that, you can poke "holes"
1035 into the user-defined keymap using the "builtin:" replacement:
1036 URxvt.keysym.Insert: <my insert key sequence>
1038 URxvt.keysym.S-Insert: builtin:
1039 The first line defines a mapping for "Insert" and any combination
1041 of modifiers. The second line re-establishes the default mapping
1042 for "Shift-Insert".
1043 The following example will map Control-Meta-1 and Control-Meta-2 to
1045 the fonts "suxuseuro" and "9x15bold", so you can have some limited
1046 font-switching at runtime:
1047 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1049 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1050 Other things are possible, e.g. resizing (see urxvt(7) for more
1052 info):
1053 URxvt.keysym.M-C-3: command:\033[8;25;80t
1055 URxvt.keysym.M-C-4: command:\033[8;48;110t
1056 perl-ext-common: string
1058 perl-ext: string
1059 Comma-separated list(s) of perl extension scripts (default:
1060 "default") to use in this terminal instance; option -pe.
1061 Extension names can be prefixed with a "-" sign to prohibit using
1063 them. This can be useful to selectively disable some extensions
1064 loaded by default, or specified via the "perl-ext-common" resource.
1065 For example, "default,-selection" will use all the default
1066 extension except "selection".
1067 Extension names can also be followed by an argument in angle
1069 brackets (e.g. "searchable-scrollback<M-s>", which binds the
1070 hotkey for searchable scrollback to Alt/Meta-s). Mentioning the
1071 same extension multiple times with different arguments will pass
1072 multiple arguments to the extension.
1073 Each extension is looked up in the library directories, loaded if
1075 necessary, and bound to the current terminal instance.
1076 If both of these resources are the empty string, then the perl
1078 interpreter will not be initialized. The idea behind two options is
1079 that perl-ext-common will be used for extensions that should be
1080 available to all instances, while perl-ext is used for specific
1081 instances.
1082 perl-eval: string
1084 Perl code to be evaluated when all extensions have been registered.
1085 See the urxvtperl(3) manpage. Due to security reasons, this
1086 resource will be ignored when running setuid/setgid.
1087 perl-lib: path
1089 Colon-separated list of additional directories that hold extension
1090 scripts. When looking for extensions specified by the "perl"
1091 resource, urxvt will first look in these directories and then in
1092 /usr/lib64/urxvt/perl/. Due to security reasons, this resource will
1093 be ignored when running setuid/setgid.
1094 See the urxvtperl(3) manpage.
1096 selection.pattern-idx: perl-regex
1098 Additional selection patterns, see the urxvtperl(3) manpage for
1099 details.
1100 selection-autotransform.idx: perl-transform
1102 Selection auto-transform patterns, see the urxvtperl(3) manpage for
1103 details.
1104 searchable-scrollback: keysym
1106 Sets the hotkey that starts the incremental scrollback buffer
1107 search (default: "M-s").
1108 urlLauncher: string
1110 Specifies the program to be started with a URL argument. Used by
1111 the "selection-popup" and "matcher" perl extensions.
1112 transient-for: windowid
1114 Compile frills: Sets the WM_TRANSIENT_FOR property to the given
1115 window id.
1116 override-redirect: boolean
1118 Compile frills: Sets override-redirect for the terminal window,
1119 making it almost invisible to window managers; option
1120 -override-redirect.
1121 iso14755_52: boolean
1123 Turn on/off ISO 14755 5.2 mode (default enabled).
1124
1126 Lines of text that scroll off the top of the urxvt window (resource:
1127 saveLines) and can be scrolled back using the scrollbar or by
1128 keystrokes. The normal urxvt scrollbar has arrows and its behaviour is
1129 fairly intuitive. The xterm-scrollbar is without arrows and its
1130 behaviour mimics that of xterm
1131 Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up
1133 with Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with
1134 Button2.
1135
1137 To temporarily override mouse reporting, for either the scrollbar or
1138 the normal text selection/insertion, hold either the Shift or the Meta
1139 (Alt) key while performing the desired mouse action.
1140 If mouse reporting mode is active, the normal scrollbar actions are
1142 disabled -- on the assumption that we are using a fullscreen
1143 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
1144 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
1145 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
1146
1148 The behaviour of text selection and insertion/pasting mechanism is
1149 similar to xterm(1).
1150 Selecting:
1152 Left click at the beginning of the region, drag to the end of the
1153 region and release; Right click to extend the marked region; Left
1154 double-click to select a word; Left triple-click to select the
1155 entire logical line (which can span multiple screen lines), unless
1156 modified by resource tripleclickwords.
1157 Starting a selection while pressing the Meta key (or Meta+Ctrl
1159 keys) (Compile: frills) will create a rectangular selection instead
1160 of a normal one. In this mode, every selected row becomes its own
1161 line in the selection, and trailing whitespace is visually
1162 underlined and removed from the selection.
1163 Pasting:
1165 Pressing and releasing the Middle mouse button in an urxvt window
1166 causes the value of the PRIMARY selection (or CLIPBOARD with the
1167 Meta modifier) to be inserted as if it had been typed on the
1168 keyboard.
1169 Pressing Shift-Insert causes the value of the PRIMARY selection to
1171 be inserted too.
1172
1174 Changing fonts (or font sizes, respectively) via the keypad is not yet
1175 supported in rxvt-unicode. Bug me if you need this.
1176 You can, however, switch fonts at runtime using escape sequences, e.g.:
1178 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1180 You can use keyboard shortcuts, too:
1182 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1184 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1185 rxvt-unicode will automatically re-apply these fonts to the output so
1187 far.
1188
1190 ISO 14755 is a standard for entering and viewing unicode characters and
1191 character codes using the keyboard. It consists of 4 parts. The first
1192 part is available if rxvt-unicode has been compiled with
1193 "--enable-frills", the rest is available when rxvt-unicode was compiled
1194 with "--enable-iso14755".
1195 · 5.1: Basic method
1197 This allows you to enter unicode characters using their hexcode.
1199 Start by pressing and holding both "Control" and "Shift", then
1201 enter hex-digits (between one and six). Releasing "Control" and
1202 "Shift" will commit the character as if it were typed directly.
1203 While holding down "Control" and "Shift" you can also enter
1204 multiple characters by pressing "Space", which will commit the
1205 current character and lets you start a new one.
1206 As an example of use, imagine a business card with a japanese
1208 e-mail address, which you cannot type. Fortunately, the card has
1209 the e-mail address printed as hexcodes, e.g. "671d 65e5". You can
1210 enter this easily by pressing "Control" and "Shift", followed by
1211 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys.
1212 · 5.2: Keyboard symbols entry method
1214 This mode lets you input characters representing the keycap symbols
1216 of your keyboard, if representable in the current locale encoding.
1217 Start by pressing "Control" and "Shift" together, then releasing
1219 them. The next special key (cursor keys, home etc.) you enter will
1220 not invoke its usual function but instead will insert the
1221 corresponding keycap symbol. The symbol will only be entered when
1222 the key has been released, otherwise pressing e.g. "Shift" would
1223 enter the symbol for "ISO Level 2 Switch", although your intention
1224 might have been to enter a reverse tab (Shift-Tab).
1225 · 5.3: Screen-selection entry method
1227 While this is implemented already (it's basically the selection
1229 mechanism), it could be extended by displaying a unicode character
1230 map.
1231 · 5.4: Feedback method for identifying displayed characters for later
1233 input
1234 This method lets you display the unicode character code associated
1236 with characters already displayed.
1237 You enter this mode by holding down "Control" and "Shift" together,
1239 then pressing and holding the left mouse button and moving around.
1240 The unicode hex code(s) (it might be a combining character) of the
1241 character under the pointer is displayed until you release
1242 "Control" and "Shift".
1243 In addition to the hex codes it will display the font used to draw
1245 this character - due to implementation reasons, characters combined
1246 with combining characters, line drawing characters and unknown
1247 characters will always be drawn using the built-in support font.
1248 With respect to conformance, rxvt-unicode is supposed to be compliant
1250 to both scenario A and B of ISO 14755, including part 5.2.
1251
1253 urxvt tries to write an entry into the utmp(5) file so that it can be
1254 seen via the who(1) command, and can accept messages. To allow this
1255 feature, urxvt may need to be installed setuid root on some systems or
1256 setgid to root or to some other group on others.
1257
1259 In addition to the default foreground and background colours, urxvt can
1260 display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
1261 versions of the same). Here is a list of the colours with their names.
1262 color0 (black) = Black
1264 color1 (red) = Red3
1265 color2 (green) = Green3
1266 color3 (yellow) = Yellow3
1267 color4 (blue) = Blue3
1268 color5 (magenta) = Magenta3
1269 color6 (cyan) = Cyan3
1270 color7 (white) = AntiqueWhite
1271 color8 (bright black) = Grey25
1272 color9 (bright red) = Red
1273 color10 (bright green) = Green
1274 color11 (bright yellow) = Yellow
1275 color12 (bright blue) = Blue
1276 color13 (bright magenta) = Magenta
1277 color14 (bright cyan) = Cyan
1278 color15 (bright white) = White
1279 foreground = Black
1280 background = White
1281 It is also possible to specify the colour values of foreground,
1283 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1284 0-15, as a convenient shorthand to reference the colour name of
1285 color0-color15.
1286 In addition to the colours defined above, urxvt offers an additional 72
1288 colours. The first 64 of those (with indices 16 to 79) consist of a
1289 4*4*4 RGB colour cube (i.e. index = r * 16 + g * 4 + b + 16), followed
1290 by 8 additional shades of gray (with indices 80 to 87).
1291 Together, all those colours implement the 88 colour xterm colours. Only
1293 the first 16 can be changed using resources currently, the rest can
1294 only be changed via command sequences ("escape codes").
1295 Note that -rv ("reverseVideo: True") simulates reverse video by always
1297 swapping the foreground/background colours. This is in contrast to
1298 xterm(1) where the colours are only swapped if they have not otherwise
1299 been specified. For example,
1300 urxvt -fg Black -bg White -rv
1302 would yield White on Black, while on xterm(1) it would yield Black
1303 on White.
1304 ALPHA CHANNEL SUPPORT
1306 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1308 get their act together, rxvt-unicode will do it's own alpha channel
1309 management:
1310 You can prefix any color with an opaquenes percentage enclosed in
1312 brackets, i.e. "[percent]", where "percent" is a decimal percentage
1313 (0-100) that specifies the opacity of the color, where 0 is completely
1314 transparent and 100 is completely opaque. For example, "[50]red" is a
1315 half-transparent red, while "[95]#00ff00" is an almost opaque green.
1316 This is the recommended format to specify transparency values, and
1317 works with all ways to specify a colour.
1318 For complete control, rxvt-unicode also supports
1320 "rgba:rrrr/gggg/bbbb/aaaa" (exactly four hex digits/component) colour
1321 specifications, where the additional "aaaa" component specifies opacity
1322 (alpha) values. The minimum value of 0000 is completely transparent,
1323 while "ffff" is completely opaque). The two example colours from
1324 earlier could also be specified as "rgba:ff00/0000/0000/8000" and
1325 "rgba:0000/ff00/0000/f332".
1326 You probably need to specify "-depth 32", too, to force a visual with
1328 alpha channels, and have the luck that your X-server uses ARGB pixel
1329 layout, as X is far from just supporting ARGB visuals out of the box,
1330 and rxvt-unicode just fudges around.
1331 For example, the following selects an almost completely transparent
1333 black background, and an almost opaque pink foreground:
1334 urxvt -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1336 When not using a background image, then the interpretation of the alpha
1338 channel is up to your compositing manager (most interpret it as
1339 transparency of course).
1340 When using a background pixmap or pseudo-transparency, then the
1342 background colour will always behave as if it were completely
1343 transparent (so the background image shows instead), regardless of how
1344 it was specified, while other colours will either be transparent as
1345 specified (the background image will show through) on servers
1346 supporting the RENDER extension, or fully opaque on servers not
1347 supporting the RENDER EXTENSION.
1348 Please note that due to bugs in Xft, specifying alpha values might
1350 result in garbage being displayed when the X-server does not support
1351 the RENDER extension.
1352
1354 urxvt sets and/or uses the following environment variables:
1355 TERM
1357 Normally set to "rxvt-unicode", unless overwritten at configure
1358 time, via resources or on the command line.
1359 COLORTERM
1361 Either "rxvt", "rxvt-xpm", depending on whether urxvt was compiled
1362 with background image support, and optionally with the added
1363 extension "-mono" to indicate that rxvt-unicode runs on a
1364 monochrome screen.
1365 COLORFGBG
1367 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1368 the colour code used as default foreground/text colour (or the
1369 string "default" to indicate that the default-colour escape
1370 sequence is to be used), "bg" is the colour code used as default
1371 background colour (or the string "default"), and "xpm" is the
1372 string "default" if urxvt was compiled with background image
1373 support. Libraries like "ncurses" and "slang" can (and do) use this
1374 information to optimize screen output.
1375 WINDOWID
1377 Set to the (decimal) X Window ID of the urxvt window (the toplevel
1378 window, which usually has subwindows for the scrollbar, the
1379 terminal window and so on).
1380 TERMINFO
1382 Set to the terminfo directory iff urxvt was configured with
1383 "--with-terminfo=PATH".
1384 DISPLAY
1386 Used by urxvt to connect to the display and set to the correct
1387 display in its child processes.
1388 SHELL
1390 The shell to be used for command execution, defaults to "/bin/sh".
1391 RXVT_SOCKET
1393 The unix domain socket path used by urxvtc(1) and urxvtd(1).
1394 Default $HOME/.rxvt-unicode-<nodename.
1396 HOME
1398 Used to locate the default directory for the unix domain socket for
1399 daemon communications and to locate various resource files (such as
1400 ".Xdefaults")
1401 XAPPLRESDIR
1403 Directory where various X resource files are being located.
1404 XENVIRONMENT
1406 If set and accessible, gives the name of a X resource file to be
1407 loaded by urxvt.
1408
1410 /usr/lib/X11/rgb.txt
1411 Color names.
1412
1414 urxvt(7), urxvtc(1), urxvtd(1), xterm(1), sh(1), resize(1), X(1),
1415 pty(4), tty(4), utmp(5)
1416
1418 Project Coordinator
1419 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1420 <http://software.schmorp.de/pkg/rxvt-unicode.html>
1422
1424 John Bovey
1425 University of Kent, 1992, wrote the original Xvt.
1426 Rob Nation <nation@rocket.sanders.lockheed.com>
1428 very heavily modified Xvt and came up with Rxvt
1429 Angelo Haritsis <ah@doc.ic.ac.uk>
1431 wrote the Greek Keyboard Input (no longer in code)
1432 mj olesen <olesen@me.QueensU.CA>
1434 Wrote the menu system.
1435 Project Coordinator (changes.txt 2.11 to 2.21)
1437 Oezguer Kesim <kesim@math.fu-berlin.de>
1439 Project Coordinator (changes.txt 2.21a to 2.4.5)
1440 Geoff Wing <gcw@pobox.com>
1442 Rewrote screen display and text selection routines.
1443 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1445 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1447 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1448 perl extension, random hacks, numerous bugfixes and extensions.
1449 Project Coordinator (Changes 1.0 -)
1451 Emanuele Giaquinta <e.giaquinta@glauco.it>
1453 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
14549.0 2008-01-26 urxvt(1)