--- rxvt-unicode/doc/rxvt.1.pod 2005/02/03 10:24:10 1.48 +++ rxvt-unicode/doc/rxvt.1.pod 2005/02/19 01:07:57 1.61 @@ -16,8 +16,10 @@ =head1 FREQUENTLY ASKED QUESTIONS -See @@RXVT_NAME@@(7) (try C) for a list of frequently -asked questions and answer to them and some common problems. +See @@RXVT_NAME@@(7) (try C) for a list of +frequently asked questions and answer to them and some common +problems. That document is also accessible on the World-Wide-Web at +L. =head1 RXVT-UNICODE VS. RXVT @@ -368,11 +370,62 @@ Turn on/off secondary screen scroll (default enabled); resource B. -=item B<-xrm> I +=item B<-keysym.>I I -No effect on rxvt-unicode. Simply passes through an argument to be made -available in the instance's argument list. Appears in I in -some window managers. +Remap a key symbol. See resource B. + +=item B<-embed> I + +Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, +which enables applications to easily embed a terminal. + +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. + +The window will not be destroyed when @@RXVT_NAME@@ exits. + +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 C<-embed> option was used or +not. + +Here is a short Gtk2-perl snippet that illustrates how this option can be +used (a longer example is in F): + + my $rxvt = new Gtk2::Socket; + $rxvt->signal_connect_after (realize => sub { + my $xid = $_[0]->window->get_xid; + system "@@RXVT_NAME@@ -embed $xid &"; + }); + +=item B<-pty-fd> I + +Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty +pair but instead use the given filehandle as the tty master. This is +useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator +without having to run a program within it. + +If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp +entries and will not tinker with pty/tty permissions - you have to do that +yourself if you want that. + +Here is a example in perl that illustrates how this option can be used (a +longer example is in F): + + use IO::Pty; + use Fcntl; + + my $pty = new IO::Pty; + fcntl $pty, F_SETFD, 0; # clear close-on-exec + system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&"; + close $pty; + + # now communicate with rxvt + my $slave = $pty->slave; + while (<$slave>) { print $slave "got <$_>\n" } =back @@ -385,8 +438,16 @@ Xresource data: using the X libraries (Xrm*-functions) or internal Xresources reader (B<~/.Xdefaults>). For the first method (ie. B<@@RXVT_NAME@@ -h> lists B), you can set and change the -resources using X11 tools like B. Many distribution do also load -settings from the B<~/.Xresources> file when X starts. +resources using X11 tools like B. Many distribution do also load +settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@ +will consult the following files/resources in order, with later settings +overwriting earlier ones: + + 1. system-wide app-defaults file, either locale-dependent OR global + 2. app-defaults file in $XAPPLRESDIR + 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults + 4. SCREEN_RESOURCES for the current screen + 5. $XENVIRONMENT file OR $HOME/.Xdefaults- If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults @@ -680,8 +741,8 @@ =item B I B: scroll with scrollback buffer when tty receives new lines (and -B is False); option B<+sw>. B: do not scroll -with scrollback buffer when tty recieves new lines; option B<-sw>. +B is False); option B<-sw>. B: do not scroll +with scrollback buffer when tty recieves new lines; option B<+sw>. =item B I @@ -933,9 +994,9 @@ If mouse reporting mode is active, the normal scrollbar actions are disabled -- on the assumption that we are using a fullscreen -application. Instead, pressing Button1 and Button3 sends B -(Next) and B (Prior), respectively. Similarly, clicking on the -up and down arrows sends B (Up) and B (Down), +application. Instead, pressing Button1 and Button3 sends B +(Next) and B (Prior), respectively. Similarly, clicking on the +up and down arrows sends B (Up) and B (Down), respectively. =head1 TEXT SELECTION AND INSERTION @@ -1100,12 +1161,83 @@ =head1 ENVIRONMENT -B<@@RXVT_NAME@@> sets the environment variables B, B -and B. The environment variable B is set to the X -window id number of the B<@@RXVT_NAME@@> window and it also uses and -sets the environment variable B to specify which display -terminal to use. B<@@RXVT_NAME@@> uses the environment variables -B and B to find XPM files. +B<@@RXVT_NAME@@> sets and/or uses the following environment variables: + +=over 4 + +=item B + +Normally set to C, unless overwritten at configure time, via +resources or on the commandline. + +=item B + +Either C, C, depending on wether @@RXVT_NAME@@ was +compiled with XPM support, and optionally with the added extension +C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. + +=item B + +Set to a string of the form C or C, where C is +the colour code used as default foreground/text colour (or the string +C to indicate that the default-colour escape sequence is to be +used), C is the colour code used as default background colour (or the +string C), and C is the string C if @@RXVT_NAME@@ +was compiled with XPM support. Libraries like C and C can +(and do) use this information to optimize screen output. + +=item B + +Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel +window, which usually has subwindows for the scrollbar, the terminal +window and so on). + +=item B + +Set to the terminfo directory iff @@RXVT_NAME@@ was configured with +C<--with-terminfo=PATH>. + +=item B + +Used by @@RXVT_NAME@@ to connect to the display and set to the correct +display in it's child processes. + +=item B + +The shell to be used for command execution, defaults to C. + +=item B + +The path where @@RXVT_NAME@@ looks for support files such as menu and xpm +files. + +=item B + +Used in the same way as C. + +=item B + +The unix domain socket path used by @@RXVT_NAME@@c(1) and +@@RXVT_NAME@@d(1). + +Default C<< $HOME/.rxvt-unicode->. + +=item B + +Used to locate the default directory for the unix domain socket for +daemon communications and to locate various resource files (such as +C<.Xdefaults>) + +=item B + +Directory where various X resource files are being located. + +=item B + +If set and accessible, gives the name of a X resource file to be loaded by +@@RXVT_NAME@@. + +=back =head1 FILES @@ -1135,13 +1267,9 @@ =item Project Coordinator -@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> - -=item Web page maintainter - -@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@> +Marc A. Lehmann L<< >> -L<@@RXVT_WEBPAGE@@> +L =back @@ -1176,7 +1304,7 @@ Rewrote screen display and text selection routines. Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) -=item Marc Alexander Lehmann L<< >> +=item Marc Alexander Lehmann L<< >> Forked rxvt-unicode, rewrote most of the display code and internal character handling to store text in unicode, improve xterm