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

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.65 by root, Sat Feb 17 20:36:36 2007 UTC vs.
Revision 1.71 by root, Fri Nov 23 13:11:31 2007 UTC

 SYNOPSIS
     rxvt [options] [-e command [ args ]]
 DESCRIPTION
-    rxvt-unicode, version 8.2, is a colour vt102 terminal emulator intended
+    rxvt-unicode, version 8.6, 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.
     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
+    rules, like tibetan or devanagari. 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 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
     -rv|+rv
         Turn on/off simulated reverse video; resource reverseVideo.
     -j|+j
-        Turn on/off jump scrolling; resource jumpScroll.
+        Turn on/off jump scrolling (allow multiple lines per refresh);
+        resource jumpScroll.
-    -ip|+ip | -tr|+tr
+    -ss|+ss
-        Turn on/off inheriting parent window's pixmap. Alternative form is
+        Turn on/off skip scrolling (allow multiple screens per refresh);
-        -tr; resource inheritPixmap.
+        resource skipScroll.
-        *Please note that transparency of any kind if completely unsupported
+    -tr|+tr
-        by the author. Don't bug him with installation questions! Read the
+        Turn on/off illusion of a transparent window background. Obsolete
-        FAQ (man 7 rxvt)!*
+        form of it is -ip and it should not be used anymore; resource
+        transparent.
+        *Please note that old resource name of inheritPixmap is obsolete and
+        should be changed to transparent. Backwards compatibility support
+        for inheritPixmap will be phased out in future versions of rxvt!*
+        *Please address all transparency related issues to Sasha Vasko at
+        sasha@aftercode.net. 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.
         Fade to this colour when fading is used (see -fade). The default
         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
+        transparency is enabled with -tr. This only works for non-tiled
-        non-tiled backgrounds, currently. See also the -sh option that can
+        backgrounds, currently. See also the -sh option that can be used to
-        be used to brighten or darken the image in addition to tinting it;
+        brighten or darken the image in addition to tinting it. Please note
+        that certain tint colours can be applied on the server-side, thus
+        yielding performance gain of two orders of magnitude. These colours
+        are: blue, red, green, cyan, magenta, yellow, and those close to
+        them. Also pure black and pure white colors essentially mean no
-        resource *tintColor*. Example:
+        tinting; resource *tintColor*. Example:
            rxvt -tr -tint blue -sh 40
-    -sh *number* Darken (0 .. 100) or lighten (-1 .. -100) the transparent
+    -sh *number*
-        background image in addition to tinting it (i.e. -tint must be
+        Darken (0 .. 100) or lighten (100 .. 200) the transparent background
-        specified, too, e.g. "-tint white"); resource *shading*.
+        image in addition to (or instead of) tinting it; resource *shading*.
+    -blt *string*
+        Specify background blending type. If background pixmap is specified
+        at the same time as transparency - such pixmap will be blended over
+        transparency image, using method specified. Supported values are :
+        add, alphablend, allanon - color values averaging, colorize, darken,
+        diff, dissipate, hue, lighten, overlay, saturate, screen, sub, tint,
+        value. The default is alpha-blending. Compile *afterimage*; resource
+        *blendType*.
+    -blr *HxV*
+        Apply Gaussian Blur with the specified radii to the transparent
+        background image. If single number is specified - both vertical and
+        horizontal radii are considered to be the same. Setting one of the
+        radii to 1 and another to a large number creates interesting effects
+        on some backgrounds. Maximum radius value is 128. Compile
+        *afterimage*; resource *blurRadius*.
     -bg *colour*
         Window background colour; resource background.
     -fg *colour*
         Window foreground colour; resource foreground.
-    -pixmap *file[;geom]*
+    -pixmap *file[;geom[:op1][:op2][...]]*
-        Compile *XPM*: Specify XPM file for the background and also
+        Compile *afterimage*: Specify image file for the background and also
         optionally specify its scaling with a geometry string. Note you may
         need to add quotes to avoid special shell interpretation of the ";"
-        in the command-line; resource backgroundPixmap.
+        in the command-line; for more details see resource backgroundPixmap.
     -cr *colour*
         The cursor colour; resource cursorColor.
     -pr *colour*
         block graphic glyphs; resource skipBuiltinGlyphs.
     -lsp *number*
         Compile *frills*: Lines (pixel height) to insert between each row of
         the display. Useful to work around font rendering problems; resource
-        linespace.
+        lineSpace.
     -tn *termname*
         This option specifies the name of the terminal type to be set in the
         TERM environment variable. This terminal type must exist in the
         *termcap(5)* database and should have *li#* and *co#* entries;
         Set the font set to use for the X Input Method, see resource imFont
         for more info.
     -tcw
         Change the meaning of triple-click selection with the left mouse
+        button. Only effective when the original (non-perl) selection code
-        button. Instead of selecting a full line it will extend the
+        is in-use. Instead of selecting a full line it will extend the
         selection the end of the logical line only. resource
         tripleclickwords.
     -insecure
         Enable "insecure" mode, which currently enables most of the escape
         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; resource hold.
+    -xrm *string*
+        Works like the X Toolkit option of the same name, by adding the
+        *string* as if it were specified in a resource file. Resource values
+        specified this way take precedence over all other resource
+        specifications.
+        Note that you need to use the *same* syntax as in the .Xdefaults
+        file, e.g. "*.background: black". Also note that all rxvt-specific
+        options can be specified as long-options on the commandline, so use
+        of -xrm is mostly limited to cases where you want to specify other
+        resources (e.g. for input methods) or for compatibility with other
+        programs.
     -keysym.*sym* *string*
         Remap a key symbol. See resource keysym.
     -embed *windowid*
         Tells rxvt to embed its windows into an already-existing window,
       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>
+      6. resources specified via -xrm on the commandline
     Note that when reading X resources, rxvt recognizes two class names:
     Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
     and the original *rxvt* to be easily configured, while the class name
     URxvt allows resources unique to rxvt, to be shared between different
         True: simulate reverse video by foreground and background colours;
         option -rv. False: regular screen colours [default]; option +rv. See
         note in COLORS AND GRAPHICS section.
     jumpScroll: *boolean*
-        True: specify that jump scrolling should be used. When scrolling
+        True: specify that jump scrolling should be used. When receiving
-        quickly, fewer screen updates are performed [default]; option -j.
+        lots of lines, rxvt will only scroll once a whole screen height of
+        lines has been read, resulting in fewer updates while still
+        displaying every received line; option -j.
-        False: specify that smooth scrolling should be used; option +j.
+        False: specify that smooth scrolling should be used. rxvt will force
+        a screen refresh on each new line it received; option +j.
+    skipScroll: *boolean*
+        True: (the default) specify that skip scrolling should be used. When
+        receiving lots of lines, rxvt will only scroll once in a while
+        (around 60 times per second), resulting in far fewer updates. This
+        can result in rxvt not ever displaying some of the lines it
+        receives; option -ss.
+        False: specify that everything is to be displayed, even if the
+        refresh is too fast for the human eye to read anything (or the
+        monitor to display anything); option +ss.
     inheritPixmap: *boolean*
         True: make the background inherit the parent windows' pixmap, giving
         artificial transparency. False: do not inherit the parent windows'
         pixmap.
     shading: *number*
         Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
         image in addition to tinting it; option -sh.
+    blendType: *string*
+        Specify background blending type; option -blt.
+    blurRadius: *number*
+        Apply Gaussian Blurr with the specified radius to the transparent
+        background image; option -blr.
     scrollColor: *colour*
         Use the specified colour for the scrollbar [default #B2B2B2].
     troughColor: *colour*
         Use the specified colour for the scrollbar's trough area [default
     borderColor: *colour*
         The colour of the border around the text area and between the
         scrollbar and the text.
-    backgroundPixmap: *file[;geom]*
+    backgroundPixmap: *file[;geom[:op1][:op2][...]]*
-        Use the specified XPM file (note the `.xpm' extension is optional)
+        Use the specified image file for the background and also optionally
-        for the background and also optionally specify its scaling with a
+        specify its scaling with a geometry string WxH+X+Y, (default
-        geometry string WxH+X+Y, in which "W" / "H" specify the
+        "0x0+50+50") in which "W" / "H" specify the horizontal/vertical
-        horizontal/vertical scale (percent) and "X" / "Y" locate the image
+        scale (percent), and "X" / "Y" locate the image centre (percent). A
-        centre (percent). A scale of 0 displays the image with tiling. A
-        scale of 1 displays the image without any scaling. A scale of 2 to 9
+        scale of 0 displays the image with tiling. A scale of 1 displays the
-        specifies an integer number of images in that direction. No image
+        image without any scaling. A scale of 2 to 9 specifies an integer
-        will be magnified beyond 10 times its original size. The maximum
+        number of images in that direction. No image will be magnified
-        permitted scale is 1000. [default 0x0+50+50]
+        beyond 10 times its original size. The maximum permitted scale is
+        1000. Additional operations can be specified after colon
+        :op1:op2.... Supported operations are:
+          tile        force background image to be tiled and not scaled. Equivalent to 0x0,
+          propscale   will scale image keeping proportions,
+          auto        will scale image to match window size. Equivalent to 100x100;
+          hscale      will scale image horizontally to the window size;
+          vscale      will scale image vertically to the window size;
+          scale       will scale image to match window size;
+          root        will tile image as if it was a root window background, auto-adjusting
+                      whenever terminal window moves.
+        If used in conjunction with -tr option, the specified pixmap will be
+        blended over transparency image using either alpha-blending, or any
+        other blending type, specified with -blt "type" option.
     path: *path*
-        Specify the colon-delimited search path for finding XPM files.
+        Specify the colon-delimited search path for finding background image
+        files.
     font: *fontlist*
         Select the fonts to be used. This is a comma separated list of font
         names that are checked in order when trying to find glyphs for
         characters. The first font defines the cell size for characters;
         colours are not reachable.
     selectstyle: *mode*
         Set mouse selection style to old which is 2.20, oldword which is
         xterm style with 2.20 old word selection, or anything else which
-        gives xterm style selection.
+        gives xterm style selection. Only effective when the original
+        (non-perl) selection code is in use.
     scrollstyle: *mode*
         Set scrollbar style to rxvt, plain, next or xterm. plain is the
         author's favourite.
         explicitly set; option -n.
     mapAlert: *boolean*
         True: de-iconify (map) on receipt of a bell character. False: no
         de-iconify (map) on receipt of a bell character [default].
+    urgentOnBell: *boolean*
+        True: set the urgency hint for the wm on receipt of a bell
+        character. False: do not set the urgency hint [default].
     visualBell: *boolean*
         True: use visual bell on receipt of a bell character; option -vb.
         False: no visual bell [default]; option +vb.
     termName: *termname*
         Specifies the terminal type name to be set in the TERM environment
         variable; option -tn.
-    linespace: *number*
+    lineSpace: *number*
         Specifies number of lines (pixel height) to insert between each row
         of the display [default 0]; option -lsp.
     meta8: *boolean*
         True: handle Meta (Alt) + keypress to set the 8th bit. False: handle
     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,
+        When the perl selection extension is in use (the default if compiled
-        see the rxvtperl(3) manpage), a suitable regex using these
+        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 `"'&()*,;<=>?@[]{|}
+        BACKSLASH `"'&()*,;<=>?@[]^{|}
     preeditType: *style*
         OverTheSpot, OffTheSpot, Root; option -pt.
     inputMethod: *name*
     secondaryScreen: *boolean*
         Turn on/off secondary screen (default enabled).
     secondaryScroll: *boolean*
-        Turn on/off secondary screen scroll (default enabled). If the this
+        Turn on/off secondary screen scroll (default enabled). If 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: *boolean*
         omitting the prefix XK_. Alternatively you can specify *key* by its
         hex keysym value (0x0000 - 0xFFFF). Note that the lookup of *sym*s
         is not performed in an exact manner; however, the closest match is
         assured.
-        *string* may contain escape values ("\a": bell, "\b": backspace,
+        *string* may contain escape values ("\n": newline, "\000": octal
-        "\e", "\E": escape, "\n": newline, "\r": carriage return, "\t": tab,
+        number), see RESOURCES in "man 7 X" for futher details.
-        "\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. This feature is deprecated and
-        will be removed.
-        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
-        processing).
         You can define a range of keysyms in one shot by providing a
         *string* with pattern list/PREFIX/MIDDLE/SUFFIX, where the delimiter
         `/' should be a character not used by the strings.
     override-redirect: *boolean*
         Compile *frills*: Sets override-redirect for the terminal window,
         making it almost invisible to window managers; option
         -override-redirect.
+    iso14755_52: *boolean*
+        Turn on/off ISO 14755 5.2 mode (default enabled).
 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
     fairly intuitive. The xterm-scrollbar is without arrows and its
     disabled -- on the assumption that we are using a fullscreen
     application. Instead, pressing Button1 and Button3 sends ESC [ 6 ~
     (Next) and ESC [ 5 ~ (Prior), respectively. Similarly, clicking on the
     up and down arrows sends ESC [ A (Up) and ESC [ B (Down), respectively.
-TEXT SELECTION AND INSERTION
+THE SELECTION: SELECTING AND PASTING TEXT
-    The behaviour of text selection and insertion mechanism is similar to
+    The behaviour of text selection and insertion/pasting mechanism is
-    *xterm*(1).
+    similar to *xterm*(1).
-    Selection:
+    Selecting:
         Left click at the beginning of the region, drag to the end of the
         region and release; Right click to extend the marked region; Left
         double-click to select a word; Left triple-click to select the
         entire logical line (which can span multiple screen lines), unless
         modified by resource tripleclickwords.
         (Compile: *frills*) will create a rectangular selection instead of a
         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:
+    Pasting:
         Pressing and releasing the Middle mouse button in an rxvt 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.
     far.
 ISO 14755 SUPPORT
     ISO 14755 is a standard for entering and viewing unicode characters and
     character codes using the keyboard. It consists of 4 parts. The first
-    part is available rxvt-unicode has been compiled with "--enable-frills",
+    part is available if rxvt-unicode has been compiled with
-    the rest is available when rxvt-unicode was compiled with
+    "--enable-frills", the rest is available when rxvt-unicode was compiled
-    "--enable-iso14755".
+    with "--enable-iso14755".
     * 5.1: Basic method
         This allows you to enter unicode characters using their hexcode.
         Start by pressing and holding both "Control" and "Shift", then enter
         Normally set to "rxvt-unicode", unless overwritten at configure
         time, via resources or on the command line.
     COLORTERM
         Either "rxvt", "rxvt-xpm", depending on whether rxvt was compiled
-        with XPM support, and optionally with the added extension "-mono" to
+        with background image support, and optionally with the added
-        indicate that rxvt-unicode runs on a monochrome screen.
+        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 rxvt was compiled with background image support. Libraries like
-        "slang" can (and do) use this information to optimize screen output.
+        "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
         window, which usually has subwindows for the scrollbar, the terminal
         window and so on).

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents): Revision 1.65 by root, Sat Feb 17 20:36:36 2007 UTC vs. Revision 1.71 by root, Fri Nov 23 13:11:31 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.65 by root, Sat Feb 17 20:36:36 2007 UTC vs.
Revision 1.71 by root, Fri Nov 23 13:11:31 2007 UTC