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.40 by root, Tue Jan 10 04:26:54 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,
… …
340 $rxvt->signal_connect_after (realize => sub { 371 $rxvt->signal_connect_after (realize => sub {
341 my $xid = $_[0]->window->get_xid; 372 my $xid = $_[0]->window->get_xid;
342 system "rxvt -embed $xid &"; 373 system "rxvt -embed $xid &";
343 }); 374 });
344 375
345 -pty-fd *fileno* 376 -pty-fd *file descriptor*
346 Tells rxvt NOT to execute any commands or create a new pty/tty pair 377 Tells rxvt NOT to execute any commands or create a new pty/tty pair
347 but instead use the given filehandle as the tty master. This is 378 but instead use the given filehandle as the tty master. This is
348 useful if you want to drive rxvt as a generic terminal emulator 379 useful if you want to drive rxvt as a generic terminal emulator
349 without having to run a program within it. 380 without having to run a program within it.
350 381
351 If this switch is given, rxvt will not create any utmp/wtmp entries 382 If this switch is given, rxvt will not create any utmp/wtmp entries
352 and will not tinker with pty/tty permissions - you have to do that 383 and will not tinker with pty/tty permissions - you have to do that
353 yourself if you want that. 384 yourself if you want that.
354 385
386 As an extremely special case, specifying -1 will completely suppress
387 pty/tty operations.
388
355 Here is a example in perl that illustrates how this option can be 389 Here is a example in perl that illustrates how this option can be
356 used (a longer example is in doc/pty-fd): 390 used (a longer example is in doc/pty-fd):
357 391
358 use IO::Pty; 392 use IO::Pty;
359 use Fcntl; 393 use Fcntl;
… …
364 close $pty; 398 close $pty;
365 399
366 # now communicate with rxvt 400 # now communicate with rxvt
367 my $slave = $pty->slave; 401 my $slave = $pty->slave;
368 while (<$slave>) { print $slave "got <$_>\n" } 402 while (<$slave>) { print $slave "got <$_>\n" }
403
404 -pe *string*
405 Comma-separated list of perl extension scripts to use (or not to
406 use) in this terminal instance. See resource perl-ext for details.
369 407
370RESOURCES (available also as long-options) 408RESOURCES (available also as long-options)
371 Note: `rxvt --help' gives a list of all resources (long options) 409 Note: `rxvt --help' gives a list of all resources (long options)
372 compiled into your version. 410 compiled into your version.
373 411
… …
467 True: make the background inherit the parent windows' pixmap, giving 505 True: make the background inherit the parent windows' pixmap, giving
468 artificial transparency. False: do not inherit the parent windows' 506 artificial transparency. False: do not inherit the parent windows'
469 pixmap. 507 pixmap.
470 508
471 fading: *number* 509 fading: *number*
472 Fade the text by the given percentage when focus is lost. 510 Fade the text by the given percentage when focus is lost; option
511 -fade.
512
513 fadeColor: *colour*
514 Fade to this colour, when fading is used (see fading:). The default
515 colour is black; option -fadecolor.
473 516
474 tintColor: *colour* 517 tintColor: *colour*
475 Tint the transparent background pixmap with the given colour. 518 Tint the transparent background pixmap with the given colour; option
519 -tint.
476 520
477 shading: *number* 521 shading: *number*
478 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 522 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
479 image in addition to tinting it. 523 image in addition to tinting it.
480 524
… …
514 font: *fontlist* 558 font: *fontlist*
515 Select the fonts to be used. This is a comma separated list of font 559 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 560 names that are used in turn when trying to display Unicode
517 characters. The first font defines the cell size for characters; 561 characters. The first font defines the cell size for characters;
518 other fonts might be smaller, but not larger. A reasonable default 562 other fonts might be smaller, but not larger. A reasonable default
519 font list is always appended to it. option -fn. 563 font list is always appended to it; option -fn.
520 564
521 Each font can either be a standard X11 core font (XLFD) name, with 565 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 566 optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
523 "xft:". 567 "xft:".
524 568
… …
570 tried. 614 tried.
571 615
572 If set, but empty, then this specific style is disabled and the 616 If set, but empty, then this specific style is disabled and the
573 normal text font will being used for the given style. 617 normal text font will being used for the given style.
574 618
619 intensityStyles: *boolean*
620 When font styles are not enabled, or this option is enabled (True,
621 option -is, the default), bold and italic font styles imply high
622 intensity foreground/backround colours. Disabling this option
623 (False, option +is) disables this behaviour, the high intensity
624 colours are not reachable.
625
575 selectstyle: *mode* 626 selectstyle: *mode*
576 Set mouse selection style to old which is 2.20, oldword which is 627 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 628 xterm style with 2.20 old word selection, or anything else which
578 gives xterm style selection. 629 gives xterm style selection.
579 630
… …
669 borderLess: *boolean* 720 borderLess: *boolean*
670 Set MWM hints to request a borderless window, i.e. if honoured by 721 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; 722 the WM, the rxvt-unicode window will not have window decorations;
672 option -bl. 723 option -bl.
673 724
725 skipBuiltinGlyphs: *boolean*
726 Compile *frills*: Disable the usage of the built-in block
727 graphics/line drawing characters and just rely on what the specified
728 fonts provide. Use this if you have a good font and want to use its
729 block graphic glyphs; option -sbg.
730
674 termName: *termname* 731 termName: *termname*
675 Specifies the terminal type name to be set in the TERM environment 732 Specifies the terminal type name to be set in the TERM environment
676 variable; option -tn. 733 variable; option -tn.
677 734
678 linespace: *number* 735 linespace: *number*
… …
736 793
737 imLocale: *name* 794 imLocale: *name*
738 The locale to use for opening the IM. You can use an "LC_CTYPE" of 795 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 796 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 797 the input extension to be able to input japanese characters while
741 staying in another locale. option -imlocale. 798 staying in another locale; option -imlocale.
742 799
743 imFont: *fontset* 800 imFont: *fontset*
744 Specify the font-set used for XIM styles "OverTheSpot" or 801 Specify the font-set used for XIM styles "OverTheSpot" or
745 "OffTheSpot". It must be a standard X font set (XLFD patterns 802 "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 803 separated by commas), i.e. it's not in the same format as the other
… …
749 to the base font. option -imfont. 806 to the base font. option -imfont.
750 807
751 tripleclickwords: *boolean* 808 tripleclickwords: *boolean*
752 Change the meaning of triple-click selection with the left mouse 809 Change the meaning of triple-click selection with the left mouse
753 button. Instead of selecting a full line it will extend the 810 button. Instead of selecting a full line it will extend the
754 selection to the end of the logical line only. option -tcw. 811 selection to the end of the logical line only; option -tcw.
755 812
756 insecure: *boolean* 813 insecure: *boolean*
757 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 814 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
758 that echo arbitrary strings like the icon name or the locale. This 815 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, 816 could be abused if somebody gets 8-bit-clean access to your display,
760 whether throuh a mail client displaying mail bodies unfiltered or 817 whether through a mail client displaying mail bodies unfiltered or
761 though write(1). Therefore, these sequences are disabled by default. 818 through write(1) or any other means. Therefore, these sequences are
762 (Note that other terminals, including xterm, have these sequences 819 disabled by default. (Note that many other terminals, including
763 enabled by default). You can enable them by setting this boolean 820 xterm, have these sequences enabled by default, which doesn't make
764 resource or specifying -insecure as an option. At the moment, this 821 it safer, though).
765 enabled display-answer, locale, findfont, icon label and window 822
766 title requests as well as dynamic menubar dispatch. 823 You can enable them by setting this boolean resource or specifying
824 -insecure as an option. At the moment, this enables display-answer,
825 locale, findfont, icon label and window title requests as well as
826 dynamic menubar dispatch.
767 827
768 modifier: *modifier* 828 modifier: *modifier*
769 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 829 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
770 super, mod1, mod2, mod3, mod4, mod5; option -mod. 830 super, mod1, mod2, mod3, mod4, mod5; option -mod.
771 831
… …
780 secondaryScroll: *bool* 840 secondaryScroll: *bool*
781 Turn on/off secondary screen scroll (default enabled). If the this 841 Turn on/off secondary screen scroll (default enabled). If the this
782 option is enabled, scrolls on the secondary screen will change the 842 option is enabled, scrolls on the secondary screen will change the
783 scrollback buffer and switching to/from the secondary screen will 843 scrollback buffer and switching to/from the secondary screen will
784 instead scroll the screen up. 844 instead scroll the screen up.
845
846 hold: *bool*
847 Turn on/off hold window after exit support. If enabled, rxvt will
848 not immediately destroy its window when the program executed within
849 it exits. Instead, it will wait till it is being killed or closed by
850 the user.
785 851
786 keysym.*sym*: *string* 852 keysym.*sym*: *string*
787 Compile *frills*: Associate *string* with keysym *sym*. The 853 Compile *frills*: Associate *string* with keysym *sym*. The
788 intervening resource name keysym. cannot be omitted. 854 intervening resource name keysym. cannot be omitted.
789 855
… …
834 the following means "change the current locale to "zh_CN.GBK" when 900 the following means "change the current locale to "zh_CN.GBK" when
835 Control-Meta-c is being pressed": 901 Control-Meta-c is being pressed":
836 902
837 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 903 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
838 904
905 If *string* takes the form "perl:STRING", then the specified STRING
906 is passed to the "on_keyboard_command" perl handler. See the
907 rxvtperl(3) manpage. For example, the selection extension (activated
908 via "rxvt -pe selection") listens for "selection:rot13" events:
909
910 URxvt.keysym.M-C-c: perl:selection:rot13
911
839 Due the the large number of modifier combinations, a defined key 912 Due the the large number of modifier combinations, a defined key
840 mapping will match if at *at least* the specified identifiers are 913 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 914 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 915 being defined. That means that defining a key map for "a" will
843 automatically provide definitions for "Meta-a", "Shift-a" and so on, 916 automatically provide definitions for "Meta-a", "Shift-a" and so on,
… …
866 info): 939 info):
867 940
868 URxvt.keysym.M-C-3: command:\033[8;25;80t 941 URxvt.keysym.M-C-3: command:\033[8;25;80t
869 URxvt.keysym.M-C-4: command:\033[8;48;110t 942 URxvt.keysym.M-C-4: command:\033[8;48;110t
870 943
944 perl-ext-common: *string*
945 perl-ext: *string*
946 Comma-separated list(s) of perl extension scripts (default:
947 "default") to use in this terminal instance; option -pe.
948
949 Extension names can be prefixed with a "-" sign to prohibit using
950 them. This can be useful to selectively disable some extensions
951 loaded by default, or specified via the "perl-ext-common" resource.
952 For example, "default,-selection" will use all the default extension
953 except "selection".
954
955 Extension names can also be followed by an argument in angle
956 brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
957 for searchable scorllback to Alt/Meta-s). Mentioning the same
958 extension multiple times with different arguments will pass multiple
959 arguments to the extension.
960
961 Each extension is looked up in the library directories, loaded if
962 necessary, and bound to the current terminal instance.
963
964 If both of these resources are the empty string, then the perl
965 interpreter will not be initialized. The idea behind two options is
966 that perl-ext-common will be used for extensions that should be
967 available to all instances, while perl-ext is used for specific
968 instances.
969
970 perl-eval: *string*
971 Perl code to be evaluated when all extensions have been registered.
972 See the rxvtperl(3) manpage. Due to security reasons, this resource
973 will be ignored when running setuid/setgid.
974
975 perl-lib: *path*
976 Colon-separated list of additional directories that hold extension
977 scripts. When looking for extensions specified by the "perl"
978 resource, rxvt will first look in these directories and then in
979 /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
980 will be ignored when running setuid/setgid.
981
982 See the rxvtperl(3) manpage.
983
984 transient-for: *windowid*
985 Sets the WM_TRANSIENT_FOR property to the given window iw.
986
871THE SCROLLBAR 987THE SCROLLBAR
872 Lines of text that scroll off the top of the rxvt window (resource: 988 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 989 saveLines) and can be scrolled back using the scrollbar or by
874 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is 990 keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
875 fairly intuitive. The xterm-scrollbar is without arrows and its 991 fairly intuitive. The xterm-scrollbar is without arrows and its
… …
901 entire logical line (which can span multiple screen lines), unless 1017 entire logical line (which can span multiple screen lines), unless
902 modified by resource tripleclickwords. 1018 modified by resource tripleclickwords.
903 1019
904 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 1020 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
905 (Compile: *frills*) will create a rectangular selection instead of a 1021 (Compile: *frills*) will create a rectangular selection instead of a
906 normal one. 1022 normal one. In this mode, every selected row becomes its own line in
1023 the selection, and trailing whitespace is visually underlined and
1024 removed from the selection.
907 1025
908 Insertion: 1026 Insertion:
909 Pressing and releasing the Middle mouse button (or Shift-Insert) in 1027 Pressing and releasing the Middle mouse button (or Shift-Insert) in
910 an rxvt window causes the current text selection to be inserted as 1028 an rxvt window causes the current text selection to be inserted as
911 if it had been typed on the keyboard. 1029 if it had been typed on the keyboard.
… …
915 supported in rxvt-unicode. Bug me if you need this. 1033 supported in rxvt-unicode. Bug me if you need this.
916 1034
917 You can, however, switch fonts at runtime using escape sequences (and 1035 You can, however, switch fonts at runtime using escape sequences (and
918 therefore using the menubar), e.g.: 1036 therefore using the menubar), e.g.:
919 1037
920 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1038 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
921 1039
922 rxvt-unicode will automatically re-apply these fonts to the output so 1040 rxvt-unicode will automatically re-apply these fonts to the output so
923 far. 1041 far.
924 1042
925ISO 14755 SUPPORT 1043ISO 14755 SUPPORT
… …
1093 1211
1094SEE ALSO 1212SEE ALSO
1095 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), 1213 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1096 tty(4), utmp(5) 1214 tty(4), utmp(5)
1097 1215
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 1216CURRENT PROJECT COORDINATOR
1106 Project Coordinator 1217 Project Coordinator
1107 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1218 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1108 1219
1109 <http://software.schmorp.de/#rxvt-unicode> 1220 <http://software.schmorp.de/#rxvt-unicode>

Diff Legend

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