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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.219 by root, Thu Jun 7 16:06:23 2012 UTC vs.
Revision 1.244 by sf-exg, Tue Jun 16 11:58:26 2015 UTC

…		…
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>	111	=item B<-visual> I<visualID>
112		112
113	Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible	113	Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for
114	visual ids).	114	possible visual ids) instead of the default, and also allocate a private
		115	colormap. All visual types except for DirectColor are supported.
115		116
116	=item B<-geometry> I<geom>	117	=item B<-geometry> I<geom>
117		118
118	Window geometry (B<-g> still respected); resource B<geometry>.	119	Window geometry (B<-g> still respected); resource B<geometry>.
119		120
…		…
126	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>.
127		128
128	=item B<-ss>\|B<+ss>	129	=item B<-ss>\|B<+ss>
129		130
130	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>.
131
132	=item B<-tr>\|B<+tr>
133
134	Turn on/off pseudo-transparency by using the root pixmap as background; resource B<transparent>.
135
136	B<-ip> is still accepted as an obsolete alias but will be removed in
137	future versions.
138		132
139	=item B<-fade> I<number>	133	=item B<-fade> I<number>
140		134
141	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
142	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
…		…
145	=item B<-fadecolor> I<colour>	139	=item B<-fadecolor> I<colour>
146		140
147	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
148	is opaque black. resource B<fadeColor>.	142	is opaque black. resource B<fadeColor>.
149		143
150	=item B<-tint> I<colour>
151
152	Tint the transparent background with the given colour;
153	resource I<tintColor>.
154
155	=item B<-sh> I<number>
156
157	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
158	A value of 100 means no shading; resource I<shading>.
159
160	=item B<-blr> I<HxV>
161
162	Apply Gaussian Blur with the specified radii to the transparent
163	background. If a single number is specified, the vertical and
164	horizontal radii are considered to be the same. Setting one of the
165	radii to 1 and the other to a large number creates interesting effects
166	on some backgrounds. The maximum radius value is 128. An horizontal or
167	vertical radius of 0 disables blurring;
168	resource I<blurRadius>.
169
170	=item B<-icon> I<file>	144	=item B<-icon> I<file>
171		145
172	Compile I<pixbuf>: Use the specified image as application icon. This	146	Compile I<pixbuf>: Use the specified image as application icon. This
173	is used by many window managers, taskbars and pagers to represent the	147	is used by many window managers, taskbars and pagers to represent the
174	application window; resource I<iconFile>.	148	application window; resource I<iconFile>.
…		…
178	Window background colour; resource B<background>.	152	Window background colour; resource B<background>.
179		153
180	=item B<-fg> I<colour>	154	=item B<-fg> I<colour>
181		155
182	Window foreground colour; resource B<foreground>.	156	Window foreground colour; resource B<foreground>.
183
184	=item B<-pixmap> I<file[;oplist]>
185
186	Compile I<pixbuf>: Specify image file for the background and also
187	optionally specify a list of operations to modify it. Note you may need to
188	add quotes to avoid special shell interpretation of the C<;> in the
189	command-line; for more details see resource B<backgroundPixmap>.
190		157
191	=item B<-cr> I<colour>	158	=item B<-cr> I<colour>
192		159
193	The cursor colour; resource B<cursorColor>.	160	The cursor colour; resource B<cursorColor>.
194		161
…		…
253		220
254	=item B<-ls>\|B<+ls>	221	=item B<-ls>\|B<+ls>
255		222
256	Start as a login-shell/sub-shell; resource B<loginShell>.	223	Start as a login-shell/sub-shell; resource B<loginShell>.
257		224
		225	=item B<-mc> I<milliseconds>
		226
		227	Specify the maximum time between multi-click selections.
		228
258	=item B<-ut>\|B<+ut>	229	=item B<-ut>\|B<+ut>
259		230
260	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	231	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
261	B<utmpInhibit>.	232	B<utmpInhibit>.
262		233
…		…
340		311
341	=item B<-override-redirect>	312	=item B<-override-redirect>
342		313
343	Compile I<frills>: Sets override-redirect on the window; resource	314	Compile I<frills>: Sets override-redirect on the window; resource
344	B<override-redirect>.	315	B<override-redirect>.
		316
		317	=item B<-dockapp>
		318
		319	Sets the initial state of the window to WithdrawnState, which makes
		320	window managers that support this extension treat it as a dockapp.
