[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.202 by sf-exg, Thu Aug 11 08:37:17 2011 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<xft>: Attempt to find a visual with the given bit depth;
104	resource B<depth>.	104	resource B<depth>.
…		…
124		124
125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.	125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
126		126
127	=item B<-tr>\|B<+tr>	127	=item B<-tr>\|B<+tr>
128		128
129	Turn on/off illusion of a transparent window background; resource B<transparent>.	129	Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
130		130
131	B<-ip> is still accepted as an obsolete alias but will be removed in	131	B<-ip> is still accepted as an obsolete alias but will be removed in
132	future versions.	132	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		133
137	=item B<-fade> I<number>	134	=item B<-fade> I<number>
138		135
139	Fade the text by the given percentage when focus is lost. Small values	136	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	137	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	142	Fade to this colour when fading is used (see B<-fade>). The default colour
146	is opaque black. resource B<fadeColor>.	143	is opaque black. resource B<fadeColor>.
147		144
148	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
149		146
150	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
151	transparency is enabled with B<-tr>. This only works for	148	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		149
162	=item B<-sh> I<number>	150	=item B<-sh> I<number>
163		151
164	Darken (0 .. 100) or lighten (100 .. 200) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
165	background image in addition to (or instead of) tinting it;	153	A value of 100 means no shading; resource I<shading>.
166	resource I<shading>.
167		154
168	=item B<-blt> I<string>	155	=item B<-blt> I<string>
169		156
170	Specify background blending type. If background pixmap is specified	157	Specify background blending type. If background pixmap is specified
171	at the same time as transparency - such pixmap will be blended over	158	at the same time as transparency - such pixmap will be blended over
172	transparency image, using method specified. Supported values are :	159	the transparent background, using the method specified. Supported values are:
173	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,	160	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
174	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,	161	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	162	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176	alpha-blending. Compile I<afterimage>; resource I<blendType>.	163	alpha-blending. Compile I<afterimage>; resource I<blendType>.
177		164
178	=item B<-blr> I<HxV>	165	=item B<-blr> I<HxV>
179		166
180	Apply Gaussian Blur with the specified radii to the transparent	167	Apply Gaussian Blur with the specified radii to the transparent
181	background image. If single number is specified - both vertical and	168	background. If a single number is specified - both vertical and
182	horizontal radii are considered to be the same. Setting one of the	169	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	170	radii to 1 and another to a large number creates interesting effects
184	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;	171	on some backgrounds. Maximum radius value is 128;
185	resource I<blurRadius>.	172	resource I<blurRadius>.
186		173
		174	=item B<-icon> I<file>
		175
		176	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
		177	is used by many window managers, taskbars and pagers to represent the
		178	application window; resource I<iconFile>.
		179
187	=item B<-bg> I<colour>	180	=item B<-bg> I<colour>
188		181
189	Window background colour; resource B<background>.	182	Window background colour; resource B<background>.
190		183
191	=item B<-fg> I<colour>	184	=item B<-fg> I<colour>
192		185
193	Window foreground colour; resource B<foreground>.	186	Window foreground colour; resource B<foreground>.
194		187
195	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>	188	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
196		189
197	Compile I<afterimage>: Specify image file for the background and also	190	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
198	optionally specify its scaling with a geometry string. Note you may need to	191	optionally specify its scaling with a geometry string. Note you may need to
199	add quotes to avoid special shell interpretation of the C<;> in the	192	add quotes to avoid special shell interpretation of the C<;> in the
200	command-line; for more details see resource B<backgroundPixmap>.	193	command-line; for more details see resource B<backgroundPixmap>.
201		194
202	=item B<-cr> I<colour>	195	=item B<-cr> I<colour>
…		…
315		308
316	=item B<-bc>\|B<+bc>	309	=item B<-bc>\|B<+bc>
317		310
318	Blink the cursor; resource B<cursorBlink>.	311	Blink the cursor; resource B<cursorBlink>.
319		312
		313	=item B<-uc>\|B<+uc>
		314
		315	Make the cursor underlined; resource B<cursorUnderline>.
		316
320	=item B<-iconic>	317	=item B<-iconic>
321		318
322	Start iconified, if the window manager supports that option.	319	Start iconified, if the window manager supports that option.
323	Alternative form is B<-ic>.	320	Alternative form is B<-ic>.
324		321
…		…
340		337
341	=item B<-bl>	338	=item B<-bl>
342		339
343	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	340	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	341	if honoured by the WM, the rxvt-unicode window will not have window
345	decorations; resource B<borderLess>.	342	decorations; resource B<borderLess>. If the window manager does not
		343	support MWM hints (e.g. kwin), enables override-redirect mode.
346		344
347	=item B<-override-redirect>	345	=item B<-override-redirect>
348		346
349	Compile I<frills>: Sets override-redirect on the window; resource	347	Compile I<frills>: Sets override-redirect on the window; resource
350	B<override-redirect>.	348	B<override-redirect>.
…		…
359	=item B<-lsp> I<number>	357	=item B<-lsp> I<number>
360		358
361	Compile I<frills>: Lines (pixel height) to insert between each row of	359	Compile I<frills>: Lines (pixel height) to insert between each row of
362	the display. Useful to work around font rendering problems; resource	360	the display. Useful to work around font rendering problems; resource
363	B<lineSpace>.	361	B<lineSpace>.
		362
		363	=item B<-letsp> I<number>
		364
		365	Compile I<frills>: Amount to adjust the computed character width by
		366	to control overall letter spacing. Negative values will tighten up the
		367	letter spacing, positive values will space letters out more. Useful to
		368	work around odd font metrics; resource B<letterSpace>.
364		369
365	=item B<-tn> I<termname>	370	=item B<-tn> I<termname>
366		371
367	This option specifies the name of the terminal type to be set in the	372	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	373	B<TERM> environment variable. This terminal type must exist in the
…		…
455	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	460	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
456	will not immediately destroy its window when the program executed within	461	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	462	it exits. Instead, it will wait till it is being killed or closed by the
458	user; resource B<hold>.	463	user; resource B<hold>.
459		464
		465	=item B<-cd> I<path>
		466
		467	Sets the working directory for the shell (or the command specified via
		468	B<-e>). The I<path> must be an absolute path and it must exist for
		469	@@RXVT_NAME@@ to start; resource B<chdir>.
		470
460	=item B<-xrm> I<string>	471	=item B<-xrm> I<string>
461		472
462	Works like the X Toolkit option of the same name, by adding the I<string>	473	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	474	as if it were specified in a resource file. Resource values specified this
464	way take precedence over all other resource specifications.	475	way take precedence over all other resource specifications.
…		…
547	You can set and change the resources using X11 tools like B<xrdb>. Many	558	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	559	distribution do also load settings from the B<~/.Xresources> file when X
549	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	560	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
550	with later settings overwriting earlier ones:	561	with later settings overwriting earlier ones:
551		562
552	1. system-wide app-defaults file, either locale-dependent OR global
553	2. app-defaults file in $XAPPLRESDIR	563	1. app-defaults file in $XAPPLRESDIR
		564	2. $HOME/.Xdefaults
554	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	565	3. RESOURCE_MANAGER property on root-window of screen 0
555	4. SCREEN_RESOURCES for the current screen	566	4. SCREEN_RESOURCES property on root-window of the current screen
556	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	567	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
557	6. resources specified via -xrm on the commandline	568	6. resources specified via -xrm on the commandline
558		569
559	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	570	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	571	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
…		…
572	=item B<depth:> I<bitdepth>	583	=item B<depth:> I<bitdepth>
573		584
574	Compile I<xft>: Attempt to find a visual with the given bit depth;	585	Compile I<xft>: Attempt to find a visual with the given bit depth;
575	option B<-depth>.	586	option B<-depth>.
576		587
		588	=item B<buffered:> I<boolean>
		589
		590	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		591	On some card/driver combination enabling it slightly decreases
		592	performance, on most it greatly helps it. The slowdown is small, so it
		593	should normally be enabled.
		594
577	=item B<geometry:> I<geom>	595	=item B<geometry:> I<geom>
578		596
579	Create the window with the specified X window geometry [default 80x24];	597	Create the window with the specified X window geometry [default 80x24];
580	option B<-geometry>.	598	option B<-geometry>.
581		599
…		…
594	Use the specified colour for the colour value I<n>, where 0-7	612	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	613	corresponds to low-intensity (normal) colours and 8-15 corresponds to
596	high-intensity (bold = bright foreground, blink = bright background)	614	high-intensity (bold = bright foreground, blink = bright background)
597	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	615	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	616	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.	617	names used are listed in the B<COLOURS AND GRAPHICS> section.
600		618
601	Colours higher than 15 cannot be set using resources (yet), but can be	619	Colours higher than 15 cannot be set using resources (yet), but can be
602	changed using an escape command (see @@RXVT_NAME@@(7)).	620	changed using an escape command (see @@RXVT_NAME@@(7)).
603		621
604	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	622	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
615	=item B<colorUL:> I<colour>	633	=item B<colorUL:> I<colour>
616		634
617	Use the specified colour to display underlined characters when the	635	Use the specified colour to display underlined characters when the
618	foreground colour is the default.	636	foreground colour is the default.
619		637
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>	638	=item B<underlineColor:> I<colour>
626		639
627	If set, use the specified colour as the colour for the underline	640	If set, use the specified colour as the colour for the underline
628	itself. If unset, use the foreground colour.	641	itself. If unset, use the foreground colour.
		642
		643	=item B<highlightColor:> I<colour>
		644
		645	If set, use the specified colour as the background for highlighted
		646	characters. If unset, use reverse video.
		647
		648	=item B<highlightTextColor:> I<colour>
		649
		650	If set and highlightColor is set, use the specified colour as the
		651	foreground for highlighted characters.
629		652
630	=item B<cursorColor:> I<colour>	653	=item B<cursorColor:> I<colour>
631		654
632	Use the specified colour for the cursor. The default is to use the	655	Use the specified colour for the cursor. The default is to use the
633	foreground colour; option B<-cr>.	656	foreground colour; option B<-cr>.
…		…
640		663
641	=item B<reverseVideo:> I<boolean>	664	=item B<reverseVideo:> I<boolean>
642		665
643	B<True>: simulate reverse video by foreground and background colours;	666	B<True>: simulate reverse video by foreground and background colours;
644	option B<-rv>. B<False>: regular screen colours [default]; option	667	option B<-rv>. B<False>: regular screen colours [default]; option
645	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	668	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
646		669
647	=item B<jumpScroll:> I<boolean>	670	=item B<jumpScroll:> I<boolean>
648		671
649	B<True>: specify that jump scrolling should be used. When receiving lots	672	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	673	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	689	if the refresh is too fast for the human eye to read anything (or the
667	monitor to display anything); option B<+ss>.	690	monitor to display anything); option B<+ss>.
668		691
669	=item B<transparent:> I<boolean>	692	=item B<transparent:> I<boolean>
670		693
671	Turn on/off illusion of a transparent window background.	694	Turn on/off pseudo-transparency by using the root pixmap as background.
672		695
673	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in	696	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
674	future versions.	697	future versions.
675		698
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>	699	=item B<fading:> I<number>
680		700
681	Fade the text by the given percentage when focus is lost; option B<-fade>.	701	Fade the text by the given percentage when focus is lost; option B<-fade>.
682		702
683	=item B<fadeColor:> I<colour>	703	=item B<fadeColor:> I<colour>
…		…
685	Fade to this colour, when fading is used (see B<fading:>). The default	705	Fade to this colour, when fading is used (see B<fading:>). The default
686	colour is black; option B<-fadecolor>.	706	colour is black; option B<-fadecolor>.
687		707
688	=item B<tintColor:> I<colour>	708	=item B<tintColor:> I<colour>
689		709
690	Tint the transparent background pixmap with the given colour; option	710	Tint the transparent background with the given colour. If the RENDER
691	B<-tint>.	711	extension is not available only black, red, green, yellow, blue,
		712	magenta, cyan and white tints can be performed server-side. Note that
		713	a black tint yields a completely black image while a white tint yields
		714	the image unchanged; option B<-tint>.
692		715
693	=item B<shading:> I<number>	716	=item B<shading:> I<number>
694		717
695	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	718	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
696	in addition to tinting it; option B<-sh>.	719	A value of 100 means no shading; option B<-sh>.
697		720
698	=item B<blendType:> I<string>	721	=item B<blendType:> I<string>
699		722
700	Specify background blending type; option B<-blt>.	723	Specify background blending type; option B<-blt>.
701		724
702	=item B<blurRadius:> I<number>	725	=item B<blurRadius:> I<number>
703		726
704	Apply Gaussian Blurr with the specified radius to the transparent	727	Apply gaussian blur with the specified radius to the transparent
705	background image; option B<-blr>.	728	background; option B<-blr>.
		729
		730	=item B<iconFile:> I<file>
		731
		732	Set the application icon pixmap; option B<-icon>.
706		733
707	=item B<scrollColor:> I<colour>	734	=item B<scrollColor:> I<colour>
708		735
709	Use the specified colour for the scrollbar [default #B2B2B2].	736	Use the specified colour for the scrollbar [default #B2B2B2].
710		737
…		…
720		747
721	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	748	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
722		749
723	Use the specified image file for the background and also	750	Use the specified image file for the background and also
724	optionally specify its scaling with a geometry string B<WxH+X+Y>,	751	optionally specify its scaling with a geometry string B<WxH+X+Y>,
725	(default C<0x0+50+50>) in which B<"W" / "H"> specify the	752	(default C<100x100+50+50>) in which B<"W" / "H"> specify the
726	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image	753	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	754	centre (percent). A scale of 0 disables scaling.
728	of 1 displays the image without any scaling. A scale of 2 to 9 specifies	755	The maximum permitted scale is 1000.
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...>.	756	Additional operations can be specified after colon B<:op1:op2...>.
732	Supported operations are:	757	Supported operations are:
733		758
734	tile force background image to be tiled and not scaled. Equivalent to 0x0	759	op=tile enables tiling
735	propscale will scale image keeping proportions	760	op=pscale enables proportional scaling
736	auto will scale image to match window size. Equivalent to 100x100	761	op=root use the position of the terminal window relative to the root
737	hscale will scale image horizontally to the window size	762	window as the image offset, simulating a root window background
738	vscale will scale image vertically to the window size	763
739	scale will scale image to match window size	764	Alternatively, a predefined set of templates can be used to achieve
740	root will tile image as if it was a root window background, auto-adjusting	765	the most common setups:
741	whenever terminal window moves	766
		767	style=tiled the image is tiled with no scaling
		768	style=aspect-stretched the image is scaled to fill the whole window maintaining
		769	the aspect ratio and centered
		770	style=stretched the image is scaled to fill the whole window
		771	style=centered the image is centered with no scaling
		772	style=root-tiled the image is tiled with no scaling and using 'op=root' positioning
		773
		774	If multiple templates are specified the last one wins. Note that a
		775	template overrides all the scale, position and operations settings.
		776	Indeed, the templates can be specified in terms of low level settings
		777	as follows:
		778
		779	style=tiled 0x0+0+0:op=tile
		780	style=aspect-stretched +50+50:op=pscale
		781	style=stretched 100x100
		782	style=centered 0x0+50+50
		783	style=root-tiled 0x0:op=tile:op=root
742		784
743	If used in conjunction with B<-tr> option, the specified pixmap will be	785	If used in conjunction with B<-tr> option, the specified pixmap will be
744	blended over transparency image using either alpha-blending, or any	786	blended over the transparent background using alpha-blending. If I<afterimage>
745	other blending type, specified with B<-blt "type"> option.	787	support has been compiled in it is possible to choose other blending
		788	types with B<-blt "type"> option.
746		789
747	=item B<path:> I<path>	790	=item B<path:> I<path>
748		791
749	Specify the colon-delimited search path for finding background image files.	792	Specify the colon-delimited search path for finding background image files.
750		793
…		…
777	it is named first) and thus defines the character cell grid to be 9 pixels	820	it is named first) and thus defines the character cell grid to be 9 pixels
778	wide and 15 pixels high.	821	wide and 15 pixels high.
779		822
780	The second font is just used to add additional unicode characters not in	823	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	824	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	825	the bold version of the font does contain fewer characters, so this is a
783	useful supplement.	826	useful supplement.
784		827
785	The third font is an Xft font with aliasing turned off, and the characters	828	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	829	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.	830	contains other characters, but we are not interested in them.
…		…
838	=item B<urgentOnBell:> I<boolean>	881	=item B<urgentOnBell:> I<boolean>
839		882
840	B<True>: set the urgency hint for the wm on receipt of a bell character.	883	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].	884	B<False>: do not set the urgency hint [default].
842		885
		886	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		887
843	=item B<visualBell:> I<boolean>	888	=item B<visualBell:> I<boolean>
844		889
845	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	890	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
846	B<False>: no visual bell [default]; option B<+vb>.	891	B<False>: no visual bell [default]; option B<+vb>.
847		892
…		…
875	=item B<scrollstyle:> I<mode>	920	=item B<scrollstyle:> I<mode>
876		921
877	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	922	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
878	the author's favourite.	923	the author's favourite.
879		924
		925	=item B<thickness:> I<number>
		926
		927	Set the scrollbar width in pixels.
		928
880	=item B<scrollBar:> I<boolean>	929	=item B<scrollBar:> I<boolean>
881		930
882	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	931	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
883	disable the scrollbar; option B<+sb>.	932	disable the scrollbar; option B<+sb>.
884		933
…		…
903	B<False>: do not scroll to bottom when tty receives output; option	952	B<False>: do not scroll to bottom when tty receives output; option
904	B<+si>.	953	B<+si>.
905		954
906	=item B<scrollWithBuffer:> I<boolean>	955	=item B<scrollWithBuffer:> I<boolean>
907		956
908	B<True>: scroll with scrollback buffer when tty receives new lines (and	957	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	958	try to show the same lines) and B<scrollTtyOutput> is False; option
910	with scrollback buffer when tty receives new lines; option B<+sw>.	959	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		960	new lines; option B<+sw>.
911		961
912	=item B<scrollTtyKeypress:> I<boolean>	962	=item B<scrollTtyKeypress:> I<boolean>
913		963
914	B<True>: scroll to bottom when a non-special key is pressed. Special keys	964	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	965	are those which are intercepted by rxvt-unicode for special handling and
…		…
971	=item B<cursorBlink:> I<boolean>	1021	=item B<cursorBlink:> I<boolean>
972		1022
973	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1023	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
974	option B<-bc>.	1024	option B<-bc>.
975		1025
		1026	=item B<cursorUnderline:> I<boolean>
		1027
		1028	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1029	option B<-uc>.
		1030
976	=item B<pointerBlank:> I<boolean>	1031	=item B<pointerBlank:> I<boolean>
977		1032
978	B<True>: blank the pointer when a key is pressed or after a set number	1033	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	1034	of seconds of inactivity. B<False>: the pointer is always visible
980	[default].	1035	[default].
…		…
993	large number (e.g. C<987654321>) to effectively disable the timeout.	1048	large number (e.g. C<987654321>) to effectively disable the timeout.
994		1049
995	=item B<backspacekey:> I<string>	1050	=item B<backspacekey:> I<string>
996		1051
997	The string to send when the backspace key is pressed. If set to B<DEC>	1052	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>	1053	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	1054	(code 8) - which can be reversed with the appropriate DEC private mode
1000	escape sequence.	1055	escape sequence.
1001		1056
1002	=item B<deletekey:> I<string>	1057	=item B<deletekey:> I<string>
1003		1058
…		…
1082		1137
1083	=item B<secondaryScroll:> I<boolean>	1138	=item B<secondaryScroll:> I<boolean>
1084		1139
1085	Turn on/off secondary screen scroll (default enabled). If this	1140	Turn on/off secondary screen scroll (default enabled). If this
1086	option is enabled, scrolls on the secondary screen will change the	1141	option is enabled, scrolls on the secondary screen will change the
1087	scrollback buffer and switching to/from the secondary screen will	1142	scrollback buffer and, when secondaryScreen is off, switching
1088	instead scroll the screen up.	1143	to/from the secondary screen will instead scroll the screen up.
1089		1144
1090	=item B<hold>: I<boolean>	1145	=item B<hold>: I<boolean>
1091		1146
1092	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1147	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1093	will not immediately destroy its window when the program executed within	1148	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	1149	it exits. Instead, it will wait till it is being killed or closed by the
1095	user.	1150	user.
		1151
		1152	=item B<chdir>: I<path>
		1153
		1154	Sets the working directory for the shell (or the command specified via
		1155	B<-e>). The I<path> must be an absolute path and it must exist for
		1156	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1157	directory will be used; option B<-cd>.
1096		1158
1097	=item B<keysym.>I<sym>: I<string>	1159	=item B<keysym.>I<sym>: I<string>
1098		1160
1099	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1161	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1100	intervening resource name B<keysym.> cannot be omitted.	1162	intervening resource name B<keysym.> cannot be omitted.
…		…
1115	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1177	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	1178	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.	1179	performed in an exact manner; however, the closest match is assured.
1118		1180
1119	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1181	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1120	number), see RESOURCES in C<man 7 X> for futher details.	1182	number), see RESOURCES in C<man 7 X> for further details.
1121		1183
1122	You can define a range of keysyms in one shot by providing a I<string>	1184	You can define a range of keysyms in one shot by providing a I<string>
1123	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1185	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1124	should be a character not used by the strings.	1186	should be a character not used by the strings.
1125		1187
1126	Its usage can be demonstrated by an example:	1188	Its usage can be demonstrated by an example:
1127		1189
1128	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1190	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1129		1191
1130	The above line is equivalent to the following three lines:	1192	The above line is equivalent to the following three lines:
1131		1193
1132	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1194	URxvt.keysym.Meta-Control-0x61: \033<a>
1133	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1195	URxvt.keysym.Meta-Control-0x62: \033<b>
1134	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1196	URxvt.keysym.Meta-Control-0x63: \033<c>
1135		1197
1136	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1198	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	1199	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>	1200	example the following means "change the current locale to C<zh_CN.GBK>
1139	when Control-Meta-c is being pressed":	1201	when Control-Meta-c is being pressed":
1140		1202
1141	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1203	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1142		1204
1143	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1205	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)	1206	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	1207	manpage. For example, the F<selection> extension (activated via
1146	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1208	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1147		1209
1148	URxvt.keysym.M-C-c: perl:selection:rot13	1210	URxvt.keysym.M-C-c: perl:selection:rot13
1149		1211
1150	Due the the large number of modifier combinations, a defined key mapping	1212	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	1213	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	1214	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	1215	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	1216	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1155	mappings themselves.	1217	mappings themselves.
1156		1218
…		…
1207	all instances, while B<perl-ext> is used for specific instances.	1269	all instances, while B<perl-ext> is used for specific instances.
1208		1270
1209	=item B<perl-eval>: I<string>	1271	=item B<perl-eval>: I<string>
1210		1272
1211	Perl code to be evaluated when all extensions have been registered. See	1273	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	1274	the @@RXVT_NAME@@perl(3) manpage.
1213	will be ignored when running setuid/setgid.
1214		1275
1215	=item B<perl-lib>: I<path>	1276	=item B<perl-lib>: I<path>
1216		1277
1217	Colon-separated list of additional directories that hold extension	1278	Colon-separated list of additional directories that hold extension
1218	scripts. When looking for extensions specified by the C<perl> resource,	1279	scripts. When looking for extensions specified by the C<perl> resource,
1219	@@RXVT_NAME@@ will first look in these directories and then in	1280	@@RXVT_NAME@@ will first look in these directories and then in
1220	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1281	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1221	will be ignored when running setuid/setgid.
1222		1282
1223	See the @@RXVT_NAME@@perl(3) manpage.	1283	See the @@RXVT_NAME@@perl(3) manpage.
1224		1284
1225	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1285	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1226		1286
…		…
1248		1308
1249	=item B<override-redirect>: I<boolean>	1309	=item B<override-redirect>: I<boolean>
1250		1310
1251	Compile I<frills>: Sets override-redirect for the terminal window, making	1311	Compile I<frills>: Sets override-redirect for the terminal window, making
1252	it almost invisible to window managers; option B<-override-redirect>.	1312	it almost invisible to window managers; option B<-override-redirect>.
		1313
		1314	=item B<iso14755:> I<boolean>
		1315
		1316	Turn on/off ISO 14755 (default enabled).
1253		1317
1254	=item B<iso14755_52:> I<boolean>	1318	=item B<iso14755_52:> I<boolean>
1255		1319
1256	Turn on/off ISO 14755 5.2 mode (default enabled).	1320	Turn on/off ISO 14755 5.2 mode (default enabled).
1257		1321
…		…
1400	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1464	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	1465	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	1466	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.	1467	on some systems or setgid to root or to some other group on others.
1404		1468
1405	=head1 COLORS AND GRAPHICS	1469	=head1 COLOURS AND GRAPHICS
1406		1470
1407	In addition to the default foreground and background colours,	1471	In addition to the default foreground and background colours,
1408	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1472	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	1473	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1410	colours with their names.	1474	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1475	cube plus a 8 (24) colour greyscale ramp.
		1476
		1477	Here is a list of the ANSI colours with their names.
1411		1478
1412	=begin table	1479	=begin table
1413		1480
1414	B<color0> (black) = Black	1481	B<color0> (black) = Black
1415	B<color1> (red) = Red3	1482	B<color1> (red) = Red3
…		…
1435	It is also possible to specify the colour values of B<foreground>,	1502	It is also possible to specify the colour values of B<foreground>,
1436	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1503	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	1504	a number 0-15, as a convenient shorthand to reference the colour name of
1438	color0-color15.	1505	color0-color15.
1439		1506
1440	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1507	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)	1508	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		1509
		1510	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1511
		1512	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1513	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1514
		1515	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1516	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1517	the RGB cube.
		1518
