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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.153 by root, Wed Dec 12 19:57:13 2007 UTC vs.
Revision 1.228 by root, Sun Apr 27 19:43:46 2014 UTC

…		…
92		92
93	Print out a message describing available options.	93	Print out a message describing available options.
94		94
95	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
96		96
97	Attempt to open a window on the named X display (B<-d> still	97	Attempt to open a window on the named X display (the older form B<-d>
98	respected). In the absence of this option, the display specified by the	98	is still respected. but deprecated). In the absence of this option, the
99	B<DISPLAY> environment variable is used.	99	display specified by the B<DISPLAY> environment variable is used.
100		100
101	=item B<-depth> I<bitdepth>	101	=item B<-depth> I<bitdepth>
102		102
103	Compile I<xft>: Attempt to find a visual with the given bit depth;	103	Compile I<frills>: Attempt to find a visual with the given bit depth;
104	resource B<depth>.	104	resource B<depth>.
105		105
		106	[Please note that many X servers (and libXft) are buggy with
		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
		111	=item B<-visual> I<visualID>
		112
		113	Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible
		114	visual ids).
		115
106	=item B<-geometry> I<geom>	116	=item B<-geometry> I<geom>
107		117
108	Window geometry (B<-g> still respected); resource B<geometry>.	118	Window geometry (B<-g> still respected); resource B<geometry>.
109		119
110	=item B<-rv>\|B<+rv>	120	=item B<-rv>\|B<+rv>
…		…
116	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.	126	Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
117		127
118	=item B<-ss>\|B<+ss>	128	=item B<-ss>\|B<+ss>
119		129
120	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.	130	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
121
122	=item B<-tr>\|B<+tr>
123
124	Turn on/off illusion of a transparent window background; resource B<transparent>.
125
126	B<-ip> is still accepted as an obsolete alias but will be removed in
127	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		131
132	=item B<-fade> I<number>	132	=item B<-fade> I<number>
133		133
134	Fade the text by the given percentage when focus is lost. Small values	134	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	135	fade a little only, 100 completely replaces all colours by the fade
…		…
138	=item B<-fadecolor> I<colour>	138	=item B<-fadecolor> I<colour>
139		139
140	Fade to this colour when fading is used (see B<-fade>). The default colour	140	Fade to this colour when fading is used (see B<-fade>). The default colour
141	is opaque black. resource B<fadeColor>.	141	is opaque black. resource B<fadeColor>.
142		142
143	=item B<-tint> I<colour>	143	=item B<-icon> I<file>
144		144
145	Tint the transparent background pixmap with the given colour when	145	Compile I<pixbuf>: Use the specified image as application icon. This
146	transparency is enabled with B<-tr>. This only works for	146	is used by many window managers, taskbars and pagers to represent the
147	non-tiled backgrounds, currently. See also the B<-sh> option that can be	147	application window; resource I<iconFile>.
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
157	=item B<-sh> I<number>
158
159	Darken (0 .. 100) or lighten (100 .. 200) the transparent
160	background image in addition to (or instead of) tinting it;
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
173	=item B<-blr> I<HxV>
174
175	Apply Gaussian Blur with the specified radii to the transparent
176	background image. If single number is specified - both vertical and
177	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
179	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
180	resource I<blurRadius>.
181		148
182	=item B<-bg> I<colour>	149	=item B<-bg> I<colour>
183		150
184	Window background colour; resource B<background>.	151	Window background colour; resource B<background>.
185		152
186	=item B<-fg> I<colour>	153	=item B<-fg> I<colour>
187		154
188	Window foreground colour; resource B<foreground>.	155	Window foreground colour; resource B<foreground>.
189
190	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
191
192	Compile I<afterimage>: Specify image file for the background and also
193	optionally specify its scaling with a geometry string. Note you may need to
194	add quotes to avoid special shell interpretation of the C<;> in the
195	command-line; for more details see resource B<backgroundPixmap>.
196		156
197	=item B<-cr> I<colour>	157	=item B<-cr> I<colour>
198		158
199	The cursor colour; resource B<cursorColor>.	159	The cursor colour; resource B<cursorColor>.
200		160
…		…
245	italic> >> characters are to be printed. See resource B<boldItalicFont>	205	italic> >> characters are to be printed. See resource B<boldItalicFont>
246	for details.	206	for details.
247		207
248	=item B<-is>\|B<+is>	208	=item B<-is>\|B<+is>
249		209
250	Compile I<font-styles>: Bold/Italic font styles imply high intensity	210	Compile I<font-styles>: Bold/Blink font styles imply high intensity
251	foreground/background (default). See resource B<intensityStyles> for	211	foreground/background (default). See resource B<intensityStyles> for
252	details.	212	details.
253		213
254	=item B<-name> I<name>	214	=item B<-name> I<name>
255		215
…		…
273		233
274	=item B<-sb>\|B<+sb>	234	=item B<-sb>\|B<+sb>
275		235
276	Turn on/off scrollbar; resource B<scrollBar>.	236	Turn on/off scrollbar; resource B<scrollBar>.
277		237
		238	=item B<-sr>\|B<+sr>
		239
		240	Put scrollbar on right/left; resource B<scrollBar_right>.
		241
		242	=item B<-st>\|B<+st>
		243
		244	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
		245	resource B<scrollBar_floating>.
		246
278	=item B<-si>\|B<+si>	247	=item B<-si>\|B<+si>
279		248
280	Turn on/off scroll-to-bottom on TTY output inhibit; resource	249	Turn on/off scroll-to-bottom on TTY output inhibit; resource
281	B<scrollTtyOutput> has opposite effect.	250	B<scrollTtyOutput> has opposite effect.
282		251
…		…
288	=item B<-sw>\|B<+sw>	257	=item B<-sw>\|B<+sw>
289		258
290	Turn on/off scrolling with the scrollback buffer as new lines appear.	259	Turn on/off scrolling with the scrollback buffer as new lines appear.
291	This only takes effect if B<-si> is also given; resource	260	This only takes effect if B<-si> is also given; resource
292	B<scrollWithBuffer>.	261	B<scrollWithBuffer>.
293
294	=item B<-sr>\|B<+sr>
295
296	Put scrollbar on right/left; resource B<scrollBar_right>.
297
298	=item B<-st>\|B<+st>
299
300	Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
301	resource B<scrollBar_floating>.
302		262
303	=item B<-ptab>\|B<+ptab>	263	=item B<-ptab>\|B<+ptab>
304		264
305	If enabled (default), "Horizontal Tab" characters are being stored as	265	If enabled (default), "Horizontal Tab" characters are being stored as
306	actual wide characters in the screen buffer, which makes it possible to	266	actual wide characters in the screen buffer, which makes it possible to
…		…
310		270
311	=item B<-bc>\|B<+bc>	271	=item B<-bc>\|B<+bc>
312		272
313	Blink the cursor; resource B<cursorBlink>.	273	Blink the cursor; resource B<cursorBlink>.
314		274
		275	=item B<-uc>\|B<+uc>
		276
		277	Make the cursor underlined; resource B<cursorUnderline>.
		278
315	=item B<-iconic>	279	=item B<-iconic>
316		280
317	Start iconified, if the window manager supports that option.	281	Start iconified, if the window manager supports that option.
318	Alternative form is B<-ic>.	282	Alternative form is B<-ic>.
319		283
…		…
335		299
336	=item B<-bl>	300	=item B<-bl>
337		301
338	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	302	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	303	if honoured by the WM, the rxvt-unicode window will not have window
340	decorations; resource B<borderLess>.	304	decorations; resource B<borderLess>. If the window manager does not
		305	support MWM hints (e.g. kwin), enables override-redirect mode.
341		306
342	=item B<-override-redirect>	307	=item B<-override-redirect>
343		308
344	Compile I<frills>: Sets override-redirect on the window; resource	309	Compile I<frills>: Sets override-redirect on the window; resource
345	B<override-redirect>.	310	B<override-redirect>.
…		…
354	=item B<-lsp> I<number>	319	=item B<-lsp> I<number>
355		320
356	Compile I<frills>: Lines (pixel height) to insert between each row of	321	Compile I<frills>: Lines (pixel height) to insert between each row of
357	the display. Useful to work around font rendering problems; resource	322	the display. Useful to work around font rendering problems; resource
358	B<lineSpace>.	323	B<lineSpace>.
		324
		325	=item B<-letsp> I<number>
		326
		327	Compile I<frills>: Amount to adjust the computed character width by
		328	to control overall letter spacing. Negative values will tighten up the
		329	letter spacing, positive values will space letters out more. Useful to
		330	work around odd font metrics; resource B<letterSpace>.
359		331
360	=item B<-tn> I<termname>	332	=item B<-tn> I<termname>
361		333
362	This option specifies the name of the terminal type to be set in the	334	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	335	B<TERM> environment variable. This terminal type must exist in the
…		…
450	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	422	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
451	will not immediately destroy its window when the program executed within	423	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	424	it exits. Instead, it will wait till it is being killed or closed by the
453	user; resource B<hold>.	425	user; resource B<hold>.
454		426
		427	=item B<-cd> I<path>
		428
		429	Sets the working directory for the shell (or the command specified via
		430	B<-e>). The I<path> must be an absolute path and it must exist for
		431	@@RXVT_NAME@@ to start; resource B<chdir>.
		432
455	=item B<-xrm> I<string>	433	=item B<-xrm> I<string>
456		434
457	Works like the X Toolkit option of the same name, by adding the I<string>	435	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	436	as if it were specified in a resource file. Resource values specified this
459	way take precedence over all other resource specifications.	437	way take precedence over all other resource specifications.
…		…
542	You can set and change the resources using X11 tools like B<xrdb>. Many	520	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	521	distribution do also load settings from the B<~/.Xresources> file when X
544	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	522	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
545	with later settings overwriting earlier ones:	523	with later settings overwriting earlier ones:
546		524
547	1. system-wide app-defaults file, either locale-dependent OR global
548	2. app-defaults file in $XAPPLRESDIR	525	1. app-defaults file in $XAPPLRESDIR
		526	2. $HOME/.Xdefaults
549	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	527	3. RESOURCE_MANAGER property on root-window of screen 0
550	4. SCREEN_RESOURCES for the current screen	528	4. SCREEN_RESOURCES property on root-window of the current screen
551	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	529	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
552	6. resources specified via -xrm on the commandline	530	6. resources specified via -xrm on the commandline
553		531
554	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	532	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	533	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
…		…
567	=item B<depth:> I<bitdepth>	545	=item B<depth:> I<bitdepth>
568		546
569	Compile I<xft>: Attempt to find a visual with the given bit depth;	547	Compile I<xft>: Attempt to find a visual with the given bit depth;
570	option B<-depth>.	548	option B<-depth>.
571		549
		550	=item B<buffered:> I<boolean>
		551
		552	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		553	On some card/driver combination enabling it slightly decreases
		554	performance, on most it greatly helps it. The slowdown is small, so it
		555	should normally be enabled.
		556
572	=item B<geometry:> I<geom>	557	=item B<geometry:> I<geom>
573		558
574	Create the window with the specified X window geometry [default 80x24];	559	Create the window with the specified X window geometry [default 80x24];
575	option B<-geometry>.	560	option B<-geometry>.
576		561
…		…
589	Use the specified colour for the colour value I<n>, where 0-7	574	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	575	corresponds to low-intensity (normal) colours and 8-15 corresponds to
591	high-intensity (bold = bright foreground, blink = bright background)	576	high-intensity (bold = bright foreground, blink = bright background)
592	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	577	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	578	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.	579	names used are listed in the B<COLOURS AND GRAPHICS> section.
595		580
596	Colours higher than 15 cannot be set using resources (yet), but can be	581	Colours higher than 15 cannot be set using resources (yet), but can be
597	changed using an escape command (see @@RXVT_NAME@@(7)).	582	changed using an escape command (see @@RXVT_NAME@@(7)).
598		583
599	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	584	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
610	=item B<colorUL:> I<colour>	595	=item B<colorUL:> I<colour>
611		596
612	Use the specified colour to display underlined characters when the	597	Use the specified colour to display underlined characters when the
613	foreground colour is the default.	598	foreground colour is the default.
614		599
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>	600	=item B<underlineColor:> I<colour>
621		601
622	If set, use the specified colour as the colour for the underline	602	If set, use the specified colour as the colour for the underline
623	itself. If unset, use the foreground colour.	603	itself. If unset, use the foreground colour.
		604
		605	=item B<highlightColor:> I<colour>
		606
		607	If set, use the specified colour as the background for highlighted
		608	characters. If unset, use reverse video.
		609
		610	=item B<highlightTextColor:> I<colour>
		611
		612	If set and highlightColor is set, use the specified colour as the
		613	foreground for highlighted characters.
624		614
625	=item B<cursorColor:> I<colour>	615	=item B<cursorColor:> I<colour>
626		616
627	Use the specified colour for the cursor. The default is to use the	617	Use the specified colour for the cursor. The default is to use the
628	foreground colour; option B<-cr>.	618	foreground colour; option B<-cr>.
…		…
635		625
636	=item B<reverseVideo:> I<boolean>	626	=item B<reverseVideo:> I<boolean>
637		627
638	B<True>: simulate reverse video by foreground and background colours;	628	B<True>: simulate reverse video by foreground and background colours;
639	option B<-rv>. B<False>: regular screen colours [default]; option	629	option B<-rv>. B<False>: regular screen colours [default]; option
640	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	630	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
641		631
642	=item B<jumpScroll:> I<boolean>	632	=item B<jumpScroll:> I<boolean>
643		633
644	B<True>: specify that jump scrolling should be used. When receiving lots	634	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	635	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
659		649
660	B<False>: specify that everything is to be displayed, even	650	B<False>: specify that everything is to be displayed, even
661	if the refresh is too fast for the human eye to read anything (or the	651	if the refresh is too fast for the human eye to read anything (or the
662	monitor to display anything); option B<+ss>.	652	monitor to display anything); option B<+ss>.
663		653
664	=item B<transparent:> I<boolean>
665
666	Turn on/off illusion of a transparent window background.
667
668	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
669	future versions.
670
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>	654	=item B<fading:> I<number>
675		655
676	Fade the text by the given percentage when focus is lost; option B<-fade>.	656	Fade the text by the given percentage when focus is lost; option B<-fade>.
677		657
678	=item B<fadeColor:> I<colour>	658	=item B<fadeColor:> I<colour>
679		659
680	Fade to this colour, when fading is used (see B<fading:>). The default	660	Fade to this colour, when fading is used (see B<fading:>). The default
681	colour is black; option B<-fadecolor>.	661	colour is black; option B<-fadecolor>.
682		662
683	=item B<tintColor:> I<colour>	663	=item B<iconFile:> I<file>
684		664
685	Tint the transparent background pixmap with the given colour; option	665	Set the application icon pixmap; option B<-icon>.
686	B<-tint>.
687
688	=item B<shading:> I<number>
689
690	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
691	in addition to tinting it; option B<-sh>.
692
693	=item B<blendType:> I<string>
694
695	Specify background blending type; option B<-blt>.
696
697	=item B<blurRadius:> I<number>
698
699	Apply Gaussian Blurr with the specified radius to the transparent
700	background image; option B<-blr>.
701		666
702	=item B<scrollColor:> I<colour>	667	=item B<scrollColor:> I<colour>
703		668
704	Use the specified colour for the scrollbar [default #B2B2B2].	669	Use the specified colour for the scrollbar [default #B2B2B2].
705		670
…		…
710		675
711	=item B<borderColor:> I<colour>	676	=item B<borderColor:> I<colour>
712		677
713	The colour of the border around the text area and between the scrollbar	678	The colour of the border around the text area and between the scrollbar
714	and the text.	679	and the text.
715
716	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
717
718	Use the specified image file for the background and also
719	optionally specify its scaling with a geometry string B<WxH+X+Y>,
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:
728
729	tile force background image to be tiled and not scaled. Equivalent to 0x0,
730	propscale will scale image keeping proportions,
731	auto will scale image to match window size. Equivalent to 100x100;
732	hscale will scale image horizontally to the window size;
733	vscale will scale image vertically to the window size;
734	scale will scale image to match window size;
735	root will tile image as if it was a root window background, auto-adjusting
736	whenever terminal window moves.
737
738	If used in conjunction with B<-tr> option, the specified pixmap will be
739	blended over transparency image using either alpha-blending, or any
740	other blending type, specified with B<-blt "type"> option.
741
742	=item B<path:> I<path>
743
744	Specify the colon-delimited search path for finding background image files.
745		680
746	=item B<font:> I<fontlist>	681	=item B<font:> I<fontlist>
747		682
748	Select the fonts to be used. This is a comma separated list of font names	683	Select the fonts to be used. This is a comma separated list of font names
749	that are checked in order when trying to find glyphs for characters. The	684	that are checked in order when trying to find glyphs for characters. The
…		…
772	it is named first) and thus defines the character cell grid to be 9 pixels	707	it is named first) and thus defines the character cell grid to be 9 pixels
773	wide and 15 pixels high.	708	wide and 15 pixels high.
774		709
775	The second font is just used to add additional unicode characters not in	710	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	711	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	712	the bold version of the font does contain fewer characters, so this is a
778	useful supplement.	713	useful supplement.
779		714
780	The third font is an Xft font with aliasing turned off, and the characters	715	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	716	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.	717	contains other characters, but we are not interested in them.
…		…
806	text font will being used for the given style.	741	text font will being used for the given style.
807		742
808	=item B<intensityStyles:> I<boolean>	743	=item B<intensityStyles:> I<boolean>
809		744
810	When font styles are not enabled, or this option is enabled (B<True>,	745	When font styles are not enabled, or this option is enabled (B<True>,
811	option B<-is>, the default), bold and italic font styles imply high	746	option B<-is>, the default), bold/blink font styles imply high
812	intensity foreground/background colours. Disabling this option (B<False>,	747	intensity foreground/background colours. Disabling this option (B<False>,
813	option B<+is>) disables this behaviour, the high intensity colours are not	748	option B<+is>) disables this behaviour, the high intensity colours are not
814	reachable.	749	reachable.
815		750
816	=item B<selectstyle:> I<mode>
817
818	Set mouse selection style to B<old> which is 2.20, B<oldword> which
819	is xterm style with 2.20 old word selection, or anything else which
820	gives xterm style selection. Only effective when the original (non-perl)
821	selection code is in use.
822
823	=item B<scrollstyle:> I<mode>
824
825	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
826	the author's favourite.
827
828	=item B<title:> I<string>	751	=item B<title:> I<string>
829		752
830	Set window title string, the default title is the command-line	753	Set window title string, the default title is the command-line
831	specified after the B<-e> option, if any, otherwise the application	754	specified after the B<-e> option, if any, otherwise the application
832	name; option B<-title>.	755	name; option B<-title>.
…		…
845	=item B<urgentOnBell:> I<boolean>	768	=item B<urgentOnBell:> I<boolean>
846		769
847	B<True>: set the urgency hint for the wm on receipt of a bell character.	770	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].	771	B<False>: do not set the urgency hint [default].
849		772
		773	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		774
850	=item B<visualBell:> I<boolean>	775	=item B<visualBell:> I<boolean>
851		776
852	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	777	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
853	B<False>: no visual bell [default]; option B<+vb>.	778	B<False>: no visual bell [default]; option B<+vb>.
854		779
…		…
877	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	802	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
878		803
879	This creates a new file in your home directory with the screen contents	804	This creates a new file in your home directory with the screen contents
880	every time you hit C<Print>.	805	every time you hit C<Print>.
881		806
		807	=item B<scrollstyle:> I<mode>
		808
		809	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
		810	the author's favourite.
		811
		812	=item B<thickness:> I<number>
		813
		814	Set the scrollbar width in pixels.
		815
882	=item B<scrollBar:> I<boolean>	816	=item B<scrollBar:> I<boolean>
883		817
884	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	818	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
885	disable the scrollbar; option B<+sb>.	819	disable the scrollbar; option B<+sb>.
886		820
…		…
905	B<False>: do not scroll to bottom when tty receives output; option	839	B<False>: do not scroll to bottom when tty receives output; option
906	B<+si>.	840	B<+si>.
907		841
908	=item B<scrollWithBuffer:> I<boolean>	842	=item B<scrollWithBuffer:> I<boolean>
909		843
910	B<True>: scroll with scrollback buffer when tty receives new lines (and	844	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
911	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	845	try to show the same lines) and B<scrollTtyOutput> is False; option
912	with scrollback buffer when tty receives new lines; option B<+sw>.	846	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		847	new lines; option B<+sw>.
913		848
914	=item B<scrollTtyKeypress:> I<boolean>	849	=item B<scrollTtyKeypress:> I<boolean>
915		850
916	B<True>: scroll to bottom when a non-special key is pressed. Special keys	851	B<True>: scroll to bottom when a non-special key is pressed. Special keys
917	are those which are intercepted by rxvt-unicode for special handling and	852	are those which are intercepted by rxvt-unicode for special handling and
…		…
973	=item B<cursorBlink:> I<boolean>	908	=item B<cursorBlink:> I<boolean>
974		909
975	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	910	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
976	option B<-bc>.	911	option B<-bc>.
977		912
		913	=item B<cursorUnderline:> I<boolean>
		914
		915	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		916	option B<-uc>.
		917
978	=item B<pointerBlank:> I<boolean>	918	=item B<pointerBlank:> I<boolean>
979		919
980	B<True>: blank the pointer when a key is pressed or after a set number	920	B<True>: blank the pointer when a key is pressed or after a set number
981	of seconds of inactivity. B<False>: the pointer is always visible	921	of seconds of inactivity. B<False>: the pointer is always visible
982	[default].	922	[default].
…		…
995	large number (e.g. C<987654321>) to effectively disable the timeout.	935	large number (e.g. C<987654321>) to effectively disable the timeout.
996		936
997	=item B<backspacekey:> I<string>	937	=item B<backspacekey:> I<string>
998		938
999	The string to send when the backspace key is pressed. If set to B<DEC>	939	The string to send when the backspace key is pressed. If set to B<DEC>
1000	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	940	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
1001	(code 8) - which can be reversed with the appropriate DEC private mode	941	(code 8) - which can be reversed with the appropriate DEC private mode
1002	escape sequence.	942	escape sequence.
1003		943
1004	=item B<deletekey:> I<string>	944	=item B<deletekey:> I<string>
1005		945
…		…
1084		1024
1085	=item B<secondaryScroll:> I<boolean>	1025	=item B<secondaryScroll:> I<boolean>
1086		1026
1087	Turn on/off secondary screen scroll (default enabled). If this	1027	Turn on/off secondary screen scroll (default enabled). If this
1088	option is enabled, scrolls on the secondary screen will change the	1028	option is enabled, scrolls on the secondary screen will change the
1089	scrollback buffer and switching to/from the secondary screen will	1029	scrollback buffer and, when secondaryScreen is off, switching
1090	instead scroll the screen up.	1030	to/from the secondary screen will instead scroll the screen up.
1091		1031
1092	=item B<hold>: I<boolean>	1032	=item B<hold>: I<boolean>
1093		1033
1094	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1034	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1095	will not immediately destroy its window when the program executed within	1035	will not immediately destroy its window when the program executed within
1096	it exits. Instead, it will wait till it is being killed or closed by the	1036	it exits. Instead, it will wait till it is being killed or closed by the
1097	user.	1037	user.
1098		1038
		1039	=item B<chdir>: I<path>
		1040
		1041	Sets the working directory for the shell (or the command specified via
		1042	B<-e>). The I<path> must be an absolute path and it must exist for
		1043	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1044	directory will be used; option B<-cd>.
		1045
1099	=item B<keysym.>I<sym>: I<string>	1046	=item B<keysym.>I<sym>: I<action>
1100		1047
1101	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1048	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1102	intervening resource name B<keysym.> cannot be omitted.	1049	resource name B<keysym.> cannot be omitted.
1103		1050
1104	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1051	Using this resource, you can map key combinations such as
1105	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1052	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1106	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,	1053	string than would normally result from that combination, making the
1107	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,	1054	terminal scroll up or down the way you want it, or any other thing an
1108	B<2>, B<3>, B<4>, B<5>.	1055	extension might provide.
		1056
		1057	The key combination that triggers the action, I<sym>, has the following format:
		1058
		1059	(modifiers-)key
		1060
		1061	Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
		1062	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
		1063	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
		1064	B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1109		1065