345		321
346	=item B<-sbg>	322	=item B<-sbg>
347		323
348	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
349	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
…		…
403		379
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>.
		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.
408		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
…		…
683		662
684	B<False>: specify that everything is to be displayed, even	663	B<False>: specify that everything is to be displayed, even
685	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
686	monitor to display anything); option B<+ss>.	665	monitor to display anything); option B<+ss>.
687		666
688	=item B<transparent:> I<boolean>
689
690	Turn on/off pseudo-transparency by using the root pixmap as background.
691
692	B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
693	future versions.
694
695	=item B<fading:> I<number>	667	=item B<fading:> I<number>
696		668
697	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>.
698		670
699	=item B<fadeColor:> I<colour>	671	=item B<fadeColor:> I<colour>
700		672
701	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
702	colour is black; option B<-fadecolor>.	674	colour is black; option B<-fadecolor>.
703		675
704	=item B<tintColor:> I<colour>
705
706	Tint the transparent background with the given colour. If the RENDER
707	extension is not available only black, red, green, yellow, blue,
708	magenta, cyan and white tints can be performed server-side. Note that
709	a black tint yields a completely black image while a white tint yields
710	the image unchanged; option B<-tint>.
711
712	=item B<shading:> I<number>
713
714	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
715	A value of 100 means no shading; option B<-sh>.
716
717	=item B<blurRadius:> I<number>
718
719	Apply gaussian blur with the specified radius to the transparent
720	background; option B<-blr>.
721
722	=item B<iconFile:> I<file>	676	=item B<iconFile:> I<file>
723		677
724	Set the application icon pixmap; option B<-icon>.	678	Set the application icon pixmap; option B<-icon>.
725		679
726	=item B<scrollColor:> I<colour>	680	=item B<scrollColor:> I<colour>
…		…
734		688
735	=item B<borderColor:> I<colour>	689	=item B<borderColor:> I<colour>
736		690
737	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
738	and the text.	692	and the text.
739
740	=item B<backgroundPixmap:> I<file[;oplist]>
741
742	Use the specified image file for the background and also
743	optionally specify a colon separated list of operations to modify it.
744	Supported operations are:
745
746	=over 4
747
748	=item B<WxH+X+Y>
749
750	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
751	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
752	scale of 0 disables scaling.
753
754	=item B<op=tile>
755
756	enables tiling
757
758	=item B<op=keep-aspect>
759
760	maintain the image aspect ratio when scaling
761
762	=item B<op=root-align>
763
764	use the position of the terminal window relative to the root window as
765	the image offset, simulating a root window background
766
767	=back
768
769	The default scale and position setting is C<100x100+50+50>.
770	Alternatively, a predefined set of templates can be used to achieve
771	the most common setups:
772
773	=over 4
774
775	=item B<style=tiled>
776
777	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
778
779	=item B<style=aspect-stretched>
780
781	the image is scaled to fill the whole window maintaining the aspect
782	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
783
784	=item B<style=stretched>
785
786	the image is scaled to fill the whole window. Equivalent to 100x100
787
788	=item B<style=centered>
789
790	the image is centered with no scaling. Equivalent to 0x0+50+50
791
792	=item B<style=root-tiled>
793
794	the image is tiled with no scaling and using 'root' positioning.
795	Equivalent to 0x0:op=tile:op=root-align
796
797	=back
798
799	If multiple templates are specified the last one wins. Note that a
800	template overrides all the scale, position and operations settings.
801
802	If used in conjunction with B<-tr> option, the specified pixmap will be
803	blended over the transparent background using alpha-blending.
804
805	=item B<path:> I<path>
806
807	Specify the colon-delimited search path for finding background image files.
808		693
809	=item B<font:> I<fontlist>	694	=item B<font:> I<fontlist>
810		695
811	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
812	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
…		…
909		794
910	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
911	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
912	[default]; option B<+ls>.	797	[default]; option B<+ls>.
913		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
914	=item B<utmpInhibit:> I<boolean>	804	=item B<utmpInhibit:> I<boolean>
915		805
916	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>;
917	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>
918	[default]; option B<+ut>.	808	[default]; option B<+ut>.
…		…
1055		945
1056	=item B<pointerColor2:> I<colour>	946	=item B<pointerColor2:> I<colour>
1057		947
1058	Mouse pointer background colour.	948	Mouse pointer background colour.
1059		949
		950	=item B<pointerShape:> I<string>
		951
		952	Compile I<frills>: Specifies the name of the mouse pointer shape
		953	[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
		954	file for possible values (omit the C<XC_> prefix).
		955
1060	=item B<pointerBlankDelay:> I<number>	956	=item B<pointerBlankDelay:> I<number>
1061		957
1062	Specifies number of seconds before blanking the pointer [default 2]. Use a	958	Specifies number of seconds before blanking the pointer [default 2]. Use a
1063	large number (e.g. C<987654321>) to effectively disable the timeout.	959	large number (e.g. C<987654321>) to effectively disable the timeout.
1064		960
…		…
1090		986
1091	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>	987	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
1092		988
1093	=item B<preeditType:> I<style>	989	=item B<preeditType:> I<style>
1094		990
1095	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	991	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1096		992
1097	=item B<inputMethod:> I<name>	993	=item B<inputMethod:> I<name>
1098		994
1099	I<name> of inputMethod to use; option B<-im>.	995	I<name> of inputMethod to use; option B<-im>.
1100		996
…		…
1169	Sets the working directory for the shell (or the command specified via	1065	Sets the working directory for the shell (or the command specified via
1170	B<-e>). The I<path> must be an absolute path and it must exist for	1066	B<-e>). The I<path> must be an absolute path and it must exist for
1171	@@RXVT_NAME@@ to start. If it isn't specified then the current working	1067	@@RXVT_NAME@@ to start. If it isn't specified then the current working
1172	directory will be used; option B<-cd>.	1068	directory will be used; option B<-cd>.
1173		1069
1174	=item B<keysym.>I<sym>: I<string>	1070	=item B<keysym.>I<sym>: I<action>
1175		1071
1176	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1072	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1177	intervening resource name B<keysym.> cannot be omitted.	1073	resource name B<keysym.> cannot be omitted.
1178		1074
1179	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1075	Using this resource, you can map key combinations such as
1180	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1076	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1181	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,	1077	string than would normally result from that combination, making the
1182	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,	1078	terminal scroll up or down the way you want it, or any other thing an
1183	B<2>, B<3>, B<4>, B<5>.	1079	extension might provide.
		1080
		1081	The key combination that triggers the action, I<sym>, has the following format:
		1082
		1083	(modifiers-)key
		1084
		1085	Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
		1086	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
		1087	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
		1088	B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1184		1089
1185	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1090	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1186	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1091	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1187	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1092	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1188	current application keymap mode state.	1093	current application keymap mode state.
1189		1094
1190	The spellings of I<key> can be obtained by using B<xev>(1) command or	1095	Due the the large number of modifier combinations, a key mapping will
1191	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1096	match if I<at least> the specified identifiers are being set, and no other
		1097	key mappings with those and more bits are being defined. That means that
		1098	defining a mapping for C<a> will automatically provide definitions for
		1099	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1100	themselves. See the C<builtin:> action, below, for a way to work around
		1101	this when this is a problem.
		1102
		1103	The spelling of I<key> depends on your implementation of X. An easy way to
		1104	find a key name is to use the B<xev>(1) command. You can find a list by
		1105	looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1192	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1106	the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1193	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1107	value (B<0x0000 - 0xFFFF>).
1194	performed in an exact manner; however, the closest match is assured.
1195		1108
1196	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1109	As with any resource value, the I<action> string may contain backslash
		1110	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1197	number), see RESOURCES in C<man 7 X> for further details.	1111	number), see RESOURCES in C<man 7 X> for further details.
1198		1112
1199	You can define a range of keysyms in one shot by	1113	An action starts with an action prefix that selects a certain type
1200	loading the C<keysym-list> perl extension and providing a I<string>	1114	of action, followed by a colon. An action string without colons is
1201	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1115	interpreted as a literal string to pass to the tty (as if it was
		1116	prefixed with C<string:>).
		1117
		1118	The following action prefixes are known - extensions can provide
		1119	additional prefixes:
		1120
		1121	=over 4
		1122
		1123	=item string:STRING
		1124
		1125	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1126	then the remaining C<STRING> will be passed to the program running in the
		1127	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1128	string C<echo rm -rf /> followed by a newline:
		1129
		1130	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
		1131
		1132	This could in theory be used to completely redefine your keymap.
		1133
		1134	In addition, for actions of this type, you can define a range of
		1135	keysyms in one shot by loading the C<keysym-list> perl extension and
		1136	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1202	should be a character not used by the strings.	1137	the delimiter `/' should be a character not used by the strings.
1203		1138
1204	Its usage can be demonstrated by an example:	1139	Its usage can be demonstrated by an example:
1205		1140
1206	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>	1141	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1207		1142
1208	The above line is equivalent to the following three lines:	1143	The above line is equivalent to the following three lines:
1209		1144
1210	URxvt.keysym.Meta-Control-0x61: \033<a>	1145	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1211	URxvt.keysym.Meta-Control-0x62: \033<b>	1146	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1212	URxvt.keysym.Meta-Control-0x63: \033<c>	1147	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1213		1148
		1149	=item command:STRING
		1150
1214	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1151	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1215	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1152	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1153	the opposite of C<string:> - instead of sending it to the program running
		1154	in the terminal, it will be treated as if it were program output). This is
		1155	most useful to feed command sequences into @@RXVT_NAME@@.
		1156
1216	example the following means "change the current locale to C<zh_CN.GBK>	1157	For example the following means "change the current locale to C<zh_CN.GBK>
1217	when Control-Meta-c is being pressed":	1158	when Control-Meta-c is being pressed":
1218		1159
1219	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1160	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1220		1161
1221	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1162	The following example will map Control-Meta-1 and Control-Meta-2 to
1222	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)	1163	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1223	manpage. For example, the F<selection> extension (activated via	1164	font-switching at runtime:
1224	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1225		1165
1226	URxvt.keysym.M-C-c: perl:selection:rot13	1166	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1167	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1227		1168
1228	Due the the large number of modifier combinations, a defined key mapping	1169	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1229	will match if I<at least> the specified identifiers are being set, and	1170	info):
1230	no other key mappings with those and more bits are being defined. That
1231	means that defining a key map for C<a> will automatically provide
1232	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1233	mappings themselves.
1234		1171
1235	Unfortunately, this will override built-in key mappings. For example	1172	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1173	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1174
		1175	=item builtin:
		1176
		1177	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1178	key binding existed for the key combination. The obvious use is to undo
		1179	the effect of existing bindings. The not so obvious use is to reinstate
		1180	bindings when another binding overrides too many modifiers.
		1181
1236	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1182	For example if you overwrite the C<Insert> key you will disable
1237	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the	1183	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1238	user-defined keymap using the C<builtin:> replacement:	1184	"holes" into the user-defined keymap using the C<builtin:> replacement:
1239		1185
1240	URxvt.keysym.Insert: <my insert key sequence>	1186	URxvt.keysym.Insert: <my insert key sequence>
1241	URxvt.keysym.S-Insert: builtin:	1187	URxvt.keysym.S-Insert: builtin:
1242		1188
1243	The first line defines a mapping for C<Insert> and I<any> combination	1189	The first line defines a mapping for C<Insert> and I<any> combination
1244	of modifiers. The second line re-establishes the default mapping for	1190	of modifiers. The second line re-establishes the default mapping for
1245	C<Shift-Insert>.	1191	C<Shift-Insert>.
1246		1192
1247	The following example will map Control-Meta-1 and Control-Meta-2 to	1193	=item builtin-string:
1248	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1249	font-switching at runtime:
1250		1194
1251	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1195	This action is mainly useful to restore string mappings for keys that
1252	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1196	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1197	difficult to explain - basically, this action will send the string to the
		1198	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1199	action for it.
1253		1200
1254	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1201	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1255	info):	1202	selection when you press C<Shift-Insert>. With the following bindings, it
		1203	would instead emit the (undocumented, but what applications running in the
		1204	terminal might expect) sequence C<ESC [ 2 $> instead:
1256		1205
1257	URxvt.keysym.M-C-3: command:\033[8;25;80t	1206	URxvt.keysym.S-Insert: builtin-string:
1258	URxvt.keysym.M-C-4: command:\033[8;48;110t	1207	URxvt.keysym.C-S-Insert: builtin:
		1208
		1209	The first line disables the paste functionality for that key
		1210	combination, and the second reinstates the default behaviour for
		1211	C<Control-Shift-Insert>, which would otherwise be overridden.
		1212
		1213	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1214	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1215	this:
		1216
		1217	URxvt.keysym.C-M-c: builtin-string:
		1218	URxvt.keysym.C-M-v: builtin-string:
		1219
		1220	=item EXTENSION:STRING
		1221
		1222	An action of this form invokes the action B<STRING>, if any, provided
		1223	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1224	be loaded automatically if necessary.
		1225
		1226	Not all extensions define actions, but popular extensions that do
		1227	include the I<selection> and I<matcher> extensions (documented in their
		1228	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1229	respectively).
		1230
		1231	From the silly examples department, this will rot13-"encrypt"
		1232	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1233	keyboards:
		1234
		1235	URxvt.keysym.M-C-c: selection:rot13
		1236
		1237	=item perl:STRING DEPRECATED
		1238
		1239	This is a deprecated way of invoking commands provided by perl
		1240	extensions. It is still supported, but should not be used anymore.
		1241
		1242	=back
1259		1243
1260	=item B<perl-ext-common>: I<string>	1244	=item B<perl-ext-common>: I<string>
1261		1245
1262	=item B<perl-ext>: I<string>	1246	=item B<perl-ext>: I<string>
1263		1247
…		…
1265	use in this terminal instance; option B<-pe>.	1249	use in this terminal instance; option B<-pe>.
1266		1250
1267	Extension names can be prefixed with a C<-> sign to prohibit using	1251	Extension names can be prefixed with a C<-> sign to prohibit using
1268	them. This can be useful to selectively disable some extensions loaded	1252	them. This can be useful to selectively disable some extensions loaded
1269	by default, or specified via the C<perl-ext-common> resource. For	1253	by default, or specified via the C<perl-ext-common> resource. For
1270	example, C<default,-selection> will use all the default extension except	1254	example, C<default,-selection> will use all the default extensions except
1271	C<selection>.	1255	C<selection>.
1272		1256
1273	Extension names can also be followed by an argument in angle brackets	1257	The default set includes the C<selection>, C<option-popup>,
1274	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1258	C<selection-popup>, C<readline> and C<searchable-scrollback>
1275	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1259	extensions, and extensions which are mentioned in B<keysym> resources.
1276	multiple times with different arguments will pass multiple arguments to	1260
1277	the extension.	1261	Any extension such that a corresponding resource is given on the
		1262	command line is automatically appended to B<perl-ext>.
1278		1263
1279	Each extension is looked up in the library directories, loaded if	1264	Each extension is looked up in the library directories, loaded if
1280	necessary, and bound to the current terminal instance.	1265	necessary, and bound to the current terminal instance. When the library
		1266	search path contains multiple extension files of the same name, then the
		1267	first one found will be used.
1281		1268
1282	If both of these resources are the empty string, then the perl	1269	If both of these resources are the empty string, then the perl interpreter
1283	interpreter will not be initialized. The idea behind two options is that	1270	will not be initialized. The rationale for having two options is that
1284	B<perl-ext-common> will be used for extensions that should be available to	1271	B<perl-ext-common> will be used for extensions that should be available to
1285	all instances, while B<perl-ext> is used for specific instances.	1272	all instances, while B<perl-ext> is used for specific instances.
1286		1273
1287	=item B<perl-eval>: I<string>	1274	=item B<perl-eval>: I<string>
1288		1275
…		…
1306	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1293	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1307		1294
1308	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1295	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1309	for details.	1296	for details.
1310		1297
1311	=item B<searchable-scrollback:> I<keysym>	1298	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1312		1299
1313	Sets the hotkey that starts the incremental scrollback buffer search	1300	This resource is deprecated and will be removed. Use a B<keysym> resource
1314	(default: C<M-s>).	1301	instead, e.g.:
1315		1302
		1303	URxvt.keysym.M-s: searchable-scrollback:start
		1304
1316	=item B<urlLauncher>: I<string>	1305	=item B<url-launcher>: I<string>
1317		1306
1318	Specifies the program to be started with a URL argument. Used by the	1307	Specifies the program to be started with a URL argument. Used by the
1319	C<selection-popup> and C<matcher> perl extensions.	1308	C<selection-popup> and C<matcher> perl extensions.
1320		1309
1321	=item B<transient-for>: I<windowid>	1310	=item B<transient-for>: I<windowid>
…		…
1332	Turn on/off ISO 14755 (default enabled).	1321	Turn on/off ISO 14755 (default enabled).
1333		1322
1334	=item B<iso14755_52:> I<boolean>	1323	=item B<iso14755_52:> I<boolean>
1335		1324
1336	Turn on/off ISO 14755 5.2 mode (default enabled).	1325	Turn on/off ISO 14755 5.2 mode (default enabled).
		1326
		1327	=back
		1328
		1329	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
		1330
		1331	=over 4
		1332
		1333	=item B<-pixmap> I<file[;oplist]>
		1334
		1335	=item B<backgroundPixmap:> I<file[;oplist]>
		1336
		1337	Compile I<pixbuf>: Use the specified image file as the window's
		1338	background and also optionally specify a colon separated list of
		1339	operations to modify it. Note that you may need to quote the C<;>
		1340	character when using the command line option, as C<;> is usually a
		1341	metacharacter in shells. Supported operations are:
		1342
		1343	=over 4
		1344
		1345	=item B<WxH+X+Y>
		1346
		1347	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
		1348	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
		1349	scale of 0 disables scaling.
		1350
		1351	=item B<op=tile>
		1352
		1353	enables tiling
		1354
		1355	=item B<op=keep-aspect>
		1356
		1357	maintain the image aspect ratio when scaling
		1358
		1359	=item B<op=root-align>
		1360
		1361	use the position of the terminal window relative to the root window as
		1362	the image offset, simulating a root window background
		1363
		1364	=back
		1365
		1366	The default scale and position setting is C<100x100+50+50>.
		1367	Alternatively, a predefined set of templates can be used to achieve
		1368	the most common setups:
		1369
		1370	=over 4
		1371
		1372	=item B<style=tiled>
		1373
		1374	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
		1375
		1376	=item B<style=aspect-stretched>
		1377
		1378	the image is scaled to fill the whole window maintaining the aspect
		1379	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
		1380
		1381	=item B<style=stretched>
		1382
		1383	the image is scaled to fill the whole window. Equivalent to 100x100
		1384
		1385	=item B<style=centered>
		1386
		1387	the image is centered with no scaling. Equivalent to 0x0+50+50
		1388
		1389	=item B<style=root-tiled>
		1390
		1391	the image is tiled with no scaling and using 'root' positioning.
		1392	Equivalent to 0x0:op=tile:op=root-align
		1393
		1394	=back
		1395
		1396	If multiple templates are specified the last one wins. Note that a
		1397	template overrides all the scale, position and operations settings.
		1398
		1399	If used in conjunction with pseudo-transparency, the specified pixmap
		1400	will be blended over the transparent background using alpha-blending.
		1401
		1402	=item B<-tr>\|B<+tr>
		1403
		1404	=item B<transparent:> I<boolean>
		1405
		1406	Turn on/off pseudo-transparency by using the root pixmap as background.
		1407
		1408	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
		1409	will be removed in future versions.
		1410
		1411	=item B<-tint> I<colour>
		1412
		1413	=item B<tintColor:> I<colour>
		1414
		1415	Tint the transparent background with the given colour. Note that a
		1416	black tint yields a completely black image while a white tint yields
		1417	the image unchanged.
		1418
		1419	=item B<-sh> I<number>
		1420
		1421	=item B<shading:> I<number>
		1422
		1423	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
		1424	A value of 100 means no shading.
		1425
		1426	=item B<-blr> I<HxV>
		1427
		1428	=item B<blurRadius:> I<HxV>
		1429
		1430	Apply gaussian blur with the specified radius to the transparent
		1431	background. If a single number is specified, the vertical and
		1432	horizontal radii are considered to be the same. Setting one of the
		1433	radii to 1 and the other to a large number creates interesting effects
		1434	on some backgrounds. The maximum radius value is 128. An horizontal or
		1435	vertical radius of 0 disables blurring.
		1436
		1437	=item B<path:> I<path>
		1438
		1439	Specify the colon-delimited search path for finding background image files.
1337		1440
1338	=back	1441	=back
1339		1442
1340	=head1 THE SCROLLBAR	1443	=head1 THE SCROLLBAR
1341		1444
…		…
1389	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1492	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1390	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.	1493	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1391		1494
1392	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1495	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1393	inserted too.	1496	inserted too.
		1497
		1498	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1499	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1500	binding causes the value of the internal selection to be copied to the
		1501	CLIPBOARD selection, while the second binding causes the value of the
		1502	CLIPBOARD selection to be inserted.
1394		1503
1395	=back	1504	=back
1396		1505
1397	=head1 CHANGING FONTS	1506	=head1 CHANGING FONTS
1398		1507
…		…
1523	The following text gives values for the standard 88 colour mode (and	1632	The following text gives values for the standard 88 colour mode (and
1524	values for the 256 colour mode in parentheses).	1633	values for the 256 colour mode in parentheses).
1525		1634
1526	The RGB cube uses indices 16..79 (16..231) using the following formulas:	1635	The RGB cube uses indices 16..79 (16..231) using the following formulas:
1527		1636
1528	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3	1637	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1529	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15	1638	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1530		1639
1531	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%	1640	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1532	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of	1641	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1533	the RGB cube.	1642	the RGB cube.
1534		1643
…		…
1688		1797
1689	=back	1798	=back
1690		1799
1691	=head1 SEE ALSO	1800	=head1 SEE ALSO
1692		1801
1693	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1802	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
		1803	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1694		1804
1695	=head1 CURRENT PROJECT COORDINATOR	1805	=head1 CURRENT PROJECT COORDINATOR
1696		1806
1697	=over 4	1807	=over 4
1698		1808
1699	=item Project Coordinator	1809	=item Project Coordinator
1700		1810
1701	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1811	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1702		1812
1703	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1813	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1704		1814
1705	=back	1815	=back
1706		1816
…		…
1710		1820
1711	=item John Bovey	1821	=item John Bovey
1712		1822
1713	University of Kent, 1992, wrote the original Xvt.	1823	University of Kent, 1992, wrote the original Xvt.
1714		1824
1715	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1825	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1716		1826
1717	very heavily modified Xvt and came up with Rxvt	1827	very heavily modified Xvt and came up with Rxvt
1718		1828
1719	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1829	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1720		1830
1721	wrote the Greek Keyboard Input (no longer in code)	1831	wrote the Greek Keyboard Input (no longer in code)
1722		1832
1723	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1833	=item mj olesen <olesen@me.QueensU.CA>
1724		1834
1725	Wrote the menu system.	1835	Wrote the menu system.
1726		1836
1727	Project Coordinator (changes.txt 2.11 to 2.21)	1837	Project Coordinator (changes.txt 2.11 to 2.21)
1728		1838
1729	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1839	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1730		1840
1731	Project Coordinator (changes.txt 2.21a to 2.4.5)	1841	Project Coordinator (changes.txt 2.21a to 2.4.5)
1732		1842
1733	=item Geoff Wing L<< <gcw@pobox.com> >>	1843	=item Geoff Wing <gcw@pobox.com>
1734		1844
1735	Rewrote screen display and text selection routines.	1845	Rewrote screen display and text selection routines.
1736		1846
1737	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1847	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1738		1848
1739	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1849	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1740		1850
1741	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1851	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1742	extension, random hacks, numerous bugfixes and extensions.	1852	extension, random hacks, numerous bugfixes and extensions.
1743		1853
1744	Project Coordinator (Changes 1.0 -)	1854	Project Coordinator (Changes 1.0 -)
1745		1855
1746	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1856	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1747		1857
1748	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.	1858	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1749		1859
1750	=back	1860	=back
1751		1861

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.219 by root, Thu Jun 7 16:06:23 2012 UTC vs. Revision 1.244 by sf-exg, Tue Jun 16 11:58:26 2015 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.219 by root, Thu Jun 7 16:06:23 2012 UTC vs.
Revision 1.244 by sf-exg, Tue Jun 16 11:58:26 2015 UTC