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.17 by root, Thu Feb 17 15:07:48 2005 UTC vs.
Revision 1.25 by root, Tue Oct 25 20:22:39 2005 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.2, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 5.8, 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
… …
204 212
205 -sr|+sr 213 -sr|+sr
206 Put scrollbar on right/left; resource scrollBar_right. 214 Put scrollbar on right/left; resource scrollBar_right.
207 215
208 -st|+st 216 -st|+st
209 Display normal (non XTerm/NeXT) scrollbar without/with a trough; 217 Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
210 resource scrollBar_floating. 218 resource scrollBar_floating.
211 219
212 -ptab|+ptab 220 -ptab|+ptab
213 If enabled (default), "Horizontal Tab" characters are being stored 221 If enabled (default), "Horizontal Tab" characters are being stored
214 as actual wide characters in the screen buffer, which makes it 222 as actual wide characters in the screen buffer, which makes it
… …
334 used or not. 342 used or not.
335 343
336 Here is a short Gtk2-perl snippet that illustrates how this option 344 Here is a short Gtk2-perl snippet that illustrates how this option
337 can be used (a longer example is in doc/embed): 345 can be used (a longer example is in doc/embed):
338 346
339 my $rxvt = new Gtk2::DrawingArea; 347 my $rxvt = new Gtk2::Socket;
340 $...->add ($rxvt); # important to add it somewhere first 348 $rxvt->signal_connect_after (realize => sub {
341 $rxvt->realize; # now it can be realized
342 my $xid = $rxvt->window->get_xid; 349 my $xid = $_[0]->window->get_xid;
343
344 system "rxvt -embed $xid &"; 350 system "rxvt -embed $xid &";
351 });
345 352
346 -pty-fd *fileno* 353 -pty-fd *fileno*
347 Tells rxvt NOT to execute any commands or create a new pty/tty pair 354 Tells rxvt NOT to execute any commands or create a new pty/tty pair
348 but instead use the given filehandle as the tty master. This is 355 but instead use the given filehandle as the tty master. This is
349 useful if you want to drive rxvt as a generic terminal emulator 356 useful if you want to drive rxvt as a generic terminal emulator
… …
359 use IO::Pty; 366 use IO::Pty;
360 use Fcntl; 367 use Fcntl;
361 368
362 my $pty = new IO::Pty; 369 my $pty = new IO::Pty;
363 fcntl $pty, F_SETFD, 0; # clear close-on-exec 370 fcntl $pty, F_SETFD, 0; # clear close-on-exec
364
365 system "rxvt -pty-fd " . (fileno $pty) . "&"; 371 system "rxvt -pty-fd " . (fileno $pty) . "&";
372 close $pty;
366 373
367 # now communicate with rxvt 374 # now communicate with rxvt
368 my $slave = $pty->slave; 375 my $slave = $pty->slave;
369 while (<$slave>) { print $slave "got <$_>\n" } 376 while (<$slave>) { print $slave "got <$_>\n" }
370 377
… …
468 True: make the background inherit the parent windows' pixmap, giving 475 True: make the background inherit the parent windows' pixmap, giving
469 artificial transparency. False: do not inherit the parent windows' 476 artificial transparency. False: do not inherit the parent windows'
470 pixmap. 477 pixmap.
471 478
472 fading: *number* 479 fading: *number*
473 Fade the text by the given percentage when focus is lost. 480 Fade the text by the given percentage when focus is lost; option
481 -fade.
482
483 fadeColor: *colour*
484 Fade to this colour, when fading is used (see fading:). The default
485 colour is black; option -fadecolor.
474 486
475 tintColor: *colour* 487 tintColor: *colour*
476 Tint the transparent background pixmap with the given colour. 488 Tint the transparent background pixmap with the given colour; option
489 -tint.
477 490
478 shading: *number* 491 shading: *number*
479 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 492 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
480 image in addition to tinting it. 493 image in addition to tinting it.
481 494
482 scrollColor: *colour* 495 scrollColor: *colour*
483 Use the specified colour for the scrollbar [default #B2B2B2]. 496 Use the specified colour for the scrollbar [default #B2B2B2].
484 497
485 troughColor: *colour* 498 troughColor: *colour*
486 Use the specified colour for the scrollbar's trough area [default 499 Use the specified colour for the scrollbar's trough area [default
487 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 500 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
488 501
489 borderColor: *colour* 502 borderColor: *colour*
490 The colour of the border around the text area and between the 503 The colour of the border around the text area and between the
491 scrollbar and the text. 504 scrollbar and the text.
492 505
… …
578 xterm style with 2.20 old word selection, or anything else which 591 xterm style with 2.20 old word selection, or anything else which
579 gives xterm style selection. 592 gives xterm style selection.
580 593
581 scrollstyle: *mode* 594 scrollstyle: *mode*
582 Set scrollbar style to rxvt, plain, next or xterm. plain is the 595 Set scrollbar style to rxvt, plain, next or xterm. plain is the
583 author's favourite.. 596 author's favourite.
584 597
585 title: *string* 598 title: *string*
586 Set window title string, the default title is the command-line 599 Set window title string, the default title is the command-line
587 specified after the -e option, if any, otherwise the application 600 specified after the -e option, if any, otherwise the application
588 name; option -title. 601 name; option -title.
… …
612 625
613 print-pipe: *string* 626 print-pipe: *string*
614 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 627 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use
615 Print to initiate a screen dump to the printer and Ctrl-Print or 628 Print to initiate a screen dump to the printer and Ctrl-Print or
616 Shift-Print to include the scrollback as well. 629 Shift-Print to include the scrollback as well.
630
631 The string will be interpreted as if typed into the shell as-is.
632
633 Example:
634
635 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
636
637 This creates a new file in your home directory with the screen
638 contents everytime you hit "Print".
617 639
618 scrollBar: *boolean* 640 scrollBar: *boolean*
619 True: enable the scrollbar [default]; option -sb. False: disable the 641 True: enable the scrollbar [default]; option -sb. False: disable the
620 scrollbar; option +sb. 642 scrollbar; option +sb.
621 643
… …
698 pointerColor2: *colour* 720 pointerColor2: *colour*
699 Mouse pointer background colour. 721 Mouse pointer background colour.
700 722
701 pointerBlankDelay: *number* 723 pointerBlankDelay: *number*
702 Specifies number of seconds before blanking the pointer [default 2]. 724 Specifies number of seconds before blanking the pointer [default 2].
725 Use a large number (e.g. 987654321) to effectively disable the
726 timeout.
703 727
704 backspacekey: *string* 728 backspacekey: *string*
705 The string to send when the backspace key is pressed. If set to DEC 729 The string to send when the backspace key is pressed. If set to DEC
706 or unset it will send Delete (code 127) or, if shifted, Backspace 730 or unset it will send Delete (code 127) or, if shifted, Backspace
707 (code 8) - which can be reversed with the appropriate DEC private 731 (code 8) - which can be reversed with the appropriate DEC private
… …
823 is interpreted and executed as rxvt's control sequence. For example 847 is interpreted and executed as rxvt's control sequence. For example
824 the following means "change the current locale to "zh_CN.GBK" when 848 the following means "change the current locale to "zh_CN.GBK" when
825 Control-Meta-c is being pressed": 849 Control-Meta-c is being pressed":
826 850
827 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 851 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
852
853 Due the the large number of modifier combinations, a defined key
854 mapping will match if at *at least* the specified identifiers are
855 being set, and no other key mappings with those and more bits are
856 being defined. That means that defining a key map for "a" will
857 automatically provide definitions for "Meta-a", "Shift-a" and so on,
858 unless some of those are defined mappings themselves.
859
860 Unfortunately, this will override built-in key mappings. For example
861 if you overwrite the "Insert" key you will disable rxvt's
862 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
863 the user-defined keymap using the "builtin:" replacement:
864
865 URxvt.keysym.Insert: <my insert key sequence>
866 URxvt.keysym.S-Insert: builtin:
867
868 The first line defines a mapping for "Insert" and *any* combination
869 of modifiers. The second line re-establishes the default mapping for
870 "Shift-Insert".
828 871
829 The following example will map Control-Meta-1 and Control-Meta-2 to 872 The following example will map Control-Meta-1 and Control-Meta-2 to
830 the fonts "suxuseuro" and "9x15bold", so you can have some limited 873 the fonts "suxuseuro" and "9x15bold", so you can have some limited
831 font-switching at runtime: 874 font-switching at runtime:
832 875
… …
1042 Used in the same way as "RXVTPATH". 1085 Used in the same way as "RXVTPATH".
1043 1086
1044 RXVT_SOCKET 1087 RXVT_SOCKET
1045 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1088 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1046 1089
1047 Default "$HOME/.rxvt-unicode-<nodename". 1090 Default $HOME/.rxvt-unicode-*<nodename*.
1048 1091
1049 HOME 1092 HOME
1050 Used to locate the default directory for the unix domain socket for 1093 Used to locate the default directory for the unix domain socket for
1051 daemon communications and to locate various resource files (such as 1094 daemon communications and to locate various resource files (such as
1052 ".Xdefaults") 1095 ".Xdefaults")
… …
1061FILES 1104FILES
1062 /usr/lib/X11/rgb.txt 1105 /usr/lib/X11/rgb.txt
1063 Color names. 1106 Color names.
1064 1107
1065SEE ALSO 1108SEE ALSO
1066 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1109 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1067 1110 tty(4), utmp(5)
1068BUGS
1069 Check the BUGS file for an up-to-date list.
1070
1071 Cursor change support is not yet implemented.
1072
1073 Click-and-drag doesn't work with X11 mouse report overriding.
1074 1111
1075CURRENT PROJECT COORDINATOR 1112CURRENT PROJECT COORDINATOR
1076 Project Coordinator 1113 Project Coordinator
1077 Marc A. Lehmann <rxvt-unicode@schmorp.de> 1114 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1078 1115

Diff Legend

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