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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.160 by root, Fri Jan 25 18:42:23 2008 UTC vs.
Revision 1.220 by root, Fri Sep 21 23:31:43 2012 UTC

…		…
92		92
93	Print out a message describing available options.	93	Print out a message describing available options.
94		94
95	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
96		96
97	Attempt to open a window on the named X display (B<-d> still	97	Attempt to open a window on the named X display (the older form B<-d>
98	respected). In the absence of this option, the display specified by the	98	is still respected. but deprecated). In the absence of this option, the
99	B<DISPLAY> environment variable is used.	99	display specified by the B<DISPLAY> environment variable is used.
100		100
101	=item B<-depth> I<bitdepth>	101	=item B<-depth> I<bitdepth>
102		102
103	Compile I<xft>: Attempt to find a visual with the given bit depth;	103	Compile I<frills>: Attempt to find a visual with the given bit depth;
104	resource B<depth>.	104	resource B<depth>.
105		105
106	[Please note that many X servers (and libXft) are buggy with	106	[Please note that many X servers (and libXft) are buggy with
107	respect to C<-depth 32> and/or alpha channels, and will cause all sorts	107	respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108	of graphical corruption. This is harmless, but we can't do anything about	108	of graphical corruption. This is harmless, but we can't do anything about
109	this, so watch out]	109	this, so watch out]
110		110
		111	=item B<-visual> I<visualID>
		112
		113	Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible
		114	visual ids).
		115
111	=item B<-geometry> I<geom>	116	=item B<-geometry> I<geom>
112		117
113	Window geometry (B<-g> still respected); resource B<geometry>.	118	Window geometry (B<-g> still respected); resource B<geometry>.
114		119
115	=item B<-rv>\|B<+rv>	120	=item B<-rv>\|B<+rv>
…		…
124		129
125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.	130	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
126		131
127	=item B<-tr>\|B<+tr>	132	=item B<-tr>\|B<+tr>
128		133
129	Turn on/off illusion of a transparent window background; resource B<transparent>.	134	Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
130		135
131	B<-ip> is still accepted as an obsolete alias but will be removed in	136	B<-ip> is still accepted as an obsolete alias but will be removed in
132	future versions.	137	future versions.
133
134	I<Please address all transparency related issues to Sasha Vasko at
135	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
136		138
137	=item B<-fade> I<number>	139	=item B<-fade> I<number>
138		140
139	Fade the text by the given percentage when focus is lost. Small values	141	Fade the text by the given percentage when focus is lost. Small values
140	fade a little only, 100 completely replaces all colours by the fade	142	fade a little only, 100 completely replaces all colours by the fade
…		…
145	Fade to this colour when fading is used (see B<-fade>). The default colour	147	Fade to this colour when fading is used (see B<-fade>). The default colour
146	is opaque black. resource B<fadeColor>.	148	is opaque black. resource B<fadeColor>.
147		149
148	=item B<-tint> I<colour>	150	=item B<-tint> I<colour>
149		151
150	Tint the transparent background pixmap with the given colour when	152	Tint the transparent background with the given colour;
151	transparency is enabled with B<-tr>. This only works for	153	resource I<tintColor>.
152	non-tiled backgrounds, currently. See also the B<-sh> option that can be
153	used to brighten or darken the image in addition to tinting it.
154	Please note that certain tint colours can be applied on the server-side,
155	thus yielding performance gain of two orders of magnitude. These colours are:
156	blue, red, green, cyan, magenta, yellow, and those close to them. Also
157	pure black and pure white colors essentially mean no tinting; resource
158	I<tintColor>. Example:
159
160	@@RXVT_NAME@@ -tr -tint blue -sh 40
161		154
162	=item B<-sh> I<number>	155	=item B<-sh> I<number>
163		156
164	Darken (0 .. 100) or lighten (100 .. 200) the transparent	157	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
165	background image in addition to (or instead of) tinting it;	158	A value of 100 means no shading; resource I<shading>.
166	resource I<shading>.
167
168	=item B<-blt> I<string>
169
170	Specify background blending type. If background pixmap is specified
171	at the same time as transparency - such pixmap will be blended over
172	transparency image, using method specified. Supported values are :
173	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
174	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176	alpha-blending. Compile I<afterimage>; resource I<blendType>.
177		159
178	=item B<-blr> I<HxV>	160	=item B<-blr> I<HxV>
179		161
180	Apply Gaussian Blur with the specified radii to the transparent	162	Apply Gaussian Blur with the specified radii to the transparent
181	background image. If single number is specified - both vertical and	163	background. If a single number is specified, the vertical and
182	horizontal radii are considered to be the same. Setting one of the	164	horizontal radii are considered to be the same. Setting one of the
183	radii to 1 and another to a large number creates interesting effects	165	radii to 1 and the other to a large number creates interesting effects
184	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;	166	on some backgrounds. The maximum radius value is 128. An horizontal or
		167	vertical radius of 0 disables blurring;
185	resource I<blurRadius>.	168	resource I<blurRadius>.
186		169
		170	=item B<-icon> I<file>
		171
		172	Compile I<pixbuf>: Use the specified image as application icon. This
		173	is used by many window managers, taskbars and pagers to represent the
		174	application window; resource I<iconFile>.
		175
187	=item B<-bg> I<colour>	176	=item B<-bg> I<colour>
188		177
189	Window background colour; resource B<background>.	178	Window background colour; resource B<background>.
190		179
191	=item B<-fg> I<colour>	180	=item B<-fg> I<colour>
192		181
193	Window foreground colour; resource B<foreground>.	182	Window foreground colour; resource B<foreground>.
194		183
195	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>	184	=item B<-pixmap> I<file[;oplist]>
196		185
197	Compile I<afterimage>: Specify image file for the background and also	186	Compile I<pixbuf>: Specify image file for the background and also
198	optionally specify its scaling with a geometry string. Note you may need to	187	optionally specify a list of operations to modify it. Note you may need to
199	add quotes to avoid special shell interpretation of the C<;> in the	188	add quotes to avoid special shell interpretation of the C<;> in the
200	command-line; for more details see resource B<backgroundPixmap>.	189	command-line; for more details see resource B<backgroundPixmap>.
201		190
202	=item B<-cr> I<colour>	191	=item B<-cr> I<colour>
203		192
…		…
315		304
316	=item B<-bc>\|B<+bc>	305	=item B<-bc>\|B<+bc>
317		306
318	Blink the cursor; resource B<cursorBlink>.	307	Blink the cursor; resource B<cursorBlink>.
319		308
		309	=item B<-uc>\|B<+uc>
		310
		311	Make the cursor underlined; resource B<cursorUnderline>.
		312
320	=item B<-iconic>	313	=item B<-iconic>
321		314
322	Start iconified, if the window manager supports that option.	315	Start iconified, if the window manager supports that option.
323	Alternative form is B<-ic>.	316	Alternative form is B<-ic>.
324		317
…		…
340		333
341	=item B<-bl>	334	=item B<-bl>
342		335
343	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	336	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
344	if honoured by the WM, the rxvt-unicode window will not have window	337	if honoured by the WM, the rxvt-unicode window will not have window
345	decorations; resource B<borderLess>.	338	decorations; resource B<borderLess>. If the window manager does not
		339	support MWM hints (e.g. kwin), enables override-redirect mode.
346		340
347	=item B<-override-redirect>	341	=item B<-override-redirect>
348		342
349	Compile I<frills>: Sets override-redirect on the window; resource	343	Compile I<frills>: Sets override-redirect on the window; resource
350	B<override-redirect>.	344	B<override-redirect>.
…		…
359	=item B<-lsp> I<number>	353	=item B<-lsp> I<number>
360		354
361	Compile I<frills>: Lines (pixel height) to insert between each row of	355	Compile I<frills>: Lines (pixel height) to insert between each row of
362	the display. Useful to work around font rendering problems; resource	356	the display. Useful to work around font rendering problems; resource
363	B<lineSpace>.	357	B<lineSpace>.
		358
		359	=item B<-letsp> I<number>
		360
		361	Compile I<frills>: Amount to adjust the computed character width by
		362	to control overall letter spacing. Negative values will tighten up the
		363	letter spacing, positive values will space letters out more. Useful to
		364	work around odd font metrics; resource B<letterSpace>.
364		365
365	=item B<-tn> I<termname>	366	=item B<-tn> I<termname>
366		367
367	This option specifies the name of the terminal type to be set in the	368	This option specifies the name of the terminal type to be set in the
368	B<TERM> environment variable. This terminal type must exist in the	369	B<TERM> environment variable. This terminal type must exist in the
…		…
455	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	456	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
456	will not immediately destroy its window when the program executed within	457	will not immediately destroy its window when the program executed within
457	it exits. Instead, it will wait till it is being killed or closed by the	458	it exits. Instead, it will wait till it is being killed or closed by the
458	user; resource B<hold>.	459	user; resource B<hold>.
459		460
		461	=item B<-cd> I<path>
		462
		463	Sets the working directory for the shell (or the command specified via
		464	B<-e>). The I<path> must be an absolute path and it must exist for
		465	@@RXVT_NAME@@ to start; resource B<chdir>.
		466
460	=item B<-xrm> I<string>	467	=item B<-xrm> I<string>
461		468
462	Works like the X Toolkit option of the same name, by adding the I<string>	469	Works like the X Toolkit option of the same name, by adding the I<string>
463	as if it were specified in a resource file. Resource values specified this	470	as if it were specified in a resource file. Resource values specified this
464	way take precedence over all other resource specifications.	471	way take precedence over all other resource specifications.
…		…
547	You can set and change the resources using X11 tools like B<xrdb>. Many	554	You can set and change the resources using X11 tools like B<xrdb>. Many
548	distribution do also load settings from the B<~/.Xresources> file when X	555	distribution do also load settings from the B<~/.Xresources> file when X
549	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	556	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
550	with later settings overwriting earlier ones:	557	with later settings overwriting earlier ones:
551		558
552	1. system-wide app-defaults file, either locale-dependent OR global
553	2. app-defaults file in $XAPPLRESDIR	559	1. app-defaults file in $XAPPLRESDIR
		560	2. $HOME/.Xdefaults
554	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	561	3. RESOURCE_MANAGER property on root-window of screen 0
555	4. SCREEN_RESOURCES for the current screen	562	4. SCREEN_RESOURCES property on root-window of the current screen
556	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	563	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
557	6. resources specified via -xrm on the commandline	564	6. resources specified via -xrm on the commandline
558		565
559	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	566	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
560	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	567	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
…		…
572	=item B<depth:> I<bitdepth>	579	=item B<depth:> I<bitdepth>
573		580
574	Compile I<xft>: Attempt to find a visual with the given bit depth;	581	Compile I<xft>: Attempt to find a visual with the given bit depth;
575	option B<-depth>.	582	option B<-depth>.
576		583
		584	=item B<buffered:> I<boolean>
		585
		586	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		587	On some card/driver combination enabling it slightly decreases
		588	performance, on most it greatly helps it. The slowdown is small, so it
		589	should normally be enabled.
		590
577	=item B<geometry:> I<geom>	591	=item B<geometry:> I<geom>
578		592
579	Create the window with the specified X window geometry [default 80x24];	593	Create the window with the specified X window geometry [default 80x24];
580	option B<-geometry>.	594	option B<-geometry>.
581		595
…		…
594	Use the specified colour for the colour value I<n>, where 0-7	608	Use the specified colour for the colour value I<n>, where 0-7
595	corresponds to low-intensity (normal) colours and 8-15 corresponds to	609	corresponds to low-intensity (normal) colours and 8-15 corresponds to
596	high-intensity (bold = bright foreground, blink = bright background)	610	high-intensity (bold = bright foreground, blink = bright background)
597	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	611	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
598	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	612	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
599	names used are listed in the B<COLORS AND GRAPHICS> section.	613	names used are listed in the B<COLOURS AND GRAPHICS> section.
600		614
601	Colours higher than 15 cannot be set using resources (yet), but can be	615	Colours higher than 15 cannot be set using resources (yet), but can be
602	changed using an escape command (see @@RXVT_NAME@@(7)).	616	changed using an escape command (see @@RXVT_NAME@@(7)).
603		617
604	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	618	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
615	=item B<colorUL:> I<colour>	629	=item B<colorUL:> I<colour>
616		630
617	Use the specified colour to display underlined characters when the	631	Use the specified colour to display underlined characters when the
618	foreground colour is the default.	632	foreground colour is the default.
619		633
620	=item B<colorRV:> I<colour>
621
622	Use the specified colour as the background for reverse video characters
623	when OPTION_HC is disabled (--disable-frills).
624
625	=item B<underlineColor:> I<colour>	634	=item B<underlineColor:> I<colour>
626		635
627	If set, use the specified colour as the colour for the underline	636	If set, use the specified colour as the colour for the underline
628	itself. If unset, use the foreground colour.	637	itself. If unset, use the foreground colour.
		638
		639	=item B<highlightColor:> I<colour>
		640
		641	If set, use the specified colour as the background for highlighted
		642	characters. If unset, use reverse video.
		643
		644	=item B<highlightTextColor:> I<colour>
		645
		646	If set and highlightColor is set, use the specified colour as the
		647	foreground for highlighted characters.
629		648
630	=item B<cursorColor:> I<colour>	649	=item B<cursorColor:> I<colour>
631		650
632	Use the specified colour for the cursor. The default is to use the	651	Use the specified colour for the cursor. The default is to use the
633	foreground colour; option B<-cr>.	652	foreground colour; option B<-cr>.
…		…
640		659
641	=item B<reverseVideo:> I<boolean>	660	=item B<reverseVideo:> I<boolean>
642		661
643	B<True>: simulate reverse video by foreground and background colours;	662	B<True>: simulate reverse video by foreground and background colours;
644	option B<-rv>. B<False>: regular screen colours [default]; option	663	option B<-rv>. B<False>: regular screen colours [default]; option
645	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	664	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
646		665
647	=item B<jumpScroll:> I<boolean>	666	=item B<jumpScroll:> I<boolean>
648		667
649	B<True>: specify that jump scrolling should be used. When receiving lots	668	B<True>: specify that jump scrolling should be used. When receiving lots
650	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines	669	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
666	if the refresh is too fast for the human eye to read anything (or the	685	if the refresh is too fast for the human eye to read anything (or the
667	monitor to display anything); option B<+ss>.	686	monitor to display anything); option B<+ss>.
668		687
669	=item B<transparent:> I<boolean>	688	=item B<transparent:> I<boolean>
670		689
671	Turn on/off illusion of a transparent window background.	690	Turn on/off pseudo-transparency by using the root pixmap as background.
672		691
673	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in	692	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
674	future versions.	693	future versions.
675		694
676	I<Please address all transparency related issues to Sasha Vasko at
677	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
678
679	=item B<fading:> I<number>	695	=item B<fading:> I<number>
680		696
681	Fade the text by the given percentage when focus is lost; option B<-fade>.	697	Fade the text by the given percentage when focus is lost; option B<-fade>.
682		698
683	=item B<fadeColor:> I<colour>	699	=item B<fadeColor:> I<colour>
…		…
685	Fade to this colour, when fading is used (see B<fading:>). The default	701	Fade to this colour, when fading is used (see B<fading:>). The default
686	colour is black; option B<-fadecolor>.	702	colour is black; option B<-fadecolor>.
687		703
688	=item B<tintColor:> I<colour>	704	=item B<tintColor:> I<colour>
689		705
690	Tint the transparent background pixmap with the given colour; option	706	Tint the transparent background with the given colour. If the RENDER
691	B<-tint>.	707	extension is not available only black, red, green, yellow, blue,
		708	magenta, cyan and white tints can be performed server-side. Note that
		709	a black tint yields a completely black image while a white tint yields
		710	the image unchanged; option B<-tint>.
692		711
693	=item B<shading:> I<number>	712	=item B<shading:> I<number>
694		713
695	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	714	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
696	in addition to tinting it; option B<-sh>.	715	A value of 100 means no shading; option B<-sh>.
697
698	=item B<blendType:> I<string>
699
700	Specify background blending type; option B<-blt>.
701		716
702	=item B<blurRadius:> I<number>	717	=item B<blurRadius:> I<number>
703		718
704	Apply Gaussian Blurr with the specified radius to the transparent	719	Apply gaussian blur with the specified radius to the transparent
705	background image; option B<-blr>.	720	background; option B<-blr>.
		721
		722	=item B<iconFile:> I<file>
		723
		724	Set the application icon pixmap; option B<-icon>.
706		725
707	=item B<scrollColor:> I<colour>	726	=item B<scrollColor:> I<colour>
708		727
709	Use the specified colour for the scrollbar [default #B2B2B2].	728	Use the specified colour for the scrollbar [default #B2B2B2].
710		729
…		…
716	=item B<borderColor:> I<colour>	735	=item B<borderColor:> I<colour>
717		736
718	The colour of the border around the text area and between the scrollbar	737	The colour of the border around the text area and between the scrollbar
719	and the text.	738	and the text.
720		739
721	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	740	=item B<backgroundPixmap:> I<file[;oplist]>
722		741
723	Use the specified image file for the background and also	742	Use the specified image file for the background and also
724	optionally specify its scaling with a geometry string B<WxH+X+Y>,	743	optionally specify a colon separated list of operations to modify it.
725	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
726	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
727	centre (percent). A scale of 0 displays the image with tiling. A scale
728	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
729	an integer number of images in that direction. No image will be magnified
730	beyond 10 times its original size. The maximum permitted scale is 1000.
731	Additional operations can be specified after colon B<:op1:op2...>.
732	Supported operations are:	744	Supported operations are:
733		745
734	tile force background image to be tiled and not scaled. Equivalent to 0x0	746	=over 4
735	propscale will scale image keeping proportions	747
736	auto will scale image to match window size. Equivalent to 100x100	748	=item B<WxH+X+Y>
737	hscale will scale image horizontally to the window size	749
738	vscale will scale image vertically to the window size	750	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
739	scale will scale image to match window size	751	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
740	root will tile image as if it was a root window background, auto-adjusting	752	scale of 0 disables scaling.
741	whenever terminal window moves	753
		754	=item B<op=tile>
		755
		756	enables tiling
		757
		758	=item B<op=keep-aspect>
		759
		760	maintain the image aspect ratio when scaling
		761
		762	=item B<op=root-align>
		763
		764	use the position of the terminal window relative to the root window as
		765	the image offset, simulating a root window background
		766
		767	=back
		768
		769	The default scale and position setting is C<100x100+50+50>.
		770	Alternatively, a predefined set of templates can be used to achieve
		771	the most common setups:
		772
		773	=over 4
		774
		775	=item B<style=tiled>
		776
		777	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		778
		779	=item B<style=aspect-stretched>
		780
		781	the image is scaled to fill the whole window maintaining the aspect
		782	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		783
		784	=item B<style=stretched>
		785
		786	the image is scaled to fill the whole window. Equivalent to 100x100
		787
		788	=item B<style=centered>
		789
		790	the image is centered with no scaling. Equivalent to 0x0+50+50
		791
		792	=item B<style=root-tiled>
		793
		794	the image is tiled with no scaling and using 'root' positioning.
		795	Equivalent to 0x0:op=tile:op=root-align
		796
		797	=back
		798
		799	If multiple templates are specified the last one wins. Note that a
		800	template overrides all the scale, position and operations settings.
742		801
743	If used in conjunction with B<-tr> option, the specified pixmap will be	802	If used in conjunction with B<-tr> option, the specified pixmap will be
744	blended over transparency image using either alpha-blending, or any	803	blended over the transparent background using alpha-blending.
745	other blending type, specified with B<-blt "type"> option.
746		804
747	=item B<path:> I<path>	805	=item B<path:> I<path>
748		806
749	Specify the colon-delimited search path for finding background image files.	807	Specify the colon-delimited search path for finding background image files.
750		808
…		…
777	it is named first) and thus defines the character cell grid to be 9 pixels	835	it is named first) and thus defines the character cell grid to be 9 pixels
778	wide and 15 pixels high.	836	wide and 15 pixels high.
779		837
780	The second font is just used to add additional unicode characters not in	838	The second font is just used to add additional unicode characters not in
781	the base font, likewise the third, which is unfortunately non-bold, but	839	the base font, likewise the third, which is unfortunately non-bold, but
782	the bold version of the font does contain less characters, so this is a	840	the bold version of the font does contain fewer characters, so this is a
783	useful supplement.	841	useful supplement.
784		842
785	The third font is an Xft font with aliasing turned off, and the characters	843	The third font is an Xft font with aliasing turned off, and the characters
786	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	844	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
787	contains other characters, but we are not interested in them.	845	contains other characters, but we are not interested in them.
…		…
838	=item B<urgentOnBell:> I<boolean>	896	=item B<urgentOnBell:> I<boolean>
839		897
840	B<True>: set the urgency hint for the wm on receipt of a bell character.	898	B<True>: set the urgency hint for the wm on receipt of a bell character.
841	B<False>: do not set the urgency hint [default].	899	B<False>: do not set the urgency hint [default].
842		900
		901	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		902
843	=item B<visualBell:> I<boolean>	903	=item B<visualBell:> I<boolean>
844		904
845	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	905	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
846	B<False>: no visual bell [default]; option B<+vb>.	906	B<False>: no visual bell [default]; option B<+vb>.
847		907
…		…
875	=item B<scrollstyle:> I<mode>	935	=item B<scrollstyle:> I<mode>
876		936
877	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	937	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
878	the author's favourite.	938	the author's favourite.
879		939
		940	=item B<thickness:> I<number>
		941
		942	Set the scrollbar width in pixels.
		943
880	=item B<scrollBar:> I<boolean>	944	=item B<scrollBar:> I<boolean>
881		945
882	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	946	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
883	disable the scrollbar; option B<+sb>.	947	disable the scrollbar; option B<+sb>.
884		948
…		…
903	B<False>: do not scroll to bottom when tty receives output; option	967	B<False>: do not scroll to bottom when tty receives output; option
904	B<+si>.	968	B<+si>.
905		969
906	=item B<scrollWithBuffer:> I<boolean>	970	=item B<scrollWithBuffer:> I<boolean>
907		971
908	B<True>: scroll with scrollback buffer when tty receives new lines (and	972	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
909	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	973	try to show the same lines) and B<scrollTtyOutput> is False; option
910	with scrollback buffer when tty receives new lines; option B<+sw>.	974	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		975	new lines; option B<+sw>.
911		976
912	=item B<scrollTtyKeypress:> I<boolean>	977	=item B<scrollTtyKeypress:> I<boolean>
913		978
914	B<True>: scroll to bottom when a non-special key is pressed. Special keys	979	B<True>: scroll to bottom when a non-special key is pressed. Special keys
915	are those which are intercepted by rxvt-unicode for special handling and	980	are those which are intercepted by rxvt-unicode for special handling and
…		…
971	=item B<cursorBlink:> I<boolean>	1036	=item B<cursorBlink:> I<boolean>
972		1037
973	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1038	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
974	option B<-bc>.	1039	option B<-bc>.
975		1040
		1041	=item B<cursorUnderline:> I<boolean>
		1042
		1043	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1044	option B<-uc>.
		1045
976	=item B<pointerBlank:> I<boolean>	1046	=item B<pointerBlank:> I<boolean>
977		1047
978	B<True>: blank the pointer when a key is pressed or after a set number	1048	B<True>: blank the pointer when a key is pressed or after a set number
979	of seconds of inactivity. B<False>: the pointer is always visible	1049	of seconds of inactivity. B<False>: the pointer is always visible
980	[default].	1050	[default].
…		…
993	large number (e.g. C<987654321>) to effectively disable the timeout.	1063	large number (e.g. C<987654321>) to effectively disable the timeout.
994		1064
995	=item B<backspacekey:> I<string>	1065	=item B<backspacekey:> I<string>
996		1066
997	The string to send when the backspace key is pressed. If set to B<DEC>	1067	The string to send when the backspace key is pressed. If set to B<DEC>
998	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1068	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
999	(code 8) - which can be reversed with the appropriate DEC private mode	1069	(code 8) - which can be reversed with the appropriate DEC private mode
1000	escape sequence.	1070	escape sequence.
1001		1071
1002	=item B<deletekey:> I<string>	1072	=item B<deletekey:> I<string>
1003		1073
…		…
1082		1152
1083	=item B<secondaryScroll:> I<boolean>	1153	=item B<secondaryScroll:> I<boolean>
1084		1154
1085	Turn on/off secondary screen scroll (default enabled). If this	1155	Turn on/off secondary screen scroll (default enabled). If this
1086	option is enabled, scrolls on the secondary screen will change the	1156	option is enabled, scrolls on the secondary screen will change the
1087	scrollback buffer and switching to/from the secondary screen will	1157	scrollback buffer and, when secondaryScreen is off, switching
1088	instead scroll the screen up.	1158	to/from the secondary screen will instead scroll the screen up.
1089		1159
1090	=item B<hold>: I<boolean>	1160	=item B<hold>: I<boolean>
1091		1161
1092	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1162	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1093	will not immediately destroy its window when the program executed within	1163	will not immediately destroy its window when the program executed within
1094	it exits. Instead, it will wait till it is being killed or closed by the	1164	it exits. Instead, it will wait till it is being killed or closed by the
1095	user.	1165	user.
		1166
		1167	=item B<chdir>: I<path>
		1168
		1169	Sets the working directory for the shell (or the command specified via
		1170	B<-e>). The I<path> must be an absolute path and it must exist for
		1171	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1172	directory will be used; option B<-cd>.
1096		1173
1097	=item B<keysym.>I<sym>: I<string>	1174	=item B<keysym.>I<sym>: I<string>
1098		1175
1099	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1176	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1100	intervening resource name B<keysym.> cannot be omitted.	1177	intervening resource name B<keysym.> cannot be omitted.
…		…
1115	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1192	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1116	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1193	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1117	performed in an exact manner; however, the closest match is assured.	1194	performed in an exact manner; however, the closest match is assured.
1118		1195
1119	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1196	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1120	number), see RESOURCES in C<man 7 X> for futher details.	1197	number), see RESOURCES in C<man 7 X> for further details.
1121		1198
1122	You can define a range of keysyms in one shot by providing a I<string>	1199	You can define a range of keysyms in one shot by
		1200	loading the C<keysym-list> perl extension and providing a I<string>
1123	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1201	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1124	should be a character not used by the strings.	1202	should be a character not used by the strings.
1125		1203
1126	Its usage can be demonstrated by an example:	1204	Its usage can be demonstrated by an example:
1127		1205
1128	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1206	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1129		1207
1130	The above line is equivalent to the following three lines:	1208	The above line is equivalent to the following three lines:
1131		1209
1132	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1210	URxvt.keysym.Meta-Control-0x61: \033<a>
1133	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1211	URxvt.keysym.Meta-Control-0x62: \033<b>
1134	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1212	URxvt.keysym.Meta-Control-0x63: \033<c>
1135		1213
1136	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1214	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1137	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1215	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1138	example the following means "change the current locale to C<zh_CN.GBK>	1216	example the following means "change the current locale to C<zh_CN.GBK>
1139	when Control-Meta-c is being pressed":	1217	when Control-Meta-c is being pressed":
1140		1218
1141	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1219	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1142		1220
1143	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1221	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1144	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1222	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1145	manpage. For example, the F<selection> extension (activated via	1223	manpage. For example, the F<selection> extension (activated via
1146	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1224	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1147		1225
1148	URxvt.keysym.M-C-c: perl:selection:rot13	1226	URxvt.keysym.M-C-c: perl:selection:rot13
1149		1227
1150	Due the the large number of modifier combinations, a defined key mapping	1228	Due the the large number of modifier combinations, a defined key mapping
1151	will match if at I<at least> the specified identifiers are being set, and	1229	will match if I<at least> the specified identifiers are being set, and
1152	no other key mappings with those and more bits are being defined. That	1230	no other key mappings with those and more bits are being defined. That
1153	means that defining a key map for C<a> will automatically provide	1231	means that defining a key map for C<a> will automatically provide
1154	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1232	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1155	mappings themselves.	1233	mappings themselves.
1156		1234
…		…
1207	all instances, while B<perl-ext> is used for specific instances.	1285	all instances, while B<perl-ext> is used for specific instances.
1208		1286
1209	=item B<perl-eval>: I<string>	1287	=item B<perl-eval>: I<string>
1210		1288
1211	Perl code to be evaluated when all extensions have been registered. See	1289	Perl code to be evaluated when all extensions have been registered. See
1212	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1290	the @@RXVT_NAME@@perl(3) manpage.
1213	will be ignored when running setuid/setgid.
1214		1291
1215	=item B<perl-lib>: I<path>	1292	=item B<perl-lib>: I<path>
1216		1293
1217	Colon-separated list of additional directories that hold extension	1294	Colon-separated list of additional directories that hold extension
1218	scripts. When looking for extensions specified by the C<perl> resource,	1295	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1219	@@RXVT_NAME@@ will first look in these directories and then in	1296	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1220	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1297	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1221	will be ignored when running setuid/setgid.
1222		1298
1223	See the @@RXVT_NAME@@perl(3) manpage.	1299	See the @@RXVT_NAME@@perl(3) manpage.
1224		1300
1225	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1301	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1226		1302
…		…
1248		1324
1249	=item B<override-redirect>: I<boolean>	1325	=item B<override-redirect>: I<boolean>
1250		1326
1251	Compile I<frills>: Sets override-redirect for the terminal window, making	1327	Compile I<frills>: Sets override-redirect for the terminal window, making
1252	it almost invisible to window managers; option B<-override-redirect>.	1328	it almost invisible to window managers; option B<-override-redirect>.
		1329
		1330	=item B<iso14755:> I<boolean>
		1331
		1332	Turn on/off ISO 14755 (default enabled).
1253		1333
1254	=item B<iso14755_52:> I<boolean>	1334	=item B<iso14755_52:> I<boolean>
1255		1335
1256	Turn on/off ISO 14755 5.2 mode (default enabled).	1336	Turn on/off ISO 14755 5.2 mode (default enabled).
1257		1337
…		…
1400	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1480	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1401	it can be seen via the I<who(1)> command, and can accept messages. To	1481	it can be seen via the I<who(1)> command, and can accept messages. To
1402	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1482	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1403	on some systems or setgid to root or to some other group on others.	1483	on some systems or setgid to root or to some other group on others.
1404		1484
1405	=head1 COLORS AND GRAPHICS	1485	=head1 COLOURS AND GRAPHICS
1406		1486
1407	In addition to the default foreground and background colours,	1487	In addition to the default foreground and background colours,
1408	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1488	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1409	high-intensity bold/blink versions of the same). Here is a list of the	1489	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1410	colours with their names.	1490	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1491	cube plus a 8 (24) colour greyscale ramp.
		1492
		1493	Here is a list of the ANSI colours with their names.
1411		1494
1412	=begin table	1495	=begin table
1413		1496
1414	B<color0> (black) = Black	1497	B<color0> (black) = Black
1415	B<color1> (red) = Red3	1498	B<color1> (red) = Red3
…		…
1435	It is also possible to specify the colour values of B<foreground>,	1518	It is also possible to specify the colour values of B<foreground>,
1436	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1519	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1437	a number 0-15, as a convenient shorthand to reference the colour name of	1520	a number 0-15, as a convenient shorthand to reference the colour name of
1438	color0-color15.	1521	color0-color15.
1439		1522
1440	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1523	The following text gives values for the standard 88 colour mode (and
1441	additional 72 colours. The first 64 of those (with indices 16 to 79)	1524	values for the 256 colour mode in parentheses).
1442	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1443	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1444		1525
		1526	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1527
		1528	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1529	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1530
		1531	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1532	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1533	the RGB cube.
		1534
1445	Together, all those colours implement the 88 colour xterm colours. Only	1535	Together, all those colours implement the 88 (256) colour xterm
1446	the first 16 can be changed using resources currently, the rest can only	1536	colours. Only the first 16 can be changed using resources currently, the
1447	be changed via command sequences ("escape codes").	1537	rest can only be changed via command sequences ("escape codes").
		1538
		1539	Applications are advised to use terminfo or command sequences to discover
		1540	number and RGB values of all colours (yes, you can query this...).
1448		1541
1449	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1542	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1450	always swapping the foreground/background colours. This is in contrast to	1543	always swapping the foreground/background colours. This is in contrast to
1451	I<xterm>(1) where the colours are only swapped if they have not otherwise	1544	I<xterm>(1) where the colours are only swapped if they have not otherwise
1452	been specified. For example,	1545	been specified. For example,
1453		1546
1454	=over 4
1455
1456	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1547	@@RXVT_NAME@@ -fg Black -bg White -rv
1457		1548
1458	would yield White on Black, while on I<xterm>(1) it would yield Black	1549	would yield White on Black, while on I<xterm>(1) it would yield Black on
1459	on White.	1550	White.
1460
1461	=back
1462		1551
1463	=head2 ALPHA CHANNEL SUPPORT	1552	=head2 ALPHA CHANNEL SUPPORT
1464		1553
1465	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1554	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1466	their act together, rxvt-unicode will do it's own alpha channel management:	1555	their act together, rxvt-unicode will do its own alpha channel management:
1467		1556
1468	You can prefix any color with an opaquenes percentage enclosed in	1557	You can prefix any colour with an opaqueness percentage enclosed in
1469	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage	1558	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1470	(0-100) that specifies the opacity of the color, where C<0> is completely	1559	(0-100) that specifies the opacity of the colour, where C<0> is completely
1471	transparent and C<100> is completely opaque. For example, C<[50]red> is a	1560	transparent and C<100> is completely opaque. For example, C<[50]red> is a
1472	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This	1561	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1473	is the recommended format to specify transparency values, and works with	1562	is the recommended format to specify transparency values, and works with
1474	all ways to specify a colour.	1563	all ways to specify a colour.
1475		1564
…		…
1546	C<--with-terminfo=PATH>.	1635	C<--with-terminfo=PATH>.
1547		1636
1548	=item B<DISPLAY>	1637	=item B<DISPLAY>
1549		1638
1550	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1639	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1551	display in its child processes.	1640	display in its child processes if C<-display> isn't used to override. It
		1641	defaults to C<:0> if it doesn't exist.
1552		1642
1553	=item B<SHELL>	1643	=item B<SHELL>
1554		1644
1555	The shell to be used for command execution, defaults to C</bin/sh>.	1645	The shell to be used for command execution, defaults to C</bin/sh>.
1556		1646
1557	=item B<RXVT_SOCKET>	1647	=item B<RXVT_SOCKET> [I<sic>]
1558		1648
1559	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1649	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1560	@@RXVT_NAME@@d(1).	1650	@@RXVT_NAME@@d(1).
1561		1651
1562	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1652	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1653
		1654	=item B<URXVT_PERL_LIB>
		1655
		1656	Additional F<:>-separated library search path for perl extensions. Will be
		1657	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1658	directory.
		1659
		1660	=item B<URXVT_PERL_VERBOSITY>
		1661
		1662	See L<@@RXVT_NAME@@perl>(3).
1563		1663
1564	=item B<HOME>	1664	=item B<HOME>
1565		1665
1566	Used to locate the default directory for the unix domain socket for	1666	Used to locate the default directory for the unix domain socket for
1567	daemon communications and to locate various resource files (such as	1667	daemon communications and to locate various resource files (such as
1568	C<.Xdefaults>)	1668	C<.Xdefaults>)
1569		1669
1570	=item B<XAPPLRESDIR>	1670	=item B<XAPPLRESDIR>
1571		1671
1572	Directory where various X resource files are being located.	1672	Directory where application-specific X resource files are located.
1573		1673
1574	=item B<XENVIRONMENT>	1674	=item B<XENVIRONMENT>
1575		1675
1576	If set and accessible, gives the name of a X resource file to be loaded by	1676	If set and accessible, gives the name of a X resource file to be loaded by
1577	@@RXVT_NAME@@.	1677	@@RXVT_NAME@@.
…		…
1582		1682
1583	=over 4	1683	=over 4
1584		1684
1585	=item B</usr/lib/X11/rgb.txt>	1685	=item B</usr/lib/X11/rgb.txt>
1586		1686
1587	Color names.	1687	Colour names.
1588		1688
1589	=back	1689	=back
1590		1690
1591	=head1 SEE ALSO	1691	=head1 SEE ALSO
1592		1692
		1693	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1593	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1694	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1594		1695
1595	=head1 CURRENT PROJECT COORDINATOR	1696	=head1 CURRENT PROJECT COORDINATOR
1596		1697
1597	=over 4	1698	=over 4
1598		1699
…		…
1643		1744
1644	Project Coordinator (Changes 1.0 -)	1745	Project Coordinator (Changes 1.0 -)
1645		1746
1646	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1747	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1647		1748
1648	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1749	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1649		1750
1650	=back	1751	=back
1651		1752

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.160 by root, Fri Jan 25 18:42:23 2008 UTC vs. Revision 1.220 by root, Fri Sep 21 23:31:43 2012 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.160 by root, Fri Jan 25 18:42:23 2008 UTC vs.
Revision 1.220 by root, Fri Sep 21 23:31:43 2012 UTC