1110	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1066	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1111	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1067	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1112	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1068	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1113	current application keymap mode state.	1069	current application keymap mode state.
1114		1070
1115	The spellings of I<key> can be obtained by using B<xev>(1) command or	1071	Due the the large number of modifier combinations, a key mapping will
1116	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1072	match if I<at least> the specified identifiers are being set, and no other
		1073	key mappings with those and more bits are being defined. That means that
		1074	defining a mapping for C<a> will automatically provide definitions for
		1075	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1076	themselves. See the C<builtin:> action, below, for a way to work around
		1077	this when this is a problem.
		1078
		1079	The spelling of I<key> depends on your implementation of X. An easy way to
		1080	find a key name is to use the B<xev>(1) command. You can find a list by
		1081	looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1117	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1082	the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1118	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1083	value (B<0x0000 - 0xFFFF>).
1119	performed in an exact manner; however, the closest match is assured.
1120		1084
1121	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1085	As with any resource value, the I<action> string may contain backslash
		1086	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1122	number), see RESOURCES in C<man 7 X> for futher details.	1087	number), see RESOURCES in C<man 7 X> for further details.
1123		1088
1124	You can define a range of keysyms in one shot by providing a I<string>	1089	An action starts with an action prefix that selects a certain type
1125	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1090	of action, followed by a colon. An action strings without colons is
1126	should be a character not used by the strings.	1091	interpreted as a literal string to pass to the tty (as if they were
		1092	prefixed with C<string:>).
1127		1093
1128	Its usage can be demonstrated by an example:	1094	The following action prefixes are known - extensions can provide
		1095	additional prefixes:
1129		1096
1130	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1097	=over 4
1131		1098
1132	The above line is equivalent to the following three lines:	1099	=item string:STRING
1133		1100
1134	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1101	If the I<action> starts with C<string:> (or otherwise contains no colons),
1135	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1102	then the remaining C<STRING> will be passed to the program running in the
1136	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1103	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1104	string C<echo rm -rf /> followed by a newline:
1137		1105
		1106	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
		1107
		1108	This could in theory be used to completely redefine your keymap.
		1109
		1110	=item command:STRING
		1111
1138	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1112	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1139	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1113	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1114	the opposite of C<string:> - instead of sending it to the program running
		1115	in the terminal, it will be treated as if it were program output). This is
		1116	most useful to feed command sequences into @@RXVT_NAME@@.
		1117
1140	example the following means "change the current locale to C<zh_CN.GBK>	1118	For example the following means "change the current locale to C<zh_CN.GBK>
1141	when Control-Meta-c is being pressed":	1119	when Control-Meta-c is being pressed":
1142		1120
1143	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1121	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1144		1122
1145	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1123	The following example will map Control-Meta-1 and Control-Meta-2 to
1146	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1124	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1147	manpage. For example, the F<selection> extension (activated via	1125	font-switching at runtime:
1148	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1149		1126
1150	URxvt.keysym.M-C-c: perl:selection:rot13	1127	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1128	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1151		1129
1152	Due the the large number of modifier combinations, a defined key mapping	1130	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1153	will match if at I<at least> the specified identifiers are being set, and	1131	info):
1154	no other key mappings with those and more bits are being defined. That
1155	means that defining a key map for C<a> will automatically provide
1156	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1157	mappings themselves.
1158		1132
1159	Unfortunately, this will override built-in key mappings. For example	1133	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1134	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1135
		1136	=item builtin:
		1137
		1138	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1139	key binding existed for the key combination. The obvious use is to undo
		1140	the effect of existing bindings. The not so obvious use is to reinstate
		1141	bindings when another binding overrides too many modifiers.
		1142
1160	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1143	For example if you overwrite the C<Insert> key you will disable
1161	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the	1144	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1162	user-defined keymap using the C<builtin:> replacement:	1145	"holes" into the user-defined keymap using the C<builtin:> replacement:
1163		1146
1164	URxvt.keysym.Insert: <my insert key sequence>	1147	URxvt.keysym.Insert: <my insert key sequence>
1165	URxvt.keysym.S-Insert: builtin:	1148	URxvt.keysym.S-Insert: builtin:
1166		1149
1167	The first line defines a mapping for C<Insert> and I<any> combination	1150	The first line defines a mapping for C<Insert> and I<any> combination
1168	of modifiers. The second line re-establishes the default mapping for	1151	of modifiers. The second line re-establishes the default mapping for
1169	C<Shift-Insert>.	1152	C<Shift-Insert>.
1170		1153
1171	The following example will map Control-Meta-1 and Control-Meta-2 to	1154	=item EXTENSION:STRING
1172	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1173	font-switching at runtime:
1174		1155
1175	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1156	An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)
1176	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1157	extension of the same name. The extension will be loaded automatically if
		1158	neccessary.
1177		1159
1178	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1160	Not all extensions define key actions, but popular extensions that do
1179	info):	1161	include the I<selection> and I<matcher> extensions (documented in their
		1162	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1163	respectively).
