ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.txt
Revision: 1.70
Committed: Mon Nov 19 12:02:35 2007 UTC (16 years, 7 months ago) by root
Content type: text/plain
Branch: MAIN
CVS Tags: rel-8_5a
Changes since 1.69: +115 -105 lines
Log Message:
*** empty log message ***

File Contents

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