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.11 by root, Fri Feb 11 18:14:07 2005 UTC vs.
Revision 1.26 by root, Sat Dec 17 20:55:45 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.0, is a colour vt102 terminal emulator intended 9 rxvt-unicode, version 5.9, 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
… …
311 319
312 -ssr|+ssr 320 -ssr|+ssr
313 Turn on/off secondary screen scroll (default enabled); resource 321 Turn on/off secondary screen scroll (default enabled); resource
314 secondaryScroll. 322 secondaryScroll.
315 323
316 -keysym.*sym*: *string* 324 -keysym.*sym* *string*
317 Remap a key symbol. See resource keysym. 325 Remap a key symbol. See resource keysym.
318 326
319 -xrm *resourcestring* 327 -embed *windowid*
320 No effect on rxvt-unicode. Simply passes through an argument to be 328 Tells rxvt to embed it's windows into an already-existing window,
321 made available in the instance's argument list. Appears in 329 which enables applications to easily embed a terminal.
322 *WM_COMMAND* in some window managers. 330
331 Right now, rxvt will first unmap/map the specified window, so it
332 shouldn't be a top-level window. rxvt will also reconfigure it quite
333 a bit, so don't expect it to keep some specific state. It's best to
334 create an extra subwindow for rxvt and leave it alone.
335
336 The window will not be destroyed when rxvt exits.
337
338 It might be useful to know that rxvt will not close file descriptors
339 passed to it (except for stdin/out/err, of course), so you can use
340 file descriptors to communicate with the programs within the
341 terminal. This works regardless of wether the "-embed" option was
342 used or not.
343
344 Here is a short Gtk2-perl snippet that illustrates how this option
345 can be used (a longer example is in doc/embed):
346
347 my $rxvt = new Gtk2::Socket;
348 $rxvt->signal_connect_after (realize => sub {
349 my $xid = $_[0]->window->get_xid;
350 system "rxvt -embed $xid &";
351 });
352
353 -pty-fd *fileno*
354 Tells rxvt NOT to execute any commands or create a new pty/tty pair
355 but instead use the given filehandle as the tty master. This is
356 useful if you want to drive rxvt as a generic terminal emulator
357 without having to run a program within it.
358
359 If this switch is given, rxvt will not create any utmp/wtmp entries
360 and will not tinker with pty/tty permissions - you have to do that
361 yourself if you want that.
362
363 Here is a example in perl that illustrates how this option can be
364 used (a longer example is in doc/pty-fd):
365
366 use IO::Pty;
367 use Fcntl;
368
369 my $pty = new IO::Pty;
370 fcntl $pty, F_SETFD, 0; # clear close-on-exec
371 system "rxvt -pty-fd " . (fileno $pty) . "&";
372 close $pty;
373
374 # now communicate with rxvt
375 my $slave = $pty->slave;
376 while (<$slave>) { print $slave "got <$_>\n" }
323 377
324RESOURCES (available also as long-options) 378RESOURCES (available also as long-options)
325 Note: `rxvt --help' gives a list of all resources (long options) 379 Note: `rxvt --help' gives a list of all resources (long options)
326 compiled into your version. 380 compiled into your version.
327 381
… …
421 True: make the background inherit the parent windows' pixmap, giving 475 True: make the background inherit the parent windows' pixmap, giving
422 artificial transparency. False: do not inherit the parent windows' 476 artificial transparency. False: do not inherit the parent windows'
423 pixmap. 477 pixmap.
424 478
425 fading: *number* 479 fading: *number*
426 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.
427 486
428 tintColor: *colour* 487 tintColor: *colour*
429 Tint the transparent background pixmap with the given colour. 488 Tint the transparent background pixmap with the given colour; option
489 -tint.
430 490
431 shading: *number* 491 shading: *number*
432 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 492 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
433 image in addition to tinting it. 493 image in addition to tinting it.
434 494
435 scrollColor: *colour* 495 scrollColor: *colour*
436 Use the specified colour for the scrollbar [default #B2B2B2]. 496 Use the specified colour for the scrollbar [default #B2B2B2].
437 497
438 troughColor: *colour* 498 troughColor: *colour*
439 Use the specified colour for the scrollbar's trough area [default 499 Use the specified colour for the scrollbar's trough area [default
440 #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 500 #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
441 501
442 borderColor: *colour* 502 borderColor: *colour*
443 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
444 scrollbar and the text. 504 scrollbar and the text.
445 505
… …
531 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
532 gives xterm style selection. 592 gives xterm style selection.
533 593
534 scrollstyle: *mode* 594 scrollstyle: *mode*
535 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
536 author's favourite.. 596 author's favourite.
537 597
538 title: *string* 598 title: *string*
539 Set window title string, the default title is the command-line 599 Set window title string, the default title is the command-line
540 specified after the -e option, if any, otherwise the application 600 specified after the -e option, if any, otherwise the application
541 name; option -title. 601 name; option -title.
… …
566 print-pipe: *string* 626 print-pipe: *string*
567 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use 627 Specify a command pipe for vt100 printer [default *lpr(1)*]. Use
568 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
569 Shift-Print to include the scrollback as well. 629 Shift-Print to include the scrollback as well.
570 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".
639
571 scrollBar: *boolean* 640 scrollBar: *boolean*
572 True: enable the scrollbar [default]; option -sb. False: disable the 641 True: enable the scrollbar [default]; option -sb. False: disable the
573 scrollbar; option +sb. 642 scrollbar; option +sb.
574 643
575 scrollBar_right: *boolean* 644 scrollBar_right: *boolean*
… …
588 True: scroll to bottom when tty receives output; option -si. False: 657 True: scroll to bottom when tty receives output; option -si. False:
589 do not scroll to bottom when tty receives output; option +si. 658 do not scroll to bottom when tty receives output; option +si.
590 659
591 scrollWithBuffer: *boolean* 660 scrollWithBuffer: *boolean*
592 True: scroll with scrollback buffer when tty receives new lines (and 661 True: scroll with scrollback buffer when tty receives new lines (and
593 scrollTtyOutput is False); option +sw. False: do not scroll with 662 scrollTtyOutput is False); option -sw. False: do not scroll with
594 scrollback buffer when tty recieves new lines; option -sw. 663 scrollback buffer when tty recieves new lines; option +sw.
595 664
596 scrollTtyKeypress: *boolean* 665 scrollTtyKeypress: *boolean*
597 True: scroll to bottom when a non-special key is pressed. Special 666 True: scroll to bottom when a non-special key is pressed. Special
598 keys are those which are intercepted by rxvt-unicode for special 667 keys are those which are intercepted by rxvt-unicode for special
599 handling and are not passed onto the shell; option -sk. False: do 668 handling and are not passed onto the shell; option -sk. False: do
… …
651 pointerColor2: *colour* 720 pointerColor2: *colour*
652 Mouse pointer background colour. 721 Mouse pointer background colour.
653 722
654 pointerBlankDelay: *number* 723 pointerBlankDelay: *number*
655 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.
656 727
657 backspacekey: *string* 728 backspacekey: *string*
658 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
659 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
660 (code 8) - which can be reversed with the appropriate DEC private 731 (code 8) - which can be reversed with the appropriate DEC private
… …
698 769
699 insecure: *boolean* 770 insecure: *boolean*
700 Enables "insecure" mode. Rxvt-unicode offers some escape sequences 771 Enables "insecure" mode. Rxvt-unicode offers some escape sequences
701 that echo arbitrary strings like the icon name or the locale. This 772 that echo arbitrary strings like the icon name or the locale. This
702 could be abused if somebody gets 8-bit-clean access to your display, 773 could be abused if somebody gets 8-bit-clean access to your display,
703 whether throuh a mail client displaying mail bodies unfiltered or 774 whether through a mail client displaying mail bodies unfiltered or
704 though write(1). Therefore, these sequences are disabled by default. 775 through write(1) or any other means. Therefore, these sequences are
705 (Note that other terminals, including xterm, have these sequences 776 disabled by default. (Note that many other terminals, including
706 enabled by default). You can enable them by setting this boolean 777 xterm, have these sequences enabled by default, which doesn't make
707 resource or specifying -insecure as an option. At the moment, this 778 it safer, though).
708 enabled display-answer, locale, findfont, icon label and window 779
709 title requests as well as dynamic menubar dispatch. 780 You can enable them by setting this boolean resource or specifying
781 -insecure as an option. At the moment, this enables display-answer,
782 locale, findfont, icon label and window title requests as well as
783 dynamic menubar dispatch.
710 784
711 modifier: *modifier* 785 modifier: *modifier*
712 Set the key to be interpreted as the Meta key to: alt, meta, hyper, 786 Set the key to be interpreted as the Meta key to: alt, meta, hyper,
713 super, mod1, mod2, mod3, mod4, mod5; option -mod. 787 super, mod1, mod2, mod3, mod4, mod5; option -mod.
714 788
… …
777 the following means "change the current locale to "zh_CN.GBK" when 851 the following means "change the current locale to "zh_CN.GBK" when
778 Control-Meta-c is being pressed": 852 Control-Meta-c is being pressed":
779 853
780 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 854 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
781 855
856 Due the the large number of modifier combinations, a defined key
857 mapping will match if at *at least* the specified identifiers are
858 being set, and no other key mappings with those and more bits are
859 being defined. That means that defining a key map for "a" will
860 automatically provide definitions for "Meta-a", "Shift-a" and so on,
861 unless some of those are defined mappings themselves.
862
863 Unfortunately, this will override built-in key mappings. For example
864 if you overwrite the "Insert" key you will disable rxvt's
865 "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
866 the user-defined keymap using the "builtin:" replacement:
867
868 URxvt.keysym.Insert: <my insert key sequence>
869 URxvt.keysym.S-Insert: builtin:
870
871 The first line defines a mapping for "Insert" and *any* combination
872 of modifiers. The second line re-establishes the default mapping for
873 "Shift-Insert".
874
782 The following example will map Control-Meta-1 and Control-Meta-2 to 875 The following example will map Control-Meta-1 and Control-Meta-2 to
783 the fonts "suxuseuro" and "9x15bold", so you can have some limited 876 the fonts "suxuseuro" and "9x15bold", so you can have some limited
784 font-switching at runtime: 877 font-switching at runtime:
785 878
786 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 879 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
… …
839 supported in rxvt-unicode. Bug me if you need this. 932 supported in rxvt-unicode. Bug me if you need this.
840 933
841 You can, however, switch fonts at runtime using escape sequences (and 934 You can, however, switch fonts at runtime using escape sequences (and
842 therefore using the menubar), e.g.: 935 therefore using the menubar), e.g.:
843 936
844 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 937 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
845 938
846 rxvt-unicode will automatically re-apply these fonts to the output so 939 rxvt-unicode will automatically re-apply these fonts to the output so
847 far. 940 far.
848 941
849ISO 14755 SUPPORT 942ISO 14755 SUPPORT
… …
966 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is 1059 Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
967 the colour code used as default foreground/text colour (or the 1060 the colour code used as default foreground/text colour (or the
968 string "default" to indicate that the default-colour escape sequence 1061 string "default" to indicate that the default-colour escape sequence
969 is to be used), "bg" is the colour code used as default background 1062 is to be used), "bg" is the colour code used as default background
970 colour (or the string "default"), and "xpm" is the string "default" 1063 colour (or the string "default"), and "xpm" is the string "default"
971 if rxvt was compiled with XPM support. Libraries like "slang" can 1064 if rxvt was compiled with XPM support. Libraries like "ncurses" and
972 (and do) use this information to optimize screen output. 1065 "slang" can (and do) use this information to optimize screen output.
973 1066
974 WINDOWID 1067 WINDOWID
975 Set to the (decimal) X Window ID of the rxvt window (the toplevel 1068 Set to the (decimal) X Window ID of the rxvt window (the toplevel
976 window, which usually has subwindows for the scrollbar, the terminal 1069 window, which usually has subwindows for the scrollbar, the terminal
977 window and so on). 1070 window and so on).
… …
995 Used in the same way as "RXVTPATH". 1088 Used in the same way as "RXVTPATH".
996 1089
997 RXVT_SOCKET 1090 RXVT_SOCKET
998 The unix domain socket path used by rxvtc(1) and rxvtd(1). 1091 The unix domain socket path used by rxvtc(1) and rxvtd(1).
999 1092
1000 Default "$HOME/.rxvt-unicode-<nodename". 1093 Default $HOME/.rxvt-unicode-*<nodename*.
1001 1094
1002 HOME 1095 HOME
1003 Used to locate the default directory for the unix domain socket for 1096 Used to locate the default directory for the unix domain socket for
1004 daemon communications and to locate various resource files (such as 1097 daemon communications and to locate various resource files (such as
1005 ".Xdefaults") 1098 ".Xdefaults")
… …
1014FILES 1107FILES
1015 /usr/lib/X11/rgb.txt 1108 /usr/lib/X11/rgb.txt
1016 Color names. 1109 Color names.
1017 1110
1018SEE ALSO 1111SEE ALSO
1019 rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1112 rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
1020 1113 tty(4), utmp(5)
1021BUGS
1022 Check the BUGS file for an up-to-date list.
1023
1024 Cursor change support is not yet implemented.
1025
1026 Click-and-drag doesn't work with X11 mouse report overriding.
1027 1114
1028CURRENT PROJECT COORDINATOR 1115CURRENT PROJECT COORDINATOR
1029 Project Coordinator 1116 Project Coordinator
1030 Marc A. Lehmann rxvt@schmorp.de 1117 Marc A. Lehmann <rxvt-unicode@schmorp.de>
1031 1118
1032 <http://software.schmorp.de/> 1119 <http://software.schmorp.de/#rxvt-unicode>
1033 1120
1034AUTHORS 1121AUTHORS
1035 John Bovey 1122 John Bovey
1036 University of Kent, 1992, wrote the original Xvt. 1123 University of Kent, 1992, wrote the original Xvt.
1037 1124
… …
1051 1138
1052 Geoff Wing <gcw@pobox.com> 1139 Geoff Wing <gcw@pobox.com>
1053 Rewrote screen display and text selection routines. Project 1140 Rewrote screen display and text selection routines. Project
1054 Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1141 Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1055 1142
1056 Marc Alexander Lehmann <rxvt@schmorp.de> 1143 Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1057 Forked rxvt-unicode, rewrote most of the display code and internal 1144 Forked rxvt-unicode, rewrote most of the display code and internal
1058 character handling to store text in unicode, improve xterm 1145 character handling to store text in unicode, improve xterm
1059 compatibility and apply numerous other bugfixes and extensions. 1146 compatibility and apply numerous other bugfixes and extensions.
1060 1147
1061 Project Coordinator (Changes 1.0 -) 1148 Project Coordinator (Changes 1.0 -)

Diff Legend

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