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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.164 by root, Sun Jun 15 13:54:15 2008 UTC vs.
Revision 1.232 by root, Sun May 18 18:19:10 2014 UTC

 is still respected. but deprecated). In the absence of this option, the
 display specified by the B<DISPLAY> environment variable is used.
 =item B<-depth> I<bitdepth>
-Compile I<xft>: Attempt to find a visual with the given bit depth;
+Compile I<frills>: Attempt to find a visual with the given bit depth;
 resource B<depth>.
 [Please note that many X servers (and libXft) are buggy with
 respect to C<-depth 32> and/or alpha channels, and will cause all sorts
 of graphical corruption. This is harmless, but we can't do anything about
 this, so watch out]
+=item B<-visual> I<visualID>
+Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible
+visual ids).
 =item B<-geometry> I<geom>
 Window geometry (B<-g> still respected); resource B<geometry>.
 =item B<-rv>|B<+rv>
 Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
 =item B<-ss>|B<+ss>
 Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
-=item B<-tr>|B<+tr>
-Turn on/off illusion of a transparent window background; resource B<transparent>.
-B<-ip> is still accepted as an obsolete alias but will be removed in
-future versions.
-I<Please address all transparency related issues to Sasha Vasko at
-sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
 =item B<-fade> I<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
 =item B<-fadecolor> I<colour>
 Fade to this colour when fading is used (see B<-fade>). The default colour
 is opaque black. resource B<fadeColor>.
-=item B<-tint> I<colour>
+=item B<-icon> I<file>
-Tint the transparent background pixmap with the given colour when
+Compile I<pixbuf>: Use the specified image as application icon. This
-transparency is enabled with B<-tr>. This only works for
+is used by many window managers, taskbars and pagers to represent the
-non-tiled backgrounds, currently. See also the B<-sh> option that can be
+application window; resource I<iconFile>.
-used to 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 tinting; resource
-I<tintColor>. Example:
-   @@RXVT_NAME@@ -tr -tint blue -sh 40
-=item B<-sh> I<number>
-Darken (0 .. 100) or lighten (100 .. 200) the transparent
-background image in addition to (or instead of) tinting it;
-resource I<shading>.
-=item B<-blt> I<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 :
-B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
-B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
-B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
-alpha-blending. Compile I<afterimage>; resource I<blendType>.
-=item B<-blr> I<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 I<afterimage>;
-resource I<blurRadius>.
 =item B<-bg> I<colour>
 Window background colour; resource B<background>.
 =item B<-fg> I<colour>
 Window foreground colour; resource B<foreground>.
-=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
-Compile I<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 C<;> in the
-command-line; for more details see resource B<backgroundPixmap>.
 =item B<-cr> I<colour>
 The cursor colour; resource B<cursorColor>.
 =item B<-bc>|B<+bc>
 Blink the cursor; resource B<cursorBlink>.
+=item B<-uc>|B<+uc>
+Make the cursor underlined; resource B<cursorUnderline>.
 =item B<-iconic>
 Start iconified, if the window manager supports that option.
 Alternative form is B<-ic>.
 =item B<-bl>
 Compile I<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 B<borderLess>.
+decorations; resource B<borderLess>. If the window manager does not
+support MWM hints (e.g. kwin), enables override-redirect mode.
 =item B<-override-redirect>
 Compile I<frills>: Sets override-redirect on the window; resource
 B<override-redirect>.
 =item B<-lsp> I<number>
 Compile I<frills>: Lines (pixel height) to insert between each row of
 the display. Useful to work around font rendering problems; resource
 B<lineSpace>.
+=item B<-letsp> I<number>
+Compile I<frills>: Amount to adjust the computed character width by
+to control overall letter spacing. Negative values will tighten up the
+letter spacing, positive values will space letters out more. Useful to
+work around odd font metrics; resource B<letterSpace>.
 =item B<-tn> I<termname>
 This option specifies the name of the terminal type to be set in the
 B<TERM> environment variable. This terminal type must exist in the
 You can set and change the resources using X11 tools like B<xrdb>. Many
 distribution do also load settings from the B<~/.Xresources> file when X
 starts. @@RXVT_NAME@@ 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
+  1. app-defaults file in $XAPPLRESDIR
+  2. $HOME/.Xdefaults
-  3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
+  3. RESOURCE_MANAGER property on root-window of screen 0
-  4. SCREEN_RESOURCES for the current screen
+  4. SCREEN_RESOURCES property on root-window of the current screen
   5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
   6. resources specified via -xrm on the commandline
 Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
 names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
 Use the specified colour for the colour value I<n>, where 0-7
 corresponds to low-intensity (normal) colours and 8-15 corresponds to
 high-intensity (bold = bright foreground, blink = bright background)
 colours. The canonical names are as follows: 0=black, 1=red, 2=green,
 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
-names used are listed in the B<COLORS AND GRAPHICS> section.
+names used are listed in the B<COLOURS AND GRAPHICS> section.
 Colours higher than 15 cannot be set using resources (yet), but can be
 changed using an escape command (see @@RXVT_NAME@@(7)).
 Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
 =item B<colorUL:> I<colour>
 Use the specified colour to display underlined characters when the
 foreground colour is the default.
-=item B<colorRV:> I<colour>
-Use the specified colour as the background for reverse video characters
-when OPTION_HC is disabled (--disable-frills).
 =item B<underlineColor:> I<colour>
 If set, use the specified colour as the colour for the underline
 itself. If unset, use the foreground colour.
+=item B<highlightColor:> I<colour>
+If set, use the specified colour as the background for highlighted
+characters. If unset, use reverse video.
+=item B<highlightTextColor:> I<colour>
+If set and highlightColor is set, use the specified colour as the
+foreground for highlighted characters.
 =item B<cursorColor:> I<colour>
 Use the specified colour for the cursor. The default is to use the
 foreground colour; option B<-cr>.
 =item B<reverseVideo:> I<boolean>
 B<True>: simulate reverse video by foreground and background colours;
 option B<-rv>. B<False>: regular screen colours [default]; option
-B<+rv>. See note in B<COLORS AND GRAPHICS> section.
+B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
 =item B<jumpScroll:> I<boolean>
 B<True>: specify that jump scrolling should be used. When receiving lots
 of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
 B<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 B<+ss>.
-=item B<transparent:> I<boolean>
-Turn on/off illusion of a transparent window background.
-B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
-future versions.
-I<Please address all transparency related issues to Sasha Vasko at
-sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
 =item B<fading:> I<number>
 Fade the text by the given percentage when focus is lost; option B<-fade>.
 =item B<fadeColor:> I<colour>
 Fade to this colour, when fading is used (see B<fading:>). The default
 colour is black; option B<-fadecolor>.
-=item B<tintColor:> I<colour>
+=item B<iconFile:> I<file>
-Tint the transparent background pixmap with the given colour; option
+Set the application icon pixmap; option B<-icon>.
-B<-tint>.
-=item B<shading:> I<number>
-Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
-in addition to tinting it; option B<-sh>.
-=item B<blendType:> I<string>
-Specify background blending type; option B<-blt>.
-=item B<blurRadius:> I<number>
-Apply Gaussian Blurr with the specified radius to the transparent
-background image; option B<-blr>.
 =item B<scrollColor:> I<colour>
 Use the specified colour for the scrollbar [default #B2B2B2].
 =item B<borderColor:> I<colour>
 The colour of the border around the text area and between the scrollbar
 and the text.
-=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
-Use the specified image file for the background and also
-optionally specify its scaling with a geometry string B<WxH+X+Y>,
-(default C<0x0+50+50>) in which B<"W" / "H"> specify the
-horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
-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 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.
-Additional operations can be specified after colon B<: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 B<-tr> option, the specified pixmap will be
-blended over transparency image using either alpha-blending, or any
-other blending type, specified with B<-blt "type"> option.
-=item B<path:> I<path>
-Specify the colon-delimited search path for finding background image files.
 =item B<font:> I<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
 it is named first) and thus defines the character cell grid to be 9 pixels
 wide and 15 pixels high.
 The second font is just used to add additional unicode characters not in
 the base font, likewise the third, which is unfortunately non-bold, but
-the bold version of the font does contain less characters, so this is a
+the bold version of the font does contain fewer characters, so this is a
 useful supplement.
 The third font is an Xft font with aliasing turned off, and the characters
 are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
 contains other characters, but we are not interested in them.
 =item B<urgentOnBell:> I<boolean>
 B<True>: set the urgency hint for the wm on receipt of a bell character.
 B<False>: do not set the urgency hint [default].
+@@RXVT_NAME@@ resets the urgency hint on every focus change.
 =item B<visualBell:> I<boolean>
 B<True>: use visual bell on receipt of a bell character; option B<-vb>.
 B<False>: no visual bell [default]; option B<+vb>.
 =item B<scrollstyle:> I<mode>
 Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
 the author's favourite.
+=item B<thickness:> I<number>
+Set the scrollbar width in pixels.
 =item B<scrollBar:> I<boolean>
 B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
 disable the scrollbar; option B<+sb>.
 B<False>: do not scroll to bottom when tty receives output; option
 B<+si>.
 =item B<scrollWithBuffer:> I<boolean>
-B<True>: scroll with scrollback buffer when tty receives new lines (and
+B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
-B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
+try to show the same lines) and B<scrollTtyOutput> is False; option
-with scrollback buffer when tty receives new lines; option B<+sw>.
+B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
+new lines; option B<+sw>.
 =item B<scrollTtyKeypress:> I<boolean>
 B<True>: scroll to bottom when a non-special key is pressed. Special keys
 are those which are intercepted by rxvt-unicode for special handling and
 =item B<cursorBlink:> I<boolean>
 B<True>: blink the cursor. B<False>: do not blink the cursor [default];
 option B<-bc>.
+=item B<cursorUnderline:> I<boolean>
+B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
+option B<-uc>.
 =item B<pointerBlank:> I<boolean>
 B<True>: blank the pointer when a key is pressed or after a set number
 of seconds of inactivity. B<False>: the pointer is always visible
 [default].
 large number (e.g. C<987654321>) to effectively disable the timeout.
 =item B<backspacekey:> I<string>
 The string to send when the backspace key is pressed. If set to B<DEC>
-or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
+or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
 (code 8) - which can be reversed with the appropriate DEC private mode
 escape sequence.
 =item B<deletekey:> I<string>
 Sets the working directory for the shell (or the command specified via
 B<-e>). The I<path> must be an absolute path and it must exist for
 @@RXVT_NAME@@ to start. If it isn't specified then the current working
 directory will be used; option B<-cd>.
-=item B<keysym.>I<sym>: I<string>
+=item B<keysym.>I<sym>: I<action>
-Compile I<frills>: Associate I<string> with keysym I<sym>. The
+Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
-intervening resource name B<keysym.> cannot be omitted.
+resource name B<keysym.> cannot be omitted.
-The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
+Using this resource, you can map key combinations such as
-any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
+C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
-B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
+string than would normally result from that combination, making the
-and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
+terminal scroll up or down the way you want it, or any other thing an
-B<2>, B<3>, B<4>, B<5>.
+extension might provide.
+The key combination that triggers the action, I<sym>, has the following format:
+   (modifiers-)key
+Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
+B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
+B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
+B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
 The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
 whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
 keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
 current application keymap mode state.
