--- rxvt-unicode/doc/rxvt.1.html 2005/01/11 02:24:59 1.1 +++ rxvt-unicode/doc/rxvt.1.html 2006/01/31 00:25:16 1.56 @@ -26,10 +26,14 @@
  • ISO 14755 SUPPORT
  • LOGIN STAMP
  • COLORS AND GRAPHICS
    • + +
  • ENVIRONMENT
  • FILES
  • SEE ALSO
    • -
  • BUGS
  • CURRENT PROJECT COORDINATOR
  • AUTHORS
    • @@ -49,7 +53,7 @@

    DESCRIPTION

    -

    rxvt-unicode, version 4.8, is a colour vt102 terminal +

    rxvt-unicode, version 7.5, 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 -- @@ -58,8 +62,10 @@

    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.

    +

    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.

    @@ -132,6 +138,13 @@ DISPLAY environment variable is used.

    +
    -depth bitdepth
    +
    +
    +Compile xft: Attempt to find a visual with the given bit depth; +resource depth. +
    +

    -geometry geom
    @@ -150,26 +163,44 @@ Turn on/off jump scrolling; resource jumpScroll.

    -
    -ip|+ip
    +
    -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. resource fading. +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 opaque black. resource fadeColor.

    -tint colour
    Tint the transparent background pixmap with the given colour when -transparency is enabled with -tr or -ip. See also the -sh -option that can be used to brighten or darken the image in addition to -tinting it. +transparency is enabled with -tr or -ip. This only works for +non-tiled backgrounds, currently. See also the -sh option that can be +used to brighten or darken the image in addition to tinting it; resource +tintColor. Example: +
    +
    +
    +   rxvt -tr -tint blue -sh 40

    -sh
    @@ -196,8 +227,8 @@
    Compile XPM: Specify XPM 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 +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.

    @@ -230,7 +261,7 @@
    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 characters. The +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. @@ -253,22 +284,31 @@
    -fb fontlist
    -Compile font-styles: The bold font list to use when bold characters are to -be printed. See resource boldFont for details. +Compile font-styles: The bold font list to use when bold characters +are to be printed. See resource boldFont for details.

    -fi fontlist
    -Compile font-styles: The italic font list to use when bold characters are to -be printed. See resource italicFont for details. +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 characters are to -be printed. See resource boldItalicFont for details. +Compile font-styles: The bold italic font list to use when bold +italic > characters are to be printed. See resource boldItalicFont +for details. +
    +

    +
    -is|+is
    +
    +
    +Compile font-styles: Bold/Italic font styles imply high intensity +foreground/background (default). See resource intensityStyles for +details.

    -name name
    @@ -336,7 +376,7 @@
    -st|+st
    -Display normal (non XTerm/NeXT) scrollbar without/with a trough; +Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; resource scrollBar_floating.

    @@ -393,6 +433,22 @@ 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
    @@ -421,6 +477,14 @@ run the program specified by the SHELL environment variable or, failing that, sh(1).
    +
    +

    Please note that you must specify a program with arguments. If you want to +run shell commands, you have to specify the shell, like this:

    +
    +
    +
    +  rxvt -e sh -c "shell commands"
    +

    -title text
    @@ -460,10 +524,25 @@
    -imlocale string
    -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. +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. resource imLocale. +
    +

    +
    -imfont fontset
    +
    +
    +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. Instead of selecting a full line it will extend the selection the +end of the logical line only. resource tripleclickwords.

    -insecure
    @@ -496,12 +575,101 @@ secondaryScroll.

    -
    -xrm resourcestring
    +
    -hold|+hold
    +
    +
    +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. +
    +

    +
    -keysym.sym string
    +
    +
    +Remap a key symbol. See resource keysym. +
    +

    +
    -embed windowid
    +
    +
    +Tells rxvt to embed it's 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 +create an extra subwindow for rxvt and leave it alone.

    +
    +
    +

    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 used or +not.

    +
    +
    +

    Here is a short Gtk2-perl snippet that illustrates how this option can be +used (a longer example is in doc/embed):

    +
    +
    +
    +   my $rxvt = new Gtk2::Socket;
+   $rxvt->signal_connect_after (realize => sub {
+      my $xid = $_[0]->window->get_xid;
+      system "rxvt -embed $xid &";
+   });
    +
    +

    +
    -pty-fd file descriptor
    -No effect on rxvt-unicode. Simply passes through an argument to be made -available in the instance's argument list. Appears in WM_COMMAND in -some window managers. +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;
    +
    +
    +
    +   my $pty = new IO::Pty;
+   fcntl $pty, F_SETFD, 0; # clear close-on-exec
+   system "rxvt -pty-fd " . (fileno $pty) . "&";
+   close $pty;
    +
    +
    +
    +   # now communicate with rxvt
+   my $slave = $pty->slave;
+   while (<$slave>) { print $slave "got <$_>\n" }
    +
    +

    +
    -pe string
    +
    +
    +Comma-separated list of perl extension scripts to use (or not to use) in +this terminal instance. See resource perl-ext for details.

    @@ -510,27 +678,34 @@

    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 xset. Many distribution do also load -settings from the ~/.Xresources file when X starts.

    -

    If compiled with internal Xresources support (i.e. rxvt -h -lists .Xdefaults) then rxvt accepts application defaults -set in XAPPLOADDIR/URxvt (compile-time defined: usually -/usr/lib/X11/app-defaults/URxvt) and resources set in -~/.Xdefaults, or ~/.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 defaults will be used. Command-line -arguments can be used to override resource settings. The following -resources are allowed:

    +

    You can set and change the resources using X11 tools like xrdb. Many +distribution do also load settings from the ~/.Xresources file when X +starts. rxvt will consult the following files/resources in order, +with later settings overwriting earlier ones:

    +
    +  1. system-wide app-defaults file, either locale-dependent OR global
+  2. app-defaults file in $XAPPLRESDIR
+  3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
+  4. SCREEN_RESOURCES for the current screen
+  5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
    +

    Note that when reading X resources, rxvt recognizes two class +names: 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 rxvt +configurations. If no resources are specified, suitable defaults 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
    @@ -578,7 +753,7 @@
    Use the specified colour to display bold or italic characters when the foreground colour is the default. If font styles are not available -(Compile styles) and this option is unset, reverse video is used instead. +(Compile styles) and this option is unset, reverse video is used instead.

    colorUL: colour
    @@ -640,17 +815,29 @@ 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. +Fade the text by the given percentage when focus is lost; option -fade. +
    +

    +
    fadeColor: colour
    +
    +
    +Fade to this colour, when fading is used (see fading:). The default +colour is black; option -fadecolor.

    tintColor: colour
    -Tint the transparent background pixmap with the given colour. +Tint the transparent background pixmap with the given colour; option +-tint.

    shading: number
    @@ -670,7 +857,7 @@
    Use the specified colour for the scrollbar's trough area [default -#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. +#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.

    borderColor: colour
    @@ -694,34 +881,24 @@ 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 -menus), in addition to the paths specified by the RXVTPATH and -PATH environment variables. +Specify the colon-delimited search path for finding XPM files.

    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 characters. -The first font defines the cell size for characters; other fonts might -be smaller, but not larger. A reasonable default font list is always -appended to it. option -fn. +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; other fonts might be +smaller, but not (in general) larger. A (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:.

    +optional prefix x: or a Xft font (Compile xft), prefixed with xft:.

    In addition, each font can be prefixed with additional hints and @@ -734,7 +911,7 @@ 

    -   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, \
@@ -788,6 +965,16 @@
 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 (False, +option +is) disables this behaviour, the high intensity colours are not +reachable. +
    +

    selectstyle: mode
    @@ -800,7 +987,7 @@
    Set scrollbar style to rxvt, plain, next or xterm. plain is -the author's favourite.. +the author's favourite.

    title: string
    @@ -856,6 +1043,20 @@ Print to initiate a screen dump to the printer and Ctrl-Print or Shift-Print to include the scrollback as well. +
    +

    The string will be interpreted as if typed into the shell as-is.

    +
    +
    +

    Example:

    +
    +
    +
    +   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
    @@ -897,8 +1098,8 @@
    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. +scrollTtyOutput is False); option -sw. False: do not scroll +with scrollback buffer when tty recieves new lines; option +sw.

    scrollTtyKeypress: boolean
    @@ -938,6 +1139,15 @@ 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
    @@ -1003,7 +1213,8 @@
    pointerBlankDelay: number
    -Specifies number of seconds before blanking the pointer [default 2]. +Specifies number of seconds before blanking the pointer [default 2]. Use a +large number (e.g. 987654321) to effectively disable the timeout.

    backspacekey: string
    @@ -1026,8 +1237,18 @@
    cutchars: string
    -The characters used as delimiters for double-click word selection. The -built-in default: +The characters used as delimiters for double-click word selection +(whitespace delimiting is added automatically if resource is given). +
    +
    +

    When the selection extension is in use (the default if compiled in, see +the rxvtperl(3) manpage), a suitable regex using these 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 ```'&()*,;<=?@[]{|} >>

    @@ -1048,10 +1269,29 @@
    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. +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. +
    +

    +
    imFont: fontset
    +
    +
    +Specify the font-set used for XIM styles OverTheSpot or +OffTheSpot. It must be a standard X font set (XLFD patterns separated +by commas), i.e. it's not in the same format as the other font lists used +in rxvt. The default will be set-up to chose *any* suitable found +found, preferably one or two pixels differing in size to the base font. +option -imfont. +
    +

    +
    tripleclickwords: boolean
    +
    +
    +Change the meaning of triple-click selection with the left mouse +button. Instead of selecting a full line it will extend the selection to +the end of the logical line only; option -tcw.

    insecure: boolean
    @@ -1060,13 +1300,15 @@ 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, whether -throuh a mail client displaying mail bodies unfiltered or though -write(1). Therefore, these sequences are disabled by default. (Note -that other terminals, including xterm, have these sequences -enabled by default). You can enable them by setting this boolean -resource or specifying -insecure as an option. At the moment, this -enabled display-answer, locale, findfont, icon label and window title -requests as well as dynamic menubar dispatch. +through a mail client displaying mail bodies unfiltered or through +write(1) or any other means. Therefore, these sequences are disabled by +default. (Note that many other terminals, including 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.

    modifier: modifier
    @@ -1085,13 +1327,13 @@ 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 @@ -1100,17 +1342,232 @@ instead scroll the screen up.

    +
    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. +
    +

    keysym.sym: string
    -Associate string with keysym sym (0xFF00 - 0xFFFF). It may -contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: -newline, \r: return, \t: -tab, \000: octal number) or control characters (^?: delete, ^@: null, -^A ...) and may enclosed with double quotes so that it can start or end -with whitespace. The intervening resource name keysym. cannot be -omitted. This resource is only available when compiled with -KEYSYM_RESOURCE. +Compile frills: Associate string with keysym sym. The +intervening resource name keysym. cannot be omitted. +
    +
    +

    The format of sym is ``(modifiers-)key'', where modifiers can be +any combination of ISOLevel3, AppKeypad, Control, NumLock, +Shift, Meta, Lock, Mod1, Mod2, Mod3, Mod4, Mod5, +and the abbreviated I, K, C, N, S, M, A, L, 1, +2, 3, 4, 5.

    +
    +
    +

    The NumLock, Meta and ISOLevel3 modifiers are usually aliased to +whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr +keys are being mapped. AppKeypad is a synthetic modifier mapped to the +current application keymap mode state.

    +
    +
    +

    The spellings of key can be obtained by using xev(1) command or +searching keysym macros from /usr/X11R6/include/X11/keysymdef.h and +omitting the prefix XK_. Alternatively you can specify key by its hex +keysym value (0x0000 - 0xFFFF). Note that the lookup of syms is not +performed in an exact manner; however, the closest match is assured.

    +
    +
    +

    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.

    +
    +
    +

    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 +\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 `/' +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|>
    +
    +
    +

    The above line is equivalent to the following three lines:

    +
    +
    +
    +  URxvt.keysym.Meta-Control-0x61:    \033<M-C-a>
