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.18 by root, Fri Feb 18 12:15:07 2005 UTC vs.
Revision 1.23 by root, Thu Jul 7 19:37:47 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.6, 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
204 204
205 -sr|+sr 205 -sr|+sr
206 Put scrollbar on right/left; resource scrollBar_right. 206 Put scrollbar on right/left; resource scrollBar_right.
207 207
208 -st|+st 208 -st|+st
209 Display normal (non XTerm/NeXT) scrollbar without/with a trough; 209 Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
210 resource scrollBar_floating. 210 resource scrollBar_floating.
211 211
212 -ptab|+ptab 212 -ptab|+ptab
213 If enabled (default), "Horizontal Tab" characters are being stored 213 If enabled (default), "Horizontal Tab" characters are being stored
214 as actual wide characters in the screen buffer, which makes it 214 as actual wide characters in the screen buffer, which makes it
334 used or not. 334 used or not.
335 335
336 Here is a short Gtk2-perl snippet that illustrates how this option 336 Here is a short Gtk2-perl snippet that illustrates how this option
337 can be used (a longer example is in doc/embed): 337 can be used (a longer example is in doc/embed):
338 338
339 my $rxvt = new Gtk2::DrawingArea; 339 my $rxvt = new Gtk2::Socket;
340 $...->add ($rxvt); # important to add it somewhere first 340 $rxvt->signal_connect_after (realize => sub {
341 $rxvt->realize; # now it can be realized
342 my $xid = $rxvt->window->get_xid; 341 my $xid = $_[0]->window->get_xid;
343
344 system "rxvt -embed $xid &"; 342 system "rxvt -embed $xid &";
343 });
345 344
346 -pty-fd *fileno* 345 -pty-fd *fileno*
347 Tells rxvt NOT to execute any commands or create a new pty/tty pair 346 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 347 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 348 useful if you want to drive rxvt as a generic terminal emulator
482 scrollColor: *colour* 481 scrollColor: *colour*
483 Use the specified colour for the scrollbar [default #B2B2B2]. 482 Use the specified colour for the scrollbar [default #B2B2B2].
484 483
485 troughColor: *colour* 484 troughColor: *colour*
486 Use the specified colour for the scrollbar's trough area [default 485 Use the specified colour for the scrollbar's trough area [default
487 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 486 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
488 487
489 borderColor: *colour* 488 borderColor: *colour*
490 The colour of the border around the text area and between the 489 The colour of the border around the text area and between the
491 scrollbar and the text. 490 scrollbar and the text.
492 491
578 xterm style with 2.20 old word selection, or anything else which 577 xterm style with 2.20 old word selection, or anything else which
579 gives xterm style selection. 578 gives xterm style selection.
580 579
581 scrollstyle: *mode* 580 scrollstyle: *mode*
582 Set scrollbar style to rxvt, plain, next or xterm. plain is the 581 Set scrollbar style to rxvt, plain, next or xterm. plain is the
583 author's favourite.. 582 author's favourite.
584 583
585 title: *string* 584 title: *string*
586 Set window title string, the default title is the command-line 585 Set window title string, the default title is the command-line
587 specified after the -e option, if any, otherwise the application 586 specified after the -e option, if any, otherwise the application
588 name; option -title. 587 name; option -title.
612 611
613 print-pipe: *string* 612 print-pipe: *string*
614 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 613 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 614 Print to initiate a screen dump to the printer and Ctrl-Print or
616 Shift-Print to include the scrollback as well. 615 Shift-Print to include the scrollback as well.
616
617 The string will be interpreted as if typed into the shell as-is.
618
619 Example:
620
621 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
622
623 This creates a new file in your home directory with the screen
624 contents everytime you hit "Print".
617 625
618 scrollBar: *boolean* 626 scrollBar: *boolean*
619 True: enable the scrollbar [default]; option -sb. False: disable the 627 True: enable the scrollbar [default]; option -sb. False: disable the
620 scrollbar; option +sb. 628 scrollbar; option +sb.
621 629
698 pointerColor2: *colour* 706 pointerColor2: *colour*
699 Mouse pointer background colour. 707 Mouse pointer background colour.
700 708
701 pointerBlankDelay: *number* 709 pointerBlankDelay: *number*
702 Specifies number of seconds before blanking the pointer [default 2]. 710 Specifies number of seconds before blanking the pointer [default 2].
711 Use a large number (e.g. 987654321) to effectively disable the
712 timeout.
703 713
704 backspacekey: *string* 714 backspacekey: *string*
705 The string to send when the backspace key is pressed. If set to DEC 715 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 716 or unset it will send Delete (code 127) or, if shifted, Backspace
707 (code 8) - which can be reversed with the appropriate DEC private 717 (code 8) - which can be reversed with the appropriate DEC private
823 is interpreted and executed as rxvt's control sequence. For example 833 is interpreted and executed as rxvt's control sequence. For example
824 the following means "change the current locale to "zh_CN.GBK" when 834 the following means "change the current locale to "zh_CN.GBK" when
825 Control-Meta-c is being pressed": 835 Control-Meta-c is being pressed":
826 836
827 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 837 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
838
839 Due the the large number of modifier combinations, a defined key
840 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
842 being defined. That means that defining a key map for "a" will
843 automatically provide definitions for "Meta-a", "Shift-a" and so on,
844 unless some of those are defined mappings themselves.
845
846 Unfortunately, this will override built-in key mappings. For example
847 if you overwrite the "Insert" key you will disable rxvt's
848 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
849 the user-defined keymap using the "builtin:" replacement:
850
851 URxvt.keysym.Insert: <my insert key sequence>
852 URxvt.keysym.S-Insert: builtin:
853
854 The first line defines a mapping for "Insert" and *any* combination
855 of modifiers. The second line re-establishes the default mapping for
856 "Shift-Insert".
828 857
829 The following example will map Control-Meta-1 and Control-Meta-2 to 858 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 859 the fonts "suxuseuro" and "9x15bold", so you can have some limited
831 font-switching at runtime: 860 font-switching at runtime:
832 861
1042 Used in the same way as "RXVTPATH". 1071 Used in the same way as "RXVTPATH".
1043 1072
1044 RXVT_SOCKET 1073 RXVT_SOCKET
1045 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1074 The unix domain socket path used by rxvtc(1) and rxvtd(1).
1046 1075
1047 Default "$HOME/.rxvt-unicode-<nodename". 1076 Default $HOME/.rxvt-unicode-*<nodename*.
1048 1077
1049 HOME 1078 HOME
1050 Used to locate the default directory for the unix domain socket for 1079 Used to locate the default directory for the unix domain socket for
1051 daemon communications and to locate various resource files (such as 1080 daemon communications and to locate various resource files (such as
1052 ".Xdefaults") 1081 ".Xdefaults")
1061FILES 1090FILES
1062 /usr/lib/X11/rgb.txt 1091 /usr/lib/X11/rgb.txt
1063 Color names. 1092 Color names.
1064 1093
1065SEE ALSO 1094SEE ALSO
1066 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1095 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1096 tty(4), utmp(5)
1067 1097
1068BUGS 1098BUGS
1069 Check the BUGS file for an up-to-date list. 1099 Check the BUGS file for an up-to-date list.
1070 1100
1071 Cursor change support is not yet implemented. 1101 Cursor change support is not yet implemented.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines