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.36 by root, Wed Dec 15 05:10:57 2004 UTC vs.
Revision 1.97 by root, Mon Jan 16 15:07:27 2006 UTC

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
17=head1 FREQUENTLY ASKED QUESTIONS 17=head1 FREQUENTLY ASKED QUESTIONS
18 18
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of frequently 19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20asked questions and answer to them and some common problems. 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>.
21 23
22=head1 RXVT-UNICODE VS. RXVT 24=head1 RXVT-UNICODE VS. RXVT
23 25
24Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
25internally. That means it can store and display most scripts in the 27internally. That means it can store and display most scripts in the
103 105
104=item B<-j>|B<+j> 106=item B<-j>|B<+j>
105 107
106Turn on/off jump scrolling; resource B<jumpScroll>. 108Turn on/off jump scrolling; resource B<jumpScroll>.
107 109
108=item B<-ip>|B<+ip> 110=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
109 111
110Turn on/off inheriting parent window's pixmap. Alternative form is 112Turn on/off inheriting parent window's pixmap. Alternative form is
111B<-tr>; resource B<inheritPixmap>. 113B<-tr>; resource B<inheritPixmap>.
112 114
113=item B<-fade> I<number> 115=item B<-fade> I<number>
114 116
115Fade the text by the given percentage when focus is lost. 117Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>.
120
121=item B<-fadecolor> I<colour>
122
123Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>.
116 125
117=item B<-tint> I<colour> 126=item B<-tint> I<colour>
118 127
119Tint the transparent background pixmap with the given colour when 128Tint the transparent background pixmap with the given colour when
120transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> 129transparency is enabled with B<-tr> or B<-ip>. This only works for
121option that can be used to brighten or darken the image in addition to 130non-tiled backgrounds, currently. See also the B<-sh> option that can be
122tinting it. 131used to brighten or darken the image in addition to tinting it; resource
132I<tintColor>. Example:
133
134 @@RXVT_NAME@@ -tr -tint blue -sh 40
123 135
124=item B<-sh> 136=item B<-sh>
125 137
126I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
127background image in addition to tinting it (i.e. B<-tint> must be 139background image in addition to tinting it (i.e. B<-tint> must be
136Window foreground colour; resource B<foreground>. 148Window foreground colour; resource B<foreground>.
137 149
138=item B<-pixmap> I<file[;geom]> 150=item B<-pixmap> I<file[;geom]>
139 151
140Compile I<XPM>: Specify XPM file for the background and also optionally 152Compile I<XPM>: Specify XPM file for the background and also optionally
141specify its scaling with a geometry string. Note you may need to add 153specify its scaling with a geometry string. Note you may need to
142quotes to avoid special shell interpretation of the `;' in the 154add quotes to avoid special shell interpretation of the C<;> in the
143command-line; resource B<backgroundPixmap>. 155command-line; resource B<backgroundPixmap>.
144 156
145=item B<-cr> I<colour> 157=item B<-cr> I<colour>
146 158
147The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
160resource B<borderColor>. 172resource B<borderColor>.
161 173
162=item B<-fn> I<fontlist> 174=item B<-fn> I<fontlist>
163 175
164Select the fonts to be used. This is a comma separated list of font names 176Select the fonts to be used. This is a comma separated list of font names
165that are used in turn when trying to display Unicode characters. The 177that are checked in order when trying to find glyphs for characters. The
166first font defines the cell size for characters; other fonts might be 178first font defines the cell size for characters; other fonts might be
167smaller, but not (in general) larger. A (hopefully) reasonable default 179smaller, but not (in general) larger. A (hopefully) reasonable default
168font list is always appended to it. See resource B<font> for more details. 180font list is always appended to it. See resource B<font> for more details.
169 181
170In short, to specify an X11 core font, just specify it's name or prefix it 182In short, to specify an X11 core font, just specify it's name or prefix it
177See also the question "How does rxvt-unicode choose fonts?" in the FAQ 189See also the question "How does rxvt-unicode choose fonts?" in the FAQ
178section of @@RXVT_NAME@@(7). 190section of @@RXVT_NAME@@(7).
179 191
180=item B<-fb> I<fontlist> 192=item B<-fb> I<fontlist>
181 193
182Compile font-styles: The bold font list to use when bold characters are to 194Compile I<font-styles>: The bold font list to use when B<bold> characters
183be printed. See resource B<boldFont> for details. 195are to be printed. See resource B<boldFont> for details.
184 196
185=item B<-fi> I<fontlist> 197=item B<-fi> I<fontlist>
186 198
187Compile font-styles: The italic font list to use when bold characters are to 199Compile I<font-styles>: The italic font list to use when I<italic>
188be printed. See resource B<italicFont> for details. 200characters are to be printed. See resource B<italicFont> for details.
189 201
190=item B<-fbi> I<fontlist> 202=item B<-fbi> I<fontlist>
191 203
192Compile font-styles: The bold italic font list to use when bold characters are to 204Compile I<font-styles>: The bold italic font list to use when B<< I<bold
193be printed. See resource B<boldItalicFont> for details. 205italic> >> characters are to be printed. See resource B<boldItalicFont>
206for details.
207
208=item B<-is>|B<+is>
209
210Compile I<font-styles>: Bold/Italic font styles imply high intensity
211foreground/background (default). See resource B<intensityStyles> for
212details.
194 213
195=item B<-name> I<name> 214=item B<-name> I<name>
196 215
197Specify the application name under which resources are to be obtained, 216Specify the application name under which resources are to be obtained,
198rather than the default executable file name. Name should not contain 217rather than the default executable file name. Name should not contain
236 255
237Put scrollbar on right/left; resource B<scrollBar_right>. 256Put scrollbar on right/left; resource B<scrollBar_right>.
238 257
239=item B<-st>|B<+st> 258=item B<-st>|B<+st>
240 259
241Display normal (non XTerm/NeXT) scrollbar without/with a trough; 260Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
242resource B<scrollBar_floating>. 261resource B<scrollBar_floating>.
243 262
244=item B<-ptab>|B<+ptab> 263=item B<-ptab>|B<+ptab>
245 264
246If enabled (default), "Horizontal Tab" characters are being stored as 265If enabled (default), "Horizontal Tab" characters are being stored as
278 297
279Compile I<frills>: Set MWM hints to request a borderless window, i.e. 298Compile I<frills>: Set MWM hints to request a borderless window, i.e.
280if honoured by the WM, the rxvt-unicode window will not have window 299if honoured by the WM, the rxvt-unicode window will not have window
281decorations; resource B<borderLess>. 300decorations; resource B<borderLess>.
282 301
302=item B<-sbg>
303
304Compile I<frills>: Disable the usage of the built-in block graphics/line
305drawing characters and just rely on what the specified fonts provide. Use
306this if you have a good font and want to use its block graphic glyphs;
307resource B<skipBuiltinGlyphs>.
308
283=item B<-lsp> I<number> 309=item B<-lsp> I<number>
284 310
285Compile I<linespace>: Lines (pixel height) to insert between each row 311Compile I<frills>: Lines (pixel height) to insert between each row of
286of the display; resource B<linespace>. 312the display. Useful to work around font rendering problems; resource
313B<linespace>.
287 314
288=item B<-tn> I<termname> 315=item B<-tn> I<termname>
289 316
290This option specifies the name of the terminal type to be set in the 317This option specifies the name of the terminal type to be set in the
291B<TERM> environment variable. This terminal type must exist in the 318B<TERM> environment variable. This terminal type must exist in the
300given on the command line. If this option is used, it must be the last 327given on the command line. If this option is used, it must be the last
301on the command-line. If there is no B<-e> option then the default is to 328on the command-line. If there is no B<-e> option then the default is to
302run the program specified by the B<SHELL> environment variable or, 329run the program specified by the B<SHELL> environment variable or,
303failing that, I<sh(1)>. 330failing that, I<sh(1)>.
304 331
332Please note that you must specify a program with arguments. If you want to
333run shell commands, you have to specify the shell, like this:
334
335 @@RXVT_NAME@@ -e sh -c "shell commands"
336
305=item B<-title> I<text> 337=item B<-title> I<text>
306 338
307Window title (B<-T> still respected); the default title is the basename 339Window title (B<-T> still respected); the default title is the basename
308of the program specified after the B<-e> option, if any, otherwise the 340of the program specified after the B<-e> option, if any, otherwise the
309application name; resource B<title>. 341application name; resource B<title>.
327 359
328Compile I<XIM>: input method name. resource B<inputMethod>. 360Compile I<XIM>: input method name. resource B<inputMethod>.
329 361
330=item B<-imlocale> I<string> 362=item B<-imlocale> I<string>
331 363
332The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 364The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
333de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 365C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
334extension to be able to input japanese characters while staying in 366input extension to be able to input japanese characters while staying in
335another locale. 367another locale. resource B<imLocale>.
368
369=item B<-imfont> I<fontset>
370
371Set the font set to use for the X Input Method, see resource B<imFont>
372for more info.
373
374=item B<-tcw>
375
376Change the meaning of triple-click selection with the left mouse
377button. Instead of selecting a full line it will extend the selection the
378end of the logical line only. resource B<tripleclickwords>.
336 379
337=item B<-insecure> 380=item B<-insecure>
338 381
339Enable "insecure" mode, which currently enables most of the escape 382Enable "insecure" mode, which currently enables most of the escape
340sequences that echo strings. See the resource B<insecure> for more 383sequences that echo strings. See the resource B<insecure> for more
354=item B<-ssr>|B<+ssr> 397=item B<-ssr>|B<+ssr>
355 398
356Turn on/off secondary screen scroll (default enabled); resource 399Turn on/off secondary screen scroll (default enabled); resource
357B<secondaryScroll>. 400B<secondaryScroll>.
358 401
402=item B<-hold>|B<+hold>
403
404Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
405will not immediately destroy its window when the program executed within
406it exits. Instead, it will wait till it is being killed or closed by the
407user; resource B<hold>.
408
409=item B<-keysym.>I<sym> I<string>
410
411Remap a key symbol. See resource B<keysym>.
412
413=item B<-embed> I<windowid>
414
415Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
416which enables applications to easily embed a terminal.
417
418Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
419shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
420quite a bit, so don't expect it to keep some specific state. It's best to
421create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
422
423The window will not be destroyed when @@RXVT_NAME@@ exits.
424
425It might be useful to know that @@RXVT_NAME@@ will not close file
426descriptors passed to it (except for stdin/out/err, of course), so you
427can use file descriptors to communicate with the programs within the
428terminal. This works regardless of wether the C<-embed> option was used or
429not.
430
431Here is a short Gtk2-perl snippet that illustrates how this option can be
432used (a longer example is in F<doc/embed>):
433
434 my $rxvt = new Gtk2::Socket;
435 $rxvt->signal_connect_after (realize => sub {
436 my $xid = $_[0]->window->get_xid;
437 system "@@RXVT_NAME@@ -embed $xid &";
438 });
439
440=item B<-pty-fd> I<file descriptor>
441
442Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
443pair but instead use the given filehandle as the tty master. This is
444useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445without having to run a program within it.
446
447If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
448entries and will not tinker with pty/tty permissions - you have to do that
449yourself if you want that.
450
451As an extremely special case, specifying C<-1> will completely suppress
452pty/tty operations.
453
454Here is a example in perl that illustrates how this option can be used (a
455longer example is in F<doc/pty-fd>):
456
457 use IO::Pty;
458 use Fcntl;
459
460 my $pty = new IO::Pty;
461 fcntl $pty, F_SETFD, 0; # clear close-on-exec
462 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
463 close $pty;
464
465 # now communicate with rxvt
466 my $slave = $pty->slave;
467 while (<$slave>) { print $slave "got <$_>\n" }
468
359=item B<-xrm> I<resourcestring> 469=item B<-pe> I<string>
360 470
361No effect on rxvt-unicode. Simply passes through an argument to be made 471Comma-separated list of perl extension scripts to use (or not to use) in
362available in the instance's argument list. Appears in I<WM_COMMAND> in 472this terminal instance. See resource B<perl-ext> for details.
363some window managers.
364 473
365=back 474=back
366 475
367=head1 RESOURCES (available also as long-options) 476=head1 RESOURCES (available also as long-options)
368 477
369Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 478Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
370options) compiled into your version. 479options) compiled into your version.
371 480
372There are two different methods that @@RXVT_NAME@@ can use to get the 481You can set and change the resources using X11 tools like B<xrdb>. Many
373Xresource data: using the X libraries (Xrm*-functions) or internal 482distribution do also load settings from the B<~/.Xresources> file when X
374Xresources reader (B<~/.Xdefaults>). For the first method (ie. 483starts. @@RXVT_NAME@@ will consult the following files/resources in order,
375B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 484with later settings overwriting earlier ones:
376resources using X11 tools like B<xset>. Many distribution do also load
377settings from the B<~/.Xresources> file when X starts.
378 485
379If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 486 1. system-wide app-defaults file, either locale-dependent OR global
380lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 487 2. app-defaults file in $XAPPLRESDIR
381set in XAPPLOADDIR/URxvt (compile-time defined: usually 488 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
382B</usr/lib/X11/app-defaults/URxvt>) and resources set in 489 4. SCREEN_RESOURCES for the current screen
383B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist. 490 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
491
384Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 492Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
385class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 493names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
386resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 494common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
387easily configured, while the class name B<URxvt> allows resources 495configured, while the class name B<URxvt> allows resources unique to
388unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 496B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
389shared between different B<@@RXVT_NAME@@> configurations. If no 497configurations. If no resources are specified, suitable defaults will
390resources are specified, suitable defaults will be used. Command-line 498be used. Command-line arguments can be used to override resource
391arguments can be used to override resource settings. The following 499settings. The following resources are supported (you might want to
392resources are allowed: 500check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
501extensions not documented here):
393 502
394=over 4 503=over 4
395 504
396=item B<geometry:> I<geom> 505=item B<geometry:> I<geom>
397 506
427 536
428=item B<colorIT:> I<colour> 537=item B<colorIT:> I<colour>
429 538
430Use the specified colour to display bold or italic characters when the 539Use the specified colour to display bold or italic characters when the
431foreground colour is the default. If font styles are not available 540foreground colour is the default. If font styles are not available
432(Compile styles) and this option is unset, reverse video is used instead. 541(Compile I<styles>) and this option is unset, reverse video is used instead.
433 542
434=item B<colorUL:> I<colour> 543=item B<colorUL:> I<colour>
435 544
436Use the specified colour to display underlined characters when the 545Use the specified colour to display underlined characters when the
437foreground colour is the default. 546foreground colour is the default.
475artificial transparency. B<False>: do not inherit the parent windows' 584artificial transparency. B<False>: do not inherit the parent windows'
476pixmap. 585pixmap.
477 586
478=item B<fading:> I<number> 587=item B<fading:> I<number>
479 588
480Fade the text by the given percentage when focus is lost. 589Fade the text by the given percentage when focus is lost; option B<-fade>.
590
591=item B<fadeColor:> I<colour>
592
593Fade to this colour, when fading is used (see B<fading:>). The default
594colour is black; option B<-fadecolor>.
481 595
482=item B<tintColor:> I<colour> 596=item B<tintColor:> I<colour>
483 597
484Tint the transparent background pixmap with the given colour. 598Tint the transparent background pixmap with the given colour; option
599B<-tint>.
485 600
486=item B<shading:> I<number> 601=item B<shading:> I<number>
487 602
488Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 603Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
489image in addition to tinting it. 604image in addition to tinting it.
493Use the specified colour for the scrollbar [default #B2B2B2]. 608Use the specified colour for the scrollbar [default #B2B2B2].
494 609
495=item B<troughColor:> I<colour> 610=item B<troughColor:> I<colour>
496 611
497Use the specified colour for the scrollbar's trough area [default 612Use the specified colour for the scrollbar's trough area [default
498#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 613#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
499 614
500=item B<borderColor:> I<colour> 615=item B<borderColor:> I<colour>
501 616
502The colour of the border around the text area and between the scrollbar 617The colour of the border around the text area and between the scrollbar
503and the text. 618and the text.
512of 1 displays the image without any scaling. A scale of 2 to 9 627of 1 displays the image without any scaling. A scale of 2 to 9
513specifies an integer number of images in that direction. No image will 628specifies an integer number of images in that direction. No image will
514be magnified beyond 10 times its original size. The maximum permitted 629be magnified beyond 10 times its original size. The maximum permitted
515scale is 1000. [default 0x0+50+50] 630scale is 1000. [default 0x0+50+50]
516 631
517=item B<menu:> I<file[;tag]>
518
519Read in the specified menu file (note the `.menu' extension is
520optional) and also optionally specify a starting tag to find. See the
521reference documentation for details on the syntax for the menuBar.
522
523=item B<path:> I<path> 632=item B<path:> I<path>
524 633
525Specify the colon-delimited search path for finding files (XPM and 634Specify the colon-delimited search path for finding XPM files.
526menus), in addition to the paths specified by the B<RXVTPATH> and
527B<PATH> environment variables.
528 635
529=item B<font:> I<fontlist> 636=item B<font:> I<fontlist>
530 637
531Select the fonts to be used. This is a comma separated list of font 638Select the fonts to be used. This is a comma separated list of font names
532names that are used in turn when trying to display Unicode characters. 639that are checked in order when trying to find glyphs for characters. The
533The first font defines the cell size for characters; other fonts might 640first font defines the cell size for characters; other fonts might be
534be smaller, but not larger. A reasonable default font list is always 641smaller, but not (in general) larger. A (hopefully) reasonable default
535appended to it. option B<-fn>. 642font list is always appended to it; option B<-fn>.
536 643
537Each font can either be a standard X11 core font (XLFD) name, with 644Each font can either be a standard X11 core font (XLFD) name, with
538optional prefix C<x:> or a Xft font (Compile xft), prefixed with C<xft:>. 645optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
539 646
540In addition, each font can be prefixed with additional hints and 647In addition, each font can be prefixed with additional hints and
541specifications enclosed in square brackets (C<[]>). The only available 648specifications enclosed in square brackets (C<[]>). The only available
542hint currently is C<codeset=codeset-name>, and this is only used for Xft 649hint currently is C<codeset=codeset-name>, and this is only used for Xft
543fonts. 650fonts.
544 651
545For example, this font resource 652For example, this font resource
546 653
547 URxvt*font: 9x15bold,\ 654 URxvt.font: 9x15bold,\
548 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 655 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
549 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 656 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
550 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 657 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
551 xft:Code2000:antialias=false 658 xft:Code2000:antialias=false
552 659
586not possible, replacement fonts of the desired shape will be tried. 693not possible, replacement fonts of the desired shape will be tried.
587 694
588If set, but empty, then this specific style is disabled and the normal 695If set, but empty, then this specific style is disabled and the normal
589text font will being used for the given style. 696text font will being used for the given style.
590 697
698=item B<intensityStyles:> I<boolean>
699
700When font styles are not enabled, or this option is enabled (B<True>,
701option B<-is>, the default), bold and italic font styles imply high
702intensity foreground/backround colours. Disabling this option (B<False>,
703option B<+is>) disables this behaviour, the high intensity colours are not
704reachable.
705
591=item B<selectstyle:> I<mode> 706=item B<selectstyle:> I<mode>
592 707
593Set mouse selection style to B<old> which is 2.20, B<oldword> which is 708Set mouse selection style to B<old> which is 2.20, B<oldword> which is
594xterm style with 2.20 old word selection, or anything else which gives 709xterm style with 2.20 old word selection, or anything else which gives
595xterm style selection. 710xterm style selection.
596 711
597=item B<scrollstyle:> I<mode> 712=item B<scrollstyle:> I<mode>
598 713
599Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 714Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
600the author's favourite.. 715the author's favourite.
601 716
602=item B<title:> I<string> 717=item B<title:> I<string>
603 718
604Set window title string, the default title is the command-line 719Set window title string, the default title is the command-line
605specified after the B<-e> option, if any, otherwise the application 720specified after the B<-e> option, if any, otherwise the application
637 752
638Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 753Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
639B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 754B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
640B<Shift-Print> to include the scrollback as well. 755B<Shift-Print> to include the scrollback as well.
641 756
757The string will be interpreted as if typed into the shell as-is.
758
759Example:
760
761 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
762
763This creates a new file in your home directory with the screen contents
764everytime you hit C<Print>.
765
642=item B<scrollBar:> I<boolean> 766=item B<scrollBar:> I<boolean>
643 767
644B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 768B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
645disable the scrollbar; option B<+sb>. 769disable the scrollbar; option B<+sb>.
646 770
666B<+si>. 790B<+si>.
667 791
668=item B<scrollWithBuffer:> I<boolean> 792=item B<scrollWithBuffer:> I<boolean>
669 793
670B<True>: scroll with scrollback buffer when tty receives new lines (and 794B<True>: scroll with scrollback buffer when tty receives new lines (and
671B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 795B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
672with scrollback buffer when tty recieves new lines; option B<-sw>. 796with scrollback buffer when tty recieves new lines; option B<+sw>.
673 797
674=item B<scrollTtyKeypress:> I<boolean> 798=item B<scrollTtyKeypress:> I<boolean>
675 799
676B<True>: scroll to bottom when a non-special key is pressed. Special keys 800B<True>: scroll to bottom when a non-special key is pressed. Special keys
677are those which are intercepted by rxvt-unicode for special handling and 801are those which are intercepted by rxvt-unicode for special handling and
696=item B<borderLess:> I<boolean> 820=item B<borderLess:> I<boolean>
697 821
698Set MWM hints to request a borderless window, i.e. if honoured by the 822Set MWM hints to request a borderless window, i.e. if honoured by the
699WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 823WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
700 824
825=item B<skipBuiltinGlyphs:> I<boolean>
826
827Compile I<frills>: Disable the usage of the built-in block graphics/line
828drawing characters and just rely on what the specified fonts provide. Use
829this if you have a good font and want to use its block graphic glyphs;
830option B<-sbg>.
831
701=item B<termName:> I<termname> 832=item B<termName:> I<termname>
702 833
703Specifies the terminal type name to be set in the B<TERM> environment 834Specifies the terminal type name to be set in the B<TERM> environment
704variable; option B<-tn>. 835variable; option B<-tn>.
705 836
742 873
743Mouse pointer background colour. 874Mouse pointer background colour.
744 875
745=item B<pointerBlankDelay:> I<number> 876=item B<pointerBlankDelay:> I<number>
746 877
747Specifies number of seconds before blanking the pointer [default 2]. 878Specifies number of seconds before blanking the pointer [default 2]. Use a
879large number (e.g. C<987654321>) to effectively disable the timeout.
748 880
749=item B<backspacekey:> I<string> 881=item B<backspacekey:> I<string>
750 882
751The string to send when the backspace key is pressed. If set to B<DEC> 883The string to send when the backspace key is pressed. If set to B<DEC>
752or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 884or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
774 906
775I<name> of inputMethod to use; option B<-im>. 907I<name> of inputMethod to use; option B<-im>.
776 908
777=item B<imLocale:> I<name> 909=item B<imLocale:> I<name>
778 910
779The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 911The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
780de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 912C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
781extension to be able to input japanese characters while staying in 913input extension to be able to input japanese characters while staying in
782another locale. option B<-imlocale>. 914another locale; option B<-imlocale>.
915
916=item B<imFont:> I<fontset>
917
918Specify the font-set used for XIM styles C<OverTheSpot> or
919C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
920by commas), i.e. it's not in the same format as the other font lists used
921in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
922found, preferably one or two pixels differing in size to the base font.
923option B<-imfont>.
924
925=item B<tripleclickwords:> I<boolean>
926
927Change the meaning of triple-click selection with the left mouse
928button. Instead of selecting a full line it will extend the selection to
929the end of the logical line only; option B<-tcw>.
783 930
784=item B<insecure:> I<boolean> 931=item B<insecure:> I<boolean>
785 932
786Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 933Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
787echo arbitrary strings like the icon name or the locale. This could be 934echo arbitrary strings like the icon name or the locale. This could be
788abused if somebody gets 8-bit-clean access to your display, whether 935abused if somebody gets 8-bit-clean access to your display, whether
789throuh a mail client displaying mail bodies unfiltered or though 936through a mail client displaying mail bodies unfiltered or through
790write(1). Therefore, these sequences are disabled by default. (Note 937write(1) or any other means. Therefore, these sequences are disabled by
791that other terminals, including xterm, have these sequences 938default. (Note that many other terminals, including xterm, have these
792enabled by default). You can enable them by setting this boolean 939sequences enabled by default, which doesn't make it safer, though).
793resource or specifying B<-insecure> as an option. At the moment, this 940
794enabled display-answer, locale, findfont, icon label and window title 941You can enable them by setting this boolean resource or specifying
795requests as well as dynamic menubar dispatch. 942B<-insecure> as an option. At the moment, this enables display-answer,
943locale, findfont, icon label and window title requests.
796 944
797=item B<modifier:> I<modifier> 945=item B<modifier:> I<modifier>
798 946
799Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 947Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
800B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 948B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
815Turn on/off secondary screen scroll (default enabled). If the this 963Turn on/off secondary screen scroll (default enabled). If the this
816option is enabled, scrolls on the secondary screen will change the 964option is enabled, scrolls on the secondary screen will change the
817scrollback buffer and switching to/from the secondary screen will 965scrollback buffer and switching to/from the secondary screen will
818instead scroll the screen up. 966instead scroll the screen up.
819 967
968=item B<hold>: I<bool>
969
970Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
971will not immediately destroy its window when the program executed within
972it exits. Instead, it will wait till it is being killed or closed by the
973user.
974
820=item B<keysym.>I<sym>: I<string> 975=item B<keysym.>I<sym>: I<string>
821 976
822Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 977Compile I<frills>: Associate I<string> with keysym I<sym>. The
823contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 978intervening resource name B<keysym.> cannot be omitted.
824newline, \r: return, \t: 979
980The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
981any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
982B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
983and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
984B<2>, B<3>, B<4>, B<5>.
985
986The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
987whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
988keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
989current application keymap mode state.
990
991The spellings of I<key> can be obtained by using B<xev>(1) command or
992searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
993omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
994keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
995performed in an exact manner; however, the closest match is assured.
996
997I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
998C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
825tab, \000: octal number) or control characters (^?: delete, ^@: null, 999C<\000>: octal number) or verbatim control characters (C<^?>: delete,
826^A ...) and may enclosed with double quotes so that it can start or end 1000C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
827with whitespace. The intervening resource name B<keysym.> cannot be 1001can start or end with whitespace.
828omitted. This resource is only available when compiled with 1002
829KEYSYM_RESOURCE. 1003Please note that you need to double the C<\> in resource files, as
1004Xlib itself does it's own de-escaping (you can use C<\033> instead of
1005C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1006processing).
1007
1008You can define a range of keysyms in one shot by providing a I<string>
1009with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
1010should be a character not used by the strings.
1011
1012Its usage can be demonstrated by an example:
1013
1014 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1015
1016The above line is equivalent to the following three lines:
1017
1018 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
1019 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
1020 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
1021
1022If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1023is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1024example the following means "change the current locale to C<zh_CN.GBK>
1025when Control-Meta-c is being pressed":
1026
1027 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1028
1029If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1030is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1031manpage. For example, the F<selection> extension (activated via
1032C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1033
1034 URxvt.keysym.M-C-c: perl:selection:rot13
1035
1036Due the the large number of modifier combinations, a defined key mapping
1037will match if at I<at least> the specified identifiers are being set, and
1038no other key mappings with those and more bits are being defined. That
1039means that defining a key map for C<a> will automatically provide
1040definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1041mappings themselves.
1042
1043Unfortunately, this will override built-in key mappings. For example
1044if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1045C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1046user-defined keymap using the C<builtin:> replacement:
1047
1048 URxvt.keysym.Insert: <my insert key sequence>
1049 URxvt.keysym.S-Insert: builtin:
1050
1051The first line defines a mapping for C<Insert> and I<any> combination
1052of modifiers. The second line re-establishes the default mapping for
1053C<Shift-Insert>.
1054
1055The following example will map Control-Meta-1 and Control-Meta-2 to
1056the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1057font-switching at runtime:
1058
1059 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1060 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1061
1062Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1063info):
1064
1065 URxvt.keysym.M-C-3: command:\033[8;25;80t
1066 URxvt.keysym.M-C-4: command:\033[8;48;110t
1067
1068=item B<perl-ext-common>: I<string>
1069
1070=item B<perl-ext>: I<string>
1071
1072Comma-separated list(s) of perl extension scripts (default: C<default>) to
1073use in this terminal instance; option B<-pe>.
1074
1075Extension names can be prefixed with a C<-> sign to prohibit using
1076them. This can be useful to selectively disable some extensions loaded
1077by default, or specified via the C<perl-ext-common> resource. For
1078example, C<default,-selection> will use all the default extension except
1079C<selection>.
1080
1081Extension names can also be followed by an argument in angle brackets
1082(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1083searchable scorllback to Alt/Meta-s). Mentioning the same extension
1084multiple times with different arguments will pass multiple arguments to
1085the extension.
1086
1087Each extension is looked up in the library directories, loaded if
1088necessary, and bound to the current terminal instance.
1089
1090If both of these resources are the empty string, then the perl
1091interpreter will not be initialized. The idea behind two options is that
1092B<perl-ext-common> will be used for extensions that should be available to
1093all instances, while B<perl-ext> is used for specific instances.
1094
1095=item B<perl-eval>: I<string>
1096
1097Perl code to be evaluated when all extensions have been registered. See
1098the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1099will be ignored when running setuid/setgid.
1100
1101=item B<perl-lib>: I<path>
1102
1103Colon-separated list of additional directories that hold extension
1104scripts. When looking for extensions specified by the C<perl> resource,
1105@@RXVT_NAME@@ will first look in these directories and then in
1106F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1107will be ignored when running setuid/setgid.
1108
1109See the @@RXVT_NAME@@perl(3) manpage.
1110
1111=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1112
1113Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1114details.
1115
1116=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1117
1118Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1119for details.
1120
1121=item B<searchable-scrollback:> I<keysym>
1122
1123Sets the hotkey that starts the incremental scrollback buffer search
1124(default: C<M-s>).
1125
1126=item B<urlLauncher>: I<string>
1127
1128Specifies the program to be started with a URL argument. Used by the
1129C<selection-popup> and C<mark-urls> perl extensions.
1130
1131=item B<transient-for>: I<windowid>
1132
1133Sets the WM_TRANSIENT_FOR property to the given window iw.
830 1134
831=back 1135=back
832 1136
833=head1 THE SCROLLBAR 1137=head1 THE SCROLLBAR
834 1138
848the normal text selection/insertion, hold either the Shift or the Meta 1152the normal text selection/insertion, hold either the Shift or the Meta
849(Alt) key while performing the desired mouse action. 1153(Alt) key while performing the desired mouse action.
850 1154
851If mouse reporting mode is active, the normal scrollbar actions are 1155If mouse reporting mode is active, the normal scrollbar actions are
852disabled -- on the assumption that we are using a fullscreen 1156disabled -- on the assumption that we are using a fullscreen
853application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1157application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
854(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1158(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
855up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), 1159up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
856respectively. 1160respectively.
857 1161
858=head1 TEXT SELECTION AND INSERTION 1162=head1 TEXT SELECTION AND INSERTION
859 1163
860The behaviour of text selection and insertion mechanism is similar to 1164The behaviour of text selection and insertion mechanism is similar to
862 1166
863=over 4 1167=over 4
864 1168
865=item B<Selection>: 1169=item B<Selection>:
866 1170
867Left click at the beginning of the region, drag to the end of the 1171Left click at the beginning of the region, drag to the end of the region
868region and release; Right click to extend the marked region; Left 1172and release; Right click to extend the marked region; Left double-click
869double-click to select a word; Left triple-click to select the entire 1173to select a word; Left triple-click to select the entire logical line
870line. 1174(which can span multiple screen lines), unless modified by resource
1175B<tripleclickwords>.
871 1176
872Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1177Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
873(Compile: frills) will create a rectangular selection instead of a normal 1178(Compile: I<frills>) will create a rectangular selection instead of a
874one. 1179normal one. In this mode, every selected row becomes its own line in the
1180selection, and trailing whitespace is visually underlined and removed from
1181the selection.
875 1182
876=item B<Insertion>: 1183=item B<Insertion>:
877 1184
878Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1185Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
879an B<@@RXVT_NAME@@> window causes the current text selection to be 1186an B<@@RXVT_NAME@@> window causes the current text selection to be
884=head1 CHANGING FONTS 1191=head1 CHANGING FONTS
885 1192
886Changing fonts (or font sizes, respectively) via the keypad is not yet 1193Changing fonts (or font sizes, respectively) via the keypad is not yet
887supported in rxvt-unicode. Bug me if you need this. 1194supported in rxvt-unicode. Bug me if you need this.
888 1195
889You can, however, switch fonts at runtime using escape sequences (and 1196You can, however, switch fonts at runtime using escape sequences, e.g.:
890therefore using the menubar), e.g.:
891 1197
892 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1198 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1199
1200You can use keyboard shortcuts, too:
1201
1202 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1203 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
893 1204
894rxvt-unicode will automatically re-apply these fonts to the output so far. 1205rxvt-unicode will automatically re-apply these fonts to the output so far.
895 1206
896=head1 ISO 14755 SUPPORT 1207=head1 ISO 14755 SUPPORT
897 1208
901C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1212C<--enable-frills>, the rest is available when rxvt-unicode was compiled
902with C<--enable-iso14755>. 1213with C<--enable-iso14755>.
903 1214
904=over 4 1215=over 4
905 1216
906=item 5.1: Basic method 1217=item * 5.1: Basic method
907 1218
908This allows you to enter unicode characters using their hexcode. 1219This allows you to enter unicode characters using their hexcode.
909 1220
910Start by pressing and holding both C<Control> and C<Shift>, then enter 1221Start by pressing and holding both C<Control> and C<Shift>, then enter
911hex-digits (between one and six). Releasing C<Control> and C<Shift> will 1222hex-digits (between one and six). Releasing C<Control> and C<Shift> will
918address, which you cannot type. Fortunately, the card has the e-mail 1229address, which you cannot type. Fortunately, the card has the e-mail
919address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily 1230address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
920by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>, 1231by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
921followed by releasing the modifier keys. 1232followed by releasing the modifier keys.
922 1233
923=item 5.2: Keyboard symbols entry method 1234=item * 5.2: Keyboard symbols entry method
924 1235
925This mode lets you input characters representing the keycap symbols of 1236This mode lets you input characters representing the keycap symbols of
926your keyboard, if representable in the current locale encoding. 1237your keyboard, if representable in the current locale encoding.
927 1238
928Start by pressing C<Control> and C<Shift> together, then releasing 1239Start by pressing C<Control> and C<Shift> together, then releasing
931keycap symbol. The symbol will only be entered when the key has been 1242keycap symbol. The symbol will only be entered when the key has been
932released, otherwise pressing e.g. C<Shift> would enter the symbol for 1243released, otherwise pressing e.g. C<Shift> would enter the symbol for
933C<ISO Level 2 Switch>, although your intention might have been to enter a 1244C<ISO Level 2 Switch>, although your intention might have been to enter a
934reverse tab (Shift-Tab). 1245reverse tab (Shift-Tab).
935 1246
936=item 5.3: Screen-selection entry method 1247=item * 5.3: Screen-selection entry method
937 1248
938While this is implemented already (it's basically the selection 1249While this is implemented already (it's basically the selection
939mechanism), it could be extended by displaying a unicode character map. 1250mechanism), it could be extended by displaying a unicode character map.
940 1251
941=item 5.4: Feedback method for identifying displayed characters for later input 1252=item * 5.4: Feedback method for identifying displayed characters for later input
942 1253
943This method lets you display the unicode character code associated with 1254This method lets you display the unicode character code associated with
944characters already displayed. 1255characters already displayed.
945 1256
946You enter this mode by holding down C<Control> and C<Shift> together, then 1257You enter this mode by holding down C<Control> and C<Shift> together, then
958With respect to conformance, rxvt-unicode is supposed to be compliant to 1269With respect to conformance, rxvt-unicode is supposed to be compliant to
959both scenario A and B of ISO 14755, including part 5.2. 1270both scenario A and B of ISO 14755, including part 5.2.
960 1271
961=head1 LOGIN STAMP 1272=head1 LOGIN STAMP
962 1273
963B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1274B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
964that it can be seen via the I<who(1)> command, and can accept messages. 1275it can be seen via the I<who(1)> command, and can accept messages. To
965To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on 1276allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
966some systems. 1277on some systems or setgid to root or to some other group on others.
967 1278
968=head1 COLORS AND GRAPHICS 1279=head1 COLORS AND GRAPHICS
969 1280
970In addition to the default foreground and background colours, 1281In addition to the default foreground and background colours,
971B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1282B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1014 1325
1015=back 1326=back
1016 1327
1017=head1 ENVIRONMENT 1328=head1 ENVIRONMENT
1018 1329
1019B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1330B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1020and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1331
1021window id number of the B<@@RXVT_NAME@@> window and it also uses and 1332=over 4
1022sets the environment variable B<DISPLAY> to specify which display 1333
1023terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1334=item B<TERM>
1024B<RXVTPATH> and B<PATH> to find XPM files. 1335
1336Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1337resources or on the commandline.
1338
1339=item B<COLORTERM>
1340
1341Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
1342compiled with XPM support, and optionally with the added extension
1343C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1344
1345=item B<COLORFGBG>
1346
1347Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1348the colour code used as default foreground/text colour (or the string
1349C<default> to indicate that the default-colour escape sequence is to be
1350used), C<bg> is the colour code used as default background colour (or the
1351string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1352was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1353(and do) use this information to optimize screen output.
1354
1355=item B<WINDOWID>
1356
1357Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1358window, which usually has subwindows for the scrollbar, the terminal
1359window and so on).
1360
1361=item B<TERMINFO>
1362
1363Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1364C<--with-terminfo=PATH>.
1365
1366=item B<DISPLAY>
1367
1368Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1369display in it's child processes.
1370
1371=item B<SHELL>
1372
1373The shell to be used for command execution, defaults to C</bin/sh>.
1374
1375=item B<RXVTPATH>
1376
1377The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1378files.
1379
1380=item B<PATH>
1381
1382Used in the same way as C<RXVTPATH>.
1383
1384=item B<RXVT_SOCKET>
1385
1386The unix domain socket path used by @@RXVT_NAME@@c(1) and
1387@@RXVT_NAME@@d(1).
1388
1389Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1390
1391=item B<HOME>
1392
1393Used to locate the default directory for the unix domain socket for
1394daemon communications and to locate various resource files (such as
1395C<.Xdefaults>)
1396
1397=item B<XAPPLRESDIR>
1398
1399Directory where various X resource files are being located.
1400
1401=item B<XENVIRONMENT>
1402
1403If set and accessible, gives the name of a X resource file to be loaded by
1404@@RXVT_NAME@@.
1405
1406=back
1025 1407
1026=head1 FILES 1408=head1 FILES
1027 1409
1028=over 4 1410=over 4
1029 1411
1030=item B</etc/utmp>
1031
1032System file for login records.
1033
1034=item B</usr/lib/X11/rgb.txt> 1412=item B</usr/lib/X11/rgb.txt>
1035 1413
1036Color names. 1414Color names.
1037 1415
1038=back 1416=back
1039 1417
1040=head1 SEE ALSO 1418=head1 SEE ALSO
1041 1419
1042@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1420@@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)
1043
1044=head1 BUGS
1045
1046Check the BUGS file for an up-to-date list.
1047
1048Cursor change support is not yet implemented.
1049
1050Click-and-drag doesn't work with X11 mouse report overriding.
1051 1421
1052=head1 CURRENT PROJECT COORDINATOR 1422=head1 CURRENT PROJECT COORDINATOR
1053 1423
1054=over 4 1424=over 4
1055 1425
1056=item Project Coordinator 1426=item Project Coordinator
1057 1427
1058@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1428Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1059 1429
1060=item Web page maintainter 1430L<http://software.schmorp.de/#rxvt-unicode>
1061
1062@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1063
1064L<@@RXVT_WEBPAGE@@>
1065 1431
1066=back 1432=back
1067 1433
1068=head1 AUTHORS 1434=head1 AUTHORS
1069 1435
1094=item Geoff Wing L<< <gcw@pobox.com> >> 1460=item Geoff Wing L<< <gcw@pobox.com> >>
1095 1461
1096Rewrote screen display and text selection routines. Project Coordinator 1462Rewrote screen display and text selection routines. Project Coordinator
1097(changes.txt 2.4.6 - rxvt-unicode) 1463(changes.txt 2.4.6 - rxvt-unicode)
1098 1464
1099=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1465=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1100 1466
1101Forked rxvt-unicode, rewrote most of the display code and internal 1467Forked rxvt-unicode, rewrote most of the display code and internal
1102character handling to store text in unicode, improve xterm 1468character handling to store text in unicode, improve xterm
1103compatibility and apply numerous other bugfixes and extensions. 1469compatibility and apply numerous other bugfixes and extensions.
1104 1470

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines