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.75 by root, Tue Dec 27 01:50:00 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
421 $rxvt->signal_connect_after (realize => sub { 435 $rxvt->signal_connect_after (realize => sub {
422 my $xid = $_[0]->window->get_xid; 436 my $xid = $_[0]->window->get_xid;
423 system "@@RXVT_NAME@@ -embed $xid &"; 437 system "@@RXVT_NAME@@ -embed $xid &";
424 }); 438 });
425 439
426=item B<-pty-fd> I<fileno> 440=item B<-pty-fd> I<file descriptor>
427 441
428Tells @@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
429pair 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
430useful 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
431without having to run a program within it. 445without having to run a program within it.
432 446
433If 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
434entries 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
435yourself if you want that. 449yourself if you want that.
436 450
451As an extremely special case, specifying C<-1> will completely suppress
452pty/tty operations.
453
437Here 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
438longer example is in F<doc/pty-fd>): 455longer example is in F<doc/pty-fd>):
439 456
440 use IO::Pty; 457 use IO::Pty;
441 use Fcntl; 458 use Fcntl;
446 close $pty; 463 close $pty;
447 464
448 # now communicate with rxvt 465 # now communicate with rxvt
449 my $slave = $pty->slave; 466 my $slave = $pty->slave;
450 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.
451 473
452=back 474=back
453 475
454=head1 RESOURCES (available also as long-options) 476=head1 RESOURCES (available also as long-options)
455 477
631 653
632Select 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
633names that are used in turn when trying to display Unicode characters. 655names that are used in turn when trying to display Unicode characters.
634The first font defines the cell size for characters; other fonts might 656The first font defines the cell size for characters; other fonts might
635be smaller, but not larger. A reasonable default font list is always 657be smaller, but not larger. A reasonable default font list is always
636appended to it. option B<-fn>. 658appended to it; option B<-fn>.
637 659
638Each 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
639optional 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:>.
640 662
641In addition, each font can be prefixed with additional hints and 663In addition, each font can be prefixed with additional hints and
687not possible, replacement fonts of the desired shape will be tried. 709not possible, replacement fonts of the desired shape will be tried.
688 710
689If 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
690text font will being used for the given style. 712text font will being used for the given style.
691 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
692=item B<selectstyle:> I<mode> 722=item B<selectstyle:> I<mode>
693 723
694Set 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
695xterm 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
696xterm style selection. 726xterm style selection.
806=item B<borderLess:> I<boolean> 836=item B<borderLess:> I<boolean>
807 837
808Set 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
809WM, 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>.
810 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
811=item B<termName:> I<termname> 848=item B<termName:> I<termname>
812 849
813Specifies 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
814variable; option B<-tn>. 851variable; option B<-tn>.
815 852
888=item B<imLocale:> I<name> 925=item B<imLocale:> I<name>
889 926
890The 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.
891C<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
892input extension to be able to input japanese characters while staying in 929input extension to be able to input japanese characters while staying in
893another locale. option B<-imlocale>. 930another locale; option B<-imlocale>.
894 931
895=item B<imFont:> I<fontset> 932=item B<imFont:> I<fontset>
896 933
897Specify the font-set used for XIM styles C<OverTheSpot> or 934Specify the font-set used for XIM styles C<OverTheSpot> or
898C<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
903 940
904=item B<tripleclickwords:> I<boolean> 941=item B<tripleclickwords:> I<boolean>
905 942
906Change the meaning of triple-click selection with the left mouse 943Change the meaning of triple-click selection with the left mouse
907button. 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
908the end of the logical line only. option B<-tcw>. 945the end of the logical line only; option B<-tcw>.
909 946
910=item B<insecure:> I<boolean> 947=item B<insecure:> I<boolean>
911 948
912Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 949Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
913echo 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
1004example 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>
1005when Control-Meta-c is being pressed": 1042when Control-Meta-c is being pressed":
1006 1043
1007 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
1008 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
1052
1009Due the the large number of modifier combinations, a defined key mapping 1053Due the the large number of modifier combinations, a defined key mapping
1010will 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
1011no 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
1012means that defining a key map for C<a> will automatically provide 1056means that defining a key map for C<a> will automatically provide
1013definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined 1057definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1035Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1079Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1036info): 1080info):
1037 1081
1038 URxvt.keysym.M-C-3: command:\033[8;25;80t 1082 URxvt.keysym.M-C-3: command:\033[8;25;80t
1039 URxvt.keysym.M-C-4: command:\033[8;48;110t 1083 URxvt.keysym.M-C-4: command:\033[8;48;110t
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.
1040 1121
1041=back 1122=back
1042 1123
1043=head1 THE SCROLLBAR 1124=head1 THE SCROLLBAR
1044 1125

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines