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.104 by root, Wed Jan 25 13:24:45 2006 UTC

172resource B<borderColor>. 172resource B<borderColor>.
173 173
174=item B<-fn> I<fontlist> 174=item B<-fn> I<fontlist>
175 175
176Select 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
177that are used in turn when trying to display Unicode characters. The 177that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 178first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 179smaller, but not (in general) larger. A (hopefully) reasonable default
180font 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.
181 181
182In 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
189See 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
190section of @@RXVT_NAME@@(7). 190section of @@RXVT_NAME@@(7).
191 191
192=item B<-fb> I<fontlist> 192=item B<-fb> I<fontlist>
193 193
194Compile 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
195be printed. See resource B<boldFont> for details. 195are to be printed. See resource B<boldFont> for details.
196 196
197=item B<-fi> I<fontlist> 197=item B<-fi> I<fontlist>
198 198
199Compile 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>
200be printed. See resource B<italicFont> for details. 200characters are to be printed. See resource B<italicFont> for details.
201 201
202=item B<-fbi> I<fontlist> 202=item B<-fbi> I<fontlist>
203 203
204Compile 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
205be 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.
206 213
207=item B<-name> I<name> 214=item B<-name> I<name>
208 215
209Specify the application name under which resources are to be obtained, 216Specify the application name under which resources are to be obtained,
210rather than the default executable file name. Name should not contain 217rather than the default executable file name. Name should not contain
289=item B<-bl> 296=item B<-bl>
290 297
291Compile 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.
292if 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
293decorations; 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>.
294 313
295=item B<-lsp> I<number> 314=item B<-lsp> I<number>
296 315
297Compile I<frills>: Lines (pixel height) to insert between each row of 316Compile I<frills>: Lines (pixel height) to insert between each row of
298the display. Useful to work around font rendering problems; resource 317the display. Useful to work around font rendering problems; resource
313given 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
314on 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
315run the program specified by the B<SHELL> environment variable or, 334run the program specified by the B<SHELL> environment variable or,
316failing that, I<sh(1)>. 335failing that, I<sh(1)>.
317 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
318=item B<-title> I<text> 342=item B<-title> I<text>
319 343
320Window title (B<-T> still respected); the default title is the basename 344Window title (B<-T> still respected); the default title is the basename
321of 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
322application name; resource B<title>. 346application name; resource B<title>.
377 401
378=item B<-ssr>|B<+ssr> 402=item B<-ssr>|B<+ssr>
379 403
380Turn on/off secondary screen scroll (default enabled); resource 404Turn on/off secondary screen scroll (default enabled); resource
381B<secondaryScroll>. 405B<secondaryScroll>.
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>.
382 413
383=item B<-keysym.>I<sym> I<string> 414=item B<-keysym.>I<sym> I<string>
384 415
385Remap a key symbol. See resource B<keysym>. 416Remap a key symbol. See resource B<keysym>.
386 417
409 $rxvt->signal_connect_after (realize => sub { 440 $rxvt->signal_connect_after (realize => sub {
410 my $xid = $_[0]->window->get_xid; 441 my $xid = $_[0]->window->get_xid;
411 system "@@RXVT_NAME@@ -embed $xid &"; 442 system "@@RXVT_NAME@@ -embed $xid &";
412 }); 443 });
413 444
414=item B<-pty-fd> I<fileno> 445=item B<-pty-fd> I<file descriptor>
415 446
416Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 447Tells @@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 448pair 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 449useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
419without having to run a program within it. 450without having to run a program within it.
420 451
421If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 452If 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 453entries and will not tinker with pty/tty permissions - you have to do that
423yourself if you want that. 454yourself if you want that.
424 455
456As an extremely special case, specifying C<-1> will completely suppress
457pty/tty operations.
458
425Here is a example in perl that illustrates how this option can be used (a 459Here is a example in perl that illustrates how this option can be used (a
426longer example is in F<doc/pty-fd>): 460longer example is in F<doc/pty-fd>):
427 461
428 use IO::Pty; 462 use IO::Pty;
429 use Fcntl; 463 use Fcntl;
435 469
436 # now communicate with rxvt 470 # now communicate with rxvt
437 my $slave = $pty->slave; 471 my $slave = $pty->slave;
438 while (<$slave>) { print $slave "got <$_>\n" } 472 while (<$slave>) { print $slave "got <$_>\n" }
439 473
474=item B<-pe> I<string>
475
476Comma-separated list of perl extension scripts to use (or not to use) in
477this terminal instance. See resource B<perl-ext> for details.
478
440=back 479=back
441 480
442=head1 RESOURCES (available also as long-options) 481=head1 RESOURCES (available also as long-options)
443 482
444Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 483Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
445options) compiled into your version. 484options) compiled into your version.
446 485
447There 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
448Xresource data: using the X libraries (Xrm*-functions) or internal 487distribution do also load settings from the B<~/.Xresources> file when X
449Xresources reader (B<~/.Xdefaults>). For the first method (ie. 488starts. @@RXVT_NAME@@ will consult the following files/resources in order,
450B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 489with 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 490
456 1. system-wide app-defaults file, either locale-dependent OR global 491 1. system-wide app-defaults file, either locale-dependent OR global
457 2. app-defaults file in $XAPPLRESDIR 492 2. app-defaults file in $XAPPLRESDIR
458 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 493 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
459 4. SCREEN_RESOURCES for the current screen 494 4. SCREEN_RESOURCES for the current screen
460 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 495 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
461 496
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 497Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
468class 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
469resources 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
470easily configured, while the class name B<URxvt> allows resources 500configured, while the class name B<URxvt> allows resources unique to
471unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 501B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
472shared between different B<@@RXVT_NAME@@> configurations. If no 502configurations. If no resources are specified, suitable defaults will
473resources are specified, suitable defaults will be used. Command-line 503be used. Command-line arguments can be used to override resource
474arguments can be used to override resource settings. The following 504settings. The following resources are supported (you might want to
475resources are allowed: 505check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
506extensions not documented here):
476 507
477=over 4 508=over 4
478 509
479=item B<geometry:> I<geom> 510=item B<geometry:> I<geom>
480 511
601of 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
602specifies an integer number of images in that direction. No image will 633specifies an integer number of images in that direction. No image will
603be magnified beyond 10 times its original size. The maximum permitted 634be magnified beyond 10 times its original size. The maximum permitted
604scale is 1000. [default 0x0+50+50] 635scale is 1000. [default 0x0+50+50]
605 636
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> 637=item B<path:> I<path>
613 638
614Specify the colon-delimited search path for finding files (XPM and 639Specify 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 640
618=item B<font:> I<fontlist> 641=item B<font:> I<fontlist>
619 642
620Select 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
621names that are used in turn when trying to display Unicode characters. 644that are checked in order when trying to find glyphs for characters. The
622The first font defines the cell size for characters; other fonts might 645first font defines the cell size for characters; other fonts might be
623be smaller, but not larger. A reasonable default font list is always 646smaller, but not (in general) larger. A (hopefully) reasonable default
624appended to it. option B<-fn>. 647font list is always appended to it; option B<-fn>.
625 648
626Each 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
627optional 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:>.
628 651
629In addition, each font can be prefixed with additional hints and 652In addition, each font can be prefixed with additional hints and
631hint 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
632fonts. 655fonts.
633 656
634For example, this font resource 657For example, this font resource
635 658
636 URxvt*font: 9x15bold,\ 659 URxvt.font: 9x15bold,\
637 -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,\
638 -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, \
639 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 662 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
640 xft:Code2000:antialias=false 663 xft:Code2000:antialias=false
641 664
675not possible, replacement fonts of the desired shape will be tried. 698not possible, replacement fonts of the desired shape will be tried.
676 699
677If 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
678text font will being used for the given style. 701text font will being used for the given style.
679 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
680=item B<selectstyle:> I<mode> 711=item B<selectstyle:> I<mode>
681 712
682Set 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
683xterm 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
684xterm style selection. 715xterm style selection.
730 761
731The string will be interpreted as if typed into the shell as-is. 762The string will be interpreted as if typed into the shell as-is.
732 763
733Example: 764Example:
734 765
735 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 766 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
736 767
737This creates a new file in your home directory with the screen contents 768This creates a new file in your home directory with the screen contents
738everytime you hit C<Print>. 769everytime you hit C<Print>.
739 770
740=item B<scrollBar:> I<boolean> 771=item B<scrollBar:> I<boolean>
794=item B<borderLess:> I<boolean> 825=item B<borderLess:> I<boolean>
795 826
796Set 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
797WM, 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>.
798 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
799=item B<termName:> I<termname> 837=item B<termName:> I<termname>
800 838
801Specifies 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
802variable; option B<-tn>. 840variable; option B<-tn>.
803 841
858pressed. If unset it will send the sequence traditionally associated 896pressed. If unset it will send the sequence traditionally associated
859with the B<Execute> key. 897with the B<Execute> key.
860 898
861=item B<cutchars:> I<string> 899=item B<cutchars:> I<string>
862 900
863The characters used as delimiters for double-click word selection. The 901The characters used as delimiters for double-click word selection.
864built-in default: 902
903When the selection extension is in use (the default if compiled in, see
904the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
905will be created (if the resource exists, otherwise, no regex will be
906created). In this mode, characters outside ISO-8859-1 can be used.
907
908When the selection extension is not used, only ISO-8859-1 characters can
909be used. If not specified, the built-in default is used:
865 910
866B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 911B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
867 912
868=item B<preeditType:> I<style> 913=item B<preeditType:> I<style>
869 914
876=item B<imLocale:> I<name> 921=item B<imLocale:> I<name>
877 922
878The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 923The 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 924C<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 925input extension to be able to input japanese characters while staying in
881another locale. option B<-imlocale>. 926another locale; option B<-imlocale>.
882 927
883=item B<imFont:> I<fontset> 928=item B<imFont:> I<fontset>
884 929
885Specify the font-set used for XIM styles C<OverTheSpot> or 930Specify the font-set used for XIM styles C<OverTheSpot> or
886C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 931C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
891 936
892=item B<tripleclickwords:> I<boolean> 937=item B<tripleclickwords:> I<boolean>
893 938
894Change the meaning of triple-click selection with the left mouse 939Change the meaning of triple-click selection with the left mouse
895button. Instead of selecting a full line it will extend the selection to 940button. Instead of selecting a full line it will extend the selection to
896the end of the logical line only. option B<-tcw>. 941the end of the logical line only; option B<-tcw>.
897 942
898=item B<insecure:> I<boolean> 943=item B<insecure:> I<boolean>
899 944
900Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 945Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
901echo arbitrary strings like the icon name or the locale. This could be 946echo arbitrary strings like the icon name or the locale. This could be
905default. (Note that many other terminals, including xterm, have these 950default. (Note that many other terminals, including xterm, have these
906sequences enabled by default, which doesn't make it safer, though). 951sequences enabled by default, which doesn't make it safer, though).
907 952
908You can enable them by setting this boolean resource or specifying 953You can enable them by setting this boolean resource or specifying
909B<-insecure> as an option. At the moment, this enables display-answer, 954B<-insecure> as an option. At the moment, this enables display-answer,
910locale, findfont, icon label and window title requests as well as dynamic 955locale, findfont, icon label and window title requests.
911menubar dispatch.
912 956
913=item B<modifier:> I<modifier> 957=item B<modifier:> I<modifier>
914 958
915Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 959Set 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 960B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
920 964
921Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 965Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
922character is passed through. It may contain escape values as described 966character is passed through. It may contain escape values as described
923in the entry on B<keysym> following. 967in the entry on B<keysym> following.
924 968
925=item B<secondaryScreen:> I<bool> 969=item B<secondaryScreen:> I<boolean>
926 970
927Turn on/off secondary screen (default enabled). 971Turn on/off secondary screen (default enabled).
928 972
929=item B<secondaryScroll:> I<bool> 973=item B<secondaryScroll:> I<boolean>
930 974
931Turn on/off secondary screen scroll (default enabled). If the this 975Turn on/off secondary screen scroll (default enabled). If the this
932option is enabled, scrolls on the secondary screen will change the 976option is enabled, scrolls on the secondary screen will change the
933scrollback buffer and switching to/from the secondary screen will 977scrollback buffer and switching to/from the secondary screen will
934instead scroll the screen up. 978instead scroll the screen up.
979
980=item B<hold>: I<boolean>
981
982Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
983will not immediately destroy its window when the program executed within
984it exits. Instead, it will wait till it is being killed or closed by the
985user.
935 986
936=item B<keysym.>I<sym>: I<string> 987=item B<keysym.>I<sym>: I<string>
937 988
938Compile I<frills>: Associate I<string> with keysym I<sym>. The 989Compile I<frills>: Associate I<string> with keysym I<sym>. The
939intervening resource name B<keysym.> cannot be omitted. 990intervening resource name B<keysym.> cannot be omitted.
959C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1010C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
960C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1011C<\000>: octal number) or verbatim control characters (C<^?>: delete,
961C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1012C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
962can start or end with whitespace. 1013can start or end with whitespace.
963 1014
964Please note that you need to double the C<\> when using 1015Please 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 1016Xlib 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 1017C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
967@@RXVT_NAME@@'s own processing). 1018processing).
968 1019
969You can define a range of keysyms in one shot by providing a I<string> 1020You can define a range of keysyms in one shot by providing a I<string>
970with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1021with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
971should be a character not used by the strings. 1022should be a character not used by the strings.
972 1023
984is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1035is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
985example the following means "change the current locale to C<zh_CN.GBK> 1036example the following means "change the current locale to C<zh_CN.GBK>
986when Control-Meta-c is being pressed": 1037when Control-Meta-c is being pressed":
987 1038
988 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1039 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1040
1041If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1042is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1043manpage. For example, the F<selection> extension (activated via
1044C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1045
1046 URxvt.keysym.M-C-c: perl:selection:rot13
989 1047
990Due the the large number of modifier combinations, a defined key mapping 1048Due 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 1049will 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 1050no other key mappings with those and more bits are being defined. That
993means that defining a key map for C<a> will automatically provide 1051means that defining a key map for C<a> will automatically provide
1017info): 1075info):
1018 1076
1019 URxvt.keysym.M-C-3: command:\033[8;25;80t 1077 URxvt.keysym.M-C-3: command:\033[8;25;80t
1020 URxvt.keysym.M-C-4: command:\033[8;48;110t 1078 URxvt.keysym.M-C-4: command:\033[8;48;110t
1021 1079
1080=item B<perl-ext-common>: I<string>
1081
1082=item B<perl-ext>: I<string>
1083
1084Comma-separated list(s) of perl extension scripts (default: C<default>) to
1085use in this terminal instance; option B<-pe>.
1086
1087Extension names can be prefixed with a C<-> sign to prohibit using
1088them. This can be useful to selectively disable some extensions loaded
1089by default, or specified via the C<perl-ext-common> resource. For
1090example, C<default,-selection> will use all the default extension except
1091C<selection>.
1092
1093Extension names can also be followed by an argument in angle brackets
1094(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1095searchable scorllback to Alt/Meta-s). Mentioning the same extension
1096multiple times with different arguments will pass multiple arguments to
1097the extension.
1098
1099Each extension is looked up in the library directories, loaded if
1100necessary, and bound to the current terminal instance.
1101
1102If both of these resources are the empty string, then the perl
1103interpreter will not be initialized. The idea behind two options is that
1104B<perl-ext-common> will be used for extensions that should be available to
1105all instances, while B<perl-ext> is used for specific instances.
1106
1107=item B<perl-eval>: I<string>
1108
1109Perl code to be evaluated when all extensions have been registered. See
1110the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1111will be ignored when running setuid/setgid.
1112
1113=item B<perl-lib>: I<path>
1114
1115Colon-separated list of additional directories that hold extension
1116scripts. When looking for extensions specified by the C<perl> resource,
1117@@RXVT_NAME@@ will first look in these directories and then in
1118F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1119will be ignored when running setuid/setgid.
1120
1121See the @@RXVT_NAME@@perl(3) manpage.
1122
1123=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1124
1125Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1126details.
1127
1128=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1129
1130Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1131for details.
1132
1133=item B<searchable-scrollback:> I<keysym>
1134
1135Sets the hotkey that starts the incremental scrollback buffer search
1136(default: C<M-s>).
1137
1138=item B<urlLauncher>: I<string>
1139
1140Specifies the program to be started with a URL argument. Used by the
1141C<selection-popup> and C<mark-urls> perl extensions.
1142
1143=item B<transient-for>: I<windowid>
1144
1145Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1146
1147=item B<override-redirect>: I<boolean>
1148
1149Compile I<frills>: Sets override-redirect for the terminal window, making
1150it almost invisible to window managers; option B<-override-redirect>.
1151
1022=back 1152=back
1023 1153
1024=head1 THE SCROLLBAR 1154=head1 THE SCROLLBAR
1025 1155
1026Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1156Lines 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 1190to select a word; Left triple-click to select the entire logical line
1061(which can span multiple screen lines), unless modified by resource 1191(which can span multiple screen lines), unless modified by resource
1062B<tripleclickwords>. 1192B<tripleclickwords>.
1063 1193
1064Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1194Starting 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 1195(Compile: I<frills>) will create a rectangular selection instead of a
1066one. 1196normal one. In this mode, every selected row becomes its own line in the
1197selection, and trailing whitespace is visually underlined and removed from
1198the selection.
1067 1199
1068=item B<Insertion>: 1200=item B<Insertion>:
1069 1201
1070Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1202Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1071an B<@@RXVT_NAME@@> window causes the current text selection to be 1203window causes the value of the PRIMARY selection (or CLIPBOARD with the
1072inserted as if it had been typed on the keyboard. 1204Meta modifier) to be inserted as if it had been typed on the keyboard.
1205
1206Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1207inserted too.
1073 1208
1074=back 1209=back
1075 1210
1076=head1 CHANGING FONTS 1211=head1 CHANGING FONTS
1077 1212
1078Changing fonts (or font sizes, respectively) via the keypad is not yet 1213Changing fonts (or font sizes, respectively) via the keypad is not yet
1079supported in rxvt-unicode. Bug me if you need this. 1214supported in rxvt-unicode. Bug me if you need this.
1080 1215
1081You can, however, switch fonts at runtime using escape sequences (and 1216You can, however, switch fonts at runtime using escape sequences, e.g.:
1082therefore using the menubar), e.g.:
1083 1217
1084 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1218 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1219
1220You can use keyboard shortcuts, too:
1221
1222 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1223 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1085 1224
1086rxvt-unicode will automatically re-apply these fonts to the output so far. 1225rxvt-unicode will automatically re-apply these fonts to the output so far.
1087 1226
1088=head1 ISO 14755 SUPPORT 1227=head1 ISO 14755 SUPPORT
1089 1228
1251 1390
1252=item B<SHELL> 1391=item B<SHELL>
1253 1392
1254The shell to be used for command execution, defaults to C</bin/sh>. 1393The shell to be used for command execution, defaults to C</bin/sh>.
1255 1394
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> 1395=item B<RXVT_SOCKET>
1266 1396
1267The unix domain socket path used by @@RXVT_NAME@@c(1) and 1397The unix domain socket path used by @@RXVT_NAME@@c(1) and
1268@@RXVT_NAME@@d(1). 1398@@RXVT_NAME@@d(1).
1269 1399
1338 1468
1339Project Coordinator (changes.txt 2.21a to 2.4.5) 1469Project Coordinator (changes.txt 2.21a to 2.4.5)
1340 1470
1341=item Geoff Wing L<< <gcw@pobox.com> >> 1471=item Geoff Wing L<< <gcw@pobox.com> >>
1342 1472
1343Rewrote screen display and text selection routines. Project Coordinator 1473Rewrote screen display and text selection routines.
1474
1344(changes.txt 2.4.6 - rxvt-unicode) 1475Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1345 1476
1346=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1477=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1347 1478
1348Forked rxvt-unicode, rewrote most of the display code and internal 1479Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1349character handling to store text in unicode, improve xterm 1480extension, random hacks, numerous bugfixes and extensions.
1350compatibility and apply numerous other bugfixes and extensions.
1351 1481
1352Project Coordinator (Changes 1.0 -) 1482Project Coordinator (Changes 1.0 -)
1353 1483
1484=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1485
1486Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1487
1354=back 1488=back
1355 1489

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines