--- rxvt-unicode/doc/rxvt.1.pod 2008/05/16 19:27:16 1.162 +++ rxvt-unicode/doc/rxvt.1.pod 2015/06/16 11:58:26 1.244 @@ -100,7 +100,7 @@ =item B<-depth> I -Compile I: Attempt to find a visual with the given bit depth; +Compile I: Attempt to find a visual with the given bit depth; resource B. [Please note that many X servers (and libXft) are buggy with @@ -108,6 +108,12 @@ of graphical corruption. This is harmless, but we can't do anything about this, so watch out] +=item B<-visual> I + +Compile I: Use the given visual (see e.g. C for +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 Window geometry (B<-g> still respected); resource B. @@ -124,16 +130,6 @@ Turn on/off skip scrolling (allow multiple screens per refresh); resource B. -=item B<-tr>|B<+tr> - -Turn on/off illusion of a transparent window background; resource B. - -B<-ip> is still accepted as an obsolete alias but will be removed in -future versions. - -I - =item B<-fade> I Fade the text by the given percentage when focus is lost. Small values @@ -145,44 +141,11 @@ Fade to this colour when fading is used (see B<-fade>). The default colour is opaque black. resource B. -=item B<-tint> I - -Tint the transparent background pixmap with the given colour when -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. Also -pure black and pure white colors essentially mean no tinting; resource -I. Example: - - @@RXVT_NAME@@ -tr -tint blue -sh 40 - -=item B<-sh> I - -Darken (0 .. 100) or lighten (100 .. 200) the transparent -background image in addition to (or instead of) tinting it; -resource I. - -=item B<-blt> I - -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, B, B - color values averaging, B, -B, B, B, B, B, B, -B, B, B, B, B. The default is -alpha-blending. Compile I; resource I. - -=item B<-blr> I +=item B<-icon> I -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; -resource I. +Compile I: Use the specified image as application icon. This +is used by many window managers, taskbars and pagers to represent the +application window; resource I. =item B<-bg> I @@ -192,13 +155,6 @@ Window foreground colour; resource B. -=item B<-pixmap> I - -Compile I: 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. - =item B<-cr> I The cursor colour; resource B. @@ -266,6 +222,10 @@ Start as a login-shell/sub-shell; resource B. +=item B<-mc> I + +Specify the maximum time between multi-click selections. + =item B<-ut>|B<+ut> Compile I: Inhibit/enable writing a utmp entry; resource @@ -317,6 +277,10 @@ Blink the cursor; resource B. +=item B<-uc>|B<+uc> + +Make the cursor underlined; resource B. + =item B<-iconic> Start iconified, if the window manager supports that option. @@ -342,13 +306,19 @@ Compile I: 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. +decorations; resource B. If the window manager does not +support MWM hints (e.g. kwin), enables override-redirect mode. =item B<-override-redirect> Compile I: Sets override-redirect on the window; resource B. +=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: Disable the usage of the built-in block graphics/line @@ -362,6 +332,13 @@ the display. Useful to work around font rendering problems; resource B. +=item B<-letsp> I + +Compile I: 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. + =item B<-tn> I This option specifies the name of the terminal type to be set in the @@ -405,6 +382,9 @@ Compile I: input style for input method; B, B, B; resource B. +If the perl extension C is used (which is the default), +then additionally the C preedit type is available. + =item B<-im> I Compile I: input method name. resource B. @@ -457,6 +437,12 @@ it exits. Instead, it will wait till it is being killed or closed by the user; resource B. +=item B<-cd> I + +Sets the working directory for the shell (or the command specified via +B<-e>). The I must be an absolute path and it must exist for +@@RXVT_NAME@@ to start; resource B. + =item B<-xrm> I Works like the X Toolkit option of the same name, by adding the I @@ -549,10 +535,10 @@ 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 + 1. app-defaults file in $XAPPLRESDIR + 2. $HOME/.Xdefaults + 3. RESOURCE_MANAGER property on root-window of screen 0 + 4. SCREEN_RESOURCES property on root-window of the current screen 5. $XENVIRONMENT file OR $HOME/.Xdefaults- 6. resources specified via -xrm on the commandline @@ -603,7 +589,7 @@ 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 section. +names used are listed in the B section. Colours higher than 15 cannot be set using resources (yet), but can be changed using an escape command (see @@RXVT_NAME@@(7)). @@ -624,16 +610,21 @@ Use the specified colour to display underlined characters when the foreground colour is the default. -=item B I - -Use the specified colour as the background for reverse video characters -when OPTION_HC is disabled (--disable-frills). - =item B I If set, use the specified colour as the colour for the underline itself. If unset, use the foreground colour. +=item B I + +If set, use the specified colour as the background for highlighted +characters. If unset, use reverse video. + +=item B I + +If set and highlightColor is set, use the specified colour as the +foreground for highlighted characters. + =item B I Use the specified colour for the cursor. The default is to use the @@ -649,7 +640,7 @@ B: simulate reverse video by foreground and background colours; option B<-rv>. B: regular screen colours [default]; option -B<+rv>. See note in B section. +B<+rv>. See note in B section. =item B I @@ -673,16 +664,6 @@ if the refresh is too fast for the human eye to read anything (or the monitor to display anything); option B<+ss>. -=item B I - -Turn on/off illusion of a transparent window background. - -B is still accepted as an obsolete alias but will be removed in -future versions. - -I - =item B I Fade the text by the given percentage when focus is lost; option B<-fade>. @@ -692,24 +673,9 @@ Fade to this colour, when fading is used (see B). The default colour is black; option B<-fadecolor>. -=item B I - -Tint the transparent background pixmap with the given colour; option -B<-tint>. - -=item B I - -Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image -in addition to tinting it; option B<-sh>. - -=item B I - -Specify background blending type; option B<-blt>. +=item B I -=item B I - -Apply Gaussian Blurr with the specified radius to the transparent -background image; option B<-blr>. +Set the application icon pixmap; option B<-icon>. =item B I @@ -725,36 +691,6 @@ The colour of the border around the text area and between the scrollbar and the text. -=item B I - -Use the specified image file for the background and also -optionally specify its scaling with a geometry string B, -(default C<0x0+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 -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. -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 - 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, the specified pixmap will be -blended over transparency image using either alpha-blending, or any -other blending type, specified with B<-blt "type"> option. - -=item B I - -Specify the colon-delimited search path for finding background image files. - =item B I Select the fonts to be used. This is a comma separated list of font names @@ -786,7 +722,7 @@ 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 @@ -847,6 +783,8 @@ B: set the urgency hint for the wm on receipt of a bell character. B: do not set the urgency hint [default]. +@@RXVT_NAME@@ resets the urgency hint on every focus change. + =item B I B: use visual bell on receipt of a bell character; option B<-vb>. @@ -858,6 +796,11 @@ the shell; option B<-ls>. B: start as a normal sub-shell [default]; option B<+ls>. +=item B I + +Specify the maximum time in milliseconds between multi-click select +events. The default is 500 milliseconds; option B<-mc>. + =item B I B: inhibit writing record into the system log file B; @@ -884,6 +827,10 @@ Set scrollbar style to B, B, B or B. B is the author's favourite. +=item B I + +Set the scrollbar width in pixels. + =item B I B: enable the scrollbar [default]; option B<-sb>. B: @@ -912,9 +859,10 @@ =item B I -B: scroll with scrollback buffer when tty receives new lines (and -B is False); option B<-sw>. B: do not scroll -with scrollback buffer when tty receives new lines; option B<+sw>. +B: scroll with scrollback buffer when tty receives new lines (i.e. +try to show the same lines) and B is False; option +B<-sw>. B: do not scroll with scrollback buffer when tty receives +new lines; option B<+sw>. =item B I @@ -980,6 +928,11 @@ B: blink the cursor. B: do not blink the cursor [default]; option B<-bc>. +=item B I + +B: Make the cursor underlined. B: Make the cursor a box [default]; +option B<-uc>. + =item B I B: blank the pointer when a key is pressed or after a set number @@ -994,6 +947,12 @@ Mouse pointer background colour. +=item B I + +Compile I: Specifies the name of the mouse pointer shape +[default B]. See the macros in the B include +file for possible values (omit the C prefix). + =item B I Specifies number of seconds before blanking the pointer [default 2]. Use a @@ -1002,7 +961,7 @@ =item B I The string to send when the backspace key is pressed. If set to B -or unset it will send B (code 127) or, if shifted, B +or unset it will send B (code 127) or, with control, B (code 8) - which can be reversed with the appropriate DEC private mode escape sequence. @@ -1029,7 +988,7 @@ =item B I