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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.157 by ayin, Sat Jan 19 16:20:09 2008 UTC vs.
Revision 1.186 by sf-exg, Wed Oct 13 23:36:00 2010 UTC

…		…
92		92
93	Print out a message describing available options.	93	Print out a message describing available options.
94		94
95	=item B<-display> I<displayname>	95	=item B<-display> I<displayname>
96		96
97	Attempt to open a window on the named X display (B<-d> still	97	Attempt to open a window on the named X display (the older form B<-d>
98	respected). In the absence of this option, the display specified by the	98	is still respected. but deprecated). In the absence of this option, the
99	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<xft>: Attempt to find a visual with the given bit depth;
104	resource B<depth>.	104	resource B<depth>.
		105
		106	[Please note that many X servers (and libXft) are buggy with
		107	respect to C<-depth 32> and/or alpha channels, and will cause all sorts
		108	of graphical corruption. This is harmless, but we can't do anything about
		109	this, so watch out]
105		110
106	=item B<-geometry> I<geom>	111	=item B<-geometry> I<geom>
107		112
108	Window geometry (B<-g> still respected); resource B<geometry>.	113	Window geometry (B<-g> still respected); resource B<geometry>.
109		114
…		…
147	non-tiled backgrounds, currently. See also the B<-sh> option that can be	152	non-tiled backgrounds, currently. See also the B<-sh> option that can be
148	used to brighten or darken the image in addition to tinting it.	153	used to brighten or darken the image in addition to tinting it.
149	Please note that certain tint colours can be applied on the server-side,	154	Please note that certain tint colours can be applied on the server-side,
150	thus yielding performance gain of two orders of magnitude. These colours are:	155	thus yielding performance gain of two orders of magnitude. These colours are:
151	blue, red, green, cyan, magenta, yellow, and those close to them. Also	156	blue, red, green, cyan, magenta, yellow, and those close to them. Also
152	pure black and pure white colors essentially mean no tinting; resource	157	pure black and pure white colours essentially mean no tinting; resource
153	I<tintColor>. Example:	158	I<tintColor>. Example:
154		159
155	@@RXVT_NAME@@ -tr -tint blue -sh 40	160	@@RXVT_NAME@@ -tr -tint blue -sh 40
156		161
157	=item B<-sh> I<number>	162	=item B<-sh> I<number>
…		…
163	=item B<-blt> I<string>	168	=item B<-blt> I<string>
164		169
165	Specify background blending type. If background pixmap is specified	170	Specify background blending type. If background pixmap is specified
166	at the same time as transparency - such pixmap will be blended over	171	at the same time as transparency - such pixmap will be blended over
167	transparency image, using method specified. Supported values are :	172	transparency image, using method specified. Supported values are :
168	B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,	173	B<add>, B<alphablend>, B<allanon> - colour values averaging, B<colorize>,
169	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,	174	B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
170	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is	175	B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
171	alpha-blending. Compile I<afterimage>; resource I<blendType>.	176	alpha-blending. Compile I<afterimage>; resource I<blendType>.
172		177
173	=item B<-blr> I<HxV>	178	=item B<-blr> I<HxV>
174		179
175	Apply Gaussian Blur with the specified radii to the transparent	180	Apply Gaussian Blur with the specified radii to the transparent
176	background image. If single number is specified - both vertical and	181	background image. If single number is specified - both vertical and
177	horizontal radii are considered to be the same. Setting one of the	182	horizontal radii are considered to be the same. Setting one of the
178	radii to 1 and another to a large number creates interesting effects	183	radii to 1 and another to a large number creates interesting effects
179	on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;	184	on some backgrounds. Maximum radius value is 128. Compile I<afterimage> or I<xft>;
180	resource I<blurRadius>.	185	resource I<blurRadius>.
181		186
		187	=item B<-icon> I<file>
		188
		189	Compile I<afterimage> or I<pixbuf>: Use the specified image as application icon. This
		190	is used by many window managers, taskbars and pagers to represent the
		191	application window; resource I<iconFile>.
		192
182	=item B<-bg> I<colour>	193	=item B<-bg> I<colour>
183		194
184	Window background colour; resource B<background>.	195	Window background colour; resource B<background>.
185		196
186	=item B<-fg> I<colour>	197	=item B<-fg> I<colour>
187		198
188	Window foreground colour; resource B<foreground>.	199	Window foreground colour; resource B<foreground>.
189		200
190	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>	201	=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
191		202
192	Compile I<afterimage>: Specify image file for the background and also	203	Compile I<afterimage> or I<pixbuf>: Specify image file for the background and also
193	optionally specify its scaling with a geometry string. Note you may need to	204	optionally specify its scaling with a geometry string. Note you may need to
194	add quotes to avoid special shell interpretation of the C<;> in the	205	add quotes to avoid special shell interpretation of the C<;> in the
195	command-line; for more details see resource B<backgroundPixmap>.	206	command-line; for more details see resource B<backgroundPixmap>.
196		207
197	=item B<-cr> I<colour>	208	=item B<-cr> I<colour>
…		…
310		321
311	=item B<-bc>\|B<+bc>	322	=item B<-bc>\|B<+bc>
312		323
313	Blink the cursor; resource B<cursorBlink>.	324	Blink the cursor; resource B<cursorBlink>.
314		325
		326	=item B<-uc>\|B<+uc>
		327
		328	Make the cursor underlined; resource B<cursorUnderline>.
		329
315	=item B<-iconic>	330	=item B<-iconic>
316		331
317	Start iconified, if the window manager supports that option.	332	Start iconified, if the window manager supports that option.
318	Alternative form is B<-ic>.	333	Alternative form is B<-ic>.
319		334
…		…
335		350
336	=item B<-bl>	351	=item B<-bl>
337		352
338	Compile I<frills>: Set MWM hints to request a borderless window, i.e.	353	Compile I<frills>: Set MWM hints to request a borderless window, i.e.
339	if honoured by the WM, the rxvt-unicode window will not have window	354	if honoured by the WM, the rxvt-unicode window will not have window
340	decorations; resource B<borderLess>.	355	decorations; resource B<borderLess>. If the window manager does not
		356	support MWM hints (e.g. kwin), enables override-redirect mode.
341		357
342	=item B<-override-redirect>	358	=item B<-override-redirect>
343		359
344	Compile I<frills>: Sets override-redirect on the window; resource	360	Compile I<frills>: Sets override-redirect on the window; resource
345	B<override-redirect>.	361	B<override-redirect>.
…		…
354	=item B<-lsp> I<number>	370	=item B<-lsp> I<number>
355		371
356	Compile I<frills>: Lines (pixel height) to insert between each row of	372	Compile I<frills>: Lines (pixel height) to insert between each row of
357	the display. Useful to work around font rendering problems; resource	373	the display. Useful to work around font rendering problems; resource
358	B<lineSpace>.	374	B<lineSpace>.
		375
		376	=item B<-letsp> I<number>
		377
		378	Compile I<frills>: Amount to adjust the computed character width by
		379	to control overall letter spacing. Negative values will tighten up the
		380	letter spacing, positive values will space letters out more. Useful to
		381	work around odd font metrics; resource B<letterSpace>.
359		382
360	=item B<-tn> I<termname>	383	=item B<-tn> I<termname>
361		384
362	This option specifies the name of the terminal type to be set in the	385	This option specifies the name of the terminal type to be set in the
363	B<TERM> environment variable. This terminal type must exist in the	386	B<TERM> environment variable. This terminal type must exist in the
…		…
449		472
450	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	473	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
451	will not immediately destroy its window when the program executed within	474	will not immediately destroy its window when the program executed within
452	it exits. Instead, it will wait till it is being killed or closed by the	475	it exits. Instead, it will wait till it is being killed or closed by the
453	user; resource B<hold>.	476	user; resource B<hold>.
		477
		478	=item B<-cd> I<path>
		479
		480	Sets the working directory for the shell (or the command specified via
		481	B<-e>). The I<path> must be an absolute path and it must exist for
		482	@@RXVT_NAME@@ to start; resource B<chdir>.
454		483
455	=item B<-xrm> I<string>	484	=item B<-xrm> I<string>
456		485
457	Works like the X Toolkit option of the same name, by adding the I<string>	486	Works like the X Toolkit option of the same name, by adding the I<string>
458	as if it were specified in a resource file. Resource values specified this	487	as if it were specified in a resource file. Resource values specified this
…		…
567	=item B<depth:> I<bitdepth>	596	=item B<depth:> I<bitdepth>
568		597
569	Compile I<xft>: Attempt to find a visual with the given bit depth;	598	Compile I<xft>: Attempt to find a visual with the given bit depth;
570	option B<-depth>.	599	option B<-depth>.
571		600
		601	=item B<buffered:> I<boolean>
		602
		603	Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
		604	On some card/driver combination enabling it slightly decreases
		605	performance, on most it greatly helps it. The slowdown is small, so it
		606	should normally be enabled.
		607
572	=item B<geometry:> I<geom>	608	=item B<geometry:> I<geom>
573		609
574	Create the window with the specified X window geometry [default 80x24];	610	Create the window with the specified X window geometry [default 80x24];
575	option B<-geometry>.	611	option B<-geometry>.
576		612
…		…
589	Use the specified colour for the colour value I<n>, where 0-7	625	Use the specified colour for the colour value I<n>, where 0-7
590	corresponds to low-intensity (normal) colours and 8-15 corresponds to	626	corresponds to low-intensity (normal) colours and 8-15 corresponds to
591	high-intensity (bold = bright foreground, blink = bright background)	627	high-intensity (bold = bright foreground, blink = bright background)
592	colours. The canonical names are as follows: 0=black, 1=red, 2=green,	628	colours. The canonical names are as follows: 0=black, 1=red, 2=green,
593	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour	629	3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
594	names used are listed in the B<COLORS AND GRAPHICS> section.	630	names used are listed in the B<COLOURS AND GRAPHICS> section.
595		631
596	Colours higher than 15 cannot be set using resources (yet), but can be	632	Colours higher than 15 cannot be set using resources (yet), but can be
597	changed using an escape command (see @@RXVT_NAME@@(7)).	633	changed using an escape command (see @@RXVT_NAME@@(7)).
598		634
599	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with	635	Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
…		…
610	=item B<colorUL:> I<colour>	646	=item B<colorUL:> I<colour>
611		647
612	Use the specified colour to display underlined characters when the	648	Use the specified colour to display underlined characters when the
613	foreground colour is the default.	649	foreground colour is the default.
614		650
615	=item B<colorRV:> I<colour>
616
617	Use the specified colour as the background for reverse video characters
618	when OPTION_HC is disabled (--disable-frills).
619
620	=item B<underlineColor:> I<colour>	651	=item B<underlineColor:> I<colour>
621		652
622	If set, use the specified colour as the colour for the underline	653	If set, use the specified colour as the colour for the underline
623	itself. If unset, use the foreground colour.	654	itself. If unset, use the foreground colour.
		655
		656	=item B<highlightColor:> I<colour>
		657
		658	If set, use the specified colour as the background for highlighted
		659	characters. If unset, use reverse video.
		660
		661	=item B<highlightTextColor:> I<colour>
		662
		663	If set and highlightColor is set, use the specified colour as the
		664	foreground for highlighted characters.
