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

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.60 by root, Thu Jul 6 19:43:21 2006 UTC vs.
Revision 1.61 by root, Mon Jul 17 19:20:29 2006 UTC

 NAME
     rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window
     system)
 SYNOPSIS
-    rxvt [options] [-e command [ args ]]
+    urxvt [options] [-e command [ args ]]
 DESCRIPTION
-    rxvt-unicode, version 7.7, is a colour vt102 terminal emulator intended
+    rxvt-unicode, version 7.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.
 FREQUENTLY ASKED QUESTIONS
-    See rxvt(7) (try "man 7 rxvt") for a list of frequently asked questions
+    See urxvt(7) (try "man 7 urxvt") for a list of frequently asked
-    and answer to them and some common problems. That document is also
+    questions and answer to them and some common problems. That document is
-    accessible on the World-Wide-Web at
+    also accessible on the World-Wide-Web at
     <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
 RXVT-UNICODE VS. RXVT
     Unlike the original rxvt, rxvt-unicode stores all text in Unicode
     internally. That means it can store and display most scripts in the
     It is still faithfully following the original rxvt idea of being lean
     and nice on resources: for example, you can still configure rxvt-unicode
     without most of its features to get a lean binary. It also comes with a
     client/daemon pair that lets you open any number of terminal windows
     from within a single process, which makes startup time very fast and
-    drastically reduces memory usage. See rxvtd(1) (daemon) and rxvtc(1)
+    drastically reduces memory usage. See urxvtd(1) (daemon) and urxvtc(1)
     (client).
     It also makes technical information about escape sequences (which have
-    been extended) easier accessible: see rxvt(7) for technical reference
+    been extended) easier accessible: see urxvt(7) for technical reference
     documentation (escape sequences etc.).
 OPTIONS
