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.42 by root, Wed Jan 11 23:08:54 2006 UTC vs.
Revision 1.53 by root, Thu Jan 26 00:09:47 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 7.0, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 7.3a, 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
84 -display *displayname* 84 -display *displayname*
85 Attempt to open a window on the named X display (-d still 85 Attempt to open a window on the named X display (-d still
86 respected). In the absence of this option, the display specified by 86 respected). In the absence of this option, the display specified by
87 the DISPLAY environment variable is used. 87 the DISPLAY environment variable is used.
88 88
89 -depth *bitdepth*
90 Compile *frills*: Attempt to find a visual with the given bit depth;
91 resource depth.
92
89 -geometry *geom* 93 -geometry *geom*
90 Window geometry (-g still respected); resource geometry. 94 Window geometry (-g still respected); resource geometry.
91 95
92 -rv|+rv 96 -rv|+rv
93 Turn on/off simulated reverse video; resource reverseVideo. 97 Turn on/off simulated reverse video; resource reverseVideo.
146 The colour of the border around the text area and between the 150 The colour of the border around the text area and between the
147 scrollbar and the text; resource borderColor. 151 scrollbar and the text; resource borderColor.
148 152
149 -fn *fontlist* 153 -fn *fontlist*
150 Select the fonts to be used. This is a comma separated list of font 154 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 155 names that are checked in order when trying to find glyphs for
152 characters. The first font defines the cell size for characters; 156 characters. The first font defines the cell size for characters;
153 other fonts might be smaller, but not (in general) larger. A 157 other fonts might be smaller, but not (in general) larger. A
154 (hopefully) reasonable default font list is always appended to it. 158 (hopefully) reasonable default font list is always appended to it.
155 See resource font for more details. 159 See resource font for more details.
156 160
251 externalBorder. 255 externalBorder.
252 256
253 -bl Compile *frills*: Set MWM hints to request a borderless window, i.e. 257 -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 258 if honoured by the WM, the rxvt-unicode window will not have window
255 decorations; resource borderLess. 259 decorations; resource borderLess.
260
261 -override-redirect
262 Compile *frills*: Sets override-redirect on the window; resource
263 override-redirect.
256 264
257 -sbg 265 -sbg
258 Compile *frills*: Disable the usage of the built-in block 266 Compile *frills*: Disable the usage of the built-in block
259 graphics/line drawing characters and just rely on what the specified 267 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 268 fonts provide. Use this if you have a good font and want to use its
427 rxvt configurations. If no resources are specified, suitable defaults 435 rxvt configurations. If no resources are specified, suitable defaults
428 will be used. Command-line arguments can be used to override resource 436 will be used. Command-line arguments can be used to override resource
429 settings. The following resources are supported (you might want to check 437 settings. The following resources are supported (you might want to check
430 the rxvtperl(3) manpage for additional settings by perl extensions not 438 the rxvtperl(3) manpage for additional settings by perl extensions not
431 documented here): 439 documented here):
440
441 depth: *bitdepth*
442 Compile *frills*: Attempt to find a visual with the given bit depth;
443 option -depth.
432 444
433 geometry: *geom* 445 geometry: *geom*
434 Create the window with the specified X window geometry [default 446 Create the window with the specified X window geometry [default
435 80x24]; option -geometry. 447 80x24]; option -geometry.
436 448
536 scale of 1 displays the image without any scaling. A scale of 2 to 9 548 scale of 1 displays the image without any scaling. A scale of 2 to 9
537 specifies an integer number of images in that direction. No image 549 specifies an integer number of images in that direction. No image
538 will be magnified beyond 10 times its original size. The maximum 550 will be magnified beyond 10 times its original size. The maximum
539 permitted scale is 1000. [default 0x0+50+50] 551 permitted scale is 1000. [default 0x0+50+50]
540 552
541 menu: *file[;tag]*
542 Read in the specified menu file (note the `.menu' extension is
543 optional) and also optionally specify a starting tag to find. See
544 the reference documentation for details on the syntax for the
545 menuBar.
546
547 path: *path* 553 path: *path*
548 Specify the colon-delimited search path for finding files (XPM and 554 Specify the colon-delimited search path for finding XPM files.
549 menus), in addition to the paths specified by the RXVTPATH and PATH
550 environment variables.
551 555
552 font: *fontlist* 556 font: *fontlist*
553 Select the fonts to be used. This is a comma separated list of font 557 Select the fonts to be used. This is a comma separated list of font
554 names that are used in turn when trying to display Unicode 558 names that are checked in order when trying to find glyphs for
555 characters. The first font defines the cell size for characters; 559 characters. The first font defines the cell size for characters;
556 other fonts might be smaller, but not larger. A reasonable default 560 other fonts might be smaller, but not (in general) larger. A
557 font list is always appended to it; option -fn. 561 (hopefully) reasonable default font list is always appended to it;
562 option -fn.
558 563
559 Each font can either be a standard X11 core font (XLFD) name, with 564 Each font can either be a standard X11 core font (XLFD) name, with
560 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 565 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
561 "xft:". 566 "xft:".
562 567
565 available hint currently is "codeset=codeset-name", and this is only 570 available hint currently is "codeset=codeset-name", and this is only
566 used for Xft fonts. 571 used for Xft fonts.
567 572
568 For example, this font resource 573 For example, this font resource
569 574
570 URxvt*font: 9x15bold,\ 575 URxvt.font: 9x15bold,\
571 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 576 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
572 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 577 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
573 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 578 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
574 xft:Code2000:antialias=false 579 xft:Code2000:antialias=false
575 580
661 666
662 The string will be interpreted as if typed into the shell as-is. 667 The string will be interpreted as if typed into the shell as-is.
663 668
664 Example: 669 Example:
665 670
666 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 671 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
667 672
668 This creates a new file in your home directory with the screen 673 This creates a new file in your home directory with the screen
669 contents everytime you hit "Print". 674 contents everytime you hit "Print".
670 675
671 scrollBar: *boolean* 676 scrollBar: *boolean*
772 The string to send when the delete key (not the keypad delete key) 777 The string to send when the delete key (not the keypad delete key)
773 is pressed. If unset it will send the sequence traditionally 778 is pressed. If unset it will send the sequence traditionally
774 associated with the Execute key. 779 associated with the Execute key.
775 780
776 cutchars: *string* 781 cutchars: *string*
777 The characters used as delimiters for double-click word selection. 782 The characters used as delimiters for double-click word selection
778 The built-in default: 783 (whitespace delimiting is added automatically if resource is given).
784
785 When the selection extension is in use (the default if compiled in,
786 see the rxvtperl(3) manpage), a suitable regex using these
787 characters will be created (if the resource exists, otherwise, no
788 regex will be created). In this mode, characters outside ISO-8859-1
789 can be used.
790
791 When the selection extension is not used, only ISO-8859-1 characters
792 can be used. If not specified, the built-in default is used:
779 793
780 BACKSLASH `"'&()*,;<=>?@[]{|} 794 BACKSLASH `"'&()*,;<=>?@[]{|}
781 795
782 preeditType: *style* 796 preeditType: *style*
783 OverTheSpot, OffTheSpot, Root; option -pt. 797 OverTheSpot, OffTheSpot, Root; option -pt.
814 xterm, have these sequences enabled by default, which doesn't make 828 xterm, have these sequences enabled by default, which doesn't make
815 it safer, though). 829 it safer, though).
816 830
817 You can enable them by setting this boolean resource or specifying 831 You can enable them by setting this boolean resource or specifying
818 -insecure as an option. At the moment, this enables display-answer, 832 -insecure as an option. At the moment, this enables display-answer,
819 locale, findfont, icon label and window title requests as well as 833 locale, findfont, icon label and window title requests.
820 dynamic menubar dispatch.
821 834
822 modifier: *modifier* 835 modifier: *modifier*
823 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 836 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
824 super, mod1, mod2, mod3, mod4, mod5; option -mod. 837 super, mod1, mod2, mod3, mod4, mod5; option -mod.
825 838
826 answerbackString: *string* 839 answerbackString: *string*
827 Specify the reply rxvt-unicode sends to the shell when an ENQ 840 Specify the reply rxvt-unicode sends to the shell when an ENQ
828 (control-E) character is passed through. It may contain escape 841 (control-E) character is passed through. It may contain escape
829 values as described in the entry on keysym following. 842 values as described in the entry on keysym following.
830 843
831 secondaryScreen: *bool* 844 secondaryScreen: *boolean*
832 Turn on/off secondary screen (default enabled). 845 Turn on/off secondary screen (default enabled).
833 846
834 secondaryScroll: *bool* 847 secondaryScroll: *boolean*
835 Turn on/off secondary screen scroll (default enabled). If the this 848 Turn on/off secondary screen scroll (default enabled). If the this
836 option is enabled, scrolls on the secondary screen will change the 849 option is enabled, scrolls on the secondary screen will change the
837 scrollback buffer and switching to/from the secondary screen will 850 scrollback buffer and switching to/from the secondary screen will
838 instead scroll the screen up. 851 instead scroll the screen up.
839 852
840 hold: *bool* 853 hold: *boolean*
841 Turn on/off hold window after exit support. If enabled, rxvt will 854 Turn on/off hold window after exit support. If enabled, rxvt will
842 not immediately destroy its window when the program executed within 855 not immediately destroy its window when the program executed within
843 it exits. Instead, it will wait till it is being killed or closed by 856 it exits. Instead, it will wait till it is being killed or closed by
844 the user. 857 the user.
845 858
973 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource 986 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
974 will be ignored when running setuid/setgid. 987 will be ignored when running setuid/setgid.
975 988
976 See the rxvtperl(3) manpage. 989 See the rxvtperl(3) manpage.
977 990
991 selection.pattern-*idx*: *perl-regex*
992 Additional selection patterns, see the rxvtperl(3) manpage for
993 details.
994
995 selection-autotransform.*idx*: *perl-transform*
996 Selection auto-transform patterns, see the rxvtperl(3) manpage for
997 details.
998
999 searchable-scrollback: *keysym*
1000 Sets the hotkey that starts the incremental scrollback buffer search
1001 (default: "M-s").
1002
978 urlLauncher: *string* 1003 urlLauncher: *string*
979 Specifies the program to be started with a URL argument. Used by the 1004 Specifies the program to be started with a URL argument. Used by the
980 "selection-popup" and "mark-urls" perl extensions. 1005 "selection-popup" and "mark-urls" perl extensions.
981 1006
982 transient-for: *windowid* 1007 transient-for: *windowid*
983 Sets the WM_TRANSIENT_FOR property to the given window iw. 1008 Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
1009 window id.
1010
1011 override-redirect: *boolean*
1012 Compile *frills*: Sets override-redirect for the terminal window,
1013 making it almost invisible to window managers; option
1014 -override-redirect.
984 1015
985THE SCROLLBAR 1016THE SCROLLBAR
986 Lines of text that scroll off the top of the rxvt window (resource: 1017 Lines of text that scroll off the top of the rxvt window (resource:
987 saveLines) and can be scrolled back using the scrollbar or by 1018 saveLines) and can be scrolled back using the scrollbar or by
988 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1019 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
1020 normal one. In this mode, every selected row becomes its own line in 1051 normal one. In this mode, every selected row becomes its own line in
1021 the selection, and trailing whitespace is visually underlined and 1052 the selection, and trailing whitespace is visually underlined and
1022 removed from the selection. 1053 removed from the selection.
1023 1054
1024 Insertion: 1055 Insertion:
1025 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1056 Pressing and releasing the Middle mouse button in an rxvt window
1026 an rxvt window causes the current text selection to be inserted as 1057 causes the value of the PRIMARY selection (or CLIPBOARD with the
1027 if it had been typed on the keyboard. 1058 Meta modifier) to be inserted as if it had been typed on the
1059 keyboard.
1060
1061 Pressing Shift-Insert causes the value of the PRIMARY selection to
1062 be inserted too.
1028 1063
1029CHANGING FONTS 1064CHANGING FONTS
1030 Changing fonts (or font sizes, respectively) via the keypad is not yet 1065 Changing fonts (or font sizes, respectively) via the keypad is not yet
1031 supported in rxvt-unicode. Bug me if you need this. 1066 supported in rxvt-unicode. Bug me if you need this.
1032 1067
1033 You can, however, switch fonts at runtime using escape sequences (and 1068 You can, however, switch fonts at runtime using escape sequences, e.g.:
1034 therefore using the menubar), e.g.:
1035 1069
1036 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1070 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1071
1072 You can use keyboard shortcuts, too:
1073
1074 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1075 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1037 1076
1038 rxvt-unicode will automatically re-apply these fonts to the output so 1077 rxvt-unicode will automatically re-apply these fonts to the output so
1039 far. 1078 far.
1040 1079
1041ISO 14755 SUPPORT 1080ISO 14755 SUPPORT
1177 display in it's child processes. 1216 display in it's child processes.
1178 1217
1179 SHELL 1218 SHELL
1180 The shell to be used for command execution, defaults to "/bin/sh". 1219 The shell to be used for command execution, defaults to "/bin/sh".
1181 1220
1182 RXVTPATH
1183 The path where rxvt looks for support files such as menu and xpm
1184 files.
1185
1186 PATH
1187 Used in the same way as "RXVTPATH".
1188
1189 RXVT_SOCKET 1221 RXVT_SOCKET
1190 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1222 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1191 1223
1192 Default $HOME/.rxvt-unicode-*<nodename*. 1224 Default $HOME/.rxvt-unicode-*<nodename*.
1193 1225
1234 1266
1235 Oezguer Kesim <kesim@math.fu-berlin.de> 1267 Oezguer Kesim <kesim@math.fu-berlin.de>
1236 Project Coordinator (changes.txt 2.21a to 2.4.5) 1268 Project Coordinator (changes.txt 2.21a to 2.4.5)
1237 1269
1238 Geoff Wing <gcw@pobox.com> 1270 Geoff Wing <gcw@pobox.com>
1239 Rewrote screen display and text selection routines. Project 1271 Rewrote screen display and text selection routines.
1272
1240 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1273 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1241 1274
1242 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1275 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1243 Forked rxvt-unicode, rewrote most of the display code and internal 1276 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1244 character handling to store text in unicode, improve xterm 1277 perl extension, random hacks, numerous bugfixes and extensions.
1245 compatibility and apply numerous other bugfixes and extensions.
1246 1278
1247 Project Coordinator (Changes 1.0 -) 1279 Project Coordinator (Changes 1.0 -)
1248 1280
1281 Emanuele Giaquinta <e.giaquinta@glauco.it>
1282 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1283

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines