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.84 by root, Wed Jan 4 05:35:34 2006 UTC

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

Diff Legend

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