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.12, 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 <http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
22
24 See urxvt(7) (try "man 7 urxvt") for a list of frequently asked
25 questions and answer to them and some common problems. That document is
26 also accessible on the World-Wide-Web at
27 http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod
28 <http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
29
31 Unlike the original rxvt, rxvt-unicode stores all text in Unicode
32 internally. That means it can store and display most scripts in the
33 world. Being a terminal emulator, however, some things are very
34 difficult, especially cursive scripts such as arabic, vertically
35 written scripts like mongolian or scripts requiring extremely complex
36 combining rules, like tibetan or devanagari. Don't expect pretty output
37 when using these scripts. Most other scripts, latin, cyrillic, kanji,
38 thai etc. should work fine, though. A somewhat difficult case are
39 right-to-left scripts, such as hebrew: rxvt-unicode adopts the view
40 that bidirectional algorithms belong in the application, not the
41 terminal emulator (too many things -- such as cursor-movement while
42 editing -- break otherwise), but that might change.
43 If you are looking for a terminal that supports more exotic scripts,
45 let me recommend "mlterm", which is a very user friendly, lean and
46 clean terminal emulator. In fact, the reason rxvt-unicode was born was
47 solely because the author couldn't get "mlterm" to use one font for
48 latin1 and another for japanese.
49 Therefore another design rationale was the use of multiple fonts to
51 display characters: The idea of a single unicode font which many other
52 programs force onto its users never made sense to me: You should be
53 able to choose any font for any script freely.
54 Apart from that, rxvt-unicode is also much better internationalised
56 than its predecessor, supports things such as XFT and ISO 14755 that
57 are handy in i18n-environments, is faster, and has a lot bugs less than
58 the original rxvt. This all in addition to dozens of other small
59 improvements.
60 It is still faithfully following the original rxvt idea of being lean
62 and nice on resources: for example, you can still configure rxvt-
63 unicode without most of its features to get a lean binary. It also
64 comes with a client/daemon pair that lets you open any number of
65 terminal windows from within a single process, which makes startup time
66 very fast and drastically reduces memory usage. See urxvtd(1) (daemon)
67 and urxvtc(1) (client).
68 It also makes technical information about escape sequences (which have
70 been extended) more accessible: see urxvt(7) for technical reference
71 documentation (escape sequences etc.).
72
74 The urxvt options (mostly a subset of xterm's) are listed below. In
75 keeping with the smaller-is-better philosophy, options may be
76 eliminated or default values chosen at compile-time, so options and
77 defaults listed may not accurately reflect the version installed on
78 your system. `urxvt -h' gives a list of major compile-time options on
79 the Options line. Option descriptions may be prefixed with which
80 compile option each is dependent upon. e.g. `Compile XIM:' requires XIM
81 on the Options line. Note: `urxvt -help' gives a list of all command-
82 line options compiled into your version.
83 Note that urxvt permits the resource name to be used as a long-option
85 (--/++ option) so the potential command-line options are far greater
86 than those listed. For example: `urxvt --loginShell --color1 Orange'.
87 The following options are available:
89 -help, --help
91 Print out a message describing available options.
92 -display displayname
94 Attempt to open a window on the named X display (the older form -d
95 is still respected. but deprecated). In the absence of this option,
96 the display specified by the DISPLAY environment variable is used.
97 -depth bitdepth
99 Compile xft: Attempt to find a visual with the given bit depth;
100 resource depth.
101 [Please note that many X servers (and libXft) are buggy with
103 respect to "-depth 32" and/or alpha channels, and will cause all
104 sorts of graphical corruption. This is harmless, but we can't do
105 anything about this, so watch out]
106 -geometry geom
108 Window geometry (-g still respected); resource geometry.
109 -rv|+rv
111 Turn on/off simulated reverse video; resource reverseVideo.
112 -j|+j
114 Turn on/off jump scrolling (allow multiple lines per refresh);
115 resource jumpScroll.
116 -ss|+ss
118 Turn on/off skip scrolling (allow multiple screens per refresh);
119 resource skipScroll.
120 -tr|+tr
122 Turn on/off pseudo-transparency by using the root pixmap as
123 background; resource transparent.
124 -ip is still accepted as an obsolete alias but will be removed in
126 future versions.
127 -fade number
129 Fade the text by the given percentage when focus is lost. Small
130 values fade a little only, 100 completely replaces all colours by
131 the fade colour; resource fading.
132 -fadecolor colour
134 Fade to this colour when fading is used (see -fade). The default
135 colour is opaque black. resource fadeColor.
136 -tint colour
138 Tint the transparent background with the given colour; resource
139 tintColor.
140 -sh number
142 Darken (0 .. 99) or lighten (101 .. 200) the transparent
143 background. A value of 100 means no shading; resource shading.
144 -blt string
146 Specify background blending type. If background pixmap is specified
147 at the same time as transparency - such pixmap will be blended over
148 the transparent background, using the method specified. Supported
149 values are: add, alphablend, allanon - colour values averaging,
150 colorize, darken, diff, dissipate, hue, lighten, overlay, saturate,
151 screen, sub, tint, value. The default is alpha-blending. Compile
152 afterimage; resource blendType.
153 -blr HxV
155 Apply Gaussian Blur with the specified radii to the transparent
156 background. If a single number is specified - both vertical and
157 horizontal radii are considered to be the same. Setting one of the
158 radii to 1 and another to a large number creates interesting
159 effects on some backgrounds. Maximum radius value is 128; resource
160 blurRadius.
161 -icon file
163 Compile afterimage or pixbuf: Use the specified image as
164 application icon. This is used by many window managers, taskbars
165 and pagers to represent the application window; resource iconFile.
166 -bg colour
168 Window background colour; resource background.
169 -fg colour
171 Window foreground colour; resource foreground.
172 -pixmap file[;geom[:op1][:op2][...]]
174 Compile afterimage or pixbuf: Specify image file for the background
175 and also optionally specify its scaling with a geometry string.
176 Note you may need to add quotes to avoid special shell
177 interpretation of the ";" in the command-line; for more details see
178 resource backgroundPixmap.
179 -cr colour
181 The cursor colour; resource cursorColor.
182 -pr colour
184 The mouse pointer foreground colour; resource pointerColor.
185 -pr2 colour
187 The mouse pointer background colour; resource pointerColor2.
188 -bd colour
190 The colour of the border around the text area and between the
191 scrollbar and the text; resource borderColor.
192 -fn fontlist
194 Select the fonts to be used. This is a comma separated list of font
195 names that are checked in order when trying to find glyphs for
196 characters. The first font defines the cell size for characters;
197 other fonts might be smaller, but not (in general) larger. A
198 (hopefully) reasonable default font list is always appended to it.
199 See resource font for more details.
200 In short, to specify an X11 core font, just specify its name or
202 prefix it with "x:". To specify an XFT-font, you need to prefix it
203 with "xft:", e.g.:
204 urxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
206 urxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
207 See also the question "How does rxvt-unicode choose fonts?" in the
209 FAQ section of urxvt(7).
210 -fb fontlist
212 Compile font-styles: The bold font list to use when bold characters
213 are to be printed. See resource boldFont for details.
214 -fi fontlist
216 Compile font-styles: The italic font list to use when italic
217 characters are to be printed. See resource italicFont for details.
218 -fbi fontlist
220 Compile font-styles: The bold italic font list to use when bold
221 italic characters are to be printed. See resource boldItalicFont
222 for details.
223 -is|+is
225 Compile font-styles: Bold/Blink font styles imply high intensity
226 foreground/background (default). See resource intensityStyles for
227 details.
228 -name name
230 Specify the application name under which resources are to be
231 obtained, rather than the default executable file name. Name should
232 not contain `.' or `*' characters. Also sets the icon and title
233 name.
234 -ls|+ls
236 Start as a login-shell/sub-shell; resource loginShell.
237 -ut|+ut
239 Compile utmp: Inhibit/enable writing a utmp entry; resource
240 utmpInhibit.
241 -vb|+vb
243 Turn on/off visual bell on receipt of a bell character; resource
244 visualBell.
245 -sb|+sb
247 Turn on/off scrollbar; resource scrollBar.
248 -sr|+sr
250 Put scrollbar on right/left; resource scrollBar_right.
251 -st|+st
253 Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
254 resource scrollBar_floating.
255 -si|+si
257 Turn on/off scroll-to-bottom on TTY output inhibit; resource
258 scrollTtyOutput has opposite effect.
259 -sk|+sk
261 Turn on/off scroll-to-bottom on keypress; resource
262 scrollTtyKeypress.
263 -sw|+sw
265 Turn on/off scrolling with the scrollback buffer as new lines
266 appear. This only takes effect if -si is also given; resource
267 scrollWithBuffer.
268 -ptab|+ptab
270 If enabled (default), "Horizontal Tab" characters are being stored
271 as actual wide characters in the screen buffer, which makes it
272 possible to select and paste them. Since a horizontal tab is a
273 cursor movement and not an actual glyph, this can sometimes be
274 visually annoying as the cursor on a tab character is displayed as
275 a wide cursor; resource pastableTabs.
276 -bc|+bc
278 Blink the cursor; resource cursorBlink.
279 -uc|+uc
281 Make the cursor underlined; resource cursorUnderline.
282 -iconic
284 Start iconified, if the window manager supports that option.
285 Alternative form is -ic.
286 -sl number
288 Save number lines in the scrollback buffer. See resource entry for
289 limits; resource saveLines.
290 -b number
292 Compile frills: Internal border of number pixels. See resource
293 entry for limits; resource internalBorder.
294 -w number
296 Compile frills: External border of number pixels. Also, -bw and
297 -borderwidth. See resource entry for limits; resource
298 externalBorder.
299 -bl Compile frills: Set MWM hints to request a borderless window, i.e.
301 if honoured by the WM, the rxvt-unicode window will not have window
302 decorations; resource borderLess. If the window manager does not
303 support MWM hints (e.g. kwin), enables override-redirect mode.
304 -override-redirect
306 Compile frills: Sets override-redirect on the window; resource
307 override-redirect.
308 -sbg
310 Compile frills: Disable the usage of the built-in block
311 graphics/line drawing characters and just rely on what the
312 specified fonts provide. Use this if you have a good font and want
313 to use its block graphic glyphs; resource skipBuiltinGlyphs.
314 -lsp number
316 Compile frills: Lines (pixel height) to insert between each row of
317 the display. Useful to work around font rendering problems;
318 resource lineSpace.
319 -letsp number
321 Compile frills: Amount to adjust the computed character width by to
322 control overall letter spacing. Negative values will tighten up the
323 letter spacing, positive values will space letters out more. Useful
324 to work around odd font metrics; resource letterSpace.
325 -tn termname
327 This option specifies the name of the terminal type to be set in
328 the TERM environment variable. This terminal type must exist in the
329 termcap(5) database and should have li# and co# entries; resource
330 termName.
331 -e command [arguments]
333 Run the command with its command-line arguments in the urxvt
334 window; also sets the window title and icon name to be the basename
335 of the program being executed if neither -title (-T) nor -n are
336 given on the command line. If this option is used, it must be the
337 last on the command-line. If there is no -e option then the default
338 is to run the program specified by the SHELL environment variable
339 or, failing that, sh(1).
340 Please note that you must specify a program with arguments. If you
342 want to run shell commands, you have to specify the shell, like
343 this:
344 urxvt -e sh -c "shell commands"
346 -title text
348 Window title (-T still respected); the default title is the
349 basename of the program specified after the -e option, if any,
350 otherwise the application name; resource title.
351 -n text
353 Icon name; the default name is the basename of the program
354 specified after the -e option, if any, otherwise the application
355 name; resource iconName.
356 -C Capture system console messages.
358 -pt style
360 Compile XIM: input style for input method; OverTheSpot, OffTheSpot,
361 Root; resource preeditType.
362 -im text
364 Compile XIM: input method name. resource inputMethod.
365 -imlocale string
367 The locale to use for opening the IM. You can use an "LC_CTYPE" of
368 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP"
369 for the input extension to be able to input japanese characters
370 while staying in another locale. resource imLocale.
371 -imfont fontset
373 Set the font set to use for the X Input Method, see resource imFont
374 for more info.
375 -tcw
377 Change the meaning of triple-click selection with the left mouse
378 button. Only effective when the original (non-perl) selection code
379 is in-use. Instead of selecting a full line it will extend the
380 selection to the end of the logical line only. resource
381 tripleclickwords.
382 -insecure
384 Enable "insecure" mode, which currently enables most of the escape
385 sequences that echo strings. See the resource insecure for more
386 info.
387 -mod modifier
389 Override detection of Meta modifier with specified key: alt, meta,
390 hyper, super, mod1, mod2, mod3, mod4, mod5; resource modifier.
391 -ssc|+ssc
393 Turn on/off secondary screen (default enabled); resource
394 secondaryScreen.
395 -ssr|+ssr
397 Turn on/off secondary screen scroll (default enabled); resource
398 secondaryScroll.
399 -hold|+hold
401 Turn on/off hold window after exit support. If enabled, urxvt will
402 not immediately destroy its window when the program executed within
403 it exits. Instead, it will wait till it is being killed or closed
404 by the user; resource hold.
405 -cd path
407 Sets the working directory for the shell (or the command specified
408 via -e). The path must be an absolute path and it must exist for
409 urxvt to start; resource chdir.
410 -xrm string
412 Works like the X Toolkit option of the same name, by adding the
413 string as if it were specified in a resource file. Resource values
414 specified this way take precedence over all other resource
415 specifications.
416 Note that you need to use the same syntax as in the .Xdefaults
418 file, e.g. "*.background: black". Also note that all urxvt-specific
419 options can be specified as long-options on the commandline, so use
420 of -xrm is mostly limited to cases where you want to specify other
421 resources (e.g. for input methods) or for compatibility with other
422 programs.
423 -keysym.sym string
425 Remap a key symbol. See resource keysym.
426 -embed windowid
428 Tells urxvt to embed its windows into an already-existing window,
429 which enables applications to easily embed a terminal.
430 Right now, urxvt will first unmap/map the specified window, so it
432 shouldn't be a top-level window. urxvt will also reconfigure it
433 quite a bit, so don't expect it to keep some specific state. It's
434 best to create an extra subwindow for urxvt and leave it alone.
435 The window will not be destroyed when urxvt exits.
437 It might be useful to know that urxvt will not close file
439 descriptors passed to it (except for stdin/out/err, of course), so
440 you can use file descriptors to communicate with the programs
441 within the terminal. This works regardless of whether the "-embed"
442 option was used or not.
443 Here is a short Gtk2-perl snippet that illustrates how this option
445 can be used (a longer example is in doc/embed):
446 my $rxvt = new Gtk2::Socket;
448 $rxvt->signal_connect_after (realize => sub {
449 my $xid = $_[0]->window->get_xid;
450 system "urxvt -embed $xid &";
451 });
452 -pty-fd file descriptor
454 Tells urxvt NOT to execute any commands or create a new pty/tty
455 pair but instead use the given file descriptor as the tty master.
456 This is useful if you want to drive urxvt as a generic terminal
457 emulator without having to run a program within it.
458 If this switch is given, urxvt will not create any utmp/wtmp
460 entries and will not tinker with pty/tty permissions - you have to
461 do that yourself if you want that.
462 As an extremely special case, specifying "-1" will completely
464 suppress pty/tty operations, which is probably only useful in
465 conjunction with some perl extension that manages the terminal.
466 Here is a example in perl that illustrates how this option can be
468 used (a longer example is in doc/pty-fd):
469 use IO::Pty;
471 use Fcntl;
472 my $pty = new IO::Pty;
474 fcntl $pty, F_SETFD, 0; # clear close-on-exec
475 system "urxvt -pty-fd " . (fileno $pty) . "&";
476 close $pty;
477 # now communicate with rxvt
479 my $slave = $pty->slave;
480 while (<$slave>) { print $slave "got <$_>\n" }
481 -pe string
483 Comma-separated list of perl extension scripts to use (or not to
484 use) in this terminal instance. See resource perl-ext for details.
485
487 Note: `urxvt --help' gives a list of all resources (long options)
488 compiled into your version. All resources are also available as long-
489 options.
490 You can set and change the resources using X11 tools like xrdb. Many
492 distribution do also load settings from the ~/.Xresources file when X
493 starts. urxvt will consult the following files/resources in order, with
494 later settings overwriting earlier ones:
495 1. app-defaults file in $XAPPLRESDIR
497 2. $HOME/.Xdefaults
498 3. RESOURCE_MANAGER property on root-window of screen 0
499 4. SCREEN_RESOURCES property on root-window of the current screen
500 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
501 6. resources specified via -xrm on the commandline
502 Note that when reading X resources, urxvt recognizes two class names:
504 Rxvt and URxvt. The class name Rxvt allows resources common to both
505 urxvt and the original rxvt to be easily configured, while the class
506 name URxvt allows resources unique to urxvt, to be shared between
507 different urxvt configurations. If no resources are specified, suitable
508 defaults will be used. Command-line arguments can be used to override
509 resource settings. The following resources are supported (you might
510 want to check the urxvtperl(3) manpage for additional settings by perl
511 extensions not documented here):
512 depth: bitdepth
514 Compile xft: Attempt to find a visual with the given bit depth;
515 option -depth.
516 buffered: boolean
518 Compile xft: Turn on/off double-buffering for xft (default
519 enabled). On some card/driver combination enabling it slightly
520 decreases performance, on most it greatly helps it. The slowdown is
521 small, so it should normally be enabled.
522 geometry: geom
524 Create the window with the specified X window geometry [default
525 80x24]; option -geometry.
526 background: colour
528 Use the specified colour as the window's background colour [default
529 White]; option -bg.
530 foreground: colour
532 Use the specified colour as the window's foreground colour [default
533 Black]; option -fg.
534 colorn: colour
536 Use the specified colour for the colour value n, where 0-7
537 corresponds to low-intensity (normal) colours and 8-15 corresponds
538 to high-intensity (bold = bright foreground, blink = bright
539 background) colours. The canonical names are as follows: 0=black,
540 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but
541 the actual colour names used are listed in the COLOURS AND GRAPHICS
542 section.
543 Colours higher than 15 cannot be set using resources (yet), but can
545 be changed using an escape command (see urxvt(7)).
546 Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm
548 with 88 colour support). Colours 80-87 are evenly spaces grey
549 steps.
550 colorBD: colour
552 colorIT: colour
553 Use the specified colour to display bold or italic characters when
554 the foreground colour is the default. If font styles are not
555 available (Compile styles) and this option is unset, reverse video
556 is used instead.
557 colorUL: colour
559 Use the specified colour to display underlined characters when the
560 foreground colour is the default.
561 underlineColor: colour
563 If set, use the specified colour as the colour for the underline
564 itself. If unset, use the foreground colour.
565 highlightColor: colour
567 If set, use the specified colour as the background for highlighted
568 characters. If unset, use reverse video.
569 highlightTextColor: colour
571 If set and highlightColor is set, use the specified colour as the
572 foreground for highlighted characters.
573 cursorColor: colour
575 Use the specified colour for the cursor. The default is to use the
576 foreground colour; option -cr.
577 cursorColor2: colour
579 Use the specified colour for the colour of the cursor text. For
580 this to take effect, cursorColor must also be specified. The
581 default is to use the background colour.
582 reverseVideo: boolean
584 True: simulate reverse video by foreground and background colours;
585 option -rv. False: regular screen colours [default]; option +rv.
586 See note in COLOURS AND GRAPHICS section.
587 jumpScroll: boolean
589 True: specify that jump scrolling should be used. When receiving
590 lots of lines, urxvt will only scroll once a whole screen height of
591 lines has been read, resulting in fewer updates while still
592 displaying every received line; option -j.
593 False: specify that smooth scrolling should be used. urxvt will
595 force a screen refresh on each new line it received; option +j.
596 skipScroll: boolean
598 True: (the default) specify that skip scrolling should be used.
599 When receiving lots of lines, urxvt will only scroll once in a
600 while (around 60 times per second), resulting in far fewer updates.
601 This can result in urxvt not ever displaying some of the lines it
602 receives; option -ss.
603 False: specify that everything is to be displayed, even if the
605 refresh is too fast for the human eye to read anything (or the
606 monitor to display anything); option +ss.
607 transparent: boolean
609 Turn on/off pseudo-transparency by using the root pixmap as
610 background.
611 inheritPixmap is still accepted as an obsolete alias but will be
613 removed in future versions.
614 fading: number
616 Fade the text by the given percentage when focus is lost; option
617 -fade.
618 fadeColor: colour
620 Fade to this colour, when fading is used (see fading:). The default
621 colour is black; option -fadecolor.
622 tintColor: colour
624 Tint the transparent background with the given colour. If the
625 RENDER extension is not available only black, red, green, yellow,
626 blue, magenta, cyan and white tints can be performed server-side.
627 Note that a black tint yields a completely black image while a
628 white tint yields the image unchanged; option -tint.
629 shading: number
631 Darken (0 .. 99) or lighten (101 .. 200) the transparent
632 background. A value of 100 means no shading; option -sh.
633 blendType: string
635 Specify background blending type; option -blt.
636 blurRadius: number
638 Apply gaussian blur with the specified radius to the transparent
639 background; option -blr.
640 iconFile: file
642 Set the application icon pixmap; option -icon.
643 scrollColor: colour
645 Use the specified colour for the scrollbar [default #B2B2B2].
646 troughColor: colour
648 Use the specified colour for the scrollbar's trough area [default
649 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
650 borderColor: colour
652 The colour of the border around the text area and between the
653 scrollbar and the text.
654 backgroundPixmap: file[;geom[:op1][:op2][...]]
656 Use the specified image file for the background and also optionally
657 specify its scaling with a geometry string WxH+X+Y, (default
658 "100x100+50+50") in which "W" / "H" specify the horizontal/vertical
659 scale (percent), and "X" / "Y" locate the image centre (percent).
660 A scale of 0 displays the image with tiling. The maximum permitted
661 scale is 1000. Additional operations can be specified after colon
662 :op1:op2.... Supported operations are:
663 tile force background image to be tiled and not scaled. Equivalent to 0x0
665 propscale will scale image keeping proportions
666 auto will scale image to match window size. Equivalent to 100x100
667 hscale will scale image horizontally to the window size
668 vscale will scale image vertically to the window size
669 scale will scale image to match window size
670 root will tile image as if it was a root window background, auto-adjusting
671 whenever terminal window moves
672 If used in conjunction with -tr option, the specified pixmap will
674 be blended over the transparent background using alpha-blending. If
675 afterimage support has been compiled in it is possible to choose
676 other blending types with -blt "type" option.
677 path: path
679 Specify the colon-delimited search path for finding background
680 image files.
681 font: fontlist
683 Select the fonts to be used. This is a comma separated list of font
684 names that are checked in order when trying to find glyphs for
685 characters. The first font defines the cell size for characters;
686 other fonts might be smaller, but not (in general) larger. A
687 (hopefully) reasonable default font list is always appended to it;
688 option -fn.
689 Each font can either be a standard X11 core font (XLFD) name, with
691 optional prefix "x:" or a Xft font (Compile xft), prefixed with
692 "xft:".
693 In addition, each font can be prefixed with additional hints and
695 specifications enclosed in square brackets ("[]"). The only
696 available hint currently is "codeset=codeset-name", and this is
697 only used for Xft fonts.
698 For example, this font resource
700 URxvt.font: 9x15bold,\
702 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
703 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
704 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
705 xft:Code2000:antialias=false
706 specifies five fonts to be used. The first one is "9x15bold"
708 (actually the iso8859-1 version of the second font), which is the
709 base font (because it is named first) and thus defines the
710 character cell grid to be 9 pixels wide and 15 pixels high.
711 The second font is just used to add additional unicode characters
713 not in the base font, likewise the third, which is unfortunately
714 non-bold, but the bold version of the font does contain fewer
715 characters, so this is a useful supplement.
716 The third font is an Xft font with aliasing turned off, and the
718 characters are limited to the JIS 0208 codeset (i.e. japanese
719 kanji). The font contains other characters, but we are not
720 interested in them.
721 The last font is a useful catch-all font that supplies most of the
723 remaining unicode characters.
724 boldFont: fontlist
726 italicFont: fontlist
727 boldItalicFont: fontlist
728 The font list to use for displaying bold, italic or bold italic
729 characters, respectively.
730 If specified and non-empty, then the syntax is the same as for the
732 font-resource, and the given font list will be used as is, which
733 makes it possible to substitute completely different font styles
734 for bold and italic.
735 If unset (the default), a suitable font list will be synthesized by
737 "morphing" the normal text font list into the desired shape. If
738 that is not possible, replacement fonts of the desired shape will
739 be tried.
740 If set, but empty, then this specific style is disabled and the
742 normal text font will being used for the given style.
743 intensityStyles: boolean
745 When font styles are not enabled, or this option is enabled (True,
746 option -is, the default), bold/blink font styles imply high
747 intensity foreground/background colours. Disabling this option
748 (False, option +is) disables this behaviour, the high intensity
749 colours are not reachable.
750 title: string
752 Set window title string, the default title is the command-line
753 specified after the -e option, if any, otherwise the application
754 name; option -title.
755 iconName: string
757 Set the name used to label the window's icon or displayed in an
758 icon manager window, it also sets the window's title unless it is
759 explicitly set; option -n.
760 mapAlert: boolean
762 True: de-iconify (map) on receipt of a bell character. False: no
763 de-iconify (map) on receipt of a bell character [default].
764 urgentOnBell: boolean
766 True: set the urgency hint for the wm on receipt of a bell
767 character. False: do not set the urgency hint [default].
768 urxvt resets the urgency hint on every focus change.
770 visualBell: boolean
772 True: use visual bell on receipt of a bell character; option -vb.
773 False: no visual bell [default]; option +vb.
774 loginShell: boolean
776 True: start as a login shell by prepending a `-' to argv[0] of the
777 shell; option -ls. False: start as a normal sub-shell [default];
778 option +ls.
779 utmpInhibit: boolean
781 True: inhibit writing record into the system log file utmp; option
782 -ut. False: write record into the system log file utmp [default];
783 option +ut.
784 print-pipe: string
786 Specify a command pipe for vt100 printer [default lpr(1)]. Use
787 Print to initiate a screen dump to the printer and Ctrl-Print or
788 Shift-Print to include the scrollback as well.
789 The string will be interpreted as if typed into the shell as-is.
791 Example:
793 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
795 This creates a new file in your home directory with the screen
797 contents every time you hit "Print".
798 scrollstyle: mode
800 Set scrollbar style to rxvt, plain, next or xterm. plain is the
801 author's favourite.
802 thickness: number
804 Set the scrollbar width in pixels.
805 scrollBar: boolean
807 True: enable the scrollbar [default]; option -sb. False: disable
808 the scrollbar; option +sb.
809 scrollBar_right: boolean
811 True: place the scrollbar on the right of the window; option -sr.
812 False: place the scrollbar on the left of the window; option +sr.
813 scrollBar_floating: boolean
815 True: display an rxvt scrollbar without a trough; option -st.
816 False: display an rxvt scrollbar with a trough; option +st.
817 scrollBar_align: mode
819 Align the top, bottom or centre [default] of the scrollbar thumb
820 with the pointer on middle button press/drag.
821 scrollTtyOutput: boolean
823 True: scroll to bottom when tty receives output; option -si.
824 False: do not scroll to bottom when tty receives output; option
825 +si.
826 scrollWithBuffer: boolean
828 True: scroll with scrollback buffer when tty receives new lines
829 (i.e. try to show the same lines) and scrollTtyOutput is False;
830 option -sw. False: do not scroll with scrollback buffer when tty
831 receives new lines; option +sw.
832 scrollTtyKeypress: boolean
834 True: scroll to bottom when a non-special key is pressed. Special
835 keys are those which are intercepted by rxvt-unicode for special
836 handling and are not passed onto the shell; option -sk. False: do
837 not scroll to bottom when a non-special key is pressed; option +sk.
838 saveLines: number
840 Save number lines in the scrollback buffer [default 64]. This
841 resource is limited on most machines to 65535; option -sl.
842 internalBorder: number
844 Internal border of number pixels. This resource is limited to 100;
845 option -b.
846 externalBorder: number
848 External border of number pixels. This resource is limited to 100;
849 option -w, -bw, -borderwidth.
850 borderLess: boolean
852 Set MWM hints to request a borderless window, i.e. if honoured by
853 the WM, the rxvt-unicode window will not have window decorations;
854 option -bl.
855 skipBuiltinGlyphs: boolean
857 Compile frills: Disable the usage of the built-in block
858 graphics/line drawing characters and just rely on what the
859 specified fonts provide. Use this if you have a good font and want
860 to use its block graphic glyphs; option -sbg.
861 termName: termname
863 Specifies the terminal type name to be set in the TERM environment
864 variable; option -tn.
865 lineSpace: number
867 Specifies number of lines (pixel height) to insert between each row
868 of the display [default 0]; option -lsp.
869 meta8: boolean
871 True: handle Meta (Alt) + keypress to set the 8th bit. False:
872 handle Meta (Alt) + keypress as an escape prefix [default].
873 mouseWheelScrollPage: boolean
875 True: the mouse wheel scrolls a page full. False: the mouse wheel
876 scrolls five lines [default].
877 pastableTabs: boolean
879 True: store tabs as wide characters. False: interpret tabs as
880 cursor movement only; option "-ptab".
881 cursorBlink: boolean
883 True: blink the cursor. False: do not blink the cursor [default];
884 option -bc.
885 cursorUnderline: boolean
887 True: Make the cursor underlined. False: Make the cursor a box
888 [default]; option -uc.
889 pointerBlank: boolean
891 True: blank the pointer when a key is pressed or after a set number
892 of seconds of inactivity. False: the pointer is always visible
893 [default].
894 pointerColor: colour
896 Mouse pointer foreground colour.
897 pointerColor2: colour
899 Mouse pointer background colour.
900 pointerBlankDelay: number
902 Specifies number of seconds before blanking the pointer [default
903 2]. Use a large number (e.g. 987654321) to effectively disable the
904 timeout.
905 backspacekey: string
907 The string to send when the backspace key is pressed. If set to DEC
908 or unset it will send Delete (code 127) or, with control, Backspace
909 (code 8) - which can be reversed with the appropriate DEC private
910 mode escape sequence.
911 deletekey: string
913 The string to send when the delete key (not the keypad delete key)
914 is pressed. If unset it will send the sequence traditionally
915 associated with the Execute key.
916 cutchars: string
918 The characters used as delimiters for double-click word selection
919 (whitespace delimiting is added automatically if resource is
920 given).
921 When the perl selection extension is in use (the default if
923 compiled in, see the urxvtperl(3) manpage), a suitable regex using
924 these characters will be created (if the resource exists,
925 otherwise, no regex will be created). In this mode, characters
926 outside ISO-8859-1 can be used.
927 When the selection extension is not used, only ISO-8859-1
929 characters can be used. If not specified, the built-in default is
930 used:
931 BACKSLASH `"'&()*,;<=>?@[]^{|}
933 preeditType: style
935 OverTheSpot, OffTheSpot, Root; option -pt.
936 inputMethod: name
938 name of inputMethod to use; option -im.
939 imLocale: name
941 The locale to use for opening the IM. You can use an "LC_CTYPE" of
942 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP"
943 for the input extension to be able to input japanese characters
944 while staying in another locale; option -imlocale.
945 imFont: fontset
947 Specify the font-set used for XIM styles "OverTheSpot" or
948 "OffTheSpot". It must be a standard X font set (XLFD patterns
949 separated by commas), i.e. it's not in the same format as the other
950 font lists used in urxvt. The default will be set-up to chose *any*
951 suitable found found, preferably one or two pixels differing in
952 size to the base font. option -imfont.
953 tripleclickwords: boolean
955 Change the meaning of triple-click selection with the left mouse
956 button. Instead of selecting a full line it will extend the
957 selection to the end of the logical line only; option -tcw.
958 insecure: boolean
960 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
961 that echo arbitrary strings like the icon name or the locale. This
962 could be abused if somebody gets 8-bit-clean access to your
963 display, whether through a mail client displaying mail bodies
964 unfiltered or through write(1) or any other means. Therefore, these
965 sequences are disabled by default. (Note that many other terminals,
966 including xterm, have these sequences enabled by default, which
967 doesn't make it safer, though).
968 You can enable them by setting this boolean resource or specifying
970 -insecure as an option. At the moment, this enables display-answer,
971 locale, findfont, icon label and window title requests.
972 modifier: modifier
974 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
975 super, mod1, mod2, mod3, mod4, mod5; option -mod.
976 answerbackString: string
978 Specify the reply rxvt-unicode sends to the shell when an ENQ
979 (control-E) character is passed through. It may contain escape
980 values as described in the entry on keysym following.
981 secondaryScreen: boolean
983 Turn on/off secondary screen (default enabled).
984 secondaryScroll: boolean
986 Turn on/off secondary screen scroll (default enabled). If this
987 option is enabled, scrolls on the secondary screen will change the
988 scrollback buffer and, when secondaryScreen is off, switching
989 to/from the secondary screen will instead scroll the screen up.
990 hold: boolean
992 Turn on/off hold window after exit support. If enabled, urxvt will
993 not immediately destroy its window when the program executed within
994 it exits. Instead, it will wait till it is being killed or closed
995 by the user.
996 chdir: path
998 Sets the working directory for the shell (or the command specified
999 via -e). The path must be an absolute path and it must exist for
1000 urxvt to start. If it isn't specified then the current working
1001 directory will be used; option -cd.
1002 keysym.sym: string
1004 Compile frills: Associate string with keysym sym. The intervening
1005 resource name keysym. cannot be omitted.
1006 The format of sym is "(modifiers-)key", where modifiers can be any
1008 combination of ISOLevel3, AppKeypad, Control, NumLock, Shift, Meta,
1009 Lock, Mod1, Mod2, Mod3, Mod4, Mod5, and the abbreviated I, K, C, N,
1010 S, M, A, L, 1, 2, 3, 4, 5.
1011 The NumLock, Meta and ISOLevel3 modifiers are usually aliased to
1013 whatever modifier the NumLock key, Meta/Alt keys or ISO Level3
1014 Shift/AltGr keys are being mapped. AppKeypad is a synthetic
1015 modifier mapped to the current application keymap mode state.
1016 The spellings of key can be obtained by using xev(1) command or
1018 searching keysym macros from /usr/X11R6/include/X11/keysymdef.h and
1019 omitting the prefix XK_. Alternatively you can specify key by its
1020 hex keysym value (0x0000 - 0xFFFF). Note that the lookup of syms is
1021 not performed in an exact manner; however, the closest match is
1022 assured.
1023 string may contain escape values ("\n": newline, "\000": octal
1025 number), see RESOURCES in "man 7 X" for further details.
1026 You can define a range of keysyms in one shot by providing a string
1028 with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter `/'
1029 should be a character not used by the strings.
1030 Its usage can be demonstrated by an example:
1032 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1034 The above line is equivalent to the following three lines:
1036 URxvt.keysym.Meta-Control-0x61: \033<a>
1038 URxvt.keysym.Meta-Control-0x62: \033<b>
1039 URxvt.keysym.Meta-Control-0x63: \033<c>
1040 If string takes the form of "command:STRING", the specified STRING
1042 is interpreted and executed as urxvt's control sequence. For
1043 example the following means "change the current locale to
1044 "zh_CN.GBK" when Control-Meta-c is being pressed":
1045 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1047 If string takes the form "perl:STRING", then the specified STRING
1049 is passed to the "on_user_command" perl handler. See the
1050 urxvtperl(3) manpage. For example, the selection extension
1051 (activated via "urxvt -pe selection") listens for "selection:rot13"
1052 events:
1053 URxvt.keysym.M-C-c: perl:selection:rot13
1055 Due the the large number of modifier combinations, a defined key
1057 mapping will match if at least the specified identifiers are being
1058 set, and no other key mappings with those and more bits are being
1059 defined. That means that defining a key map for "a" will
1060 automatically provide definitions for "Meta-a", "Shift-a" and so
1061 on, unless some of those are defined mappings themselves.
1062 Unfortunately, this will override built-in key mappings. For
1064 example if you overwrite the "Insert" key you will disable urxvt's
1065 "Shift-Insert" mapping. To re-enable that, you can poke "holes"
1066 into the user-defined keymap using the "builtin:" replacement:
1067 URxvt.keysym.Insert: <my insert key sequence>
1069 URxvt.keysym.S-Insert: builtin:
1070 The first line defines a mapping for "Insert" and any combination
1072 of modifiers. The second line re-establishes the default mapping
1073 for "Shift-Insert".
1074 The following example will map Control-Meta-1 and Control-Meta-2 to
1076 the fonts "suxuseuro" and "9x15bold", so you can have some limited
1077 font-switching at runtime:
1078 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1080 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1081 Other things are possible, e.g. resizing (see urxvt(7) for more
1083 info):
1084 URxvt.keysym.M-C-3: command:\033[8;25;80t
1086 URxvt.keysym.M-C-4: command:\033[8;48;110t
1087 perl-ext-common: string
1089 perl-ext: string
1090 Comma-separated list(s) of perl extension scripts (default:
1091 "default") to use in this terminal instance; option -pe.
1092 Extension names can be prefixed with a "-" sign to prohibit using
1094 them. This can be useful to selectively disable some extensions
1095 loaded by default, or specified via the "perl-ext-common" resource.
1096 For example, "default,-selection" will use all the default
1097 extension except "selection".
1098 Extension names can also be followed by an argument in angle
1100 brackets (e.g. "searchable-scrollback<M-s>", which binds the
1101 hotkey for searchable scrollback to Alt/Meta-s). Mentioning the
1102 same extension multiple times with different arguments will pass
1103 multiple arguments to the extension.
1104 Each extension is looked up in the library directories, loaded if
1106 necessary, and bound to the current terminal instance.
1107 If both of these resources are the empty string, then the perl
1109 interpreter will not be initialized. The idea behind two options is
1110 that perl-ext-common will be used for extensions that should be
1111 available to all instances, while perl-ext is used for specific
1112 instances.
1113 perl-eval: string
1115 Perl code to be evaluated when all extensions have been registered.
1116 See the urxvtperl(3) manpage.
1117 perl-lib: path
1119 Colon-separated list of additional directories that hold extension
1120 scripts. When looking for extensions specified by the "perl"
1121 resource, urxvt will first look in these directories and then in
1122 /usr/lib64/urxvt/perl/.
1123 See the urxvtperl(3) manpage.
1125 selection.pattern-idx: perl-regex
1127 Additional selection patterns, see the urxvtperl(3) manpage for
1128 details.
1129 selection-autotransform.idx: perl-transform
1131 Selection auto-transform patterns, see the urxvtperl(3) manpage for
1132 details.
1133 searchable-scrollback: keysym
1135 Sets the hotkey that starts the incremental scrollback buffer
1136 search (default: "M-s").
1137 urlLauncher: string
1139 Specifies the program to be started with a URL argument. Used by
1140 the "selection-popup" and "matcher" perl extensions.
1141 transient-for: windowid
1143 Compile frills: Sets the WM_TRANSIENT_FOR property to the given
1144 window id.
1145 override-redirect: boolean
1147 Compile frills: Sets override-redirect for the terminal window,
1148 making it almost invisible to window managers; option
1149 -override-redirect.
1150 iso14755: boolean
1152 Turn on/off ISO 14755 (default enabled).
1153 iso14755_52: boolean
1155 Turn on/off ISO 14755 5.2 mode (default enabled).
1156
1158 Lines of text that scroll off the top of the urxvt window (resource:
1159 saveLines) and can be scrolled back using the scrollbar or by
1160 keystrokes. The normal urxvt scrollbar has arrows and its behaviour is
1161 fairly intuitive. The xterm-scrollbar is without arrows and its
1162 behaviour mimics that of xterm
1163 Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up
1165 with Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with
1166 Button2.
1167
1169 To temporarily override mouse reporting, for either the scrollbar or
1170 the normal text selection/insertion, hold either the Shift or the Meta
1171 (Alt) key while performing the desired mouse action.
1172 If mouse reporting mode is active, the normal scrollbar actions are
1174 disabled -- on the assumption that we are using a fullscreen
1175 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
1176 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
1177 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
1178
1180 The behaviour of text selection and insertion/pasting mechanism is
1181 similar to xterm(1).
1182 Selecting:
1184 Left click at the beginning of the region, drag to the end of the
1185 region and release; Right click to extend the marked region; Left
1186 double-click to select a word; Left triple-click to select the
1187 entire logical line (which can span multiple screen lines), unless
1188 modified by resource tripleclickwords.
1189 Starting a selection while pressing the Meta key (or Meta+Ctrl
1191 keys) (Compile: frills) will create a rectangular selection instead
1192 of a normal one. In this mode, every selected row becomes its own
1193 line in the selection, and trailing whitespace is visually
1194 underlined and removed from the selection.
1195 Pasting:
1197 Pressing and releasing the Middle mouse button in an urxvt window
1198 causes the value of the PRIMARY selection (or CLIPBOARD with the
1199 Meta modifier) to be inserted as if it had been typed on the
1200 keyboard.
1201 Pressing Shift-Insert causes the value of the PRIMARY selection to
1203 be inserted too.
1204
1206 Changing fonts (or font sizes, respectively) via the keypad is not yet
1207 supported in rxvt-unicode. Bug me if you need this.
1208 You can, however, switch fonts at runtime using escape sequences, e.g.:
1210 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1212 You can use keyboard shortcuts, too:
1214 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1216 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1217 rxvt-unicode will automatically re-apply these fonts to the output so
1219 far.
1220
1222 ISO 14755 is a standard for entering and viewing unicode characters and
1223 character codes using the keyboard. It consists of 4 parts. The first
1224 part is available if rxvt-unicode has been compiled with
1225 "--enable-frills", the rest is available when rxvt-unicode was compiled
1226 with "--enable-iso14755".
1227 · 5.1: Basic method
1229 This allows you to enter unicode characters using their hexcode.
1231 Start by pressing and holding both "Control" and "Shift", then
1233 enter hex-digits (between one and six). Releasing "Control" and
1234 "Shift" will commit the character as if it were typed directly.
1235 While holding down "Control" and "Shift" you can also enter
1236 multiple characters by pressing "Space", which will commit the
1237 current character and lets you start a new one.
1238 As an example of use, imagine a business card with a japanese
1240 e-mail address, which you cannot type. Fortunately, the card has
1241 the e-mail address printed as hexcodes, e.g. "671d 65e5". You can
1242 enter this easily by pressing "Control" and "Shift", followed by
1243 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys.
1244 · 5.2: Keyboard symbols entry method
1246 This mode lets you input characters representing the keycap symbols
1248 of your keyboard, if representable in the current locale encoding.
1249 Start by pressing "Control" and "Shift" together, then releasing
1251 them. The next special key (cursor keys, home etc.) you enter will
1252 not invoke its usual function but instead will insert the
1253 corresponding keycap symbol. The symbol will only be entered when
1254 the key has been released, otherwise pressing e.g. "Shift" would
1255 enter the symbol for "ISO Level 2 Switch", although your intention
1256 might have been to enter a reverse tab (Shift-Tab).
1257 · 5.3: Screen-selection entry method
1259 While this is implemented already (it's basically the selection
1261 mechanism), it could be extended by displaying a unicode character
1262 map.
1263 · 5.4: Feedback method for identifying displayed characters for later
1265 input
1266 This method lets you display the unicode character code associated
1268 with characters already displayed.
1269 You enter this mode by holding down "Control" and "Shift" together,
1271 then pressing and holding the left mouse button and moving around.
1272 The unicode hex code(s) (it might be a combining character) of the
1273 character under the pointer is displayed until you release
1274 "Control" and "Shift".
1275 In addition to the hex codes it will display the font used to draw
1277 this character - due to implementation reasons, characters combined
1278 with combining characters, line drawing characters and unknown
1279 characters will always be drawn using the built-in support font.
1280 With respect to conformance, rxvt-unicode is supposed to be compliant
1282 to both scenario A and B of ISO 14755, including part 5.2.
1283
1285 urxvt tries to write an entry into the utmp(5) file so that it can be
1286 seen via the who(1) command, and can accept messages. To allow this
1287 feature, urxvt may need to be installed setuid root on some systems or
1288 setgid to root or to some other group on others.
1289
1291 In addition to the default foreground and background colours, urxvt can
1292 display up to 88/256 colours: 8 ANSI colours plus high-intensity
1293 (potentially bold/blink) versions of the same, and 72 (or 240 in 256
1294 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB cube
1295 plus a 8 (24) colour greyscale ramp.
1296 Here is a list of the ANSI colours with their names.
1298 color0 (black) = Black
1300 color1 (red) = Red3
1301 color2 (green) = Green3
1302 color3 (yellow) = Yellow3
1303 color4 (blue) = Blue3
1304 color5 (magenta) = Magenta3
1305 color6 (cyan) = Cyan3
1306 color7 (white) = AntiqueWhite
1307 color8 (bright black) = Grey25
1308 color9 (bright red) = Red
1309 color10 (bright green) = Green
1310 color11 (bright yellow) = Yellow
1311 color12 (bright blue) = Blue
1312 color13 (bright magenta) = Magenta
1313 color14 (bright cyan) = Cyan
1314 color15 (bright white) = White
1315 foreground = Black
1316 background = White
1317 It is also possible to specify the colour values of foreground,
1319 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1320 0-15, as a convenient shorthand to reference the colour name of
1321 color0-color15.
1322 The following text gives values for the standard 88 colour mode (and
1324 values for the 256 colour mode in parentheses).
1325 The RGB cube uses indices 16..79 (16..231) using the following
1327 formulas:
1328 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1330 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1331 The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in
1333 10% steps (1/26 to 25/26 in 1/26 steps) - black and white are already
1334 part of the RGB cube.
1335 Together, all those colours implement the 88 (256) colour xterm
1337 colours. Only the first 16 can be changed using resources currently,
1338 the rest can only be changed via command sequences ("escape codes").
1339 Applications are advised to use terminfo or command sequences to
1341 discover number and RGB values of all colours (yes, you can query
1342 this...).
1343 Note that -rv ("reverseVideo: True") simulates reverse video by always
1345 swapping the foreground/background colours. This is in contrast to
1346 xterm(1) where the colours are only swapped if they have not otherwise
1347 been specified. For example,
1348 urxvt -fg Black -bg White -rv
1350 would yield White on Black, while on xterm(1) it would yield Black on
1352 White.
1353 ALPHA CHANNEL SUPPORT
1355 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1356 get their act together, rxvt-unicode will do it's own alpha channel
1357 management:
1358 You can prefix any colour with an opaqueness percentage enclosed in
1360 brackets, i.e. "[percent]", where "percent" is a decimal percentage
1361 (0-100) that specifies the opacity of the colour, where 0 is completely
1362 transparent and 100 is completely opaque. For example, "[50]red" is a
1363 half-transparent red, while "[95]#00ff00" is an almost opaque green.
1364 This is the recommended format to specify transparency values, and
1365 works with all ways to specify a colour.
1366 For complete control, rxvt-unicode also supports
1368 "rgba:rrrr/gggg/bbbb/aaaa" (exactly four hex digits/component) colour
1369 specifications, where the additional "aaaa" component specifies opacity
1370 (alpha) values. The minimum value of 0000 is completely transparent,
1371 while "ffff" is completely opaque). The two example colours from
1372 earlier could also be specified as "rgba:ff00/0000/0000/8000" and
1373 "rgba:0000/ff00/0000/f332".
1374 You probably need to specify "-depth 32", too, to force a visual with
1376 alpha channels, and have the luck that your X-server uses ARGB pixel
1377 layout, as X is far from just supporting ARGB visuals out of the box,
1378 and rxvt-unicode just fudges around.
1379 For example, the following selects an almost completely transparent
1381 black background, and an almost opaque pink foreground:
1382 urxvt -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1384 When not using a background image, then the interpretation of the alpha
1386 channel is up to your compositing manager (most interpret it as
1387 transparency of course).
1388 When using a background pixmap or pseudo-transparency, then the
1390 background colour will always behave as if it were completely
1391 transparent (so the background image shows instead), regardless of how
1392 it was specified, while other colours will either be transparent as
1393 specified (the background image will show through) on servers
1394 supporting the RENDER extension, or fully opaque on servers not
1395 supporting the RENDER EXTENSION.
1396 Please note that due to bugs in Xft, specifying alpha values might
1398 result in garbage being displayed when the X-server does not support
1399 the RENDER extension.
1400
1402 urxvt sets and/or uses the following environment variables:
1403 TERM
1405 Normally set to "rxvt-unicode", unless overwritten at configure
1406 time, via resources or on the command line.
1407 COLORTERM
1409 Either "rxvt", "rxvt-xpm", depending on whether urxvt was compiled
1410 with background image support, and optionally with the added
1411 extension "-mono" to indicate that rxvt-unicode runs on a
1412 monochrome screen.
1413 COLORFGBG
1415 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1416 the colour code used as default foreground/text colour (or the
1417 string "default" to indicate that the default-colour escape
1418 sequence is to be used), "bg" is the colour code used as default
1419 background colour (or the string "default"), and "xpm" is the
1420 string "default" if urxvt was compiled with background image
1421 support. Libraries like "ncurses" and "slang" can (and do) use this
1422 information to optimize screen output.
1423 WINDOWID
1425 Set to the (decimal) X Window ID of the urxvt window (the toplevel
1426 window, which usually has subwindows for the scrollbar, the
1427 terminal window and so on).
1428 TERMINFO
1430 Set to the terminfo directory iff urxvt was configured with
1431 "--with-terminfo=PATH".
1432 DISPLAY
1434 Used by urxvt to connect to the display and set to the correct
1435 display in its child processes if "-display" isn't used to
1436 override. It defaults to ":0" if it doesn't exist.
1437 SHELL
1439 The shell to be used for command execution, defaults to "/bin/sh".
1440 RXVT_SOCKET
1442 The unix domain socket path used by urxvtc(1) and urxvtd(1).
1443 Default $HOME/.rxvt-unicode-<nodename>.
1445 HOME
1447 Used to locate the default directory for the unix domain socket for
1448 daemon communications and to locate various resource files (such as
1449 ".Xdefaults")
1450 XAPPLRESDIR
1452 Directory where application-specific X resource files are located.
1453 XENVIRONMENT
1455 If set and accessible, gives the name of a X resource file to be
1456 loaded by urxvt.
1457
1459 /usr/lib/X11/rgb.txt
1460 Colour names.
1461
1463 urxvt(7), urxvtc(1), urxvtd(1), xterm(1), sh(1), resize(1), X(1),
1464 pty(4), tty(4), utmp(5)
1465
1467 Project Coordinator
1468 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1469 http://software.schmorp.de/pkg/rxvt-unicode.html
1471 <http://software.schmorp.de/pkg/rxvt-unicode.html>
1472
1474 John Bovey
1475 University of Kent, 1992, wrote the original Xvt.
1476 Rob Nation <nation@rocket.sanders.lockheed.com>
1478 very heavily modified Xvt and came up with Rxvt
1479 Angelo Haritsis <ah@doc.ic.ac.uk>
1481 wrote the Greek Keyboard Input (no longer in code)
1482 mj olesen <olesen@me.QueensU.CA>
1484 Wrote the menu system.
1485 Project Coordinator (changes.txt 2.11 to 2.21)
1487 Oezguer Kesim <kesim@math.fu-berlin.de>
1489 Project Coordinator (changes.txt 2.21a to 2.4.5)
1490 Geoff Wing <gcw@pobox.com>
1492 Rewrote screen display and text selection routines.
1493 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1495 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1497 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1498 perl extension, random hacks, numerous bugfixes and extensions.
1499 Project Coordinator (Changes 1.0 -)
1501 Emanuele Giaquinta <e.giaquinta@glauco.it>
1503 pty/utmp code rewrite, image code improvements, many random hacks
1504 and bugfixes.
15059.12 2011-06-29 urxvt(1)