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