1urxvt-ml(1) RXVT-UNICODE urxvt-ml(1)
2
6 rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window
7 system)
8
10 urxvt-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 urxvt-ml(7) (try "man 7 urxvt-ml") for a list of frequently asked
25 questions and answer to them and some common problems. That document is
26 also accessible on the World-Wide-Web at
27 http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod
28 <http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
29
31 Unlike the original rxvt, rxvt-unicode stores all text in Unicode
32 internally. That means it can store and display most scripts in the
33 world. Being a terminal emulator, however, some things are very
34 difficult, especially cursive scripts such as arabic, vertically
35 written scripts like mongolian or scripts requiring extremely complex
36 combining rules, like tibetan or devanagari. Don't expect pretty output
37 when using these scripts. Most other scripts, latin, cyrillic, kanji,
38 thai etc. should work fine, though. A somewhat difficult case are
39 right-to-left scripts, such as hebrew: rxvt-unicode adopts the view
40 that bidirectional algorithms belong in the application, not the
41 terminal emulator (too many things -- such as cursor-movement while
42 editing -- break otherwise), but that might change.
43 If you are looking for a terminal that supports more exotic scripts,
45 let me recommend "mlterm", which is a very user friendly, lean and
46 clean terminal emulator. In fact, the reason rxvt-unicode was born was
47 solely because the author couldn't get "mlterm" to use one font for
48 latin1 and another for japanese.
49 Therefore another design rationale was the use of multiple fonts to
51 display characters: The idea of a single unicode font which many other
52 programs force onto its users never made sense to me: You should be
53 able to choose any font for any script freely.
54 Apart from that, rxvt-unicode is also much better internationalised
56 than its predecessor, supports things such as XFT and ISO 14755 that
57 are handy in i18n-environments, is faster, and has a lot bugs less than
58 the original rxvt. This all in addition to dozens of other small
59 improvements.
60 It is still faithfully following the original rxvt idea of being lean
62 and nice on resources: for example, you can still configure rxvt-
63 unicode without most of its features to get a lean binary. It also
64 comes with a client/daemon pair that lets you open any number of
65 terminal windows from within a single process, which makes startup time
66 very fast and drastically reduces memory usage. See urxvt-mld(1)
67 (daemon) and urxvt-mlc(1) (client).
68 It also makes technical information about escape sequences (which have
70 been extended) more accessible: see urxvt-ml(7) for technical reference
71 documentation (escape sequences etc.).
72
74 The urxvt-ml options (mostly a subset of xterm's) are listed below. In
75 keeping with the smaller-is-better philosophy, options may be
76 eliminated or default values chosen at compile-time, so options and
77 defaults listed may not accurately reflect the version installed on
78 your system. `urxvt-ml -h' gives a list of major compile-time options
79 on the Options line. Option descriptions may be prefixed with which
80 compile option each is dependent upon. e.g. `Compile XIM:' requires XIM
81 on the Options line. Note: `urxvt-ml -help' gives a list of all
82 command-line options compiled into your version.
83 Note that urxvt-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: `urxvt-ml --loginShell --color1
87 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 urxvt-ml -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
207 urxvt-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 urxvt-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 urxvt-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 urxvt-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, urxvt-ml
403 will not immediately destroy its window when the program executed
404 within it exits. Instead, it will wait till it is being killed or
405 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 urxvt-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 urxvt-
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 urxvt-ml to embed its windows into an already-existing
430 window, which enables applications to easily embed a terminal.
431 Right now, urxvt-ml will first unmap/map the specified window, so
433 it shouldn't be a top-level window. urxvt-ml will also reconfigure
434 it quite a bit, so don't expect it to keep some specific state.
435 It's best to create an extra subwindow for urxvt-ml and leave it
436 alone.
437 The window will not be destroyed when urxvt-ml exits.
439 It might be useful to know that urxvt-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 "urxvt-ml -embed $xid &";
453 });
454 -pty-fd file descriptor
456 Tells urxvt-ml NOT to execute any commands or create a new pty/tty
457 pair but instead use the given file descriptor as the tty master.
458 This is useful if you want to drive urxvt-ml as a generic terminal
459 emulator without having to run a program within it.
460 If this switch is given, urxvt-ml will not create any utmp/wtmp
462 entries and will not tinker with pty/tty permissions - you have to
463 do that yourself if you want that.
464 As an extremely special case, specifying "-1" will completely
466 suppress pty/tty operations, which is probably only useful in
467 conjunction with some perl extension that manages the terminal.
468 Here is a example in perl that illustrates how this option can be
470 used (a longer example is in doc/pty-fd):
471 use IO::Pty;
473 use Fcntl;
474 my $pty = new IO::Pty;
476 fcntl $pty, F_SETFD, 0; # clear close-on-exec
477 system "urxvt-ml -pty-fd " . (fileno $pty) . "&";
478 close $pty;
479 # now communicate with rxvt
481 my $slave = $pty->slave;
482 while (<$slave>) { print $slave "got <$_>\n" }
483 -pe string
485 Comma-separated list of perl extension scripts to use (or not to
486 use) in this terminal instance. See resource perl-ext for details.
487
489 Note: `urxvt-ml --help' gives a list of all resources (long options)
490 compiled into your version. All resources are also available as long-
491 options.
492 You can set and change the resources using X11 tools like xrdb. Many
494 distribution do also load settings from the ~/.Xresources file when X
495 starts. urxvt-ml will consult the following files/resources in order,
496 with later settings overwriting earlier ones:
497 1. app-defaults file in $XAPPLRESDIR
499 2. $HOME/.Xdefaults
500 3. RESOURCE_MANAGER property on root-window of screen 0
501 4. SCREEN_RESOURCES property on root-window of the current screen
502 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
503 6. resources specified via -xrm on the commandline
504 Note that when reading X resources, urxvt-ml recognizes two class
506 names: Rxvt and URxvt. The class name Rxvt allows resources common to
507 both urxvt-ml and the original rxvt to be easily configured, while the
508 class name URxvt allows resources unique to urxvt-ml, to be shared
509 between different urxvt-ml configurations. If no resources are
510 specified, suitable defaults will be used. Command-line arguments can
511 be used to override resource settings. The following resources are
512 supported (you might want to check the urxvt-mlperl(3) manpage for
513 additional settings by perl extensions not documented here):
514 depth: bitdepth
516 Compile xft: Attempt to find a visual with the given bit depth;
517 option -depth.
518 buffered: boolean
520 Compile xft: Turn on/off double-buffering for xft (default
521 enabled). On some card/driver combination enabling it slightly
522 decreases performance, on most it greatly helps it. The slowdown is
523 small, so it should normally be enabled.
524 geometry: geom
526 Create the window with the specified X window geometry [default
527 80x24]; option -geometry.
528 background: colour
530 Use the specified colour as the window's background colour [default
531 White]; option -bg.
532 foreground: colour
534 Use the specified colour as the window's foreground colour [default
535 Black]; option -fg.
536 colorn: colour
538 Use the specified colour for the colour value n, where 0-7
539 corresponds to low-intensity (normal) colours and 8-15 corresponds
540 to high-intensity (bold = bright foreground, blink = bright
541 background) colours. The canonical names are as follows: 0=black,
542 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but
543 the actual colour names used are listed in the COLOURS AND GRAPHICS
544 section.
545 Colours higher than 15 cannot be set using resources (yet), but can
547 be changed using an escape command (see urxvt-ml(7)).
548 Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm
550 with 88 colour support). Colours 80-87 are evenly spaces grey
551 steps.
552 colorBD: colour
554 colorIT: colour
555 Use the specified colour to display bold or italic characters when
556 the foreground colour is the default. If font styles are not
557 available (Compile styles) and this option is unset, reverse video
558 is used instead.
559 colorUL: colour
561 Use the specified colour to display underlined characters when the
562 foreground colour is the default.
563 underlineColor: colour
565 If set, use the specified colour as the colour for the underline
566 itself. If unset, use the foreground colour.
567 highlightColor: colour
569 If set, use the specified colour as the background for highlighted
570 characters. If unset, use reverse video.
571 highlightTextColor: colour
573 If set and highlightColor is set, use the specified colour as the
574 foreground for highlighted characters.
575 cursorColor: colour
577 Use the specified colour for the cursor. The default is to use the
578 foreground colour; option -cr.
579 cursorColor2: colour
581 Use the specified colour for the colour of the cursor text. For
582 this to take effect, cursorColor must also be specified. The
583 default is to use the background colour.
584 reverseVideo: boolean
586 True: simulate reverse video by foreground and background colours;
587 option -rv. False: regular screen colours [default]; option +rv.
588 See note in COLOURS AND GRAPHICS section.
589 jumpScroll: boolean
591 True: specify that jump scrolling should be used. When receiving
592 lots of lines, urxvt-ml will only scroll once a whole screen height
593 of lines has been read, resulting in fewer updates while still
594 displaying every received line; option -j.
595 False: specify that smooth scrolling should be used. urxvt-ml will
597 force a screen refresh on each new line it received; option +j.
598 skipScroll: boolean
600 True: (the default) specify that skip scrolling should be used.
601 When receiving lots of lines, urxvt-ml will only scroll once in a
602 while (around 60 times per second), resulting in far fewer updates.
603 This can result in urxvt-ml not ever displaying some of the lines
604 it receives; option -ss.
605 False: specify that everything is to be displayed, even if the
607 refresh is too fast for the human eye to read anything (or the
608 monitor to display anything); option +ss.
609 transparent: boolean
611 Turn on/off pseudo-transparency by using the root pixmap as
612 background.
613 inheritPixmap is still accepted as an obsolete alias but will be
615 removed in future versions.
616 fading: number
618 Fade the text by the given percentage when focus is lost; option
619 -fade.
620 fadeColor: colour
622 Fade to this colour, when fading is used (see fading:). The default
623 colour is black; option -fadecolor.
624 tintColor: colour
626 Tint the transparent background with the given colour. If the
627 RENDER extension is not available only black, red, green, yellow,
628 blue, magenta, cyan and white tints can be performed server-side.
629 Note that a black tint yields a completely black image while a
630 white tint yields the image unchanged; option -tint.
631 shading: number
633 Darken (0 .. 99) or lighten (101 .. 200) the transparent
634 background. A value of 100 means no shading; option -sh.
635 blendType: string
637 Specify background blending type; option -blt.
638 blurRadius: number
640 Apply gaussian blur with the specified radius to the transparent
641 background; option -blr.
642 iconFile: file
644 Set the application icon pixmap; option -icon.
645 scrollColor: colour
647 Use the specified colour for the scrollbar [default #B2B2B2].
648 troughColor: colour
650 Use the specified colour for the scrollbar's trough area [default
651 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
652 borderColor: colour
654 The colour of the border around the text area and between the
655 scrollbar and the text.
656 backgroundPixmap: file[;geom[:op1][:op2][...]]
658 Use the specified image file for the background and also optionally
659 specify its scaling with a geometry string WxH+X+Y, (default
660 "100x100+50+50") in which "W" / "H" specify the horizontal/vertical
661 scale (percent), and "X" / "Y" locate the image centre (percent).
662 A scale of 0 displays the image with tiling. The maximum permitted
663 scale is 1000. Additional operations can be specified after colon
664 :op1:op2.... Supported operations are:
665 tile force background image to be tiled and not scaled. Equivalent to 0x0
667 propscale will scale image keeping proportions
668 auto will scale image to match window size. Equivalent to 100x100
669 hscale will scale image horizontally to the window size
670 vscale will scale image vertically to the window size
671 scale will scale image to match window size
672 root will tile image as if it was a root window background, auto-adjusting
673 whenever terminal window moves
674 If used in conjunction with -tr option, the specified pixmap will
676 be blended over the transparent background using alpha-blending. If
677 afterimage support has been compiled in it is possible to choose
678 other blending types with -blt "type" option.
679 path: path
681 Specify the colon-delimited search path for finding background
682 image files.
683 font: fontlist
685 Select the fonts to be used. This is a comma separated list of font
686 names that are checked in order when trying to find glyphs for
687 characters. The first font defines the cell size for characters;
688 other fonts might be smaller, but not (in general) larger. A
689 (hopefully) reasonable default font list is always appended to it;
690 option -fn.
691 Each font can either be a standard X11 core font (XLFD) name, with
693 optional prefix "x:" or a Xft font (Compile xft), prefixed with
694 "xft:".
695 In addition, each font can be prefixed with additional hints and
697 specifications enclosed in square brackets ("[]"). The only
698 available hint currently is "codeset=codeset-name", and this is
699 only used for Xft fonts.
700 For example, this font resource
702 URxvt.font: 9x15bold,\
704 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
705 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
706 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
707 xft:Code2000:antialias=false
708 specifies five fonts to be used. The first one is "9x15bold"
710 (actually the iso8859-1 version of the second font), which is the
711 base font (because it is named first) and thus defines the
712 character cell grid to be 9 pixels wide and 15 pixels high.
713 The second font is just used to add additional unicode characters
715 not in the base font, likewise the third, which is unfortunately
716 non-bold, but the bold version of the font does contain fewer
717 characters, so this is a useful supplement.
718 The third font is an Xft font with aliasing turned off, and the
720 characters are limited to the JIS 0208 codeset (i.e. japanese
721 kanji). The font contains other characters, but we are not
722 interested in them.
723 The last font is a useful catch-all font that supplies most of the
725 remaining unicode characters.
726 boldFont: fontlist
728 italicFont: fontlist
729 boldItalicFont: fontlist
730 The font list to use for displaying bold, italic or bold italic
731 characters, respectively.
732 If specified and non-empty, then the syntax is the same as for the
734 font-resource, and the given font list will be used as is, which
735 makes it possible to substitute completely different font styles
736 for bold and italic.
737 If unset (the default), a suitable font list will be synthesized by
739 "morphing" the normal text font list into the desired shape. If
740 that is not possible, replacement fonts of the desired shape will
741 be tried.
742 If set, but empty, then this specific style is disabled and the
744 normal text font will being used for the given style.
745 intensityStyles: boolean
747 When font styles are not enabled, or this option is enabled (True,
748 option -is, the default), bold/blink font styles imply high
749 intensity foreground/background colours. Disabling this option
750 (False, option +is) disables this behaviour, the high intensity
751 colours are not reachable.
752 title: string
754 Set window title string, the default title is the command-line
755 specified after the -e option, if any, otherwise the application
756 name; option -title.
757 iconName: string
759 Set the name used to label the window's icon or displayed in an
760 icon manager window, it also sets the window's title unless it is
761 explicitly set; option -n.
762 mapAlert: boolean
764 True: de-iconify (map) on receipt of a bell character. False: no
765 de-iconify (map) on receipt of a bell character [default].
766 urgentOnBell: boolean
768 True: set the urgency hint for the wm on receipt of a bell
769 character. False: do not set the urgency hint [default].
770 urxvt-ml resets the urgency hint on every focus change.
772 visualBell: boolean
774 True: use visual bell on receipt of a bell character; option -vb.
775 False: no visual bell [default]; option +vb.
776 loginShell: boolean
778 True: start as a login shell by prepending a `-' to argv[0] of the
779 shell; option -ls. False: start as a normal sub-shell [default];
780 option +ls.
781 utmpInhibit: boolean
783 True: inhibit writing record into the system log file utmp; option
784 -ut. False: write record into the system log file utmp [default];
785 option +ut.
786 print-pipe: string
788 Specify a command pipe for vt100 printer [default lpr(1)]. Use
789 Print to initiate a screen dump to the printer and Ctrl-Print or
790 Shift-Print to include the scrollback as well.
791 The string will be interpreted as if typed into the shell as-is.
793 Example:
795 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
797 This creates a new file in your home directory with the screen
799 contents every time you hit "Print".
800 scrollstyle: mode
802 Set scrollbar style to rxvt, plain, next or xterm. plain is the
803 author's favourite.
804 thickness: number
806 Set the scrollbar width in pixels.
807 scrollBar: boolean
809 True: enable the scrollbar [default]; option -sb. False: disable
810 the scrollbar; option +sb.
811 scrollBar_right: boolean
813 True: place the scrollbar on the right of the window; option -sr.
814 False: place the scrollbar on the left of the window; option +sr.
815 scrollBar_floating: boolean
817 True: display an rxvt scrollbar without a trough; option -st.
818 False: display an rxvt scrollbar with a trough; option +st.
819 scrollBar_align: mode
821 Align the top, bottom or centre [default] of the scrollbar thumb
822 with the pointer on middle button press/drag.
823 scrollTtyOutput: boolean
825 True: scroll to bottom when tty receives output; option -si.
826 False: do not scroll to bottom when tty receives output; option
827 +si.
828 scrollWithBuffer: boolean
830 True: scroll with scrollback buffer when tty receives new lines
831 (i.e. try to show the same lines) and scrollTtyOutput is False;
832 option -sw. False: do not scroll with scrollback buffer when tty
833 receives new lines; option +sw.
834 scrollTtyKeypress: boolean
836 True: scroll to bottom when a non-special key is pressed. Special
837 keys are those which are intercepted by rxvt-unicode for special
838 handling and are not passed onto the shell; option -sk. False: do
839 not scroll to bottom when a non-special key is pressed; option +sk.
840 saveLines: number
842 Save number lines in the scrollback buffer [default 64]. This
843 resource is limited on most machines to 65535; option -sl.
844 internalBorder: number
846 Internal border of number pixels. This resource is limited to 100;
847 option -b.
848 externalBorder: number
850 External border of number pixels. This resource is limited to 100;
851 option -w, -bw, -borderwidth.
852 borderLess: boolean
854 Set MWM hints to request a borderless window, i.e. if honoured by
855 the WM, the rxvt-unicode window will not have window decorations;
856 option -bl.
857 skipBuiltinGlyphs: boolean
859 Compile frills: Disable the usage of the built-in block
860 graphics/line drawing characters and just rely on what the
861 specified fonts provide. Use this if you have a good font and want
862 to use its block graphic glyphs; option -sbg.
863 termName: termname
865 Specifies the terminal type name to be set in the TERM environment
866 variable; option -tn.
867 lineSpace: number
869 Specifies number of lines (pixel height) to insert between each row
870 of the display [default 0]; option -lsp.
871 meta8: boolean
873 True: handle Meta (Alt) + keypress to set the 8th bit. False:
874 handle Meta (Alt) + keypress as an escape prefix [default].
875 mouseWheelScrollPage: boolean
877 True: the mouse wheel scrolls a page full. False: the mouse wheel
878 scrolls five lines [default].
879 pastableTabs: boolean
881 True: store tabs as wide characters. False: interpret tabs as
882 cursor movement only; option "-ptab".
883 cursorBlink: boolean
885 True: blink the cursor. False: do not blink the cursor [default];
886 option -bc.
887 cursorUnderline: boolean
889 True: Make the cursor underlined. False: Make the cursor a box
890 [default]; option -uc.
891 pointerBlank: boolean
893 True: blank the pointer when a key is pressed or after a set number
894 of seconds of inactivity. False: the pointer is always visible
895 [default].
896 pointerColor: colour
898 Mouse pointer foreground colour.
899 pointerColor2: colour
901 Mouse pointer background colour.
902 pointerBlankDelay: number
904 Specifies number of seconds before blanking the pointer [default
905 2]. Use a large number (e.g. 987654321) to effectively disable the
906 timeout.
907 backspacekey: string
909 The string to send when the backspace key is pressed. If set to DEC
910 or unset it will send Delete (code 127) or, with control, Backspace
911 (code 8) - which can be reversed with the appropriate DEC private
912 mode escape sequence.
913 deletekey: string
915 The string to send when the delete key (not the keypad delete key)
916 is pressed. If unset it will send the sequence traditionally
917 associated with the Execute key.
918 cutchars: string
920 The characters used as delimiters for double-click word selection
921 (whitespace delimiting is added automatically if resource is
922 given).
923 When the perl selection extension is in use (the default if
925 compiled in, see the urxvt-mlperl(3) manpage), a suitable regex
926 using these characters will be created (if the resource exists,
927 otherwise, no regex will be created). In this mode, characters
928 outside ISO-8859-1 can be used.
929 When the selection extension is not used, only ISO-8859-1
931 characters can be used. If not specified, the built-in default is
932 used:
933 BACKSLASH `"'&()*,;<=>?@[]^{|}
935 preeditType: style
937 OverTheSpot, OffTheSpot, Root; option -pt.
938 inputMethod: name
940 name of inputMethod to use; option -im.
941 imLocale: name
943 The locale to use for opening the IM. You can use an "LC_CTYPE" of
944 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP"
945 for the input extension to be able to input japanese characters
946 while staying in another locale; option -imlocale.
947 imFont: fontset
949 Specify the font-set used for XIM styles "OverTheSpot" or
950 "OffTheSpot". It must be a standard X font set (XLFD patterns
951 separated by commas), i.e. it's not in the same format as the other
952 font lists used in urxvt-ml. The default will be set-up to chose
953 *any* suitable found found, preferably one or two pixels differing
954 in size to the base font. option -imfont.
955 tripleclickwords: boolean
957 Change the meaning of triple-click selection with the left mouse
958 button. Instead of selecting a full line it will extend the
959 selection to the end of the logical line only; option -tcw.
960 insecure: boolean
962 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
963 that echo arbitrary strings like the icon name or the locale. This
964 could be abused if somebody gets 8-bit-clean access to your
965 display, whether through a mail client displaying mail bodies
966 unfiltered or through write(1) or any other means. Therefore, these
967 sequences are disabled by default. (Note that many other terminals,
968 including xterm, have these sequences enabled by default, which
969 doesn't make it safer, though).
970 You can enable them by setting this boolean resource or specifying
972 -insecure as an option. At the moment, this enables display-answer,
973 locale, findfont, icon label and window title requests.
974 modifier: modifier
976 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
977 super, mod1, mod2, mod3, mod4, mod5; option -mod.
978 answerbackString: string
980 Specify the reply rxvt-unicode sends to the shell when an ENQ
981 (control-E) character is passed through. It may contain escape
982 values as described in the entry on keysym following.
983 secondaryScreen: boolean
985 Turn on/off secondary screen (default enabled).
986 secondaryScroll: boolean
988 Turn on/off secondary screen scroll (default enabled). If this
989 option is enabled, scrolls on the secondary screen will change the
990 scrollback buffer and, when secondaryScreen is off, switching
991 to/from the secondary screen will instead scroll the screen up.
992 hold: boolean
994 Turn on/off hold window after exit support. If enabled, urxvt-ml
995 will not immediately destroy its window when the program executed
996 within it exits. Instead, it will wait till it is being killed or
997 closed by the user.
998 chdir: path
1000 Sets the working directory for the shell (or the command specified
1001 via -e). The path must be an absolute path and it must exist for
1002 urxvt-ml to start. If it isn't specified then the current working
1003 directory will be used; option -cd.
1004 keysym.sym: string
1006 Compile frills: Associate string with keysym sym. The intervening
1007 resource name keysym. cannot be omitted.
1008 The format of sym is "(modifiers-)key", where modifiers can be any
1010 combination of ISOLevel3, AppKeypad, Control, NumLock, Shift, Meta,
1011 Lock, Mod1, Mod2, Mod3, Mod4, Mod5, and the abbreviated I, K, C, N,
1012 S, M, A, L, 1, 2, 3, 4, 5.
1013 The NumLock, Meta and ISOLevel3 modifiers are usually aliased to
1015 whatever modifier the NumLock key, Meta/Alt keys or ISO Level3
1016 Shift/AltGr keys are being mapped. AppKeypad is a synthetic
1017 modifier mapped to the current application keymap mode state.
1018 The spellings of key can be obtained by using xev(1) command or
1020 searching keysym macros from /usr/X11R6/include/X11/keysymdef.h and
1021 omitting the prefix XK_. Alternatively you can specify key by its
1022 hex keysym value (0x0000 - 0xFFFF). Note that the lookup of syms is
1023 not performed in an exact manner; however, the closest match is
1024 assured.
1025 string may contain escape values ("\n": newline, "\000": octal
1027 number), see RESOURCES in "man 7 X" for further details.
1028 You can define a range of keysyms in one shot by providing a string
1030 with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter `/'
1031 should be a character not used by the strings.
1032 Its usage can be demonstrated by an example:
1034 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1036 The above line is equivalent to the following three lines:
1038 URxvt.keysym.Meta-Control-0x61: \033<a>
1040 URxvt.keysym.Meta-Control-0x62: \033<b>
1041 URxvt.keysym.Meta-Control-0x63: \033<c>
1042 If string takes the form of "command:STRING", the specified STRING
1044 is interpreted and executed as urxvt-ml's control sequence. For
1045 example the following means "change the current locale to
1046 "zh_CN.GBK" when Control-Meta-c is being pressed":
1047 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1049 If string takes the form "perl:STRING", then the specified STRING
1051 is passed to the "on_user_command" perl handler. See the urxvt-
1052 mlperl(3) manpage. For example, the selection extension (activated
1053 via "urxvt-ml -pe selection") listens for "selection:rot13" events:
1054 URxvt.keysym.M-C-c: perl:selection:rot13
1056 Due the the large number of modifier combinations, a defined key
1058 mapping will match if at least the specified identifiers are being
1059 set, and no other key mappings with those and more bits are being
1060 defined. That means that defining a key map for "a" will
1061 automatically provide definitions for "Meta-a", "Shift-a" and so
1062 on, unless some of those are defined mappings themselves.
1063 Unfortunately, this will override built-in key mappings. For
1065 example if you overwrite the "Insert" key you will disable urxvt-
1066 ml's "Shift-Insert" mapping. To re-enable that, you can poke
1067 "holes" into the user-defined keymap using the "builtin:"
1068 replacement:
1069 URxvt.keysym.Insert: <my insert key sequence>
1071 URxvt.keysym.S-Insert: builtin:
1072 The first line defines a mapping for "Insert" and any combination
1074 of modifiers. The second line re-establishes the default mapping
1075 for "Shift-Insert".
1076 The following example will map Control-Meta-1 and Control-Meta-2 to
1078 the fonts "suxuseuro" and "9x15bold", so you can have some limited
1079 font-switching at runtime:
1080 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1082 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1083 Other things are possible, e.g. resizing (see urxvt-ml(7) for more
1085 info):
1086 URxvt.keysym.M-C-3: command:\033[8;25;80t
1088 URxvt.keysym.M-C-4: command:\033[8;48;110t
1089 perl-ext-common: string
1091 perl-ext: string
1092 Comma-separated list(s) of perl extension scripts (default:
1093 "default") to use in this terminal instance; option -pe.
1094 Extension names can be prefixed with a "-" sign to prohibit using
1096 them. This can be useful to selectively disable some extensions
1097 loaded by default, or specified via the "perl-ext-common" resource.
1098 For example, "default,-selection" will use all the default
1099 extension except "selection".
1100 Extension names can also be followed by an argument in angle
1102 brackets (e.g. "searchable-scrollback<M-s>", which binds the
1103 hotkey for searchable scrollback to Alt/Meta-s). Mentioning the
1104 same extension multiple times with different arguments will pass
1105 multiple arguments to the extension.
1106 Each extension is looked up in the library directories, loaded if
1108 necessary, and bound to the current terminal instance.
1109 If both of these resources are the empty string, then the perl
1111 interpreter will not be initialized. The idea behind two options is
1112 that perl-ext-common will be used for extensions that should be
1113 available to all instances, while perl-ext is used for specific
1114 instances.
1115 perl-eval: string
1117 Perl code to be evaluated when all extensions have been registered.
1118 See the urxvt-mlperl(3) manpage.
1119 perl-lib: path
1121 Colon-separated list of additional directories that hold extension
1122 scripts. When looking for extensions specified by the "perl"
1123 resource, urxvt-ml will first look in these directories and then in
1124 /usr/lib64/urxvt/perl/.
1125 See the urxvt-mlperl(3) manpage.
1127 selection.pattern-idx: perl-regex
1129 Additional selection patterns, see the urxvt-mlperl(3) manpage for
1130 details.
1131 selection-autotransform.idx: perl-transform
1133 Selection auto-transform patterns, see the urxvt-mlperl(3) manpage
1134 for details.
1135 searchable-scrollback: keysym
1137 Sets the hotkey that starts the incremental scrollback buffer
1138 search (default: "M-s").
1139 urlLauncher: string
1141 Specifies the program to be started with a URL argument. Used by
1142 the "selection-popup" and "matcher" perl extensions.
1143 transient-for: windowid
1145 Compile frills: Sets the WM_TRANSIENT_FOR property to the given
1146 window id.
1147 override-redirect: boolean
1149 Compile frills: Sets override-redirect for the terminal window,
1150 making it almost invisible to window managers; option
1151 -override-redirect.
1152 iso14755: boolean
1154 Turn on/off ISO 14755 (default enabled).
1155 iso14755_52: boolean
1157 Turn on/off ISO 14755 5.2 mode (default enabled).
1158
1160 Lines of text that scroll off the top of the urxvt-ml window (resource:
1161 saveLines) and can be scrolled back using the scrollbar or by
1162 keystrokes. The normal urxvt-ml scrollbar has arrows and its behaviour
1163 is fairly intuitive. The xterm-scrollbar is without arrows and its
1164 behaviour mimics that of xterm
1165 Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up
1167 with Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with
1168 Button2.
1169
1171 To temporarily override mouse reporting, for either the scrollbar or
1172 the normal text selection/insertion, hold either the Shift or the Meta
1173 (Alt) key while performing the desired mouse action.
1174 If mouse reporting mode is active, the normal scrollbar actions are
1176 disabled -- on the assumption that we are using a fullscreen
1177 application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
1178 (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
1179 up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
1180
1182 The behaviour of text selection and insertion/pasting mechanism is
1183 similar to xterm(1).
1184 Selecting:
1186 Left click at the beginning of the region, drag to the end of the
1187 region and release; Right click to extend the marked region; Left
1188 double-click to select a word; Left triple-click to select the
1189 entire logical line (which can span multiple screen lines), unless
1190 modified by resource tripleclickwords.
1191 Starting a selection while pressing the Meta key (or Meta+Ctrl
1193 keys) (Compile: frills) will create a rectangular selection instead
1194 of a normal one. In this mode, every selected row becomes its own
1195 line in the selection, and trailing whitespace is visually
1196 underlined and removed from the selection.
1197 Pasting:
1199 Pressing and releasing the Middle mouse button in an urxvt-ml
1200 window causes the value of the PRIMARY selection (or CLIPBOARD with
1201 the Meta modifier) to be inserted as if it had been typed on the
1202 keyboard.
1203 Pressing Shift-Insert causes the value of the PRIMARY selection to
1205 be inserted too.
1206
1208 Changing fonts (or font sizes, respectively) via the keypad is not yet
1209 supported in rxvt-unicode. Bug me if you need this.
1210 You can, however, switch fonts at runtime using escape sequences, e.g.:
1212 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1214 You can use keyboard shortcuts, too:
1216 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1218 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1219 rxvt-unicode will automatically re-apply these fonts to the output so
1221 far.
1222
1224 ISO 14755 is a standard for entering and viewing unicode characters and
1225 character codes using the keyboard. It consists of 4 parts. The first
1226 part is available if rxvt-unicode has been compiled with
1227 "--enable-frills", the rest is available when rxvt-unicode was compiled
1228 with "--enable-iso14755".
1229 · 5.1: Basic method
1231 This allows you to enter unicode characters using their hexcode.
1233 Start by pressing and holding both "Control" and "Shift", then
1235 enter hex-digits (between one and six). Releasing "Control" and
1236 "Shift" will commit the character as if it were typed directly.
1237 While holding down "Control" and "Shift" you can also enter
1238 multiple characters by pressing "Space", which will commit the
1239 current character and lets you start a new one.
1240 As an example of use, imagine a business card with a japanese
1242 e-mail address, which you cannot type. Fortunately, the card has
1243 the e-mail address printed as hexcodes, e.g. "671d 65e5". You can
1244 enter this easily by pressing "Control" and "Shift", followed by
1245 "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys.
1246 · 5.2: Keyboard symbols entry method
1248 This mode lets you input characters representing the keycap symbols
1250 of your keyboard, if representable in the current locale encoding.
1251 Start by pressing "Control" and "Shift" together, then releasing
1253 them. The next special key (cursor keys, home etc.) you enter will
1254 not invoke its usual function but instead will insert the
1255 corresponding keycap symbol. The symbol will only be entered when
1256 the key has been released, otherwise pressing e.g. "Shift" would
1257 enter the symbol for "ISO Level 2 Switch", although your intention
1258 might have been to enter a reverse tab (Shift-Tab).
1259 · 5.3: Screen-selection entry method
1261 While this is implemented already (it's basically the selection
1263 mechanism), it could be extended by displaying a unicode character
1264 map.
1265 · 5.4: Feedback method for identifying displayed characters for later
1267 input
1268 This method lets you display the unicode character code associated
1270 with characters already displayed.
1271 You enter this mode by holding down "Control" and "Shift" together,
1273 then pressing and holding the left mouse button and moving around.
1274 The unicode hex code(s) (it might be a combining character) of the
1275 character under the pointer is displayed until you release
1276 "Control" and "Shift".
1277 In addition to the hex codes it will display the font used to draw
1279 this character - due to implementation reasons, characters combined
1280 with combining characters, line drawing characters and unknown
1281 characters will always be drawn using the built-in support font.
1282 With respect to conformance, rxvt-unicode is supposed to be compliant
1284 to both scenario A and B of ISO 14755, including part 5.2.
1285
1287 urxvt-ml tries to write an entry into the utmp(5) file so that it can
1288 be seen via the who(1) command, and can accept messages. To allow this
1289 feature, urxvt-ml may need to be installed setuid root on some systems
1290 or setgid to root or to some other group on others.
1291
1293 In addition to the default foreground and background colours, urxvt-ml
1294 can display up to 88/256 colours: 8 ANSI colours plus high-intensity
1295 (potentially bold/blink) versions of the same, and 72 (or 240 in 256
1296 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB cube
1297 plus a 8 (24) colour greyscale ramp.
1298 Here is a list of the ANSI colours with their names.
1300 color0 (black) = Black
1302 color1 (red) = Red3
1303 color2 (green) = Green3
1304 color3 (yellow) = Yellow3
1305 color4 (blue) = Blue3
1306 color5 (magenta) = Magenta3
1307 color6 (cyan) = Cyan3
1308 color7 (white) = AntiqueWhite
1309 color8 (bright black) = Grey25
1310 color9 (bright red) = Red
1311 color10 (bright green) = Green
1312 color11 (bright yellow) = Yellow
1313 color12 (bright blue) = Blue
1314 color13 (bright magenta) = Magenta
1315 color14 (bright cyan) = Cyan
1316 color15 (bright white) = White
1317 foreground = Black
1318 background = White
1319 It is also possible to specify the colour values of foreground,
1321 background, cursorColor, cursorColor2, colorBD, colorUL as a number
1322 0-15, as a convenient shorthand to reference the colour name of
1323 color0-color15.
1324 The following text gives values for the standard 88 colour mode (and
1326 values for the 256 colour mode in parentheses).
1327 The RGB cube uses indices 16..79 (16..231) using the following
1329 formulas:
1330 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1332 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1333 The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in
1335 10% steps (1/26 to 25/26 in 1/26 steps) - black and white are already
1336 part of the RGB cube.
1337 Together, all those colours implement the 88 (256) colour xterm
1339 colours. Only the first 16 can be changed using resources currently,
1340 the rest can only be changed via command sequences ("escape codes").
1341 Applications are advised to use terminfo or command sequences to
1343 discover number and RGB values of all colours (yes, you can query
1344 this...).
1345 Note that -rv ("reverseVideo: True") simulates reverse video by always
1347 swapping the foreground/background colours. This is in contrast to
1348 xterm(1) where the colours are only swapped if they have not otherwise
1349 been specified. For example,
1350 urxvt-ml -fg Black -bg White -rv
1352 would yield White on Black, while on xterm(1) it would yield Black on
1354 White.
1355 ALPHA CHANNEL SUPPORT
1357 If Xft support has been compiled in and as long as Xft/Xrender/X don't
1358 get their act together, rxvt-unicode will do it's own alpha channel
1359 management:
1360 You can prefix any colour with an opaqueness percentage enclosed in
1362 brackets, i.e. "[percent]", where "percent" is a decimal percentage
1363 (0-100) that specifies the opacity of the colour, where 0 is completely
1364 transparent and 100 is completely opaque. For example, "[50]red" is a
1365 half-transparent red, while "[95]#00ff00" is an almost opaque green.
1366 This is the recommended format to specify transparency values, and
1367 works with all ways to specify a colour.
1368 For complete control, rxvt-unicode also supports
1370 "rgba:rrrr/gggg/bbbb/aaaa" (exactly four hex digits/component) colour
1371 specifications, where the additional "aaaa" component specifies opacity
1372 (alpha) values. The minimum value of 0000 is completely transparent,
1373 while "ffff" is completely opaque). The two example colours from
1374 earlier could also be specified as "rgba:ff00/0000/0000/8000" and
1375 "rgba:0000/ff00/0000/f332".
1376 You probably need to specify "-depth 32", too, to force a visual with
1378 alpha channels, and have the luck that your X-server uses ARGB pixel
1379 layout, as X is far from just supporting ARGB visuals out of the box,
1380 and rxvt-unicode just fudges around.
1381 For example, the following selects an almost completely transparent
1383 black background, and an almost opaque pink foreground:
1384 urxvt-ml -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1386 When not using a background image, then the interpretation of the alpha
1388 channel is up to your compositing manager (most interpret it as
1389 transparency of course).
1390 When using a background pixmap or pseudo-transparency, then the
1392 background colour will always behave as if it were completely
1393 transparent (so the background image shows instead), regardless of how
1394 it was specified, while other colours will either be transparent as
1395 specified (the background image will show through) on servers
1396 supporting the RENDER extension, or fully opaque on servers not
1397 supporting the RENDER EXTENSION.
1398 Please note that due to bugs in Xft, specifying alpha values might
1400 result in garbage being displayed when the X-server does not support
1401 the RENDER extension.
1402
1404 urxvt-ml sets and/or uses the following environment variables:
1405 TERM
1407 Normally set to "rxvt-unicode", unless overwritten at configure
1408 time, via resources or on the command line.
1409 COLORTERM
1411 Either "rxvt", "rxvt-xpm", depending on whether urxvt-ml was
1412 compiled with background image support, and optionally with the
1413 added extension "-mono" to indicate that rxvt-unicode runs on a
1414 monochrome screen.
1415 COLORFGBG
1417 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1418 the colour code used as default foreground/text colour (or the
1419 string "default" to indicate that the default-colour escape
1420 sequence is to be used), "bg" is the colour code used as default
1421 background colour (or the string "default"), and "xpm" is the
1422 string "default" if urxvt-ml was compiled with background image
1423 support. Libraries like "ncurses" and "slang" can (and do) use this
1424 information to optimize screen output.
1425 WINDOWID
1427 Set to the (decimal) X Window ID of the urxvt-ml window (the
1428 toplevel window, which usually has subwindows for the scrollbar,
1429 the terminal window and so on).
1430 TERMINFO
1432 Set to the terminfo directory iff urxvt-ml was configured with
1433 "--with-terminfo=PATH".
1434 DISPLAY
1436 Used by urxvt-ml to connect to the display and set to the correct
1437 display in its child processes if "-display" isn't used to
1438 override. It defaults to ":0" if it doesn't exist.
1439 SHELL
1441 The shell to be used for command execution, defaults to "/bin/sh".
1442 RXVT_SOCKET
1444 The unix domain socket path used by urxvt-mlc(1) and urxvt-mld(1).
1445 Default $HOME/.rxvt-unicode-<nodename>.
1447 HOME
1449 Used to locate the default directory for the unix domain socket for
1450 daemon communications and to locate various resource files (such as
1451 ".Xdefaults")
1452 XAPPLRESDIR
1454 Directory where application-specific X resource files are located.
1455 XENVIRONMENT
1457 If set and accessible, gives the name of a X resource file to be
1458 loaded by urxvt-ml.
1459
1461 /usr/lib/X11/rgb.txt
1462 Colour names.
1463
1465 urxvt-ml(7), urxvt-mlc(1), urxvt-mld(1), xterm(1), sh(1), resize(1),
1466 X(1), pty(4), tty(4), utmp(5)
1467
1469 Project Coordinator
1470 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1471 http://software.schmorp.de/pkg/rxvt-unicode.html
1473 <http://software.schmorp.de/pkg/rxvt-unicode.html>
1474
1476 John Bovey
1477 University of Kent, 1992, wrote the original Xvt.
1478 Rob Nation <nation@rocket.sanders.lockheed.com>
1480 very heavily modified Xvt and came up with Rxvt
1481 Angelo Haritsis <ah@doc.ic.ac.uk>
1483 wrote the Greek Keyboard Input (no longer in code)
1484 mj olesen <olesen@me.QueensU.CA>
1486 Wrote the menu system.
1487 Project Coordinator (changes.txt 2.11 to 2.21)
1489 Oezguer Kesim <kesim@math.fu-berlin.de>
1491 Project Coordinator (changes.txt 2.21a to 2.4.5)
1492 Geoff Wing <gcw@pobox.com>
1494 Rewrote screen display and text selection routines.
1495 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1497 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1499 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1500 perl extension, random hacks, numerous bugfixes and extensions.
1501 Project Coordinator (Changes 1.0 -)
1503 Emanuele Giaquinta <e.giaquinta@glauco.it>
1505 pty/utmp code rewrite, image code improvements, many random hacks
1506 and bugfixes.
15079.12 2011-06-29 urxvt-ml(1)