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.14 by root, Mon Feb 14 10:44:50 2005 UTC vs.
Revision 1.23 by root, Sat Jun 18 11:01:41 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" "" "RXVT-UNICODE" 132.TH rxvt 1 "2005-06-18" "5.5" "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\-xrm\fR \fIresourcestring\fR" 4 449.IP "\fB\-embed\fR \fIwindowid\fR" 4
450.IX Item "-xrm resourcestring" 450.IX Item "-embed windowid"
451No effect on rxvt\-unicode. Simply passes through an argument to be made 451Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
452available in the instance's argument list. Appears in \fI\s-1WM_COMMAND\s0\fR in 452which enables applications to easily embed a terminal.
453some window managers. 453.Sp
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
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.
458.Sp
459The window will not be destroyed when @@RXVT_NAME@@ exits.
460.Sp
461It might be useful to know that @@RXVT_NAME@@ will not close file
462descriptors passed to it (except for stdin/out/err, of course), so you
463can use file descriptors to communicate with the programs within the
464terminal. This works regardless of wether the \f(CW\*(C`\-embed\*(C'\fR option was used or
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
454.SH "RESOURCES (available also as long\-options)" 508.SH "RESOURCES (available also as long\-options)"
455.IX Header "RESOURCES (available also as long-options)" 509.IX Header "RESOURCES (available also as long-options)"
456Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long 510Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long
457options) compiled into your version. 511options) compiled into your version.
458.PP 512.PP
… …
572.IX Item "scrollColor: colour" 626.IX Item "scrollColor: colour"
573Use the specified colour for the scrollbar [default #B2B2B2]. 627Use the specified colour for the scrollbar [default #B2B2B2].
574.IP "\fBtroughColor:\fR \fIcolour\fR" 4 628.IP "\fBtroughColor:\fR \fIcolour\fR" 4
575.IX Item "troughColor: colour" 629.IX Item "troughColor: colour"
576Use the specified colour for the scrollbar's trough area [default 630Use the specified colour for the scrollbar's trough area [default
577#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 631#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
578.IP "\fBborderColor:\fR \fIcolour\fR" 4 632.IP "\fBborderColor:\fR \fIcolour\fR" 4
579.IX Item "borderColor: colour" 633.IX Item "borderColor: colour"
580The 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
581and the text. 635and the text.
582.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4 636.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4
… …
670xterm 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
671xterm style selection. 725xterm style selection.
672.IP "\fBscrollstyle:\fR \fImode\fR" 4 726.IP "\fBscrollstyle:\fR \fImode\fR" 4
673.IX Item "scrollstyle: mode" 727.IX Item "scrollstyle: mode"
674Set 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
675the author's favourite.. 729the author's favourite.
676.IP "\fBtitle:\fR \fIstring\fR" 4 730.IP "\fBtitle:\fR \fIstring\fR" 4
677.IX Item "title: string" 731.IX Item "title: string"
678Set window title string, the default title is the command-line 732Set window title string, the default title is the command-line
679specified after the \fB\-e\fR option, if any, otherwise the application 733specified after the \fB\-e\fR option, if any, otherwise the application
680name; option \fB\-title\fR. 734name; option \fB\-title\fR.
… …
728\&\fBFalse\fR: do not scroll to bottom when tty receives output; option 782\&\fBFalse\fR: do not scroll to bottom when tty receives output; option
729\&\fB+si\fR. 783\&\fB+si\fR.
730.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4 784.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4
731.IX Item "scrollWithBuffer: boolean" 785.IX Item "scrollWithBuffer: boolean"
732\&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and 786\&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and
733\&\fBscrollTtyOutput\fR is False); option \fB+sw\fR. \fBFalse\fR: do not scroll 787\&\fBscrollTtyOutput\fR is False); option \fB\-sw\fR. \fBFalse\fR: do not scroll
734with scrollback buffer when tty recieves new lines; option \fB\-sw\fR. 788with scrollback buffer when tty recieves new lines; option \fB+sw\fR.
735.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4 789.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4
736.IX Item "scrollTtyKeypress: boolean" 790.IX Item "scrollTtyKeypress: boolean"
737\&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys 791\&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys
738are those which are intercepted by rxvt-unicode for special handling and 792are those which are intercepted by rxvt-unicode for special handling and
739are not passed onto the shell; option \fB\-sk\fR. \fBFalse\fR: do not scroll to 793are not passed onto the shell; option \fB\-sk\fR. \fBFalse\fR: do not scroll to
… …
789.IP "\fBpointerColor2:\fR \fIcolour\fR" 4 843.IP "\fBpointerColor2:\fR \fIcolour\fR" 4
790.IX Item "pointerColor2: colour" 844.IX Item "pointerColor2: colour"
791Mouse pointer background colour. 845Mouse pointer background colour.
792.IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4 846.IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4
793.IX Item "pointerBlankDelay: number" 847.IX Item "pointerBlankDelay: number"
794Specifies number of seconds before blanking the pointer [default 2]. 848Specifies number of seconds before blanking the pointer [default 2]. Use a
849large number (e.g. \f(CW987654321\fR) to effectively disable the timeout.
795.IP "\fBbackspacekey:\fR \fIstring\fR" 4 850.IP "\fBbackspacekey:\fR \fIstring\fR" 4
796.IX Item "backspacekey: string" 851.IX Item "backspacekey: string"
797The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR 852The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR
798or unset it will send \fBDelete\fR (code 127) or, if shifted, \fBBackspace\fR 853or unset it will send \fBDelete\fR (code 127) or, if shifted, \fBBackspace\fR
799(code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode 854(code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode
… …
923.Sp 978.Sp
924.Vb 1 979.Vb 1
925\& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007 980\& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007
926.Ve 981.Ve
927.Sp 982.Sp
983Due the the large number of modifier combinations, a defined key mapping
984will match if at \fIat least\fR the specified identifiers are being set, and
985no other key mappings with those and more bits are being defined. That
986means that defining a key map for \f(CW\*(C`a\*(C'\fR will automatically provide
987definitions for \f(CW\*(C`Meta\-a\*(C'\fR, \f(CW\*(C`Shift\-a\*(C'\fR and so on, unless some of those are defined
988mappings themselves.
989.Sp
990Unfortunately, this will override built-in key mappings. For example
991if you overwrite the \f(CW\*(C`Insert\*(C'\fR key you will disable @@RXVT_NAME@@'s
992\&\f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke \*(L"holes\*(R" into the
993user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement:
994.Sp
995.Vb 2
996\& URxvt.keysym.Insert: <my insert key sequence>
997\& URxvt.keysym.S-Insert: builtin:
998.Ve
999.Sp
1000The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination
1001of modifiers. The second line re-establishes the default mapping for
1002\&\f(CW\*(C`Shift\-Insert\*(C'\fR.
1003.Sp
928The following example will map Control\-Meta\-1 and Control\-Meta\-2 to 1004The following example will map Control\-Meta\-1 and Control\-Meta\-2 to
929the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited 1005the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited
930font-switching at runtime: 1006font-switching at runtime:
931.Sp 1007.Sp
932.Vb 2 1008.Vb 2

Diff Legend

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