624		665
625	=item B<cursorColor:> I<colour>	666	=item B<cursorColor:> I<colour>
626		667
627	Use the specified colour for the cursor. The default is to use the	668	Use the specified colour for the cursor. The default is to use the
628	foreground colour; option B<-cr>.	669	foreground colour; option B<-cr>.
…		…
635		676
636	=item B<reverseVideo:> I<boolean>	677	=item B<reverseVideo:> I<boolean>
637		678
638	B<True>: simulate reverse video by foreground and background colours;	679	B<True>: simulate reverse video by foreground and background colours;
639	option B<-rv>. B<False>: regular screen colours [default]; option	680	option B<-rv>. B<False>: regular screen colours [default]; option
640	B<+rv>. See note in B<COLORS AND GRAPHICS> section.	681	B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
641		682
642	=item B<jumpScroll:> I<boolean>	683	=item B<jumpScroll:> I<boolean>
643		684
644	B<True>: specify that jump scrolling should be used. When receiving lots	685	B<True>: specify that jump scrolling should be used. When receiving lots
645	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines	686	of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
…		…
694		735
695	Specify background blending type; option B<-blt>.	736	Specify background blending type; option B<-blt>.
696		737
697	=item B<blurRadius:> I<number>	738	=item B<blurRadius:> I<number>
698		739
699	Apply Gaussian Blurr with the specified radius to the transparent	740	Apply gaussian blur with the specified radius to the transparent
700	background image; option B<-blr>.	741	background image; option B<-blr>.
		742
		743	=item B<iconFile:> I<file>
		744
		745	Set the application icon pixmap; option B<-icon>.
701		746
702	=item B<scrollColor:> I<colour>	747	=item B<scrollColor:> I<colour>
703		748
704	Use the specified colour for the scrollbar [default #B2B2B2].	749	Use the specified colour for the scrollbar [default #B2B2B2].
705		750
…		…
715		760
716	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>	761	=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
717		762
718	Use the specified image file for the background and also	763	Use the specified image file for the background and also
719	optionally specify its scaling with a geometry string B<WxH+X+Y>,	764	optionally specify its scaling with a geometry string B<WxH+X+Y>,
720	(default C<0x0+50+50>) in which B<"W" / "H"> specify the	765	(default C<100x100+50+50>) in which B<"W" / "H"> specify the
721	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image	766	horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
722	centre (percent). A scale of 0 displays the image with tiling. A scale	767	centre (percent). A scale of 0 displays the image with tiling.
723	of 1 displays the image without any scaling. A scale of 2 to 9 specifies	768	The maximum permitted scale is 1000.
724	an integer number of images in that direction. No image will be magnified
725	beyond 10 times its original size. The maximum permitted scale is 1000.
726	Additional operations can be specified after colon B<:op1:op2...>.	769	Additional operations can be specified after colon B<:op1:op2...>.
727	Supported operations are:	770	Supported operations are:
728		771
729	tile force background image to be tiled and not scaled. Equivalent to 0x0	772	tile force background image to be tiled and not scaled. Equivalent to 0x0
730	propscale will scale image keeping proportions	773	propscale will scale image keeping proportions
…		…
734	scale will scale image to match window size	777	scale will scale image to match window size
735	root will tile image as if it was a root window background, auto-adjusting	778	root will tile image as if it was a root window background, auto-adjusting
736	whenever terminal window moves	779	whenever terminal window moves
737		780
738	If used in conjunction with B<-tr> option, the specified pixmap will be	781	If used in conjunction with B<-tr> option, the specified pixmap will be
739	blended over transparency image using either alpha-blending, or any	782	blended over transparency image using alpha-blending. If I<afterimage>
740	other blending type, specified with B<-blt "type"> option.	783	support has been compiled in it is possible to choose other blending
		784	types with B<-blt "type"> option.
741		785
742	=item B<path:> I<path>	786	=item B<path:> I<path>
743		787
744	Specify the colon-delimited search path for finding background image files.	788	Specify the colon-delimited search path for finding background image files.
745		789
…		…
772	it is named first) and thus defines the character cell grid to be 9 pixels	816	it is named first) and thus defines the character cell grid to be 9 pixels
773	wide and 15 pixels high.	817	wide and 15 pixels high.
774		818
775	The second font is just used to add additional unicode characters not in	819	The second font is just used to add additional unicode characters not in
776	the base font, likewise the third, which is unfortunately non-bold, but	820	the base font, likewise the third, which is unfortunately non-bold, but
777	the bold version of the font does contain less characters, so this is a	821	the bold version of the font does contain fewer characters, so this is a
778	useful supplement.	822	useful supplement.
779		823
780	The third font is an Xft font with aliasing turned off, and the characters	824	The third font is an Xft font with aliasing turned off, and the characters
781	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font	825	are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
782	contains other characters, but we are not interested in them.	826	contains other characters, but we are not interested in them.
…		…
833	=item B<urgentOnBell:> I<boolean>	877	=item B<urgentOnBell:> I<boolean>
834		878
835	B<True>: set the urgency hint for the wm on receipt of a bell character.	879	B<True>: set the urgency hint for the wm on receipt of a bell character.
836	B<False>: do not set the urgency hint [default].	880	B<False>: do not set the urgency hint [default].
837		881
		882	@@RXVT_NAME@@ resets the urgency hint on every focus change.
		883
