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

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.213 by sf-exg, Sat Feb 4 21:47:06 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.213 by sf-exg, Sat Feb 4 21:47:06 2012 UTC