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.42 by root, Wed Jan 11 23:08:54 2006 UTC vs.
Revision 1.49 by root, Fri Jan 20 16:02:20 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
982 searchable-scrollback: *keysym*
983 Sets the hotkey that starts the incremental scrollback buffer search
984 (default: "M-s").
985
978 urlLauncher: *string* 986 urlLauncher: *string*
979 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
980 "selection-popup" and "mark-urls" perl extensions. 988 "selection-popup" and "mark-urls" perl extensions.
981 989
982 transient-for: *windowid* 990 transient-for: *windowid*
983 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.
984 998
985THE SCROLLBAR 999THE SCROLLBAR
986 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:
987 saveLines) and can be scrolled back using the scrollbar or by 1001 saveLines) and can be scrolled back using the scrollbar or by
988 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 1002 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
1028 1042
1029CHANGING FONTS 1043CHANGING FONTS
1030 Changing fonts (or font sizes, respectively) via the keypad is not yet 1044 Changing fonts (or font sizes, respectively) via the keypad is not yet
1031 supported in rxvt-unicode. Bug me if you need this. 1045 supported in rxvt-unicode. Bug me if you need this.
1032 1046
1033 You can, however, switch fonts at runtime using escape sequences (and 1047 You can, however, switch fonts at runtime using escape sequences, e.g.:
1034 therefore using the menubar), e.g.:
1035 1048
1036 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1049 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1050
1051 You can use keyboard shortcuts, too:
1052
1053 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1054 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1037 1055
1038 rxvt-unicode will automatically re-apply these fonts to the output so 1056 rxvt-unicode will automatically re-apply these fonts to the output so
1039 far. 1057 far.
1040 1058
1041ISO 14755 SUPPORT 1059ISO 14755 SUPPORT
1177 display in it's child processes. 1195 display in it's child processes.
1178 1196
1179 SHELL 1197 SHELL
1180 The shell to be used for command execution, defaults to "/bin/sh". 1198 The shell to be used for command execution, defaults to "/bin/sh".
1181 1199
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 1200 RXVT_SOCKET
1190 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1201 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1191 1202
1192 Default $HOME/.rxvt-unicode-*<nodename*. 1203 Default $HOME/.rxvt-unicode-*<nodename*.
1193 1204
1234 1245
1235 Oezguer Kesim <kesim@math.fu-berlin.de> 1246 Oezguer Kesim <kesim@math.fu-berlin.de>
1236 Project Coordinator (changes.txt 2.21a to 2.4.5) 1247 Project Coordinator (changes.txt 2.21a to 2.4.5)
1237 1248
1238 Geoff Wing <gcw@pobox.com> 1249 Geoff Wing <gcw@pobox.com>
1239 Rewrote screen display and text selection routines. Project 1250 Rewrote screen display and text selection routines.
1251
1240 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1252 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1241 1253
1242 Marc Alexander Lehmann <rxvt-unicode@schmorp.de> 1254 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1243 Forked rxvt-unicode, rewrote most of the display code and internal 1255 Forked rxvt-unicode, unicode support, rewrote almost all the code,
1244 character handling to store text in unicode, improve xterm 1256 perl extension, random hacks, numerous bugfixes and extensions.
1245 compatibility and apply numerous other bugfixes and extensions.
1246 1257
1247 Project Coordinator (Changes 1.0 -) 1258 Project Coordinator (Changes 1.0 -)
1248 1259
1260 Emanuele Giaquinta <e.giaquinta@glauco.it>
1261 Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1262

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines