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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.163 by root, Mon May 19 14:00:02 2008 UTC vs.
Revision 1.244 by sf-exg, Tue Jun 16 11:58:26 2015 UTC

…		…
98	is still respected. but deprecated). In the absence of this option, the	98	is still respected. but deprecated). In the absence of this option, the
99	display specified by the B<DISPLAY> environment variable is used.	99	display specified by the B<DISPLAY> environment variable is used.
100		100
101	=item B<-depth> I<bitdepth>	101	=item B<-depth> I<bitdepth>
102		102
103	Compile I<xft>: Attempt to find a visual with the given bit depth;	103	Compile I<frills>: Attempt to find a visual with the given bit depth;
104	resource B<depth>.	104	resource B<depth>.
105		105
106	[Please note that many X servers (and libXft) are buggy with	106	[Please note that many X servers (and libXft) are buggy with
107	respect to C<-depth 32> and/or alpha channels, and will cause all sorts	107	respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108	of graphical corruption. This is harmless, but we can't do anything about	108	of graphical corruption. This is harmless, but we can't do anything about
109	this, so watch out]	109	this, so watch out]
110		110
		111	=item B<-visual> I<visualID>
		112
		113	Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for
		114	possible visual ids) instead of the default, and also allocate a private
		115	colormap. All visual types except for DirectColor are supported.
		116
111	=item B<-geometry> I<geom>	117	=item B<-geometry> I<geom>
112		118
113	Window geometry (B<-g> still respected); resource B<geometry>.	119	Window geometry (B<-g> still respected); resource B<geometry>.
114		120
115	=item B<-rv>\|B<+rv>	121	=item B<-rv>\|B<+rv>
…		…
121	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.	127	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
122		128
123	=item B<-ss>\|B<+ss>	129	=item B<-ss>\|B<+ss>
124		130
125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.	131	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
126
127	=item B<-tr>\|B<+tr>
128
129	Turn on/off illusion of a transparent window background; resource B<transparent>.
130
131	B<-ip> is still accepted as an obsolete alias but will be removed in
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		132
137	=item B<-fade> I<number>	133	=item B<-fade> I<number>
138		134
139	Fade the text by the given percentage when focus is lost. Small values	135	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	136	fade a little only, 100 completely replaces all colours by the fade
…		…
143	=item B<-fadecolor> I<colour>	139	=item B<-fadecolor> I<colour>
144		140
145	Fade to this colour when fading is used (see B<-fade>). The default colour	141	Fade to this colour when fading is used (see B<-fade>). The default colour
146	is opaque black. resource B<fadeColor>.	142	is opaque black. resource B<fadeColor>.
147		143
148	=item B<-tint> I<colour>	144	=item B<-icon> I<file>
149		145
150	Tint the transparent background pixmap with the given colour when	146	Compile I<pixbuf>: Use the specified image as application icon. This
151	transparency is enabled with B<-tr>. This only works for	147	is used by many window managers, taskbars and pagers to represent the
152	non-tiled backgrounds, currently. See also the B<-sh> option that can be	148	application window; resource I<iconFile>.
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
162	=item B<-sh> I<number>
163
164	Darken (0 .. 100) or lighten (100 .. 200) the transparent
165	background image in addition to (or instead of) tinting it;
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
178	=item B<-blr> I<HxV>
179
180	Apply Gaussian Blur with the specified radii to the transparent
181	background image. If single number is specified - both vertical and
182	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
184	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
185	resource I<blurRadius>.
186		149
187	=item B<-bg> I<colour>	150	=item B<-bg> I<colour>
188		151
189	Window background colour; resource B<background>.	152	Window background colour; resource B<background>.
190		153
191	=item B<-fg> I<colour>	154	=item B<-fg> I<colour>
192		155
193	Window foreground colour; resource B<foreground>.	156	Window foreground colour; resource B<foreground>.
194
195	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
196
197	Compile I<afterimage>: Specify image file for the background and also
198	optionally specify its scaling with a geometry string. Note you may need to
199	add quotes to avoid special shell interpretation of the C<;> in the
200	command-line; for more details see resource B<backgroundPixmap>.
201		157
202	=item B<-cr> I<colour>	158	=item B<-cr> I<colour>
203		159
204	The cursor colour; resource B<cursorColor>.	160	The cursor colour; resource B<cursorColor>.
205		161
…		…
264		220
265	=item B<-ls>\|B<+ls>	221	=item B<-ls>\|B<+ls>
266		222
267	Start as a login-shell/sub-shell; resource B<loginShell>.	223	Start as a login-shell/sub-shell; resource B<loginShell>.
268		224
		225	=item B<-mc> I<milliseconds>
		226
		227	Specify the maximum time between multi-click selections.
		228
269	=item B<-ut>\|B<+ut>	229	=item B<-ut>\|B<+ut>
270		230
271	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	231	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
272	B<utmpInhibit>.	232	B<utmpInhibit>.
273		233
…		…
315		275
316	=item B<-bc>\|B<+bc>	276	=item B<-bc>\|B<+bc>
317		277
318	Blink the cursor; resource B<cursorBlink>.	278	Blink the cursor; resource B<cursorBlink>.
319		279
		280	=item B<-uc>\|B<+uc>
		281
		282	Make the cursor underlined; resource B<cursorUnderline>.
		283
320	=item B<-iconic>	284	=item B<-iconic>
321		285
322	Start iconified, if the window manager supports that option.	286	Start iconified, if the window manager supports that option.
323	Alternative form is B<-ic>.	287	Alternative form is B<-ic>.
324		288
…		…
340		304
341	=item B<-bl>	305	=item B<-bl>
342		306
343	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	307	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	308	if honoured by the WM, the rxvt-unicode window will not have window
345	decorations; resource B<borderLess>.	309	decorations; resource B<borderLess>. If the window manager does not
		310	support MWM hints (e.g. kwin), enables override-redirect mode.
346		311
347	=item B<-override-redirect>	312	=item B<-override-redirect>
348		313
349	Compile I<frills>: Sets override-redirect on the window; resource	314	Compile I<frills>: Sets override-redirect on the window; resource
350	B<override-redirect>.	315	B<override-redirect>.
		316
		317	=item B<-dockapp>
		318
		319	Sets the initial state of the window to WithdrawnState, which makes
		320	window managers that support this extension treat it as a dockapp.
