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.92 by root, Wed Jan 11 02:13:55 2006 UTC vs.
Revision 1.96 by root, Fri Jan 13 12:40:46 2006 UTC

172resource B<borderColor>. 172resource B<borderColor>.
173 173
174=item B<-fn> I<fontlist> 174=item B<-fn> I<fontlist>
175 175
176Select the fonts to be used. This is a comma separated list of font names 176Select the fonts to be used. This is a comma separated list of font names
177that are used in turn when trying to display Unicode characters. The 177that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 178first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 179smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 180font list is always appended to it. See resource B<font> for more details.
181 181
182In short, to specify an X11 core font, just specify it's name or prefix it 182In short, to specify an X11 core font, just specify it's name or prefix it
476=head1 RESOURCES (available also as long-options) 476=head1 RESOURCES (available also as long-options)
477 477
478Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 478Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
479options) compiled into your version. 479options) compiled into your version.
480 480
481There 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
482Xresource data: using the X libraries (Xrm*-functions) or internal 482distribution do also load settings from the B<~/.Xresources> file when X
483Xresources reader (B<~/.Xdefaults>). For the first method (ie. 483starts. @@RXVT_NAME@@ will consult the following files/resources in order,
484B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 484with later settings overwriting earlier ones:
485resources using X11 tools like B<xrdb>. Many distribution do also load
486settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
487will consult the following files/resources in order, with later settings
488overwriting earlier ones:
489 485
490 1. system-wide app-defaults file, either locale-dependent OR global 486 1. system-wide app-defaults file, either locale-dependent OR global
491 2. app-defaults file in $XAPPLRESDIR 487 2. app-defaults file in $XAPPLRESDIR
492 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 488 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
493 4. SCREEN_RESOURCES for the current screen 489 4. SCREEN_RESOURCES for the current screen
494 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 490 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
495 491
496If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
497lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
498set in XAPPLOADDIR/URxvt (compile-time defined: usually
499B</usr/lib/X11/app-defaults/URxvt>) and resources set in
500B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
501Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 492Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
502class 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
503resources 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
504easily configured, while the class name B<URxvt> allows resources 495configured, while the class name B<URxvt> allows resources unique to
505unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 496B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
506shared between different B<@@RXVT_NAME@@> configurations. If no 497configurations. If no resources are specified, suitable defaults will
507resources are specified, suitable defaults will be used. Command-line 498be used. Command-line arguments can be used to override resource
508arguments can be used to override resource settings. The following 499settings. The following resources are supported (you might want to
509resources are allowed: 500check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
501extensions not documented here):
510 502
511=over 4 503=over 4
512 504
513=item B<geometry:> I<geom> 505=item B<geometry:> I<geom>
514 506
649menus), in addition to the paths specified by the B<RXVTPATH> and 641menus), in addition to the paths specified by the B<RXVTPATH> and
650B<PATH> environment variables. 642B<PATH> environment variables.
651 643
652=item B<font:> I<fontlist> 644=item B<font:> I<fontlist>
653 645
654Select the fonts to be used. This is a comma separated list of font 646Select the fonts to be used. This is a comma separated list of font names
655names that are used in turn when trying to display Unicode characters. 647that are checked in order when trying to find glyphs for characters. The
656The first font defines the cell size for characters; other fonts might 648first font defines the cell size for characters; other fonts might be
657be smaller, but not larger. A reasonable default font list is always 649smaller, but not (in general) larger. A (hopefully) reasonable default
658appended to it; option B<-fn>. 650font list is always appended to it; option B<-fn>.
659 651
660Each font can either be a standard X11 core font (XLFD) name, with 652Each font can either be a standard X11 core font (XLFD) name, with
661optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 653optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
662 654
663In addition, each font can be prefixed with additional hints and 655In addition, each font can be prefixed with additional hints and
1015C<\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,
1016C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1008C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1017C<^@>: 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
1018can start or end with whitespace. 1010can start or end with whitespace.
1019 1011
1020Please note that you need to double the C<\> when using 1012Please note that you need to double the C<\> in resource files, as
1021C<--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
1022use 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
1023@@RXVT_NAME@@'s own processing). 1015processing).
1024 1016
1025You 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>
1026with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1018with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
1027should be a character not used by the strings. 1019should be a character not used by the strings.
1028 1020
1122@@RXVT_NAME@@ will first look in these directories and then in 1114@@RXVT_NAME@@ will first look in these directories and then in
1123F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1115F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1124will be ignored when running setuid/setgid. 1116will be ignored when running setuid/setgid.
1125 1117
1126See the @@RXVT_NAME@@perl(3) manpage. 1118See the @@RXVT_NAME@@perl(3) manpage.
1119
1120=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1121
1122Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1123details.
1124
1125=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1126
1127Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1128for details.
1129
1130=item B<searchable-scrollback:> I<keysym>
1131
1132Sets the hotkey that starts the incremental scrollback buffer search
1133(default: C<M-s>).
1127 1134
1128=item B<urlLauncher>: I<string> 1135=item B<urlLauncher>: I<string>
1129 1136
1130Specifies the program to be started with a URL argument. Used by the 1137Specifies the program to be started with a URL argument. Used by the
1131C<selection-popup> and C<mark-urls> perl extensions. 1138C<selection-popup> and C<mark-urls> perl extensions.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines