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.73 by root, Thu Dec 15 18:14:08 2005 UTC vs.
Revision 1.111 by root, Tue Jan 31 00:25:16 2006 UTC

… …
93 93
94Attempt to open a window on the named X display (B<-d> still 94Attempt to open a window on the named X display (B<-d> still
95respected). In the absence of this option, the display specified by the 95respected). In the absence of this option, the display specified by the
96B<DISPLAY> environment variable is used. 96B<DISPLAY> environment variable is used.
97 97
98=item B<-depth> I<bitdepth>
99
100Compile I<xft>: Attempt to find a visual with the given bit depth;
101resource B<depth>.
102
98=item B<-geometry> I<geom> 103=item B<-geometry> I<geom>
99 104
100Window geometry (B<-g> still respected); resource B<geometry>. 105Window geometry (B<-g> still respected); resource B<geometry>.
101 106
102=item B<-rv>|B<+rv> 107=item B<-rv>|B<+rv>
… …
109 114
110=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 115=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
111 116
112Turn on/off inheriting parent window's pixmap. Alternative form is 117Turn on/off inheriting parent window's pixmap. Alternative form is
113B<-tr>; resource B<inheritPixmap>. 118B<-tr>; resource B<inheritPixmap>.
119
120I<Please note that transparency of any kind if completely unsupported by
121the author. Don't bug him with installation questions!>
114 122
115=item B<-fade> I<number> 123=item B<-fade> I<number>
116 124
117Fade the text by the given percentage when focus is lost. Small values 125Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade 126fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>. 127colour; resource B<fading>.
120 128
121=item B<-fadecolor> I<colour> 129=item B<-fadecolor> I<colour>
122 130
123Fade to this colour when fading is used (see B<-fade>). The default colour 131Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>. 132is opaque black. resource B<fadeColor>.
125 133
126=item B<-tint> I<colour> 134=item B<-tint> I<colour>
127 135
128Tint the transparent background pixmap with the given colour when 136Tint the transparent background pixmap with the given colour when
129transparency is enabled with B<-tr> or B<-ip>. This only works for 137transparency is enabled with B<-tr> or B<-ip>. This only works for
… …
172resource B<borderColor>. 180resource B<borderColor>.
173 181
174=item B<-fn> I<fontlist> 182=item B<-fn> I<fontlist>
175 183
176Select the fonts to be used. This is a comma separated list of font names 184Select the fonts to be used. This is a comma separated list of font names
177that are used in turn when trying to display Unicode characters. The 185that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 186first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 187smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 188font list is always appended to it. See resource B<font> for more details.
181 189
182In short, to specify an X11 core font, just specify it's name or prefix it 190In short, to specify an X11 core font, just specify it's name or prefix it
… …
189See also the question "How does rxvt-unicode choose fonts?" in the FAQ 197See also the question "How does rxvt-unicode choose fonts?" in the FAQ
190section of @@RXVT_NAME@@(7). 198section of @@RXVT_NAME@@(7).
191 199
192=item B<-fb> I<fontlist> 200=item B<-fb> I<fontlist>
193 201
194Compile font-styles: The bold font list to use when bold characters are to 202Compile I<font-styles>: The bold font list to use when B<bold> characters
195be printed. See resource B<boldFont> for details. 203are to be printed. See resource B<boldFont> for details.
196 204
197=item B<-fi> I<fontlist> 205=item B<-fi> I<fontlist>
198 206
199Compile font-styles: The italic font list to use when bold characters are to 207Compile I<font-styles>: The italic font list to use when I<italic>
200be printed. See resource B<italicFont> for details. 208characters are to be printed. See resource B<italicFont> for details.
201 209
202=item B<-fbi> I<fontlist> 210=item B<-fbi> I<fontlist>
203 211
204Compile font-styles: The bold italic font list to use when bold characters are to 212Compile I<font-styles>: The bold italic font list to use when B<< I<bold
205be printed. See resource B<boldItalicFont> for details. 213italic> >> characters are to be printed. See resource B<boldItalicFont>
214for details.
215
216=item B<-is>|B<+is>
217
218Compile I<font-styles>: Bold/Italic font styles imply high intensity
219foreground/background (default). See resource B<intensityStyles> for
220details.
206 221
207=item B<-name> I<name> 222=item B<-name> I<name>
208 223
209Specify the application name under which resources are to be obtained, 224Specify the application name under which resources are to be obtained,
210rather than the default executable file name. Name should not contain 225rather than the default executable file name. Name should not contain
… …
289=item B<-bl> 304=item B<-bl>
290 305
291Compile I<frills>: Set MWM hints to request a borderless window, i.e. 306Compile I<frills>: Set MWM hints to request a borderless window, i.e.
292if honoured by the WM, the rxvt-unicode window will not have window 307if honoured by the WM, the rxvt-unicode window will not have window
293decorations; resource B<borderLess>. 308decorations; resource B<borderLess>.
309
310=item B<-override-redirect>
311
312Compile I<frills>: Sets override-redirect on the window; resource
313B<override-redirect>.
314
315=item B<-sbg>
316
317Compile I<frills>: Disable the usage of the built-in block graphics/line
318drawing characters and just rely on what the specified fonts provide. Use
319this if you have a good font and want to use its block graphic glyphs;
320resource B<skipBuiltinGlyphs>.
294 321
295=item B<-lsp> I<number> 322=item B<-lsp> I<number>
296 323
297Compile I<frills>: Lines (pixel height) to insert between each row of 324Compile I<frills>: Lines (pixel height) to insert between each row of
298the display. Useful to work around font rendering problems; resource 325the display. Useful to work around font rendering problems; resource
… …
313given on the command line. If this option is used, it must be the last 340given on the command line. If this option is used, it must be the last
314on the command-line. If there is no B<-e> option then the default is to 341on the command-line. If there is no B<-e> option then the default is to
315run the program specified by the B<SHELL> environment variable or, 342run the program specified by the B<SHELL> environment variable or,
316failing that, I<sh(1)>. 343failing that, I<sh(1)>.
317 344
345Please note that you must specify a program with arguments. If you want to
346run shell commands, you have to specify the shell, like this:
347
348 @@RXVT_NAME@@ -e sh -c "shell commands"
349
318=item B<-title> I<text> 350=item B<-title> I<text>
319 351
320Window title (B<-T> still respected); the default title is the basename 352Window title (B<-T> still respected); the default title is the basename
321of the program specified after the B<-e> option, if any, otherwise the 353of the program specified after the B<-e> option, if any, otherwise the
322application name; resource B<title>. 354application name; resource B<title>.
… …
377 409
378=item B<-ssr>|B<+ssr> 410=item B<-ssr>|B<+ssr>
379 411
380Turn on/off secondary screen scroll (default enabled); resource 412Turn on/off secondary screen scroll (default enabled); resource
381B<secondaryScroll>. 413B<secondaryScroll>.
414
415=item B<-hold>|B<+hold>
416
417Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
418will not immediately destroy its window when the program executed within
419it exits. Instead, it will wait till it is being killed or closed by the
420user; resource B<hold>.
382 421
383=item B<-keysym.>I<sym> I<string> 422=item B<-keysym.>I<sym> I<string>
384 423
385Remap a key symbol. See resource B<keysym>. 424Remap a key symbol. See resource B<keysym>.
386 425
… …
409 $rxvt->signal_connect_after (realize => sub { 448 $rxvt->signal_connect_after (realize => sub {
410 my $xid = $_[0]->window->get_xid; 449 my $xid = $_[0]->window->get_xid;
411 system "@@RXVT_NAME@@ -embed $xid &"; 450 system "@@RXVT_NAME@@ -embed $xid &";
412 }); 451 });
413 452
414=item B<-pty-fd> I<fileno> 453=item B<-pty-fd> I<file descriptor>
415 454
416Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 455Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
417pair but instead use the given filehandle as the tty master. This is 456pair but instead use the given filehandle as the tty master. This is
418useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 457useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
419without having to run a program within it. 458without having to run a program within it.
420 459
421If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 460If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
422entries and will not tinker with pty/tty permissions - you have to do that 461entries and will not tinker with pty/tty permissions - you have to do that
423yourself if you want that. 462yourself if you want that.
424 463
464As an extremely special case, specifying C<-1> will completely suppress
465pty/tty operations.
466
425Here is a example in perl that illustrates how this option can be used (a 467Here is a example in perl that illustrates how this option can be used (a
426longer example is in F<doc/pty-fd>): 468longer example is in F<doc/pty-fd>):
427 469
428 use IO::Pty; 470 use IO::Pty;
429 use Fcntl; 471 use Fcntl;
… …
435 477
436 # now communicate with rxvt 478 # now communicate with rxvt
437 my $slave = $pty->slave; 479 my $slave = $pty->slave;
438 while (<$slave>) { print $slave "got <$_>\n" } 480 while (<$slave>) { print $slave "got <$_>\n" }
439 481
482=item B<-pe> I<string>
483
484Comma-separated list of perl extension scripts to use (or not to use) in
485this terminal instance. See resource B<perl-ext> for details.
486
440=back 487=back
441 488
442=head1 RESOURCES (available also as long-options) 489=head1 RESOURCES (available also as long-options)
443 490
444Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 491Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
445options) compiled into your version. 492options) compiled into your version.
446 493
447There are two different methods that @@RXVT_NAME@@ can use to get the 494You can set and change the resources using X11 tools like B<xrdb>. Many
448Xresource data: using the X libraries (Xrm*-functions) or internal 495distribution do also load settings from the B<~/.Xresources> file when X
449Xresources reader (B<~/.Xdefaults>). For the first method (ie. 496starts. @@RXVT_NAME@@ will consult the following files/resources in order,
450B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 497with later settings overwriting earlier ones:
451resources using X11 tools like B<xrdb>. Many distribution do also load
452settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
453will consult the following files/resources in order, with later settings
454overwriting earlier ones:
455 498
456 1. system-wide app-defaults file, either locale-dependent OR global 499 1. system-wide app-defaults file, either locale-dependent OR global
457 2. app-defaults file in $XAPPLRESDIR 500 2. app-defaults file in $XAPPLRESDIR
458 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 501 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
459 4. SCREEN_RESOURCES for the current screen 502 4. SCREEN_RESOURCES for the current screen
460 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 503 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
461 504
462If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
463lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
464set in XAPPLOADDIR/URxvt (compile-time defined: usually
465B</usr/lib/X11/app-defaults/URxvt>) and resources set in
466B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
467Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 505Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
468class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 506names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
469resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 507common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
470easily configured, while the class name B<URxvt> allows resources 508configured, while the class name B<URxvt> allows resources unique to
471unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 509B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
472shared between different B<@@RXVT_NAME@@> configurations. If no 510configurations. If no resources are specified, suitable defaults will
473resources are specified, suitable defaults will be used. Command-line 511be used. Command-line arguments can be used to override resource
474arguments can be used to override resource settings. The following 512settings. The following resources are supported (you might want to
475resources are allowed: 513check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
514extensions not documented here):
476 515
477=over 4 516=over 4
517
518=item B<depth:> I<bitdepth>
519
520Compile I<xft>: Attempt to find a visual with the given bit depth;
521option B<-depth>.
478 522
479=item B<geometry:> I<geom> 523=item B<geometry:> I<geom>
480 524
481Create the window with the specified X window geometry [default 80x24]; 525Create the window with the specified X window geometry [default 80x24];
482option B<-geometry>. 526option B<-geometry>.
… …
555=item B<inheritPixmap:> I<boolean> 599=item B<inheritPixmap:> I<boolean>
556 600
557B<True>: make the background inherit the parent windows' pixmap, giving 601B<True>: make the background inherit the parent windows' pixmap, giving
558artificial transparency. B<False>: do not inherit the parent windows' 602artificial transparency. B<False>: do not inherit the parent windows'
559pixmap. 603pixmap.
604
605I<Please note that transparency of any kind if completely unsupported by
606the author. Don't bug him with installation questions!>
560 607
561=item B<fading:> I<number> 608=item B<fading:> I<number>
562 609
563Fade the text by the given percentage when focus is lost; option B<-fade>. 610Fade the text by the given percentage when focus is lost; option B<-fade>.
564 611
… …
601of 1 displays the image without any scaling. A scale of 2 to 9 648of 1 displays the image without any scaling. A scale of 2 to 9
602specifies an integer number of images in that direction. No image will 649specifies an integer number of images in that direction. No image will
603be magnified beyond 10 times its original size. The maximum permitted 650be magnified beyond 10 times its original size. The maximum permitted
604scale is 1000. [default 0x0+50+50] 651scale is 1000. [default 0x0+50+50]
605 652
606=item B<menu:> I<file[;tag]>
607
608Read in the specified menu file (note the `.menu' extension is
609optional) and also optionally specify a starting tag to find. See the
610reference documentation for details on the syntax for the menuBar.
611
612=item B<path:> I<path> 653=item B<path:> I<path>
613 654
614Specify the colon-delimited search path for finding files (XPM and 655Specify the colon-delimited search path for finding XPM files.
615menus), in addition to the paths specified by the B<RXVTPATH> and
616B<PATH> environment variables.
617 656
618=item B<font:> I<fontlist> 657=item B<font:> I<fontlist>
619 658
620Select the fonts to be used. This is a comma separated list of font 659Select the fonts to be used. This is a comma separated list of font names
621names that are used in turn when trying to display Unicode characters. 660that are checked in order when trying to find glyphs for characters. The
622The first font defines the cell size for characters; other fonts might 661first font defines the cell size for characters; other fonts might be
623be smaller, but not larger. A reasonable default font list is always 662smaller, but not (in general) larger. A (hopefully) reasonable default
624appended to it. option B<-fn>. 663font list is always appended to it; option B<-fn>.
625 664
626Each font can either be a standard X11 core font (XLFD) name, with 665Each font can either be a standard X11 core font (XLFD) name, with
627optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 666optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
628 667
629In addition, each font can be prefixed with additional hints and 668In addition, each font can be prefixed with additional hints and
… …
631hint currently is C<codeset=codeset-name>, and this is only used for Xft 670hint currently is C<codeset=codeset-name>, and this is only used for Xft
632fonts. 671fonts.
633 672
634For example, this font resource 673For example, this font resource
635 674
636 URxvt*font: 9x15bold,\ 675 URxvt.font: 9x15bold,\
637 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 676 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
638 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 677 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
639 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 678 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
640 xft:Code2000:antialias=false 679 xft:Code2000:antialias=false
641 680
… …
675not possible, replacement fonts of the desired shape will be tried. 714not possible, replacement fonts of the desired shape will be tried.
676 715
677If set, but empty, then this specific style is disabled and the normal 716If set, but empty, then this specific style is disabled and the normal
678text font will being used for the given style. 717text font will being used for the given style.
679 718
719=item B<intensityStyles:> I<boolean>
720
721When font styles are not enabled, or this option is enabled (B<True>,
722option B<-is>, the default), bold and italic font styles imply high
723intensity foreground/backround colours. Disabling this option (B<False>,
724option B<+is>) disables this behaviour, the high intensity colours are not
725reachable.
726
680=item B<selectstyle:> I<mode> 727=item B<selectstyle:> I<mode>
681 728
682Set mouse selection style to B<old> which is 2.20, B<oldword> which is 729Set mouse selection style to B<old> which is 2.20, B<oldword> which is
683xterm style with 2.20 old word selection, or anything else which gives 730xterm style with 2.20 old word selection, or anything else which gives
684xterm style selection. 731xterm style selection.
… …
730 777
731The string will be interpreted as if typed into the shell as-is. 778The string will be interpreted as if typed into the shell as-is.
732 779
733Example: 780Example:
734 781
735 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 782 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
736 783
737This creates a new file in your home directory with the screen contents 784This creates a new file in your home directory with the screen contents
738everytime you hit C<Print>. 785everytime you hit C<Print>.
739 786
740=item B<scrollBar:> I<boolean> 787=item B<scrollBar:> I<boolean>
… …
794=item B<borderLess:> I<boolean> 841=item B<borderLess:> I<boolean>
795 842
796Set MWM hints to request a borderless window, i.e. if honoured by the 843Set MWM hints to request a borderless window, i.e. if honoured by the
797WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 844WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
798 845
846=item B<skipBuiltinGlyphs:> I<boolean>
847
848Compile I<frills>: Disable the usage of the built-in block graphics/line
849drawing characters and just rely on what the specified fonts provide. Use
850this if you have a good font and want to use its block graphic glyphs;
851option B<-sbg>.
852
799=item B<termName:> I<termname> 853=item B<termName:> I<termname>
800 854
801Specifies the terminal type name to be set in the B<TERM> environment 855Specifies the terminal type name to be set in the B<TERM> environment
802variable; option B<-tn>. 856variable; option B<-tn>.
803 857
… …
858pressed. If unset it will send the sequence traditionally associated 912pressed. If unset it will send the sequence traditionally associated
859with the B<Execute> key. 913with the B<Execute> key.
860 914
861=item B<cutchars:> I<string> 915=item B<cutchars:> I<string>
862 916
863The characters used as delimiters for double-click word selection. The 917The characters used as delimiters for double-click word selection
864built-in default: 918(whitespace delimiting is added automatically if resource is given).
919
920When the selection extension is in use (the default if compiled in, see
921the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
922will be created (if the resource exists, otherwise, no regex will be
923created). In this mode, characters outside ISO-8859-1 can be used.
924
925When the selection extension is not used, only ISO-8859-1 characters can
926be used. If not specified, the built-in default is used:
865 927
866B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 928B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
867 929
868=item B<preeditType:> I<style> 930=item B<preeditType:> I<style>
869 931
… …
876=item B<imLocale:> I<name> 938=item B<imLocale:> I<name>
877 939
878The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 940The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
879C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the 941C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
880input extension to be able to input japanese characters while staying in 942input extension to be able to input japanese characters while staying in
881another locale. option B<-imlocale>. 943another locale; option B<-imlocale>.
882 944
883=item B<imFont:> I<fontset> 945=item B<imFont:> I<fontset>
884 946
885Specify the font-set used for XIM styles C<OverTheSpot> or 947Specify the font-set used for XIM styles C<OverTheSpot> or
886C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 948C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
… …
891 953
892=item B<tripleclickwords:> I<boolean> 954=item B<tripleclickwords:> I<boolean>
893 955
894Change the meaning of triple-click selection with the left mouse 956Change the meaning of triple-click selection with the left mouse
895button. Instead of selecting a full line it will extend the selection to 957button. Instead of selecting a full line it will extend the selection to
896the end of the logical line only. option B<-tcw>. 958the end of the logical line only; option B<-tcw>.
897 959
898=item B<insecure:> I<boolean> 960=item B<insecure:> I<boolean>
899 961
900Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 962Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
901echo arbitrary strings like the icon name or the locale. This could be 963echo arbitrary strings like the icon name or the locale. This could be
… …
905default. (Note that many other terminals, including xterm, have these 967default. (Note that many other terminals, including xterm, have these
906sequences enabled by default, which doesn't make it safer, though). 968sequences enabled by default, which doesn't make it safer, though).
907 969
908You can enable them by setting this boolean resource or specifying 970You can enable them by setting this boolean resource or specifying
909B<-insecure> as an option. At the moment, this enables display-answer, 971B<-insecure> as an option. At the moment, this enables display-answer,
910locale, findfont, icon label and window title requests as well as dynamic 972locale, findfont, icon label and window title requests.
911menubar dispatch.
912 973
913=item B<modifier:> I<modifier> 974=item B<modifier:> I<modifier>
914 975
915Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 976Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
916B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 977B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
… …
920 981
921Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 982Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
922character is passed through. It may contain escape values as described 983character is passed through. It may contain escape values as described
923in the entry on B<keysym> following. 984in the entry on B<keysym> following.
924 985
925=item B<secondaryScreen:> I<bool> 986=item B<secondaryScreen:> I<boolean>
926 987
927Turn on/off secondary screen (default enabled). 988Turn on/off secondary screen (default enabled).
928 989
929=item B<secondaryScroll:> I<bool> 990=item B<secondaryScroll:> I<boolean>
930 991
931Turn on/off secondary screen scroll (default enabled). If the this 992Turn on/off secondary screen scroll (default enabled). If the this
932option is enabled, scrolls on the secondary screen will change the 993option is enabled, scrolls on the secondary screen will change the
933scrollback buffer and switching to/from the secondary screen will 994scrollback buffer and switching to/from the secondary screen will
934instead scroll the screen up. 995instead scroll the screen up.
996
997=item B<hold>: I<boolean>
998
999Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1000will not immediately destroy its window when the program executed within
1001it exits. Instead, it will wait till it is being killed or closed by the
1002user.
935 1003
936=item B<keysym.>I<sym>: I<string> 1004=item B<keysym.>I<sym>: I<string>
937 1005
938Compile I<frills>: Associate I<string> with keysym I<sym>. The 1006Compile I<frills>: Associate I<string> with keysym I<sym>. The
939intervening resource name B<keysym.> cannot be omitted. 1007intervening resource name B<keysym.> cannot be omitted.
… …
959C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1027C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
960C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1028C<\000>: octal number) or verbatim control characters (C<^?>: delete,
961C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1029C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
962can start or end with whitespace. 1030can start or end with whitespace.
963 1031
964Please note that you need to double the C<\> when using 1032Please note that you need to double the C<\> in resource files, as
965C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can 1033Xlib itself does it's own de-escaping (you can use C<\033> instead of
966use C<\033> instead of C<\e> (and so on), which will work with both Xt and 1034C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
967@@RXVT_NAME@@'s own processing). 1035processing).
968 1036
969You can define a range of keysyms in one shot by providing a I<string> 1037You can define a range of keysyms in one shot by providing a I<string>
970with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1038with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
971should be a character not used by the strings. 1039should be a character not used by the strings.
972 1040
… …
984is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1052is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
985example the following means "change the current locale to C<zh_CN.GBK> 1053example the following means "change the current locale to C<zh_CN.GBK>
986when Control-Meta-c is being pressed": 1054when Control-Meta-c is being pressed":
987 1055
988 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1056 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1057
1058If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1059is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1060manpage. For example, the F<selection> extension (activated via
1061C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1062
1063 URxvt.keysym.M-C-c: perl:selection:rot13
989 1064
990Due the the large number of modifier combinations, a defined key mapping 1065Due the the large number of modifier combinations, a defined key mapping
991will match if at I<at least> the specified identifiers are being set, and 1066will match if at I<at least> the specified identifiers are being set, and
992no other key mappings with those and more bits are being defined. That 1067no other key mappings with those and more bits are being defined. That
993means that defining a key map for C<a> will automatically provide 1068means that defining a key map for C<a> will automatically provide
… …
1017info): 1092info):
1018 1093
1019 URxvt.keysym.M-C-3: command:\033[8;25;80t 1094 URxvt.keysym.M-C-3: command:\033[8;25;80t
1020 URxvt.keysym.M-C-4: command:\033[8;48;110t 1095 URxvt.keysym.M-C-4: command:\033[8;48;110t
1021 1096
1097=item B<perl-ext-common>: I<string>
1098
1099=item B<perl-ext>: I<string>
1100
1101Comma-separated list(s) of perl extension scripts (default: C<default>) to
1102use in this terminal instance; option B<-pe>.
1103
1104Extension names can be prefixed with a C<-> sign to prohibit using
1105them. This can be useful to selectively disable some extensions loaded
1106by default, or specified via the C<perl-ext-common> resource. For
1107example, C<default,-selection> will use all the default extension except
1108C<selection>.
1109
1110Extension names can also be followed by an argument in angle brackets
1111(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1112searchable scorllback to Alt/Meta-s). Mentioning the same extension
1113multiple times with different arguments will pass multiple arguments to
1114the extension.
1115
1116Each extension is looked up in the library directories, loaded if
1117necessary, and bound to the current terminal instance.
1118
1119If both of these resources are the empty string, then the perl
1120interpreter will not be initialized. The idea behind two options is that
1121B<perl-ext-common> will be used for extensions that should be available to
1122all instances, while B<perl-ext> is used for specific instances.
1123
1124=item B<perl-eval>: I<string>
1125
1126Perl code to be evaluated when all extensions have been registered. See
1127the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1128will be ignored when running setuid/setgid.
1129
1130=item B<perl-lib>: I<path>
1131
1132Colon-separated list of additional directories that hold extension
1133scripts. When looking for extensions specified by the C<perl> resource,
1134@@RXVT_NAME@@ will first look in these directories and then in
1135F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1136will be ignored when running setuid/setgid.
1137
1138See the @@RXVT_NAME@@perl(3) manpage.
1139
1140=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1141
1142Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1143details.
1144
1145=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1146
1147Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1148for details.
1149
1150=item B<searchable-scrollback:> I<keysym>
1151
1152Sets the hotkey that starts the incremental scrollback buffer search
1153(default: C<M-s>).
1154
1155=item B<urlLauncher>: I<string>
1156
1157Specifies the program to be started with a URL argument. Used by the
1158C<selection-popup> and C<mark-urls> perl extensions.
1159
1160=item B<transient-for>: I<windowid>
1161
1162Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1163
1164=item B<override-redirect>: I<boolean>
1165
1166Compile I<frills>: Sets override-redirect for the terminal window, making
1167it almost invisible to window managers; option B<-override-redirect>.
1168
1022=back 1169=back
1023 1170
1024=head1 THE SCROLLBAR 1171=head1 THE SCROLLBAR
1025 1172
1026Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1173Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
… …
1060to select a word; Left triple-click to select the entire logical line 1207to select a word; Left triple-click to select the entire logical line
1061(which can span multiple screen lines), unless modified by resource 1208(which can span multiple screen lines), unless modified by resource
1062B<tripleclickwords>. 1209B<tripleclickwords>.
1063 1210
1064Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1211Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1065(Compile: I<frills>) will create a rectangular selection instead of a normal 1212(Compile: I<frills>) will create a rectangular selection instead of a
1066one. 1213normal one. In this mode, every selected row becomes its own line in the
1214selection, and trailing whitespace is visually underlined and removed from
1215the selection.
1067 1216
1068=item B<Insertion>: 1217=item B<Insertion>:
1069 1218
1070Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1219Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1071an B<@@RXVT_NAME@@> window causes the current text selection to be 1220window causes the value of the PRIMARY selection (or CLIPBOARD with the
1072inserted as if it had been typed on the keyboard. 1221Meta modifier) to be inserted as if it had been typed on the keyboard.
1222
1223Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1224inserted too.
1073 1225
1074=back 1226=back
1075 1227
1076=head1 CHANGING FONTS 1228=head1 CHANGING FONTS
1077 1229
1078Changing fonts (or font sizes, respectively) via the keypad is not yet 1230Changing fonts (or font sizes, respectively) via the keypad is not yet
1079supported in rxvt-unicode. Bug me if you need this. 1231supported in rxvt-unicode. Bug me if you need this.
1080 1232
1081You can, however, switch fonts at runtime using escape sequences (and 1233You can, however, switch fonts at runtime using escape sequences, e.g.:
1082therefore using the menubar), e.g.:
1083 1234
1084 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1235 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1236
1237You can use keyboard shortcuts, too:
1238
1239 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1240 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1085 1241
1086rxvt-unicode will automatically re-apply these fonts to the output so far. 1242rxvt-unicode will automatically re-apply these fonts to the output so far.
1087 1243
1088=head1 ISO 14755 SUPPORT 1244=head1 ISO 14755 SUPPORT
1089 1245
… …
1160=head1 COLORS AND GRAPHICS 1316=head1 COLORS AND GRAPHICS
1161 1317
1162In addition to the default foreground and background colours, 1318In addition to the default foreground and background colours,
1163B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1319B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1164high-intensity bold/blink versions of the same). Here is a list of the 1320high-intensity bold/blink versions of the same). Here is a list of the
1165colours with their B<rgb.txt> names. 1321colours with their names.
1166 1322
1167=begin table 1323=begin table
1168 1324
1169 B<color0> (black) = Black 1325 B<color0> (black) = Black
1170 B<color1> (red) = Red3 1326 B<color1> (red) = Red3
… …
1204would yield White on Black, while on I<xterm>(1) it would yield Black 1360would yield White on Black, while on I<xterm>(1) it would yield Black
1205on White. 1361on White.
1206 1362
1207=back 1363=back
1208 1364
1365=head2 ALPHA CHANNEL SUPPORT
1366
1367If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1368their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1369(recommended, but B<MUST> have 4 digits/component) colour specifications,
1370in addition to the ones provided by X, where the additional A component
1371specifies opacity (alpha) values. The minimum value of C<0> is completely
1372transparent). You can also prefix any color with C<[a]>, where C<a> is on
1373to four hex digits specifiying the opacity value.
1374
1375You probably need to specify B<"-depth 32">, too, and have the luck that
1376your X-server uses ARGB pixel layout, as X is far from just supporting
1377ARGB visuals out of the box, and rxvt-unicode just fudges around.
1378
1379For example, the following selects an almost completely transparent red
1380background, and an almost opaque pink foreground:
1381
1382 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1383
1384I<Please note that transparency of any kind if completely unsupported by
1385the author. Don't bug him with installation questions!>
1386
1209=head1 ENVIRONMENT 1387=head1 ENVIRONMENT
1210 1388
1211B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1389B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1212 1390
1213=over 4 1391=over 4
… …
1251 1429
1252=item B<SHELL> 1430=item B<SHELL>
1253 1431
1254The shell to be used for command execution, defaults to C</bin/sh>. 1432The shell to be used for command execution, defaults to C</bin/sh>.
1255 1433
1256=item B<RXVTPATH>
1257
1258The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1259files.
1260
1261=item B<PATH>
1262
1263Used in the same way as C<RXVTPATH>.
1264
1265=item B<RXVT_SOCKET> 1434=item B<RXVT_SOCKET>
1266 1435
1267The unix domain socket path used by @@RXVT_NAME@@c(1) and 1436The unix domain socket path used by @@RXVT_NAME@@c(1) and
1268@@RXVT_NAME@@d(1). 1437@@RXVT_NAME@@d(1).
1269 1438
… …
1338 1507
1339Project Coordinator (changes.txt 2.21a to 2.4.5) 1508Project Coordinator (changes.txt 2.21a to 2.4.5)
1340 1509
1341=item Geoff Wing L<< <gcw@pobox.com> >> 1510=item Geoff Wing L<< <gcw@pobox.com> >>
1342 1511
1343Rewrote screen display and text selection routines. Project Coordinator 1512Rewrote screen display and text selection routines.
1513
1344(changes.txt 2.4.6 - rxvt-unicode) 1514Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1345 1515
1346=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1516=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1347 1517
1348Forked rxvt-unicode, rewrote most of the display code and internal 1518Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1349character handling to store text in unicode, improve xterm 1519extension, random hacks, numerous bugfixes and extensions.
1350compatibility and apply numerous other bugfixes and extensions.
1351 1520
1352Project Coordinator (Changes 1.0 -) 1521Project Coordinator (Changes 1.0 -)
1353 1522
1523=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1524
1525Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1526
1354=back 1527=back
1355 1528

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines