ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/cvsroot/rxvt-unicode/doc/rxvt.1.txt
Revision: 1.68
Committed: Wed Aug 1 18:38:15 2007 UTC (16 years, 11 months ago) by root
Content type: text/plain
Branch: MAIN
CVS Tags: rel-8_3
Changes since 1.67: +16 -9 lines
Log Message:
fix lots of configure bugs

File Contents

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