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.12 by root, Fri Feb 11 18:14:07 2005 UTC vs.
Revision 1.22 by root, Fri Apr 22 02:09:39 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-11" "5.0" "RXVT-UNICODE" 132.TH rxvt 1 "2005-04-22" "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 ]]
… …
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
… …
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
… …
1118Set to a string of the form \f(CW\*(C`fg;bg\*(C'\fR or \f(CW\*(C`fg;xpm;bg\*(C'\fR, where \f(CW\*(C`fg\*(C'\fR is 1194Set to a string of the form \f(CW\*(C`fg;bg\*(C'\fR or \f(CW\*(C`fg;xpm;bg\*(C'\fR, where \f(CW\*(C`fg\*(C'\fR is
1119the colour code used as default foreground/text colour (or the string 1195the colour code used as default foreground/text colour (or the string
1120\&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be 1196\&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be
1121used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the 1197used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the
1122string \f(CW\*(C`default\*(C'\fR), and \f(CW\*(C`xpm\*(C'\fR is the string \f(CW\*(C`default\*(C'\fR if @@RXVT_NAME@@ 1198string \f(CW\*(C`default\*(C'\fR), and \f(CW\*(C`xpm\*(C'\fR is the string \f(CW\*(C`default\*(C'\fR if @@RXVT_NAME@@
1123was compiled with \s-1XPM\s0 support. Libraries like \f(CW\*(C`slang\*(C'\fR can (and do) use 1199was compiled with \s-1XPM\s0 support. Libraries like \f(CW\*(C`ncurses\*(C'\fR and \f(CW\*(C`slang\*(C'\fR can
1124this information to optimize screen output. 1200(and do) use this information to optimize screen output.
1125.IP "\fB\s-1WINDOWID\s0\fR" 4 1201.IP "\fB\s-1WINDOWID\s0\fR" 4
1126.IX Item "WINDOWID" 1202.IX Item "WINDOWID"
1127Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel 1203Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel
1128window, which usually has subwindows for the scrollbar, the terminal 1204window, which usually has subwindows for the scrollbar, the terminal
1129window and so on). 1205window and so on).
… …
1180Click-and-drag doesn't work with X11 mouse report overriding. 1256Click-and-drag doesn't work with X11 mouse report overriding.
1181.SH "CURRENT PROJECT COORDINATOR" 1257.SH "CURRENT PROJECT COORDINATOR"
1182.IX Header "CURRENT PROJECT COORDINATOR" 1258.IX Header "CURRENT PROJECT COORDINATOR"
1183.IP "Project Coordinator" 4 1259.IP "Project Coordinator" 4
1184.IX Item "Project Coordinator" 1260.IX Item "Project Coordinator"
1185@@RXVT_MAINT@@ @@RXVT_MAINTEMAIL@@ 1261Marc A. Lehmann <rxvt\-unicode@schmorp.de>
1186.Sp 1262.Sp
1187@@RXVT_WEBPAGE@@ 1263<http://software.schmorp.de/#rxvt\-unicode>
1188.SH "AUTHORS" 1264.SH "AUTHORS"
1189.IX Header "AUTHORS" 1265.IX Header "AUTHORS"
1190.IP "John Bovey" 4 1266.IP "John Bovey" 4
1191.IX Item "John Bovey" 1267.IX Item "John Bovey"
1192University of Kent, 1992, wrote the original Xvt. 1268University of Kent, 1992, wrote the original Xvt.
… …
1206Project Coordinator (changes.txt 2.21a to 2.4.5) 1282Project Coordinator (changes.txt 2.21a to 2.4.5)
1207.IP "Geoff Wing <gcw@pobox.com>" 4 1283.IP "Geoff Wing <gcw@pobox.com>" 4
1208.IX Item "Geoff Wing <gcw@pobox.com>" 1284.IX Item "Geoff Wing <gcw@pobox.com>"
1209Rewrote screen display and text selection routines. Project Coordinator 1285Rewrote screen display and text selection routines. Project Coordinator
1210(changes.txt 2.4.6 \- rxvt\-unicode) 1286(changes.txt 2.4.6 \- rxvt\-unicode)
1211.IP "Marc Alexander Lehmann <rxvt@schmorp.de>" 4 1287.IP "Marc Alexander Lehmann <rxvt\-unicode@schmorp.de>" 4
1212.IX Item "Marc Alexander Lehmann <rxvt@schmorp.de>" 1288.IX Item "Marc Alexander Lehmann <rxvt-unicode@schmorp.de>"
1213Forked rxvt\-unicode, rewrote most of the display code and internal 1289Forked rxvt\-unicode, rewrote most of the display code and internal
1214character handling to store text in unicode, improve xterm 1290character handling to store text in unicode, improve xterm
1215compatibility and apply numerous other bugfixes and extensions. 1291compatibility and apply numerous other bugfixes and extensions.
1216.Sp 1292.Sp
1217Project Coordinator (Changes 1.0 \-) 1293Project Coordinator (Changes 1.0 \-)

Diff Legend

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