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.43 by root, Thu Jan 12 05:37:34 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 7.0, 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
536 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
537 specifies an integer number of images in that direction. No image 541 specifies an integer number of images in that direction. No image
538 will be magnified beyond 10 times its original size. The maximum 542 will be magnified beyond 10 times its original size. The maximum
539 permitted scale is 1000. [default 0x0+50+50] 543 permitted scale is 1000. [default 0x0+50+50]
540 544
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* 545 path: *path*
548 Specify the colon-delimited search path for finding files (XPM and 546 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 547
552 font: *fontlist* 548 font: *fontlist*
553 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
554 names that are used in turn when trying to display Unicode 550 names that are checked in order when trying to find glyphs for
555 characters. The first font defines the cell size for characters; 551 characters. The first font defines the cell size for characters;
556 other fonts might be smaller, but not larger. A reasonable default 552 other fonts might be smaller, but not (in general) larger. A
557 font list is always appended to it; option -fn. 553 (hopefully) reasonable default font list is always appended to it;
554 option -fn.
558 555
559 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
560 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 557 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
561 "xft:". 558 "xft:".
562 559
565 available hint currently is "codeset=codeset-name", and this is only 562 available hint currently is "codeset=codeset-name", and this is only
566 used for Xft fonts. 563 used for Xft fonts.
567 564
568 For example, this font resource 565 For example, this font resource
569 566
570 URxvt*font: 9x15bold,\ 567 URxvt.font: 9x15bold,\
571 -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,\
572 -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, \
573 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 570 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
574 xft:Code2000:antialias=false 571 xft:Code2000:antialias=false
575 572
661 658
662 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.
663 660
664 Example: 661 Example:
665 662
666 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 663 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
667 664
668 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
669 contents everytime you hit "Print". 666 contents everytime you hit "Print".
670 667
671 scrollBar: *boolean* 668 scrollBar: *boolean*
814 xterm, have these sequences enabled by default, which doesn't make 811 xterm, have these sequences enabled by default, which doesn't make
815 it safer, though). 812 it safer, though).
816 813
817 You can enable them by setting this boolean resource or specifying 814 You can enable them by setting this boolean resource or specifying
818 -insecure as an option. At the moment, this enables display-answer, 815 -insecure as an option. At the moment, this enables display-answer,
819 locale, findfont, icon label and window title requests as well as 816 locale, findfont, icon label and window title requests.
820 dynamic menubar dispatch.
821 817
822 modifier: *modifier* 818 modifier: *modifier*
823 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,
824 super, mod1, mod2, mod3, mod4, mod5; option -mod. 820 super, mod1, mod2, mod3, mod4, mod5; option -mod.
825 821
826 answerbackString: *string* 822 answerbackString: *string*
827 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
828 (control-E) character is passed through. It may contain escape 824 (control-E) character is passed through. It may contain escape
829 values as described in the entry on keysym following. 825 values as described in the entry on keysym following.
830 826
831 secondaryScreen: *bool* 827 secondaryScreen: *boolean*
832 Turn on/off secondary screen (default enabled). 828 Turn on/off secondary screen (default enabled).
833 829
834 secondaryScroll: *bool* 830 secondaryScroll: *boolean*
835 Turn on/off secondary screen scroll (default enabled). If the this 831 Turn on/off secondary screen scroll (default enabled). If the this
836 option is enabled, scrolls on the secondary screen will change the 832 option is enabled, scrolls on the secondary screen will change the
837 scrollback buffer and switching to/from the secondary screen will 833 scrollback buffer and switching to/from the secondary screen will
838 instead scroll the screen up. 834 instead scroll the screen up.
839 835
840 hold: *bool* 836 hold: *boolean*
841 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
842 not immediately destroy its window when the program executed within 838 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 839 it exits. Instead, it will wait till it is being killed or closed by
844 the user. 840 the user.
845 841
973 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource 969 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
974 will be ignored when running setuid/setgid. 970 will be ignored when running setuid/setgid.
975 971
976 See the rxvtperl(3) manpage. 972 See the rxvtperl(3) manpage.
977 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
978 searchable-scrollback: *keysym* 982 searchable-scrollback: *keysym*
979 Sets the hotkey that starts the incremental scrollback buffer search 983 Sets the hotkey that starts the incremental scrollback buffer search
980 (default: "M-s"). 984 (default: "M-s").
981 985
982 urlLauncher: *string* 986 urlLauncher: *string*
983 Specifies the program to be started with a URL argument. Used by the 987 Specifies the program to be started with a URL argument. Used by the
984 "selection-popup" and "mark-urls" perl extensions. 988 "selection-popup" and "mark-urls" perl extensions.
985 989
986 transient-for: *windowid* 990 transient-for: *windowid*
987 Sets the WM_TRANSIENT_FOR property to the given window iw. 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.
988 998
989THE SCROLLBAR 999THE SCROLLBAR
990 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:
991 saveLines) and can be scrolled back using the scrollbar or by 1001 saveLines) and can be scrolled back using the scrollbar or by
992 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1002 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
1024 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
1025 the selection, and trailing whitespace is visually underlined and 1035 the selection, and trailing whitespace is visually underlined and
1026 removed from the selection. 1036 removed from the selection.
1027 1037
1028 Insertion: 1038 Insertion:
1029 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1039 Pressing and releasing the Middle mouse button in an rxvt window
1030 an rxvt window causes the current text selection to be inserted as 1040 causes the value of the PRIMARY selection (Shift for CLIPBOARD) to
1031 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.
1032 1043
1033CHANGING FONTS 1044CHANGING FONTS
1034 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
1035 supported in rxvt-unicode. Bug me if you need this. 1046 supported in rxvt-unicode. Bug me if you need this.
1036 1047
1037 You can, however, switch fonts at runtime using escape sequences (and 1048 You can, however, switch fonts at runtime using escape sequences, e.g.:
1038 therefore using the menubar), e.g.:
1039 1049
1040 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
1041 1056
1042 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
1043 far. 1058 far.
1044 1059
1045ISO 14755 SUPPORT 1060ISO 14755 SUPPORT
1181 display in it's child processes. 1196 display in it's child processes.
1182 1197
1183 SHELL 1198 SHELL
1184 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".
1185 1200
1186 RXVTPATH
1187 The path where rxvt looks for support files such as menu and xpm
1188 files.
1189
1190 PATH
1191 Used in the same way as "RXVTPATH".
1192
1193 RXVT_SOCKET 1201 RXVT_SOCKET
1194 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).
1195 1203
1196 Default $HOME/.rxvt-unicode-*<nodename*. 1204 Default $HOME/.rxvt-unicode-*<nodename*.
1197 1205
1238 1246
1239 Oezguer Kesim <kesim@math.fu-berlin.de> 1247 Oezguer Kesim <kesim@math.fu-berlin.de>
1240 Project Coordinator (changes.txt 2.21a to 2.4.5) 1248 Project Coordinator (changes.txt 2.21a to 2.4.5)
1241 1249
1242 Geoff Wing <gcw@pobox.com> 1250 Geoff Wing <gcw@pobox.com>
1243 Rewrote screen display and text selection routines. Project 1251 Rewrote screen display and text selection routines.
1252
1244 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1253 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1245 1254
1246 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1255 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1247 Forked rxvt-unicode, rewrote most of the display code and internal 1256 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1248 character handling to store text in unicode, improve xterm 1257 perl extension, random hacks, numerous bugfixes and extensions.
1249 compatibility and apply numerous other bugfixes and extensions.
1250 1258
1251 Project Coordinator (Changes 1.0 -) 1259 Project Coordinator (Changes 1.0 -)
1252 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