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.84 by root, Wed Jan 4 05:35:34 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 font-styles: The bold font list to use when B<bold> characters are to
192be printed. See resource B<boldFont> for details. 195be 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 font-styles: The italic font list to use when I<italic> characters are to
197be printed. See resource B<italicFont> for details. 200be 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 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 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
310given 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
311on 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
312run the program specified by the B<SHELL> environment variable or, 322run the program specified by the B<SHELL> environment variable or,
313failing that, I<sh(1)>. 323failing that, I<sh(1)>.
314 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
315=item B<-title> I<text> 330=item B<-title> I<text>
316 331
317Window title (B<-T> still respected); the default title is the basename 332Window title (B<-T> still respected); the default title is the basename
318of 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
319application name; resource B<title>. 334application name; resource B<title>.
374 389
375=item B<-ssr>|B<+ssr> 390=item B<-ssr>|B<+ssr>
376 391
377Turn on/off secondary screen scroll (default enabled); resource 392Turn on/off secondary screen scroll (default enabled); resource
378B<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>.
379 401
380=item B<-keysym.>I<sym> I<string> 402=item B<-keysym.>I<sym> I<string>
381 403
382Remap a key symbol. See resource B<keysym>. 404Remap a key symbol. See resource B<keysym>.
383 405
431 close $pty; 453 close $pty;
432 454
433 # now communicate with rxvt 455 # now communicate with rxvt
434 my $slave = $pty->slave; 456 my $slave = $pty->slave;
435 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>.
436 463
437=back 464=back
438 465
439=head1 RESOURCES (available also as long-options) 466=head1 RESOURCES (available also as long-options)
440 467
616 643
617Select 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
618names that are used in turn when trying to display Unicode characters. 645names that are used in turn when trying to display Unicode characters.
619The first font defines the cell size for characters; other fonts might 646The first font defines the cell size for characters; other fonts might
620be smaller, but not larger. A reasonable default font list is always 647be smaller, but not larger. A reasonable default font list is always
621appended to it. option B<-fn>. 648appended to it; option B<-fn>.
622 649
623Each 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
624optional 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:>.
625 652
626In addition, each font can be prefixed with additional hints and 653In addition, each font can be prefixed with additional hints and
672not possible, replacement fonts of the desired shape will be tried. 699not possible, replacement fonts of the desired shape will be tried.
673 700
674If 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
675text font will being used for the given style. 702text font will being used for the given style.
676 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
677=item B<selectstyle:> I<mode> 712=item B<selectstyle:> I<mode>
678 713
679Set 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
680xterm 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
681xterm style selection. 716xterm style selection.
873=item B<imLocale:> I<name> 908=item B<imLocale:> I<name>
874 909
875The 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.
876C<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
877input extension to be able to input japanese characters while staying in 912input extension to be able to input japanese characters while staying in
878another locale. option B<-imlocale>. 913another locale; option B<-imlocale>.
879 914
880=item B<imFont:> I<fontset> 915=item B<imFont:> I<fontset>
881 916
882Specify the font-set used for XIM styles C<OverTheSpot> or 917Specify the font-set used for XIM styles C<OverTheSpot> or
883C<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
888 923
889=item B<tripleclickwords:> I<boolean> 924=item B<tripleclickwords:> I<boolean>
890 925
891Change the meaning of triple-click selection with the left mouse 926Change the meaning of triple-click selection with the left mouse
892button. 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
893the end of the logical line only. option B<-tcw>. 928the end of the logical line only; option B<-tcw>.
894 929
895=item B<insecure:> I<boolean> 930=item B<insecure:> I<boolean>
896 931
897Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 932Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
898echo 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
899abused if somebody gets 8-bit-clean access to your display, whether 934abused if somebody gets 8-bit-clean access to your display, whether
900throuh a mail client displaying mail bodies unfiltered or though 935through a mail client displaying mail bodies unfiltered or through
901write(1). Therefore, these sequences are disabled by default. (Note 936write(1) or any other means. Therefore, these sequences are disabled by
902that other terminals, including xterm, have these sequences 937default. (Note that many other terminals, including xterm, have these
903enabled by default). You can enable them by setting this boolean 938sequences enabled by default, which doesn't make it safer, though).
904resource or specifying B<-insecure> as an option. At the moment, this 939
905enabled display-answer, locale, findfont, icon label and window title 940You can enable them by setting this boolean resource or specifying
906requests as well as dynamic menubar dispatch. 941B<-insecure> as an option. At the moment, this enables display-answer,
942locale, findfont, icon label and window title requests as well as dynamic
943menubar dispatch.
907 944
908=item B<modifier:> I<modifier> 945=item B<modifier:> I<modifier>
909 946
910Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 947Set 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 948B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
925 962
926Turn on/off secondary screen scroll (default enabled). If the this 963Turn on/off secondary screen scroll (default enabled). If the this
927option is enabled, scrolls on the secondary screen will change the 964option is enabled, scrolls on the secondary screen will change the
928scrollback buffer and switching to/from the secondary screen will 965scrollback buffer and switching to/from the secondary screen will
929instead scroll the screen up. 966instead scroll the screen up.
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.
930 974
931=item B<keysym.>I<sym>: I<string> 975=item B<keysym.>I<sym>: I<string>
932 976
933Compile I<frills>: Associate I<string> with keysym I<sym>. The 977Compile I<frills>: Associate I<string> with keysym I<sym>. The
934intervening resource name B<keysym.> cannot be omitted. 978intervening resource name B<keysym.> cannot be omitted.
979is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1023is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
980example 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>
981when Control-Meta-c is being pressed": 1025when Control-Meta-c is being pressed":
982 1026
983 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
984 1035
985Due the the large number of modifier combinations, a defined key mapping 1036Due 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 1037will 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 1038no other key mappings with those and more bits are being defined. That
988means that defining a key map for C<a> will automatically provide 1039means that defining a key map for C<a> will automatically provide
1012info): 1063info):
1013 1064
1014 URxvt.keysym.M-C-3: command:\033[8;25;80t 1065 URxvt.keysym.M-C-3: command:\033[8;25;80t
1015 URxvt.keysym.M-C-4: command:\033[8;48;110t 1066 URxvt.keysym.M-C-4: command:\033[8;48;110t
1016 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
1017=back 1094=back
1018 1095
1019=head1 THE SCROLLBAR 1096=head1 THE SCROLLBAR
1020 1097
1021Lines 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
1055to 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
1056(which can span multiple screen lines), unless modified by resource 1133(which can span multiple screen lines), unless modified by resource
1057B<tripleclickwords>. 1134B<tripleclickwords>.
1058 1135
1059Starting 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)
1060(Compile: I<frills>) will create a rectangular selection instead of a normal 1137(Compile: I<frills>) will create a rectangular selection instead of a
1061one. 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.
1062 1141
1063=item B<Insertion>: 1142=item B<Insertion>:
1064 1143
1065Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1144Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
1066an B<@@RXVT_NAME@@> window causes the current text selection to be 1145an B<@@RXVT_NAME@@> window causes the current text selection to be
1074supported in rxvt-unicode. Bug me if you need this. 1153supported in rxvt-unicode. Bug me if you need this.
1075 1154
1076You can, however, switch fonts at runtime using escape sequences (and 1155You can, however, switch fonts at runtime using escape sequences (and
1077therefore using the menubar), e.g.: 1156therefore using the menubar), e.g.:
1078 1157
1079 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1158 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1080 1159
1081rxvt-unicode will automatically re-apply these fonts to the output so far. 1160rxvt-unicode will automatically re-apply these fonts to the output so far.
1082 1161
1083=head1 ISO 14755 SUPPORT 1162=head1 ISO 14755 SUPPORT
1084 1163
1293 1372
1294=head1 SEE ALSO 1373=head1 SEE ALSO
1295 1374
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) 1375@@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 1376
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 1377=head1 CURRENT PROJECT COORDINATOR
1307 1378
1308=over 4 1379=over 4
1309 1380
1310=item Project Coordinator 1381=item Project Coordinator

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines