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

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.44 by root, Thu Jan 12 12:15:10 2006 UTC vs.
Revision 1.63 by root, Thu Nov 2 17:37:47 2006 UTC

 SYNOPSIS
     rxvt [options] [-e command [ args ]]
 DESCRIPTION
-    rxvt-unicode, version 7.0, is a colour vt102 terminal emulator intended
+    rxvt-unicode, version 8.0, 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
     and answer to them and some common problems. That document is also
     accessible on the World-Wide-Web at
-    <http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
+    <http://cvs.schmorp.de/browse/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
     world. Being a terminal emulator, however, some things are very
     difficult, especially cursive scripts such as arabic, vertically written
     scripts like mongolian or scripts requiring extremely complex combining
     rules, like tibetan or devenagari. Don't expect pretty output when using
     these scripts. Most other scripts, latin, cyrillic, kanji, thai etc.
-    should work fine, though. A somewhat difficult case are left-to-right
+    should work fine, though. A somewhat difficult case are right-to-left
     scripts, such as hebrew: rxvt-unicode adopts the view that bidirectional
     algorithms belong into the application, not the terminal emulator (too
     many things -- such as cursor-movement while editing -- break
     otherwise), but that might change.
     If you are looking for a terminal that supports more exotic scripts, let
-    me recommend "mlterm", which is a very userfriendly, lean and clean
+    me recommend "mlterm", which is a very user friendly, lean and clean
     terminal emulator. In fact, the reason rxvt-unicode was born was solely
     because the author couldn't get "mlterm" to use one font for latin1 and
     another for japanese.
     Therefore another design rationale was the use of multiple fonts to
     display characters: The idea of a single unicode font which many other
-    programs force onto it's users never made sense to me: You should be
+    programs force onto its users never made sense to me: You should be able
-    able to choose any font for any script freely.
+    to choose any font for any script freely.
     Apart from that, rxvt-unicode is also much better internationalised than
-    it's predecessor, supports things such as XFT and ISO 14755 that are
+    its predecessor, supports things such as XFT and ISO 14755 that are
-    handy in i18n-environments, is faster, and has a lot less bugs than the
+    handy in i18n-environments, is faster, and has a lot bugs less than the
     original rxvt. This all in addition to dozens of other small
     improvements.
     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 it's features to get a lean binary. It also comes with a
+    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)
     (client).
     It also makes technical information about escape sequences (which have
-    been extended) easier accessible: see rxvt(7) for technical reference
+    been extended) more accessible: see rxvt(7) for technical reference
     documentation (escape sequences etc.).
 OPTIONS
     The rxvt options (mostly a subset of *xterm*'s) are listed below. In
     keeping with the smaller-is-better philosophy, options may be eliminated
     -display *displayname*
         Attempt to open a window on the named X display (-d still
         respected). In the absence of this option, the display specified by
         the DISPLAY environment variable is used.
+    -depth *bitdepth*
+        Compile *xft*: Attempt to find a visual with the given bit depth;
+        resource depth.
     -geometry *geom*
         Window geometry (-g still respected); resource geometry.
     -rv|+rv
         Turn on/off simulated reverse video; resource reverseVideo.
         Turn on/off jump scrolling; resource jumpScroll.
     -ip|+ip | -tr|+tr
         Turn on/off inheriting parent window's pixmap. Alternative form is
         -tr; resource inheritPixmap.
+        *Please note that transparency of any kind if completely unsupported
+        by the author. Don't bug him with installation questions! Read the
+        FAQ (man 7 rxvt)!*
     -fade *number*
         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 fading.
     -fadecolor *colour*
         Fade to this colour when fading is used (see -fade). The default
-        colour is black. resource fadeColor.
+        colour is opaque black. resource fadeColor.
     -tint *colour*
         Tint the transparent background pixmap with the given colour when
         transparency is enabled with -tr or -ip. This only works for
         non-tiled backgrounds, currently. See also the -sh option that can
         The colour of the border around the text area and between the
         scrollbar and the text; resource borderColor.
     -fn *fontlist*
         Select the fonts to be used. This is a comma separated list of font
-        names that are used in turn when trying to display Unicode
+        names that are checked in order when trying to find glyphs for
         characters. The first font defines the cell size for characters;
         other fonts might be smaller, but not (in general) larger. A
         (hopefully) reasonable default font list is always appended to it.
         See resource font for more details.
-        In short, to specify an X11 core font, just specify it's name or
+        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"
            rxvt -fn "9x15bold,xft:Bitstream Vera Sans Mono"
         externalBorder.
     -bl Compile *frills*: Set MWM hints to request a borderless window, i.e.
         if honoured by the WM, the rxvt-unicode window will not have window
         decorations; resource borderLess.
+    -override-redirect
+        Compile *frills*: Sets override-redirect on the window; resource
+        override-redirect.
     -sbg
         Compile *frills*: Disable the usage of the built-in block
         graphics/line drawing characters and just rely on what the specified
         fonts provide. Use this if you have a good font and want to use its
     -keysym.*sym* *string*
         Remap a key symbol. See resource keysym.
     -embed *windowid*
-        Tells rxvt to embed it's windows into an already-existing window,
+        Tells rxvt 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
         shouldn't be a top-level window. rxvt will also reconfigure it quite
         a bit, so don't expect it to keep some specific state. It's best to
         The window will not be destroyed when rxvt exits.
         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
+        terminal. This works regardless of whether 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):
               system "rxvt -embed $xid &";
            });
     -pty-fd *file descriptor*
         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
