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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.152 by root, Wed Dec 12 19:56:37 2007 UTC vs.
Revision 1.232 by root, Sun May 18 18:19:10 2014 UTC

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

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.152 by root, Wed Dec 12 19:56:37 2007 UTC vs. Revision 1.232 by root, Sun May 18 18:19:10 2014 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.152 by root, Wed Dec 12 19:56:37 2007 UTC vs.
Revision 1.232 by root, Sun May 18 18:19:10 2014 UTC