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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.111 by root, Tue Jan 31 00:25:16 2006 UTC vs.
Revision 1.131 by ayin, Sat Jun 9 09:05:38 2007 UTC

 =head1 FREQUENTLY ASKED QUESTIONS
 See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
 frequently asked questions and answer to them and some common
 problems. That document is also accessible on the World-Wide-Web at
-L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
+L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
 =head1 RXVT-UNICODE VS. RXVT
 Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
 internally. That means it can store and display most scripts in the
 world. Being a terminal emulator, however, some things are very difficult,
 especially cursive scripts such as arabic, vertically written scripts
 like mongolian or scripts requiring extremely complex combining rules,
 like tibetan or devenagari. Don't expect pretty output when using these
 scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
-fine, though. A somewhat difficult case are left-to-right scripts, such
+fine, though. A somewhat difficult case are right-to-left scripts, such
 as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
 belong into the application, not the terminal emulator (too many things --
 such as cursor-movement while editing -- break otherwise), but that might
 change.
 If you are looking for a terminal that supports more exotic scripts, let
-me recommend C<mlterm>, which is a very userfriendly, lean and clean
+me recommend C<mlterm>, which is a very user friendly, lean and clean
 terminal emulator. In fact, the reason rxvt-unicode was born was solely
 because the author couldn't get C<mlterm> to use one font for latin1 and
 another for japanese.
 Therefore another design rationale was the use of multiple fonts to
 display characters: The idea of a single unicode font which many other
-programs force onto it's users never made sense to me: You should be able
+programs force onto its users never made sense to me: You should be able
 to choose any font for any script freely.
 Apart from that, rxvt-unicode is also much better internationalised than
-it's predecessor, supports things such as XFT and ISO 14755 that are handy
+its predecessor, supports things such as XFT and ISO 14755 that are handy
-in i18n-environments, is faster, and has a lot less bugs than the original
+in i18n-environments, is faster, and has a lot bugs less than the original
 rxvt. This all in addition to dozens of other small improvements.
 It is still faithfully following the original rxvt idea of being lean
 and nice on resources: for example, you can still configure rxvt-unicode
-without most of it's features to get a lean binary. It also comes with
+without most of its features to get a lean binary. It also comes with
 a client/daemon pair that lets you open any number of terminal windows
 from within a single process, which makes startup time very fast and
 drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
 @@RXVT_NAME@@c(1) (client).
 It also makes technical information about escape sequences (which have
-been extended) easier accessible: see @@RXVT_NAME@@(7) for technical
+been extended) more accessible: see @@RXVT_NAME@@(7) for technical
 reference documentation (escape sequences etc.).
 =head1 OPTIONS
 The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
 Turn on/off inheriting parent window's pixmap. Alternative form is
 B<-tr>; resource B<inheritPixmap>.
 I<Please note that transparency of any kind if completely unsupported by
-the author. Don't bug him with installation questions!>
+the author. Don't bug him with installation questions! 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
 used to brighten or darken the image in addition to tinting it; resource
 I<tintColor>. Example:
    @@RXVT_NAME@@ -tr -tint blue -sh 40
-=item B<-sh>
+=item B<-sh> I<number>
-I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
+Darken (0 .. 100) or lighten (-1 .. -100) the transparent
-background image in addition to tinting it (i.e. B<-tint> must be
+background image in addition to (or instead of) tinting it;
-specified, too, e.g. C<-tint white>).
+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; resource I<blendType>.
+=item B<-blr> I<number>
+Apply Gaussian Blur with the specified radius to the transparent
+background image; resource I<blurRadius>.
 =item B<-bg> I<colour>
 Window background colour; resource B<background>.
 Window foreground colour; resource B<foreground>.
 =item B<-pixmap> I<file[;geom]>
-Compile I<XPM>: Specify XPM file for the background and also optionally
+Compile I<afterimage>: Specify image file for the background and also
-specify its scaling with a geometry string. Note you may need to
+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; resource B<backgroundPixmap>.
+command-line; for more details see resource B<backgroundPixmap>.
 =item B<-cr> I<colour>
 The cursor colour; resource B<cursorColor>.
 that are checked in order when trying to find glyphs for characters. The
 first font defines the cell size for characters; other fonts might be
 smaller, but not (in general) larger. A (hopefully) reasonable default
 font list is always appended to it. See resource B<font> for more details.
-In short, to specify an X11 core font, just specify it's name or prefix it
+In short, to specify an X11 core font, just specify its name or prefix it
 with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
 e.g.:
    @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
    @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
 for more info.
 =item B<-tcw>
 Change the meaning of triple-click selection with the left mouse
+button. Only effective when the original (non-perl) selection code is
-button. Instead of selecting a full line it will extend the selection the
+in-use. Instead of selecting a full line it will extend the selection the
 end of the logical line only. resource B<tripleclickwords>.
 =item B<-insecure>
 Enable "insecure" mode, which currently enables most of the escape
 Remap a key symbol. See resource B<keysym>.
 =item B<-embed> I<windowid>
-Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
+Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
 which enables applications to easily embed a terminal.
 Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
 shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
 quite a bit, so don't expect it to keep some specific state. It's best to
 The window will not be destroyed when @@RXVT_NAME@@ exits.
 It might be useful to know that @@RXVT_NAME@@ will not close file
 descriptors passed to it (except for stdin/out/err, of course), so you
 can use file descriptors to communicate with the programs within the
-terminal. This works regardless of wether the C<-embed> option was used or
+terminal. This works regardless of whether the C<-embed> option was used or
 not.
 Here is a short Gtk2-perl snippet that illustrates how this option can be
 used (a longer example is in F<doc/embed>):
    });
 =item B<-pty-fd> I<file descriptor>
 Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
-pair but instead use the given filehandle as the tty master. This is
+pair but instead use the given file descriptor as the tty master. This is
 useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
 without having to run a program within it.
 If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
 entries and will not tinker with pty/tty permissions - you have to do that
 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
+Use the specified colour as the background for reverse video characters
-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.
 Tint the transparent background pixmap with the given colour; option
 B<-tint>.
 =item B<shading:> I<number>
-Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
+Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
-image in addition to tinting it.
+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].
 The colour of the border around the text area and between the scrollbar
 and the text.
 =item B<backgroundPixmap:> I<file[;geom]>
