ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.txt
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.31 by root, Mon Jan 2 20:35:39 2006 UTC vs.
Revision 1.46 by root, Mon Jan 16 15:07:27 2006 UTC

… …
4 4
5SYNOPSIS 5SYNOPSIS
6 rxvt [options] [-e command [ args ]] 6 rxvt [options] [-e command [ args ]]
7 7
8DESCRIPTION 8DESCRIPTION
9 rxvt-unicode, version 6.2, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 7.0, is a colour vt102 terminal emulator intended
10 as an *xterm*(1) replacement for users who do not require features such 10 as an *xterm*(1) replacement for users who do not require features such
11 as Tektronix 4014 emulation and toolkit-style configurability. As a 11 as Tektronix 4014 emulation and toolkit-style configurability. As a
12 result, rxvt-unicode uses much less swap space -- a significant 12 result, rxvt-unicode uses much less swap space -- a significant
13 advantage on a machine serving many X sessions. 13 advantage on a machine serving many X sessions.
14 14
… …
146 The colour of the border around the text area and between the 146 The colour of the border around the text area and between the
147 scrollbar and the text; resource borderColor. 147 scrollbar and the text; resource borderColor.
148 148
149 -fn *fontlist* 149 -fn *fontlist*
150 Select the fonts to be used. This is a comma separated list of font 150 Select the fonts to be used. This is a comma separated list of font
151 names that are used in turn when trying to display Unicode 151 names that are checked in order when trying to find glyphs for
152 characters. The first font defines the cell size for characters; 152 characters. The first font defines the cell size for characters;
153 other fonts might be smaller, but not (in general) larger. A 153 other fonts might be smaller, but not (in general) larger. A
154 (hopefully) reasonable default font list is always appended to it. 154 (hopefully) reasonable default font list is always appended to it.
155 See resource font for more details. 155 See resource font for more details.
156 156
… …
163 163
164 See also the question "How does rxvt-unicode choose fonts?" in the 164 See also the question "How does rxvt-unicode choose fonts?" in the
165 FAQ section of rxvt(7). 165 FAQ section of rxvt(7).
166 166
167 -fb *fontlist* 167 -fb *fontlist*
168 Compile font-styles: The bold font list to use when bold characters 168 Compile *font-styles*: The bold font list to use when bold
169 are to be printed. See resource boldFont for details. 169 characters are to be printed. See resource boldFont for details.
170 170
171 -fi *fontlist* 171 -fi *fontlist*
172 Compile font-styles: The italic font list to use when bold 172 Compile *font-styles*: The italic font list to use when *italic*
173 characters are to be printed. See resource italicFont for details. 173 characters are to be printed. See resource italicFont for details.
174 174
175 -fbi *fontlist* 175 -fbi *fontlist*
176 Compile font-styles: The bold italic font list to use when bold 176 Compile *font-styles*: The bold italic font list to use when *bold
177 characters are to be printed. See resource boldItalicFont for 177 italic* characters are to be printed. See resource boldItalicFont
178 details. 178 for details.
179 179
180 -is|+is 180 -is|+is
181 Compile font-styles: Bold/Italic font styles imply high intensity 181 Compile *font-styles*: Bold/Italic font styles imply high intensity
182 foreground/background (default). See resource intensityStyles for 182 foreground/background (default). See resource intensityStyles for
183 details. 183 details.
184 184
185 -name *name* 185 -name *name*
186 Specify the application name under which resources are to be 186 Specify the application name under which resources are to be
… …
251 externalBorder. 251 externalBorder.
252 252
253 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. 253 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e.
254 if honoured by the WM, the rxvt-unicode window will not have window 254 if honoured by the WM, the rxvt-unicode window will not have window
255 decorations; resource borderLess. 255 decorations; resource borderLess.
256
257 -sbg
258 Compile *frills*: Disable the usage of the built-in block
259 graphics/line drawing characters and just rely on what the specified
260 fonts provide. Use this if you have a good font and want to use its
261 block graphic glyphs; resource skipBuiltinGlyphs.
256 262
257 -lsp *number* 263 -lsp *number*
258 Compile *frills*: Lines (pixel height) to insert between each row of 264 Compile *frills*: Lines (pixel height) to insert between each row of
259 the display. Useful to work around font rendering problems; resource 265 the display. Useful to work around font rendering problems; resource
260 linespace. 266 linespace.
… …
365 $rxvt->signal_connect_after (realize => sub { 371 $rxvt->signal_connect_after (realize => sub {
366 my $xid = $_[0]->window->get_xid; 372 my $xid = $_[0]->window->get_xid;
367 system "rxvt -embed $xid &"; 373 system "rxvt -embed $xid &";
368 }); 374 });
369 375
370 -pty-fd *fileno* 376 -pty-fd *file descriptor*
371 Tells rxvt NOT to execute any commands or create a new pty/tty pair 377 Tells rxvt NOT to execute any commands or create a new pty/tty pair
372 but instead use the given filehandle as the tty master. This is 378 but instead use the given filehandle as the tty master. This is
373 useful if you want to drive rxvt as a generic terminal emulator 379 useful if you want to drive rxvt as a generic terminal emulator
374 without having to run a program within it. 380 without having to run a program within it.
375 381
376 If this switch is given, rxvt will not create any utmp/wtmp entries 382 If this switch is given, rxvt will not create any utmp/wtmp entries
377 and will not tinker with pty/tty permissions - you have to do that 383 and will not tinker with pty/tty permissions - you have to do that
378 yourself if you want that. 384 yourself if you want that.
379 385
386 As an extremely special case, specifying -1 will completely suppress
387 pty/tty operations.
388
380 Here is a example in perl that illustrates how this option can be 389 Here is a example in perl that illustrates how this option can be
381 used (a longer example is in doc/pty-fd): 390 used (a longer example is in doc/pty-fd):
382 391
383 use IO::Pty; 392 use IO::Pty;
384 use Fcntl; 393 use Fcntl;
… …
391 # now communicate with rxvt 400 # now communicate with rxvt
392 my $slave = $pty->slave; 401 my $slave = $pty->slave;
393 while (<$slave>) { print $slave "got <$_>\n" } 402 while (<$slave>) { print $slave "got <$_>\n" }
394 403
395 -pe *string* 404 -pe *string*
396 Colon-separated list of perl extension scripts to use in this 405 Comma-separated list of perl extension scripts to use (or not to
397 terminal instance. See resource perl-ext. 406 use) in this terminal instance. See resource perl-ext for details.
398 407
399RESOURCES (available also as long-options) 408RESOURCES (available also as long-options)
400 Note: `rxvt --help' gives a list of all resources (long options) 409 Note: `rxvt --help' gives a list of all resources (long options)
401 compiled into your version. 410 compiled into your version.
402 411
403 There are two different methods that rxvt can use to get the Xresource
404 data: using the X libraries (Xrm*-functions) or internal Xresources
405 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
406 XGetDefaults), you can set and change the resources using X11 tools like 412 You can set and change the resources using X11 tools like xrdb. Many
407 xrdb. Many distribution do also load settings from the ~/.Xresources 413 distribution do also load settings from the ~/.Xresources file when X
408 file when X starts. rxvt will consult the following files/resources in 414 starts. rxvt will consult the following files/resources in order, with
409 order, with later settings overwriting earlier ones: 415 later settings overwriting earlier ones:
410 416
411 1. system-wide app-defaults file, either locale-dependent OR global 417 1. system-wide app-defaults file, either locale-dependent OR global
412 2. app-defaults file in $XAPPLRESDIR 418 2. app-defaults file in $XAPPLRESDIR
413 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 419 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
414 4. SCREEN_RESOURCES for the current screen 420 4. SCREEN_RESOURCES for the current screen
415 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 421 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
416 422
417 If compiled with internal Xresources support (i.e. rxvt -h lists 423 Note that when reading X resources, rxvt recognizes two class names:
418 .Xdefaults) then rxvt accepts application defaults set in 424 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
419 XAPPLOADDIR/URxvt (compile-time defined: usually 425 and the original *rxvt* to be easily configured, while the class name
420 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 426 URxvt allows resources unique to rxvt, to be shared between different
421 ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X
422 resources, rxvt recognizes two class names: XTerm and URxvt. The class
423 name Rxvt allows resources common to both rxvt and the original *rxvt*
424 to be easily configured, while the class name URxvt allows resources
425 unique to rxvt, notably colours and key-handling, to be shared between
426 different rxvt configurations. If no resources are specified, suitable 427 rxvt configurations. If no resources are specified, suitable defaults
427 defaults will be used. Command-line arguments can be used to override 428 will be used. Command-line arguments can be used to override resource
428 resource settings. The following resources are allowed: 429 settings. The following resources are supported (you might want to check
430 the rxvtperl(3) manpage for additional settings by perl extensions not
431 documented here):
429 432
430 geometry: *geom* 433 geometry: *geom*
431 Create the window with the specified X window geometry [default 434 Create the window with the specified X window geometry [default
432 80x24]; option -geometry. 435 80x24]; option -geometry.
433 436
… …
533 scale of 1 displays the image without any scaling. A scale of 2 to 9 536 scale of 1 displays the image without any scaling. A scale of 2 to 9
534 specifies an integer number of images in that direction. No image 537 specifies an integer number of images in that direction. No image
535 will be magnified beyond 10 times its original size. The maximum 538 will be magnified beyond 10 times its original size. The maximum
536 permitted scale is 1000. [default 0x0+50+50] 539 permitted scale is 1000. [default 0x0+50+50]
537 540
538 menu: *file[;tag]*
539 Read in the specified menu file (note the `.menu' extension is
540 optional) and also optionally specify a starting tag to find. See
541 the reference documentation for details on the syntax for the
542 menuBar.
543
544 path: *path* 541 path: *path*
545 Specify the colon-delimited search path for finding files (XPM and 542 Specify the colon-delimited search path for finding XPM files.
546 menus), in addition to the paths specified by the RXVTPATH and PATH
547 environment variables.
548 543
549 font: *fontlist* 544 font: *fontlist*
550 Select the fonts to be used. This is a comma separated list of font 545 Select the fonts to be used. This is a comma separated list of font
551 names that are used in turn when trying to display Unicode 546 names that are checked in order when trying to find glyphs for
552 characters. The first font defines the cell size for characters; 547 characters. The first font defines the cell size for characters;
553 other fonts might be smaller, but not larger. A reasonable default 548 other fonts might be smaller, but not (in general) larger. A
554 font list is always appended to it; option -fn. 549 (hopefully) reasonable default font list is always appended to it;
550 option -fn.
555 551
556 Each font can either be a standard X11 core font (XLFD) name, with 552 Each font can either be a standard X11 core font (XLFD) name, with
557 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 553 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
558 "xft:". 554 "xft:".
559 555
… …
562 available hint currently is "codeset=codeset-name", and this is only 558 available hint currently is "codeset=codeset-name", and this is only
563 used for Xft fonts. 559 used for Xft fonts.
564 560
565 For example, this font resource 561 For example, this font resource
566 562
567 URxvt*font: 9x15bold,\ 563 URxvt.font: 9x15bold,\
568 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 564 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
569 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 565 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
570 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 566 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
571 xft:Code2000:antialias=false 567 xft:Code2000:antialias=false
572 568
… …
658 654
659 The string will be interpreted as if typed into the shell as-is. 655 The string will be interpreted as if typed into the shell as-is.
660 656
661 Example: 657 Example:
662 658
663 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 659 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
664 660
665 This creates a new file in your home directory with the screen 661 This creates a new file in your home directory with the screen
666 contents everytime you hit "Print". 662 contents everytime you hit "Print".
667 663
668 scrollBar: *boolean* 664 scrollBar: *boolean*
… …
710 706
711 borderLess: *boolean* 707 borderLess: *boolean*
712 Set MWM hints to request a borderless window, i.e. if honoured by 708 Set MWM hints to request a borderless window, i.e. if honoured by
713 the WM, the rxvt-unicode window will not have window decorations; 709 the WM, the rxvt-unicode window will not have window decorations;
714 option -bl. 710 option -bl.
711
712 skipBuiltinGlyphs: *boolean*
713 Compile *frills*: Disable the usage of the built-in block
714 graphics/line drawing characters and just rely on what the specified
715 fonts provide. Use this if you have a good font and want to use its
716 block graphic glyphs; option -sbg.
715 717
716 termName: *termname* 718 termName: *termname*
717 Specifies the terminal type name to be set in the TERM environment 719 Specifies the terminal type name to be set in the TERM environment
718 variable; option -tn. 720 variable; option -tn.
719 721
… …
805 xterm, have these sequences enabled by default, which doesn't make 807 xterm, have these sequences enabled by default, which doesn't make
806 it safer, though). 808 it safer, though).
807 809
808 You can enable them by setting this boolean resource or specifying 810 You can enable them by setting this boolean resource or specifying
809 -insecure as an option. At the moment, this enables display-answer, 811 -insecure as an option. At the moment, this enables display-answer,
810 locale, findfont, icon label and window title requests as well as 812 locale, findfont, icon label and window title requests.
811 dynamic menubar dispatch.
812 813
813 modifier: *modifier* 814 modifier: *modifier*
814 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 815 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
815 super, mod1, mod2, mod3, mod4, mod5; option -mod. 816 super, mod1, mod2, mod3, mod4, mod5; option -mod.
816 817
… …
859 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 860 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
860 "\000": octal number) or verbatim control characters ("^?": delete, 861 "\000": octal number) or verbatim control characters ("^?": delete,
861 "^@": null, "^A" ...) and may be enclosed with double quotes so that 862 "^@": null, "^A" ...) and may be enclosed with double quotes so that
862 it can start or end with whitespace. 863 it can start or end with whitespace.
863 864
864 Please note that you need to double the "\" when using 865 Please note that you need to double the "\" in resource files, as
865 "--enable-xgetdefault", as X itself does it's own de-escaping (you 866 Xlib itself does it's own de-escaping (you can use "\033" instead of
866 can use "\033" instead of "\e" (and so on), which will work with 867 "\e" (and so on), which will work with both Xt and rxvt's own
867 both Xt and rxvt's own processing). 868 processing).
868 869
869 You can define a range of keysyms in one shot by providing a 870 You can define a range of keysyms in one shot by providing a
870 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 871 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
871 `/' should be a character not used by the strings. 872 `/' should be a character not used by the strings.
872 873
… …
884 is interpreted and executed as rxvt's control sequence. For example 885 is interpreted and executed as rxvt's control sequence. For example
885 the following means "change the current locale to "zh_CN.GBK" when 886 the following means "change the current locale to "zh_CN.GBK" when
886 Control-Meta-c is being pressed": 887 Control-Meta-c is being pressed":
887 888
888 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 889 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
890
891 If *string* takes the form "perl:STRING", then the specified STRING
892 is passed to the "on_keyboard_command" perl handler. See the
893 rxvtperl(3) manpage. For example, the selection extension (activated
894 via "rxvt -pe selection") listens for "selection:rot13" events:
895
896 URxvt.keysym.M-C-c: perl:selection:rot13
889 897
890 Due the the large number of modifier combinations, a defined key 898 Due the the large number of modifier combinations, a defined key
891 mapping will match if at *at least* the specified identifiers are 899 mapping will match if at *at least* the specified identifiers are
892 being set, and no other key mappings with those and more bits are 900 being set, and no other key mappings with those and more bits are
893 being defined. That means that defining a key map for "a" will 901 being defined. That means that defining a key map for "a" will
… …
917 info): 925 info):
918 926
919 URxvt.keysym.M-C-3: command:\033[8;25;80t 927 URxvt.keysym.M-C-3: command:\033[8;25;80t
920 URxvt.keysym.M-C-4: command:\033[8;48;110t 928 URxvt.keysym.M-C-4: command:\033[8;48;110t
921 929
930 perl-ext-common: *string*
922 perl-ext: *string* 931 perl-ext: *string*
923 Colon-separated list of perl extension scripts to use in this 932 Comma-separated list(s) of perl extension scripts (default:
924 terminal instance. Each extension is looked up in the library 933 "default") to use in this terminal instance; option -pe.
934
935 Extension names can be prefixed with a "-" sign to prohibit using
936 them. This can be useful to selectively disable some extensions
937 loaded by default, or specified via the "perl-ext-common" resource.
938 For example, "default,-selection" will use all the default extension
939 except "selection".
940
941 Extension names can also be followed by an argument in angle
942 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
943 for searchable scorllback to Alt/Meta-s). Mentioning the same
944 extension multiple times with different arguments will pass multiple
945 arguments to the extension.
946
947 Each extension is looked up in the library directories, loaded if
925 directories, loaded if necessary, and bound to the current terminal 948 necessary, and bound to the current terminal instance.
926 instance; option -pe. 949
950 If both of these resources are the empty string, then the perl
951 interpreter will not be initialized. The idea behind two options is
952 that perl-ext-common will be used for extensions that should be
953 available to all instances, while perl-ext is used for specific
954 instances.
927 955
928 perl-eval: *string* 956 perl-eval: *string*
929 Perl code to be evaluated when all extensions have been registered. 957 Perl code to be evaluated when all extensions have been registered.
930 See the rxvtperl(3) manpage. 958 See the rxvtperl(3) manpage. Due to security reasons, this resource
959 will be ignored when running setuid/setgid.
931 960
932 perl-lib: *path* 961 perl-lib: *path*
933 Colon-separated list of additional directories that hold extension 962 Colon-separated list of additional directories that hold extension
934 scripts. When looking for extensions specified by the "perl" 963 scripts. When looking for extensions specified by the "perl"
935 resource, rxvt will first look in these directories and then in 964 resource, rxvt will first look in these directories and then in
936 /opt/rxvt/lib/urxvt/perl-ext/. 965 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
966 will be ignored when running setuid/setgid.
937 967
938 See the rxvtperl(3) manpage. 968 See the rxvtperl(3) manpage.
969
970 selection.pattern-*idx*: *perl-regex*
971 Additional selection patterns, see the rxvtperl(3) manpage for
972 details.
973
974 selection-autotransform.*idx*: *perl-transform*
975 Selection auto-transform patterns, see the rxvtperl(3) manpage for
976 details.
977
978 searchable-scrollback: *keysym*
979 Sets the hotkey that starts the incremental scrollback buffer search
980 (default: "M-s").
981
982 urlLauncher: *string*
983 Specifies the program to be started with a URL argument. Used by the
984 "selection-popup" and "mark-urls" perl extensions.
985
986 transient-for: *windowid*
987 Sets the WM_TRANSIENT_FOR property to the given window iw.
939 988
940THE SCROLLBAR 989THE SCROLLBAR
941 Lines of text that scroll off the top of the rxvt window (resource: 990 Lines of text that scroll off the top of the rxvt window (resource:
942 saveLines) and can be scrolled back using the scrollbar or by 991 saveLines) and can be scrolled back using the scrollbar or by
943 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 992 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
… …
983 1032
984CHANGING FONTS 1033CHANGING FONTS
985 Changing fonts (or font sizes, respectively) via the keypad is not yet 1034 Changing fonts (or font sizes, respectively) via the keypad is not yet
986 supported in rxvt-unicode. Bug me if you need this. 1035 supported in rxvt-unicode. Bug me if you need this.
987 1036
988 You can, however, switch fonts at runtime using escape sequences (and 1037 You can, however, switch fonts at runtime using escape sequences, e.g.:
989 therefore using the menubar), e.g.:
990 1038
991 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1039 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1040
1041 You can use keyboard shortcuts, too:
1042
1043 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1044 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
992 1045
993 rxvt-unicode will automatically re-apply these fonts to the output so 1046 rxvt-unicode will automatically re-apply these fonts to the output so
994 far. 1047 far.
995 1048
996ISO 14755 SUPPORT 1049ISO 14755 SUPPORT

Diff Legend

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