838	=item B<visualBell:> I<boolean>	884	=item B<visualBell:> I<boolean>
839		885
840	B<True>: use visual bell on receipt of a bell character; option B<-vb>.	886	B<True>: use visual bell on receipt of a bell character; option B<-vb>.
841	B<False>: no visual bell [default]; option B<+vb>.	887	B<False>: no visual bell [default]; option B<+vb>.
842		888
…		…
966	=item B<cursorBlink:> I<boolean>	1012	=item B<cursorBlink:> I<boolean>
967		1013
968	B<True>: blink the cursor. B<False>: do not blink the cursor [default];	1014	B<True>: blink the cursor. B<False>: do not blink the cursor [default];
969	option B<-bc>.	1015	option B<-bc>.
970		1016
		1017	=item B<cursorUnderline:> I<boolean>
		1018
		1019	B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
		1020	option B<-uc>.
		1021
971	=item B<pointerBlank:> I<boolean>	1022	=item B<pointerBlank:> I<boolean>
972		1023
973	B<True>: blank the pointer when a key is pressed or after a set number	1024	B<True>: blank the pointer when a key is pressed or after a set number
974	of seconds of inactivity. B<False>: the pointer is always visible	1025	of seconds of inactivity. B<False>: the pointer is always visible
975	[default].	1026	[default].
…		…
988	large number (e.g. C<987654321>) to effectively disable the timeout.	1039	large number (e.g. C<987654321>) to effectively disable the timeout.
989		1040
990	=item B<backspacekey:> I<string>	1041	=item B<backspacekey:> I<string>
991		1042
992	The string to send when the backspace key is pressed. If set to B<DEC>	1043	The string to send when the backspace key is pressed. If set to B<DEC>
993	or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>	1044	or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
994	(code 8) - which can be reversed with the appropriate DEC private mode	1045	(code 8) - which can be reversed with the appropriate DEC private mode
995	escape sequence.	1046	escape sequence.
996		1047
997	=item B<deletekey:> I<string>	1048	=item B<deletekey:> I<string>
998		1049
…		…
1077		1128
1078	=item B<secondaryScroll:> I<boolean>	1129	=item B<secondaryScroll:> I<boolean>
1079		1130
1080	Turn on/off secondary screen scroll (default enabled). If this	1131	Turn on/off secondary screen scroll (default enabled). If this
1081	option is enabled, scrolls on the secondary screen will change the	1132	option is enabled, scrolls on the secondary screen will change the
1082	scrollback buffer and switching to/from the secondary screen will	1133	scrollback buffer and, when secondaryScreen is off, switching
1083	instead scroll the screen up.	1134	to/from the secondary screen will instead scroll the screen up.
1084		1135
1085	=item B<hold>: I<boolean>	1136	=item B<hold>: I<boolean>
1086		1137
1087	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	1138	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1088	will not immediately destroy its window when the program executed within	1139	will not immediately destroy its window when the program executed within
1089	it exits. Instead, it will wait till it is being killed or closed by the	1140	it exits. Instead, it will wait till it is being killed or closed by the
1090	user.	1141	user.
		1142
		1143	=item B<chdir>: I<path>
		1144
		1145	Sets the working directory for the shell (or the command specified via
		1146	B<-e>). The I<path> must be an absolute path and it must exist for
		1147	@@RXVT_NAME@@ to start. If it isn't specified then the current working
		1148	directory will be used; option B<-cd>.
1091		1149
1092	=item B<keysym.>I<sym>: I<string>	1150	=item B<keysym.>I<sym>: I<string>
1093		1151
1094	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1152	Compile I<frills>: Associate I<string> with keysym I<sym>. The
1095	intervening resource name B<keysym.> cannot be omitted.	1153	intervening resource name B<keysym.> cannot be omitted.
…		…
1110	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1168	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1111	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1169	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1112	performed in an exact manner; however, the closest match is assured.	1170	performed in an exact manner; however, the closest match is assured.
1113		1171
1114	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1172	I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1115	number), see RESOURCES in C<man 7 X> for futher details.	1173	number), see RESOURCES in C<man 7 X> for further details.
1116		1174
1117	You can define a range of keysyms in one shot by providing a I<string>	1175	You can define a range of keysyms in one shot by providing a I<string>
1118	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1176	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1119	should be a character not used by the strings.	1177	should be a character not used by the strings.
1120		1178
…		…
1134	when Control-Meta-c is being pressed":	1192	when Control-Meta-c is being pressed":
1135		1193
1136	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1194	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1137		1195
1138	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1196	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1139	is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)	1197	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1140	manpage. For example, the F<selection> extension (activated via	1198	manpage. For example, the F<selection> extension (activated via
1141	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:	1199	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1142		1200
1143	URxvt.keysym.M-C-c: perl:selection:rot13	1201	URxvt.keysym.M-C-c: perl:selection:rot13
1144		1202
1145	Due the the large number of modifier combinations, a defined key mapping	1203	Due the the large number of modifier combinations, a defined key mapping
1146	will match if at I<at least> the specified identifiers are being set, and	1204	will match if I<at least> the specified identifiers are being set, and
1147	no other key mappings with those and more bits are being defined. That	1205	no other key mappings with those and more bits are being defined. That
1148	means that defining a key map for C<a> will automatically provide	1206	means that defining a key map for C<a> will automatically provide
1149	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined	1207	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1150	mappings themselves.	1208	mappings themselves.
1151		1209
…		…
1202	all instances, while B<perl-ext> is used for specific instances.	1260	all instances, while B<perl-ext> is used for specific instances.
1203		1261
1204	=item B<perl-eval>: I<string>	1262	=item B<perl-eval>: I<string>
1205		1263
1206	Perl code to be evaluated when all extensions have been registered. See	1264	Perl code to be evaluated when all extensions have been registered. See
1207	the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource	1265	the @@RXVT_NAME@@perl(3) manpage.
1208	will be ignored when running setuid/setgid.
1209		1266
1210	=item B<perl-lib>: I<path>	1267	=item B<perl-lib>: I<path>
1211		1268
1212	Colon-separated list of additional directories that hold extension	1269	Colon-separated list of additional directories that hold extension
1213	scripts. When looking for extensions specified by the C<perl> resource,	1270	scripts. When looking for extensions specified by the C<perl> resource,
1214	@@RXVT_NAME@@ will first look in these directories and then in	1271	@@RXVT_NAME@@ will first look in these directories and then in
1215	F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource	1272	F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1216	will be ignored when running setuid/setgid.
1217		1273
1218	See the @@RXVT_NAME@@perl(3) manpage.	1274	See the @@RXVT_NAME@@perl(3) manpage.
1219		1275
1220	=item B<< selection.pattern-I<idx> >>: I<perl-regex>	1276	=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1221		1277
…		…
1243		1299
1244	=item B<override-redirect>: I<boolean>	1300	=item B<override-redirect>: I<boolean>
1245		1301
1246	Compile I<frills>: Sets override-redirect for the terminal window, making	1302	Compile I<frills>: Sets override-redirect for the terminal window, making
1247	it almost invisible to window managers; option B<-override-redirect>.	1303	it almost invisible to window managers; option B<-override-redirect>.
		1304
		1305	=item B<iso14755:> I<boolean>
		1306
		1307	Turn on/off ISO 14755 (default enabled).
1248		1308
1249	=item B<iso14755_52:> I<boolean>	1309	=item B<iso14755_52:> I<boolean>
1250		1310
1251	Turn on/off ISO 14755 5.2 mode (default enabled).	1311	Turn on/off ISO 14755 5.2 mode (default enabled).
1252		1312
…		…
1395	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that	1455	B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1396	it can be seen via the I<who(1)> command, and can accept messages. To	1456	it can be seen via the I<who(1)> command, and can accept messages. To
1397	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root	1457	allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1398	on some systems or setgid to root or to some other group on others.	1458	on some systems or setgid to root or to some other group on others.
1399		1459
1400	=head1 COLORS AND GRAPHICS	1460	=head1 COLOURS AND GRAPHICS
1401		1461
1402	In addition to the default foreground and background colours,	1462	In addition to the default foreground and background colours,
1403	B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus	1463	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1404	high-intensity bold/blink versions of the same). Here is a list of the	1464	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1405	colours with their names.	1465	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
		1466	cube plus a 8 (24) colour greyscale ramp.
		1467
		1468	Here is a list of the ANSI colours with their names.
1406		1469
1407	=begin table	1470	=begin table
1408		1471
1409	B<color0> (black) = Black	1472	B<color0> (black) = Black
1410	B<color1> (red) = Red3	1473	B<color1> (red) = Red3
…		…
1430	It is also possible to specify the colour values of B<foreground>,	1493	It is also possible to specify the colour values of B<foreground>,
1431	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as	1494	B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1432	a number 0-15, as a convenient shorthand to reference the colour name of	1495	a number 0-15, as a convenient shorthand to reference the colour name of
1433	color0-color15.	1496	color0-color15.
1434		1497
1435	In addition to the colours defined above, @@RXVT_NAME@@ offers an	1498	The following text gives values for the standard 88 colour mode (and
1436	additional 72 colours. The first 64 of those (with indices 16 to 79)	1499	values for the 256 colour mode in parentheses).
1437	consist of a 444 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1438	16>), followed by 8 additional shades of gray (with indices 80 to 87).
1439		1500
		1501	The RGB cube uses indices 16..79 (16..231) using the following formulas:
		1502
		1503	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
		1504	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
		1505
		1506	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
		1507	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
		1508	the RGB cube.
		1509
