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.85 by root, Wed Jan 4 20:43:37 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 I<font-styles>: The bold font list to use when B<bold> characters
195be printed. See resource B<boldFont> for details. 195are to be printed. See resource B<boldFont> for details.
196 196
197=item B<-fi> I<fontlist> 197=item B<-fi> I<fontlist>
198 198
199Compile font-styles: The italic font list to use when bold characters are to 199Compile I<font-styles>: The italic font list to use when I<italic>
200be printed. See resource B<italicFont> for details. 200characters are to be printed. See resource B<italicFont> for details.
201 201
202=item B<-fbi> I<fontlist> 202=item B<-fbi> I<fontlist>
203 203
204Compile font-styles: The bold italic font list to use when bold characters are to 204Compile I<font-styles>: The bold italic font list to use when B<< I<bold
205be printed. See resource B<boldItalicFont> for details. 205italic> >> characters are to be printed. See resource B<boldItalicFont>
206for details.
207
208=item B<-is>|B<+is>
209
210Compile I<font-styles>: Bold/Italic font styles imply high intensity
211foreground/background (default). See resource B<intensityStyles> for
212details.
206 213
207=item B<-name> I<name> 214=item B<-name> I<name>
208 215
209Specify the application name under which resources are to be obtained, 216Specify the application name under which resources are to be obtained,
210rather than the default executable file name. Name should not contain 217rather than the default executable file name. Name should not contain
289=item B<-bl> 296=item B<-bl>
290 297
291Compile I<frills>: Set MWM hints to request a borderless window, i.e. 298Compile I<frills>: Set MWM hints to request a borderless window, i.e.
292if honoured by the WM, the rxvt-unicode window will not have window 299if honoured by the WM, the rxvt-unicode window will not have window
293decorations; resource B<borderLess>. 300decorations; resource B<borderLess>.
301
302=item B<-sbg>
303
304Compile I<frills>: Disable the usage of the built-in block graphics/line
305drawing characters and just rely on what the specified fonts provide. Use
306this if you have a good font and want to use its block graphic glyphs;
307resource B<skipBuiltinGlyphs>.
294 308
295=item B<-lsp> I<number> 309=item B<-lsp> I<number>
296 310
297Compile I<frills>: Lines (pixel height) to insert between each row of 311Compile I<frills>: Lines (pixel height) to insert between each row of
298the display. Useful to work around font rendering problems; resource 312the display. Useful to work around font rendering problems; resource
313given on the command line. If this option is used, it must be the last 327given 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 328on 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, 329run the program specified by the B<SHELL> environment variable or,
316failing that, I<sh(1)>. 330failing that, I<sh(1)>.
317 331
332Please note that you must specify a program with arguments. If you want to
333run shell commands, you have to specify the shell, like this:
334
335 @@RXVT_NAME@@ -e sh -c "shell commands"
336
318=item B<-title> I<text> 337=item B<-title> I<text>
319 338
320Window title (B<-T> still respected); the default title is the basename 339Window title (B<-T> still respected); the default title is the basename
321of the program specified after the B<-e> option, if any, otherwise the 340of the program specified after the B<-e> option, if any, otherwise the
322application name; resource B<title>. 341application name; resource B<title>.
377 396
378=item B<-ssr>|B<+ssr> 397=item B<-ssr>|B<+ssr>
379 398
380Turn on/off secondary screen scroll (default enabled); resource 399Turn on/off secondary screen scroll (default enabled); resource
381B<secondaryScroll>. 400B<secondaryScroll>.
401
402=item B<-hold>|B<+hold>
403
404Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
405will not immediately destroy its window when the program executed within
406it exits. Instead, it will wait till it is being killed or closed by the
407user; resource B<hold>.
382 408
383=item B<-keysym.>I<sym> I<string> 409=item B<-keysym.>I<sym> I<string>
384 410
385Remap a key symbol. See resource B<keysym>. 411Remap a key symbol. See resource B<keysym>.
386 412
434 close $pty; 460 close $pty;
435 461
436 # now communicate with rxvt 462 # now communicate with rxvt
437 my $slave = $pty->slave; 463 my $slave = $pty->slave;
438 while (<$slave>) { print $slave "got <$_>\n" } 464 while (<$slave>) { print $slave "got <$_>\n" }
465
466=item B<-pe> I<string>
467
468Colon-separated list of perl extension scripts to use in this terminal
469instance. See resource B<perl-ext>.
439 470
440=back 471=back
441 472
442=head1 RESOURCES (available also as long-options) 473=head1 RESOURCES (available also as long-options)
443 474
619 650
620Select the fonts to be used. This is a comma separated list of font 651Select 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. 652names that are used in turn when trying to display Unicode characters.
622The first font defines the cell size for characters; other fonts might 653The first font defines the cell size for characters; other fonts might
623be smaller, but not larger. A reasonable default font list is always 654be smaller, but not larger. A reasonable default font list is always
624appended to it. option B<-fn>. 655appended to it; option B<-fn>.
625 656
626Each font can either be a standard X11 core font (XLFD) name, with 657Each 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:>. 658optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
628 659
629In addition, each font can be prefixed with additional hints and 660In addition, each font can be prefixed with additional hints and
675not possible, replacement fonts of the desired shape will be tried. 706not possible, replacement fonts of the desired shape will be tried.
676 707
677If set, but empty, then this specific style is disabled and the normal 708If set, but empty, then this specific style is disabled and the normal
678text font will being used for the given style. 709text font will being used for the given style.
679 710
711=item B<intensityStyles:> I<boolean>
712
713When font styles are not enabled, or this option is enabled (B<True>,
714option B<-is>, the default), bold and italic font styles imply high
715intensity foreground/backround colours. Disabling this option (B<False>,
716option B<+is>) disables this behaviour, the high intensity colours are not
717reachable.
718
680=item B<selectstyle:> I<mode> 719=item B<selectstyle:> I<mode>
681 720
682Set mouse selection style to B<old> which is 2.20, B<oldword> which is 721Set 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 722xterm style with 2.20 old word selection, or anything else which gives
684xterm style selection. 723xterm style selection.
794=item B<borderLess:> I<boolean> 833=item B<borderLess:> I<boolean>
795 834
796Set MWM hints to request a borderless window, i.e. if honoured by the 835Set 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>. 836WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
798 837
838=item B<skipBuiltinGlyphs:> I<boolean>
839
840Compile I<frills>: Disable the usage of the built-in block graphics/line
841drawing characters and just rely on what the specified fonts provide. Use
842this if you have a good font and want to use its block graphic glyphs;
843option B<-sbg>.
844
799=item B<termName:> I<termname> 845=item B<termName:> I<termname>
800 846
801Specifies the terminal type name to be set in the B<TERM> environment 847Specifies the terminal type name to be set in the B<TERM> environment
802variable; option B<-tn>. 848variable; option B<-tn>.
803 849
876=item B<imLocale:> I<name> 922=item B<imLocale:> I<name>
877 923
878The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 924The 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 925C<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 926input extension to be able to input japanese characters while staying in
881another locale. option B<-imlocale>. 927another locale; option B<-imlocale>.
882 928
883=item B<imFont:> I<fontset> 929=item B<imFont:> I<fontset>
884 930
885Specify the font-set used for XIM styles C<OverTheSpot> or 931Specify the font-set used for XIM styles C<OverTheSpot> or
886C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 932C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
891 937
892=item B<tripleclickwords:> I<boolean> 938=item B<tripleclickwords:> I<boolean>
893 939
894Change the meaning of triple-click selection with the left mouse 940Change the meaning of triple-click selection with the left mouse
895button. Instead of selecting a full line it will extend the selection to 941button. Instead of selecting a full line it will extend the selection to
896the end of the logical line only. option B<-tcw>. 942the end of the logical line only; option B<-tcw>.
897 943
898=item B<insecure:> I<boolean> 944=item B<insecure:> I<boolean>
899 945
900Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 946Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
901echo arbitrary strings like the icon name or the locale. This could be 947echo arbitrary strings like the icon name or the locale. This could be
902abused if somebody gets 8-bit-clean access to your display, whether 948abused if somebody gets 8-bit-clean access to your display, whether
903throuh a mail client displaying mail bodies unfiltered or though 949through a mail client displaying mail bodies unfiltered or through
904write(1). Therefore, these sequences are disabled by default. (Note 950write(1) or any other means. Therefore, these sequences are disabled by
905that other terminals, including xterm, have these sequences 951default. (Note that many other terminals, including xterm, have these
906enabled by default). You can enable them by setting this boolean 952sequences enabled by default, which doesn't make it safer, though).
907resource or specifying B<-insecure> as an option. At the moment, this 953
908enabled display-answer, locale, findfont, icon label and window title 954You can enable them by setting this boolean resource or specifying
909requests as well as dynamic menubar dispatch. 955B<-insecure> as an option. At the moment, this enables display-answer,
956locale, findfont, icon label and window title requests as well as dynamic
957menubar dispatch.
910 958
911=item B<modifier:> I<modifier> 959=item B<modifier:> I<modifier>
912 960
913Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 961Set 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 962B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
928 976
929Turn on/off secondary screen scroll (default enabled). If the this 977Turn on/off secondary screen scroll (default enabled). If the this
930option is enabled, scrolls on the secondary screen will change the 978option is enabled, scrolls on the secondary screen will change the
931scrollback buffer and switching to/from the secondary screen will 979scrollback buffer and switching to/from the secondary screen will
932instead scroll the screen up. 980instead scroll the screen up.
981
982=item B<hold>: I<bool>
983
984Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
985will not immediately destroy its window when the program executed within
986it exits. Instead, it will wait till it is being killed or closed by the
987user.
933 988
934=item B<keysym.>I<sym>: I<string> 989=item B<keysym.>I<sym>: I<string>
935 990
936Compile I<frills>: Associate I<string> with keysym I<sym>. The 991Compile I<frills>: Associate I<string> with keysym I<sym>. The
937intervening resource name B<keysym.> cannot be omitted. 992intervening resource name B<keysym.> cannot be omitted.
982is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1037is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
983example the following means "change the current locale to C<zh_CN.GBK> 1038example the following means "change the current locale to C<zh_CN.GBK>
984when Control-Meta-c is being pressed": 1039when Control-Meta-c is being pressed":
985 1040
986 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1041 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1042
1043If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1044is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1045manpage. For example, the F<selection> extension (activated via
1046C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1047
1048 URxvt.keysym.M-C-c: perl:selection:rot13
987 1049
988Due the the large number of modifier combinations, a defined key mapping 1050Due 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 1051will 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 1052no other key mappings with those and more bits are being defined. That
991means that defining a key map for C<a> will automatically provide 1053means that defining a key map for C<a> will automatically provide
1015info): 1077info):
1016 1078
1017 URxvt.keysym.M-C-3: command:\033[8;25;80t 1079 URxvt.keysym.M-C-3: command:\033[8;25;80t
1018 URxvt.keysym.M-C-4: command:\033[8;48;110t 1080 URxvt.keysym.M-C-4: command:\033[8;48;110t
1019 1081
1082=item B<perl-ext-common>: I<string>
1083
1084=item B<perl-ext>: I<string>
1085
1086Colon-separated list(s) of perl extension scripts to use in this terminal
1087instance. Each extension is looked up in the library directories, loaded
1088if necessary, and bound to the current terminal instance. If this
1089resource is empty or missing, then the perl interpreter will not be
1090initialized. The idea behind two options is that B<perl-ext-common> will
1091be used for extensions that should be available to all instances, while
1092B<perl-ext> is used for specific instances; option B<-pe>.
1093
1094=item B<perl-eval>: I<string>
1095
1096Perl code to be evaluated when all extensions have been registered. See the
1097@@RXVT_NAME@@perl(3) manpage.
1098
1099=item B<perl-lib>: I<path>
1100
1101Colon-separated list of additional directories that hold extension
1102scripts. When looking for extensions specified by the C<perl> resource,
1103@@RXVT_NAME@@ will first look in these directories and then in
1104F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1105
1106See the @@RXVT_NAME@@perl(3) manpage.
1107
1020=back 1108=back
1021 1109
1022=head1 THE SCROLLBAR 1110=head1 THE SCROLLBAR
1023 1111
1024Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1112Lines 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 1146to select a word; Left triple-click to select the entire logical line
1059(which can span multiple screen lines), unless modified by resource 1147(which can span multiple screen lines), unless modified by resource
1060B<tripleclickwords>. 1148B<tripleclickwords>.
1061 1149
1062Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1150Starting 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 1151(Compile: I<frills>) will create a rectangular selection instead of a
1064one. 1152normal one. In this mode, every selected row becomes its own line in the
1153selection, and trailing whitespace is visually underlined and removed from
1154the selection.
1065 1155
1066=item B<Insertion>: 1156=item B<Insertion>:
1067 1157
1068Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1158Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
1069an B<@@RXVT_NAME@@> window causes the current text selection to be 1159an B<@@RXVT_NAME@@> window causes the current text selection to be

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines