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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.161 by ayin, Sat Jan 26 14:24:42 2008 UTC vs.
Revision 1.186 by sf-exg, Wed Oct 13 23:36:00 2010 UTC

 Print out a message describing available options.
 =item B<-display> I<displayname>
-Attempt to open a window on the named X display (B<-d> still
+Attempt to open a window on the named X display (the older form B<-d>
-respected). In the absence of this option, the display specified by the
+is still respected. but deprecated). In the absence of this option, the
-B<DISPLAY> environment variable is used.
+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>.
 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. Also
-pure black and pure white colors essentially mean no tinting; resource
+pure black and pure white colours essentially mean no tinting; resource
 I<tintColor>. Example:
    @@RXVT_NAME@@ -tr -tint blue -sh 40
 =item B<-sh> I<number>
 =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<add>, B<alphablend>, B<allanon> - colour 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. 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. Compile I<afterimage>;
+on some backgrounds. Maximum radius value is 128. Compile I<afterimage> or I<xft>;
 resource I<blurRadius>.
+=item B<-icon> I<file>
+Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
+is used by many window managers, taskbars and pagers to represent the
+application window; resource I<iconFile>.
 =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[:op1][:op2][...]]>
-Compile I<afterimage>: Specify image file for the background and also
+Compile I<afterimage> or I<pixbuf>: 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>
 =item B<-bc>|B<+bc>
 Blink the cursor; resource B<cursorBlink>.
+=item B<-uc>|B<+uc>
+Make the cursor underlined; resource B<cursorUnderline>.
 =item B<-iconic>
 Start iconified, if the window manager supports that option.
 Alternative form is B<-ic>.
 =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>.
+decorations; resource B<borderLess>. If the window manager does not
+support MWM hints (e.g. kwin), enables override-redirect mode.
 =item B<-override-redirect>
 Compile I<frills>: Sets override-redirect on the window; resource
 B<override-redirect>.
 =item B<-lsp> I<number>
 Compile I<frills>: Lines (pixel height) to insert between each row of
 the display. Useful to work around font rendering problems; resource
 B<lineSpace>.
+=item B<-letsp> I<number>
+Compile I<frills>: Amount to adjust the computed character width by
+to control overall letter spacing. Negative values will tighten up the
+letter spacing, positive values will space letters out more. Useful to
+work around odd font metrics; resource B<letterSpace>.
 =item B<-tn> I<termname>
 This option specifies the name of the terminal type to be set in the
 B<TERM> environment variable. This terminal type must exist in the
 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<-cd> I<path>
+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; resource B<chdir>.
 =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
 Use the specified colour for the colour value I<n>, where 0-7
 corresponds to low-intensity (normal) colours and 8-15 corresponds to
 high-intensity (bold = bright foreground, blink = bright background)
 colours. The canonical names are as follows: 0=black, 1=red, 2=green,
 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
-names used are listed in the B<COLORS AND GRAPHICS> section.
+names used are listed in the B<COLOURS AND GRAPHICS> section.
 Colours higher than 15 cannot be set using resources (yet), but can be
 changed using an escape command (see @@RXVT_NAME@@(7)).
 Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
 =item B<colorUL:> I<colour>
 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 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.
+=item B<highlightColor:> I<colour>
+If set, use the specified colour as the background for highlighted
+characters. If unset, use reverse video.
+=item B<highlightTextColor:> I<colour>
+If set and highlightColor is set, use the specified colour as the
+foreground for highlighted characters.
 =item B<cursorColor:> I<colour>
 Use the specified colour for the cursor. The default is to use the
 foreground colour; option B<-cr>.
 =item B<reverseVideo:> I<boolean>
 B<True>: simulate reverse video by foreground and background colours;
 option B<-rv>. B<False>: regular screen colours [default]; option
-B<+rv>. See note in B<COLORS AND GRAPHICS> section.
+B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
 =item B<jumpScroll:> I<boolean>
 B<True>: specify that jump scrolling should be used. When receiving lots
 of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
 Specify background blending type; option B<-blt>.
 =item B<blurRadius:> I<number>
-Apply Gaussian Blurr with the specified radius to the transparent
+Apply gaussian blur with the specified radius to the transparent
 background image; option B<-blr>.
+=item B<iconFile:> I<file>
+Set the application icon pixmap; option B<-icon>.
 =item B<scrollColor:> I<colour>
 Use the specified colour for the scrollbar [default #B2B2B2].
 =item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
 Use the specified image file for the background and also
 optionally specify its scaling with a geometry string B<WxH+X+Y>,
-(default C<0x0+50+50>) in which B<"W" / "H"> specify the
+(default C<100x100+50+50>) in which B<"W" / "H"> specify the
 horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
-centre (percent).  A scale of 0 displays the image with tiling. A scale
+centre (percent).  A scale of 0 displays the image with tiling.
-of 1 displays the image without any scaling. A scale of 2 to 9 specifies
+The maximum permitted scale is 1000.
-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.
 Additional operations can be specified after colon B<:op1:op2...>.
 Supported operations are:
   tile        force background image to be tiled and not scaled. Equivalent to 0x0
   propscale   will scale image keeping proportions
   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, the specified pixmap will be
-blended over transparency image using either alpha-blending, or any
+blended over transparency image using alpha-blending. If I<afterimage>
-other blending type, specified with B<-blt "type"> option.
+support has been compiled in it is possible to choose other blending
+types with B<-blt "type"> option.
 =item B<path:> I<path>
 Specify the colon-delimited search path for finding background image files.
 it is named first) and thus defines the character cell grid to be 9 pixels
 wide and 15 pixels high.
 The second font is just used to add additional unicode characters not in
 the base font, likewise the third, which is unfortunately non-bold, but
-the bold version of the font does contain less characters, so this is a
+the bold version of the font does contain fewer characters, so this is a
 useful supplement.
 The third font is an Xft font with aliasing turned off, and the characters
 are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
 contains other characters, but we are not interested in them.
 =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].
+@@RXVT_NAME@@ resets the urgency hint on every focus change.
 =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>.
 =item B<cursorBlink:> I<boolean>
 B<True>: blink the cursor. B<False>: do not blink the cursor [default];
 option B<-bc>.
+=item B<cursorUnderline:> I<boolean>
+B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
+option B<-uc>.
 =item B<pointerBlank:> I<boolean>
 B<True>: blank the pointer when a key is pressed or after a set number
 of seconds of inactivity. B<False>: the pointer is always visible
 [default].
 large number (e.g. C<987654321>) to effectively disable the timeout.
 =item B<backspacekey:> I<string>
 The string to send when the backspace key is pressed. If set to B<DEC>
-or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
+or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
 (code 8) - which can be reversed with the appropriate DEC private mode
 escape sequence.
 =item B<deletekey:> I<string>
 =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 switching to/from the secondary screen will
+scrollback buffer and, when secondaryScreen is off, switching
-instead scroll the screen up.
+to/from the secondary screen will instead scroll the screen up.
 =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.
+=item B<chdir>: I<path>
+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>
 Compile I<frills>: Associate I<string> with keysym I<sym>. The
 intervening resource name B<keysym.> cannot be omitted.
 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<\n>: newline, C<\000>: octal
-number), see RESOURCES in C<man 7 X> for futher details.
+number), see RESOURCES in C<man 7 X> for further details.
 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.
 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>
-is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
+is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
 manpage. For example, the F<selection> extension (activated via
 C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
   URxvt.keysym.M-C-c: perl:selection:rot13
 Due the the large number of modifier combinations, a defined key mapping
-will match if at I<at least> the specified identifiers are being set, and
+will 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 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.
 all instances, while B<perl-ext> is used for specific instances.
 =item B<perl-eval>: I<string>
 Perl code to be evaluated when all extensions have been registered. See
-the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
+the @@RXVT_NAME@@perl(3) manpage.
-will be ignored when running setuid/setgid.
 =item B<perl-lib>: I<path>
 Colon-separated list of additional directories that hold extension
 scripts. When looking for extensions specified by the C<perl> resource,
 @@RXVT_NAME@@ will first look in these directories and then in
-F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
+F<@@RXVT_LIBDIR@@/urxvt/perl/>.
-will be ignored when running setuid/setgid.
 See the @@RXVT_NAME@@perl(3) manpage.
 =item B<< selection.pattern-I<idx> >>: I<perl-regex>
 =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:> I<boolean>
+Turn on/off ISO 14755 (default enabled).
 =item B<iso14755_52:> I<boolean>
 Turn on/off ISO 14755 5.2 mode (default enabled).
 B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
 it can be seen via the I<who(1)> command, and can accept messages.  To
 allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
 on some systems or setgid to root or to some other group on others.
-=head1 COLORS AND GRAPHICS
+=head1 COLOURS AND GRAPHICS
 In addition to the default foreground and background colours,
-B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
+B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
-high-intensity bold/blink versions of the same). Here is a list of the
+high-intensity (potentially bold/blink) versions of the same, and 72 (or
-colours with their names.
+240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
+cube plus a 8 (24) colour greyscale ramp.
+Here is a list of the ANSI 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
+The following text gives values for the standard 88 colour mode (and
-additional 72 colours. The first 64 of those (with indices 16 to 79)
+values for the 256 colour mode in parentheses).
-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).
+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_256 = (r * 16 + g) * 16 + b + 16   # r, g, b = 0..15
+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.
-Together, all those colours implement the 88 colour xterm colours. Only
+Together, all those colours implement the 88 (256) colour xterm
-the first 16 can be changed using resources currently, the rest can only
+colours. Only the first 16 can be changed using resources currently, the
-be changed via command sequences ("escape codes").
+rest can only be changed via command sequences ("escape codes").
+Applications are advised to use terminfo or command sequences to discover
+number and RGB values of all colours (yes, you can query this...).
 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,
-=over 4
-=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
+   @@RXVT_NAME@@ -fg Black -bg White -rv
-would yield White on Black, while on I<xterm>(1) it would yield Black
+would yield White on Black, while on I<xterm>(1) it would yield Black on
-on White.
+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 do it's own alpha channel management:
-You can prefix any color with an opaquenes percentage enclosed in
+You can prefix any colour with an opaqueness percentage enclosed in
 brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
-(0-100) that specifies the opacity of the color, where C<0> is completely
+(0-100) that specifies the opacity of the colour, where C<0> is completely
 transparent and C<100> is completely opaque. For example, C<[50]red> is a
 half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
 is the recommended format to specify transparency values, and works with
 all ways to specify a colour.
 C<--with-terminfo=PATH>.
 =item B<DISPLAY>
 Used by @@RXVT_NAME@@ to connect to the display and set to the correct
-display in its child processes.
+display in its child processes if C<-display> isn't used to override. It
+defaults to C<:0> if it doesn't exist.
 =item B<SHELL>
 The shell to be used for command execution, defaults to C</bin/sh>.
 =over 4
 =item B</usr/lib/X11/rgb.txt>
-Color names.
+Colour names.
 =back
 =head1 SEE ALSO

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.161 by ayin, Sat Jan 26 14:24:42 2008 UTC vs. Revision 1.186 by sf-exg, Wed Oct 13 23:36:00 2010 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.161 by ayin, Sat Jan 26 14:24:42 2008 UTC vs.
Revision 1.186 by sf-exg, Wed Oct 13 23:36:00 2010 UTC