[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.215 by sf-exg, Sun May 20 16:34:42 2012 UTC

…		…
124		124
125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.	125	Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
126		126
127	=item B<-tr>\|B<+tr>	127	=item B<-tr>\|B<+tr>
128		128
129	Turn on/off illusion of a transparent window background; resource B<transparent>.	129	Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
130		130
131	B<-ip> is still accepted as an obsolete alias but will be removed in	131	B<-ip> is still accepted as an obsolete alias but will be removed in
132	future versions.	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		133
137	=item B<-fade> I<number>	134	=item B<-fade> I<number>
138		135
139	Fade the text by the given percentage when focus is lost. Small values	136	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	137	fade a little only, 100 completely replaces all colours by the fade
…		…
145	Fade to this colour when fading is used (see B<-fade>). The default colour	142	Fade to this colour when fading is used (see B<-fade>). The default colour
146	is opaque black. resource B<fadeColor>.	143	is opaque black. resource B<fadeColor>.
147		144
148	=item B<-tint> I<colour>	145	=item B<-tint> I<colour>
149		146
150	Tint the transparent background pixmap with the given colour when	147	Tint the transparent background with the given colour;
151	transparency is enabled with B<-tr>. This only works for	148	resource I<tintColor>.
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		149
162	=item B<-sh> I<number>	150	=item B<-sh> I<number>
163		151
164	Darken (0 .. 100) or lighten (100 .. 200) the transparent	152	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
165	background image in addition to (or instead of) tinting it;	153	A value of 100 means no shading; resource I<shading>.
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		154
178	=item B<-blr> I<HxV>	155	=item B<-blr> I<HxV>
179		156
180	Apply Gaussian Blur with the specified radii to the transparent	157	Apply Gaussian Blur with the specified radii to the transparent
181	background image. If single number is specified - both vertical and	158	background. If a single number is specified, the vertical and
182	horizontal radii are considered to be the same. Setting one of the	159	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	160	radii to 1 and the other to a large number creates interesting effects
184	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;	161	on some backgrounds. The maximum radius value is 128. An horizontal or
		162	vertical radius of 0 disables blurring;
185	resource I<blurRadius>.	163	resource I<blurRadius>.
186		164
187	=item B<-icon> I<file>	165	=item B<-icon> I<file>
188		166
189	Compile I<afterimage>: Use the specified image as application icon. This	167	Compile I<pixbuf>: Use the specified image as application icon. This
190	is used by many window managers, taskbars and pagers to represent the	168	is used by many window managers, taskbars and pagers to represent the
191	appliation window; resource I<iconFile>.	169	application window; resource I<iconFile>.
192		170
193	=item B<-bg> I<colour>	171	=item B<-bg> I<colour>
194		172
195	Window background colour; resource B<background>.	173	Window background colour; resource B<background>.
196		174
197	=item B<-fg> I<colour>	175	=item B<-fg> I<colour>
198		176
199	Window foreground colour; resource B<foreground>.	177	Window foreground colour; resource B<foreground>.
200		178
201	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>	179	=item B<-pixmap> I<file[;oplist]>
202		180
203	Compile I<afterimage>: Specify image file for the background and also	181	Compile I<pixbuf>: Specify image file for the background and also
204	optionally specify its scaling with a geometry string. Note you may need to	182	optionally specify a list of operations to modify it. Note you may need to
205	add quotes to avoid special shell interpretation of the C<;> in the	183	add quotes to avoid special shell interpretation of the C<;> in the
206	command-line; for more details see resource B<backgroundPixmap>.	184	command-line; for more details see resource B<backgroundPixmap>.
207		185
208	=item B<-cr> I<colour>	186	=item B<-cr> I<colour>
209		187
…		…
321		299
322	=item B<-bc>\|B<+bc>	300	=item B<-bc>\|B<+bc>
323		301
324	Blink the cursor; resource B<cursorBlink>.	302	Blink the cursor; resource B<cursorBlink>.
325		303
		304	=item B<-uc>\|B<+uc>
		305
		306	Make the cursor underlined; resource B<cursorUnderline>.
		307
326	=item B<-iconic>	308	=item B<-iconic>
327		309
328	Start iconified, if the window manager supports that option.	310	Start iconified, if the window manager supports that option.
329	Alternative form is B<-ic>.	311	Alternative form is B<-ic>.
330		312
…		…
366	=item B<-lsp> I<number>	348	=item B<-lsp> I<number>
367		349
368	Compile I<frills>: Lines (pixel height) to insert between each row of	350	Compile I<frills>: Lines (pixel height) to insert between each row of
369	the display. Useful to work around font rendering problems; resource	351	the display. Useful to work around font rendering problems; resource
370	B<lineSpace>.	352	B<lineSpace>.
		353
		354	=item B<-letsp> I<number>
		355
		356	Compile I<frills>: Amount to adjust the computed character width by
		357	to control overall letter spacing. Negative values will tighten up the
		358	letter spacing, positive values will space letters out more. Useful to
		359	work around odd font metrics; resource B<letterSpace>.
371		360
372	=item B<-tn> I<termname>	361	=item B<-tn> I<termname>
373		362
374	This option specifies the name of the terminal type to be set in the	363	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	364	B<TERM> environment variable. This terminal type must exist in the
…		…
560	You can set and change the resources using X11 tools like B<xrdb>. Many	549	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	550	distribution do also load settings from the B<~/.Xresources> file when X
562	starts. @@RXVT_NAME@@ will consult the following files/resources in order,	551	starts. @@RXVT_NAME@@ will consult the following files/resources in order,
563	with later settings overwriting earlier ones:	552	with later settings overwriting earlier ones:
564		553
565	1. system-wide app-defaults file, either locale-dependent OR global
566	2. app-defaults file in $XAPPLRESDIR	554	1. app-defaults file in $XAPPLRESDIR
		555	2. $HOME/.Xdefaults
567	3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults	556	3. RESOURCE_MANAGER property on root-window of screen 0
568	4. SCREEN_RESOURCES for the current screen	557	4. SCREEN_RESOURCES property on root-window of the current screen
569	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>	558	5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
570	6. resources specified via -xrm on the commandline	559	6. resources specified via -xrm on the commandline
571		560
572	Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class	561	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	562	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	603	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	604	corresponds to low-intensity (normal) colours and 8-15 corresponds to
616	high-intensity (bold = bright foreground, blink = bright background)	605	high-intensity (bold = bright foreground, blink = bright background)
617	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	606	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	607	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.	608	names used are listed in the B<COLOURS AND GRAPHICS> section.
620		609
621	Colours higher than 15 cannot be set using resources (yet), but can be	610	Colours higher than 15 cannot be set using resources (yet), but can be
622	changed using an escape command (see @@RXVT_NAME@@(7)).	611	changed using an escape command (see @@RXVT_NAME@@(7)).
623		612
624	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	613	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
635	=item B<colorUL:> I<colour>	624	=item B<colorUL:> I<colour>
636		625
637	Use the specified colour to display underlined characters when the	626	Use the specified colour to display underlined characters when the
638	foreground colour is the default.	627	foreground colour is the default.
639		628
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>	629	=item B<underlineColor:> I<colour>
646		630
647	If set, use the specified colour as the colour for the underline	631	If set, use the specified colour as the colour for the underline
648	itself. If unset, use the foreground colour.	632	itself. If unset, use the foreground colour.
		633
		634	=item B<highlightColor:> I<colour>
		635
		636	If set, use the specified colour as the background for highlighted
		637	characters. If unset, use reverse video.
		638
		639	=item B<highlightTextColor:> I<colour>
		640
		641	If set and highlightColor is set, use the specified colour as the
		642	foreground for highlighted characters.
649		643
650	=item B<cursorColor:> I<colour>	644	=item B<cursorColor:> I<colour>
651		645
652	Use the specified colour for the cursor. The default is to use the	646	Use the specified colour for the cursor. The default is to use the
653	foreground colour; option B<-cr>.	647	foreground colour; option B<-cr>.
…		…
660		654
661	=item B<reverseVideo:> I<boolean>	655	=item B<reverseVideo:> I<boolean>
662		656
663	B<True>: simulate reverse video by foreground and background colours;	657	B<True>: simulate reverse video by foreground and background colours;
664	option B<-rv>. B<False>: regular screen colours [default]; option	658	option B<-rv>. B<False>: regular screen colours [default]; option
665	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	659	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
666		660
667	=item B<jumpScroll:> I<boolean>	661	=item B<jumpScroll:> I<boolean>
668		662
669	B<True>: specify that jump scrolling should be used. When receiving lots	663	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	664	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
686	if the refresh is too fast for the human eye to read anything (or the	680	if the refresh is too fast for the human eye to read anything (or the
687	monitor to display anything); option B<+ss>.	681	monitor to display anything); option B<+ss>.
688		682
689	=item B<transparent:> I<boolean>	683	=item B<transparent:> I<boolean>
690		684
691	Turn on/off illusion of a transparent window background.	685	Turn on/off pseudo-transparency by using the root pixmap as background.
692		686
693	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in	687	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
694	future versions.	688	future versions.
695		689
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>	690	=item B<fading:> I<number>
700		691
701	Fade the text by the given percentage when focus is lost; option B<-fade>.	692	Fade the text by the given percentage when focus is lost; option B<-fade>.
702		693
703	=item B<fadeColor:> I<colour>	694	=item B<fadeColor:> I<colour>
…		…
705	Fade to this colour, when fading is used (see B<fading:>). The default	696	Fade to this colour, when fading is used (see B<fading:>). The default
706	colour is black; option B<-fadecolor>.	697	colour is black; option B<-fadecolor>.
707		698
708	=item B<tintColor:> I<colour>	699	=item B<tintColor:> I<colour>
709		700
710	Tint the transparent background pixmap with the given colour; option	701	Tint the transparent background with the given colour. If the RENDER
711	B<-tint>.	702	extension is not available only black, red, green, yellow, blue,
		703	magenta, cyan and white tints can be performed server-side. Note that
		704	a black tint yields a completely black image while a white tint yields
		705	the image unchanged; option B<-tint>.
712		706
713	=item B<shading:> I<number>	707	=item B<shading:> I<number>
714		708
715	Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image	709	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
716	in addition to tinting it; option B<-sh>.	710	A value of 100 means no shading; option B<-sh>.
717
718	=item B<blendType:> I<string>
719
720	Specify background blending type; option B<-blt>.
721		711
722	=item B<blurRadius:> I<number>	712	=item B<blurRadius:> I<number>
723		713
724	Apply gaussian blur with the specified radius to the transparent	714	Apply gaussian blur with the specified radius to the transparent
725	background image; option B<-blr>.	715	background; option B<-blr>.
726		716
727	=item B<iconFile:> I<file>	717	=item B<iconFile:> I<file>
728		718
729	Set the application icon pixmap; option B<-icon>.	719	Set the application icon pixmap; option B<-icon>.
730		720
…		…
740	=item B<borderColor:> I<colour>	730	=item B<borderColor:> I<colour>
741		731
742	The colour of the border around the text area and between the scrollbar	732	The colour of the border around the text area and between the scrollbar
743	and the text.	733	and the text.
744		734
745	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	735	=item B<backgroundPixmap:> I<file[;oplist]>
746		736
747	Use the specified image file for the background and also	737	Use the specified image file for the background and also
748	optionally specify its scaling with a geometry string B<WxH+X+Y>,	738	optionally specify a colon separated list of operations to modify it.
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:	739	Supported operations are:
757		740
758	tile force background image to be tiled and not scaled. Equivalent to 0x0	741	=over 4
759	propscale will scale image keeping proportions	742
760	auto will scale image to match window size. Equivalent to 100x100	743	=item B<WxH+X+Y>
761	hscale will scale image horizontally to the window size	744
762	vscale will scale image vertically to the window size	745	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
763	scale will scale image to match window size	746	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
764	root will tile image as if it was a root window background, auto-adjusting	747	scale of 0 disables scaling.
765	whenever terminal window moves	748
		749	=item B<op=tile>
		750
		751	enables tiling
		752
		753	=item B<op=keep-aspect>
		754
		755	maintain the image aspect ratio when scaling
		756
		757	=item B<op=root-align>
		758
		759	use the position of the terminal window relative to the root window as
		760	the image offset, simulating a root window background
		761
		762	=back
		763
		764	The default scale and position setting is C<100x100+50+50>.
		765	Alternatively, a predefined set of templates can be used to achieve
		766	the most common setups:
		767
		768	=over 4
		769
		770	=item B<style=tiled>
		771
		772	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		773
		774	=item B<style=aspect-stretched>
		775
		776	the image is scaled to fill the whole window maintaining the aspect
		777	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		778
		779	=item B<style=stretched>
		780
		781	the image is scaled to fill the whole window. Equivalent to 100x100
		782
		783	=item B<style=centered>
		784
		785	the image is centered with no scaling. Equivalent to 0x0+50+50
		786
		787	=item B<style=root-tiled>
		788
		789	the image is tiled with no scaling and using 'root' positioning.
		790	Equivalent to 0x0:op=tile:op=root-align
		791
		792	=back
		793
		794	If multiple templates are specified the last one wins. Note that a
		795	template overrides all the scale, position and operations settings.
766		796
767	If used in conjunction with B<-tr> option, the specified pixmap will be	797	If used in conjunction with B<-tr> option, the specified pixmap will be
768	blended over transparency image using either alpha-blending, or any	798	blended over the transparent background using alpha-blending.
769	other blending type, specified with B<-blt "type"> option.
770		799
771	=item B<path:> I<path>	800	=item B<path:> I<path>
772		801
773	Specify the colon-delimited search path for finding background image files.	802	Specify the colon-delimited search path for finding background image files.
774		803
…		…
801	it is named first) and thus defines the character cell grid to be 9 pixels	830	it is named first) and thus defines the character cell grid to be 9 pixels
802	wide and 15 pixels high.	831	wide and 15 pixels high.
803		832
804	The second font is just used to add additional unicode characters not in	833	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	834	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	835	the bold version of the font does contain fewer characters, so this is a
807	useful supplement.	836	useful supplement.
808		837
809	The third font is an Xft font with aliasing turned off, and the characters	838	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	839	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.	840	contains other characters, but we are not interested in them.
…		…
901	=item B<scrollstyle:> I<mode>	930	=item B<scrollstyle:> I<mode>
902		931
903	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is	932	Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
904	the author's favourite.	933	the author's favourite.
905		934
		935	=item B<thickness:> I<number>
		936
		937	Set the scrollbar width in pixels.
		938
