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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.165 by root, Thu Oct 2 17:06:50 2008 UTC vs.
Revision 1.249 by root, Sat Oct 10 20:03:39 2020 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>	144	=item B<-icon> I<file>
149		145
150	Tint the transparent background pixmap with the given colour when	146	Compile I<pixbuf>: Use the specified image as application icon. This
151	transparency is enabled with B<-tr>. This only works for	147	is used by many window managers, taskbars and pagers to represent the
152	non-tiled backgrounds, currently. See also the B<-sh> option that can be	148	application window; resource I<iconFile>.
153	used to brighten or darken the image in addition to tinting it.
154	Please note that certain tint colours can be applied on the server-side,
155	thus yielding performance gain of two orders of magnitude. These colours are:
156	blue, red, green, cyan, magenta, yellow, and those close to them. Also
157	pure black and pure white colors essentially mean no tinting; resource
158	I<tintColor>. Example:
159
160	@@RXVT_NAME@@ -tr -tint blue -sh 40
161
162	=item B<-sh> I<number>
163
164	Darken (0 .. 100) or lighten (100 .. 200) the transparent
165	background image in addition to (or instead of) tinting it;
166	resource I<shading>.
167
168	=item B<-blt> I<string>
169
170	Specify background blending type. If background pixmap is specified
171	at the same time as transparency - such pixmap will be blended over
172	transparency image, using method specified. Supported values are :
173	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
174	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176	alpha-blending. Compile I<afterimage>; resource I<blendType>.
177
178	=item B<-blr> I<HxV>
179
180	Apply Gaussian Blur with the specified radii to the transparent
181	background image. If single number is specified - both vertical and
182	horizontal radii are considered to be the same. Setting one of the
183	radii to 1 and another to a large number creates interesting effects
184	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
185	resource I<blurRadius>.
186		149
187	=item B<-bg> I<colour>	150	=item B<-bg> I<colour>
188		151
189	Window background colour; resource B<background>.	152	Window background colour; resource B<background>.
190		153
191	=item B<-fg> I<colour>	154	=item B<-fg> I<colour>
192		155
193	Window foreground colour; resource B<foreground>.	156	Window foreground colour; resource B<foreground>.
194
195	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
196
197	Compile I<afterimage>: Specify image file for the background and also
198	optionally specify its scaling with a geometry string. Note you may need to
199	add quotes to avoid special shell interpretation of the C<;> in the
200	command-line; for more details see resource B<backgroundPixmap>.
201		157
202	=item B<-cr> I<colour>	158	=item B<-cr> I<colour>
203		159
204	The cursor colour; resource B<cursorColor>.	160	The cursor colour; resource B<cursorColor>.
205		161
…		…
264		220
265	=item B<-ls>\|B<+ls>	221	=item B<-ls>\|B<+ls>
266		222
267	Start as a login-shell/sub-shell; resource B<loginShell>.	223	Start as a login-shell/sub-shell; resource B<loginShell>.
268		224
		225	=item B<-mc> I<milliseconds>
		226
		227	Specify the maximum time between multi-click selections.
		228
269	=item B<-ut>\|B<+ut>	229	=item B<-ut>\|B<+ut>
270		230
271	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	231	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
272	B<utmpInhibit>.	232	B<utmpInhibit>.
273		233
…		…
315		275
316	=item B<-bc>\|B<+bc>	276	=item B<-bc>\|B<+bc>
317		277
318	Blink the cursor; resource B<cursorBlink>.	278	Blink the cursor; resource B<cursorBlink>.
319		279
		280	=item B<-uc>\|B<+uc>
		281
		282	Make the cursor underlined; resource B<cursorUnderline>.
		283
320	=item B<-iconic>	284	=item B<-iconic>
321		285
322	Start iconified, if the window manager supports that option.	286	Start iconified, if the window manager supports that option.
323	Alternative form is B<-ic>.	287	Alternative form is B<-ic>.
324		288
…		…
348	=item B<-override-redirect>	312	=item B<-override-redirect>
349		313
350	Compile I<frills>: Sets override-redirect on the window; resource	314	Compile I<frills>: Sets override-redirect on the window; resource
351	B<override-redirect>.	315	B<override-redirect>.
352		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
353	=item B<-sbg>	322	=item B<-sbg>
354		323
355	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
356	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
357	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;
…		…
360	=item B<-lsp> I<number>	329	=item B<-lsp> I<number>
361		330
362	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
363	the display. Useful to work around font rendering problems; resource	332	the display. Useful to work around font rendering problems; resource
364	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>.
365		341
366	=item B<-tn> I<termname>	342	=item B<-tn> I<termname>
367		343
368	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
369	B<TERM> environment variable. This terminal type must exist in the	345	B<TERM> environment variable. This terminal type must exist in the
…		…
404	=item B<-pt> I<style>	380	=item B<-pt> I<style>
405		381
406	Compile I<XIM>: input style for input method; B<OverTheSpot>,	382	Compile I<XIM>: input style for input method; B<OverTheSpot>,
407	B<OffTheSpot>, B<Root>; resource B<preeditType>.	383	B<OffTheSpot>, B<Root>; resource B<preeditType>.
408		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
409	=item B<-im> I<text>	388	=item B<-im> I<text>
410		389
411	Compile I<XIM>: input method name. resource B<inputMethod>.	390	Compile I<XIM>: input method name. resource B<inputMethod>.
412		391
413	=item B<-imlocale> I<string>	392	=item B<-imlocale> I<string>
…		…
554	You can set and change the resources using X11 tools like B<xrdb>. Many	533	You can set and change the resources using X11 tools like B<xrdb>. Many
555	distribution do also load settings from the B<~/.Xresources> file when X	534	distribution do also load settings from the B<~/.Xresources> file when X
556	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	535	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
557	with later settings overwriting earlier ones:	536	with later settings overwriting earlier ones:
558		537
559	1. system-wide app-defaults file, either locale-dependent OR global
560	2. app-defaults file in $XAPPLRESDIR	538	1. app-defaults file in $XAPPLRESDIR
		539	2. $HOME/.Xdefaults
561	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	540	3. RESOURCE_MANAGER property on root-window of screen 0
562	4. SCREEN_RESOURCES for the current screen	541	4. SCREEN_RESOURCES property on root-window of the current screen
563	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	542	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
564	6. resources specified via -xrm on the commandline	543	6. resources specified via -xrm on the commandline
565		544
566	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	545	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
567	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources	546	names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
…		…
608	Use the specified colour for the colour value I<n>, where 0-7	587	Use the specified colour for the colour value I<n>, where 0-7
609	corresponds to low-intensity (normal) colours and 8-15 corresponds to	588	corresponds to low-intensity (normal) colours and 8-15 corresponds to
610	high-intensity (bold = bright foreground, blink = bright background)	589	high-intensity (bold = bright foreground, blink = bright background)
611	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	590	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
612	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	591	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
613	names used are listed in the B<COLORS AND GRAPHICS> section.	592	names used are listed in the B<COLOURS AND GRAPHICS> section.
614		593
615	Colours higher than 15 cannot be set using resources (yet), but can be	594	Colours higher than 15 cannot be set using resources (yet), but can be
616	changed using an escape command (see @@RXVT_NAME@@(7)).	595	changed using an escape command (see @@RXVT_NAME@@(7)).
617		596
618	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	597	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
629	=item B<colorUL:> I<colour>	608	=item B<colorUL:> I<colour>
630		609
631	Use the specified colour to display underlined characters when the	610	Use the specified colour to display underlined characters when the
632	foreground colour is the default.	611	foreground colour is the default.
633		612
634	=item B<colorRV:> I<colour>
635
636	Use the specified colour as the background for reverse video characters
637	when OPTION_HC is disabled (--disable-frills).
638
639	=item B<underlineColor:> I<colour>	613	=item B<underlineColor:> I<colour>
640		614
641	If set, use the specified colour as the colour for the underline	615	If set, use the specified colour as the colour for the underline
642	itself. If unset, use the foreground colour.	616	itself. If unset, use the foreground colour.
		617
		618	=item B<highlightColor:> I<colour>
		619
		620	If set, use the specified colour as the background for highlighted
		621	characters. If unset, use reverse video.
		622
		623	=item B<highlightTextColor:> I<colour>
		624
		625	If set and highlightColor is set, use the specified colour as the
		626	foreground for highlighted characters.
