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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.157 by ayin, Sat Jan 19 16:20:09 2008 UTC vs.
Revision 1.240 by sf-exg, Mon Oct 13 17:05:32 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
…		…
259		219
260	=item B<-ls>\|B<+ls>	220	=item B<-ls>\|B<+ls>
261		221
262	Start as a login-shell/sub-shell; resource B<loginShell>.	222	Start as a login-shell/sub-shell; resource B<loginShell>.
263		223
		224	=item B<-mc> I<milliseconds>
		225
		226	Specify the maximum time between multi-click selections.
		227
264	=item B<-ut>\|B<+ut>	228	=item B<-ut>\|B<+ut>
265		229
266	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	230	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
267	B<utmpInhibit>.	231	B<utmpInhibit>.
268		232
…		…
310		274
311	=item B<-bc>\|B<+bc>	275	=item B<-bc>\|B<+bc>
312		276
313	Blink the cursor; resource B<cursorBlink>.	277	Blink the cursor; resource B<cursorBlink>.
314		278
		279	=item B<-uc>\|B<+uc>
		280
		281	Make the cursor underlined; resource B<cursorUnderline>.
		282
315	=item B<-iconic>	283	=item B<-iconic>
316		284
317	Start iconified, if the window manager supports that option.	285	Start iconified, if the window manager supports that option.
318	Alternative form is B<-ic>.	286	Alternative form is B<-ic>.
319		287
…		…
335		303
336	=item B<-bl>	304	=item B<-bl>
337		305
338	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	306	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	307	if honoured by the WM, the rxvt-unicode window will not have window
340	decorations; resource B<borderLess>.	308	decorations; resource B<borderLess>. If the window manager does not
		309	support MWM hints (e.g. kwin), enables override-redirect mode.
341		310
342	=item B<-override-redirect>	311	=item B<-override-redirect>
343		312
344	Compile I<frills>: Sets override-redirect on the window; resource	313	Compile I<frills>: Sets override-redirect on the window; resource
345	B<override-redirect>.	314	B<override-redirect>.
		315
		316	=item B<-dockapp>
		317
		318	Sets the initial state of the window to WithdrawnState, which makes
		319	window managers that support this extension treat it as a dockapp.
346		320
347	=item B<-sbg>	321	=item B<-sbg>
348		322
349	Compile I<frills>: Disable the usage of the built-in block graphics/line	323	Compile I<frills>: Disable the usage of the built-in block graphics/line
350	drawing characters and just rely on what the specified fonts provide. Use	324	drawing characters and just rely on what the specified fonts provide. Use
…		…
354	=item B<-lsp> I<number>	328	=item B<-lsp> I<number>
355		329
356	Compile I<frills>: Lines (pixel height) to insert between each row of	330	Compile I<frills>: Lines (pixel height) to insert between each row of
357	the display. Useful to work around font rendering problems; resource	331	the display. Useful to work around font rendering problems; resource
358	B<lineSpace>.	332	B<lineSpace>.
		333
		334	=item B<-letsp> I<number>
		335
		336	Compile I<frills>: Amount to adjust the computed character width by
		337	to control overall letter spacing. Negative values will tighten up the
		338	letter spacing, positive values will space letters out more. Useful to
		339	work around odd font metrics; resource B<letterSpace>.
359		340
360	=item B<-tn> I<termname>	341	=item B<-tn> I<termname>
361		342
362	This option specifies the name of the terminal type to be set in the	343	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	344	B<TERM> environment variable. This terminal type must exist in the
…		…
450	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	431	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
451	will not immediately destroy its window when the program executed within	432	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	433	it exits. Instead, it will wait till it is being killed or closed by the
453	user; resource B<hold>.	434	user; resource B<hold>.
454		435
		436	=item B<-cd> I<path>
		437
		438	Sets the working directory for the shell (or the command specified via
		439	B<-e>). The I<path> must be an absolute path and it must exist for
		440	@@RXVT_NAME@@ to start; resource B<chdir>.
		441
455	=item B<-xrm> I<string>	442	=item B<-xrm> I<string>
456		443
457	Works like the X Toolkit option of the same name, by adding the I<string>	444	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	445	as if it were specified in a resource file. Resource values specified this
459	way take precedence over all other resource specifications.	446	way take precedence over all other resource specifications.
…		…
542	You can set and change the resources using X11 tools like B<xrdb>. Many	529	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	530	distribution do also load settings from the B<~/.Xresources> file when X
544	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	531	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
545	with later settings overwriting earlier ones:	532	with later settings overwriting earlier ones:
546		533
547	1. system-wide app-defaults file, either locale-dependent OR global
548	2. app-defaults file in $XAPPLRESDIR	534	1. app-defaults file in $XAPPLRESDIR
		535	2. $HOME/.Xdefaults
549	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	536	3. RESOURCE_MANAGER property on root-window of screen 0
550	4. SCREEN_RESOURCES for the current screen	537	4. SCREEN_RESOURCES property on root-window of the current screen
551	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	538	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
552	6. resources specified via -xrm on the commandline	539	6. resources specified via -xrm on the commandline
553		540
554	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	541	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	542	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
…		…
567	=item B<depth:> I<bitdepth>	554	=item B<depth:> I<bitdepth>
568		555
569	Compile I<xft>: Attempt to find a visual with the given bit depth;	556	Compile I<xft>: Attempt to find a visual with the given bit depth;
570	option B<-depth>.	557	option B<-depth>.
571		558
		559	=item B<buffered:> I<boolean>
		560
		561	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		562	On some card/driver combination enabling it slightly decreases
		563	performance, on most it greatly helps it. The slowdown is small, so it
		564	should normally be enabled.
		565
572	=item B<geometry:> I<geom>	566	=item B<geometry:> I<geom>
573		567
574	Create the window with the specified X window geometry [default 80x24];	568	Create the window with the specified X window geometry [default 80x24];
575	option B<-geometry>.	569	option B<-geometry>.
576		570
…		…
589	Use the specified colour for the colour value I<n>, where 0-7	583	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	584	corresponds to low-intensity (normal) colours and 8-15 corresponds to
591	high-intensity (bold = bright foreground, blink = bright background)	585	high-intensity (bold = bright foreground, blink = bright background)
592	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	586	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	587	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.	588	names used are listed in the B<COLOURS AND GRAPHICS> section.
595		589
596	Colours higher than 15 cannot be set using resources (yet), but can be	590	Colours higher than 15 cannot be set using resources (yet), but can be
597	changed using an escape command (see @@RXVT_NAME@@(7)).	591	changed using an escape command (see @@RXVT_NAME@@(7)).
598		592
599	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	593	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
610	=item B<colorUL:> I<colour>	604	=item B<colorUL:> I<colour>
611		605
612	Use the specified colour to display underlined characters when the	606	Use the specified colour to display underlined characters when the
613	foreground colour is the default.	607	foreground colour is the default.
614		608
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>	609	=item B<underlineColor:> I<colour>
621		610
622	If set, use the specified colour as the colour for the underline	611	If set, use the specified colour as the colour for the underline
623	itself. If unset, use the foreground colour.	612	itself. If unset, use the foreground colour.
		613
		614	=item B<highlightColor:> I<colour>
		615
		616	If set, use the specified colour as the background for highlighted
		617	characters. If unset, use reverse video.
		618
		619	=item B<highlightTextColor:> I<colour>
		620
		621	If set and highlightColor is set, use the specified colour as the
		622	foreground for highlighted characters.
624		623
625	=item B<cursorColor:> I<colour>	624	=item B<cursorColor:> I<colour>
626		625
627	Use the specified colour for the cursor. The default is to use the	626	Use the specified colour for the cursor. The default is to use the
628	foreground colour; option B<-cr>.	627	foreground colour; option B<-cr>.
…		…
635		634
636	=item B<reverseVideo:> I<boolean>	635	=item B<reverseVideo:> I<boolean>
637		636
638	B<True>: simulate reverse video by foreground and background colours;	637	B<True>: simulate reverse video by foreground and background colours;
639	option B<-rv>. B<False>: regular screen colours [default]; option	638	option B<-rv>. B<False>: regular screen colours [default]; option
640	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	639	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
641		640
642	=item B<jumpScroll:> I<boolean>	641	=item B<jumpScroll:> I<boolean>
643		642
644	B<True>: specify that jump scrolling should be used. When receiving lots	643	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	644	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
659		658
660	B<False>: specify that everything is to be displayed, even	659	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	660	if the refresh is too fast for the human eye to read anything (or the
662	monitor to display anything); option B<+ss>.	661	monitor to display anything); option B<+ss>.
663		662
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>	663	=item B<fading:> I<number>
675		664
676	Fade the text by the given percentage when focus is lost; option B<-fade>.	665	Fade the text by the given percentage when focus is lost; option B<-fade>.
677		666
678	=item B<fadeColor:> I<colour>	667	=item B<fadeColor:> I<colour>
679		668
680	Fade to this colour, when fading is used (see B<fading:>). The default	669	Fade to this colour, when fading is used (see B<fading:>). The default
681	colour is black; option B<-fadecolor>.	670	colour is black; option B<-fadecolor>.
682		671
683	=item B<tintColor:> I<colour>	672	=item B<iconFile:> I<file>
684		673
685	Tint the transparent background pixmap with the given colour; option	674	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		675
702	=item B<scrollColor:> I<colour>	676	=item B<scrollColor:> I<colour>
703		677
704	Use the specified colour for the scrollbar [default #B2B2B2].	678	Use the specified colour for the scrollbar [default #B2B2B2].
705		679
…		…
710		684
711	=item B<borderColor:> I<colour>	685	=item B<borderColor:> I<colour>
712		686
713	The colour of the border around the text area and between the scrollbar	687	The colour of the border around the text area and between the scrollbar
714	and the text.	688	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		689
746	=item B<font:> I<fontlist>	690	=item B<font:> I<fontlist>
747		691
748	Select the fonts to be used. This is a comma separated list of font names	692	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	693	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	716	it is named first) and thus defines the character cell grid to be 9 pixels
773	wide and 15 pixels high.	717	wide and 15 pixels high.
774		718
775	The second font is just used to add additional unicode characters not in	719	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	720	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	721	the bold version of the font does contain fewer characters, so this is a
778	useful supplement.	722	useful supplement.
779		723
780	The third font is an Xft font with aliasing turned off, and the characters	724	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	725	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.	726	contains other characters, but we are not interested in them.
…		…
833	=item B<urgentOnBell:> I<boolean>	777	=item B<urgentOnBell:> I<boolean>
834		778
835	B<True>: set the urgency hint for the wm on receipt of a bell character.	779	B<True>: set the urgency hint for the wm on receipt of a bell character.
836	B<False>: do not set the urgency hint [default].	780	B<False>: do not set the urgency hint [default].
837		781
		782	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		783
