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.78 by root, Mon Jan 2 20:35:39 2006 UTC vs.
Revision 1.97 by root, Mon Jan 16 15:07:27 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
… …
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 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 bold 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 bold characters are to 204Compile I<font-styles>: The bold italic font list to use when B<< I<bold
205be printed. See resource B<boldItalicFont> for details. 205italic> >> characters are to be printed. See resource B<boldItalicFont>
206for details.
206 207
207=item B<-is>|B<+is> 208=item B<-is>|B<+is>
208 209
209Compile font-styles: Bold/Italic font styles imply high intensity 210Compile I<font-styles>: Bold/Italic font styles imply high intensity
210foreground/background (default). See resource B<intensityStyles> for 211foreground/background (default). See resource B<intensityStyles> for
211details. 212details.
212 213
213=item B<-name> I<name> 214=item B<-name> I<name>
214 215
… …
295=item B<-bl> 296=item B<-bl>
296 297
297Compile 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.
298if 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
299decorations; 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>.
300 308
301=item B<-lsp> I<number> 309=item B<-lsp> I<number>
302 310
303Compile I<frills>: Lines (pixel height) to insert between each row of 311Compile I<frills>: Lines (pixel height) to insert between each row of
304the display. Useful to work around font rendering problems; resource 312the display. Useful to work around font rendering problems; resource
… …
427 $rxvt->signal_connect_after (realize => sub { 435 $rxvt->signal_connect_after (realize => sub {
428 my $xid = $_[0]->window->get_xid; 436 my $xid = $_[0]->window->get_xid;
429 system "@@RXVT_NAME@@ -embed $xid &"; 437 system "@@RXVT_NAME@@ -embed $xid &";
430 }); 438 });
431 439
432=item B<-pty-fd> I<fileno> 440=item B<-pty-fd> I<file descriptor>
433 441
434Tells @@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
435pair 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
436useful 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
437without having to run a program within it. 445without having to run a program within it.
438 446
439If 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
440entries 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
441yourself if you want that. 449yourself if you want that.
442 450
451As an extremely special case, specifying C<-1> will completely suppress
452pty/tty operations.
453
443Here 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
444longer example is in F<doc/pty-fd>): 455longer example is in F<doc/pty-fd>):
445 456
446 use IO::Pty; 457 use IO::Pty;
447 use Fcntl; 458 use Fcntl;
… …
455 my $slave = $pty->slave; 466 my $slave = $pty->slave;
456 while (<$slave>) { print $slave "got <$_>\n" } 467 while (<$slave>) { print $slave "got <$_>\n" }
457 468
458=item B<-pe> I<string> 469=item B<-pe> I<string>
459 470
460Colon-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.
461 473
462=back 474=back
463 475
464=head1 RESOURCES (available also as long-options) 476=head1 RESOURCES (available also as long-options)
465 477
466Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 478Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
467options) compiled into your version. 479options) compiled into your version.
468 480
469There 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
470Xresource data: using the X libraries (Xrm*-functions) or internal 482distribution do also load settings from the B<~/.Xresources> file when X
471Xresources reader (B<~/.Xdefaults>). For the first method (ie. 483starts. @@RXVT_NAME@@ will consult the following files/resources in order,
472B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 484with later settings overwriting earlier ones:
473resources using X11 tools like B<xrdb>. Many distribution do also load
474settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
475will consult the following files/resources in order, with later settings
476overwriting earlier ones:
477 485
478 1. system-wide app-defaults file, either locale-dependent OR global 486 1. system-wide app-defaults file, either locale-dependent OR global
479 2. app-defaults file in $XAPPLRESDIR 487 2. app-defaults file in $XAPPLRESDIR
480 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 488 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
481 4. SCREEN_RESOURCES for the current screen 489 4. SCREEN_RESOURCES for the current screen
482 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 490 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
483 491
484If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
485lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
486set in XAPPLOADDIR/URxvt (compile-time defined: usually
487B</usr/lib/X11/app-defaults/URxvt>) and resources set in
488B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
489Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 492Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
490class 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
491resources 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
492easily configured, while the class name B<URxvt> allows resources 495configured, while the class name B<URxvt> allows resources unique to
493unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 496B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
494shared between different B<@@RXVT_NAME@@> configurations. If no 497configurations. If no resources are specified, suitable defaults will
495resources are specified, suitable defaults will be used. Command-line 498be used. Command-line arguments can be used to override resource
496arguments can be used to override resource settings. The following 499settings. The following resources are supported (you might want to
497resources are allowed: 500check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
501extensions not documented here):
498 502
499=over 4 503=over 4
500 504
501=item B<geometry:> I<geom> 505=item B<geometry:> I<geom>
502 506
… …
623of 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
624specifies an integer number of images in that direction. No image will 628specifies an integer number of images in that direction. No image will
625be magnified beyond 10 times its original size. The maximum permitted 629be magnified beyond 10 times its original size. The maximum permitted
626scale is 1000. [default 0x0+50+50] 630scale is 1000. [default 0x0+50+50]
627 631
628=item B<menu:> I<file[;tag]>
629
630Read in the specified menu file (note the `.menu' extension is
631optional) and also optionally specify a starting tag to find. See the
632reference documentation for details on the syntax for the menuBar.
633
634=item B<path:> I<path> 632=item B<path:> I<path>
635 633
636Specify the colon-delimited search path for finding files (XPM and 634Specify the colon-delimited search path for finding XPM files.
637menus), in addition to the paths specified by the B<RXVTPATH> and
638B<PATH> environment variables.
639 635
640=item B<font:> I<fontlist> 636=item B<font:> I<fontlist>
641 637
642Select 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
643names that are used in turn when trying to display Unicode characters. 639that are checked in order when trying to find glyphs for characters. The
644The first font defines the cell size for characters; other fonts might 640first font defines the cell size for characters; other fonts might be
645be smaller, but not larger. A reasonable default font list is always 641smaller, but not (in general) larger. A (hopefully) reasonable default
646appended to it; option B<-fn>. 642font list is always appended to it; option B<-fn>.
647 643
648Each 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
649optional 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:>.
650 646
651In addition, each font can be prefixed with additional hints and 647In addition, each font can be prefixed with additional hints and
… …
653hint 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
654fonts. 650fonts.
655 651
656For example, this font resource 652For example, this font resource
657 653
658 URxvt*font: 9x15bold,\ 654 URxvt.font: 9x15bold,\
659 -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,\
660 -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, \
661 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 657 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
662 xft:Code2000:antialias=false 658 xft:Code2000:antialias=false
663 659
… …
760 756
761The 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.
762 758
763Example: 759Example:
764 760
765 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 761 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
766 762
767This 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
768everytime you hit C<Print>. 764everytime you hit C<Print>.
769 765
770=item B<scrollBar:> I<boolean> 766=item B<scrollBar:> I<boolean>
… …
823 819
824=item B<borderLess:> I<boolean> 820=item B<borderLess:> I<boolean>
825 821
826Set MWM hints to request a borderless window, i.e. if honoured by the 822Set MWM hints to request a borderless window, i.e. if honoured by the
827WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 823WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
824
825=item B<skipBuiltinGlyphs:> I<boolean>
826
827Compile I<frills>: Disable the usage of the built-in block graphics/line
828drawing characters and just rely on what the specified fonts provide. Use
829this if you have a good font and want to use its block graphic glyphs;
830option B<-sbg>.
828 831
829=item B<termName:> I<termname> 832=item B<termName:> I<termname>
830 833
831Specifies the terminal type name to be set in the B<TERM> environment 834Specifies the terminal type name to be set in the B<TERM> environment
832variable; option B<-tn>. 835variable; option B<-tn>.
… …
935default. (Note that many other terminals, including xterm, have these 938default. (Note that many other terminals, including xterm, have these
936sequences enabled by default, which doesn't make it safer, though). 939sequences enabled by default, which doesn't make it safer, though).
937 940
938You can enable them by setting this boolean resource or specifying 941You can enable them by setting this boolean resource or specifying
939B<-insecure> as an option. At the moment, this enables display-answer, 942B<-insecure> as an option. At the moment, this enables display-answer,
940locale, findfont, icon label and window title requests as well as dynamic 943locale, findfont, icon label and window title requests.
941menubar dispatch.
942 944
943=item B<modifier:> I<modifier> 945=item B<modifier:> I<modifier>
944 946
945Set 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>,
946B<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
… …
996C<\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,
997C<\000>: octal number) or verbatim control characters (C<^?>: delete, 999C<\000>: octal number) or verbatim control characters (C<^?>: delete,
998C<^@>: 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
999can start or end with whitespace. 1001can start or end with whitespace.
1000 1002
1001Please note that you need to double the C<\> when using 1003Please note that you need to double the C<\> in resource files, as
1002C<--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
1003use 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
1004@@RXVT_NAME@@'s own processing). 1006processing).
1005 1007
1006You 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>
1007with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1009with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
1008should be a character not used by the strings. 1010should be a character not used by the strings.
1009 1011
… …
1021is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1023is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1022example the following means "change the current locale to C<zh_CN.GBK> 1024example the following means "change the current locale to C<zh_CN.GBK>
1023when Control-Meta-c is being pressed": 1025when Control-Meta-c is being pressed":
1024 1026
1025 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1027 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1028
1029If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1030is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1031manpage. For example, the F<selection> extension (activated via
1032C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1033
1034 URxvt.keysym.M-C-c: perl:selection:rot13
1026 1035
1027Due the the large number of modifier combinations, a defined key mapping 1036Due the the large number of modifier combinations, a defined key mapping
1028will match if at I<at least> the specified identifiers are being set, and 1037will match if at I<at least> the specified identifiers are being set, and
1029no other key mappings with those and more bits are being defined. That 1038no other key mappings with those and more bits are being defined. That
1030means that defining a key map for C<a> will automatically provide 1039means that defining a key map for C<a> will automatically provide
… …
1054info): 1063info):
1055 1064
1056 URxvt.keysym.M-C-3: command:\033[8;25;80t 1065 URxvt.keysym.M-C-3: command:\033[8;25;80t
1057 URxvt.keysym.M-C-4: command:\033[8;48;110t 1066 URxvt.keysym.M-C-4: command:\033[8;48;110t
1058 1067
1068=item B<perl-ext-common>: I<string>
1069
1059=item B<perl-ext>: I<string> 1070=item B<perl-ext>: I<string>
1060 1071
1061Colon-separated list of perl extension scripts to use in this terminal 1072Comma-separated list(s) of perl extension scripts (default: C<default>) to
1073use in this terminal instance; option B<-pe>.
1074
1075Extension names can be prefixed with a C<-> sign to prohibit using
1076them. This can be useful to selectively disable some extensions loaded
1077by default, or specified via the C<perl-ext-common> resource. For
1078example, C<default,-selection> will use all the default extension except
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.
1086
1062instance. Each extension is looked up in the library directories, loaded 1087Each extension is looked up in the library directories, loaded if
1063if necessary, and bound to the current terminal instance; option B<-pe>. 1088necessary, and bound to the current terminal instance.
1089
1090If both of these resources are the empty string, then the perl
1091interpreter will not be initialized. The idea behind two options is that
1092B<perl-ext-common> will be used for extensions that should be available to
1093all instances, while B<perl-ext> is used for specific instances.
1064 1094
1065=item B<perl-eval>: I<string> 1095=item B<perl-eval>: I<string>
1066 1096
1067Perl code to be evaluated when all extensions have been registered. See the 1097Perl code to be evaluated when all extensions have been registered. See
1068rxvtperl(3) manpage. 1098the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1099will be ignored when running setuid/setgid.
1069 1100
1070=item B<perl-lib>: I<path> 1101=item B<perl-lib>: I<path>
1071 1102
1072Colon-separated list of additional directories that hold extension 1103Colon-separated list of additional directories that hold extension
1073scripts. When looking for extensions specified by the C<perl> resource, 1104scripts. When looking for extensions specified by the C<perl> resource,
1074@@RXVT_NAME@@ will first look in these directories and then in 1105@@RXVT_NAME@@ will first look in these directories and then in
1075F<@@RXVT_LIBDIR@@/urxvt/perl-ext/>. 1106F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1107will be ignored when running setuid/setgid.
1076 1108
1077See the rxvtperl(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.
1130
1131=item B<transient-for>: I<windowid>
1132
1133Sets the WM_TRANSIENT_FOR property to the given window iw.
1078 1134
1079=back 1135=back
1080 1136
1081=head1 THE SCROLLBAR 1137=head1 THE SCROLLBAR
1082 1138
… …
1135=head1 CHANGING FONTS 1191=head1 CHANGING FONTS
1136 1192
1137Changing fonts (or font sizes, respectively) via the keypad is not yet 1193Changing fonts (or font sizes, respectively) via the keypad is not yet
1138supported in rxvt-unicode. Bug me if you need this. 1194supported in rxvt-unicode. Bug me if you need this.
1139 1195
1140You can, however, switch fonts at runtime using escape sequences (and 1196You can, however, switch fonts at runtime using escape sequences, e.g.:
1141therefore using the menubar), e.g.:
1142 1197
1143 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
1144 1204
1145rxvt-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.
1146 1206
1147=head1 ISO 14755 SUPPORT 1207=head1 ISO 14755 SUPPORT
1148 1208

Diff Legend

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