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.20 by root, Sun Apr 17 22:36:13 2005 UTC vs.
Revision 1.33 by root, Tue Jan 3 21:15:22 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.3, 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
… …
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
170 details. 178 details.
171 179
180 -is|+is
181 Compile font-styles: Bold/Italic font styles imply high intensity
182 foreground/background (default). See resource intensityStyles for
183 details.
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
175 not contain `.' or `*' characters. Also sets the icon and title 188 not contain `.' or `*' characters. Also sets the icon and title
176 name. 189 name.
… …
204 217
205 -sr|+sr 218 -sr|+sr
206 Put scrollbar on right/left; resource scrollBar_right. 219 Put scrollbar on right/left; resource scrollBar_right.
207 220
208 -st|+st 221 -st|+st
209 Display normal (non XTerm/NeXT) scrollbar without/with a trough; 222 Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
210 resource scrollBar_floating. 223 resource scrollBar_floating.
211 224
212 -ptab|+ptab 225 -ptab|+ptab
213 If enabled (default), "Horizontal Tab" characters are being stored 226 If enabled (default), "Horizontal Tab" characters are being stored
214 as actual wide characters in the screen buffer, which makes it 227 as actual wide characters in the screen buffer, which makes it
… …
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
481 scrollColor: *colour* 516 scrollColor: *colour*
482 Use the specified colour for the scrollbar [default #B2B2B2]. 517 Use the specified colour for the scrollbar [default #B2B2B2].
483 518
484 troughColor: *colour* 519 troughColor: *colour*
485 Use the specified colour for the scrollbar's trough area [default 520 Use the specified colour for the scrollbar's trough area [default
486 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 521 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
487 522
488 borderColor: *colour* 523 borderColor: *colour*
489 The colour of the border around the text area and between the 524 The colour of the border around the text area and between the
490 scrollbar and the text. 525 scrollbar and the text.
491 526
… …
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
580 scrollstyle: *mode* 622 scrollstyle: *mode*
581 Set scrollbar style to rxvt, plain, next or xterm. plain is the 623 Set scrollbar style to rxvt, plain, next or xterm. plain is the
582 author's favourite.. 624 author's favourite.
583 625
584 title: *string* 626 title: *string*
585 Set window title string, the default title is the command-line 627 Set window title string, the default title is the command-line
586 specified after the -e option, if any, otherwise the application 628 specified after the -e option, if any, otherwise the application
587 name; option -title. 629 name; option -title.
… …
611 653
612 print-pipe: *string* 654 print-pipe: *string*
613 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 655 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use
614 Print to initiate a screen dump to the printer and Ctrl-Print or 656 Print to initiate a screen dump to the printer and Ctrl-Print or
615 Shift-Print to include the scrollback as well. 657 Shift-Print to include the scrollback as well.
658
659 The string will be interpreted as if typed into the shell as-is.
660
661 Example:
662
663 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
664
665 This creates a new file in your home directory with the screen
666 contents everytime you hit "Print".
616 667
617 scrollBar: *boolean* 668 scrollBar: *boolean*
618 True: enable the scrollbar [default]; option -sb. False: disable the 669 True: enable the scrollbar [default]; option -sb. False: disable the
619 scrollbar; option +sb. 670 scrollbar; option +sb.
620 671
… …
727 778
728 imLocale: *name* 779 imLocale: *name*
729 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
730 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
731 the input extension to be able to input japanese characters while 782 the input extension to be able to input japanese characters while
732 staying in another locale. option -imlocale. 783 staying in another locale; option -imlocale.
733 784
734 imFont: *fontset* 785 imFont: *fontset*
735 Specify the font-set used for XIM styles "OverTheSpot" or 786 Specify the font-set used for XIM styles "OverTheSpot" or
736 "OffTheSpot". It must be a standard X font set (XLFD patterns 787 "OffTheSpot". It must be a standard X font set (XLFD patterns
737 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
… …
740 to the base font. option -imfont. 791 to the base font. option -imfont.
741 792
742 tripleclickwords: *boolean* 793 tripleclickwords: *boolean*
743 Change the meaning of triple-click selection with the left mouse 794 Change the meaning of triple-click selection with the left mouse
744 button. Instead of selecting a full line it will extend the 795 button. Instead of selecting a full line it will extend the
745 selection to the end of the logical line only. option -tcw. 796 selection to the end of the logical line only; option -tcw.
746 797
747 insecure: *boolean* 798 insecure: *boolean*
748 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 799 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
749 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
750 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,
751 whether throuh a mail client displaying mail bodies unfiltered or 802 whether through a mail client displaying mail bodies unfiltered or
752 though write(1). Therefore, these sequences are disabled by default. 803 through write(1) or any other means. Therefore, these sequences are
753 (Note that other terminals, including xterm, have these sequences 804 disabled by default. (Note that many other terminals, including
754 enabled by default). You can enable them by setting this boolean 805 xterm, have these sequences enabled by default, which doesn't make
755 resource or specifying -insecure as an option. At the moment, this 806 it safer, though).
756 enabled display-answer, locale, findfont, icon label and window 807
757 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.
758 812
759 modifier: *modifier* 813 modifier: *modifier*
760 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,
761 super, mod1, mod2, mod3, mod4, mod5; option -mod. 815 super, mod1, mod2, mod3, mod4, mod5; option -mod.
762 816
… …
771 secondaryScroll: *bool* 825 secondaryScroll: *bool*
772 Turn on/off secondary screen scroll (default enabled). If the this 826 Turn on/off secondary screen scroll (default enabled). If the this
773 option is enabled, scrolls on the secondary screen will change the 827 option is enabled, scrolls on the secondary screen will change the
774 scrollback buffer and switching to/from the secondary screen will 828 scrollback buffer and switching to/from the secondary screen will
775 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.
776 836
777 keysym.*sym*: *string* 837 keysym.*sym*: *string*
778 Compile *frills*: Associate *string* with keysym *sym*. The 838 Compile *frills*: Associate *string* with keysym *sym*. The
779 intervening resource name keysym. cannot be omitted. 839 intervening resource name keysym. cannot be omitted.
780 840
… …
825 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
826 Control-Meta-c is being pressed": 886 Control-Meta-c is being pressed":
827 887
828 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
829 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
897 Due the the large number of modifier combinations, a defined key
898 mapping will match if at *at least* the specified identifiers are
899 being set, and no other key mappings with those and more bits are
900 being defined. That means that defining a key map for "a" will
901 automatically provide definitions for "Meta-a", "Shift-a" and so on,
902 unless some of those are defined mappings themselves.
903
904 Unfortunately, this will override built-in key mappings. For example
905 if you overwrite the "Insert" key you will disable rxvt's
906 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
907 the user-defined keymap using the "builtin:" replacement:
908
909 URxvt.keysym.Insert: <my insert key sequence>
910 URxvt.keysym.S-Insert: builtin:
911
912 The first line defines a mapping for "Insert" and *any* combination
913 of modifiers. The second line re-establishes the default mapping for
914 "Shift-Insert".
915
830 The following example will map Control-Meta-1 and Control-Meta-2 to 916 The following example will map Control-Meta-1 and Control-Meta-2 to
831 the fonts "suxuseuro" and "9x15bold", so you can have some limited 917 the fonts "suxuseuro" and "9x15bold", so you can have some limited
832 font-switching at runtime: 918 font-switching at runtime:
833 919
834 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 920 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
… …
837 Other things are possible, e.g. resizing (see rxvt(7) for more 923 Other things are possible, e.g. resizing (see rxvt(7) for more
838 info): 924 info):
839 925
840 URxvt.keysym.M-C-3: command:\033[8;25;80t 926 URxvt.keysym.M-C-3: command:\033[8;25;80t
841 URxvt.keysym.M-C-4: command:\033[8;48;110t 927 URxvt.keysym.M-C-4: command:\033[8;48;110t
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. If this resource is empty or missing, then the perl
934 interpreter will not be initialized; option -pe.
935
936 perl-eval: *string*
937 Perl code to be evaluated when all extensions have been registered.
938 See the rxvtperl(3) manpage.
939
940 perl-lib: *path*
941 Colon-separated list of additional directories that hold extension
942 scripts. When looking for extensions specified by the "perl"
943 resource, rxvt will first look in these directories and then in
944 /opt/rxvt/lib/urxvt/perl/.
945
946 See the rxvtperl(3) manpage.
842 947
843THE SCROLLBAR 948THE SCROLLBAR
844 Lines of text that scroll off the top of the rxvt window (resource: 949 Lines of text that scroll off the top of the rxvt window (resource:
845 saveLines) and can be scrolled back using the scrollbar or by 950 saveLines) and can be scrolled back using the scrollbar or by
846 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 951 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
… …
873 entire logical line (which can span multiple screen lines), unless 978 entire logical line (which can span multiple screen lines), unless
874 modified by resource tripleclickwords. 979 modified by resource tripleclickwords.
875 980
876 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 981 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
877 (Compile: *frills*) will create a rectangular selection instead of a 982 (Compile: *frills*) will create a rectangular selection instead of a
878 normal one. 983 normal one. In this mode, every selected row becomes its own line in
984 the selection, and trailing whitespace is visually underlined and
985 removed from the selection.
879 986
880 Insertion: 987 Insertion:
881 Pressing and releasing the Middle mouse button (or Shift-Insert) in 988 Pressing and releasing the Middle mouse button (or Shift-Insert) in
882 an rxvt window causes the current text selection to be inserted as 989 an rxvt window causes the current text selection to be inserted as
883 if it had been typed on the keyboard. 990 if it had been typed on the keyboard.
… …
887 supported in rxvt-unicode. Bug me if you need this. 994 supported in rxvt-unicode. Bug me if you need this.
888 995
889 You can, however, switch fonts at runtime using escape sequences (and 996 You can, however, switch fonts at runtime using escape sequences (and
890 therefore using the menubar), e.g.: 997 therefore using the menubar), e.g.:
891 998
892 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 999 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
893 1000
894 rxvt-unicode will automatically re-apply these fonts to the output so 1001 rxvt-unicode will automatically re-apply these fonts to the output so
895 far. 1002 far.
896 1003
897ISO 14755 SUPPORT 1004ISO 14755 SUPPORT
… …
1043 Used in the same way as "RXVTPATH". 1150 Used in the same way as "RXVTPATH".
1044 1151
1045 RXVT_SOCKET 1152 RXVT_SOCKET
1046 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1153 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1047 1154
1048 Default "$HOME/.rxvt-unicode-<nodename". 1155 Default $HOME/.rxvt-unicode-*<nodename*.
1049 1156
1050 HOME 1157 HOME
1051 Used to locate the default directory for the unix domain socket for 1158 Used to locate the default directory for the unix domain socket for
1052 daemon communications and to locate various resource files (such as 1159 daemon communications and to locate various resource files (such as
1053 ".Xdefaults") 1160 ".Xdefaults")
… …
1062FILES 1169FILES
1063 /usr/lib/X11/rgb.txt 1170 /usr/lib/X11/rgb.txt
1064 Color names. 1171 Color names.
1065 1172
1066SEE ALSO 1173SEE ALSO
1067 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1174 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1068 1175 tty(4), utmp(5)
1069BUGS
1070 Check the BUGS file for an up-to-date list.
1071
1072 Cursor change support is not yet implemented.
1073
1074 Click-and-drag doesn't work with X11 mouse report overriding.
1075 1176
1076CURRENT PROJECT COORDINATOR 1177CURRENT PROJECT COORDINATOR
1077 Project Coordinator 1178 Project Coordinator
1078 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1179 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1079 1180

Diff Legend

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