ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.txt
Revision: 1.71
Committed: Fri Nov 23 13:11:31 2007 UTC (16 years, 6 months ago) by root
Content type: text/plain
Branch: MAIN
CVS Tags: rel-8_6, rel-8_7
Changes since 1.70: +15 -1 lines
Log Message:
*** empty log message ***

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