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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.158 by root, Wed Jan 23 14:33:42 2008 UTC vs.
Revision 1.214 by sf-exg, Sun May 13 21:34:29 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>.
105		105
		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
		108	of graphical corruption. This is harmless, but we can't do anything about
		109	this, so watch out]
		110
106	=item B<-geometry> I<geom>	111	=item B<-geometry> I<geom>
107		112
108	Window geometry (B<-g> still respected); resource B<geometry>.	113	Window geometry (B<-g> still respected); resource B<geometry>.
109		114
110	=item B<-rv>\|B<+rv>	115	=item B<-rv>\|B<+rv>
…		…
119		124
120	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>.
121		126
122	=item B<-tr>\|B<+tr>	127	=item B<-tr>\|B<+tr>
123		128
124	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>.
125		130
126	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
127	future versions.	132	future versions.
128
129	I<Please address all transparency related issues to Sasha Vasko at
130	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
131		133
132	=item B<-fade> I<number>	134	=item B<-fade> I<number>
133		135
134	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
135	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
…		…
140	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
141	is opaque black. resource B<fadeColor>.	143	is opaque black. resource B<fadeColor>.
142		144
143	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
144		146
145	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
146	transparency is enabled with B<-tr>. This only works for	148	resource I<tintColor>.
147	non-tiled backgrounds, currently. See also the B<-sh> option that can be
148	used to brighten or darken the image in addition to tinting it.
149	Please note that certain tint colours can be applied on the server-side,
150	thus yielding performance gain of two orders of magnitude. These colours are:
151	blue, red, green, cyan, magenta, yellow, and those close to them. Also
152	pure black and pure white colors essentially mean no tinting; resource
153	I<tintColor>. Example:
154
155	@@RXVT_NAME@@ -tr -tint blue -sh 40
156		149
157	=item B<-sh> I<number>	150	=item B<-sh> I<number>
158		151
159	Darken (0 .. 100) or lighten (100 .. 200) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
160	background image in addition to (or instead of) tinting it;	153	A value of 100 means no shading; resource I<shading>.
161	resource I<shading>.
162
163	=item B<-blt> I<string>
164
165	Specify background blending type. If background pixmap is specified
166	at the same time as transparency - such pixmap will be blended over
167	transparency image, using method specified. Supported values are :
168	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
169	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
170	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
171	alpha-blending. Compile I<afterimage>; resource I<blendType>.
172		154
173	=item B<-blr> I<HxV>	155	=item B<-blr> I<HxV>
174		156
175	Apply Gaussian Blur with the specified radii to the transparent	157	Apply Gaussian Blur with the specified radii to the transparent
176	background image. If single number is specified - both vertical and	158	background. If a single number is specified, the vertical and
177	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
178	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
179	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;
180	resource I<blurRadius>.	163	resource I<blurRadius>.
181		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
182	=item B<-bg> I<colour>	171	=item B<-bg> I<colour>
183		172
184	Window background colour; resource B<background>.	173	Window background colour; resource B<background>.
185		174
186	=item B<-fg> I<colour>	175	=item B<-fg> I<colour>
187		176
188	Window foreground colour; resource B<foreground>.	177	Window foreground colour; resource B<foreground>.
189		178
190	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>	179	=item B<-pixmap> I<file[;oplist]>
191		180
192	Compile I<afterimage>: Specify image file for the background and also	181	Compile I<pixbuf>: Specify image file for the background and also
193	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
194	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
195	command-line; for more details see resource B<backgroundPixmap>.	184	command-line; for more details see resource B<backgroundPixmap>.
196		185
197	=item B<-cr> I<colour>	186	=item B<-cr> I<colour>
198		187
…		…
310		299
311	=item B<-bc>\|B<+bc>	300	=item B<-bc>\|B<+bc>
312		301
313	Blink the cursor; resource B<cursorBlink>.	302	Blink the cursor; resource B<cursorBlink>.
314		303
		304	=item B<-uc>\|B<+uc>
		305
		306	Make the cursor underlined; resource B<cursorUnderline>.
		307
315	=item B<-iconic>	308	=item B<-iconic>
316		309
317	Start iconified, if the window manager supports that option.	310	Start iconified, if the window manager supports that option.
318	Alternative form is B<-ic>.	311	Alternative form is B<-ic>.
319		312
…		…
335		328
336	=item B<-bl>	329	=item B<-bl>
337		330
338	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.
339	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
340	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.
341		335
342	=item B<-override-redirect>	336	=item B<-override-redirect>
343		337
344	Compile I<frills>: Sets override-redirect on the window; resource	338	Compile I<frills>: Sets override-redirect on the window; resource
345	B<override-redirect>.	339	B<override-redirect>.
…		…
354	=item B<-lsp> I<number>	348	=item B<-lsp> I<number>
355		349
356	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
357	the display. Useful to work around font rendering problems; resource	351	the display. Useful to work around font rendering problems; resource
358	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>.
359		360
360	=item B<-tn> I<termname>	361	=item B<-tn> I<termname>
361		362
362	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
363	B<TERM> environment variable. This terminal type must exist in the	364	B<TERM> environment variable. This terminal type must exist in the
…		…
450	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@@
451	will not immediately destroy its window when the program executed within	452	will not immediately destroy its window when the program executed within
452	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
453	user; resource B<hold>.	454	user; resource B<hold>.
454		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
455	=item B<-xrm> I<string>	462	=item B<-xrm> I<string>
456		463
457	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>
458	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
459	way take precedence over all other resource specifications.	466	way take precedence over all other resource specifications.
…		…
542	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
543	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
544	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	551	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
545	with later settings overwriting earlier ones:	552	with later settings overwriting earlier ones:
546		553
547	1. system-wide app-defaults file, either locale-dependent OR global
548	2. app-defaults file in $XAPPLRESDIR	554	1. app-defaults file in $XAPPLRESDIR
		555	2. $HOME/.Xdefaults
549	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	556	3. RESOURCE_MANAGER property on root-window of screen 0
550	4. SCREEN_RESOURCES for the current screen	557	4. SCREEN_RESOURCES property on root-window of the current screen
551	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	558	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
552	6. resources specified via -xrm on the commandline	559	6. resources specified via -xrm on the commandline
553		560
554	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
555	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
…		…
567	=item B<depth:> I<bitdepth>	574	=item B<depth:> I<bitdepth>
568		575
569	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;
570	option B<-depth>.	577	option B<-depth>.
571		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
572	=item B<geometry:> I<geom>	586	=item B<geometry:> I<geom>
573		587
574	Create the window with the specified X window geometry [default 80x24];	588	Create the window with the specified X window geometry [default 80x24];
575	option B<-geometry>.	589	option B<-geometry>.
576		590
…		…
589	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
590	corresponds to low-intensity (normal) colours and 8-15 corresponds to	604	corresponds to low-intensity (normal) colours and 8-15 corresponds to
591	high-intensity (bold = bright foreground, blink = bright background)	605	high-intensity (bold = bright foreground, blink = bright background)
592	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,
593	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
594	names used are listed in the B<COLORS AND GRAPHICS> section.	608	names used are listed in the B<COLOURS AND GRAPHICS> section.
595		609
596	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
597	changed using an escape command (see @@RXVT_NAME@@(7)).	611	changed using an escape command (see @@RXVT_NAME@@(7)).
598		612
599	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
…		…
610	=item B<colorUL:> I<colour>	624	=item B<colorUL:> I<colour>
611		625
612	Use the specified colour to display underlined characters when the	626	Use the specified colour to display underlined characters when the
613	foreground colour is the default.	627	foreground colour is the default.
614		628
615	=item B<colorRV:> I<colour>
616
617	Use the specified colour as the background for reverse video characters
618	when OPTION_HC is disabled (--disable-frills).
619
620	=item B<underlineColor:> I<colour>	629	=item B<underlineColor:> I<colour>
621		630
622	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
623	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.
624		643
625	=item B<cursorColor:> I<colour>	644	=item B<cursorColor:> I<colour>
626		645
627	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
628	foreground colour; option B<-cr>.	647	foreground colour; option B<-cr>.
…		…
635		654
636	=item B<reverseVideo:> I<boolean>	655	=item B<reverseVideo:> I<boolean>
637		656
638	B<True>: simulate reverse video by foreground and background colours;	657	B<True>: simulate reverse video by foreground and background colours;
639	option B<-rv>. B<False>: regular screen colours [default]; option	658	option B<-rv>. B<False>: regular screen colours [default]; option
640	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	659	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
641		660
642	=item B<jumpScroll:> I<boolean>	661	=item B<jumpScroll:> I<boolean>
643		662
644	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
645	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
…		…
661	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
662	monitor to display anything); option B<+ss>.	681	monitor to display anything); option B<+ss>.
663		682
664	=item B<transparent:> I<boolean>	683	=item B<transparent:> I<boolean>
665		684
666	Turn on/off illusion of a transparent window background.	685	Turn on/off pseudo-transparency by using the root pixmap as background.
667		686
668	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
669	future versions.	688	future versions.
670		689
671	I<Please address all transparency related issues to Sasha Vasko at
672	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
673
674	=item B<fading:> I<number>	690	=item B<fading:> I<number>
675		691
676	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>.
677		693
678	=item B<fadeColor:> I<colour>	694	=item B<fadeColor:> I<colour>
…		…
680	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
681	colour is black; option B<-fadecolor>.	697	colour is black; option B<-fadecolor>.
682		698
683	=item B<tintColor:> I<colour>	699	=item B<tintColor:> I<colour>
684		700
685	Tint the transparent background pixmap with the given colour; option	701	Tint the transparent background with the given colour. If the RENDER
686	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>.
687		706
688	=item B<shading:> I<number>	707	=item B<shading:> I<number>
689		708
690	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	709	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
691	in addition to tinting it; option B<-sh>.	710	A value of 100 means no shading; option B<-sh>.
692
693	=item B<blendType:> I<string>
694
695	Specify background blending type; option B<-blt>.
696		711
697	=item B<blurRadius:> I<number>	712	=item B<blurRadius:> I<number>
698		713
699	Apply Gaussian Blurr with the specified radius to the transparent	714	Apply gaussian blur with the specified radius to the transparent
700	background image; option B<-blr>.	715	background; option B<-blr>.
		716
		717	=item B<iconFile:> I<file>
		718
		719	Set the application icon pixmap; option B<-icon>.
701		720
702	=item B<scrollColor:> I<colour>	721	=item B<scrollColor:> I<colour>
703		722
704	Use the specified colour for the scrollbar [default #B2B2B2].	723	Use the specified colour for the scrollbar [default #B2B2B2].
705		724
…		…
711	=item B<borderColor:> I<colour>	730	=item B<borderColor:> I<colour>
712		731
713	The colour of the border around the text area and between the scrollbar	732	The colour of the border around the text area and between the scrollbar
714	and the text.	733	and the text.
715		734
716	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	735	=item B<backgroundPixmap:> I<file[;oplist]>
717		736
718	Use the specified image file for the background and also	737	Use the specified image file for the background and also
719	optionally specify its scaling with a geometry string B<WxH+X+Y>,	738	optionally specify a colon separated list of operations to modify it.
720	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
721	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
722	centre (percent). A scale of 0 displays the image with tiling. A scale
723	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
724	an integer number of images in that direction. No image will be magnified
725	beyond 10 times its original size. The maximum permitted scale is 1000.
726	Additional operations can be specified after colon B<:op1:op2...>.
727	Supported operations are:	739	Supported operations are:
728		740
729	tile force background image to be tiled and not scaled. Equivalent to 0x0	741	=over 4
730	propscale will scale image keeping proportions	742
731	auto will scale image to match window size. Equivalent to 100x100	743	=item B<WxH+X+Y>
732	hscale will scale image horizontally to the window size	744
733	vscale will scale image vertically to the window size	745	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
734	scale will scale image to match window size	746	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
735	root will tile image as if it was a root window background, auto-adjusting	747	scale of 0 disables scaling. The maximum permitted scale is 1000.
736	whenever terminal window moves	748
		749	=item B<op=tile>
		750
		751	enables tiling
		752
		753	=item B<op=keep-aspect>
		754
		755	maintain the image aspect ratio when scaling
		756
		757	=item B<op=root-align>
		758
		759	use the position of the terminal window relative to the root window as
		760	the image offset, simulating a root window background
		761
		762	=back
		763
		764	The default scale and position setting is C<100x100+50+50>.
		765	Alternatively, a predefined set of templates can be used to achieve
		766	the most common setups:
		767
		768	=over 4
		769
		770	=item B<style=tiled>
		771
		772	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		773
		774	=item B<style=aspect-stretched>
		775
		776	the image is scaled to fill the whole window maintaining the aspect
		777	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		778
		779	=item B<style=stretched>
		780
		781	the image is scaled to fill the whole window. Equivalent to 100x100
		782
		783	=item B<style=centered>
		784
		785	the image is centered with no scaling. Equivalent to 0x0+50+50
		786
		787	=item B<style=root-tiled>
		788
		789	the image is tiled with no scaling and using 'root' positioning.
		790	Equivalent to 0x0:op=tile:op=root-align
		791
		792	=back
		793
		794	If multiple templates are specified the last one wins. Note that a
		795	template overrides all the scale, position and operations settings.
737		796
738	If used in conjunction with B<-tr> option, the specified pixmap will be	797	If used in conjunction with B<-tr> option, the specified pixmap will be
739	blended over transparency image using either alpha-blending, or any	798	blended over the transparent background using alpha-blending.
740	other blending type, specified with B<-blt "type"> option.
741		799
742	=item B<path:> I<path>	800	=item B<path:> I<path>
743		801
744	Specify the colon-delimited search path for finding background image files.	802	Specify the colon-delimited search path for finding background image files.
745		803
…		…
772	it is named first) and thus defines the character cell grid to be 9 pixels	830	it is named first) and thus defines the character cell grid to be 9 pixels
773	wide and 15 pixels high.	831	wide and 15 pixels high.
774		832
775	The second font is just used to add additional unicode characters not in	833	The second font is just used to add additional unicode characters not in
776	the base font, likewise the third, which is unfortunately non-bold, but	834	the base font, likewise the third, which is unfortunately non-bold, but
777	the bold version of the font does contain less characters, so this is a	835	the bold version of the font does contain fewer characters, so this is a
778	useful supplement.	836	useful supplement.
779		837
780	The third font is an Xft font with aliasing turned off, and the characters	838	The third font is an Xft font with aliasing turned off, and the characters
781	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	839	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
782	contains other characters, but we are not interested in them.	840	contains other characters, but we are not interested in them.
…		…
833	=item B<urgentOnBell:> I<boolean>	891	=item B<urgentOnBell:> I<boolean>
834		892
835	B<True>: set the urgency hint for the wm on receipt of a bell character.	893	B<True>: set the urgency hint for the wm on receipt of a bell character.
836	B<False>: do not set the urgency hint [default].	894	B<False>: do not set the urgency hint [default].
837		895
		896	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		897
838	=item B<visualBell:> I<boolean>	898	=item B<visualBell:> I<boolean>
839		899
840	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	900	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
841	B<False>: no visual bell [default]; option B<+vb>.	901	B<False>: no visual bell [default]; option B<+vb>.
842		902
…		…
870	=item B<scrollstyle:> I<mode>	930	=item B<scrollstyle:> I<mode>
871		931
872	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	932	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
873	the author's favourite.	933	the author's favourite.
874		934
		935	=item B<thickness:> I<number>
		936
		937	Set the scrollbar width in pixels.
		938
875	=item B<scrollBar:> I<boolean>	939	=item B<scrollBar:> I<boolean>
876		940
877	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	941	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
878	disable the scrollbar; option B<+sb>.	942	disable the scrollbar; option B<+sb>.
879		943
…		…
898	B<False>: do not scroll to bottom when tty receives output; option	962	B<False>: do not scroll to bottom when tty receives output; option
899	B<+si>.	963	B<+si>.
900		964
901	=item B<scrollWithBuffer:> I<boolean>	965	=item B<scrollWithBuffer:> I<boolean>
902		966
903	B<True>: scroll with scrollback buffer when tty receives new lines (and	967	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
904	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	968	try to show the same lines) and B<scrollTtyOutput> is False; option
905	with scrollback buffer when tty receives new lines; option B<+sw>.	969	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		970	new lines; option B<+sw>.
906		971
907	=item B<scrollTtyKeypress:> I<boolean>	972	=item B<scrollTtyKeypress:> I<boolean>
908		973
909	B<True>: scroll to bottom when a non-special key is pressed. Special keys	974	B<True>: scroll to bottom when a non-special key is pressed. Special keys
910	are those which are intercepted by rxvt-unicode for special handling and	975	are those which are intercepted by rxvt-unicode for special handling and
…		…
966	=item B<cursorBlink:> I<boolean>	1031	=item B<cursorBlink:> I<boolean>
967		1032
968	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1033	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
969	option B<-bc>.	1034	option B<-bc>.
970		1035
		1036	=item B<cursorUnderline:> I<boolean>
		1037
		1038	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1039	option B<-uc>.
		1040
971	=item B<pointerBlank:> I<boolean>	1041	=item B<pointerBlank:> I<boolean>
972		1042
973	B<True>: blank the pointer when a key is pressed or after a set number	1043	B<True>: blank the pointer when a key is pressed or after a set number
974	of seconds of inactivity. B<False>: the pointer is always visible	1044	of seconds of inactivity. B<False>: the pointer is always visible
975	[default].	1045	[default].
…		…
988	large number (e.g. C<987654321>) to effectively disable the timeout.	1058	large number (e.g. C<987654321>) to effectively disable the timeout.
989		1059
990	=item B<backspacekey:> I<string>	1060	=item B<backspacekey:> I<string>
991		1061
992	The string to send when the backspace key is pressed. If set to B<DEC>	1062	The string to send when the backspace key is pressed. If set to B<DEC>
993	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1063	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
994	(code 8) - which can be reversed with the appropriate DEC private mode	1064	(code 8) - which can be reversed with the appropriate DEC private mode
995	escape sequence.	1065	escape sequence.
996		1066
997	=item B<deletekey:> I<string>	1067	=item B<deletekey:> I<string>
998		1068
…		…
1077		1147
1078	=item B<secondaryScroll:> I<boolean>	1148	=item B<secondaryScroll:> I<boolean>
1079		1149
1080	Turn on/off secondary screen scroll (default enabled). If this	1150	Turn on/off secondary screen scroll (default enabled). If this
1081	option is enabled, scrolls on the secondary screen will change the	1151	option is enabled, scrolls on the secondary screen will change the
1082	scrollback buffer and switching to/from the secondary screen will	1152	scrollback buffer and, when secondaryScreen is off, switching
1083	instead scroll the screen up.	1153	to/from the secondary screen will instead scroll the screen up.
1084		1154
1085	=item B<hold>: I<boolean>	1155	=item B<hold>: I<boolean>
1086		1156
1087	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1157	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1088	will not immediately destroy its window when the program executed within	1158	will not immediately destroy its window when the program executed within
1089	it exits. Instead, it will wait till it is being killed or closed by the	1159	it exits. Instead, it will wait till it is being killed or closed by the
1090	user.	1160	user.
		1161
		1162	=item B<chdir>: I<path>
		1163
		1164	Sets the working directory for the shell (or the command specified via
		1165	B<-e>). The I<path> must be an absolute path and it must exist for
		1166	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1167	directory will be used; option B<-cd>.
1091		1168
1092	=item B<keysym.>I<sym>: I<string>	1169	=item B<keysym.>I<sym>: I<string>
1093		1170
1094	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1171	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1095	intervening resource name B<keysym.> cannot be omitted.	1172	intervening resource name B<keysym.> cannot be omitted.
…		…
1110	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1187	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1111	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1188	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1112	performed in an exact manner; however, the closest match is assured.	1189	performed in an exact manner; however, the closest match is assured.
1113		1190
1114	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1191	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1115	number), see RESOURCES in C<man 7 X> for futher details.	1192	number), see RESOURCES in C<man 7 X> for further details.
1116		1193
1117	You can define a range of keysyms in one shot by providing a I<string>	1194	You can define a range of keysyms in one shot by
		1195	loading the C<keysym-list> perl extension and providing a I<string>
1118	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1196	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1119	should be a character not used by the strings.	1197	should be a character not used by the strings.
1120		1198
1121	Its usage can be demonstrated by an example:	1199	Its usage can be demonstrated by an example:
1122		1200
1123	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1201	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1124		1202
1125	The above line is equivalent to the following three lines:	1203	The above line is equivalent to the following three lines:
1126		1204
1127	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1205	URxvt.keysym.Meta-Control-0x61: \033<a>
1128	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1206	URxvt.keysym.Meta-Control-0x62: \033<b>
1129	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1207	URxvt.keysym.Meta-Control-0x63: \033<c>
1130		1208
1131	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1209	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1132	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1210	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1133	example the following means "change the current locale to C<zh_CN.GBK>	1211	example the following means "change the current locale to C<zh_CN.GBK>
1134	when Control-Meta-c is being pressed":	1212	when Control-Meta-c is being pressed":
1135		1213
1136	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1214	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1137		1215
1138	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1216	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1139	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1217	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1140	manpage. For example, the F<selection> extension (activated via	1218	manpage. For example, the F<selection> extension (activated via
1141	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1219	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1142		1220
1143	URxvt.keysym.M-C-c: perl:selection:rot13	1221	URxvt.keysym.M-C-c: perl:selection:rot13
1144		1222
1145	Due the the large number of modifier combinations, a defined key mapping	1223	Due the the large number of modifier combinations, a defined key mapping
1146	will match if at I<at least> the specified identifiers are being set, and	1224	will match if I<at least> the specified identifiers are being set, and
1147	no other key mappings with those and more bits are being defined. That	1225	no other key mappings with those and more bits are being defined. That
1148	means that defining a key map for C<a> will automatically provide	1226	means that defining a key map for C<a> will automatically provide
1149	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1227	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1150	mappings themselves.	1228	mappings themselves.
1151		1229
…		…
1202	all instances, while B<perl-ext> is used for specific instances.	1280	all instances, while B<perl-ext> is used for specific instances.
1203		1281
1204	=item B<perl-eval>: I<string>	1282	=item B<perl-eval>: I<string>
1205		1283
1206	Perl code to be evaluated when all extensions have been registered. See	1284	Perl code to be evaluated when all extensions have been registered. See
1207	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1285	the @@RXVT_NAME@@perl(3) manpage.
1208	will be ignored when running setuid/setgid.
1209		1286
1210	=item B<perl-lib>: I<path>	1287	=item B<perl-lib>: I<path>
1211		1288
1212	Colon-separated list of additional directories that hold extension	1289	Colon-separated list of additional directories that hold extension
1213	scripts. When looking for extensions specified by the C<perl> resource,	1290	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1214	@@RXVT_NAME@@ will first look in these directories and then in	1291	look in these directories, then in $HOME/.urxvt/ext and lastly in
1215	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1292	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1216	will be ignored when running setuid/setgid.
1217		1293
1218	See the @@RXVT_NAME@@perl(3) manpage.	1294	See the @@RXVT_NAME@@perl(3) manpage.
1219		1295
1220	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1296	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1221		1297
…		…
1243		1319
1244	=item B<override-redirect>: I<boolean>	1320	=item B<override-redirect>: I<boolean>
1245		1321
1246	Compile I<frills>: Sets override-redirect for the terminal window, making	1322	Compile I<frills>: Sets override-redirect for the terminal window, making
1247	it almost invisible to window managers; option B<-override-redirect>.	1323	it almost invisible to window managers; option B<-override-redirect>.
		1324
		1325	=item B<iso14755:> I<boolean>
		1326
		1327	Turn on/off ISO 14755 (default enabled).
1248		1328
1249	=item B<iso14755_52:> I<boolean>	1329	=item B<iso14755_52:> I<boolean>
1250		1330
1251	Turn on/off ISO 14755 5.2 mode (default enabled).	1331	Turn on/off ISO 14755 5.2 mode (default enabled).
1252		1332
…		…
1395	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1475	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1396	it can be seen via the I<who(1)> command, and can accept messages. To	1476	it can be seen via the I<who(1)> command, and can accept messages. To
1397	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1477	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1398	on some systems or setgid to root or to some other group on others.	1478	on some systems or setgid to root or to some other group on others.
1399		1479
1400	=head1 COLORS AND GRAPHICS	1480	=head1 COLOURS AND GRAPHICS
1401		1481
1402	In addition to the default foreground and background colours,	1482	In addition to the default foreground and background colours,
1403	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1483	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1404	high-intensity bold/blink versions of the same). Here is a list of the	1484	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1405	colours with their names.	1485	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1486	cube plus a 8 (24) colour greyscale ramp.
		1487
		1488	Here is a list of the ANSI colours with their names.
1406		1489
1407	=begin table	1490	=begin table
1408		1491
1409	B<color0> (black) = Black	1492	B<color0> (black) = Black
1410	B<color1> (red) = Red3	1493	B<color1> (red) = Red3
…		…
1430	It is also possible to specify the colour values of B<foreground>,	1513	It is also possible to specify the colour values of B<foreground>,
1431	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1514	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1432	a number 0-15, as a convenient shorthand to reference the colour name of	1515	a number 0-15, as a convenient shorthand to reference the colour name of
1433	color0-color15.	1516	color0-color15.
1434		1517
1435	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1518	The following text gives values for the standard 88 colour mode (and
1436	additional 72 colours. The first 64 of those (with indices 16 to 79)	1519	values for the 256 colour mode in parentheses).
1437	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1438	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1439		1520
		1521	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1522
		1523	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1524	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1525
		1526	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1527	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1528	the RGB cube.
		1529
1440	Together, all those colours implement the 88 colour xterm colours. Only	1530	Together, all those colours implement the 88 (256) colour xterm
1441	the first 16 can be changed using resources currently, the rest can only	1531	colours. Only the first 16 can be changed using resources currently, the
1442	be changed via command sequences ("escape codes").	1532	rest can only be changed via command sequences ("escape codes").
		1533
		1534	Applications are advised to use terminfo or command sequences to discover
		1535	number and RGB values of all colours (yes, you can query this...).
1443		1536
1444	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1537	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1445	always swapping the foreground/background colours. This is in contrast to	1538	always swapping the foreground/background colours. This is in contrast to
1446	I<xterm>(1) where the colours are only swapped if they have not otherwise	1539	I<xterm>(1) where the colours are only swapped if they have not otherwise
1447	been specified. For example,	1540	been specified. For example,
1448		1541
1449	=over 4
1450
1451	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1542	@@RXVT_NAME@@ -fg Black -bg White -rv
1452		1543
1453	would yield White on Black, while on I<xterm>(1) it would yield Black	1544	would yield White on Black, while on I<xterm>(1) it would yield Black on
1454	on White.	1545	White.
1455		1546
1456	=back	1547	=head2 ALPHA CHANNEL SUPPORT
1457
1458	=head2 ALPHA CHANNEL SUPPORT / TRANSPARENT COLOURS
1459		1548
1460	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1549	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1461	their act together, rxvt-unicode will do it's own alpha channel management:	1550	their act together, rxvt-unicode will do its own alpha channel management:
1462		1551
1463	You can prefix any color with an opaquenes percentage enclosed in	1552	You can prefix any colour with an opaqueness percentage enclosed in
1464	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage	1553	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1465	(0-100) that specifies the opacity of the color, where C<0> is completely	1554	(0-100) that specifies the opacity of the colour, where C<0> is completely
1466	transparent and C<100> is completely opaque. For example, C<[50]red> is a	1555	transparent and C<100> is completely opaque. For example, C<[50]red> is a
1467	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This	1556	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1468	is the recommended format to specify transparency values, and works with	1557	is the recommended format to specify transparency values, and works with
1469	all ways to specify a colour.	1558	all ways to specify a colour.
1470		1559
…		…
1541	C<--with-terminfo=PATH>.	1630	C<--with-terminfo=PATH>.
1542		1631
1543	=item B<DISPLAY>	1632	=item B<DISPLAY>
1544		1633
1545	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1634	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1546	display in its child processes.	1635	display in its child processes if C<-display> isn't used to override. It
		1636	defaults to C<:0> if it doesn't exist.
1547		1637
1548	=item B<SHELL>	1638	=item B<SHELL>
1549		1639
1550	The shell to be used for command execution, defaults to C</bin/sh>.	1640	The shell to be used for command execution, defaults to C</bin/sh>.
1551		1641
1552	=item B<RXVT_SOCKET>	1642	=item B<RXVT_SOCKET>
1553		1643
1554	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1644	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1555	@@RXVT_NAME@@d(1).	1645	@@RXVT_NAME@@d(1).
1556		1646
1557	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1647	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1558		1648
1559	=item B<HOME>	1649	=item B<HOME>
1560		1650
1561	Used to locate the default directory for the unix domain socket for	1651	Used to locate the default directory for the unix domain socket for
1562	daemon communications and to locate various resource files (such as	1652	daemon communications and to locate various resource files (such as
1563	C<.Xdefaults>)	1653	C<.Xdefaults>)
1564		1654
1565	=item B<XAPPLRESDIR>	1655	=item B<XAPPLRESDIR>
1566		1656
1567	Directory where various X resource files are being located.	1657	Directory where application-specific X resource files are located.
1568		1658
1569	=item B<XENVIRONMENT>	1659	=item B<XENVIRONMENT>
1570		1660
1571	If set and accessible, gives the name of a X resource file to be loaded by	1661	If set and accessible, gives the name of a X resource file to be loaded by
1572	@@RXVT_NAME@@.	1662	@@RXVT_NAME@@.
…		…
1577		1667
1578	=over 4	1668	=over 4
1579		1669
1580	=item B</usr/lib/X11/rgb.txt>	1670	=item B</usr/lib/X11/rgb.txt>
1581		1671
1582	Color names.	1672	Colour names.
1583		1673
1584	=back	1674	=back
1585		1675
1586	=head1 SEE ALSO	1676	=head1 SEE ALSO
1587		1677
…		…
1638		1728
1639	Project Coordinator (Changes 1.0 -)	1729	Project Coordinator (Changes 1.0 -)
1640		1730
1641	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1731	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1642		1732
1643	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1733	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1644		1734
1645	=back	1735	=back
1646		1736

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.158 by root, Wed Jan 23 14:33:42 2008 UTC vs. Revision 1.214 by sf-exg, Sun May 13 21:34:29 2012 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.158 by root, Wed Jan 23 14:33:42 2008 UTC vs.
Revision 1.214 by sf-exg, Sun May 13 21:34:29 2012 UTC