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.85 by root, Wed Jan 4 20:43:37 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
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<-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>.
293 308
294=item B<-lsp> I<number> 309=item B<-lsp> I<number>
295 310
296Compile I<frills>: Lines (pixel height) to insert between each row of 311Compile I<frills>: Lines (pixel height) to insert between each row of
297the display. Useful to work around font rendering problems; resource 312the display. Useful to work around font rendering problems; resource
312given 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
313on 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
314run the program specified by the B<SHELL> environment variable or, 329run the program specified by the B<SHELL> environment variable or,
315failing that, I<sh(1)>. 330failing that, I<sh(1)>.
316 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
317=item B<-title> I<text> 337=item B<-title> I<text>
318 338
319Window title (B<-T> still respected); the default title is the basename 339Window title (B<-T> still respected); the default title is the basename
320of 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
321application name; resource B<title>. 341application name; resource B<title>.
376 396
377=item B<-ssr>|B<+ssr> 397=item B<-ssr>|B<+ssr>
378 398
379Turn on/off secondary screen scroll (default enabled); resource 399Turn on/off secondary screen scroll (default enabled); resource
380B<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>.
381 408
382=item B<-keysym.>I<sym> I<string> 409=item B<-keysym.>I<sym> I<string>
383 410
384Remap a key symbol. See resource B<keysym>. 411Remap a key symbol. See resource B<keysym>.
385 412
433 close $pty; 460 close $pty;
434 461
435 # now communicate with rxvt 462 # now communicate with rxvt
436 my $slave = $pty->slave; 463 my $slave = $pty->slave;
437 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>.
438 470
439=back 471=back
440 472
441=head1 RESOURCES (available also as long-options) 473=head1 RESOURCES (available also as long-options)
442 474
618 650
619Select 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
620names that are used in turn when trying to display Unicode characters. 652names that are used in turn when trying to display Unicode characters.
621The first font defines the cell size for characters; other fonts might 653The first font defines the cell size for characters; other fonts might
622be smaller, but not larger. A reasonable default font list is always 654be smaller, but not larger. A reasonable default font list is always
623appended to it. option B<-fn>. 655appended to it; option B<-fn>.
624 656
625Each 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
626optional 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:>.
627 659
628In addition, each font can be prefixed with additional hints and 660In addition, each font can be prefixed with additional hints and
674not possible, replacement fonts of the desired shape will be tried. 706not possible, replacement fonts of the desired shape will be tried.
675 707
676If 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
677text font will being used for the given style. 709text font will being used for the given style.
678 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
679=item B<selectstyle:> I<mode> 719=item B<selectstyle:> I<mode>
680 720
681Set 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
682xterm 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
683xterm style selection. 723xterm style selection.
793=item B<borderLess:> I<boolean> 833=item B<borderLess:> I<boolean>
794 834
795Set 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
796WM, 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>.
797 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
798=item B<termName:> I<termname> 845=item B<termName:> I<termname>
799 846
800Specifies 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
801variable; option B<-tn>. 848variable; option B<-tn>.
802 849
875=item B<imLocale:> I<name> 922=item B<imLocale:> I<name>
876 923
877The 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.
878C<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
879input extension to be able to input japanese characters while staying in 926input extension to be able to input japanese characters while staying in
880another locale. option B<-imlocale>. 927another locale; option B<-imlocale>.
881 928
882=item B<imFont:> I<fontset> 929=item B<imFont:> I<fontset>
883 930
884Specify the font-set used for XIM styles C<OverTheSpot> or 931Specify the font-set used for XIM styles C<OverTheSpot> or
885C<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
890 937
891=item B<tripleclickwords:> I<boolean> 938=item B<tripleclickwords:> I<boolean>
892 939
893Change the meaning of triple-click selection with the left mouse 940Change the meaning of triple-click selection with the left mouse
894button. 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
895the end of the logical line only. option B<-tcw>. 942the end of the logical line only; option B<-tcw>.
896 943
897=item B<insecure:> I<boolean> 944=item B<insecure:> I<boolean>
898 945
899Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 946Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
900echo 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
901abused if somebody gets 8-bit-clean access to your display, whether 948abused if somebody gets 8-bit-clean access to your display, whether
902throuh a mail client displaying mail bodies unfiltered or though 949through a mail client displaying mail bodies unfiltered or through
903write(1). Therefore, these sequences are disabled by default. (Note 950write(1) or any other means. Therefore, these sequences are disabled by
904that other terminals, including xterm, have these sequences 951default. (Note that many other terminals, including xterm, have these
905enabled by default). You can enable them by setting this boolean 952sequences enabled by default, which doesn't make it safer, though).
906resource or specifying B<-insecure> as an option. At the moment, this 953
907enabled display-answer, locale, findfont, icon label and window title 954You can enable them by setting this boolean resource or specifying
908requests 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.
909 958
910=item B<modifier:> I<modifier> 959=item B<modifier:> I<modifier>
911 960
912Set 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>,
913B<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
927 976
928Turn on/off secondary screen scroll (default enabled). If the this 977Turn on/off secondary screen scroll (default enabled). If the this
929option is enabled, scrolls on the secondary screen will change the 978option is enabled, scrolls on the secondary screen will change the
930scrollback buffer and switching to/from the secondary screen will 979scrollback buffer and switching to/from the secondary screen will
931instead 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.
932 988
933=item B<keysym.>I<sym>: I<string> 989=item B<keysym.>I<sym>: I<string>
934 990
935Compile I<frills>: Associate I<string> with keysym I<sym>. The 991Compile I<frills>: Associate I<string> with keysym I<sym>. The
936intervening resource name B<keysym.> cannot be omitted. 992intervening resource name B<keysym.> cannot be omitted.
981is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1037is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
982example 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>
983when Control-Meta-c is being pressed": 1039when Control-Meta-c is being pressed":
984 1040
985 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
986 1049
987Due the the large number of modifier combinations, a defined key mapping 1050Due 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 1051will 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 1052no other key mappings with those and more bits are being defined. That
990means that defining a key map for C<a> will automatically provide 1053means that defining a key map for C<a> will automatically provide
1014info): 1077info):
1015 1078
1016 URxvt.keysym.M-C-3: command:\033[8;25;80t 1079 URxvt.keysym.M-C-3: command:\033[8;25;80t
1017 URxvt.keysym.M-C-4: command:\033[8;48;110t 1080 URxvt.keysym.M-C-4: command:\033[8;48;110t
1018 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
1019=back 1108=back
1020 1109
1021=head1 THE SCROLLBAR 1110=head1 THE SCROLLBAR
1022 1111
1023Lines 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
1057to 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
1058(which can span multiple screen lines), unless modified by resource 1147(which can span multiple screen lines), unless modified by resource
1059B<tripleclickwords>. 1148B<tripleclickwords>.
1060 1149
1061Starting 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)
1062(Compile: I<frills>) will create a rectangular selection instead of a normal 1151(Compile: I<frills>) will create a rectangular selection instead of a
1063one. 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.
1064 1155
1065=item B<Insertion>: 1156=item B<Insertion>:
1066 1157
1067Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1158Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
1068an B<@@RXVT_NAME@@> window causes the current text selection to be 1159an B<@@RXVT_NAME@@> window causes the current text selection to be
1076supported in rxvt-unicode. Bug me if you need this. 1167supported in rxvt-unicode. Bug me if you need this.
1077 1168
1078You can, however, switch fonts at runtime using escape sequences (and 1169You can, however, switch fonts at runtime using escape sequences (and
1079therefore using the menubar), e.g.: 1170therefore using the menubar), e.g.:
1080 1171
1081 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1172 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1082 1173
1083rxvt-unicode will automatically re-apply these fonts to the output so far. 1174rxvt-unicode will automatically re-apply these fonts to the output so far.
1084 1175
1085=head1 ISO 14755 SUPPORT 1176=head1 ISO 14755 SUPPORT
1086 1177
1295 1386
1296=head1 SEE ALSO 1387=head1 SEE ALSO
1297 1388
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) 1389@@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 1390
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 1391=head1 CURRENT PROJECT COORDINATOR
1309 1392
1310=over 4 1393=over 4
1311 1394
1312=item Project Coordinator 1395=item Project Coordinator

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines