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

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.160 by root, Fri Jan 25 18:42:23 2008 UTC vs. Revision 1.241 by root, Wed Dec 17 15:22:10 2014 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.160 by root, Fri Jan 25 18:42:23 2008 UTC vs.
Revision 1.241 by root, Wed Dec 17 15:22:10 2014 UTC