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