ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.2 by root, Thu Aug 12 21:30:14 2004 UTC vs.
Revision 1.65 by root, Thu Jun 30 14:00:49 2005 UTC

6 6
7B<@@RXVT_NAME@@> [options] [-e command [ args ]] 7B<@@RXVT_NAME@@> [options] [-e command [ args ]]
8 8
9=head1 DESCRIPTION 9=head1 DESCRIPTION
10 10
11B<rxvt-unicode>, version B<@@RXVTVERSION@@>, is a colour vt102 terminal 11B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal
12emulator intended as an I<xterm>(1) replacement for users who do not 12emulator intended as an I<xterm>(1) replacement for users who do not
13require features such as Tektronix 4014 emulation and toolkit-style 13require features such as Tektronix 4014 emulation and toolkit-style
14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16 16
17See also @@RXVT_NAME@@(7) for technical reference documentation (escape 17=head1 FREQUENTLY ASKED QUESTIONS
18sequences etc.). 18
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
23
24=head1 RXVT-UNICODE VS. RXVT
25
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the
28world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are left-to-right scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might
37change.
38
39If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very userfriendly, lean and clean
41terminal emulator. In fact, the reason rxvt-unicode was born was solely
42because the author couldn't get C<mlterm> to use one font for latin1 and
43another for japanese.
44
45Therefore another design rationale was the use of multiple fonts to
46display characters: The idea of a single unicode font which many other
47programs force onto it's users never made sense to me: You should be able
48to choose any font for any script freely.
49
50Apart from that, rxvt-unicode is also much better internationalised than
51it's predecessor, supports things such as XFT and ISO 14755 that are handy
52in i18n-environments, is faster, and has a lot less bugs than the original
53rxvt. This all in addition to dozens of other small improvements.
54
55It is still faithfully following the original rxvt idea of being lean
56and nice on resources: for example, you can still configure rxvt-unicode
57without most of it's features to get a lean binary. It also comes with
58a client/daemon pair that lets you open any number of terminal windows
59from within a single process, which makes startup time very fast and
60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61@@RXVT_NAME@@c(1) (client).
62
63It also makes technical information about escape sequences (which have
64been extended) easier accessible: see @@RXVT_NAME@@(7) for technical
65reference documentation (escape sequences etc.).
19 66
20=head1 OPTIONS 67=head1 OPTIONS
21 68
22The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed 69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
23below. In keeping with the smaller-is-better philosophy, options may be 70below. In keeping with the smaller-is-better philosophy, options may be
24eliminated or default values chosen at compile-time, so options and 71eliminated or default values chosen at compile-time, so options and
25defaults listed may not accurately reflect the version installed on 72defaults listed may not accurately reflect the version installed on
26your system. `rxvt -h' gives a list of major compile-time options on 73your system. `@@RXVT_NAME@@ -h' gives a list of major compile-time options on
27the I<Options> line. Option descriptions may be prefixed with which 74the I<Options> line. Option descriptions may be prefixed with which
28compile option each is dependent upon. e.g. `Compile I<XIM>:' requires 75compile option each is dependent upon. e.g. `Compile I<XIM>:' requires
29I<XIM> on the I<Options> line. Note: `rxvt -help' gives a list of all 76I<XIM> on the I<Options> line. Note: `@@RXVT_NAME@@ -help' gives a list of all
30command-line options compiled into your version. 77command-line options compiled into your version.
31 78
32Note that B<@@RXVT_NAME@@> permits the resource name to be used as a 79Note that B<@@RXVT_NAME@@> permits the resource name to be used as a
33long-option (--/++ option) so the potential command-line options are 80long-option (--/++ option) so the potential command-line options are
34far greater than those listed. For example: `rxvt --loginShell --color1 81far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1
35Orange'. 82Orange'.
36 83
37The following options are available: 84The following options are available:
38 85
39=over 4 86=over 4
65Turn on/off inheriting parent window's pixmap. Alternative form is 112Turn on/off inheriting parent window's pixmap. Alternative form is
66B<-tr>; resource B<inheritPixmap>. 113B<-tr>; resource B<inheritPixmap>.
67 114
68=item B<-fade> I<number> 115=item B<-fade> I<number>
69 116
70Fade the text by the given percentage when focus is lost. 117Fade the text by the given percentage when focus is lost. resource B<fading>.
71 118
72=item B<-tint> I<colour> 119=item B<-tint> I<colour>
73 120
74Tint the transparent background pixmap with the given colour when 121Tint the transparent background pixmap with the given colour when
75transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> 122transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>
78 125
79=item B<-sh> 126=item B<-sh>
80 127
81I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 128I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
82background image in addition to tinting it (i.e. B<-tint> must be 129background image in addition to tinting it (i.e. B<-tint> must be
83specified, too). 130specified, too, e.g. C<-tint white>).
84 131
85=item B<-bg> I<colour> 132=item B<-bg> I<colour>
86 133
87Window background colour; resource B<background>. 134Window background colour; resource B<background>.
88 135
91Window foreground colour; resource B<foreground>. 138Window foreground colour; resource B<foreground>.
92 139
93=item B<-pixmap> I<file[;geom]> 140=item B<-pixmap> I<file[;geom]>
94 141
95Compile I<XPM>: Specify XPM file for the background and also optionally 142Compile I<XPM>: Specify XPM file for the background and also optionally
96specify its scaling with a geometry string. Note you may need to add 143specify its scaling with a geometry string. Note you may need to
97quotes to avoid special shell interpretation of the `;' in the 144add quotes to avoid special shell interpretation of the C<;> in the
98command-line; resource B<backgroundPixmap>. 145command-line; resource B<backgroundPixmap>.
99 146
100=item B<-cr> I<colour> 147=item B<-cr> I<colour>
101 148
102The cursor colour; resource B<cursorColor>. 149The cursor colour; resource B<cursorColor>.
109 156
110The mouse pointer background colour; resource B<pointerColor2>. 157The mouse pointer background colour; resource B<pointerColor2>.
111 158
112=item B<-bd> I<colour> 159=item B<-bd> I<colour>
113 160
114The colour of the border between the xterm scrollbar and the text; 161The colour of the border around the text area and between the scrollbar and the text;
115resource B<borderColor>. 162resource B<borderColor>.
116 163
117=item B<-fn> I<fontname> 164=item B<-fn> I<fontlist>
118 165
119Select the fonts to be used. This is a comma seperated list of font 166Select the fonts to be used. This is a comma separated list of font names
120names that are used in turn when trying to display Unicode characters. 167that are used in turn when trying to display Unicode characters. The
121The first font defines the cell size for characters; other fonts might 168first font defines the cell size for characters; other fonts might be
122be smaller, but not larger. A reasonable default font list is always 169smaller, but not (in general) larger. A (hopefully) reasonable default
123appended to it. resource B<font>. 170font list is always appended to it. See resource B<font> for more details.
124 171
125=item B<-rb>|B<+rb> 172In short, to specify an X11 core font, just specify it's name or prefix it
173with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
174e.g.:
126 175
127Enable "real bold" support. When this option is on, bold text will be 176 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
128displayed using the first available bold font in the font list. Bold 177 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
129fonts should thus be specified in the font list after their 178
130corresponding regular fonts. If no bold font can be found, a regular 179See also the question "How does rxvt-unicode choose fonts?" in the FAQ
131font will be used. resource B<realBold>. 180section of @@RXVT_NAME@@(7).
181
182=item B<-fb> I<fontlist>
183
184Compile font-styles: The bold font list to use when bold characters are to
185be printed. See resource B<boldFont> for details.
186
187=item B<-fi> I<fontlist>
188
189Compile font-styles: The italic font list to use when bold characters are to
190be printed. See resource B<italicFont> for details.
191
192=item B<-fbi> I<fontlist>
193
194Compile font-styles: The bold italic font list to use when bold characters are to
195be printed. See resource B<boldItalicFont> for details.
132 196
133=item B<-name> I<name> 197=item B<-name> I<name>
134 198
135Specify the application name under which resources are to be obtained, 199Specify the application name under which resources are to be obtained,
136rather than the default executable file name. Name should not contain 200rather than the default executable file name. Name should not contain
174 238
175Put scrollbar on right/left; resource B<scrollBar_right>. 239Put scrollbar on right/left; resource B<scrollBar_right>.
176 240
177=item B<-st>|B<+st> 241=item B<-st>|B<+st>
178 242
179Display normal (non XTerm/NeXT) scrollbar without/with a trough; 243Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
180resource B<scrollBar_floating>. 244resource B<scrollBar_floating>.
245
246=item B<-ptab>|B<+ptab>
247
248If enabled (default), "Horizontal Tab" characters are being stored as
249actual wide characters in the screen buffer, which makes it possible to
250select and paste them. Since a horizontal tab is a cursor movement and
251not an actual glyph, this can sometimes be visually annoying as the cursor
252on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
181 253
182=item B<-bc>|B<+bc> 254=item B<-bc>|B<+bc>
183 255
184Blink the cursor; resource B<cursorBlink>. 256Blink the cursor; resource B<cursorBlink>.
185 257
205B<externalBorder>. 277B<externalBorder>.
206 278
207=item B<-bl> 279=item B<-bl>
208 280
209Compile I<frills>: Set MWM hints to request a borderless window, i.e. 281Compile I<frills>: Set MWM hints to request a borderless window, i.e.
210if honoured by the WM, the rxvt window will not have window 282if honoured by the WM, the rxvt-unicode window will not have window
211decorations; resource B<borderLess>. 283decorations; resource B<borderLess>.
212 284
213=item B<-lsp> I<number> 285=item B<-lsp> I<number>
214 286
215Compile I<linespace>: Lines (pixel height) to insert between each row 287Compile I<frills>: Lines (pixel height) to insert between each row of
216of the display; resource B<linespace>. 288the display. Useful to work around font rendering problems; resource
289B<linespace>.
217 290
218=item B<-tn> I<termname> 291=item B<-tn> I<termname>
219 292
220This option specifies the name of the terminal type to be set in the 293This option specifies the name of the terminal type to be set in the
221B<TERM> environment variable. This terminal type must exist in the 294B<TERM> environment variable. This terminal type must exist in the
257 330
258Compile I<XIM>: input method name. resource B<inputMethod>. 331Compile I<XIM>: input method name. resource B<inputMethod>.
259 332
260=item B<-imlocale> I<string> 333=item B<-imlocale> I<string>
261 334
262The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 335The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
263de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 336C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
264extension to be able to input japanese characters while staying in 337input extension to be able to input japanese characters while staying in
265another locale. 338another locale. resource B<imLocale>.
339
340=item B<-imfont> I<fontset>
341
342Set the font set to use for the X Input Method, see resource B<imFont>
343for more info.
344
345=item B<-tcw>
346
347Change the meaning of triple-click selection with the left mouse
348button. Instead of selecting a full line it will extend the selection the
349end of the logical line only. resource B<tripleclickwords>.
266 350
267=item B<-insecure> 351=item B<-insecure>
268 352
269Enable "insecure" mode, which currently enables most of the escape 353Enable "insecure" mode, which currently enables most of the escape
270sequences that echo strings. See the resource B<insecure> for more 354sequences that echo strings. See the resource B<insecure> for more
284=item B<-ssr>|B<+ssr> 368=item B<-ssr>|B<+ssr>
285 369
286Turn on/off secondary screen scroll (default enabled); resource 370Turn on/off secondary screen scroll (default enabled); resource
287B<secondaryScroll>. 371B<secondaryScroll>.
288 372
289=item B<-xrm> I<resourcestring> 373=item B<-keysym.>I<sym> I<string>
290 374
291No effect on rxvt. Simply passes through an argument to be made 375Remap a key symbol. See resource B<keysym>.
292available in the instance's argument list. Appears in I<WM_COMMAND> in 376
293some window managers. 377=item B<-embed> I<windowid>
378
379Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
380which enables applications to easily embed a terminal.
381
382Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
383shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
384quite a bit, so don't expect it to keep some specific state. It's best to
385create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
386
387The window will not be destroyed when @@RXVT_NAME@@ exits.
388
389It might be useful to know that @@RXVT_NAME@@ will not close file
390descriptors passed to it (except for stdin/out/err, of course), so you
391can use file descriptors to communicate with the programs within the
392terminal. This works regardless of wether the C<-embed> option was used or
393not.
394
395Here is a short Gtk2-perl snippet that illustrates how this option can be
396used (a longer example is in F<doc/embed>):
397
398 my $rxvt = new Gtk2::Socket;
399 $rxvt->signal_connect_after (realize => sub {
400 my $xid = $_[0]->window->get_xid;
401 system "@@RXVT_NAME@@ -embed $xid &";
402 });
403
404=item B<-pty-fd> I<fileno>
405
406Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
407pair but instead use the given filehandle as the tty master. This is
408useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
409without having to run a program within it.
410
411If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
412entries and will not tinker with pty/tty permissions - you have to do that
413yourself if you want that.
414
415Here is a example in perl that illustrates how this option can be used (a
416longer example is in F<doc/pty-fd>):
417
418 use IO::Pty;
419 use Fcntl;
420
421 my $pty = new IO::Pty;
422 fcntl $pty, F_SETFD, 0; # clear close-on-exec
423 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
424 close $pty;
425
426 # now communicate with rxvt
427 my $slave = $pty->slave;
428 while (<$slave>) { print $slave "got <$_>\n" }
294 429
295=back 430=back
296 431
297=head1 RESOURCES (available also as long-options) 432=head1 RESOURCES (available also as long-options)
298 433
301 436
302There are two different methods that @@RXVT_NAME@@ can use to get the 437There are two different methods that @@RXVT_NAME@@ can use to get the
303Xresource data: using the X libraries (Xrm*-functions) or internal 438Xresource data: using the X libraries (Xrm*-functions) or internal
304Xresources reader (B<~/.Xdefaults>). For the first method (ie. 439Xresources reader (B<~/.Xdefaults>). For the first method (ie.
305B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 440B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
306resources using X11 tools like B<xset>. Many distribution do also load 441resources using X11 tools like B<xrdb>. Many distribution do also load
307settings from the B<~/.Xresources> file when X starts. 442settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
443will consult the following files/resources in order, with later settings
444overwriting earlier ones:
445
446 1. system-wide app-defaults file, either locale-dependent OR global
447 2. app-defaults file in $XAPPLRESDIR
448 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
449 4. SCREEN_RESOURCES for the current screen
450 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
308 451
309If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 452If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
310lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 453lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
311set in XAPPLOADDIR/URxvt (compile-time defined: usually 454set in XAPPLOADDIR/URxvt (compile-time defined: usually
312B</usr/lib/X11/app-defaults/URxvt>) and resources set in 455B</usr/lib/X11/app-defaults/URxvt>) and resources set in
345high-intensity (bold = bright foreground, blink = bright background) 488high-intensity (bold = bright foreground, blink = bright background)
346colours. The canonical names are as follows: 0=black, 1=red, 2=green, 489colours. The canonical names are as follows: 0=black, 1=red, 2=green,
3473=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 4903=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
348names used are listed in the B<COLORS AND GRAPHICS> section. 491names used are listed in the B<COLORS AND GRAPHICS> section.
349 492
493Colours higher than 15 cannot be set using resources (yet), but can be
494changed using an escape command (see @@RXVT_NAME@@(7)).
495
496Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
49788 colour support). Colours 80-87 are evenly spaces grey steps.
498
350=item B<colorBD:> I<colour> 499=item B<colorBD:> I<colour>
351 500
501=item B<colorIT:> I<colour>
502
352Use the specified colour to display bold characters when the foreground 503Use the specified colour to display bold or italic characters when the
353colour is the default. This option will be ignored if B<realBold> is 504foreground colour is the default. If font styles are not available
354enabled. 505(Compile I<styles>) and this option is unset, reverse video is used instead.
355 506
356=item B<colorUL:> I<colour> 507=item B<colorUL:> I<colour>
357 508
358Use the specified colour to display underlined characters when the 509Use the specified colour to display underlined characters when the
359foreground colour is the default. 510foreground colour is the default.
360 511
361=item B<colorRV:> I<colour> 512=item B<colorRV:> I<colour>
362 513
363Use the specified colour as the background for reverse video 514Use the specified colour as the background for reverse video
364characters. 515characters.
516
517=item B<underlineColor:> I<colour>
518
519If set, use the specified colour as the colour for the underline
520itself. If unset, use the foreground colour.
365 521
366=item B<cursorColor:> I<colour> 522=item B<cursorColor:> I<colour>
367 523
368Use the specified colour for the cursor. The default is to use the 524Use the specified colour for the cursor. The default is to use the
369foreground colour; option B<-cr>. 525foreground colour; option B<-cr>.
403=item B<shading:> I<number> 559=item B<shading:> I<number>
404 560
405Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 561Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
406image in addition to tinting it. 562image in addition to tinting it.
407 563
408=item B<fading:> I<number>
409
410Scale the tint colour by the given percentage.
411
412=item B<scrollColor:> I<colour> 564=item B<scrollColor:> I<colour>
413 565
414Use the specified colour for the scrollbar [default #B2B2B2]. 566Use the specified colour for the scrollbar [default #B2B2B2].
415 567
416=item B<troughColor:> I<colour> 568=item B<troughColor:> I<colour>
417 569
418Use the specified colour for the scrollbar's trough area [default 570Use the specified colour for the scrollbar's trough area [default
419#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 571#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
572
573=item B<borderColor:> I<colour>
574
575The colour of the border around the text area and between the scrollbar
576and the text.
420 577
421=item B<backgroundPixmap:> I<file[;geom]> 578=item B<backgroundPixmap:> I<file[;geom]>
422 579
423Use the specified XPM file (note the `.xpm' extension is optional) for 580Use the specified XPM file (note the `.xpm' extension is optional) for
424the background and also optionally specify its scaling with a geometry 581the background and also optionally specify its scaling with a geometry
440 597
441Specify the colon-delimited search path for finding files (XPM and 598Specify the colon-delimited search path for finding files (XPM and
442menus), in addition to the paths specified by the B<RXVTPATH> and 599menus), in addition to the paths specified by the B<RXVTPATH> and
443B<PATH> environment variables. 600B<PATH> environment variables.
444 601
445=item B<font:> I<fontname> 602=item B<font:> I<fontlist>
446 603
447Select the fonts to be used. This is a comma seperated list of font 604Select the fonts to be used. This is a comma separated list of font
448names that are used in turn when trying to display Unicode characters. 605names that are used in turn when trying to display Unicode characters.
449The first font defines the cell size for characters; other fonts might 606The first font defines the cell size for characters; other fonts might
450be smaller, but not larger. A reasonable default font list is always 607be smaller, but not larger. A reasonable default font list is always
451appended to it. option B<-fn>. 608appended to it. option B<-fn>.
452 609
453=item B<realBold:> I<boolean> 610Each font can either be a standard X11 core font (XLFD) name, with
611optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
454 612
455B<True>: Enable "real bold" support. When this option is on, bold text 613In addition, each font can be prefixed with additional hints and
456will be displayed using the first available bold font in the font list. 614specifications enclosed in square brackets (C<[]>). The only available
457Bold fonts should thus be specified in the font list after their 615hint currently is C<codeset=codeset-name>, and this is only used for Xft
458corresponding regular fonts. If no bold font can be found, a regular 616fonts.
459font will be used. option B<-rb>. B<False>: Display bold text in a 617
460regular font, using the color specified with B<colorBD>; option B<+rb>. 618For example, this font resource
619
620 URxvt*font: 9x15bold,\
621 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
622 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
623 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
624 xft:Code2000:antialias=false
625
626specifies five fonts to be used. The first one is C<9x15bold> (actually
627the iso8859-1 version of the second font), which is the base font (because
628it is named first) and thus defines the character cell grid to be 9 pixels
629wide and 15 pixels high.
630
631The second font is just used to add additional unicode characters not in
632the base font, likewise the third, which is unfortunately non-bold, but
633the bold version of the font does contain less characters, so this is a
634useful supplement.
635
636The third font is an Xft font with aliasing turned off, and the characters
637are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
638contains other characters, but we are not interested in them.
639
640The last font is a useful catch-all font that supplies most of the
641remaining unicode characters.
642
643=item B<boldFont:> I<fontlist>
644
645=item B<italicFont:> I<fontlist>
646
647=item B<boldItalicFont:> I<fontlist>
648
649The font list to use for displaying B<bold>, I<italic> or B<< I<bold
650italic> >> characters, respectively.
651
652If specified and non-empty, then the syntax is the same as for the
653B<font>-resource, and the given font list will be used as is, which makes
654it possible to substitute completely different font styles for bold and
655italic.
656
657If unset (the default), a suitable font list will be synthesized by
658"morphing" the normal text font list into the desired shape. If that is
659not possible, replacement fonts of the desired shape will be tried.
660
661If set, but empty, then this specific style is disabled and the normal
662text font will being used for the given style.
461 663
462=item B<selectstyle:> I<mode> 664=item B<selectstyle:> I<mode>
463 665
464Set mouse selection style to B<old> which is 2.20, B<oldword> which is 666Set mouse selection style to B<old> which is 2.20, B<oldword> which is
465xterm style with 2.20 old word selection, or anything else which gives 667xterm style with 2.20 old word selection, or anything else which gives
466xterm style selection. 668xterm style selection.
467 669
468=item B<scrollstyle:> I<mode> 670=item B<scrollstyle:> I<mode>
469 671
470Set scrollbar style to B<@@RXVT_NAME@@>, B<rxvt>, B<plain>, B<next> or 672Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
471B<xterm> 673the author's favourite.
472 674
473=item B<title:> I<string> 675=item B<title:> I<string>
474 676
475Set window title string, the default title is the command-line 677Set window title string, the default title is the command-line
476specified after the B<-e> option, if any, otherwise the application 678specified after the B<-e> option, if any, otherwise the application
508 710
509Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 711Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
510B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 712B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
511B<Shift-Print> to include the scrollback as well. 713B<Shift-Print> to include the scrollback as well.
512 714
715The string will be interpreted as if typed into the shell as-is.
716
513=item B<scrollBar:> I<boolean> 717=item B<scrollBar:> I<boolean>
514 718
515B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 719B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
516disable the scrollbar; option B<+sb>. 720disable the scrollbar; option B<+sb>.
517 721
530Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar 734Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar
531thumb with the pointer on middle button press/drag. 735thumb with the pointer on middle button press/drag.
532 736
533=item B<scrollTtyOutput:> I<boolean> 737=item B<scrollTtyOutput:> I<boolean>
534 738
535B<True>: scroll to bottom when tty receives output; option B<+si>. 739B<True>: scroll to bottom when tty receives output; option B<-si>.
536B<False>: do not scroll to bottom when tty receives output; option 740B<False>: do not scroll to bottom when tty receives output; option
537B<-si>. 741B<+si>.
538 742
539=item B<scrollWithBuffer:> I<boolean> 743=item B<scrollWithBuffer:> I<boolean>
540 744
541B<True>: scroll with scrollback buffer when tty recieves new lines (and 745B<True>: scroll with scrollback buffer when tty receives new lines (and
542B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 746B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
543with scrollback buffer when tty recieves new lines; option B<-sw>. 747with scrollback buffer when tty recieves new lines; option B<+sw>.
544 748
545=item B<scrollTtyKeypress:> I<boolean> 749=item B<scrollTtyKeypress:> I<boolean>
546 750
547B<True>: scroll to bottom when a non-special key is pressed. Special 751B<True>: scroll to bottom when a non-special key is pressed. Special keys
548keys are those which are intercepted by rxvt for special handling and 752are those which are intercepted by rxvt-unicode for special handling and
549are not passed onto the shell; option B<-sk>. B<False>: do not scroll 753are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
550to bottom when a non-special key is pressed; option B<+sk>. 754bottom when a non-special key is pressed; option B<+sk>.
551
552=item B<smallfont_key:> I<keysym>
553
554If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a smaller font
555[default B<@@HOTKEY@@-@@SMALLFONT@@>]
556
557=item B<bigfont_key:> I<keysym>
558
559If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a bigger font
560[default B<@@HOTKEY@@-@@BIGFONT@@>]
561 755
562=item B<saveLines:> I<number> 756=item B<saveLines:> I<number>
563 757
564Save I<number> lines in the scrollback buffer [default 64]. This 758Save I<number> lines in the scrollback buffer [default 64]. This
565resource is limited on most machines to 65535; option B<-sl>. 759resource is limited on most machines to 65535; option B<-sl>.
575option B<-w>, B<-bw>, B<-borderwidth>. 769option B<-w>, B<-bw>, B<-borderwidth>.
576 770
577=item B<borderLess:> I<boolean> 771=item B<borderLess:> I<boolean>
578 772
579Set MWM hints to request a borderless window, i.e. if honoured by the 773Set MWM hints to request a borderless window, i.e. if honoured by the
580WM, the rxvt window will not have window decorations; option B<-bl>. 774WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
581 775
582=item B<termName:> I<termname> 776=item B<termName:> I<termname>
583 777
584Specifies the terminal type name to be set in the B<TERM> environment 778Specifies the terminal type name to be set in the B<TERM> environment
585variable; option B<-tn>. 779variable; option B<-tn>.
596 790
597=item B<mouseWheelScrollPage:> I<boolean> 791=item B<mouseWheelScrollPage:> I<boolean>
598 792
599B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel 793B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
600scrolls five lines [default]. 794scrolls five lines [default].
795
796=item B<pastableTabs:> I<boolean>
797
798B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
799movement only; option C<-ptab>.
601 800
602=item B<cursorBlink:> I<boolean> 801=item B<cursorBlink:> I<boolean>
603 802
604B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 803B<True>: blink the cursor. B<False>: do not blink the cursor [default];
605option B<-bc>. 804option B<-bc>.
618 817
619Mouse pointer background colour. 818Mouse pointer background colour.
620 819
621=item B<pointerBlankDelay:> I<number> 820=item B<pointerBlankDelay:> I<number>
622 821
623Specifies number of seconds before blanking the pointer [default 2]. 822Specifies number of seconds before blanking the pointer [default 2]. Use a
823large number (e.g. C<987654321>) to effectively disable the timeout.
624 824
625=item B<backspacekey:> I<string> 825=item B<backspacekey:> I<string>
626 826
627The string to send when the backspace key is pressed. If set to B<DEC> 827The string to send when the backspace key is pressed. If set to B<DEC>
628or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 828or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
650 850
651I<name> of inputMethod to use; option B<-im>. 851I<name> of inputMethod to use; option B<-im>.
652 852
653=item B<imLocale:> I<name> 853=item B<imLocale:> I<name>
654 854
655The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 855The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
656de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 856C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
657extension to be able to input japanese characters while staying in 857input extension to be able to input japanese characters while staying in
658another locale. option B<-imlocale>. 858another locale. option B<-imlocale>.
659 859
660=item B<insecure> 860=item B<imFont:> I<fontset>
861
862Specify the font-set used for XIM styles C<OverTheSpot> or
863C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
864by commas), i.e. it's not in the same format as the other font lists used
865in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
866found, preferably one or two pixels differing in size to the base font.
867option B<-imfont>.
868
869=item B<tripleclickwords:> I<boolean>
870
871Change the meaning of triple-click selection with the left mouse
872button. Instead of selecting a full line it will extend the selection to
873the end of the logical line only. option B<-tcw>.
874
875=item B<insecure:> I<boolean>
661 876
662Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 877Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
663echo arbitrary strings like the icon name or the locale. This could be 878echo arbitrary strings like the icon name or the locale. This could be
664abused if somebody gets 8-bit-clean access to your display, wether 879abused if somebody gets 8-bit-clean access to your display, whether
665throuh a mail client displaying mail bodies unfiltered or though 880throuh a mail client displaying mail bodies unfiltered or though
666write(1). Therefore, these sequences are disabled by default. (Note 881write(1). Therefore, these sequences are disabled by default. (Note
667that other terminals, including xterm, have these sequences 882that other terminals, including xterm, have these sequences
668enabled by default). You can enable them by setting this boolean 883enabled by default). You can enable them by setting this boolean
669resource or specifying B<-insecure> as an option. At the moment, this 884resource or specifying B<-insecure> as an option. At the moment, this
676B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 891B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
677B<-mod>. 892B<-mod>.
678 893
679=item B<answerbackString:> I<string> 894=item B<answerbackString:> I<string>
680 895
681Specify the reply rxvt sends to the shell when an ENQ (control-E) 896Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
682character is passed through. It may contain escape values as described 897character is passed through. It may contain escape values as described
683in the entry on B<keysym> following. 898in the entry on B<keysym> following.
684 899
685=item B<secondaryScreen:> I<bool> 900=item B<secondaryScreen:> I<bool>
686 901
693scrollback buffer and switching to/from the secondary screen will 908scrollback buffer and switching to/from the secondary screen will
694instead scroll the screen up. 909instead scroll the screen up.
695 910
696=item B<keysym.>I<sym>: I<string> 911=item B<keysym.>I<sym>: I<string>
697 912
698Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 913Compile I<frills>: Associate I<string> with keysym I<sym>. The
699contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 914intervening resource name B<keysym.> cannot be omitted.
700newline, \r: return, \t: 915
916The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
917any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
918B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
919and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
920B<2>, B<3>, B<4>, B<5>.
921
922The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
923whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
924keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
925current application keymap mode state.
926
927The spellings of I<key> can be obtained by using B<xev>(1) command or
928searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
929omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
930keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
931performed in an exact manner; however, the closest match is assured.
932
933I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
934C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
701tab, \000: octal number) or control characters (^?: delete, ^@: null, 935C<\000>: octal number) or verbatim control characters (C<^?>: delete,
702^A ...) and may enclosed with double quotes so that it can start or end 936C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
703with whitespace. The intervening resource name B<keysym.> cannot be 937can start or end with whitespace.
704omitted. This resource is only available when compiled with 938
705KEYSYM_RESOURCE. 939Please note that you need to double the C<\> when using
940C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
941use C<\033> instead of C<\e> (and so on), which will work with both Xt and
942@@RXVT_NAME@@'s own processing).
943
944You can define a range of keysyms in one shot by providing a I<string>
945with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
946should be a character not used by the strings.
947
948Its usage can be demonstrated by an example:
949
950 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
951
952The above line is equivalent to the following three lines:
953
954 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
955 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
956 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
957
958If I<string> takes the form of C<command:STRING>, the specified B<STRING>
959is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
960example the following means "change the current locale to C<zh_CN.GBK>
961when Control-Meta-c is being pressed":
962
963 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
964
965Due the the large number of modifier combinations, a defined key mapping
966will match if at I<at least> the specified identifiers are being set, and
967no other key mappings with those and more bits are being defined. That
968means that defining a key map for C<a> will automatically provide
969definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
970mappings themselves.
971
972Unfortunately, this will override built-in key mappings. For example
973if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
974C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
975user-defined keymap using the C<builtin:> replacement:
976
977 URxvt.keysym.Insert: <my insert key sequence>
978 URxvt.keysym.S-Insert: builtin:
979
980The first line defines a mapping for C<Insert> and I<any> combination
981of modifiers. The second line re-establishes the default mapping for
982C<Shift-Insert>.
983
984The following example will map Control-Meta-1 and Control-Meta-2 to
985the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
986font-switching at runtime:
987
988 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
989 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
990
991Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
992info):
993
994 URxvt.keysym.M-C-3: command:\033[8;25;80t
995 URxvt.keysym.M-C-4: command:\033[8;48;110t
706 996
707=back 997=back
708 998
709=head1 THE SCROLLBAR 999=head1 THE SCROLLBAR
710 1000
724the normal text selection/insertion, hold either the Shift or the Meta 1014the normal text selection/insertion, hold either the Shift or the Meta
725(Alt) key while performing the desired mouse action. 1015(Alt) key while performing the desired mouse action.
726 1016
727If mouse reporting mode is active, the normal scrollbar actions are 1017If mouse reporting mode is active, the normal scrollbar actions are
728disabled -- on the assumption that we are using a fullscreen 1018disabled -- on the assumption that we are using a fullscreen
729application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1019application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
730(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1020(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
731up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), 1021up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
732respectively. 1022respectively.
733 1023
734=head1 TEXT SELECTION AND INSERTION 1024=head1 TEXT SELECTION AND INSERTION
735 1025
736The behaviour of text selection and insertion mechanism is similar to 1026The behaviour of text selection and insertion mechanism is similar to
738 1028
739=over 4 1029=over 4
740 1030
741=item B<Selection>: 1031=item B<Selection>:
742 1032
743Left click at the beginning of the region, drag to the end of the 1033Left click at the beginning of the region, drag to the end of the region
744region and release; Right click to extend the marked region; Left 1034and release; Right click to extend the marked region; Left double-click
745double-click to select a word; Left triple-click to select the entire 1035to select a word; Left triple-click to select the entire logical line
746line. 1036(which can span multiple screen lines), unless modified by resource
1037B<tripleclickwords>.
1038
1039Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1040(Compile: I<frills>) will create a rectangular selection instead of a normal
1041one.
747 1042
748=item B<Insertion>: 1043=item B<Insertion>:
749 1044
750Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1045Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
751an B<@@RXVT_NAME@@> window causes the current text selection to be 1046an B<@@RXVT_NAME@@> window causes the current text selection to be
753 1048
754=back 1049=back
755 1050
756=head1 CHANGING FONTS 1051=head1 CHANGING FONTS
757 1052
758You can change fonts on-the-fly, which is to say cycle through the 1053Changing fonts (or font sizes, respectively) via the keypad is not yet
759default font and others of various sizes, by using B<Shift-KP_Add> and 1054supported in rxvt-unicode. Bug me if you need this.
760B<Shift-KP_Subtract>. Or, alternatively (if enabled) with 1055
761B<@@HOTKEY@@-@@BIGFONT@@> and B<@@HOTKEY@@-@@SMALLFONT@@>, where the 1056You can, however, switch fonts at runtime using escape sequences (and
762actual key can be selected using resources 1057therefore using the menubar), e.g.:
763B<smallfont_key>/B<bigfont_key>. 1058
1059 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"
1060
1061rxvt-unicode will automatically re-apply these fonts to the output so far.
764 1062
765=head1 ISO 14755 SUPPORT 1063=head1 ISO 14755 SUPPORT
766 1064
767Partial ISO 14755-support is implemented. that means that pressing 1065ISO 14755 is a standard for entering and viewing unicode characters
1066and character codes using the keyboard. It consists of 4 parts. The
1067first part is available rxvt-unicode has been compiled with
1068C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1069with C<--enable-iso14755>.
768 1070
769Section 5.1: Control and Shift together enters unicode input 1071=over 4
770mode. Entering hex digits composes a Unicode character, pressing space or
771releasing the modifiers commits the keycode and every other key cancels
772the current input character.
773 1072
774Section 5.2: Pressing and immediately releasing Control and Shift together 1073=item * 5.1: Basic method
775enters keycap entry mode for the next key: pressing a function key (tab, 1074
776return etc..) will enter the unicode character corresponding to the given 1075This allows you to enter unicode characters using their hexcode.
777key. 1076
1077Start by pressing and holding both C<Control> and C<Shift>, then enter
1078hex-digits (between one and six). Releasing C<Control> and C<Shift> will
1079commit the character as if it were typed directly. While holding down
1080C<Control> and C<Shift> you can also enter multiple characters by pressing
1081C<Space>, which will commit the current character and lets you start a new
1082one.
1083
1084As an example of use, imagine a business card with a japanese e-mail
1085address, which you cannot type. Fortunately, the card has the e-mail
1086address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
1087by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
1088followed by releasing the modifier keys.
1089
1090=item * 5.2: Keyboard symbols entry method
1091
1092This mode lets you input characters representing the keycap symbols of
1093your keyboard, if representable in the current locale encoding.
1094
1095Start by pressing C<Control> and C<Shift> together, then releasing
1096them. The next special key (cursor keys, home etc.) you enter will not
1097invoke it's usual function but instead will insert the corresponding
1098keycap symbol. The symbol will only be entered when the key has been
1099released, otherwise pressing e.g. C<Shift> would enter the symbol for
1100C<ISO Level 2 Switch>, although your intention might have been to enter a
1101reverse tab (Shift-Tab).
1102
1103=item * 5.3: Screen-selection entry method
1104
1105While this is implemented already (it's basically the selection
1106mechanism), it could be extended by displaying a unicode character map.
1107
1108=item * 5.4: Feedback method for identifying displayed characters for later input
1109
1110This method lets you display the unicode character code associated with
1111characters already displayed.
1112
1113You enter this mode by holding down C<Control> and C<Shift> together, then
1114pressing and holding the left mouse button and moving around. The unicode
1115hex code(s) (it might be a combining character) of the character under the
1116pointer is displayed until you release C<Control> and C<Shift>.
1117
1118In addition to the hex codes it will display the font used to draw this
1119character - due to implementation reasons, characters combined with
1120combining characters, line drawing characters and unknown characters will
1121always be drawn using the built-in support font.
1122
1123=back
1124
1125With respect to conformance, rxvt-unicode is supposed to be compliant to
1126both scenario A and B of ISO 14755, including part 5.2.
778 1127
779=head1 LOGIN STAMP 1128=head1 LOGIN STAMP
780 1129
781B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1130B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
782that it can be seen via the I<who(1)> command, and can accept messages. 1131it can be seen via the I<who(1)> command, and can accept messages. To
783To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on 1132allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
784some systems. 1133on some systems or setgid to root or to some other group on others.
785 1134
786=head1 COLORS AND GRAPHICS 1135=head1 COLORS AND GRAPHICS
787 1136
788In addition to the default foreground and background colours, 1137In addition to the default foreground and background colours,
789B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1138B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
823I<xterm>(1) where the colours are only swapped if they have not otherwise 1172I<xterm>(1) where the colours are only swapped if they have not otherwise
824been specified. For example, 1173been specified. For example,
825 1174
826=over 4 1175=over 4
827 1176
828=item B<rxvt -fg Black -bg White -rv> 1177=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
829 1178
830would yield White on Black, while on I<xterm>(1) it would yield Black 1179would yield White on Black, while on I<xterm>(1) it would yield Black
831on White. 1180on White.
832 1181
833=back 1182=back
834 1183
835=head1 ENVIRONMENT 1184=head1 ENVIRONMENT
836 1185
837B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1186B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
838and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1187
839window id number of the B<@@RXVT_NAME@@> window and it also uses and 1188=over 4
840sets the environment variable B<DISPLAY> to specify which display 1189
841terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1190=item B<TERM>
842B<RXVTPATH> and B<PATH> to find XPM files. 1191
1192Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1193resources or on the commandline.
1194
1195=item B<COLORTERM>
1196
1197Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
1198compiled with XPM support, and optionally with the added extension
1199C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1200
1201=item B<COLORFGBG>
1202
1203Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1204the colour code used as default foreground/text colour (or the string
1205C<default> to indicate that the default-colour escape sequence is to be
1206used), C<bg> is the colour code used as default background colour (or the
1207string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1208was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1209(and do) use this information to optimize screen output.
1210
1211=item B<WINDOWID>
1212
1213Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1214window, which usually has subwindows for the scrollbar, the terminal
1215window and so on).
1216
1217=item B<TERMINFO>
1218
1219Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1220C<--with-terminfo=PATH>.
1221
1222=item B<DISPLAY>
1223
1224Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1225display in it's child processes.
1226
1227=item B<SHELL>
1228
1229The shell to be used for command execution, defaults to C</bin/sh>.
1230
1231=item B<RXVTPATH>
1232
1233The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1234files.
1235
1236=item B<PATH>
1237
1238Used in the same way as C<RXVTPATH>.
1239
1240=item B<RXVT_SOCKET>
1241
1242The unix domain socket path used by @@RXVT_NAME@@c(1) and
1243@@RXVT_NAME@@d(1).
1244
1245Default C<< $HOME/.rxvt-unicode-<nodename >>.
1246
1247=item B<HOME>
1248
1249Used to locate the default directory for the unix domain socket for
1250daemon communications and to locate various resource files (such as
1251C<.Xdefaults>)
1252
1253=item B<XAPPLRESDIR>
1254
1255Directory where various X resource files are being located.
1256
1257=item B<XENVIRONMENT>
1258
1259If set and accessible, gives the name of a X resource file to be loaded by
1260@@RXVT_NAME@@.
1261
1262=back
843 1263
844=head1 FILES 1264=head1 FILES
845 1265
846=over 4 1266=over 4
847 1267
848=item B</etc/utmp>
849
850System file for login records.
851
852=item B</usr/lib/X11/rgb.txt> 1268=item B</usr/lib/X11/rgb.txt>
853 1269
854Color names. 1270Color names.
855 1271
856=back 1272=back
857 1273
858=head1 SEEALSO 1274=head1 SEE ALSO
859 1275
860I<xterm>(1), I<sh>(1), I<resize>(1), I<X>(1), I<pty>(4), I<tty>(4), I<utmp>(5) 1276@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
861
862See rxvtRef.html rxvtRef.txt for detailed information on recognized escape sequences and menuBar syntax, etc.
863 1277
864=head1 BUGS 1278=head1 BUGS
865 1279
866Check the BUGS file for an up-to-date list. 1280Check the BUGS file for an up-to-date list.
867 1281
873 1287
874=over 4 1288=over 4
875 1289
876=item Project Coordinator 1290=item Project Coordinator
877 1291
878@@RXVTMAINT@@ L<@@RXVT_MAINTEMAIL@@> 1292Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
879 1293
880=item Web page maintainter 1294L<http://software.schmorp.de/#rxvt-unicode>
881
882@@RXVTWEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
883
884L<@@RXVT_WEBPAGE@@>
885 1295
886=back 1296=back
887 1297
888=head1 AUTHORS 1298=head1 AUTHORS
889 1299
914=item Geoff Wing L<< <gcw@pobox.com> >> 1324=item Geoff Wing L<< <gcw@pobox.com> >>
915 1325
916Rewrote screen display and text selection routines. Project Coordinator 1326Rewrote screen display and text selection routines. Project Coordinator
917(changes.txt 2.4.6 - rxvt-unicode) 1327(changes.txt 2.4.6 - rxvt-unicode)
918 1328
919=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1329=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
920 1330
921Forked rxvt-unicode, rewrote most of the display code and internal 1331Forked rxvt-unicode, rewrote most of the display code and internal
922character handling to store text in unicode, improve xterm 1332character handling to store text in unicode, improve xterm
923compatibility and apply numerous other bugfixes and extensions. 1333compatibility and apply numerous other bugfixes and extensions.
924 1334

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines