--- rxvt-unicode/doc/rxvt.1.pod	2014/01/16 07:59:24	1.226
+++ rxvt-unicode/doc/rxvt.1.pod	2016/06/21 12:03:55	1.246
@@ -110,8 +110,9 @@
 
 =item B<-visual> I<visualID>
 
-Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible
-visual ids).
+Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for
+possible visual ids) instead of the default, and also allocate a private
+colormap. All visual types except for DirectColor are supported.
 
 =item B<-geometry> I<geom>
 
@@ -221,6 +222,10 @@
 
 Start as a login-shell/sub-shell; resource B<loginShell>.
 
+=item B<-mc> I<milliseconds>
+
+Specify the maximum time between multi-click selections.
+
 =item B<-ut>|B<+ut>
 
 Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
@@ -309,6 +314,11 @@
 Compile I<frills>: Sets override-redirect on the window; resource
 B<override-redirect>.
 
+=item B<-dockapp>
+
+Sets the initial state of the window to WithdrawnState, which makes
+window managers that support this extension treat it as a dockapp.
+
 =item B<-sbg>
 
 Compile I<frills>: Disable the usage of the built-in block graphics/line
@@ -372,6 +382,9 @@
 Compile I<XIM>: input style for input method; B<OverTheSpot>,
 B<OffTheSpot>, B<Root>; resource B<preeditType>.
 
+If the perl extension C<xim-onthespot> is used (which is the default),
+then additionally the C<OnTheSpot> preedit type is available.
+
 =item B<-im> I<text>
 
 Compile I<XIM>: input method name. resource B<inputMethod>.
@@ -783,6 +796,11 @@
 the shell; option B<-ls>. B<False>: start as a normal sub-shell
 [default]; option B<+ls>.
 
+=item B<multiClickTime:> I<number>
+
+Specify the maximum time in milliseconds between multi-click select
+events. The default is 500 milliseconds; option B<-mc>.
+
 =item B<utmpInhibit:> I<boolean>
 
 B<True>: inhibit writing record into the system log file B<utmp>;
@@ -855,8 +873,7 @@
 
 =item B<saveLines:> I<number>
 
-Save I<number> lines in the scrollback buffer [default 64]. This
-resource is limited on most machines to 65535; option B<-sl>.
+Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
 
 =item B<internalBorder:> I<number>
 
@@ -929,6 +946,12 @@
 
 Mouse pointer background colour.
 
+=item B<pointerShape:> I<string>
+
+Compile I<frills>: Specifies the name of the mouse pointer shape
+[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
+file for possible values (omit the C<XC_> prefix).
+
 =item B<pointerBlankDelay:> I<number>
 
 Specifies number of seconds before blanking the pointer [default 2]. Use a
@@ -964,7 +987,7 @@
 
 =item B<preeditType:> I<style>
 
-B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
+B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
 
 =item B<inputMethod:> I<name>
 
@@ -1043,35 +1066,74 @@
 @@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<action> with keysym I<sym>. The intervening
+resource name B<keysym.> cannot be omitted.
+
+Using this resource, you can map key combinations such as
+C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
+string than would normally result from that combination, making the
+terminal scroll up or down the way you want it, or any other thing an
+extension might provide.
+
+The key combination that triggers the action, I<sym>, has the following format:
 
-Compile I<frills>: Associate I<string> with keysym I<sym>. The
-intervening resource name B<keysym.> cannot be omitted.
+   (modifiers-)key
 
-The format of I<sym> is "I<(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>.
+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
-searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
-omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
-keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
-performed in an exact manner; however, the closest match is assured.
+Due the the large number of modifier combinations, a key mapping will
+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
+the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
+value (B<0x0000 - 0xFFFF>).
 
-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 further details.
 
-You can define a range of keysyms in one shot by
-loading the C<keysym-list> perl extension and providing a I<string>
-with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
-should be a character not used by the strings.
+An action starts with an action prefix that selects a certain type
+of action, followed by a colon. An action string without colons is
+interpreted as a literal string to pass to the tty (as if it was
+prefixed with C<string:>).
+
+The following action prefixes are known - extensions can provide
+additional prefixes:
+
+=over 4
+
+=item string:STRING
+
+If the I<action> starts with C<string:> (or otherwise contains no colons),
+then the remaining C<STRING> will be passed to the program running in the
+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.
+
+In addition, for actions of this type, you can define a range of
+keysyms in one shot by loading the C<keysym-list> perl extension and
+providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
+the delimiter `/' should be a character not used by the strings.
 
 Its usage can be demonstrated by an example:
 
@@ -1079,43 +1141,23 @@
 
 The above line is equivalent to the following three lines:
 
-  URxvt.keysym.Meta-Control-0x61:    \033<a>
-  URxvt.keysym.Meta-Control-0x62:    \033<b>
-  URxvt.keysym.Meta-Control-0x63:    \033<c>
-
-If I<string> takes the form of C<command:STRING>, the specified B<STRING>
-is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
-example the following means "change the current locale to C<zh_CN.GBK>
+  URxvt.keysym.Meta-Control-0x61:    string:\033<a>
+  URxvt.keysym.Meta-Control-0x62:    string:\033<b>
+  URxvt.keysym.Meta-Control-0x63:    string:\033<c>
+
+=item command: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 (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@@.
+
+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>
-is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
-manpage. For example, the F<selection> extension (activated via
-C<@@RXVT_NAME@@ -pe selection>) listens for C<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 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 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
-if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
-C<Shift-Insert> mapping. To re-enable that, you can poke "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
 the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
 font-switching at runtime:
@@ -1129,6 +1171,75 @@
   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.
+
+For example if you overwrite the C<Insert> key you will disable
+@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
+"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>.
+
+=item builtin-string:
+
+This action is mainly useful to restore string mappings for keys that
+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.
+
+An example might make it clearer: @@RXVT_NAME@@ normally pastes the
+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.S-Insert: builtin-string:
+   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-M-c: builtin-string:
+   URxvt.keysym.C-M-v: builtin-string:
+
+=item EXTENSION:STRING
+
+An action of this form invokes the action B<STRING>, if any, provided
+by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
+be loaded automatically if necessary.
+
+Not all extensions define 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 invoking commands provided by 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>
@@ -1139,20 +1250,23 @@
 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
-(e.g.  C<< searchable-scrollback<M-s> >>, which binds the hotkey for
-searchable scrollback to Alt/Meta-s). Mentioning the same extension
-multiple times with different arguments will pass multiple arguments to
-the extension.
+The default set includes the C<selection>, C<option-popup>,
+C<selection-popup>, C<readline> and C<searchable-scrollback>
+extensions, and extensions which are mentioned in B<keysym> resources.
+
+Any extension such that a corresponding resource is given on the
+command line is automatically appended to B<perl-ext>.
 
 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
-interpreter will not be initialized. The idea behind two options is that
+If both of these resources are the empty string, then the perl interpreter
+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.
 
@@ -1180,10 +1294,12 @@
 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
-(default: C<M-s>).
+This resource is deprecated and will be removed. Use a B<keysym> resource
+instead, e.g.:
+
+   URxvt.keysym.M-s: searchable-scrollback:start
 
 =item B<url-launcher>: I<string>
 
@@ -1378,6 +1494,12 @@
 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
@@ -1476,6 +1598,15 @@
 240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
 cube plus a 8 (24) colour greyscale ramp.
 
+B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
+C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
+number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
+colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
+24-bit colour space. When indexing collisions happen, the nearest old colour in
+the cube will be adapted to the new 24-bit RGB colour. That means one cannot
+use many similar 24-bit colours. It's typically not a problem in common
+scenarios.
+
 Here is a list of the ANSI colours with their names.
 
 =begin table