1445	Together, all those colours implement the 88 colour xterm colours. Only	1519	Together, all those colours implement the 88 (256) colour xterm
1446	the first 16 can be changed using resources currently, the rest can only	1520	colours. Only the first 16 can be changed using resources currently, the
1447	be changed via command sequences ("escape codes").	1521	rest can only be changed via command sequences ("escape codes").
		1522
		1523	Applications are advised to use terminfo or command sequences to discover
		1524	number and RGB values of all colours (yes, you can query this...).
1448		1525
1449	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1526	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1450	always swapping the foreground/background colours. This is in contrast to	1527	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	1528	I<xterm>(1) where the colours are only swapped if they have not otherwise
1452	been specified. For example,	1529	been specified. For example,
1453		1530
1454	=over 4
1455
1456	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1531	@@RXVT_NAME@@ -fg Black -bg White -rv
1457		1532
1458	would yield White on Black, while on I<xterm>(1) it would yield Black	1533	would yield White on Black, while on I<xterm>(1) it would yield Black on
1459	on White.	1534	White.
1460
1461	=back
1462		1535
1463	=head2 ALPHA CHANNEL SUPPORT	1536	=head2 ALPHA CHANNEL SUPPORT
1464		1537
1465	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1538	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:	1539	their act together, rxvt-unicode will do it's own alpha channel management:
1467		1540
1468	You can prefix any color with an opaquenes percentage enclosed in	1541	You can prefix any colour with an opaqueness percentage enclosed in
1469	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage	1542	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	1543	(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	1544	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	1545	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	1546	is the recommended format to specify transparency values, and works with
1474	all ways to specify a colour.	1547	all ways to specify a colour.
1475		1548
…		…
1546	C<--with-terminfo=PATH>.	1619	C<--with-terminfo=PATH>.
1547		1620
1548	=item B<DISPLAY>	1621	=item B<DISPLAY>
1549		1622
1550	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1623	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1551	display in its child processes.	1624	display in its child processes if C<-display> isn't used to override. It
		1625	defaults to C<:0> if it doesn't exist.
1552		1626
1553	=item B<SHELL>	1627	=item B<SHELL>
1554		1628
1555	The shell to be used for command execution, defaults to C</bin/sh>.	1629	The shell to be used for command execution, defaults to C</bin/sh>.
1556		1630
1557	=item B<RXVT_SOCKET>	1631	=item B<RXVT_SOCKET>
1558		1632
1559	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1633	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1560	@@RXVT_NAME@@d(1).	1634	@@RXVT_NAME@@d(1).
1561		1635
1562	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1636	Default F<<< $HOME/.rxvt-unicode-I<< <nodename> >> >>>.
1563		1637
1564	=item B<HOME>	1638	=item B<HOME>
1565		1639
1566	Used to locate the default directory for the unix domain socket for	1640	Used to locate the default directory for the unix domain socket for
1567	daemon communications and to locate various resource files (such as	1641	daemon communications and to locate various resource files (such as
1568	C<.Xdefaults>)	1642	C<.Xdefaults>)
1569		1643
1570	=item B<XAPPLRESDIR>	1644	=item B<XAPPLRESDIR>
1571		1645
1572	Directory where various X resource files are being located.	1646	Directory where application-specific X resource files are located.
1573		1647
1574	=item B<XENVIRONMENT>	1648	=item B<XENVIRONMENT>
1575		1649
1576	If set and accessible, gives the name of a X resource file to be loaded by	1650	If set and accessible, gives the name of a X resource file to be loaded by
1577	@@RXVT_NAME@@.	1651	@@RXVT_NAME@@.
…		…
1582		1656
1583	=over 4	1657	=over 4
1584		1658
1585	=item B</usr/lib/X11/rgb.txt>	1659	=item B</usr/lib/X11/rgb.txt>
1586		1660
1587	Color names.	1661	Colour names.
1588		1662
1589	=back	1663	=back
1590		1664
1591	=head1 SEE ALSO	1665	=head1 SEE ALSO
1592		1666
…		…
1643		1717
1644	Project Coordinator (Changes 1.0 -)	1718	Project Coordinator (Changes 1.0 -)
1645		1719
1646	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1720	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1647		1721
1648	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1722	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1649		1723
1650	=back	1724	=back
1651		1725

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.202 by sf-exg, Thu Aug 11 08:37:17 2011 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.202 by sf-exg, Thu Aug 11 08:37:17 2011 UTC