-    The rxvt options (mostly a subset of *xterm*'s) are listed below. In
+    The urxvt options (mostly a subset of *xterm*'s) are listed below. In
     keeping with the smaller-is-better philosophy, options may be eliminated
     or default values chosen at compile-time, so options and defaults listed
-    may not accurately reflect the version installed on your system. `rxvt
+    may not accurately reflect the version installed on your system. `urxvt
     -h' gives a list of major compile-time options on the *Options* line.
     Option descriptions may be prefixed with which compile option each is
     dependent upon. e.g. `Compile *XIM*:' requires *XIM* on the *Options*
-    line. Note: `rxvt -help' gives a list of all command-line options
+    line. Note: `urxvt -help' gives a list of all command-line options
     compiled into your version.
-    Note that rxvt permits the resource name to be used as a long-option
+    Note that urxvt permits the resource name to be used as a long-option
     (--/++ option) so the potential command-line options are far greater
-    than those listed. For example: `rxvt --loginShell --color1 Orange'.
+    than those listed. For example: `urxvt --loginShell --color1 Orange'.
     The following options are available:
     -help, --help
         Print out a message describing available options.
         transparency is enabled with -tr or -ip. This only works for
         non-tiled backgrounds, currently. See also the -sh option that can
         be used to brighten or darken the image in addition to tinting it;
         resource *tintColor*. Example:
-           rxvt -tr -tint blue -sh 40
+           urxvt -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").
         In short, to specify an X11 core font, just specify its name or
         prefix it with "x:". To specify an XFT-font, you need to prefix it
         with "xft:", e.g.:
-           rxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
+           urxvt -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
-           rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
+           urxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
         See also the question "How does rxvt-unicode choose fonts?" in the
-        FAQ section of rxvt(7).
+        FAQ section of urxvt(7).
     -fb *fontlist*
         Compile *font-styles*: The bold font list to use when bold
         characters are to be printed. See resource boldFont for details.
         TERM environment variable. This terminal type must exist in the
         *termcap(5)* database and should have *li#* and *co#* entries;
         resource termName.
     -e *command [arguments]*
-        Run the command with its command-line arguments in the rxvt window;
+        Run the command with its command-line arguments in the urxvt window;
         also sets the window title and icon name to be the basename of the
         program being executed if neither *-title* (*-T*) nor *-n* are given
         on the command line. If this option is used, it must be the last on
         the command-line. If there is no -e option then the default is to
         run the program specified by the SHELL environment variable or,
         Please note that you must specify a program with arguments. If you
         want to run shell commands, you have to specify the shell, like
         this:
-          rxvt -e sh -c "shell commands"
+          urxvt -e sh -c "shell commands"
     -title *text*
         Window title (-T still respected); the default title is the basename
         of the program specified after the -e option, if any, otherwise the
         application name; resource title.
     -ssr|+ssr
         Turn on/off secondary screen scroll (default enabled); resource
         secondaryScroll.
     -hold|+hold
-        Turn on/off hold window after exit support. If enabled, rxvt will
+        Turn on/off hold window after exit support. If enabled, urxvt will
         not immediately destroy its window when the program executed within
         it exits. Instead, it will wait till it is being killed or closed by
         the user; resource hold.
     -keysym.*sym* *string*
         Remap a key symbol. See resource keysym.
     -embed *windowid*
-        Tells rxvt to embed its windows into an already-existing window,
+        Tells urxvt to embed its 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
+        Right now, urxvt will first unmap/map the specified window, so it
-        shouldn't be a top-level window. rxvt will also reconfigure it quite
+        shouldn't be a top-level window. urxvt will also reconfigure it
-        a bit, so don't expect it to keep some specific state. It's best to
+        quite a bit, so don't expect it to keep some specific state. It's
-        create an extra subwindow for rxvt and leave it alone.
+        best to create an extra subwindow for urxvt and leave it alone.
-        The window will not be destroyed when rxvt exits.
+        The window will not be destroyed when urxvt exits.
-        It might be useful to know that rxvt will not close file descriptors
+        It might be useful to know that urxvt will not close file
-        passed to it (except for stdin/out/err, of course), so you can use
+        descriptors passed to it (except for stdin/out/err, of course), so
-        file descriptors to communicate with the programs within the
+        you can use file descriptors to communicate with the programs within
-        terminal. This works regardless of wether the "-embed" option was
+        the terminal. This works regardless of wether the "-embed" option
-        used or not.
+        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 &";
+              system "urxvt -embed $xid &";
            });
     -pty-fd *file descriptor*
-        Tells rxvt NOT to execute any commands or create a new pty/tty pair
+        Tells urxvt 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
+        useful if you want to drive urxvt 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
+        If this switch is given, urxvt 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.
         As an extremely special case, specifying -1 will completely suppress
         pty/tty operations.
            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) . "&";
+           system "urxvt -pty-fd " . (fileno $pty) . "&";
            close $pty;
            # now communicate with rxvt
            my $slave = $pty->slave;
            while (<$slave>) { print $slave "got <$_>\n" }
     -pe *string*
         Comma-separated list of perl extension scripts to use (or not to
         use) in this terminal instance. See resource perl-ext for details.
 RESOURCES (available also as long-options)
-    Note: `rxvt --help' gives a list of all resources (long options)
+    Note: `urxvt --help' gives a list of all resources (long options)
     compiled into your version.
     You can set and change the resources using X11 tools like xrdb. Many
     distribution do also load settings from the ~/.Xresources file when X
-    starts. rxvt will consult the following files/resources in order, with
+    starts. urxvt 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-<nodename>
-    Note that when reading X resources, rxvt recognizes two class names:
+    Note that when reading X resources, urxvt recognizes two class names:
-    Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
+    Rxvt and URxvt. The class name Rxvt allows resources common to both
-    and the original *rxvt* to be easily configured, while the class name
+    urxvt and the original *rxvt* to be easily configured, while the class
-    URxvt allows resources unique to rxvt, to be shared between different
+    name URxvt allows resources unique to urxvt, to be shared between
-    rxvt configurations. If no resources are specified, suitable defaults
+    different urxvt configurations. If no resources are specified, suitable
-    will be used. Command-line arguments can be used to override resource
+    defaults will be used. Command-line arguments can be used to override
-    settings. The following resources are supported (you might want to check
+    resource settings. The following resources are supported (you might want
-    the rxvtperl(3) manpage for additional settings by perl extensions not
+    to check the urxvtperl(3) manpage for additional settings by perl
-    documented here):
+    extensions not documented here):
     depth: *bitdepth*
         Compile *xft*: Attempt to find a visual with the given bit depth;
         option -depth.
         1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but
         the actual colour names used are listed in the COLORS AND GRAPHICS
         section.
         Colours higher than 15 cannot be set using resources (yet), but can
-        be changed using an escape command (see rxvt(7)).
+        be changed using an escape command (see urxvt(7)).
         Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm
         with 88 colour support). Colours 80-87 are evenly spaces grey steps.
     colorBD: *colour*
     cutchars: *string*
         The characters used as delimiters for double-click word selection
         (whitespace delimiting is added automatically if resource is given).
         When the selection extension is in use (the default if compiled in,
-        see the rxvtperl(3) manpage), a suitable regex using these
+        see the urxvtperl(3) manpage), a suitable regex using these
         characters will be created (if the resource exists, otherwise, no
         regex will be created). In this mode, characters outside ISO-8859-1
         can be used.
         When the selection extension is not used, only ISO-8859-1 characters
     imFont: *fontset*
         Specify the font-set used for XIM styles "OverTheSpot" or
         "OffTheSpot". It must be a standard X font set (XLFD patterns
         separated by commas), i.e. it's not in the same format as the other
-        font lists used in rxvt. The default will be set-up to chose *any*
+        font lists used in urxvt. The default will be set-up to chose *any*
         suitable found found, preferably one or two pixels differing in size
         to the base font. option -imfont.
     tripleclickwords: *boolean*
         Change the meaning of triple-click selection with the left mouse
         option is enabled, scrolls on the secondary screen will change the
         scrollback buffer and switching to/from the secondary screen will
         instead scroll the screen up.
     hold: *boolean*
-        Turn on/off hold window after exit support. If enabled, rxvt will
+        Turn on/off hold window after exit support. If enabled, urxvt will
         not immediately destroy its window when the program executed within
         it exits. Instead, it will wait till it is being killed or closed by
         the user.
     keysym.*sym*: *string*
         "^@": null, "^A" ...) and may be enclosed with double quotes so that
         it can start or end with whitespace.
         Please note that you need to double the "\" in resource files, as
         Xlib itself does its own de-escaping (you can use "\033" instead of
-        "\e" (and so on), which will work with both Xt and rxvt's own
+        "\e" (and so on), which will work with both Xt and urxvt's own
         processing).
         You can define a range of keysyms in one shot by providing a
         *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
         `/' should be a character not used by the strings.
           URxvt.keysym.Meta-Control-0x61:    \033<M-C-a>
           URxvt.keysym.Meta-Control-0x62:    \033<M-C-b>
           URxvt.keysym.Meta-Control-0x63:    \033<M-C-c>
         If *string* takes the form of "command:STRING", the specified STRING
-        is interpreted and executed as rxvt's control sequence. For example
+        is interpreted and executed as urxvt'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
         If *string* takes the form "perl:STRING", then the specified STRING
         is passed to the "on_keyboard_command" perl handler. See the
-        rxvtperl(3) manpage. For example, the selection extension (activated
+        urxvtperl(3) manpage. For example, the selection extension
-        via "rxvt -pe selection") listens for "selection:rot13" events:
+        (activated via "urxvt -pe selection") listens for "selection:rot13"
+        events:
           URxvt.keysym.M-C-c: perl:selection:rot13
         Due the the large number of modifier combinations, a defined key
         mapping will match if at *at least* the specified identifiers 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
+        if you overwrite the "Insert" key you will disable urxvt'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:
         font-switching at runtime:
           URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
           URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
-        Other things are possible, e.g. resizing (see rxvt(7) for more
+        Other things are possible, e.g. resizing (see urxvt(7) for more
         info):
           URxvt.keysym.M-C-3: command:\033[8;25;80t
           URxvt.keysym.M-C-4: command:\033[8;48;110t
         available to all instances, while perl-ext is used for specific
         instances.
     perl-eval: *string*
         Perl code to be evaluated when all extensions have been registered.
-        See the rxvtperl(3) manpage. Due to security reasons, this resource
+        See the urxvtperl(3) manpage. Due to security reasons, this resource
         will be ignored when running setuid/setgid.
     perl-lib: *path*
         Colon-separated list of additional directories that hold extension
         scripts. When looking for extensions specified by the "perl"
-        resource, rxvt will first look in these directories and then in
+        resource, urxvt will first look in these directories and then in
-        /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
+        /usr/local/lib/urxvt/perl/. Due to security reasons, this resource
         will be ignored when running setuid/setgid.
-        See the rxvtperl(3) manpage.
+        See the urxvtperl(3) manpage.
     selection.pattern-*idx*: *perl-regex*
-        Additional selection patterns, see the rxvtperl(3) manpage for
+        Additional selection patterns, see the urxvtperl(3) manpage for
         details.
     selection-autotransform.*idx*: *perl-transform*
-        Selection auto-transform patterns, see the rxvtperl(3) manpage for
+        Selection auto-transform patterns, see the urxvtperl(3) manpage for
         details.
     searchable-scrollback: *keysym*
         Sets the hotkey that starts the incremental scrollback buffer search
         (default: "M-s").
         Compile *frills*: Sets override-redirect for the terminal window,
         making it almost invisible to window managers; option
         -override-redirect.
 THE SCROLLBAR
-    Lines of text that scroll off the top of the rxvt window (resource:
+    Lines of text that scroll off the top of the urxvt window (resource:
     saveLines) and can be scrolled back using the scrollbar or by
-    keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
+    keystrokes. The normal urxvt scrollbar has arrows and its behaviour is
     fairly intuitive. The xterm-scrollbar is without arrows and its
     behaviour mimics that of *xterm*
     Scroll down with Button1 (xterm-scrollbar) or Shift-Next. Scroll up with
     Button3 (xterm-scrollbar) or Shift-Prior. Continuous scroll with
         normal one. In this mode, every selected row becomes its own line in
         the selection, and trailing whitespace is visually underlined and
         removed from the selection.
     Insertion:
-        Pressing and releasing the Middle mouse button in an rxvt window
+        Pressing and releasing the Middle mouse button in an urxvt window
         causes the value of the PRIMARY selection (or CLIPBOARD with the
         Meta modifier) to be inserted as if it had been typed on the
         keyboard.
         Pressing Shift-Insert causes the value of the PRIMARY selection to
     With respect to conformance, rxvt-unicode is supposed to be compliant to
     both scenario A and B of ISO 14755, including part 5.2.
 LOGIN STAMP
-    rxvt tries to write an entry into the *utmp*(5) file so that it can be
+    urxvt tries to write an entry into the *utmp*(5) file so that it can be
     seen via the *who(1)* command, and can accept messages. To allow this
-    feature, rxvt may need to be installed setuid root on some systems or
+    feature, urxvt may need to be installed setuid root on some systems or
     setgid to root or to some other group on others.
 COLORS AND GRAPHICS
-    In addition to the default foreground and background colours, rxvt can
+    In addition to the default foreground and background colours, urxvt can
     display up to 16 colours (8 ANSI colours plus high-intensity bold/blink
     versions of the same). Here is a list of the colours with their names.
    color0          (black)         = Black
    color1          (red)           = Red3
     It is also possible to specify the colour values of foreground,
     background, cursorColor, cursorColor2, colorBD, colorUL as a number
     0-15, as a convenient shorthand to reference the colour name of
     color0-color15.
-    In addition to the colours defined above, rxvt offers an additional 72
+    In addition to the colours defined above, urxvt offers an additional 72
     colours. The first 64 of those (with indices 16 to 79) consist of a
     4*4*4 RGB colour cube (i.e. *index = r * 16 + g * 4 + b + 16*), followed
     by 8 additional shades of gray (with indices 80 to 87).
     Together, all those colours implement the 88 colour xterm colours. Only
     Note that -rv ("reverseVideo: True") simulates reverse video by always
     swapping the foreground/background colours. This is in contrast to
     *xterm*(1) where the colours are only swapped if they have not otherwise
     been specified. For example,
-    rxvt -fg Black -bg White -rv
+    urxvt -fg Black -bg White -rv
         would yield White on Black, while on *xterm*(1) it would yield Black
         on White.
   ALPHA CHANNEL SUPPORT
     If Xft support has been compiled in and as long as Xft/Xrender/X don't
     ARGB visuals out of the box, and rxvt-unicode just fudges around.
     For example, the following selects an almost completely transparent red
     background, and an almost opaque pink foreground:
-       rxvt -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
+       urxvt -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
     *Please note that transparency of any kind if completely unsupported by
     the author. Don't bug him with installation questions!*
 ENVIRONMENT
-    rxvt sets and/or uses the following environment variables:
+    urxvt sets and/or uses the following environment variables:
     TERM
         Normally set to "rxvt-unicode", unless overwritten at configure
         time, via resources or on the commandline.
     COLORTERM
-        Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled
+        Either "rxvt", "rxvt-xpm", depending on wether urxvt was compiled
         with XPM support, and optionally with the added extension "-mono" to
         indicate that rxvt-unicode runs on a monochrome screen.
     COLORFGBG
         Set to a string of the form "fg;bg" or "fg;xpm;bg", where "fg" is
         the colour code used as default foreground/text colour (or the
         string "default" to indicate that the default-colour escape sequence
         is to be used), "bg" is the colour code used as default background
         colour (or the string "default"), and "xpm" is the string "default"
-        if rxvt was compiled with XPM support. Libraries like "ncurses" and
+        if urxvt was compiled with XPM support. Libraries like "ncurses" and
         "slang" can (and do) use this information to optimize screen output.
     WINDOWID
-        Set to the (decimal) X Window ID of the rxvt window (the toplevel
+        Set to the (decimal) X Window ID of the urxvt window (the toplevel
         window, which usually has subwindows for the scrollbar, the terminal
         window and so on).
     TERMINFO
-        Set to the terminfo directory iff rxvt was configured with
+        Set to the terminfo directory iff urxvt was configured with
         "--with-terminfo=PATH".
     DISPLAY
-        Used by rxvt to connect to the display and set to the correct
+        Used by urxvt to connect to the display and set to the correct
         display in its child processes.
     SHELL
         The shell to be used for command execution, defaults to "/bin/sh".
     RXVT_SOCKET
-        The unix domain socket path used by rxvtc(1) and rxvtd(1).
+        The unix domain socket path used by urxvtc(1) and urxvtd(1).
         Default $HOME/.rxvt-unicode-*<nodename*.
     HOME
         Used to locate the default directory for the unix domain socket for
     XAPPLRESDIR
         Directory where various X resource files are being located.
     XENVIRONMENT
         If set and accessible, gives the name of a X resource file to be
-        loaded by rxvt.
+        loaded by urxvt.
 FILES
     /usr/lib/X11/rgb.txt
         Color names.
 SEE ALSO
-    rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4),
+    urxvt(7), urxvtc(1), urxvtd(1), xterm(1), sh(1), resize(1), X(1),
-    tty(4), utmp(5)
+    pty(4), tty(4), utmp(5)
 CURRENT PROJECT COORDINATOR
     Project Coordinator
         Marc A. Lehmann <rxvt-unicode@schmorp.de>

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents): Revision 1.60 by root, Thu Jul 6 19:43:21 2006 UTC vs. Revision 1.61 by root, Mon Jul 17 19:20:29 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.60 by root, Thu Jul 6 19:43:21 2006 UTC vs.
Revision 1.61 by root, Mon Jul 17 19:20:29 2006 UTC