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.23 by root, Thu Jul 7 19:37:47 2005 UTC vs.
Revision 1.32 by root, Mon Jan 2 21:41:51 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.2, 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
… …
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 characters are to be printed. See resource boldItalicFont for
178 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
… …
259 on the command line. If this option is used, it must be the last on 272 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 273 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, 274 run the program specified by the SHELL environment variable or,
262 failing that, *sh(1)*. 275 failing that, *sh(1)*.
263 276
277 Please note that you must specify a program with arguments. If you
278 want to run shell commands, you have to specify the shell, like
279 this:
280
281 rxvt -e sh -c "shell commands"
282
264 -title *text* 283 -title *text*
265 Window title (-T still respected); the default title is the basename 284 Window title (-T still respected); the default title is the basename
266 of the program specified after the -e option, if any, otherwise the 285 of the program specified after the -e option, if any, otherwise the
267 application name; resource title. 286 application name; resource title.
268 287
… …
311 330
312 -ssr|+ssr 331 -ssr|+ssr
313 Turn on/off secondary screen scroll (default enabled); resource 332 Turn on/off secondary screen scroll (default enabled); resource
314 secondaryScroll. 333 secondaryScroll.
315 334
335 -hold|+hold
336 Turn on/off hold window after exit support. If enabled, rxvt will
337 not immediately destroy its window when the program executed within
338 it exits. Instead, it will wait till it is being killed or closed by
339 the user; resource hold.
340
316 -keysym.*sym* *string* 341 -keysym.*sym* *string*
317 Remap a key symbol. See resource keysym. 342 Remap a key symbol. See resource keysym.
318 343
319 -embed *windowid* 344 -embed *windowid*
320 Tells rxvt to embed it's windows into an already-existing window, 345 Tells rxvt to embed it's windows into an already-existing window,
… …
364 close $pty; 389 close $pty;
365 390
366 # now communicate with rxvt 391 # now communicate with rxvt
367 my $slave = $pty->slave; 392 my $slave = $pty->slave;
368 while (<$slave>) { print $slave "got <$_>\n" } 393 while (<$slave>) { print $slave "got <$_>\n" }
394
395 -pe *string*
396 Colon-separated list of perl extension scripts to use in this
397 terminal instance. See resource perl-ext.
369 398
370RESOURCES (available also as long-options) 399RESOURCES (available also as long-options)
371 Note: `rxvt --help' gives a list of all resources (long options) 400 Note: `rxvt --help' gives a list of all resources (long options)
372 compiled into your version. 401 compiled into your version.
373 402
… …
467 True: make the background inherit the parent windows' pixmap, giving 496 True: make the background inherit the parent windows' pixmap, giving
468 artificial transparency. False: do not inherit the parent windows' 497 artificial transparency. False: do not inherit the parent windows'
469 pixmap. 498 pixmap.
470 499
471 fading: *number* 500 fading: *number*
472 Fade the text by the given percentage when focus is lost. 501 Fade the text by the given percentage when focus is lost; option
502 -fade.
503
504 fadeColor: *colour*
505 Fade to this colour, when fading is used (see fading:). The default
506 colour is black; option -fadecolor.
473 507
474 tintColor: *colour* 508 tintColor: *colour*
475 Tint the transparent background pixmap with the given colour. 509 Tint the transparent background pixmap with the given colour; option
510 -tint.
476 511
477 shading: *number* 512 shading: *number*
478 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 513 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
479 image in addition to tinting it. 514 image in addition to tinting it.
480 515
… …
514 font: *fontlist* 549 font: *fontlist*
515 Select the fonts to be used. This is a comma separated list of font 550 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 551 names that are used in turn when trying to display Unicode
517 characters. The first font defines the cell size for characters; 552 characters. The first font defines the cell size for characters;
518 other fonts might be smaller, but not larger. A reasonable default 553 other fonts might be smaller, but not larger. A reasonable default
519 font list is always appended to it. option -fn. 554 font list is always appended to it; option -fn.
520 555
521 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
522 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with 557 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
523 "xft:". 558 "xft:".
524 559
… …
570 tried. 605 tried.
571 606
572 If set, but empty, then this specific style is disabled and the 607 If set, but empty, then this specific style is disabled and the
573 normal text font will being used for the given style. 608 normal text font will being used for the given style.
574 609
610 intensityStyles: *boolean*
611 When font styles are not enabled, or this option is enabled (True,
612 option -is, the default), bold and italic font styles imply high
613 intensity foreground/backround colours. Disabling this option
614 (False, option +is) disables this behaviour, the high intensity
615 colours are not reachable.
616
575 selectstyle: *mode* 617 selectstyle: *mode*
576 Set mouse selection style to old which is 2.20, oldword which is 618 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 619 xterm style with 2.20 old word selection, or anything else which
578 gives xterm style selection. 620 gives xterm style selection.
579 621
… …
736 778
737 imLocale: *name* 779 imLocale: *name*
738 The locale to use for opening the IM. You can use an "LC_CTYPE" of 780 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 781 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 782 the input extension to be able to input japanese characters while
741 staying in another locale. option -imlocale. 783 staying in another locale; option -imlocale.
742 784
743 imFont: *fontset* 785 imFont: *fontset*
744 Specify the font-set used for XIM styles "OverTheSpot" or 786 Specify the font-set used for XIM styles "OverTheSpot" or
745 "OffTheSpot". It must be a standard X font set (XLFD patterns 787 "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 788 separated by commas), i.e. it's not in the same format as the other
… …
749 to the base font. option -imfont. 791 to the base font. option -imfont.
750 792
751 tripleclickwords: *boolean* 793 tripleclickwords: *boolean*
752 Change the meaning of triple-click selection with the left mouse 794 Change the meaning of triple-click selection with the left mouse
753 button. Instead of selecting a full line it will extend the 795 button. Instead of selecting a full line it will extend the
754 selection to the end of the logical line only. option -tcw. 796 selection to the end of the logical line only; option -tcw.
755 797
756 insecure: *boolean* 798 insecure: *boolean*
757 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 799 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
758 that echo arbitrary strings like the icon name or the locale. This 800 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, 801 could be abused if somebody gets 8-bit-clean access to your display,
760 whether throuh a mail client displaying mail bodies unfiltered or 802 whether through a mail client displaying mail bodies unfiltered or
761 though write(1). Therefore, these sequences are disabled by default. 803 through write(1) or any other means. Therefore, these sequences are
762 (Note that other terminals, including xterm, have these sequences 804 disabled by default. (Note that many other terminals, including
763 enabled by default). You can enable them by setting this boolean 805 xterm, have these sequences enabled by default, which doesn't make
764 resource or specifying -insecure as an option. At the moment, this 806 it safer, though).
765 enabled display-answer, locale, findfont, icon label and window 807
766 title requests as well as dynamic menubar dispatch. 808 You can enable them by setting this boolean resource or specifying
809 -insecure as an option. At the moment, this enables display-answer,
810 locale, findfont, icon label and window title requests as well as
811 dynamic menubar dispatch.
767 812
768 modifier: *modifier* 813 modifier: *modifier*
769 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 814 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
770 super, mod1, mod2, mod3, mod4, mod5; option -mod. 815 super, mod1, mod2, mod3, mod4, mod5; option -mod.
771 816
… …
780 secondaryScroll: *bool* 825 secondaryScroll: *bool*
781 Turn on/off secondary screen scroll (default enabled). If the this 826 Turn on/off secondary screen scroll (default enabled). If the this
782 option is enabled, scrolls on the secondary screen will change the 827 option is enabled, scrolls on the secondary screen will change the
783 scrollback buffer and switching to/from the secondary screen will 828 scrollback buffer and switching to/from the secondary screen will
784 instead scroll the screen up. 829 instead scroll the screen up.
830
831 hold: *bool*
832 Turn on/off hold window after exit support. If enabled, rxvt will
833 not immediately destroy its window when the program executed within
834 it exits. Instead, it will wait till it is being killed or closed by
835 the user.
785 836
786 keysym.*sym*: *string* 837 keysym.*sym*: *string*
787 Compile *frills*: Associate *string* with keysym *sym*. The 838 Compile *frills*: Associate *string* with keysym *sym*. The
788 intervening resource name keysym. cannot be omitted. 839 intervening resource name keysym. cannot be omitted.
789 840
… …
834 the following means "change the current locale to "zh_CN.GBK" when 885 the following means "change the current locale to "zh_CN.GBK" when
835 Control-Meta-c is being pressed": 886 Control-Meta-c is being pressed":
836 887
837 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 888 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
838 889
890 If *string* takes the form "perl:STRING", then the specified STRING
891 is passed to the "on_keyboard_command" perl handler. See the
892 rxvtperl(3) manpage. For example, the selection extension (activated
893 via "rxvt -pe selection") listens for "selection:rot13" events:
894
895 URxvt.keysym.M-C-c: perl:selection:rot13
896
839 Due the the large number of modifier combinations, a defined key 897 Due the the large number of modifier combinations, a defined key
840 mapping will match if at *at least* the specified identifiers are 898 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 899 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 900 being defined. That means that defining a key map for "a" will
843 automatically provide definitions for "Meta-a", "Shift-a" and so on, 901 automatically provide definitions for "Meta-a", "Shift-a" and so on,
… …
866 info): 924 info):
867 925
868 URxvt.keysym.M-C-3: command:\033[8;25;80t 926 URxvt.keysym.M-C-3: command:\033[8;25;80t
869 URxvt.keysym.M-C-4: command:\033[8;48;110t 927 URxvt.keysym.M-C-4: command:\033[8;48;110t
870 928
929 perl-ext: *string*
930 Colon-separated list of perl extension scripts to use in this
931 terminal instance. Each extension is looked up in the library
932 directories, loaded if necessary, and bound to the current terminal
933 instance; option -pe.
934
935 perl-eval: *string*
936 Perl code to be evaluated when all extensions have been registered.
937 See the rxvtperl(3) manpage.
938
939 perl-lib: *path*
940 Colon-separated list of additional directories that hold extension
941 scripts. When looking for extensions specified by the "perl"
942 resource, rxvt will first look in these directories and then in
943 /opt/rxvt/lib/urxvt/perl/.
944
945 See the rxvtperl(3) manpage.
946
871THE SCROLLBAR 947THE SCROLLBAR
872 Lines of text that scroll off the top of the rxvt window (resource: 948 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 949 saveLines) and can be scrolled back using the scrollbar or by
874 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 950 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
875 fairly intuitive. The xterm-scrollbar is without arrows and its 951 fairly intuitive. The xterm-scrollbar is without arrows and its
… …
901 entire logical line (which can span multiple screen lines), unless 977 entire logical line (which can span multiple screen lines), unless
902 modified by resource tripleclickwords. 978 modified by resource tripleclickwords.
903 979
904 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 980 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
905 (Compile: *frills*) will create a rectangular selection instead of a 981 (Compile: *frills*) will create a rectangular selection instead of a
906 normal one. 982 normal one. In this mode, every selected row becomes its own line in
983 the selection, and trailing whitespace is visually underlined and
984 removed from the selection.
907 985
908 Insertion: 986 Insertion:
909 Pressing and releasing the Middle mouse button (or Shift-Insert) in 987 Pressing and releasing the Middle mouse button (or Shift-Insert) in
910 an rxvt window causes the current text selection to be inserted as 988 an rxvt window causes the current text selection to be inserted as
911 if it had been typed on the keyboard. 989 if it had been typed on the keyboard.
… …
915 supported in rxvt-unicode. Bug me if you need this. 993 supported in rxvt-unicode. Bug me if you need this.
916 994
917 You can, however, switch fonts at runtime using escape sequences (and 995 You can, however, switch fonts at runtime using escape sequences (and
918 therefore using the menubar), e.g.: 996 therefore using the menubar), e.g.:
919 997
920 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 998 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
921 999
922 rxvt-unicode will automatically re-apply these fonts to the output so 1000 rxvt-unicode will automatically re-apply these fonts to the output so
923 far. 1001 far.
924 1002
925ISO 14755 SUPPORT 1003ISO 14755 SUPPORT
… …
1093 1171
1094SEE ALSO 1172SEE ALSO
1095 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), 1173 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1096 tty(4), utmp(5) 1174 tty(4), utmp(5)
1097 1175
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 1176CURRENT PROJECT COORDINATOR
1106 Project Coordinator 1177 Project Coordinator
1107 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1178 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1108 1179
1109 <http://software.schmorp.de/#rxvt-unicode> 1180 <http://software.schmorp.de/#rxvt-unicode>

Diff Legend

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