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.30, 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 (the older form -d
93 is still respected. but deprecated). In the absence of this option,
94 the display specified by the DISPLAY environment variable is used.
95 -depth bitdepth
97 Compile frills: 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 -visual visualID
106 Compile frills: Use the given visual (see e.g. "xdpyinfo" for
107 possible visual ids) instead of the default, and also allocate a
108 private colormap. All visual types except for DirectColor are
109 supported.
110 -geometry geom
112 Window geometry (-g still respected); resource geometry.
113 -rv|+rv
115 Turn on/off simulated reverse video; resource reverseVideo.
116 -j|+j
118 Turn on/off jump scrolling (allow multiple lines per refresh);
119 resource jumpScroll.
120 -ss|+ss
122 Turn on/off skip scrolling (allow multiple screens per refresh);
123 resource skipScroll.
124 -fade number
126 Fade the text by the given percentage when focus is lost. Small
127 values fade a little only, 100 completely replaces all colours by
128 the fade colour; resource fading.
129 -fadecolor colour
131 Fade to this colour when fading is used (see -fade). The default
132 colour is opaque black. resource fadeColor.
133 -icon file
135 Compile pixbuf: Use the specified image as application icon. This
136 is used by many window managers, taskbars and pagers to represent
137 the application window; resource iconFile.
138 -bg colour
140 Window background colour; resource background.
141 -fg colour
143 Window foreground colour; resource foreground.
144 -cr colour
146 The cursor colour; resource cursorColor.
147 -pr colour
149 The mouse pointer foreground colour; resource pointerColor.
150 -pr2 colour
152 The mouse pointer background colour; resource pointerColor2.
153 -bd colour
155 The colour of the border around the text area and between the
156 scrollbar and the text; resource borderColor.
157 -fn fontlist
159 Select the fonts to be used. This is a comma separated list of font
160 names that are checked in order when trying to find glyphs for
161 characters. The first font defines the cell size for characters;
162 other fonts might be smaller, but not (in general) larger. A
163 (hopefully) reasonable default font list is always appended to it.
164 See resource font for more details.
165 In short, to specify an X11 core font, just specify its name or
167 prefix it with "x:". To specify an XFT-font, you need to prefix it
168 with "xft:", e.g.:
169 urxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
171 urxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
172 See also the question "How does rxvt-unicode choose fonts?" in the
174 FAQ section of urxvt(7).
175 -fb fontlist
177 Compile font-styles: The bold font list to use when bold characters
178 are to be printed. See resource boldFont for details.
179 -fi fontlist
181 Compile font-styles: The italic font list to use when italic
182 characters are to be printed. See resource italicFont for details.
183 -fbi fontlist
185 Compile font-styles: The bold italic font list to use when bold
186 italic characters are to be printed. See resource boldItalicFont
187 for details.
188 -is|+is
190 Compile font-styles: Bold/Blink font styles imply high intensity
191 foreground/background (default). See resource intensityStyles for
192 details.
193 -name name
195 Specify the application name under which resources are to be
196 obtained, rather than the default executable file name. Name should
197 not contain `.' or `*' characters. Also sets the icon and title
198 name.
199 -ls|+ls
201 Start as a login-shell/sub-shell; resource loginShell.
202 -mc milliseconds
204 Specify the maximum time between multi-click selections.
205 -ut|+ut
207 Compile utmp: Inhibit/enable writing a utmp entry; resource
208 utmpInhibit.
209 -vb|+vb
211 Turn on/off visual bell on receipt of a bell character; resource
212 visualBell.
213 -sb|+sb
215 Turn on/off scrollbar; resource scrollBar.
216 -sr|+sr
218 Put scrollbar on right/left; resource scrollBar_right.
219 -st|+st
221 Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
222 resource scrollBar_floating.
223 -si|+si
225 Turn on/off scroll-to-bottom on TTY output inhibit; resource
226 scrollTtyOutput has opposite effect.
227 -sk|+sk
229 Turn on/off scroll-to-bottom on keypress; resource
230 scrollTtyKeypress.
231 -sw|+sw
233 Turn on/off scrolling with the scrollback buffer as new lines
234 appear. This only takes effect if -si is also given; resource
235 scrollWithBuffer.
236 -ptab|+ptab
238 If enabled (default), "Horizontal Tab" characters are being stored
239 as actual wide characters in the screen buffer, which makes it
240 possible to select and paste them. Since a horizontal tab is a
241 cursor movement and not an actual glyph, this can sometimes be
242 visually annoying as the cursor on a tab character is displayed as
243 a wide cursor; resource pastableTabs.
244 -bc|+bc
246 Blink the cursor; resource cursorBlink.
247 -uc|+uc
249 Make the cursor underlined; resource cursorUnderline.
250 -iconic
252 Start iconified, if the window manager supports that option.
253 Alternative form is -ic.
254 -sl number
256 Save number lines in the scrollback buffer. See resource entry for
257 limits; resource saveLines.
258 -b number
260 Compile frills: Internal border of number pixels. See resource
261 entry for limits; resource internalBorder.
262 -w number
264 Compile frills: External border of number pixels. Also, -bw and
265 -borderwidth. See resource entry for limits; resource
266 externalBorder.
267 -bl Compile frills: Set MWM hints to request a borderless window, i.e.
269 if honoured by the WM, the rxvt-unicode window will not have window
270 decorations; resource borderLess. If the window manager does not
271 support MWM hints (e.g. kwin), enables override-redirect mode.
272 -override-redirect
274 Compile frills: Sets override-redirect on the window; resource
275 override-redirect.
276 -dockapp
278 Sets the initial state of the window to WithdrawnState, which makes
279 window managers that support this extension treat it as a dockapp.
280 -sbg
282 Compile frills: Disable the usage of the built-in block
283 graphics/line drawing characters and just rely on what the
284 specified fonts provide. Use this if you have a good font and want
285 to use its block graphic glyphs; resource skipBuiltinGlyphs.
286 -lsp number
288 Compile frills: Lines (pixel height) to insert between each row of
289 the display. Useful to work around font rendering problems;
290 resource lineSpace.
291 -letsp number
293 Compile frills: Amount to adjust the computed character width by to
294 control overall letter spacing. Negative values will tighten up the
295 letter spacing, positive values will space letters out more. Useful
296 to work around odd font metrics; resource letterSpace.
297 -tn termname
299 This option specifies the name of the terminal type to be set in
300 the TERM environment variable. This terminal type must exist in the
301 termcap(5) database and should have li# and co# entries; resource
302 termName.
303 -e command [arguments]
305 Run the command with its command-line arguments in the urxvt
306 window; also sets the window title and icon name to be the basename
307 of the program being executed if neither -title (-T) nor -n are
308 given on the command line. If this option is used, it must be the
309 last on the command-line. If there is no -e option then the default
310 is to run the program specified by the SHELL environment variable
311 or, failing that, sh(1).
312 Please note that you must specify a program with arguments. If you
314 want to run shell commands, you have to specify the shell, like
315 this:
316 urxvt -e sh -c "shell commands"
318 -title text
320 Window title (-T still respected); the default title is the
321 basename of the program specified after the -e option, if any,
322 otherwise the application name; resource title.
323 -n text
325 Icon name; the default name is the basename of the program
326 specified after the -e option, if any, otherwise the application
327 name; resource iconName.
328 -C Capture system console messages.
330 -pt style
332 Compile XIM: input style for input method; OverTheSpot, OffTheSpot,
333 Root; resource preeditType.
334 If the perl extension "xim-onthespot" is used (which is the
336 default), then additionally the "OnTheSpot" preedit type is
337 available.
338 -im text
340 Compile XIM: input method name. resource inputMethod.
341 -imlocale string
343 The locale to use for opening the IM. You can use an "LC_CTYPE" of
344 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP"
345 for the input extension to be able to input japanese characters
346 while staying in another locale. resource imLocale.
347 -imfont fontset
349 Set the font set to use for the X Input Method, see resource imFont
350 for more info.
351 -tcw
353 Change the meaning of triple-click selection with the left mouse
354 button. Only effective when the original (non-perl) selection code
355 is in-use. Instead of selecting a full line it will extend the
356 selection to the end of the logical line only. resource
357 tripleclickwords.
358 -dpb|+dpb
360 Compile frills: Disable (or enable) emitting bracketed paste mode
361 sequences (default enabled). Bracketed paste mode allows programs
362 to detect when something is pasted. Since more and more programs
363 abuse this, these sequences can be disabled. The command sequences
364 to enable and query paste mode will still work, but the actual
365 bracket sequences will no longer be emitted. You can also toggle
366 this from the ctrl-middle-mouse-button menu; resource
367 disablePasteBrackets.
368 -insecure
370 Enable "insecure" mode, which currently enables most of the escape
371 sequences that echo strings. See the resource insecure for more
372 info.
373 -mod modifier
375 Override detection of Meta modifier with specified key: alt, meta,
376 hyper, super, mod1, mod2, mod3, mod4, mod5; resource modifier.
377 -ssc|+ssc
379 Turn on/off secondary screen (default enabled); resource
380 secondaryScreen.
381 -ssr|+ssr
383 Turn on/off secondary screen scroll (default enabled); resource
384 secondaryScroll.
385 -rm mode
387 Compile frills: Sets long line rewrapping behaviour on window
388 resizes to one of auto (the default), always or never. The latter
389 two modes do the obvious, auto rewraps (acts like always) if
390 scrollback is non-empty, and wings lines (acts like never)
391 otherwise; resource rewrapMode.
392 -hold|+hold
394 Turn on/off hold window after exit support. If enabled, urxvt will
395 not immediately destroy its window when the program executed within
396 it exits. Instead, it will wait till it is being killed or closed
397 by the user; resource hold.
398 -cd path
400 Sets the working directory for the shell (or the command specified
401 via -e). The path must be an absolute path and it must exist for
402 urxvt to start; resource chdir.
403 -xrm string
405 Works like the X Toolkit option of the same name, by adding the
406 string as if it were specified in a resource file. Resource values
407 specified this way take precedence over all other resource
408 specifications.
409 Note that you need to use the same syntax as in the .Xdefaults
411 file, e.g. "*.background: black". Also note that all urxvt-specific
412 options can be specified as long-options on the commandline, so use
413 of -xrm is mostly limited to cases where you want to specify other
414 resources (e.g. for input methods) or for compatibility with other
415 programs.
416 -keysym.sym string
418 Remap a key symbol. See resource keysym.
419 -embed windowid
421 Tells urxvt to embed its windows into an already-existing window,
422 which enables applications to easily embed a terminal.
423 Right now, urxvt will first unmap/map the specified window, so it
425 shouldn't be a top-level window. urxvt will also reconfigure it
426 quite a bit, so don't expect it to keep some specific state. It's
427 best to create an extra subwindow for urxvt and leave it alone.
428 The window will not be destroyed when urxvt exits.
430 It might be useful to know that urxvt will not close file
432 descriptors passed to it (except for stdin/out/err, of course), so
433 you can use file descriptors to communicate with the programs
434 within the terminal. This works regardless of whether the "-embed"
435 option was used or not.
436 Here is a short Gtk2-perl snippet that illustrates how this option
438 can be used (a longer example is in doc/embed):
439 my $rxvt = new Gtk2::Socket;
441 $rxvt->signal_connect_after (realize => sub {
442 my $xid = $_[0]->window->get_xid;
443 system "urxvt -embed $xid &";
444 });
445 -pty-fd file descriptor
447 Tells urxvt NOT to execute any commands or create a new pty/tty
448 pair but instead use the given file descriptor as the tty master.
449 This is useful if you want to drive urxvt as a generic terminal
450 emulator without having to run a program within it.
451 If this switch is given, urxvt will not create any utmp/wtmp
453 entries and will not tinker with pty/tty permissions - you have to
454 do that yourself if you want that.
455 As an extremely special case, specifying "-1" will completely
457 suppress pty/tty operations, which is probably only useful in
458 conjunction with some perl extension that manages the terminal.
459 Here is a example in perl that illustrates how this option can be
461 used (a longer example is in doc/pty-fd):
462 use IO::Pty;
464 use Fcntl;
465 my $pty = new IO::Pty;
467 fcntl $pty, F_SETFD, 0; # clear close-on-exec
468 system "urxvt -pty-fd " . (fileno $pty) . "&";
469 close $pty;
470 # now communicate with rxvt
472 my $slave = $pty->slave;
473 while (<$slave>) { print $slave "got <$_>\n" }
474 Note that, despite what the name might imply, the file descriptor
476 does not need to be a pty, it can be a bi-directional pipe as well
477 (e.g. a unix domain or tcp socket). While tty operations cannot be
478 done in this case, urxvt can still be remote controlled with it:
479 use Socket;
481 use Fcntl;
482 socketpair my $URXVT, my $slave, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC;
484 fcntl $slave, Fcntl::F_SETFD, 0;
485 system "exec urxvt -pty-fd " . (fileno $slave) . " &";
486 close $slave;
487 syswrite $URXVT, "Type a secret password: ";
489 my $secret = do { local $/ = "\r"; <$URXVT> };
490 print "Not so secret anymore: $secret\n";
491 -pe string
493 Comma-separated list of perl extension scripts to use (or not to
494 use) in this terminal instance. See resource perl-ext for details.
495
497 Note: `urxvt --help' gives a list of all resources (long options)
498 compiled into your version. All resources are also available as long-
499 options.
500 You can set and change the resources using X11 tools like xrdb. Many
502 distribution do also load settings from the ~/.Xresources file when X
503 starts. urxvt will consult the following files/resources in order, with
504 later settings overwriting earlier ones:
505 1. app-defaults file in $XAPPLRESDIR
507 2. $HOME/.Xdefaults
508 3. RESOURCE_MANAGER property on root-window of screen 0
509 4. SCREEN_RESOURCES property on root-window of the current screen
510 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
511 6. resources specified via -xrm on the commandline
512 Note that when reading X resources, urxvt recognizes two class names:
514 Rxvt and URxvt. The class name Rxvt allows resources common to both
515 urxvt and the original rxvt to be easily configured, while the class
516 name URxvt allows resources unique to urxvt, to be shared between
517 different urxvt configurations. If no resources are specified, suitable
518 defaults will be used. Command-line arguments can be used to override
519 resource settings. The following resources are supported (you might
520 want to check the urxvtperl(3) manpage for additional settings by perl
521 extensions not documented here):
522 depth: bitdepth
524 Compile xft: Attempt to find a visual with the given bit depth;
525 option -depth.
526 buffered: boolean
528 Compile xft: Turn on/off double-buffering for xft (default
529 enabled). On some card/driver combination enabling it slightly
530 decreases performance, on most it greatly helps it. The slowdown is
531 small, so it should normally be enabled.
532 geometry: geom
534 Create the window with the specified X window geometry [default
535 80x24]; option -geometry.
536 background: colour
538 Use the specified colour as the window's background colour [default
539 White]; option -bg.
540 foreground: colour
542 Use the specified colour as the window's foreground colour [default
543 Black]; option -fg.
544 colorn: colour
546 Use the specified colour for the colour value n, where 0-7
547 corresponds to low-intensity (normal) colours and 8-15 corresponds
548 to high-intensity (bold = bright foreground, blink = bright
549 background) colours. The canonical names are as follows: 0=black,
550 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but
551 the actual colour names used are listed in the COLOURS AND GRAPHICS
552 section.
553 Colours higher than 15 cannot be set using resources (yet), but can
555 be changed using an escape command (see urxvt(7)).
556 Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm
558 with 88 colour support). Colours 80-87 are evenly spaces grey
559 steps.
560 colorBD: colour
562 colorIT: colour
563 Use the specified colour to display bold or italic characters when
564 the foreground colour is the default. If font styles are not
565 available (Compile styles) and this option is unset, reverse video
566 is used instead.
567 colorUL: colour
569 Use the specified colour to display underlined characters when the
570 foreground colour is the default.
571 underlineColor: colour
573 If set, use the specified colour as the colour for the underline
574 itself. If unset, use the foreground colour.
575 highlightColor: colour
577 If set, use the specified colour as the background for highlighted
578 characters. If unset, use reverse video.
579 highlightTextColor: colour
581 If set and highlightColor is set, use the specified colour as the
582 foreground for highlighted characters.
583 cursorColor: colour
585 Use the specified colour for the cursor. The default is to use the
586 foreground colour; option -cr.
587 cursorColor2: colour
589 Use the specified colour for the colour of the cursor text. For
590 this to take effect, cursorColor must also be specified. The
591 default is to use the background colour.
592 reverseVideo: boolean
594 True: simulate reverse video by foreground and background colours;
595 option -rv. False: regular screen colours [default]; option +rv.
596 See note in COLOURS AND GRAPHICS section.
597 jumpScroll: boolean
599 True: specify that jump scrolling should be used. When receiving
600 lots of lines, urxvt will only scroll once a whole screen height of
601 lines has been read, resulting in fewer updates while still
602 displaying every received line; option -j.
603 False: specify that smooth scrolling should be used. urxvt will
605 force a screen refresh on each new line it received; option +j.
606 skipScroll: boolean
608 True: (the default) specify that skip scrolling should be used.
609 When receiving lots of lines, urxvt will only scroll once in a
610 while (around 60 times per second), resulting in far fewer updates.
611 This can result in urxvt not ever displaying some of the lines it
612 receives; option -ss.
613 False: specify that everything is to be displayed, even if the
615 refresh is too fast for the human eye to read anything (or the
616 monitor to display anything); option +ss.
617 fading: number
619 Fade the text by the given percentage when focus is lost; option
620 -fade.
621 fadeColor: colour
623 Fade to this colour, when fading is used (see fading:). The default
624 colour is black; option -fadecolor.
625 iconFile: file
627 Set the application icon pixmap; option -icon.
628 scrollColor: colour
630 Use the specified colour for the scrollbar [default #B2B2B2].
631 troughColor: colour
633 Use the specified colour for the scrollbar's trough area [default
634 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
635 borderColor: colour
637 The colour of the border around the text area and between the
638 scrollbar and the text.
639 font: fontlist
641 Select the fonts to be used. This is a comma separated list of font
642 names that are checked in order when trying to find glyphs for
643 characters. The first font defines the cell size for characters;
644 other fonts might be smaller, but not (in general) larger. A
645 (hopefully) reasonable default font list is always appended to it;
646 option -fn.
647 Each font can either be a standard X11 core font (XLFD) name, with
649 optional prefix "x:" or a Xft font (Compile xft), prefixed with
650 "xft:".
651 In addition, each font can be prefixed with additional hints and
653 specifications enclosed in square brackets ("[]"). The only
654 available hint currently is "codeset=codeset-name", and this is
655 only used for Xft fonts.
656 For example, this font resource
658 URxvt.font: 9x15bold,\
660 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
661 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
662 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
663 xft:Code2000:antialias=false
664 specifies five fonts to be used. The first one is "9x15bold"
666 (actually the iso8859-1 version of the second font), which is the
667 base font (because it is named first) and thus defines the
668 character cell grid to be 9 pixels wide and 15 pixels high.
669 The second font is just used to add additional unicode characters
671 not in the base font, likewise the third, which is unfortunately
672 non-bold, but the bold version of the font does contain fewer
673 characters, so this is a useful supplement.
674 The third font is an Xft font with aliasing turned off, and the
676 characters are limited to the JIS 0208 codeset (i.e. japanese
677 kanji). The font contains other characters, but we are not
678 interested in them.
679 The last font is a useful catch-all font that supplies most of the
681 remaining unicode characters.
682 boldFont: fontlist
684 italicFont: fontlist
685 boldItalicFont: fontlist
686 The font list to use for displaying bold, italic or bold italic
687 characters, respectively.
688 If specified and non-empty, then the syntax is the same as for the
690 font-resource, and the given font list will be used as is, which
691 makes it possible to substitute completely different font styles
692 for bold and italic.
693 If unset (the default), a suitable font list will be synthesized by
695 "morphing" the normal text font list into the desired shape. If
696 that is not possible, replacement fonts of the desired shape will
697 be tried.
698 If set, but empty, then this specific style is disabled and the
700 normal text font will being used for the given style.
701 intensityStyles: boolean
703 When font styles are not enabled, or this option is enabled (True,
704 option -is, the default), bold/blink font styles imply high
705 intensity foreground/background colours. Disabling this option
706 (False, option +is) disables this behaviour, the high intensity
707 colours are not reachable.
708 title: string
710 Set window title string, the default title is the command-line
711 specified after the -e option, if any, otherwise the application
712 name; option -title.
713 iconName: string
715 Set the name used to label the window's icon or displayed in an
716 icon manager window, it also sets the window's title unless it is
717 explicitly set; option -n.
718 mapAlert: boolean
720 True: de-iconify (map) on receipt of a bell character. False: no
721 de-iconify (map) on receipt of a bell character [default].
722 urgentOnBell: boolean
724 True: set the urgency hint for the wm on receipt of a bell
725 character. False: do not set the urgency hint [default].
726 urxvt resets the urgency hint on every focus change.
728 visualBell: boolean
730 True: use visual bell on receipt of a bell character; option -vb.
731 False: no visual bell [default]; option +vb.
732 loginShell: boolean
734 True: start as a login shell by prepending a `-' to argv[0] of the
735 shell; option -ls. False: start as a normal sub-shell [default];
736 option +ls.
737 multiClickTime: number
739 Specify the maximum time in milliseconds between multi-click select
740 events. The default is 500 milliseconds; option -mc.
741 utmpInhibit: boolean
743 True: inhibit writing record into the system log file utmp; option
744 -ut. False: write record into the system log file utmp [default];
745 option +ut.
746 print-pipe: string
748 Specify a command pipe for vt100 printer [default lpr(1)]. Use
749 Print to initiate a screen dump to the printer and Ctrl-Print or
750 Shift-Print to include the scrollback as well.
751 The string will be interpreted as if typed into the shell as-is.
753 Example:
755 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
757 This creates a new file in your home directory with the screen
759 contents every time you hit "Print".
760 scrollstyle: mode
762 Set scrollbar style to rxvt, plain, next or xterm. plain is the
763 author's favourite.
764 thickness: number
766 Set the scrollbar width in pixels.
767 scrollBar: boolean
769 True: enable the scrollbar [default]; option -sb. False: disable
770 the scrollbar; option +sb.
771 scrollBar_right: boolean
773 True: place the scrollbar on the right of the window; option -sr.
774 False: place the scrollbar on the left of the window; option +sr.
775 scrollBar_floating: boolean
777 True: display an rxvt scrollbar without a trough; option -st.
778 False: display an rxvt scrollbar with a trough; option +st.
779 scrollBar_align: mode
781 Align the top, bottom or centre [default] of the scrollbar thumb
782 with the pointer on middle button press/drag.
783 scrollTtyOutput: boolean
785 True: scroll to bottom when tty receives output; option -si.
786 False: do not scroll to bottom when tty receives output; option
787 +si.
788 scrollWithBuffer: boolean
790 True: scroll with scrollback buffer when tty receives new lines
791 (i.e. try to show the same lines) and scrollTtyOutput is False;
792 option -sw. False: do not scroll with scrollback buffer when tty
793 receives new lines; option +sw.
794 scrollTtyKeypress: boolean
796 True: scroll to bottom when a non-special key is pressed. Special
797 keys are those which are intercepted by rxvt-unicode for special
798 handling and are not passed onto the shell; option -sk. False: do
799 not scroll to bottom when a non-special key is pressed; option +sk.
800 saveLines: number
802 Save number lines in the scrollback buffer [default 1000]; option
803 -sl.
804 internalBorder: number
806 Internal border of number pixels. This resource is limited to 100;
807 option -b.
808 externalBorder: number
810 External border of number pixels. This resource is limited to 100;
811 option -w, -bw, -borderwidth.
812 borderLess: boolean
814 Set MWM hints to request a borderless window, i.e. if honoured by
815 the WM, the rxvt-unicode window will not have window decorations;
816 option -bl.
817 skipBuiltinGlyphs: boolean
819 Compile frills: Disable the usage of the built-in block
820 graphics/line drawing characters and just rely on what the
821 specified fonts provide. Use this if you have a good font and want
822 to use its block graphic glyphs; option -sbg.
823 termName: termname
825 Specifies the terminal type name to be set in the TERM environment
826 variable; option -tn.
827 lineSpace: number
829 Specifies number of lines (pixel height) to insert between each row
830 of the display [default 0]; option -lsp.
831 meta8: boolean
833 True: handle Meta (Alt) + keypress to set the 8th bit. False:
834 handle Meta (Alt) + keypress as an escape prefix [default].
835 mouseWheelScrollPage: boolean
837 True: the mouse wheel scrolls a page full. False: the mouse wheel
838 scrolls five lines [default].
839 pastableTabs: boolean
841 True: store tabs as wide characters. False: interpret tabs as
842 cursor movement only; option "-ptab".
843 cursorBlink: boolean
845 True: blink the cursor. False: do not blink the cursor [default];
846 option -bc.
847 cursorUnderline: boolean
849 True: Make the cursor underlined. False: Make the cursor a box
850 [default]; option -uc.
851 pointerBlank: boolean
853 True: blank the pointer when a key is pressed or after a set number
854 of seconds of inactivity. False: the pointer is always visible
855 [default].
856 pointerColor: colour
858 Mouse pointer foreground colour.
859 pointerColor2: colour
861 Mouse pointer background colour.
862 pointerShape: string
864 Compile frills: Specifies the name of the mouse pointer shape
865 [default xterm]. See the macros in the X11/cursorfont.h include
866 file for possible values (omit the "XC_" prefix).
867 pointerBlankDelay: number
869 Specifies number of seconds before blanking the pointer [default
870 2]. Use a large number (e.g. 987654321) to effectively disable the
871 timeout.
872 backspacekey: string
874 The string to send when the backspace key is pressed. If set to DEC
875 or unset it will send Delete (code 127) or, with control, Backspace
876 (code 8) - which can be reversed with the appropriate DEC private
877 mode escape sequence.
878 deletekey: string
880 The string to send when the delete key (not the keypad delete key)
881 is pressed. If unset it will send the sequence traditionally
882 associated with the Execute key.
883 cutchars: string
885 The characters used as delimiters for double-click word selection
886 (whitespace delimiting is added automatically if resource is
887 given).
888 When the perl selection extension is in use (the default if
890 compiled in, see the urxvtperl(3) manpage), a suitable regex using
891 these characters will be created (if the resource exists,
892 otherwise, no regex will be created). In this mode, characters
893 outside ISO-8859-1 can be used.
894 When the selection extension is not used, only ISO-8859-1
896 characters can be used. If not specified, the built-in default is
897 used:
898 BACKSLASH `"'&()*,;<=>?@[]^{|}
900 preeditType: style
902 OnTheSpot, OverTheSpot, OffTheSpot, Root; option -pt.
903 inputMethod: name
905 name of inputMethod to use; option -im.
906 imLocale: name
908 The locale to use for opening the IM. You can use an "LC_CTYPE" of
909 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP"
910 for the input extension to be able to input japanese characters
911 while staying in another locale; option -imlocale.
912 imFont: fontset
914 Specify the font-set used for XIM styles "OverTheSpot" or
915 "OffTheSpot". It must be a standard X font set (XLFD patterns
916 separated by commas), i.e. it's not in the same format as the other
917 font lists used in urxvt. The default will be set-up to chose *any*
918 suitable found found, preferably one or two pixels differing in
919 size to the base font. option -imfont.
920 tripleclickwords: boolean
922 Change the meaning of triple-click selection with the left mouse
923 button. Instead of selecting a full line it will extend the
924 selection to the end of the logical line only; option -tcw.
925 disablePasteBrackets: boolean
927 Prevent emission of paste bracket sequences; option -dpb.
928 insecure: boolean
930 Enable "insecure" mode. Rxvt-unicode offers some escape sequences
931 that echo arbitrary strings like the icon name or the locale. This
932 could be abused if somebody gets 8-bit-clean access to your
933 display, whether through a mail client displaying mail bodies
934 unfiltered or through write(1) or any other means. Therefore, these
935 sequences are disabled by default. (Note that many other terminals,
936 including xterm, have these sequences enabled by default, which
937 doesn't make it safer, though).
938 You can enable them by setting this boolean resource or specifying
940 -insecure as an option. At the moment, this enables display-answer,
941 locale, findfont, icon label and window title requests.
942 modifier: modifier
944 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
945 super, mod1, mod2, mod3, mod4, mod5; option -mod.
946 answerbackString: string
948 Specify the reply rxvt-unicode sends to the shell when an ENQ
949 (control-E) character is passed through. It may contain escape
950 values as described in the entry on keysym following.
951 secondaryScreen: boolean
953 Turn on/off secondary screen (default enabled).
954 rewrapMode: mode
956 Sets long line rewrap behaviour on window resize to one of auto
957 (default), always or never.
958 secondaryScroll: boolean
960 Turn on/off secondary screen scroll (default enabled). If this
961 option is enabled, scrolls on the secondary screen will change the
962 scrollback buffer and, when secondaryScreen is off, switching
963 to/from the secondary screen will instead scroll the screen up.
964 hold: boolean
966 Turn on/off hold window after exit support. If enabled, urxvt will
967 not immediately destroy its window when the program executed within
968 it exits. Instead, it will wait till it is being killed or closed
969 by the user.
970 chdir: path
972 Sets the working directory for the shell (or the command specified
973 via -e). The path must be an absolute path and it must exist for
974 urxvt to start. If it isn't specified then the current working
975 directory will be used; option -cd.
976 keysym.sym: action
978 Compile frills: Associate action with keysym sym. The intervening
979 resource name keysym. cannot be omitted.
980 Using this resource, you can map key combinations such as
982 "Ctrl-Shift-BackSpace" to various actions, such as outputting a
983 different string than would normally result from that combination,
984 making the terminal scroll up or down the way you want it, or any
985 other thing an extension might provide.
986 The key combination that triggers the action, sym, has the
988 following format:
989 (modifiers-)key
991 Where modifiers can be any combination of the following full or
993 abbreviated modifier names:
994 ISOLevel3 I
996 AppKeypad K
997 Control C
998 NumLock N
999 Shift S
1000 Meta M or A
1001 Lock L
1002 Mod1 1
1003 Mod2 2
1004 Mod3 3
1005 Mod4 4
1006 Mod5 5
1007 The NumLock, Meta and ISOLevel3 modifiers are usually aliased to
1009 whatever modifier the NumLock key, Meta/Alt keys or ISO Level3
1010 Shift/AltGr keys are being mapped. AppKeypad is a synthetic
1011 modifier mapped to the current application keymap mode state.
1012 Due the the large number of modifier combinations, a key mapping
1014 will match if at least the specified identifiers are being set, and
1015 no other key mappings with those and more bits are being defined.
1016 That means that defining a mapping for "a" will automatically
1017 provide definitions for "Meta-a", "Shift-a" and so on, unless some
1018 of those are defined mappings themselves. See the "builtin:"
1019 action, below, for a way to work around this when this is a
1020 problem.
1021 The spelling of key depends on your implementation of X. An easy
1023 way to find a key name is to use the xev(1) command. You can find a
1024 list by looking for the "XK_" macros in the X11/keysymdef.h include
1025 file (omit the "XK_" prefix). Alternatively you can specify key by
1026 its hex keysym value (0x0000 - 0xFFFF).
1027 As with any resource value, the action string may contain backslash
1029 escape sequences ("\n": newline, "\\": backslash, "\000": octal
1030 number), see RESOURCES in "man 7 X" for further details.
1031 An action starts with an action prefix that selects a certain type
1033 of action, followed by a colon. An action string without colons is
1034 interpreted as a literal string to pass to the tty (as if it was
1035 prefixed with "string:").
1036 The following action prefixes are known - extensions can provide
1038 additional prefixes:
1039 string:STRING
1041 If the action starts with "string:" (or otherwise contains no
1042 colons), then the remaining "STRING" will be passed to the
1043 program running in the terminal. For example, you could replace
1044 whatever Shift-Tab outputs by the string "echo rm -rf /"
1045 followed by a newline:
1046 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1048 This could in theory be used to completely redefine your
1050 keymap.
1051 In addition, for actions of this type, you can define a range
1053 of keysyms in one shot by loading the "keysym-list" perl
1054 extension and providing an action with pattern
1055 list/PREFIX/MIDDLE/SUFFIX, where the delimiter `/' should be a
1056 character not used by the strings.
1057 Its usage can be demonstrated by an example:
1059 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1061 The above line is equivalent to the following three lines:
1063 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1065 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1066 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1067 command:STRING
1069 If action takes the form of "command:STRING", the specified
1070 STRING is interpreted and executed as urxvt's control sequence
1071 (basically the opposite of "string:" - instead of sending it to
1072 the program running in the terminal, it will be treated as if
1073 it were program output). This is most useful to feed command
1074 sequences into urxvt.
1075 For example the following means "change the current locale to
1077 "zh_CN.GBK" when Control-Meta-c is being pressed":
1078 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1080 The following example will map Control-Meta-1 and
1082 Control-Meta-2 to the fonts "suxuseuro" and "9x15bold", so you
1083 can have some limited font-switching at runtime:
1084 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1086 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1087 Other things are possible, e.g. resizing (see urxvt(7) for more
1089 info):
1090 URxvt.keysym.M-C-3: command:\033[8;25;80t
1092 URxvt.keysym.M-C-4: command:\033[8;48;110t
1093 builtin:
1095 The builtin action is the action that urxvt would execute if no
1096 key binding existed for the key combination. The obvious use is
1097 to undo the effect of existing bindings. The not so obvious use
1098 is to reinstate bindings when another binding overrides too
1099 many modifiers.
1100 For example if you overwrite the "Insert" key you will disable
1102 urxvt's "Shift-Insert" mapping. To re-enable that, you can poke
1103 "holes" into the user-defined keymap using the "builtin:"
1104 replacement:
1105 URxvt.keysym.Insert: <my insert key sequence>
1107 URxvt.keysym.S-Insert: builtin:
1108 The first line defines a mapping for "Insert" and any
1110 combination of modifiers. The second line re-establishes the
1111 default mapping for "Shift-Insert".
1112 builtin-string:
1114 This action is mainly useful to restore string mappings for
1115 keys that have predefined actions in urxvt. The exact semantics
1116 are a bit difficult to explain - basically, this action will
1117 send the string to the application that would be sent if urxvt
1118 wouldn't have a built-in action for it.
1119 An example might make it clearer: urxvt normally pastes the
1121 selection when you press "Shift-Insert". With the following
1122 bindings, it would instead emit the (undocumented, but what
1123 applications running in the terminal might expect) sequence
1124 "ESC [ 2 $" instead:
1125 URxvt.keysym.S-Insert: builtin-string:
1127 URxvt.keysym.C-S-Insert: builtin:
1128 The first line disables the paste functionality for that key
1130 combination, and the second reinstates the default behaviour
1131 for "Control-Shift-Insert", which would otherwise be
1132 overridden.
1133 Similarly, to let applications gain access to the "C-M-c" (copy
1135 to clipboard) and "C-M-v" (paste clipboard) key combination,
1136 you can do this:
1137 URxvt.keysym.C-M-c: builtin-string:
1139 URxvt.keysym.C-M-v: builtin-string:
1140 EXTENSION:STRING
1142 An action of this form invokes the action STRING, if any,
1143 provided by the urxvtperl(3) extension EXTENSION. The extension
1144 will be loaded automatically if necessary.
1145 Not all extensions define actions, but popular extensions that
1147 do include the selection and matcher extensions (documented in
1148 their own manpages, urxvt-selection(1) and urxvt-matcher(1),
1149 respectively).
1150 From the silly examples department, this will rot13-"encrypt"
1152 urxvt's selection when Alt-Control-c is pressed on typical PC
1153 keyboards:
1154 URxvt.keysym.M-C-c: selection:rot13
1156 perl:STRING *DEPRECATED*
1158 This is a deprecated way of invoking commands provided by perl
1159 extensions. It is still supported, but should not be used
1160 anymore.
1161 perl-ext-common: string
1163 perl-ext: string
1164 Comma-separated list(s) of perl extension scripts (default:
1165 "default") to use in this terminal instance; option -pe.
1166 Extension names can be prefixed with a "-" sign to remove them
1168 again, in case they had been specified earlier. This can be useful
1169 to selectively disable some extensions loaded by default, or
1170 specified via the "perl-ext-common" resource. For example,
1171 "default,-selection" will use all the default extensions except
1172 "selection".
1173 To prohibit autoloading of extensions, you can prefix them with
1175 "/", which will make urxvt refuse to automatically load them (this
1176 can be overriden, however, by specifying the extension name again
1177 without a prefix, though). This does not prohibit extensions
1178 themselves loading other extensions. For example,
1179 "default,/background" will keep the "background" extension from
1180 being loaded when a background OSC sequence is received.
1181 The default set includes the "selection", "option-popup",
1183 "selection-popup", "readline", "searchable-scrollback" and
1184 "confirm-paste" extensions, as well as any extensions which are
1185 mentioned in keysym resources.
1186 Any extension such that a corresponding resource is given on the
1188 command line is automatically appended to perl-ext.
1189 Each extension is looked up in the library directories, loaded if
1191 necessary, and bound to the current terminal instance. When the
1192 library search path contains multiple extension files of the same
1193 name, then the first one found will be used.
1194 If both of these resources are the empty string, then the perl
1196 interpreter will not be initialized. The rationale for having two
1197 options is that perl-ext-common will be used for extensions that
1198 should be available to all instances, while perl-ext is used for
1199 specific instances.
1200 perl-eval: string
1202 Perl code to be evaluated when all extensions have been registered.
1203 See the urxvtperl(3) manpage.
1204 perl-lib: path
1206 Colon-separated list of additional directories that hold extension
1207 scripts. When looking for perl extensions, urxvt will first look in
1208 these directories, then in $URXVT_PERL_LIB, $HOME/.urxvt/ext and
1209 lastly in /usr/lib64/urxvt/perl/.
1210 See the urxvtperl(3) manpage.
1212 selection.pattern-idx: perl-regex
1214 Additional selection patterns, see the urxvtperl(3) manpage for
1215 details.
1216 selection-autotransform.idx: perl-transform
1218 Selection auto-transform patterns, see the urxvtperl(3) manpage for
1219 details.
1220 searchable-scrollback: keysym *DEPRECATED*
1222 This resource is deprecated and will be removed. Use a keysym
1223 resource instead, e.g.:
1224 URxvt.keysym.M-s: searchable-scrollback:start
1226 url-launcher: string
1228 Specifies the program to be started with a URL argument. Used by
1229 the "selection-popup" and "matcher" perl extensions.
1230 transient-for: windowid
1232 Compile frills: Sets the WM_TRANSIENT_FOR property to the given
1233 window id.
1234 override-redirect: boolean
1236 Compile frills: Sets override-redirect for the terminal window,
1237 making it almost invisible to window managers; option
1238 -override-redirect.
1239 iso14755: boolean
1241 Turn on/off ISO 14755 (default enabled).
1242 iso14755_52: boolean
1244 Turn on/off ISO 14755 5.2 mode (default enabled).
1245
1247 Lines of text that scroll off the top of the urxvt window (resource:
1248 saveLines) and can be scrolled back using the scrollbar or by
1249 keystrokes. The normal urxvt scrollbar has arrows and its behaviour is
1250 fairly intuitive. The xterm-scrollbar is without arrows and its
1251 behaviour mimics that of xterm
1252 Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up
1254 with Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with
1255 Button2.
1256
1258 To temporarily override mouse reporting, for either the scrollbar or
1259 the normal text selection/insertion, hold either the Shift or the Meta
1260 (Alt) key while performing the desired mouse action.
1261 If mouse reporting mode is active, the normal scrollbar actions are
1263 disabled -- on the assumption that we are using a fullscreen
1264 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
1265 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
1266 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
1267
1269 The behaviour of text selection and insertion/pasting mechanism is
1270 similar to xterm(1).
1271 Selecting:
1273 Left click at the beginning of the region, drag to the end of the
1274 region and release; Right click to extend the marked region; Left
1275 double-click to select a word; Left triple-click to select the
1276 entire logical line (which can span multiple screen lines), unless
1277 modified by resource tripleclickwords.
1278 Starting a selection while pressing the Meta key (or Meta+Ctrl
1280 keys) (Compile: frills) will create a rectangular selection instead
1281 of a normal one. In this mode, every selected row becomes its own
1282 line in the selection, and trailing whitespace is visually
1283 underlined and removed from the selection.
1284 Pasting:
1286 Pressing and releasing the Middle mouse button in an urxvt window
1287 causes the value of the PRIMARY selection (or CLIPBOARD with the
1288 Meta modifier) to be inserted as if it had been typed on the
1289 keyboard.
1290 Pressing Shift-Insert causes the value of the PRIMARY selection to
1292 be inserted too.
1293 rxvt-unicode also provides the bindings Ctrl-Meta-c and
1295 <Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1296 binding causes the value of the internal selection to be copied to
1297 the CLIPBOARD selection, while the second binding causes the value
1298 of the CLIPBOARD selection to be inserted.
1299
1301 Changing fonts (or font sizes, respectively) via the keypad is not yet
1302 supported in rxvt-unicode. Bug me if you need this.
1303 You can, however, switch fonts at runtime using escape sequences, e.g.:
1305 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1307 You can use keyboard shortcuts, too:
1309 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1311 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1312 rxvt-unicode will automatically re-apply these fonts to the output so
1314 far.
1315
1317 ISO 14755 is a standard for entering and viewing unicode characters and
1318 character codes using the keyboard. It consists of 4 parts. The first
1319 part is available if rxvt-unicode has been compiled with
1320 "--enable-frills", the rest is available when rxvt-unicode was compiled
1321 with "--enable-iso14755".
1322 • 5.1: Basic method
1324 This allows you to enter unicode characters using their hexcode.
1326 Start by pressing and holding both "Control" and "Shift", then
1328 enter hex-digits (between one and six). Releasing "Control" and
1329 "Shift" will commit the character as if it were typed directly.
1330 While holding down "Control" and "Shift" you can also enter
1331 multiple characters by pressing "Space", which will commit the
1332 current character and lets you start a new one.
1333 As an example of use, imagine a business card with a japanese
1335 e-mail address, which you cannot type. Fortunately, the card has
1336 the e-mail address printed as hexcodes, e.g. "671d 65e5". You can
1337 enter this easily by pressing "Control" and "Shift", followed by
1338 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys.
1339 • 5.2: Keyboard symbols entry method
1341 This mode lets you input characters representing the keycap symbols
1343 of your keyboard, if representable in the current locale encoding.
1344 Start by pressing "Control" and "Shift" together, then releasing
1346 them. The next special key (cursor keys, home etc.) you enter will
1347 not invoke its usual function but instead will insert the
1348 corresponding keycap symbol. The symbol will only be entered when
1349 the key has been released, otherwise pressing e.g. "Shift" would
1350 enter the symbol for "ISO Level 2 Switch", although your intention
1351 might have been to enter a reverse tab (Shift-Tab).
1352 • 5.3: Screen-selection entry method
1354 While this is implemented already (it's basically the selection
1356 mechanism), it could be extended by displaying a unicode character
1357 map.
1358 • 5.4: Feedback method for identifying displayed characters for later
1360 input
1361 This method lets you display the unicode character code associated
1363 with characters already displayed.
1364 You enter this mode by holding down "Control" and "Shift" together,
1366 then pressing and holding the left mouse button and moving around.
1367 The unicode hex code(s) (it might be a combining character) of the
1368 character under the pointer is displayed until you release
1369 "Control" and "Shift".
1370 In addition to the hex codes it will display the font used to draw
1372 this character - due to implementation reasons, characters combined
1373 with combining characters, line drawing characters and unknown
1374 characters will always be drawn using the built-in support font.
1375 With respect to conformance, rxvt-unicode is supposed to be compliant
1377 to both scenario A and B of ISO 14755, including part 5.2.
1378
1380 urxvt tries to write an entry into the utmp(5) file so that it can be
1381 seen via the who(1) command, and can accept messages. To allow this
1382 feature, urxvt may need to be installed setuid root on some systems or
1383 setgid to root or to some other group on others.
1384
1386 In addition to the default foreground and background colours, urxvt can
1387 display up to 88/256 colours: 8 ANSI colours plus high-intensity
1388 (potentially bold/blink) versions of the same, and 72 (or 240 in 256
1389 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB cube
1390 plus a 8 (24) colour greyscale ramp.
1391 urxvt supports direct 24-bit fg/bg RGB colour escapes " ESC [ 38 ; 2 ;
1393 R ; G ; Bm " / " ESC [ 48 ; 2; R ; G ; Bm ". However the number of
1394 24-bit colours that can be used is limited: an internal 7x7x5 (256
1395 colour mode) or 6x6x4 (88 colour mode) colour cube is used to index
1396 into the 24-bit colour space. When indexing collisions happen, the
1397 nearest old colour in the cube will be adapted to the new 24-bit RGB
1398 colour. That means one cannot use many similar 24-bit colours. It's
1399 typically not a problem in common scenarios.
1400 Here is a list of the ANSI colours with their names.
1402 color0 (black) = Black
1404 color1 (red) = Red3
1405 color2 (green) = Green3
1406 color3 (yellow) = Yellow3
1407 color4 (blue) = Blue3
1408 color5 (magenta) = Magenta3
1409 color6 (cyan) = Cyan3
1410 color7 (white) = AntiqueWhite
1411 color8 (bright black) = Grey25
1412 color9 (bright red) = Red
1413 color10 (bright green) = Green
1414 color11 (bright yellow) = Yellow
1415 color12 (bright blue) = Blue
1416 color13 (bright magenta) = Magenta
1417 color14 (bright cyan) = Cyan
1418 color15 (bright white) = White
1419 foreground = Black
1420 background = White
1421 It is also possible to specify the colour values of foreground,
1423 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1424 0-15, as a convenient shorthand to reference the colour name of
1425 color0-color15.
1426 The following text gives values for the standard 88 colour mode (and
1428 values for the 256 colour mode in parentheses).
1429 The RGB cube uses indices 16..79 (16..231) using the following
1431 formulas:
1432 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1434 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1435 The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in
1437 10% steps (1/26 to 25/26 in 1/26 steps) - black and white are already
1438 part of the RGB cube.
1439 Together, all those colours implement the 88 (256) colour xterm
1441 colours. Only the first 16 can be changed using resources currently,
1442 the rest can only be changed via command sequences ("escape codes").
1443 Applications are advised to use terminfo or command sequences to
1445 discover number and RGB values of all colours (yes, you can query
1446 this...).
1447 Note that -rv ("reverseVideo: True") simulates reverse video by always
1449 swapping the foreground/background colours. This is in contrast to
1450 xterm(1) where the colours are only swapped if they have not otherwise
1451 been specified. For example,
1452 urxvt -fg Black -bg White -rv
1454 would yield White on Black, while on xterm(1) it would yield Black on
1456 White.
1457 ALPHA CHANNEL SUPPORT
1459 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1460 get their act together, rxvt-unicode will do its own alpha channel
1461 management:
1462 You can prefix any colour with an opaqueness percentage enclosed in
1464 brackets, i.e. "[percent]", where "percent" is a decimal percentage
1465 (0-100) that specifies the opacity of the colour, where 0 is completely
1466 transparent and 100 is completely opaque. For example, "[50]red" is a
1467 half-transparent red, while "[95]#00ff00" is an almost opaque green.
1468 This is the recommended format to specify transparency values, and
1469 works with all ways to specify a colour.
1470 For complete control, rxvt-unicode also supports
1472 "rgba:rrrr/gggg/bbbb/aaaa" (exactly four hex digits/component) colour
1473 specifications, where the additional "aaaa" component specifies opacity
1474 (alpha) values. The minimum value of 0000 is completely transparent,
1475 while "ffff" is completely opaque). The two example colours from
1476 earlier could also be specified as "rgba:ff00/0000/0000/8000" and
1477 "rgba:0000/ff00/0000/f332".
1478 You probably need to specify "-depth 32", too, to force a visual with
1480 alpha channels, and have the luck that your X-server uses ARGB pixel
1481 layout, as X is far from just supporting ARGB visuals out of the box,
1482 and rxvt-unicode just fudges around.
1483 For example, the following selects an almost completely transparent
1485 black background, and an almost opaque pink foreground:
1486 urxvt -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1488 When not using a background image, then the interpretation of the alpha
1490 channel is up to your compositing manager (most interpret it as
1491 transparency of course).
1492 When using a background pixmap or pseudo-transparency, then the
1494 background colour will always behave as if it were completely
1495 transparent (so the background image shows instead), regardless of how
1496 it was specified, while other colours will either be transparent as
1497 specified (the background image will show through) on servers
1498 supporting the RENDER extension, or fully opaque on servers not
1499 supporting the RENDER EXTENSION.
1500 Please note that due to bugs in Xft, specifying alpha values might
1502 result in garbage being displayed when the X-server does not support
1503 the RENDER extension.
1504
1506 urxvt sets and/or uses the following environment variables:
1507 TERM
1509 Normally set to "rxvt-unicode", unless overwritten at configure
1510 time, via resources or on the command line.
1511 COLORTERM
1513 Either "rxvt", "rxvt-xpm", depending on whether urxvt was compiled
1514 with background image support, and optionally with the added
1515 extension "-mono" to indicate that rxvt-unicode runs on a
1516 monochrome screen.
1517 COLORFGBG
1519 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1520 the colour code used as default foreground/text colour (or the
1521 string "default" to indicate that the default-colour escape
1522 sequence is to be used), "bg" is the colour code used as default
1523 background colour (or the string "default"), and "xpm" is the
1524 string "default" if urxvt was compiled with background image
1525 support. Libraries like "ncurses" and "slang" can (and do) use this
1526 information to optimize screen output.
1527 WINDOWID
1529 Set to the (decimal) X Window ID of the urxvt window (the toplevel
1530 window, which usually has subwindows for the scrollbar, the
1531 terminal window and so on).
1532 TERMINFO
1534 Set to the terminfo directory iff urxvt was configured with
1535 "--with-terminfo=PATH".
1536 DISPLAY
1538 Used by urxvt to connect to the display and set to the correct
1539 display in its child processes if "-display" isn't used to
1540 override. It defaults to ":0" if it doesn't exist.
1541 SHELL
1543 The shell to be used for command execution, defaults to "/bin/sh".
1544 RXVT_SOCKET [sic]
1546 The unix domain socket path used by urxvtc(1) and urxvtd(1).
1547 Default $HOME/.urxvt/urxvtd-<nodename>.
1549 URXVT_PERL_LIB
1551 Additional :-separated library search path for perl extensions.
1552 Will be searched after -perl-lib but before ~/.urxvt/ext and the
1553 system library directory.
1554 URXVT_PERL_VERBOSITY
1556 See urxvtperl(3).
1557 HOME
1559 Used to locate the default directory for the unix domain socket for
1560 daemon communications and to locate various resource files (such as
1561 ".Xdefaults")
1562 XAPPLRESDIR
1564 Directory where application-specific X resource files are located.
1565 XENVIRONMENT
1567 If set and accessible, gives the name of a X resource file to be
1568 loaded by urxvt.
1569
1571 /usr/lib/X11/rgb.txt
1572 Colour names.
1573
1575 urxvt(7), urxvtc(1), urxvtd(1), urxvt-extensions(1), urxvtperl(3),
1576 xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1577
1579 Project Coordinator
1580 Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1581 <http://software.schmorp.de/pkg/rxvt-unicode.html>
1583
1585 John Bovey
1586 University of Kent, 1992, wrote the original Xvt.
1587 Rob Nation <nation@rocket.sanders.lockheed.com>
1589 very heavily modified Xvt and came up with Rxvt
1590 Angelo Haritsis <ah@doc.ic.ac.uk>
1592 wrote the Greek Keyboard Input (no longer in code)
1593 mj olesen <olesen@me.QueensU.CA>
1595 Wrote the menu system.
1596 Project Coordinator (changes.txt 2.11 to 2.21)
1598 Oezguer Kesim <kesim@math.fu-berlin.de>
1600 Project Coordinator (changes.txt 2.21a to 2.4.5)
1601 Geoff Wing <gcw@pobox.com>
1603 Rewrote screen display and text selection routines.
1604 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1606 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1608 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1609 perl extension, random hacks, numerous bugfixes and extensions.
1610 Project Coordinator (Changes 1.0 -)
1612 Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1614 pty/utmp code rewrite, image code improvements, many random hacks
1615 and bugfixes.
16169.30 2021-11-22 urxvt(1)