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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.89 by root, Sun Jan 8 08:43:11 2006 UTC vs.
Revision 1.114 by root, Thu Jul 6 19:43:21 2006 UTC

 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
 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).
 Attempt to open a window on the named X display (B<-d> still
 respected). 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;
+resource B<depth>.
 =item B<-geometry> I<geom>
 Window geometry (B<-g> still respected); resource B<geometry>.
 =item B<-rv>|B<+rv>
 =item B<-ip>|B<+ip> | B<-tr>|B<+tr>
 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!>
 =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
 colour; resource B<fading>.
 =item B<-fadecolor> I<colour>
 Fade to this colour when fading is used (see B<-fade>). The default colour
-is black. resource B<fadeColor>.
+is opaque black. resource B<fadeColor>.
 =item B<-tint> I<colour>
 Tint the transparent background pixmap with the given colour when
 transparency is enabled with B<-tr> or B<-ip>. This only works for
 resource B<borderColor>.
 =item B<-fn> I<fontlist>
 Select the fonts to be used. This is a comma separated list of font names
-that are used in turn when trying to display Unicode characters.  The
+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"
 =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>.
+=item B<-override-redirect>
+Compile I<frills>: Sets override-redirect on the window; resource
+B<override-redirect>.
 =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
 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
 =head1 RESOURCES (available also as long-options)
 Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
 options) compiled into your version.
