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.92 by root, Wed Jan 11 02:13:55 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
406 $rxvt->signal_connect_after (realize => sub { 435 $rxvt->signal_connect_after (realize => sub {
407 my $xid = $_[0]->window->get_xid; 436 my $xid = $_[0]->window->get_xid;
408 system "@@RXVT_NAME@@ -embed $xid &"; 437 system "@@RXVT_NAME@@ -embed $xid &";
409 }); 438 });
410 439
411=item B<-pty-fd> I<fileno> 440=item B<-pty-fd> I<file descriptor>
412 441
413Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 442Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
414pair but instead use the given filehandle as the tty master. This is 443pair but instead use the given filehandle as the tty master. This is
415useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 444useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
416without having to run a program within it. 445without having to run a program within it.
417 446
418If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 447If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
419entries and will not tinker with pty/tty permissions - you have to do that 448entries and will not tinker with pty/tty permissions - you have to do that
420yourself if you want that. 449yourself if you want that.
421 450
451As an extremely special case, specifying C<-1> will completely suppress
452pty/tty operations.
453
422Here is a example in perl that illustrates how this option can be used (a 454Here is a example in perl that illustrates how this option can be used (a
423longer example is in F<doc/pty-fd>): 455longer example is in F<doc/pty-fd>):
424 456
425 use IO::Pty; 457 use IO::Pty;
426 use Fcntl; 458 use Fcntl;
431 close $pty; 463 close $pty;
432 464
433 # now communicate with rxvt 465 # now communicate with rxvt
434 my $slave = $pty->slave; 466 my $slave = $pty->slave;
435 while (<$slave>) { print $slave "got <$_>\n" } 467 while (<$slave>) { print $slave "got <$_>\n" }
468
469=item B<-pe> I<string>
470
471Comma-separated list of perl extension scripts to use (or not to use) in
472this terminal instance. See resource B<perl-ext> for details.
436 473
437=back 474=back
438 475
439=head1 RESOURCES (available also as long-options) 476=head1 RESOURCES (available also as long-options)
440 477
616 653
617Select the fonts to be used. This is a comma separated list of font 654Select 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. 655names that are used in turn when trying to display Unicode characters.
619The first font defines the cell size for characters; other fonts might 656The first font defines the cell size for characters; other fonts might
620be smaller, but not larger. A reasonable default font list is always 657be smaller, but not larger. A reasonable default font list is always
621appended to it. option B<-fn>. 658appended to it; option B<-fn>.
622 659
623Each font can either be a standard X11 core font (XLFD) name, with 660Each 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:>. 661optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
625 662
626In addition, each font can be prefixed with additional hints and 663In addition, each font can be prefixed with additional hints and
672not possible, replacement fonts of the desired shape will be tried. 709not possible, replacement fonts of the desired shape will be tried.
673 710
674If set, but empty, then this specific style is disabled and the normal 711If set, but empty, then this specific style is disabled and the normal
675text font will being used for the given style. 712text font will being used for the given style.
676 713
714=item B<intensityStyles:> I<boolean>
715
716When font styles are not enabled, or this option is enabled (B<True>,
717option B<-is>, the default), bold and italic font styles imply high
718intensity foreground/backround colours. Disabling this option (B<False>,
719option B<+is>) disables this behaviour, the high intensity colours are not
720reachable.
721
677=item B<selectstyle:> I<mode> 722=item B<selectstyle:> I<mode>
678 723
679Set mouse selection style to B<old> which is 2.20, B<oldword> which is 724Set 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 725xterm style with 2.20 old word selection, or anything else which gives
681xterm style selection. 726xterm style selection.
791=item B<borderLess:> I<boolean> 836=item B<borderLess:> I<boolean>
792 837
793Set MWM hints to request a borderless window, i.e. if honoured by the 838Set 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>. 839WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
795 840
841=item B<skipBuiltinGlyphs:> I<boolean>
842
843Compile I<frills>: Disable the usage of the built-in block graphics/line
844drawing characters and just rely on what the specified fonts provide. Use
845this if you have a good font and want to use its block graphic glyphs;
846option B<-sbg>.
847
796=item B<termName:> I<termname> 848=item B<termName:> I<termname>
797 849
798Specifies the terminal type name to be set in the B<TERM> environment 850Specifies the terminal type name to be set in the B<TERM> environment
799variable; option B<-tn>. 851variable; option B<-tn>.
800 852
873=item B<imLocale:> I<name> 925=item B<imLocale:> I<name>
874 926
875The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 927The 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 928C<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 929input extension to be able to input japanese characters while staying in
878another locale. option B<-imlocale>. 930another locale; option B<-imlocale>.
879 931
880=item B<imFont:> I<fontset> 932=item B<imFont:> I<fontset>
881 933
882Specify the font-set used for XIM styles C<OverTheSpot> or 934Specify the font-set used for XIM styles C<OverTheSpot> or
883C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 935C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
888 940
889=item B<tripleclickwords:> I<boolean> 941=item B<tripleclickwords:> I<boolean>
890 942
891Change the meaning of triple-click selection with the left mouse 943Change the meaning of triple-click selection with the left mouse
892button. Instead of selecting a full line it will extend the selection to 944button. Instead of selecting a full line it will extend the selection to
893the end of the logical line only. option B<-tcw>. 945the end of the logical line only; option B<-tcw>.
894 946
895=item B<insecure:> I<boolean> 947=item B<insecure:> I<boolean>
896 948
897Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 949Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
898echo arbitrary strings like the icon name or the locale. This could be 950echo arbitrary strings like the icon name or the locale. This could be
899abused if somebody gets 8-bit-clean access to your display, whether 951abused if somebody gets 8-bit-clean access to your display, whether
900throuh a mail client displaying mail bodies unfiltered or though 952through a mail client displaying mail bodies unfiltered or through
901write(1). Therefore, these sequences are disabled by default. (Note 953write(1) or any other means. Therefore, these sequences are disabled by
902that other terminals, including xterm, have these sequences 954default. (Note that many other terminals, including xterm, have these
903enabled by default). You can enable them by setting this boolean 955sequences enabled by default, which doesn't make it safer, though).
904resource or specifying B<-insecure> as an option. At the moment, this 956
905enabled display-answer, locale, findfont, icon label and window title 957You can enable them by setting this boolean resource or specifying
906requests as well as dynamic menubar dispatch. 958B<-insecure> as an option. At the moment, this enables display-answer,
959locale, findfont, icon label and window title requests as well as dynamic
960menubar dispatch.
907 961
908=item B<modifier:> I<modifier> 962=item B<modifier:> I<modifier>
909 963
910Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 964Set 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 965B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
925 979
926Turn on/off secondary screen scroll (default enabled). If the this 980Turn on/off secondary screen scroll (default enabled). If the this
927option is enabled, scrolls on the secondary screen will change the 981option is enabled, scrolls on the secondary screen will change the
928scrollback buffer and switching to/from the secondary screen will 982scrollback buffer and switching to/from the secondary screen will
929instead scroll the screen up. 983instead scroll the screen up.
984
985=item B<hold>: I<bool>
986
987Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
988will not immediately destroy its window when the program executed within
989it exits. Instead, it will wait till it is being killed or closed by the
990user.
930 991
931=item B<keysym.>I<sym>: I<string> 992=item B<keysym.>I<sym>: I<string>
932 993
933Compile I<frills>: Associate I<string> with keysym I<sym>. The 994Compile I<frills>: Associate I<string> with keysym I<sym>. The
934intervening resource name B<keysym.> cannot be omitted. 995intervening resource name B<keysym.> cannot be omitted.
979is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1040is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
980example the following means "change the current locale to C<zh_CN.GBK> 1041example the following means "change the current locale to C<zh_CN.GBK>
981when Control-Meta-c is being pressed": 1042when Control-Meta-c is being pressed":
982 1043
983 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1044 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1045
1046If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1047is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1048manpage. For example, the F<selection> extension (activated via
1049C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1050
1051 URxvt.keysym.M-C-c: perl:selection:rot13
984 1052
985Due the the large number of modifier combinations, a defined key mapping 1053Due 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 1054will 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 1055no other key mappings with those and more bits are being defined. That
988means that defining a key map for C<a> will automatically provide 1056means that defining a key map for C<a> will automatically provide
1012info): 1080info):
1013 1081
1014 URxvt.keysym.M-C-3: command:\033[8;25;80t 1082 URxvt.keysym.M-C-3: command:\033[8;25;80t
1015 URxvt.keysym.M-C-4: command:\033[8;48;110t 1083 URxvt.keysym.M-C-4: command:\033[8;48;110t
1016 1084
1085=item B<perl-ext-common>: I<string>
1086
1087=item B<perl-ext>: I<string>
1088
1089Comma-separated list(s) of perl extension scripts (default: C<default>) to
1090use in this terminal instance; option B<-pe>.
1091
1092Extension names can be prefixed with a C<-> sign to prohibit using
1093them. This can be useful to selectively disable some extensions loaded
1094by default, or specified via the C<perl-ext-common> resource. For
1095example, C<default,-selection> will use all the default extension except
1096C<selection>.
1097
1098Extension names can also be followed by an argument in angle brackets
1099(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1100searchable scorllback to Alt/Meta-s). Mentioning the same extension
1101multiple times with different arguments will pass multiple arguments to
1102the extension.
1103
1104Each extension is looked up in the library directories, loaded if
1105necessary, and bound to the current terminal instance.
1106
1107If both of these resources are the empty string, then the perl
1108interpreter will not be initialized. The idea behind two options is that
1109B<perl-ext-common> will be used for extensions that should be available to
1110all instances, while B<perl-ext> is used for specific instances.
1111
1112=item B<perl-eval>: I<string>
1113
1114Perl code to be evaluated when all extensions have been registered. See
1115the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1116will be ignored when running setuid/setgid.
1117
1118=item B<perl-lib>: I<path>
1119
1120Colon-separated list of additional directories that hold extension
1121scripts. When looking for extensions specified by the C<perl> resource,
1122@@RXVT_NAME@@ will first look in these directories and then in
1123F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1124will be ignored when running setuid/setgid.
1125
1126See the @@RXVT_NAME@@perl(3) manpage.
1127
1128=item B<urlLauncher>: I<string>
1129
1130Specifies the program to be started with a URL argument. Used by the
1131C<selection-popup> and C<mark-urls> perl extensions.
1132
1133=item B<transient-for>: I<windowid>
1134
1135Sets the WM_TRANSIENT_FOR property to the given window iw.
1136
1017=back 1137=back
1018 1138
1019=head1 THE SCROLLBAR 1139=head1 THE SCROLLBAR
1020 1140
1021Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1141Lines 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 1175to select a word; Left triple-click to select the entire logical line
1056(which can span multiple screen lines), unless modified by resource 1176(which can span multiple screen lines), unless modified by resource
1057B<tripleclickwords>. 1177B<tripleclickwords>.
1058 1178
1059Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1179Starting 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 1180(Compile: I<frills>) will create a rectangular selection instead of a
1061one. 1181normal one. In this mode, every selected row becomes its own line in the
1182selection, and trailing whitespace is visually underlined and removed from
1183the selection.
1062 1184
1063=item B<Insertion>: 1185=item B<Insertion>:
1064 1186
1065Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1187Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
1066an B<@@RXVT_NAME@@> window causes the current text selection to be 1188an B<@@RXVT_NAME@@> window causes the current text selection to be
1074supported in rxvt-unicode. Bug me if you need this. 1196supported in rxvt-unicode. Bug me if you need this.
1075 1197
1076You can, however, switch fonts at runtime using escape sequences (and 1198You can, however, switch fonts at runtime using escape sequences (and
1077therefore using the menubar), e.g.: 1199therefore using the menubar), e.g.:
1078 1200
1079 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1201 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1080 1202
1081rxvt-unicode will automatically re-apply these fonts to the output so far. 1203rxvt-unicode will automatically re-apply these fonts to the output so far.
1082 1204
1083=head1 ISO 14755 SUPPORT 1205=head1 ISO 14755 SUPPORT
1084 1206
1293 1415
1294=head1 SEE ALSO 1416=head1 SEE ALSO
1295 1417
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) 1418@@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 1419
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 1420=head1 CURRENT PROJECT COORDINATOR
1307 1421
1308=over 4 1422=over 4
1309 1423
1310=item Project Coordinator 1424=item Project Coordinator

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines