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.14 by root, Mon Feb 14 18:47:54 2005 UTC vs.
Revision 1.29 by root, Mon Jan 2 15:11:05 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.1, 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,
321 which enables applications to easily embed a terminal. 346 which enables applications to easily embed a terminal.
322 347
323 Right now, rxvt will first unmap/map the specified window, so it 348 Right now, rxvt will first unmap/map the specified window, so it
324 shouldn't be a top-level window. rxvt will also reconfigure it quite 349 shouldn't be a top-level window. rxvt will also reconfigure it quite
325 a bit, so don't expect it to keep some specific state. It's best to 350 a bit, so don't expect it to keep some specific state. It's best to
326 create an extra subwindow for rxvt and leave it alone. 351 create an extra subwindow for rxvt and leave it alone.
352
353 The window will not be destroyed when rxvt exits.
327 354
328 It might be useful to know that rxvt will not close file descriptors 355 It might be useful to know that rxvt will not close file descriptors
329 passed to it (except for stdin/out/err, of course), so you can use 356 passed to it (except for stdin/out/err, of course), so you can use
330 file descriptors to communicate with the programs within the 357 file descriptors to communicate with the programs within the
331 terminal. This works regardless of wether the "-embed" option was 358 terminal. This works regardless of wether the "-embed" option was
332 used or not. 359 used or not.
360
361 Here is a short Gtk2-perl snippet that illustrates how this option
362 can be used (a longer example is in doc/embed):
363
364 my $rxvt = new Gtk2::Socket;
365 $rxvt->signal_connect_after (realize => sub {
366 my $xid = $_[0]->window->get_xid;
367 system "rxvt -embed $xid &";
368 });
369
370 -pty-fd *fileno*
371 Tells rxvt NOT to execute any commands or create a new pty/tty pair
372 but instead use the given filehandle as the tty master. This is
373 useful if you want to drive rxvt as a generic terminal emulator
374 without having to run a program within it.
375
376 If this switch is given, rxvt will not create any utmp/wtmp entries
377 and will not tinker with pty/tty permissions - you have to do that
378 yourself if you want that.
379
380 Here is a example in perl that illustrates how this option can be
381 used (a longer example is in doc/pty-fd):
382
383 use IO::Pty;
384 use Fcntl;
385
386 my $pty = new IO::Pty;
387 fcntl $pty, F_SETFD, 0; # clear close-on-exec
388 system "rxvt -pty-fd " . (fileno $pty) . "&";
389 close $pty;
390
391 # now communicate with rxvt
392 my $slave = $pty->slave;
393 while (<$slave>) { print $slave "got <$_>\n" }
333 394
334RESOURCES (available also as long-options) 395RESOURCES (available also as long-options)
335 Note: `rxvt --help' gives a list of all resources (long options) 396 Note: `rxvt --help' gives a list of all resources (long options)
336 compiled into your version. 397 compiled into your version.
337 398
… …
431 True: make the background inherit the parent windows' pixmap, giving 492 True: make the background inherit the parent windows' pixmap, giving
432 artificial transparency. False: do not inherit the parent windows' 493 artificial transparency. False: do not inherit the parent windows'
433 pixmap. 494 pixmap.
434 495
435 fading: *number* 496 fading: *number*
436 Fade the text by the given percentage when focus is lost. 497 Fade the text by the given percentage when focus is lost; option
498 -fade.
499
500 fadeColor: *colour*
501 Fade to this colour, when fading is used (see fading:). The default
502 colour is black; option -fadecolor.
437 503
438 tintColor: *colour* 504 tintColor: *colour*
439 Tint the transparent background pixmap with the given colour. 505 Tint the transparent background pixmap with the given colour; option
506 -tint.
440 507
441 shading: *number* 508 shading: *number*
442 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 509 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
443 image in addition to tinting it. 510 image in addition to tinting it.
444 511
445 scrollColor: *colour* 512 scrollColor: *colour*
446 Use the specified colour for the scrollbar [default #B2B2B2]. 513 Use the specified colour for the scrollbar [default #B2B2B2].
447 514
448 troughColor: *colour* 515 troughColor: *colour*
449 Use the specified colour for the scrollbar's trough area [default 516 Use the specified colour for the scrollbar's trough area [default
450 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 517 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
451 518
452 borderColor: *colour* 519 borderColor: *colour*
453 The colour of the border around the text area and between the 520 The colour of the border around the text area and between the
454 scrollbar and the text. 521 scrollbar and the text.
455 522
… …
534 tried. 601 tried.
535 602
536 If set, but empty, then this specific style is disabled and the 603 If set, but empty, then this specific style is disabled and the
537 normal text font will being used for the given style. 604 normal text font will being used for the given style.
538 605
606 intensityStyles: *boolean*
607 When font styles are not enabled, or this option is enabled (True,
608 option -is, the default), bold and italic font styles imply high
609 intensity foreground/backround colours. Disabling this option
610 (False, option +is) disables this behaviour, the high intensity
611 colours are not reachable.
612
539 selectstyle: *mode* 613 selectstyle: *mode*
540 Set mouse selection style to old which is 2.20, oldword which is 614 Set mouse selection style to old which is 2.20, oldword which is
541 xterm style with 2.20 old word selection, or anything else which 615 xterm style with 2.20 old word selection, or anything else which
542 gives xterm style selection. 616 gives xterm style selection.
543 617
544 scrollstyle: *mode* 618 scrollstyle: *mode*
545 Set scrollbar style to rxvt, plain, next or xterm. plain is the 619 Set scrollbar style to rxvt, plain, next or xterm. plain is the
546 author's favourite.. 620 author's favourite.
547 621
548 title: *string* 622 title: *string*
549 Set window title string, the default title is the command-line 623 Set window title string, the default title is the command-line
550 specified after the -e option, if any, otherwise the application 624 specified after the -e option, if any, otherwise the application
551 name; option -title. 625 name; option -title.
… …
576 print-pipe: *string* 650 print-pipe: *string*
577 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 651 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use
578 Print to initiate a screen dump to the printer and Ctrl-Print or 652 Print to initiate a screen dump to the printer and Ctrl-Print or
579 Shift-Print to include the scrollback as well. 653 Shift-Print to include the scrollback as well.
580 654
655 The string will be interpreted as if typed into the shell as-is.
656
657 Example:
658
659 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
660
661 This creates a new file in your home directory with the screen
662 contents everytime you hit "Print".
663
581 scrollBar: *boolean* 664 scrollBar: *boolean*
582 True: enable the scrollbar [default]; option -sb. False: disable the 665 True: enable the scrollbar [default]; option -sb. False: disable the
583 scrollbar; option +sb. 666 scrollbar; option +sb.
584 667
585 scrollBar_right: *boolean* 668 scrollBar_right: *boolean*
… …
598 True: scroll to bottom when tty receives output; option -si. False: 681 True: scroll to bottom when tty receives output; option -si. False:
599 do not scroll to bottom when tty receives output; option +si. 682 do not scroll to bottom when tty receives output; option +si.
600 683
601 scrollWithBuffer: *boolean* 684 scrollWithBuffer: *boolean*
602 True: scroll with scrollback buffer when tty receives new lines (and 685 True: scroll with scrollback buffer when tty receives new lines (and
603 scrollTtyOutput is False); option +sw. False: do not scroll with 686 scrollTtyOutput is False); option -sw. False: do not scroll with
604 scrollback buffer when tty recieves new lines; option -sw. 687 scrollback buffer when tty recieves new lines; option +sw.
605 688
606 scrollTtyKeypress: *boolean* 689 scrollTtyKeypress: *boolean*
607 True: scroll to bottom when a non-special key is pressed. Special 690 True: scroll to bottom when a non-special key is pressed. Special
608 keys are those which are intercepted by rxvt-unicode for special 691 keys are those which are intercepted by rxvt-unicode for special
609 handling and are not passed onto the shell; option -sk. False: do 692 handling and are not passed onto the shell; option -sk. False: do
… …
661 pointerColor2: *colour* 744 pointerColor2: *colour*
662 Mouse pointer background colour. 745 Mouse pointer background colour.
663 746
664 pointerBlankDelay: *number* 747 pointerBlankDelay: *number*
665 Specifies number of seconds before blanking the pointer [default 2]. 748 Specifies number of seconds before blanking the pointer [default 2].
749 Use a large number (e.g. 987654321) to effectively disable the
750 timeout.
666 751
667 backspacekey: *string* 752 backspacekey: *string*
668 The string to send when the backspace key is pressed. If set to DEC 753 The string to send when the backspace key is pressed. If set to DEC
669 or unset it will send Delete (code 127) or, if shifted, Backspace 754 or unset it will send Delete (code 127) or, if shifted, Backspace
670 (code 8) - which can be reversed with the appropriate DEC private 755 (code 8) - which can be reversed with the appropriate DEC private
… …
708 793
709 insecure: *boolean* 794 insecure: *boolean*
710 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 795 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
711 that echo arbitrary strings like the icon name or the locale. This 796 that echo arbitrary strings like the icon name or the locale. This
712 could be abused if somebody gets 8-bit-clean access to your display, 797 could be abused if somebody gets 8-bit-clean access to your display,
713 whether throuh a mail client displaying mail bodies unfiltered or 798 whether through a mail client displaying mail bodies unfiltered or
714 though write(1). Therefore, these sequences are disabled by default. 799 through write(1) or any other means. Therefore, these sequences are
715 (Note that other terminals, including xterm, have these sequences 800 disabled by default. (Note that many other terminals, including
716 enabled by default). You can enable them by setting this boolean 801 xterm, have these sequences enabled by default, which doesn't make
717 resource or specifying -insecure as an option. At the moment, this 802 it safer, though).
718 enabled display-answer, locale, findfont, icon label and window 803
719 title requests as well as dynamic menubar dispatch. 804 You can enable them by setting this boolean resource or specifying
805 -insecure as an option. At the moment, this enables display-answer,
806 locale, findfont, icon label and window title requests as well as
807 dynamic menubar dispatch.
720 808
721 modifier: *modifier* 809 modifier: *modifier*
722 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 810 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
723 super, mod1, mod2, mod3, mod4, mod5; option -mod. 811 super, mod1, mod2, mod3, mod4, mod5; option -mod.
724 812
… …
733 secondaryScroll: *bool* 821 secondaryScroll: *bool*
734 Turn on/off secondary screen scroll (default enabled). If the this 822 Turn on/off secondary screen scroll (default enabled). If the this
735 option is enabled, scrolls on the secondary screen will change the 823 option is enabled, scrolls on the secondary screen will change the
736 scrollback buffer and switching to/from the secondary screen will 824 scrollback buffer and switching to/from the secondary screen will
737 instead scroll the screen up. 825 instead scroll the screen up.
826
827 hold: *bool*
828 Turn on/off hold window after exit support. If enabled, rxvt will
829 not immediately destroy its window when the program executed within
830 it exits. Instead, it will wait till it is being killed or closed by
831 the user.
738 832
739 keysym.*sym*: *string* 833 keysym.*sym*: *string*
740 Compile *frills*: Associate *string* with keysym *sym*. The 834 Compile *frills*: Associate *string* with keysym *sym*. The
741 intervening resource name keysym. cannot be omitted. 835 intervening resource name keysym. cannot be omitted.
742 836
… …
787 the following means "change the current locale to "zh_CN.GBK" when 881 the following means "change the current locale to "zh_CN.GBK" when
788 Control-Meta-c is being pressed": 882 Control-Meta-c is being pressed":
789 883
790 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 884 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
791 885
886 Due the the large number of modifier combinations, a defined key
887 mapping will match if at *at least* the specified identifiers are
888 being set, and no other key mappings with those and more bits are
889 being defined. That means that defining a key map for "a" will
890 automatically provide definitions for "Meta-a", "Shift-a" and so on,
891 unless some of those are defined mappings themselves.
892
893 Unfortunately, this will override built-in key mappings. For example
894 if you overwrite the "Insert" key you will disable rxvt's
895 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
896 the user-defined keymap using the "builtin:" replacement:
897
898 URxvt.keysym.Insert: <my insert key sequence>
899 URxvt.keysym.S-Insert: builtin:
900
901 The first line defines a mapping for "Insert" and *any* combination
902 of modifiers. The second line re-establishes the default mapping for
903 "Shift-Insert".
904
792 The following example will map Control-Meta-1 and Control-Meta-2 to 905 The following example will map Control-Meta-1 and Control-Meta-2 to
793 the fonts "suxuseuro" and "9x15bold", so you can have some limited 906 the fonts "suxuseuro" and "9x15bold", so you can have some limited
794 font-switching at runtime: 907 font-switching at runtime:
795 908
796 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 909 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
… …
835 entire logical line (which can span multiple screen lines), unless 948 entire logical line (which can span multiple screen lines), unless
836 modified by resource tripleclickwords. 949 modified by resource tripleclickwords.
837 950
838 Starting a selection while pressing the Meta key (or Meta+Ctrl keys) 951 Starting a selection while pressing the Meta key (or Meta+Ctrl keys)
839 (Compile: *frills*) will create a rectangular selection instead of a 952 (Compile: *frills*) will create a rectangular selection instead of a
840 normal one. 953 normal one. In this mode, every selected row becomes its own line in
954 the selection, and trailing whitespace is visually underlined and
955 removed from the selection.
841 956
842 Insertion: 957 Insertion:
843 Pressing and releasing the Middle mouse button (or Shift-Insert) in 958 Pressing and releasing the Middle mouse button (or Shift-Insert) in
844 an rxvt window causes the current text selection to be inserted as 959 an rxvt window causes the current text selection to be inserted as
845 if it had been typed on the keyboard. 960 if it had been typed on the keyboard.
… …
849 supported in rxvt-unicode. Bug me if you need this. 964 supported in rxvt-unicode. Bug me if you need this.
850 965
851 You can, however, switch fonts at runtime using escape sequences (and 966 You can, however, switch fonts at runtime using escape sequences (and
852 therefore using the menubar), e.g.: 967 therefore using the menubar), e.g.:
853 968
854 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 969 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
855 970
856 rxvt-unicode will automatically re-apply these fonts to the output so 971 rxvt-unicode will automatically re-apply these fonts to the output so
857 far. 972 far.
858 973
859ISO 14755 SUPPORT 974ISO 14755 SUPPORT
… …
1005 Used in the same way as "RXVTPATH". 1120 Used in the same way as "RXVTPATH".
1006 1121
1007 RXVT_SOCKET 1122 RXVT_SOCKET
1008 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1123 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1009 1124
1010 Default "$HOME/.rxvt-unicode-<nodename". 1125 Default $HOME/.rxvt-unicode-*<nodename*.
1011 1126
1012 HOME 1127 HOME
1013 Used to locate the default directory for the unix domain socket for 1128 Used to locate the default directory for the unix domain socket for
1014 daemon communications and to locate various resource files (such as 1129 daemon communications and to locate various resource files (such as
1015 ".Xdefaults") 1130 ".Xdefaults")
… …
1024FILES 1139FILES
1025 /usr/lib/X11/rgb.txt 1140 /usr/lib/X11/rgb.txt
1026 Color names. 1141 Color names.
1027 1142
1028SEE ALSO 1143SEE ALSO
1029 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1144 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1030 1145 tty(4), utmp(5)
1031BUGS
1032 Check the BUGS file for an up-to-date list.
1033
1034 Cursor change support is not yet implemented.
1035
1036 Click-and-drag doesn't work with X11 mouse report overriding.
1037 1146
1038CURRENT PROJECT COORDINATOR 1147CURRENT PROJECT COORDINATOR
1039 Project Coordinator 1148 Project Coordinator
1040 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1149 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1041 1150

Diff Legend

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