+  URxvt.keysym.Meta-Control-0x62:    \033<M-C-b>
+  URxvt.keysym.Meta-Control-0x63:    \033<M-C-c>
    +
    +
    +

    If string takes the form of command:STRING, the specified STRING +is interpreted and executed as rxvt's control sequence. For +example 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 automatically provide +definitions for Meta-a, Shift-a and so on, unless some of those are defined +mappings themselves.

    +
    +
    +

    Unfortunately, this will override built-in key mappings. For example +if you overwrite the Insert key you will disable rxvt's +Shift-Insert mapping. To re-enable that, you can poke ``holes'' into the +user-defined keymap using the builtin: replacement:

    +
    +
    +
    +  URxvt.keysym.Insert: <my insert key sequence>
+  URxvt.keysym.S-Insert: builtin:
    +
    +
    +

    The first line defines a mapping for Insert and any combination +of modifiers. The second line re-establishes the default mapping for +Shift-Insert.

    +
    +
    +

    The following example will map Control-Meta-1 and Control-Meta-2 to +the fonts suxuseuro and 9x15bold, so you can have some limited +font-switching at runtime:

    +
    +
    +
    +  URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
+  URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
    +
    +
    +

    Other things are possible, e.g. resizing (see rxvt(7) for more +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.

    @@ -1134,9 +1591,9 @@ (Alt) key while performing the desired mouse action.

    If mouse reporting mode is active, the normal scrollbar actions are 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), +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.

    @@ -1148,23 +1605,30 @@
    Selection:
    -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 -line. +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.

    Starting a selection while pressing the Meta key (or Meta+Ctrl keys) -(Compile: frills) will create a rectangular selection instead of a normal -one.

    +(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:
    -Pressing and releasing the Middle mouse button (or Shift-Insert) in -an rxvt window causes the current text selection to be -inserted as if it had been typed on the keyboard. +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. +
    +
    +

    Pressing Shift-Insert causes the value of the PRIMARY selection to be +inserted too.

    @@ -1173,10 +1637,13 @@

    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 -therefore using the menubar), e.g.:

    +

    You can, however, switch fonts at runtime using escape sequences, e.g.:

    +
    +   printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
    +

    You can use keyboard shortcuts, too:

    -   printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic"
    + 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.

    @@ -1187,8 +1654,8 @@ first part is available rxvt-unicode has been compiled with --enable-frills, the rest is available when rxvt-unicode was compiled with --enable-iso14755.

    -
      -
    1. 1: Basic method
      +
    +

    With respect to conformance, rxvt-unicode is supposed to be compliant to both scenario A and B of ISO 14755, including part 5.2.

    LOGIN STAMP

    -

    rxvt tries to write an entry into the utmp(5) file so -that it can be seen via the who(1) command, and can accept messages. -To allow this feature, rxvt must be installed setuid root on -some systems.

    +

    rxvt tries to write an entry into the utmp(5) file so that +it can be seen via the who(1) command, and can accept messages. To +allow this feature, rxvt may need to be installed setuid root +on some systems or setgid to root or to some other group on others.

    @@ -1250,7 +1717,7 @@

    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 names.

    +colours with their names.

    @@ -1288,43 +1755,131 @@

    -
    -

    ENVIRONMENT

    -

    rxvt sets the environment variables TERM, COLORTERM -and COLORFGBG. The environment variable WINDOWID is set to the X -window id number of the rxvt window and it also uses and -sets the environment variable DISPLAY to specify which display -terminal to use. rxvt uses the environment variables -RXVTPATH and PATH to find XPM files.

    +

    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!

    -

    FILES

    +

    ENVIRONMENT

    +

    rxvt sets and/or uses the following environment variables:

    -
    /etc/utmp
    +
    TERM
    -System file for login records. +Normally set to rxvt-unicode, unless overwritten at configure time, via +resources or on the commandline.

    -
    /usr/lib/X11/rgb.txt
    +
    COLORTERM
    -Color names. +Either rxvt, rxvt-xpm, depending on wether 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 +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 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). +
    +

    +
    TERMINFO
    +
    +
    +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. +
    +

    +
    SHELL
    +
    +
    +The shell to be used for command execution, defaults to /bin/sh. +
    +

    +
    RXVT_SOCKET
    +
    +
    +The unix domain socket path used by rxvtc(1) and +rxvtd(1). +
    +
    +

    Default $HOME/.rxvt-unicode-<nodename >>>.

    +
    +

    +
    HOME
    +
    +
    +Used to locate the default directory for the unix domain socket for +daemon communications and to locate various resource files (such as +.Xdefaults) +
    +

    +
    XAPPLRESDIR
    +
    +
    +Directory where various X resource files are being located. +
    +

    +
    XENVIRONMENT
    +
    +
    +If set and accessible, gives the name of a X resource file to be loaded by +rxvt.

    -

    SEE ALSO

    -

    rxvt(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)

    +

    FILES

    +
    +
    /usr/lib/X11/rgb.txt
    +
    +
    +Color names. +
    +

    -

    BUGS

    -

    Check the BUGS file for an up-to-date list.

    -

    Cursor change support is not yet implemented.

    -

    Click-and-drag doesn't work with X11 mouse report overriding.

    +

    SEE ALSO

    +

    rxvt(7), rxvtc(1), rxvtd(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)

    @@ -1333,16 +1888,10 @@
    Project Coordinator
    -Marc A. Lehmann rxvt@schmorp.de -
    -

    -
    Web page maintainter
    -
    -
    -Marc A. Lehmann rxvt@schmorp.de +Marc A. Lehmann >
    -

    http://software.schmorp.de/

    +

    http://software.schmorp.de/#rxvt-unicode

    @@ -1386,20 +1935,30 @@

    Geoff Wing >
    -Rewrote screen display and text selection routines. Project Coordinator -(changes.txt 2.4.6 - rxvt-unicode) +Rewrote screen display and text selection routines. + +
    +
    +
    +
+Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)

    -
    Marc Alexander Lehmann >
    +
    Marc Alexander Lehmann >
    -Forked rxvt-unicode, rewrote most of the display code and internal -character handling to store text in unicode, improve xterm -compatibility and apply numerous other bugfixes and extensions. +Forked rxvt-unicode, unicode support, rewrote almost all the code, perl +extension, random hacks, numerous bugfixes and extensions.

    Project Coordinator (Changes 1.0 -)

    +

    +
    Emanuele Giaquinta >
    +
    +
    +Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. +

    color0(black)= Black
    color1(red)= Red3