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.73 by root, Thu Dec 15 18:14:08 2005 UTC vs.
Revision 1.89 by root, Sun Jan 8 08:43:11 2006 UTC

189See 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
190section of @@RXVT_NAME@@(7). 190section of @@RXVT_NAME@@(7).
191 191
192=item B<-fb> I<fontlist> 192=item B<-fb> I<fontlist>
193 193
194Compile 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
195be printed. See resource B<boldFont> for details. 195are to be printed. See resource B<boldFont> for details.
196 196
197=item B<-fi> I<fontlist> 197=item B<-fi> I<fontlist>
198 198
199Compile 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>
200be printed. See resource B<italicFont> for details. 200characters are to be printed. See resource B<italicFont> for details.
201 201
202=item B<-fbi> I<fontlist> 202=item B<-fbi> I<fontlist>
203 203
204Compile 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
205be 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.
206 213
207=item B<-name> I<name> 214=item B<-name> I<name>
208 215
209Specify the application name under which resources are to be obtained, 216Specify the application name under which resources are to be obtained,
210rather than the default executable file name. Name should not contain 217rather than the default executable file name. Name should not contain
289=item B<-bl> 296=item B<-bl>
290 297
291Compile 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.
292if 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
293decorations; 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>.
294 308
295=item B<-lsp> I<number> 309=item B<-lsp> I<number>
296 310
297Compile I<frills>: Lines (pixel height) to insert between each row of 311Compile I<frills>: Lines (pixel height) to insert between each row of
298the display. Useful to work around font rendering problems; resource 312the display. Useful to work around font rendering problems; resource
313given 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
314on 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
315run the program specified by the B<SHELL> environment variable or, 329run the program specified by the B<SHELL> environment variable or,
316failing that, I<sh(1)>. 330failing that, I<sh(1)>.
317 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
318=item B<-title> I<text> 337=item B<-title> I<text>
319 338
320Window title (B<-T> still respected); the default title is the basename 339Window title (B<-T> still respected); the default title is the basename
321of 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
322application name; resource B<title>. 341application name; resource B<title>.
377 396
378=item B<-ssr>|B<+ssr> 397=item B<-ssr>|B<+ssr>
379 398
380Turn on/off secondary screen scroll (default enabled); resource 399Turn on/off secondary screen scroll (default enabled); resource
381B<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>.
382 408
383=item B<-keysym.>I<sym> I<string> 409=item B<-keysym.>I<sym> I<string>
384 410
385Remap a key symbol. See resource B<keysym>. 411Remap a key symbol. See resource B<keysym>.
386 412
409 $rxvt->signal_connect_after (realize => sub { 435 $rxvt->signal_connect_after (realize => sub {
410 my $xid = $_[0]->window->get_xid; 436 my $xid = $_[0]->window->get_xid;
411 system "@@RXVT_NAME@@ -embed $xid &"; 437 system "@@RXVT_NAME@@ -embed $xid &";
412 }); 438 });
413 439
414=item B<-pty-fd> I<fileno> 440=item B<-pty-fd> I<file descriptor>
415 441
416Tells @@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
417pair 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
418useful 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
419without having to run a program within it. 445without having to run a program within it.
420 446
421If 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
422entries 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
423yourself if you want that. 449yourself if you want that.
424 450
451As an extremely special case, specifying C<-1> will completely suppress
452pty/tty operations.
453
425Here 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
426longer example is in F<doc/pty-fd>): 455longer example is in F<doc/pty-fd>):
427 456
428 use IO::Pty; 457 use IO::Pty;
429 use Fcntl; 458 use Fcntl;
434 close $pty; 463 close $pty;
435 464
436 # now communicate with rxvt 465 # now communicate with rxvt
437 my $slave = $pty->slave; 466 my $slave = $pty->slave;
438 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.
439 473
440=back 474=back
441 475
442=head1 RESOURCES (available also as long-options) 476=head1 RESOURCES (available also as long-options)
443 477
619 653
620Select 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
621names that are used in turn when trying to display Unicode characters. 655names that are used in turn when trying to display Unicode characters.
622The first font defines the cell size for characters; other fonts might 656The first font defines the cell size for characters; other fonts might
623be smaller, but not larger. A reasonable default font list is always 657be smaller, but not larger. A reasonable default font list is always
624appended to it. option B<-fn>. 658appended to it; option B<-fn>.
625 659
626Each 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
627optional 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:>.
628 662
629In addition, each font can be prefixed with additional hints and 663In addition, each font can be prefixed with additional hints and
675not possible, replacement fonts of the desired shape will be tried. 709not possible, replacement fonts of the desired shape will be tried.
676 710
677If 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
678text font will being used for the given style. 712text font will being used for the given style.
679 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
680=item B<selectstyle:> I<mode> 722=item B<selectstyle:> I<mode>
681 723
682Set 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
683xterm 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
684xterm style selection. 726xterm style selection.
794=item B<borderLess:> I<boolean> 836=item B<borderLess:> I<boolean>
795 837
796Set 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
797WM, 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>.
798 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
799=item B<termName:> I<termname> 848=item B<termName:> I<termname>
800 849
801Specifies 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
802variable; option B<-tn>. 851variable; option B<-tn>.
803 852
876=item B<imLocale:> I<name> 925=item B<imLocale:> I<name>
877 926
878The 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.
879C<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
880input extension to be able to input japanese characters while staying in 929input extension to be able to input japanese characters while staying in
881another locale. option B<-imlocale>. 930another locale; option B<-imlocale>.
882 931
883=item B<imFont:> I<fontset> 932=item B<imFont:> I<fontset>
884 933
885Specify the font-set used for XIM styles C<OverTheSpot> or 934Specify the font-set used for XIM styles C<OverTheSpot> or
886C<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
891 940
892=item B<tripleclickwords:> I<boolean> 941=item B<tripleclickwords:> I<boolean>
893 942
894Change the meaning of triple-click selection with the left mouse 943Change the meaning of triple-click selection with the left mouse
895button. 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
896the end of the logical line only. option B<-tcw>. 945the end of the logical line only; option B<-tcw>.
897 946
898=item B<insecure:> I<boolean> 947=item B<insecure:> I<boolean>
899 948
900Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 949Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
901echo 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
931Turn on/off secondary screen scroll (default enabled). If the this 980Turn on/off secondary screen scroll (default enabled). If the this
932option is enabled, scrolls on the secondary screen will change the 981option is enabled, scrolls on the secondary screen will change the
933scrollback buffer and switching to/from the secondary screen will 982scrollback buffer and switching to/from the secondary screen will
934instead scroll the screen up. 983instead scroll the screen up.
935 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.
991
936=item B<keysym.>I<sym>: I<string> 992=item B<keysym.>I<sym>: I<string>
937 993
938Compile I<frills>: Associate I<string> with keysym I<sym>. The 994Compile I<frills>: Associate I<string> with keysym I<sym>. The
939intervening resource name B<keysym.> cannot be omitted. 995intervening resource name B<keysym.> cannot be omitted.
940 996
984is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1040is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
985example 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>
986when Control-Meta-c is being pressed": 1042when Control-Meta-c is being pressed":
987 1043
988 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
989 1052
990Due the the large number of modifier combinations, a defined key mapping 1053Due the the large number of modifier combinations, a defined key mapping
991will 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
992no 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
993means that defining a key map for C<a> will automatically provide 1056means that defining a key map for C<a> will automatically provide
1017info): 1080info):
1018 1081
1019 URxvt.keysym.M-C-3: command:\033[8;25;80t 1082 URxvt.keysym.M-C-3: command:\033[8;25;80t
1020 URxvt.keysym.M-C-4: command:\033[8;48;110t 1083 URxvt.keysym.M-C-4: command:\033[8;48;110t
1021 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
1093it. 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
1098Each extension is looked up in the library directories, loaded if
1099necessary, and bound to the current terminal instance.
1100
1101If both of these resources are the empty string, then the perl
1102interpreter will not be initialized. The idea behind two options is that
1103B<perl-ext-common> will be used for extensions that should be available to
1104all instances, while B<perl-ext> is used for specific instances.
1105
1106=item B<perl-eval>: I<string>
1107
1108Perl code to be evaluated when all extensions have been registered. See
1109the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1110will be ignored when running setuid/setgid.
1111
1112=item B<perl-lib>: I<path>
1113
1114Colon-separated list of additional directories that hold extension
1115scripts. When looking for extensions specified by the C<perl> resource,
1116@@RXVT_NAME@@ will first look in these directories and then in
1117F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1118will be ignored when running setuid/setgid.
1119
1120See the @@RXVT_NAME@@perl(3) manpage.
1121
1022=back 1122=back
1023 1123
1024=head1 THE SCROLLBAR 1124=head1 THE SCROLLBAR
1025 1125
1026Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1126Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
1060to select a word; Left triple-click to select the entire logical line 1160to select a word; Left triple-click to select the entire logical line
1061(which can span multiple screen lines), unless modified by resource 1161(which can span multiple screen lines), unless modified by resource
1062B<tripleclickwords>. 1162B<tripleclickwords>.
1063 1163
1064Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1164Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1065(Compile: I<frills>) will create a rectangular selection instead of a normal 1165(Compile: I<frills>) will create a rectangular selection instead of a
1066one. 1166normal one. In this mode, every selected row becomes its own line in the
1167selection, and trailing whitespace is visually underlined and removed from
1168the selection.
1067 1169
1068=item B<Insertion>: 1170=item B<Insertion>:
1069 1171
1070Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1172Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
1071an B<@@RXVT_NAME@@> window causes the current text selection to be 1173an B<@@RXVT_NAME@@> window causes the current text selection to be

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines