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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.225 by sf-exg, Wed Jun 5 07:58:17 2013 UTC vs.
Revision 1.249 by root, Sat Oct 10 20:03:39 2020 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
…		…
219		220
220	=item B<-ls>\|B<+ls>	221	=item B<-ls>\|B<+ls>
221		222
222	Start as a login-shell/sub-shell; resource B<loginShell>.	223	Start as a login-shell/sub-shell; resource B<loginShell>.
223		224
		225	=item B<-mc> I<milliseconds>
		226
		227	Specify the maximum time between multi-click selections.
		228
224	=item B<-ut>\|B<+ut>	229	=item B<-ut>\|B<+ut>
225		230
226	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	231	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
227	B<utmpInhibit>.	232	B<utmpInhibit>.
228		233
…		…
306		311
307	=item B<-override-redirect>	312	=item B<-override-redirect>
308		313
309	Compile I<frills>: Sets override-redirect on the window; resource	314	Compile I<frills>: Sets override-redirect on the window; resource
310	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.
311		321
312	=item B<-sbg>	322	=item B<-sbg>
313		323
314	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
315	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
…		…
369		379
370	=item B<-pt> I<style>	380	=item B<-pt> I<style>
371		381
372	Compile I<XIM>: input style for input method; B<OverTheSpot>,	382	Compile I<XIM>: input style for input method; B<OverTheSpot>,
373	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.
374		387
375	=item B<-im> I<text>	388	=item B<-im> I<text>
376		389
377	Compile I<XIM>: input method name. resource B<inputMethod>.	390	Compile I<XIM>: input method name. resource B<inputMethod>.
378		391
…		…
781		794
782	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
783	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
784	[default]; option B<+ls>.	797	[default]; option B<+ls>.
785		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
786	=item B<utmpInhibit:> I<boolean>	804	=item B<utmpInhibit:> I<boolean>
787		805
788	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>;
789	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>
790	[default]; option B<+ut>.	808	[default]; option B<+ut>.
…		…
853	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to	871	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
854	bottom when a non-special key is pressed; option B<+sk>.	872	bottom when a non-special key is pressed; option B<+sk>.
855		873
856	=item B<saveLines:> I<number>	874	=item B<saveLines:> I<number>
857		875
858	Save I<number> lines in the scrollback buffer [default 64]. This	876	Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
859	resource is limited on most machines to 65535; option B<-sl>.
860		877
861	=item B<internalBorder:> I<number>	878	=item B<internalBorder:> I<number>
862		879
863	Internal border of I<number> pixels. This resource is limited to 100;	880	Internal border of I<number> pixels. This resource is limited to 100;
864	option B<-b>.	881	option B<-b>.
…		…
927		944
928	=item B<pointerColor2:> I<colour>	945	=item B<pointerColor2:> I<colour>
929		946
930	Mouse pointer background colour.	947	Mouse pointer background colour.
931		948
		949	=item B<pointerShape:> I<string>
		950
		951	Compile I<frills>: Specifies the name of the mouse pointer shape
		952	[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
		953	file for possible values (omit the C<XC_> prefix).
		954
932	=item B<pointerBlankDelay:> I<number>	955	=item B<pointerBlankDelay:> I<number>
933		956
934	Specifies number of seconds before blanking the pointer [default 2]. Use a	957	Specifies number of seconds before blanking the pointer [default 2]. Use a
935	large number (e.g. C<987654321>) to effectively disable the timeout.	958	large number (e.g. C<987654321>) to effectively disable the timeout.
936		959
…		…
962		985
963	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>	986	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
964		987
965	=item B<preeditType:> I<style>	988	=item B<preeditType:> I<style>
966		989
967	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	990	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
968		991
969	=item B<inputMethod:> I<name>	992	=item B<inputMethod:> I<name>
970		993
971	I<name> of inputMethod to use; option B<-im>.	994	I<name> of inputMethod to use; option B<-im>.
972		995
…		…
1041	Sets the working directory for the shell (or the command specified via	1064	Sets the working directory for the shell (or the command specified via
1042	B<-e>). The I<path> must be an absolute path and it must exist for	1065	B<-e>). The I<path> must be an absolute path and it must exist for
1043	@@RXVT_NAME@@ to start. If it isn't specified then the current working	1066	@@RXVT_NAME@@ to start. If it isn't specified then the current working
1044	directory will be used; option B<-cd>.	1067	directory will be used; option B<-cd>.
1045		1068
1046	=item B<keysym.>I<sym>: I<string>	1069	=item B<keysym.>I<sym>: I<action>
1047		1070
1048	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1071	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1049	intervening resource name B<keysym.> cannot be omitted.	1072	resource name B<keysym.> cannot be omitted.
1050		1073
1051	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1074	Using this resource, you can map key combinations such as
1052	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1075	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1053	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,	1076	string than would normally result from that combination, making the
1054	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,	1077	terminal scroll up or down the way you want it, or any other thing an
1055	B<2>, B<3>, B<4>, B<5>.	1078	extension might provide.
		1079
		1080	The key combination that triggers the action, I<sym>, has the following format:
		1081
		1082	(modifiers-)key
		1083
		1084	Where I<modifiers> can be any combination of the following full or
		1085	abbreviated modifier names:
		1086
		1087	=begin table
		1088
		1089	B<ISOLevel3> B<I>
		1090	B<AppKeypad> B<K>
		1091	B<Control> B<C>
		1092	B<NumLock> B<N>
		1093	B<Shift> B<S>
		1094	B<Meta> B<M>, B<A>
		1095	B<Lock> B<L>
		1096	B<Mod1> B<1>
		1097	B<Mod2> B<2>
		1098	B<Mod3> B<3>
		1099	B<Mod4> B<4>
		1100	B<Mod5> B<5>
		1101
		1102	=end table
1056		1103
1057	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1104	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1058	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1105	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1059	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1106	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1060	current application keymap mode state.	1107	current application keymap mode state.
1061		1108
1062	The spellings of I<key> can be obtained by using B<xev>(1) command or	1109	Due the the large number of modifier combinations, a key mapping will
1063	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1110	match if I<at least> the specified identifiers are being set, and no other
		1111	key mappings with those and more bits are being defined. That means that
		1112	defining a mapping for C<a> will automatically provide definitions for
		1113	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1114	themselves. See the C<builtin:> action, below, for a way to work around
		1115	this when this is a problem.
		1116
		1117	The spelling of I<key> depends on your implementation of X. An easy way to
		1118	find a key name is to use the B<xev>(1) command. You can find a list by
		1119	looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1064	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1120	the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1065	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1121	value (B<0x0000 - 0xFFFF>).
1066	performed in an exact manner; however, the closest match is assured.
1067		1122
1068	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1123	As with any resource value, the I<action> string may contain backslash
		1124	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1069	number), see RESOURCES in C<man 7 X> for further details.	1125	number), see RESOURCES in C<man 7 X> for further details.
1070		1126
1071	You can define a range of keysyms in one shot by	1127	An action starts with an action prefix that selects a certain type
1072	loading the C<keysym-list> perl extension and providing a I<string>	1128	of action, followed by a colon. An action string without colons is
1073	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1129	interpreted as a literal string to pass to the tty (as if it was
		1130	prefixed with C<string:>).
		1131
		1132	The following action prefixes are known - extensions can provide
		1133	additional prefixes:
		1134
		1135	=over 4
		1136
		1137	=item string:STRING
		1138
		1139	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1140	then the remaining C<STRING> will be passed to the program running in the
		1141	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1142	string C<echo rm -rf /> followed by a newline:
		1143
		1144	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
		1145
		1146	This could in theory be used to completely redefine your keymap.
		1147
		1148	In addition, for actions of this type, you can define a range of
		1149	keysyms in one shot by loading the C<keysym-list> perl extension and
		1150	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1074	should be a character not used by the strings.	1151	the delimiter `/' should be a character not used by the strings.
1075		1152
1076	Its usage can be demonstrated by an example:	1153	Its usage can be demonstrated by an example:
1077		1154
1078	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>	1155	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1079		1156
1080	The above line is equivalent to the following three lines:	1157	The above line is equivalent to the following three lines:
1081		1158
1082	URxvt.keysym.Meta-Control-0x61: \033<a>	1159	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1083	URxvt.keysym.Meta-Control-0x62: \033<b>	1160	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1084	URxvt.keysym.Meta-Control-0x63: \033<c>	1161	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1085		1162
		1163	=item command:STRING
		1164
1086	If I<string> takes the form of C<command:STRING>, the specified B<STRING>	1165	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1087	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1166	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1167	the opposite of C<string:> - instead of sending it to the program running
		1168	in the terminal, it will be treated as if it were program output). This is
		1169	most useful to feed command sequences into @@RXVT_NAME@@.
		1170
1088	example the following means "change the current locale to C<zh_CN.GBK>	1171	For example the following means "change the current locale to C<zh_CN.GBK>
1089	when Control-Meta-c is being pressed":	1172	when Control-Meta-c is being pressed":
1090		1173
1091	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1174	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1092		1175
1093	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1176	The following example will map Control-Meta-1 and Control-Meta-2 to
1094	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)	1177	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1095	manpage. For example, the F<selection> extension (activated via	1178	font-switching at runtime:
1096	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1097		1179
1098	URxvt.keysym.M-C-c: perl:selection:rot13	1180	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1181	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1099		1182
1100	Due the the large number of modifier combinations, a defined key mapping	1183	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1101	will match if I<at least> the specified identifiers are being set, and	1184	info):
1102	no other key mappings with those and more bits are being defined. That
1103	means that defining a key map for C<a> will automatically provide
1104	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1105	mappings themselves.
1106		1185
1107	Unfortunately, this will override built-in key mappings. For example	1186	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1187	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1188
		1189	=item builtin:
		1190
		1191	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1192	key binding existed for the key combination. The obvious use is to undo
		1193	the effect of existing bindings. The not so obvious use is to reinstate
		1194	bindings when another binding overrides too many modifiers.
		1195
1108	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1196	For example if you overwrite the C<Insert> key you will disable
1109	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the	1197	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1110	user-defined keymap using the C<builtin:> replacement:	1198	"holes" into the user-defined keymap using the C<builtin:> replacement:
1111		1199
1112	URxvt.keysym.Insert: <my insert key sequence>	1200	URxvt.keysym.Insert: <my insert key sequence>
1113	URxvt.keysym.S-Insert: builtin:	1201	URxvt.keysym.S-Insert: builtin:
1114		1202
1115	The first line defines a mapping for C<Insert> and I<any> combination	1203	The first line defines a mapping for C<Insert> and I<any> combination
1116	of modifiers. The second line re-establishes the default mapping for	1204	of modifiers. The second line re-establishes the default mapping for
1117	C<Shift-Insert>.	1205	C<Shift-Insert>.
1118		1206
1119	The following example will map Control-Meta-1 and Control-Meta-2 to	1207	=item builtin-string:
1120	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1121	font-switching at runtime:
1122		1208
1123	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1209	This action is mainly useful to restore string mappings for keys that
1124	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1210	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1211	difficult to explain - basically, this action will send the string to the
		1212	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1213	action for it.
1125		1214
1126	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1215	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1127	info):	1216	selection when you press C<Shift-Insert>. With the following bindings, it
		1217	would instead emit the (undocumented, but what applications running in the
		1218	terminal might expect) sequence C<ESC [ 2 $> instead:
1128		1219
1129	URxvt.keysym.M-C-3: command:\033[8;25;80t	1220	URxvt.keysym.S-Insert: builtin-string:
1130	URxvt.keysym.M-C-4: command:\033[8;48;110t	1221	URxvt.keysym.C-S-Insert: builtin:
		1222
		1223	The first line disables the paste functionality for that key
		1224	combination, and the second reinstates the default behaviour for
		1225	C<Control-Shift-Insert>, which would otherwise be overridden.
		1226
		1227	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1228	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1229	this:
		1230
		1231	URxvt.keysym.C-M-c: builtin-string:
		1232	URxvt.keysym.C-M-v: builtin-string:
		1233
		1234	=item EXTENSION:STRING
		1235
		1236	An action of this form invokes the action B<STRING>, if any, provided
		1237	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1238	be loaded automatically if necessary.
		1239
		1240	Not all extensions define actions, but popular extensions that do
		1241	include the I<selection> and I<matcher> extensions (documented in their
		1242	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1243	respectively).
		1244
		1245	From the silly examples department, this will rot13-"encrypt"
		1246	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1247	keyboards:
		1248
		1249	URxvt.keysym.M-C-c: selection:rot13
		1250
		1251	=item perl:STRING DEPRECATED
		1252
		1253	This is a deprecated way of invoking commands provided by perl
		1254	extensions. It is still supported, but should not be used anymore.
		1255
		1256	=back
1131		1257
1132	=item B<perl-ext-common>: I<string>	1258	=item B<perl-ext-common>: I<string>
1133		1259
1134	=item B<perl-ext>: I<string>	1260	=item B<perl-ext>: I<string>
1135		1261
…		…
1137	use in this terminal instance; option B<-pe>.	1263	use in this terminal instance; option B<-pe>.
1138		1264
1139	Extension names can be prefixed with a C<-> sign to prohibit using	1265	Extension names can be prefixed with a C<-> sign to prohibit using
1140	them. This can be useful to selectively disable some extensions loaded	1266	them. This can be useful to selectively disable some extensions loaded
1141	by default, or specified via the C<perl-ext-common> resource. For	1267	by default, or specified via the C<perl-ext-common> resource. For
1142	example, C<default,-selection> will use all the default extension except	1268	example, C<default,-selection> will use all the default extensions except
1143	C<selection>.	1269	C<selection>.
1144		1270
1145	Extension names can also be followed by an argument in angle brackets	1271	The default set includes the C<selection>, C<option-popup>,
1146	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1272	C<selection-popup>, C<readline> and C<searchable-scrollback>
1147	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1273	extensions, and extensions which are mentioned in B<keysym> resources.
1148	multiple times with different arguments will pass multiple arguments to	1274
1149	the extension.	1275	Any extension such that a corresponding resource is given on the
		1276	command line is automatically appended to B<perl-ext>.
1150		1277
1151	Each extension is looked up in the library directories, loaded if	1278	Each extension is looked up in the library directories, loaded if
1152	necessary, and bound to the current terminal instance.	1279	necessary, and bound to the current terminal instance. When the library
		1280	search path contains multiple extension files of the same name, then the
		1281	first one found will be used.
1153		1282
1154	If both of these resources are the empty string, then the perl	1283	If both of these resources are the empty string, then the perl interpreter
1155	interpreter will not be initialized. The idea behind two options is that	1284	will not be initialized. The rationale for having two options is that
1156	B<perl-ext-common> will be used for extensions that should be available to	1285	B<perl-ext-common> will be used for extensions that should be available to
1157	all instances, while B<perl-ext> is used for specific instances.	1286	all instances, while B<perl-ext> is used for specific instances.
1158		1287
1159	=item B<perl-eval>: I<string>	1288	=item B<perl-eval>: I<string>
1160		1289
…		…
1178	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1307	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1179		1308
1180	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1309	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1181	for details.	1310	for details.
1182		1311
1183	=item B<searchable-scrollback:> I<keysym>	1312	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1184		1313
1185	Sets the hotkey that starts the incremental scrollback buffer search	1314	This resource is deprecated and will be removed. Use a B<keysym> resource
1186	(default: C<M-s>).	1315	instead, e.g.:
		1316
		1317	URxvt.keysym.M-s: searchable-scrollback:start
1187		1318
1188	=item B<url-launcher>: I<string>	1319	=item B<url-launcher>: I<string>
1189		1320
1190	Specifies the program to be started with a URL argument. Used by the	1321	Specifies the program to be started with a URL argument. Used by the
1191	C<selection-popup> and C<matcher> perl extensions.	1322	C<selection-popup> and C<matcher> perl extensions.
…		…
1204	Turn on/off ISO 14755 (default enabled).	1335	Turn on/off ISO 14755 (default enabled).
1205		1336
1206	=item B<iso14755_52:> I<boolean>	1337	=item B<iso14755_52:> I<boolean>
1207		1338
1208	Turn on/off ISO 14755 5.2 mode (default enabled).	1339	Turn on/off ISO 14755 5.2 mode (default enabled).
1209
1210	=back
1211
1212	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1213
1214	=over 4
1215
1216	=item B<-pixmap> I<file[;oplist]>
1217
1218	=item B<backgroundPixmap:> I<file[;oplist]>
1219
1220	Compile I<pixbuf>: Use the specified image file as the window's
1221	background and also optionally specify a colon separated list of
1222	operations to modify it. Note that you may need to quote the C<;>
1223	character when using the command line option, as C<;> is usually a
1224	metacharacter in shells. Supported operations are:
1225
1226	=over 4
1227
1228	=item B<WxH+X+Y>
1229
1230	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1231	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1232	scale of 0 disables scaling.
1233
1234	=item B<op=tile>
1235
1236	enables tiling
1237
1238	=item B<op=keep-aspect>
1239
1240	maintain the image aspect ratio when scaling
1241
1242	=item B<op=root-align>
1243
1244	use the position of the terminal window relative to the root window as
1245	the image offset, simulating a root window background
1246
1247	=back
1248
1249	The default scale and position setting is C<100x100+50+50>.
1250	Alternatively, a predefined set of templates can be used to achieve
1251	the most common setups:
1252
1253	=over 4
1254
1255	=item B<style=tiled>
1256
1257	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1258
1259	=item B<style=aspect-stretched>
1260
1261	the image is scaled to fill the whole window maintaining the aspect
1262	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1263
1264	=item B<style=stretched>
1265
1266	the image is scaled to fill the whole window. Equivalent to 100x100
1267
1268	=item B<style=centered>
1269
1270	the image is centered with no scaling. Equivalent to 0x0+50+50
1271
1272	=item B<style=root-tiled>
1273
1274	the image is tiled with no scaling and using 'root' positioning.
1275	Equivalent to 0x0:op=tile:op=root-align
1276
1277	=back
1278
1279	If multiple templates are specified the last one wins. Note that a
1280	template overrides all the scale, position and operations settings.
1281
1282	If used in conjunction with pseudo-transparency, the specified pixmap
1283	will be blended over the transparent background using alpha-blending.
1284
1285	=item B<-tr>\|B<+tr>
1286
1287	=item B<transparent:> I<boolean>
1288
1289	Turn on/off pseudo-transparency by using the root pixmap as background.
1290
1291	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1292	will be removed in future versions.
1293
1294	=item B<-tint> I<colour>
1295
1296	=item B<tintColor:> I<colour>
1297
1298	Tint the transparent background with the given colour. Note that a
1299	black tint yields a completely black image while a white tint yields
1300	the image unchanged.
1301
1302	=item B<-sh> I<number>
1303
1304	=item B<shading:> I<number>
1305
1306	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1307	A value of 100 means no shading.
1308
1309	=item B<-blr> I<HxV>
1310
1311	=item B<blurRadius:> I<HxV>
1312
1313	Apply gaussian blur with the specified radius to the transparent
1314	background. If a single number is specified, the vertical and
1315	horizontal radii are considered to be the same. Setting one of the
1316	radii to 1 and the other to a large number creates interesting effects
1317	on some backgrounds. The maximum radius value is 128. An horizontal or
1318	vertical radius of 0 disables blurring.
1319
1320	=item B<path:> I<path>
1321
1322	Specify the colon-delimited search path for finding background image files.
1323		1340
1324	=back	1341	=back
1325		1342
1326	=head1 THE SCROLLBAR	1343	=head1 THE SCROLLBAR
1327		1344
…		…
1375	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1392	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1376	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.	1393	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1377		1394
1378	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1395	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1379	inserted too.	1396	inserted too.
		1397
		1398	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1399	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1400	binding causes the value of the internal selection to be copied to the
		1401	CLIPBOARD selection, while the second binding causes the value of the
		1402	CLIPBOARD selection to be inserted.
1380		1403
1381	=back	1404	=back
1382		1405
1383	=head1 CHANGING FONTS	1406	=head1 CHANGING FONTS
1384		1407
…		…
1473	In addition to the default foreground and background colours,	1496	In addition to the default foreground and background colours,
1474	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus	1497	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1475	high-intensity (potentially bold/blink) versions of the same, and 72 (or	1498	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1476	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB	1499	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1477	cube plus a 8 (24) colour greyscale ramp.	1500	cube plus a 8 (24) colour greyscale ramp.
		1501
		1502	B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
		1503	C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
		1504	number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
		1505	colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
		1506	24-bit colour space. When indexing collisions happen, the nearest old colour in
		1507	the cube will be adapted to the new 24-bit RGB colour. That means one cannot
		1508	use many similar 24-bit colours. It's typically not a problem in common
		1509	scenarios.
1478		1510
1479	Here is a list of the ANSI colours with their names.	1511	Here is a list of the ANSI colours with their names.
1480		1512
1481	=begin table	1513	=begin table
1482		1514
…		…
1509	The following text gives values for the standard 88 colour mode (and	1541	The following text gives values for the standard 88 colour mode (and
1510	values for the 256 colour mode in parentheses).	1542	values for the 256 colour mode in parentheses).
1511		1543
1512	The RGB cube uses indices 16..79 (16..231) using the following formulas:	1544	The RGB cube uses indices 16..79 (16..231) using the following formulas:
1513		1545
1514	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3	1546	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1515	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15	1547	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1516		1548
1517	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%	1549	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1518	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of	1550	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1519	the RGB cube.	1551	the RGB cube.
1520		1552

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.225 by sf-exg, Wed Jun 5 07:58:17 2013 UTC vs. Revision 1.249 by root, Sat Oct 10 20:03:39 2020 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.225 by sf-exg, Wed Jun 5 07:58:17 2013 UTC vs.
Revision 1.249 by root, Sat Oct 10 20:03:39 2020 UTC