1440	Together, all those colours implement the 88 colour xterm colours. Only	1510	Together, all those colours implement the 88 (256) colour xterm
1441	the first 16 can be changed using resources currently, the rest can only	1511	colours. Only the first 16 can be changed using resources currently, the
1442	be changed via command sequences ("escape codes").	1512	rest can only be changed via command sequences ("escape codes").
		1513
		1514	Applications are advised to use terminfo or command sequences to discover
		1515	number and RGB values of all colours (yes, you can query this...).
1443		1516
1444	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by	1517	Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1445	always swapping the foreground/background colours. This is in contrast to	1518	always swapping the foreground/background colours. This is in contrast to
1446	I<xterm>(1) where the colours are only swapped if they have not otherwise	1519	I<xterm>(1) where the colours are only swapped if they have not otherwise
1447	been specified. For example,	1520	been specified. For example,
1448		1521
1449	=over 4
1450
1451	=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>	1522	@@RXVT_NAME@@ -fg Black -bg White -rv
1452		1523
1453	would yield White on Black, while on I<xterm>(1) it would yield Black	1524	would yield White on Black, while on I<xterm>(1) it would yield Black on
1454	on White.	1525	White.
1455
1456	=back
1457		1526
1458	=head2 ALPHA CHANNEL SUPPORT	1527	=head2 ALPHA CHANNEL SUPPORT
1459		1528
1460	If Xft support has been compiled in and as long as Xft/Xrender/X don't get	1529	If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1461	their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>	1530	their act together, rxvt-unicode will do it's own alpha channel management:
1462	(recommended, but B<MUST> have 4 digits/component) colour specifications,	1531
1463	in addition to the ones provided by X, where the additional A component	1532	You can prefix any colour with an opaqueness percentage enclosed in
		1533	brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
		1534	(0-100) that specifies the opacity of the colour, where C<0> is completely
		1535	transparent and C<100> is completely opaque. For example, C<[50]red> is a
		1536	half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
		1537	is the recommended format to specify transparency values, and works with
		1538	all ways to specify a colour.
		1539
		1540	For complete control, rxvt-unicode also supports
		1541	C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
		1542	specifications, where the additional C<aaaa> component specifies opacity
1464	specifies opacity (alpha) values. The minimum value of C<0> is completely	1543	(alpha) values. The minimum value of C<0000> is completely transparent,
1465	transparent). You can also prefix any color with C<[percent]>, where	1544	while C<ffff> is completely opaque). The two example colours from
1466	C<percent> is a decimal percentage (0-100) that specifies the opacity of	1545	earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1467	the color, where C<0> is completely transparent and C<100> is completelxy	1546	C<rgba:0000/ff00/0000/f332>.
1468	opaque.
1469		1547
1470	You probably need to specify B<"-depth 32">, too, and have the luck that	1548	You probably need to specify B<"-depth 32">, too, to force a visual with
1471	your X-server uses ARGB pixel layout, as X is far from just supporting	1549	alpha channels, and have the luck that your X-server uses ARGB pixel
1472	ARGB visuals out of the box, and rxvt-unicode just fudges around.	1550	layout, as X is far from just supporting ARGB visuals out of the box, and
		1551	rxvt-unicode just fudges around.
1473		1552
1474	For example, the following selects an almost completely transparent red	1553	For example, the following selects an almost completely transparent black
1475	background, and an almost opaque pink foreground:	1554	background, and an almost opaque pink foreground:
1476		1555
1477	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"	1556	@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1478		1557
1479	I<Please note that transparency of any kind if completely unsupported by	1558	When not using a background image, then the interpretation of the
1480	the author. Don't bug him with installation questions!>	1559	alpha channel is up to your compositing manager (most interpret it as
		1560	transparency of course).
		1561
		1562	When using a background pixmap or pseudo-transparency, then the background
		1563	colour will always behave as if it were completely transparent (so the
		1564	background image shows instead), regardless of how it was specified, while
		1565	other colours will either be transparent as specified (the background
		1566	image will show through) on servers supporting the RENDER extension, or
		1567	fully opaque on servers not supporting the RENDER EXTENSION.
		1568
		1569	Please note that due to bugs in Xft, specifying alpha values might result
		1570	in garbage being displayed when the X-server does not support the RENDER
		1571	extension.
1481		1572
1482	=head1 ENVIRONMENT	1573	=head1 ENVIRONMENT
1483		1574
1484	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1575	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1485		1576
…		…
1519	C<--with-terminfo=PATH>.	1610	C<--with-terminfo=PATH>.
1520		1611
1521	=item B<DISPLAY>	1612	=item B<DISPLAY>
1522		1613
1523	Used by @@RXVT_NAME@@ to connect to the display and set to the correct	1614	Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1524	display in its child processes.	1615	display in its child processes if C<-display> isn't used to override. It
		1616	defaults to C<:0> if it doesn't exist.
1525		1617
1526	=item B<SHELL>	1618	=item B<SHELL>
1527		1619
1528	The shell to be used for command execution, defaults to C</bin/sh>.	1620	The shell to be used for command execution, defaults to C</bin/sh>.
1529		1621
…		…
1555		1647
1556	=over 4	1648	=over 4
1557		1649
1558	=item B</usr/lib/X11/rgb.txt>	1650	=item B</usr/lib/X11/rgb.txt>
1559		1651
1560	Color names.	1652	Colour names.
1561		1653
1562	=back	1654	=back
1563		1655
1564	=head1 SEE ALSO	1656	=head1 SEE ALSO
1565		1657

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.157 by ayin, Sat Jan 19 16:20:09 2008 UTC vs. Revision 1.186 by sf-exg, Wed Oct 13 23:36:00 2010 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.157 by ayin, Sat Jan 19 16:20:09 2008 UTC vs.
Revision 1.186 by sf-exg, Wed Oct 13 23:36:00 2010 UTC