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.83 by root, Tue Jan 3 22:28:07 2006 UTC vs.
Revision 1.93 by root, Wed Jan 11 23:08:54 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 B<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 I<italic> 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 B<< I<bold 204Compile I<font-styles>: The bold italic font list to use when B<< I<bold
205italic> >> characters are to be printed. See resource B<boldItalicFont> 205italic> >> characters are to be printed. See resource B<boldItalicFont>
206for details. 206for details.
207 207
208=item B<-is>|B<+is> 208=item B<-is>|B<+is>
209 209
210Compile font-styles: Bold/Italic font styles imply high intensity 210Compile I<font-styles>: Bold/Italic font styles imply high intensity
211foreground/background (default). See resource B<intensityStyles> for 211foreground/background (default). See resource B<intensityStyles> for
212details. 212details.
213 213
214=item B<-name> I<name> 214=item B<-name> I<name>
215 215
296=item B<-bl> 296=item B<-bl>
297 297
298Compile 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.
299if 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
300decorations; 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>.
301 308
302=item B<-lsp> I<number> 309=item B<-lsp> I<number>
303 310
304Compile I<frills>: Lines (pixel height) to insert between each row of 311Compile I<frills>: Lines (pixel height) to insert between each row of
305the display. Useful to work around font rendering problems; resource 312the display. Useful to work around font rendering problems; resource
428 $rxvt->signal_connect_after (realize => sub { 435 $rxvt->signal_connect_after (realize => sub {
429 my $xid = $_[0]->window->get_xid; 436 my $xid = $_[0]->window->get_xid;
430 system "@@RXVT_NAME@@ -embed $xid &"; 437 system "@@RXVT_NAME@@ -embed $xid &";
431 }); 438 });
432 439
433=item B<-pty-fd> I<fileno> 440=item B<-pty-fd> I<file descriptor>
434 441
435Tells @@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
436pair 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
437useful 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
438without having to run a program within it. 445without having to run a program within it.
439 446
440If 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
441entries 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
442yourself if you want that. 449yourself if you want that.
443 450
451As an extremely special case, specifying C<-1> will completely suppress
452pty/tty operations.
453
444Here 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
445longer example is in F<doc/pty-fd>): 455longer example is in F<doc/pty-fd>):
446 456
447 use IO::Pty; 457 use IO::Pty;
448 use Fcntl; 458 use Fcntl;
456 my $slave = $pty->slave; 466 my $slave = $pty->slave;
457 while (<$slave>) { print $slave "got <$_>\n" } 467 while (<$slave>) { print $slave "got <$_>\n" }
458 468
459=item B<-pe> I<string> 469=item B<-pe> I<string>
460 470
461Colon-separated list of perl extension scripts to use in this terminal instance. See resource B<perl-ext>. 471Comma-separated list of perl extension scripts to use (or not to use) in
472this terminal instance. See resource B<perl-ext> for details.
462 473
463=back 474=back
464 475
465=head1 RESOURCES (available also as long-options) 476=head1 RESOURCES (available also as long-options)
466 477
467Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 478Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
468options) compiled into your version. 479options) compiled into your version.
469 480
470There are two different methods that @@RXVT_NAME@@ can use to get the 481You can set and change the resources using X11 tools like B<xrdb>. Many
471Xresource data: using the X libraries (Xrm*-functions) or internal 482distribution do also load settings from the B<~/.Xresources> file when X
472Xresources reader (B<~/.Xdefaults>). For the first method (ie. 483starts. @@RXVT_NAME@@ will consult the following files/resources in order,
473B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 484with later settings overwriting earlier ones:
474resources using X11 tools like B<xrdb>. Many distribution do also load
475settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
476will consult the following files/resources in order, with later settings
477overwriting earlier ones:
478 485
479 1. system-wide app-defaults file, either locale-dependent OR global 486 1. system-wide app-defaults file, either locale-dependent OR global
480 2. app-defaults file in $XAPPLRESDIR 487 2. app-defaults file in $XAPPLRESDIR
481 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 488 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
482 4. SCREEN_RESOURCES for the current screen 489 4. SCREEN_RESOURCES for the current screen
483 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 490 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
484 491
485If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
486lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
487set in XAPPLOADDIR/URxvt (compile-time defined: usually
488B</usr/lib/X11/app-defaults/URxvt>) and resources set in
489B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
490Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 492Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
491class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 493names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
492resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 494common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
493easily configured, while the class name B<URxvt> allows resources 495configured, while the class name B<URxvt> allows resources unique to
494unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 496B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
495shared between different B<@@RXVT_NAME@@> configurations. If no 497configurations. If no resources are specified, suitable defaults will
496resources are specified, suitable defaults will be used. Command-line 498be used. Command-line arguments can be used to override resource
497arguments can be used to override resource settings. The following 499settings. The following resources are supported (you might want to
498resources are allowed: 500check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
501extensions not documented here):
499 502
500=over 4 503=over 4
501 504
502=item B<geometry:> I<geom> 505=item B<geometry:> I<geom>
503 506
825=item B<borderLess:> I<boolean> 828=item B<borderLess:> I<boolean>
826 829
827Set MWM hints to request a borderless window, i.e. if honoured by the 830Set MWM hints to request a borderless window, i.e. if honoured by the
828WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 831WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
829 832
833=item B<skipBuiltinGlyphs:> I<boolean>
834
835Compile I<frills>: Disable the usage of the built-in block graphics/line
836drawing characters and just rely on what the specified fonts provide. Use
837this if you have a good font and want to use its block graphic glyphs;
838option B<-sbg>.
839
830=item B<termName:> I<termname> 840=item B<termName:> I<termname>
831 841
832Specifies the terminal type name to be set in the B<TERM> environment 842Specifies the terminal type name to be set in the B<TERM> environment
833variable; option B<-tn>. 843variable; option B<-tn>.
834 844
997C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1007C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
998C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1008C<\000>: octal number) or verbatim control characters (C<^?>: delete,
999C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1009C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1000can start or end with whitespace. 1010can start or end with whitespace.
1001 1011
1002Please note that you need to double the C<\> when using 1012Please note that you need to double the C<\> in resource files, as
1003C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can 1013Xlib itself does it's own de-escaping (you can use C<\033> instead of
1004use C<\033> instead of C<\e> (and so on), which will work with both Xt and 1014C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1005@@RXVT_NAME@@'s own processing). 1015processing).
1006 1016
1007You can define a range of keysyms in one shot by providing a I<string> 1017You can define a range of keysyms in one shot by providing a I<string>
1008with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1018with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
1009should be a character not used by the strings. 1019should be a character not used by the strings.
1010 1020
1062info): 1072info):
1063 1073
1064 URxvt.keysym.M-C-3: command:\033[8;25;80t 1074 URxvt.keysym.M-C-3: command:\033[8;25;80t
1065 URxvt.keysym.M-C-4: command:\033[8;48;110t 1075 URxvt.keysym.M-C-4: command:\033[8;48;110t
1066 1076
1077=item B<perl-ext-common>: I<string>
1078
1067=item B<perl-ext>: I<string> 1079=item B<perl-ext>: I<string>
1068 1080
1069Colon-separated list of perl extension scripts to use in this terminal 1081Comma-separated list(s) of perl extension scripts (default: C<default>) to
1082use in this terminal instance; option B<-pe>.
1083
1084Extension names can be prefixed with a C<-> sign to prohibit using
1085them. This can be useful to selectively disable some extensions loaded
1086by default, or specified via the C<perl-ext-common> resource. For
1087example, C<default,-selection> will use all the default extension except
1088C<selection>.
1089
1090Extension names can also be followed by an argument in angle brackets
1091(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1092searchable scorllback to Alt/Meta-s). Mentioning the same extension
1093multiple times with different arguments will pass multiple arguments to
1094the extension.
1095
1070instance. Each extension is looked up in the library directories, loaded 1096Each extension is looked up in the library directories, loaded if
1071if necessary, and bound to the current terminal instance. If this resource 1097necessary, and bound to the current terminal instance.
1072is empty or missing, then the perl interpreter will not be initialized; 1098
1073option B<-pe>. 1099If both of these resources are the empty string, then the perl
1100interpreter will not be initialized. The idea behind two options is that
1101B<perl-ext-common> will be used for extensions that should be available to
1102all instances, while B<perl-ext> is used for specific instances.
1074 1103
1075=item B<perl-eval>: I<string> 1104=item B<perl-eval>: I<string>
1076 1105
1077Perl code to be evaluated when all extensions have been registered. See the 1106Perl code to be evaluated when all extensions have been registered. See
1078@@RXVT_NAME@@perl(3) manpage. 1107the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1108will be ignored when running setuid/setgid.
1079 1109
1080=item B<perl-lib>: I<path> 1110=item B<perl-lib>: I<path>
1081 1111
1082Colon-separated list of additional directories that hold extension 1112Colon-separated list of additional directories that hold extension
1083scripts. When looking for extensions specified by the C<perl> resource, 1113scripts. When looking for extensions specified by the C<perl> resource,
1084@@RXVT_NAME@@ will first look in these directories and then in 1114@@RXVT_NAME@@ will first look in these directories and then in
1085F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1115F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1116will be ignored when running setuid/setgid.
1086 1117
1087See the @@RXVT_NAME@@perl(3) manpage. 1118See the @@RXVT_NAME@@perl(3) manpage.
1119
1120=item B<urlLauncher>: I<string>
1121
1122Specifies the program to be started with a URL argument. Used by the
1123C<selection-popup> and C<mark-urls> perl extensions.
1124
1125=item B<transient-for>: I<windowid>
1126
1127Sets the WM_TRANSIENT_FOR property to the given window iw.
1088 1128
1089=back 1129=back
1090 1130
1091=head1 THE SCROLLBAR 1131=head1 THE SCROLLBAR
1092 1132

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines