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.78 by root, Mon Jan 2 20:35:39 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
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 bold characters are to
202be printed. See resource B<boldItalicFont> for details. 205be printed. See resource B<boldItalicFont> for details.
206
207=item B<-is>|B<+is>
208
209Compile font-styles: Bold/Italic font styles imply high intensity
210foreground/background (default). See resource B<intensityStyles> for
211details.
203 212
204=item B<-name> I<name> 213=item B<-name> I<name>
205 214
206Specify the application name under which resources are to be obtained, 215Specify the application name under which resources are to be obtained,
207rather than the default executable file name. Name should not contain 216rather 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 319given 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 320on 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, 321run the program specified by the B<SHELL> environment variable or,
313failing that, I<sh(1)>. 322failing that, I<sh(1)>.
314 323
324Please note that you must specify a program with arguments. If you want to
325run shell commands, you have to specify the shell, like this:
326
327 @@RXVT_NAME@@ -e sh -c "shell commands"
328
315=item B<-title> I<text> 329=item B<-title> I<text>
316 330
317Window title (B<-T> still respected); the default title is the basename 331Window title (B<-T> still respected); the default title is the basename
318of the program specified after the B<-e> option, if any, otherwise the 332of the program specified after the B<-e> option, if any, otherwise the
319application name; resource B<title>. 333application name; resource B<title>.
374 388
375=item B<-ssr>|B<+ssr> 389=item B<-ssr>|B<+ssr>
376 390
377Turn on/off secondary screen scroll (default enabled); resource 391Turn on/off secondary screen scroll (default enabled); resource
378B<secondaryScroll>. 392B<secondaryScroll>.
393
394=item B<-hold>|B<+hold>
395
396Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
397will not immediately destroy its window when the program executed within
398it exits. Instead, it will wait till it is being killed or closed by the
399user; resource B<hold>.
379 400
380=item B<-keysym.>I<sym> I<string> 401=item B<-keysym.>I<sym> I<string>
381 402
382Remap a key symbol. See resource B<keysym>. 403Remap a key symbol. See resource B<keysym>.
383 404
431 close $pty; 452 close $pty;
432 453
433 # now communicate with rxvt 454 # now communicate with rxvt
434 my $slave = $pty->slave; 455 my $slave = $pty->slave;
435 while (<$slave>) { print $slave "got <$_>\n" } 456 while (<$slave>) { print $slave "got <$_>\n" }
457
458=item B<-pe> I<string>
459
460Colon-separated list of perl extension scripts to use in this terminal instance. See resource B<perl-ext>.
436 461
437=back 462=back
438 463
439=head1 RESOURCES (available also as long-options) 464=head1 RESOURCES (available also as long-options)
440 465
616 641
617Select the fonts to be used. This is a comma separated list of font 642Select 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. 643names that are used in turn when trying to display Unicode characters.
619The first font defines the cell size for characters; other fonts might 644The first font defines the cell size for characters; other fonts might
620be smaller, but not larger. A reasonable default font list is always 645be smaller, but not larger. A reasonable default font list is always
621appended to it. option B<-fn>. 646appended to it; option B<-fn>.
622 647
623Each font can either be a standard X11 core font (XLFD) name, with 648Each 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:>. 649optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
625 650
626In addition, each font can be prefixed with additional hints and 651In addition, each font can be prefixed with additional hints and
672not possible, replacement fonts of the desired shape will be tried. 697not possible, replacement fonts of the desired shape will be tried.
673 698
674If set, but empty, then this specific style is disabled and the normal 699If set, but empty, then this specific style is disabled and the normal
675text font will being used for the given style. 700text font will being used for the given style.
676 701
702=item B<intensityStyles:> I<boolean>
703
704When font styles are not enabled, or this option is enabled (B<True>,
705option B<-is>, the default), bold and italic font styles imply high
706intensity foreground/backround colours. Disabling this option (B<False>,
707option B<+is>) disables this behaviour, the high intensity colours are not
708reachable.
709
677=item B<selectstyle:> I<mode> 710=item B<selectstyle:> I<mode>
678 711
679Set mouse selection style to B<old> which is 2.20, B<oldword> which is 712Set 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 713xterm style with 2.20 old word selection, or anything else which gives
681xterm style selection. 714xterm style selection.
873=item B<imLocale:> I<name> 906=item B<imLocale:> I<name>
874 907
875The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 908The 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 909C<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 910input extension to be able to input japanese characters while staying in
878another locale. option B<-imlocale>. 911another locale; option B<-imlocale>.
879 912
880=item B<imFont:> I<fontset> 913=item B<imFont:> I<fontset>
881 914
882Specify the font-set used for XIM styles C<OverTheSpot> or 915Specify the font-set used for XIM styles C<OverTheSpot> or
883C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 916C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
888 921
889=item B<tripleclickwords:> I<boolean> 922=item B<tripleclickwords:> I<boolean>
890 923
891Change the meaning of triple-click selection with the left mouse 924Change the meaning of triple-click selection with the left mouse
892button. Instead of selecting a full line it will extend the selection to 925button. Instead of selecting a full line it will extend the selection to
893the end of the logical line only. option B<-tcw>. 926the end of the logical line only; option B<-tcw>.
894 927
895=item B<insecure:> I<boolean> 928=item B<insecure:> I<boolean>
896 929
897Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 930Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
898echo arbitrary strings like the icon name or the locale. This could be 931echo arbitrary strings like the icon name or the locale. This could be
899abused if somebody gets 8-bit-clean access to your display, whether 932abused if somebody gets 8-bit-clean access to your display, whether
900throuh a mail client displaying mail bodies unfiltered or though 933through a mail client displaying mail bodies unfiltered or through
901write(1). Therefore, these sequences are disabled by default. (Note 934write(1) or any other means. Therefore, these sequences are disabled by
902that other terminals, including xterm, have these sequences 935default. (Note that many other terminals, including xterm, have these
903enabled by default). You can enable them by setting this boolean 936sequences enabled by default, which doesn't make it safer, though).
904resource or specifying B<-insecure> as an option. At the moment, this 937
905enabled display-answer, locale, findfont, icon label and window title 938You can enable them by setting this boolean resource or specifying
906requests as well as dynamic menubar dispatch. 939B<-insecure> as an option. At the moment, this enables display-answer,
940locale, findfont, icon label and window title requests as well as dynamic
941menubar dispatch.
907 942
908=item B<modifier:> I<modifier> 943=item B<modifier:> I<modifier>
909 944
910Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 945Set 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 946B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
925 960
926Turn on/off secondary screen scroll (default enabled). If the this 961Turn on/off secondary screen scroll (default enabled). If the this
927option is enabled, scrolls on the secondary screen will change the 962option is enabled, scrolls on the secondary screen will change the
928scrollback buffer and switching to/from the secondary screen will 963scrollback buffer and switching to/from the secondary screen will
929instead scroll the screen up. 964instead scroll the screen up.
965
966=item B<hold>: I<bool>
967
968Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
969will not immediately destroy its window when the program executed within
970it exits. Instead, it will wait till it is being killed or closed by the
971user.
930 972
931=item B<keysym.>I<sym>: I<string> 973=item B<keysym.>I<sym>: I<string>
932 974
933Compile I<frills>: Associate I<string> with keysym I<sym>. The 975Compile I<frills>: Associate I<string> with keysym I<sym>. The
934intervening resource name B<keysym.> cannot be omitted. 976intervening resource name B<keysym.> cannot be omitted.
1012info): 1054info):
1013 1055
1014 URxvt.keysym.M-C-3: command:\033[8;25;80t 1056 URxvt.keysym.M-C-3: command:\033[8;25;80t
1015 URxvt.keysym.M-C-4: command:\033[8;48;110t 1057 URxvt.keysym.M-C-4: command:\033[8;48;110t
1016 1058
1059=item B<perl-ext>: I<string>
1060
1061Colon-separated list of perl extension scripts to use in this terminal
1062instance. Each extension is looked up in the library directories, loaded
1063if necessary, and bound to the current terminal instance; option B<-pe>.
1064
1065=item B<perl-eval>: I<string>
1066
1067Perl code to be evaluated when all extensions have been registered. See the
1068rxvtperl(3) manpage.
1069
1070=item B<perl-lib>: I<path>
1071
1072Colon-separated list of additional directories that hold extension
1073scripts. When looking for extensions specified by the C<perl> resource,
1074@@RXVT_NAME@@ will first look in these directories and then in
1075F<@@RXVT_LIBDIR@@/urxvt/perl-ext/>.
1076
1077See the rxvtperl(3) manpage.
1078
1017=back 1079=back
1018 1080
1019=head1 THE SCROLLBAR 1081=head1 THE SCROLLBAR
1020 1082
1021Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1083Lines 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 1117to select a word; Left triple-click to select the entire logical line
1056(which can span multiple screen lines), unless modified by resource 1118(which can span multiple screen lines), unless modified by resource
1057B<tripleclickwords>. 1119B<tripleclickwords>.
1058 1120
1059Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1121Starting 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 1122(Compile: I<frills>) will create a rectangular selection instead of a
1061one. 1123normal one. In this mode, every selected row becomes its own line in the
1124selection, and trailing whitespace is visually underlined and removed from
1125the selection.
1062 1126
1063=item B<Insertion>: 1127=item B<Insertion>:
1064 1128
1065Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1129Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
1066an B<@@RXVT_NAME@@> window causes the current text selection to be 1130an B<@@RXVT_NAME@@> window causes the current text selection to be
1074supported in rxvt-unicode. Bug me if you need this. 1138supported in rxvt-unicode. Bug me if you need this.
1075 1139
1076You can, however, switch fonts at runtime using escape sequences (and 1140You can, however, switch fonts at runtime using escape sequences (and
1077therefore using the menubar), e.g.: 1141therefore using the menubar), e.g.:
1078 1142
1079 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1143 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1080 1144
1081rxvt-unicode will automatically re-apply these fonts to the output so far. 1145rxvt-unicode will automatically re-apply these fonts to the output so far.
1082 1146
1083=head1 ISO 14755 SUPPORT 1147=head1 ISO 14755 SUPPORT
1084 1148
1293 1357
1294=head1 SEE ALSO 1358=head1 SEE ALSO
1295 1359
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) 1360@@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 1361
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 1362=head1 CURRENT PROJECT COORDINATOR
1307 1363
1308=over 4 1364=over 4
1309 1365
1310=item Project Coordinator 1366=item Project Coordinator

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines