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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.138 by sasha, Thu Sep 20 15:56:41 2007 UTC vs.
Revision 1.147 by root, Fri Nov 23 11:18:04 2007 UTC

 =item B<-ss>|B<+ss>
 Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
-=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
+=item B<-tr>|B<+tr>
-Turn on/off inheriting parent window's pixmap. Alternative form is
+Turn on/off illusion of a transparent window background. Obsolete form of it is
-B<-tr>; resource B<inheritPixmap>.
+B<-ip> and it should not be used anymore; resource B<transparent>.
+I<Please note that old resource name of B<inheritPixmap> is obsolete and should be
+changed to B<transparent>. Backwards compatibility support for B<inheritPixmap> will
+be phased out in future versions of rxvt!>
 I<Please address all transparency related issues to Sasha Vasko at
 sasha@aftercode.net. 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
 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
+transparency is enabled with B<-tr>. This only works for
 non-tiled backgrounds, currently. See also the B<-sh> option that can be
 used to brighten or darken the image in addition to tinting it.
 Please note that certain tint colours can be applied on the server-side,
 thus yielding performance gain of two orders of magnitude. These colours are:
-blue, red, green, cyan, magenta, yellow, and those close to them; resource
+blue, red, green, cyan, magenta, yellow, and those close to them. Also
+pure black and pure white colors essentially mean no tinting; resource
 I<tintColor>. Example:
    @@RXVT_NAME@@ -tr -tint blue -sh 40
 =item B<-sh> I<number>
-Darken (0 .. 100) or lighten (-1 .. -100) the transparent
+Darken (0 .. 100) or lighten (100 .. 200) the transparent
 background image in addition to (or instead of) tinting it;
 resource I<shading>.
 =item B<-blt> I<string>
 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>.
+alpha-blending. Compile I<afterimage>; resource I<blendType>.
 =item B<-blr> I<HxV>
 Apply Gaussian Blur with the specified radii to the transparent
 background image. If single number is specified - both vertical and
 horizontal radii are considered to be the same. Setting one of the
 radii to 1 and another to a large number creates interesting effects
-on some backgrounds. Maximum radius value is 128; resource I<blurRadius>.
+on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
+resource I<blurRadius>.
 =item B<-bg> I<colour>
 Window background colour; resource B<background>.
 =item B<-fg> I<colour>
 Window foreground colour; resource B<foreground>.
-=item B<-pixmap> I<file[;geom]>
+=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
 Compile I<afterimage>: Specify image file for the background and also
 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; for more details see resource B<backgroundPixmap>.
 =item B<-cr> I<colour>
 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; resource B<hold>.
+=item B<-xrm> I<string>
+Works like the X Toolkit option of the same name, by adding the I<string>
+as if it were specified in a resource file. Resource values specified this
+way take precedence over all other resource specifications.
+Note that you need to use the I<same> syntax as in the .Xdefaults file,
+e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
+options can be specified as long-options on the commandline, so use
+of B<-xrm> is mostly limited to cases where you want to specify other
+resources (e.g. for input methods) or for compatibility with other
+programs.
 =item B<-keysym.>I<sym> I<string>
 Remap a key symbol. See resource B<keysym>.
 =item B<-embed> I<windowid>
   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>
+  6. resources specified via -xrm on the commandline
 Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
 names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
 common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
 configured, while the class name B<URxvt> allows resources unique to
 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].
 =item B<borderColor:> I<colour>
 The colour of the border around the text area and between the scrollbar
 and the text.
-=item B<backgroundPixmap:> I<file[;geom]>
+=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
-Use the specified image file for the background and also optionally
+Use the specified image file for the background and also
-specify its scaling with a geometry string B<WxH+X+Y>,
+optionally specify its scaling with a geometry string B<WxH+X+Y>,
-in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
+(default C<0x0+50+50>) in which B<"W" / "H"> specify the
-and B<"X" / "Y"> locate the image centre (percent).
+horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
-A scale of 0 displays the image with tiling. A scale of 1 displays the
+centre (percent).  A scale of 0 displays the image with tiling. A scale
-image without any scaling. A scale of 2 to 9 specifies an integer
+of 1 displays the image without any scaling. A scale of 2 to 9 specifies
-number of images in that direction. No image will be magnified beyond
+an integer number of images in that direction. No image will be magnified
-10 times its original size. The maximum permitted scale is 1000.
+beyond 10 times its original size. The maximum permitted scale is 1000.
-Special string of B<"auto"> used as a geometry will cause image to be
+Additional operations can be specified after colon B<:op1:op2...>.
-automatically scaled to match window size.
+Supported operations are:
+  tile        force background image to be tiled and not scaled. Equivalent to 0x0,
+  propscale   will scale image keeping proportions,
+  auto        will scale image to match window size. Equivalent to 100x100;
+  hscale      will scale image horizontally to the window size;
+  vscale      will scale image vertically to the window size;
+  scale       will scale image to match window size;
+  root        will tile image as if it was a root window background, auto-adjusting
+              whenever terminal window moves.
-If used in conjunction with B<-tr> option - specified pixmap will be
+If used in conjunction with B<-tr> option, the 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 background image files.
 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 `"'&()*,;<=>?@[]{|} >>
+B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
 =item B<preeditType:> I<style>
 B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
 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.
-I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
+I<string> may contain escape values (C<\n>: newline, C<\000>: octal
-C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
+number), see RESOURCES in C<man 7 X> for futher details.
-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. 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 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 delimiter `/'
 should be a character not used by the strings.
 resources or on the command line.
 =item B<COLORTERM>
 Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
 compiled with background image support, and optionally with the added
 extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
 screen.
 =item B<COLORFGBG>
 Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
 the colour code used as default foreground/text colour (or the string
 C<default> to indicate that the default-colour escape sequence is to be
 used), C<bg> is the colour code used as default background colour (or the
 string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
 was compiled with background image support. Libraries like C<ncurses>
 and C<slang> can (and do) use this information to optimize screen output.
 =item B<WINDOWID>
 Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
 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 (changes.txt 2.4.6 - rxvt-unicode)
 =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
 Forked rxvt-unicode, unicode support, rewrote almost all the code, perl

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.138 by sasha, Thu Sep 20 15:56:41 2007 UTC vs. Revision 1.147 by root, Fri Nov 23 11:18:04 2007 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.138 by sasha, Thu Sep 20 15:56:41 2007 UTC vs.
Revision 1.147 by root, Fri Nov 23 11:18:04 2007 UTC