-There are two different methods that @@RXVT_NAME@@ can use to get the
+You can set and change the resources using X11 tools like B<xrdb>. Many
-Xresource data: using the X libraries (Xrm*-functions) or internal
+distribution do also load settings from the B<~/.Xresources> file when X
-Xresources reader (B<~/.Xdefaults>). For the first method (ie.
+starts. @@RXVT_NAME@@ will consult the following files/resources in order,
-B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
+with later settings overwriting earlier ones:
-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
   3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
   4. SCREEN_RESOURCES for the current screen
   5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
-If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
-lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
-set in XAPPLOADDIR/URxvt (compile-time defined: usually
-B</usr/lib/X11/app-defaults/URxvt>) and resources set in
-B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
-Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two
+Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
-class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows
+names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
-resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be
+common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
-easily configured, while the class name B<URxvt> allows resources
+configured, while the class name B<URxvt> allows resources unique to
-unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be
+B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
-shared between different B<@@RXVT_NAME@@> configurations. If no
+configurations. If no resources are specified, suitable defaults will
-resources are specified, suitable defaults will be used. Command-line
+be used. Command-line arguments can be used to override resource
-arguments can be used to override resource settings. The following
+settings. The following resources are supported (you might want to
-resources are allowed:
+check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
+extensions not documented here):
 =over 4
+=item B<depth:> I<bitdepth>
+Compile I<xft>: Attempt to find a visual with the given bit depth;
+option B<-depth>.
 =item B<geometry:> I<geom>
 Create the window with the specified X window geometry [default 80x24];
 option B<-geometry>.
 =item B<inheritPixmap:> I<boolean>
 B<True>: make the background inherit the parent windows' pixmap, giving
 artificial transparency. B<False>: do not inherit the parent windows'
 pixmap.
+I<Please note that transparency of any kind if completely unsupported by
+the author. Don't bug him with installation questions!>
 =item B<fading:> I<number>
 Fade the text by the given percentage when focus is lost; option B<-fade>.
 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. [default 0x0+50+50]
-=item B<menu:> I<file[;tag]>
-Read in the specified menu file (note the `.menu' extension is
-optional) and also optionally specify a starting tag to find. See the
-reference documentation for details on the syntax for the menuBar.
 =item B<path:> I<path>
-Specify the colon-delimited search path for finding files (XPM and
+Specify the colon-delimited search path for finding XPM files.
-menus), in addition to the paths specified by the B<RXVTPATH> and
-B<PATH> environment variables.
 =item B<font:> I<fontlist>
-Select the fonts to be used. This is a comma separated list of font
+Select the fonts to be used. This is a comma separated list of font names
-names that are used in turn when trying to display Unicode characters.
+that are checked in order when trying to find glyphs for characters. The
-The first font defines the cell size for characters; other fonts might
+first font defines the cell size for characters; other fonts might be
-be smaller, but not larger. A reasonable default font list is always
+smaller, but not (in general) larger. A (hopefully) reasonable default
-appended to it; option B<-fn>.
+font list is always appended to it; option B<-fn>.
 Each font can either be a standard X11 core font (XLFD) name, with
 optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
 In addition, each font can be prefixed with additional hints and
 hint currently is C<codeset=codeset-name>, and this is only used for Xft
 fonts.
 For example, this font resource
-   URxvt*font: 9x15bold,\
+   URxvt.font: 9x15bold,\
                -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
                -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
                [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
                xft:Code2000:antialias=false
 The string will be interpreted as if typed into the shell as-is.
 Example:
-   URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
+   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>.
 =item B<scrollBar:> I<boolean>
 pressed. If unset it will send the sequence traditionally associated
 with the B<Execute> key.
 =item B<cutchars:> I<string>
-The characters used as delimiters for double-click word selection. The
+The characters used as delimiters for double-click word selection
-built-in default:
+(whitespace delimiting is added automatically if resource is given).
+When the selection extension is in use (the default if compiled in, see
+the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
+will be created (if the resource exists, otherwise, no regex 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 `"'&()*,;<=>?@[]{|} >>
 =item B<preeditType:> I<style>
 default. (Note that many other terminals, including xterm, have these
 sequences enabled by default, which doesn't make it safer, though).
 You can enable them by setting this boolean resource or specifying
 B<-insecure> as an option. At the moment, this enables display-answer,
-locale, findfont, icon label and window title requests as well as dynamic
+locale, findfont, icon label and window title requests.
-menubar dispatch.
 =item B<modifier:> I<modifier>
 Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
 B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
 Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
 character is passed through. It may contain escape values as described
 in the entry on B<keysym> following.
-=item B<secondaryScreen:> I<bool>
+=item B<secondaryScreen:> I<boolean>
 Turn on/off secondary screen (default enabled).
-=item B<secondaryScroll:> I<bool>
+=item B<secondaryScroll:> I<boolean>
 Turn on/off secondary screen scroll (default enabled). If the 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<bool>
+=item B<hold>: I<boolean>
 Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
 will not immediately destroy its window when the program executed within
 it exits. Instead, it will wait till it is being killed or closed by the
 user.
 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.
-Please note that you need to double the C<\> when using
+Please note that you need to double the C<\> in resource files, as
-C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
+Xlib itself does its own de-escaping (you can use C<\033> instead of
-use C<\033> instead of C<\e> (and so on), which will work with both Xt and
+C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
-@@RXVT_NAME@@'s own processing).
+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 `/'
 should be a character not used by the strings.
 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
-it. This can be useful to selectively disable some extensions loaded
+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
 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
+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.
 If both of these resources are the empty string, then the perl
 @@RXVT_NAME@@ will first look in these directories and then in
 F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
 will be ignored when running setuid/setgid.
 See the @@RXVT_NAME@@perl(3) manpage.
+=item B<< selection.pattern-I<idx> >>: I<perl-regex>
+Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
+details.
+=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>
+Sets the hotkey that starts the incremental scrollback buffer search
+(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.
+=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>.
 =back
 =head1 THE SCROLLBAR
 selection, and trailing whitespace is visually underlined and removed from
 the selection.
 =item B<Insertion>:
-Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
+Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
-an B<@@RXVT_NAME@@> window causes the current text selection to be
+window causes the value of the PRIMARY selection (or CLIPBOARD with the
-inserted as if it had been typed on the keyboard.
+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
 =head1 CHANGING FONTS
 Changing fonts (or font sizes, respectively) via the keypad is not yet
 supported in rxvt-unicode. Bug me if you need this.
-You can, however, switch fonts at runtime using escape sequences (and
+You can, however, switch fonts at runtime using escape sequences, e.g.:
-therefore using the menubar), e.g.:
    printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
+You can use keyboard shortcuts, too:
+   URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
+   URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
 rxvt-unicode will automatically re-apply these fonts to the output so far.
 =head1 ISO 14755 SUPPORT
 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).
 =head1 COLORS AND GRAPHICS
 In addition to the default foreground and background colours,
 B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
 high-intensity bold/blink versions of the same). Here is a list of the
-colours with their B<rgb.txt> names.
+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
+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,
 would yield White on Black, while on I<xterm>(1) it would yield Black
 on 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 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
+to four hex digits specifiying the opacity value.
+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"
+I<Please note that transparency of any kind if completely unsupported by
+the author. Don't bug him with installation questions!>
 =head1 ENVIRONMENT
 B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
 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 B<RXVTPATH>
-The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
-files.
-=item B<PATH>
-Used in the same way as C<RXVTPATH>.
 =item B<RXVT_SOCKET>
 The unix domain socket path used by @@RXVT_NAME@@c(1) and
 @@RXVT_NAME@@d(1).
 =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
 Project Coordinator (changes.txt 2.21a to 2.4.5)
 =item Geoff Wing L<< <gcw@pobox.com> >>
-Rewrote screen display and text selection routines. Project Coordinator
+Rewrote screen display and text selection routines.
-(changes.txt 2.4.6 - rxvt-unicode)
+Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
 =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
-Forked rxvt-unicode, rewrote most of the display code and internal
+Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
-character handling to store text in unicode, improve xterm
+extension, random hacks, numerous bugfixes and extensions.
-compatibility and apply numerous other bugfixes and extensions.
 Project Coordinator (Changes 1.0 -)
+=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
+Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
 =back

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.89 by root, Sun Jan 8 08:43:11 2006 UTC vs. Revision 1.114 by root, Thu Jul 6 19:43:21 2006 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.89 by root, Sun Jan 8 08:43:11 2006 UTC vs.
Revision 1.114 by root, Thu Jul 6 19:43:21 2006 UTC