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.72 by root, Wed Dec 7 20:55:52 2005 UTC vs.
Revision 1.106 by root, Wed Jan 25 21:03:03 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<frills>: 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>
172resource B<borderColor>. 177resource B<borderColor>.
173 178
174=item B<-fn> I<fontlist> 179=item B<-fn> I<fontlist>
175 180
176Select the fonts to be used. This is a comma separated list of font names 181Select 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 182that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 183first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 184smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 185font list is always appended to it. See resource B<font> for more details.
181 186
182In short, to specify an X11 core font, just specify it's name or prefix it 187In 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 194See also the question "How does rxvt-unicode choose fonts?" in the FAQ
190section of @@RXVT_NAME@@(7). 195section of @@RXVT_NAME@@(7).
191 196
192=item B<-fb> I<fontlist> 197=item B<-fb> I<fontlist>
193 198
194Compile font-styles: The bold font list to use when bold characters are to 199Compile I<font-styles>: The bold font list to use when B<bold> characters
195be printed. See resource B<boldFont> for details. 200are to be printed. See resource B<boldFont> for details.
196 201
197=item B<-fi> I<fontlist> 202=item B<-fi> I<fontlist>
198 203
199Compile font-styles: The italic font list to use when bold characters are to 204Compile I<font-styles>: The italic font list to use when I<italic>
200be printed. See resource B<italicFont> for details. 205characters are to be printed. See resource B<italicFont> for details.
201 206
202=item B<-fbi> I<fontlist> 207=item B<-fbi> I<fontlist>
203 208
204Compile font-styles: The bold italic font list to use when bold characters are to 209Compile I<font-styles>: The bold italic font list to use when B<< I<bold
205be printed. See resource B<boldItalicFont> for details. 210italic> >> characters are to be printed. See resource B<boldItalicFont>
211for details.
212
213=item B<-is>|B<+is>
214
215Compile I<font-styles>: Bold/Italic font styles imply high intensity
216foreground/background (default). See resource B<intensityStyles> for
217details.
206 218
207=item B<-name> I<name> 219=item B<-name> I<name>
208 220
209Specify the application name under which resources are to be obtained, 221Specify the application name under which resources are to be obtained,
210rather than the default executable file name. Name should not contain 222rather than the default executable file name. Name should not contain
289=item B<-bl> 301=item B<-bl>
290 302
291Compile I<frills>: Set MWM hints to request a borderless window, i.e. 303Compile 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 304if honoured by the WM, the rxvt-unicode window will not have window
293decorations; resource B<borderLess>. 305decorations; resource B<borderLess>.
306
307=item B<-override-redirect>
308
309Compile I<frills>: Sets override-redirect on the window; resource
310B<override-redirect>.
311
312=item B<-sbg>
313
314Compile I<frills>: Disable the usage of the built-in block graphics/line
315drawing characters and just rely on what the specified fonts provide. Use
316this if you have a good font and want to use its block graphic glyphs;
317resource B<skipBuiltinGlyphs>.
294 318
295=item B<-lsp> I<number> 319=item B<-lsp> I<number>
296 320
297Compile I<frills>: Lines (pixel height) to insert between each row of 321Compile I<frills>: Lines (pixel height) to insert between each row of
298the display. Useful to work around font rendering problems; resource 322the display. Useful to work around font rendering problems; resource
313given on the command line. If this option is used, it must be the last 337given 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 338on 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, 339run the program specified by the B<SHELL> environment variable or,
316failing that, I<sh(1)>. 340failing that, I<sh(1)>.
317 341
342Please note that you must specify a program with arguments. If you want to
343run shell commands, you have to specify the shell, like this:
344
345 @@RXVT_NAME@@ -e sh -c "shell commands"
346
318=item B<-title> I<text> 347=item B<-title> I<text>
319 348
320Window title (B<-T> still respected); the default title is the basename 349Window title (B<-T> still respected); the default title is the basename
321of the program specified after the B<-e> option, if any, otherwise the 350of the program specified after the B<-e> option, if any, otherwise the
322application name; resource B<title>. 351application name; resource B<title>.
377 406
378=item B<-ssr>|B<+ssr> 407=item B<-ssr>|B<+ssr>
379 408
380Turn on/off secondary screen scroll (default enabled); resource 409Turn on/off secondary screen scroll (default enabled); resource
381B<secondaryScroll>. 410B<secondaryScroll>.
411
412=item B<-hold>|B<+hold>
413
414Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
415will not immediately destroy its window when the program executed within
416it exits. Instead, it will wait till it is being killed or closed by the
417user; resource B<hold>.
382 418
383=item B<-keysym.>I<sym> I<string> 419=item B<-keysym.>I<sym> I<string>
384 420
385Remap a key symbol. See resource B<keysym>. 421Remap a key symbol. See resource B<keysym>.
386 422
409 $rxvt->signal_connect_after (realize => sub { 445 $rxvt->signal_connect_after (realize => sub {
410 my $xid = $_[0]->window->get_xid; 446 my $xid = $_[0]->window->get_xid;
411 system "@@RXVT_NAME@@ -embed $xid &"; 447 system "@@RXVT_NAME@@ -embed $xid &";
412 }); 448 });
413 449
414=item B<-pty-fd> I<fileno> 450=item B<-pty-fd> I<file descriptor>
415 451
416Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 452Tells @@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 453pair 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 454useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
419without having to run a program within it. 455without having to run a program within it.
420 456
421If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 457If 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 458entries and will not tinker with pty/tty permissions - you have to do that
423yourself if you want that. 459yourself if you want that.
424 460
461As an extremely special case, specifying C<-1> will completely suppress
462pty/tty operations.
463
425Here is a example in perl that illustrates how this option can be used (a 464Here is a example in perl that illustrates how this option can be used (a
426longer example is in F<doc/pty-fd>): 465longer example is in F<doc/pty-fd>):
427 466
428 use IO::Pty; 467 use IO::Pty;
429 use Fcntl; 468 use Fcntl;
435 474
436 # now communicate with rxvt 475 # now communicate with rxvt
437 my $slave = $pty->slave; 476 my $slave = $pty->slave;
438 while (<$slave>) { print $slave "got <$_>\n" } 477 while (<$slave>) { print $slave "got <$_>\n" }
439 478
479=item B<-pe> I<string>
480
481Comma-separated list of perl extension scripts to use (or not to use) in
482this terminal instance. See resource B<perl-ext> for details.
483
440=back 484=back
441 485
442=head1 RESOURCES (available also as long-options) 486=head1 RESOURCES (available also as long-options)
443 487
444Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 488Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
445options) compiled into your version. 489options) compiled into your version.
446 490
447There are two different methods that @@RXVT_NAME@@ can use to get the 491You can set and change the resources using X11 tools like B<xrdb>. Many
448Xresource data: using the X libraries (Xrm*-functions) or internal 492distribution do also load settings from the B<~/.Xresources> file when X
449Xresources reader (B<~/.Xdefaults>). For the first method (ie. 493starts. @@RXVT_NAME@@ will consult the following files/resources in order,
450B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 494with 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 495
456 1. system-wide app-defaults file, either locale-dependent OR global 496 1. system-wide app-defaults file, either locale-dependent OR global
457 2. app-defaults file in $XAPPLRESDIR 497 2. app-defaults file in $XAPPLRESDIR
458 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 498 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
459 4. SCREEN_RESOURCES for the current screen 499 4. SCREEN_RESOURCES for the current screen
460 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 500 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
461 501
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 502Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
468class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 503names: 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 504common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
470easily configured, while the class name B<URxvt> allows resources 505configured, while the class name B<URxvt> allows resources unique to
471unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 506B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
472shared between different B<@@RXVT_NAME@@> configurations. If no 507configurations. If no resources are specified, suitable defaults will
473resources are specified, suitable defaults will be used. Command-line 508be used. Command-line arguments can be used to override resource
474arguments can be used to override resource settings. The following 509settings. The following resources are supported (you might want to
475resources are allowed: 510check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
511extensions not documented here):
476 512
477=over 4 513=over 4
514
515=item B<depth:> I<bitdepth>
516
517Compile I<frills>: Attempt to find a visual with the given bit depth;
518option B<-depth>.
478 519
479=item B<geometry:> I<geom> 520=item B<geometry:> I<geom>
480 521
481Create the window with the specified X window geometry [default 80x24]; 522Create the window with the specified X window geometry [default 80x24];
482option B<-geometry>. 523option B<-geometry>.
601of 1 displays the image without any scaling. A scale of 2 to 9 642of 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 643specifies an integer number of images in that direction. No image will
603be magnified beyond 10 times its original size. The maximum permitted 644be magnified beyond 10 times its original size. The maximum permitted
604scale is 1000. [default 0x0+50+50] 645scale is 1000. [default 0x0+50+50]
605 646
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> 647=item B<path:> I<path>
613 648
614Specify the colon-delimited search path for finding files (XPM and 649Specify 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 650
618=item B<font:> I<fontlist> 651=item B<font:> I<fontlist>
619 652
620Select the fonts to be used. This is a comma separated list of font 653Select 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. 654that are checked in order when trying to find glyphs for characters. The
622The first font defines the cell size for characters; other fonts might 655first font defines the cell size for characters; other fonts might be
623be smaller, but not larger. A reasonable default font list is always 656smaller, but not (in general) larger. A (hopefully) reasonable default
624appended to it. option B<-fn>. 657font list is always appended to it; option B<-fn>.
625 658
626Each font can either be a standard X11 core font (XLFD) name, with 659Each 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:>. 660optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
628 661
629In addition, each font can be prefixed with additional hints and 662In addition, each font can be prefixed with additional hints and
631hint currently is C<codeset=codeset-name>, and this is only used for Xft 664hint currently is C<codeset=codeset-name>, and this is only used for Xft
632fonts. 665fonts.
633 666
634For example, this font resource 667For example, this font resource
635 668
636 URxvt*font: 9x15bold,\ 669 URxvt.font: 9x15bold,\
637 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 670 -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, \ 671 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
639 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 672 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
640 xft:Code2000:antialias=false 673 xft:Code2000:antialias=false
641 674
675not possible, replacement fonts of the desired shape will be tried. 708not possible, replacement fonts of the desired shape will be tried.
676 709
677If set, but empty, then this specific style is disabled and the normal 710If set, but empty, then this specific style is disabled and the normal
678text font will being used for the given style. 711text font will being used for the given style.
679 712
713=item B<intensityStyles:> I<boolean>
714
715When font styles are not enabled, or this option is enabled (B<True>,
716option B<-is>, the default), bold and italic font styles imply high
717intensity foreground/backround colours. Disabling this option (B<False>,
718option B<+is>) disables this behaviour, the high intensity colours are not
719reachable.
720
680=item B<selectstyle:> I<mode> 721=item B<selectstyle:> I<mode>
681 722
682Set mouse selection style to B<old> which is 2.20, B<oldword> which is 723Set 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 724xterm style with 2.20 old word selection, or anything else which gives
684xterm style selection. 725xterm style selection.
730 771
731The string will be interpreted as if typed into the shell as-is. 772The string will be interpreted as if typed into the shell as-is.
732 773
733Example: 774Example:
734 775
735 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 776 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
736 777
737This creates a new file in your home directory with the screen contents 778This creates a new file in your home directory with the screen contents
738everytime you hit C<Print>. 779everytime you hit C<Print>.
739 780
740=item B<scrollBar:> I<boolean> 781=item B<scrollBar:> I<boolean>
794=item B<borderLess:> I<boolean> 835=item B<borderLess:> I<boolean>
795 836
796Set MWM hints to request a borderless window, i.e. if honoured by the 837Set 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>. 838WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
798 839
840=item B<skipBuiltinGlyphs:> I<boolean>
841
842Compile I<frills>: Disable the usage of the built-in block graphics/line
843drawing characters and just rely on what the specified fonts provide. Use
844this if you have a good font and want to use its block graphic glyphs;
845option B<-sbg>.
846
799=item B<termName:> I<termname> 847=item B<termName:> I<termname>
800 848
801Specifies the terminal type name to be set in the B<TERM> environment 849Specifies the terminal type name to be set in the B<TERM> environment
802variable; option B<-tn>. 850variable; option B<-tn>.
803 851
858pressed. If unset it will send the sequence traditionally associated 906pressed. If unset it will send the sequence traditionally associated
859with the B<Execute> key. 907with the B<Execute> key.
860 908
861=item B<cutchars:> I<string> 909=item B<cutchars:> I<string>
862 910
863The characters used as delimiters for double-click word selection. The 911The characters used as delimiters for double-click word selection
864built-in default: 912(whitespace delimiting is added automatically if resource is given).
913
914When the selection extension is in use (the default if compiled in, see
915the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
916will be created (if the resource exists, otherwise, no regex will be
917created). In this mode, characters outside ISO-8859-1 can be used.
918
919When the selection extension is not used, only ISO-8859-1 characters can
920be used. If not specified, the built-in default is used:
865 921
866B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 922B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
867 923
868=item B<preeditType:> I<style> 924=item B<preeditType:> I<style>
869 925
876=item B<imLocale:> I<name> 932=item B<imLocale:> I<name>
877 933
878The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 934The 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 935C<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 936input extension to be able to input japanese characters while staying in
881another locale. option B<-imlocale>. 937another locale; option B<-imlocale>.
882 938
883=item B<imFont:> I<fontset> 939=item B<imFont:> I<fontset>
884 940
885Specify the font-set used for XIM styles C<OverTheSpot> or 941Specify the font-set used for XIM styles C<OverTheSpot> or
886C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 942C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
891 947
892=item B<tripleclickwords:> I<boolean> 948=item B<tripleclickwords:> I<boolean>
893 949
894Change the meaning of triple-click selection with the left mouse 950Change the meaning of triple-click selection with the left mouse
895button. Instead of selecting a full line it will extend the selection to 951button. Instead of selecting a full line it will extend the selection to
896the end of the logical line only. option B<-tcw>. 952the end of the logical line only; option B<-tcw>.
897 953
898=item B<insecure:> I<boolean> 954=item B<insecure:> I<boolean>
899 955
900Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 956Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
901echo arbitrary strings like the icon name or the locale. This could be 957echo arbitrary strings like the icon name or the locale. This could be
902abused if somebody gets 8-bit-clean access to your display, whether 958abused if somebody gets 8-bit-clean access to your display, whether
903throuh a mail client displaying mail bodies unfiltered or though 959through a mail client displaying mail bodies unfiltered or through
904write(1). Therefore, these sequences are disabled by default. (Note 960write(1) or any other means. Therefore, these sequences are disabled by
905that other terminals, including xterm, have these sequences 961default. (Note that many other terminals, including xterm, have these
906enabled by default). You can enable them by setting this boolean 962sequences enabled by default, which doesn't make it safer, though).
907resource or specifying B<-insecure> as an option. At the moment, this 963
908enabled display-answer, locale, findfont, icon label and window title 964You can enable them by setting this boolean resource or specifying
909requests as well as dynamic menubar dispatch. 965B<-insecure> as an option. At the moment, this enables display-answer,
966locale, findfont, icon label and window title requests.
910 967
911=item B<modifier:> I<modifier> 968=item B<modifier:> I<modifier>
912 969
913Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 970Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
914B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 971B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
918 975
919Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 976Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
920character is passed through. It may contain escape values as described 977character is passed through. It may contain escape values as described
921in the entry on B<keysym> following. 978in the entry on B<keysym> following.
922 979
923=item B<secondaryScreen:> I<bool> 980=item B<secondaryScreen:> I<boolean>
924 981
925Turn on/off secondary screen (default enabled). 982Turn on/off secondary screen (default enabled).
926 983
927=item B<secondaryScroll:> I<bool> 984=item B<secondaryScroll:> I<boolean>
928 985
929Turn on/off secondary screen scroll (default enabled). If the this 986Turn on/off secondary screen scroll (default enabled). If the this
930option is enabled, scrolls on the secondary screen will change the 987option is enabled, scrolls on the secondary screen will change the
931scrollback buffer and switching to/from the secondary screen will 988scrollback buffer and switching to/from the secondary screen will
932instead scroll the screen up. 989instead scroll the screen up.
990
991=item B<hold>: I<boolean>
992
993Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
994will not immediately destroy its window when the program executed within
995it exits. Instead, it will wait till it is being killed or closed by the
996user.
933 997
934=item B<keysym.>I<sym>: I<string> 998=item B<keysym.>I<sym>: I<string>
935 999
936Compile I<frills>: Associate I<string> with keysym I<sym>. The 1000Compile I<frills>: Associate I<string> with keysym I<sym>. The
937intervening resource name B<keysym.> cannot be omitted. 1001intervening resource name B<keysym.> cannot be omitted.
957C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1021C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
958C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1022C<\000>: octal number) or verbatim control characters (C<^?>: delete,
959C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1023C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
960can start or end with whitespace. 1024can start or end with whitespace.
961 1025
962Please note that you need to double the C<\> when using 1026Please note that you need to double the C<\> in resource files, as
963C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can 1027Xlib itself does it's own de-escaping (you can use C<\033> instead of
964use C<\033> instead of C<\e> (and so on), which will work with both Xt and 1028C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
965@@RXVT_NAME@@'s own processing). 1029processing).
966 1030
967You can define a range of keysyms in one shot by providing a I<string> 1031You can define a range of keysyms in one shot by providing a I<string>
968with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1032with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
969should be a character not used by the strings. 1033should be a character not used by the strings.
970 1034
982is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1046is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
983example the following means "change the current locale to C<zh_CN.GBK> 1047example the following means "change the current locale to C<zh_CN.GBK>
984when Control-Meta-c is being pressed": 1048when Control-Meta-c is being pressed":
985 1049
986 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1050 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1051
1052If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1053is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1054manpage. For example, the F<selection> extension (activated via
1055C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1056
1057 URxvt.keysym.M-C-c: perl:selection:rot13
987 1058
988Due the the large number of modifier combinations, a defined key mapping 1059Due the the large number of modifier combinations, a defined key mapping
989will match if at I<at least> the specified identifiers are being set, and 1060will match if at I<at least> the specified identifiers are being set, and
990no other key mappings with those and more bits are being defined. That 1061no other key mappings with those and more bits are being defined. That
991means that defining a key map for C<a> will automatically provide 1062means that defining a key map for C<a> will automatically provide
1015info): 1086info):
1016 1087
1017 URxvt.keysym.M-C-3: command:\033[8;25;80t 1088 URxvt.keysym.M-C-3: command:\033[8;25;80t
1018 URxvt.keysym.M-C-4: command:\033[8;48;110t 1089 URxvt.keysym.M-C-4: command:\033[8;48;110t
1019 1090
1091=item B<perl-ext-common>: I<string>
1092
1093=item B<perl-ext>: I<string>
1094
1095Comma-separated list(s) of perl extension scripts (default: C<default>) to
1096use in this terminal instance; option B<-pe>.
1097
1098Extension names can be prefixed with a C<-> sign to prohibit using
1099them. This can be useful to selectively disable some extensions loaded
1100by default, or specified via the C<perl-ext-common> resource. For
1101example, C<default,-selection> will use all the default extension except
1102C<selection>.
1103
1104Extension names can also be followed by an argument in angle brackets
1105(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1106searchable scorllback to Alt/Meta-s). Mentioning the same extension
1107multiple times with different arguments will pass multiple arguments to
1108the extension.
1109
1110Each extension is looked up in the library directories, loaded if
1111necessary, and bound to the current terminal instance.
1112
1113If both of these resources are the empty string, then the perl
1114interpreter will not be initialized. The idea behind two options is that
1115B<perl-ext-common> will be used for extensions that should be available to
1116all instances, while B<perl-ext> is used for specific instances.
1117
1118=item B<perl-eval>: I<string>
1119
1120Perl code to be evaluated when all extensions have been registered. See
1121the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1122will be ignored when running setuid/setgid.
1123
1124=item B<perl-lib>: I<path>
1125
1126Colon-separated list of additional directories that hold extension
1127scripts. When looking for extensions specified by the C<perl> resource,
1128@@RXVT_NAME@@ will first look in these directories and then in
1129F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1130will be ignored when running setuid/setgid.
1131
1132See the @@RXVT_NAME@@perl(3) manpage.
1133
1134=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1135
1136Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1137details.
1138
1139=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1140
1141Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1142for details.
1143
1144=item B<searchable-scrollback:> I<keysym>
1145
1146Sets the hotkey that starts the incremental scrollback buffer search
1147(default: C<M-s>).
1148
1149=item B<urlLauncher>: I<string>
1150
1151Specifies the program to be started with a URL argument. Used by the
1152C<selection-popup> and C<mark-urls> perl extensions.
1153
1154=item B<transient-for>: I<windowid>
1155
1156Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1157
1158=item B<override-redirect>: I<boolean>
1159
1160Compile I<frills>: Sets override-redirect for the terminal window, making
1161it almost invisible to window managers; option B<-override-redirect>.
1162
1020=back 1163=back
1021 1164
1022=head1 THE SCROLLBAR 1165=head1 THE SCROLLBAR
1023 1166
1024Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1167Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
1058to select a word; Left triple-click to select the entire logical line 1201to select a word; Left triple-click to select the entire logical line
1059(which can span multiple screen lines), unless modified by resource 1202(which can span multiple screen lines), unless modified by resource
1060B<tripleclickwords>. 1203B<tripleclickwords>.
1061 1204
1062Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1205Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1063(Compile: I<frills>) will create a rectangular selection instead of a normal 1206(Compile: I<frills>) will create a rectangular selection instead of a
1064one. 1207normal one. In this mode, every selected row becomes its own line in the
1208selection, and trailing whitespace is visually underlined and removed from
1209the selection.
1065 1210
1066=item B<Insertion>: 1211=item B<Insertion>:
1067 1212
1068Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1213Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1069an B<@@RXVT_NAME@@> window causes the current text selection to be 1214window causes the value of the PRIMARY selection (or CLIPBOARD with the
1070inserted as if it had been typed on the keyboard. 1215Meta modifier) to be inserted as if it had been typed on the keyboard.
1216
1217Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1218inserted too.
1071 1219
1072=back 1220=back
1073 1221
1074=head1 CHANGING FONTS 1222=head1 CHANGING FONTS
1075 1223
1076Changing fonts (or font sizes, respectively) via the keypad is not yet 1224Changing fonts (or font sizes, respectively) via the keypad is not yet
1077supported in rxvt-unicode. Bug me if you need this. 1225supported in rxvt-unicode. Bug me if you need this.
1078 1226
1079You can, however, switch fonts at runtime using escape sequences (and 1227You can, however, switch fonts at runtime using escape sequences, e.g.:
1080therefore using the menubar), e.g.:
1081 1228
1082 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1229 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1230
1231You can use keyboard shortcuts, too:
1232
1233 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1234 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1083 1235
1084rxvt-unicode will automatically re-apply these fonts to the output so far. 1236rxvt-unicode will automatically re-apply these fonts to the output so far.
1085 1237
1086=head1 ISO 14755 SUPPORT 1238=head1 ISO 14755 SUPPORT
1087 1239
1249 1401
1250=item B<SHELL> 1402=item B<SHELL>
1251 1403
1252The shell to be used for command execution, defaults to C</bin/sh>. 1404The shell to be used for command execution, defaults to C</bin/sh>.
1253 1405
1254=item B<RXVTPATH>
1255
1256The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1257files.
1258
1259=item B<PATH>
1260
1261Used in the same way as C<RXVTPATH>.
1262
1263=item B<RXVT_SOCKET> 1406=item B<RXVT_SOCKET>
1264 1407
1265The unix domain socket path used by @@RXVT_NAME@@c(1) and 1408The unix domain socket path used by @@RXVT_NAME@@c(1) and
1266@@RXVT_NAME@@d(1). 1409@@RXVT_NAME@@d(1).
1267 1410
1336 1479
1337Project Coordinator (changes.txt 2.21a to 2.4.5) 1480Project Coordinator (changes.txt 2.21a to 2.4.5)
1338 1481
1339=item Geoff Wing L<< <gcw@pobox.com> >> 1482=item Geoff Wing L<< <gcw@pobox.com> >>
1340 1483
1341Rewrote screen display and text selection routines. Project Coordinator 1484Rewrote screen display and text selection routines.
1485
1342(changes.txt 2.4.6 - rxvt-unicode) 1486Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1343 1487
1344=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1488=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1345 1489
1346Forked rxvt-unicode, rewrote most of the display code and internal 1490Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1347character handling to store text in unicode, improve xterm 1491extension, random hacks, numerous bugfixes and extensions.
1348compatibility and apply numerous other bugfixes and extensions.
1349 1492
1350Project Coordinator (Changes 1.0 -) 1493Project Coordinator (Changes 1.0 -)
1351 1494
1495=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1496
1497Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1498
1352=back 1499=back
1353 1500

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines