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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.228 by root, Sun Apr 27 19:43:46 2014 UTC vs.
Revision 1.235 by mikachu, Tue Jul 29 13:50:05 2014 UTC

 =item B<-override-redirect>
 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
 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;
 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>.
 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.
 An action starts with an action prefix that selects a certain type
-of action, followed by a colon. An action strings without colons is
+of action, followed by a colon. An action string without colons is
-interpreted as a literal string to pass to the tty (as if they were
+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:
 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-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.
+necessary.
 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).
 @@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
 keyboards:
   URxvt.keysym.M-C-c: selection:rot13
-=item perl:STRING
+=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
-In addition, 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.
-Its usage can be demonstrated by an example:
-  URxvt.keysym.M-C-0x61:    list|\033<|abc|>
-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>
 =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>
 =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<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.

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.228 by root, Sun Apr 27 19:43:46 2014 UTC vs. Revision 1.235 by mikachu, Tue Jul 29 13:50:05 2014 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.228 by root, Sun Apr 27 19:43:46 2014 UTC vs.
Revision 1.235 by mikachu, Tue Jul 29 13:50:05 2014 UTC