+        but instead use the given file descriptor 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
     will be used. Command-line arguments can be used to override resource
     settings. The following resources are supported (you might want to check
     the rxvtperl(3) manpage for additional settings by perl extensions not
     documented here):
+    depth: *bitdepth*
+        Compile *xft*: Attempt to find a visual with the given bit depth;
+        option -depth.
     geometry: *geom*
         Create the window with the specified X window geometry [default
         80x24]; option -geometry.
     background: *colour*
     inheritPixmap: *boolean*
         True: make the background inherit the parent windows' pixmap, giving
         artificial transparency. False: do not inherit the parent windows'
         pixmap.
+        *Please note that transparency of any kind if completely unsupported
+        by the author. Don't bug him with installation questions!*
     fading: *number*
         Fade the text by the given percentage when focus is lost; option
         -fade.
         scale of 1 displays the image without any scaling. A scale of 2 to 9
         specifies an integer number of images in that direction. No image
         will be magnified beyond 10 times its original size. The maximum
         permitted scale is 1000. [default 0x0+50+50]
-    menu: *file[;tag]*
-        Read in the specified menu file (note the `.menu' extension is
-        optional) and also optionally specify a starting tag to find. See
-        the reference documentation for details on the syntax for the
-        menuBar.
     path: *path*
-        Specify the colon-delimited search path for finding files (XPM and
+        Specify the colon-delimited search path for finding XPM files.
-        menus), in addition to the paths specified by the RXVTPATH and PATH
-        environment variables.
     font: *fontlist*
         Select the fonts to be used. This is a comma separated list of font
-        names that are used in turn when trying to display Unicode
+        names that are checked in order when trying to find glyphs for
         characters. The first font defines the cell size for characters;
-        other fonts might be smaller, but not larger. A reasonable default
+        other fonts might be smaller, but not (in general) larger. A
-        font list is always appended to it; option -fn.
+        (hopefully) reasonable default font list is always appended to it;
+        option -fn.
         Each font can either be a standard X11 core font (XLFD) name, with
         optional prefix "x:" or a Xft font (Compile *xft*), prefixed with
         "xft:".
         available hint currently is "codeset=codeset-name", and this is only
         used for Xft fonts.
         For example, this font resource
-           URxvt*font: 9x15bold,\
+           URxvt.font: 9x15bold,\
                        -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
                        -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
                        [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
                        xft:Code2000:antialias=false
         normal text font will being used for the given style.
     intensityStyles: *boolean*
         When font styles are not enabled, or this option is enabled (True,
         option -is, the default), bold and italic font styles imply high
-        intensity foreground/backround colours. Disabling this option
+        intensity foreground/background colours. Disabling this option
         (False, option +is) disables this behaviour, the high intensity
         colours are not reachable.
     selectstyle: *mode*
         Set mouse selection style to old which is 2.20, oldword which is
         The string will be interpreted as if typed into the shell as-is.
         Example:
-           URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
+           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".
+        contents every time you hit "Print".
     scrollBar: *boolean*
         True: enable the scrollbar [default]; option -sb. False: disable the
         scrollbar; option +sb.
         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
-        scrollback buffer when tty recieves new lines; option +sw.
+        scrollback buffer when tty receives 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
         The string to send when the delete key (not the keypad delete key)
         is pressed. If unset it will send the sequence traditionally
         associated with the Execute key.
     cutchars: *string*
-        The characters used as delimiters for double-click word selection.
+        The characters used as delimiters for double-click word selection
-        The built-in default:
+        (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
+        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
+        can be used. If not specified, the built-in default is used:
         BACKSLASH `"'&()*,;<=>?@[]{|}
     preeditType: *style*
         OverTheSpot, OffTheSpot, Root; option -pt.
         xterm, have these sequences enabled by default, which doesn't make
         it safer, though).
         You can enable them by setting this boolean resource or specifying
         -insecure as an option. At the moment, this enables display-answer,
-        locale, findfont, icon label and window title requests as well as
+        locale, findfont, icon label and window title requests.
-        dynamic menubar dispatch.
     modifier: *modifier*
         Set the key to be interpreted as the Meta key to: alt, meta, hyper,
         super, mod1, mod2, mod3, mod4, mod5; option -mod.
     answerbackString: *string*
         Specify the reply rxvt-unicode sends to the shell when an ENQ
         (control-E) character is passed through. It may contain escape
         values as described in the entry on keysym following.
-    secondaryScreen: *bool*
+    secondaryScreen: *boolean*
         Turn on/off secondary screen (default enabled).
-    secondaryScroll: *bool*
+    secondaryScroll: *boolean*
         Turn on/off secondary screen scroll (default enabled). If the this
         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: *bool*
+    hold: *boolean*
         Turn on/off hold window after exit support. If enabled, rxvt 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.
         *string* may contain escape values ("\a": bell, "\b": backspace,
         "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
         "\000": octal number) or verbatim control characters ("^?": delete,
         "^@": null, "^A" ...) and may be enclosed with double quotes so that
-        it can start or end with whitespace.
+        it can start or end with whitespace. This feature is deprecated and
+        will be removed.
         Please note that you need to double the "\" in resource files, as
-        Xlib itself does it's own de-escaping (you can use "\033" instead of
+        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
         processing).
         You can define a range of keysyms in one shot by providing a
