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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines