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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.231 by root, Sat May 17 17:12:29 2014 UTC vs.
Revision 1.250 by root, Sat Oct 10 20:06:45 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
…		…
1056		1079
1057	The key combination that triggers the action, I<sym>, has the following format:	1080	The key combination that triggers the action, I<sym>, has the following format:
1058		1081
1059	(modifiers-)key	1082	(modifiers-)key
1060		1083
1061	Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,	1084	Where I<modifiers> can be any combination of the following full or
1062	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,	1085	abbreviated modifier names:
1063	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,	1086
1064	B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.	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> I<or> 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
1065		1103
1066	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
1067	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
1068	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
1069	current application keymap mode state.	1107	current application keymap mode state.
…		…
1085	As with any resource value, the I<action> string may contain backslash	1123	As with any resource value, the I<action> string may contain backslash
1086	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal	1124	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1087	number), see RESOURCES in C<man 7 X> for further details.	1125	number), see RESOURCES in C<man 7 X> for further details.
1088		1126
1089	An action starts with an action prefix that selects a certain type	1127	An action starts with an action prefix that selects a certain type
1090	of action, followed by a colon. An action strings without colons is	1128	of action, followed by a colon. An action string without colons is
1091	interpreted as a literal string to pass to the tty (as if they were	1129	interpreted as a literal string to pass to the tty (as if it was
1092	prefixed with C<string:>).	1130	prefixed with C<string:>).
1093		1131
1094	The following action prefixes are known - extensions can provide	1132	The following action prefixes are known - extensions can provide
1095	additional prefixes:	1133	additional prefixes:
1096		1134
…		…
1104	string C<echo rm -rf /> followed by a newline:	1142	string C<echo rm -rf /> followed by a newline:
1105		1143
1106	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n	1144	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1107		1145
1108	This could in theory be used to completely redefine your keymap.	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
		1151	the delimiter `/' should be a character not used by the strings.
		1152
		1153	Its usage can be demonstrated by an example:
		1154
		1155	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
		1156
		1157	The above line is equivalent to the following three lines:
		1158
		1159	URxvt.keysym.Meta-Control-0x61: string:\033<a>
		1160	URxvt.keysym.Meta-Control-0x62: string:\033<b>
		1161	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1109		1162
1110	=item command:STRING	1163	=item command:STRING
1111		1164
1112	If I<action> 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>
1113	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically	1166	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
…		…
1173		1226
1174	Similarly, to let applications gain access to the C<C-M-c> (copy to	1227	Similarly, to let applications gain access to the C<C-M-c> (copy to
1175	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do	1228	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1176	this:	1229	this:
1177		1230
1178	URxvt.keysym.C-S-c: builtin-string:	1231	URxvt.keysym.C-M-c: builtin-string:
1179	URxvt.keysym.C-S-v: builtin-string:	1232	URxvt.keysym.C-M-v: builtin-string:
1180		1233
1181	=item EXTENSION:STRING	1234	=item EXTENSION:STRING
1182		1235
1183	An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)	1236	An action of this form invokes the action B<STRING>, if any, provided
1184	extension of the same name. The extension will be loaded automatically if	1237	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1185	neccessary.	1238	be loaded automatically if necessary.
1186		1239
1187	Not all extensions define key actions, but popular extensions that do	1240	Not all extensions define actions, but popular extensions that do
1188	include the I<selection> and I<matcher> extensions (documented in their	1241	include the I<selection> and I<matcher> extensions (documented in their
1189	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),	1242	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1190	respectively).	1243	respectively).
1191		1244
1192	From the silly examples department, this will rot13-"encrypt"	1245	From the silly examples department, this will rot13-"encrypt"
…		…
1195		1248
1196	URxvt.keysym.M-C-c: selection:rot13	1249	URxvt.keysym.M-C-c: selection:rot13
1197		1250
1198	=item perl:STRING DEPRECATED	1251	=item perl:STRING DEPRECATED
1199		1252
1200	This is a deprecated way of passing key mappings to perl extensions. It is	1253	This is a deprecated way of invoking commands provided by perl
1201	still supported, but should not be used anymore.	1254	extensions. It is still supported, but should not be used anymore.
1202		1255
1203	=back	1256	=back
1204		1257
1205	=item B<perl-ext-common>: I<string>	1258	=item B<perl-ext-common>: I<string>
1206		1259
…		…
1210	use in this terminal instance; option B<-pe>.	1263	use in this terminal instance; option B<-pe>.
1211		1264
1212	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
1213	them. This can be useful to selectively disable some extensions loaded	1266	them. This can be useful to selectively disable some extensions loaded
1214	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
1215	example, C<default,-selection> will use all the default extension except	1268	example, C<default,-selection> will use all the default extensions except
1216	C<selection>.	1269	C<selection>.
1217		1270
1218	Some extensions define resources or command line switches, and will	1271	The default set includes the C<selection>, C<option-popup>,
1219	automatically be used when their resource or switch is specified.	1272	C<selection-popup>, C<readline> and C<searchable-scrollback>
		1273	extensions, and extensions which are mentioned in B<keysym> resources.
		1274
		1275	Any extension such that a corresponding resource is given on the
		1276	command line is automatically appended to B<perl-ext>.
1220		1277
1221	Each extension is looked up in the library directories, loaded if	1278	Each extension is looked up in the library directories, loaded if
1222	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.
1223		1282
1224	If both of these resources are the empty string, then the perl interpreter	1283	If both of these resources are the empty string, then the perl interpreter
1225	will not be initialized. The rationale for having two options is that	1284	will not be initialized. The rationale for having two options is that
1226	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
1227	all instances, while B<perl-ext> is used for specific instances.	1286	all instances, while B<perl-ext> is used for specific instances.
…		…
1276	Turn on/off ISO 14755 (default enabled).	1335	Turn on/off ISO 14755 (default enabled).
1277		1336
1278	=item B<iso14755_52:> I<boolean>	1337	=item B<iso14755_52:> I<boolean>
1279		1338
1280	Turn on/off ISO 14755 5.2 mode (default enabled).	1339	Turn on/off ISO 14755 5.2 mode (default enabled).
1281
1282	=back
1283
1284	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1285
1286	=over 4
1287
1288	=item B<-pixmap> I<file[;oplist]>
1289
1290	=item B<backgroundPixmap:> I<file[;oplist]>
1291
1292	Compile I<pixbuf>: Use the specified image file as the window's
1293	background and also optionally specify a colon separated list of
1294	operations to modify it. Note that you may need to quote the C<;>
1295	character when using the command line option, as C<;> is usually a
1296	metacharacter in shells. Supported operations are:
1297
1298	=over 4
1299
1300	=item B<WxH+X+Y>
1301
1302	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1303	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1304	scale of 0 disables scaling.
1305
1306	=item B<op=tile>
1307
1308	enables tiling
1309
1310	=item B<op=keep-aspect>
1311
1312	maintain the image aspect ratio when scaling
1313
1314	=item B<op=root-align>
1315
1316	use the position of the terminal window relative to the root window as
1317	the image offset, simulating a root window background
1318
1319	=back
1320
1321	The default scale and position setting is C<100x100+50+50>.
1322	Alternatively, a predefined set of templates can be used to achieve
1323	the most common setups:
1324
1325	=over 4
1326
1327	=item B<style=tiled>
1328
1329	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1330
1331	=item B<style=aspect-stretched>
1332
1333	the image is scaled to fill the whole window maintaining the aspect
1334	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1335
1336	=item B<style=stretched>
1337
1338	the image is scaled to fill the whole window. Equivalent to 100x100
1339
1340	=item B<style=centered>
1341
1342	the image is centered with no scaling. Equivalent to 0x0+50+50
1343
1344	=item B<style=root-tiled>
1345
1346	the image is tiled with no scaling and using 'root' positioning.
1347	Equivalent to 0x0:op=tile:op=root-align
1348
1349	=back
1350
1351	If multiple templates are specified the last one wins. Note that a
1352	template overrides all the scale, position and operations settings.
1353
1354	If used in conjunction with pseudo-transparency, the specified pixmap
1355	will be blended over the transparent background using alpha-blending.
1356
1357	=item B<-tr>\|B<+tr>
1358
1359	=item B<transparent:> I<boolean>
1360
1361	Turn on/off pseudo-transparency by using the root pixmap as background.
1362
1363	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1364	will be removed in future versions.
1365
1366	=item B<-tint> I<colour>
1367
1368	=item B<tintColor:> I<colour>
1369
1370	Tint the transparent background with the given colour. Note that a
1371	black tint yields a completely black image while a white tint yields
1372	the image unchanged.
1373
1374	=item B<-sh> I<number>
1375
1376	=item B<shading:> I<number>
1377
1378	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1379	A value of 100 means no shading.
1380
1381	=item B<-blr> I<HxV>
1382
1383	=item B<blurRadius:> I<HxV>
1384
1385	Apply gaussian blur with the specified radius to the transparent
1386	background. If a single number is specified, the vertical and
1387	horizontal radii are considered to be the same. Setting one of the
1388	radii to 1 and the other to a large number creates interesting effects
1389	on some backgrounds. The maximum radius value is 128. An horizontal or
1390	vertical radius of 0 disables blurring.
1391
1392	=item B<path:> I<path>
1393
1394	Specify the colon-delimited search path for finding background image files.
1395		1340
1396	=back	1341	=back
1397		1342
1398	=head1 THE SCROLLBAR	1343	=head1 THE SCROLLBAR
1399		1344
…		…
1551	In addition to the default foreground and background colours,	1496	In addition to the default foreground and background colours,
1552	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
1553	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
1554	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
1555	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.
1556		1510
1557	Here is a list of the ANSI colours with their names.	1511	Here is a list of the ANSI colours with their names.
1558		1512
1559	=begin table	1513	=begin table
1560		1514

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.231 by root, Sat May 17 17:12:29 2014 UTC vs. Revision 1.250 by root, Sat Oct 10 20:06:45 2020 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.231 by root, Sat May 17 17:12:29 2014 UTC vs.
Revision 1.250 by root, Sat Oct 10 20:06:45 2020 UTC