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

Comparing cvsroot/rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.39 by root, Mon Jan 9 01:36:56 2006 UTC vs.
Revision 1.47 by root, Mon Jan 16 15:12:48 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.3, 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
407 407
408RESOURCES (available also as long-options) 408RESOURCES (available also as long-options)
409 Note: `rxvt --help' gives a list of all resources (long options) 409 Note: `rxvt --help' gives a list of all resources (long options)
410 compiled into your version. 410 compiled into your version.
411 411
412 There are two different methods that rxvt can use to get the Xresource
413 data: using the X libraries (Xrm*-functions) or internal Xresources
414 reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
415 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
416 xrdb. Many distribution do also load settings from the ~/.Xresources 413 distribution do also load settings from the ~/.Xresources file when X
417 file when X starts. rxvt will consult the following files/resources in 414 starts. rxvt will consult the following files/resources in order, with
418 order, with later settings overwriting earlier ones: 415 later settings overwriting earlier ones:
419 416
420 1. system-wide app-defaults file, either locale-dependent OR global 417 1. system-wide app-defaults file, either locale-dependent OR global
421 2. app-defaults file in $XAPPLRESDIR 418 2. app-defaults file in $XAPPLRESDIR
422 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 419 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
423 4. SCREEN_RESOURCES for the current screen 420 4. SCREEN_RESOURCES for the current screen
424 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 421 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
425 422
426 If compiled with internal Xresources support (i.e. rxvt -h lists 423 Note that when reading X resources, rxvt recognizes two class names:
427 .Xdefaults) then rxvt accepts application defaults set in 424 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
428 XAPPLOADDIR/URxvt (compile-time defined: usually 425 and the original *rxvt* to be easily configured, while the class name
429 /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or 426 URxvt allows resources unique to rxvt, to be shared between different
430 ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X
431 resources, rxvt recognizes two class names: XTerm and URxvt. The class
432 name Rxvt allows resources common to both rxvt and the original *rxvt*
433 to be easily configured, while the class name URxvt allows resources
434 unique to rxvt, notably colours and key-handling, to be shared between
435 different rxvt configurations. If no resources are specified, suitable 427 rxvt configurations. If no resources are specified, suitable defaults
436 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
437 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):
438 432
439 geometry: *geom* 433 geometry: *geom*
440 Create the window with the specified X window geometry [default 434 Create the window with the specified X window geometry [default
441 80x24]; option -geometry. 435 80x24]; option -geometry.
442 436
542 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
543 specifies an integer number of images in that direction. No image 537 specifies an integer number of images in that direction. No image
544 will be magnified beyond 10 times its original size. The maximum 538 will be magnified beyond 10 times its original size. The maximum
545 permitted scale is 1000. [default 0x0+50+50] 539 permitted scale is 1000. [default 0x0+50+50]
546 540
547 menu: *file[;tag]*
548 Read in the specified menu file (note the `.menu' extension is
549 optional) and also optionally specify a starting tag to find. See
550 the reference documentation for details on the syntax for the
551 menuBar.
552
553 path: *path* 541 path: *path*
554 Specify the colon-delimited search path for finding files (XPM and 542 Specify the colon-delimited search path for finding XPM files.
555 menus), in addition to the paths specified by the RXVTPATH and PATH
556 environment variables.
557 543
558 font: *fontlist* 544 font: *fontlist*
559 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
560 names that are used in turn when trying to display Unicode 546 names that are checked in order when trying to find glyphs for
561 characters. The first font defines the cell size for characters; 547 characters. The first font defines the cell size for characters;
562 other fonts might be smaller, but not larger. A reasonable default 548 other fonts might be smaller, but not (in general) larger. A
563 font list is always appended to it; option -fn. 549 (hopefully) reasonable default font list is always appended to it;
550 option -fn.
564 551
565 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
566 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 553 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
567 "xft:". 554 "xft:".
568 555
571 available hint currently is "codeset=codeset-name", and this is only 558 available hint currently is "codeset=codeset-name", and this is only
572 used for Xft fonts. 559 used for Xft fonts.
573 560
574 For example, this font resource 561 For example, this font resource
575 562
576 URxvt*font: 9x15bold,\ 563 URxvt.font: 9x15bold,\
577 -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,\
578 -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, \
579 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 566 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
580 xft:Code2000:antialias=false 567 xft:Code2000:antialias=false
581 568
667 654
668 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.
669 656
670 Example: 657 Example:
671 658
672 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 659 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
673 660
674 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
675 contents everytime you hit "Print". 662 contents everytime you hit "Print".
676 663
677 scrollBar: *boolean* 664 scrollBar: *boolean*
820 xterm, have these sequences enabled by default, which doesn't make 807 xterm, have these sequences enabled by default, which doesn't make
821 it safer, though). 808 it safer, though).
822 809
823 You can enable them by setting this boolean resource or specifying 810 You can enable them by setting this boolean resource or specifying
824 -insecure as an option. At the moment, this enables display-answer, 811 -insecure as an option. At the moment, this enables display-answer,
825 locale, findfont, icon label and window title requests as well as 812 locale, findfont, icon label and window title requests.
826 dynamic menubar dispatch.
827 813
828 modifier: *modifier* 814 modifier: *modifier*
829 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,
830 super, mod1, mod2, mod3, mod4, mod5; option -mod. 816 super, mod1, mod2, mod3, mod4, mod5; option -mod.
831 817
874 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 860 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
875 "\000": octal number) or verbatim control characters ("^?": delete, 861 "\000": octal number) or verbatim control characters ("^?": delete,
876 "^@": null, "^A" ...) and may be enclosed with double quotes so that 862 "^@": null, "^A" ...) and may be enclosed with double quotes so that
877 it can start or end with whitespace. 863 it can start or end with whitespace.
878 864
879 Please note that you need to double the "\" when using 865 Please note that you need to double the "\" in resource files, as
880 "--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
881 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
882 both Xt and rxvt's own processing). 868 processing).
883 869
884 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
885 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 871 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
886 `/' should be a character not used by the strings. 872 `/' should be a character not used by the strings.
887 873
945 perl-ext: *string* 931 perl-ext: *string*
946 Comma-separated list(s) of perl extension scripts (default: 932 Comma-separated list(s) of perl extension scripts (default:
947 "default") to use in this terminal instance; option -pe. 933 "default") to use in this terminal instance; option -pe.
948 934
949 Extension names can be prefixed with a "-" sign to prohibit using 935 Extension names can be prefixed with a "-" sign to prohibit using
950 it. This can be useful to selectively disable some extensions loaded 936 them. This can be useful to selectively disable some extensions
951 by default, or specified via the "perl-ext-common" resource. For 937 loaded by default, or specified via the "perl-ext-common" resource.
952 example, "default,-selection" will use all the default extension 938 For example, "default,-selection" will use all the default extension
953 except "selection". 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.
954 946
955 Each extension is looked up in the library directories, loaded if 947 Each extension is looked up in the library directories, loaded if
956 necessary, and bound to the current terminal instance. 948 necessary, and bound to the current terminal instance.
957 949
958 If both of these resources are the empty string, then the perl 950 If both of these resources are the empty string, then the perl
973 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource 965 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
974 will be ignored when running setuid/setgid. 966 will be ignored when running setuid/setgid.
975 967
976 See the rxvtperl(3) manpage. 968 See the rxvtperl(3) manpage.
977 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
978 transient-for: *windowid* 986 transient-for: *windowid*
979 Sets the WM_TRANSIENT_FOR property to the given window iw. 987 Sets the WM_TRANSIENT_FOR property to the given window iw.
980 988
981THE SCROLLBAR 989THE SCROLLBAR
982 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:
1024 1032
1025CHANGING FONTS 1033CHANGING FONTS
1026 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
1027 supported in rxvt-unicode. Bug me if you need this. 1035 supported in rxvt-unicode. Bug me if you need this.
1028 1036
1029 You can, however, switch fonts at runtime using escape sequences (and 1037 You can, however, switch fonts at runtime using escape sequences, e.g.:
1030 therefore using the menubar), e.g.:
1031 1038
1032 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
1033 1045
1034 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
1035 far. 1047 far.
1036 1048
1037ISO 14755 SUPPORT 1049ISO 14755 SUPPORT
1173 display in it's child processes. 1185 display in it's child processes.
1174 1186
1175 SHELL 1187 SHELL
1176 The shell to be used for command execution, defaults to "/bin/sh". 1188 The shell to be used for command execution, defaults to "/bin/sh".
1177 1189
1178 RXVTPATH
1179 The path where rxvt looks for support files such as menu and xpm
1180 files.
1181
1182 PATH
1183 Used in the same way as "RXVTPATH".
1184
1185 RXVT_SOCKET 1190 RXVT_SOCKET
1186 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1191 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1187 1192
1188 Default $HOME/.rxvt-unicode-*<nodename*. 1193 Default $HOME/.rxvt-unicode-*<nodename*.
1189 1194

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines