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.37 by root, Sat Jan 7 04:19:43 2006 UTC vs.
Revision 1.50 by root, Fri Jan 20 22:49:34 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.1, 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
… …
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 -override-redirect
258 Compile *frills*: Sets override-redirect on the window; resource
259 override-redirect.
256 260
257 -sbg 261 -sbg
258 Compile *frills*: Disable the usage of the built-in block 262 Compile *frills*: Disable the usage of the built-in block
259 graphics/line drawing characters and just rely on what the specified 263 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 264 fonts provide. Use this if you have a good font and want to use its
… …
400 # now communicate with rxvt 404 # now communicate with rxvt
401 my $slave = $pty->slave; 405 my $slave = $pty->slave;
402 while (<$slave>) { print $slave "got <$_>\n" } 406 while (<$slave>) { print $slave "got <$_>\n" }
403 407
404 -pe *string* 408 -pe *string*
405 Comma-separated list of perl extension scripts to use in this 409 Comma-separated list of perl extension scripts to use (or not to
406 terminal instance. See resource perl-ext. 410 use) in this terminal instance. See resource perl-ext for details.
407 411
408RESOURCES (available also as long-options) 412RESOURCES (available also as long-options)
409 Note: `rxvt --help' gives a list of all resources (long options) 413 Note: `rxvt --help' gives a list of all resources (long options)
410 compiled into your version. 414 compiled into your version.
411 415
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 416 You can set and change the resources using X11 tools like xrdb. Many
416 xrdb. Many distribution do also load settings from the ~/.Xresources 417 distribution do also load settings from the ~/.Xresources file when X
417 file when X starts. rxvt will consult the following files/resources in 418 starts. rxvt will consult the following files/resources in order, with
418 order, with later settings overwriting earlier ones: 419 later settings overwriting earlier ones:
419 420
420 1. system-wide app-defaults file, either locale-dependent OR global 421 1. system-wide app-defaults file, either locale-dependent OR global
421 2. app-defaults file in $XAPPLRESDIR 422 2. app-defaults file in $XAPPLRESDIR
422 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 423 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
423 4. SCREEN_RESOURCES for the current screen 424 4. SCREEN_RESOURCES for the current screen
424 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 425 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
425 426
426 If compiled with internal Xresources support (i.e. rxvt -h lists 427 Note that when reading X resources, rxvt recognizes two class names:
427 .Xdefaults) then rxvt accepts application defaults set in 428 Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
428 XAPPLOADDIR/URxvt (compile-time defined: usually 429 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 430 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 431 rxvt configurations. If no resources are specified, suitable defaults
436 defaults will be used. Command-line arguments can be used to override 432 will be used. Command-line arguments can be used to override resource
437 resource settings. The following resources are allowed: 433 settings. The following resources are supported (you might want to check
434 the rxvtperl(3) manpage for additional settings by perl extensions not
435 documented here):
438 436
439 geometry: *geom* 437 geometry: *geom*
440 Create the window with the specified X window geometry [default 438 Create the window with the specified X window geometry [default
441 80x24]; option -geometry. 439 80x24]; option -geometry.
442 440
… …
542 scale of 1 displays the image without any scaling. A scale of 2 to 9 540 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 541 specifies an integer number of images in that direction. No image
544 will be magnified beyond 10 times its original size. The maximum 542 will be magnified beyond 10 times its original size. The maximum
545 permitted scale is 1000. [default 0x0+50+50] 543 permitted scale is 1000. [default 0x0+50+50]
546 544
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* 545 path: *path*
554 Specify the colon-delimited search path for finding files (XPM and 546 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 547
558 font: *fontlist* 548 font: *fontlist*
559 Select the fonts to be used. This is a comma separated list of font 549 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 550 names that are checked in order when trying to find glyphs for
561 characters. The first font defines the cell size for characters; 551 characters. The first font defines the cell size for characters;
562 other fonts might be smaller, but not larger. A reasonable default 552 other fonts might be smaller, but not (in general) larger. A
563 font list is always appended to it; option -fn. 553 (hopefully) reasonable default font list is always appended to it;
554 option -fn.
564 555
565 Each font can either be a standard X11 core font (XLFD) name, with 556 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 557 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
567 "xft:". 558 "xft:".
568 559
… …
571 available hint currently is "codeset=codeset-name", and this is only 562 available hint currently is "codeset=codeset-name", and this is only
572 used for Xft fonts. 563 used for Xft fonts.
573 564
574 For example, this font resource 565 For example, this font resource
575 566
576 URxvt*font: 9x15bold,\ 567 URxvt.font: 9x15bold,\
577 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 568 -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, \ 569 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
579 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 570 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
580 xft:Code2000:antialias=false 571 xft:Code2000:antialias=false
581 572
… …
667 658
668 The string will be interpreted as if typed into the shell as-is. 659 The string will be interpreted as if typed into the shell as-is.
669 660
670 Example: 661 Example:
671 662
672 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 663 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
673 664
674 This creates a new file in your home directory with the screen 665 This creates a new file in your home directory with the screen
675 contents everytime you hit "Print". 666 contents everytime you hit "Print".
676 667
677 scrollBar: *boolean* 668 scrollBar: *boolean*
… …
820 xterm, have these sequences enabled by default, which doesn't make 811 xterm, have these sequences enabled by default, which doesn't make
821 it safer, though). 812 it safer, though).
822 813
823 You can enable them by setting this boolean resource or specifying 814 You can enable them by setting this boolean resource or specifying
824 -insecure as an option. At the moment, this enables display-answer, 815 -insecure as an option. At the moment, this enables display-answer,
825 locale, findfont, icon label and window title requests as well as 816 locale, findfont, icon label and window title requests.
826 dynamic menubar dispatch.
827 817
828 modifier: *modifier* 818 modifier: *modifier*
829 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 819 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
830 super, mod1, mod2, mod3, mod4, mod5; option -mod. 820 super, mod1, mod2, mod3, mod4, mod5; option -mod.
831 821
832 answerbackString: *string* 822 answerbackString: *string*
833 Specify the reply rxvt-unicode sends to the shell when an ENQ 823 Specify the reply rxvt-unicode sends to the shell when an ENQ
834 (control-E) character is passed through. It may contain escape 824 (control-E) character is passed through. It may contain escape
835 values as described in the entry on keysym following. 825 values as described in the entry on keysym following.
836 826
837 secondaryScreen: *bool* 827 secondaryScreen: *boolean*
838 Turn on/off secondary screen (default enabled). 828 Turn on/off secondary screen (default enabled).
839 829
840 secondaryScroll: *bool* 830 secondaryScroll: *boolean*
841 Turn on/off secondary screen scroll (default enabled). If the this 831 Turn on/off secondary screen scroll (default enabled). If the this
842 option is enabled, scrolls on the secondary screen will change the 832 option is enabled, scrolls on the secondary screen will change the
843 scrollback buffer and switching to/from the secondary screen will 833 scrollback buffer and switching to/from the secondary screen will
844 instead scroll the screen up. 834 instead scroll the screen up.
845 835
846 hold: *bool* 836 hold: *boolean*
847 Turn on/off hold window after exit support. If enabled, rxvt will 837 Turn on/off hold window after exit support. If enabled, rxvt will
848 not immediately destroy its window when the program executed within 838 not immediately destroy its window when the program executed within
849 it exits. Instead, it will wait till it is being killed or closed by 839 it exits. Instead, it will wait till it is being killed or closed by
850 the user. 840 the user.
851 841
… …
874 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab, 864 "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
875 "\000": octal number) or verbatim control characters ("^?": delete, 865 "\000": octal number) or verbatim control characters ("^?": delete,
876 "^@": null, "^A" ...) and may be enclosed with double quotes so that 866 "^@": null, "^A" ...) and may be enclosed with double quotes so that
877 it can start or end with whitespace. 867 it can start or end with whitespace.
878 868
879 Please note that you need to double the "\" when using 869 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 870 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 871 "\e" (and so on), which will work with both Xt and rxvt's own
882 both Xt and rxvt's own processing). 872 processing).
883 873
884 You can define a range of keysyms in one shot by providing a 874 You can define a range of keysyms in one shot by providing a
885 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter 875 *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
886 `/' should be a character not used by the strings. 876 `/' should be a character not used by the strings.
887 877
… …
941 URxvt.keysym.M-C-3: command:\033[8;25;80t 931 URxvt.keysym.M-C-3: command:\033[8;25;80t
942 URxvt.keysym.M-C-4: command:\033[8;48;110t 932 URxvt.keysym.M-C-4: command:\033[8;48;110t
943 933
944 perl-ext-common: *string* 934 perl-ext-common: *string*
945 perl-ext: *string* 935 perl-ext: *string*
946 Comma-separated list(s) of perl extension scripts to use in this 936 Comma-separated list(s) of perl extension scripts (default:
947 terminal instance. Each extension is looked up in the library 937 "default") to use in this terminal instance; option -pe.
938
939 Extension names can be prefixed with a "-" sign to prohibit using
940 them. This can be useful to selectively disable some extensions
941 loaded by default, or specified via the "perl-ext-common" resource.
942 For example, "default,-selection" will use all the default extension
943 except "selection".
944
945 Extension names can also be followed by an argument in angle
946 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
947 for searchable scorllback to Alt/Meta-s). Mentioning the same
948 extension multiple times with different arguments will pass multiple
949 arguments to the extension.
950
951 Each extension is looked up in the library directories, loaded if
948 directories, loaded if necessary, and bound to the current terminal 952 necessary, and bound to the current terminal instance.
949 instance. If this resource is empty or missing, then the perl 953
954 If both of these resources are the empty string, then the perl
950 interpreter will not be initialized. The idea behind two options is 955 interpreter will not be initialized. The idea behind two options is
951 that perl-ext-common will be used for extensions that should be 956 that perl-ext-common will be used for extensions that should be
952 available to all instances, while perl-ext is used for specific 957 available to all instances, while perl-ext is used for specific
953 instances; option -pe. 958 instances.
954 959
955 perl-eval: *string* 960 perl-eval: *string*
956 Perl code to be evaluated when all extensions have been registered. 961 Perl code to be evaluated when all extensions have been registered.
957 See the rxvtperl(3) manpage. 962 See the rxvtperl(3) manpage. Due to security reasons, this resource
963 will be ignored when running setuid/setgid.
958 964
959 perl-lib: *path* 965 perl-lib: *path*
960 Colon-separated list of additional directories that hold extension 966 Colon-separated list of additional directories that hold extension
961 scripts. When looking for extensions specified by the "perl" 967 scripts. When looking for extensions specified by the "perl"
962 resource, rxvt will first look in these directories and then in 968 resource, rxvt will first look in these directories and then in
963 /opt/rxvt/lib/urxvt/perl/. 969 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
970 will be ignored when running setuid/setgid.
964 971
965 See the rxvtperl(3) manpage. 972 See the rxvtperl(3) manpage.
973
974 selection.pattern-*idx*: *perl-regex*
975 Additional selection patterns, see the rxvtperl(3) manpage for
976 details.
977
978 selection-autotransform.*idx*: *perl-transform*
979 Selection auto-transform patterns, see the rxvtperl(3) manpage for
980 details.
981
982 searchable-scrollback: *keysym*
983 Sets the hotkey that starts the incremental scrollback buffer search
984 (default: "M-s").
985
986 urlLauncher: *string*
987 Specifies the program to be started with a URL argument. Used by the
988 "selection-popup" and "mark-urls" perl extensions.
989
990 transient-for: *windowid*
991 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
992 window id.
993
994 override-redirect: *boolean*
995 Compile *frills*: Sets override-redirect for the terminal window,
996 making it almost invisible to window managers; option
997 -override-redirect.
966 998
967THE SCROLLBAR 999THE SCROLLBAR
968 Lines of text that scroll off the top of the rxvt window (resource: 1000 Lines of text that scroll off the top of the rxvt window (resource:
969 saveLines) and can be scrolled back using the scrollbar or by 1001 saveLines) and can be scrolled back using the scrollbar or by
970 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1002 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
… …
1002 normal one. In this mode, every selected row becomes its own line in 1034 normal one. In this mode, every selected row becomes its own line in
1003 the selection, and trailing whitespace is visually underlined and 1035 the selection, and trailing whitespace is visually underlined and
1004 removed from the selection. 1036 removed from the selection.
1005 1037
1006 Insertion: 1038 Insertion:
1007 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1039 Pressing and releasing the Middle mouse button in an rxvt window
1008 an rxvt window causes the current text selection to be inserted as 1040 causes the value of the PRIMARY selection (Shift for CLIPBOARD) to
1009 if it had been typed on the keyboard. 1041 be inserted as if it had been typed on the keyboard. Shift-Insert
1042 causes the value of the PRIMARY selection to be inserted too.
1010 1043
1011CHANGING FONTS 1044CHANGING FONTS
1012 Changing fonts (or font sizes, respectively) via the keypad is not yet 1045 Changing fonts (or font sizes, respectively) via the keypad is not yet
1013 supported in rxvt-unicode. Bug me if you need this. 1046 supported in rxvt-unicode. Bug me if you need this.
1014 1047
1015 You can, however, switch fonts at runtime using escape sequences (and 1048 You can, however, switch fonts at runtime using escape sequences, e.g.:
1016 therefore using the menubar), e.g.:
1017 1049
1018 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1050 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1051
1052 You can use keyboard shortcuts, too:
1053
1054 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1055 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1019 1056
1020 rxvt-unicode will automatically re-apply these fonts to the output so 1057 rxvt-unicode will automatically re-apply these fonts to the output so
1021 far. 1058 far.
1022 1059
1023ISO 14755 SUPPORT 1060ISO 14755 SUPPORT
… …
1159 display in it's child processes. 1196 display in it's child processes.
1160 1197
1161 SHELL 1198 SHELL
1162 The shell to be used for command execution, defaults to "/bin/sh". 1199 The shell to be used for command execution, defaults to "/bin/sh".
1163 1200
1164 RXVTPATH
1165 The path where rxvt looks for support files such as menu and xpm
1166 files.
1167
1168 PATH
1169 Used in the same way as "RXVTPATH".
1170
1171 RXVT_SOCKET 1201 RXVT_SOCKET
1172 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1202 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1173 1203
1174 Default $HOME/.rxvt-unicode-*<nodename*. 1204 Default $HOME/.rxvt-unicode-*<nodename*.
1175 1205
… …
1216 1246
1217 Oezguer Kesim <kesim@math.fu-berlin.de> 1247 Oezguer Kesim <kesim@math.fu-berlin.de>
1218 Project Coordinator (changes.txt 2.21a to 2.4.5) 1248 Project Coordinator (changes.txt 2.21a to 2.4.5)
1219 1249
1220 Geoff Wing <gcw@pobox.com> 1250 Geoff Wing <gcw@pobox.com>
1221 Rewrote screen display and text selection routines. Project 1251 Rewrote screen display and text selection routines.
1252
1222 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1253 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1223 1254
1224 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1255 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1225 Forked rxvt-unicode, rewrote most of the display code and internal 1256 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1226 character handling to store text in unicode, improve xterm 1257 perl extension, random hacks, numerous bugfixes and extensions.
1227 compatibility and apply numerous other bugfixes and extensions.
1228 1258
1229 Project Coordinator (Changes 1.0 -) 1259 Project Coordinator (Changes 1.0 -)
1230 1260
1261 Emanuele Giaquinta <e.giaquinta@glauco.it>
1262 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1263

Diff Legend

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