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.68 by root, Thu Aug 11 02:05:07 2005 UTC vs.
Revision 1.85 by root, Wed Jan 4 20:43:37 2006 UTC

105 105
106=item B<-j>|B<+j> 106=item B<-j>|B<+j>
107 107
108Turn on/off jump scrolling; resource B<jumpScroll>. 108Turn on/off jump scrolling; resource B<jumpScroll>.
109 109
110=item B<-ip>|B<+ip> 110=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
111 111
112Turn on/off inheriting parent window's pixmap. Alternative form is 112Turn on/off inheriting parent window's pixmap. Alternative form is
113B<-tr>; resource B<inheritPixmap>. 113B<-tr>; resource B<inheritPixmap>.
114 114
115=item B<-fade> I<number> 115=item B<-fade> I<number>
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>. 131used to brighten or darken the image in addition to tinting it; resource
132I<tintColor>. Example:
133
134 @@RXVT_NAME@@ -tr -tint blue -sh 40
132 135
133=item B<-sh> 136=item B<-sh>
134 137
135I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
136background image in addition to tinting it (i.e. B<-tint> must be 139background image in addition to tinting it (i.e. B<-tint> must be
186See 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
187section of @@RXVT_NAME@@(7). 190section of @@RXVT_NAME@@(7).
188 191
189=item B<-fb> I<fontlist> 192=item B<-fb> I<fontlist>
190 193
191Compile 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
192be printed. See resource B<boldFont> for details. 195are to be printed. See resource B<boldFont> for details.
193 196
194=item B<-fi> I<fontlist> 197=item B<-fi> I<fontlist>
195 198
196Compile 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>
197be printed. See resource B<italicFont> for details. 200characters are to be printed. See resource B<italicFont> for details.
198 201
199=item B<-fbi> I<fontlist> 202=item B<-fbi> I<fontlist>
200 203
201Compile 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
202be 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.
203 213
204=item B<-name> I<name> 214=item B<-name> I<name>
205 215
206Specify the application name under which resources are to be obtained, 216Specify the application name under which resources are to be obtained,
207rather than the default executable file name. Name should not contain 217rather than the default executable file name. Name should not contain
286=item B<-bl> 296=item B<-bl>
287 297
288Compile 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.
289if 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
290decorations; 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>.
291 308
292=item B<-lsp> I<number> 309=item B<-lsp> I<number>
293 310
294Compile I<frills>: Lines (pixel height) to insert between each row of 311Compile I<frills>: Lines (pixel height) to insert between each row of
295the display. Useful to work around font rendering problems; resource 312the display. Useful to work around font rendering problems; resource
310given 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
311on 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
312run the program specified by the B<SHELL> environment variable or, 329run the program specified by the B<SHELL> environment variable or,
313failing that, I<sh(1)>. 330failing that, I<sh(1)>.
314 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
315=item B<-title> I<text> 337=item B<-title> I<text>
316 338
317Window title (B<-T> still respected); the default title is the basename 339Window title (B<-T> still respected); the default title is the basename
318of 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
319application name; resource B<title>. 341application name; resource B<title>.
374 396
375=item B<-ssr>|B<+ssr> 397=item B<-ssr>|B<+ssr>
376 398
377Turn on/off secondary screen scroll (default enabled); resource 399Turn on/off secondary screen scroll (default enabled); resource
378B<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>.
379 408
380=item B<-keysym.>I<sym> I<string> 409=item B<-keysym.>I<sym> I<string>
381 410
382Remap a key symbol. See resource B<keysym>. 411Remap a key symbol. See resource B<keysym>.
383 412
431 close $pty; 460 close $pty;
432 461
433 # now communicate with rxvt 462 # now communicate with rxvt
434 my $slave = $pty->slave; 463 my $slave = $pty->slave;
435 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>.
436 470
437=back 471=back
438 472
439=head1 RESOURCES (available also as long-options) 473=head1 RESOURCES (available also as long-options)
440 474
616 650
617Select 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
618names that are used in turn when trying to display Unicode characters. 652names that are used in turn when trying to display Unicode characters.
619The first font defines the cell size for characters; other fonts might 653The first font defines the cell size for characters; other fonts might
620be smaller, but not larger. A reasonable default font list is always 654be smaller, but not larger. A reasonable default font list is always
621appended to it. option B<-fn>. 655appended to it; option B<-fn>.
622 656
623Each 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
624optional 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:>.
625 659
626In addition, each font can be prefixed with additional hints and 660In addition, each font can be prefixed with additional hints and
672not possible, replacement fonts of the desired shape will be tried. 706not possible, replacement fonts of the desired shape will be tried.
673 707
674If 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
675text font will being used for the given style. 709text font will being used for the given style.
676 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
677=item B<selectstyle:> I<mode> 719=item B<selectstyle:> I<mode>
678 720
679Set 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
680xterm 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
681xterm style selection. 723xterm style selection.
791=item B<borderLess:> I<boolean> 833=item B<borderLess:> I<boolean>
792 834
793Set 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
794WM, 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>.
795 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
796=item B<termName:> I<termname> 845=item B<termName:> I<termname>
797 846
798Specifies 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
799variable; option B<-tn>. 848variable; option B<-tn>.
800 849
873=item B<imLocale:> I<name> 922=item B<imLocale:> I<name>
874 923
875The 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.
876C<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
877input extension to be able to input japanese characters while staying in 926input extension to be able to input japanese characters while staying in
878another locale. option B<-imlocale>. 927another locale; option B<-imlocale>.
879 928
880=item B<imFont:> I<fontset> 929=item B<imFont:> I<fontset>
881 930
882Specify the font-set used for XIM styles C<OverTheSpot> or 931Specify the font-set used for XIM styles C<OverTheSpot> or
883C<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
888 937
889=item B<tripleclickwords:> I<boolean> 938=item B<tripleclickwords:> I<boolean>
890 939
891Change the meaning of triple-click selection with the left mouse 940Change the meaning of triple-click selection with the left mouse
892button. 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
893the end of the logical line only. option B<-tcw>. 942the end of the logical line only; option B<-tcw>.
894 943
895=item B<insecure:> I<boolean> 944=item B<insecure:> I<boolean>
896 945
897Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 946Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
898echo 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
899abused if somebody gets 8-bit-clean access to your display, whether 948abused if somebody gets 8-bit-clean access to your display, whether
900throuh a mail client displaying mail bodies unfiltered or though 949through a mail client displaying mail bodies unfiltered or through
901write(1). Therefore, these sequences are disabled by default. (Note 950write(1) or any other means. Therefore, these sequences are disabled by
902that other terminals, including xterm, have these sequences 951default. (Note that many other terminals, including xterm, have these
903enabled by default). You can enable them by setting this boolean 952sequences enabled by default, which doesn't make it safer, though).
904resource or specifying B<-insecure> as an option. At the moment, this 953
905enabled display-answer, locale, findfont, icon label and window title 954You can enable them by setting this boolean resource or specifying
906requests 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.
907 958
908=item B<modifier:> I<modifier> 959=item B<modifier:> I<modifier>
909 960
910Set 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>,
911B<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
925 976
926Turn on/off secondary screen scroll (default enabled). If the this 977Turn on/off secondary screen scroll (default enabled). If the this
927option is enabled, scrolls on the secondary screen will change the 978option is enabled, scrolls on the secondary screen will change the
928scrollback buffer and switching to/from the secondary screen will 979scrollback buffer and switching to/from the secondary screen will
929instead 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.
930 988
931=item B<keysym.>I<sym>: I<string> 989=item B<keysym.>I<sym>: I<string>
932 990
933Compile I<frills>: Associate I<string> with keysym I<sym>. The 991Compile I<frills>: Associate I<string> with keysym I<sym>. The
934intervening resource name B<keysym.> cannot be omitted. 992intervening resource name B<keysym.> cannot be omitted.
979is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1037is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
980example 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>
981when Control-Meta-c is being pressed": 1039when Control-Meta-c is being pressed":
982 1040
983 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
984 1049
985Due the the large number of modifier combinations, a defined key mapping 1050Due the the large number of modifier combinations, a defined key mapping
986will 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
987no 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
988means that defining a key map for C<a> will automatically provide 1053means that defining a key map for C<a> will automatically provide
1012info): 1077info):
1013 1078
1014 URxvt.keysym.M-C-3: command:\033[8;25;80t 1079 URxvt.keysym.M-C-3: command:\033[8;25;80t
1015 URxvt.keysym.M-C-4: command:\033[8;48;110t 1080 URxvt.keysym.M-C-4: command:\033[8;48;110t
1016 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
1017=back 1108=back
1018 1109
1019=head1 THE SCROLLBAR 1110=head1 THE SCROLLBAR
1020 1111
1021Lines 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
1055to 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
1056(which can span multiple screen lines), unless modified by resource 1147(which can span multiple screen lines), unless modified by resource
1057B<tripleclickwords>. 1148B<tripleclickwords>.
1058 1149
1059Starting 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)
1060(Compile: I<frills>) will create a rectangular selection instead of a normal 1151(Compile: I<frills>) will create a rectangular selection instead of a
1061one. 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.
1062 1155
1063=item B<Insertion>: 1156=item B<Insertion>:
1064 1157
1065Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1158Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
1066an B<@@RXVT_NAME@@> window causes the current text selection to be 1159an B<@@RXVT_NAME@@> window causes the current text selection to be
1074supported in rxvt-unicode. Bug me if you need this. 1167supported in rxvt-unicode. Bug me if you need this.
1075 1168
1076You can, however, switch fonts at runtime using escape sequences (and 1169You can, however, switch fonts at runtime using escape sequences (and
1077therefore using the menubar), e.g.: 1170therefore using the menubar), e.g.:
1078 1171
1079 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1172 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1080 1173
1081rxvt-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.
1082 1175
1083=head1 ISO 14755 SUPPORT 1176=head1 ISO 14755 SUPPORT
1084 1177
1293 1386
1294=head1 SEE ALSO 1387=head1 SEE ALSO
1295 1388
1296@@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)
1297 1390
1298=head1 BUGS
1299
1300Check the BUGS file for an up-to-date list.
1301
1302Cursor change support is not yet implemented.
1303
1304Click-and-drag doesn't work with X11 mouse report overriding.
1305
1306=head1 CURRENT PROJECT COORDINATOR 1391=head1 CURRENT PROJECT COORDINATOR
1307 1392
1308=over 4 1393=over 4
1309 1394
1310=item Project Coordinator 1395=item Project Coordinator

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines