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

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.29 by root, Mon Jan 2 15:11:05 2006 UTC vs.
Revision 1.55 by root, Sun Jan 29 22:38:43 2006 UTC

 SYNOPSIS
     rxvt [options] [-e command [ args ]]
 DESCRIPTION
-    rxvt-unicode, version 6.2, is a colour vt102 terminal emulator intended
+    rxvt-unicode, version 7.4, 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.
         See also the question "How does rxvt-unicode choose fonts?" in the
         FAQ section of rxvt(7).
     -fb *fontlist*
-        Compile font-styles: The bold font list to use when bold characters
+        Compile *font-styles*: The bold font list to use when bold
-        are to be printed. See resource boldFont for details.
+        characters are to be printed. See resource boldFont for details.
     -fi *fontlist*
-        Compile font-styles: The italic font list to use when bold
+        Compile *font-styles*: The italic font list to use when *italic*
         characters are to be printed. See resource italicFont for details.
     -fbi *fontlist*
-        Compile font-styles: The bold italic font list to use when bold
+        Compile *font-styles*: The bold italic font list to use when *bold
-        characters are to be printed. See resource boldItalicFont for
+        italic* characters are to be printed. See resource boldItalicFont
-        details.
+        for details.
     -is|+is
-        Compile font-styles: Bold/Italic font styles imply high intensity
+        Compile *font-styles*: Bold/Italic font styles imply high intensity
         foreground/background (default). See resource intensityStyles for
         details.
     -name *name*
         Specify the application name under which resources are to be
         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
+        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.
            $rxvt->signal_connect_after (realize => sub {
               my $xid = $_[0]->window->get_xid;
               system "rxvt -embed $xid &";
            });
-    -pty-fd *fileno*
+    -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
         useful if you want to drive rxvt as a generic terminal emulator
         without having to run a program within it.
         If this switch is given, rxvt will not create any utmp/wtmp entries
         and will not tinker with pty/tty permissions - you have to do that
         yourself if you want that.
+        As an extremely special case, specifying -1 will completely suppress
+        pty/tty operations.
         Here is a example in perl that illustrates how this option can be
         used (a longer example is in doc/pty-fd):
            use IO::Pty;
            use Fcntl;
            # 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)
     compiled into your version.
-    There are two different methods that rxvt can use to get the Xresource
-    data: using the X libraries (Xrm*-functions) or internal Xresources
-    reader (~/.Xdefaults). For the first method (ie. rxvt -h lists
-    XGetDefaults), you can set and change the resources using X11 tools like
+    You can set and change the resources using X11 tools like xrdb. Many
-    xrdb. Many distribution do also load settings from the ~/.Xresources
+    distribution do also load settings from the ~/.Xresources file when X
-    file when X starts. rxvt will consult the following files/resources in
+    starts. rxvt will consult the following files/resources in order, with
-    order, with later settings overwriting earlier ones:
+    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>
-    If compiled with internal Xresources support (i.e. rxvt -h lists
+    Note that when reading X resources, rxvt recognizes two class names:
-    .Xdefaults) then rxvt accepts application defaults set in
+    Rxvt and URxvt. The class name Rxvt allows resources common to both rxvt
-    XAPPLOADDIR/URxvt (compile-time defined: usually
+    and the original *rxvt* to be easily configured, while the class name
-    /usr/lib/X11/app-defaults/URxvt) and resources set in ~/.Xdefaults, or
+    URxvt allows resources unique to rxvt, to be shared between different
-    ~/.Xresources if ~/.Xdefaults does not exist. Note that when reading X
-    resources, rxvt recognizes two class names: XTerm 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, notably colours and key-handling, to be shared between
-    different rxvt configurations. If no resources are specified, suitable
+    rxvt configurations. If no resources are specified, suitable defaults
-    defaults will be used. Command-line arguments can be used to override
+    will be used. Command-line arguments can be used to override resource
-    resource settings. The following resources are allowed:
+    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.
     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*
     borderLess: *boolean*
         Set MWM hints to request a borderless window, i.e. if honoured by
         the WM, the rxvt-unicode window will not have window decorations;
         option -bl.
+    skipBuiltinGlyphs: *boolean*
+        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
+        block graphic glyphs; option -sbg.
     termName: *termname*
         Specifies the terminal type name to be set in the TERM environment
         variable; option -tn.
     linespace: *number*
         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.
     imLocale: *name*
         The locale to use for opening the IM. You can use an "LC_CTYPE" of
         e.g. "de_DE.UTF-8" for normal text processing but "ja_JP.EUC-JP" for
         the input extension to be able to input japanese characters while
-        staying in another locale. option -imlocale.
+        staying in another locale; option -imlocale.
     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
         to the base font. option -imfont.
     tripleclickwords: *boolean*
         Change the meaning of triple-click selection with the left mouse
         button. Instead of selecting a full line it will extend the
-        selection to the end of the logical line only. option -tcw.
+        selection to the end of the logical line only; option -tcw.
     insecure: *boolean*
         Enables "insecure" mode. Rxvt-unicode offers some escape sequences
         that echo arbitrary strings like the icon name or the locale. This
         could be abused if somebody gets 8-bit-clean access to your display,
         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.
         "\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.
-        Please note that you need to double the "\" when using
+        Please note that you need to double the "\" in resource files, as
-        "--enable-xgetdefault", as X itself does it's own de-escaping (you
+        Xlib itself does it's own de-escaping (you can use "\033" instead of
-        can use "\033" instead of "\e" (and so on), which will work with
+        "\e" (and so on), which will work with both Xt and rxvt's own
-        both Xt and rxvt's own processing).
+        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.
         is interpreted and executed as rxvt's control sequence. For example
         the following means "change the current locale to "zh_CN.GBK" when
         Control-Meta-c is being pressed":
           URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
+        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
+        via "rxvt -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 set, and no other key mappings with those and more bits are
         being defined. That means that defining a key map for "a" will
         info):
           URxvt.keysym.M-C-3: command:\033[8;25;80t
           URxvt.keysym.M-C-4: command:\033[8;48;110t
+    perl-ext-common: *string*
+    perl-ext: *string*
+        Comma-separated list(s) of perl extension scripts (default:
+        "default") to use in this terminal instance; option -pe.
+        Extension names can be prefixed with a "-" sign to prohibit using
+        them. This can be useful to selectively disable some extensions
+        loaded by default, or specified via the "perl-ext-common" resource.
+        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
+        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.
+        If both of these resources are the empty string, then the perl
+        interpreter will not be initialized. The idea behind two options is
+        that perl-ext-common will be used for extensions that should be
+        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
+        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
+        /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*
+        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
     fairly intuitive. The xterm-scrollbar is without arrows and its
         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.
+    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), "#ARGB", "#AARRGGBB" and "#AAAARRRRGGGGBBBB" colour
+    specifications, in addition to the ones provided by X, where the
+    additional A component specifies alpha (opacity) values (0 is completely
+    transparent and the maximum is opaque). 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.
+    *Please note that transparency of any kind if completely unsupported by
+    the author. Don't bug him with installation questions!*
     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,
         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.29 by root, Mon Jan 2 15:11:05 2006 UTC vs. Revision 1.55 by root, Sun Jan 29 22:38:43 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.txt (file contents):
Revision 1.29 by root, Mon Jan 2 15:11:05 2006 UTC vs.
Revision 1.55 by root, Sun Jan 29 22:38:43 2006 UTC