1urxvt256c-ml(1) RXVT-UNICODE urxvt256c-ml(1)
2
6 rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window
7 system)
8
10 urxvt256c-ml [options] [-e command [ args ]]
11
13 rxvt-unicode, version 9.22, 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 urxvt256c-ml(7) (try "man 7 urxvt256c-ml") for a list of frequently
24 asked questions and answer to them and some common problems. That
25 document is 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 urxvt256c-mld(1)
65 (daemon) and urxvt256c-mlc(1) (client).
66 It also makes technical information about escape sequences (which have
68 been extended) more accessible: see urxvt256c-ml(7) for technical
69 reference documentation (escape sequences etc.).
70
72 The urxvt256c-ml options (mostly a subset of xterm's) are listed below.
73 In keeping with the smaller-is-better philosophy, options may be
74 eliminated or default values chosen at compile-time, so options and
75 defaults listed may not accurately reflect the version installed on
76 your system. `urxvt256c-ml -h' gives a list of major compile-time
77 options on the Options line. Option descriptions may be prefixed with
78 which compile option each is dependent upon. e.g. `Compile XIM:'
79 requires XIM on the Options line. Note: `urxvt256c-ml -help' gives a
80 list of all command-line options compiled into your version.
81 Note that urxvt256c-ml permits the resource name to be used as a long-
83 option (--/++ option) so the potential command-line options are far
84 greater than those listed. For example: `urxvt256c-ml --loginShell
85 --color1 Orange'.
86 The following options are available:
88 -help, --help
90 Print out a message describing available options.
91 -display displayname
93 Attempt to open a window on the named X display (the older form -d
94 is still respected. but deprecated). In the absence of this option,
95 the display specified by the DISPLAY environment variable is used.
96 -depth bitdepth
98 Compile frills: Attempt to find a visual with the given bit depth;
99 resource depth.
100 [Please note that many X servers (and libXft) are buggy with
102 respect to "-depth 32" and/or alpha channels, and will cause all
103 sorts of graphical corruption. This is harmless, but we can't do
104 anything about this, so watch out]
105 -visual visualID
107 Compile frills: Use the given visual (see e.g. "xdpyinfo" for
108 possible visual ids) instead of the default, and also allocate a
109 private colormap. All visual types except for DirectColor are
110 supported.
111 -geometry geom
113 Window geometry (-g still respected); resource geometry.
114 -rv|+rv
116 Turn on/off simulated reverse video; resource reverseVideo.
117 -j|+j
119 Turn on/off jump scrolling (allow multiple lines per refresh);
120 resource jumpScroll.
121 -ss|+ss
123 Turn on/off skip scrolling (allow multiple screens per refresh);
124 resource skipScroll.
125 -fade number
127 Fade the text by the given percentage when focus is lost. Small
128 values fade a little only, 100 completely replaces all colours by
129 the fade colour; resource fading.
130 -fadecolor colour
132 Fade to this colour when fading is used (see -fade). The default
133 colour is opaque black. resource fadeColor.
134 -icon file
136 Compile pixbuf: Use the specified image as application icon. This
137 is used by many window managers, taskbars and pagers to represent
138 the application window; resource iconFile.
139 -bg colour
141 Window background colour; resource background.
142 -fg colour
144 Window foreground colour; resource foreground.
145 -cr colour
147 The cursor colour; resource cursorColor.
148 -pr colour
150 The mouse pointer foreground colour; resource pointerColor.
151 -pr2 colour
153 The mouse pointer background colour; resource pointerColor2.
154 -bd colour
156 The colour of the border around the text area and between the
157 scrollbar and the text; resource borderColor.
158 -fn fontlist
160 Select the fonts to be used. This is a comma separated list of font
161 names that are checked in order when trying to find glyphs for
162 characters. The first font defines the cell size for characters;
163 other fonts might be smaller, but not (in general) larger. A
164 (hopefully) reasonable default font list is always appended to it.
165 See resource font for more details.
166 In short, to specify an X11 core font, just specify its name or
168 prefix it with "x:". To specify an XFT-font, you need to prefix it
169 with "xft:", e.g.:
170 urxvt256c-ml -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
172 urxvt256c-ml -fn "9x15bold,xft:Bitstream Vera Sans Mono"
173 See also the question "How does rxvt-unicode choose fonts?" in the
175 FAQ section of urxvt256c-ml(7).
176 -fb fontlist
178 Compile font-styles: The bold font list to use when bold characters
179 are to be printed. See resource boldFont for details.
180 -fi fontlist
182 Compile font-styles: The italic font list to use when italic
183 characters are to be printed. See resource italicFont for details.
184 -fbi fontlist
186 Compile font-styles: The bold italic font list to use when bold
187 italic characters are to be printed. See resource boldItalicFont
188 for details.
189 -is|+is
191 Compile font-styles: Bold/Blink font styles imply high intensity
192 foreground/background (default). See resource intensityStyles for
193 details.
194 -name name
196 Specify the application name under which resources are to be
197 obtained, rather than the default executable file name. Name should
198 not contain `.' or `*' characters. Also sets the icon and title
199 name.
200 -ls|+ls
202 Start as a login-shell/sub-shell; resource loginShell.
203 -mc milliseconds
205 Specify the maximum time between multi-click selections.
206 -ut|+ut
208 Compile utmp: Inhibit/enable writing a utmp entry; resource
209 utmpInhibit.
210 -vb|+vb
212 Turn on/off visual bell on receipt of a bell character; resource
213 visualBell.
214 -sb|+sb
216 Turn on/off scrollbar; resource scrollBar.
217 -sr|+sr
219 Put scrollbar on right/left; resource scrollBar_right.
220 -st|+st
222 Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
223 resource scrollBar_floating.
224 -si|+si
226 Turn on/off scroll-to-bottom on TTY output inhibit; resource
227 scrollTtyOutput has opposite effect.
228 -sk|+sk
230 Turn on/off scroll-to-bottom on keypress; resource
231 scrollTtyKeypress.
232 -sw|+sw
234 Turn on/off scrolling with the scrollback buffer as new lines
235 appear. This only takes effect if -si is also given; resource
236 scrollWithBuffer.
237 -ptab|+ptab
239 If enabled (default), "Horizontal Tab" characters are being stored
240 as actual wide characters in the screen buffer, which makes it
241 possible to select and paste them. Since a horizontal tab is a
242 cursor movement and not an actual glyph, this can sometimes be
243 visually annoying as the cursor on a tab character is displayed as
244 a wide cursor; resource pastableTabs.
245 -bc|+bc
247 Blink the cursor; resource cursorBlink.
248 -uc|+uc
250 Make the cursor underlined; resource cursorUnderline.
251 -iconic
253 Start iconified, if the window manager supports that option.
254 Alternative form is -ic.
255 -sl number
257 Save number lines in the scrollback buffer. See resource entry for
258 limits; resource saveLines.
259 -b number
261 Compile frills: Internal border of number pixels. See resource
262 entry for limits; resource internalBorder.
263 -w number
265 Compile frills: External border of number pixels. Also, -bw and
266 -borderwidth. See resource entry for limits; resource
267 externalBorder.
268 -bl Compile frills: Set MWM hints to request a borderless window, i.e.
270 if honoured by the WM, the rxvt-unicode window will not have window
271 decorations; resource borderLess. If the window manager does not
272 support MWM hints (e.g. kwin), enables override-redirect mode.
273 -override-redirect
275 Compile frills: Sets override-redirect on the window; resource
276 override-redirect.
277 -dockapp
279 Sets the initial state of the window to WithdrawnState, which makes
280 window managers that support this extension treat it as a dockapp.
281 -sbg
283 Compile frills: Disable the usage of the built-in block
284 graphics/line drawing characters and just rely on what the
285 specified fonts provide. Use this if you have a good font and want
286 to use its block graphic glyphs; resource skipBuiltinGlyphs.
287 -lsp number
289 Compile frills: Lines (pixel height) to insert between each row of
290 the display. Useful to work around font rendering problems;
291 resource lineSpace.
292 -letsp number
294 Compile frills: Amount to adjust the computed character width by to
295 control overall letter spacing. Negative values will tighten up the
296 letter spacing, positive values will space letters out more. Useful
297 to work around odd font metrics; resource letterSpace.
298 -tn termname
300 This option specifies the name of the terminal type to be set in
301 the TERM environment variable. This terminal type must exist in the
302 termcap(5) database and should have li# and co# entries; resource
303 termName.
304 -e command [arguments]
306 Run the command with its command-line arguments in the urxvt256c-ml
307 window; also sets the window title and icon name to be the basename
308 of the program being executed if neither -title (-T) nor -n are
309 given on the command line. If this option is used, it must be the
310 last on the command-line. If there is no -e option then the default
311 is to run the program specified by the SHELL environment variable
312 or, failing that, sh(1).
313 Please note that you must specify a program with arguments. If you
315 want to run shell commands, you have to specify the shell, like
316 this:
317 urxvt256c-ml -e sh -c "shell commands"
319 -title text
321 Window title (-T still respected); the default title is the
322 basename of the program specified after the -e option, if any,
323 otherwise the application name; resource title.
324 -n text
326 Icon name; the default name is the basename of the program
327 specified after the -e option, if any, otherwise the application
328 name; resource iconName.
329 -C Capture system console messages.
331 -pt style
333 Compile XIM: input style for input method; OverTheSpot, OffTheSpot,
334 Root; resource preeditType.
335 If the perl extension "xim-onthespot" is used (which is the
337 default), then additionally the "OnTheSpot" preedit type is
338 available.
339 -im text
341 Compile XIM: input method name. resource inputMethod.
342 -imlocale string
344 The locale to use for opening the IM. You can use an "LC_CTYPE" of
345 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP"
346 for the input extension to be able to input japanese characters
347 while staying in another locale. resource imLocale.
348 -imfont fontset
350 Set the font set to use for the X Input Method, see resource imFont
351 for more info.
352 -tcw
354 Change the meaning of triple-click selection with the left mouse
355 button. Only effective when the original (non-perl) selection code
356 is in-use. Instead of selecting a full line it will extend the
357 selection to the end of the logical line only. resource
358 tripleclickwords.
359 -insecure
361 Enable "insecure" mode, which currently enables most of the escape
362 sequences that echo strings. See the resource insecure for more
363 info.
364 -mod modifier
366 Override detection of Meta modifier with specified key: alt, meta,
367 hyper, super, mod1, mod2, mod3, mod4, mod5; resource modifier.
368 -ssc|+ssc
370 Turn on/off secondary screen (default enabled); resource
371 secondaryScreen.
372 -ssr|+ssr
374 Turn on/off secondary screen scroll (default enabled); resource
375 secondaryScroll.
376 -hold|+hold
378 Turn on/off hold window after exit support. If enabled, urxvt256c-
379 ml will not immediately destroy its window when the program
380 executed within it exits. Instead, it will wait till it is being
381 killed or closed by the user; resource hold.
382 -cd path
384 Sets the working directory for the shell (or the command specified
385 via -e). The path must be an absolute path and it must exist for
386 urxvt256c-ml to start; resource chdir.
387 -xrm string
389 Works like the X Toolkit option of the same name, by adding the
390 string as if it were specified in a resource file. Resource values
391 specified this way take precedence over all other resource
392 specifications.
393 Note that you need to use the same syntax as in the .Xdefaults
395 file, e.g. "*.background: black". Also note that all urxvt256c-
396 ml-specific options can be specified as long-options on the
397 commandline, so use of -xrm is mostly limited to cases where you
398 want to specify other resources (e.g. for input methods) or for
399 compatibility with other programs.
400 -keysym.sym string
402 Remap a key symbol. See resource keysym.
403 -embed windowid
405 Tells urxvt256c-ml to embed its windows into an already-existing
406 window, which enables applications to easily embed a terminal.
407 Right now, urxvt256c-ml will first unmap/map the specified window,
409 so it shouldn't be a top-level window. urxvt256c-ml will also
410 reconfigure it quite a bit, so don't expect it to keep some
411 specific state. It's best to create an extra subwindow for
412 urxvt256c-ml and leave it alone.
413 The window will not be destroyed when urxvt256c-ml exits.
415 It might be useful to know that urxvt256c-ml will not close file
417 descriptors passed to it (except for stdin/out/err, of course), so
418 you can use file descriptors to communicate with the programs
419 within the terminal. This works regardless of whether the "-embed"
420 option was used or not.
421 Here is a short Gtk2-perl snippet that illustrates how this option
423 can be used (a longer example is in doc/embed):
424 my $rxvt = new Gtk2::Socket;
426 $rxvt->signal_connect_after (realize => sub {
427 my $xid = $_[0]->window->get_xid;
428 system "urxvt256c-ml -embed $xid &";
429 });
430 -pty-fd file descriptor
432 Tells urxvt256c-ml NOT to execute any commands or create a new
433 pty/tty pair but instead use the given file descriptor as the tty
434 master. This is useful if you want to drive urxvt256c-ml as a
435 generic terminal emulator without having to run a program within
436 it.
437 If this switch is given, urxvt256c-ml will not create any utmp/wtmp
439 entries and will not tinker with pty/tty permissions - you have to
440 do that yourself if you want that.
441 As an extremely special case, specifying "-1" will completely
443 suppress pty/tty operations, which is probably only useful in
444 conjunction with some perl extension that manages the terminal.
445 Here is a example in perl that illustrates how this option can be
447 used (a longer example is in doc/pty-fd):
448 use IO::Pty;
450 use Fcntl;
451 my $pty = new IO::Pty;
453 fcntl $pty, F_SETFD, 0; # clear close-on-exec
454 system "urxvt256c-ml -pty-fd " . (fileno $pty) . "&";
455 close $pty;
456 # now communicate with rxvt
458 my $slave = $pty->slave;
459 while (<$slave>) { print $slave "got <$_>\n" }
460 -pe string
462 Comma-separated list of perl extension scripts to use (or not to
463 use) in this terminal instance. See resource perl-ext for details.
464
466 Note: `urxvt256c-ml --help' gives a list of all resources (long
467 options) compiled into your version. All resources are also available
468 as long-options.
469 You can set and change the resources using X11 tools like xrdb. Many
471 distribution do also load settings from the ~/.Xresources file when X
472 starts. urxvt256c-ml will consult the following files/resources in
473 order, with later settings overwriting earlier ones:
474 1. app-defaults file in $XAPPLRESDIR
476 2. $HOME/.Xdefaults
477 3. RESOURCE_MANAGER property on root-window of screen 0
478 4. SCREEN_RESOURCES property on root-window of the current screen
479 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
480 6. resources specified via -xrm on the commandline
481 Note that when reading X resources, urxvt256c-ml recognizes two class
483 names: Rxvt and URxvt. The class name Rxvt allows resources common to
484 both urxvt256c-ml and the original rxvt to be easily configured, while
485 the class name URxvt allows resources unique to urxvt256c-ml, to be
486 shared between different urxvt256c-ml configurations. If no resources
487 are specified, suitable defaults will be used. Command-line arguments
488 can be used to override resource settings. The following resources are
489 supported (you might want to check the urxvt256c-mlperl(3) manpage for
490 additional settings by perl extensions not documented here):
491 depth: bitdepth
493 Compile xft: Attempt to find a visual with the given bit depth;
494 option -depth.
495 buffered: boolean
497 Compile xft: Turn on/off double-buffering for xft (default
498 enabled). On some card/driver combination enabling it slightly
499 decreases performance, on most it greatly helps it. The slowdown is
500 small, so it should normally be enabled.
501 geometry: geom
503 Create the window with the specified X window geometry [default
504 80x24]; option -geometry.
505 background: colour
507 Use the specified colour as the window's background colour [default
508 White]; option -bg.
509 foreground: colour
511 Use the specified colour as the window's foreground colour [default
512 Black]; option -fg.
513 colorn: colour
515 Use the specified colour for the colour value n, where 0-7
516 corresponds to low-intensity (normal) colours and 8-15 corresponds
517 to high-intensity (bold = bright foreground, blink = bright
518 background) colours. The canonical names are as follows: 0=black,
519 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but
520 the actual colour names used are listed in the COLOURS AND GRAPHICS
521 section.
522 Colours higher than 15 cannot be set using resources (yet), but can
524 be changed using an escape command (see urxvt256c-ml(7)).
525 Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm
527 with 88 colour support). Colours 80-87 are evenly spaces grey
528 steps.
529 colorBD: colour
531 colorIT: colour
532 Use the specified colour to display bold or italic characters when
533 the foreground colour is the default. If font styles are not
534 available (Compile styles) and this option is unset, reverse video
535 is used instead.
536 colorUL: colour
538 Use the specified colour to display underlined characters when the
539 foreground colour is the default.
540 underlineColor: colour
542 If set, use the specified colour as the colour for the underline
543 itself. If unset, use the foreground colour.
544 highlightColor: colour
546 If set, use the specified colour as the background for highlighted
547 characters. If unset, use reverse video.
548 highlightTextColor: colour
550 If set and highlightColor is set, use the specified colour as the
551 foreground for highlighted characters.
552 cursorColor: colour
554 Use the specified colour for the cursor. The default is to use the
555 foreground colour; option -cr.
556 cursorColor2: colour
558 Use the specified colour for the colour of the cursor text. For
559 this to take effect, cursorColor must also be specified. The
560 default is to use the background colour.
561 reverseVideo: boolean
563 True: simulate reverse video by foreground and background colours;
564 option -rv. False: regular screen colours [default]; option +rv.
565 See note in COLOURS AND GRAPHICS section.
566 jumpScroll: boolean
568 True: specify that jump scrolling should be used. When receiving
569 lots of lines, urxvt256c-ml will only scroll once a whole screen
570 height of lines has been read, resulting in fewer updates while
571 still displaying every received line; option -j.
572 False: specify that smooth scrolling should be used. urxvt256c-ml
574 will force a screen refresh on each new line it received; option
575 +j.
576 skipScroll: boolean
578 True: (the default) specify that skip scrolling should be used.
579 When receiving lots of lines, urxvt256c-ml will only scroll once in
580 a while (around 60 times per second), resulting in far fewer
581 updates. This can result in urxvt256c-ml not ever displaying some
582 of the lines it receives; option -ss.
583 False: specify that everything is to be displayed, even if the
585 refresh is too fast for the human eye to read anything (or the
586 monitor to display anything); option +ss.
587 fading: number
589 Fade the text by the given percentage when focus is lost; option
590 -fade.
591 fadeColor: colour
593 Fade to this colour, when fading is used (see fading:). The default
594 colour is black; option -fadecolor.
595 iconFile: file
597 Set the application icon pixmap; option -icon.
598 scrollColor: colour
600 Use the specified colour for the scrollbar [default #B2B2B2].
601 troughColor: colour
603 Use the specified colour for the scrollbar's trough area [default
604 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
605 borderColor: colour
607 The colour of the border around the text area and between the
608 scrollbar and the text.
609 font: fontlist
611 Select the fonts to be used. This is a comma separated list of font
612 names that are checked in order when trying to find glyphs for
613 characters. The first font defines the cell size for characters;
614 other fonts might be smaller, but not (in general) larger. A
615 (hopefully) reasonable default font list is always appended to it;
616 option -fn.
617 Each font can either be a standard X11 core font (XLFD) name, with
619 optional prefix "x:" or a Xft font (Compile xft), prefixed with
620 "xft:".
621 In addition, each font can be prefixed with additional hints and
623 specifications enclosed in square brackets ("[]"). The only
624 available hint currently is "codeset=codeset-name", and this is
625 only used for Xft fonts.
626 For example, this font resource
628 URxvt.font: 9x15bold,\
630 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
631 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
632 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
633 xft:Code2000:antialias=false
634 specifies five fonts to be used. The first one is "9x15bold"
636 (actually the iso8859-1 version of the second font), which is the
637 base font (because it is named first) and thus defines the
638 character cell grid to be 9 pixels wide and 15 pixels high.
639 The second font is just used to add additional unicode characters
641 not in the base font, likewise the third, which is unfortunately
642 non-bold, but the bold version of the font does contain fewer
643 characters, so this is a useful supplement.
644 The third font is an Xft font with aliasing turned off, and the
646 characters are limited to the JIS 0208 codeset (i.e. japanese
647 kanji). The font contains other characters, but we are not
648 interested in them.
649 The last font is a useful catch-all font that supplies most of the
651 remaining unicode characters.
652 boldFont: fontlist
654 italicFont: fontlist
655 boldItalicFont: fontlist
656 The font list to use for displaying bold, italic or bold italic
657 characters, respectively.
658 If specified and non-empty, then the syntax is the same as for the
660 font-resource, and the given font list will be used as is, which
661 makes it possible to substitute completely different font styles
662 for bold and italic.
663 If unset (the default), a suitable font list will be synthesized by
665 "morphing" the normal text font list into the desired shape. If
666 that is not possible, replacement fonts of the desired shape will
667 be tried.
668 If set, but empty, then this specific style is disabled and the
670 normal text font will being used for the given style.
671 intensityStyles: boolean
673 When font styles are not enabled, or this option is enabled (True,
674 option -is, the default), bold/blink font styles imply high
675 intensity foreground/background colours. Disabling this option
676 (False, option +is) disables this behaviour, the high intensity
677 colours are not reachable.
678 title: string
680 Set window title string, the default title is the command-line
681 specified after the -e option, if any, otherwise the application
682 name; option -title.
683 iconName: string
685 Set the name used to label the window's icon or displayed in an
686 icon manager window, it also sets the window's title unless it is
687 explicitly set; option -n.
688 mapAlert: boolean
690 True: de-iconify (map) on receipt of a bell character. False: no
691 de-iconify (map) on receipt of a bell character [default].
692 urgentOnBell: boolean
694 True: set the urgency hint for the wm on receipt of a bell
695 character. False: do not set the urgency hint [default].
696 urxvt256c-ml resets the urgency hint on every focus change.
698 visualBell: boolean
700 True: use visual bell on receipt of a bell character; option -vb.
701 False: no visual bell [default]; option +vb.
702 loginShell: boolean
704 True: start as a login shell by prepending a `-' to argv[0] of the
705 shell; option -ls. False: start as a normal sub-shell [default];
706 option +ls.
707 multiClickTime: number
709 Specify the maximum time in milliseconds between multi-click select
710 events. The default is 500 milliseconds; option -mc.
711 utmpInhibit: boolean
713 True: inhibit writing record into the system log file utmp; option
714 -ut. False: write record into the system log file utmp [default];
715 option +ut.
716 print-pipe: string
718 Specify a command pipe for vt100 printer [default lpr(1)]. Use
719 Print to initiate a screen dump to the printer and Ctrl-Print or
720 Shift-Print to include the scrollback as well.
721 The string will be interpreted as if typed into the shell as-is.
723 Example:
725 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
727 This creates a new file in your home directory with the screen
729 contents every time you hit "Print".
730 scrollstyle: mode
732 Set scrollbar style to rxvt, plain, next or xterm. plain is the
733 author's favourite.
734 thickness: number
736 Set the scrollbar width in pixels.
737 scrollBar: boolean
739 True: enable the scrollbar [default]; option -sb. False: disable
740 the scrollbar; option +sb.
741 scrollBar_right: boolean
743 True: place the scrollbar on the right of the window; option -sr.
744 False: place the scrollbar on the left of the window; option +sr.
745 scrollBar_floating: boolean
747 True: display an rxvt scrollbar without a trough; option -st.
748 False: display an rxvt scrollbar with a trough; option +st.
749 scrollBar_align: mode
751 Align the top, bottom or centre [default] of the scrollbar thumb
752 with the pointer on middle button press/drag.
753 scrollTtyOutput: boolean
755 True: scroll to bottom when tty receives output; option -si.
756 False: do not scroll to bottom when tty receives output; option
757 +si.
758 scrollWithBuffer: boolean
760 True: scroll with scrollback buffer when tty receives new lines
761 (i.e. try to show the same lines) and scrollTtyOutput is False;
762 option -sw. False: do not scroll with scrollback buffer when tty
763 receives new lines; option +sw.
764 scrollTtyKeypress: boolean
766 True: scroll to bottom when a non-special key is pressed. Special
767 keys are those which are intercepted by rxvt-unicode for special
768 handling and are not passed onto the shell; option -sk. False: do
769 not scroll to bottom when a non-special key is pressed; option +sk.
770 saveLines: number
772 Save number lines in the scrollback buffer [default 1000]; option
773 -sl.
774 internalBorder: number
776 Internal border of number pixels. This resource is limited to 100;
777 option -b.
778 externalBorder: number
780 External border of number pixels. This resource is limited to 100;
781 option -w, -bw, -borderwidth.
782 borderLess: boolean
784 Set MWM hints to request a borderless window, i.e. if honoured by
785 the WM, the rxvt-unicode window will not have window decorations;
786 option -bl.
787 skipBuiltinGlyphs: boolean
789 Compile frills: Disable the usage of the built-in block
790 graphics/line drawing characters and just rely on what the
791 specified fonts provide. Use this if you have a good font and want
792 to use its block graphic glyphs; option -sbg.
793 termName: termname
795 Specifies the terminal type name to be set in the TERM environment
796 variable; option -tn.
797 lineSpace: number
799 Specifies number of lines (pixel height) to insert between each row
800 of the display [default 0]; option -lsp.
801 meta8: boolean
803 True: handle Meta (Alt) + keypress to set the 8th bit. False:
804 handle Meta (Alt) + keypress as an escape prefix [default].
805 mouseWheelScrollPage: boolean
807 True: the mouse wheel scrolls a page full. False: the mouse wheel
808 scrolls five lines [default].
809 pastableTabs: boolean
811 True: store tabs as wide characters. False: interpret tabs as
812 cursor movement only; option "-ptab".
813 cursorBlink: boolean
815 True: blink the cursor. False: do not blink the cursor [default];
816 option -bc.
817 cursorUnderline: boolean
819 True: Make the cursor underlined. False: Make the cursor a box
820 [default]; option -uc.
821 pointerBlank: boolean
823 True: blank the pointer when a key is pressed or after a set number
824 of seconds of inactivity. False: the pointer is always visible
825 [default].
826 pointerColor: colour
828 Mouse pointer foreground colour.
829 pointerColor2: colour
831 Mouse pointer background colour.
832 pointerShape: string
834 Compile frills: Specifies the name of the mouse pointer shape
835 [default xterm]. See the macros in the X11/cursorfont.h include
836 file for possible values (omit the "XC_" prefix).
837 pointerBlankDelay: number
839 Specifies number of seconds before blanking the pointer [default
840 2]. Use a large number (e.g. 987654321) to effectively disable the
841 timeout.
842 backspacekey: string
844 The string to send when the backspace key is pressed. If set to DEC
845 or unset it will send Delete (code 127) or, with control, Backspace
846 (code 8) - which can be reversed with the appropriate DEC private
847 mode escape sequence.
848 deletekey: string
850 The string to send when the delete key (not the keypad delete key)
851 is pressed. If unset it will send the sequence traditionally
852 associated with the Execute key.
853 cutchars: string
855 The characters used as delimiters for double-click word selection
856 (whitespace delimiting is added automatically if resource is
857 given).
858 When the perl selection extension is in use (the default if
860 compiled in, see the urxvt256c-mlperl(3) manpage), a suitable regex
861 using these characters will be created (if the resource exists,
862 otherwise, no regex will be created). In this mode, characters
863 outside ISO-8859-1 can be used.
864 When the selection extension is not used, only ISO-8859-1
866 characters can be used. If not specified, the built-in default is
867 used:
868 BACKSLASH `"'&()*,;<=>?@[]^{|}
870 preeditType: style
872 OnTheSpot, OverTheSpot, OffTheSpot, Root; option -pt.
873 inputMethod: name
875 name of inputMethod to use; option -im.
876 imLocale: name
878 The locale to use for opening the IM. You can use an "LC_CTYPE" of
879 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP"
880 for the input extension to be able to input japanese characters
881 while staying in another locale; option -imlocale.
882 imFont: fontset
884 Specify the font-set used for XIM styles "OverTheSpot" or
885 "OffTheSpot". It must be a standard X font set (XLFD patterns
886 separated by commas), i.e. it's not in the same format as the other
887 font lists used in urxvt256c-ml. The default will be set-up to
888 chose *any* suitable found found, preferably one or two pixels
889 differing in size to the base font. option -imfont.
890 tripleclickwords: boolean
892 Change the meaning of triple-click selection with the left mouse
893 button. Instead of selecting a full line it will extend the
894 selection to the end of the logical line only; option -tcw.
895 insecure: boolean
897 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
898 that echo arbitrary strings like the icon name or the locale. This
899 could be abused if somebody gets 8-bit-clean access to your
900 display, whether through a mail client displaying mail bodies
901 unfiltered or through write(1) or any other means. Therefore, these
902 sequences are disabled by default. (Note that many other terminals,
903 including xterm, have these sequences enabled by default, which
904 doesn't make it safer, though).
905 You can enable them by setting this boolean resource or specifying
907 -insecure as an option. At the moment, this enables display-answer,
908 locale, findfont, icon label and window title requests.
909 modifier: modifier
911 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
912 super, mod1, mod2, mod3, mod4, mod5; option -mod.
913 answerbackString: string
915 Specify the reply rxvt-unicode sends to the shell when an ENQ
916 (control-E) character is passed through. It may contain escape
917 values as described in the entry on keysym following.
918 secondaryScreen: boolean
920 Turn on/off secondary screen (default enabled).
921 secondaryScroll: boolean
923 Turn on/off secondary screen scroll (default enabled). If this
924 option is enabled, scrolls on the secondary screen will change the
925 scrollback buffer and, when secondaryScreen is off, switching
926 to/from the secondary screen will instead scroll the screen up.
927 hold: boolean
929 Turn on/off hold window after exit support. If enabled, urxvt256c-
930 ml will not immediately destroy its window when the program
931 executed within it exits. Instead, it will wait till it is being
932 killed or closed by the user.
933 chdir: path
935 Sets the working directory for the shell (or the command specified
936 via -e). The path must be an absolute path and it must exist for
937 urxvt256c-ml to start. If it isn't specified then the current
938 working directory will be used; option -cd.
939 keysym.sym: action
941 Compile frills: Associate action with keysym sym. The intervening
942 resource name keysym. cannot be omitted.
943 Using this resource, you can map key combinations such as
945 "Ctrl-Shift-BackSpace" to various actions, such as outputting a
946 different string than would normally result from that combination,
947 making the terminal scroll up or down the way you want it, or any
948 other thing an extension might provide.
949 The key combination that triggers the action, sym, has the
951 following format:
952 (modifiers-)key
954 Where modifiers can be any combination of ISOLevel3, AppKeypad,
956 Control, NumLock, Shift, Meta, Lock, Mod1, Mod2, Mod3, Mod4, Mod5,
957 and the abbreviated I, K, C, N, S, M, A, L, 1, 2, 3, 4, 5.
958 The NumLock, Meta and ISOLevel3 modifiers are usually aliased to
960 whatever modifier the NumLock key, Meta/Alt keys or ISO Level3
961 Shift/AltGr keys are being mapped. AppKeypad is a synthetic
962 modifier mapped to the current application keymap mode state.
963 Due the the large number of modifier combinations, a key mapping
965 will match if at least the specified identifiers are being set, and
966 no other key mappings with those and more bits are being defined.
967 That means that defining a mapping for "a" will automatically
968 provide definitions for "Meta-a", "Shift-a" and so on, unless some
969 of those are defined mappings themselves. See the "builtin:"
970 action, below, for a way to work around this when this is a
971 problem.
972 The spelling of key depends on your implementation of X. An easy
974 way to find a key name is to use the xev(1) command. You can find a
975 list by looking for the "XK_" macros in the X11/keysymdef.h include
976 file (omit the "XK_" prefix). Alternatively you can specify key by
977 its hex keysym value (0x0000 - 0xFFFF).
978 As with any resource value, the action string may contain backslash
980 escape sequences ("\n": newline, "\\": backslash, "\000": octal
981 number), see RESOURCES in "man 7 X" for further details.
982 An action starts with an action prefix that selects a certain type
984 of action, followed by a colon. An action string without colons is
985 interpreted as a literal string to pass to the tty (as if it was
986 prefixed with "string:").
987 The following action prefixes are known - extensions can provide
989 additional prefixes:
990 string:STRING
992 If the action starts with "string:" (or otherwise contains no
993 colons), then the remaining "STRING" will be passed to the
994 program running in the terminal. For example, you could replace
995 whatever Shift-Tab outputs by the string "echo rm -rf /"
996 followed by a newline:
997 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
999 This could in theory be used to completely redefine your
1001 keymap.
1002 In addition, for actions of this type, you can define a range
1004 of keysyms in one shot by loading the "keysym-list" perl
1005 extension and providing an action with pattern
1006 list/PREFIX/MIDDLE/SUFFIX, where the delimiter `/' should be a
1007 character not used by the strings.
1008 Its usage can be demonstrated by an example:
1010 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1012 The above line is equivalent to the following three lines:
1014 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1016 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1017 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1018 command:STRING
1020 If action takes the form of "command:STRING", the specified
1021 STRING is interpreted and executed as urxvt256c-ml's control
1022 sequence (basically the opposite of "string:" - instead of
1023 sending it to the program running in the terminal, it will be
1024 treated as if it were program output). This is most useful to
1025 feed command sequences into urxvt256c-ml.
1026 For example the following means "change the current locale to
1028 "zh_CN.GBK" when Control-Meta-c is being pressed":
1029 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1031 The following example will map Control-Meta-1 and
1033 Control-Meta-2 to the fonts "suxuseuro" and "9x15bold", so you
1034 can have some limited font-switching at runtime:
1035 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1037 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1038 Other things are possible, e.g. resizing (see urxvt256c-ml(7)
1040 for more info):
1041 URxvt.keysym.M-C-3: command:\033[8;25;80t
1043 URxvt.keysym.M-C-4: command:\033[8;48;110t
1044 builtin:
1046 The builtin action is the action that urxvt256c-ml would
1047 execute if no key binding existed for the key combination. The
1048 obvious use is to undo the effect of existing bindings. The not
1049 so obvious use is to reinstate bindings when another binding
1050 overrides too many modifiers.
1051 For example if you overwrite the "Insert" key you will disable
1053 urxvt256c-ml's "Shift-Insert" mapping. To re-enable that, you
1054 can poke "holes" into the user-defined keymap using the
1055 "builtin:" replacement:
1056 URxvt.keysym.Insert: <my insert key sequence>
1058 URxvt.keysym.S-Insert: builtin:
1059 The first line defines a mapping for "Insert" and any
1061 combination of modifiers. The second line re-establishes the
1062 default mapping for "Shift-Insert".
1063 builtin-string:
1065 This action is mainly useful to restore string mappings for
1066 keys that have predefined actions in urxvt256c-ml. The exact
1067 semantics are a bit difficult to explain - basically, this
1068 action will send the string to the application that would be
1069 sent if urxvt256c-ml wouldn't have a built-in action for it.
1070 An example might make it clearer: urxvt256c-ml normally pastes
1072 the selection when you press "Shift-Insert". With the following
1073 bindings, it would instead emit the (undocumented, but what
1074 applications running in the terminal might expect) sequence
1075 "ESC [ 2 $" instead:
1076 URxvt.keysym.S-Insert: builtin-string:
1078 URxvt.keysym.C-S-Insert: builtin:
1079 The first line disables the paste functionality for that key
1081 combination, and the second reinstates the default behaviour
1082 for "Control-Shift-Insert", which would otherwise be
1083 overridden.
1084 Similarly, to let applications gain access to the "C-M-c" (copy
1086 to clipboard) and "C-M-v" (paste clipboard) key combination,
1087 you can do this:
1088 URxvt.keysym.C-M-c: builtin-string:
1090 URxvt.keysym.C-M-v: builtin-string:
1091 EXTENSION:STRING
1093 An action of this form invokes the action STRING, if any,
1094 provided by the urxvt256c-mlperl(3) extension EXTENSION. The
1095 extension will be loaded automatically if necessary.
1096 Not all extensions define actions, but popular extensions that
1098 do include the selection and matcher extensions (documented in
1099 their own manpages, urxvt256c-ml-selection(1) and urxvt256c-
1100 ml-matcher(1), respectively).
1101 From the silly examples department, this will rot13-"encrypt"
1103 urxvt256c-ml's selection when Alt-Control-c is pressed on
1104 typical PC keyboards:
1105 URxvt.keysym.M-C-c: selection:rot13
1107 perl:STRING *DEPRECATED*
1109 This is a deprecated way of invoking commands provided by perl
1110 extensions. It is still supported, but should not be used
1111 anymore.
1112 perl-ext-common: string
1114 perl-ext: string
1115 Comma-separated list(s) of perl extension scripts (default:
1116 "default") to use in this terminal instance; option -pe.
1117 Extension names can be prefixed with a "-" sign to prohibit using
1119 them. This can be useful to selectively disable some extensions
1120 loaded by default, or specified via the "perl-ext-common" resource.
1121 For example, "default,-selection" will use all the default
1122 extensions except "selection".
1123 The default set includes the "selection", "option-popup",
1125 "selection-popup", "readline" and "searchable-scrollback"
1126 extensions, and extensions which are mentioned in keysym resources.
1127 Any extension such that a corresponding resource is given on the
1129 command line is automatically appended to perl-ext.
1130 Each extension is looked up in the library directories, loaded if
1132 necessary, and bound to the current terminal instance. When the
1133 library search path contains multiple extension files of the same
1134 name, then the first one found will be used.
1135 If both of these resources are the empty string, then the perl
1137 interpreter will not be initialized. The rationale for having two
1138 options is that perl-ext-common will be used for extensions that
1139 should be available to all instances, while perl-ext is used for
1140 specific instances.
1141 perl-eval: string
1143 Perl code to be evaluated when all extensions have been registered.
1144 See the urxvt256c-mlperl(3) manpage.
1145 perl-lib: path
1147 Colon-separated list of additional directories that hold extension
1148 scripts. When looking for perl extensions, urxvt256c-ml will first
1149 look in these directories, then in $URXVT_PERL_LIB,
1150 $HOME/.urxvt/ext and lastly in /usr/lib64/urxvt/perl/.
1151 See the urxvt256c-mlperl(3) manpage.
1153 selection.pattern-idx: perl-regex
1155 Additional selection patterns, see the urxvt256c-mlperl(3) manpage
1156 for details.
1157 selection-autotransform.idx: perl-transform
1159 Selection auto-transform patterns, see the urxvt256c-mlperl(3)
1160 manpage for details.
1161 searchable-scrollback: keysym *DEPRECATED*
1163 This resource is deprecated and will be removed. Use a keysym
1164 resource instead, e.g.:
1165 URxvt.keysym.M-s: searchable-scrollback:start
1167 url-launcher: string
1169 Specifies the program to be started with a URL argument. Used by
1170 the "selection-popup" and "matcher" perl extensions.
1171 transient-for: windowid
1173 Compile frills: Sets the WM_TRANSIENT_FOR property to the given
1174 window id.
1175 override-redirect: boolean
1177 Compile frills: Sets override-redirect for the terminal window,
1178 making it almost invisible to window managers; option
1179 -override-redirect.
1180 iso14755: boolean
1182 Turn on/off ISO 14755 (default enabled).
1183 iso14755_52: boolean
1185 Turn on/off ISO 14755 5.2 mode (default enabled).
1186
1188 -pixmap file[;oplist]
1189 backgroundPixmap: file[;oplist]
1190 Compile pixbuf: Use the specified image file as the window's
1191 background and also optionally specify a colon separated list of
1192 operations to modify it. Note that you may need to quote the ";"
1193 character when using the command line option, as ";" is usually a
1194 metacharacter in shells. Supported operations are:
1195 WxH+X+Y
1197 sets scale and position. "W" / "H" specify the
1198 horizontal/vertical scale (percent), and "X" / "Y" locate the
1199 image centre (percent). A scale of 0 disables scaling.
1200 op=tile
1202 enables tiling
1203 op=keep-aspect
1205 maintain the image aspect ratio when scaling
1206 op=root-align
1208 use the position of the terminal window relative to the root
1209 window as the image offset, simulating a root window background
1210 The default scale and position setting is "100x100+50+50".
1212 Alternatively, a predefined set of templates can be used to achieve
1213 the most common setups:
1214 style=tiled
1216 the image is tiled with no scaling. Equivalent to
1217 0x0+0+0:op=tile
1218 style=aspect-stretched
1220 the image is scaled to fill the whole window maintaining the
1221 aspect ratio and centered. Equivalent to
1222 100x100+50+50:op=keep-aspect
1223 style=stretched
1225 the image is scaled to fill the whole window. Equivalent to
1226 100x100
1227 style=centered
1229 the image is centered with no scaling. Equivalent to 0x0+50+50
1230 style=root-tiled
1232 the image is tiled with no scaling and using 'root'
1233 positioning. Equivalent to 0x0:op=tile:op=root-align
1234 If multiple templates are specified the last one wins. Note that a
1236 template overrides all the scale, position and operations settings.
1237 If used in conjunction with pseudo-transparency, the specified
1239 pixmap will be blended over the transparent background using alpha-
1240 blending.
1241 -tr|+tr
1243 transparent: boolean
1244 Turn on/off pseudo-transparency by using the root pixmap as
1245 background.
1246 -ip (inheritPixmap) is still accepted as an obsolete alias but will
1248 be removed in future versions.
1249 -tint colour
1251 tintColor: colour
1252 Tint the transparent background with the given colour. Note that a
1253 black tint yields a completely black image while a white tint
1254 yields the image unchanged.
1255 -sh number
1257 shading: number
1258 Darken (0 .. 99) or lighten (101 .. 200) the transparent
1259 background. A value of 100 means no shading.
1260 -blr HxV
1262 blurRadius: HxV
1263 Apply gaussian blur with the specified radius to the transparent
1264 background. If a single number is specified, the vertical and
1265 horizontal radii are considered to be the same. Setting one of the
1266 radii to 1 and the other to a large number creates interesting
1267 effects on some backgrounds. The maximum radius value is 128. An
1268 horizontal or vertical radius of 0 disables blurring.
1269 path: path
1271 Specify the colon-delimited search path for finding background
1272 image files.
1273
1275 Lines of text that scroll off the top of the urxvt256c-ml window
1276 (resource: saveLines) and can be scrolled back using the scrollbar or
1277 by keystrokes. The normal urxvt256c-ml scrollbar has arrows and its
1278 behaviour is fairly intuitive. The xterm-scrollbar is without arrows
1279 and its behaviour mimics that of xterm
1280 Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up
1282 with Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with
1283 Button2.
1284
1286 To temporarily override mouse reporting, for either the scrollbar or
1287 the normal text selection/insertion, hold either the Shift or the Meta
1288 (Alt) key while performing the desired mouse action.
1289 If mouse reporting mode is active, the normal scrollbar actions are
1291 disabled -- on the assumption that we are using a fullscreen
1292 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
1293 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
1294 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
1295
1297 The behaviour of text selection and insertion/pasting mechanism is
1298 similar to xterm(1).
1299 Selecting:
1301 Left click at the beginning of the region, drag to the end of the
1302 region and release; Right click to extend the marked region; Left
1303 double-click to select a word; Left triple-click to select the
1304 entire logical line (which can span multiple screen lines), unless
1305 modified by resource tripleclickwords.
1306 Starting a selection while pressing the Meta key (or Meta+Ctrl
1308 keys) (Compile: frills) will create a rectangular selection instead
1309 of a normal one. In this mode, every selected row becomes its own
1310 line in the selection, and trailing whitespace is visually
1311 underlined and removed from the selection.
1312 Pasting:
1314 Pressing and releasing the Middle mouse button in an urxvt256c-ml
1315 window causes the value of the PRIMARY selection (or CLIPBOARD with
1316 the Meta modifier) to be inserted as if it had been typed on the
1317 keyboard.
1318 Pressing Shift-Insert causes the value of the PRIMARY selection to
1320 be inserted too.
1321 rxvt-unicode also provides the bindings Ctrl-Meta-c and
1323 <Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1324 binding causes the value of the internal selection to be copied to
1325 the CLIPBOARD selection, while the second binding causes the value
1326 of the CLIPBOARD selection to be inserted.
1327
1329 Changing fonts (or font sizes, respectively) via the keypad is not yet
1330 supported in rxvt-unicode. Bug me if you need this.
1331 You can, however, switch fonts at runtime using escape sequences, e.g.:
1333 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1335 You can use keyboard shortcuts, too:
1337 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1339 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1340 rxvt-unicode will automatically re-apply these fonts to the output so
1342 far.
1343
1345 ISO 14755 is a standard for entering and viewing unicode characters and
1346 character codes using the keyboard. It consists of 4 parts. The first
1347 part is available if rxvt-unicode has been compiled with
1348 "--enable-frills", the rest is available when rxvt-unicode was compiled
1349 with "--enable-iso14755".
1350 · 5.1: Basic method
1352 This allows you to enter unicode characters using their hexcode.
1354 Start by pressing and holding both "Control" and "Shift", then
1356 enter hex-digits (between one and six). Releasing "Control" and
1357 "Shift" will commit the character as if it were typed directly.
1358 While holding down "Control" and "Shift" you can also enter
1359 multiple characters by pressing "Space", which will commit the
1360 current character and lets you start a new one.
1361 As an example of use, imagine a business card with a japanese
1363 e-mail address, which you cannot type. Fortunately, the card has
1364 the e-mail address printed as hexcodes, e.g. "671d 65e5". You can
1365 enter this easily by pressing "Control" and "Shift", followed by
1366 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys.
1367 · 5.2: Keyboard symbols entry method
1369 This mode lets you input characters representing the keycap symbols
1371 of your keyboard, if representable in the current locale encoding.
1372 Start by pressing "Control" and "Shift" together, then releasing
1374 them. The next special key (cursor keys, home etc.) you enter will
1375 not invoke its usual function but instead will insert the
1376 corresponding keycap symbol. The symbol will only be entered when
1377 the key has been released, otherwise pressing e.g. "Shift" would
1378 enter the symbol for "ISO Level 2 Switch", although your intention
1379 might have been to enter a reverse tab (Shift-Tab).
1380 · 5.3: Screen-selection entry method
1382 While this is implemented already (it's basically the selection
1384 mechanism), it could be extended by displaying a unicode character
1385 map.
1386 · 5.4: Feedback method for identifying displayed characters for later
1388 input
1389 This method lets you display the unicode character code associated
1391 with characters already displayed.
1392 You enter this mode by holding down "Control" and "Shift" together,
1394 then pressing and holding the left mouse button and moving around.
1395 The unicode hex code(s) (it might be a combining character) of the
1396 character under the pointer is displayed until you release
1397 "Control" and "Shift".
1398 In addition to the hex codes it will display the font used to draw
1400 this character - due to implementation reasons, characters combined
1401 with combining characters, line drawing characters and unknown
1402 characters will always be drawn using the built-in support font.
1403 With respect to conformance, rxvt-unicode is supposed to be compliant
1405 to both scenario A and B of ISO 14755, including part 5.2.
1406
1408 urxvt256c-ml tries to write an entry into the utmp(5) file so that it
1409 can be seen via the who(1) command, and can accept messages. To allow
1410 this feature, urxvt256c-ml may need to be installed setuid root on some
1411 systems or setgid to root or to some other group on others.
1412
1414 In addition to the default foreground and background colours,
1415 urxvt256c-ml can display up to 88/256 colours: 8 ANSI colours plus
1416 high-intensity (potentially bold/blink) versions of the same, and 72
1417 (or 240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6)
1418 colour RGB cube plus a 8 (24) colour greyscale ramp.
1419 Here is a list of the ANSI colours with their names.
1421 color0 (black) = Black
1423 color1 (red) = Red3
1424 color2 (green) = Green3
1425 color3 (yellow) = Yellow3
1426 color4 (blue) = Blue3
1427 color5 (magenta) = Magenta3
1428 color6 (cyan) = Cyan3
1430 color7 (white) = AntiqueWhite
1431 color8 (bright black) = Grey25
1432 color9 (bright red) = Red
1433 color10 (bright green) = Green
1434 color11 (bright yellow) = Yellow
1435 color12 (bright blue) = Blue
1436 color13 (bright magenta) = Magenta
1437 color14 (bright cyan) = Cyan
1438 color15 (bright white) = White
1439 foreground = Black
1440 background = White
1441 It is also possible to specify the colour values of foreground,
1443 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1444 0-15, as a convenient shorthand to reference the colour name of
1445 color0-color15.
1446 The following text gives values for the standard 88 colour mode (and
1448 values for the 256 colour mode in parentheses).
1449 The RGB cube uses indices 16..79 (16..231) using the following
1451 formulas:
1452 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1454 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1455 The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in
1457 10% steps (1/26 to 25/26 in 1/26 steps) - black and white are already
1458 part of the RGB cube.
1459 Together, all those colours implement the 88 (256) colour xterm
1461 colours. Only the first 16 can be changed using resources currently,
1462 the rest can only be changed via command sequences ("escape codes").
1463 Applications are advised to use terminfo or command sequences to
1465 discover number and RGB values of all colours (yes, you can query
1466 this...).
1467 Note that -rv ("reverseVideo: True") simulates reverse video by always
1469 swapping the foreground/background colours. This is in contrast to
1470 xterm(1) where the colours are only swapped if they have not otherwise
1471 been specified. For example,
1472 urxvt256c-ml -fg Black -bg White -rv
1474 would yield White on Black, while on xterm(1) it would yield Black on
1476 White.
1477 ALPHA CHANNEL SUPPORT
1479 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1480 get their act together, rxvt-unicode will do its own alpha channel
1481 management:
1482 You can prefix any colour with an opaqueness percentage enclosed in
1484 brackets, i.e. "[percent]", where "percent" is a decimal percentage
1485 (0-100) that specifies the opacity of the colour, where 0 is completely
1486 transparent and 100 is completely opaque. For example, "[50]red" is a
1487 half-transparent red, while "[95]#00ff00" is an almost opaque green.
1488 This is the recommended format to specify transparency values, and
1489 works with all ways to specify a colour.
1490 For complete control, rxvt-unicode also supports
1492 "rgba:rrrr/gggg/bbbb/aaaa" (exactly four hex digits/component) colour
1493 specifications, where the additional "aaaa" component specifies opacity
1494 (alpha) values. The minimum value of 0000 is completely transparent,
1495 while "ffff" is completely opaque). The two example colours from
1496 earlier could also be specified as "rgba:ff00/0000/0000/8000" and
1497 "rgba:0000/ff00/0000/f332".
1498 You probably need to specify "-depth 32", too, to force a visual with
1500 alpha channels, and have the luck that your X-server uses ARGB pixel
1501 layout, as X is far from just supporting ARGB visuals out of the box,
1502 and rxvt-unicode just fudges around.
1503 For example, the following selects an almost completely transparent
1505 black background, and an almost opaque pink foreground:
1506 urxvt256c-ml -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1508 When not using a background image, then the interpretation of the alpha
1510 channel is up to your compositing manager (most interpret it as
1511 transparency of course).
1512 When using a background pixmap or pseudo-transparency, then the
1514 background colour will always behave as if it were completely
1515 transparent (so the background image shows instead), regardless of how
1516 it was specified, while other colours will either be transparent as
1517 specified (the background image will show through) on servers
1518 supporting the RENDER extension, or fully opaque on servers not
1519 supporting the RENDER EXTENSION.
1520 Please note that due to bugs in Xft, specifying alpha values might
1522 result in garbage being displayed when the X-server does not support
1523 the RENDER extension.
1524
1526 urxvt256c-ml sets and/or uses the following environment variables:
1527 TERM
1529 Normally set to "rxvt-unicode", unless overwritten at configure
1530 time, via resources or on the command line.
1531 COLORTERM
1533 Either "rxvt", "rxvt-xpm", depending on whether urxvt256c-ml was
1534 compiled with background image support, and optionally with the
1535 added extension "-mono" to indicate that rxvt-unicode runs on a
1536 monochrome screen.
1537 COLORFGBG
1539 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1540 the colour code used as default foreground/text colour (or the
1541 string "default" to indicate that the default-colour escape
1542 sequence is to be used), "bg" is the colour code used as default
1543 background colour (or the string "default"), and "xpm" is the
1544 string "default" if urxvt256c-ml was compiled with background image
1545 support. Libraries like "ncurses" and "slang" can (and do) use this
1546 information to optimize screen output.
1547 WINDOWID
1549 Set to the (decimal) X Window ID of the urxvt256c-ml window (the
1550 toplevel window, which usually has subwindows for the scrollbar,
1551 the terminal window and so on).
1552 TERMINFO
1554 Set to the terminfo directory iff urxvt256c-ml was configured with
1555 "--with-terminfo=PATH".
1556 DISPLAY
1558 Used by urxvt256c-ml to connect to the display and set to the
1559 correct display in its child processes if "-display" isn't used to
1560 override. It defaults to ":0" if it doesn't exist.
1561 SHELL
1563 The shell to be used for command execution, defaults to "/bin/sh".
1564 RXVT_SOCKET [sic]
1566 The unix domain socket path used by urxvt256c-mlc(1) and urxvt256c-
1567 mld(1).
1568 Default $HOME/.urxvt/urxvtd-<nodename>.
1570 URXVT_PERL_LIB
1572 Additional :-separated library search path for perl extensions.
1573 Will be searched after -perl-lib but before ~/.urxvt/ext and the
1574 system library directory.
1575 URXVT_PERL_VERBOSITY
1577 See urxvt256c-mlperl(3).
1578 HOME
1580 Used to locate the default directory for the unix domain socket for
1581 daemon communications and to locate various resource files (such as
1582 ".Xdefaults")
1583 XAPPLRESDIR
1585 Directory where application-specific X resource files are located.
1586 XENVIRONMENT
1588 If set and accessible, gives the name of a X resource file to be
1589 loaded by urxvt256c-ml.
1590
1592 /usr/lib/X11/rgb.txt
1593 Colour names.
1594
1596 urxvt256c-ml(7), urxvt256c-mlc(1), urxvt256c-mld(1), urxvt256c-
1597 ml-extensions(1), urxvt256c-mlperl(3), xterm(1), sh(1), resize(1),
1598 X(1), pty(4), tty(4), utmp(5)
1599
1601 Project Coordinator
1602 Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1603 <http://software.schmorp.de/pkg/rxvt-unicode.html>
1605
1607 John Bovey
1608 University of Kent, 1992, wrote the original Xvt.
1609 Rob Nation <nation@rocket.sanders.lockheed.com>
1611 very heavily modified Xvt and came up with Rxvt
1612 Angelo Haritsis <ah@doc.ic.ac.uk>
1614 wrote the Greek Keyboard Input (no longer in code)
1615 mj olesen <olesen@me.QueensU.CA>
1617 Wrote the menu system.
1618 Project Coordinator (changes.txt 2.11 to 2.21)
1620 Oezguer Kesim <kesim@math.fu-berlin.de>
1622 Project Coordinator (changes.txt 2.21a to 2.4.5)
1623 Geoff Wing <gcw@pobox.com>
1625 Rewrote screen display and text selection routines.
1626 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1628 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1630 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1631 perl extension, random hacks, numerous bugfixes and extensions.
1632 Project Coordinator (Changes 1.0 -)
1634 Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1636 pty/utmp code rewrite, image code improvements, many random hacks
1637 and bugfixes.
16389.22 2016-01-23 urxvt256c-ml(1)