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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.168 by root, Tue Nov 4 11:03:29 2008 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	appliation 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
…		…
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>.
358		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.
		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
363	this if you have a good font and want to use its block graphic glyphs;	326	this if you have a good font and want to use its block graphic glyphs;
…		…
366	=item B<-lsp> I<number>	329	=item B<-lsp> I<number>
367		330
368	Compile I<frills>: Lines (pixel height) to insert between each row of	331	Compile I<frills>: Lines (pixel height) to insert between each row of
369	the display. Useful to work around font rendering problems; resource	332	the display. Useful to work around font rendering problems; resource
370	B<lineSpace>.	333	B<lineSpace>.
		334
		335	=item B<-letsp> I<number>
		336
		337	Compile I<frills>: Amount to adjust the computed character width by
		338	to control overall letter spacing. Negative values will tighten up the
		339	letter spacing, positive values will space letters out more. Useful to
		340	work around odd font metrics; resource B<letterSpace>.
371		341
372	=item B<-tn> I<termname>	342	=item B<-tn> I<termname>
373		343
374	This option specifies the name of the terminal type to be set in the	344	This option specifies the name of the terminal type to be set in the
375	B<TERM> environment variable. This terminal type must exist in the	345	B<TERM> environment variable. This terminal type must exist in the
…		…
410	=item B<-pt> I<style>	380	=item B<-pt> I<style>
411		381
412	Compile I<XIM>: input style for input method; B<OverTheSpot>,	382	Compile I<XIM>: input style for input method; B<OverTheSpot>,
413	B<OffTheSpot>, B<Root>; resource B<preeditType>.	383	B<OffTheSpot>, B<Root>; resource B<preeditType>.
414		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
415	=item B<-im> I<text>	388	=item B<-im> I<text>
416		389
417	Compile I<XIM>: input method name. resource B<inputMethod>.	390	Compile I<XIM>: input method name. resource B<inputMethod>.
418		391
419	=item B<-imlocale> I<string>	392	=item B<-imlocale> I<string>
…		…
433	Change the meaning of triple-click selection with the left mouse	406	Change the meaning of triple-click selection with the left mouse
434	button. Only effective when the original (non-perl) selection code is	407	button. Only effective when the original (non-perl) selection code is
435	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
436	the end of the logical line only. resource B<tripleclickwords>.	409	the end of the logical line only. resource B<tripleclickwords>.
437		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
438	=item B<-insecure>	421	=item B<-insecure>
439		422
440	Enable "insecure" mode, which currently enables most of the escape	423	Enable "insecure" mode, which currently enables most of the escape
441	sequences that echo strings. See the resource B<insecure> for more	424	sequences that echo strings. See the resource B<insecure> for more
442	info.	425	info.
…		…
454		437
455	=item B<-ssr>\|B<+ssr>	438	=item B<-ssr>\|B<+ssr>
456		439
457	Turn on/off secondary screen scroll (default enabled); resource	440	Turn on/off secondary screen scroll (default enabled); resource
458	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>.
459		450
460	=item B<-hold>\|B<+hold>	451	=item B<-hold>\|B<+hold>
461		452
462	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@@
463	will not immediately destroy its window when the program executed within	454	will not immediately destroy its window when the program executed within
…		…
560	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
561	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
562	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	553	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
563	with later settings overwriting earlier ones:	554	with later settings overwriting earlier ones:
564		555
565	1. system-wide app-defaults file, either locale-dependent OR global
566	2. app-defaults file in $XAPPLRESDIR	556	1. app-defaults file in $XAPPLRESDIR
		557	2. $HOME/.Xdefaults
567	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	558	3. RESOURCE_MANAGER property on root-window of screen 0
568	4. SCREEN_RESOURCES for the current screen	559	4. SCREEN_RESOURCES property on root-window of the current screen
569	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	560	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
570	6. resources specified via -xrm on the commandline	561	6. resources specified via -xrm on the commandline
571		562
572	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
573	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
…		…
614	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
615	corresponds to low-intensity (normal) colours and 8-15 corresponds to	606	corresponds to low-intensity (normal) colours and 8-15 corresponds to
616	high-intensity (bold = bright foreground, blink = bright background)	607	high-intensity (bold = bright foreground, blink = bright background)
617	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,
618	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
619	names used are listed in the B<COLORS AND GRAPHICS> section.	610	names used are listed in the B<COLOURS AND GRAPHICS> section.
620		611
621	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
622	changed using an escape command (see @@RXVT_NAME@@(7)).	613	changed using an escape command (see @@RXVT_NAME@@(7)).
623		614
624	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
…		…
635	=item B<colorUL:> I<colour>	626	=item B<colorUL:> I<colour>
636		627
637	Use the specified colour to display underlined characters when the	628	Use the specified colour to display underlined characters when the
638	foreground colour is the default.	629	foreground colour is the default.
639		630
640	=item B<colorRV:> I<colour>
641
642	Use the specified colour as the background for reverse video characters
643	when OPTION_HC is disabled (--disable-frills).
644
645	=item B<underlineColor:> I<colour>	631	=item B<underlineColor:> I<colour>
646		632
647	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
648	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.
649		645
650	=item B<cursorColor:> I<colour>	646	=item B<cursorColor:> I<colour>
651		647
652	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
653	foreground colour; option B<-cr>.	649	foreground colour; option B<-cr>.
…		…
660		656
661	=item B<reverseVideo:> I<boolean>	657	=item B<reverseVideo:> I<boolean>
662		658
663	B<True>: simulate reverse video by foreground and background colours;	659	B<True>: simulate reverse video by foreground and background colours;
664	option B<-rv>. B<False>: regular screen colours [default]; option	660	option B<-rv>. B<False>: regular screen colours [default]; option
665	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	661	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
666		662
667	=item B<jumpScroll:> I<boolean>	663	=item B<jumpScroll:> I<boolean>
668		664
669	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
670	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
…		…
684		680
685	B<False>: specify that everything is to be displayed, even	681	B<False>: specify that everything is to be displayed, even
686	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
687	monitor to display anything); option B<+ss>.	683	monitor to display anything); option B<+ss>.
688		684
689	=item B<transparent:> I<boolean>
690
691	Turn on/off illusion of a transparent window background.
692
693	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
694	future versions.
695
696	I<Please address all transparency related issues to Sasha Vasko at
697	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
698
699	=item B<fading:> I<number>	685	=item B<fading:> I<number>
700		686
701	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>.
702		688
703	=item B<fadeColor:> I<colour>	689	=item B<fadeColor:> I<colour>
704		690
705	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
706	colour is black; option B<-fadecolor>.	692	colour is black; option B<-fadecolor>.
707		693
708	=item B<tintColor:> I<colour>
709
710	Tint the transparent background pixmap with the given colour; option
711	B<-tint>.
712
713	=item B<shading:> I<number>
714
715	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
716	in addition to tinting it; option B<-sh>.
717
718	=item B<blendType:> I<string>
719
720	Specify background blending type; option B<-blt>.
721
722	=item B<blurRadius:> I<number>
723
724	Apply gaussian blur with the specified radius to the transparent
725	background image; option B<-blr>.
726
727	=item B<iconFile:> I<file>	694	=item B<iconFile:> I<file>
728		695
729	Set the application icon pixmap; option B<-icon>.	696	Set the application icon pixmap; option B<-icon>.
730		697
731	=item B<scrollColor:> I<colour>	698	=item B<scrollColor:> I<colour>
…		…
739		706
740	=item B<borderColor:> I<colour>	707	=item B<borderColor:> I<colour>
741		708
742	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
743	and the text.	710	and the text.
744
745	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
746
747	Use the specified image file for the background and also
748	optionally specify its scaling with a geometry string B<WxH+X+Y>,
749	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
750	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
751	centre (percent). A scale of 0 displays the image with tiling. A scale
752	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
753	an integer number of images in that direction. No image will be magnified
754	beyond 10 times its original size. The maximum permitted scale is 1000.
755	Additional operations can be specified after colon B<:op1:op2...>.
756	Supported operations are:
757
758	tile force background image to be tiled and not scaled. Equivalent to 0x0
759	propscale will scale image keeping proportions
760	auto will scale image to match window size. Equivalent to 100x100
761	hscale will scale image horizontally to the window size
762	vscale will scale image vertically to the window size
763	scale will scale image to match window size
764	root will tile image as if it was a root window background, auto-adjusting
765	whenever terminal window moves
766
767	If used in conjunction with B<-tr> option, the specified pixmap will be
768	blended over transparency image using either alpha-blending, or any
769	other blending type, specified with B<-blt "type"> option.
770
771	=item B<path:> I<path>
772
773	Specify the colon-delimited search path for finding background image files.
774		711
775	=item B<font:> I<fontlist>	712	=item B<font:> I<fontlist>
776		713
777	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
778	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
…		…
801	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
802	wide and 15 pixels high.	739	wide and 15 pixels high.
803		740
804	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
805	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
806	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
807	useful supplement.	744	useful supplement.
808		745
809	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
810	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
811	contains other characters, but we are not interested in them.	748	contains other characters, but we are not interested in them.
…		…
875		812
876	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
877	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
878	[default]; option B<+ls>.	815	[default]; option B<+ls>.
879		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
880	=item B<utmpInhibit:> I<boolean>	822	=item B<utmpInhibit:> I<boolean>
881		823
882	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>;
883	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>
884	[default]; option B<+ut>.	826	[default]; option B<+ut>.
…		…
901	=item B<scrollstyle:> I<mode>	843	=item B<scrollstyle:> I<mode>
902		844
903	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
904	the author's favourite.	846	the author's favourite.
905		847
		848	=item B<thickness:> I<number>
		849
		850	Set the scrollbar width in pixels.
		851
906	=item B<scrollBar:> I<boolean>	852	=item B<scrollBar:> I<boolean>
907		853
908	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	854	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
909	disable the scrollbar; option B<+sb>.	855	disable the scrollbar; option B<+sb>.
910		856
…		…
929	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
930	B<+si>.	876	B<+si>.
931		877
932	=item B<scrollWithBuffer:> I<boolean>	878	=item B<scrollWithBuffer:> I<boolean>
933		879
934	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.
935	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
936	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>.
937		884
938	=item B<scrollTtyKeypress:> I<boolean>	885	=item B<scrollTtyKeypress:> I<boolean>
939		886
940	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
941	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
942	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
943	bottom when a non-special key is pressed; option B<+sk>.	890	bottom when a non-special key is pressed; option B<+sk>.
944		891
945	=item B<saveLines:> I<number>	892	=item B<saveLines:> I<number>
946		893
947	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>.
948	resource is limited on most machines to 65535; option B<-sl>.
949		895
950	=item B<internalBorder:> I<number>	896	=item B<internalBorder:> I<number>
951		897
952	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;
953	option B<-b>.	899	option B<-b>.
…		…
997	=item B<cursorBlink:> I<boolean>	943	=item B<cursorBlink:> I<boolean>
998		944
999	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];
1000	option B<-bc>.	946	option B<-bc>.
1001		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
1002	=item B<pointerBlank:> I<boolean>	953	=item B<pointerBlank:> I<boolean>
1003		954
1004	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
1005	of seconds of inactivity. B<False>: the pointer is always visible	956	of seconds of inactivity. B<False>: the pointer is always visible
1006	[default].	957	[default].
…		…
1011		962
1012	=item B<pointerColor2:> I<colour>	963	=item B<pointerColor2:> I<colour>
1013		964
1014	Mouse pointer background colour.	965	Mouse pointer background colour.
1015		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
1016	=item B<pointerBlankDelay:> I<number>	973	=item B<pointerBlankDelay:> I<number>
1017		974
1018	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
1019	large number (e.g. C<987654321>) to effectively disable the timeout.	976	large number (e.g. C<987654321>) to effectively disable the timeout.
1020		977
1021	=item B<backspacekey:> I<string>	978	=item B<backspacekey:> I<string>
1022		979
1023	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>
1024	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>
1025	(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
1026	escape sequence.	983	escape sequence.
1027		984
1028	=item B<deletekey:> I<string>	985	=item B<deletekey:> I<string>
1029		986
…		…
1046		1003
1047	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>	1004	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
1048		1005
1049	=item B<preeditType:> I<style>	1006	=item B<preeditType:> I<style>
1050		1007
1051	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1008	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1052		1009
1053	=item B<inputMethod:> I<name>	1010	=item B<inputMethod:> I<name>
1054		1011
1055	I<name> of inputMethod to use; option B<-im>.	1012	I<name> of inputMethod to use; option B<-im>.
1056		1013
…		…
1074		1031
1075	Change the meaning of triple-click selection with the left mouse	1032	Change the meaning of triple-click selection with the left mouse
1076	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
1077	the end of the logical line only; option B<-tcw>.	1034	the end of the logical line only; option B<-tcw>.
1078		1035
		1036	=item B<disablePasteBrackets:> I<boolean>
		1037
		1038	Prevent emission of paste bracket sequences; option B<-dpb>.
		1039
1079	=item B<insecure:> I<boolean>	1040	=item B<insecure:> I<boolean>
1080		1041
1081	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1042	Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1082	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
1083	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
1084	through a mail client displaying mail bodies unfiltered or through	1045	through a mail client displaying mail bodies unfiltered or through
1085	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
1086	default. (Note that many other terminals, including xterm, have these	1047	default. (Note that many other terminals, including xterm, have these
…		…
1104		1065
1105	=item B<secondaryScreen:> I<boolean>	1066	=item B<secondaryScreen:> I<boolean>
1106		1067
1107	Turn on/off secondary screen (default enabled).	1068	Turn on/off secondary screen (default enabled).
1108		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
1109	=item B<secondaryScroll:> I<boolean>	1075	=item B<secondaryScroll:> I<boolean>
1110		1076
1111	Turn on/off secondary screen scroll (default enabled). If this	1077	Turn on/off secondary screen scroll (default enabled). If this
1112	option is enabled, scrolls on the secondary screen will change the	1078	option is enabled, scrolls on the secondary screen will change the
1113	scrollback buffer and, when secondaryScreen is off, switching	1079	scrollback buffer and, when secondaryScreen is off, switching
…		…
1125	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
1126	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
1127	@@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
1128	directory will be used; option B<-cd>.	1094	directory will be used; option B<-cd>.
1129		1095
1130	=item B<keysym.>I<sym>: I<string>	1096	=item B<keysym.>I<sym>: I<action>
1131		1097
1132	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1098	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1133	intervening resource name B<keysym.> cannot be omitted.	1099	resource name B<keysym.> cannot be omitted.
1134		1100
1135	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
1136	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1102	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1137	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
1138	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
1139	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
1140		1130
1141	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
1142	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
1143	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
1144	current application keymap mode state.	1134	current application keymap mode state.
1145		1135
1146	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
1147	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
1148	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
1149	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1148	value (B<0x0000 - 0xFFFF>).
1150	performed in an exact manner; however, the closest match is assured.
1151		1149
1152	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
1153	number), see RESOURCES in C<man 7 X> for futher details.	1152	number), see RESOURCES in C<man 7 X> for further details.
1154		1153
1155	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
1156	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
1157	should be a character not used by the strings.	1178	the delimiter `/' should be a character not used by the strings.
1158		1179
1159	Its usage can be demonstrated by an example:	1180	Its usage can be demonstrated by an example:
1160		1181
1161	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1182	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1162		1183
1163	The above line is equivalent to the following three lines:	1184	The above line is equivalent to the following three lines:
1164		1185
1165	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1186	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1166	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1187	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1167	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1188	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1168		1189
		1190	=item command:STRING
		1191
1169	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>
1170	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
1171	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>
1172	when Control-Meta-c is being pressed":	1199	when Control-Meta-c is being pressed":
1173		1200
1174	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
1175		1202
1176	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
1177	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
1178	manpage. For example, the F<selection> extension (activated via	1205	font-switching at runtime:
1179	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1180		1206
1181	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
1182		1209
1183	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
1184	will match if at I<at least> the specified identifiers are being set, and	1211	info):
1185	no other key mappings with those and more bits are being defined. That
1186	means that defining a key map for C<a> will automatically provide
1187	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1188	mappings themselves.
1189		1212
1190	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
1191	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
1192	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
1193	user-defined keymap using the C<builtin:> replacement:	1225	"holes" into the user-defined keymap using the C<builtin:> replacement:
1194		1226
1195	URxvt.keysym.Insert: <my insert key sequence>	1227	URxvt.keysym.Insert: <my insert key sequence>
1196	URxvt.keysym.S-Insert: builtin:	1228	URxvt.keysym.S-Insert: builtin:
1197		1229
1198	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
1199	of modifiers. The second line re-establishes the default mapping for	1231	of modifiers. The second line re-establishes the default mapping for
1200	C<Shift-Insert>.	1232	C<Shift-Insert>.
1201		1233
1202	The following example will map Control-Meta-1 and Control-Meta-2 to	1234	=item builtin-string:
1203	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1204	font-switching at runtime:
1205		1235
1206	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1236	This action is mainly useful to restore string mappings for keys that
1207	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.
1208		1241
1209	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
1210	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:
1211		1246
1212	URxvt.keysym.M-C-3: command:\033[8;25;80t	1247	URxvt.keysym.S-Insert: builtin-string:
1213	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
1214		1284
1215	=item B<perl-ext-common>: I<string>	1285	=item B<perl-ext-common>: I<string>
1216		1286
1217	=item B<perl-ext>: I<string>	1287	=item B<perl-ext>: I<string>
1218		1288
…		…
1220	use in this terminal instance; option B<-pe>.	1290	use in this terminal instance; option B<-pe>.
1221		1291
1222	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
1223	them. This can be useful to selectively disable some extensions loaded	1293	them. This can be useful to selectively disable some extensions loaded
1224	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
1225	example, C<default,-selection> will use all the default extension except	1295	example, C<default,-selection> will use all the default extensions except
1226	C<selection>.	1296	C<selection>.
1227		1297
1228	Extension names can also be followed by an argument in angle brackets	1298	The default set includes the C<selection>, C<option-popup>,
1229	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1299	C<selection-popup>, C<readline> and C<searchable-scrollback>
1230	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1300	extensions, and extensions which are mentioned in B<keysym> resources.
1231	multiple times with different arguments will pass multiple arguments to	1301
1232	the extension.	1302	Any extension such that a corresponding resource is given on the
		1303	command line is automatically appended to B<perl-ext>.
1233		1304
1234	Each extension is looked up in the library directories, loaded if	1305	Each extension is looked up in the library directories, loaded if
1235	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.
1236		1309
1237	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
1238	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
1239	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
1240	all instances, while B<perl-ext> is used for specific instances.	1313	all instances, while B<perl-ext> is used for specific instances.
1241		1314
1242	=item B<perl-eval>: I<string>	1315	=item B<perl-eval>: I<string>
1243		1316
…		…
1245	the @@RXVT_NAME@@perl(3) manpage.	1318	the @@RXVT_NAME@@perl(3) manpage.
1246		1319
1247	=item B<perl-lib>: I<path>	1320	=item B<perl-lib>: I<path>
1248		1321
1249	Colon-separated list of additional directories that hold extension	1322	Colon-separated list of additional directories that hold extension
1250	scripts. When looking for extensions specified by the C<perl> resource,	1323	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1251	@@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
1252	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1325	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1253		1326
1254	See the @@RXVT_NAME@@perl(3) manpage.	1327	See the @@RXVT_NAME@@perl(3) manpage.
1255		1328
1256	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1329	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1257		1330
…		…
1261	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1334	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1262		1335
1263	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1336	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1264	for details.	1337	for details.
1265		1338
1266	=item B<searchable-scrollback:> I<keysym>	1339	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1267		1340
1268	Sets the hotkey that starts the incremental scrollback buffer search	1341	This resource is deprecated and will be removed. Use a B<keysym> resource
1269	(default: C<M-s>).	1342	instead, e.g.:
1270		1343
		1344	URxvt.keysym.M-s: searchable-scrollback:start
		1345
1271	=item B<urlLauncher>: I<string>	1346	=item B<url-launcher>: I<string>
1272		1347
1273	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
1274	C<selection-popup> and C<matcher> perl extensions.	1349	C<selection-popup> and C<matcher> perl extensions.
1275		1350
1276	=item B<transient-for>: I<windowid>	1351	=item B<transient-for>: I<windowid>
…		…
1279		1354
1280	=item B<override-redirect>: I<boolean>	1355	=item B<override-redirect>: I<boolean>
1281		1356
1282	Compile I<frills>: Sets override-redirect for the terminal window, making	1357	Compile I<frills>: Sets override-redirect for the terminal window, making
1283	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).
1284		1363
1285	=item B<iso14755_52:> I<boolean>	1364	=item B<iso14755_52:> I<boolean>
1286		1365
1287	Turn on/off ISO 14755 5.2 mode (default enabled).	1366	Turn on/off ISO 14755 5.2 mode (default enabled).
1288		1367
…		…
1340	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
1341	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.
1342		1421
1343	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
1344	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.
1345		1430
1346	=back	1431	=back
1347		1432
1348	=head1 CHANGING FONTS	1433	=head1 CHANGING FONTS
1349		1434
…		…
1431	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
1432	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
1433	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
1434	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.
1435		1520
1436	=head1 COLORS AND GRAPHICS	1521	=head1 COLOURS AND GRAPHICS
1437		1522
1438	In addition to the default foreground and background colours,	1523	In addition to the default foreground and background colours,
1439	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
1440	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
1441	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.
1442		1539
1443	=begin table	1540	=begin table
1444		1541
1445	B<color0> (black) = Black	1542	B<color0> (black) = Black
1446	B<color1> (red) = Red3	1543	B<color1> (red) = Red3
…		…
1466	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>,
1467	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1564	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1468	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
1469	color0-color15.	1566	color0-color15.
1470		1567
1471	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1568	The following text gives values for the standard 88 colour mode (and
1472	additional 72 colours. The first 64 of those (with indices 16 to 79)	1569	values for the 256 colour mode in parentheses).
1473	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1474	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1475		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
1476	Together, all those colours implement the 88 colour xterm colours. Only	1580	Together, all those colours implement the 88 (256) colour xterm
1477	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
1478	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...).
1479		1586
1480	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1587	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1481	always swapping the foreground/background colours. This is in contrast to	1588	always swapping the foreground/background colours. This is in contrast to
1482	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
1483	been specified. For example,	1590	been specified. For example,
1484		1591
1485	=over 4
1486
1487	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1592	@@RXVT_NAME@@ -fg Black -bg White -rv
1488		1593
1489	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
1490	on White.	1595	White.
1491
1492	=back
1493		1596
1494	=head2 ALPHA CHANNEL SUPPORT	1597	=head2 ALPHA CHANNEL SUPPORT
1495		1598
1496	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
1497	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:
1498		1601
1499	You can prefix any color with an opaquenes percentage enclosed in	1602	You can prefix any colour with an opaqueness percentage enclosed in
1500	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
1501	(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
1502	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
1503	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
1504	is the recommended format to specify transparency values, and works with	1607	is the recommended format to specify transparency values, and works with
1505	all ways to specify a colour.	1608	all ways to specify a colour.
1506		1609
…		…
1584		1687
1585	=item B<SHELL>	1688	=item B<SHELL>
1586		1689
1587	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>.
1588		1691
1589	=item B<RXVT_SOCKET>	1692	=item B<RXVT_SOCKET> [I<sic>]
1590		1693
1591	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
1592	@@RXVT_NAME@@d(1).	1695	@@RXVT_NAME@@d(1).
1593		1696
1594	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).
1595		1708
1596	=item B<HOME>	1709	=item B<HOME>
1597		1710
1598	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
1599	daemon communications and to locate various resource files (such as	1712	daemon communications and to locate various resource files (such as
1600	C<.Xdefaults>)	1713	C<.Xdefaults>)
1601		1714
1602	=item B<XAPPLRESDIR>	1715	=item B<XAPPLRESDIR>
1603		1716
1604	Directory where various X resource files are being located.	1717	Directory where application-specific X resource files are located.
1605		1718
1606	=item B<XENVIRONMENT>	1719	=item B<XENVIRONMENT>
1607		1720
1608	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
1609	@@RXVT_NAME@@.	1722	@@RXVT_NAME@@.
…		…
1614		1727
1615	=over 4	1728	=over 4
1616		1729
1617	=item B</usr/lib/X11/rgb.txt>	1730	=item B</usr/lib/X11/rgb.txt>
1618		1731
1619	Color names.	1732	Colour names.
1620		1733
1621	=back	1734	=back
1622		1735
1623	=head1 SEE ALSO	1736	=head1 SEE ALSO
1624		1737
		1738	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1625	@@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)
1626		1740
1627	=head1 CURRENT PROJECT COORDINATOR	1741	=head1 CURRENT PROJECT COORDINATOR
1628		1742
1629	=over 4	1743	=over 4
1630		1744
1631	=item Project Coordinator	1745	=item Project Coordinator
1632		1746
1633	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1747	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1634		1748
1635	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1749	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1636		1750
1637	=back	1751	=back
1638		1752
…		…
1642		1756
1643	=item John Bovey	1757	=item John Bovey
1644		1758
1645	University of Kent, 1992, wrote the original Xvt.	1759	University of Kent, 1992, wrote the original Xvt.
1646		1760
1647	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1761	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1648		1762
1649	very heavily modified Xvt and came up with Rxvt	1763	very heavily modified Xvt and came up with Rxvt
1650		1764
1651	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1765	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1652		1766
1653	wrote the Greek Keyboard Input (no longer in code)	1767	wrote the Greek Keyboard Input (no longer in code)
1654		1768
1655	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1769	=item mj olesen <olesen@me.QueensU.CA>
1656		1770
1657	Wrote the menu system.	1771	Wrote the menu system.
1658		1772
1659	Project Coordinator (changes.txt 2.11 to 2.21)	1773	Project Coordinator (changes.txt 2.11 to 2.21)
1660		1774
1661	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1775	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1662		1776
1663	Project Coordinator (changes.txt 2.21a to 2.4.5)	1777	Project Coordinator (changes.txt 2.21a to 2.4.5)
1664		1778
1665	=item Geoff Wing L<< <gcw@pobox.com> >>	1779	=item Geoff Wing <gcw@pobox.com>
1666		1780
1667	Rewrote screen display and text selection routines.	1781	Rewrote screen display and text selection routines.
1668		1782
1669	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1783	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1670		1784
1671	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1785	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1672		1786
1673	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1787	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1674	extension, random hacks, numerous bugfixes and extensions.	1788	extension, random hacks, numerous bugfixes and extensions.
1675		1789
1676	Project Coordinator (Changes 1.0 -)	1790	Project Coordinator (Changes 1.0 -)
1677		1791
1678	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1792	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1679		1793
1680	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1794	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1681		1795
1682	=back	1796	=back
1683		1797

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.168 by root, Tue Nov 4 11:03:29 2008 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.168 by root, Tue Nov 4 11:03:29 2008 UTC vs.
Revision 1.253 by root, Sat Jul 3 15:34:35 2021 UTC