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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.235 by mikachu, Tue Jul 29 13:50:05 2014 UTC vs.
Revision 1.251 by root, Sat Jul 3 04:04:12 2021 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
…		…
218	`.' or `*' characters. Also sets the icon and title name.	219	`.' or `*' characters. Also sets the icon and title name.
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>.
		224
		225	=item B<-mc> I<milliseconds>
		226
		227	Specify the maximum time between multi-click selections.
223		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>.
…		…
375	=item B<-pt> I<style>	380	=item B<-pt> I<style>
376		381
377	Compile I<XIM>: input style for input method; B<OverTheSpot>,	382	Compile I<XIM>: input style for input method; B<OverTheSpot>,
378	B<OffTheSpot>, B<Root>; resource B<preeditType>.	383	B<OffTheSpot>, B<Root>; resource B<preeditType>.
379		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.
		387
380	=item B<-im> I<text>	388	=item B<-im> I<text>
381		389
382	Compile I<XIM>: input method name. resource B<inputMethod>.	390	Compile I<XIM>: input method name. resource B<inputMethod>.
383		391
384	=item B<-imlocale> I<string>	392	=item B<-imlocale> I<string>
…		…
398	Change the meaning of triple-click selection with the left mouse	406	Change the meaning of triple-click selection with the left mouse
399	button. Only effective when the original (non-perl) selection code is	407	button. Only effective when the original (non-perl) selection code is
400	in-use. Instead of selecting a full line it will extend the selection to	408	in-use. Instead of selecting a full line it will extend the selection to
401	the end of the logical line only. resource B<tripleclickwords>.	409	the end of the logical line only. resource B<tripleclickwords>.
402		410
		411	=item B<-dpb>\|B<+dpb>
		412
		413	Compile frills: Disables (or enabled) emitting bracketed paste mode
		414	sequences (default enabled). Bracketed paste mode allows programs
		415	to detect when something is pasted. Since more and more programs
		416	abuse this, these sequences can be disabled. The command sequences to
		417	enable and query paste mode will still work, but the actual bracket
		418	sequences will no longer be omitted. You can also toggle this from the
		419	ctrl-middle-mouse-button menu; resource B<disablePAsteBrackets>.
		420
403	=item B<-insecure>	421	=item B<-insecure>
404		422
405	Enable "insecure" mode, which currently enables most of the escape	423	Enable "insecure" mode, which currently enables most of the escape
406	sequences that echo strings. See the resource B<insecure> for more	424	sequences that echo strings. See the resource B<insecure> for more
407	info.	425	info.
…		…
419		437
420	=item B<-ssr>\|B<+ssr>	438	=item B<-ssr>\|B<+ssr>
421		439
422	Turn on/off secondary screen scroll (default enabled); resource	440	Turn on/off secondary screen scroll (default enabled); resource
423	B<secondaryScroll>.	441	B<secondaryScroll>.
		442
		443	=item B<-rm> I<mode>
		444
		445	Compile I<frills>: Sets long line rewrapping behaviour on window resizes
		446	to one of B<auto> (the default), B<always> or B<never>. The latter two
		447	modes do the obvious, B<auto> rewraps (acts like B<always>) if scrollback
		448	is non-empty, and wings lines (acts like B<never>) otherwise; resource
		449	B<rewrapMode>.
424		450
425	=item B<-hold>\|B<+hold>	451	=item B<-hold>\|B<+hold>
426		452
427	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@	453	Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
428	will not immediately destroy its window when the program executed within	454	will not immediately destroy its window when the program executed within
…		…
786		812
787	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of	813	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
788	the shell; option B<-ls>. B<False>: start as a normal sub-shell	814	the shell; option B<-ls>. B<False>: start as a normal sub-shell
789	[default]; option B<+ls>.	815	[default]; option B<+ls>.
790		816
		817	=item B<multiClickTime:> I<number>
		818
		819	Specify the maximum time in milliseconds between multi-click select
		820	events. The default is 500 milliseconds; option B<-mc>.
		821
791	=item B<utmpInhibit:> I<boolean>	822	=item B<utmpInhibit:> I<boolean>
792		823
793	B<True>: inhibit writing record into the system log file B<utmp>;	824	B<True>: inhibit writing record into the system log file B<utmp>;
794	option B<-ut>. B<False>: write record into the system log file B<utmp>	825	option B<-ut>. B<False>: write record into the system log file B<utmp>
795	[default]; option B<+ut>.	826	[default]; option B<+ut>.
…		…
858	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to	889	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
859	bottom when a non-special key is pressed; option B<+sk>.	890	bottom when a non-special key is pressed; option B<+sk>.
860		891
861	=item B<saveLines:> I<number>	892	=item B<saveLines:> I<number>
862		893
863	Save I<number> lines in the scrollback buffer [default 64]. This	894	Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
864	resource is limited on most machines to 65535; option B<-sl>.
865		895
866	=item B<internalBorder:> I<number>	896	=item B<internalBorder:> I<number>
867		897
868	Internal border of I<number> pixels. This resource is limited to 100;	898	Internal border of I<number> pixels. This resource is limited to 100;
869	option B<-b>.	899	option B<-b>.
…		…
932		962
933	=item B<pointerColor2:> I<colour>	963	=item B<pointerColor2:> I<colour>
934		964
935	Mouse pointer background colour.	965	Mouse pointer background colour.
936		966
		967	=item B<pointerShape:> I<string>
		968
		969	Compile I<frills>: Specifies the name of the mouse pointer shape
		970	[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
		971	file for possible values (omit the C<XC_> prefix).
		972
937	=item B<pointerBlankDelay:> I<number>	973	=item B<pointerBlankDelay:> I<number>
938		974
939	Specifies number of seconds before blanking the pointer [default 2]. Use a	975	Specifies number of seconds before blanking the pointer [default 2]. Use a
940	large number (e.g. C<987654321>) to effectively disable the timeout.	976	large number (e.g. C<987654321>) to effectively disable the timeout.
941		977
…		…
967		1003
968	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>	1004	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
969		1005
970	=item B<preeditType:> I<style>	1006	=item B<preeditType:> I<style>
971		1007
972	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1008	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
973		1009
974	=item B<inputMethod:> I<name>	1010	=item B<inputMethod:> I<name>
975		1011
976	I<name> of inputMethod to use; option B<-im>.	1012	I<name> of inputMethod to use; option B<-im>.
977		1013
…		…
994	=item B<tripleclickwords:> I<boolean>	1030	=item B<tripleclickwords:> I<boolean>
995		1031
996	Change the meaning of triple-click selection with the left mouse	1032	Change the meaning of triple-click selection with the left mouse
997	button. Instead of selecting a full line it will extend the selection to	1033	button. Instead of selecting a full line it will extend the selection to
998	the end of the logical line only; option B<-tcw>.	1034	the end of the logical line only; option B<-tcw>.
		1035
		1036	=item B<disablePasteBrackets:> I<boolean>
		1037
		1038	Prevents emission of paste bracket sequences; option B<-dpb>.
999		1039
1000	=item B<insecure:> I<boolean>	1040	=item B<insecure:> I<boolean>
1001		1041
1002	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1042	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
1003	echo arbitrary strings like the icon name or the locale. This could be	1043	echo arbitrary strings like the icon name or the locale. This could be
…		…
1025		1065
1026	=item B<secondaryScreen:> I<boolean>	1066	=item B<secondaryScreen:> I<boolean>
1027		1067
1028	Turn on/off secondary screen (default enabled).	1068	Turn on/off secondary screen (default enabled).
1029		1069
		1070	=item B<rewrapMode:> I<mode>
		1071
		1072	Sets long line rewrap behaviour on window resize to one of B<auto>
		1073	(default), B<always> or B<never>.
		1074
1030	=item B<secondaryScroll:> I<boolean>	1075	=item B<secondaryScroll:> I<boolean>
1031		1076
1032	Turn on/off secondary screen scroll (default enabled). If this	1077	Turn on/off secondary screen scroll (default enabled). If this
1033	option is enabled, scrolls on the secondary screen will change the	1078	option is enabled, scrolls on the secondary screen will change the
1034	scrollback buffer and, when secondaryScreen is off, switching	1079	scrollback buffer and, when secondaryScreen is off, switching
…		…
1061		1106
1062	The key combination that triggers the action, I<sym>, has the following format:	1107	The key combination that triggers the action, I<sym>, has the following format:
1063		1108
1064	(modifiers-)key	1109	(modifiers-)key
1065		1110
1066	Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,	1111	Where I<modifiers> can be any combination of the following full or
1067	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,	1112	abbreviated modifier names:
1068	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,	1113
1069	B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.	1114	=begin table
		1115
		1116	B<ISOLevel3> B<I>
		1117	B<AppKeypad> B<K>
		1118	B<Control> B<C>
		1119	B<NumLock> B<N>
		1120	B<Shift> B<S>
		1121	B<Meta> B<M> I<or> B<A>
		1122	B<Lock> B<L>
		1123	B<Mod1> B<1>
		1124	B<Mod2> B<2>
		1125	B<Mod3> B<3>
		1126	B<Mod4> B<4>
		1127	B<Mod5> B<5>
		1128
		1129	=end table
1070		1130
1071	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1131	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1072	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr	1132	whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1073	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the	1133	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1074	current application keymap mode state.	1134	current application keymap mode state.
…		…
1110		1170
1111	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n	1171	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1112		1172
1113	This could in theory be used to completely redefine your keymap.	1173	This could in theory be used to completely redefine your keymap.
1114		1174
		1175	In addition, for actions of this type, you can define a range of
		1176	keysyms in one shot by loading the C<keysym-list> perl extension and
		1177	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
		1178	the delimiter `/' should be a character not used by the strings.
		1179
		1180	Its usage can be demonstrated by an example:
		1181
		1182	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
		1183
		1184	The above line is equivalent to the following three lines:
		1185
		1186	URxvt.keysym.Meta-Control-0x61: string:\033<a>
		1187	URxvt.keysym.Meta-Control-0x62: string:\033<b>
		1188	URxvt.keysym.Meta-Control-0x63: string:\033<c>
		1189
1115	=item command:STRING	1190	=item command:STRING
1116		1191
1117	If I<action> takes the form of C<command:STRING>, the specified B<STRING>	1192	If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1118	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically	1193	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1119	the opposite of C<string:> - instead of sending it to the program running	1194	the opposite of C<string:> - instead of sending it to the program running
…		…
1178		1253
1179	Similarly, to let applications gain access to the C<C-M-c> (copy to	1254	Similarly, to let applications gain access to the C<C-M-c> (copy to
1180	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do	1255	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1181	this:	1256	this:
1182		1257
1183	URxvt.keysym.C-S-c: builtin-string:	1258	URxvt.keysym.C-M-c: builtin-string:
1184	URxvt.keysym.C-S-v: builtin-string:	1259	URxvt.keysym.C-M-v: builtin-string:
1185		1260
1186	=item EXTENSION:STRING	1261	=item EXTENSION:STRING
1187		1262
1188	An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)	1263	An action of this form invokes the action B<STRING>, if any, provided
1189	extension of the same name. The extension will be loaded automatically if	1264	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1190	necessary.	1265	be loaded automatically if necessary.
1191		1266
1192	Not all extensions define key actions, but popular extensions that do	1267	Not all extensions define actions, but popular extensions that do
1193	include the I<selection> and I<matcher> extensions (documented in their	1268	include the I<selection> and I<matcher> extensions (documented in their
1194	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),	1269	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1195	respectively).	1270	respectively).
1196		1271
1197	From the silly examples department, this will rot13-"encrypt"	1272	From the silly examples department, this will rot13-"encrypt"
…		…
1200		1275
1201	URxvt.keysym.M-C-c: selection:rot13	1276	URxvt.keysym.M-C-c: selection:rot13
1202		1277
1203	=item perl:STRING DEPRECATED	1278	=item perl:STRING DEPRECATED
1204		1279
1205	This is a deprecated way of passing key mappings to perl extensions. It is	1280	This is a deprecated way of invoking commands provided by perl
1206	still supported, but should not be used anymore.	1281	extensions. It is still supported, but should not be used anymore.
1207		1282
1208	=back	1283	=back
1209		1284
1210	=item B<perl-ext-common>: I<string>	1285	=item B<perl-ext-common>: I<string>
1211		1286
…		…
1219	by default, or specified via the C<perl-ext-common> resource. For	1294	by default, or specified via the C<perl-ext-common> resource. For
1220	example, C<default,-selection> will use all the default extensions except	1295	example, C<default,-selection> will use all the default extensions except
1221	C<selection>.	1296	C<selection>.
1222		1297
1223	The default set includes the C<selection>, C<option-popup>,	1298	The default set includes the C<selection>, C<option-popup>,
1224	C<selection-popup> and C<readline> extensions, any extensions that define	1299	C<selection-popup>, C<readline> and C<searchable-scrollback>
1225	keybindings via C<BINDING> meta comments, extensions loaded because	1300	extensions, and extensions which are mentioned in B<keysym> resources.
1226	their resources/commandline switches were used, and extensions which are	1301
1227	mentioned in B<keysym> resources.	1302	Any extension such that a corresponding resource is given on the
		1303	command line is automatically appended to B<perl-ext>.
1228		1304
1229	Each extension is looked up in the library directories, loaded if	1305	Each extension is looked up in the library directories, loaded if
1230	necessary, and bound to the current terminal instance. When the library	1306	necessary, and bound to the current terminal instance. When the library
1231	search path contains multiple extension files of the same name, then the	1307	search path contains multiple extension files of the same name, then the
1232	first one found will be used.	1308	first one found will be used.
…		…
1286	Turn on/off ISO 14755 (default enabled).	1362	Turn on/off ISO 14755 (default enabled).
1287		1363
1288	=item B<iso14755_52:> I<boolean>	1364	=item B<iso14755_52:> I<boolean>
1289		1365
1290	Turn on/off ISO 14755 5.2 mode (default enabled).	1366	Turn on/off ISO 14755 5.2 mode (default enabled).
1291
1292	=back
1293
1294	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1295
1296	=over 4
1297
1298	=item B<-pixmap> I<file[;oplist]>
1299
1300	=item B<backgroundPixmap:> I<file[;oplist]>
1301
1302	Compile I<pixbuf>: Use the specified image file as the window's
1303	background and also optionally specify a colon separated list of
1304	operations to modify it. Note that you may need to quote the C<;>
1305	character when using the command line option, as C<;> is usually a
1306	metacharacter in shells. Supported operations are:
1307
1308	=over 4
1309
1310	=item B<WxH+X+Y>
1311
1312	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1313	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1314	scale of 0 disables scaling.
1315
1316	=item B<op=tile>
1317
1318	enables tiling
1319
1320	=item B<op=keep-aspect>
1321
1322	maintain the image aspect ratio when scaling
1323
1324	=item B<op=root-align>
1325
1326	use the position of the terminal window relative to the root window as
1327	the image offset, simulating a root window background
1328
1329	=back
1330
1331	The default scale and position setting is C<100x100+50+50>.
1332	Alternatively, a predefined set of templates can be used to achieve
1333	the most common setups:
1334
1335	=over 4
1336
1337	=item B<style=tiled>
1338
1339	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1340
1341	=item B<style=aspect-stretched>
1342
1343	the image is scaled to fill the whole window maintaining the aspect
1344	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1345
1346	=item B<style=stretched>
1347
1348	the image is scaled to fill the whole window. Equivalent to 100x100
1349
1350	=item B<style=centered>
1351
1352	the image is centered with no scaling. Equivalent to 0x0+50+50
1353
1354	=item B<style=root-tiled>
1355
1356	the image is tiled with no scaling and using 'root' positioning.
1357	Equivalent to 0x0:op=tile:op=root-align
1358
1359	=back
1360
1361	If multiple templates are specified the last one wins. Note that a
1362	template overrides all the scale, position and operations settings.
1363
1364	If used in conjunction with pseudo-transparency, the specified pixmap
1365	will be blended over the transparent background using alpha-blending.
1366
1367	=item B<-tr>\|B<+tr>
1368
1369	=item B<transparent:> I<boolean>
1370
1371	Turn on/off pseudo-transparency by using the root pixmap as background.
1372
1373	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1374	will be removed in future versions.
1375
1376	=item B<-tint> I<colour>
1377
1378	=item B<tintColor:> I<colour>
1379
1380	Tint the transparent background with the given colour. Note that a
1381	black tint yields a completely black image while a white tint yields
1382	the image unchanged.
1383
1384	=item B<-sh> I<number>
1385
1386	=item B<shading:> I<number>
1387
1388	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1389	A value of 100 means no shading.
1390
1391	=item B<-blr> I<HxV>
1392
1393	=item B<blurRadius:> I<HxV>
1394
1395	Apply gaussian blur with the specified radius to the transparent
1396	background. If a single number is specified, the vertical and
1397	horizontal radii are considered to be the same. Setting one of the
1398	radii to 1 and the other to a large number creates interesting effects
1399	on some backgrounds. The maximum radius value is 128. An horizontal or
1400	vertical radius of 0 disables blurring.
1401
1402	=item B<path:> I<path>
1403
1404	Specify the colon-delimited search path for finding background image files.
1405		1367
1406	=back	1368	=back
1407		1369
1408	=head1 THE SCROLLBAR	1370	=head1 THE SCROLLBAR
1409		1371
…		…
1561	In addition to the default foreground and background colours,	1523	In addition to the default foreground and background colours,
1562	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus	1524	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1563	high-intensity (potentially bold/blink) versions of the same, and 72 (or	1525	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1564	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB	1526	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1565	cube plus a 8 (24) colour greyscale ramp.	1527	cube plus a 8 (24) colour greyscale ramp.
		1528
		1529	B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
		1530	C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
		1531	number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
		1532	colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
		1533	24-bit colour space. When indexing collisions happen, the nearest old colour in
		1534	the cube will be adapted to the new 24-bit RGB colour. That means one cannot
		1535	use many similar 24-bit colours. It's typically not a problem in common
		1536	scenarios.
1566		1537
1567	Here is a list of the ANSI colours with their names.	1538	Here is a list of the ANSI colours with their names.
1568		1539
1569	=begin table	1540	=begin table
1570		1541

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.235 by mikachu, Tue Jul 29 13:50:05 2014 UTC vs. Revision 1.251 by root, Sat Jul 3 04:04:12 2021 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.235 by mikachu, Tue Jul 29 13:50:05 2014 UTC vs.
Revision 1.251 by root, Sat Jul 3 04:04:12 2021 UTC