351		321
352	=item B<-sbg>	322	=item B<-sbg>
353		323
354	Compile I<frills>: Disable the usage of the built-in block graphics/line	324	Compile I<frills>: Disable the usage of the built-in block graphics/line
355	drawing characters and just rely on what the specified fonts provide. Use	325	drawing characters and just rely on what the specified fonts provide. Use
…		…
359	=item B<-lsp> I<number>	329	=item B<-lsp> I<number>
360		330
361	Compile I<frills>: Lines (pixel height) to insert between each row of	331	Compile I<frills>: Lines (pixel height) to insert between each row of
362	the display. Useful to work around font rendering problems; resource	332	the display. Useful to work around font rendering problems; resource
363	B<lineSpace>.	333	B<lineSpace>.
		334
		335	=item B<-letsp> I<number>
		336
		337	Compile I<frills>: Amount to adjust the computed character width by
		338	to control overall letter spacing. Negative values will tighten up the
		339	letter spacing, positive values will space letters out more. Useful to
		340	work around odd font metrics; resource B<letterSpace>.
364		341
365	=item B<-tn> I<termname>	342	=item B<-tn> I<termname>
366		343
367	This option specifies the name of the terminal type to be set in the	344	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	345	B<TERM> environment variable. This terminal type must exist in the
…		…
403	=item B<-pt> I<style>	380	=item B<-pt> I<style>
404		381
405	Compile I<XIM>: input style for input method; B<OverTheSpot>,	382	Compile I<XIM>: input style for input method; B<OverTheSpot>,
406	B<OffTheSpot>, B<Root>; resource B<preeditType>.	383	B<OffTheSpot>, B<Root>; resource B<preeditType>.
407		384
		385	If the perl extension C<xim-onthespot> is used (which is the default),
		386	then additionally the C<OnTheSpot> preedit type is available.
		387
408	=item B<-im> I<text>	388	=item B<-im> I<text>
409		389
410	Compile I<XIM>: input method name. resource B<inputMethod>.	390	Compile I<XIM>: input method name. resource B<inputMethod>.
411		391
412	=item B<-imlocale> I<string>	392	=item B<-imlocale> I<string>
…		…
454		434
455	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	435	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
456	will not immediately destroy its window when the program executed within	436	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	437	it exits. Instead, it will wait till it is being killed or closed by the
458	user; resource B<hold>.	438	user; resource B<hold>.
		439
		440	=item B<-cd> I<path>
		441
		442	Sets the working directory for the shell (or the command specified via
		443	B<-e>). The I<path> must be an absolute path and it must exist for
		444	@@RXVT_NAME@@ to start; resource B<chdir>.
459		445
460	=item B<-xrm> I<string>	446	=item B<-xrm> I<string>
461		447
462	Works like the X Toolkit option of the same name, by adding the I<string>	448	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	449	as if it were specified in a resource file. Resource values specified this
…		…
547	You can set and change the resources using X11 tools like B<xrdb>. Many	533	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	534	distribution do also load settings from the B<~/.Xresources> file when X
549	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	535	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
550	with later settings overwriting earlier ones:	536	with later settings overwriting earlier ones:
551		537
552	1. system-wide app-defaults file, either locale-dependent OR global
553	2. app-defaults file in $XAPPLRESDIR	538	1. app-defaults file in $XAPPLRESDIR
		539	2. $HOME/.Xdefaults
554	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	540	3. RESOURCE_MANAGER property on root-window of screen 0
555	4. SCREEN_RESOURCES for the current screen	541	4. SCREEN_RESOURCES property on root-window of the current screen
556	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	542	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
557	6. resources specified via -xrm on the commandline	543	6. resources specified via -xrm on the commandline
558		544
559	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	545	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	546	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
…		…
601	Use the specified colour for the colour value I<n>, where 0-7	587	Use the specified colour for the colour value I<n>, where 0-7
602	corresponds to low-intensity (normal) colours and 8-15 corresponds to	588	corresponds to low-intensity (normal) colours and 8-15 corresponds to
603	high-intensity (bold = bright foreground, blink = bright background)	589	high-intensity (bold = bright foreground, blink = bright background)
604	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	590	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
605	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	591	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
606	names used are listed in the B<COLORS AND GRAPHICS> section.	592	names used are listed in the B<COLOURS AND GRAPHICS> section.
607		593
608	Colours higher than 15 cannot be set using resources (yet), but can be	594	Colours higher than 15 cannot be set using resources (yet), but can be
609	changed using an escape command (see @@RXVT_NAME@@(7)).	595	changed using an escape command (see @@RXVT_NAME@@(7)).
610		596
611	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	597	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
622	=item B<colorUL:> I<colour>	608	=item B<colorUL:> I<colour>
623		609
624	Use the specified colour to display underlined characters when the	610	Use the specified colour to display underlined characters when the
625	foreground colour is the default.	611	foreground colour is the default.
626		612
627	=item B<colorRV:> I<colour>
628
629	Use the specified colour as the background for reverse video characters
630	when OPTION_HC is disabled (--disable-frills).
631
632	=item B<underlineColor:> I<colour>	613	=item B<underlineColor:> I<colour>
633		614
634	If set, use the specified colour as the colour for the underline	615	If set, use the specified colour as the colour for the underline
635	itself. If unset, use the foreground colour.	616	itself. If unset, use the foreground colour.
		617
		618	=item B<highlightColor:> I<colour>
		619
		620	If set, use the specified colour as the background for highlighted
		621	characters. If unset, use reverse video.
		622
		623	=item B<highlightTextColor:> I<colour>
		624
		625	If set and highlightColor is set, use the specified colour as the
		626	foreground for highlighted characters.
636		627
637	=item B<cursorColor:> I<colour>	628	=item B<cursorColor:> I<colour>
638		629
639	Use the specified colour for the cursor. The default is to use the	630	Use the specified colour for the cursor. The default is to use the
640	foreground colour; option B<-cr>.	631	foreground colour; option B<-cr>.
…		…
647		638
648	=item B<reverseVideo:> I<boolean>	639	=item B<reverseVideo:> I<boolean>
649		640
650	B<True>: simulate reverse video by foreground and background colours;	641	B<True>: simulate reverse video by foreground and background colours;
651	option B<-rv>. B<False>: regular screen colours [default]; option	642	option B<-rv>. B<False>: regular screen colours [default]; option
652	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	643	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
653		644
654	=item B<jumpScroll:> I<boolean>	645	=item B<jumpScroll:> I<boolean>
655		646
656	B<True>: specify that jump scrolling should be used. When receiving lots	647	B<True>: specify that jump scrolling should be used. When receiving lots
657	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines	648	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
671		662
672	B<False>: specify that everything is to be displayed, even	663	B<False>: specify that everything is to be displayed, even
673	if the refresh is too fast for the human eye to read anything (or the	664	if the refresh is too fast for the human eye to read anything (or the
674	monitor to display anything); option B<+ss>.	665	monitor to display anything); option B<+ss>.
675		666
676	=item B<transparent:> I<boolean>
677
678	Turn on/off illusion of a transparent window background.
679
680	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
681	future versions.
682
683	I<Please address all transparency related issues to Sasha Vasko at
684	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
685
686	=item B<fading:> I<number>	667	=item B<fading:> I<number>
687		668
688	Fade the text by the given percentage when focus is lost; option B<-fade>.	669	Fade the text by the given percentage when focus is lost; option B<-fade>.
689		670
690	=item B<fadeColor:> I<colour>	671	=item B<fadeColor:> I<colour>
691		672
692	Fade to this colour, when fading is used (see B<fading:>). The default	673	Fade to this colour, when fading is used (see B<fading:>). The default
693	colour is black; option B<-fadecolor>.	674	colour is black; option B<-fadecolor>.
694		675
695	=item B<tintColor:> I<colour>	676	=item B<iconFile:> I<file>
696		677
697	Tint the transparent background pixmap with the given colour; option	678	Set the application icon pixmap; option B<-icon>.
698	B<-tint>.
699
700	=item B<shading:> I<number>
701
702	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
703	in addition to tinting it; option B<-sh>.
704
705	=item B<blendType:> I<string>
706
707	Specify background blending type; option B<-blt>.
708
709	=item B<blurRadius:> I<number>
710
711	Apply Gaussian Blurr with the specified radius to the transparent
712	background image; option B<-blr>.
713		679
714	=item B<scrollColor:> I<colour>	680	=item B<scrollColor:> I<colour>
715		681
716	Use the specified colour for the scrollbar [default #B2B2B2].	682	Use the specified colour for the scrollbar [default #B2B2B2].
717		683
…		…
722		688
723	=item B<borderColor:> I<colour>	689	=item B<borderColor:> I<colour>
724		690
725	The colour of the border around the text area and between the scrollbar	691	The colour of the border around the text area and between the scrollbar
726	and the text.	692	and the text.
727
728	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
729
730	Use the specified image file for the background and also
731	optionally specify its scaling with a geometry string B<WxH+X+Y>,
732	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
733	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
734	centre (percent). A scale of 0 displays the image with tiling. A scale
735	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
736	an integer number of images in that direction. No image will be magnified
737	beyond 10 times its original size. The maximum permitted scale is 1000.
738	Additional operations can be specified after colon B<:op1:op2...>.
739	Supported operations are:
740
741	tile force background image to be tiled and not scaled. Equivalent to 0x0
742	propscale will scale image keeping proportions
743	auto will scale image to match window size. Equivalent to 100x100
744	hscale will scale image horizontally to the window size
745	vscale will scale image vertically to the window size
746	scale will scale image to match window size
747	root will tile image as if it was a root window background, auto-adjusting
748	whenever terminal window moves
749
750	If used in conjunction with B<-tr> option, the specified pixmap will be
751	blended over transparency image using either alpha-blending, or any
752	other blending type, specified with B<-blt "type"> option.
753
754	=item B<path:> I<path>
755
756	Specify the colon-delimited search path for finding background image files.
757		693
758	=item B<font:> I<fontlist>	694	=item B<font:> I<fontlist>
759		695
760	Select the fonts to be used. This is a comma separated list of font names	696	Select the fonts to be used. This is a comma separated list of font names
761	that are checked in order when trying to find glyphs for characters. The	697	that are checked in order when trying to find glyphs for characters. The
…		…
784	it is named first) and thus defines the character cell grid to be 9 pixels	720	it is named first) and thus defines the character cell grid to be 9 pixels
785	wide and 15 pixels high.	721	wide and 15 pixels high.
786		722
787	The second font is just used to add additional unicode characters not in	723	The second font is just used to add additional unicode characters not in
788	the base font, likewise the third, which is unfortunately non-bold, but	724	the base font, likewise the third, which is unfortunately non-bold, but
789	the bold version of the font does contain less characters, so this is a	725	the bold version of the font does contain fewer characters, so this is a
790	useful supplement.	726	useful supplement.
791		727
792	The third font is an Xft font with aliasing turned off, and the characters	728	The third font is an Xft font with aliasing turned off, and the characters
793	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	729	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
794	contains other characters, but we are not interested in them.	730	contains other characters, but we are not interested in them.
…		…
845	=item B<urgentOnBell:> I<boolean>	781	=item B<urgentOnBell:> I<boolean>
846		782
847	B<True>: set the urgency hint for the wm on receipt of a bell character.	783	B<True>: set the urgency hint for the wm on receipt of a bell character.
848	B<False>: do not set the urgency hint [default].	784	B<False>: do not set the urgency hint [default].
849		785
		786	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		787
850	=item B<visualBell:> I<boolean>	788	=item B<visualBell:> I<boolean>
851		789
852	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	790	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
853	B<False>: no visual bell [default]; option B<+vb>.	791	B<False>: no visual bell [default]; option B<+vb>.
854		792
…		…
856		794
857	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of	795	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
858	the shell; option B<-ls>. B<False>: start as a normal sub-shell	796	the shell; option B<-ls>. B<False>: start as a normal sub-shell
859	[default]; option B<+ls>.	797	[default]; option B<+ls>.
860		798
		799	=item B<multiClickTime:> I<number>
		800
		801	Specify the maximum time in milliseconds between multi-click select
		802	events. The default is 500 milliseconds; option B<-mc>.
		803
861	=item B<utmpInhibit:> I<boolean>	804	=item B<utmpInhibit:> I<boolean>
862		805
863	B<True>: inhibit writing record into the system log file B<utmp>;	806	B<True>: inhibit writing record into the system log file B<utmp>;
864	option B<-ut>. B<False>: write record into the system log file B<utmp>	807	option B<-ut>. B<False>: write record into the system log file B<utmp>
865	[default]; option B<+ut>.	808	[default]; option B<+ut>.
…		…
882	=item B<scrollstyle:> I<mode>	825	=item B<scrollstyle:> I<mode>
883		826
884	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	827	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
885	the author's favourite.	828	the author's favourite.
886		829
		830	=item B<thickness:> I<number>
		831
		832	Set the scrollbar width in pixels.
		833
887	=item B<scrollBar:> I<boolean>	834	=item B<scrollBar:> I<boolean>
888		835
889	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	836	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
890	disable the scrollbar; option B<+sb>.	837	disable the scrollbar; option B<+sb>.
891		838
…		…
910	B<False>: do not scroll to bottom when tty receives output; option	857	B<False>: do not scroll to bottom when tty receives output; option
911	B<+si>.	858	B<+si>.
912		859
913	=item B<scrollWithBuffer:> I<boolean>	860	=item B<scrollWithBuffer:> I<boolean>
914		861
915	B<True>: scroll with scrollback buffer when tty receives new lines (and	862	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
916	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	863	try to show the same lines) and B<scrollTtyOutput> is False; option
917	with scrollback buffer when tty receives new lines; option B<+sw>.	864	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		865	new lines; option B<+sw>.
918		866
919	=item B<scrollTtyKeypress:> I<boolean>	867	=item B<scrollTtyKeypress:> I<boolean>
920		868
921	B<True>: scroll to bottom when a non-special key is pressed. Special keys	869	B<True>: scroll to bottom when a non-special key is pressed. Special keys
922	are those which are intercepted by rxvt-unicode for special handling and	870	are those which are intercepted by rxvt-unicode for special handling and
…		…
978	=item B<cursorBlink:> I<boolean>	926	=item B<cursorBlink:> I<boolean>
979		927
980	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	928	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
981	option B<-bc>.	929	option B<-bc>.
982		930
		931	=item B<cursorUnderline:> I<boolean>
		932
		933	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		934	option B<-uc>.
		935
983	=item B<pointerBlank:> I<boolean>	936	=item B<pointerBlank:> I<boolean>
984		937
985	B<True>: blank the pointer when a key is pressed or after a set number	938	B<True>: blank the pointer when a key is pressed or after a set number
986	of seconds of inactivity. B<False>: the pointer is always visible	939	of seconds of inactivity. B<False>: the pointer is always visible
987	[default].	940	[default].
…		…
992		945
993	=item B<pointerColor2:> I<colour>	946	=item B<pointerColor2:> I<colour>
994		947
995	Mouse pointer background colour.	948	Mouse pointer background colour.
996		949
		950	=item B<pointerShape:> I<string>
		951
		952	Compile I<frills>: Specifies the name of the mouse pointer shape
		953	[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
		954	file for possible values (omit the C<XC_> prefix).
		955
997	=item B<pointerBlankDelay:> I<number>	956	=item B<pointerBlankDelay:> I<number>
998		957
999	Specifies number of seconds before blanking the pointer [default 2]. Use a	958	Specifies number of seconds before blanking the pointer [default 2]. Use a
1000	large number (e.g. C<987654321>) to effectively disable the timeout.	959	large number (e.g. C<987654321>) to effectively disable the timeout.
1001		960
1002	=item B<backspacekey:> I<string>	961	=item B<backspacekey:> I<string>
1003		962
1004	The string to send when the backspace key is pressed. If set to B<DEC>	963	The string to send when the backspace key is pressed. If set to B<DEC>
1005	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	964	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
1006	(code 8) - which can be reversed with the appropriate DEC private mode	965	(code 8) - which can be reversed with the appropriate DEC private mode
1007	escape sequence.	966	escape sequence.
1008		967
1009	=item B<deletekey:> I<string>	968	=item B<deletekey:> I<string>
1010		969
…		…
1027		986
1028	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>	987	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
1029		988
1030	=item B<preeditType:> I<style>	989	=item B<preeditType:> I<style>
1031		990
1032	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	991	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1033		992
1034	=item B<inputMethod:> I<name>	993	=item B<inputMethod:> I<name>
1035		994
1036	I<name> of inputMethod to use; option B<-im>.	995	I<name> of inputMethod to use; option B<-im>.
1037		996
…		…
1099	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1058	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1100	will not immediately destroy its window when the program executed within	1059	will not immediately destroy its window when the program executed within
1101	it exits. Instead, it will wait till it is being killed or closed by the	1060	it exits. Instead, it will wait till it is being killed or closed by the
1102	user.	1061	user.
1103		1062
		1063	=item B<chdir>: I<path>
		1064
		1065	Sets the working directory for the shell (or the command specified via
		1066	B<-e>). The I<path> must be an absolute path and it must exist for
		1067	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1068	directory will be used; option B<-cd>.
		1069
1104	=item B<keysym.>I<sym>: I<string>	1070	=item B<keysym.>I<sym>: I<action>
1105		1071
1106	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1072	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1107	intervening resource name B<keysym.> cannot be omitted.	1073	resource name B<keysym.> cannot be omitted.
1108		1074
1109	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1075	Using this resource, you can map key combinations such as
1110	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1076	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1111	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,	1077	string than would normally result from that combination, making the
1112	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,	1078	terminal scroll up or down the way you want it, or any other thing an
1113	B<2>, B<3>, B<4>, B<5>.	1079	extension might provide.
		1080
		1081	The key combination that triggers the action, I<sym>, has the following format:
		1082
		1083	(modifiers-)key
		1084
		1085	Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
		1086	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
		1087	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
		1088	B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1114		1089
1115	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1090	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1116	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1091	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1117	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1092	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1118	current application keymap mode state.	1093	current application keymap mode state.
1119		1094
1120	The spellings of I<key> can be obtained by using B<xev>(1) command or	1095	Due the the large number of modifier combinations, a key mapping will
1121	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1096	match if I<at least> the specified identifiers are being set, and no other
		1097	key mappings with those and more bits are being defined. That means that
		1098	defining a mapping for C<a> will automatically provide definitions for
		1099	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1100	themselves. See the C<builtin:> action, below, for a way to work around
		1101	this when this is a problem.
		1102
		1103	The spelling of I<key> depends on your implementation of X. An easy way to
		1104	find a key name is to use the B<xev>(1) command. You can find a list by
		1105	looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1122	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1106	the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1123	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1107	value (B<0x0000 - 0xFFFF>).
1124	performed in an exact manner; however, the closest match is assured.
1125		1108
1126	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1109	As with any resource value, the I<action> string may contain backslash
		1110	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1127	number), see RESOURCES in C<man 7 X> for futher details.	1111	number), see RESOURCES in C<man 7 X> for further details.
1128		1112
1129	You can define a range of keysyms in one shot by providing a I<string>	1113	An action starts with an action prefix that selects a certain type
1130	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1114	of action, followed by a colon. An action string without colons is
		1115	interpreted as a literal string to pass to the tty (as if it was
		1116	prefixed with C<string:>).
		1117
		1118	The following action prefixes are known - extensions can provide
		1119	additional prefixes:
		1120
		1121	=over 4
		1122
		1123	=item string:STRING
		1124
		1125	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1126	then the remaining C<STRING> will be passed to the program running in the
		1127	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1128	string C<echo rm -rf /> followed by a newline:
		1129
		1130	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
		1131
		1132	This could in theory be used to completely redefine your keymap.
		1133
		1134	In addition, for actions of this type, you can define a range of
		1135	keysyms in one shot by loading the C<keysym-list> perl extension and
		1136	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1131	should be a character not used by the strings.	1137	the delimiter `/' should be a character not used by the strings.
1132		1138
1133	Its usage can be demonstrated by an example:	1139	Its usage can be demonstrated by an example:
1134		1140
1135	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1141	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1136		1142
1137	The above line is equivalent to the following three lines:	1143	The above line is equivalent to the following three lines:
1138		1144
1139	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1145	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1140	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1146	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1141	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1147	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1142		1148
		1149	=item command:STRING
		1150
1143	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1151	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1144	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1152	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1153	the opposite of C<string:> - instead of sending it to the program running
		1154	in the terminal, it will be treated as if it were program output). This is
		1155	most useful to feed command sequences into @@RXVT_NAME@@.
		1156
1145	example the following means "change the current locale to C<zh_CN.GBK>	1157	For example the following means "change the current locale to C<zh_CN.GBK>
1146	when Control-Meta-c is being pressed":	1158	when Control-Meta-c is being pressed":
1147		1159
1148	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1160	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1149		1161
1150	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1162	The following example will map Control-Meta-1 and Control-Meta-2 to
1151	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1163	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1152	manpage. For example, the F<selection> extension (activated via	1164	font-switching at runtime:
1153	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1154		1165
1155	URxvt.keysym.M-C-c: perl:selection:rot13	1166	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1167	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1156		1168
1157	Due the the large number of modifier combinations, a defined key mapping	1169	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1158	will match if at I<at least> the specified identifiers are being set, and	1170	info):
1159	no other key mappings with those and more bits are being defined. That
1160	means that defining a key map for C<a> will automatically provide
1161	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1162	mappings themselves.
1163		1171
1164	Unfortunately, this will override built-in key mappings. For example	1172	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1173	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1174
		1175	=item builtin:
		1176
		1177	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1178	key binding existed for the key combination. The obvious use is to undo
		1179	the effect of existing bindings. The not so obvious use is to reinstate
		1180	bindings when another binding overrides too many modifiers.
		1181
1165	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1182	For example if you overwrite the C<Insert> key you will disable
1166	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the	1183	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1167	user-defined keymap using the C<builtin:> replacement:	1184	"holes" into the user-defined keymap using the C<builtin:> replacement:
1168		1185
1169	URxvt.keysym.Insert: <my insert key sequence>	1186	URxvt.keysym.Insert: <my insert key sequence>
1170	URxvt.keysym.S-Insert: builtin:	1187	URxvt.keysym.S-Insert: builtin:
1171		1188
1172	The first line defines a mapping for C<Insert> and I<any> combination	1189	The first line defines a mapping for C<Insert> and I<any> combination
1173	of modifiers. The second line re-establishes the default mapping for	1190	of modifiers. The second line re-establishes the default mapping for
1174	C<Shift-Insert>.	1191	C<Shift-Insert>.
1175		1192
1176	The following example will map Control-Meta-1 and Control-Meta-2 to	1193	=item builtin-string:
1177	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1178	font-switching at runtime:
1179		1194
1180	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1195	This action is mainly useful to restore string mappings for keys that
1181	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1196	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1197	difficult to explain - basically, this action will send the string to the
		1198	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1199	action for it.
1182		1200
1183	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1201	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1184	info):	1202	selection when you press C<Shift-Insert>. With the following bindings, it
		1203	would instead emit the (undocumented, but what applications running in the
		1204	terminal might expect) sequence C<ESC [ 2 $> instead:
1185		1205
1186	URxvt.keysym.M-C-3: command:\033[8;25;80t	1206	URxvt.keysym.S-Insert: builtin-string:
1187	URxvt.keysym.M-C-4: command:\033[8;48;110t	1207	URxvt.keysym.C-S-Insert: builtin:
		1208
		1209	The first line disables the paste functionality for that key
		1210	combination, and the second reinstates the default behaviour for
		1211	C<Control-Shift-Insert>, which would otherwise be overridden.
		1212
		1213	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1214	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1215	this:
		1216
		1217	URxvt.keysym.C-M-c: builtin-string:
		1218	URxvt.keysym.C-M-v: builtin-string:
		1219
		1220	=item EXTENSION:STRING
		1221
		1222	An action of this form invokes the action B<STRING>, if any, provided
		1223	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1224	be loaded automatically if necessary.
		1225
		1226	Not all extensions define actions, but popular extensions that do
		1227	include the I<selection> and I<matcher> extensions (documented in their
		1228	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1229	respectively).
		1230
		1231	From the silly examples department, this will rot13-"encrypt"
		1232	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1233	keyboards:
		1234
		1235	URxvt.keysym.M-C-c: selection:rot13
		1236
		1237	=item perl:STRING DEPRECATED
		1238
		1239	This is a deprecated way of invoking commands provided by perl
		1240	extensions. It is still supported, but should not be used anymore.
		1241
		1242	=back
1188		1243
1189	=item B<perl-ext-common>: I<string>	1244	=item B<perl-ext-common>: I<string>
1190		1245
1191	=item B<perl-ext>: I<string>	1246	=item B<perl-ext>: I<string>
1192		1247
…		…
1194	use in this terminal instance; option B<-pe>.	1249	use in this terminal instance; option B<-pe>.
1195		1250
1196	Extension names can be prefixed with a C<-> sign to prohibit using	1251	Extension names can be prefixed with a C<-> sign to prohibit using
1197	them. This can be useful to selectively disable some extensions loaded	1252	them. This can be useful to selectively disable some extensions loaded
1198	by default, or specified via the C<perl-ext-common> resource. For	1253	by default, or specified via the C<perl-ext-common> resource. For
1199	example, C<default,-selection> will use all the default extension except	1254	example, C<default,-selection> will use all the default extensions except
1200	C<selection>.	1255	C<selection>.
1201		1256
1202	Extension names can also be followed by an argument in angle brackets	1257	The default set includes the C<selection>, C<option-popup>,
1203	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1258	C<selection-popup>, C<readline> and C<searchable-scrollback>
1204	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1259	extensions, and extensions which are mentioned in B<keysym> resources.
1205	multiple times with different arguments will pass multiple arguments to	1260
1206	the extension.	1261	Any extension such that a corresponding resource is given on the
		1262	command line is automatically appended to B<perl-ext>.
1207		1263
1208	Each extension is looked up in the library directories, loaded if	1264	Each extension is looked up in the library directories, loaded if
1209	necessary, and bound to the current terminal instance.	1265	necessary, and bound to the current terminal instance. When the library
		1266	search path contains multiple extension files of the same name, then the
		1267	first one found will be used.
1210		1268
1211	If both of these resources are the empty string, then the perl	1269	If both of these resources are the empty string, then the perl interpreter
1212	interpreter will not be initialized. The idea behind two options is that	1270	will not be initialized. The rationale for having two options is that
1213	B<perl-ext-common> will be used for extensions that should be available to	1271	B<perl-ext-common> will be used for extensions that should be available to
1214	all instances, while B<perl-ext> is used for specific instances.	1272	all instances, while B<perl-ext> is used for specific instances.
1215		1273
1216	=item B<perl-eval>: I<string>	1274	=item B<perl-eval>: I<string>
1217		1275
1218	Perl code to be evaluated when all extensions have been registered. See	1276	Perl code to be evaluated when all extensions have been registered. See
1219	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1277	the @@RXVT_NAME@@perl(3) manpage.
1220	will be ignored when running setuid/setgid.
1221		1278
1222	=item B<perl-lib>: I<path>	1279	=item B<perl-lib>: I<path>
1223		1280
1224	Colon-separated list of additional directories that hold extension	1281	Colon-separated list of additional directories that hold extension
1225	scripts. When looking for extensions specified by the C<perl> resource,	1282	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1226	@@RXVT_NAME@@ will first look in these directories and then in	1283	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1227	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1284	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1228	will be ignored when running setuid/setgid.
1229		1285
1230	See the @@RXVT_NAME@@perl(3) manpage.	1286	See the @@RXVT_NAME@@perl(3) manpage.
1231		1287
1232	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1288	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1233		1289
…		…
1237	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1293	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1238		1294
1239	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1295	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1240	for details.	1296	for details.
1241		1297
1242	=item B<searchable-scrollback:> I<keysym>	1298	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1243		1299
1244	Sets the hotkey that starts the incremental scrollback buffer search	1300	This resource is deprecated and will be removed. Use a B<keysym> resource
1245	(default: C<M-s>).	1301	instead, e.g.:
1246		1302
		1303	URxvt.keysym.M-s: searchable-scrollback:start
		1304
1247	=item B<urlLauncher>: I<string>	1305	=item B<url-launcher>: I<string>
1248		1306
1249	Specifies the program to be started with a URL argument. Used by the	1307	Specifies the program to be started with a URL argument. Used by the
1250	C<selection-popup> and C<matcher> perl extensions.	1308	C<selection-popup> and C<matcher> perl extensions.
1251		1309
1252	=item B<transient-for>: I<windowid>	1310	=item B<transient-for>: I<windowid>
…		…
1256	=item B<override-redirect>: I<boolean>	1314	=item B<override-redirect>: I<boolean>
1257		1315
1258	Compile I<frills>: Sets override-redirect for the terminal window, making	1316	Compile I<frills>: Sets override-redirect for the terminal window, making
1259	it almost invisible to window managers; option B<-override-redirect>.	1317	it almost invisible to window managers; option B<-override-redirect>.
1260		1318
		1319	=item B<iso14755:> I<boolean>
		1320
		1321	Turn on/off ISO 14755 (default enabled).
		1322
1261	=item B<iso14755_52:> I<boolean>	1323	=item B<iso14755_52:> I<boolean>
1262		1324
1263	Turn on/off ISO 14755 5.2 mode (default enabled).	1325	Turn on/off ISO 14755 5.2 mode (default enabled).
		1326
		1327	=back
		1328
		1329	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
		1330
		1331	=over 4
		1332
		1333	=item B<-pixmap> I<file[;oplist]>
		1334
		1335	=item B<backgroundPixmap:> I<file[;oplist]>
		1336
		1337	Compile I<pixbuf>: Use the specified image file as the window's
		1338	background and also optionally specify a colon separated list of
		1339	operations to modify it. Note that you may need to quote the C<;>
		1340	character when using the command line option, as C<;> is usually a
		1341	metacharacter in shells. Supported operations are:
		1342
		1343	=over 4
		1344
		1345	=item B<WxH+X+Y>
		1346
		1347	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		1348	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		1349	scale of 0 disables scaling.
		1350
		1351	=item B<op=tile>
		1352
		1353	enables tiling
		1354
		1355	=item B<op=keep-aspect>
		1356
		1357	maintain the image aspect ratio when scaling
		1358
		1359	=item B<op=root-align>
		1360
		1361	use the position of the terminal window relative to the root window as
		1362	the image offset, simulating a root window background
		1363
		1364	=back
		1365
		1366	The default scale and position setting is C<100x100+50+50>.
		1367	Alternatively, a predefined set of templates can be used to achieve
		1368	the most common setups:
		1369
		1370	=over 4
		1371
		1372	=item B<style=tiled>
		1373
		1374	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		1375
		1376	=item B<style=aspect-stretched>
		1377
		1378	the image is scaled to fill the whole window maintaining the aspect
		1379	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		1380
		1381	=item B<style=stretched>
		1382
		1383	the image is scaled to fill the whole window. Equivalent to 100x100
		1384
		1385	=item B<style=centered>
		1386
		1387	the image is centered with no scaling. Equivalent to 0x0+50+50
		1388
		1389	=item B<style=root-tiled>
		1390
		1391	the image is tiled with no scaling and using 'root' positioning.
		1392	Equivalent to 0x0:op=tile:op=root-align
		1393
		1394	=back
		1395
		1396	If multiple templates are specified the last one wins. Note that a
		1397	template overrides all the scale, position and operations settings.
		1398
		1399	If used in conjunction with pseudo-transparency, the specified pixmap
		1400	will be blended over the transparent background using alpha-blending.
		1401
		1402	=item B<-tr>\|B<+tr>
		1403
		1404	=item B<transparent:> I<boolean>
		1405
		1406	Turn on/off pseudo-transparency by using the root pixmap as background.
		1407
		1408	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
		1409	will be removed in future versions.
		1410
		1411	=item B<-tint> I<colour>
		1412
		1413	=item B<tintColor:> I<colour>
		1414
		1415	Tint the transparent background with the given colour. Note that a
		1416	black tint yields a completely black image while a white tint yields
		1417	the image unchanged.
		1418
		1419	=item B<-sh> I<number>
		1420
		1421	=item B<shading:> I<number>
		1422
		1423	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
		1424	A value of 100 means no shading.
		1425
		1426	=item B<-blr> I<HxV>
		1427
		1428	=item B<blurRadius:> I<HxV>
		1429
		1430	Apply gaussian blur with the specified radius to the transparent
		1431	background. If a single number is specified, the vertical and
		1432	horizontal radii are considered to be the same. Setting one of the
		1433	radii to 1 and the other to a large number creates interesting effects
		1434	on some backgrounds. The maximum radius value is 128. An horizontal or
		1435	vertical radius of 0 disables blurring.
		1436
		1437	=item B<path:> I<path>
		1438
		1439	Specify the colon-delimited search path for finding background image files.
1264		1440
1265	=back	1441	=back
1266		1442
1267	=head1 THE SCROLLBAR	1443	=head1 THE SCROLLBAR
1268		1444
…		…
1316	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1492	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1317	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.	1493	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1318		1494
1319	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1495	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1320	inserted too.	1496	inserted too.
		1497
		1498	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1499	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1500	binding causes the value of the internal selection to be copied to the
		1501	CLIPBOARD selection, while the second binding causes the value of the
		1502	CLIPBOARD selection to be inserted.
1321		1503
1322	=back	1504	=back
1323		1505
1324	=head1 CHANGING FONTS	1506	=head1 CHANGING FONTS
1325		1507
…		…
1407	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1589	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1408	it can be seen via the I<who(1)> command, and can accept messages. To	1590	it can be seen via the I<who(1)> command, and can accept messages. To
1409	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1591	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1410	on some systems or setgid to root or to some other group on others.	1592	on some systems or setgid to root or to some other group on others.
1411		1593
1412	=head1 COLORS AND GRAPHICS	1594	=head1 COLOURS AND GRAPHICS
1413		1595
1414	In addition to the default foreground and background colours,	1596	In addition to the default foreground and background colours,
1415	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1597	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1416	high-intensity bold/blink versions of the same). Here is a list of the	1598	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1417	colours with their names.	1599	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1600	cube plus a 8 (24) colour greyscale ramp.
		1601
		1602	Here is a list of the ANSI colours with their names.
1418		1603
1419	=begin table	1604	=begin table
1420		1605
1421	B<color0> (black) = Black	1606	B<color0> (black) = Black
1422	B<color1> (red) = Red3	1607	B<color1> (red) = Red3
…		…
1442	It is also possible to specify the colour values of B<foreground>,	1627	It is also possible to specify the colour values of B<foreground>,
1443	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1628	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1444	a number 0-15, as a convenient shorthand to reference the colour name of	1629	a number 0-15, as a convenient shorthand to reference the colour name of
1445	color0-color15.	1630	color0-color15.
1446		1631
1447	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1632	The following text gives values for the standard 88 colour mode (and
1448	additional 72 colours. The first 64 of those (with indices 16 to 79)	1633	values for the 256 colour mode in parentheses).
1449	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1450	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1451		1634
		1635	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1636
		1637	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1638	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
		1639
		1640	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1641	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1642	the RGB cube.
		1643
1452	Together, all those colours implement the 88 colour xterm colours. Only	1644	Together, all those colours implement the 88 (256) colour xterm
1453	the first 16 can be changed using resources currently, the rest can only	1645	colours. Only the first 16 can be changed using resources currently, the
1454	be changed via command sequences ("escape codes").	1646	rest can only be changed via command sequences ("escape codes").
		1647
		1648	Applications are advised to use terminfo or command sequences to discover
		1649	number and RGB values of all colours (yes, you can query this...).
1455		1650
1456	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1651	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1457	always swapping the foreground/background colours. This is in contrast to	1652	always swapping the foreground/background colours. This is in contrast to
1458	I<xterm>(1) where the colours are only swapped if they have not otherwise	1653	I<xterm>(1) where the colours are only swapped if they have not otherwise
1459	been specified. For example,	1654	been specified. For example,
1460		1655
1461	=over 4
1462
1463	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1656	@@RXVT_NAME@@ -fg Black -bg White -rv
1464		1657
1465	would yield White on Black, while on I<xterm>(1) it would yield Black	1658	would yield White on Black, while on I<xterm>(1) it would yield Black on
1466	on White.	1659	White.
1467
1468	=back
1469		1660
1470	=head2 ALPHA CHANNEL SUPPORT	1661	=head2 ALPHA CHANNEL SUPPORT
1471		1662
1472	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1663	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1473	their act together, rxvt-unicode will do it's own alpha channel management:	1664	their act together, rxvt-unicode will do its own alpha channel management:
1474		1665
1475	You can prefix any color with an opaquenes percentage enclosed in	1666	You can prefix any colour with an opaqueness percentage enclosed in
1476	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage	1667	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1477	(0-100) that specifies the opacity of the color, where C<0> is completely	1668	(0-100) that specifies the opacity of the colour, where C<0> is completely
1478	transparent and C<100> is completely opaque. For example, C<[50]red> is a	1669	transparent and C<100> is completely opaque. For example, C<[50]red> is a
1479	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This	1670	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1480	is the recommended format to specify transparency values, and works with	1671	is the recommended format to specify transparency values, and works with
1481	all ways to specify a colour.	1672	all ways to specify a colour.
1482		1673
…		…
1560		1751
1561	=item B<SHELL>	1752	=item B<SHELL>
1562		1753
1563	The shell to be used for command execution, defaults to C</bin/sh>.	1754	The shell to be used for command execution, defaults to C</bin/sh>.
1564		1755
1565	=item B<RXVT_SOCKET>	1756	=item B<RXVT_SOCKET> [I<sic>]
1566		1757
1567	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1758	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1568	@@RXVT_NAME@@d(1).	1759	@@RXVT_NAME@@d(1).
1569		1760
1570	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1761	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1762
		1763	=item B<URXVT_PERL_LIB>
		1764
		1765	Additional F<:>-separated library search path for perl extensions. Will be
		1766	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1767	directory.
		1768
		1769	=item B<URXVT_PERL_VERBOSITY>
		1770
		1771	See L<@@RXVT_NAME@@perl>(3).
1571		1772
1572	=item B<HOME>	1773	=item B<HOME>
1573		1774
1574	Used to locate the default directory for the unix domain socket for	1775	Used to locate the default directory for the unix domain socket for
1575	daemon communications and to locate various resource files (such as	1776	daemon communications and to locate various resource files (such as
1576	C<.Xdefaults>)	1777	C<.Xdefaults>)
1577		1778
1578	=item B<XAPPLRESDIR>	1779	=item B<XAPPLRESDIR>
1579		1780
1580	Directory where various X resource files are being located.	1781	Directory where application-specific X resource files are located.
1581		1782
1582	=item B<XENVIRONMENT>	1783	=item B<XENVIRONMENT>
1583		1784
1584	If set and accessible, gives the name of a X resource file to be loaded by	1785	If set and accessible, gives the name of a X resource file to be loaded by
1585	@@RXVT_NAME@@.	1786	@@RXVT_NAME@@.
…		…
1590		1791
1591	=over 4	1792	=over 4
1592		1793
1593	=item B</usr/lib/X11/rgb.txt>	1794	=item B</usr/lib/X11/rgb.txt>
1594		1795
1595	Color names.	1796	Colour names.
1596		1797
1597	=back	1798	=back
1598		1799
1599	=head1 SEE ALSO	1800	=head1 SEE ALSO
1600		1801
		1802	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1601	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1803	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1602		1804
1603	=head1 CURRENT PROJECT COORDINATOR	1805	=head1 CURRENT PROJECT COORDINATOR
1604		1806
1605	=over 4	1807	=over 4
1606		1808
1607	=item Project Coordinator	1809	=item Project Coordinator
1608		1810
1609	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1811	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1610		1812
1611	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1813	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1612		1814
1613	=back	1815	=back
1614		1816
…		…
1618		1820
1619	=item John Bovey	1821	=item John Bovey
1620		1822
1621	University of Kent, 1992, wrote the original Xvt.	1823	University of Kent, 1992, wrote the original Xvt.
1622		1824
1623	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1825	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1624		1826
1625	very heavily modified Xvt and came up with Rxvt	1827	very heavily modified Xvt and came up with Rxvt
1626		1828
1627	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1829	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1628		1830
1629	wrote the Greek Keyboard Input (no longer in code)	1831	wrote the Greek Keyboard Input (no longer in code)
1630		1832
1631	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1833	=item mj olesen <olesen@me.QueensU.CA>
1632		1834
1633	Wrote the menu system.	1835	Wrote the menu system.
1634		1836
1635	Project Coordinator (changes.txt 2.11 to 2.21)	1837	Project Coordinator (changes.txt 2.11 to 2.21)
1636		1838
1637	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1839	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1638		1840
1639	Project Coordinator (changes.txt 2.21a to 2.4.5)	1841	Project Coordinator (changes.txt 2.21a to 2.4.5)
1640		1842
1641	=item Geoff Wing L<< <gcw@pobox.com> >>	1843	=item Geoff Wing <gcw@pobox.com>
1642		1844
1643	Rewrote screen display and text selection routines.	1845	Rewrote screen display and text selection routines.
1644		1846
1645	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1847	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1646		1848
1647	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1849	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1648		1850
1649	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1851	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1650	extension, random hacks, numerous bugfixes and extensions.	1852	extension, random hacks, numerous bugfixes and extensions.
1651		1853
1652	Project Coordinator (Changes 1.0 -)	1854	Project Coordinator (Changes 1.0 -)
1653		1855
1654	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1856	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1655		1857
1656	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1858	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1657		1859
1658	=back	1860	=back
1659		1861

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.163 by root, Mon May 19 14:00:02 2008 UTC vs. Revision 1.244 by sf-exg, Tue Jun 16 11:58:26 2015 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.163 by root, Mon May 19 14:00:02 2008 UTC vs.
Revision 1.244 by sf-exg, Tue Jun 16 11:58:26 2015 UTC