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.18 by root, Thu Feb 17 15:07:48 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-02-17" "5.2" "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 4
471\& my $rxvt = new Gtk2::DrawingArea;
472\& $...->add ($rxvt); # important to add it somewhere first
473\& $rxvt->realize; # now it can be realized
474\& my $xid = $rxvt->window->get_xid;
475.Ve
476.Sp
477.Vb 1
478\& system "@@RXVT_NAME@@ -embed $xid &";
479.Ve
480.IP "\fB\-pty\-fd\fR \fIfileno\fR" 4
481.IX Item "-pty-fd fileno"
482Tells @@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
484useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
485without having to run a program within it.
486.Sp
487If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
488entries and will not tinker with pty/tty permissions \- you have to do that
489yourself if you want that.
490.Sp
491Here is a example in perl that illustrates how this option can be used (a
492longer example is in \fIdoc/pty\-fd\fR):
493.Sp
494.Vb 2
495\& use IO::Pty;
496\& use Fcntl;
497.Ve
498.Sp
499.Vb 2
500\& my $pty = new IO::Pty;
501\& fcntl $pty, F_SETFD, 0; # clear close-on-exec
502.Ve
503.Sp
504.Vb 1
505\& system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
506.Ve
507.Sp
508.Vb 3
509\& # now communicate with rxvt
510\& my $slave = $pty->slave;
511\& while (<$slave>) { print $slave "got <$_>\en" }
512.Ve
454.SH "RESOURCES (available also as long\-options)" 513.SH "RESOURCES (available also as long\-options)"
455.IX Header "RESOURCES (available also as long-options)" 514.IX Header "RESOURCES (available also as long-options)"
456Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long 515Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long
457options) compiled into your version. 516options) compiled into your version.
458.PP 517.PP
… …
728\&\fBFalse\fR: do not scroll to bottom when tty receives output; option 787\&\fBFalse\fR: do not scroll to bottom when tty receives output; option
729\&\fB+si\fR. 788\&\fB+si\fR.
730.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4 789.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4
731.IX Item "scrollWithBuffer: boolean" 790.IX Item "scrollWithBuffer: boolean"
732\&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and 791\&\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 792\&\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. 793with scrollback buffer when tty recieves new lines; option \fB+sw\fR.
735.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4 794.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4
736.IX Item "scrollTtyKeypress: boolean" 795.IX Item "scrollTtyKeypress: boolean"
737\&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys 796\&\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 797are 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 798are not passed onto the shell; option \fB\-sk\fR. \fBFalse\fR: do not scroll to
… …
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 1177Set 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 1178the 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 1179\&\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 1180used), \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@@ 1181string \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 1182was 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. 1183(and do) use this information to optimize screen output.
1125.IP "\fB\s-1WINDOWID\s0\fR" 4 1184.IP "\fB\s-1WINDOWID\s0\fR" 4
1126.IX Item "WINDOWID" 1185.IX Item "WINDOWID"
1127Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel 1186Set 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 1187window, which usually has subwindows for the scrollbar, the terminal
1129window and so on). 1188window and so on).
… …
1180Click-and-drag doesn't work with X11 mouse report overriding. 1239Click-and-drag doesn't work with X11 mouse report overriding.
1181.SH "CURRENT PROJECT COORDINATOR" 1240.SH "CURRENT PROJECT COORDINATOR"
1182.IX Header "CURRENT PROJECT COORDINATOR" 1241.IX Header "CURRENT PROJECT COORDINATOR"
1183.IP "Project Coordinator" 4 1242.IP "Project Coordinator" 4
1184.IX Item "Project Coordinator" 1243.IX Item "Project Coordinator"
1185@@RXVT_MAINT@@ @@RXVT_MAINTEMAIL@@ 1244Marc A. Lehmann <rxvt\-unicode@schmorp.de>
1186.Sp 1245.Sp
1187@@RXVT_WEBPAGE@@ 1246<http://software.schmorp.de/#rxvt\-unicode>
1188.SH "AUTHORS" 1247.SH "AUTHORS"
1189.IX Header "AUTHORS" 1248.IX Header "AUTHORS"
1190.IP "John Bovey" 4 1249.IP "John Bovey" 4
1191.IX Item "John Bovey" 1250.IX Item "John Bovey"
1192University of Kent, 1992, wrote the original Xvt. 1251University of Kent, 1992, wrote the original Xvt.
… …
1206Project Coordinator (changes.txt 2.21a to 2.4.5) 1265Project Coordinator (changes.txt 2.21a to 2.4.5)
1207.IP "Geoff Wing <gcw@pobox.com>" 4 1266.IP "Geoff Wing <gcw@pobox.com>" 4
1208.IX Item "Geoff Wing <gcw@pobox.com>" 1267.IX Item "Geoff Wing <gcw@pobox.com>"
1209Rewrote screen display and text selection routines. Project Coordinator 1268Rewrote screen display and text selection routines. Project Coordinator
1210(changes.txt 2.4.6 \- rxvt\-unicode) 1269(changes.txt 2.4.6 \- rxvt\-unicode)
1211.IP "Marc Alexander Lehmann <rxvt@schmorp.de>" 4 1270.IP "Marc Alexander Lehmann <rxvt\-unicode@schmorp.de>" 4
1212.IX Item "Marc Alexander Lehmann <rxvt@schmorp.de>" 1271.IX Item "Marc Alexander Lehmann <rxvt-unicode@schmorp.de>"
1213Forked rxvt\-unicode, rewrote most of the display code and internal 1272Forked rxvt\-unicode, rewrote most of the display code and internal
1214character handling to store text in unicode, improve xterm 1273character handling to store text in unicode, improve xterm
1215compatibility and apply numerous other bugfixes and extensions. 1274compatibility and apply numerous other bugfixes and extensions.
1216.Sp 1275.Sp
1217Project Coordinator (Changes 1.0 \-) 1276Project Coordinator (Changes 1.0 \-)

Diff Legend

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