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.90 by root, Mon Jan 9 01:36:56 2006 UTC vs.
Revision 1.98 by root, Mon Jan 16 15:12:48 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
… …
635of 1 displays the image without any scaling. A scale of 2 to 9 627of 1 displays the image without any scaling. A scale of 2 to 9
636specifies an integer number of images in that direction. No image will 628specifies an integer number of images in that direction. No image will
637be magnified beyond 10 times its original size. The maximum permitted 629be magnified beyond 10 times its original size. The maximum permitted
638scale is 1000. [default 0x0+50+50] 630scale is 1000. [default 0x0+50+50]
639 631
640=item B<menu:> I<file[;tag]>
641
642Read in the specified menu file (note the `.menu' extension is
643optional) and also optionally specify a starting tag to find. See the
644reference documentation for details on the syntax for the menuBar.
645
646=item B<path:> I<path> 632=item B<path:> I<path>
647 633
648Specify the colon-delimited search path for finding files (XPM and 634Specify the colon-delimited search path for finding XPM files.
649menus), in addition to the paths specified by the B<RXVTPATH> and
650B<PATH> environment variables.
651 635
652=item B<font:> I<fontlist> 636=item B<font:> I<fontlist>
653 637
654Select the fonts to be used. This is a comma separated list of font 638Select 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. 639that are checked in order when trying to find glyphs for characters. The
656The first font defines the cell size for characters; other fonts might 640first font defines the cell size for characters; other fonts might be
657be smaller, but not larger. A reasonable default font list is always 641smaller, but not (in general) larger. A (hopefully) reasonable default
658appended to it; option B<-fn>. 642font list is always appended to it; option B<-fn>.
659 643
660Each font can either be a standard X11 core font (XLFD) name, with 644Each 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:>. 645optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
662 646
663In addition, each font can be prefixed with additional hints and 647In addition, each font can be prefixed with additional hints and
… …
665hint currently is C<codeset=codeset-name>, and this is only used for Xft 649hint currently is C<codeset=codeset-name>, and this is only used for Xft
666fonts. 650fonts.
667 651
668For example, this font resource 652For example, this font resource
669 653
670 URxvt*font: 9x15bold,\ 654 URxvt.font: 9x15bold,\
671 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 655 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
672 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 656 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
673 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 657 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
674 xft:Code2000:antialias=false 658 xft:Code2000:antialias=false
675 659
… …
772 756
773The string will be interpreted as if typed into the shell as-is. 757The string will be interpreted as if typed into the shell as-is.
774 758
775Example: 759Example:
776 760
777 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 761 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
778 762
779This creates a new file in your home directory with the screen contents 763This creates a new file in your home directory with the screen contents
780everytime you hit C<Print>. 764everytime you hit C<Print>.
781 765
782=item B<scrollBar:> I<boolean> 766=item B<scrollBar:> I<boolean>
… …
954default. (Note that many other terminals, including xterm, have these 938default. (Note that many other terminals, including xterm, have these
955sequences enabled by default, which doesn't make it safer, though). 939sequences enabled by default, which doesn't make it safer, though).
956 940
957You can enable them by setting this boolean resource or specifying 941You can enable them by setting this boolean resource or specifying
958B<-insecure> as an option. At the moment, this enables display-answer, 942B<-insecure> as an option. At the moment, this enables display-answer,
959locale, findfont, icon label and window title requests as well as dynamic 943locale, findfont, icon label and window title requests.
960menubar dispatch.
961 944
962=item B<modifier:> I<modifier> 945=item B<modifier:> I<modifier>
963 946
964Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 947Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
965B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 948B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
… …
1015C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 998C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
1016C<\000>: octal number) or verbatim control characters (C<^?>: delete, 999C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1017C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1000C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1018can start or end with whitespace. 1001can start or end with whitespace.
1019 1002
1020Please note that you need to double the C<\> when using 1003Please 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 1004Xlib 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 1005C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1023@@RXVT_NAME@@'s own processing). 1006processing).
1024 1007
1025You can define a range of keysyms in one shot by providing a I<string> 1008You can define a range of keysyms in one shot by providing a I<string>
1026with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1009with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
1027should be a character not used by the strings. 1010should be a character not used by the strings.
1028 1011
… …
1088 1071
1089Comma-separated list(s) of perl extension scripts (default: C<default>) to 1072Comma-separated list(s) of perl extension scripts (default: C<default>) to
1090use in this terminal instance; option B<-pe>. 1073use in this terminal instance; option B<-pe>.
1091 1074
1092Extension names can be prefixed with a C<-> sign to prohibit using 1075Extension names can be prefixed with a C<-> sign to prohibit using
1093it. This can be useful to selectively disable some extensions loaded 1076them. This can be useful to selectively disable some extensions loaded
1094by default, or specified via the C<perl-ext-common> resource. For 1077by default, or specified via the C<perl-ext-common> resource. For
1095example, C<default,-selection> will use all the default extension except 1078example, C<default,-selection> will use all the default extension except
1096C<selection>. 1079C<selection>.
1080
1081Extension names can also be followed by an argument in angle brackets
1082(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1083searchable scorllback to Alt/Meta-s). Mentioning the same extension
1084multiple times with different arguments will pass multiple arguments to
1085the extension.
1097 1086
1098Each extension is looked up in the library directories, loaded if 1087Each extension is looked up in the library directories, loaded if
1099necessary, and bound to the current terminal instance. 1088necessary, and bound to the current terminal instance.
1100 1089
1101If both of these resources are the empty string, then the perl 1090If both of these resources are the empty string, then the perl
… …
1116@@RXVT_NAME@@ will first look in these directories and then in 1105@@RXVT_NAME@@ will first look in these directories and then in
1117F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1106F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1118will be ignored when running setuid/setgid. 1107will be ignored when running setuid/setgid.
1119 1108
1120See the @@RXVT_NAME@@perl(3) manpage. 1109See the @@RXVT_NAME@@perl(3) manpage.
1110
1111=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1112
1113Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1114details.
1115
1116=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1117
1118Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1119for details.
1120
1121=item B<searchable-scrollback:> I<keysym>
1122
1123Sets the hotkey that starts the incremental scrollback buffer search
1124(default: C<M-s>).
1125
1126=item B<urlLauncher>: I<string>
1127
1128Specifies the program to be started with a URL argument. Used by the
1129C<selection-popup> and C<mark-urls> perl extensions.
1121 1130
1122=item B<transient-for>: I<windowid> 1131=item B<transient-for>: I<windowid>
1123 1132
1124Sets the WM_TRANSIENT_FOR property to the given window iw. 1133Sets the WM_TRANSIENT_FOR property to the given window iw.
1125 1134
… …
1182=head1 CHANGING FONTS 1191=head1 CHANGING FONTS
1183 1192
1184Changing fonts (or font sizes, respectively) via the keypad is not yet 1193Changing fonts (or font sizes, respectively) via the keypad is not yet
1185supported in rxvt-unicode. Bug me if you need this. 1194supported in rxvt-unicode. Bug me if you need this.
1186 1195
1187You can, however, switch fonts at runtime using escape sequences (and 1196You can, however, switch fonts at runtime using escape sequences, e.g.:
1188therefore using the menubar), e.g.:
1189 1197
1190 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1198 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1199
1200You can use keyboard shortcuts, too:
1201
1202 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1203 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1191 1204
1192rxvt-unicode will automatically re-apply these fonts to the output so far. 1205rxvt-unicode will automatically re-apply these fonts to the output so far.
1193 1206
1194=head1 ISO 14755 SUPPORT 1207=head1 ISO 14755 SUPPORT
1195 1208
… …
1357 1370
1358=item B<SHELL> 1371=item B<SHELL>
1359 1372
1360The shell to be used for command execution, defaults to C</bin/sh>. 1373The shell to be used for command execution, defaults to C</bin/sh>.
1361 1374
1362=item B<RXVTPATH>
1363
1364The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1365files.
1366
1367=item B<PATH>
1368
1369Used in the same way as C<RXVTPATH>.
1370
1371=item B<RXVT_SOCKET> 1375=item B<RXVT_SOCKET>
1372 1376
1373The unix domain socket path used by @@RXVT_NAME@@c(1) and 1377The unix domain socket path used by @@RXVT_NAME@@c(1) and
1374@@RXVT_NAME@@d(1). 1378@@RXVT_NAME@@d(1).
1375 1379

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines