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.69 by root, Tue Oct 25 19:04:45 2005 UTC vs.
Revision 1.100 by root, Thu Jan 19 18:02:28 2006 UTC

124is black. resource B<fadeColor>. 124is black. resource B<fadeColor>.
125 125
126=item B<-tint> I<colour> 126=item B<-tint> I<colour>
127 127
128Tint the transparent background pixmap with the given colour when 128Tint the transparent background pixmap with the given colour when
129transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> 129transparency is enabled with B<-tr> or B<-ip>. This only works for
130option that can be used to brighten or darken the image in addition to 130non-tiled backgrounds, currently. See also the B<-sh> option that can be
131tinting it; resource I<tintColor>. Example: 131used to brighten or darken the image in addition to tinting it; resource
132I<tintColor>. Example:
132 133
133 @@RXVT_NAME@@ -tr -tint blue -sh 40 134 @@RXVT_NAME@@ -tr -tint blue -sh 40
134 135
135=item B<-sh> 136=item B<-sh>
136 137
171resource B<borderColor>. 172resource B<borderColor>.
172 173
173=item B<-fn> I<fontlist> 174=item B<-fn> I<fontlist>
174 175
175Select 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
176that are used in turn when trying to display Unicode characters. The 177that are checked in order when trying to find glyphs for characters. The
177first font defines the cell size for characters; other fonts might be 178first font defines the cell size for characters; other fonts might be
178smaller, but not (in general) larger. A (hopefully) reasonable default 179smaller, but not (in general) larger. A (hopefully) reasonable default
179font 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.
180 181
181In 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
188See 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
189section of @@RXVT_NAME@@(7). 190section of @@RXVT_NAME@@(7).
190 191
191=item B<-fb> I<fontlist> 192=item B<-fb> I<fontlist>
192 193
193Compile 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
194be printed. See resource B<boldFont> for details. 195are to be printed. See resource B<boldFont> for details.
195 196
196=item B<-fi> I<fontlist> 197=item B<-fi> I<fontlist>
197 198
198Compile 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>
199be printed. See resource B<italicFont> for details. 200characters are to be printed. See resource B<italicFont> for details.
200 201
201=item B<-fbi> I<fontlist> 202=item B<-fbi> I<fontlist>
202 203
203Compile 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
204be 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.
205 213
206=item B<-name> I<name> 214=item B<-name> I<name>
207 215
208Specify the application name under which resources are to be obtained, 216Specify the application name under which resources are to be obtained,
209rather than the default executable file name. Name should not contain 217rather than the default executable file name. Name should not contain
288=item B<-bl> 296=item B<-bl>
289 297
290Compile 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.
291if 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
292decorations; 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>.
293 313
294=item B<-lsp> I<number> 314=item B<-lsp> I<number>
295 315
296Compile I<frills>: Lines (pixel height) to insert between each row of 316Compile I<frills>: Lines (pixel height) to insert between each row of
297the display. Useful to work around font rendering problems; resource 317the display. Useful to work around font rendering problems; resource
312given 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
313on 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
314run the program specified by the B<SHELL> environment variable or, 334run the program specified by the B<SHELL> environment variable or,
315failing that, I<sh(1)>. 335failing that, I<sh(1)>.
316 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
317=item B<-title> I<text> 342=item B<-title> I<text>
318 343
319Window title (B<-T> still respected); the default title is the basename 344Window title (B<-T> still respected); the default title is the basename
320of 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
321application name; resource B<title>. 346application name; resource B<title>.
376 401
377=item B<-ssr>|B<+ssr> 402=item B<-ssr>|B<+ssr>
378 403
379Turn on/off secondary screen scroll (default enabled); resource 404Turn on/off secondary screen scroll (default enabled); resource
380B<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>.
381 413
382=item B<-keysym.>I<sym> I<string> 414=item B<-keysym.>I<sym> I<string>
383 415
384Remap a key symbol. See resource B<keysym>. 416Remap a key symbol. See resource B<keysym>.
385 417
408 $rxvt->signal_connect_after (realize => sub { 440 $rxvt->signal_connect_after (realize => sub {
409 my $xid = $_[0]->window->get_xid; 441 my $xid = $_[0]->window->get_xid;
410 system "@@RXVT_NAME@@ -embed $xid &"; 442 system "@@RXVT_NAME@@ -embed $xid &";
411 }); 443 });
412 444
413=item B<-pty-fd> I<fileno> 445=item B<-pty-fd> I<file descriptor>
414 446
415Tells @@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
416pair 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
417useful 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
418without having to run a program within it. 450without having to run a program within it.
419 451
420If 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
421entries 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
422yourself if you want that. 454yourself if you want that.
423 455
456As an extremely special case, specifying C<-1> will completely suppress
457pty/tty operations.
458
424Here 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
425longer example is in F<doc/pty-fd>): 460longer example is in F<doc/pty-fd>):
426 461
427 use IO::Pty; 462 use IO::Pty;
428 use Fcntl; 463 use Fcntl;
434 469
435 # now communicate with rxvt 470 # now communicate with rxvt
436 my $slave = $pty->slave; 471 my $slave = $pty->slave;
437 while (<$slave>) { print $slave "got <$_>\n" } 472 while (<$slave>) { print $slave "got <$_>\n" }
438 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
439=back 479=back
440 480
441=head1 RESOURCES (available also as long-options) 481=head1 RESOURCES (available also as long-options)
442 482
443Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 483Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
444options) compiled into your version. 484options) compiled into your version.
445 485
446There 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
447Xresource data: using the X libraries (Xrm*-functions) or internal 487distribution do also load settings from the B<~/.Xresources> file when X
448Xresources reader (B<~/.Xdefaults>). For the first method (ie. 488starts. @@RXVT_NAME@@ will consult the following files/resources in order,
449B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 489with later settings overwriting earlier ones:
450resources using X11 tools like B<xrdb>. Many distribution do also load
451settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
452will consult the following files/resources in order, with later settings
453overwriting earlier ones:
454 490
455 1. system-wide app-defaults file, either locale-dependent OR global 491 1. system-wide app-defaults file, either locale-dependent OR global
456 2. app-defaults file in $XAPPLRESDIR 492 2. app-defaults file in $XAPPLRESDIR
457 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 493 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
458 4. SCREEN_RESOURCES for the current screen 494 4. SCREEN_RESOURCES for the current screen
459 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 495 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
460 496
461If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
462lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
463set in XAPPLOADDIR/URxvt (compile-time defined: usually
464B</usr/lib/X11/app-defaults/URxvt>) and resources set in
465B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
466Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 497Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
467class 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
468resources 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
469easily configured, while the class name B<URxvt> allows resources 500configured, while the class name B<URxvt> allows resources unique to
470unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 501B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
471shared between different B<@@RXVT_NAME@@> configurations. If no 502configurations. If no resources are specified, suitable defaults will
472resources are specified, suitable defaults will be used. Command-line 503be used. Command-line arguments can be used to override resource
473arguments can be used to override resource settings. The following 504settings. The following resources are supported (you might want to
474resources are allowed: 505check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
506extensions not documented here):
475 507
476=over 4 508=over 4
477 509
478=item B<geometry:> I<geom> 510=item B<geometry:> I<geom>
479 511
600of 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
601specifies an integer number of images in that direction. No image will 633specifies an integer number of images in that direction. No image will
602be magnified beyond 10 times its original size. The maximum permitted 634be magnified beyond 10 times its original size. The maximum permitted
603scale is 1000. [default 0x0+50+50] 635scale is 1000. [default 0x0+50+50]
604 636
605=item B<menu:> I<file[;tag]>
606
607Read in the specified menu file (note the `.menu' extension is
608optional) and also optionally specify a starting tag to find. See the
609reference documentation for details on the syntax for the menuBar.
610
611=item B<path:> I<path> 637=item B<path:> I<path>
612 638
613Specify the colon-delimited search path for finding files (XPM and 639Specify the colon-delimited search path for finding XPM files.
614menus), in addition to the paths specified by the B<RXVTPATH> and
615B<PATH> environment variables.
616 640
617=item B<font:> I<fontlist> 641=item B<font:> I<fontlist>
618 642
619Select 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
620names that are used in turn when trying to display Unicode characters. 644that are checked in order when trying to find glyphs for characters. The
621The first font defines the cell size for characters; other fonts might 645first font defines the cell size for characters; other fonts might be
622be smaller, but not larger. A reasonable default font list is always 646smaller, but not (in general) larger. A (hopefully) reasonable default
623appended to it. option B<-fn>. 647font list is always appended to it; option B<-fn>.
624 648
625Each 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
626optional 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:>.
627 651
628In addition, each font can be prefixed with additional hints and 652In addition, each font can be prefixed with additional hints and
630hint 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
631fonts. 655fonts.
632 656
633For example, this font resource 657For example, this font resource
634 658
635 URxvt*font: 9x15bold,\ 659 URxvt.font: 9x15bold,\
636 -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,\
637 -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, \
638 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 662 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
639 xft:Code2000:antialias=false 663 xft:Code2000:antialias=false
640 664
674not possible, replacement fonts of the desired shape will be tried. 698not possible, replacement fonts of the desired shape will be tried.
675 699
676If 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
677text font will being used for the given style. 701text font will being used for the given style.
678 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
679=item B<selectstyle:> I<mode> 711=item B<selectstyle:> I<mode>
680 712
681Set 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
682xterm 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
683xterm style selection. 715xterm style selection.
729 761
730The 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.
731 763
732Example: 764Example:
733 765
734 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 766 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
735 767
736This 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
737everytime you hit C<Print>. 769everytime you hit C<Print>.
738 770
739=item B<scrollBar:> I<boolean> 771=item B<scrollBar:> I<boolean>
793=item B<borderLess:> I<boolean> 825=item B<borderLess:> I<boolean>
794 826
795Set 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
796WM, 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>.
797 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
798=item B<termName:> I<termname> 837=item B<termName:> I<termname>
799 838
800Specifies 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
801variable; option B<-tn>. 840variable; option B<-tn>.
802 841
875=item B<imLocale:> I<name> 914=item B<imLocale:> I<name>
876 915
877The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 916The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
878C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the 917C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
879input extension to be able to input japanese characters while staying in 918input extension to be able to input japanese characters while staying in
880another locale. option B<-imlocale>. 919another locale; option B<-imlocale>.
881 920
882=item B<imFont:> I<fontset> 921=item B<imFont:> I<fontset>
883 922
884Specify the font-set used for XIM styles C<OverTheSpot> or 923Specify the font-set used for XIM styles C<OverTheSpot> or
885C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 924C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
890 929
891=item B<tripleclickwords:> I<boolean> 930=item B<tripleclickwords:> I<boolean>
892 931
893Change the meaning of triple-click selection with the left mouse 932Change the meaning of triple-click selection with the left mouse
894button. Instead of selecting a full line it will extend the selection to 933button. Instead of selecting a full line it will extend the selection to
895the end of the logical line only. option B<-tcw>. 934the end of the logical line only; option B<-tcw>.
896 935
897=item B<insecure:> I<boolean> 936=item B<insecure:> I<boolean>
898 937
899Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 938Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
900echo arbitrary strings like the icon name or the locale. This could be 939echo arbitrary strings like the icon name or the locale. This could be
901abused if somebody gets 8-bit-clean access to your display, whether 940abused if somebody gets 8-bit-clean access to your display, whether
902throuh a mail client displaying mail bodies unfiltered or though 941through a mail client displaying mail bodies unfiltered or through
903write(1). Therefore, these sequences are disabled by default. (Note 942write(1) or any other means. Therefore, these sequences are disabled by
904that other terminals, including xterm, have these sequences 943default. (Note that many other terminals, including xterm, have these
905enabled by default). You can enable them by setting this boolean 944sequences enabled by default, which doesn't make it safer, though).
906resource or specifying B<-insecure> as an option. At the moment, this 945
907enabled display-answer, locale, findfont, icon label and window title 946You can enable them by setting this boolean resource or specifying
908requests as well as dynamic menubar dispatch. 947B<-insecure> as an option. At the moment, this enables display-answer,
948locale, findfont, icon label and window title requests.
909 949
910=item B<modifier:> I<modifier> 950=item B<modifier:> I<modifier>
911 951
912Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 952Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
913B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 953B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
917 957
918Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 958Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
919character is passed through. It may contain escape values as described 959character is passed through. It may contain escape values as described
920in the entry on B<keysym> following. 960in the entry on B<keysym> following.
921 961
922=item B<secondaryScreen:> I<bool> 962=item B<secondaryScreen:> I<boolean>
923 963
924Turn on/off secondary screen (default enabled). 964Turn on/off secondary screen (default enabled).
925 965
926=item B<secondaryScroll:> I<bool> 966=item B<secondaryScroll:> I<boolean>
927 967
928Turn on/off secondary screen scroll (default enabled). If the this 968Turn on/off secondary screen scroll (default enabled). If the this
929option is enabled, scrolls on the secondary screen will change the 969option is enabled, scrolls on the secondary screen will change the
930scrollback buffer and switching to/from the secondary screen will 970scrollback buffer and switching to/from the secondary screen will
931instead scroll the screen up. 971instead scroll the screen up.
972
973=item B<hold>: I<boolean>
974
975Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
976will not immediately destroy its window when the program executed within
977it exits. Instead, it will wait till it is being killed or closed by the
978user.
932 979
933=item B<keysym.>I<sym>: I<string> 980=item B<keysym.>I<sym>: I<string>
934 981
935Compile I<frills>: Associate I<string> with keysym I<sym>. The 982Compile I<frills>: Associate I<string> with keysym I<sym>. The
936intervening resource name B<keysym.> cannot be omitted. 983intervening resource name B<keysym.> cannot be omitted.
956C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1003C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
957C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1004C<\000>: octal number) or verbatim control characters (C<^?>: delete,
958C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1005C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
959can start or end with whitespace. 1006can start or end with whitespace.
960 1007
961Please note that you need to double the C<\> when using 1008Please note that you need to double the C<\> in resource files, as
962C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can 1009Xlib itself does it's own de-escaping (you can use C<\033> instead of
963use C<\033> instead of C<\e> (and so on), which will work with both Xt and 1010C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
964@@RXVT_NAME@@'s own processing). 1011processing).
965 1012
966You can define a range of keysyms in one shot by providing a I<string> 1013You can define a range of keysyms in one shot by providing a I<string>
967with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1014with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
968should be a character not used by the strings. 1015should be a character not used by the strings.
969 1016
981is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1028is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
982example the following means "change the current locale to C<zh_CN.GBK> 1029example the following means "change the current locale to C<zh_CN.GBK>
983when Control-Meta-c is being pressed": 1030when Control-Meta-c is being pressed":
984 1031
985 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1032 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1033
1034If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1035is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1036manpage. For example, the F<selection> extension (activated via
1037C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1038
1039 URxvt.keysym.M-C-c: perl:selection:rot13
986 1040
987Due the the large number of modifier combinations, a defined key mapping 1041Due the the large number of modifier combinations, a defined key mapping
988will match if at I<at least> the specified identifiers are being set, and 1042will match if at I<at least> the specified identifiers are being set, and
989no other key mappings with those and more bits are being defined. That 1043no other key mappings with those and more bits are being defined. That
990means that defining a key map for C<a> will automatically provide 1044means that defining a key map for C<a> will automatically provide
1014info): 1068info):
1015 1069
1016 URxvt.keysym.M-C-3: command:\033[8;25;80t 1070 URxvt.keysym.M-C-3: command:\033[8;25;80t
1017 URxvt.keysym.M-C-4: command:\033[8;48;110t 1071 URxvt.keysym.M-C-4: command:\033[8;48;110t
1018 1072
1073=item B<perl-ext-common>: I<string>
1074
1075=item B<perl-ext>: I<string>
1076
1077Comma-separated list(s) of perl extension scripts (default: C<default>) to
1078use in this terminal instance; option B<-pe>.
1079
1080Extension names can be prefixed with a C<-> sign to prohibit using
1081them. This can be useful to selectively disable some extensions loaded
1082by default, or specified via the C<perl-ext-common> resource. For
1083example, C<default,-selection> will use all the default extension except
1084C<selection>.
1085
1086Extension names can also be followed by an argument in angle brackets
1087(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1088searchable scorllback to Alt/Meta-s). Mentioning the same extension
1089multiple times with different arguments will pass multiple arguments to
1090the extension.
1091
1092Each extension is looked up in the library directories, loaded if
1093necessary, and bound to the current terminal instance.
1094
1095If both of these resources are the empty string, then the perl
1096interpreter will not be initialized. The idea behind two options is that
1097B<perl-ext-common> will be used for extensions that should be available to
1098all instances, while B<perl-ext> is used for specific instances.
1099
1100=item B<perl-eval>: I<string>
1101
1102Perl code to be evaluated when all extensions have been registered. See
1103the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1104will be ignored when running setuid/setgid.
1105
1106=item B<perl-lib>: I<path>
1107
1108Colon-separated list of additional directories that hold extension
1109scripts. When looking for extensions specified by the C<perl> resource,
1110@@RXVT_NAME@@ will first look in these directories and then in
1111F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1112will be ignored when running setuid/setgid.
1113
1114See the @@RXVT_NAME@@perl(3) manpage.
1115
1116=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1117
1118Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1119details.
1120
1121=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1122
1123Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1124for details.
1125
1126=item B<searchable-scrollback:> I<keysym>
1127
1128Sets the hotkey that starts the incremental scrollback buffer search
1129(default: C<M-s>).
1130
1131=item B<urlLauncher>: I<string>
1132
1133Specifies the program to be started with a URL argument. Used by the
1134C<selection-popup> and C<mark-urls> perl extensions.
1135
1136=item B<transient-for>: I<windowid>
1137
1138Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1139
1140=item B<override-redirect>: I<boolean>
1141
1142Compile I<frills>: Sets override-redirect for the terminal window, making
1143it almost invisible to window managers; option B<-override-redirect>.
1144
1019=back 1145=back
1020 1146
1021=head1 THE SCROLLBAR 1147=head1 THE SCROLLBAR
1022 1148
1023Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1149Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
1057to select a word; Left triple-click to select the entire logical line 1183to select a word; Left triple-click to select the entire logical line
1058(which can span multiple screen lines), unless modified by resource 1184(which can span multiple screen lines), unless modified by resource
1059B<tripleclickwords>. 1185B<tripleclickwords>.
1060 1186
1061Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1187Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1062(Compile: I<frills>) will create a rectangular selection instead of a normal 1188(Compile: I<frills>) will create a rectangular selection instead of a
1063one. 1189normal one. In this mode, every selected row becomes its own line in the
1190selection, and trailing whitespace is visually underlined and removed from
1191the selection.
1064 1192
1065=item B<Insertion>: 1193=item B<Insertion>:
1066 1194
1067Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1195Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
1068an B<@@RXVT_NAME@@> window causes the current text selection to be 1196an B<@@RXVT_NAME@@> window causes the current text selection to be
1073=head1 CHANGING FONTS 1201=head1 CHANGING FONTS
1074 1202
1075Changing fonts (or font sizes, respectively) via the keypad is not yet 1203Changing fonts (or font sizes, respectively) via the keypad is not yet
1076supported in rxvt-unicode. Bug me if you need this. 1204supported in rxvt-unicode. Bug me if you need this.
1077 1205
1078You can, however, switch fonts at runtime using escape sequences (and 1206You can, however, switch fonts at runtime using escape sequences, e.g.:
1079therefore using the menubar), e.g.:
1080 1207
1081 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1208 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1209
1210You can use keyboard shortcuts, too:
1211
1212 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1213 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1082 1214
1083rxvt-unicode will automatically re-apply these fonts to the output so far. 1215rxvt-unicode will automatically re-apply these fonts to the output so far.
1084 1216
1085=head1 ISO 14755 SUPPORT 1217=head1 ISO 14755 SUPPORT
1086 1218
1248 1380
1249=item B<SHELL> 1381=item B<SHELL>
1250 1382
1251The shell to be used for command execution, defaults to C</bin/sh>. 1383The shell to be used for command execution, defaults to C</bin/sh>.
1252 1384
1253=item B<RXVTPATH>
1254
1255The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1256files.
1257
1258=item B<PATH>
1259
1260Used in the same way as C<RXVTPATH>.
1261
1262=item B<RXVT_SOCKET> 1385=item B<RXVT_SOCKET>
1263 1386
1264The unix domain socket path used by @@RXVT_NAME@@c(1) and 1387The unix domain socket path used by @@RXVT_NAME@@c(1) and
1265@@RXVT_NAME@@d(1). 1388@@RXVT_NAME@@d(1).
1266 1389
1295 1418
1296=head1 SEE ALSO 1419=head1 SEE ALSO
1297 1420
1298@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1421@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1299 1422
1300=head1 BUGS
1301
1302Check the BUGS file for an up-to-date list.
1303
1304Cursor change support is not yet implemented.
1305
1306Click-and-drag doesn't work with X11 mouse report overriding.
1307
1308=head1 CURRENT PROJECT COORDINATOR 1423=head1 CURRENT PROJECT COORDINATOR
1309 1424
1310=over 4 1425=over 4
1311 1426
1312=item Project Coordinator 1427=item Project Coordinator
1343 1458
1344Project Coordinator (changes.txt 2.21a to 2.4.5) 1459Project Coordinator (changes.txt 2.21a to 2.4.5)
1345 1460
1346=item Geoff Wing L<< <gcw@pobox.com> >> 1461=item Geoff Wing L<< <gcw@pobox.com> >>
1347 1462
1348Rewrote screen display and text selection routines. Project Coordinator 1463Rewrote screen display and text selection routines.
1464
1349(changes.txt 2.4.6 - rxvt-unicode) 1465Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1350 1466
1351=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1467=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1352 1468
1353Forked rxvt-unicode, rewrote most of the display code and internal 1469Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1354character handling to store text in unicode, improve xterm 1470extension, random hacks, numerous bugfixes and extensions.
1355compatibility and apply numerous other bugfixes and extensions.
1356 1471
1357Project Coordinator (Changes 1.0 -) 1472Project Coordinator (Changes 1.0 -)
1358 1473
1474=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1475
1476Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugxifing.
1477
1359=back 1478=back
1360 1479

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines