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.16 by root, Wed Feb 16 22:16:30 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
311 311
312 -ssr|+ssr 312 -ssr|+ssr
313 Turn on/off secondary screen scroll (default enabled); resource 313 Turn on/off secondary screen scroll (default enabled); resource
314 secondaryScroll. 314 secondaryScroll.
315 315
316 -keysym.*sym*: *string* 316 -keysym.*sym* *string*
317 Remap a key symbol. See resource keysym. 317 Remap a key symbol. See resource keysym.
318 318
319 -embed: *windowid* 319 -embed *windowid*
320 Tells rxvt to embed it's windows into an already-existing window, 320 Tells rxvt to embed it's windows into an already-existing window,
321 which enables applications to easily embed a terminal. 321 which enables applications to easily embed a terminal.
322 322
323 Right now, rxvt will first unmap/map the specified window, so it 323 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 324 shouldn't be a top-level window. rxvt will also reconfigure it quite
330 It might be useful to know that rxvt will not close file descriptors 330 It might be useful to know that rxvt will not close file descriptors
331 passed to it (except for stdin/out/err, of course), so you can use 331 passed to it (except for stdin/out/err, of course), so you can use
332 file descriptors to communicate with the programs within the 332 file descriptors to communicate with the programs within the
333 terminal. This works regardless of wether the "-embed" option was 333 terminal. This works regardless of wether the "-embed" option was
334 used or not. 334 used or not.
335
336 Here is a short Gtk2-perl snippet that illustrates how this option
337 can be used (a longer example is in doc/embed):
338
339 my $rxvt = new Gtk2::Socket;
340 $rxvt->signal_connect_after (realize => sub {
341 my $xid = $_[0]->window->get_xid;
342 system "rxvt -embed $xid &";
343 });
344
345 -pty-fd *fileno*
346 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
348 useful if you want to drive rxvt as a generic terminal emulator
349 without having to run a program within it.
350
351 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
353 yourself if you want that.
354
355 Here is a example in perl that illustrates how this option can be
356 used (a longer example is in doc/pty-fd):
357
358 use IO::Pty;
359 use Fcntl;
360
361 my $pty = new IO::Pty;
362 fcntl $pty, F_SETFD, 0; # clear close-on-exec
363 system "rxvt -pty-fd " . (fileno $pty) . "&";
364 close $pty;
365
366 # now communicate with rxvt
367 my $slave = $pty->slave;
368 while (<$slave>) { print $slave "got <$_>\n" }
335 369
336RESOURCES (available also as long-options) 370RESOURCES (available also as long-options)
337 Note: `rxvt --help' gives a list of all resources (long options) 371 Note: `rxvt --help' gives a list of all resources (long options)
338 compiled into your version. 372 compiled into your version.
339 373
447 scrollColor: *colour* 481 scrollColor: *colour*
448 Use the specified colour for the scrollbar [default #B2B2B2]. 482 Use the specified colour for the scrollbar [default #B2B2B2].
449 483
450 troughColor: *colour* 484 troughColor: *colour*
451 Use the specified colour for the scrollbar's trough area [default 485 Use the specified colour for the scrollbar's trough area [default
452 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 486 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
453 487
454 borderColor: *colour* 488 borderColor: *colour*
455 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
456 scrollbar and the text. 490 scrollbar and the text.
457 491
543 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
544 gives xterm style selection. 578 gives xterm style selection.
545 579
546 scrollstyle: *mode* 580 scrollstyle: *mode*
547 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
548 author's favourite.. 582 author's favourite.
549 583
550 title: *string* 584 title: *string*
551 Set window title string, the default title is the command-line 585 Set window title string, the default title is the command-line
552 specified after the -e option, if any, otherwise the application 586 specified after the -e option, if any, otherwise the application
553 name; option -title. 587 name; option -title.
577 611
578 print-pipe: *string* 612 print-pipe: *string*
579 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 613 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use
580 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
581 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".
582 625
583 scrollBar: *boolean* 626 scrollBar: *boolean*
584 True: enable the scrollbar [default]; option -sb. False: disable the 627 True: enable the scrollbar [default]; option -sb. False: disable the
585 scrollbar; option +sb. 628 scrollbar; option +sb.
586 629
663 pointerColor2: *colour* 706 pointerColor2: *colour*
664 Mouse pointer background colour. 707 Mouse pointer background colour.
665 708
666 pointerBlankDelay: *number* 709 pointerBlankDelay: *number*
667 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.
668 713
669 backspacekey: *string* 714 backspacekey: *string*
670 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
671 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
672 (code 8) - which can be reversed with the appropriate DEC private 717 (code 8) - which can be reversed with the appropriate DEC private
788 is interpreted and executed as rxvt's control sequence. For example 833 is interpreted and executed as rxvt's control sequence. For example
789 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
790 Control-Meta-c is being pressed": 835 Control-Meta-c is being pressed":
791 836
792 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".
793 857
794 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
795 the fonts "suxuseuro" and "9x15bold", so you can have some limited 859 the fonts "suxuseuro" and "9x15bold", so you can have some limited
796 font-switching at runtime: 860 font-switching at runtime:
797 861
1007 Used in the same way as "RXVTPATH". 1071 Used in the same way as "RXVTPATH".
1008 1072
1009 RXVT_SOCKET 1073 RXVT_SOCKET
1010 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).
1011 1075
1012 Default "$HOME/.rxvt-unicode-<nodename". 1076 Default $HOME/.rxvt-unicode-*<nodename*.
1013 1077
1014 HOME 1078 HOME
1015 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
1016 daemon communications and to locate various resource files (such as 1080 daemon communications and to locate various resource files (such as
1017 ".Xdefaults") 1081 ".Xdefaults")
1026FILES 1090FILES
1027 /usr/lib/X11/rgb.txt 1091 /usr/lib/X11/rgb.txt
1028 Color names. 1092 Color names.
1029 1093
1030SEE ALSO 1094SEE ALSO
1031 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)
1032 1097
1033BUGS 1098BUGS
1034 Check the BUGS file for an up-to-date list. 1099 Check the BUGS file for an up-to-date list.
1035 1100
1036 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