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.23 by root, Thu Jul 7 19:37:47 2005 UTC vs.
Revision 1.36 by root, Wed Jan 4 21:37:55 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 5.6, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 6.3, 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
… …
93 Turn on/off simulated reverse video; resource reverseVideo. 93 Turn on/off simulated reverse video; resource reverseVideo.
94 94
95 -j|+j 95 -j|+j
96 Turn on/off jump scrolling; resource jumpScroll. 96 Turn on/off jump scrolling; resource jumpScroll.
97 97
98 -ip|+ip 98 -ip|+ip | -tr|+tr
99 Turn on/off inheriting parent window's pixmap. Alternative form is 99 Turn on/off inheriting parent window's pixmap. Alternative form is
100 -tr; resource inheritPixmap. 100 -tr; resource inheritPixmap.
101 101
102 -fade *number* 102 -fade *number*
103 Fade the text by the given percentage when focus is lost. resource 103 Fade the text by the given percentage when focus is lost. Small
104 fading. 104 values fade a little only, 100 completely replaces all colours by
105 the fade colour; resource fading.
106
107 -fadecolor *colour*
108 Fade to this colour when fading is used (see -fade). The default
109 colour is black. resource fadeColor.
105 110
106 -tint *colour* 111 -tint *colour*
107 Tint the transparent background pixmap with the given colour when 112 Tint the transparent background pixmap with the given colour when
108 transparency is enabled with -tr or -ip. See also the -sh option 113 transparency is enabled with -tr or -ip. This only works for
114 non-tiled backgrounds, currently. See also the -sh option that can
109 that can be used to brighten or darken the image in addition to 115 be used to brighten or darken the image in addition to tinting it;
110 tinting it. 116 resource *tintColor*. Example:
117
118 rxvt -tr -tint blue -sh 40
111 119
112 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent 120 -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent
113 background image in addition to tinting it (i.e. -tint must be 121 background image in addition to tinting it (i.e. -tint must be
114 specified, too, e.g. "-tint white"). 122 specified, too, e.g. "-tint white").
115 123
… …
155 163
156 See also the question "How does rxvt-unicode choose fonts?" in the 164 See also the question "How does rxvt-unicode choose fonts?" in the
157 FAQ section of rxvt(7). 165 FAQ section of rxvt(7).
158 166
159 -fb *fontlist* 167 -fb *fontlist*
160 Compile font-styles: The bold font list to use when bold characters 168 Compile *font-styles*: The bold font list to use when bold
161 are to be printed. See resource boldFont for details. 169 characters are to be printed. See resource boldFont for details.
162 170
163 -fi *fontlist* 171 -fi *fontlist*
164 Compile font-styles: The italic font list to use when bold 172 Compile *font-styles*: The italic font list to use when *italic*
165 characters are to be printed. See resource italicFont for details. 173 characters are to be printed. See resource italicFont for details.
166 174
167 -fbi *fontlist* 175 -fbi *fontlist*
168 Compile font-styles: The bold italic font list to use when bold 176 Compile *font-styles*: The bold italic font list to use when *bold
169 characters are to be printed. See resource boldItalicFont for 177 italic* characters are to be printed. See resource boldItalicFont
178 for details.
179
180 -is|+is
181 Compile *font-styles*: Bold/Italic font styles imply high intensity
182 foreground/background (default). See resource intensityStyles for
170 details. 183 details.
171 184
172 -name *name* 185 -name *name*
173 Specify the application name under which resources are to be 186 Specify the application name under which resources are to be
174 obtained, rather than the default executable file name. Name should 187 obtained, rather than the default executable file name. Name should
… …
238 externalBorder. 251 externalBorder.
239 252
240 -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.
241 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
242 decorations; resource borderLess. 255 decorations; resource borderLess.
256
257 -sbg
258 Compile *frills*: Disable the usage of the built-in block
259 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
261 block graphic glyphs; resource skipBuiltinGlyphs.
243 262
244 -lsp *number* 263 -lsp *number*
245 Compile *frills*: Lines (pixel height) to insert between each row of 264 Compile *frills*: Lines (pixel height) to insert between each row of
246 the display. Useful to work around font rendering problems; resource 265 the display. Useful to work around font rendering problems; resource
247 linespace. 266 linespace.
… …
259 on the command line. If this option is used, it must be the last on 278 on the command line. If this option is used, it must be the last on
260 the command-line. If there is no -e option then the default is to 279 the command-line. If there is no -e option then the default is to
261 run the program specified by the SHELL environment variable or, 280 run the program specified by the SHELL environment variable or,
262 failing that, *sh(1)*. 281 failing that, *sh(1)*.
263 282
283 Please note that you must specify a program with arguments. If you
284 want to run shell commands, you have to specify the shell, like
285 this:
286
287 rxvt -e sh -c "shell commands"
288
264 -title *text* 289 -title *text*
265 Window title (-T still respected); the default title is the basename 290 Window title (-T still respected); the default title is the basename
266 of the program specified after the -e option, if any, otherwise the 291 of the program specified after the -e option, if any, otherwise the
267 application name; resource title. 292 application name; resource title.
268 293
… …
311 336
312 -ssr|+ssr 337 -ssr|+ssr
313 Turn on/off secondary screen scroll (default enabled); resource 338 Turn on/off secondary screen scroll (default enabled); resource
314 secondaryScroll. 339 secondaryScroll.
315 340
341 -hold|+hold
342 Turn on/off hold window after exit support. If enabled, rxvt will
343 not immediately destroy its window when the program executed within
344 it exits. Instead, it will wait till it is being killed or closed by
345 the user; resource hold.
346
316 -keysym.*sym* *string* 347 -keysym.*sym* *string*
317 Remap a key symbol. See resource keysym. 348 Remap a key symbol. See resource keysym.
318 349
319 -embed *windowid* 350 -embed *windowid*
320 Tells rxvt to embed it's windows into an already-existing window, 351 Tells rxvt to embed it's windows into an already-existing window,
… …
364 close $pty; 395 close $pty;
365 396
366 # now communicate with rxvt 397 # now communicate with rxvt
367 my $slave = $pty->slave; 398 my $slave = $pty->slave;
368 while (<$slave>) { print $slave "got <$_>\n" } 399 while (<$slave>) { print $slave "got <$_>\n" }
400
401 -pe *string*
402 Colon-separated list of perl extension scripts to use in this
403 terminal instance. See resource perl-ext.
369 404
370RESOURCES (available also as long-options) 405RESOURCES (available also as long-options)
371 Note: `rxvt --help' gives a list of all resources (long options) 406 Note: `rxvt --help' gives a list of all resources (long options)
372 compiled into your version. 407 compiled into your version.
373 408
… …
467 True: make the background inherit the parent windows' pixmap, giving 502 True: make the background inherit the parent windows' pixmap, giving
468 artificial transparency. False: do not inherit the parent windows' 503 artificial transparency. False: do not inherit the parent windows'
469 pixmap. 504 pixmap.
470 505
471 fading: *number* 506 fading: *number*
472 Fade the text by the given percentage when focus is lost. 507 Fade the text by the given percentage when focus is lost; option
508 -fade.
509
510 fadeColor: *colour*
511 Fade to this colour, when fading is used (see fading:). The default
512 colour is black; option -fadecolor.
473 513
474 tintColor: *colour* 514 tintColor: *colour*
475 Tint the transparent background pixmap with the given colour. 515 Tint the transparent background pixmap with the given colour; option
516 -tint.
476 517
477 shading: *number* 518 shading: *number*
478 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 519 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
479 image in addition to tinting it. 520 image in addition to tinting it.
480 521
… …
514 font: *fontlist* 555 font: *fontlist*
515 Select the fonts to be used. This is a comma separated list of font 556 Select the fonts to be used. This is a comma separated list of font
516 names that are used in turn when trying to display Unicode 557 names that are used in turn when trying to display Unicode
517 characters. The first font defines the cell size for characters; 558 characters. The first font defines the cell size for characters;
518 other fonts might be smaller, but not larger. A reasonable default 559 other fonts might be smaller, but not larger. A reasonable default
519 font list is always appended to it. option -fn. 560 font list is always appended to it; option -fn.
520 561
521 Each font can either be a standard X11 core font (XLFD) name, with 562 Each font can either be a standard X11 core font (XLFD) name, with
522 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 563 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
523 "xft:". 564 "xft:".
524 565
… …
570 tried. 611 tried.
571 612
572 If set, but empty, then this specific style is disabled and the 613 If set, but empty, then this specific style is disabled and the
573 normal text font will being used for the given style. 614 normal text font will being used for the given style.
574 615
616 intensityStyles: *boolean*
617 When font styles are not enabled, or this option is enabled (True,
618 option -is, the default), bold and italic font styles imply high
619 intensity foreground/backround colours. Disabling this option
620 (False, option +is) disables this behaviour, the high intensity
621 colours are not reachable.
622
575 selectstyle: *mode* 623 selectstyle: *mode*
576 Set mouse selection style to old which is 2.20, oldword which is 624 Set mouse selection style to old which is 2.20, oldword which is
577 xterm style with 2.20 old word selection, or anything else which 625 xterm style with 2.20 old word selection, or anything else which
578 gives xterm style selection. 626 gives xterm style selection.
579 627
… …
669 borderLess: *boolean* 717 borderLess: *boolean*
670 Set MWM hints to request a borderless window, i.e. if honoured by 718 Set MWM hints to request a borderless window, i.e. if honoured by
671 the WM, the rxvt-unicode window will not have window decorations; 719 the WM, the rxvt-unicode window will not have window decorations;
672 option -bl. 720 option -bl.
673 721
722 skipBuiltinGlyphs: *boolean*
723 Compile *frills*: Disable the usage of the built-in block
724 graphics/line drawing characters and just rely on what the specified
725 fonts provide. Use this if you have a good font and want to use its
726 block graphic glyphs; option -sbg.
727
674 termName: *termname* 728 termName: *termname*
675 Specifies the terminal type name to be set in the TERM environment 729 Specifies the terminal type name to be set in the TERM environment
676 variable; option -tn. 730 variable; option -tn.
677 731
678 linespace: *number* 732 linespace: *number*
… …
736 790
737 imLocale: *name* 791 imLocale: *name*
738 The locale to use for opening the IM. You can use an "LC_CTYPE" of 792 The locale to use for opening the IM. You can use an "LC_CTYPE" of
739 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for 793 e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for
740 the input extension to be able to input japanese characters while 794 the input extension to be able to input japanese characters while
741 staying in another locale. option -imlocale. 795 staying in another locale; option -imlocale.
742 796
743 imFont: *fontset* 797 imFont: *fontset*
744 Specify the font-set used for XIM styles "OverTheSpot" or 798 Specify the font-set used for XIM styles "OverTheSpot" or
745 "OffTheSpot". It must be a standard X font set (XLFD patterns 799 "OffTheSpot". It must be a standard X font set (XLFD patterns
746 separated by commas), i.e. it's not in the same format as the other 800 separated by commas), i.e. it's not in the same format as the other
… …
749 to the base font. option -imfont. 803 to the base font. option -imfont.
750 804
751 tripleclickwords: *boolean* 805 tripleclickwords: *boolean*
752 Change the meaning of triple-click selection with the left mouse 806 Change the meaning of triple-click selection with the left mouse
753 button. Instead of selecting a full line it will extend the 807 button. Instead of selecting a full line it will extend the
754 selection to the end of the logical line only. option -tcw. 808 selection to the end of the logical line only; option -tcw.
755 809
756 insecure: *boolean* 810 insecure: *boolean*
757 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 811 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
758 that echo arbitrary strings like the icon name or the locale. This 812 that echo arbitrary strings like the icon name or the locale. This
759 could be abused if somebody gets 8-bit-clean access to your display, 813 could be abused if somebody gets 8-bit-clean access to your display,
760 whether throuh a mail client displaying mail bodies unfiltered or 814 whether through a mail client displaying mail bodies unfiltered or
761 though write(1). Therefore, these sequences are disabled by default. 815 through write(1) or any other means. Therefore, these sequences are
762 (Note that other terminals, including xterm, have these sequences 816 disabled by default. (Note that many other terminals, including
763 enabled by default). You can enable them by setting this boolean 817 xterm, have these sequences enabled by default, which doesn't make
764 resource or specifying -insecure as an option. At the moment, this 818 it safer, though).
765 enabled display-answer, locale, findfont, icon label and window 819
766 title requests as well as dynamic menubar dispatch. 820 You can enable them by setting this boolean resource or specifying
821 -insecure as an option. At the moment, this enables display-answer,
822 locale, findfont, icon label and window title requests as well as
823 dynamic menubar dispatch.
767 824
768 modifier: *modifier* 825 modifier: *modifier*
769 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 826 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
770 super, mod1, mod2, mod3, mod4, mod5; option -mod. 827 super, mod1, mod2, mod3, mod4, mod5; option -mod.
771 828
… …
780 secondaryScroll: *bool* 837 secondaryScroll: *bool*
781 Turn on/off secondary screen scroll (default enabled). If the this 838 Turn on/off secondary screen scroll (default enabled). If the this
782 option is enabled, scrolls on the secondary screen will change the 839 option is enabled, scrolls on the secondary screen will change the
783 scrollback buffer and switching to/from the secondary screen will 840 scrollback buffer and switching to/from the secondary screen will
784 instead scroll the screen up. 841 instead scroll the screen up.
842
843 hold: *bool*
844 Turn on/off hold window after exit support. If enabled, rxvt will
845 not immediately destroy its window when the program executed within
846 it exits. Instead, it will wait till it is being killed or closed by
847 the user.
785 848
786 keysym.*sym*: *string* 849 keysym.*sym*: *string*
787 Compile *frills*: Associate *string* with keysym *sym*. The 850 Compile *frills*: Associate *string* with keysym *sym*. The
788 intervening resource name keysym. cannot be omitted. 851 intervening resource name keysym. cannot be omitted.
789 852
… …
834 the following means "change the current locale to "zh_CN.GBK" when 897 the following means "change the current locale to "zh_CN.GBK" when
835 Control-Meta-c is being pressed": 898 Control-Meta-c is being pressed":
836 899
837 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 900 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
838 901
902 If *string* takes the form "perl:STRING", then the specified STRING
903 is passed to the "on_keyboard_command" perl handler. See the
904 rxvtperl(3) manpage. For example, the selection extension (activated
905 via "rxvt -pe selection") listens for "selection:rot13" events:
906
907 URxvt.keysym.M-C-c: perl:selection:rot13
908
839 Due the the large number of modifier combinations, a defined key 909 Due the the large number of modifier combinations, a defined key
840 mapping will match if at *at least* the specified identifiers are 910 mapping will match if at *at least* the specified identifiers are
841 being set, and no other key mappings with those and more bits are 911 being set, and no other key mappings with those and more bits are
842 being defined. That means that defining a key map for "a" will 912 being defined. That means that defining a key map for "a" will
843 automatically provide definitions for "Meta-a", "Shift-a" and so on, 913 automatically provide definitions for "Meta-a", "Shift-a" and so on,
… …
866 info): 936 info):
867 937
868 URxvt.keysym.M-C-3: command:\033[8;25;80t 938 URxvt.keysym.M-C-3: command:\033[8;25;80t
869 URxvt.keysym.M-C-4: command:\033[8;48;110t 939 URxvt.keysym.M-C-4: command:\033[8;48;110t
870 940
941 perl-ext-common: *string*
942 perl-ext: *string*
943 Colon-separated list(s) of perl extension scripts to use in this
944 terminal instance. Each extension is looked up in the library
945 directories, loaded if necessary, and bound to the current terminal
946 instance. If this resource is empty or missing, then the perl
947 interpreter will not be initialized. The idea behind two options is
948 that perl-ext-common will be used for extensions that should be
949 available to all instances, while perl-ext is used for specific
950 instances; option -pe.
951
952 perl-eval: *string*
953 Perl code to be evaluated when all extensions have been registered.
954 See the rxvtperl(3) manpage.
955
956 perl-lib: *path*
957 Colon-separated list of additional directories that hold extension
958 scripts. When looking for extensions specified by the "perl"
959 resource, rxvt will first look in these directories and then in
960 /opt/rxvt/lib/urxvt/perl/.
961
962 See the rxvtperl(3) manpage.
963
871THE SCROLLBAR 964THE SCROLLBAR
872 Lines of text that scroll off the top of the rxvt window (resource: 965 Lines of text that scroll off the top of the rxvt window (resource:
873 saveLines) and can be scrolled back using the scrollbar or by 966 saveLines) and can be scrolled back using the scrollbar or by
874 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 967 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
875 fairly intuitive. The xterm-scrollbar is without arrows and its 968 fairly intuitive. The xterm-scrollbar is without arrows and its
… …
901 entire logical line (which can span multiple screen lines), unless 994 entire logical line (which can span multiple screen lines), unless
902 modified by resource tripleclickwords. 995 modified by resource tripleclickwords.
903 996
904 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 997 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
905 (Compile: *frills*) will create a rectangular selection instead of a 998 (Compile: *frills*) will create a rectangular selection instead of a
906 normal one. 999 normal one. In this mode, every selected row becomes its own line in
1000 the selection, and trailing whitespace is visually underlined and
1001 removed from the selection.
907 1002
908 Insertion: 1003 Insertion:
909 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1004 Pressing and releasing the Middle mouse button (or Shift-Insert) in
910 an rxvt window causes the current text selection to be inserted as 1005 an rxvt window causes the current text selection to be inserted as
911 if it had been typed on the keyboard. 1006 if it had been typed on the keyboard.
… …
915 supported in rxvt-unicode. Bug me if you need this. 1010 supported in rxvt-unicode. Bug me if you need this.
916 1011
917 You can, however, switch fonts at runtime using escape sequences (and 1012 You can, however, switch fonts at runtime using escape sequences (and
918 therefore using the menubar), e.g.: 1013 therefore using the menubar), e.g.:
919 1014
920 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1015 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
921 1016
922 rxvt-unicode will automatically re-apply these fonts to the output so 1017 rxvt-unicode will automatically re-apply these fonts to the output so
923 far. 1018 far.
924 1019
925ISO 14755 SUPPORT 1020ISO 14755 SUPPORT
… …
1093 1188
1094SEE ALSO 1189SEE ALSO
1095 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), 1190 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1096 tty(4), utmp(5) 1191 tty(4), utmp(5)
1097 1192
1098BUGS
1099 Check the BUGS file for an up-to-date list.
1100
1101 Cursor change support is not yet implemented.
1102
1103 Click-and-drag doesn't work with X11 mouse report overriding.
1104
1105CURRENT PROJECT COORDINATOR 1193CURRENT PROJECT COORDINATOR
1106 Project Coordinator 1194 Project Coordinator
1107 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1195 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1108 1196
1109 <http://software.schmorp.de/#rxvt-unicode> 1197 <http://software.schmorp.de/#rxvt-unicode>

Diff Legend

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