643		627
644	=item B<cursorColor:> I<colour>	628	=item B<cursorColor:> I<colour>
645		629
646	Use the specified colour for the cursor. The default is to use the	630	Use the specified colour for the cursor. The default is to use the
647	foreground colour; option B<-cr>.	631	foreground colour; option B<-cr>.
…		…
654		638
655	=item B<reverseVideo:> I<boolean>	639	=item B<reverseVideo:> I<boolean>
656		640
657	B<True>: simulate reverse video by foreground and background colours;	641	B<True>: simulate reverse video by foreground and background colours;
658	option B<-rv>. B<False>: regular screen colours [default]; option	642	option B<-rv>. B<False>: regular screen colours [default]; option
659	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	643	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
660		644
661	=item B<jumpScroll:> I<boolean>	645	=item B<jumpScroll:> I<boolean>
662		646
663	B<True>: specify that jump scrolling should be used. When receiving lots	647	B<True>: specify that jump scrolling should be used. When receiving lots
664	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines	648	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
678		662
679	B<False>: specify that everything is to be displayed, even	663	B<False>: specify that everything is to be displayed, even
680	if the refresh is too fast for the human eye to read anything (or the	664	if the refresh is too fast for the human eye to read anything (or the
681	monitor to display anything); option B<+ss>.	665	monitor to display anything); option B<+ss>.
682		666
683	=item B<transparent:> I<boolean>
684
685	Turn on/off illusion of a transparent window background.
686
687	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
688	future versions.
689
690	I<Please address all transparency related issues to Sasha Vasko at
691	sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
692
693	=item B<fading:> I<number>	667	=item B<fading:> I<number>
694		668
695	Fade the text by the given percentage when focus is lost; option B<-fade>.	669	Fade the text by the given percentage when focus is lost; option B<-fade>.
696		670
697	=item B<fadeColor:> I<colour>	671	=item B<fadeColor:> I<colour>
698		672
699	Fade to this colour, when fading is used (see B<fading:>). The default	673	Fade to this colour, when fading is used (see B<fading:>). The default
700	colour is black; option B<-fadecolor>.	674	colour is black; option B<-fadecolor>.
701		675
702	=item B<tintColor:> I<colour>	676	=item B<iconFile:> I<file>
703		677
704	Tint the transparent background pixmap with the given colour; option	678	Set the application icon pixmap; option B<-icon>.
705	B<-tint>.
706
707	=item B<shading:> I<number>
708
709	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
710	in addition to tinting it; option B<-sh>.
711
712	=item B<blendType:> I<string>
713
714	Specify background blending type; option B<-blt>.
715
716	=item B<blurRadius:> I<number>
717
718	Apply Gaussian Blurr with the specified radius to the transparent
719	background image; option B<-blr>.
720		679
721	=item B<scrollColor:> I<colour>	680	=item B<scrollColor:> I<colour>
722		681
723	Use the specified colour for the scrollbar [default #B2B2B2].	682	Use the specified colour for the scrollbar [default #B2B2B2].
724		683
…		…
729		688
730	=item B<borderColor:> I<colour>	689	=item B<borderColor:> I<colour>
731		690
732	The colour of the border around the text area and between the scrollbar	691	The colour of the border around the text area and between the scrollbar
733	and the text.	692	and the text.
734
735	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
736
737	Use the specified image file for the background and also
738	optionally specify its scaling with a geometry string B<WxH+X+Y>,
739	(default C<0x0+50+50>) in which B<"W" / "H"> specify the
740	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
741	centre (percent). A scale of 0 displays the image with tiling. A scale
742	of 1 displays the image without any scaling. A scale of 2 to 9 specifies
743	an integer number of images in that direction. No image will be magnified
744	beyond 10 times its original size. The maximum permitted scale is 1000.
745	Additional operations can be specified after colon B<:op1:op2...>.
746	Supported operations are:
747
748	tile force background image to be tiled and not scaled. Equivalent to 0x0
749	propscale will scale image keeping proportions
750	auto will scale image to match window size. Equivalent to 100x100
751	hscale will scale image horizontally to the window size
752	vscale will scale image vertically to the window size
753	scale will scale image to match window size
754	root will tile image as if it was a root window background, auto-adjusting
755	whenever terminal window moves
756
757	If used in conjunction with B<-tr> option, the specified pixmap will be
758	blended over transparency image using either alpha-blending, or any
759	other blending type, specified with B<-blt "type"> option.
760
761	=item B<path:> I<path>
762
763	Specify the colon-delimited search path for finding background image files.
764		693
765	=item B<font:> I<fontlist>	694	=item B<font:> I<fontlist>
766		695
767	Select the fonts to be used. This is a comma separated list of font names	696	Select the fonts to be used. This is a comma separated list of font names
768	that are checked in order when trying to find glyphs for characters. The	697	that are checked in order when trying to find glyphs for characters. The
…		…
791	it is named first) and thus defines the character cell grid to be 9 pixels	720	it is named first) and thus defines the character cell grid to be 9 pixels
792	wide and 15 pixels high.	721	wide and 15 pixels high.
793		722
794	The second font is just used to add additional unicode characters not in	723	The second font is just used to add additional unicode characters not in
795	the base font, likewise the third, which is unfortunately non-bold, but	724	the base font, likewise the third, which is unfortunately non-bold, but
796	the bold version of the font does contain less characters, so this is a	725	the bold version of the font does contain fewer characters, so this is a
797	useful supplement.	726	useful supplement.
798		727
799	The third font is an Xft font with aliasing turned off, and the characters	728	The third font is an Xft font with aliasing turned off, and the characters
800	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	729	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
801	contains other characters, but we are not interested in them.	730	contains other characters, but we are not interested in them.
…		…
852	=item B<urgentOnBell:> I<boolean>	781	=item B<urgentOnBell:> I<boolean>
853		782
854	B<True>: set the urgency hint for the wm on receipt of a bell character.	783	B<True>: set the urgency hint for the wm on receipt of a bell character.
855	B<False>: do not set the urgency hint [default].	784	B<False>: do not set the urgency hint [default].
856		785
		786	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		787
857	=item B<visualBell:> I<boolean>	788	=item B<visualBell:> I<boolean>
858		789
859	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	790	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
860	B<False>: no visual bell [default]; option B<+vb>.	791	B<False>: no visual bell [default]; option B<+vb>.
861		792
…		…
863		794
864	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of	795	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
865	the shell; option B<-ls>. B<False>: start as a normal sub-shell	796	the shell; option B<-ls>. B<False>: start as a normal sub-shell
866	[default]; option B<+ls>.	797	[default]; option B<+ls>.
867		798
		799	=item B<multiClickTime:> I<number>
		800
		801	Specify the maximum time in milliseconds between multi-click select
		802	events. The default is 500 milliseconds; option B<-mc>.
		803
868	=item B<utmpInhibit:> I<boolean>	804	=item B<utmpInhibit:> I<boolean>
869		805
870	B<True>: inhibit writing record into the system log file B<utmp>;	806	B<True>: inhibit writing record into the system log file B<utmp>;
871	option B<-ut>. B<False>: write record into the system log file B<utmp>	807	option B<-ut>. B<False>: write record into the system log file B<utmp>
872	[default]; option B<+ut>.	808	[default]; option B<+ut>.
…		…
889	=item B<scrollstyle:> I<mode>	825	=item B<scrollstyle:> I<mode>
890		826
891	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	827	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
892	the author's favourite.	828	the author's favourite.
893		829
		830	=item B<thickness:> I<number>
		831
		832	Set the scrollbar width in pixels.
		833
894	=item B<scrollBar:> I<boolean>	834	=item B<scrollBar:> I<boolean>
895		835
896	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	836	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
897	disable the scrollbar; option B<+sb>.	837	disable the scrollbar; option B<+sb>.
898		838
…		…
917	B<False>: do not scroll to bottom when tty receives output; option	857	B<False>: do not scroll to bottom when tty receives output; option
918	B<+si>.	858	B<+si>.
919		859
920	=item B<scrollWithBuffer:> I<boolean>	860	=item B<scrollWithBuffer:> I<boolean>
921		861
922	B<True>: scroll with scrollback buffer when tty receives new lines (and	862	B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
923	B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll	863	try to show the same lines) and B<scrollTtyOutput> is False; option
924	with scrollback buffer when tty receives new lines; option B<+sw>.	864	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		865	new lines; option B<+sw>.
925		866
926	=item B<scrollTtyKeypress:> I<boolean>	867	=item B<scrollTtyKeypress:> I<boolean>
927		868
928	B<True>: scroll to bottom when a non-special key is pressed. Special keys	869	B<True>: scroll to bottom when a non-special key is pressed. Special keys
929	are those which are intercepted by rxvt-unicode for special handling and	870	are those which are intercepted by rxvt-unicode for special handling and
930	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to	871	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
931	bottom when a non-special key is pressed; option B<+sk>.	872	bottom when a non-special key is pressed; option B<+sk>.
932		873
933	=item B<saveLines:> I<number>	874	=item B<saveLines:> I<number>
934		875
935	Save I<number> lines in the scrollback buffer [default 64]. This	876	Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
936	resource is limited on most machines to 65535; option B<-sl>.
937		877
938	=item B<internalBorder:> I<number>	878	=item B<internalBorder:> I<number>
939		879
940	Internal border of I<number> pixels. This resource is limited to 100;	880	Internal border of I<number> pixels. This resource is limited to 100;
941	option B<-b>.	881	option B<-b>.
…		…
985	=item B<cursorBlink:> I<boolean>	925	=item B<cursorBlink:> I<boolean>
986		926
987	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	927	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
988	option B<-bc>.	928	option B<-bc>.
989		929
		930	=item B<cursorUnderline:> I<boolean>
		931
		932	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		933	option B<-uc>.
		934
990	=item B<pointerBlank:> I<boolean>	935	=item B<pointerBlank:> I<boolean>
991		936
992	B<True>: blank the pointer when a key is pressed or after a set number	937	B<True>: blank the pointer when a key is pressed or after a set number
993	of seconds of inactivity. B<False>: the pointer is always visible	938	of seconds of inactivity. B<False>: the pointer is always visible
994	[default].	939	[default].
…		…
999		944
1000	=item B<pointerColor2:> I<colour>	945	=item B<pointerColor2:> I<colour>
1001		946
1002	Mouse pointer background colour.	947	Mouse pointer background colour.
1003		948
		949	=item B<pointerShape:> I<string>
		950
		951	Compile I<frills>: Specifies the name of the mouse pointer shape
		952	[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
		953	file for possible values (omit the C<XC_> prefix).
		954
1004	=item B<pointerBlankDelay:> I<number>	955	=item B<pointerBlankDelay:> I<number>
1005		956
1006	Specifies number of seconds before blanking the pointer [default 2]. Use a	957	Specifies number of seconds before blanking the pointer [default 2]. Use a
1007	large number (e.g. C<987654321>) to effectively disable the timeout.	958	large number (e.g. C<987654321>) to effectively disable the timeout.
1008		959
1009	=item B<backspacekey:> I<string>	960	=item B<backspacekey:> I<string>
1010		961
1011	The string to send when the backspace key is pressed. If set to B<DEC>	962	The string to send when the backspace key is pressed. If set to B<DEC>
1012	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	963	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
1013	(code 8) - which can be reversed with the appropriate DEC private mode	964	(code 8) - which can be reversed with the appropriate DEC private mode
1014	escape sequence.	965	escape sequence.
1015		966
1016	=item B<deletekey:> I<string>	967	=item B<deletekey:> I<string>
1017		968
…		…
1034		985
1035	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>	986	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
1036		987
1037	=item B<preeditType:> I<style>	988	=item B<preeditType:> I<style>
1038		989
1039	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	990	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1040		991
1041	=item B<inputMethod:> I<name>	992	=item B<inputMethod:> I<name>
1042		993
1043	I<name> of inputMethod to use; option B<-im>.	994	I<name> of inputMethod to use; option B<-im>.
1044		995
…		…
1113	Sets the working directory for the shell (or the command specified via	1064	Sets the working directory for the shell (or the command specified via
1114	B<-e>). The I<path> must be an absolute path and it must exist for	1065	B<-e>). The I<path> must be an absolute path and it must exist for
1115	@@RXVT_NAME@@ to start. If it isn't specified then the current working	1066	@@RXVT_NAME@@ to start. If it isn't specified then the current working
1116	directory will be used; option B<-cd>.	1067	directory will be used; option B<-cd>.
1117		1068
1118	=item B<keysym.>I<sym>: I<string>	1069	=item B<keysym.>I<sym>: I<action>
1119		1070
1120	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1071	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1121	intervening resource name B<keysym.> cannot be omitted.	1072	resource name B<keysym.> cannot be omitted.
1122		1073
1123	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1074	Using this resource, you can map key combinations such as
1124	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1075	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1125	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,	1076	string than would normally result from that combination, making the
1126	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,	1077	terminal scroll up or down the way you want it, or any other thing an
1127	B<2>, B<3>, B<4>, B<5>.	1078	extension might provide.
		1079
		1080	The key combination that triggers the action, I<sym>, has the following format:
		1081
		1082	(modifiers-)key
		1083
		1084	Where I<modifiers> can be any combination of the following full or
		1085	abbreviated modifier names:
		1086
		1087	=begin table
		1088
		1089	B<ISOLevel3> B<I>
		1090	B<AppKeypad> B<K>
		1091	B<Control> B<C>
		1092	B<NumLock> B<N>
		1093	B<Shift> B<S>
		1094	B<Meta> B<M>, B<A>
		1095	B<Lock> B<L>
		1096	B<Mod1> B<1>
		1097	B<Mod2> B<2>
		1098	B<Mod3> B<3>
		1099	B<Mod4> B<4>
		1100	B<Mod5> B<5>
		1101
		1102	=end table
1128		1103
1129	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1104	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1130	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1105	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1131	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1106	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1132	current application keymap mode state.	1107	current application keymap mode state.
1133		1108
1134	The spellings of I<key> can be obtained by using B<xev>(1) command or	1109	Due the the large number of modifier combinations, a key mapping will
1135	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1110	match if I<at least> the specified identifiers are being set, and no other
		1111	key mappings with those and more bits are being defined. That means that
		1112	defining a mapping for C<a> will automatically provide definitions for
		1113	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1114	themselves. See the C<builtin:> action, below, for a way to work around
		1115	this when this is a problem.
		1116
		1117	The spelling of I<key> depends on your implementation of X. An easy way to
		1118	find a key name is to use the B<xev>(1) command. You can find a list by
		1119	looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1136	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1120	the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1137	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1121	value (B<0x0000 - 0xFFFF>).
1138	performed in an exact manner; however, the closest match is assured.
1139		1122
1140	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1123	As with any resource value, the I<action> string may contain backslash
		1124	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1141	number), see RESOURCES in C<man 7 X> for futher details.	1125	number), see RESOURCES in C<man 7 X> for further details.
1142		1126
1143	You can define a range of keysyms in one shot by providing a I<string>	1127	An action starts with an action prefix that selects a certain type
1144	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1128	of action, followed by a colon. An action string without colons is
		1129	interpreted as a literal string to pass to the tty (as if it was
		1130	prefixed with C<string:>).
		1131
		1132	The following action prefixes are known - extensions can provide
		1133	additional prefixes:
		1134
		1135	=over 4
		1136
		1137	=item string:STRING
		1138
		1139	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1140	then the remaining C<STRING> will be passed to the program running in the
		1141	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1142	string C<echo rm -rf /> followed by a newline:
		1143
		1144	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
		1145
		1146	This could in theory be used to completely redefine your keymap.
		1147
		1148	In addition, for actions of this type, you can define a range of
		1149	keysyms in one shot by loading the C<keysym-list> perl extension and
		1150	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1145	should be a character not used by the strings.	1151	the delimiter `/' should be a character not used by the strings.
1146		1152
1147	Its usage can be demonstrated by an example:	1153	Its usage can be demonstrated by an example:
1148		1154
1149	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1155	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1150		1156
1151	The above line is equivalent to the following three lines:	1157	The above line is equivalent to the following three lines:
1152		1158
1153	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1159	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1154	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1160	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1155	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1161	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1156		1162
		1163	=item command:STRING
		1164
1157	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1165	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1158	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1166	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1167	the opposite of C<string:> - instead of sending it to the program running
		1168	in the terminal, it will be treated as if it were program output). This is
		1169	most useful to feed command sequences into @@RXVT_NAME@@.
		1170
1159	example the following means "change the current locale to C<zh_CN.GBK>	1171	For example the following means "change the current locale to C<zh_CN.GBK>
1160	when Control-Meta-c is being pressed":	1172	when Control-Meta-c is being pressed":
1161		1173
1162	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1174	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1163		1175
1164	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1176	The following example will map Control-Meta-1 and Control-Meta-2 to
1165	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1177	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1166	manpage. For example, the F<selection> extension (activated via	1178	font-switching at runtime:
1167	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1168		1179
1169	URxvt.keysym.M-C-c: perl:selection:rot13	1180	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1181	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1170		1182
1171	Due the the large number of modifier combinations, a defined key mapping	1183	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1172	will match if at I<at least> the specified identifiers are being set, and	1184	info):
1173	no other key mappings with those and more bits are being defined. That
1174	means that defining a key map for C<a> will automatically provide
1175	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1176	mappings themselves.
1177		1185
1178	Unfortunately, this will override built-in key mappings. For example	1186	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1187	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1188
		1189	=item builtin:
		1190
		1191	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1192	key binding existed for the key combination. The obvious use is to undo
		1193	the effect of existing bindings. The not so obvious use is to reinstate
		1194	bindings when another binding overrides too many modifiers.
		1195
1179	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1196	For example if you overwrite the C<Insert> key you will disable
1180	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the	1197	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1181	user-defined keymap using the C<builtin:> replacement:	1198	"holes" into the user-defined keymap using the C<builtin:> replacement:
1182		1199
1183	URxvt.keysym.Insert: <my insert key sequence>	1200	URxvt.keysym.Insert: <my insert key sequence>
1184	URxvt.keysym.S-Insert: builtin:	1201	URxvt.keysym.S-Insert: builtin:
1185		1202
1186	The first line defines a mapping for C<Insert> and I<any> combination	1203	The first line defines a mapping for C<Insert> and I<any> combination
1187	of modifiers. The second line re-establishes the default mapping for	1204	of modifiers. The second line re-establishes the default mapping for
1188	C<Shift-Insert>.	1205	C<Shift-Insert>.
1189		1206
1190	The following example will map Control-Meta-1 and Control-Meta-2 to	1207	=item builtin-string:
1191	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1192	font-switching at runtime:
1193		1208
1194	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1209	This action is mainly useful to restore string mappings for keys that
1195	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1210	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1211	difficult to explain - basically, this action will send the string to the
		1212	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1213	action for it.
1196		1214
1197	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1215	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1198	info):	1216	selection when you press C<Shift-Insert>. With the following bindings, it
		1217	would instead emit the (undocumented, but what applications running in the
		1218	terminal might expect) sequence C<ESC [ 2 $> instead:
1199		1219
1200	URxvt.keysym.M-C-3: command:\033[8;25;80t	1220	URxvt.keysym.S-Insert: builtin-string:
1201	URxvt.keysym.M-C-4: command:\033[8;48;110t	1221	URxvt.keysym.C-S-Insert: builtin:
		1222
		1223	The first line disables the paste functionality for that key
		1224	combination, and the second reinstates the default behaviour for
		1225	C<Control-Shift-Insert>, which would otherwise be overridden.
		1226
		1227	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1228	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1229	this:
		1230
		1231	URxvt.keysym.C-M-c: builtin-string:
		1232	URxvt.keysym.C-M-v: builtin-string:
		1233
		1234	=item EXTENSION:STRING
		1235
		1236	An action of this form invokes the action B<STRING>, if any, provided
		1237	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1238	be loaded automatically if necessary.
		1239
		1240	Not all extensions define actions, but popular extensions that do
		1241	include the I<selection> and I<matcher> extensions (documented in their
		1242	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1243	respectively).
		1244
		1245	From the silly examples department, this will rot13-"encrypt"
		1246	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1247	keyboards:
		1248
		1249	URxvt.keysym.M-C-c: selection:rot13
		1250
		1251	=item perl:STRING DEPRECATED
		1252
		1253	This is a deprecated way of invoking commands provided by perl
		1254	extensions. It is still supported, but should not be used anymore.
		1255
		1256	=back
1202		1257
1203	=item B<perl-ext-common>: I<string>	1258	=item B<perl-ext-common>: I<string>
1204		1259
1205	=item B<perl-ext>: I<string>	1260	=item B<perl-ext>: I<string>
1206		1261
…		…
1208	use in this terminal instance; option B<-pe>.	1263	use in this terminal instance; option B<-pe>.
1209		1264
1210	Extension names can be prefixed with a C<-> sign to prohibit using	1265	Extension names can be prefixed with a C<-> sign to prohibit using
1211	them. This can be useful to selectively disable some extensions loaded	1266	them. This can be useful to selectively disable some extensions loaded
1212	by default, or specified via the C<perl-ext-common> resource. For	1267	by default, or specified via the C<perl-ext-common> resource. For
1213	example, C<default,-selection> will use all the default extension except	1268	example, C<default,-selection> will use all the default extensions except
1214	C<selection>.	1269	C<selection>.
1215		1270
1216	Extension names can also be followed by an argument in angle brackets	1271	The default set includes the C<selection>, C<option-popup>,
1217	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1272	C<selection-popup>, C<readline> and C<searchable-scrollback>
1218	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1273	extensions, and extensions which are mentioned in B<keysym> resources.
1219	multiple times with different arguments will pass multiple arguments to	1274
1220	the extension.	1275	Any extension such that a corresponding resource is given on the
		1276	command line is automatically appended to B<perl-ext>.
1221		1277
1222	Each extension is looked up in the library directories, loaded if	1278	Each extension is looked up in the library directories, loaded if
1223	necessary, and bound to the current terminal instance.	1279	necessary, and bound to the current terminal instance. When the library
		1280	search path contains multiple extension files of the same name, then the
		1281	first one found will be used.
1224		1282
1225	If both of these resources are the empty string, then the perl	1283	If both of these resources are the empty string, then the perl interpreter
1226	interpreter will not be initialized. The idea behind two options is that	1284	will not be initialized. The rationale for having two options is that
1227	B<perl-ext-common> will be used for extensions that should be available to	1285	B<perl-ext-common> will be used for extensions that should be available to
1228	all instances, while B<perl-ext> is used for specific instances.	1286	all instances, while B<perl-ext> is used for specific instances.
1229		1287
1230	=item B<perl-eval>: I<string>	1288	=item B<perl-eval>: I<string>
1231		1289
1232	Perl code to be evaluated when all extensions have been registered. See	1290	Perl code to be evaluated when all extensions have been registered. See
1233	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1291	the @@RXVT_NAME@@perl(3) manpage.
1234	will be ignored when running setuid/setgid.
1235		1292
1236	=item B<perl-lib>: I<path>	1293	=item B<perl-lib>: I<path>
1237		1294
1238	Colon-separated list of additional directories that hold extension	1295	Colon-separated list of additional directories that hold extension
1239	scripts. When looking for extensions specified by the C<perl> resource,	1296	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1240	@@RXVT_NAME@@ will first look in these directories and then in	1297	in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1241	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1298	lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1242	will be ignored when running setuid/setgid.
1243		1299
1244	See the @@RXVT_NAME@@perl(3) manpage.	1300	See the @@RXVT_NAME@@perl(3) manpage.
1245		1301
1246	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1302	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1247		1303
…		…
1251	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1307	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1252		1308
1253	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1309	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1254	for details.	1310	for details.
1255		1311
1256	=item B<searchable-scrollback:> I<keysym>	1312	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1257		1313
1258	Sets the hotkey that starts the incremental scrollback buffer search	1314	This resource is deprecated and will be removed. Use a B<keysym> resource
1259	(default: C<M-s>).	1315	instead, e.g.:
1260		1316
		1317	URxvt.keysym.M-s: searchable-scrollback:start
		1318
1261	=item B<urlLauncher>: I<string>	1319	=item B<url-launcher>: I<string>
1262		1320
1263	Specifies the program to be started with a URL argument. Used by the	1321	Specifies the program to be started with a URL argument. Used by the
1264	C<selection-popup> and C<matcher> perl extensions.	1322	C<selection-popup> and C<matcher> perl extensions.
1265		1323
1266	=item B<transient-for>: I<windowid>	1324	=item B<transient-for>: I<windowid>
…		…
1269		1327
1270	=item B<override-redirect>: I<boolean>	1328	=item B<override-redirect>: I<boolean>
1271		1329
1272	Compile I<frills>: Sets override-redirect for the terminal window, making	1330	Compile I<frills>: Sets override-redirect for the terminal window, making
1273	it almost invisible to window managers; option B<-override-redirect>.	1331	it almost invisible to window managers; option B<-override-redirect>.
		1332
		1333	=item B<iso14755:> I<boolean>
		1334
		1335	Turn on/off ISO 14755 (default enabled).
1274		1336
1275	=item B<iso14755_52:> I<boolean>	1337	=item B<iso14755_52:> I<boolean>
1276		1338
1277	Turn on/off ISO 14755 5.2 mode (default enabled).	1339	Turn on/off ISO 14755 5.2 mode (default enabled).
1278		1340
…		…
1330	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1392	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1331	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.	1393	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1332		1394
1333	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1395	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1334	inserted too.	1396	inserted too.
		1397
		1398	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1399	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1400	binding causes the value of the internal selection to be copied to the
		1401	CLIPBOARD selection, while the second binding causes the value of the
		1402	CLIPBOARD selection to be inserted.
1335		1403
1336	=back	1404	=back
1337		1405
1338	=head1 CHANGING FONTS	1406	=head1 CHANGING FONTS
1339		1407
…		…
1421	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1489	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1422	it can be seen via the I<who(1)> command, and can accept messages. To	1490	it can be seen via the I<who(1)> command, and can accept messages. To
1423	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1491	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1424	on some systems or setgid to root or to some other group on others.	1492	on some systems or setgid to root or to some other group on others.
1425		1493
1426	=head1 COLORS AND GRAPHICS	1494	=head1 COLOURS AND GRAPHICS
1427		1495
1428	In addition to the default foreground and background colours,	1496	In addition to the default foreground and background colours,
1429	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1497	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1430	high-intensity bold/blink versions of the same). Here is a list of the	1498	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1431	colours with their names.	1499	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1500	cube plus a 8 (24) colour greyscale ramp.
		1501
		1502	B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
		1503	C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
		1504	number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
		1505	colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
		1506	24-bit colour space. When indexing collisions happen, the nearest old colour in
		1507	the cube will be adapted to the new 24-bit RGB colour. That means one cannot
		1508	use many similar 24-bit colours. It's typically not a problem in common
		1509	scenarios.
		1510
		1511	Here is a list of the ANSI colours with their names.
1432		1512
1433	=begin table	1513	=begin table
1434		1514
1435	B<color0> (black) = Black	1515	B<color0> (black) = Black
1436	B<color1> (red) = Red3	1516	B<color1> (red) = Red3
…		…
1456	It is also possible to specify the colour values of B<foreground>,	1536	It is also possible to specify the colour values of B<foreground>,
1457	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1537	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1458	a number 0-15, as a convenient shorthand to reference the colour name of	1538	a number 0-15, as a convenient shorthand to reference the colour name of
1459	color0-color15.	1539	color0-color15.
1460		1540
1461	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1541	The following text gives values for the standard 88 colour mode (and
1462	additional 72 colours. The first 64 of those (with indices 16 to 79)	1542	values for the 256 colour mode in parentheses).
1463	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1464	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1465		1543
		1544	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1545
		1546	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1547	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
		1548
		1549	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1550	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1551	the RGB cube.
		1552
1466	Together, all those colours implement the 88 colour xterm colours. Only	1553	Together, all those colours implement the 88 (256) colour xterm
1467	the first 16 can be changed using resources currently, the rest can only	1554	colours. Only the first 16 can be changed using resources currently, the
1468	be changed via command sequences ("escape codes").	1555	rest can only be changed via command sequences ("escape codes").
		1556
		1557	Applications are advised to use terminfo or command sequences to discover
		1558	number and RGB values of all colours (yes, you can query this...).
1469		1559
1470	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1560	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1471	always swapping the foreground/background colours. This is in contrast to	1561	always swapping the foreground/background colours. This is in contrast to
1472	I<xterm>(1) where the colours are only swapped if they have not otherwise	1562	I<xterm>(1) where the colours are only swapped if they have not otherwise
1473	been specified. For example,	1563	been specified. For example,
1474		1564
1475	=over 4
1476
1477	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1565	@@RXVT_NAME@@ -fg Black -bg White -rv
1478		1566
1479	would yield White on Black, while on I<xterm>(1) it would yield Black	1567	would yield White on Black, while on I<xterm>(1) it would yield Black on
1480	on White.	1568	White.
1481
1482	=back
1483		1569
1484	=head2 ALPHA CHANNEL SUPPORT	1570	=head2 ALPHA CHANNEL SUPPORT
1485		1571
1486	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1572	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1487	their act together, rxvt-unicode will do it's own alpha channel management:	1573	their act together, rxvt-unicode will do its own alpha channel management:
1488		1574
1489	You can prefix any color with an opaquenes percentage enclosed in	1575	You can prefix any colour with an opaqueness percentage enclosed in
1490	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage	1576	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1491	(0-100) that specifies the opacity of the color, where C<0> is completely	1577	(0-100) that specifies the opacity of the colour, where C<0> is completely
1492	transparent and C<100> is completely opaque. For example, C<[50]red> is a	1578	transparent and C<100> is completely opaque. For example, C<[50]red> is a
1493	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This	1579	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1494	is the recommended format to specify transparency values, and works with	1580	is the recommended format to specify transparency values, and works with
1495	all ways to specify a colour.	1581	all ways to specify a colour.
1496		1582
…		…
1574		1660
1575	=item B<SHELL>	1661	=item B<SHELL>
1576		1662
1577	The shell to be used for command execution, defaults to C</bin/sh>.	1663	The shell to be used for command execution, defaults to C</bin/sh>.
1578		1664
1579	=item B<RXVT_SOCKET>	1665	=item B<RXVT_SOCKET> [I<sic>]
1580		1666
1581	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1667	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1582	@@RXVT_NAME@@d(1).	1668	@@RXVT_NAME@@d(1).
1583		1669
1584	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1670	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
		1671
		1672	=item B<URXVT_PERL_LIB>
		1673
		1674	Additional F<:>-separated library search path for perl extensions. Will be
		1675	searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
		1676	directory.
		1677
		1678	=item B<URXVT_PERL_VERBOSITY>
		1679
		1680	See L<@@RXVT_NAME@@perl>(3).
1585		1681
1586	=item B<HOME>	1682	=item B<HOME>
1587		1683
1588	Used to locate the default directory for the unix domain socket for	1684	Used to locate the default directory for the unix domain socket for
1589	daemon communications and to locate various resource files (such as	1685	daemon communications and to locate various resource files (such as
1590	C<.Xdefaults>)	1686	C<.Xdefaults>)
1591		1687
1592	=item B<XAPPLRESDIR>	1688	=item B<XAPPLRESDIR>
1593		1689
1594	Directory where various X resource files are being located.	1690	Directory where application-specific X resource files are located.
1595		1691
1596	=item B<XENVIRONMENT>	1692	=item B<XENVIRONMENT>
1597		1693
1598	If set and accessible, gives the name of a X resource file to be loaded by	1694	If set and accessible, gives the name of a X resource file to be loaded by
1599	@@RXVT_NAME@@.	1695	@@RXVT_NAME@@.
…		…
1604		1700
1605	=over 4	1701	=over 4
1606		1702
1607	=item B</usr/lib/X11/rgb.txt>	1703	=item B</usr/lib/X11/rgb.txt>
1608		1704
1609	Color names.	1705	Colour names.
1610		1706
1611	=back	1707	=back
1612		1708
1613	=head1 SEE ALSO	1709	=head1 SEE ALSO
1614		1710
		1711	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1615	@@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)	1712	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1616		1713
1617	=head1 CURRENT PROJECT COORDINATOR	1714	=head1 CURRENT PROJECT COORDINATOR
1618		1715
1619	=over 4	1716	=over 4
1620		1717
1621	=item Project Coordinator	1718	=item Project Coordinator
1622		1719
1623	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1720	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1624		1721
1625	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1722	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1626		1723
1627	=back	1724	=back
1628		1725
…		…
1632		1729
1633	=item John Bovey	1730	=item John Bovey
1634		1731
1635	University of Kent, 1992, wrote the original Xvt.	1732	University of Kent, 1992, wrote the original Xvt.
1636		1733
1637	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1734	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1638		1735
1639	very heavily modified Xvt and came up with Rxvt	1736	very heavily modified Xvt and came up with Rxvt
1640		1737
1641	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1738	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1642		1739
1643	wrote the Greek Keyboard Input (no longer in code)	1740	wrote the Greek Keyboard Input (no longer in code)
1644		1741
1645	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1742	=item mj olesen <olesen@me.QueensU.CA>
1646		1743
1647	Wrote the menu system.	1744	Wrote the menu system.
1648		1745
1649	Project Coordinator (changes.txt 2.11 to 2.21)	1746	Project Coordinator (changes.txt 2.11 to 2.21)
1650		1747
1651	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1748	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1652		1749
1653	Project Coordinator (changes.txt 2.21a to 2.4.5)	1750	Project Coordinator (changes.txt 2.21a to 2.4.5)
1654		1751
1655	=item Geoff Wing L<< <gcw@pobox.com> >>	1752	=item Geoff Wing <gcw@pobox.com>
1656		1753
1657	Rewrote screen display and text selection routines.	1754	Rewrote screen display and text selection routines.
1658		1755
1659	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1756	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1660		1757
1661	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1758	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1662		1759
1663	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1760	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1664	extension, random hacks, numerous bugfixes and extensions.	1761	extension, random hacks, numerous bugfixes and extensions.
1665		1762
1666	Project Coordinator (Changes 1.0 -)	1763	Project Coordinator (Changes 1.0 -)
1667		1764
1668	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1765	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1669		1766
1670	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1767	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1671		1768
1672	=back	1769	=back
1673		1770

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.165 by root, Thu Oct 2 17:06:50 2008 UTC vs. Revision 1.249 by root, Sat Oct 10 20:03:39 2020 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.165 by root, Thu Oct 2 17:06:50 2008 UTC vs.
Revision 1.249 by root, Sat Oct 10 20:03:39 2020 UTC