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.30 by root, Mon Jan 2 19:36:07 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 -perl *string*
396 Used by perl extension. See resource perl.
369 397
370RESOURCES (available also as long-options) 398RESOURCES (available also as long-options)
371 Note: `rxvt --help' gives a list of all resources (long options) 399 Note: `rxvt --help' gives a list of all resources (long options)
372 compiled into your version. 400 compiled into your version.
373 401
… …
467 True: make the background inherit the parent windows' pixmap, giving 495 True: make the background inherit the parent windows' pixmap, giving
468 artificial transparency. False: do not inherit the parent windows' 496 artificial transparency. False: do not inherit the parent windows'
469 pixmap. 497 pixmap.
470 498
471 fading: *number* 499 fading: *number*
472 Fade the text by the given percentage when focus is lost. 500 Fade the text by the given percentage when focus is lost; option
501 -fade.
502
503 fadeColor: *colour*
504 Fade to this colour, when fading is used (see fading:). The default
505 colour is black; option -fadecolor.
473 506
474 tintColor: *colour* 507 tintColor: *colour*
475 Tint the transparent background pixmap with the given colour. 508 Tint the transparent background pixmap with the given colour; option
509 -tint.
476 510
477 shading: *number* 511 shading: *number*
478 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 512 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
479 image in addition to tinting it. 513 image in addition to tinting it.
480 514
481 scrollColor: *colour* 515 scrollColor: *colour*
482 Use the specified colour for the scrollbar [default #B2B2B2]. 516 Use the specified colour for the scrollbar [default #B2B2B2].
483 517
484 troughColor: *colour* 518 troughColor: *colour*
485 Use the specified colour for the scrollbar's trough area [default 519 Use the specified colour for the scrollbar's trough area [default
486 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 520 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
487 521
488 borderColor: *colour* 522 borderColor: *colour*
489 The colour of the border around the text area and between the 523 The colour of the border around the text area and between the
490 scrollbar and the text. 524 scrollbar and the text.
491 525
… …
514 font: *fontlist* 548 font: *fontlist*
515 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
516 names that are used in turn when trying to display Unicode 550 names that are used in turn when trying to display Unicode
517 characters. The first font defines the cell size for characters; 551 characters. The first font defines the cell size for characters;
518 other fonts might be smaller, but not larger. A reasonable default 552 other fonts might be smaller, but not larger. A reasonable default
519 font list is always appended to it. option -fn. 553 font list is always appended to it; option -fn.
520 554
521 Each font can either be a standard X11 core font (XLFD) name, with 555 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 556 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
523 "xft:". 557 "xft:".
524 558
… …
570 tried. 604 tried.
571 605
572 If set, but empty, then this specific style is disabled and the 606 If set, but empty, then this specific style is disabled and the
573 normal text font will being used for the given style. 607 normal text font will being used for the given style.
574 608
609 intensityStyles: *boolean*
610 When font styles are not enabled, or this option is enabled (True,
611 option -is, the default), bold and italic font styles imply high
612 intensity foreground/backround colours. Disabling this option
613 (False, option +is) disables this behaviour, the high intensity
614 colours are not reachable.
615
575 selectstyle: *mode* 616 selectstyle: *mode*
576 Set mouse selection style to old which is 2.20, oldword which is 617 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 618 xterm style with 2.20 old word selection, or anything else which
578 gives xterm style selection. 619 gives xterm style selection.
579 620
580 scrollstyle: *mode* 621 scrollstyle: *mode*
581 Set scrollbar style to rxvt, plain, next or xterm. plain is the 622 Set scrollbar style to rxvt, plain, next or xterm. plain is the
582 author's favourite.. 623 author's favourite.
583 624
584 title: *string* 625 title: *string*
585 Set window title string, the default title is the command-line 626 Set window title string, the default title is the command-line
586 specified after the -e option, if any, otherwise the application 627 specified after the -e option, if any, otherwise the application
587 name; option -title. 628 name; option -title.
… …
611 652
612 print-pipe: *string* 653 print-pipe: *string*
613 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 654 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 655 Print to initiate a screen dump to the printer and Ctrl-Print or
615 Shift-Print to include the scrollback as well. 656 Shift-Print to include the scrollback as well.
657
658 The string will be interpreted as if typed into the shell as-is.
659
660 Example:
661
662 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
663
664 This creates a new file in your home directory with the screen
665 contents everytime you hit "Print".
616 666
617 scrollBar: *boolean* 667 scrollBar: *boolean*
618 True: enable the scrollbar [default]; option -sb. False: disable the 668 True: enable the scrollbar [default]; option -sb. False: disable the
619 scrollbar; option +sb. 669 scrollbar; option +sb.
620 670
… …
727 777
728 imLocale: *name* 778 imLocale: *name*
729 The locale to use for opening the IM. You can use an "LC_CTYPE" of 779 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 780 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 781 the input extension to be able to input japanese characters while
732 staying in another locale. option -imlocale. 782 staying in another locale; option -imlocale.
733 783
734 imFont: *fontset* 784 imFont: *fontset*
735 Specify the font-set used for XIM styles "OverTheSpot" or 785 Specify the font-set used for XIM styles "OverTheSpot" or
736 "OffTheSpot". It must be a standard X font set (XLFD patterns 786 "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 787 separated by commas), i.e. it's not in the same format as the other
… …
740 to the base font. option -imfont. 790 to the base font. option -imfont.
741 791
742 tripleclickwords: *boolean* 792 tripleclickwords: *boolean*
743 Change the meaning of triple-click selection with the left mouse 793 Change the meaning of triple-click selection with the left mouse
744 button. Instead of selecting a full line it will extend the 794 button. Instead of selecting a full line it will extend the
745 selection to the end of the logical line only. option -tcw. 795 selection to the end of the logical line only; option -tcw.
746 796
747 insecure: *boolean* 797 insecure: *boolean*
748 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 798 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
749 that echo arbitrary strings like the icon name or the locale. This 799 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, 800 could be abused if somebody gets 8-bit-clean access to your display,
751 whether throuh a mail client displaying mail bodies unfiltered or 801 whether through a mail client displaying mail bodies unfiltered or
752 though write(1). Therefore, these sequences are disabled by default. 802 through write(1) or any other means. Therefore, these sequences are
753 (Note that other terminals, including xterm, have these sequences 803 disabled by default. (Note that many other terminals, including
754 enabled by default). You can enable them by setting this boolean 804 xterm, have these sequences enabled by default, which doesn't make
755 resource or specifying -insecure as an option. At the moment, this 805 it safer, though).
756 enabled display-answer, locale, findfont, icon label and window 806
757 title requests as well as dynamic menubar dispatch. 807 You can enable them by setting this boolean resource or specifying
808 -insecure as an option. At the moment, this enables display-answer,
809 locale, findfont, icon label and window title requests as well as
810 dynamic menubar dispatch.
758 811
759 modifier: *modifier* 812 modifier: *modifier*
760 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 813 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
761 super, mod1, mod2, mod3, mod4, mod5; option -mod. 814 super, mod1, mod2, mod3, mod4, mod5; option -mod.
762 815
… …
771 secondaryScroll: *bool* 824 secondaryScroll: *bool*
772 Turn on/off secondary screen scroll (default enabled). If the this 825 Turn on/off secondary screen scroll (default enabled). If the this
773 option is enabled, scrolls on the secondary screen will change the 826 option is enabled, scrolls on the secondary screen will change the
774 scrollback buffer and switching to/from the secondary screen will 827 scrollback buffer and switching to/from the secondary screen will
775 instead scroll the screen up. 828 instead scroll the screen up.
829
830 hold: *bool*
831 Turn on/off hold window after exit support. If enabled, rxvt will
832 not immediately destroy its window when the program executed within
833 it exits. Instead, it will wait till it is being killed or closed by
834 the user.
776 835
777 keysym.*sym*: *string* 836 keysym.*sym*: *string*
778 Compile *frills*: Associate *string* with keysym *sym*. The 837 Compile *frills*: Associate *string* with keysym *sym*. The
779 intervening resource name keysym. cannot be omitted. 838 intervening resource name keysym. cannot be omitted.
780 839
… …
825 the following means "change the current locale to "zh_CN.GBK" when 884 the following means "change the current locale to "zh_CN.GBK" when
826 Control-Meta-c is being pressed": 885 Control-Meta-c is being pressed":
827 886
828 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 887 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
829 888
889 Due the the large number of modifier combinations, a defined key
890 mapping will match if at *at least* the specified identifiers are
891 being set, and no other key mappings with those and more bits are
892 being defined. That means that defining a key map for "a" will
893 automatically provide definitions for "Meta-a", "Shift-a" and so on,
894 unless some of those are defined mappings themselves.
895
896 Unfortunately, this will override built-in key mappings. For example
897 if you overwrite the "Insert" key you will disable rxvt's
898 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
899 the user-defined keymap using the "builtin:" replacement:
900
901 URxvt.keysym.Insert: <my insert key sequence>
902 URxvt.keysym.S-Insert: builtin:
903
904 The first line defines a mapping for "Insert" and *any* combination
905 of modifiers. The second line re-establishes the default mapping for
906 "Shift-Insert".
907
830 The following example will map Control-Meta-1 and Control-Meta-2 to 908 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 909 the fonts "suxuseuro" and "9x15bold", so you can have some limited
832 font-switching at runtime: 910 font-switching at runtime:
833 911
834 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 912 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
… …
837 Other things are possible, e.g. resizing (see rxvt(7) for more 915 Other things are possible, e.g. resizing (see rxvt(7) for more
838 info): 916 info):
839 917
840 URxvt.keysym.M-C-3: command:\033[8;25;80t 918 URxvt.keysym.M-C-3: command:\033[8;25;80t
841 URxvt.keysym.M-C-4: command:\033[8;48;110t 919 URxvt.keysym.M-C-4: command:\033[8;48;110t
920
921 perl: *string*
922 Used by perl extension and is free for any use, as it is not
923 interpreted by rxvt-unicode itself; option perl.
924
925 perl-eval: *string*
926 Perl code to be evaluated when all extensions have been loaded. See
927 the rxvtperl(3) manpage.
928
929 perl-lib: *path*
930 Additional directory that holds extension scripts that are loaded
931 and enabled for this terminal instance, in addition to scripts
932 stored in /opt/rxvt/lib/urxvt/perl-ext/, which are global to all
933 terminal instances.
934
935 See the rxvtperl(3) manpage.
842 936
843THE SCROLLBAR 937THE SCROLLBAR
844 Lines of text that scroll off the top of the rxvt window (resource: 938 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 939 saveLines) and can be scrolled back using the scrollbar or by
846 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 940 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
… …
873 entire logical line (which can span multiple screen lines), unless 967 entire logical line (which can span multiple screen lines), unless
874 modified by resource tripleclickwords. 968 modified by resource tripleclickwords.
875 969
876 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 970 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
877 (Compile: *frills*) will create a rectangular selection instead of a 971 (Compile: *frills*) will create a rectangular selection instead of a
878 normal one. 972 normal one. In this mode, every selected row becomes its own line in
973 the selection, and trailing whitespace is visually underlined and
974 removed from the selection.
879 975
880 Insertion: 976 Insertion:
881 Pressing and releasing the Middle mouse button (or Shift-Insert) in 977 Pressing and releasing the Middle mouse button (or Shift-Insert) in
882 an rxvt window causes the current text selection to be inserted as 978 an rxvt window causes the current text selection to be inserted as
883 if it had been typed on the keyboard. 979 if it had been typed on the keyboard.
… …
887 supported in rxvt-unicode. Bug me if you need this. 983 supported in rxvt-unicode. Bug me if you need this.
888 984
889 You can, however, switch fonts at runtime using escape sequences (and 985 You can, however, switch fonts at runtime using escape sequences (and
890 therefore using the menubar), e.g.: 986 therefore using the menubar), e.g.:
891 987
892 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 988 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
893 989
894 rxvt-unicode will automatically re-apply these fonts to the output so 990 rxvt-unicode will automatically re-apply these fonts to the output so
895 far. 991 far.
896 992
897ISO 14755 SUPPORT 993ISO 14755 SUPPORT
… …
1043 Used in the same way as "RXVTPATH". 1139 Used in the same way as "RXVTPATH".
1044 1140
1045 RXVT_SOCKET 1141 RXVT_SOCKET
1046 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1142 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1047 1143
1048 Default "$HOME/.rxvt-unicode-<nodename". 1144 Default $HOME/.rxvt-unicode-*<nodename*.
1049 1145
1050 HOME 1146 HOME
1051 Used to locate the default directory for the unix domain socket for 1147 Used to locate the default directory for the unix domain socket for
1052 daemon communications and to locate various resource files (such as 1148 daemon communications and to locate various resource files (such as
1053 ".Xdefaults") 1149 ".Xdefaults")
… …
1062FILES 1158FILES
1063 /usr/lib/X11/rgb.txt 1159 /usr/lib/X11/rgb.txt
1064 Color names. 1160 Color names.
1065 1161
1066SEE ALSO 1162SEE ALSO
1067 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1163 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1068 1164 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 1165
1076CURRENT PROJECT COORDINATOR 1166CURRENT PROJECT COORDINATOR
1077 Project Coordinator 1167 Project Coordinator
1078 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1168 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1079 1169

Diff Legend

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