-The spellings of I<key> can be obtained by using B<xev>(1) command or
+Due the the large number of modifier combinations, a key mapping will
-searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
+match if I<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 mapping for C<a> will automatically provide definitions for
+C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
+themselves. See the C<builtin:> action, below, for a way to work around
+this when this is a problem.
+The spelling of I<key> depends on your implementation of X. An easy way to
+find a key name is to use the B<xev>(1) command. You can find a list by
+looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
-omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
+the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
-keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
+value (B<0x0000 - 0xFFFF>).
-performed in an exact manner; however, the closest match is assured.
-I<string> may contain escape values (C<\n>: newline, C<\000>: octal
+As with any resource value, the I<action> string may contain backslash
+escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
-number), see RESOURCES in C<man 7 X> for futher details.
+number), see RESOURCES in C<man 7 X> for further details.
-You can define a range of keysyms in one shot by providing a I<string>
+An action starts with an action prefix that selects a certain type
-with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
+of action, followed by a colon. An action strings without colons is
-should be a character not used by the strings.
+interpreted as a literal string to pass to the tty (as if they were
+prefixed with C<string:>).
-Its usage can be demonstrated by an example:
+The following action prefixes are known - extensions can provide
+additional prefixes:
-  URxvt.keysym.M-C-0x61:    list|\033<M-C-|abc|>
+=over 4
-The above line is equivalent to the following three lines:
+=item string:STRING
-  URxvt.keysym.Meta-Control-0x61:    \033<M-C-a>
+If the I<action> starts with C<string:> (or otherwise contains no colons),
-  URxvt.keysym.Meta-Control-0x62:    \033<M-C-b>
+then the remaining C<STRING> will be passed to the program running in the
-  URxvt.keysym.Meta-Control-0x63:    \033<M-C-c>
+terminal. For example, you could replace whatever Shift-Tab outputs by the
+string C<echo rm -rf /> followed by a newline:
+   URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
+This could in theory be used to completely redefine your keymap.
+=item command:STRING
-If I<string> takes the form of C<command:STRING>, the specified B<STRING>
+If I<action> takes the form of C<command:STRING>, the specified B<STRING>
-is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
+is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
+the opposite of C<string:> - instead of sending it to the program running
+in the terminal, it will be treated as if it were program output). This is
+most useful to feed command sequences into @@RXVT_NAME@@.
-example the following means "change the current locale to C<zh_CN.GBK>
+For example the following means "change the current locale to C<zh_CN.GBK>
 when Control-Meta-c is being pressed":
   URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
-If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
+The following example will map Control-Meta-1 and Control-Meta-2 to
-is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
+the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
-manpage. For example, the F<selection> extension (activated via
+font-switching at runtime:
-C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
-  URxvt.keysym.M-C-c: perl:selection:rot13
+  URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
+  URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
-Due the the large number of modifier combinations, a defined key mapping
+Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
-will match if at I<at least> the specified identifiers are being set, and
+info):
-no other key mappings with those and more bits are being defined. That
-means that defining a key map for C<a> will automatically provide
-definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
-mappings themselves.
-Unfortunately, this will override built-in key mappings. For example
+  URxvt.keysym.M-C-3: command:\033[8;25;80t
+  URxvt.keysym.M-C-4: command:\033[8;48;110t
+=item builtin:
+The builtin action is the action that @@RXVT_NAME@@ would execute if no
+key binding existed for the key combination. The obvious use is to undo
+the effect of existing bindings. The not so obvious use is to reinstate
+bindings when another binding overrides too many modifiers.
-if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
+For example if you overwrite the C<Insert> key you will disable
-C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
+@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
-user-defined keymap using the C<builtin:> replacement:
+"holes" into the user-defined keymap using the C<builtin:> replacement:
   URxvt.keysym.Insert: <my insert key sequence>
   URxvt.keysym.S-Insert: builtin:
 The first line defines a mapping for C<Insert> and I<any> combination
 of modifiers. The second line re-establishes the default mapping for
 C<Shift-Insert>.
-The following example will map Control-Meta-1 and Control-Meta-2 to
+=item builtin-string:
-the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
-font-switching at runtime:
-  URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
+This action is mainly useful to restore string mappings for keys that
-  URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
+have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
+difficult to explain - basically, this action will send the string to the
+application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
+action for it.
-Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
+An example might make it clearer: @@RXVT_NAME@@ normally pastes the
-info):
+selection when you press C<Shift-Insert>. With the following bindings, it
+would instead emit the (undocumented, but what applications running in the
+terminal might expect) sequence C<ESC [ 2 $> instead:
-  URxvt.keysym.M-C-3: command:\033[8;25;80t
+   URxvt.keysym.S-Insert: builtin-string:
-  URxvt.keysym.M-C-4: command:\033[8;48;110t
+   URxvt.keysym.C-S-Insert: builtin:
+The first line disables the paste functionality for that key
+combination, and the second reinstates the default behaviour for
+C<Control-Shift-Insert>, which would otherwise be overridden.
+Similarly, to let applications gain access to the C<C-M-c> (copy to
+clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
+this:
+   URxvt.keysym.C-S-c: builtin-string:
+   URxvt.keysym.C-S-v: builtin-string:
+=item EXTENSION:STRING
+An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)
+extension of the same name. The extension will be loaded automatically if
+neccessary.
+Not all extensions define key actions, but popular extensions that do
+include the I<selection> and I<matcher> extensions (documented in their
+own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
+respectively).
+From the silly examples department, this will rot13-"encrypt"
+@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
+keyboards:
+  URxvt.keysym.M-C-c: selection:rot13
+=item perl:STRING *DEPRECATED*
+This is a deprecated way of passing key mappings to perl extensions. It is
+still supported, but should not be used anymore.
+=back
 =item B<perl-ext-common>: I<string>
 =item B<perl-ext>: I<string>
 use in this terminal instance; option B<-pe>.
 Extension names can be prefixed with a C<-> sign to prohibit using
 them. This can be useful to selectively disable some extensions loaded
 by default, or specified via the C<perl-ext-common> resource. For
-example, C<default,-selection> will use all the default extension except
+example, C<default,-selection> will use all the default extensions except
 C<selection>.
-Extension names can also be followed by an argument in angle brackets
+The default set includes the C<selection>, C<option-popup>,
-(e.g.  C<< searchable-scrollback<M-s> >>, which binds the hotkey for
+C<selection-popup> and C<readline> extensions, any extensions that define
-searchable scrollback to Alt/Meta-s). Mentioning the same extension
+keybindings via C<BINDING> meta comments, extensions loaded because
-multiple times with different arguments will pass multiple arguments to
+their resources/commandline switches were used, and extensions which are
-the extension.
+mentioned in B<keysym> resources.
 Each extension is looked up in the library directories, loaded if
-necessary, and bound to the current terminal instance.
+necessary, and bound to the current terminal instance. When the library
+search path contains multiple extension files of the same name, then the
+first one found will be used.
-If both of these resources are the empty string, then the perl
+If both of these resources are the empty string, then the perl interpreter
-interpreter will not be initialized. The idea behind two options is that
+will not be initialized. The rationale for having two options is that
 B<perl-ext-common> will be used for extensions that should be available to
 all instances, while B<perl-ext> is used for specific instances.
 =item B<perl-eval>: I<string>
 Perl code to be evaluated when all extensions have been registered. See
-the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
+the @@RXVT_NAME@@perl(3) manpage.
-will be ignored when running setuid/setgid.
 =item B<perl-lib>: I<path>
 Colon-separated list of additional directories that hold extension
-scripts. When looking for extensions specified by the C<perl> resource,
+scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
-@@RXVT_NAME@@ will first look in these directories and then in
+in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
-F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
+lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
-will be ignored when running setuid/setgid.
 See the @@RXVT_NAME@@perl(3) manpage.
 =item B<< selection.pattern-I<idx> >>: I<perl-regex>
 =item B<< selection-autotransform.I<idx> >>: I<perl-transform>
 Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
 for details.
-=item B<searchable-scrollback:> I<keysym>
+=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
-Sets the hotkey that starts the incremental scrollback buffer search
+This resource is deprecated and will be removed. Use a B<keysym> resource
-(default: C<M-s>).
+instead, e.g.:
+   URxvt.keysym.M-s: searchable-scrollback:start
-=item B<urlLauncher>: I<string>
+=item B<url-launcher>: I<string>
 Specifies the program to be started with a URL argument. Used by the
 C<selection-popup> and C<matcher> perl extensions.
 =item B<transient-for>: I<windowid>
 =item B<override-redirect>: I<boolean>
 Compile I<frills>: Sets override-redirect for the terminal window, making
 it almost invisible to window managers; option B<-override-redirect>.
+=item B<iso14755:> I<boolean>
+Turn on/off ISO 14755 (default enabled).
 =item B<iso14755_52:> I<boolean>
 Turn on/off ISO 14755 5.2 mode (default enabled).
+=back
+=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
+=over 4
+=item B<-pixmap> I<file[;oplist]>
+=item B<backgroundPixmap:> I<file[;oplist]>
+Compile I<pixbuf>: Use the specified image file as the window's
+background and also optionally specify a colon separated list of
+operations to modify it. Note that you may need to quote the C<;>
+character when using the command line option, as C<;> is usually a
+metacharacter in shells. Supported operations are:
+=over 4
+=item B<WxH+X+Y>
+sets scale and position. B<"W" / "H"> specify the horizontal/vertical
+scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
+scale of 0 disables scaling.
+=item B<op=tile>
+enables tiling
+=item B<op=keep-aspect>
+maintain the image aspect ratio when scaling
+=item B<op=root-align>
+use the position of the terminal window relative to the root window as
+the image offset, simulating a root window background
+=back
+The default scale and position setting is C<100x100+50+50>.
+Alternatively, a predefined set of templates can be used to achieve
+the most common setups:
+=over 4
+=item B<style=tiled>
+the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
+=item B<style=aspect-stretched>
+the image is scaled to fill the whole window maintaining the aspect
+ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
+=item B<style=stretched>
+the image is scaled to fill the whole window. Equivalent to 100x100
+=item B<style=centered>
+the image is centered with no scaling. Equivalent to 0x0+50+50
+=item B<style=root-tiled>
+the image is tiled with no scaling and using 'root' positioning.
+Equivalent to 0x0:op=tile:op=root-align
+=back
+If multiple templates are specified the last one wins. Note that a
+template overrides all the scale, position and operations settings.
+If used in conjunction with pseudo-transparency, the specified pixmap
+will be blended over the transparent background using alpha-blending.
+=item B<-tr>|B<+tr>
+=item B<transparent:> I<boolean>
+Turn on/off pseudo-transparency by using the root pixmap as background.
+B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
+will be removed in future versions.
+=item B<-tint> I<colour>
+=item B<tintColor:> I<colour>
+Tint the transparent background with the given colour. Note that a
+black tint yields a completely black image while a white tint yields
+the image unchanged.
+=item B<-sh> I<number>
+=item B<shading:> I<number>
+Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
+A value of 100 means no shading.
+=item B<-blr> I<HxV>
+=item B<blurRadius:> I<HxV>
+Apply gaussian blur with the specified radius to the transparent
+background. If a single number is specified, the vertical and
+horizontal radii are considered to be the same. Setting one of the
+radii to 1 and the other to a large number creates interesting effects
+on some backgrounds. The maximum radius value is 128. An horizontal or
+vertical radius of 0 disables blurring.
+=item B<path:> I<path>
+Specify the colon-delimited search path for finding background image files.
 =back
 =head1 THE SCROLLBAR
 window causes the value of the PRIMARY selection (or CLIPBOARD with the
 B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
 Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
 inserted too.
+rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
+<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
+binding causes the value of the internal selection to be copied to the
+CLIPBOARD selection, while the second binding causes the value of the
+CLIPBOARD selection to be inserted.
 =back
 =head1 CHANGING FONTS
 B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
 it can be seen via the I<who(1)> command, and can accept messages.  To
 allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
 on some systems or setgid to root or to some other group on others.
-=head1 COLORS AND GRAPHICS
+=head1 COLOURS AND GRAPHICS
 In addition to the default foreground and background colours,
-B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
+B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
-high-intensity bold/blink versions of the same). Here is a list of the
+high-intensity (potentially bold/blink) versions of the same, and 72 (or
-colours with their names.
+240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
+cube plus a 8 (24) colour greyscale ramp.
+Here is a list of the ANSI colours with their names.
 =begin table
 	B<color0>	(black)	= Black
 	B<color1>	(red)	= Red3
 It is also possible to specify the colour values of B<foreground>,
 B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<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_NAME@@ offers an
+The following text gives values for the standard 88 colour mode (and
-additional 72 colours. The first 64 of those (with indices 16 to 79)
+values for the 256 colour mode in parentheses).
-consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
-16>), followed by 8 additional shades of gray (with indices 80 to 87).
+The RGB cube uses indices 16..79 (16..231) using the following formulas:
+   index_88  = (r * 4 + g) * 4 + b + 16   # r, g, b = 0..3
+   index_256 = (r * 6 + g) * 6 + b + 16   # r, g, b = 0..5
+The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
+steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
+the RGB cube.
-Together, all those colours implement the 88 colour xterm colours. Only
+Together, all those colours implement the 88 (256) colour xterm
-the first 16 can be changed using resources currently, the rest can only
+colours. Only the first 16 can be changed using resources currently, the
-be changed via command sequences ("escape codes").
+rest can only be changed via command sequences ("escape codes").
+Applications are advised to use terminfo or command sequences to discover
+number and RGB values of all colours (yes, you can query this...).
 Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
 always swapping the foreground/background colours. This is in contrast to
 I<xterm>(1) where the colours are only swapped if they have not otherwise
 been specified. For example,
-=over 4
-=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
+   @@RXVT_NAME@@ -fg Black -bg White -rv
-would yield White on Black, while on I<xterm>(1) it would yield Black
+would yield White on Black, while on I<xterm>(1) it would yield Black on
-on White.
+White.
-=back
 =head2 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 do it's own alpha channel management:
+their act together, rxvt-unicode will do its own alpha channel management:
-You can prefix any color with an opaquenes percentage enclosed in
+You can prefix any colour with an opaqueness percentage enclosed in
 brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
-(0-100) that specifies the opacity of the color, where C<0> is completely
+(0-100) that specifies the opacity of the colour, where C<0> is completely
 transparent and C<100> is completely opaque. For example, C<[50]red> is a
 half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
 is the recommended format to specify transparency values, and works with
 all ways to specify a colour.
 =item B<SHELL>
 The shell to be used for command execution, defaults to C</bin/sh>.
-=item B<RXVT_SOCKET>
+=item B<RXVT_SOCKET> [I<sic>]
 The unix domain socket path used by @@RXVT_NAME@@c(1) and
 @@RXVT_NAME@@d(1).
-Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
+Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
+=item B<URXVT_PERL_LIB>
+Additional F<:>-separated library search path for perl extensions. Will be
+searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
+directory.
+=item B<URXVT_PERL_VERBOSITY>
+See L<@@RXVT_NAME@@perl>(3).
 =item B<HOME>
 Used to locate the default directory for the unix domain socket for
 daemon communications and to locate various resource files (such as
 C<.Xdefaults>)
 =item B<XAPPLRESDIR>
-Directory where various X resource files are being located.
+Directory where application-specific X resource files are located.
 =item B<XENVIRONMENT>
 If set and accessible, gives the name of a X resource file to be loaded by
 @@RXVT_NAME@@.
 =over 4
 =item B</usr/lib/X11/rgb.txt>
-Color names.
+Colour names.
 =back
 =head1 SEE ALSO
+@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
-@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
+@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
 =head1 CURRENT PROJECT COORDINATOR
 =over 4
 =item Project Coordinator
-Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
+Marc A. Lehmann <rxvt-unicode@schmorp.de>.
 L<http://software.schmorp.de/pkg/rxvt-unicode.html>
 =back
 =item John Bovey
 University of Kent, 1992, wrote the original Xvt.
-=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>
+=item Rob Nation <nation@rocket.sanders.lockheed.com>
 very heavily modified Xvt and came up with Rxvt
-=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>
+=item Angelo Haritsis <ah@doc.ic.ac.uk>
 wrote the Greek Keyboard Input (no longer in code)
-=item mj olesen L<< <olesen@me.QueensU.CA> >>
+=item mj olesen <olesen@me.QueensU.CA>
 Wrote the menu system.
 Project Coordinator (changes.txt 2.11 to 2.21)
-=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>
+=item Oezguer Kesim <kesim@math.fu-berlin.de>
 Project Coordinator (changes.txt 2.21a to 2.4.5)
-=item Geoff Wing L<< <gcw@pobox.com> >>
+=item Geoff Wing <gcw@pobox.com>
 Rewrote screen display and text selection routines.
 Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
-=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
+=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
 Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
 extension, random hacks, numerous bugfixes and extensions.
 Project Coordinator (Changes 1.0 -)
-=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
+=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
-Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
+pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
 =back

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.164 by root, Sun Jun 15 13:54:15 2008 UTC vs. Revision 1.232 by root, Sun May 18 18:19:10 2014 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.164 by root, Sun Jun 15 13:54:15 2008 UTC vs.
Revision 1.232 by root, Sun May 18 18:19:10 2014 UTC