[ViewVC] Diff of: cvs/rxvt-unicode/doc/rxvt.1.pod

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.56 by root, Mon Feb 14 18:47:54 2005 UTC vs.
Revision 1.68 by root, Thu Aug 11 02:05:07 2005 UTC

 Turn on/off inheriting parent window's pixmap. Alternative form is
 B<-tr>; resource B<inheritPixmap>.
 =item B<-fade> I<number>
-Fade the text by the given percentage when focus is lost. resource B<fading>.
+Fade the text by the given percentage when focus is lost. Small values
+fade a little only, 100 completely replaces all colours by the fade
+colour; resource B<fading>.
+=item B<-fadecolor> I<colour>
+Fade to this colour when fading is used (see B<-fade>). The default colour
+is black. resource B<fadeColor>.
 =item B<-tint> I<colour>
 Tint the transparent background pixmap with the given colour when
 transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>
 option that can be used to brighten or darken the image in addition to
-tinting it.
+tinting it; resource I<tintColor>.
 =item B<-sh>
 I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
 background image in addition to tinting it (i.e. B<-tint> must be
 Put scrollbar on right/left; resource B<scrollBar_right>.
 =item B<-st>|B<+st>
-Display normal (non XTerm/NeXT) scrollbar without/with a trough;
+Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
 resource B<scrollBar_floating>.
 =item B<-ptab>|B<+ptab>
 If enabled (default), "Horizontal Tab" characters are being stored as
 =item B<-ssr>|B<+ssr>
 Turn on/off secondary screen scroll (default enabled); resource
 B<secondaryScroll>.
-=item B<-keysym.>I<sym>: I<string>
+=item B<-keysym.>I<sym> I<string>
 Remap a key symbol. See resource B<keysym>.
-=item B<-embed>: I<windowid>
+=item B<-embed> I<windowid>
 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<doc/embed>):
+   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<fileno>
+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<doc/pty-fd>):
+   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
 =head1 RESOURCES (available also as long-options)
 artificial transparency. B<False>: do not inherit the parent windows'
 pixmap.
 =item B<fading:> I<number>
-Fade the text by the given percentage when focus is lost.
+Fade the text by the given percentage when focus is lost; option B<-fade>.
+=item B<fadeColor:> I<colour>
+Fade to this colour, when fading is used (see B<fading:>). The default
+colour is black; option B<-fadecolor>.
 =item B<tintColor:> I<colour>
-Tint the transparent background pixmap with the given colour.
+Tint the transparent background pixmap with the given colour; option
+B<-tint>.
 =item B<shading:> I<number>
 Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
 image in addition to tinting it.
 Use the specified colour for the scrollbar [default #B2B2B2].
 =item B<troughColor:> I<colour>
 Use the specified colour for the scrollbar's trough area [default
-#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar.
+#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
 =item B<borderColor:> I<colour>
 The colour of the border around the text area and between the scrollbar
 and the text.
 xterm style selection.
 =item B<scrollstyle:> I<mode>
 Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
-the author's favourite..
+the author's favourite.
 =item B<title:> I<string>
 Set window title string, the default title is the command-line
 specified after the B<-e> option, if any, otherwise the application
 Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
 B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
 B<Shift-Print> to include the scrollback as well.
+The string will be interpreted as if typed into the shell as-is.
+Example:
+   URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
+This creates a new file in your home directory with the screen contents
+everytime you hit C<Print>.
 =item B<scrollBar:> I<boolean>
 B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
 disable the scrollbar; option B<+sb>.
 B<+si>.
 =item B<scrollWithBuffer:> I<boolean>
 B<True>: scroll with scrollback buffer when tty receives new lines (and
-B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll
+B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
-with scrollback buffer when tty recieves new lines; option B<-sw>.
+with scrollback buffer when tty recieves new lines; option B<+sw>.
 =item B<scrollTtyKeypress:> I<boolean>
 B<True>: scroll to bottom when a non-special key is pressed. Special keys
 are those which are intercepted by rxvt-unicode for special handling and
 Mouse pointer background colour.
 =item B<pointerBlankDelay:> I<number>
-Specifies number of seconds before blanking the pointer [default 2].
+Specifies number of seconds before blanking the pointer [default 2]. Use a
+large number (e.g. C<987654321>) to effectively disable the timeout.
 =item B<backspacekey:> I<string>
 The string to send when the backspace key is pressed. If set to B<DEC>
 or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
 is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
 example the following means "change the current locale to C<zh_CN.GBK>
 when Control-Meta-c is being pressed":
   URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
+Due the the large number of modifier combinations, a defined key mapping
+will match if at I<at least> the specified identifiers are being set, and
+no other key mappings with those and more bits are being defined. That
+means that defining a key map for C<a> will automatically provide
+definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
+mappings themselves.
+Unfortunately, this will override built-in key mappings. For example
+if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
+C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
+user-defined keymap using the C<builtin:> replacement:
+  URxvt.keysym.Insert: <my insert key sequence>
+  URxvt.keysym.S-Insert: builtin:
+The first line defines a mapping for C<Insert> and I<any> combination
+of modifiers. The second line re-establishes the default mapping for
+C<Shift-Insert>.
 The following example will map Control-Meta-1 and Control-Meta-2 to
 the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
 font-switching at runtime:
 =item B<RXVT_SOCKET>
 The unix domain socket path used by @@RXVT_NAME@@c(1) and
 @@RXVT_NAME@@d(1).
-Default C<< $HOME/.rxvt-unicode-<nodename >>.
+Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
 =item B<HOME>
 Used to locate the default directory for the unix domain socket for
 daemon communications and to locate various resource files (such as
 =back
 =head1 SEE ALSO
-@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
+@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
 =head1 BUGS
 Check the BUGS file for an up-to-date list.

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.56 by root, Mon Feb 14 18:47:54 2005 UTC vs. Revision 1.68 by root, Thu Aug 11 02:05:07 2005 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.56 by root, Mon Feb 14 18:47:54 2005 UTC vs.
Revision 1.68 by root, Thu Aug 11 02:05:07 2005 UTC