838	=item B<visualBell:> I<boolean>	784	=item B<visualBell:> I<boolean>
839		785
840	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	786	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
841	B<False>: no visual bell [default]; option B<+vb>.	787	B<False>: no visual bell [default]; option B<+vb>.
842		788
…		…
844		790
845	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of	791	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
846	the shell; option B<-ls>. B<False>: start as a normal sub-shell	792	the shell; option B<-ls>. B<False>: start as a normal sub-shell
847	[default]; option B<+ls>.	793	[default]; option B<+ls>.
848		794
		795	=item B<multiClickTime:> I<number>
		796
		797	Specify the maximum time in milliseconds between multi-click select
		798	events. The default is 500 milliseconds; option B<-mc>.
		799
849	=item B<utmpInhibit:> I<boolean>	800	=item B<utmpInhibit:> I<boolean>
850		801
851	B<True>: inhibit writing record into the system log file B<utmp>;	802	B<True>: inhibit writing record into the system log file B<utmp>;
852	option B<-ut>. B<False>: write record into the system log file B<utmp>	803	option B<-ut>. B<False>: write record into the system log file B<utmp>
853	[default]; option B<+ut>.	804	[default]; option B<+ut>.
…		…
870	=item B<scrollstyle:> I<mode>	821	=item B<scrollstyle:> I<mode>
871		822
872	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	823	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
873	the author's favourite.	824	the author's favourite.
874		825
		826	=item B<thickness:> I<number>
		827
		828	Set the scrollbar width in pixels.
		829
875	=item B<scrollBar:> I<boolean>	830	=item B<scrollBar:> I<boolean>
876		831
877	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	832	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
878	disable the scrollbar; option B<+sb>.	833	disable the scrollbar; option B<+sb>.
879		834
…		…
898	B<False>: do not scroll to bottom when tty receives output; option	853	B<False>: do not scroll to bottom when tty receives output; option
899	B<+si>.	854	B<+si>.
900		855
901	=item B<scrollWithBuffer:> I<boolean>	856	=item B<scrollWithBuffer:> I<boolean>
902		857
903	B<True>: scroll with scrollback buffer when tty receives new lines (and	858	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	859	try to show the same lines) and B<scrollTtyOutput> is False; option
905	with scrollback buffer when tty receives new lines; option B<+sw>.	860	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		861	new lines; option B<+sw>.
906		862
907	=item B<scrollTtyKeypress:> I<boolean>	863	=item B<scrollTtyKeypress:> I<boolean>
908		864
909	B<True>: scroll to bottom when a non-special key is pressed. Special keys	865	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	866	are those which are intercepted by rxvt-unicode for special handling and
…		…
966	=item B<cursorBlink:> I<boolean>	922	=item B<cursorBlink:> I<boolean>
967		923
968	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	924	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
969	option B<-bc>.	925	option B<-bc>.
970		926
		927	=item B<cursorUnderline:> I<boolean>
		928
		929	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		930	option B<-uc>.
		931
971	=item B<pointerBlank:> I<boolean>	932	=item B<pointerBlank:> I<boolean>
972		933
973	B<True>: blank the pointer when a key is pressed or after a set number	934	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	935	of seconds of inactivity. B<False>: the pointer is always visible
975	[default].	936	[default].
…		…
988	large number (e.g. C<987654321>) to effectively disable the timeout.	949	large number (e.g. C<987654321>) to effectively disable the timeout.
989		950
990	=item B<backspacekey:> I<string>	951	=item B<backspacekey:> I<string>
991		952
992	The string to send when the backspace key is pressed. If set to B<DEC>	953	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>	954	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	955	(code 8) - which can be reversed with the appropriate DEC private mode
995	escape sequence.	956	escape sequence.
996		957
997	=item B<deletekey:> I<string>	958	=item B<deletekey:> I<string>
998		959
…		…
1077		1038
1078	=item B<secondaryScroll:> I<boolean>	1039	=item B<secondaryScroll:> I<boolean>
1079		1040
1080	Turn on/off secondary screen scroll (default enabled). If this	1041	Turn on/off secondary screen scroll (default enabled). If this
1081	option is enabled, scrolls on the secondary screen will change the	1042	option is enabled, scrolls on the secondary screen will change the
1082	scrollback buffer and switching to/from the secondary screen will	1043	scrollback buffer and, when secondaryScreen is off, switching
1083	instead scroll the screen up.	1044	to/from the secondary screen will instead scroll the screen up.
1084		1045
1085	=item B<hold>: I<boolean>	1046	=item B<hold>: I<boolean>
1086		1047
1087	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1048	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1088	will not immediately destroy its window when the program executed within	1049	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	1050	it exits. Instead, it will wait till it is being killed or closed by the
1090	user.	1051	user.
1091		1052
		1053	=item B<chdir>: I<path>
		1054
		1055	Sets the working directory for the shell (or the command specified via
		1056	B<-e>). The I<path> must be an absolute path and it must exist for
		1057	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1058	directory will be used; option B<-cd>.
		1059
1092	=item B<keysym.>I<sym>: I<string>	1060	=item B<keysym.>I<sym>: I<action>
1093		1061
1094	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1062	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1095	intervening resource name B<keysym.> cannot be omitted.	1063	resource name B<keysym.> cannot be omitted.
1096		1064
1097	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1065	Using this resource, you can map key combinations such as
1098	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1066	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>,	1067	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>,	1068	terminal scroll up or down the way you want it, or any other thing an
1101	B<2>, B<3>, B<4>, B<5>.	1069	extension might provide.
		1070
		1071	The key combination that triggers the action, I<sym>, has the following format:
		1072
		1073	(modifiers-)key
		1074
		1075	Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
		1076	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
		1077	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
		1078	B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1102		1079
1103	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1080	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	1081	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	1082	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1106	current application keymap mode state.	1083	current application keymap mode state.
1107		1084
1108	The spellings of I<key> can be obtained by using B<xev>(1) command or	1085	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	1086	match if I<at least> the specified identifiers are being set, and no other
		1087	key mappings with those and more bits are being defined. That means that
		1088	defining a mapping for C<a> will automatically provide definitions for
		1089	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1090	themselves. See the C<builtin:> action, below, for a way to work around
		1091	this when this is a problem.
		1092
		1093	The spelling of I<key> depends on your implementation of X. An easy way to
		1094	find a key name is to use the B<xev>(1) command. You can find a list by
		1095	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	1096	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	1097	value (B<0x0000 - 0xFFFF>).
1112	performed in an exact manner; however, the closest match is assured.
1113		1098
1114	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1099	As with any resource value, the I<action> string may contain backslash
		1100	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1115	number), see RESOURCES in C<man 7 X> for futher details.	1101	number), see RESOURCES in C<man 7 X> for further details.
1116		1102
1117	You can define a range of keysyms in one shot by providing a I<string>	1103	An action starts with an action prefix that selects a certain type
1118	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1104	of action, followed by a colon. An action string without colons is
		1105	interpreted as a literal string to pass to the tty (as if it was
		1106	prefixed with C<string:>).
		1107
		1108	The following action prefixes are known - extensions can provide
		1109	additional prefixes:
		1110
		1111	=over 4
		1112
		1113	=item string:STRING
		1114
		1115	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1116	then the remaining C<STRING> will be passed to the program running in the
		1117	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1118	string C<echo rm -rf /> followed by a newline:
		1119
		1120	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
		1121
		1122	This could in theory be used to completely redefine your keymap.
		1123
		1124	In addition, for actions of this type, you can define a range of
		1125	keysyms in one shot by loading the C<keysym-list> perl extension and
		1126	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1119	should be a character not used by the strings.	1127	the delimiter `/' should be a character not used by the strings.
1120		1128
1121	Its usage can be demonstrated by an example:	1129	Its usage can be demonstrated by an example:
1122		1130
1123	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1131	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1124		1132
1125	The above line is equivalent to the following three lines:	1133	The above line is equivalent to the following three lines:
1126		1134
1127	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1135	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1128	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1136	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1129	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1137	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1130		1138
		1139	=item command:STRING
		1140
1131	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1141	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	1142	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1143	the opposite of C<string:> - instead of sending it to the program running
		1144	in the terminal, it will be treated as if it were program output). This is
		1145	most useful to feed command sequences into @@RXVT_NAME@@.
		1146
1133	example the following means "change the current locale to C<zh_CN.GBK>	1147	For example the following means "change the current locale to C<zh_CN.GBK>
1134	when Control-Meta-c is being pressed":	1148	when Control-Meta-c is being pressed":
1135		1149
1136	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1150	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1137		1151
1138	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1152	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)	1153	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1140	manpage. For example, the F<selection> extension (activated via	1154	font-switching at runtime:
1141	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1142		1155
1143	URxvt.keysym.M-C-c: perl:selection:rot13	1156	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1157	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1144		1158
1145	Due the the large number of modifier combinations, a defined key mapping	1159	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	1160	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		1161
1152	Unfortunately, this will override built-in key mappings. For example	1162	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1163	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1164
		1165	=item builtin:
		1166
		1167	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1168	key binding existed for the key combination. The obvious use is to undo
		1169	the effect of existing bindings. The not so obvious use is to reinstate
		1170	bindings when another binding overrides too many modifiers.
		1171
1153	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1172	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	1173	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1155	user-defined keymap using the C<builtin:> replacement:	1174	"holes" into the user-defined keymap using the C<builtin:> replacement:
1156		1175
1157	URxvt.keysym.Insert: <my insert key sequence>	1176	URxvt.keysym.Insert: <my insert key sequence>
1158	URxvt.keysym.S-Insert: builtin:	1177	URxvt.keysym.S-Insert: builtin:
1159		1178
1160	The first line defines a mapping for C<Insert> and I<any> combination	1179	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	1180	of modifiers. The second line re-establishes the default mapping for
1162	C<Shift-Insert>.	1181	C<Shift-Insert>.
1163		1182
1164	The following example will map Control-Meta-1 and Control-Meta-2 to	1183	=item builtin-string:
1165	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1166	font-switching at runtime:
1167		1184
1168	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1185	This action is mainly useful to restore string mappings for keys that
1169	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1186	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1187	difficult to explain - basically, this action will send the string to the
		1188	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1189	action for it.
1170		1190
1171	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1191	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1172	info):	1192	selection when you press C<Shift-Insert>. With the following bindings, it
		1193	would instead emit the (undocumented, but what applications running in the
		1194	terminal might expect) sequence C<ESC [ 2 $> instead:
1173		1195
1174	URxvt.keysym.M-C-3: command:\033[8;25;80t	1196	URxvt.keysym.S-Insert: builtin-string:
1175	URxvt.keysym.M-C-4: command:\033[8;48;110t	1197	URxvt.keysym.C-S-Insert: builtin:
		1198
		1199	The first line disables the paste functionality for that key
		1200	combination, and the second reinstates the default behaviour for
		1201	C<Control-Shift-Insert>, which would otherwise be overridden.
		1202
		1203	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1204	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1205	this:
		1206
		1207	URxvt.keysym.C-M-c: builtin-string:
		1208	URxvt.keysym.C-M-v: builtin-string:
		1209
		1210	=item EXTENSION:STRING
		1211
		1212	An action of this form invokes the action B<STRING>, if any, provided
		1213	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1214	be loaded automatically if necessary.
		1215
		1216	Not all extensions define actions, but popular extensions that do
		1217	include the I<selection> and I<matcher> extensions (documented in their
		1218	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1219	respectively).
		1220
		1221	From the silly examples department, this will rot13-"encrypt"
		1222	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1223	keyboards:
		1224
		1225	URxvt.keysym.M-C-c: selection:rot13
		1226
		1227	=item perl:STRING DEPRECATED
		1228
		1229	This is a deprecated way of invoking commands provided by perl
		1230	extensions. It is still supported, but should not be used anymore.
		1231
		1232	=back
1176		1233
1177	=item B<perl-ext-common>: I<string>	1234	=item B<perl-ext-common>: I<string>
1178		1235
1179	=item B<perl-ext>: I<string>	1236	=item B<perl-ext>: I<string>
1180		1237
…		…
1182	use in this terminal instance; option B<-pe>.	1239	use in this terminal instance; option B<-pe>.
1183		1240
1184	Extension names can be prefixed with a C<-> sign to prohibit using	1241	Extension names can be prefixed with a C<-> sign to prohibit using
1185	them. This can be useful to selectively disable some extensions loaded	1242	them. This can be useful to selectively disable some extensions loaded
1186	by default, or specified via the C<perl-ext-common> resource. For	1243	by default, or specified via the C<perl-ext-common> resource. For
1187	example, C<default,-selection> will use all the default extension except	1244	example, C<default,-selection> will use all the default extensions except
1188	C<selection>.	1245	C<selection>.
1189		1246
1190	Extension names can also be followed by an argument in angle brackets	1247	The default set includes the C<selection>, C<option-popup>,
1191	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1248	C<selection-popup> and C<readline> extensions, any extensions that
1192	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1249	define keybindings via C<BINDING> meta comments, and extensions which
1193	multiple times with different arguments will pass multiple arguments to	1250	are mentioned in B<keysym> resources.
1194	the extension.	1251
		1252	Any extension such that a corresponding resource is given on the
		1253	command line is automatically appended to B<perl-ext>.
1195		1254
1196	Each extension is looked up in the library directories, loaded if	1255	Each extension is looked up in the library directories, loaded if
1197	necessary, and bound to the current terminal instance.	1256	necessary, and bound to the current terminal instance. When the library
		1257	search path contains multiple extension files of the same name, then the
		1258	first one found will be used.
1198		1259
1199	If both of these resources are the empty string, then the perl	1260	If both of these resources are the empty string, then the perl interpreter
1200	interpreter will not be initialized. The idea behind two options is that	1261	will not be initialized. The rationale for having two options is that
1201	B<perl-ext-common> will be used for extensions that should be available to	1262	B<perl-ext-common> will be used for extensions that should be available to
1202	all instances, while B<perl-ext> is used for specific instances.	1263	all instances, while B<perl-ext> is used for specific instances.
1203		1264
1204	=item B<perl-eval>: I<string>	1265	=item B<perl-eval>: I<string>
1205		1266
1206	Perl code to be evaluated when all extensions have been registered. See	1267	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	1268	the @@RXVT_NAME@@perl(3) manpage.
1208	will be ignored when running setuid/setgid.
1209		1269
1210	=item B<perl-lib>: I<path>	1270	=item B<perl-lib>: I<path>
1211		1271
1212	Colon-separated list of additional directories that hold extension	1272	Colon-separated list of additional directories that hold extension
1213	scripts. When looking for extensions specified by the C<perl> resource,	1273	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1214	@@RXVT_NAME@@ will first look in these directories and then in	1274	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	1275	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1216	will be ignored when running setuid/setgid.
1217		1276
1218	See the @@RXVT_NAME@@perl(3) manpage.	1277	See the @@RXVT_NAME@@perl(3) manpage.
1219		1278
1220	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1279	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1221		1280
…		…
1225	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1284	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1226		1285
1227	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1286	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1228	for details.	1287	for details.
1229		1288
1230	=item B<searchable-scrollback:> I<keysym>	1289	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1231		1290
1232	Sets the hotkey that starts the incremental scrollback buffer search	1291	This resource is deprecated and will be removed. Use a B<keysym> resource
1233	(default: C<M-s>).	1292	instead, e.g.:
1234		1293
		1294	URxvt.keysym.M-s: searchable-scrollback:start
		1295
1235	=item B<urlLauncher>: I<string>	1296	=item B<url-launcher>: I<string>
1236		1297
1237	Specifies the program to be started with a URL argument. Used by the	1298	Specifies the program to be started with a URL argument. Used by the
1238	C<selection-popup> and C<matcher> perl extensions.	1299	C<selection-popup> and C<matcher> perl extensions.
1239		1300
1240	=item B<transient-for>: I<windowid>	1301	=item B<transient-for>: I<windowid>
…		…
1244	=item B<override-redirect>: I<boolean>	1305	=item B<override-redirect>: I<boolean>
1245		1306
1246	Compile I<frills>: Sets override-redirect for the terminal window, making	1307	Compile I<frills>: Sets override-redirect for the terminal window, making
1247	it almost invisible to window managers; option B<-override-redirect>.	1308	it almost invisible to window managers; option B<-override-redirect>.
1248		1309
		1310	=item B<iso14755:> I<boolean>
		1311
		1312	Turn on/off ISO 14755 (default enabled).
		1313
1249	=item B<iso14755_52:> I<boolean>	1314	=item B<iso14755_52:> I<boolean>
1250		1315
1251	Turn on/off ISO 14755 5.2 mode (default enabled).	1316	Turn on/off ISO 14755 5.2 mode (default enabled).
		1317
		1318	=back
		1319
		1320	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
		1321
		1322	=over 4
		1323
		1324	=item B<-pixmap> I<file[;oplist]>
		1325
		1326	=item B<backgroundPixmap:> I<file[;oplist]>
		1327
		1328	Compile I<pixbuf>: Use the specified image file as the window's
		1329	background and also optionally specify a colon separated list of
		1330	operations to modify it. Note that you may need to quote the C<;>
		1331	character when using the command line option, as C<;> is usually a
		1332	metacharacter in shells. Supported operations are:
		1333
		1334	=over 4
		1335
		1336	=item B<WxH+X+Y>
		1337
		1338	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		1339	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		1340	scale of 0 disables scaling.
		1341
		1342	=item B<op=tile>
		1343
		1344	enables tiling
		1345
		1346	=item B<op=keep-aspect>
		1347
		1348	maintain the image aspect ratio when scaling
		1349
		1350	=item B<op=root-align>
		1351
		1352	use the position of the terminal window relative to the root window as
		1353	the image offset, simulating a root window background
		1354
		1355	=back
		1356
		1357	The default scale and position setting is C<100x100+50+50>.
		1358	Alternatively, a predefined set of templates can be used to achieve
		1359	the most common setups:
		1360
		1361	=over 4
		1362
		1363	=item B<style=tiled>
		1364
		1365	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		1366
		1367	=item B<style=aspect-stretched>
		1368
		1369	the image is scaled to fill the whole window maintaining the aspect
		1370	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		1371
		1372	=item B<style=stretched>
		1373
		1374	the image is scaled to fill the whole window. Equivalent to 100x100
		1375
		1376	=item B<style=centered>
		1377
		1378	the image is centered with no scaling. Equivalent to 0x0+50+50
		1379
		1380	=item B<style=root-tiled>
		1381
		1382	the image is tiled with no scaling and using 'root' positioning.
		1383	Equivalent to 0x0:op=tile:op=root-align
		1384
		1385	=back
		1386
		1387	If multiple templates are specified the last one wins. Note that a
		1388	template overrides all the scale, position and operations settings.
		1389
		1390	If used in conjunction with pseudo-transparency, the specified pixmap
		1391	will be blended over the transparent background using alpha-blending.
		1392
		1393	=item B<-tr>\|B<+tr>
		1394
		1395	=item B<transparent:> I<boolean>
		1396
		1397	Turn on/off pseudo-transparency by using the root pixmap as background.
		1398
		1399	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
		1400	will be removed in future versions.
		1401
		1402	=item B<-tint> I<colour>
		1403
		1404	=item B<tintColor:> I<colour>
		1405
		1406	Tint the transparent background with the given colour. Note that a
		1407	black tint yields a completely black image while a white tint yields
		1408	the image unchanged.
		1409
		1410	=item B<-sh> I<number>
		1411
		1412	=item B<shading:> I<number>
		1413
		1414	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
		1415	A value of 100 means no shading.
		1416
		1417	=item B<-blr> I<HxV>
		1418
		1419	=item B<blurRadius:> I<HxV>
		1420
		1421	Apply gaussian blur with the specified radius to the transparent
		1422	background. If a single number is specified, the vertical and
		1423	horizontal radii are considered to be the same. Setting one of the
		1424	radii to 1 and the other to a large number creates interesting effects
		1425	on some backgrounds. The maximum radius value is 128. An horizontal or
		1426	vertical radius of 0 disables blurring.
		1427
		1428	=item B<path:> I<path>
		1429
		1430	Specify the colon-delimited search path for finding background image files.
1252		1431
1253	=back	1432	=back
1254		1433
1255	=head1 THE SCROLLBAR	1434	=head1 THE SCROLLBAR
1256		1435
…		…
1304	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1483	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.	1484	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1306		1485
1307	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1486	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1308	inserted too.	1487	inserted too.
		1488
		1489	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1490	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1491	binding causes the value of the internal selection to be copied to the
		1492	CLIPBOARD selection, while the second binding causes the value of the
		1493	CLIPBOARD selection to be inserted.
1309		1494
1310	=back	1495	=back
1311		1496
1312	=head1 CHANGING FONTS	1497	=head1 CHANGING FONTS
1313		1498
…		…
1395	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1580	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	1581	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	1582	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.	1583	on some systems or setgid to root or to some other group on others.
1399		1584
1400	=head1 COLORS AND GRAPHICS	1585	=head1 COLOURS AND GRAPHICS
1401		1586
1402	In addition to the default foreground and background colours,	1587	In addition to the default foreground and background colours,
1403	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1588	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	1589	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1405	colours with their names.	1590	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1591	cube plus a 8 (24) colour greyscale ramp.
		1592
		1593	Here is a list of the ANSI colours with their names.
1406		1594
1407	=begin table	1595	=begin table
1408		1596
1409	B<color0> (black) = Black	1597	B<color0> (black) = Black
1410	B<color1> (red) = Red3	1598	B<color1> (red) = Red3
…		…
1430	It is also possible to specify the colour values of B<foreground>,	1618	It is also possible to specify the colour values of B<foreground>,
1431	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1619	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	1620	a number 0-15, as a convenient shorthand to reference the colour name of
1433	color0-color15.	1621	color0-color15.
1434		1622
1435	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1623	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)	1624	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		1625
		1626	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1627
		1628	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1629	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
		1630
		1631	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1632	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1633	the RGB cube.
		1634
1440	Together, all those colours implement the 88 colour xterm colours. Only	1635	Together, all those colours implement the 88 (256) colour xterm
1441	the first 16 can be changed using resources currently, the rest can only	1636	colours. Only the first 16 can be changed using resources currently, the
1442	be changed via command sequences ("escape codes").	1637	rest can only be changed via command sequences ("escape codes").
		1638
		1639	Applications are advised to use terminfo or command sequences to discover
		1640	number and RGB values of all colours (yes, you can query this...).
1443		1641
1444	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1642	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1445	always swapping the foreground/background colours. This is in contrast to	1643	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	1644	I<xterm>(1) where the colours are only swapped if they have not otherwise
1447	been specified. For example,	1645	been specified. For example,
1448		1646
1449	=over 4
1450
1451	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1647	@@RXVT_NAME@@ -fg Black -bg White -rv
1452		1648
1453	would yield White on Black, while on I<xterm>(1) it would yield Black	1649	would yield White on Black, while on I<xterm>(1) it would yield Black on
1454	on White.	1650	White.
1455
1456	=back
1457		1651
1458	=head2 ALPHA CHANNEL SUPPORT	1652	=head2 ALPHA CHANNEL SUPPORT
1459		1653
1460	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1654	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>	1655	their act together, rxvt-unicode will do its own alpha channel management:
1462	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1656
1463	in addition to the ones provided by X, where the additional A component	1657	You can prefix any colour with an opaqueness percentage enclosed in
		1658	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1659	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1660	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1661	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1662	is the recommended format to specify transparency values, and works with
		1663	all ways to specify a colour.
		1664
		1665	For complete control, rxvt-unicode also supports
		1666	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1667	specifications, where the additional C<aaaa> component specifies opacity
1464	specifies opacity (alpha) values. The minimum value of C<0> is completely	1668	(alpha) values. The minimum value of C<0000> is completely transparent,
1465	transparent). You can also prefix any color with C<[percent]>, where	1669	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	1670	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	1671	C<rgba:0000/ff00/0000/f332>.
1468	opaque.
1469		1672
1470	You probably need to specify B<"-depth 32">, too, and have the luck that	1673	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	1674	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.	1675	layout, as X is far from just supporting ARGB visuals out of the box, and
		1676	rxvt-unicode just fudges around.
1473		1677
1474	For example, the following selects an almost completely transparent red	1678	For example, the following selects an almost completely transparent black
1475	background, and an almost opaque pink foreground:	1679	background, and an almost opaque pink foreground:
1476		1680
1477	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1681	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1478		1682
1479	I<Please note that transparency of any kind if completely unsupported by	1683	When not using a background image, then the interpretation of the
1480	the author. Don't bug him with installation questions!>	1684	alpha channel is up to your compositing manager (most interpret it as
		1685	transparency of course).
		1686
		1687	When using a background pixmap or pseudo-transparency, then the background
		1688	colour will always behave as if it were completely transparent (so the
		1689	background image shows instead), regardless of how it was specified, while
		1690	other colours will either be transparent as specified (the background
		1691	image will show through) on servers supporting the RENDER extension, or
		1692	fully opaque on servers not supporting the RENDER EXTENSION.
		1693
		1694	Please note that due to bugs in Xft, specifying alpha values might result
		1695	in garbage being displayed when the X-server does not support the RENDER
		1696	extension.
1481		1697
1482	=head1 ENVIRONMENT	1698	=head1 ENVIRONMENT
1483		1699
1484	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1700	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1485		1701
…		…
1519	C<--with-terminfo=PATH>.	1735	C<--with-terminfo=PATH>.
1520		1736
1521	=item B<DISPLAY>	1737	=item B<DISPLAY>
1522		1738
1523	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1739	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1524	display in its child processes.	1740	display in its child processes if C<-display> isn't used to override. It
		1741	defaults to C<:0> if it doesn't exist.
1525		1742
1526	=item B<SHELL>	1743	=item B<SHELL>
1527		1744
1528	The shell to be used for command execution, defaults to C</bin/sh>.	1745	The shell to be used for command execution, defaults to C</bin/sh>.
1529		1746
1530	=item B<RXVT_SOCKET>	1747	=item B<RXVT_SOCKET> [I<sic>]
1531		1748
1532	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1749	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1533	@@RXVT_NAME@@d(1).	1750	@@RXVT_NAME@@d(1).
1534		1751
1535	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1752	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1753
		1754	=item B<URXVT_PERL_LIB>
		1755
		1756	Additional F<:>-separated library search path for perl extensions. Will be
		1757	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1758	directory.
		1759
		1760	=item B<URXVT_PERL_VERBOSITY>
		1761
		1762	See L<@@RXVT_NAME@@perl>(3).
1536		1763
1537	=item B<HOME>	1764	=item B<HOME>
1538		1765
1539	Used to locate the default directory for the unix domain socket for	1766	Used to locate the default directory for the unix domain socket for
1540	daemon communications and to locate various resource files (such as	1767	daemon communications and to locate various resource files (such as
1541	C<.Xdefaults>)	1768	C<.Xdefaults>)
1542		1769
1543	=item B<XAPPLRESDIR>	1770	=item B<XAPPLRESDIR>
1544		1771
1545	Directory where various X resource files are being located.	1772	Directory where application-specific X resource files are located.
1546		1773
1547	=item B<XENVIRONMENT>	1774	=item B<XENVIRONMENT>
1548		1775
1549	If set and accessible, gives the name of a X resource file to be loaded by	1776	If set and accessible, gives the name of a X resource file to be loaded by
1550	@@RXVT_NAME@@.	1777	@@RXVT_NAME@@.
…		…
1555		1782
1556	=over 4	1783	=over 4
1557		1784
1558	=item B</usr/lib/X11/rgb.txt>	1785	=item B</usr/lib/X11/rgb.txt>
1559		1786
1560	Color names.	1787	Colour names.
1561		1788
1562	=back	1789	=back
1563		1790
1564	=head1 SEE ALSO	1791	=head1 SEE ALSO
1565		1792
		1793	@@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)	1794	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1567		1795
1568	=head1 CURRENT PROJECT COORDINATOR	1796	=head1 CURRENT PROJECT COORDINATOR
1569		1797
1570	=over 4	1798	=over 4
1571		1799
1572	=item Project Coordinator	1800	=item Project Coordinator
1573		1801
1574	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1802	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1575		1803
1576	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1804	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1577		1805
1578	=back	1806	=back
1579		1807
…		…
1583		1811
1584	=item John Bovey	1812	=item John Bovey
1585		1813
1586	University of Kent, 1992, wrote the original Xvt.	1814	University of Kent, 1992, wrote the original Xvt.
1587		1815
1588	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1816	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1589		1817
1590	very heavily modified Xvt and came up with Rxvt	1818	very heavily modified Xvt and came up with Rxvt
1591		1819
1592	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1820	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1593		1821
1594	wrote the Greek Keyboard Input (no longer in code)	1822	wrote the Greek Keyboard Input (no longer in code)
1595		1823
1596	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1824	=item mj olesen <olesen@me.QueensU.CA>
1597		1825
1598	Wrote the menu system.	1826	Wrote the menu system.
1599		1827
1600	Project Coordinator (changes.txt 2.11 to 2.21)	1828	Project Coordinator (changes.txt 2.11 to 2.21)
1601		1829
1602	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1830	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1603		1831
1604	Project Coordinator (changes.txt 2.21a to 2.4.5)	1832	Project Coordinator (changes.txt 2.21a to 2.4.5)
1605		1833
1606	=item Geoff Wing L<< <gcw@pobox.com> >>	1834	=item Geoff Wing <gcw@pobox.com>
1607		1835
1608	Rewrote screen display and text selection routines.	1836	Rewrote screen display and text selection routines.
1609		1837
1610	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1838	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1611		1839
1612	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1840	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1613		1841
1614	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1842	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1615	extension, random hacks, numerous bugfixes and extensions.	1843	extension, random hacks, numerous bugfixes and extensions.
1616		1844
1617	Project Coordinator (Changes 1.0 -)	1845	Project Coordinator (Changes 1.0 -)
1618		1846
1619	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1847	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1620		1848
1621	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1849	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1622		1850
1623	=back	1851	=back
1624		1852

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.157 by ayin, Sat Jan 19 16:20:09 2008 UTC vs. Revision 1.240 by sf-exg, Mon Oct 13 17:05:32 2014 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.157 by ayin, Sat Jan 19 16:20:09 2008 UTC vs.
Revision 1.240 by sf-exg, Mon Oct 13 17:05:32 2014 UTC