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.80 by root, Mon Jan 2 21:26:05 2006 UTC

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 font-styles: The bold italic font list to use when bold characters are to
205be printed. See resource B<boldItalicFont> for details. 205be printed. See resource B<boldItalicFont> for details.
206 206
207=item B<-is>|B<+is>
208
209Compile font-styles: Bold/Italic font styles imply high intensity
210foreground/background (default). See resource B<intensityStyles> for
211details.
212
207=item B<-name> I<name> 213=item B<-name> I<name>
208 214
209Specify the application name under which resources are to be obtained, 215Specify the application name under which resources are to be obtained,
210rather than the default executable file name. Name should not contain 216rather than the default executable file name. Name should not contain
211`.' or `*' characters. Also sets the icon and title name. 217`.' or `*' characters. Also sets the icon and title name.
313given on the command line. If this option is used, it must be the last 319given 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 320on 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, 321run the program specified by the B<SHELL> environment variable or,
316failing that, I<sh(1)>. 322failing that, I<sh(1)>.
317 323
324Please note that you must specify a program with arguments. If you want to
325run shell commands, you have to specify the shell, like this:
326
327 @@RXVT_NAME@@ -e sh -c "shell commands"
328
318=item B<-title> I<text> 329=item B<-title> I<text>
319 330
320Window title (B<-T> still respected); the default title is the basename 331Window title (B<-T> still respected); the default title is the basename
321of the program specified after the B<-e> option, if any, otherwise the 332of the program specified after the B<-e> option, if any, otherwise the
322application name; resource B<title>. 333application name; resource B<title>.
377 388
378=item B<-ssr>|B<+ssr> 389=item B<-ssr>|B<+ssr>
379 390
380Turn on/off secondary screen scroll (default enabled); resource 391Turn on/off secondary screen scroll (default enabled); resource
381B<secondaryScroll>. 392B<secondaryScroll>.
393
394=item B<-hold>|B<+hold>
395
396Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
397will not immediately destroy its window when the program executed within
398it exits. Instead, it will wait till it is being killed or closed by the
399user; resource B<hold>.
382 400
383=item B<-keysym.>I<sym> I<string> 401=item B<-keysym.>I<sym> I<string>
384 402
385Remap a key symbol. See resource B<keysym>. 403Remap a key symbol. See resource B<keysym>.
386 404
434 close $pty; 452 close $pty;
435 453
436 # now communicate with rxvt 454 # now communicate with rxvt
437 my $slave = $pty->slave; 455 my $slave = $pty->slave;
438 while (<$slave>) { print $slave "got <$_>\n" } 456 while (<$slave>) { print $slave "got <$_>\n" }
457
458=item B<-pe> I<string>
459
460Colon-separated list of perl extension scripts to use in this terminal instance. See resource B<perl-ext>.
439 461
440=back 462=back
441 463
442=head1 RESOURCES (available also as long-options) 464=head1 RESOURCES (available also as long-options)
443 465
619 641
620Select the fonts to be used. This is a comma separated list of font 642Select the fonts to be used. This is a comma separated list of font
621names that are used in turn when trying to display Unicode characters. 643names that are used in turn when trying to display Unicode characters.
622The first font defines the cell size for characters; other fonts might 644The first font defines the cell size for characters; other fonts might
623be smaller, but not larger. A reasonable default font list is always 645be smaller, but not larger. A reasonable default font list is always
624appended to it. option B<-fn>. 646appended to it; option B<-fn>.
625 647
626Each font can either be a standard X11 core font (XLFD) name, with 648Each 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:>. 649optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
628 650
629In addition, each font can be prefixed with additional hints and 651In addition, each font can be prefixed with additional hints and
675not possible, replacement fonts of the desired shape will be tried. 697not possible, replacement fonts of the desired shape will be tried.
676 698
677If set, but empty, then this specific style is disabled and the normal 699If set, but empty, then this specific style is disabled and the normal
678text font will being used for the given style. 700text font will being used for the given style.
679 701
702=item B<intensityStyles:> I<boolean>
703
704When font styles are not enabled, or this option is enabled (B<True>,
705option B<-is>, the default), bold and italic font styles imply high
706intensity foreground/backround colours. Disabling this option (B<False>,
707option B<+is>) disables this behaviour, the high intensity colours are not
708reachable.
709
680=item B<selectstyle:> I<mode> 710=item B<selectstyle:> I<mode>
681 711
682Set mouse selection style to B<old> which is 2.20, B<oldword> which is 712Set 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 713xterm style with 2.20 old word selection, or anything else which gives
684xterm style selection. 714xterm style selection.
876=item B<imLocale:> I<name> 906=item B<imLocale:> I<name>
877 907
878The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 908The 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 909C<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 910input extension to be able to input japanese characters while staying in
881another locale. option B<-imlocale>. 911another locale; option B<-imlocale>.
882 912
883=item B<imFont:> I<fontset> 913=item B<imFont:> I<fontset>
884 914
885Specify the font-set used for XIM styles C<OverTheSpot> or 915Specify the font-set used for XIM styles C<OverTheSpot> or
886C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 916C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
891 921
892=item B<tripleclickwords:> I<boolean> 922=item B<tripleclickwords:> I<boolean>
893 923
894Change the meaning of triple-click selection with the left mouse 924Change the meaning of triple-click selection with the left mouse
895button. Instead of selecting a full line it will extend the selection to 925button. Instead of selecting a full line it will extend the selection to
896the end of the logical line only. option B<-tcw>. 926the end of the logical line only; option B<-tcw>.
897 927
898=item B<insecure:> I<boolean> 928=item B<insecure:> I<boolean>
899 929
900Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 930Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
901echo arbitrary strings like the icon name or the locale. This could be 931echo arbitrary strings like the icon name or the locale. This could be
931Turn on/off secondary screen scroll (default enabled). If the this 961Turn on/off secondary screen scroll (default enabled). If the this
932option is enabled, scrolls on the secondary screen will change the 962option is enabled, scrolls on the secondary screen will change the
933scrollback buffer and switching to/from the secondary screen will 963scrollback buffer and switching to/from the secondary screen will
934instead scroll the screen up. 964instead scroll the screen up.
935 965
966=item B<hold>: I<bool>
967
968Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
969will not immediately destroy its window when the program executed within
970it exits. Instead, it will wait till it is being killed or closed by the
971user.
972
936=item B<keysym.>I<sym>: I<string> 973=item B<keysym.>I<sym>: I<string>
937 974
938Compile I<frills>: Associate I<string> with keysym I<sym>. The 975Compile I<frills>: Associate I<string> with keysym I<sym>. The
939intervening resource name B<keysym.> cannot be omitted. 976intervening resource name B<keysym.> cannot be omitted.
940 977
984is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1021is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
985example the following means "change the current locale to C<zh_CN.GBK> 1022example the following means "change the current locale to C<zh_CN.GBK>
986when Control-Meta-c is being pressed": 1023when Control-Meta-c is being pressed":
987 1024
988 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1025 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1026
1027If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1028is passed to the C<on_keyboard_command> perl handler. See the rxvtperl(3)
1029manpage. For example, the F<selection> extension (activated via
1030C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1031
1032 URxvt.keysym.M-C-c: perl:selection:rot13
989 1033
990Due the the large number of modifier combinations, a defined key mapping 1034Due 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 1035will 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 1036no other key mappings with those and more bits are being defined. That
993means that defining a key map for C<a> will automatically provide 1037means that defining a key map for C<a> will automatically provide
1017info): 1061info):
1018 1062
1019 URxvt.keysym.M-C-3: command:\033[8;25;80t 1063 URxvt.keysym.M-C-3: command:\033[8;25;80t
1020 URxvt.keysym.M-C-4: command:\033[8;48;110t 1064 URxvt.keysym.M-C-4: command:\033[8;48;110t
1021 1065
1066=item B<perl-ext>: I<string>
1067
1068Colon-separated list of perl extension scripts to use in this terminal
1069instance. Each extension is looked up in the library directories, loaded
1070if necessary, and bound to the current terminal instance; option B<-pe>.
1071
1072=item B<perl-eval>: I<string>
1073
1074Perl code to be evaluated when all extensions have been registered. See the
1075rxvtperl(3) manpage.
1076
1077=item B<perl-lib>: I<path>
1078
1079Colon-separated list of additional directories that hold extension
1080scripts. When looking for extensions specified by the C<perl> resource,
1081@@RXVT_NAME@@ will first look in these directories and then in
1082F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1083
1084See the rxvtperl(3) manpage.
1085
1022=back 1086=back
1023 1087
1024=head1 THE SCROLLBAR 1088=head1 THE SCROLLBAR
1025 1089
1026Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1090Lines 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 1124to select a word; Left triple-click to select the entire logical line
1061(which can span multiple screen lines), unless modified by resource 1125(which can span multiple screen lines), unless modified by resource
1062B<tripleclickwords>. 1126B<tripleclickwords>.
1063 1127
1064Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1128Starting 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 1129(Compile: I<frills>) will create a rectangular selection instead of a
1066one. 1130normal one. In this mode, every selected row becomes its own line in the
1131selection, and trailing whitespace is visually underlined and removed from
1132the selection.
1067 1133
1068=item B<Insertion>: 1134=item B<Insertion>:
1069 1135
1070Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1136Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
1071an B<@@RXVT_NAME@@> window causes the current text selection to be 1137an B<@@RXVT_NAME@@> window causes the current text selection to be

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines