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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.156 by ayin, Sun Dec 30 22:43:40 2007 UTC vs.
Revision 1.230 by sf-exg, Mon Apr 28 16:00:34 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
…		…
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.
…		…
811	option B<-is>, the default), bold/blink 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<scrollstyle:> I<mode>
817
818	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
819	the author's favourite.
820
821	=item B<title:> I<string>	751	=item B<title:> I<string>
822		752
823	Set window title string, the default title is the command-line	753	Set window title string, the default title is the command-line
824	specified after the B<-e> option, if any, otherwise the application	754	specified after the B<-e> option, if any, otherwise the application
825	name; option B<-title>.	755	name; option B<-title>.
…		…
838	=item B<urgentOnBell:> I<boolean>	768	=item B<urgentOnBell:> I<boolean>
839		769
840	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.
841	B<False>: do not set the urgency hint [default].	771	B<False>: do not set the urgency hint [default].
842		772
		773	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		774
843	=item B<visualBell:> I<boolean>	775	=item B<visualBell:> I<boolean>
844		776
845	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>.
846	B<False>: no visual bell [default]; option B<+vb>.	778	B<False>: no visual bell [default]; option B<+vb>.
847		779
…		…
870	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)	802	URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
871		803
872	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
873	every time you hit C<Print>.	805	every time you hit C<Print>.
874		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
875	=item B<scrollBar:> I<boolean>	816	=item B<scrollBar:> I<boolean>
876		817
877	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	818	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
878	disable the scrollbar; option B<+sb>.	819	disable the scrollbar; option B<+sb>.
879		820
…		…
898	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
899	B<+si>.	840	B<+si>.
900		841
901	=item B<scrollWithBuffer:> I<boolean>	842	=item B<scrollWithBuffer:> I<boolean>
902		843
903	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.
904	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
905	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>.
906		848
907	=item B<scrollTtyKeypress:> I<boolean>	849	=item B<scrollTtyKeypress:> I<boolean>
908		850
909	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
910	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
…		…
966	=item B<cursorBlink:> I<boolean>	908	=item B<cursorBlink:> I<boolean>
967		909
968	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];
969	option B<-bc>.	911	option B<-bc>.
970		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
971	=item B<pointerBlank:> I<boolean>	918	=item B<pointerBlank:> I<boolean>
972		919
973	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
974	of seconds of inactivity. B<False>: the pointer is always visible	921	of seconds of inactivity. B<False>: the pointer is always visible
975	[default].	922	[default].
…		…
988	large number (e.g. C<987654321>) to effectively disable the timeout.	935	large number (e.g. C<987654321>) to effectively disable the timeout.
989		936
990	=item B<backspacekey:> I<string>	937	=item B<backspacekey:> I<string>
991		938
992	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>
993	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>
994	(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
995	escape sequence.	942	escape sequence.
996		943
997	=item B<deletekey:> I<string>	944	=item B<deletekey:> I<string>
998		945
…		…
1077		1024
1078	=item B<secondaryScroll:> I<boolean>	1025	=item B<secondaryScroll:> I<boolean>
1079		1026
1080	Turn on/off secondary screen scroll (default enabled). If this	1027	Turn on/off secondary screen scroll (default enabled). If this
1081	option is enabled, scrolls on the secondary screen will change the	1028	option is enabled, scrolls on the secondary screen will change the
1082	scrollback buffer and switching to/from the secondary screen will	1029	scrollback buffer and, when secondaryScreen is off, switching
1083	instead scroll the screen up.	1030	to/from the secondary screen will instead scroll the screen up.
1084		1031
1085	=item B<hold>: I<boolean>	1032	=item B<hold>: I<boolean>
1086		1033
1087	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@@
1088	will not immediately destroy its window when the program executed within	1035	will not immediately destroy its window when the program executed within
1089	it exits. Instead, it will wait till it is being killed or closed by the	1036	it exits. Instead, it will wait till it is being killed or closed by the
1090	user.	1037	user.
1091		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
1092	=item B<keysym.>I<sym>: I<string>	1046	=item B<keysym.>I<sym>: I<action>
1093		1047
1094	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1048	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1095	intervening resource name B<keysym.> cannot be omitted.	1049	resource name B<keysym.> cannot be omitted.
1096		1050
1097	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
1098	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1052	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1099	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
1100	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
1101	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>.
1102		1065
1103	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
1104	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
1105	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
1106	current application keymap mode state.	1069	current application keymap mode state.
1107		1070
1108	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
1109	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
1110	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
1111	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1083	value (B<0x0000 - 0xFFFF>).
1112	performed in an exact manner; however, the closest match is assured.
1113		1084
1114	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
1115	number), see RESOURCES in C<man 7 X> for futher details.	1087	number), see RESOURCES in C<man 7 X> for further details.
1116		1088
1117	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
1118	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1090	of action, followed by a colon. An action strings without colons is
1119	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:>).
1120		1093
1121	Its usage can be demonstrated by an example:	1094	The following action prefixes are known - extensions can provide
		1095	additional prefixes:
1122		1096
1123	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1097	=over 4
1124		1098
1125	The above line is equivalent to the following three lines:	1099	=item string:STRING
1126		1100
1127	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1101	If the I<action> starts with C<string:> (or otherwise contains no colons),
1128	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1102	then the remaining C<STRING> will be passed to the program running in the
1129	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:
1130		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
1131	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>
1132	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
1133	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>
1134	when Control-Meta-c is being pressed":	1119	when Control-Meta-c is being pressed":
1135		1120
1136	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
1137		1122
1138	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
1139	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
1140	manpage. For example, the F<selection> extension (activated via	1125	font-switching at runtime:
1141	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1142		1126
1143	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
1144		1129
1145	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
1146	will match if at I<at least> the specified identifiers are being set, and	1131	info):
1147	no other key mappings with those and more bits are being defined. That
1148	means that defining a key map for C<a> will automatically provide
1149	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1150	mappings themselves.
1151		1132
1152	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
1153	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
1154	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
1155	user-defined keymap using the C<builtin:> replacement:	1145	"holes" into the user-defined keymap using the C<builtin:> replacement:
1156		1146
1157	URxvt.keysym.Insert: <my insert key sequence>	1147	URxvt.keysym.Insert: <my insert key sequence>
1158	URxvt.keysym.S-Insert: builtin:	1148	URxvt.keysym.S-Insert: builtin:
1159		1149
1160	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
1161	of modifiers. The second line re-establishes the default mapping for	1151	of modifiers. The second line re-establishes the default mapping for
1162	C<Shift-Insert>.	1152	C<Shift-Insert>.
1163		1153
1164	The following example will map Control-Meta-1 and Control-Meta-2 to	1154	=item builtin-string:
1165	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1166	font-switching at runtime:
1167		1155
1168	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1156	This action is mainly useful to restore string mappings for keys that
1169	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1157	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1158	difficult to explain - basically, this action will send the string to the
		1159	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1160	action for it.
1170		1161
1171	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1162	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1172	info):	1163	selection when you press C<Shift-Insert>. With the following bindings, it
		1164	would instead emit the (undocumented, but what applications running in the
		1165	terminal might expect) sequence C<ESC [ 2 $> instead:
1173		1166
1174	URxvt.keysym.M-C-3: command:\033[8;25;80t	1167	URxvt.keysym.S-Insert: builtin-string:
1175	URxvt.keysym.M-C-4: command:\033[8;48;110t	1168	URxvt.keysym.C-S-Insert: builtin:
		1169
		1170	The first line disables the paste functionality for that key
		1171	combination, and the second reinstates the default behaviour for
		1172	C<Control-Shift-Insert>, which would otherwise be overridden.
		1173
		1174	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1175	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1176	this:
		1177
		1178	URxvt.keysym.C-S-c: builtin-string:
		1179	URxvt.keysym.C-S-v: builtin-string:
		1180
		1181	=item EXTENSION:STRING
		1182
		1183	An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)
		1184	extension of the same name. The extension will be loaded automatically if
		1185	neccessary.
		1186
		1187	Not all extensions define key actions, but popular extensions that do
		1188	include the I<selection> and I<matcher> extensions (documented in their
		1189	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1190	respectively).
		1191
		1192	From the silly examples department, this will rot13-"encrypt"
		1193	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1194	keyboards:
		1195
		1196	URxvt.keysym.M-C-c: selection:rot13
		1197
		1198	=item perl:STRING
		1199
		1200	This is a deprecated way of passing key mappings to perl extensions. It is
		1201	still supported, but should not be used anymore.
		1202
		1203	=back
		1204
		1205	In addition, you can define a range of keysyms in one shot by loading
		1206	the C<keysym-list> perl extension and providing a I<string> with pattern
		1207	B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' should be a
		1208	character not used by the strings.
		1209
		1210	Its usage can be demonstrated by an example:
		1211
		1212	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
		1213
		1214	The above line is equivalent to the following three lines:
		1215
		1216	URxvt.keysym.Meta-Control-0x61: \033<a>
		1217	URxvt.keysym.Meta-Control-0x62: \033<b>
		1218	URxvt.keysym.Meta-Control-0x63: \033<c>
1176		1219
1177	=item B<perl-ext-common>: I<string>	1220	=item B<perl-ext-common>: I<string>
1178		1221
1179	=item B<perl-ext>: I<string>	1222	=item B<perl-ext>: I<string>
1180		1223
…		…
1202	all instances, while B<perl-ext> is used for specific instances.	1245	all instances, while B<perl-ext> is used for specific instances.
1203		1246
1204	=item B<perl-eval>: I<string>	1247	=item B<perl-eval>: I<string>
1205		1248
1206	Perl code to be evaluated when all extensions have been registered. See	1249	Perl code to be evaluated when all extensions have been registered. See
1207	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1250	the @@RXVT_NAME@@perl(3) manpage.
1208	will be ignored when running setuid/setgid.
1209		1251
1210	=item B<perl-lib>: I<path>	1252	=item B<perl-lib>: I<path>
1211		1253
1212	Colon-separated list of additional directories that hold extension	1254	Colon-separated list of additional directories that hold extension
1213	scripts. When looking for extensions specified by the C<perl> resource,	1255	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1214	@@RXVT_NAME@@ will first look in these directories and then in	1256	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1215	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1257	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1216	will be ignored when running setuid/setgid.
1217		1258
1218	See the @@RXVT_NAME@@perl(3) manpage.	1259	See the @@RXVT_NAME@@perl(3) manpage.
1219		1260
1220	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1261	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1221		1262
…		…
1230	=item B<searchable-scrollback:> I<keysym>	1271	=item B<searchable-scrollback:> I<keysym>
1231		1272
1232	Sets the hotkey that starts the incremental scrollback buffer search	1273	Sets the hotkey that starts the incremental scrollback buffer search
1233	(default: C<M-s>).	1274	(default: C<M-s>).
1234		1275
1235	=item B<urlLauncher>: I<string>	1276	=item B<url-launcher>: I<string>
1236		1277
1237	Specifies the program to be started with a URL argument. Used by the	1278	Specifies the program to be started with a URL argument. Used by the
1238	C<selection-popup> and C<matcher> perl extensions.	1279	C<selection-popup> and C<matcher> perl extensions.
1239		1280
1240	=item B<transient-for>: I<windowid>	1281	=item B<transient-for>: I<windowid>
…		…
1244	=item B<override-redirect>: I<boolean>	1285	=item B<override-redirect>: I<boolean>
1245		1286
1246	Compile I<frills>: Sets override-redirect for the terminal window, making	1287	Compile I<frills>: Sets override-redirect for the terminal window, making
1247	it almost invisible to window managers; option B<-override-redirect>.	1288	it almost invisible to window managers; option B<-override-redirect>.
1248		1289
		1290	=item B<iso14755:> I<boolean>
		1291
		1292	Turn on/off ISO 14755 (default enabled).
		1293
1249	=item B<iso14755_52:> I<boolean>	1294	=item B<iso14755_52:> I<boolean>
1250		1295
1251	Turn on/off ISO 14755 5.2 mode (default enabled).	1296	Turn on/off ISO 14755 5.2 mode (default enabled).
		1297
		1298	=back
		1299
		1300	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
		1301
		1302	=over 4
		1303
		1304	=item B<-pixmap> I<file[;oplist]>
		1305
		1306	=item B<backgroundPixmap:> I<file[;oplist]>
		1307
		1308	Compile I<pixbuf>: Use the specified image file as the window's
		1309	background and also optionally specify a colon separated list of
		1310	operations to modify it. Note that you may need to quote the C<;>
		1311	character when using the command line option, as C<;> is usually a
		1312	metacharacter in shells. Supported operations are:
		1313
		1314	=over 4
		1315
		1316	=item B<WxH+X+Y>
		1317
		1318	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		1319	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		1320	scale of 0 disables scaling.
		1321
		1322	=item B<op=tile>
		1323
		1324	enables tiling
		1325
		1326	=item B<op=keep-aspect>
		1327
		1328	maintain the image aspect ratio when scaling
		1329
		1330	=item B<op=root-align>
		1331
		1332	use the position of the terminal window relative to the root window as
		1333	the image offset, simulating a root window background
		1334
		1335	=back
		1336
		1337	The default scale and position setting is C<100x100+50+50>.
		1338	Alternatively, a predefined set of templates can be used to achieve
		1339	the most common setups:
		1340
		1341	=over 4
		1342
		1343	=item B<style=tiled>
		1344
		1345	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		1346
		1347	=item B<style=aspect-stretched>
		1348
		1349	the image is scaled to fill the whole window maintaining the aspect
		1350	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		1351
		1352	=item B<style=stretched>
		1353
		1354	the image is scaled to fill the whole window. Equivalent to 100x100
		1355
		1356	=item B<style=centered>
		1357
		1358	the image is centered with no scaling. Equivalent to 0x0+50+50
		1359
		1360	=item B<style=root-tiled>
		1361
		1362	the image is tiled with no scaling and using 'root' positioning.
		1363	Equivalent to 0x0:op=tile:op=root-align
		1364
		1365	=back
		1366
		1367	If multiple templates are specified the last one wins. Note that a
		1368	template overrides all the scale, position and operations settings.
		1369
		1370	If used in conjunction with pseudo-transparency, the specified pixmap
		1371	will be blended over the transparent background using alpha-blending.
		1372
		1373	=item B<-tr>\|B<+tr>
		1374
		1375	=item B<transparent:> I<boolean>
		1376
		1377	Turn on/off pseudo-transparency by using the root pixmap as background.
		1378
		1379	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
		1380	will be removed in future versions.
		1381
		1382	=item B<-tint> I<colour>
		1383
		1384	=item B<tintColor:> I<colour>
		1385
		1386	Tint the transparent background with the given colour. Note that a
		1387	black tint yields a completely black image while a white tint yields
		1388	the image unchanged.
		1389
		1390	=item B<-sh> I<number>
		1391
		1392	=item B<shading:> I<number>
		1393
		1394	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
		1395	A value of 100 means no shading.
		1396
		1397	=item B<-blr> I<HxV>
		1398
		1399	=item B<blurRadius:> I<HxV>
		1400
		1401	Apply gaussian blur with the specified radius to the transparent
		1402	background. If a single number is specified, the vertical and
		1403	horizontal radii are considered to be the same. Setting one of the
		1404	radii to 1 and the other to a large number creates interesting effects
		1405	on some backgrounds. The maximum radius value is 128. An horizontal or
		1406	vertical radius of 0 disables blurring.
		1407
		1408	=item B<path:> I<path>
		1409
		1410	Specify the colon-delimited search path for finding background image files.
1252		1411
1253	=back	1412	=back
1254		1413
1255	=head1 THE SCROLLBAR	1414	=head1 THE SCROLLBAR
1256		1415
…		…
1304	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1463	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1305	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.	1464	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1306		1465
1307	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1466	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1308	inserted too.	1467	inserted too.
		1468
		1469	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1470	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1471	binding causes the value of the internal selection to be copied to the
		1472	CLIPBOARD selection, while the second binding causes the value of the
		1473	CLIPBOARD selection to be inserted.
1309		1474
1310	=back	1475	=back
1311		1476
1312	=head1 CHANGING FONTS	1477	=head1 CHANGING FONTS
1313		1478
…		…
1395	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1560	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1396	it can be seen via the I<who(1)> command, and can accept messages. To	1561	it can be seen via the I<who(1)> command, and can accept messages. To
1397	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1562	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1398	on some systems or setgid to root or to some other group on others.	1563	on some systems or setgid to root or to some other group on others.
1399		1564
1400	=head1 COLORS AND GRAPHICS	1565	=head1 COLOURS AND GRAPHICS
1401		1566
1402	In addition to the default foreground and background colours,	1567	In addition to the default foreground and background colours,
1403	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1568	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1404	high-intensity bold/blink versions of the same). Here is a list of the	1569	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1405	colours with their names.	1570	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1571	cube plus a 8 (24) colour greyscale ramp.
		1572
		1573	Here is a list of the ANSI colours with their names.
1406		1574
1407	=begin table	1575	=begin table
1408		1576
1409	B<color0> (black) = Black	1577	B<color0> (black) = Black
1410	B<color1> (red) = Red3	1578	B<color1> (red) = Red3
…		…
1430	It is also possible to specify the colour values of B<foreground>,	1598	It is also possible to specify the colour values of B<foreground>,
1431	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1599	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1432	a number 0-15, as a convenient shorthand to reference the colour name of	1600	a number 0-15, as a convenient shorthand to reference the colour name of
1433	color0-color15.	1601	color0-color15.
1434		1602
1435	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1603	The following text gives values for the standard 88 colour mode (and
1436	additional 72 colours. The first 64 of those (with indices 16 to 79)	1604	values for the 256 colour mode in parentheses).
1437	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1438	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1439		1605
		1606	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1607
		1608	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1609	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
		1610
		1611	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1612	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1613	the RGB cube.
		1614
1440	Together, all those colours implement the 88 colour xterm colours. Only	1615	Together, all those colours implement the 88 (256) colour xterm
1441	the first 16 can be changed using resources currently, the rest can only	1616	colours. Only the first 16 can be changed using resources currently, the
1442	be changed via command sequences ("escape codes").	1617	rest can only be changed via command sequences ("escape codes").
		1618
		1619	Applications are advised to use terminfo or command sequences to discover
		1620	number and RGB values of all colours (yes, you can query this...).
1443		1621
1444	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1622	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1445	always swapping the foreground/background colours. This is in contrast to	1623	always swapping the foreground/background colours. This is in contrast to
1446	I<xterm>(1) where the colours are only swapped if they have not otherwise	1624	I<xterm>(1) where the colours are only swapped if they have not otherwise
1447	been specified. For example,	1625	been specified. For example,
1448		1626
1449	=over 4
1450
1451	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1627	@@RXVT_NAME@@ -fg Black -bg White -rv
1452		1628
1453	would yield White on Black, while on I<xterm>(1) it would yield Black	1629	would yield White on Black, while on I<xterm>(1) it would yield Black on
1454	on White.	1630	White.
1455
1456	=back
1457		1631
1458	=head2 ALPHA CHANNEL SUPPORT	1632	=head2 ALPHA CHANNEL SUPPORT
1459		1633
1460	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1634	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1461	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1635	their act together, rxvt-unicode will do its own alpha channel management:
1462	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1636
1463	in addition to the ones provided by X, where the additional A component	1637	You can prefix any colour with an opaqueness percentage enclosed in
		1638	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1639	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1640	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1641	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1642	is the recommended format to specify transparency values, and works with
		1643	all ways to specify a colour.
		1644
		1645	For complete control, rxvt-unicode also supports
		1646	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1647	specifications, where the additional C<aaaa> component specifies opacity
1464	specifies opacity (alpha) values. The minimum value of C<0> is completely	1648	(alpha) values. The minimum value of C<0000> is completely transparent,
1465	transparent). You can also prefix any color with C<[percent]>, where	1649	while C<ffff> is completely opaque). The two example colours from
1466	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1650	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1467	the color, where C<0> is completely transparent and C<100> is completelxy	1651	C<rgba:0000/ff00/0000/f332>.
1468	opaque.
1469		1652
1470	You probably need to specify B<"-depth 32">, too, and have the luck that	1653	You probably need to specify B<"-depth 32">, too, to force a visual with
1471	your X-server uses ARGB pixel layout, as X is far from just supporting	1654	alpha channels, and have the luck that your X-server uses ARGB pixel
1472	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1655	layout, as X is far from just supporting ARGB visuals out of the box, and
		1656	rxvt-unicode just fudges around.
1473		1657
1474	For example, the following selects an almost completely transparent red	1658	For example, the following selects an almost completely transparent black
1475	background, and an almost opaque pink foreground:	1659	background, and an almost opaque pink foreground:
1476		1660
1477	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1661	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1478		1662
1479	I<Please note that transparency of any kind if completely unsupported by	1663	When not using a background image, then the interpretation of the
1480	the author. Don't bug him with installation questions!>	1664	alpha channel is up to your compositing manager (most interpret it as
		1665	transparency of course).
		1666
		1667	When using a background pixmap or pseudo-transparency, then the background
		1668	colour will always behave as if it were completely transparent (so the
		1669	background image shows instead), regardless of how it was specified, while
		1670	other colours will either be transparent as specified (the background
		1671	image will show through) on servers supporting the RENDER extension, or
		1672	fully opaque on servers not supporting the RENDER EXTENSION.
		1673
		1674	Please note that due to bugs in Xft, specifying alpha values might result
		1675	in garbage being displayed when the X-server does not support the RENDER
		1676	extension.
1481		1677
1482	=head1 ENVIRONMENT	1678	=head1 ENVIRONMENT
1483		1679
1484	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1680	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1485		1681
…		…
1519	C<--with-terminfo=PATH>.	1715	C<--with-terminfo=PATH>.
1520		1716
1521	=item B<DISPLAY>	1717	=item B<DISPLAY>
1522		1718
1523	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1719	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1524	display in its child processes.	1720	display in its child processes if C<-display> isn't used to override. It
		1721	defaults to C<:0> if it doesn't exist.
1525		1722
1526	=item B<SHELL>	1723	=item B<SHELL>
1527		1724
1528	The shell to be used for command execution, defaults to C</bin/sh>.	1725	The shell to be used for command execution, defaults to C</bin/sh>.
1529		1726
1530	=item B<RXVT_SOCKET>	1727	=item B<RXVT_SOCKET> [I<sic>]
1531		1728
1532	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1729	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1533	@@RXVT_NAME@@d(1).	1730	@@RXVT_NAME@@d(1).
1534		1731
1535	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1732	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1733
		1734	=item B<URXVT_PERL_LIB>
		1735
		1736	Additional F<:>-separated library search path for perl extensions. Will be
		1737	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1738	directory.
		1739
		1740	=item B<URXVT_PERL_VERBOSITY>
		1741
		1742	See L<@@RXVT_NAME@@perl>(3).
1536		1743
1537	=item B<HOME>	1744	=item B<HOME>
1538		1745
1539	Used to locate the default directory for the unix domain socket for	1746	Used to locate the default directory for the unix domain socket for
1540	daemon communications and to locate various resource files (such as	1747	daemon communications and to locate various resource files (such as
1541	C<.Xdefaults>)	1748	C<.Xdefaults>)
1542		1749
1543	=item B<XAPPLRESDIR>	1750	=item B<XAPPLRESDIR>
1544		1751
1545	Directory where various X resource files are being located.	1752	Directory where application-specific X resource files are located.
1546		1753
1547	=item B<XENVIRONMENT>	1754	=item B<XENVIRONMENT>
1548		1755
1549	If set and accessible, gives the name of a X resource file to be loaded by	1756	If set and accessible, gives the name of a X resource file to be loaded by
1550	@@RXVT_NAME@@.	1757	@@RXVT_NAME@@.
…		…
1555		1762
1556	=over 4	1763	=over 4
1557		1764
1558	=item B</usr/lib/X11/rgb.txt>	1765	=item B</usr/lib/X11/rgb.txt>
1559		1766
1560	Color names.	1767	Colour names.
1561		1768
1562	=back	1769	=back
1563		1770
1564	=head1 SEE ALSO	1771	=head1 SEE ALSO
1565		1772
		1773	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1566	@@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)	1774	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1567		1775
1568	=head1 CURRENT PROJECT COORDINATOR	1776	=head1 CURRENT PROJECT COORDINATOR
1569		1777
1570	=over 4	1778	=over 4
1571		1779
1572	=item Project Coordinator	1780	=item Project Coordinator
1573		1781
1574	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1782	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1575		1783
1576	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1784	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1577		1785
1578	=back	1786	=back
1579		1787
…		…
1583		1791
1584	=item John Bovey	1792	=item John Bovey
1585		1793
1586	University of Kent, 1992, wrote the original Xvt.	1794	University of Kent, 1992, wrote the original Xvt.
1587		1795
1588	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1796	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1589		1797
1590	very heavily modified Xvt and came up with Rxvt	1798	very heavily modified Xvt and came up with Rxvt
1591		1799
1592	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1800	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1593		1801
1594	wrote the Greek Keyboard Input (no longer in code)	1802	wrote the Greek Keyboard Input (no longer in code)
1595		1803
1596	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1804	=item mj olesen <olesen@me.QueensU.CA>
1597		1805
1598	Wrote the menu system.	1806	Wrote the menu system.
1599		1807
1600	Project Coordinator (changes.txt 2.11 to 2.21)	1808	Project Coordinator (changes.txt 2.11 to 2.21)
1601		1809
1602	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1810	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1603		1811
1604	Project Coordinator (changes.txt 2.21a to 2.4.5)	1812	Project Coordinator (changes.txt 2.21a to 2.4.5)
1605		1813
1606	=item Geoff Wing L<< <gcw@pobox.com> >>	1814	=item Geoff Wing <gcw@pobox.com>
1607		1815
1608	Rewrote screen display and text selection routines.	1816	Rewrote screen display and text selection routines.
1609		1817
1610	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1818	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1611		1819
1612	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1820	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1613		1821
1614	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1822	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1615	extension, random hacks, numerous bugfixes and extensions.	1823	extension, random hacks, numerous bugfixes and extensions.
1616		1824
1617	Project Coordinator (Changes 1.0 -)	1825	Project Coordinator (Changes 1.0 -)
1618		1826
1619	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1827	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1620		1828
1621	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1829	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1622		1830
1623	=back	1831	=back
1624		1832

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.156 by ayin, Sun Dec 30 22:43:40 2007 UTC vs. Revision 1.230 by sf-exg, Mon Apr 28 16:00:34 2014 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.156 by ayin, Sun Dec 30 22:43:40 2007 UTC vs.
Revision 1.230 by sf-exg, Mon Apr 28 16:00:34 2014 UTC