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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.170 by root, Sat May 30 08:51:23 2009 UTC vs.
Revision 1.253 by root, Sat Jul 3 15:34:35 2021 UTC

…		…
98	is still respected. but deprecated). In the absence of this option, the	98	is still respected. but deprecated). In the absence of this option, the
99	display specified by the 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>
149
150	Tint the transparent background pixmap with the given colour when
151	transparency is enabled with B<-tr>. This only works for
152	non-tiled backgrounds, currently. See also the B<-sh> option that can be
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
187	=item B<-icon> I<file>	144	=item B<-icon> I<file>
188		145
189	Compile I<afterimage>: Use the specified image as application icon. This	146	Compile I<pixbuf>: Use the specified image as application icon. This
190	is used by many window managers, taskbars and pagers to represent the	147	is used by many window managers, taskbars and pagers to represent the
191	application window; resource I<iconFile>.	148	application window; resource I<iconFile>.
192		149
193	=item B<-bg> I<colour>	150	=item B<-bg> I<colour>
194		151
195	Window background colour; resource B<background>.	152	Window background colour; resource B<background>.
196		153
197	=item B<-fg> I<colour>	154	=item B<-fg> I<colour>
198		155
199	Window foreground colour; resource B<foreground>.	156	Window foreground colour; resource B<foreground>.
200
201	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
202
203	Compile I<afterimage>: Specify image file for the background and also
204	optionally specify its scaling with a geometry string. Note you may need to
205	add quotes to avoid special shell interpretation of the C<;> in the
206	command-line; for more details see resource B<backgroundPixmap>.
207		157
208	=item B<-cr> I<colour>	158	=item B<-cr> I<colour>
209		159
210	The cursor colour; resource B<cursorColor>.	160	The cursor colour; resource B<cursorColor>.
211		161
…		…
270		220
271	=item B<-ls>\|B<+ls>	221	=item B<-ls>\|B<+ls>
272		222
273	Start as a login-shell/sub-shell; resource B<loginShell>.	223	Start as a login-shell/sub-shell; resource B<loginShell>.
274		224
		225	=item B<-mc> I<milliseconds>
		226
		227	Specify the maximum time between multi-click selections.
		228
275	=item B<-ut>\|B<+ut>	229	=item B<-ut>\|B<+ut>
276		230
277	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	231	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
278	B<utmpInhibit>.	232	B<utmpInhibit>.
279		233
…		…
321		275
322	=item B<-bc>\|B<+bc>	276	=item B<-bc>\|B<+bc>
323		277
324	Blink the cursor; resource B<cursorBlink>.	278	Blink the cursor; resource B<cursorBlink>.
325		279
		280	=item B<-uc>\|B<+uc>
		281
		282	Make the cursor underlined; resource B<cursorUnderline>.
		283
326	=item B<-iconic>	284	=item B<-iconic>
327		285
328	Start iconified, if the window manager supports that option.	286	Start iconified, if the window manager supports that option.
329	Alternative form is B<-ic>.	287	Alternative form is B<-ic>.
330		288
…		…
353		311
354	=item B<-override-redirect>	312	=item B<-override-redirect>
355		313
356	Compile I<frills>: Sets override-redirect on the window; resource	314	Compile I<frills>: Sets override-redirect on the window; resource
357	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.
358		321
359	=item B<-sbg>	322	=item B<-sbg>
360		323
361	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
362	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
…		…
417	=item B<-pt> I<style>	380	=item B<-pt> I<style>
418		381
419	Compile I<XIM>: input style for input method; B<OverTheSpot>,	382	Compile I<XIM>: input style for input method; B<OverTheSpot>,
420	B<OffTheSpot>, B<Root>; resource B<preeditType>.	383	B<OffTheSpot>, B<Root>; resource B<preeditType>.
421		384
		385	If the perl extension C<xim-onthespot> is used (which is the default),
		386	then additionally the C<OnTheSpot> preedit type is available.
		387
422	=item B<-im> I<text>	388	=item B<-im> I<text>
423		389
424	Compile I<XIM>: input method name. resource B<inputMethod>.	390	Compile I<XIM>: input method name. resource B<inputMethod>.
425		391
426	=item B<-imlocale> I<string>	392	=item B<-imlocale> I<string>
…		…
440	Change the meaning of triple-click selection with the left mouse	406	Change the meaning of triple-click selection with the left mouse
441	button. Only effective when the original (non-perl) selection code is	407	button. Only effective when the original (non-perl) selection code is
442	in-use. Instead of selecting a full line it will extend the selection to	408	in-use. Instead of selecting a full line it will extend the selection to
443	the end of the logical line only. resource B<tripleclickwords>.	409	the end of the logical line only. resource B<tripleclickwords>.
444		410
		411	=item B<-dpb>\|B<+dpb>
		412
		413	Compile frills: Disable (or enable) emitting bracketed paste mode
		414	sequences (default enabled). Bracketed paste mode allows programs
		415	to detect when something is pasted. Since more and more programs
		416	abuse this, these sequences can be disabled. The command sequences to
		417	enable and query paste mode will still work, but the actual bracket
		418	sequences will no longer be emitted. You can also toggle this from the
		419	ctrl-middle-mouse-button menu; resource B<disablePasteBrackets>.
		420
445	=item B<-insecure>	421	=item B<-insecure>
446		422
447	Enable "insecure" mode, which currently enables most of the escape	423	Enable "insecure" mode, which currently enables most of the escape
448	sequences that echo strings. See the resource B<insecure> for more	424	sequences that echo strings. See the resource B<insecure> for more
449	info.	425	info.
…		…
461		437
462	=item B<-ssr>\|B<+ssr>	438	=item B<-ssr>\|B<+ssr>
463		439
464	Turn on/off secondary screen scroll (default enabled); resource	440	Turn on/off secondary screen scroll (default enabled); resource
465	B<secondaryScroll>.	441	B<secondaryScroll>.
		442
		443	=item B<-rm> I<mode>
		444
		445	Compile I<frills>: Sets long line rewrapping behaviour on window resizes
		446	to one of B<auto> (the default), B<always> or B<never>. The latter two
		447	modes do the obvious, B<auto> rewraps (acts like B<always>) if scrollback
		448	is non-empty, and wings lines (acts like B<never>) otherwise; resource
		449	B<rewrapMode>.
466		450
467	=item B<-hold>\|B<+hold>	451	=item B<-hold>\|B<+hold>
468		452
469	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	453	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
470	will not immediately destroy its window when the program executed within	454	will not immediately destroy its window when the program executed within
…		…
567	You can set and change the resources using X11 tools like B<xrdb>. Many	551	You can set and change the resources using X11 tools like B<xrdb>. Many
568	distribution do also load settings from the B<~/.Xresources> file when X	552	distribution do also load settings from the B<~/.Xresources> file when X
569	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	553	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
570	with later settings overwriting earlier ones:	554	with later settings overwriting earlier ones:
571		555
572	1. system-wide app-defaults file, either locale-dependent OR global
573	2. app-defaults file in $XAPPLRESDIR	556	1. app-defaults file in $XAPPLRESDIR
		557	2. $HOME/.Xdefaults
574	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	558	3. RESOURCE_MANAGER property on root-window of screen 0
575	4. SCREEN_RESOURCES for the current screen	559	4. SCREEN_RESOURCES property on root-window of the current screen
576	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	560	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
577	6. resources specified via -xrm on the commandline	561	6. resources specified via -xrm on the commandline
578		562
579	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	563	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
580	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	564	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
…		…
621	Use the specified colour for the colour value I<n>, where 0-7	605	Use the specified colour for the colour value I<n>, where 0-7
622	corresponds to low-intensity (normal) colours and 8-15 corresponds to	606	corresponds to low-intensity (normal) colours and 8-15 corresponds to
623	high-intensity (bold = bright foreground, blink = bright background)	607	high-intensity (bold = bright foreground, blink = bright background)
624	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	608	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
625	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	609	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
626	names used are listed in the B<COLORS AND GRAPHICS> section.	610	names used are listed in the B<COLOURS AND GRAPHICS> section.
627		611
628	Colours higher than 15 cannot be set using resources (yet), but can be	612	Colours higher than 15 cannot be set using resources (yet), but can be
629	changed using an escape command (see @@RXVT_NAME@@(7)).	613	changed using an escape command (see @@RXVT_NAME@@(7)).
630		614
631	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	615	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
642	=item B<colorUL:> I<colour>	626	=item B<colorUL:> I<colour>
643		627
644	Use the specified colour to display underlined characters when the	628	Use the specified colour to display underlined characters when the
645	foreground colour is the default.	629	foreground colour is the default.
646		630
647	=item B<colorRV:> I<colour>
648
649	Use the specified colour as the background for reverse video characters
650	when OPTION_HC is disabled (--disable-frills).
651
652	=item B<underlineColor:> I<colour>	631	=item B<underlineColor:> I<colour>
653		632
654	If set, use the specified colour as the colour for the underline	633	If set, use the specified colour as the colour for the underline
655	itself. If unset, use the foreground colour.	634	itself. If unset, use the foreground colour.
		635
		636	=item B<highlightColor:> I<colour>
		637
		638	If set, use the specified colour as the background for highlighted
		639	characters. If unset, use reverse video.
		640
		641	=item B<highlightTextColor:> I<colour>
		642
		643	If set and highlightColor is set, use the specified colour as the
		644	foreground for highlighted characters.
656		645
657	=item B<cursorColor:> I<colour>	646	=item B<cursorColor:> I<colour>
658		647
659	Use the specified colour for the cursor. The default is to use the	648	Use the specified colour for the cursor. The default is to use the
660	foreground colour; option B<-cr>.	649	foreground colour; option B<-cr>.
…		…
667		656
668	=item B<reverseVideo:> I<boolean>	657	=item B<reverseVideo:> I<boolean>
669		658
670	B<True>: simulate reverse video by foreground and background colours;	659	B<True>: simulate reverse video by foreground and background colours;
671	option B<-rv>. B<False>: regular screen colours [default]; option	660	option B<-rv>. B<False>: regular screen colours [default]; option
672	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	661	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
673		662
674	=item B<jumpScroll:> I<boolean>	663	=item B<jumpScroll:> I<boolean>
675		664
676	B<True>: specify that jump scrolling should be used. When receiving lots	665	B<True>: specify that jump scrolling should be used. When receiving lots
677	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines	666	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
691		680
692	B<False>: specify that everything is to be displayed, even	681	B<False>: specify that everything is to be displayed, even
693	if the refresh is too fast for the human eye to read anything (or the	682	if the refresh is too fast for the human eye to read anything (or the
694	monitor to display anything); option B<+ss>.	683	monitor to display anything); option B<+ss>.
695		684
696	=item B<transparent:> I<boolean>
697
698	Turn on/off illusion of a transparent window background.
699
700	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
701	future versions.
702
703	I<Please address all transparency related issues to Sasha Vasko at
704	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
705
706	=item B<fading:> I<number>	685	=item B<fading:> I<number>
707		686
708	Fade the text by the given percentage when focus is lost; option B<-fade>.	687	Fade the text by the given percentage when focus is lost; option B<-fade>.
709		688
710	=item B<fadeColor:> I<colour>	689	=item B<fadeColor:> I<colour>
711		690
712	Fade to this colour, when fading is used (see B<fading:>). The default	691	Fade to this colour, when fading is used (see B<fading:>). The default
713	colour is black; option B<-fadecolor>.	692	colour is black; option B<-fadecolor>.
714		693
715	=item B<tintColor:> I<colour>
716
717	Tint the transparent background pixmap with the given colour; option
718	B<-tint>.
719
720	=item B<shading:> I<number>
721
722	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
723	in addition to tinting it; option B<-sh>.
724
725	=item B<blendType:> I<string>
726
727	Specify background blending type; option B<-blt>.
728
729	=item B<blurRadius:> I<number>
730
731	Apply gaussian blur with the specified radius to the transparent
732	background image; option B<-blr>.
733
734	=item B<iconFile:> I<file>	694	=item B<iconFile:> I<file>
735		695
736	Set the application icon pixmap; option B<-icon>.	696	Set the application icon pixmap; option B<-icon>.
737		697
738	=item B<scrollColor:> I<colour>	698	=item B<scrollColor:> I<colour>
…		…
746		706
747	=item B<borderColor:> I<colour>	707	=item B<borderColor:> I<colour>
748		708
749	The colour of the border around the text area and between the scrollbar	709	The colour of the border around the text area and between the scrollbar
750	and the text.	710	and the text.
751
752	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
753
754	Use the specified image file for the background and also
755	optionally specify its scaling with a geometry string B<WxH+X+Y>,
756	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
757	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
758	centre (percent). A scale of 0 displays the image with tiling. A scale
759	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
760	an integer number of images in that direction. No image will be magnified
761	beyond 10 times its original size. The maximum permitted scale is 1000.
762	Additional operations can be specified after colon B<:op1:op2...>.
763	Supported operations are:
764
765	tile force background image to be tiled and not scaled. Equivalent to 0x0
766	propscale will scale image keeping proportions
767	auto will scale image to match window size. Equivalent to 100x100
768	hscale will scale image horizontally to the window size
769	vscale will scale image vertically to the window size
770	scale will scale image to match window size
771	root will tile image as if it was a root window background, auto-adjusting
772	whenever terminal window moves
773
774	If used in conjunction with B<-tr> option, the specified pixmap will be
775	blended over transparency image using either alpha-blending, or any
776	other blending type, specified with B<-blt "type"> option.
777
778	=item B<path:> I<path>
779
780	Specify the colon-delimited search path for finding background image files.
781		711
782	=item B<font:> I<fontlist>	712	=item B<font:> I<fontlist>
783		713
784	Select the fonts to be used. This is a comma separated list of font names	714	Select the fonts to be used. This is a comma separated list of font names
785	that are checked in order when trying to find glyphs for characters. The	715	that are checked in order when trying to find glyphs for characters. The
…		…
808	it is named first) and thus defines the character cell grid to be 9 pixels	738	it is named first) and thus defines the character cell grid to be 9 pixels
809	wide and 15 pixels high.	739	wide and 15 pixels high.
810		740
811	The second font is just used to add additional unicode characters not in	741	The second font is just used to add additional unicode characters not in
812	the base font, likewise the third, which is unfortunately non-bold, but	742	the base font, likewise the third, which is unfortunately non-bold, but
813	the bold version of the font does contain less characters, so this is a	743	the bold version of the font does contain fewer characters, so this is a
814	useful supplement.	744	useful supplement.
815		745
816	The third font is an Xft font with aliasing turned off, and the characters	746	The third font is an Xft font with aliasing turned off, and the characters
817	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	747	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
818	contains other characters, but we are not interested in them.	748	contains other characters, but we are not interested in them.
…		…
882		812
883	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of	813	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
884	the shell; option B<-ls>. B<False>: start as a normal sub-shell	814	the shell; option B<-ls>. B<False>: start as a normal sub-shell
885	[default]; option B<+ls>.	815	[default]; option B<+ls>.
886		816
		817	=item B<multiClickTime:> I<number>
		818
		819	Specify the maximum time in milliseconds between multi-click select
		820	events. The default is 500 milliseconds; option B<-mc>.
		821
887	=item B<utmpInhibit:> I<boolean>	822	=item B<utmpInhibit:> I<boolean>
888		823
889	B<True>: inhibit writing record into the system log file B<utmp>;	824	B<True>: inhibit writing record into the system log file B<utmp>;
890	option B<-ut>. B<False>: write record into the system log file B<utmp>	825	option B<-ut>. B<False>: write record into the system log file B<utmp>
891	[default]; option B<+ut>.	826	[default]; option B<+ut>.
…		…
908	=item B<scrollstyle:> I<mode>	843	=item B<scrollstyle:> I<mode>
909		844
910	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	845	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
911	the author's favourite.	846	the author's favourite.
912		847
		848	=item B<thickness:> I<number>
		849
		850	Set the scrollbar width in pixels.
		851
913	=item B<scrollBar:> I<boolean>	852	=item B<scrollBar:> I<boolean>
914		853
915	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	854	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
916	disable the scrollbar; option B<+sb>.	855	disable the scrollbar; option B<+sb>.
917		856
…		…
936	B<False>: do not scroll to bottom when tty receives output; option	875	B<False>: do not scroll to bottom when tty receives output; option
937	B<+si>.	876	B<+si>.
938		877
939	=item B<scrollWithBuffer:> I<boolean>	878	=item B<scrollWithBuffer:> I<boolean>
940		879
941	B<True>: scroll with scrollback buffer when tty receives new lines (and	880	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
942	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	881	try to show the same lines) and B<scrollTtyOutput> is False; option
943	with scrollback buffer when tty receives new lines; option B<+sw>.	882	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		883	new lines; option B<+sw>.
944		884
945	=item B<scrollTtyKeypress:> I<boolean>	885	=item B<scrollTtyKeypress:> I<boolean>
946		886
947	B<True>: scroll to bottom when a non-special key is pressed. Special keys	887	B<True>: scroll to bottom when a non-special key is pressed. Special keys
948	are those which are intercepted by rxvt-unicode for special handling and	888	are those which are intercepted by rxvt-unicode for special handling and
949	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to	889	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
950	bottom when a non-special key is pressed; option B<+sk>.	890	bottom when a non-special key is pressed; option B<+sk>.
951		891
952	=item B<saveLines:> I<number>	892	=item B<saveLines:> I<number>
953		893
954	Save I<number> lines in the scrollback buffer [default 64]. This	894	Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
955	resource is limited on most machines to 65535; option B<-sl>.
956		895
957	=item B<internalBorder:> I<number>	896	=item B<internalBorder:> I<number>
958		897
959	Internal border of I<number> pixels. This resource is limited to 100;	898	Internal border of I<number> pixels. This resource is limited to 100;
960	option B<-b>.	899	option B<-b>.
…		…
1004	=item B<cursorBlink:> I<boolean>	943	=item B<cursorBlink:> I<boolean>
1005		944
1006	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	945	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
1007	option B<-bc>.	946	option B<-bc>.
1008		947
		948	=item B<cursorUnderline:> I<boolean>
		949
		950	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		951	option B<-uc>.
		952
1009	=item B<pointerBlank:> I<boolean>	953	=item B<pointerBlank:> I<boolean>
1010		954
1011	B<True>: blank the pointer when a key is pressed or after a set number	955	B<True>: blank the pointer when a key is pressed or after a set number
1012	of seconds of inactivity. B<False>: the pointer is always visible	956	of seconds of inactivity. B<False>: the pointer is always visible
1013	[default].	957	[default].
…		…
1018		962
1019	=item B<pointerColor2:> I<colour>	963	=item B<pointerColor2:> I<colour>
1020		964
1021	Mouse pointer background colour.	965	Mouse pointer background colour.
1022		966
		967	=item B<pointerShape:> I<string>
		968
		969	Compile I<frills>: Specifies the name of the mouse pointer shape
		970	[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
		971	file for possible values (omit the C<XC_> prefix).
		972
1023	=item B<pointerBlankDelay:> I<number>	973	=item B<pointerBlankDelay:> I<number>
1024		974
1025	Specifies number of seconds before blanking the pointer [default 2]. Use a	975	Specifies number of seconds before blanking the pointer [default 2]. Use a
1026	large number (e.g. C<987654321>) to effectively disable the timeout.	976	large number (e.g. C<987654321>) to effectively disable the timeout.
1027		977
1028	=item B<backspacekey:> I<string>	978	=item B<backspacekey:> I<string>
1029		979
1030	The string to send when the backspace key is pressed. If set to B<DEC>	980	The string to send when the backspace key is pressed. If set to B<DEC>
1031	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	981	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
1032	(code 8) - which can be reversed with the appropriate DEC private mode	982	(code 8) - which can be reversed with the appropriate DEC private mode
1033	escape sequence.	983	escape sequence.
1034		984
1035	=item B<deletekey:> I<string>	985	=item B<deletekey:> I<string>
1036		986
…		…
1053		1003
1054	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>	1004	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
1055		1005
1056	=item B<preeditType:> I<style>	1006	=item B<preeditType:> I<style>
1057		1007
1058	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1008	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1059		1009
1060	=item B<inputMethod:> I<name>	1010	=item B<inputMethod:> I<name>
1061		1011
1062	I<name> of inputMethod to use; option B<-im>.	1012	I<name> of inputMethod to use; option B<-im>.
1063		1013
…		…
1081		1031
1082	Change the meaning of triple-click selection with the left mouse	1032	Change the meaning of triple-click selection with the left mouse
1083	button. Instead of selecting a full line it will extend the selection to	1033	button. Instead of selecting a full line it will extend the selection to
1084	the end of the logical line only; option B<-tcw>.	1034	the end of the logical line only; option B<-tcw>.
1085		1035
		1036	=item B<disablePasteBrackets:> I<boolean>
		1037
		1038	Prevent emission of paste bracket sequences; option B<-dpb>.
		1039
1086	=item B<insecure:> I<boolean>	1040	=item B<insecure:> I<boolean>
1087		1041
1088	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1042	Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1089	echo arbitrary strings like the icon name or the locale. This could be	1043	echo arbitrary strings like the icon name or the locale. This could be
1090	abused if somebody gets 8-bit-clean access to your display, whether	1044	abused if somebody gets 8-bit-clean access to your display, whether
1091	through a mail client displaying mail bodies unfiltered or through	1045	through a mail client displaying mail bodies unfiltered or through
1092	write(1) or any other means. Therefore, these sequences are disabled by	1046	write(1) or any other means. Therefore, these sequences are disabled by
1093	default. (Note that many other terminals, including xterm, have these	1047	default. (Note that many other terminals, including xterm, have these
…		…
1111		1065
1112	=item B<secondaryScreen:> I<boolean>	1066	=item B<secondaryScreen:> I<boolean>
1113		1067
1114	Turn on/off secondary screen (default enabled).	1068	Turn on/off secondary screen (default enabled).
1115		1069
		1070	=item B<rewrapMode:> I<mode>
		1071
		1072	Sets long line rewrap behaviour on window resize to one of B<auto>
		1073	(default), B<always> or B<never>.
		1074
1116	=item B<secondaryScroll:> I<boolean>	1075	=item B<secondaryScroll:> I<boolean>
1117		1076
1118	Turn on/off secondary screen scroll (default enabled). If this	1077	Turn on/off secondary screen scroll (default enabled). If this
1119	option is enabled, scrolls on the secondary screen will change the	1078	option is enabled, scrolls on the secondary screen will change the
1120	scrollback buffer and, when secondaryScreen is off, switching	1079	scrollback buffer and, when secondaryScreen is off, switching
…		…
1132	Sets the working directory for the shell (or the command specified via	1091	Sets the working directory for the shell (or the command specified via
1133	B<-e>). The I<path> must be an absolute path and it must exist for	1092	B<-e>). The I<path> must be an absolute path and it must exist for
1134	@@RXVT_NAME@@ to start. If it isn't specified then the current working	1093	@@RXVT_NAME@@ to start. If it isn't specified then the current working
1135	directory will be used; option B<-cd>.	1094	directory will be used; option B<-cd>.
1136		1095
1137	=item B<keysym.>I<sym>: I<string>	1096	=item B<keysym.>I<sym>: I<action>
1138		1097
1139	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1098	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1140	intervening resource name B<keysym.> cannot be omitted.	1099	resource name B<keysym.> cannot be omitted.
1141		1100
1142	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1101	Using this resource, you can map key combinations such as
1143	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1102	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1144	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,	1103	string than would normally result from that combination, making the
1145	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,	1104	terminal scroll up or down the way you want it, or any other thing an
1146	B<2>, B<3>, B<4>, B<5>.	1105	extension might provide.
		1106
		1107	The key combination that triggers the action, I<sym>, has the following format:
		1108
		1109	(modifiers-)key
		1110
		1111	Where I<modifiers> can be any combination of the following full or
		1112	abbreviated modifier names:
		1113
		1114	=begin table
		1115
		1116	B<ISOLevel3> B<I>
		1117	B<AppKeypad> B<K>
		1118	B<Control> B<C>
		1119	B<NumLock> B<N>
		1120	B<Shift> B<S>
		1121	B<Meta> B<M> I<or> B<A>
		1122	B<Lock> B<L>
		1123	B<Mod1> B<1>
		1124	B<Mod2> B<2>
		1125	B<Mod3> B<3>
		1126	B<Mod4> B<4>
		1127	B<Mod5> B<5>
		1128
		1129	=end table
1147		1130
1148	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1131	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1149	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1132	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1150	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1133	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1151	current application keymap mode state.	1134	current application keymap mode state.
1152		1135
1153	The spellings of I<key> can be obtained by using B<xev>(1) command or	1136	Due the the large number of modifier combinations, a key mapping will
1154	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1137	match if I<at least> the specified identifiers are being set, and no other
		1138	key mappings with those and more bits are being defined. That means that
		1139	defining a mapping for C<a> will automatically provide definitions for
		1140	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1141	themselves. See the C<builtin:> action, below, for a way to work around
		1142	this when this is a problem.
		1143
		1144	The spelling of I<key> depends on your implementation of X. An easy way to
		1145	find a key name is to use the B<xev>(1) command. You can find a list by
		1146	looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1155	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1147	the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1156	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1148	value (B<0x0000 - 0xFFFF>).
1157	performed in an exact manner; however, the closest match is assured.
1158		1149
1159	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1150	As with any resource value, the I<action> string may contain backslash
		1151	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1160	number), see RESOURCES in C<man 7 X> for futher details.	1152	number), see RESOURCES in C<man 7 X> for further details.
1161		1153
1162	You can define a range of keysyms in one shot by providing a I<string>	1154	An action starts with an action prefix that selects a certain type
1163	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1155	of action, followed by a colon. An action string without colons is
		1156	interpreted as a literal string to pass to the tty (as if it was
		1157	prefixed with C<string:>).
		1158
		1159	The following action prefixes are known - extensions can provide
		1160	additional prefixes:
		1161
		1162	=over 4
		1163
		1164	=item string:STRING
		1165
		1166	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1167	then the remaining C<STRING> will be passed to the program running in the
		1168	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1169	string C<echo rm -rf /> followed by a newline:
		1170
		1171	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
		1172
		1173	This could in theory be used to completely redefine your keymap.
		1174
		1175	In addition, for actions of this type, you can define a range of
		1176	keysyms in one shot by loading the C<keysym-list> perl extension and
		1177	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1164	should be a character not used by the strings.	1178	the delimiter `/' should be a character not used by the strings.
1165		1179
1166	Its usage can be demonstrated by an example:	1180	Its usage can be demonstrated by an example:
1167		1181
1168	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1182	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1169		1183
1170	The above line is equivalent to the following three lines:	1184	The above line is equivalent to the following three lines:
1171		1185
1172	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1186	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1173	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1187	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1174	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1188	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1175		1189
		1190	=item command:STRING
		1191
1176	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1192	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1177	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1193	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1194	the opposite of C<string:> - instead of sending it to the program running
		1195	in the terminal, it will be treated as if it were program output). This is
		1196	most useful to feed command sequences into @@RXVT_NAME@@.
		1197
1178	example the following means "change the current locale to C<zh_CN.GBK>	1198	For example the following means "change the current locale to C<zh_CN.GBK>
1179	when Control-Meta-c is being pressed":	1199	when Control-Meta-c is being pressed":
1180		1200
1181	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1201	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1182		1202
1183	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1203	The following example will map Control-Meta-1 and Control-Meta-2 to
1184	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1204	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1185	manpage. For example, the F<selection> extension (activated via	1205	font-switching at runtime:
1186	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1187		1206
1188	URxvt.keysym.M-C-c: perl:selection:rot13	1207	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1208	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1189		1209
1190	Due the the large number of modifier combinations, a defined key mapping	1210	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1191	will match if at I<at least> the specified identifiers are being set, and	1211	info):
1192	no other key mappings with those and more bits are being defined. That
1193	means that defining a key map for C<a> will automatically provide
1194	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1195	mappings themselves.
1196		1212
1197	Unfortunately, this will override built-in key mappings. For example	1213	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1214	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1215
		1216	=item builtin:
		1217
		1218	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1219	key binding existed for the key combination. The obvious use is to undo
		1220	the effect of existing bindings. The not so obvious use is to reinstate
		1221	bindings when another binding overrides too many modifiers.
		1222
1198	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1223	For example if you overwrite the C<Insert> key you will disable
1199	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the	1224	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1200	user-defined keymap using the C<builtin:> replacement:	1225	"holes" into the user-defined keymap using the C<builtin:> replacement:
1201		1226
1202	URxvt.keysym.Insert: <my insert key sequence>	1227	URxvt.keysym.Insert: <my insert key sequence>
1203	URxvt.keysym.S-Insert: builtin:	1228	URxvt.keysym.S-Insert: builtin:
1204		1229
1205	The first line defines a mapping for C<Insert> and I<any> combination	1230	The first line defines a mapping for C<Insert> and I<any> combination
1206	of modifiers. The second line re-establishes the default mapping for	1231	of modifiers. The second line re-establishes the default mapping for
1207	C<Shift-Insert>.	1232	C<Shift-Insert>.
1208		1233
1209	The following example will map Control-Meta-1 and Control-Meta-2 to	1234	=item builtin-string:
1210	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1211	font-switching at runtime:
1212		1235
1213	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1236	This action is mainly useful to restore string mappings for keys that
1214	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1237	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1238	difficult to explain - basically, this action will send the string to the
		1239	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1240	action for it.
1215		1241
1216	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1242	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1217	info):	1243	selection when you press C<Shift-Insert>. With the following bindings, it
		1244	would instead emit the (undocumented, but what applications running in the
		1245	terminal might expect) sequence C<ESC [ 2 $> instead:
1218		1246
1219	URxvt.keysym.M-C-3: command:\033[8;25;80t	1247	URxvt.keysym.S-Insert: builtin-string:
1220	URxvt.keysym.M-C-4: command:\033[8;48;110t	1248	URxvt.keysym.C-S-Insert: builtin:
		1249
		1250	The first line disables the paste functionality for that key
		1251	combination, and the second reinstates the default behaviour for
		1252	C<Control-Shift-Insert>, which would otherwise be overridden.
		1253
		1254	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1255	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1256	this:
		1257
		1258	URxvt.keysym.C-M-c: builtin-string:
		1259	URxvt.keysym.C-M-v: builtin-string:
		1260
		1261	=item EXTENSION:STRING
		1262
		1263	An action of this form invokes the action B<STRING>, if any, provided
		1264	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1265	be loaded automatically if necessary.
		1266
		1267	Not all extensions define actions, but popular extensions that do
		1268	include the I<selection> and I<matcher> extensions (documented in their
		1269	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1270	respectively).
		1271
		1272	From the silly examples department, this will rot13-"encrypt"
		1273	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1274	keyboards:
		1275
		1276	URxvt.keysym.M-C-c: selection:rot13
		1277
		1278	=item perl:STRING DEPRECATED
		1279
		1280	This is a deprecated way of invoking commands provided by perl
		1281	extensions. It is still supported, but should not be used anymore.
		1282
		1283	=back
1221		1284
1222	=item B<perl-ext-common>: I<string>	1285	=item B<perl-ext-common>: I<string>
1223		1286
1224	=item B<perl-ext>: I<string>	1287	=item B<perl-ext>: I<string>
1225		1288
…		…
1227	use in this terminal instance; option B<-pe>.	1290	use in this terminal instance; option B<-pe>.
1228		1291
1229	Extension names can be prefixed with a C<-> sign to prohibit using	1292	Extension names can be prefixed with a C<-> sign to prohibit using
1230	them. This can be useful to selectively disable some extensions loaded	1293	them. This can be useful to selectively disable some extensions loaded
1231	by default, or specified via the C<perl-ext-common> resource. For	1294	by default, or specified via the C<perl-ext-common> resource. For
1232	example, C<default,-selection> will use all the default extension except	1295	example, C<default,-selection> will use all the default extensions except
1233	C<selection>.	1296	C<selection>.
1234		1297
1235	Extension names can also be followed by an argument in angle brackets	1298	The default set includes the C<selection>, C<option-popup>,
1236	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1299	C<selection-popup>, C<readline> and C<searchable-scrollback>
1237	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1300	extensions, and extensions which are mentioned in B<keysym> resources.
1238	multiple times with different arguments will pass multiple arguments to	1301
1239	the extension.	1302	Any extension such that a corresponding resource is given on the
		1303	command line is automatically appended to B<perl-ext>.
1240		1304
1241	Each extension is looked up in the library directories, loaded if	1305	Each extension is looked up in the library directories, loaded if
1242	necessary, and bound to the current terminal instance.	1306	necessary, and bound to the current terminal instance. When the library
		1307	search path contains multiple extension files of the same name, then the
		1308	first one found will be used.
1243		1309
1244	If both of these resources are the empty string, then the perl	1310	If both of these resources are the empty string, then the perl interpreter
1245	interpreter will not be initialized. The idea behind two options is that	1311	will not be initialized. The rationale for having two options is that
1246	B<perl-ext-common> will be used for extensions that should be available to	1312	B<perl-ext-common> will be used for extensions that should be available to
1247	all instances, while B<perl-ext> is used for specific instances.	1313	all instances, while B<perl-ext> is used for specific instances.
1248		1314
1249	=item B<perl-eval>: I<string>	1315	=item B<perl-eval>: I<string>
1250		1316
…		…
1252	the @@RXVT_NAME@@perl(3) manpage.	1318	the @@RXVT_NAME@@perl(3) manpage.
1253		1319
1254	=item B<perl-lib>: I<path>	1320	=item B<perl-lib>: I<path>
1255		1321
1256	Colon-separated list of additional directories that hold extension	1322	Colon-separated list of additional directories that hold extension
1257	scripts. When looking for extensions specified by the C<perl> resource,	1323	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1258	@@RXVT_NAME@@ will first look in these directories and then in	1324	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1259	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1325	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1260		1326
1261	See the @@RXVT_NAME@@perl(3) manpage.	1327	See the @@RXVT_NAME@@perl(3) manpage.
1262		1328
1263	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1329	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1264		1330
…		…
1268	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1334	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1269		1335
1270	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1336	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1271	for details.	1337	for details.
1272		1338
1273	=item B<searchable-scrollback:> I<keysym>	1339	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1274		1340
1275	Sets the hotkey that starts the incremental scrollback buffer search	1341	This resource is deprecated and will be removed. Use a B<keysym> resource
1276	(default: C<M-s>).	1342	instead, e.g.:
1277		1343
		1344	URxvt.keysym.M-s: searchable-scrollback:start
		1345
1278	=item B<urlLauncher>: I<string>	1346	=item B<url-launcher>: I<string>
1279		1347
1280	Specifies the program to be started with a URL argument. Used by the	1348	Specifies the program to be started with a URL argument. Used by the
1281	C<selection-popup> and C<matcher> perl extensions.	1349	C<selection-popup> and C<matcher> perl extensions.
1282		1350
1283	=item B<transient-for>: I<windowid>	1351	=item B<transient-for>: I<windowid>
…		…
1286		1354
1287	=item B<override-redirect>: I<boolean>	1355	=item B<override-redirect>: I<boolean>
1288		1356
1289	Compile I<frills>: Sets override-redirect for the terminal window, making	1357	Compile I<frills>: Sets override-redirect for the terminal window, making
1290	it almost invisible to window managers; option B<-override-redirect>.	1358	it almost invisible to window managers; option B<-override-redirect>.
		1359
		1360	=item B<iso14755:> I<boolean>
		1361
		1362	Turn on/off ISO 14755 (default enabled).
1291		1363
1292	=item B<iso14755_52:> I<boolean>	1364	=item B<iso14755_52:> I<boolean>
1293		1365
1294	Turn on/off ISO 14755 5.2 mode (default enabled).	1366	Turn on/off ISO 14755 5.2 mode (default enabled).
1295		1367
…		…
1347	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1419	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1348	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.	1420	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1349		1421
1350	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1422	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1351	inserted too.	1423	inserted too.
		1424
		1425	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1426	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1427	binding causes the value of the internal selection to be copied to the
		1428	CLIPBOARD selection, while the second binding causes the value of the
		1429	CLIPBOARD selection to be inserted.
1352		1430
1353	=back	1431	=back
1354		1432
1355	=head1 CHANGING FONTS	1433	=head1 CHANGING FONTS
1356		1434
…		…
1438	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1516	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1439	it can be seen via the I<who(1)> command, and can accept messages. To	1517	it can be seen via the I<who(1)> command, and can accept messages. To
1440	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1518	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1441	on some systems or setgid to root or to some other group on others.	1519	on some systems or setgid to root or to some other group on others.
1442		1520
1443	=head1 COLORS AND GRAPHICS	1521	=head1 COLOURS AND GRAPHICS
1444		1522
1445	In addition to the default foreground and background colours,	1523	In addition to the default foreground and background colours,
1446	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1524	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1447	high-intensity bold/blink versions of the same). Here is a list of the	1525	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1448	colours with their names.	1526	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1527	cube plus a 8 (24) colour greyscale ramp.
		1528
		1529	B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
		1530	C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
		1531	number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
		1532	colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
		1533	24-bit colour space. When indexing collisions happen, the nearest old colour in
		1534	the cube will be adapted to the new 24-bit RGB colour. That means one cannot
		1535	use many similar 24-bit colours. It's typically not a problem in common
		1536	scenarios.
		1537
		1538	Here is a list of the ANSI colours with their names.
1449		1539
1450	=begin table	1540	=begin table
1451		1541
1452	B<color0> (black) = Black	1542	B<color0> (black) = Black
1453	B<color1> (red) = Red3	1543	B<color1> (red) = Red3
…		…
1473	It is also possible to specify the colour values of B<foreground>,	1563	It is also possible to specify the colour values of B<foreground>,
1474	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1564	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1475	a number 0-15, as a convenient shorthand to reference the colour name of	1565	a number 0-15, as a convenient shorthand to reference the colour name of
1476	color0-color15.	1566	color0-color15.
1477		1567
1478	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1568	The following text gives values for the standard 88 colour mode (and
1479	additional 72 colours. The first 64 of those (with indices 16 to 79)	1569	values for the 256 colour mode in parentheses).
1480	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1481	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1482		1570
		1571	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1572
		1573	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1574	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
		1575
		1576	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1577	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1578	the RGB cube.
		1579
1483	Together, all those colours implement the 88 colour xterm colours. Only	1580	Together, all those colours implement the 88 (256) colour xterm
1484	the first 16 can be changed using resources currently, the rest can only	1581	colours. Only the first 16 can be changed using resources currently, the
1485	be changed via command sequences ("escape codes").	1582	rest can only be changed via command sequences ("escape codes").
		1583
		1584	Applications are advised to use terminfo or command sequences to discover
		1585	number and RGB values of all colours (yes, you can query this...).
1486		1586
1487	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1587	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1488	always swapping the foreground/background colours. This is in contrast to	1588	always swapping the foreground/background colours. This is in contrast to
1489	I<xterm>(1) where the colours are only swapped if they have not otherwise	1589	I<xterm>(1) where the colours are only swapped if they have not otherwise
1490	been specified. For example,	1590	been specified. For example,
1491		1591
1492	=over 4
1493
1494	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1592	@@RXVT_NAME@@ -fg Black -bg White -rv
1495		1593
1496	would yield White on Black, while on I<xterm>(1) it would yield Black	1594	would yield White on Black, while on I<xterm>(1) it would yield Black on
1497	on White.	1595	White.
1498
1499	=back
1500		1596
1501	=head2 ALPHA CHANNEL SUPPORT	1597	=head2 ALPHA CHANNEL SUPPORT
1502		1598
1503	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1599	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1504	their act together, rxvt-unicode will do it's own alpha channel management:	1600	their act together, rxvt-unicode will do its own alpha channel management:
1505		1601
1506	You can prefix any color with an opaquenes percentage enclosed in	1602	You can prefix any colour with an opaqueness percentage enclosed in
1507	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage	1603	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1508	(0-100) that specifies the opacity of the color, where C<0> is completely	1604	(0-100) that specifies the opacity of the colour, where C<0> is completely
1509	transparent and C<100> is completely opaque. For example, C<[50]red> is a	1605	transparent and C<100> is completely opaque. For example, C<[50]red> is a
1510	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This	1606	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1511	is the recommended format to specify transparency values, and works with	1607	is the recommended format to specify transparency values, and works with
1512	all ways to specify a colour.	1608	all ways to specify a colour.
1513		1609
…		…
1591		1687
1592	=item B<SHELL>	1688	=item B<SHELL>
1593		1689
1594	The shell to be used for command execution, defaults to C</bin/sh>.	1690	The shell to be used for command execution, defaults to C</bin/sh>.
1595		1691
1596	=item B<RXVT_SOCKET>	1692	=item B<RXVT_SOCKET> [I<sic>]
1597		1693
1598	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1694	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1599	@@RXVT_NAME@@d(1).	1695	@@RXVT_NAME@@d(1).
1600		1696
1601	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1697	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1698
		1699	=item B<URXVT_PERL_LIB>
		1700
		1701	Additional F<:>-separated library search path for perl extensions. Will be
		1702	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1703	directory.
		1704
		1705	=item B<URXVT_PERL_VERBOSITY>
		1706
		1707	See L<@@RXVT_NAME@@perl>(3).
1602		1708
1603	=item B<HOME>	1709	=item B<HOME>
1604		1710
1605	Used to locate the default directory for the unix domain socket for	1711	Used to locate the default directory for the unix domain socket for
1606	daemon communications and to locate various resource files (such as	1712	daemon communications and to locate various resource files (such as
1607	C<.Xdefaults>)	1713	C<.Xdefaults>)
1608		1714
1609	=item B<XAPPLRESDIR>	1715	=item B<XAPPLRESDIR>
1610		1716
1611	Directory where various X resource files are being located.	1717	Directory where application-specific X resource files are located.
1612		1718
1613	=item B<XENVIRONMENT>	1719	=item B<XENVIRONMENT>
1614		1720
1615	If set and accessible, gives the name of a X resource file to be loaded by	1721	If set and accessible, gives the name of a X resource file to be loaded by
1616	@@RXVT_NAME@@.	1722	@@RXVT_NAME@@.
…		…
1621		1727
1622	=over 4	1728	=over 4
1623		1729
1624	=item B</usr/lib/X11/rgb.txt>	1730	=item B</usr/lib/X11/rgb.txt>
1625		1731
1626	Color names.	1732	Colour names.
1627		1733
1628	=back	1734	=back
1629		1735
1630	=head1 SEE ALSO	1736	=head1 SEE ALSO
1631		1737
		1738	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1632	@@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)	1739	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1633		1740
1634	=head1 CURRENT PROJECT COORDINATOR	1741	=head1 CURRENT PROJECT COORDINATOR
1635		1742
1636	=over 4	1743	=over 4
1637		1744
1638	=item Project Coordinator	1745	=item Project Coordinator
1639		1746
1640	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1747	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1641		1748
1642	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1749	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1643		1750
1644	=back	1751	=back
1645		1752
…		…
1649		1756
1650	=item John Bovey	1757	=item John Bovey
1651		1758
1652	University of Kent, 1992, wrote the original Xvt.	1759	University of Kent, 1992, wrote the original Xvt.
1653		1760
1654	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1761	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1655		1762
1656	very heavily modified Xvt and came up with Rxvt	1763	very heavily modified Xvt and came up with Rxvt
1657		1764
1658	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1765	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1659		1766
1660	wrote the Greek Keyboard Input (no longer in code)	1767	wrote the Greek Keyboard Input (no longer in code)
1661		1768
1662	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1769	=item mj olesen <olesen@me.QueensU.CA>
1663		1770
1664	Wrote the menu system.	1771	Wrote the menu system.
1665		1772
1666	Project Coordinator (changes.txt 2.11 to 2.21)	1773	Project Coordinator (changes.txt 2.11 to 2.21)
1667		1774
1668	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1775	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1669		1776
1670	Project Coordinator (changes.txt 2.21a to 2.4.5)	1777	Project Coordinator (changes.txt 2.21a to 2.4.5)
1671		1778
1672	=item Geoff Wing L<< <gcw@pobox.com> >>	1779	=item Geoff Wing <gcw@pobox.com>
1673		1780
1674	Rewrote screen display and text selection routines.	1781	Rewrote screen display and text selection routines.
1675		1782
1676	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1783	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1677		1784
1678	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1785	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1679		1786
1680	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1787	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1681	extension, random hacks, numerous bugfixes and extensions.	1788	extension, random hacks, numerous bugfixes and extensions.
1682		1789
1683	Project Coordinator (Changes 1.0 -)	1790	Project Coordinator (Changes 1.0 -)
1684		1791
1685	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1792	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1686		1793
1687	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1794	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1688		1795
1689	=back	1796	=back
1690		1797

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.170 by root, Sat May 30 08:51:23 2009 UTC vs. Revision 1.253 by root, Sat Jul 3 15:34:35 2021 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.170 by root, Sat May 30 08:51:23 2009 UTC vs.
Revision 1.253 by root, Sat Jul 3 15:34:35 2021 UTC