906	=item B<scrollBar:> I<boolean>	939	=item B<scrollBar:> I<boolean>
907		940
908	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:	941	B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
909	disable the scrollbar; option B<+sb>.	942	disable the scrollbar; option B<+sb>.
910		943
…		…
929	B<False>: do not scroll to bottom when tty receives output; option	962	B<False>: do not scroll to bottom when tty receives output; option
930	B<+si>.	963	B<+si>.
931		964
932	=item B<scrollWithBuffer:> I<boolean>	965	=item B<scrollWithBuffer:> I<boolean>
933		966
934	B<True>: scroll with scrollback buffer when tty receives new lines (and	967	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	968	try to show the same lines) and B<scrollTtyOutput> is False; option
936	with scrollback buffer when tty receives new lines; option B<+sw>.	969	B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
		970	new lines; option B<+sw>.
937		971
938	=item B<scrollTtyKeypress:> I<boolean>	972	=item B<scrollTtyKeypress:> I<boolean>
939		973
940	B<True>: scroll to bottom when a non-special key is pressed. Special keys	974	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	975	are those which are intercepted by rxvt-unicode for special handling and
…		…
997	=item B<cursorBlink:> I<boolean>	1031	=item B<cursorBlink:> I<boolean>
998		1032
999	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1033	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
1000	option B<-bc>.	1034	option B<-bc>.
1001		1035
		1036	=item B<cursorUnderline:> I<boolean>
		1037
		1038	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1039	option B<-uc>.
		1040
1002	=item B<pointerBlank:> I<boolean>	1041	=item B<pointerBlank:> I<boolean>
1003		1042
1004	B<True>: blank the pointer when a key is pressed or after a set number	1043	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	1044	of seconds of inactivity. B<False>: the pointer is always visible
1006	[default].	1045	[default].
…		…
1019	large number (e.g. C<987654321>) to effectively disable the timeout.	1058	large number (e.g. C<987654321>) to effectively disable the timeout.
1020		1059
1021	=item B<backspacekey:> I<string>	1060	=item B<backspacekey:> I<string>
1022		1061
1023	The string to send when the backspace key is pressed. If set to B<DEC>	1062	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>	1063	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	1064	(code 8) - which can be reversed with the appropriate DEC private mode
1026	escape sequence.	1065	escape sequence.
1027		1066
1028	=item B<deletekey:> I<string>	1067	=item B<deletekey:> I<string>
1029		1068
…		…
1148	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1187	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1149	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1188	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1150	performed in an exact manner; however, the closest match is assured.	1189	performed in an exact manner; however, the closest match is assured.
1151		1190
1152	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1191	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1153	number), see RESOURCES in C<man 7 X> for futher details.	1192	number), see RESOURCES in C<man 7 X> for further details.
1154		1193
1155	You can define a range of keysyms in one shot by providing a I<string>	1194	You can define a range of keysyms in one shot by
		1195	loading the C<keysym-list> perl extension and providing a I<string>
1156	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1196	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1157	should be a character not used by the strings.	1197	should be a character not used by the strings.
1158		1198
1159	Its usage can be demonstrated by an example:	1199	Its usage can be demonstrated by an example:
1160		1200
1161	URxvt.keysym.M-C-0x61: list\|\033<M-C-\|abc\|>	1201	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1162		1202
1163	The above line is equivalent to the following three lines:	1203	The above line is equivalent to the following three lines:
1164		1204
1165	URxvt.keysym.Meta-Control-0x61: \033<M-C-a>	1205	URxvt.keysym.Meta-Control-0x61: \033<a>
1166	URxvt.keysym.Meta-Control-0x62: \033<M-C-b>	1206	URxvt.keysym.Meta-Control-0x62: \033<b>
1167	URxvt.keysym.Meta-Control-0x63: \033<M-C-c>	1207	URxvt.keysym.Meta-Control-0x63: \033<c>
1168		1208
1169	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1209	If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1170	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1210	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1171	example the following means "change the current locale to C<zh_CN.GBK>	1211	example the following means "change the current locale to C<zh_CN.GBK>
1172	when Control-Meta-c is being pressed":	1212	when Control-Meta-c is being pressed":
1173		1213
1174	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1214	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1175		1215
1176	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1216	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1177	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1217	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1178	manpage. For example, the F<selection> extension (activated via	1218	manpage. For example, the F<selection> extension (activated via
1179	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1219	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1180		1220
1181	URxvt.keysym.M-C-c: perl:selection:rot13	1221	URxvt.keysym.M-C-c: perl:selection:rot13
1182		1222
1183	Due the the large number of modifier combinations, a defined key mapping	1223	Due the the large number of modifier combinations, a defined key mapping
1184	will match if at I<at least> the specified identifiers are being set, and	1224	will match if I<at least> the specified identifiers are being set, and
1185	no other key mappings with those and more bits are being defined. That	1225	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	1226	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	1227	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1188	mappings themselves.	1228	mappings themselves.
1189		1229
…		…
1245	the @@RXVT_NAME@@perl(3) manpage.	1285	the @@RXVT_NAME@@perl(3) manpage.
1246		1286
1247	=item B<perl-lib>: I<path>	1287	=item B<perl-lib>: I<path>
1248		1288
1249	Colon-separated list of additional directories that hold extension	1289	Colon-separated list of additional directories that hold extension
1250	scripts. When looking for extensions specified by the C<perl> resource,	1290	scripts. When looking for perl extensions, @@RXVT_NAME@@ will first
1251	@@RXVT_NAME@@ will first look in these directories and then in	1291	look in these directories, then in $HOME/.urxvt/ext and lastly in
1252	F<@@RXVT_LIBDIR@@/urxvt/perl/>.	1292	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1253		1293
1254	See the @@RXVT_NAME@@perl(3) manpage.	1294	See the @@RXVT_NAME@@perl(3) manpage.
1255		1295
1256	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1296	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
…		…
1279		1319
1280	=item B<override-redirect>: I<boolean>	1320	=item B<override-redirect>: I<boolean>
1281		1321
1282	Compile I<frills>: Sets override-redirect for the terminal window, making	1322	Compile I<frills>: Sets override-redirect for the terminal window, making
1283	it almost invisible to window managers; option B<-override-redirect>.	1323	it almost invisible to window managers; option B<-override-redirect>.
		1324
		1325	=item B<iso14755:> I<boolean>
		1326
		1327	Turn on/off ISO 14755 (default enabled).
1284		1328
1285	=item B<iso14755_52:> I<boolean>	1329	=item B<iso14755_52:> I<boolean>
1286		1330
1287	Turn on/off ISO 14755 5.2 mode (default enabled).	1331	Turn on/off ISO 14755 5.2 mode (default enabled).
1288		1332
…		…
1431	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1475	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	1476	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	1477	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.	1478	on some systems or setgid to root or to some other group on others.
1435		1479
1436	=head1 COLORS AND GRAPHICS	1480	=head1 COLOURS AND GRAPHICS
1437		1481
1438	In addition to the default foreground and background colours,	1482	In addition to the default foreground and background colours,
1439	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1483	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	1484	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1441	colours with their names.	1485	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1486	cube plus a 8 (24) colour greyscale ramp.
		1487
		1488	Here is a list of the ANSI colours with their names.
1442		1489
1443	=begin table	1490	=begin table
1444		1491
1445	B<color0> (black) = Black	1492	B<color0> (black) = Black
1446	B<color1> (red) = Red3	1493	B<color1> (red) = Red3
…		…
1466	It is also possible to specify the colour values of B<foreground>,	1513	It is also possible to specify the colour values of B<foreground>,
1467	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1514	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	1515	a number 0-15, as a convenient shorthand to reference the colour name of
1469	color0-color15.	1516	color0-color15.
1470		1517
1471	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1518	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)	1519	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		1520
		1521	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1522
		1523	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1524	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1525
		1526	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1527	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1528	the RGB cube.
		1529
1476	Together, all those colours implement the 88 colour xterm colours. Only	1530	Together, all those colours implement the 88 (256) colour xterm
1477	the first 16 can be changed using resources currently, the rest can only	1531	colours. Only the first 16 can be changed using resources currently, the
1478	be changed via command sequences ("escape codes").	1532	rest can only be changed via command sequences ("escape codes").
		1533
		1534	Applications are advised to use terminfo or command sequences to discover
		1535	number and RGB values of all colours (yes, you can query this...).
1479		1536
1480	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1537	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1481	always swapping the foreground/background colours. This is in contrast to	1538	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	1539	I<xterm>(1) where the colours are only swapped if they have not otherwise
1483	been specified. For example,	1540	been specified. For example,
1484		1541
1485	=over 4
1486
1487	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1542	@@RXVT_NAME@@ -fg Black -bg White -rv
1488		1543
1489	would yield White on Black, while on I<xterm>(1) it would yield Black	1544	would yield White on Black, while on I<xterm>(1) it would yield Black on
1490	on White.	1545	White.
1491
1492	=back
1493		1546
1494	=head2 ALPHA CHANNEL SUPPORT	1547	=head2 ALPHA CHANNEL SUPPORT
1495		1548
1496	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1549	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:	1550	their act together, rxvt-unicode will do its own alpha channel management:
1498		1551
1499	You can prefix any color with an opaquenes percentage enclosed in	1552	You can prefix any colour with an opaqueness percentage enclosed in
1500	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage	1553	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	1554	(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	1555	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	1556	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	1557	is the recommended format to specify transparency values, and works with
1505	all ways to specify a colour.	1558	all ways to specify a colour.
1506		1559
…		…
1589	=item B<RXVT_SOCKET>	1642	=item B<RXVT_SOCKET>
1590		1643
1591	The unix domain socket path used by @@RXVT_NAME@@c(1) and	1644	The unix domain socket path used by @@RXVT_NAME@@c(1) and
1592	@@RXVT_NAME@@d(1).	1645	@@RXVT_NAME@@d(1).
1593		1646
1594	Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.	1647	Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1595		1648
1596	=item B<HOME>	1649	=item B<HOME>
1597		1650
1598	Used to locate the default directory for the unix domain socket for	1651	Used to locate the default directory for the unix domain socket for
1599	daemon communications and to locate various resource files (such as	1652	daemon communications and to locate various resource files (such as
1600	C<.Xdefaults>)	1653	C<.Xdefaults>)
1601		1654
1602	=item B<XAPPLRESDIR>	1655	=item B<XAPPLRESDIR>
1603		1656
1604	Directory where various X resource files are being located.	1657	Directory where application-specific X resource files are located.
1605		1658
1606	=item B<XENVIRONMENT>	1659	=item B<XENVIRONMENT>
1607		1660
1608	If set and accessible, gives the name of a X resource file to be loaded by	1661	If set and accessible, gives the name of a X resource file to be loaded by
1609	@@RXVT_NAME@@.	1662	@@RXVT_NAME@@.
…		…
1614		1667
1615	=over 4	1668	=over 4
1616		1669
1617	=item B</usr/lib/X11/rgb.txt>	1670	=item B</usr/lib/X11/rgb.txt>
1618		1671
1619	Color names.	1672	Colour names.
1620		1673
1621	=back	1674	=back
1622		1675
1623	=head1 SEE ALSO	1676	=head1 SEE ALSO
1624		1677
…		…
1675		1728
1676	Project Coordinator (Changes 1.0 -)	1729	Project Coordinator (Changes 1.0 -)
1677		1730
1678	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1731	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1679		1732
1680	Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.	1733	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1681		1734
1682	=back	1735	=back
1683		1736

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.215 by sf-exg, Sun May 20 16:34:42 2012 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.215 by sf-exg, Sun May 20 16:34:42 2012 UTC