--- rxvt-unicode/doc/rxvt.1.man.in 2005/02/11 18:14:07 1.12 +++ rxvt-unicode/doc/rxvt.1.man.in 2005/02/16 22:16:30 1.17 @@ -129,7 +129,7 @@ .\" ======================================================================== .\" .IX Title "rxvt 1" -.TH rxvt 1 "2005-02-11" "5.0" "RXVT-UNICODE" +.TH rxvt 1 "2005-02-16" "5.2" "RXVT-UNICODE" .SH "NAME" rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system) .SH "SYNOPSIS" @@ -446,11 +446,23 @@ .IP "\fB\-keysym.\fR\fIsym\fR: \fIstring\fR" 4 .IX Item "-keysym.sym: string" Remap a key symbol. See resource \fBkeysym\fR. -.IP "\fB\-xrm\fR \fIresourcestring\fR" 4 -.IX Item "-xrm resourcestring" -No effect on rxvt\-unicode. Simply passes through an argument to be made -available in the instance's argument list. Appears in \fI\s-1WM_COMMAND\s0\fR in -some window managers. +.IP "\fB\-embed\fR: \fIwindowid\fR" 4 +.IX Item "-embed: windowid" +Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, +which enables applications to easily embed a terminal. +.Sp +Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it +shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it +quite a bit, so don't expect it to keep some specific state. It's best to +create an extra subwindow for @@RXVT_NAME@@ and leave it alone. +.Sp +The window will not be destroyed when @@RXVT_NAME@@ exits. +.Sp +It might be useful to know that @@RXVT_NAME@@ will not close file +descriptors passed to it (except for stdin/out/err, of course), so you +can use file descriptors to communicate with the programs within the +terminal. This works regardless of wether the \f(CW\*(C`\-embed\*(C'\fR option was used or +not. .SH "RESOURCES (available also as long\-options)" .IX Header "RESOURCES (available also as long-options)" Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long @@ -730,8 +742,8 @@ .IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4 .IX Item "scrollWithBuffer: boolean" \&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and -\&\fBscrollTtyOutput\fR is False); option \fB+sw\fR. \fBFalse\fR: do not scroll -with scrollback buffer when tty recieves new lines; option \fB\-sw\fR. +\&\fBscrollTtyOutput\fR is False); option \fB\-sw\fR. \fBFalse\fR: do not scroll +with scrollback buffer when tty recieves new lines; option \fB+sw\fR. .IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4 .IX Item "scrollTtyKeypress: boolean" \&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys @@ -1120,8 +1132,8 @@ \&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the string \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@@ -was compiled with \s-1XPM\s0 support. Libraries like \f(CW\*(C`slang\*(C'\fR can (and do) use -this information to optimize screen output. +was compiled with \s-1XPM\s0 support. Libraries like \f(CW\*(C`ncurses\*(C'\fR and \f(CW\*(C`slang\*(C'\fR can +(and do) use this information to optimize screen output. .IP "\fB\s-1WINDOWID\s0\fR" 4 .IX Item "WINDOWID" Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel @@ -1182,9 +1194,9 @@ .IX Header "CURRENT PROJECT COORDINATOR" .IP "Project Coordinator" 4 .IX Item "Project Coordinator" -@@RXVT_MAINT@@ @@RXVT_MAINTEMAIL@@ +Marc A. Lehmann .Sp -@@RXVT_WEBPAGE@@ + .SH "AUTHORS" .IX Header "AUTHORS" .IP "John Bovey" 4 @@ -1208,8 +1220,8 @@ .IX Item "Geoff Wing " Rewrote screen display and text selection routines. Project Coordinator (changes.txt 2.4.6 \- rxvt\-unicode) -.IP "Marc Alexander Lehmann " 4 -.IX Item "Marc Alexander Lehmann " +.IP "Marc Alexander Lehmann " 4 +.IX Item "Marc Alexander Lehmann " Forked rxvt\-unicode, rewrote most of the display code and internal character handling to store text in unicode, improve xterm compatibility and apply numerous other bugfixes and extensions.