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