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.19 by root, Fri Feb 18 12:15:07 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-18" "5.2" "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
… …
465not. 465not.
466.Sp 466.Sp
467Here is a short Gtk2\-perl snippet that illustrates how this option can be 467Here is a short Gtk2\-perl snippet that illustrates how this option can be
468used (a longer example is in \fIdoc/embed\fR): 468used (a longer example is in \fIdoc/embed\fR):
469.Sp 469.Sp
470.Vb 4 470.Vb 5
471\& my $rxvt = new Gtk2::DrawingArea; 471\& my $rxvt = new Gtk2::Socket;
472\& $...->add ($rxvt); # important to add it somewhere first 472\& $rxvt->signal_connect_after (realize => sub {
473\& $rxvt->realize; # now it can be realized
474\& my $xid = $rxvt->window->get_xid; 473\& my $xid = $_[0]->window->get_xid;
475.Ve
476.Sp
477.Vb 1
478\& system "@@RXVT_NAME@@ -embed $xid &"; 474\& system "@@RXVT_NAME@@ -embed $xid &";
475\& });
479.Ve 476.Ve
480.IP "\fB\-pty\-fd\fR \fIfileno\fR" 4 477.IP "\fB\-pty\-fd\fR \fIfileno\fR" 4
481.IX Item "-pty-fd fileno" 478.IX Item "-pty-fd fileno"
482Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty 479Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty
483pair but instead use the given filehandle as the tty master. This is 480pair but instead use the given filehandle as the tty master. This is
… …
629.IX Item "scrollColor: colour" 626.IX Item "scrollColor: colour"
630Use the specified colour for the scrollbar [default #B2B2B2]. 627Use the specified colour for the scrollbar [default #B2B2B2].
631.IP "\fBtroughColor:\fR \fIcolour\fR" 4 628.IP "\fBtroughColor:\fR \fIcolour\fR" 4
632.IX Item "troughColor: colour" 629.IX Item "troughColor: colour"
633Use the specified colour for the scrollbar's trough area [default 630Use the specified colour for the scrollbar's trough area [default
634#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 631#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
635.IP "\fBborderColor:\fR \fIcolour\fR" 4 632.IP "\fBborderColor:\fR \fIcolour\fR" 4
636.IX Item "borderColor: colour" 633.IX Item "borderColor: colour"
637The 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
638and the text. 635and the text.
639.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4 636.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4
… …
727xterm 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
728xterm style selection. 725xterm style selection.
729.IP "\fBscrollstyle:\fR \fImode\fR" 4 726.IP "\fBscrollstyle:\fR \fImode\fR" 4
730.IX Item "scrollstyle: mode" 727.IX Item "scrollstyle: mode"
731Set 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
732the author's favourite.. 729the author's favourite.
733.IP "\fBtitle:\fR \fIstring\fR" 4 730.IP "\fBtitle:\fR \fIstring\fR" 4
734.IX Item "title: string" 731.IX Item "title: string"
735Set window title string, the default title is the command-line 732Set window title string, the default title is the command-line
736specified after the \fB\-e\fR option, if any, otherwise the application 733specified after the \fB\-e\fR option, if any, otherwise the application
737name; option \fB\-title\fR. 734name; option \fB\-title\fR.
… …
761.IP "\fBprint\-pipe:\fR \fIstring\fR" 4 758.IP "\fBprint\-pipe:\fR \fIstring\fR" 4
762.IX Item "print-pipe: string" 759.IX Item "print-pipe: string"
763Specify 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
764\&\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
765\&\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.
766.IP "\fBscrollBar:\fR \fIboolean\fR" 4 774.IP "\fBscrollBar:\fR \fIboolean\fR" 4
767.IX Item "scrollBar: boolean" 775.IX Item "scrollBar: boolean"
768\&\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:
769disable the scrollbar; option \fB+sb\fR. 777disable the scrollbar; option \fB+sb\fR.
770.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4 778.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4
… …
846.IP "\fBpointerColor2:\fR \fIcolour\fR" 4 854.IP "\fBpointerColor2:\fR \fIcolour\fR" 4
847.IX Item "pointerColor2: colour" 855.IX Item "pointerColor2: colour"
848Mouse pointer background colour. 856Mouse pointer background colour.
849.IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4 857.IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4
850.IX Item "pointerBlankDelay: number" 858.IX Item "pointerBlankDelay: number"
851Specifies 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.
852.IP "\fBbackspacekey:\fR \fIstring\fR" 4 861.IP "\fBbackspacekey:\fR \fIstring\fR" 4
853.IX Item "backspacekey: string" 862.IX Item "backspacekey: string"
854The 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
855or 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
856(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
… …
980.Sp 989.Sp
981.Vb 1 990.Vb 1
982\& 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
983.Ve 992.Ve
984.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
985The 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
986the 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
987font-switching at runtime: 1017font-switching at runtime:
988.Sp 1018.Sp
989.Vb 2 1019.Vb 2
… …
1205.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4 1235.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
1206.IX Item "RXVT_SOCKET" 1236.IX Item "RXVT_SOCKET"
1207The unix domain socket path used by @@RXVT_NAME@@c(1) and 1237The unix domain socket path used by @@RXVT_NAME@@c(1) and
1208@@RXVT_NAME@@d(1). 1238@@RXVT_NAME@@d(1).
1209.Sp 1239.Sp
1210Default \f(CW\*(C`$HOME/.rxvt\-unicode\-<nodename\*(C'\fR. 1240Default \fI$HOME/.rxvt\-unicode\-\fI<nodename\fI\fR.
1211.IP "\fB\s-1HOME\s0\fR" 4 1241.IP "\fB\s-1HOME\s0\fR" 4
1212.IX Item "HOME" 1242.IX Item "HOME"
1213Used to locate the default directory for the unix domain socket for 1243Used to locate the default directory for the unix domain socket for
1214daemon communications and to locate various resource files (such as 1244daemon communications and to locate various resource files (such as
1215\&\f(CW\*(C`.Xdefaults\*(C'\fR) 1245\&\f(CW\*(C`.Xdefaults\*(C'\fR)
… …
1225.IP "\fB/usr/lib/X11/rgb.txt\fR" 4 1255.IP "\fB/usr/lib/X11/rgb.txt\fR" 4
1226.IX Item "/usr/lib/X11/rgb.txt" 1256.IX Item "/usr/lib/X11/rgb.txt"
1227Color names. 1257Color names.
1228.SH "SEE ALSO" 1258.SH "SEE ALSO"
1229.IX Header "SEE ALSO" 1259.IX Header "SEE ALSO"
1230@@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)
1231.SH "BUGS" 1261.SH "BUGS"
1232.IX Header "BUGS" 1262.IX Header "BUGS"
1233Check the \s-1BUGS\s0 file for an up-to-date list. 1263Check the \s-1BUGS\s0 file for an up-to-date list.
1234.PP 1264.PP
1235Cursor change support is not yet implemented. 1265Cursor change support is not yet implemented.

Diff Legend

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