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.85 by root, Wed Jan 4 20:43:37 2006 UTC vs.
Revision 1.94 by root, Thu Jan 12 05:37:34 2006 UTC

435 $rxvt->signal_connect_after (realize => sub { 435 $rxvt->signal_connect_after (realize => sub {
436 my $xid = $_[0]->window->get_xid; 436 my $xid = $_[0]->window->get_xid;
437 system "@@RXVT_NAME@@ -embed $xid &"; 437 system "@@RXVT_NAME@@ -embed $xid &";
438 }); 438 });
439 439
440=item B<-pty-fd> I<fileno> 440=item B<-pty-fd> I<file descriptor>
441 441
442Tells @@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
443pair 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
444useful 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
445without having to run a program within it. 445without having to run a program within it.
446 446
447If 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
448entries 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
449yourself if you want that. 449yourself if you want that.
450 450
451As an extremely special case, specifying C<-1> will completely suppress
452pty/tty operations.
453
451Here 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
452longer example is in F<doc/pty-fd>): 455longer example is in F<doc/pty-fd>):
453 456
454 use IO::Pty; 457 use IO::Pty;
455 use Fcntl; 458 use Fcntl;
463 my $slave = $pty->slave; 466 my $slave = $pty->slave;
464 while (<$slave>) { print $slave "got <$_>\n" } 467 while (<$slave>) { print $slave "got <$_>\n" }
465 468
466=item B<-pe> I<string> 469=item B<-pe> I<string>
467 470
468Colon-separated list of perl extension scripts to use in this terminal 471Comma-separated list of perl extension scripts to use (or not to use) in
469instance. See resource B<perl-ext>. 472this terminal instance. See resource B<perl-ext> for details.
470 473
471=back 474=back
472 475
473=head1 RESOURCES (available also as long-options) 476=head1 RESOURCES (available also as long-options)
474 477
475Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 478Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
476options) compiled into your version. 479options) compiled into your version.
477 480
478There 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
479Xresource data: using the X libraries (Xrm*-functions) or internal 482distribution do also load settings from the B<~/.Xresources> file when X
480Xresources reader (B<~/.Xdefaults>). For the first method (ie. 483starts. @@RXVT_NAME@@ will consult the following files/resources in order,
481B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 484with later settings overwriting earlier ones:
482resources using X11 tools like B<xrdb>. Many distribution do also load
483settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
484will consult the following files/resources in order, with later settings
485overwriting earlier ones:
486 485
487 1. system-wide app-defaults file, either locale-dependent OR global 486 1. system-wide app-defaults file, either locale-dependent OR global
488 2. app-defaults file in $XAPPLRESDIR 487 2. app-defaults file in $XAPPLRESDIR
489 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 488 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
490 4. SCREEN_RESOURCES for the current screen 489 4. SCREEN_RESOURCES for the current screen
491 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 490 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
492 491
493If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
494lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
495set in XAPPLOADDIR/URxvt (compile-time defined: usually
496B</usr/lib/X11/app-defaults/URxvt>) and resources set in
497B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
498Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 492Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
499class 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
500resources 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
501easily configured, while the class name B<URxvt> allows resources 495configured, while the class name B<URxvt> allows resources unique to
502unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 496B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
503shared between different B<@@RXVT_NAME@@> configurations. If no 497configurations. If no resources are specified, suitable defaults will
504resources are specified, suitable defaults will be used. Command-line 498be used. Command-line arguments can be used to override resource
505arguments can be used to override resource settings. The following 499settings. The following resources are supported (you might want to
506resources are allowed: 500check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
501extensions not documented here):
507 502
508=over 4 503=over 4
509 504
510=item B<geometry:> I<geom> 505=item B<geometry:> I<geom>
511 506
1012C<\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,
1013C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1008C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1014C<^@>: 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
1015can start or end with whitespace. 1010can start or end with whitespace.
1016 1011
1017Please note that you need to double the C<\> when using 1012Please note that you need to double the C<\> in resource files, as
1018C<--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
1019use 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
1020@@RXVT_NAME@@'s own processing). 1015processing).
1021 1016
1022You 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>
1023with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1018with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
1024should be a character not used by the strings. 1019should be a character not used by the strings.
1025 1020
1081 1076
1082=item B<perl-ext-common>: I<string> 1077=item B<perl-ext-common>: I<string>
1083 1078
1084=item B<perl-ext>: I<string> 1079=item B<perl-ext>: I<string>
1085 1080
1086Colon-separated list(s) 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
1087instance. Each extension is looked up in the library directories, loaded 1096Each extension is looked up in the library directories, loaded if
1088if necessary, and bound to the current terminal instance. If this 1097necessary, and bound to the current terminal instance.
1089resource is empty or missing, then the perl interpreter will not be 1098
1090initialized. The idea behind two options is that B<perl-ext-common> will 1099If both of these resources are the empty string, then the perl
1091be used for extensions that should be available to all instances, while 1100interpreter will not be initialized. The idea behind two options is that
1092B<perl-ext> is used for specific instances; option B<-pe>. 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.
1093 1103
1094=item B<perl-eval>: I<string> 1104=item B<perl-eval>: I<string>
1095 1105
1096Perl code to be evaluated when all extensions have been registered. See the 1106Perl code to be evaluated when all extensions have been registered. See
1097@@RXVT_NAME@@perl(3) manpage. 1107the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1108will be ignored when running setuid/setgid.
1098 1109
1099=item B<perl-lib>: I<path> 1110=item B<perl-lib>: I<path>
1100 1111
1101Colon-separated list of additional directories that hold extension 1112Colon-separated list of additional directories that hold extension
1102scripts. When looking for extensions specified by the C<perl> resource, 1113scripts. When looking for extensions specified by the C<perl> resource,
1103@@RXVT_NAME@@ will first look in these directories and then in 1114@@RXVT_NAME@@ will first look in these directories and then in
1104F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1115F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1116will be ignored when running setuid/setgid.
1105 1117
1106See the @@RXVT_NAME@@perl(3) manpage. 1118See the @@RXVT_NAME@@perl(3) manpage.
1119
1120=item B<searchable-scrollback:> I<keysym>
1121
1122Sets the hotkey that starts the incremental scrollback buffer search
1123(default: C<M-s>).
1124
1125=item B<urlLauncher>: I<string>
1126
1127Specifies the program to be started with a URL argument. Used by the
1128C<selection-popup> and C<mark-urls> perl extensions.
1129
1130=item B<transient-for>: I<windowid>
1131
1132Sets the WM_TRANSIENT_FOR property to the given window iw.
1107 1133
1108=back 1134=back
1109 1135
1110=head1 THE SCROLLBAR 1136=head1 THE SCROLLBAR
1111 1137

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines