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

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.15 by root, Mon Feb 14 18:50:57 2005 UTC vs.
Revision 1.24 by root, Tue Oct 25 20:04:59 2005 UTC

 SYNOPSIS
     rxvt [options] [-e command [ args ]]
 DESCRIPTION
-    rxvt-unicode, version 5.1, is a colour vt102 terminal emulator intended
+    rxvt-unicode, version 5.8, is a colour vt102 terminal emulator intended
     as an *xterm*(1) replacement for users who do not require features such
     as Tektronix 4014 emulation and toolkit-style configurability. As a
     result, rxvt-unicode uses much less swap space -- a significant
     advantage on a machine serving many X sessions.
         Turn on/off simulated reverse video; resource reverseVideo.
     -j|+j
         Turn on/off jump scrolling; resource jumpScroll.
-    -ip|+ip
+    -ip|+ip | -tr|+tr
         Turn on/off inheriting parent window's pixmap. Alternative form is
         -tr; resource inheritPixmap.
     -fade *number*
-        Fade the text by the given percentage when focus is lost. resource
+        Fade the text by the given percentage when focus is lost. Small
-        fading.
+        values fade a little only, 100 completely replaces all colours by
+        the fade colour; resource fading.
+    -fadecolor *colour*
+        Fade to this colour when fading is used (see -fade). The default
+        colour is black. resource fadeColor.
     -tint *colour*
         Tint the transparent background pixmap with the given colour when
-        transparency is enabled with -tr or -ip. See also the -sh option
+        transparency is enabled with -tr or -ip. This only works for
+        non-tiled backgrounds, currently. See also the -sh option that can
-        that can be used to brighten or darken the image in addition to
+        be used to brighten or darken the image in addition to tinting it;
-        tinting it.
+        resource *tintColor*. Example:
+           rxvt -tr -tint blue -sh 40
     -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent
         background image in addition to tinting it (i.e. -tint must be
         specified, too, e.g. "-tint white").
     -sr|+sr
         Put scrollbar on right/left; resource scrollBar_right.
     -st|+st
-        Display normal (non XTerm/NeXT) scrollbar without/with a trough;
+        Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
         resource scrollBar_floating.
     -ptab|+ptab
         If enabled (default), "Horizontal Tab" characters are being stored
         as actual wide characters in the screen buffer, which makes it
     -ssr|+ssr
         Turn on/off secondary screen scroll (default enabled); resource
         secondaryScroll.
-    -keysym.*sym*: *string*
+    -keysym.*sym* *string*
         Remap a key symbol. See resource keysym.
-    -embed: *windowid*
+    -embed *windowid*
         Tells rxvt to embed it's windows into an already-existing window,
         which enables applications to easily embed a terminal.
         Right now, rxvt will first unmap/map the specified window, so it
         shouldn't be a top-level window. rxvt will also reconfigure it quite
         It might be useful to know that rxvt 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 "-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 doc/embed):
+           my $rxvt = new Gtk2::Socket;
+           $rxvt->signal_connect_after (realize => sub {
+              my $xid = $_[0]->window->get_xid;
+              system "rxvt -embed $xid &";
+           });
+    -pty-fd *fileno*
+        Tells rxvt 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 as a generic terminal emulator
+        without having to run a program within it.
+        If this switch is given, rxvt 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 doc/pty-fd):
+           use IO::Pty;
+           use Fcntl;
+           my $pty = new IO::Pty;
+           fcntl $pty, F_SETFD, 0; # clear close-on-exec
+           system "rxvt -pty-fd " . (fileno $pty) . "&";
+           close $pty;
+           # now communicate with rxvt
+           my $slave = $pty->slave;
+           while (<$slave>) { print $slave "got <$_>\n" }
 RESOURCES (available also as long-options)
     Note: `rxvt --help' gives a list of all resources (long options)
     compiled into your version.
         True: make the background inherit the parent windows' pixmap, giving
         artificial transparency. False: do not inherit the parent windows'
         pixmap.
     fading: *number*
-        Fade the text by the given percentage when focus is lost.
+        Fade the text by the given percentage when focus is lost; option
+        -fade.
+    fadeColor: *colour*
+        Fade to this colour, when fading is used (see fading:). The default
+        colour is black; option -fadecolor.
     tintColor: *colour*
-        Tint the transparent background pixmap with the given colour.
+        Tint the transparent background pixmap with the given colour; option
+        -tint.
     shading: *number*
         Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
         image in addition to tinting it.
     scrollColor: *colour*
         Use the specified colour for the scrollbar [default #B2B2B2].
     troughColor: *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.
     borderColor: *colour*
         The colour of the border around the text area and between the
         scrollbar and the text.
         xterm style with 2.20 old word selection, or anything else which
         gives xterm style selection.
     scrollstyle: *mode*
         Set scrollbar style to rxvt, plain, next or xterm. plain is the
-        author's favourite..
+        author's favourite.
     title: *string*
         Set window title string, the default title is the command-line
         specified after the -e option, if any, otherwise the application
         name; option -title.
     print-pipe: *string*
         Specify a command pipe for vt100 printer [default *lpr(1)*]. Use
         Print to initiate a screen dump to the printer and Ctrl-Print or
         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 "Print".
     scrollBar: *boolean*
         True: enable the scrollbar [default]; option -sb. False: disable the
         scrollbar; option +sb.
     scrollBar_right: *boolean*
         True: scroll to bottom when tty receives output; option -si. False:
         do not scroll to bottom when tty receives output; option +si.
     scrollWithBuffer: *boolean*
         True: scroll with scrollback buffer when tty receives new lines (and
-        scrollTtyOutput is False); option +sw. False: do not scroll with
+        scrollTtyOutput is False); option -sw. False: do not scroll with
-        scrollback buffer when tty recieves new lines; option -sw.
+        scrollback buffer when tty recieves new lines; option +sw.
     scrollTtyKeypress: *boolean*
         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 are not passed onto the shell; option -sk. False: do
     pointerColor2: *colour*
         Mouse pointer background colour.
     pointerBlankDelay: *number*
         Specifies number of seconds before blanking the pointer [default 2].
+        Use a large number (e.g. 987654321) to effectively disable the
+        timeout.
     backspacekey: *string*
         The string to send when the backspace key is pressed. If set to DEC
         or unset it will send Delete (code 127) or, if shifted, Backspace
         (code 8) - which can be reversed with the appropriate DEC private
         is interpreted and executed as rxvt's control sequence. For example
         the following means "change the current locale to "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 *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 "a" will
+        automatically provide definitions for "Meta-a", "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 "Insert" key you will disable rxvt's
+        "Shift-Insert" mapping. To re-enable that, you can poke "holes" into
+        the user-defined keymap using the "builtin:" replacement:
+          URxvt.keysym.Insert: <my insert key sequence>
+          URxvt.keysym.S-Insert: builtin:
+        The first line defines a mapping for "Insert" and *any* combination
+        of modifiers. The second line re-establishes the default mapping for
+        "Shift-Insert".
         The following example will map Control-Meta-1 and Control-Meta-2 to
         the fonts "suxuseuro" and "9x15bold", so you can have some limited
         font-switching at runtime:
         Used in the same way as "RXVTPATH".
     RXVT_SOCKET
         The unix domain socket path used by rxvtc(1) and rxvtd(1).
-        Default "$HOME/.rxvt-unicode-<nodename".
+        Default $HOME/.rxvt-unicode-*<nodename*.
     HOME
         Used to locate the default directory for the unix domain socket for
         daemon communications and to locate various resource files (such as
         ".Xdefaults")
 FILES
     /usr/lib/X11/rgb.txt
         Color names.
 SEE ALSO
-    rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
+    rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
+    tty(4), utmp(5)
 BUGS
     Check the BUGS file for an up-to-date list.
     Cursor change support is not yet implemented.

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents): Revision 1.15 by root, Mon Feb 14 18:50:57 2005 UTC vs. Revision 1.24 by root, Tue Oct 25 20:04:59 2005 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.15 by root, Mon Feb 14 18:50:57 2005 UTC vs.
Revision 1.24 by root, Tue Oct 25 20:04:59 2005 UTC