1180		1164
1181	URxvt.keysym.M-C-3: command:\033[8;25;80t	1165	From the silly examples department, this will rot13-"encrypt"
1182	URxvt.keysym.M-C-4: command:\033[8;48;110t	1166	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1167	keyboards:
		1168
		1169	URxvt.keysym.M-C-c: selection:rot13
		1170
		1171	=item perl:STRING
		1172
		1173	This is a deprecated way of passing key mappings to perl extensions. It is
		1174	still supported, but should not be used anymore.
		1175
		1176	=back
		1177
		1178	In addition, you can define a range of keysyms in one shot by loading
		1179	the C<keysym-list> perl extension and providing a I<string> with pattern
		1180	B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' should be a
		1181	character not used by the strings.
		1182
		1183	Its usage can be demonstrated by an example:
		1184
		1185	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
		1186
		1187	The above line is equivalent to the following three lines:
		1188
		1189	URxvt.keysym.Meta-Control-0x61: \033<a>
		1190	URxvt.keysym.Meta-Control-0x62: \033<b>
		1191	URxvt.keysym.Meta-Control-0x63: \033<c>
1183		1192
1184	=item B<perl-ext-common>: I<string>	1193	=item B<perl-ext-common>: I<string>
1185		1194
1186	=item B<perl-ext>: I<string>	1195	=item B<perl-ext>: I<string>
1187		1196
…		…
1209	all instances, while B<perl-ext> is used for specific instances.	1218	all instances, while B<perl-ext> is used for specific instances.
1210		1219
1211	=item B<perl-eval>: I<string>	1220	=item B<perl-eval>: I<string>
1212		1221
1213	Perl code to be evaluated when all extensions have been registered. See	1222	Perl code to be evaluated when all extensions have been registered. See
1214	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1223	the @@RXVT_NAME@@perl(3) manpage.
1215	will be ignored when running setuid/setgid.
1216		1224
1217	=item B<perl-lib>: I<path>	1225	=item B<perl-lib>: I<path>
1218		1226
1219	Colon-separated list of additional directories that hold extension	1227	Colon-separated list of additional directories that hold extension
1220	scripts. When looking for extensions specified by the C<perl> resource,	1228	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1221	@@RXVT_NAME@@ will first look in these directories and then in	1229	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1222	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1230	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1223	will be ignored when running setuid/setgid.
1224		1231
1225	See the @@RXVT_NAME@@perl(3) manpage.	1232	See the @@RXVT_NAME@@perl(3) manpage.
1226		1233
1227	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1234	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1228		1235
…		…
1237	=item B<searchable-scrollback:> I<keysym>	1244	=item B<searchable-scrollback:> I<keysym>
1238		1245
1239	Sets the hotkey that starts the incremental scrollback buffer search	1246	Sets the hotkey that starts the incremental scrollback buffer search
1240	(default: C<M-s>).	1247	(default: C<M-s>).
1241		1248
1242	=item B<urlLauncher>: I<string>	1249	=item B<url-launcher>: I<string>
1243		1250
1244	Specifies the program to be started with a URL argument. Used by the	1251	Specifies the program to be started with a URL argument. Used by the
1245	C<selection-popup> and C<matcher> perl extensions.	1252	C<selection-popup> and C<matcher> perl extensions.
1246		1253
1247	=item B<transient-for>: I<windowid>	1254	=item B<transient-for>: I<windowid>
…		…
1251	=item B<override-redirect>: I<boolean>	1258	=item B<override-redirect>: I<boolean>
1252		1259
1253	Compile I<frills>: Sets override-redirect for the terminal window, making	1260	Compile I<frills>: Sets override-redirect for the terminal window, making
1254	it almost invisible to window managers; option B<-override-redirect>.	1261	it almost invisible to window managers; option B<-override-redirect>.
1255		1262
		1263	=item B<iso14755:> I<boolean>
		1264
		1265	Turn on/off ISO 14755 (default enabled).
		1266
1256	=item B<iso14755_52:> I<boolean>	1267	=item B<iso14755_52:> I<boolean>
1257		1268
1258	Turn on/off ISO 14755 5.2 mode (default enabled).	1269	Turn on/off ISO 14755 5.2 mode (default enabled).
		1270
		1271	=back
		1272
		1273	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
		1274
		1275	=over 4
		1276
		1277	=item B<-pixmap> I<file[;oplist]>
		1278
		1279	=item B<backgroundPixmap:> I<file[;oplist]>
		1280
		1281	Compile I<pixbuf>: Use the specified image file as the window's
		1282	background and also optionally specify a colon separated list of
		1283	operations to modify it. Note that you may need to quote the C<;>
		1284	character when using the command line option, as C<;> is usually a
		1285	metacharacter in shells. Supported operations are:
		1286
		1287	=over 4
		1288
		1289	=item B<WxH+X+Y>
		1290
		1291	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		1292	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		1293	scale of 0 disables scaling.
		1294
		1295	=item B<op=tile>
		1296
		1297	enables tiling
		1298
		1299	=item B<op=keep-aspect>
		1300
		1301	maintain the image aspect ratio when scaling
		1302
		1303	=item B<op=root-align>
		1304
		1305	use the position of the terminal window relative to the root window as
		1306	the image offset, simulating a root window background
		1307
		1308	=back
		1309
		1310	The default scale and position setting is C<100x100+50+50>.
		1311	Alternatively, a predefined set of templates can be used to achieve
		1312	the most common setups:
		1313
		1314	=over 4
		1315
		1316	=item B<style=tiled>
		1317
		1318	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		1319
		1320	=item B<style=aspect-stretched>
		1321
		1322	the image is scaled to fill the whole window maintaining the aspect
		1323	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		1324
		1325	=item B<style=stretched>
		1326
		1327	the image is scaled to fill the whole window. Equivalent to 100x100
		1328
		1329	=item B<style=centered>
		1330
		1331	the image is centered with no scaling. Equivalent to 0x0+50+50
		1332
		1333	=item B<style=root-tiled>
		1334
		1335	the image is tiled with no scaling and using 'root' positioning.
		1336	Equivalent to 0x0:op=tile:op=root-align
		1337
		1338	=back
		1339
		1340	If multiple templates are specified the last one wins. Note that a
		1341	template overrides all the scale, position and operations settings.
		1342
		1343	If used in conjunction with pseudo-transparency, the specified pixmap
		1344	will be blended over the transparent background using alpha-blending.
		1345
		1346	=item B<-tr>\|B<+tr>
		1347
		1348	=item B<transparent:> I<boolean>
		1349
		1350	Turn on/off pseudo-transparency by using the root pixmap as background.
		1351
		1352	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
		1353	will be removed in future versions.
		1354
		1355	=item B<-tint> I<colour>
		1356
		1357	=item B<tintColor:> I<colour>
		1358
		1359	Tint the transparent background with the given colour. Note that a
		1360	black tint yields a completely black image while a white tint yields
		1361	the image unchanged.
		1362
		1363	=item B<-sh> I<number>
		1364
		1365	=item B<shading:> I<number>
		1366
		1367	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
		1368	A value of 100 means no shading.
		1369
		1370	=item B<-blr> I<HxV>
		1371
		1372	=item B<blurRadius:> I<HxV>
		1373
		1374	Apply gaussian blur with the specified radius to the transparent
		1375	background. If a single number is specified, the vertical and
		1376	horizontal radii are considered to be the same. Setting one of the
		1377	radii to 1 and the other to a large number creates interesting effects
		1378	on some backgrounds. The maximum radius value is 128. An horizontal or
		1379	vertical radius of 0 disables blurring.
		1380
		1381	=item B<path:> I<path>
		1382
		1383	Specify the colon-delimited search path for finding background image files.
1259		1384
1260	=back	1385	=back
1261		1386
1262	=head1 THE SCROLLBAR	1387	=head1 THE SCROLLBAR
1263		1388
…		…
1311	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1436	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1312	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.	1437	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1313		1438
1314	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1439	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1315	inserted too.	1440	inserted too.
		1441
		1442	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1443	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1444	binding causes the value of the internal selection to be copied to the
		1445	CLIPBOARD selection, while the second binding causes the value of the
		1446	CLIPBOARD selection to be inserted.
1316		1447
1317	=back	1448	=back
1318		1449
1319	=head1 CHANGING FONTS	1450	=head1 CHANGING FONTS
1320		1451
…		…
1402	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1533	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1403	it can be seen via the I<who(1)> command, and can accept messages. To	1534	it can be seen via the I<who(1)> command, and can accept messages. To
1404	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1535	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1405	on some systems or setgid to root or to some other group on others.	1536	on some systems or setgid to root or to some other group on others.
1406		1537
1407	=head1 COLORS AND GRAPHICS	1538	=head1 COLOURS AND GRAPHICS
1408		1539
1409	In addition to the default foreground and background colours,	1540	In addition to the default foreground and background colours,
1410	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1541	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1411	high-intensity bold/blink versions of the same). Here is a list of the	1542	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1412	colours with their names.	1543	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1544	cube plus a 8 (24) colour greyscale ramp.
		1545
		1546	Here is a list of the ANSI colours with their names.
1413		1547
1414	=begin table	1548	=begin table
1415		1549
1416	B<color0> (black) = Black	1550	B<color0> (black) = Black
1417	B<color1> (red) = Red3	1551	B<color1> (red) = Red3
…		…
1437	It is also possible to specify the colour values of B<foreground>,	1571	It is also possible to specify the colour values of B<foreground>,
1438	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1572	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1439	a number 0-15, as a convenient shorthand to reference the colour name of	1573	a number 0-15, as a convenient shorthand to reference the colour name of
1440	color0-color15.	1574	color0-color15.
1441		1575
1442	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1576	The following text gives values for the standard 88 colour mode (and
1443	additional 72 colours. The first 64 of those (with indices 16 to 79)	1577	values for the 256 colour mode in parentheses).
1444	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1445	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1446		1578
		1579	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1580
		1581	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1582	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
		1583
		1584	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1585	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1586	the RGB cube.
		1587
1447	Together, all those colours implement the 88 colour xterm colours. Only	1588	Together, all those colours implement the 88 (256) colour xterm
1448	the first 16 can be changed using resources currently, the rest can only	1589	colours. Only the first 16 can be changed using resources currently, the
1449	be changed via command sequences ("escape codes").	1590	rest can only be changed via command sequences ("escape codes").
		1591
		1592	Applications are advised to use terminfo or command sequences to discover
		1593	number and RGB values of all colours (yes, you can query this...).
1450		1594
1451	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1595	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1452	always swapping the foreground/background colours. This is in contrast to	1596	always swapping the foreground/background colours. This is in contrast to
1453	I<xterm>(1) where the colours are only swapped if they have not otherwise	1597	I<xterm>(1) where the colours are only swapped if they have not otherwise
1454	been specified. For example,	1598	been specified. For example,
1455		1599
1456	=over 4
1457
1458	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1600	@@RXVT_NAME@@ -fg Black -bg White -rv
1459		1601
1460	would yield White on Black, while on I<xterm>(1) it would yield Black	1602	would yield White on Black, while on I<xterm>(1) it would yield Black on
1461	on White.	1603	White.
1462
1463	=back
1464		1604
1465	=head2 ALPHA CHANNEL SUPPORT	1605	=head2 ALPHA CHANNEL SUPPORT
1466		1606
1467	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1607	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1468	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1608	their act together, rxvt-unicode will do its own alpha channel management:
1469	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1609
1470	in addition to the ones provided by X, where the additional A component	1610	You can prefix any colour with an opaqueness percentage enclosed in
		1611	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1612	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1613	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1614	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1615	is the recommended format to specify transparency values, and works with
		1616	all ways to specify a colour.
		1617
		1618	For complete control, rxvt-unicode also supports
		1619	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1620	specifications, where the additional C<aaaa> component specifies opacity
1471	specifies opacity (alpha) values. The minimum value of C<0> is completely	1621	(alpha) values. The minimum value of C<0000> is completely transparent,
1472	transparent). You can also prefix any color with C<[percent]>, where	1622	while C<ffff> is completely opaque). The two example colours from
1473	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1623	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1474	the color, where C<0> is completely transparent and C<100> is completelxy	1624	C<rgba:0000/ff00/0000/f332>.
1475	opaque.
1476		1625
1477	You probably need to specify B<"-depth 32">, too, and have the luck that	1626	You probably need to specify B<"-depth 32">, too, to force a visual with
1478	your X-server uses ARGB pixel layout, as X is far from just supporting	1627	alpha channels, and have the luck that your X-server uses ARGB pixel
1479	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1628	layout, as X is far from just supporting ARGB visuals out of the box, and
		1629	rxvt-unicode just fudges around.
1480		1630
1481	For example, the following selects an almost completely transparent red	1631	For example, the following selects an almost completely transparent black
1482	background, and an almost opaque pink foreground:	1632	background, and an almost opaque pink foreground:
1483		1633
1484	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1634	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1485		1635
1486	I<Please note that transparency of any kind if completely unsupported by	1636	When not using a background image, then the interpretation of the
1487	the author. Don't bug him with installation questions!>	1637	alpha channel is up to your compositing manager (most interpret it as
		1638	transparency of course).
		1639
		1640	When using a background pixmap or pseudo-transparency, then the background
		1641	colour will always behave as if it were completely transparent (so the
		1642	background image shows instead), regardless of how it was specified, while
		1643	other colours will either be transparent as specified (the background
		1644	image will show through) on servers supporting the RENDER extension, or
		1645	fully opaque on servers not supporting the RENDER EXTENSION.
		1646
		1647	Please note that due to bugs in Xft, specifying alpha values might result
		1648	in garbage being displayed when the X-server does not support the RENDER
		1649	extension.
1488		1650
1489	=head1 ENVIRONMENT	1651	=head1 ENVIRONMENT
1490		1652
1491	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1653	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1492		1654
…		…
1526	C<--with-terminfo=PATH>.	1688	C<--with-terminfo=PATH>.
1527		1689
1528	=item B<DISPLAY>	1690	=item B<DISPLAY>
1529		1691
1530	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1692	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1531	display in its child processes.	1693	display in its child processes if C<-display> isn't used to override. It
		1694	defaults to C<:0> if it doesn't exist.
1532		1695
1533	=item B<SHELL>	1696	=item B<SHELL>
1534		1697
1535	The shell to be used for command execution, defaults to C</bin/sh>.	1698	The shell to be used for command execution, defaults to C</bin/sh>.
1536		1699
1537	=item B<RXVT_SOCKET>	1700	=item B<RXVT_SOCKET> [I<sic>]
1538		1701
1539	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1702	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1540	@@RXVT_NAME@@d(1).	1703	@@RXVT_NAME@@d(1).
1541		1704
1542	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1705	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1706
		1707	=item B<URXVT_PERL_LIB>
		1708
		1709	Additional F<:>-separated library search path for perl extensions. Will be
		1710	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1711	directory.
		1712
		1713	=item B<URXVT_PERL_VERBOSITY>
		1714
		1715	See L<@@RXVT_NAME@@perl>(3).
1543		1716
1544	=item B<HOME>	1717	=item B<HOME>
1545		1718
1546	Used to locate the default directory for the unix domain socket for	1719	Used to locate the default directory for the unix domain socket for
1547	daemon communications and to locate various resource files (such as	1720	daemon communications and to locate various resource files (such as
1548	C<.Xdefaults>)	1721	C<.Xdefaults>)
1549		1722
1550	=item B<XAPPLRESDIR>	1723	=item B<XAPPLRESDIR>
1551		1724
1552	Directory where various X resource files are being located.	1725	Directory where application-specific X resource files are located.
1553		1726
1554	=item B<XENVIRONMENT>	1727	=item B<XENVIRONMENT>
1555		1728
1556	If set and accessible, gives the name of a X resource file to be loaded by	1729	If set and accessible, gives the name of a X resource file to be loaded by
1557	@@RXVT_NAME@@.	1730	@@RXVT_NAME@@.
…		…
1562		1735
1563	=over 4	1736	=over 4
1564		1737
1565	=item B</usr/lib/X11/rgb.txt>	1738	=item B</usr/lib/X11/rgb.txt>
1566		1739
1567	Color names.	1740	Colour names.
1568		1741
1569	=back	1742	=back
1570		1743
1571	=head1 SEE ALSO	1744	=head1 SEE ALSO
1572		1745
		1746	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1573	@@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)	1747	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1574		1748
1575	=head1 CURRENT PROJECT COORDINATOR	1749	=head1 CURRENT PROJECT COORDINATOR
1576		1750
1577	=over 4	1751	=over 4
1578		1752
1579	=item Project Coordinator	1753	=item Project Coordinator
1580		1754
1581	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1755	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1582		1756
1583	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1757	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1584		1758
1585	=back	1759	=back
1586		1760
…		…
1590		1764
1591	=item John Bovey	1765	=item John Bovey
1592		1766
1593	University of Kent, 1992, wrote the original Xvt.	1767	University of Kent, 1992, wrote the original Xvt.
1594		1768
1595	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1769	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1596		1770
1597	very heavily modified Xvt and came up with Rxvt	1771	very heavily modified Xvt and came up with Rxvt
1598		1772
1599	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1773	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1600		1774
1601	wrote the Greek Keyboard Input (no longer in code)	1775	wrote the Greek Keyboard Input (no longer in code)
1602		1776
1603	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1777	=item mj olesen <olesen@me.QueensU.CA>
1604		1778
1605	Wrote the menu system.	1779	Wrote the menu system.
1606		1780
1607	Project Coordinator (changes.txt 2.11 to 2.21)	1781	Project Coordinator (changes.txt 2.11 to 2.21)
1608		1782
1609	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1783	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1610		1784
1611	Project Coordinator (changes.txt 2.21a to 2.4.5)	1785	Project Coordinator (changes.txt 2.21a to 2.4.5)
1612		1786
1613	=item Geoff Wing L<< <gcw@pobox.com> >>	1787	=item Geoff Wing <gcw@pobox.com>
1614		1788
1615	Rewrote screen display and text selection routines.	1789	Rewrote screen display and text selection routines.
1616		1790
1617	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1791	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1618		1792
1619	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1793	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1620		1794
1621	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1795	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1622	extension, random hacks, numerous bugfixes and extensions.	1796	extension, random hacks, numerous bugfixes and extensions.
1623		1797
1624	Project Coordinator (Changes 1.0 -)	1798	Project Coordinator (Changes 1.0 -)
1625		1799
1626	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1800	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1627		1801
1628	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1802	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1629		1803
1630	=back	1804	=back
1631		1805

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.153 by root, Wed Dec 12 19:57:13 2007 UTC vs. Revision 1.228 by root, Sun Apr 27 19:43:46 2014 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.153 by root, Wed Dec 12 19:57:13 2007 UTC vs.
Revision 1.228 by root, Sun Apr 27 19:43:46 2014 UTC