-        *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimeter
+        *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter
         `/' should be a character not used by the strings.
         Its usage can be demonstrated by an example:
           URxvt.keysym.M-C-0x61:    list|\033<M-C-|abc|>
         For example, "default,-selection" will use all the default extension
         except "selection".
         Extension names can also be followed by an argument in angle
         brackets (e.g. "searchable-scrollback<M-s>", which binds the hotkey
-        for searchable scorllback to Alt/Meta-s). Mentioning the same
+        for searchable scrollback to Alt/Meta-s). Mentioning the same
         extension multiple times with different arguments will pass multiple
         arguments to the extension.
         Each extension is looked up in the library directories, loaded if
         necessary, and bound to the current terminal instance.
     urlLauncher: *string*
         Specifies the program to be started with a URL argument. Used by the
         "selection-popup" and "mark-urls" perl extensions.
     transient-for: *windowid*
-        Sets the WM_TRANSIENT_FOR property to the given window iw.
+        Compile *frills*: Sets the WM_TRANSIENT_FOR property to the given
+        window id.
+    override-redirect: *boolean*
+        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:
     saveLines) and can be scrolled back using the scrollbar or by
     keystrokes. The normal rxvt scrollbar has arrows and its behaviour is
         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 (or Shift-Insert) in
+        Pressing and releasing the Middle mouse button in an rxvt window
-        an rxvt window causes the current text selection to be inserted as
+        causes the value of the PRIMARY selection (or CLIPBOARD with the
-        if it had been typed on the keyboard.
+        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
+        be inserted too.
 CHANGING FONTS
     Changing fonts (or font sizes, respectively) via the keypad is not yet
     supported in rxvt-unicode. Bug me if you need this.
-    You can, however, switch fonts at runtime using escape sequences (and
+    You can, however, switch fonts at runtime using escape sequences, e.g.:
-    therefore using the menubar), e.g.:
        printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
+    You can use keyboard shortcuts, too:
+       URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
+       URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
     rxvt-unicode will automatically re-apply these fonts to the output so
     far.
 ISO 14755 SUPPORT
         This mode lets you input characters representing the keycap symbols
         of your keyboard, if representable in the current locale encoding.
         Start by pressing "Control" and "Shift" together, then releasing
         them. The next special key (cursor keys, home etc.) you enter will
-        not invoke it's usual function but instead will insert the
+        not invoke its usual function but instead will insert the
         corresponding keycap symbol. The symbol will only be entered when
         the key has been released, otherwise pressing e.g. "Shift" would
         enter the symbol for "ISO Level 2 Switch", although your intention
         might have been to enter a reverse tab (Shift-Tab).
     setgid to root or to some other group on others.
 COLORS AND GRAPHICS
     In addition to the default foreground and background colours, rxvt 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 rgb.txt
+    versions of the same). Here is a list of the colours with their names.
-    names.
        color0          (black)         = Black
        color1          (red)           = Red3
        color2          (green)         = Green3
        color3          (yellow)        = Yellow3
     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
+    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
+    the first 16 can be changed using resources currently, the rest can only
+    be changed via command sequences ("escape codes").
     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
         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
+    get their act together, rxvt-unicode will support
+    "rgba:rrrr/gggg/bbbb/aaaa" (recommended, but MUST have 4
+    digits/component) colour specifications, in addition to the ones
+    provided by X, where the additional A component specifies opacity
+    (alpha) values. The minimum value of 0 is completely transparent). You
+    can also prefix any color with "[a]", where "a" is on to four hex digits
+    specifiying the opacity value.
+    You probably need to specify "-depth 32", too, and have the luck that
+    your X-server uses ARGB pixel layout, as X is far from just supporting
+    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"
+    *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:
     TERM
         Normally set to "rxvt-unicode", unless overwritten at configure
-        time, via resources or on the commandline.
+        time, via resources or on the command line.
     COLORTERM
-        Either "rxvt", "rxvt-xpm", depending on wether rxvt was compiled
+        Either "rxvt", "rxvt-xpm", depending on whether rxvt 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
         Set to the terminfo directory iff rxvt was configured with
         "--with-terminfo=PATH".
     DISPLAY
         Used by rxvt to connect to the display and set to the correct
-        display in it's child processes.
+        display in its child processes.
     SHELL
         The shell to be used for command execution, defaults to "/bin/sh".
-    RXVTPATH
-        The path where rxvt looks for support files such as menu and xpm
-        files.
-    PATH
-        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*.
 CURRENT PROJECT COORDINATOR
     Project Coordinator
         Marc A. Lehmann <rxvt-unicode@schmorp.de>
-        <http://software.schmorp.de/#rxvt-unicode>
+        <http://software.schmorp.de/pkg/rxvt-unicode.html>
 AUTHORS
     John Bovey
         University of Kent, 1992, wrote the original Xvt.
     Oezguer Kesim <kesim@math.fu-berlin.de>
         Project Coordinator (changes.txt 2.21a to 2.4.5)
     Geoff Wing <gcw@pobox.com>
-        Rewrote screen display and text selection routines. Project
+        Rewrote screen display and text selection routines.
-        Coordinator (changes.txt 2.4.6 - rxvt-unicode)
+        Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
     Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
-        Forked rxvt-unicode, rewrote most of the display code and internal
+        Forked rxvt-unicode, unicode support, rewrote almost all the code,
-        character handling to store text in unicode, improve xterm
+        perl extension, random hacks, numerous bugfixes and extensions.
-        compatibility and apply numerous other bugfixes and extensions.
         Project Coordinator (Changes 1.0 -)
+    Emanuele Giaquinta <e.giaquinta@glauco.it>
+        Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents): Revision 1.44 by root, Thu Jan 12 12:15:10 2006 UTC vs. Revision 1.63 by root, Thu Nov 2 17:37:47 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.44 by root, Thu Jan 12 12:15:10 2006 UTC vs.
Revision 1.63 by root, Thu Nov 2 17:37:47 2006 UTC