475
478
Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
476
479
options) compiled into your version.
478
There are two different methods that @@RXVT_NAME@@ can use to get the
479
Xresource data: using the X libraries (Xrm*-functions) or internal
480
Xresources reader (B<~/.Xdefaults>). For the first method (ie.
481
B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
482
resources using X11 tools like B<xrdb>. Many distribution do also load
483
settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
484
will consult the following files/resources in order, with later settings
485
overwriting earlier ones:
481
You can set and change the resources using X11 tools like B<xrdb>. Many
482
distribution do also load settings from the B<~/.Xresources> file when X
483
starts. @@RXVT_NAME@@ will consult the following files/resources in order,
484
with later settings overwriting earlier ones:
487
486
1. system-wide app-defaults file, either locale-dependent OR global
488
487
2. app-defaults file in $XAPPLRESDIR
490
489
4. SCREEN_RESOURCES for the current screen
491
490
5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
493
If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
494
lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
495
set in XAPPLOADDIR/URxvt (compile-time defined: usually
496
B</usr/lib/X11/app-defaults/URxvt>) and resources set in
497
B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
498
Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two
499
class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows
500
resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be
501
easily configured, while the class name B<URxvt> allows resources
502
unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be
503
shared between different B<@@RXVT_NAME@@> configurations. If no
504
resources are specified, suitable defaults will be used. Command-line
505
arguments can be used to override resource settings. The following
506
resources are allowed:
492
Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
493
names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
494
common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
495
configured, while the class name B<URxvt> allows resources unique to
496
B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
497
configurations. If no resources are specified, suitable defaults will
498
be used. Command-line arguments can be used to override resource
499
settings. The following resources are supported (you might want to
500
check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
501
extensions not documented here):
649
644
=item B<font:> I<fontlist>
651
Select the fonts to be used. This is a comma separated list of font
652
names that are used in turn when trying to display Unicode characters.
653
The first font defines the cell size for characters; other fonts might
654
be smaller, but not larger. A reasonable default font list is always
655
appended to it; option B<-fn>.
646
Select the fonts to be used. This is a comma separated list of font names
647
that are checked in order when trying to find glyphs for characters. The
648
first font defines the cell size for characters; other fonts might be
649
smaller, but not (in general) larger. A (hopefully) reasonable default
650
font list is always appended to it; option B<-fn>.
657
652
Each font can either be a standard X11 core font (XLFD) name, with
658
653
optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
1014
1009
C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1015
1010
can start or end with whitespace.
1017
Please note that you need to double the C<\> when using
1018
C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
1019
use C<\033> instead of C<\e> (and so on), which will work with both Xt and
1020
@@RXVT_NAME@@'s own processing).
1012
Please note that you need to double the C<\> in resource files, as
1013
Xlib itself does it's own de-escaping (you can use C<\033> instead of
1014
C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1022
1017
You can define a range of keysyms in one shot by providing a I<string>
1023
1018
with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
1084
1079
=item B<perl-ext>: I<string>
1086
Colon-separated list(s) of perl extension scripts to use in this terminal
1087
instance. Each extension is looked up in the library directories, loaded
1088
if necessary, and bound to the current terminal instance. If this
1089
resource is empty or missing, then the perl interpreter will not be
1090
initialized. The idea behind two options is that B<perl-ext-common> will
1091
be used for extensions that should be available to all instances, while
1092
B<perl-ext> is used for specific instances; option B<-pe>.
1081
Comma-separated list(s) of perl extension scripts (default: C<default>) to
1082
use in this terminal instance; option B<-pe>.
1084
Extension names can be prefixed with a C<-> sign to prohibit using
1085
them. This can be useful to selectively disable some extensions loaded
1086
by default, or specified via the C<perl-ext-common> resource. For
1087
example, C<default,-selection> will use all the default extension except
1090
Extension names can also be followed by an argument in angle brackets
1091
(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1092
searchable scorllback to Alt/Meta-s). Mentioning the same extension
1093
multiple times with different arguments will pass multiple arguments to
1096
Each extension is looked up in the library directories, loaded if
1097
necessary, and bound to the current terminal instance.
1099
If both of these resources are the empty string, then the perl
1100
interpreter will not be initialized. The idea behind two options is that
1101
B<perl-ext-common> will be used for extensions that should be available to
1102
all instances, while B<perl-ext> is used for specific instances.
1094
1104
=item B<perl-eval>: I<string>
1096
Perl code to be evaluated when all extensions have been registered. See the
1097
@@RXVT_NAME@@perl(3) manpage.
1106
Perl code to be evaluated when all extensions have been registered. See
1107
the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1108
will be ignored when running setuid/setgid.
1099
1110
=item B<perl-lib>: I<path>
1101
1112
Colon-separated list of additional directories that hold extension
1102
1113
scripts. When looking for extensions specified by the C<perl> resource,
1103
1114
@@RXVT_NAME@@ will first look in these directories and then in
1104
F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1115
F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1116
will be ignored when running setuid/setgid.
1106
1118
See the @@RXVT_NAME@@perl(3) manpage.
1120
=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1122
Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1125
=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1127
Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1130
=item B<searchable-scrollback:> I<keysym>
1132
Sets the hotkey that starts the incremental scrollback buffer search
1135
=item B<urlLauncher>: I<string>
1137
Specifies the program to be started with a URL argument. Used by the
1138
C<selection-popup> and C<mark-urls> perl extensions.
1140
=item B<transient-for>: I<windowid>
1142
Sets the WM_TRANSIENT_FOR property to the given window iw.
1110
1146
=head1 THE SCROLLBAR
added
removed
doc/rxvt.1.pod
