ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.man.in
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.man.in (file contents):
Revision 1.15 by root, Mon Feb 14 18:47:54 2005 UTC vs.
Revision 1.24 by root, Thu Jul 7 19:37:46 2005 UTC

… …
127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title "rxvt 1" 131.IX Title "rxvt 1"
132.TH rxvt 1 "2005-02-14" "5.1" "RXVT-UNICODE" 132.TH rxvt 1 "2005-07-07" "5.6" "RXVT-UNICODE"
133.SH "NAME" 133.SH "NAME"
134rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system) 134rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system)
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137\&\fB@@RXVT_NAME@@\fR [options] [\-e command [ args ]] 137\&\fB@@RXVT_NAME@@\fR [options] [\-e command [ args ]]
… …
334.IP "\fB\-sr\fR|\fB+sr\fR" 4 334.IP "\fB\-sr\fR|\fB+sr\fR" 4
335.IX Item "-sr|+sr" 335.IX Item "-sr|+sr"
336Put scrollbar on right/left; resource \fBscrollBar_right\fR. 336Put scrollbar on right/left; resource \fBscrollBar_right\fR.
337.IP "\fB\-st\fR|\fB+st\fR" 4 337.IP "\fB\-st\fR|\fB+st\fR" 4
338.IX Item "-st|+st" 338.IX Item "-st|+st"
339Display normal (non XTerm/NeXT) scrollbar without/with a trough; 339Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
340resource \fBscrollBar_floating\fR. 340resource \fBscrollBar_floating\fR.
341.IP "\fB\-ptab\fR|\fB+ptab\fR" 4 341.IP "\fB\-ptab\fR|\fB+ptab\fR" 4
342.IX Item "-ptab|+ptab" 342.IX Item "-ptab|+ptab"
343If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as 343If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as
344actual wide characters in the screen buffer, which makes it possible to 344actual wide characters in the screen buffer, which makes it possible to
… …
441\&\fBsecondaryScreen\fR. 441\&\fBsecondaryScreen\fR.
442.IP "\fB\-ssr\fR|\fB+ssr\fR" 4 442.IP "\fB\-ssr\fR|\fB+ssr\fR" 4
443.IX Item "-ssr|+ssr" 443.IX Item "-ssr|+ssr"
444Turn on/off secondary screen scroll (default enabled); resource 444Turn on/off secondary screen scroll (default enabled); resource
445\&\fBsecondaryScroll\fR. 445\&\fBsecondaryScroll\fR.
446.IP "\fB\-keysym.\fR\fIsym\fR: \fIstring\fR" 4 446.IP "\fB\-keysym.\fR\fIsym\fR \fIstring\fR" 4
447.IX Item "-keysym.sym: string" 447.IX Item "-keysym.sym string"
448Remap a key symbol. See resource \fBkeysym\fR. 448Remap a key symbol. See resource \fBkeysym\fR.
449.IP "\fB\-embed\fR: \fIwindowid\fR" 4 449.IP "\fB\-embed\fR \fIwindowid\fR" 4
450.IX Item "-embed: windowid" 450.IX Item "-embed windowid"
451Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 451Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
452which enables applications to easily embed a terminal. 452which enables applications to easily embed a terminal.
453.Sp 453.Sp
454Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 454Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
455shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 455shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
456quite a bit, so don't expect it to keep some specific state. It's best to 456quite a bit, so don't expect it to keep some specific state. It's best to
457create an extra subwindow for @@RXVT_NAME@@ and leave it alone. 457create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
458.Sp
459The window will not be destroyed when @@RXVT_NAME@@ exits.
458.Sp 460.Sp
459It might be useful to know that @@RXVT_NAME@@ will not close file 461It might be useful to know that @@RXVT_NAME@@ will not close file
460descriptors passed to it (except for stdin/out/err, of course), so you 462descriptors passed to it (except for stdin/out/err, of course), so you
461can use file descriptors to communicate with the programs within the 463can use file descriptors to communicate with the programs within the
462terminal. This works regardless of wether the \f(CW\*(C`\-embed\*(C'\fR option was used or 464terminal. This works regardless of wether the \f(CW\*(C`\-embed\*(C'\fR option was used or
463not. 465not.
466.Sp
467Here is a short Gtk2\-perl snippet that illustrates how this option can be
468used (a longer example is in \fIdoc/embed\fR):
469.Sp
470.Vb 5
471\& my $rxvt = new Gtk2::Socket;
472\& $rxvt->signal_connect_after (realize => sub {
473\& my $xid = $_[0]->window->get_xid;
474\& system "@@RXVT_NAME@@ -embed $xid &";
475\& });
476.Ve
477.IP "\fB\-pty\-fd\fR \fIfileno\fR" 4
478.IX Item "-pty-fd fileno"
479Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty
480pair but instead use the given filehandle as the tty master. This is
481useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
482without having to run a program within it.
483.Sp
484If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
485entries and will not tinker with pty/tty permissions \- you have to do that
486yourself if you want that.
487.Sp
488Here is a example in perl that illustrates how this option can be used (a
489longer example is in \fIdoc/pty\-fd\fR):
490.Sp
491.Vb 2
492\& use IO::Pty;
493\& use Fcntl;
494.Ve
495.Sp
496.Vb 4
497\& my $pty = new IO::Pty;
498\& fcntl $pty, F_SETFD, 0; # clear close-on-exec
499\& system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
500\& close $pty;
501.Ve
502.Sp
503.Vb 3
504\& # now communicate with rxvt
505\& my $slave = $pty->slave;
506\& while (<$slave>) { print $slave "got <$_>\en" }
507.Ve
464.SH "RESOURCES (available also as long\-options)" 508.SH "RESOURCES (available also as long\-options)"
465.IX Header "RESOURCES (available also as long-options)" 509.IX Header "RESOURCES (available also as long-options)"
466Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long 510Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long
467options) compiled into your version. 511options) compiled into your version.
468.PP 512.PP
… …
582.IX Item "scrollColor: colour" 626.IX Item "scrollColor: colour"
583Use the specified colour for the scrollbar [default #B2B2B2]. 627Use the specified colour for the scrollbar [default #B2B2B2].
584.IP "\fBtroughColor:\fR \fIcolour\fR" 4 628.IP "\fBtroughColor:\fR \fIcolour\fR" 4
585.IX Item "troughColor: colour" 629.IX Item "troughColor: colour"
586Use the specified colour for the scrollbar's trough area [default 630Use the specified colour for the scrollbar's trough area [default
587#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 631#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
588.IP "\fBborderColor:\fR \fIcolour\fR" 4 632.IP "\fBborderColor:\fR \fIcolour\fR" 4
589.IX Item "borderColor: colour" 633.IX Item "borderColor: colour"
590The colour of the border around the text area and between the scrollbar 634The colour of the border around the text area and between the scrollbar
591and the text. 635and the text.
592.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4 636.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4
… …
680xterm style with 2.20 old word selection, or anything else which gives 724xterm style with 2.20 old word selection, or anything else which gives
681xterm style selection. 725xterm style selection.
682.IP "\fBscrollstyle:\fR \fImode\fR" 4 726.IP "\fBscrollstyle:\fR \fImode\fR" 4
683.IX Item "scrollstyle: mode" 727.IX Item "scrollstyle: mode"
684Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is 728Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is
685the author's favourite.. 729the author's favourite.
686.IP "\fBtitle:\fR \fIstring\fR" 4 730.IP "\fBtitle:\fR \fIstring\fR" 4
687.IX Item "title: string" 731.IX Item "title: string"
688Set window title string, the default title is the command-line 732Set window title string, the default title is the command-line
689specified after the \fB\-e\fR option, if any, otherwise the application 733specified after the \fB\-e\fR option, if any, otherwise the application
690name; option \fB\-title\fR. 734name; option \fB\-title\fR.
… …
714.IP "\fBprint\-pipe:\fR \fIstring\fR" 4 758.IP "\fBprint\-pipe:\fR \fIstring\fR" 4
715.IX Item "print-pipe: string" 759.IX Item "print-pipe: string"
716Specify a command pipe for vt100 printer [default \fI\fIlpr\fI\|(1)\fR]. Use 760Specify a command pipe for vt100 printer [default \fI\fIlpr\fI\|(1)\fR]. Use
717\&\fBPrint\fR to initiate a screen dump to the printer and \fBCtrl-Print\fR or 761\&\fBPrint\fR to initiate a screen dump to the printer and \fBCtrl-Print\fR or
718\&\fBShift-Print\fR to include the scrollback as well. 762\&\fBShift-Print\fR to include the scrollback as well.
763.Sp
764The string will be interpreted as if typed into the shell as\-is.
765.Sp
766Example:
767.Sp
768.Vb 1
769\& URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
770.Ve
771.Sp
772This creates a new file in your home directory with the screen contents
773everytime you hit \f(CW\*(C`Print\*(C'\fR.
719.IP "\fBscrollBar:\fR \fIboolean\fR" 4 774.IP "\fBscrollBar:\fR \fIboolean\fR" 4
720.IX Item "scrollBar: boolean" 775.IX Item "scrollBar: boolean"
721\&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR: 776\&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR:
722disable the scrollbar; option \fB+sb\fR. 777disable the scrollbar; option \fB+sb\fR.
723.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4 778.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4
… …
738\&\fBFalse\fR: do not scroll to bottom when tty receives output; option 793\&\fBFalse\fR: do not scroll to bottom when tty receives output; option
739\&\fB+si\fR. 794\&\fB+si\fR.
740.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4 795.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4
741.IX Item "scrollWithBuffer: boolean" 796.IX Item "scrollWithBuffer: boolean"
742\&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and 797\&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and
743\&\fBscrollTtyOutput\fR is False); option \fB+sw\fR. \fBFalse\fR: do not scroll 798\&\fBscrollTtyOutput\fR is False); option \fB\-sw\fR. \fBFalse\fR: do not scroll
744with scrollback buffer when tty recieves new lines; option \fB\-sw\fR. 799with scrollback buffer when tty recieves new lines; option \fB+sw\fR.
745.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4 800.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4
746.IX Item "scrollTtyKeypress: boolean" 801.IX Item "scrollTtyKeypress: boolean"
747\&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys 802\&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys
748are those which are intercepted by rxvt-unicode for special handling and 803are those which are intercepted by rxvt-unicode for special handling and
749are not passed onto the shell; option \fB\-sk\fR. \fBFalse\fR: do not scroll to 804are not passed onto the shell; option \fB\-sk\fR. \fBFalse\fR: do not scroll to
… …
799.IP "\fBpointerColor2:\fR \fIcolour\fR" 4 854.IP "\fBpointerColor2:\fR \fIcolour\fR" 4
800.IX Item "pointerColor2: colour" 855.IX Item "pointerColor2: colour"
801Mouse pointer background colour. 856Mouse pointer background colour.
802.IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4 857.IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4
803.IX Item "pointerBlankDelay: number" 858.IX Item "pointerBlankDelay: number"
804Specifies number of seconds before blanking the pointer [default 2]. 859Specifies number of seconds before blanking the pointer [default 2]. Use a
860large number (e.g. \f(CW987654321\fR) to effectively disable the timeout.
805.IP "\fBbackspacekey:\fR \fIstring\fR" 4 861.IP "\fBbackspacekey:\fR \fIstring\fR" 4
806.IX Item "backspacekey: string" 862.IX Item "backspacekey: string"
807The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR 863The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR
808or unset it will send \fBDelete\fR (code 127) or, if shifted, \fBBackspace\fR 864or unset it will send \fBDelete\fR (code 127) or, if shifted, \fBBackspace\fR
809(code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode 865(code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode
… …
933.Sp 989.Sp
934.Vb 1 990.Vb 1
935\& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007 991\& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007
936.Ve 992.Ve
937.Sp 993.Sp
994Due the the large number of modifier combinations, a defined key mapping
995will match if at \fIat least\fR the specified identifiers are being set, and
996no other key mappings with those and more bits are being defined. That
997means that defining a key map for \f(CW\*(C`a\*(C'\fR will automatically provide
998definitions for \f(CW\*(C`Meta\-a\*(C'\fR, \f(CW\*(C`Shift\-a\*(C'\fR and so on, unless some of those are defined
999mappings themselves.
1000.Sp
1001Unfortunately, this will override built-in key mappings. For example
1002if you overwrite the \f(CW\*(C`Insert\*(C'\fR key you will disable @@RXVT_NAME@@'s
1003\&\f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke \*(L"holes\*(R" into the
1004user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement:
1005.Sp
1006.Vb 2
1007\& URxvt.keysym.Insert: <my insert key sequence>
1008\& URxvt.keysym.S-Insert: builtin:
1009.Ve
1010.Sp
1011The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination
1012of modifiers. The second line re-establishes the default mapping for
1013\&\f(CW\*(C`Shift\-Insert\*(C'\fR.
1014.Sp
938The following example will map Control\-Meta\-1 and Control\-Meta\-2 to 1015The following example will map Control\-Meta\-1 and Control\-Meta\-2 to
939the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited 1016the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited
940font-switching at runtime: 1017font-switching at runtime:
941.Sp 1018.Sp
942.Vb 2 1019.Vb 2
… …
1158.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4 1235.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
1159.IX Item "RXVT_SOCKET" 1236.IX Item "RXVT_SOCKET"
1160The unix domain socket path used by @@RXVT_NAME@@c(1) and 1237The unix domain socket path used by @@RXVT_NAME@@c(1) and
1161@@RXVT_NAME@@d(1). 1238@@RXVT_NAME@@d(1).
1162.Sp 1239.Sp
1163Default \f(CW\*(C`$HOME/.rxvt\-unicode\-<nodename\*(C'\fR. 1240Default \fI$HOME/.rxvt\-unicode\-\fI<nodename\fI\fR.
1164.IP "\fB\s-1HOME\s0\fR" 4 1241.IP "\fB\s-1HOME\s0\fR" 4
1165.IX Item "HOME" 1242.IX Item "HOME"
1166Used to locate the default directory for the unix domain socket for 1243Used to locate the default directory for the unix domain socket for
1167daemon communications and to locate various resource files (such as 1244daemon communications and to locate various resource files (such as
1168\&\f(CW\*(C`.Xdefaults\*(C'\fR) 1245\&\f(CW\*(C`.Xdefaults\*(C'\fR)
… …
1178.IP "\fB/usr/lib/X11/rgb.txt\fR" 4 1255.IP "\fB/usr/lib/X11/rgb.txt\fR" 4
1179.IX Item "/usr/lib/X11/rgb.txt" 1256.IX Item "/usr/lib/X11/rgb.txt"
1180Color names. 1257Color names.
1181.SH "SEE ALSO" 1258.SH "SEE ALSO"
1182.IX Header "SEE ALSO" 1259.IX Header "SEE ALSO"
1183@@RXVT_NAME@@(7), \fIxterm\fR\|(1), \fIsh\fR\|(1), \fIresize\fR\|(1), X(1), \fIpty\fR\|(4), \fItty\fR\|(4), \fIutmp\fR\|(5) 1260@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), \fIxterm\fR\|(1), \fIsh\fR\|(1), \fIresize\fR\|(1), X(1), \fIpty\fR\|(4), \fItty\fR\|(4), \fIutmp\fR\|(5)
1184.SH "BUGS" 1261.SH "BUGS"
1185.IX Header "BUGS" 1262.IX Header "BUGS"
1186Check the \s-1BUGS\s0 file for an up-to-date list. 1263Check the \s-1BUGS\s0 file for an up-to-date list.
1187.PP 1264.PP
1188Cursor change support is not yet implemented. 1265Cursor change support is not yet implemented.

Diff Legend

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