1urxvt(1)                         RXVT-UNICODE                         urxvt(1)
2
3
4

NAME

6       rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window
7       system)
8

SYNOPSIS

10       urxvt [options] [-e command [ args ]]
11

DESCRIPTION

13       rxvt-unicode, version 9.26, 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
19       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

FREQUENTLY ASKED QUESTIONS

23       See urxvt(7) (try "man 7 urxvt") for a list of frequently asked
24       questions and answer to them and some common problems. That document is
25       also accessible on the World-Wide-Web at
26       <http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
27

RXVT-UNICODE VS. RXVT

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
42       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
48       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
53       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
59       It is still faithfully following the original rxvt idea of being lean
60       and nice on resources: for example, you can still configure rxvt-
61       unicode without most of its features to get a lean binary. It also
62       comes with a client/daemon pair that lets you open any number of
63       terminal windows from within a single process, which makes startup time
64       very fast and drastically reduces memory usage. See urxvtd(1) (daemon)
65       and urxvtc(1) (client).
66
67       It also makes technical information about escape sequences (which have
68       been extended) more accessible: see urxvt(7) for technical reference
69       documentation (escape sequences etc.).
70

OPTIONS

72       The urxvt options (mostly a subset of xterm's) are listed below. In
73       keeping with the smaller-is-better philosophy, options may be
74       eliminated or default values chosen at compile-time, so options and
75       defaults listed may not accurately reflect the version installed on
76       your system. `urxvt -h' gives a list of major compile-time options on
77       the Options line. Option descriptions may be prefixed with which
78       compile option each is dependent upon. e.g. `Compile XIM:' requires XIM
79       on the Options line. Note: `urxvt -help' gives a list of all command-
80       line options compiled into your version.
81
82       Note that urxvt permits the resource name to be used as a long-option
83       (--/++ option) so the potential command-line options are far greater
84       than those listed. For example: `urxvt --loginShell --color1 Orange'.
85
86       The following options are available:
87
88       -help, --help
89           Print out a message describing available options.
90
91       -display displayname
92           Attempt to open a window on the named X display (the older form -d
93           is still respected. but deprecated). In the absence of this option,
94           the display specified by the DISPLAY environment variable is used.
95
96       -depth bitdepth
97           Compile frills: Attempt to find a visual with the given bit depth;
98           resource depth.
99
100           [Please note that many X servers (and libXft) are buggy with
101           respect to "-depth 32" and/or alpha channels, and will cause all
102           sorts of graphical corruption. This is harmless, but we can't do
103           anything about this, so watch out]
104
105       -visual visualID
106           Compile frills: Use the given visual (see e.g. "xdpyinfo" for
107           possible visual ids) instead of the default, and also allocate a
108           private colormap. All visual types except for DirectColor are
109           supported.
110
111       -geometry geom
112           Window geometry (-g still respected); resource geometry.
113
114       -rv|+rv
115           Turn on/off simulated reverse video; resource reverseVideo.
116
117       -j|+j
118           Turn on/off jump scrolling (allow multiple lines per refresh);
119           resource jumpScroll.
120
121       -ss|+ss
122           Turn on/off skip scrolling (allow multiple screens per refresh);
123           resource skipScroll.
124
125       -fade number
126           Fade the text by the given percentage when focus is lost. Small
127           values fade a little only, 100 completely replaces all colours by
128           the fade colour; resource fading.
129
130       -fadecolor colour
131           Fade to this colour when fading is used (see -fade). The default
132           colour is opaque black. resource fadeColor.
133
134       -icon file
135           Compile pixbuf: Use the specified image as application icon. This
136           is used by many window managers, taskbars and pagers to represent
137           the application window; resource iconFile.
138
139       -bg colour
140           Window background colour; resource background.
141
142       -fg colour
143           Window foreground colour; resource foreground.
144
145       -cr colour
146           The cursor colour; resource cursorColor.
147
148       -pr colour
149           The mouse pointer foreground colour; resource pointerColor.
150
151       -pr2 colour
152           The mouse pointer background colour; resource pointerColor2.
153
154       -bd colour
155           The colour of the border around the text area and between the
156           scrollbar and the text; resource borderColor.
157
158       -fn fontlist
159           Select the fonts to be used. This is a comma separated list of font
160           names that are checked in order when trying to find glyphs for
161           characters. The first font defines the cell size for characters;
162           other fonts might be smaller, but not (in general) larger. A
163           (hopefully) reasonable default font list is always appended to it.
164           See resource font for more details.
165
166           In short, to specify an X11 core font, just specify its name or
167           prefix it with "x:". To specify an XFT-font, you need to prefix it
168           with "xft:", e.g.:
169
170              urxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
171              urxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
172
173           See also the question "How does rxvt-unicode choose fonts?" in the
174           FAQ section of urxvt(7).
175
176       -fb fontlist
177           Compile font-styles: The bold font list to use when bold characters
178           are to be printed. See resource boldFont for details.
179
180       -fi fontlist
181           Compile font-styles: The italic font list to use when italic
182           characters are to be printed. See resource italicFont for details.
183
184       -fbi fontlist
185           Compile font-styles: The bold italic font list to use when bold
186           italic characters are to be printed. See resource boldItalicFont
187           for details.
188
189       -is|+is
190           Compile font-styles: Bold/Blink font styles imply high intensity
191           foreground/background (default). See resource intensityStyles for
192           details.
193
194       -name name
195           Specify the application name under which resources are to be
196           obtained, rather than the default executable file name. Name should
197           not contain `.' or `*' characters. Also sets the icon and title
198           name.
199
200       -ls|+ls
201           Start as a login-shell/sub-shell; resource loginShell.
202
203       -mc milliseconds
204           Specify the maximum time between multi-click selections.
205
206       -ut|+ut
207           Compile utmp: Inhibit/enable writing a utmp entry; resource
208           utmpInhibit.
209
210       -vb|+vb
211           Turn on/off visual bell on receipt of a bell character; resource
212           visualBell.
213
214       -sb|+sb
215           Turn on/off scrollbar; resource scrollBar.
216
217       -sr|+sr
218           Put scrollbar on right/left; resource scrollBar_right.
219
220       -st|+st
221           Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
222           resource scrollBar_floating.
223
224       -si|+si
225           Turn on/off scroll-to-bottom on TTY output inhibit; resource
226           scrollTtyOutput has opposite effect.
227
228       -sk|+sk
229           Turn on/off scroll-to-bottom on keypress; resource
230           scrollTtyKeypress.
231
232       -sw|+sw
233           Turn on/off scrolling with the scrollback buffer as new lines
234           appear.  This only takes effect if -si is also given; resource
235           scrollWithBuffer.
236
237       -ptab|+ptab
238           If enabled (default), "Horizontal Tab" characters are being stored
239           as actual wide characters in the screen buffer, which makes it
240           possible to select and paste them. Since a horizontal tab is a
241           cursor movement and not an actual glyph, this can sometimes be
242           visually annoying as the cursor on a tab character is displayed as
243           a wide cursor; resource pastableTabs.
244
245       -bc|+bc
246           Blink the cursor; resource cursorBlink.
247
248       -uc|+uc
249           Make the cursor underlined; resource cursorUnderline.
250
251       -iconic
252           Start iconified, if the window manager supports that option.
253           Alternative form is -ic.
254
255       -sl number
256           Save number lines in the scrollback buffer. See resource entry for
257           limits; resource saveLines.
258
259       -b number
260           Compile frills: Internal border of number pixels. See resource
261           entry for limits; resource internalBorder.
262
263       -w number
264           Compile frills: External border of number pixels. Also, -bw and
265           -borderwidth. See resource entry for limits; resource
266           externalBorder.
267
268       -bl Compile frills: Set MWM hints to request a borderless window, i.e.
269           if honoured by the WM, the rxvt-unicode window will not have window
270           decorations; resource borderLess. If the window manager does not
271           support MWM hints (e.g. kwin), enables override-redirect mode.
272
273       -override-redirect
274           Compile frills: Sets override-redirect on the window; resource
275           override-redirect.
276
277       -dockapp
278           Sets the initial state of the window to WithdrawnState, which makes
279           window managers that support this extension treat it as a dockapp.
280
281       -sbg
282           Compile frills: Disable the usage of the built-in block
283           graphics/line drawing characters and just rely on what the
284           specified fonts provide. Use this if you have a good font and want
285           to use its block graphic glyphs; resource skipBuiltinGlyphs.
286
287       -lsp number
288           Compile frills: Lines (pixel height) to insert between each row of
289           the display. Useful to work around font rendering problems;
290           resource lineSpace.
291
292       -letsp number
293           Compile frills: Amount to adjust the computed character width by to
294           control overall letter spacing. Negative values will tighten up the
295           letter spacing, positive values will space letters out more. Useful
296           to work around odd font metrics; resource letterSpace.
297
298       -tn termname
299           This option specifies the name of the terminal type to be set in
300           the TERM environment variable. This terminal type must exist in the
301           termcap(5) database and should have li# and co# entries; resource
302           termName.
303
304       -e command [arguments]
305           Run the command with its command-line arguments in the urxvt
306           window; also sets the window title and icon name to be the basename
307           of the program being executed if neither -title (-T) nor -n are
308           given on the command line. If this option is used, it must be the
309           last on the command-line. If there is no -e option then the default
310           is to run the program specified by the SHELL environment variable
311           or, failing that, sh(1).
312
313           Please note that you must specify a program with arguments. If you
314           want to run shell commands, you have to specify the shell, like
315           this:
316
317             urxvt -e sh -c "shell commands"
318
319       -title text
320           Window title (-T still respected); the default title is the
321           basename of the program specified after the -e option, if any,
322           otherwise the application name; resource title.
323
324       -n text
325           Icon name; the default name is the basename of the program
326           specified after the -e option, if any, otherwise the application
327           name; resource iconName.
328
329       -C  Capture system console messages.
330
331       -pt style
332           Compile XIM: input style for input method; OverTheSpot, OffTheSpot,
333           Root; resource preeditType.
334
335           If the perl extension "xim-onthespot" is used (which is the
336           default), then additionally the "OnTheSpot" preedit type is
337           available.
338
339       -im text
340           Compile XIM: input method name. resource inputMethod.
341
342       -imlocale string
343           The locale to use for opening the IM. You can use an "LC_CTYPE" of
344           e.g.  "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP"
345           for the input extension to be able to input japanese characters
346           while staying in another locale. resource imLocale.
347
348       -imfont fontset
349           Set the font set to use for the X Input Method, see resource imFont
350           for more info.
351
352       -tcw
353           Change the meaning of triple-click selection with the left mouse
354           button. Only effective when the original (non-perl) selection code
355           is in-use. Instead of selecting a full line it will extend the
356           selection to the end of the logical line only. resource
357           tripleclickwords.
358
359       -insecure
360           Enable "insecure" mode, which currently enables most of the escape
361           sequences that echo strings. See the resource insecure for more
362           info.
363
364       -mod modifier
365           Override detection of Meta modifier with specified key: alt, meta,
366           hyper, super, mod1, mod2, mod3, mod4, mod5; resource modifier.
367
368       -ssc|+ssc
369           Turn on/off secondary screen (default enabled); resource
370           secondaryScreen.
371
372       -ssr|+ssr
373           Turn on/off secondary screen scroll (default enabled); resource
374           secondaryScroll.
375
376       -hold|+hold
377           Turn on/off hold window after exit support. If enabled, urxvt will
378           not immediately destroy its window when the program executed within
379           it exits. Instead, it will wait till it is being killed or closed
380           by the user; resource hold.
381
382       -cd path
383           Sets the working directory for the shell (or the command specified
384           via -e). The path must be an absolute path and it must exist for
385           urxvt to start; resource chdir.
386
387       -xrm string
388           Works like the X Toolkit option of the same name, by adding the
389           string as if it were specified in a resource file. Resource values
390           specified this way take precedence over all other resource
391           specifications.
392
393           Note that you need to use the same syntax as in the .Xdefaults
394           file, e.g. "*.background: black". Also note that all urxvt-specific
395           options can be specified as long-options on the commandline, so use
396           of -xrm is mostly limited to cases where you want to specify other
397           resources (e.g. for input methods) or for compatibility with other
398           programs.
399
400       -keysym.sym string
401           Remap a key symbol. See resource keysym.
402
403       -embed windowid
404           Tells urxvt to embed its windows into an already-existing window,
405           which enables applications to easily embed a terminal.
406
407           Right now, urxvt will first unmap/map the specified window, so it
408           shouldn't be a top-level window. urxvt will also reconfigure it
409           quite a bit, so don't expect it to keep some specific state. It's
410           best to create an extra subwindow for urxvt and leave it alone.
411
412           The window will not be destroyed when urxvt exits.
413
414           It might be useful to know that urxvt will not close file
415           descriptors passed to it (except for stdin/out/err, of course), so
416           you can use file descriptors to communicate with the programs
417           within the terminal. This works regardless of whether the "-embed"
418           option was used or not.
419
420           Here is a short Gtk2-perl snippet that illustrates how this option
421           can be used (a longer example is in doc/embed):
422
423              my $rxvt = new Gtk2::Socket;
424              $rxvt->signal_connect_after (realize => sub {
425                 my $xid = $_[0]->window->get_xid;
426                 system "urxvt -embed $xid &";
427              });
428
429       -pty-fd file descriptor
430           Tells urxvt NOT to execute any commands or create a new pty/tty
431           pair but instead use the given file descriptor as the tty master.
432           This is useful if you want to drive urxvt as a generic terminal
433           emulator without having to run a program within it.
434
435           If this switch is given, urxvt will not create any utmp/wtmp
436           entries and will not tinker with pty/tty permissions - you have to
437           do that yourself if you want that.
438
439           As an extremely special case, specifying "-1" will completely
440           suppress pty/tty operations, which is probably only useful in
441           conjunction with some perl extension that manages the terminal.
442
443           Here is a example in perl that illustrates how this option can be
444           used (a longer example is in doc/pty-fd):
445
446              use IO::Pty;
447              use Fcntl;
448
449              my $pty = new IO::Pty;
450              fcntl $pty, F_SETFD, 0; # clear close-on-exec
451              system "urxvt -pty-fd " . (fileno $pty) . "&";
452              close $pty;
453
454              # now communicate with rxvt
455              my $slave = $pty->slave;
456              while (<$slave>) { print $slave "got <$_>\n" }
457
458       -pe string
459           Comma-separated list of perl extension scripts to use (or not to
460           use) in this terminal instance. See resource perl-ext for details.
461

RESOURCES

463       Note: `urxvt --help' gives a list of all resources (long options)
464       compiled into your version. All resources are also available as long-
465       options.
466
467       You can set and change the resources using X11 tools like xrdb. Many
468       distribution do also load settings from the ~/.Xresources file when X
469       starts. urxvt will consult the following files/resources in order, with
470       later settings overwriting earlier ones:
471
472         1. app-defaults file in $XAPPLRESDIR
473         2. $HOME/.Xdefaults
474         3. RESOURCE_MANAGER property on root-window of screen 0
475         4. SCREEN_RESOURCES property on root-window of the current screen
476         5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
477         6. resources specified via -xrm on the commandline
478
479       Note that when reading X resources, urxvt recognizes two class names:
480       Rxvt and URxvt. The class name Rxvt allows resources common to both
481       urxvt and the original rxvt to be easily configured, while the class
482       name URxvt allows resources unique to urxvt, to be shared between
483       different urxvt configurations. If no resources are specified, suitable
484       defaults will be used. Command-line arguments can be used to override
485       resource settings. The following resources are supported (you might
486       want to check the urxvtperl(3) manpage for additional settings by perl
487       extensions not documented here):
488
489       depth: bitdepth
490           Compile xft: Attempt to find a visual with the given bit depth;
491           option -depth.
492
493       buffered: boolean
494           Compile xft: Turn on/off double-buffering for xft (default
495           enabled).  On some card/driver combination enabling it slightly
496           decreases performance, on most it greatly helps it. The slowdown is
497           small, so it should normally be enabled.
498
499       geometry: geom
500           Create the window with the specified X window geometry [default
501           80x24]; option -geometry.
502
503       background: colour
504           Use the specified colour as the window's background colour [default
505           White]; option -bg.
506
507       foreground: colour
508           Use the specified colour as the window's foreground colour [default
509           Black]; option -fg.
510
511       colorn: colour
512           Use the specified colour for the colour value n, where 0-7
513           corresponds to low-intensity (normal) colours and 8-15 corresponds
514           to high-intensity (bold = bright foreground, blink = bright
515           background) colours. The canonical names are as follows: 0=black,
516           1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but
517           the actual colour names used are listed in the COLOURS AND GRAPHICS
518           section.
519
520           Colours higher than 15 cannot be set using resources (yet), but can
521           be changed using an escape command (see urxvt(7)).
522
523           Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm
524           with 88 colour support). Colours 80-87 are evenly spaces grey
525           steps.
526
527       colorBD: colour
528       colorIT: colour
529           Use the specified colour to display bold or italic characters when
530           the foreground colour is the default. If font styles are not
531           available (Compile styles) and this option is unset, reverse video
532           is used instead.
533
534       colorUL: colour
535           Use the specified colour to display underlined characters when the
536           foreground colour is the default.
537
538       underlineColor: colour
539           If set, use the specified colour as the colour for the underline
540           itself. If unset, use the foreground colour.
541
542       highlightColor: colour
543           If set, use the specified colour as the background for highlighted
544           characters. If unset, use reverse video.
545
546       highlightTextColor: colour
547           If set and highlightColor is set, use the specified colour as the
548           foreground for highlighted characters.
549
550       cursorColor: colour
551           Use the specified colour for the cursor. The default is to use the
552           foreground colour; option -cr.
553
554       cursorColor2: colour
555           Use the specified colour for the colour of the cursor text. For
556           this to take effect, cursorColor must also be specified. The
557           default is to use the background colour.
558
559       reverseVideo: boolean
560           True: simulate reverse video by foreground and background colours;
561           option -rv. False: regular screen colours [default]; option +rv.
562           See note in COLOURS AND GRAPHICS section.
563
564       jumpScroll: boolean
565           True: specify that jump scrolling should be used. When receiving
566           lots of lines, urxvt will only scroll once a whole screen height of
567           lines has been read, resulting in fewer updates while still
568           displaying every received line; option -j.
569
570           False: specify that smooth scrolling should be used. urxvt will
571           force a screen refresh on each new line it received; option +j.
572
573       skipScroll: boolean
574           True: (the default) specify that skip scrolling should be used.
575           When receiving lots of lines, urxvt will only scroll once in a
576           while (around 60 times per second), resulting in far fewer updates.
577           This can result in urxvt not ever displaying some of the lines it
578           receives; option -ss.
579
580           False: specify that everything is to be displayed, even if the
581           refresh is too fast for the human eye to read anything (or the
582           monitor to display anything); option +ss.
583
584       fading: number
585           Fade the text by the given percentage when focus is lost; option
586           -fade.
587
588       fadeColor: colour
589           Fade to this colour, when fading is used (see fading:). The default
590           colour is black; option -fadecolor.
591
592       iconFile: file
593           Set the application icon pixmap; option -icon.
594
595       scrollColor: colour
596           Use the specified colour for the scrollbar [default #B2B2B2].
597
598       troughColor: colour
599           Use the specified colour for the scrollbar's trough area [default
600           #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
601
602       borderColor: colour
603           The colour of the border around the text area and between the
604           scrollbar and the text.
605
606       font: fontlist
607           Select the fonts to be used. This is a comma separated list of font
608           names that are checked in order when trying to find glyphs for
609           characters. The first font defines the cell size for characters;
610           other fonts might be smaller, but not (in general) larger. A
611           (hopefully) reasonable default font list is always appended to it;
612           option -fn.
613
614           Each font can either be a standard X11 core font (XLFD) name, with
615           optional prefix "x:" or a Xft font (Compile xft), prefixed with
616           "xft:".
617
618           In addition, each font can be prefixed with additional hints and
619           specifications enclosed in square brackets ("[]"). The only
620           available hint currently is "codeset=codeset-name", and this is
621           only used for Xft fonts.
622
623           For example, this font resource
624
625              URxvt.font: 9x15bold,\
626                          -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
627                          -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
628                          [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
629                          xft:Code2000:antialias=false
630
631           specifies five fonts to be used. The first one is "9x15bold"
632           (actually the iso8859-1 version of the second font), which is the
633           base font (because it is named first) and thus defines the
634           character cell grid to be 9 pixels wide and 15 pixels high.
635
636           The second font is just used to add additional unicode characters
637           not in the base font, likewise the third, which is unfortunately
638           non-bold, but the bold version of the font does contain fewer
639           characters, so this is a useful supplement.
640
641           The third font is an Xft font with aliasing turned off, and the
642           characters are limited to the JIS 0208 codeset (i.e. japanese
643           kanji). The font contains other characters, but we are not
644           interested in them.
645
646           The last font is a useful catch-all font that supplies most of the
647           remaining unicode characters.
648
649       boldFont: fontlist
650       italicFont: fontlist
651       boldItalicFont: fontlist
652           The font list to use for displaying bold, italic or bold italic
653           characters, respectively.
654
655           If specified and non-empty, then the syntax is the same as for the
656           font-resource, and the given font list will be used as is, which
657           makes it possible to substitute completely different font styles
658           for bold and italic.
659
660           If unset (the default), a suitable font list will be synthesized by
661           "morphing" the normal text font list into the desired shape. If
662           that is not possible, replacement fonts of the desired shape will
663           be tried.
664
665           If set, but empty, then this specific style is disabled and the
666           normal text font will being used for the given style.
667
668       intensityStyles: boolean
669           When font styles are not enabled, or this option is enabled (True,
670           option -is, the default), bold/blink font styles imply high
671           intensity foreground/background colours. Disabling this option
672           (False, option +is) disables this behaviour, the high intensity
673           colours are not reachable.
674
675       title: string
676           Set window title string, the default title is the command-line
677           specified after the -e option, if any, otherwise the application
678           name; option -title.
679
680       iconName: string
681           Set the name used to label the window's icon or displayed in an
682           icon manager window, it also sets the window's title unless it is
683           explicitly set; option -n.
684
685       mapAlert: boolean
686           True: de-iconify (map) on receipt of a bell character. False: no
687           de-iconify (map) on receipt of a bell character [default].
688
689       urgentOnBell: boolean
690           True: set the urgency hint for the wm on receipt of a bell
691           character.  False: do not set the urgency hint [default].
692
693           urxvt resets the urgency hint on every focus change.
694
695       visualBell: boolean
696           True: use visual bell on receipt of a bell character; option -vb.
697           False: no visual bell [default]; option +vb.
698
699       loginShell: boolean
700           True: start as a login shell by prepending a `-' to argv[0] of the
701           shell; option -ls. False: start as a normal sub-shell [default];
702           option +ls.
703
704       multiClickTime: number
705           Specify the maximum time in milliseconds between multi-click select
706           events. The default is 500 milliseconds; option -mc.
707
708       utmpInhibit: boolean
709           True: inhibit writing record into the system log file utmp; option
710           -ut. False: write record into the system log file utmp [default];
711           option +ut.
712
713       print-pipe: string
714           Specify a command pipe for vt100 printer [default lpr(1)]. Use
715           Print to initiate a screen dump to the printer and Ctrl-Print or
716           Shift-Print to include the scrollback as well.
717
718           The string will be interpreted as if typed into the shell as-is.
719
720           Example:
721
722              URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
723
724           This creates a new file in your home directory with the screen
725           contents every time you hit "Print".
726
727       scrollstyle: mode
728           Set scrollbar style to rxvt, plain, next or xterm. plain is the
729           author's favourite.
730
731       thickness: number
732           Set the scrollbar width in pixels.
733
734       scrollBar: boolean
735           True: enable the scrollbar [default]; option -sb. False: disable
736           the scrollbar; option +sb.
737
738       scrollBar_right: boolean
739           True: place the scrollbar on the right of the window; option -sr.
740           False: place the scrollbar on the left of the window; option +sr.
741
742       scrollBar_floating: boolean
743           True: display an rxvt scrollbar without a trough; option -st.
744           False: display an rxvt scrollbar with a trough; option +st.
745
746       scrollBar_align: mode
747           Align the top, bottom or centre [default] of the scrollbar thumb
748           with the pointer on middle button press/drag.
749
750       scrollTtyOutput: boolean
751           True: scroll to bottom when tty receives output; option -si.
752           False: do not scroll to bottom when tty receives output; option
753           +si.
754
755       scrollWithBuffer: boolean
756           True: scroll with scrollback buffer when tty receives new lines
757           (i.e.  try to show the same lines) and scrollTtyOutput is False;
758           option -sw. False: do not scroll with scrollback buffer when tty
759           receives new lines; option +sw.
760
761       scrollTtyKeypress: boolean
762           True: scroll to bottom when a non-special key is pressed. Special
763           keys are those which are intercepted by rxvt-unicode for special
764           handling and are not passed onto the shell; option -sk. False: do
765           not scroll to bottom when a non-special key is pressed; option +sk.
766
767       saveLines: number
768           Save number lines in the scrollback buffer [default 1000]; option
769           -sl.
770
771       internalBorder: number
772           Internal border of number pixels. This resource is limited to 100;
773           option -b.
774
775       externalBorder: number
776           External border of number pixels. This resource is limited to 100;
777           option -w, -bw, -borderwidth.
778
779       borderLess: boolean
780           Set MWM hints to request a borderless window, i.e. if honoured by
781           the WM, the rxvt-unicode window will not have window decorations;
782           option -bl.
783
784       skipBuiltinGlyphs: boolean
785           Compile frills: Disable the usage of the built-in block
786           graphics/line drawing characters and just rely on what the
787           specified fonts provide. Use this if you have a good font and want
788           to use its block graphic glyphs; option -sbg.
789
790       termName: termname
791           Specifies the terminal type name to be set in the TERM environment
792           variable; option -tn.
793
794       lineSpace: number
795           Specifies number of lines (pixel height) to insert between each row
796           of the display [default 0]; option -lsp.
797
798       meta8: boolean
799           True: handle Meta (Alt) + keypress to set the 8th bit. False:
800           handle Meta (Alt) + keypress as an escape prefix [default].
801
802       mouseWheelScrollPage: boolean
803           True: the mouse wheel scrolls a page full. False: the mouse wheel
804           scrolls five lines [default].
805
806       pastableTabs: boolean
807           True: store tabs as wide characters. False: interpret tabs as
808           cursor movement only; option "-ptab".
809
810       cursorBlink: boolean
811           True: blink the cursor. False: do not blink the cursor [default];
812           option -bc.
813
814       cursorUnderline: boolean
815           True: Make the cursor underlined. False: Make the cursor a box
816           [default]; option -uc.
817
818       pointerBlank: boolean
819           True: blank the pointer when a key is pressed or after a set number
820           of seconds of inactivity. False: the pointer is always visible
821           [default].
822
823       pointerColor: colour
824           Mouse pointer foreground colour.
825
826       pointerColor2: colour
827           Mouse pointer background colour.
828
829       pointerShape: string
830           Compile frills: Specifies the name of the mouse pointer shape
831           [default xterm]. See the macros in the X11/cursorfont.h include
832           file for possible values (omit the "XC_" prefix).
833
834       pointerBlankDelay: number
835           Specifies number of seconds before blanking the pointer [default
836           2]. Use a large number (e.g. 987654321) to effectively disable the
837           timeout.
838
839       backspacekey: string
840           The string to send when the backspace key is pressed. If set to DEC
841           or unset it will send Delete (code 127) or, with control, Backspace
842           (code 8) - which can be reversed with the appropriate DEC private
843           mode escape sequence.
844
845       deletekey: string
846           The string to send when the delete key (not the keypad delete key)
847           is pressed. If unset it will send the sequence traditionally
848           associated with the Execute key.
849
850       cutchars: string
851           The characters used as delimiters for double-click word selection
852           (whitespace delimiting is added automatically if resource is
853           given).
854
855           When the perl selection extension is in use (the default if
856           compiled in, see the urxvtperl(3) manpage), a suitable regex using
857           these characters will be created (if the resource exists,
858           otherwise, no regex will be created). In this mode, characters
859           outside ISO-8859-1 can be used.
860
861           When the selection extension is not used, only ISO-8859-1
862           characters can be used. If not specified, the built-in default is
863           used:
864
865           BACKSLASH `"'&()*,;<=>?@[]^{|}
866
867       preeditType: style
868           OnTheSpot, OverTheSpot, OffTheSpot, Root; option -pt.
869
870       inputMethod: name
871           name of inputMethod to use; option -im.
872
873       imLocale: name
874           The locale to use for opening the IM. You can use an "LC_CTYPE" of
875           e.g.  "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP"
876           for the input extension to be able to input japanese characters
877           while staying in another locale; option -imlocale.
878
879       imFont: fontset
880           Specify the font-set used for XIM styles "OverTheSpot" or
881           "OffTheSpot". It must be a standard X font set (XLFD patterns
882           separated by commas), i.e. it's not in the same format as the other
883           font lists used in urxvt. The default will be set-up to chose *any*
884           suitable found found, preferably one or two pixels differing in
885           size to the base font.  option -imfont.
886
887       tripleclickwords: boolean
888           Change the meaning of triple-click selection with the left mouse
889           button. Instead of selecting a full line it will extend the
890           selection to the end of the logical line only; option -tcw.
891
892       insecure: boolean
893           Enables "insecure" mode. Rxvt-unicode offers some escape sequences
894           that echo arbitrary strings like the icon name or the locale. This
895           could be abused if somebody gets 8-bit-clean access to your
896           display, whether through a mail client displaying mail bodies
897           unfiltered or through write(1) or any other means. Therefore, these
898           sequences are disabled by default. (Note that many other terminals,
899           including xterm, have these sequences enabled by default, which
900           doesn't make it safer, though).
901
902           You can enable them by setting this boolean resource or specifying
903           -insecure as an option. At the moment, this enables display-answer,
904           locale, findfont, icon label and window title requests.
905
906       modifier: modifier
907           Set the key to be interpreted as the Meta key to: alt, meta, hyper,
908           super, mod1, mod2, mod3, mod4, mod5; option -mod.
909
910       answerbackString: string
911           Specify the reply rxvt-unicode sends to the shell when an ENQ
912           (control-E) character is passed through. It may contain escape
913           values as described in the entry on keysym following.
914
915       secondaryScreen: boolean
916           Turn on/off secondary screen (default enabled).
917
918       secondaryScroll: boolean
919           Turn on/off secondary screen scroll (default enabled). If this
920           option is enabled, scrolls on the secondary screen will change the
921           scrollback buffer and, when secondaryScreen is off, switching
922           to/from the secondary screen will instead scroll the screen up.
923
924       hold: boolean
925           Turn on/off hold window after exit support. If enabled, urxvt will
926           not immediately destroy its window when the program executed within
927           it exits. Instead, it will wait till it is being killed or closed
928           by the user.
929
930       chdir: path
931           Sets the working directory for the shell (or the command specified
932           via -e). The path must be an absolute path and it must exist for
933           urxvt to start. If it isn't specified then the current working
934           directory will be used; option -cd.
935
936       keysym.sym: action
937           Compile frills: Associate action with keysym sym. The intervening
938           resource name keysym. cannot be omitted.
939
940           Using this resource, you can map key combinations such as
941           "Ctrl-Shift-BackSpace" to various actions, such as outputting a
942           different string than would normally result from that combination,
943           making the terminal scroll up or down the way you want it, or any
944           other thing an extension might provide.
945
946           The key combination that triggers the action, sym, has the
947           following format:
948
949              (modifiers-)key
950
951           Where modifiers can be any combination of the following full or
952           abbreviated modifier names:
953
954           ISOLevel3   I
955           AppKeypad   K
956           Control     C
957           NumLock     N
958           Shift       S
959           Meta        M or A
960           Lock        L
961           Mod1        1
962           Mod2        2
963           Mod3        3
964           Mod4        4
965           Mod5        5
966
967           The NumLock, Meta and ISOLevel3 modifiers are usually aliased to
968           whatever modifier the NumLock key, Meta/Alt keys or ISO Level3
969           Shift/AltGr keys are being mapped. AppKeypad is a synthetic
970           modifier mapped to the current application keymap mode state.
971
972           Due the the large number of modifier combinations, a key mapping
973           will match if at least the specified identifiers are being set, and
974           no other key mappings with those and more bits are being defined.
975           That means that defining a mapping for "a" will automatically
976           provide definitions for "Meta-a", "Shift-a" and so on, unless some
977           of those are defined mappings themselves. See the "builtin:"
978           action, below, for a way to work around this when this is a
979           problem.
980
981           The spelling of key depends on your implementation of X. An easy
982           way to find a key name is to use the xev(1) command. You can find a
983           list by looking for the "XK_" macros in the X11/keysymdef.h include
984           file (omit the "XK_" prefix). Alternatively you can specify key by
985           its hex keysym value (0x0000 - 0xFFFF).
986
987           As with any resource value, the action string may contain backslash
988           escape sequences ("\n": newline, "\\": backslash, "\000": octal
989           number), see RESOURCES in "man 7 X" for further details.
990
991           An action starts with an action prefix that selects a certain type
992           of action, followed by a colon. An action string without colons is
993           interpreted as a literal string to pass to the tty (as if it was
994           prefixed with "string:").
995
996           The following action prefixes are known - extensions can provide
997           additional prefixes:
998
999           string:STRING
1000               If the action starts with "string:" (or otherwise contains no
1001               colons), then the remaining "STRING" will be passed to the
1002               program running in the terminal. For example, you could replace
1003               whatever Shift-Tab outputs by the string "echo rm -rf /"
1004               followed by a newline:
1005
1006                  URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1007
1008               This could in theory be used to completely redefine your
1009               keymap.
1010
1011               In addition, for actions of this type, you can define a range
1012               of keysyms in one shot by loading the "keysym-list" perl
1013               extension and providing an action with pattern
1014               list/PREFIX/MIDDLE/SUFFIX, where the delimiter `/' should be a
1015               character not used by the strings.
1016
1017               Its usage can be demonstrated by an example:
1018
1019                 URxvt.keysym.M-C-0x61:    list|\033<|abc|>
1020
1021               The above line is equivalent to the following three lines:
1022
1023                 URxvt.keysym.Meta-Control-0x61:    string:\033<a>
1024                 URxvt.keysym.Meta-Control-0x62:    string:\033<b>
1025                 URxvt.keysym.Meta-Control-0x63:    string:\033<c>
1026
1027           command:STRING
1028               If action takes the form of "command:STRING", the specified
1029               STRING is interpreted and executed as urxvt's control sequence
1030               (basically the opposite of "string:" - instead of sending it to
1031               the program running in the terminal, it will be treated as if
1032               it were program output). This is most useful to feed command
1033               sequences into urxvt.
1034
1035               For example the following means "change the current locale to
1036               "zh_CN.GBK" when Control-Meta-c is being pressed":
1037
1038                 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1039
1040               The following example will map Control-Meta-1 and
1041               Control-Meta-2 to the fonts "suxuseuro" and "9x15bold", so you
1042               can have some limited font-switching at runtime:
1043
1044                 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1045                 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1046
1047               Other things are possible, e.g. resizing (see urxvt(7) for more
1048               info):
1049
1050                 URxvt.keysym.M-C-3: command:\033[8;25;80t
1051                 URxvt.keysym.M-C-4: command:\033[8;48;110t
1052
1053           builtin:
1054               The builtin action is the action that urxvt would execute if no
1055               key binding existed for the key combination. The obvious use is
1056               to undo the effect of existing bindings. The not so obvious use
1057               is to reinstate bindings when another binding overrides too
1058               many modifiers.
1059
1060               For example if you overwrite the "Insert" key you will disable
1061               urxvt's "Shift-Insert" mapping. To re-enable that, you can poke
1062               "holes" into the user-defined keymap using the "builtin:"
1063               replacement:
1064
1065                 URxvt.keysym.Insert: <my insert key sequence>
1066                 URxvt.keysym.S-Insert: builtin:
1067
1068               The first line defines a mapping for "Insert" and any
1069               combination of modifiers. The second line re-establishes the
1070               default mapping for "Shift-Insert".
1071
1072           builtin-string:
1073               This action is mainly useful to restore string mappings for
1074               keys that have predefined actions in urxvt. The exact semantics
1075               are a bit difficult to explain - basically, this action will
1076               send the string to the application that would be sent if urxvt
1077               wouldn't have a built-in action for it.
1078
1079               An example might make it clearer: urxvt normally pastes the
1080               selection when you press "Shift-Insert". With the following
1081               bindings, it would instead emit the (undocumented, but what
1082               applications running in the terminal might expect) sequence
1083               "ESC [ 2 $" instead:
1084
1085                  URxvt.keysym.S-Insert: builtin-string:
1086                  URxvt.keysym.C-S-Insert: builtin:
1087
1088               The first line disables the paste functionality for that key
1089               combination, and the second reinstates the default behaviour
1090               for "Control-Shift-Insert", which would otherwise be
1091               overridden.
1092
1093               Similarly, to let applications gain access to the "C-M-c" (copy
1094               to clipboard) and "C-M-v" (paste clipboard) key combination,
1095               you can do this:
1096
1097                  URxvt.keysym.C-M-c: builtin-string:
1098                  URxvt.keysym.C-M-v: builtin-string:
1099
1100           EXTENSION:STRING
1101               An action of this form invokes the action STRING, if any,
1102               provided by the urxvtperl(3) extension EXTENSION. The extension
1103               will be loaded automatically if necessary.
1104
1105               Not all extensions define actions, but popular extensions that
1106               do include the selection and matcher extensions (documented in
1107               their own manpages, urxvt-selection(1) and urxvt-matcher(1),
1108               respectively).
1109
1110               From the silly examples department, this will rot13-"encrypt"
1111               urxvt's selection when Alt-Control-c is pressed on typical PC
1112               keyboards:
1113
1114                 URxvt.keysym.M-C-c: selection:rot13
1115
1116           perl:STRING *DEPRECATED*
1117               This is a deprecated way of invoking commands provided by perl
1118               extensions. It is still supported, but should not be used
1119               anymore.
1120
1121       perl-ext-common: string
1122       perl-ext: string
1123           Comma-separated list(s) of perl extension scripts (default:
1124           "default") to use in this terminal instance; option -pe.
1125
1126           Extension names can be prefixed with a "-" sign to prohibit using
1127           them. This can be useful to selectively disable some extensions
1128           loaded by default, or specified via the "perl-ext-common" resource.
1129           For example, "default,-selection" will use all the default
1130           extensions except "selection".
1131
1132           The default set includes the "selection", "option-popup",
1133           "selection-popup", "readline" and "searchable-scrollback"
1134           extensions, and extensions which are mentioned in keysym resources.
1135
1136           Any extension such that a corresponding resource is given on the
1137           command line is automatically appended to perl-ext.
1138
1139           Each extension is looked up in the library directories, loaded if
1140           necessary, and bound to the current terminal instance. When the
1141           library search path contains multiple extension files of the same
1142           name, then the first one found will be used.
1143
1144           If both of these resources are the empty string, then the perl
1145           interpreter will not be initialized. The rationale for having two
1146           options is that perl-ext-common will be used for extensions that
1147           should be available to all instances, while perl-ext is used for
1148           specific instances.
1149
1150       perl-eval: string
1151           Perl code to be evaluated when all extensions have been registered.
1152           See the urxvtperl(3) manpage.
1153
1154       perl-lib: path
1155           Colon-separated list of additional directories that hold extension
1156           scripts. When looking for perl extensions, urxvt will first look in
1157           these directories, then in $URXVT_PERL_LIB, $HOME/.urxvt/ext and
1158           lastly in /usr/lib64/urxvt/perl/.
1159
1160           See the urxvtperl(3) manpage.
1161
1162       selection.pattern-idx: perl-regex
1163           Additional selection patterns, see the urxvtperl(3) manpage for
1164           details.
1165
1166       selection-autotransform.idx: perl-transform
1167           Selection auto-transform patterns, see the urxvtperl(3) manpage for
1168           details.
1169
1170       searchable-scrollback: keysym *DEPRECATED*
1171           This resource is deprecated and will be removed. Use a keysym
1172           resource instead, e.g.:
1173
1174              URxvt.keysym.M-s: searchable-scrollback:start
1175
1176       url-launcher: string
1177           Specifies the program to be started with a URL argument. Used by
1178           the "selection-popup" and "matcher" perl extensions.
1179
1180       transient-for: windowid
1181           Compile frills: Sets the WM_TRANSIENT_FOR property to the given
1182           window id.
1183
1184       override-redirect: boolean
1185           Compile frills: Sets override-redirect for the terminal window,
1186           making it almost invisible to window managers; option
1187           -override-redirect.
1188
1189       iso14755: boolean
1190           Turn on/off ISO 14755 (default enabled).
1191
1192       iso14755_52: boolean
1193           Turn on/off ISO 14755 5.2 mode (default enabled).
1194

THE SCROLLBAR

1196       Lines of text that scroll off the top of the urxvt window (resource:
1197       saveLines) and can be scrolled back using the scrollbar or by
1198       keystrokes. The normal urxvt scrollbar has arrows and its behaviour is
1199       fairly intuitive. The xterm-scrollbar is without arrows and its
1200       behaviour mimics that of xterm
1201
1202       Scroll down with Button1 (xterm-scrollbar) or Shift-Next.  Scroll up
1203       with Button3 (xterm-scrollbar) or Shift-Prior.  Continuous scroll with
1204       Button2.
1205

MOUSE REPORTING

1207       To temporarily override mouse reporting, for either the scrollbar or
1208       the normal text selection/insertion, hold either the Shift or the Meta
1209       (Alt) key while performing the desired mouse action.
1210
1211       If mouse reporting mode is active, the normal scrollbar actions are
1212       disabled -- on the assumption that we are using a fullscreen
1213       application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
1214       (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
1215       up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
1216

THE SELECTION: SELECTING AND PASTING TEXT

1218       The behaviour of text selection and insertion/pasting mechanism is
1219       similar to xterm(1).
1220
1221       Selecting:
1222           Left click at the beginning of the region, drag to the end of the
1223           region and release; Right click to extend the marked region; Left
1224           double-click to select a word; Left triple-click to select the
1225           entire logical line (which can span multiple screen lines), unless
1226           modified by resource tripleclickwords.
1227
1228           Starting a selection while pressing the Meta key (or Meta+Ctrl
1229           keys) (Compile: frills) will create a rectangular selection instead
1230           of a normal one. In this mode, every selected row becomes its own
1231           line in the selection, and trailing whitespace is visually
1232           underlined and removed from the selection.
1233
1234       Pasting:
1235           Pressing and releasing the Middle mouse button in an urxvt window
1236           causes the value of the PRIMARY selection (or CLIPBOARD with the
1237           Meta modifier) to be inserted as if it had been typed on the
1238           keyboard.
1239
1240           Pressing Shift-Insert causes the value of the PRIMARY selection to
1241           be inserted too.
1242
1243           rxvt-unicode also provides the bindings Ctrl-Meta-c and
1244           <Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1245           binding causes the value of the internal selection to be copied to
1246           the CLIPBOARD selection, while the second binding causes the value
1247           of the CLIPBOARD selection to be inserted.
1248

CHANGING FONTS

1250       Changing fonts (or font sizes, respectively) via the keypad is not yet
1251       supported in rxvt-unicode. Bug me if you need this.
1252
1253       You can, however, switch fonts at runtime using escape sequences, e.g.:
1254
1255          printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1256
1257       You can use keyboard shortcuts, too:
1258
1259          URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1260          URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1261
1262       rxvt-unicode will automatically re-apply these fonts to the output so
1263       far.
1264

ISO 14755 SUPPORT

1266       ISO 14755 is a standard for entering and viewing unicode characters and
1267       character codes using the keyboard. It consists of 4 parts. The first
1268       part is available if rxvt-unicode has been compiled with
1269       "--enable-frills", the rest is available when rxvt-unicode was compiled
1270       with "--enable-iso14755".
1271
1272       •   5.1: Basic method
1273
1274           This allows you to enter unicode characters using their hexcode.
1275
1276           Start by pressing and holding both "Control" and "Shift", then
1277           enter hex-digits (between one and six). Releasing "Control" and
1278           "Shift" will commit the character as if it were typed directly.
1279           While holding down "Control" and "Shift" you can also enter
1280           multiple characters by pressing "Space", which will commit the
1281           current character and lets you start a new one.
1282
1283           As an example of use, imagine a business card with a japanese
1284           e-mail address, which you cannot type. Fortunately, the card has
1285           the e-mail address printed as hexcodes, e.g. "671d 65e5". You can
1286           enter this easily by pressing "Control" and "Shift", followed by
1287           "6-7-1-D-SPACE-6-5-E-5", followed by releasing the modifier keys.
1288
1289       •   5.2: Keyboard symbols entry method
1290
1291           This mode lets you input characters representing the keycap symbols
1292           of your keyboard, if representable in the current locale encoding.
1293
1294           Start by pressing "Control" and "Shift" together, then releasing
1295           them. The next special key (cursor keys, home etc.) you enter will
1296           not invoke its usual function but instead will insert the
1297           corresponding keycap symbol. The symbol will only be entered when
1298           the key has been released, otherwise pressing e.g. "Shift" would
1299           enter the symbol for "ISO Level 2 Switch", although your intention
1300           might have been to enter a reverse tab (Shift-Tab).
1301
1302       •   5.3: Screen-selection entry method
1303
1304           While this is implemented already (it's basically the selection
1305           mechanism), it could be extended by displaying a unicode character
1306           map.
1307
1308       •   5.4: Feedback method for identifying displayed characters for later
1309           input
1310
1311           This method lets you display the unicode character code associated
1312           with characters already displayed.
1313
1314           You enter this mode by holding down "Control" and "Shift" together,
1315           then pressing and holding the left mouse button and moving around.
1316           The unicode hex code(s) (it might be a combining character) of the
1317           character under the pointer is displayed until you release
1318           "Control" and "Shift".
1319
1320           In addition to the hex codes it will display the font used to draw
1321           this character - due to implementation reasons, characters combined
1322           with combining characters, line drawing characters and unknown
1323           characters will always be drawn using the built-in support font.
1324
1325       With respect to conformance, rxvt-unicode is supposed to be compliant
1326       to both scenario A and B of ISO 14755, including part 5.2.
1327

LOGIN STAMP

1329       urxvt tries to write an entry into the utmp(5) file so that it can be
1330       seen via the who(1) command, and can accept messages.  To allow this
1331       feature, urxvt may need to be installed setuid root on some systems or
1332       setgid to root or to some other group on others.
1333

COLOURS AND GRAPHICS

1335       In addition to the default foreground and background colours, urxvt can
1336       display up to 88/256 colours: 8 ANSI colours plus high-intensity
1337       (potentially bold/blink) versions of the same, and 72 (or 240 in 256
1338       colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB cube
1339       plus a 8 (24) colour greyscale ramp.
1340
1341       urxvt supports direct 24-bit fg/bg RGB colour escapes " ESC [ 38 ; 2 ;
1342       R ; G ; Bm " / " ESC [ 48 ; 2; R ; G ; Bm ". However the number of
1343       24-bit colours that can be used is limited: an internal 7x7x5 (256
1344       colour mode) or 6x6x4 (88 colour mode) colour cube is used to index
1345       into the 24-bit colour space. When indexing collisions happen, the
1346       nearest old colour in the cube will be adapted to the new 24-bit RGB
1347       colour. That means one cannot use many similar 24-bit colours. It's
1348       typically not a problem in common scenarios.
1349
1350       Here is a list of the ANSI colours with their names.
1351
1352       color0       (black)            = Black
1353       color1       (red)              = Red3
1354       color2       (green)            = Green3
1355       color3       (yellow)           = Yellow3
1356       color4       (blue)             = Blue3
1357       color5       (magenta)          = Magenta3
1358       color6       (cyan)             = Cyan3
1359       color7       (white)            = AntiqueWhite
1360       color8       (bright black)     = Grey25
1361       color9       (bright red)       = Red
1362       color10      (bright green)     = Green
1363       color11      (bright yellow)    = Yellow
1364       color12      (bright blue)      = Blue
1365       color13      (bright magenta)   = Magenta
1366       color14      (bright cyan)      = Cyan
1367       color15      (bright white)     = White
1368       foreground                      = Black
1369       background                      = White
1370
1371       It is also possible to specify the colour values of foreground,
1372       background, cursorColor, cursorColor2, colorBD, colorUL as a number
1373       0-15, as a convenient shorthand to reference the colour name of
1374       color0-color15.
1375
1376       The following text gives values for the standard 88 colour mode (and
1377       values for the 256 colour mode in parentheses).
1378
1379       The RGB cube uses indices 16..79 (16..231) using the following
1380       formulas:
1381
1382          index_88  = (r * 4 + g) * 4 + b + 16   # r, g, b = 0..3
1383          index_256 = (r * 6 + g) * 6 + b + 16   # r, g, b = 0..5
1384
1385       The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in
1386       10% steps (1/26 to 25/26 in 1/26 steps) - black and white are already
1387       part of the RGB cube.
1388
1389       Together, all those colours implement the 88 (256) colour xterm
1390       colours. Only the first 16 can be changed using resources currently,
1391       the rest can only be changed via command sequences ("escape codes").
1392
1393       Applications are advised to use terminfo or command sequences to
1394       discover number and RGB values of all colours (yes, you can query
1395       this...).
1396
1397       Note that -rv ("reverseVideo: True") simulates reverse video by always
1398       swapping the foreground/background colours. This is in contrast to
1399       xterm(1) where the colours are only swapped if they have not otherwise
1400       been specified. For example,
1401
1402          urxvt -fg Black -bg White -rv
1403
1404       would yield White on Black, while on xterm(1) it would yield Black on
1405       White.
1406
1407   ALPHA CHANNEL SUPPORT
1408       If Xft support has been compiled in and as long as Xft/Xrender/X don't
1409       get their act together, rxvt-unicode will do its own alpha channel
1410       management:
1411
1412       You can prefix any colour with an opaqueness percentage enclosed in
1413       brackets, i.e. "[percent]", where "percent" is a decimal percentage
1414       (0-100) that specifies the opacity of the colour, where 0 is completely
1415       transparent and 100 is completely opaque. For example, "[50]red" is a
1416       half-transparent red, while "[95]#00ff00" is an almost opaque green.
1417       This is the recommended format to specify transparency values, and
1418       works with all ways to specify a colour.
1419
1420       For complete control, rxvt-unicode also supports
1421       "rgba:rrrr/gggg/bbbb/aaaa" (exactly four hex digits/component) colour
1422       specifications, where the additional "aaaa" component specifies opacity
1423       (alpha) values. The minimum value of 0000 is completely transparent,
1424       while "ffff" is completely opaque). The two example colours from
1425       earlier could also be specified as "rgba:ff00/0000/0000/8000" and
1426       "rgba:0000/ff00/0000/f332".
1427
1428       You probably need to specify "-depth 32", too, to force a visual with
1429       alpha channels, and have the luck that your X-server uses ARGB pixel
1430       layout, as X is far from just supporting ARGB visuals out of the box,
1431       and rxvt-unicode just fudges around.
1432
1433       For example, the following selects an almost completely transparent
1434       black background, and an almost opaque pink foreground:
1435
1436          urxvt -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1437
1438       When not using a background image, then the interpretation of the alpha
1439       channel is up to your compositing manager (most interpret it as
1440       transparency of course).
1441
1442       When using a background pixmap or pseudo-transparency, then the
1443       background colour will always behave as if it were completely
1444       transparent (so the background image shows instead), regardless of how
1445       it was specified, while other colours will either be transparent as
1446       specified (the background image will show through) on servers
1447       supporting the RENDER extension, or fully opaque on servers not
1448       supporting the RENDER EXTENSION.
1449
1450       Please note that due to bugs in Xft, specifying alpha values might
1451       result in garbage being displayed when the X-server does not support
1452       the RENDER extension.
1453

ENVIRONMENT

1455       urxvt sets and/or uses the following environment variables:
1456
1457       TERM
1458           Normally set to "rxvt-unicode", unless overwritten at configure
1459           time, via resources or on the command line.
1460
1461       COLORTERM
1462           Either "rxvt", "rxvt-xpm", depending on whether urxvt was compiled
1463           with background image support, and optionally with the added
1464           extension "-mono" to indicate that rxvt-unicode runs on a
1465           monochrome screen.
1466
1467       COLORFGBG
1468           Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
1469           the colour code used as default foreground/text colour (or the
1470           string "default" to indicate that the default-colour escape
1471           sequence is to be used), "bg" is the colour code used as default
1472           background colour (or the string "default"), and "xpm" is the
1473           string "default" if urxvt was compiled with background image
1474           support. Libraries like "ncurses" and "slang" can (and do) use this
1475           information to optimize screen output.
1476
1477       WINDOWID
1478           Set to the (decimal) X Window ID of the urxvt window (the toplevel
1479           window, which usually has subwindows for the scrollbar, the
1480           terminal window and so on).
1481
1482       TERMINFO
1483           Set to the terminfo directory iff urxvt was configured with
1484           "--with-terminfo=PATH".
1485
1486       DISPLAY
1487           Used by urxvt to connect to the display and set to the correct
1488           display in its child processes if "-display" isn't used to
1489           override. It defaults to ":0" if it doesn't exist.
1490
1491       SHELL
1492           The shell to be used for command execution, defaults to "/bin/sh".
1493
1494       RXVT_SOCKET [sic]
1495           The unix domain socket path used by urxvtc(1) and urxvtd(1).
1496
1497           Default $HOME/.urxvt/urxvtd-<nodename>.
1498
1499       URXVT_PERL_LIB
1500           Additional :-separated library search path for perl extensions.
1501           Will be searched after -perl-lib but before ~/.urxvt/ext and the
1502           system library directory.
1503
1504       URXVT_PERL_VERBOSITY
1505           See urxvtperl(3).
1506
1507       HOME
1508           Used to locate the default directory for the unix domain socket for
1509           daemon communications and to locate various resource files (such as
1510           ".Xdefaults")
1511
1512       XAPPLRESDIR
1513           Directory where application-specific X resource files are located.
1514
1515       XENVIRONMENT
1516           If set and accessible, gives the name of a X resource file to be
1517           loaded by urxvt.
1518

FILES

1520       /usr/lib/X11/rgb.txt
1521           Colour names.
1522

SEE ALSO

1524       urxvt(7), urxvtc(1), urxvtd(1), urxvt-extensions(1), urxvtperl(3),
1525       xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1526

CURRENT PROJECT COORDINATOR

1528       Project Coordinator
1529           Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1530
1531           <http://software.schmorp.de/pkg/rxvt-unicode.html>
1532

AUTHORS

1534       John Bovey
1535           University of Kent, 1992, wrote the original Xvt.
1536
1537       Rob Nation <nation@rocket.sanders.lockheed.com>
1538           very heavily modified Xvt and came up with Rxvt
1539
1540       Angelo Haritsis <ah@doc.ic.ac.uk>
1541           wrote the Greek Keyboard Input (no longer in code)
1542
1543       mj olesen <olesen@me.QueensU.CA>
1544           Wrote the menu system.
1545
1546           Project Coordinator (changes.txt 2.11 to 2.21)
1547
1548       Oezguer Kesim <kesim@math.fu-berlin.de>
1549           Project Coordinator (changes.txt 2.21a to 2.4.5)
1550
1551       Geoff Wing <gcw@pobox.com>
1552           Rewrote screen display and text selection routines.
1553
1554           Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1555
1556       Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1557           Forked rxvt-unicode, unicode support, rewrote almost all the code,
1558           perl extension, random hacks, numerous bugfixes and extensions.
1559
1560           Project Coordinator (Changes 1.0 -)
1561
1562       Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1563           pty/utmp code rewrite, image code improvements, many random hacks
1564           and bugfixes.
1565
1566
1567
15689.26                              2021-05-14                          urxvt(1)
Impressum