ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.pod
Revision: 1.85
Committed: Wed Jan 4 20:43:37 2006 UTC (18 years, 6 months ago) by root
Branch: MAIN
CVS Tags: rel-6_3
Changes since 1.84: +20 -6 lines
Log Message:
*** empty log message ***

File Contents

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