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.77 by root, Mon Jan 2 19:36:07 2006 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.
206 207
207=item B<-is>|B<+is> 208=item B<-is>|B<+is>
208 209
209Compile font-styles: Bold/Italic font styles imply high intensity 210Compile I<font-styles>: Bold/Italic font styles imply high intensity
210foreground/background (default). See resource B<intensityStyles> for 211foreground/background (default). See resource B<intensityStyles> for
211details. 212details.
212 213
213=item B<-name> I<name> 214=item B<-name> I<name>
214 215
295=item B<-bl> 296=item B<-bl>
296 297
297Compile 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.
298if 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
299decorations; 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>.
300 308
301=item B<-lsp> I<number> 309=item B<-lsp> I<number>
302 310
303Compile I<frills>: Lines (pixel height) to insert between each row of 311Compile I<frills>: Lines (pixel height) to insert between each row of
304the display. Useful to work around font rendering problems; resource 312the display. Useful to work around font rendering problems; resource
427 $rxvt->signal_connect_after (realize => sub { 435 $rxvt->signal_connect_after (realize => sub {
428 my $xid = $_[0]->window->get_xid; 436 my $xid = $_[0]->window->get_xid;
429 system "@@RXVT_NAME@@ -embed $xid &"; 437 system "@@RXVT_NAME@@ -embed $xid &";
430 }); 438 });
431 439
432=item B<-pty-fd> I<fileno> 440=item B<-pty-fd> I<file descriptor>
433 441
434Tells @@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
435pair 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
436useful 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
437without having to run a program within it. 445without having to run a program within it.
438 446
439If 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
440entries 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
441yourself if you want that. 449yourself if you want that.
442 450
451As an extremely special case, specifying C<-1> will completely suppress
452pty/tty operations.
453
443Here 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
444longer example is in F<doc/pty-fd>): 455longer example is in F<doc/pty-fd>):
445 456
446 use IO::Pty; 457 use IO::Pty;
447 use Fcntl; 458 use Fcntl;
453 464
454 # now communicate with rxvt 465 # now communicate with rxvt
455 my $slave = $pty->slave; 466 my $slave = $pty->slave;
456 while (<$slave>) { print $slave "got <$_>\n" } 467 while (<$slave>) { print $slave "got <$_>\n" }
457 468
458=item B<-perl> I<string> 469=item B<-pe> I<string>
459 470
460Used by perl extension. See resource B<perl>. 471Comma-separated list of perl extension scripts to use (or not to use) in
472this terminal instance. See resource B<perl-ext> for details.
461 473
462=back 474=back
463 475
464=head1 RESOURCES (available also as long-options) 476=head1 RESOURCES (available also as long-options)
465 477
824=item B<borderLess:> I<boolean> 836=item B<borderLess:> I<boolean>
825 837
826Set 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
827WM, 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>.
828 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
829=item B<termName:> I<termname> 848=item B<termName:> I<termname>
830 849
831Specifies 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
832variable; option B<-tn>. 851variable; option B<-tn>.
833 852
1022example 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>
1023when Control-Meta-c is being pressed": 1042when Control-Meta-c is being pressed":
1024 1043
1025 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
1026 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
1027Due the the large number of modifier combinations, a defined key mapping 1053Due the the large number of modifier combinations, a defined key mapping
1028will 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
1029no 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
1030means that defining a key map for C<a> will automatically provide 1056means that defining a key map for C<a> will automatically provide
1031definitions 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
1054info): 1080info):
1055 1081
1056 URxvt.keysym.M-C-3: command:\033[8;25;80t 1082 URxvt.keysym.M-C-3: command:\033[8;25;80t
1057 URxvt.keysym.M-C-4: command:\033[8;48;110t 1083 URxvt.keysym.M-C-4: command:\033[8;48;110t
1058 1084
1085=item B<perl-ext-common>: I<string>
1086
1059=item B<perl>: I<string> 1087=item B<perl-ext>: I<string>
1060 1088
1061Used by perl extension and is free for any use, as it is not interpreted 1089Comma-separated list(s) of perl extension scripts (default: C<default>) to
1062by rxvt-unicode itself; option B<perl>. 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.
1063 1105
1064=item B<perl-eval>: I<string> 1106=item B<perl-eval>: I<string>
1065 1107
1066Perl code to be evaluated when all extensions have been loaded. See the 1108Perl code to be evaluated when all extensions have been registered. See
1067rxvtperl(3) manpage. 1109the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1110will be ignored when running setuid/setgid.
1068 1111
1069=item B<perl-lib>: I<path> 1112=item B<perl-lib>: I<path>
1070 1113
1071Additional directory that holds extension scripts that are loaded and 1114Colon-separated list of additional directories that hold extension
1072enabled for this terminal instance, in addition to scripts stored in 1115scripts. When looking for extensions specified by the C<perl> resource,
1073F<@@RXVT_LIBDIR@@/urxvt/perl-ext/>, which are global to all terminal 1116@@RXVT_NAME@@ will first look in these directories and then in
1074instances. 1117F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1118will be ignored when running setuid/setgid.
1075 1119
1076See the rxvtperl(3) manpage. 1120See the @@RXVT_NAME@@perl(3) manpage.
1077 1121
1078=back 1122=back
1079 1123
1080=head1 THE SCROLLBAR 1124=head1 THE SCROLLBAR
1081 1125

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines