ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.txt
Revision: 1.67
Committed: Sun Jun 24 22:12:18 2007 UTC (16 years, 11 months ago) by root
Content type: text/plain
Branch: MAIN
Changes since 1.66: +64 -18 lines
Log Message:
use pod2xhtml and our stylesheet

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