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

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.42 by root, Wed Jan 11 23:08:54 2006 UTC vs.
Revision 1.58 by root, Tue Feb 21 01:00:40 2006 UTC

 SYNOPSIS
     rxvt [options] [-e command [ args ]]
 DESCRIPTION
-    rxvt-unicode, version 7.0, is a colour vt102 terminal emulator intended
+    rxvt-unicode, version 7.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.
     -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!*
     -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.
         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
     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
         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".
     scrollBar: *boolean*
         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.
         /opt/rxvt/lib/urxvt/perl/. Due to security reasons, this resource
         will be ignored when running setuid/setgid.
         See the rxvtperl(3) manpage.
+    selection.pattern-*idx*: *perl-regex*
+        Additional selection patterns, see the rxvtperl(3) manpage for
+        details.
+    selection-autotransform.*idx*: *perl-transform*
+        Selection auto-transform patterns, see the rxvtperl(3) manpage for
+        details.
+    searchable-scrollback: *keysym*
+        Sets the hotkey that starts the incremental scrollback buffer search
+        (default: "M-s").
     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
     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
         display in it's 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*.
     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.42 by root, Wed Jan 11 23:08:54 2006 UTC vs. Revision 1.58 by root, Tue Feb 21 01:00:40 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.42 by root, Wed Jan 11 23:08:54 2006 UTC vs.
Revision 1.58 by root, Tue Feb 21 01:00:40 2006 UTC