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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.225 by sf-exg, Wed Jun 5 07:58:17 2013 UTC vs.
Revision 1.260 by root, Fri Dec 23 21:46:46 2022 UTC

 far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1
 Orange'.
 The following options are available:
-=over 4
+=over
 =item B<-help>, B<--help>
 Print out a message describing available options.
 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
+Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for
-visual ids).
+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>
 Window geometry (B<-g> still respected); resource B<geometry>.
 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<-fps> I<number>
+Compile I<frills>: Set the refresh interval (in frames per second or
+negative seconds); resource B<refreshRate>.
 =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<-ls>|B<+ls>
 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
 B<utmpInhibit>.
 =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
 =item B<-pt> I<style>
 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>.
 =item B<-imlocale> I<string>
 Change the meaning of triple-click selection with the left mouse
 button. Only effective when the original (non-perl) selection code is
 in-use. Instead of selecting a full line it will extend the selection to
 the end of the logical line only. resource B<tripleclickwords>.
+=item B<-dpb>|B<+dpb>
+Compile frills: Disable (or enable) emitting bracketed paste mode
+sequences (default enabled). Bracketed paste mode allows programs
+to detect when something is pasted. Since more and more programs
+abuse this, these sequences can be disabled. The command sequences to
+enable and query paste mode will still work, but the actual bracket
+sequences will no longer be emitted. You can also toggle this from the
+ctrl-middle-mouse-button menu; resource B<disablePasteBrackets>.
 =item B<-insecure>
 Enable "insecure" mode, which currently enables most of the escape
 sequences that echo strings. See the resource B<insecure> for more
 info.
 =item B<-ssr>|B<+ssr>
 Turn on/off secondary screen scroll (default enabled); resource
 B<secondaryScroll>.
+=item B<-rm> I<mode>
+Compile I<frills>: Sets long line rewrapping behaviour on window resizes
+to one of B<auto> (the default), B<always> or B<never>. The latter two
+modes do the obvious, B<auto> rewraps (acts like B<always>) if scrollback
+is non-empty, and wings lines (acts like B<never>) otherwise; resource
+B<rewrapMode>.
 =item B<-hold>|B<+hold>
 Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
 will not immediately destroy its window when the program executed within
    close $pty;
    # now communicate with rxvt
    my $slave = $pty->slave;
    while (<$slave>) { print $slave "got <$_>\n" }
+Note that, despite what the name might imply, the file descriptor does not
+need to be a pty, it can be a bi-directional pipe as well (e.g. a unix
+domain or tcp socket). While tty operations cannot be done in this case,
+B<@@RXVT_NAME@@> can still be remote controlled with it:
+   use Socket;
+   use Fcntl;
+   socketpair my $URXVT, my $slave, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC;
+   fcntl $slave, Fcntl::F_SETFD, 0;
+   system "exec @@RXVT_NAME@@ -pty-fd " . (fileno $slave) . " &";
+   close $slave;
+   syswrite $URXVT, "Type a secret password: ";
+   my $secret = do { local $/ = "\r"; <$URXVT> };
+   print "Not so secret anymore: $secret\n";
 =item B<-pe> I<string>
 Comma-separated list of perl extension scripts to use (or not to use) in
 this terminal instance. See resource B<perl-ext> for details.
 be used. Command-line arguments can be used to override resource
 settings. The following resources are supported (you might want to
 check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
 extensions not documented here):
-=over 4
+=over
 =item B<depth:> I<bitdepth>
 Compile I<xft>: Attempt to find a visual with the given bit depth;
 option B<-depth>.
 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<refreshRate:> I<number>
+Compile I<frills>: When positive, sets the maximum refreshes per second
+(the default is C<60>). When zero or negative, sets the minimum interval
+between refreshes, negated. That is, positive numbers limit the number
+of refreshes per second to that number, similar to a fps limiter in
+games. Zero or negative numbers get negated and directly set the minimum
+interval between refreshs, that is, C<10> and C<-0.1> both specify the
+same refresh interval (likewise C<50> and C<0.02>). Fractional values are
+supported; option B<-fps>.
 =item B<fading:> I<number>
 Fade the text by the given percentage when focus is lost; option B<-fade>.
 =item B<fadeColor:> I<colour>
 B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
 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>;
 option B<-ut>. B<False>: write record into the system log file B<utmp>
 [default]; option B<+ut>.
 are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
 bottom when a non-special key is pressed; option B<+sk>.
 =item B<saveLines:> I<number>
-Save I<number> lines in the scrollback buffer [default 64]. This
+Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
-resource is limited on most machines to 65535; option B<-sl>.
 =item B<internalBorder:> I<number>
 Internal border of I<number> pixels. This resource is limited to 100;
 option B<-b>.
 =item B<pointerColor2:> I<colour>
 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
 large number (e.g. C<987654321>) to effectively disable the timeout.
 B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
 =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>
 I<name> of inputMethod to use; option B<-im>.
 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 B<-tcw>.
+=item B<disablePasteBrackets:> I<boolean>
+Prevent emission of paste bracket sequences; option B<-dpb>.
 =item B<insecure:> I<boolean>
-Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
+Enable "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
 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
 =item B<secondaryScreen:> I<boolean>
 Turn on/off secondary screen (default enabled).
+=item B<rewrapMode:> I<mode>
+Sets long line rewrap behaviour on window resize to one of B<auto>
+(default), B<always> or B<never>.
 =item B<secondaryScroll:> I<boolean>
 Turn on/off secondary screen scroll (default enabled). If this
 option is enabled, scrolls on the secondary screen will change the
 scrollback buffer and, when secondaryScreen is off, switching
 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 the following full or
+abbreviated modifier names:
+=begin table
+	B<ISOLevel3>	B<I>
+	B<AppKeypad>	B<K>
+	B<Control>	B<C>
+	B<NumLock>	B<N>
+	B<Shift>	B<S>
+	B<Meta>	B<M> I<or> B<A>
+	B<Lock>	B<L>
+	B<Mod1>	B<1>
+	B<Mod2>	B<2>
+	B<Mod3>	B<3>
+	B<Mod4>	B<4>
+	B<Mod5>	B<5>
+=end table
 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 further details.
-You can define a range of keysyms in one shot by
+An action starts with an action prefix that selects a certain type
-loading the C<keysym-list> perl extension and providing a I<string>
+of action, followed by a colon. An action string without colons is
-with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
+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
+=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
-should be a character not used by the strings.
+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-0x61:    string:\033<a>
-  URxvt.keysym.Meta-Control-0x62:    \033<b>
+  URxvt.keysym.Meta-Control-0x62:    string:\033<b>
-  URxvt.keysym.Meta-Control-0x63:    \033<c>
+  URxvt.keysym.Meta-Control-0x63:    string:\033<c>
+=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_user_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 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-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>
 Comma-separated list(s) of perl extension scripts (default: C<default>) to
 use in this terminal instance; option B<-pe>.
-Extension names can be prefixed with a C<-> sign to prohibit using
+Extension names can be prefixed with a C<-> sign to remove them again, in
-them. This can be useful to selectively disable some extensions loaded
+case they had been specified earlier. This can be useful to selectively
-by default, or specified via the C<perl-ext-common> resource. For
+disable some extensions loaded by default, or specified via the
-example, C<default,-selection> will use all the default extension except
+C<perl-ext-common> resource. For example, C<default,-selection> will use
-C<selection>.
+all the default extensions except C<selection>.
-Extension names can also be followed by an argument in angle brackets
+To prohibit autoloading of extensions, you can prefix them with C</>,
-(e.g.  C<< searchable-scrollback<M-s> >>, which binds the hotkey for
+which will make urxvt refuse to automatically load them (this can be
-searchable scrollback to Alt/Meta-s). Mentioning the same extension
+overridden, however, by specifying the extension name again without a
-multiple times with different arguments will pass multiple arguments to
+prefix, though). This does not prohibit extensions themselves loading
-the extension.
+other extensions. For example, C<default,/background> will keep the
+C<background> extension from being loaded when a background OSC sequence
+is received.
+The default set includes the C<selection>, C<option-popup>,
+C<selection-popup>, C<readline>, C<searchable-scrollback> and
+C<confirm-paste> extensions, as well as any 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
+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.
 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
 =head1 THE SELECTION: SELECTING AND PASTING TEXT
 The behaviour of text selection and insertion/pasting mechanism is similar
 to I<xterm>(1).
-=over 4
+=over
 =item B<Selecting>:
 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
 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
 Changing fonts (or font sizes, respectively) via the keypad is not yet
 and character codes using the keyboard. It consists of 4 parts. The
 first part is available if rxvt-unicode has been compiled with
 C<--enable-frills>, the rest is available when rxvt-unicode was compiled
 with C<--enable-iso14755>.
-=over 4
+=over
 =item * 5.1: Basic method
 This allows you to enter unicode characters using their hexcode.
 In addition to the default foreground and background colours,
 B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
 high-intensity (potentially bold/blink) versions of the same, and 72 (or
 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
 The following text gives values for the standard 88 colour mode (and
 values for the 256 colour mode in parentheses).
 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_88  = (r * 4 + g) * 4 + b + 16   # r, g, b = 0..3
-   index_256 = (r * 16 + g) * 16 + b + 16   # r, g, b = 0..15
+   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.
 =head1 ENVIRONMENT
 B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
-=over 4
+=over
 =item B<TERM>
 Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
 resources or on the command line.
 =back
 =head1 FILES
-=over 4
+=over
 =item B</usr/lib/X11/rgb.txt>
 Colour names.
 @@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
 @@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
 =head1 CURRENT PROJECT COORDINATOR
-=over 4
+=over
 =item Project Coordinator
 Marc A. Lehmann <rxvt-unicode@schmorp.de>.
 =back
 =head1 AUTHORS
-=over 4
+=over
 =item John Bovey
 University of Kent, 1992, wrote the original Xvt.

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.225 by sf-exg, Wed Jun 5 07:58:17 2013 UTC vs. Revision 1.260 by root, Fri Dec 23 21:46:46 2022 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.225 by sf-exg, Wed Jun 5 07:58:17 2013 UTC vs.
Revision 1.260 by root, Fri Dec 23 21:46:46 2022 UTC