-Use the specified XPM file (note the `.xpm' extension is optional) for
+Use the specified image file for the background and also optionally
-the background and also optionally specify its scaling with a geometry
+specify its scaling with a geometry string B<WxH+X+Y>,
-string B<WxH+X+Y>, in which B<"W" / "H"> specify the
+in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
-horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image
+and B<"X" / "Y"> locate the image centre (percent).
-centre (percent). A scale of 0 displays the image with tiling. A scale
+A scale of 0 displays the image with tiling. A scale of 1 displays the
-of 1 displays the image without any scaling. A scale of 2 to 9
+image without any scaling. A scale of 2 to 9 specifies an integer
-specifies an integer number of images in that direction. No image will
+number of images in that direction. No image will be magnified beyond
-be magnified beyond 10 times its original size. The maximum permitted
+10 times its original size. The maximum permitted scale is 1000.
-scale is 1000. [default 0x0+50+50]
+Special string of B<"auto"> used as a geometry will cause image to be
+automatically scaled to match window size.
+If used in conjunction with B<-tr> option - specified pixmap will be
+blended over transparency image using either alpha-blending, or any
+other blending type, specified with B<-blt "type"> option.
+[default 0x0+50+50]
 =item B<path:> I<path>
 Specify the colon-delimited search path for finding XPM files.
 =item B<intensityStyles:> I<boolean>
 When font styles are not enabled, or this option is enabled (B<True>,
 option B<-is>, the default), bold and italic font styles imply high
-intensity foreground/backround colours. Disabling this option (B<False>,
+intensity foreground/background colours. Disabling this option (B<False>,
 option B<+is>) disables this behaviour, the high intensity colours are not
 reachable.
 =item B<selectstyle:> I<mode>
-Set mouse selection style to B<old> which is 2.20, B<oldword> which is
+Set mouse selection style to B<old> which is 2.20, B<oldword> which
-xterm style with 2.20 old word selection, or anything else which gives
+is xterm style with 2.20 old word selection, or anything else which
-xterm style selection.
+gives xterm style selection. Only effective when the original (non-perl)
+selection code is in use.
 =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<mapAlert:> I<boolean>
 B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
 de-iconify (map) on receipt of a bell character [default].
+=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].
 =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>.
 Example:
    URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
 This creates a new file in your home directory with the screen contents
-everytime you hit C<Print>.
+every time you hit C<Print>.
 =item B<scrollBar:> I<boolean>
 B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
 disable the scrollbar; option B<+sb>.
 =item B<scrollWithBuffer:> I<boolean>
 B<True>: scroll with scrollback buffer when tty receives new lines (and
 B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
-with scrollback buffer when tty recieves new lines; option B<+sw>.
+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<cutchars:> I<string>
 The characters used as delimiters for double-click word selection
 (whitespace delimiting is added automatically if resource is given).
-When the selection extension is in use (the default if compiled in, see
+When the perl selection extension is in use (the default if compiled
-the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
+in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
-will be created (if the resource exists, otherwise, no regex will be
+characters will be created (if the resource exists, otherwise, no regex
-created). In this mode, characters outside ISO-8859-1 can be used.
+will be created). In this mode, characters outside ISO-8859-1 can be used.
 When the selection extension is not used, only ISO-8859-1 characters can
 be used. If not specified, the built-in default is used:
 B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
 Turn on/off secondary screen (default enabled).
 =item B<secondaryScroll:> I<boolean>
-Turn on/off secondary screen scroll (default enabled). If the this
+Turn on/off secondary screen scroll (default enabled). If this
 option is enabled, scrolls on the secondary screen will change the
 scrollback buffer and switching to/from the secondary screen will
 instead scroll the screen up.
 =item B<hold>: I<boolean>
 I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
 C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
 C<\000>: octal number) or verbatim control characters (C<^?>: delete,
 C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
-can start or end with whitespace.
+can start or end with whitespace. B<This feature is deprecated and will
+be removed>.
 Please note that you need to double the C<\> in resource files, as
-Xlib itself does it's own de-escaping (you can use C<\033> instead of
+Xlib itself does its own de-escaping (you can use C<\033> instead of
 C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
 processing).
 You can define a range of keysyms in one shot by providing a I<string>
-with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
+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<M-C-|abc|>
 example, C<default,-selection> will use all the default extension 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 scorllback to Alt/Meta-s). Mentioning the same extension
+searchable scrollback to Alt/Meta-s). Mentioning the same extension
 multiple times with different arguments will pass multiple arguments to
 the extension.
 Each extension is looked up in the library directories, loaded if
 necessary, and bound to the current terminal instance.
 (default: C<M-s>).
 =item B<urlLauncher>: I<string>
 Specifies the program to be started with a URL argument. Used by the
-C<selection-popup> and C<mark-urls> perl extensions.
+C<selection-popup> and C<matcher> perl extensions.
 =item B<transient-for>: I<windowid>
 Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
 =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_52:> I<boolean>
+Turn on/off ISO 14755 5.2 mode (default enabled).
 =back
 =head1 THE SCROLLBAR
 application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
 (Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
 up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
 respectively.
-=head1 TEXT SELECTION AND INSERTION
+=head1 THE SELECTION: SELECTING AND PASTING TEXT
-The behaviour of text selection and insertion mechanism is similar to
+The behaviour of text selection and insertion/pasting mechanism is similar
-I<xterm>(1).
+to I<xterm>(1).
 =over 4
-=item B<Selection>:
+=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
 to select a word; Left triple-click to select the entire logical line
 (which can span multiple screen lines), unless modified by resource
 (Compile: I<frills>) will create a rectangular selection instead of a
 normal one. In this mode, every selected row becomes its own line in the
 selection, and trailing whitespace is visually underlined and removed from
 the selection.
-=item B<Insertion>:
+=item B<Pasting>:
 Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
 window causes the value of the PRIMARY selection (or CLIPBOARD with the
-Meta modifier) to be inserted as if it had been typed on the keyboard.
+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.
 =back
 This mode lets you input characters representing the keycap symbols of
 your keyboard, if representable in the current locale encoding.
 Start by pressing C<Control> and C<Shift> together, then releasing
 them. The next special key (cursor keys, home etc.) you enter will not
-invoke it's usual function but instead will insert the corresponding
+invoke its usual function but instead will insert the corresponding
 keycap symbol. The symbol will only be entered when the key has been
 released, otherwise pressing e.g. C<Shift> would enter the symbol for
 C<ISO Level 2 Switch>, although your intention might have been to enter a
 reverse tab (Shift-Tab).
 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
+additional 72 colours. The first 64 of those (with indices 16 to 79)
+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).
+Together, all those colours implement the 88 colour xterm colours. Only
+the first 16 can be changed using resources currently, the rest can only
+be changed via command sequences ("escape codes").
 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,
 If Xft support has been compiled in and as long as Xft/Xrender/X don't get
 their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
 (recommended, but B<MUST> have 4 digits/component) colour specifications,
 in addition to the ones provided by X, where the additional A component
 specifies opacity (alpha) values. The minimum value of C<0> is completely
-transparent). You can also prefix any color with C<[a]>, where C<a> is on
+transparent). You can also prefix any color with C<[percent]>, where
-to four hex digits specifiying the opacity value.
+C<percent> is a decimal percentage (0-100) that specifies the opacity of
+the color, where C<0> is completely transparent and C<100> is completelxy
+opaque.
 You probably need to specify B<"-depth 32">, too, and have the luck that
 your X-server uses ARGB pixel layout, as X is far from just supporting
 ARGB visuals out of the box, and rxvt-unicode just fudges around.
 For example, the following selects an almost completely transparent red
 background, and an almost opaque pink foreground:
-   @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
+   @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
 I<Please note that transparency of any kind if completely unsupported by
 the author. Don't bug him with installation questions!>
 =head1 ENVIRONMENT
 =over 4
 =item B<TERM>
 Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
-resources or on the commandline.
+resources or on the command line.
 =item B<COLORTERM>
-Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
+Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
 compiled with XPM support, and optionally with the added extension
 C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
 =item B<COLORFGBG>
 C<--with-terminfo=PATH>.
 =item B<DISPLAY>
 Used by @@RXVT_NAME@@ to connect to the display and set to the correct
-display in it's child processes.
+display in its child processes.
 =item B<SHELL>
 The shell to be used for command execution, defaults to C</bin/sh>.
 =item Project Coordinator
 Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
-L<http://software.schmorp.de/#rxvt-unicode>
+L<http://software.schmorp.de/pkg/rxvt-unicode.html>
 =back
 =head1 AUTHORS

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.111 by root, Tue Jan 31 00:25:16 2006 UTC vs. Revision 1.131 by ayin, Sat Jun 9 09:05:38 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.111 by root, Tue Jan 31 00:25:16 2006 UTC vs.
Revision 1.131 by ayin, Sat Jun 9 09:05:38 2007 UTC