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