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.19 by root, Fri Feb 18 12:15:07 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-02-18" "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 4
500\& my $pty = new IO::Pty;
501\& fcntl $pty, F_SETFD, 0; # clear close-on-exec
502\& system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
503\& close $pty;
504.Ve
505.Sp
506.Vb 3
507\& # now communicate with rxvt
508\& my $slave = $pty->slave;
509\& while (<$slave>) { print $slave "got <$_>\en" }
510.Ve
454.SH "RESOURCES (available also as long\-options)" 511.SH "RESOURCES (available also as long\-options)"
455.IX Header "RESOURCES (available also as long-options)" 512.IX Header "RESOURCES (available also as long-options)"
456Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long 513Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long
457options) compiled into your version. 514options) compiled into your version.
458.PP 515.PP
728\&\fBFalse\fR: do not scroll to bottom when tty receives output; option 785\&\fBFalse\fR: do not scroll to bottom when tty receives output; option
729\&\fB+si\fR. 786\&\fB+si\fR.
730.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4 787.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4
731.IX Item "scrollWithBuffer: boolean" 788.IX Item "scrollWithBuffer: boolean"
732\&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and 789\&\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 790\&\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. 791with scrollback buffer when tty recieves new lines; option \fB+sw\fR.
735.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4 792.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4
736.IX Item "scrollTtyKeypress: boolean" 793.IX Item "scrollTtyKeypress: boolean"
737\&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys 794\&\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 795are 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 796are not passed onto the shell; option \fB\-sk\fR. \fBFalse\fR: do not scroll to

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines