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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.237 by sf-exg, Thu Aug 21 19:21:14 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
…		…
379	=item B<-pt> I<style>	380	=item B<-pt> I<style>
380		381
381	Compile I<XIM>: input style for input method; B<OverTheSpot>,	382	Compile I<XIM>: input style for input method; B<OverTheSpot>,
382	B<OffTheSpot>, B<Root>; resource B<preeditType>.	383	B<OffTheSpot>, B<Root>; resource B<preeditType>.
383		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
384	=item B<-im> I<text>	388	=item B<-im> I<text>
385		389
386	Compile I<XIM>: input method name. resource B<inputMethod>.	390	Compile I<XIM>: input method name. resource B<inputMethod>.
387		391
388	=item B<-imlocale> I<string>	392	=item B<-imlocale> I<string>
…		…
402	Change the meaning of triple-click selection with the left mouse	406	Change the meaning of triple-click selection with the left mouse
403	button. Only effective when the original (non-perl) selection code is	407	button. Only effective when the original (non-perl) selection code is
404	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
405	the end of the logical line only. resource B<tripleclickwords>.	409	the end of the logical line only. resource B<tripleclickwords>.
406		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
407	=item B<-insecure>	421	=item B<-insecure>
408		422
409	Enable "insecure" mode, which currently enables most of the escape	423	Enable "insecure" mode, which currently enables most of the escape
410	sequences that echo strings. See the resource B<insecure> for more	424	sequences that echo strings. See the resource B<insecure> for more
411	info.	425	info.
…		…
423		437
424	=item B<-ssr>\|B<+ssr>	438	=item B<-ssr>\|B<+ssr>
425		439
426	Turn on/off secondary screen scroll (default enabled); resource	440	Turn on/off secondary screen scroll (default enabled); resource
427	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>.
428		450
429	=item B<-hold>\|B<+hold>	451	=item B<-hold>\|B<+hold>
430		452
431	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@@
432	will not immediately destroy its window when the program executed within	454	will not immediately destroy its window when the program executed within
…		…
867	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
868	bottom when a non-special key is pressed; option B<+sk>.	890	bottom when a non-special key is pressed; option B<+sk>.
869		891
870	=item B<saveLines:> I<number>	892	=item B<saveLines:> I<number>
871		893
872	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>.
873	resource is limited on most machines to 65535; option B<-sl>.
874		895
875	=item B<internalBorder:> I<number>	896	=item B<internalBorder:> I<number>
876		897
877	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;
878	option B<-b>.	899	option B<-b>.
…		…
941		962
942	=item B<pointerColor2:> I<colour>	963	=item B<pointerColor2:> I<colour>
943		964
944	Mouse pointer background colour.	965	Mouse pointer background colour.
945		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
946	=item B<pointerBlankDelay:> I<number>	973	=item B<pointerBlankDelay:> I<number>
947		974
948	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
949	large number (e.g. C<987654321>) to effectively disable the timeout.	976	large number (e.g. C<987654321>) to effectively disable the timeout.
950		977
…		…
976		1003
977	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>	1004	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
978		1005
979	=item B<preeditType:> I<style>	1006	=item B<preeditType:> I<style>
980		1007
981	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1008	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
982		1009
983	=item B<inputMethod:> I<name>	1010	=item B<inputMethod:> I<name>
984		1011
985	I<name> of inputMethod to use; option B<-im>.	1012	I<name> of inputMethod to use; option B<-im>.
986		1013
…		…
1003	=item B<tripleclickwords:> I<boolean>	1030	=item B<tripleclickwords:> I<boolean>
1004		1031
1005	Change the meaning of triple-click selection with the left mouse	1032	Change the meaning of triple-click selection with the left mouse
1006	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
1007	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>.
1008		1039
1009	=item B<insecure:> I<boolean>	1040	=item B<insecure:> I<boolean>
1010		1041
1011	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1042	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
1012	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
…		…
1034		1065
1035	=item B<secondaryScreen:> I<boolean>	1066	=item B<secondaryScreen:> I<boolean>
1036		1067
1037	Turn on/off secondary screen (default enabled).	1068	Turn on/off secondary screen (default enabled).
1038		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
1039	=item B<secondaryScroll:> I<boolean>	1075	=item B<secondaryScroll:> I<boolean>
1040		1076
1041	Turn on/off secondary screen scroll (default enabled). If this	1077	Turn on/off secondary screen scroll (default enabled). If this
1042	option is enabled, scrolls on the secondary screen will change the	1078	option is enabled, scrolls on the secondary screen will change the
1043	scrollback buffer and, when secondaryScreen is off, switching	1079	scrollback buffer and, when secondaryScreen is off, switching
…		…
1070		1106
1071	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:
1072		1108
1073	(modifiers-)key	1109	(modifiers-)key
1074		1110
1075	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
1076	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,	1112	abbreviated modifier names:
1077	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,	1113
1078	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
1079		1130
1080	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
1081	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
1082	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
1083	current application keymap mode state.	1134	current application keymap mode state.
…		…
1119		1170
1120	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n	1171	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1121		1172
1122	This could in theory be used to completely redefine your keymap.	1173	This could in theory be used to completely redefine your keymap.
1123		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
1124	=item command:STRING	1190	=item command:STRING
1125		1191
1126	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>
1127	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically	1193	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1128	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
…		…
1192	URxvt.keysym.C-M-c: builtin-string:	1258	URxvt.keysym.C-M-c: builtin-string:
1193	URxvt.keysym.C-M-v: builtin-string:	1259	URxvt.keysym.C-M-v: builtin-string:
1194		1260
1195	=item EXTENSION:STRING	1261	=item EXTENSION:STRING
1196		1262
1197	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
1198	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
1199	necessary.	1265	be loaded automatically if necessary.
1200		1266
1201	Not all extensions define key actions, but popular extensions that do	1267	Not all extensions define actions, but popular extensions that do
1202	include the I<selection> and I<matcher> extensions (documented in their	1268	include the I<selection> and I<matcher> extensions (documented in their
1203	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),	1269	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1204	respectively).	1270	respectively).
1205		1271
1206	From the silly examples department, this will rot13-"encrypt"	1272	From the silly examples department, this will rot13-"encrypt"
…		…
1209		1275
1210	URxvt.keysym.M-C-c: selection:rot13	1276	URxvt.keysym.M-C-c: selection:rot13
1211		1277
1212	=item perl:STRING DEPRECATED	1278	=item perl:STRING DEPRECATED
1213		1279
1214	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
1215	still supported, but should not be used anymore.	1281	extensions. It is still supported, but should not be used anymore.
1216		1282
1217	=back	1283	=back
1218		1284
1219	=item B<perl-ext-common>: I<string>	1285	=item B<perl-ext-common>: I<string>
1220		1286
…		…
1228	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
1229	example, C<default,-selection> will use all the default extensions except	1295	example, C<default,-selection> will use all the default extensions except
1230	C<selection>.	1296	C<selection>.
1231		1297
1232	The default set includes the C<selection>, C<option-popup>,	1298	The default set includes the C<selection>, C<option-popup>,
1233	C<selection-popup> and C<readline> extensions, any extensions that define	1299	C<selection-popup>, C<readline> and C<searchable-scrollback>
1234	keybindings via C<BINDING> meta comments, extensions loaded because	1300	extensions, and extensions which are mentioned in B<keysym> resources.
1235	their resources/commandline switches were used, and extensions which are	1301
1236	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>.
1237		1304
1238	Each extension is looked up in the library directories, loaded if	1305	Each extension is looked up in the library directories, loaded if
1239	necessary, and bound to the current terminal instance. When the library	1306	necessary, and bound to the current terminal instance. When the library
1240	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
1241	first one found will be used.	1308	first one found will be used.
…		…
1295	Turn on/off ISO 14755 (default enabled).	1362	Turn on/off ISO 14755 (default enabled).
1296		1363
1297	=item B<iso14755_52:> I<boolean>	1364	=item B<iso14755_52:> I<boolean>
1298		1365
1299	Turn on/off ISO 14755 5.2 mode (default enabled).	1366	Turn on/off ISO 14755 5.2 mode (default enabled).
1300
1301	=back
1302
1303	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1304
1305	=over 4
1306
1307	=item B<-pixmap> I<file[;oplist]>
1308
1309	=item B<backgroundPixmap:> I<file[;oplist]>
1310
1311	Compile I<pixbuf>: Use the specified image file as the window's
1312	background and also optionally specify a colon separated list of
1313	operations to modify it. Note that you may need to quote the C<;>
1314	character when using the command line option, as C<;> is usually a
1315	metacharacter in shells. Supported operations are:
1316
1317	=over 4
1318
1319	=item B<WxH+X+Y>
1320
1321	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1322	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1323	scale of 0 disables scaling.
1324
1325	=item B<op=tile>
1326
1327	enables tiling
1328
1329	=item B<op=keep-aspect>
1330
1331	maintain the image aspect ratio when scaling
1332
1333	=item B<op=root-align>
1334
1335	use the position of the terminal window relative to the root window as
1336	the image offset, simulating a root window background
1337
1338	=back
1339
1340	The default scale and position setting is C<100x100+50+50>.
1341	Alternatively, a predefined set of templates can be used to achieve
1342	the most common setups:
1343
1344	=over 4
1345
1346	=item B<style=tiled>
1347
1348	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1349
1350	=item B<style=aspect-stretched>
1351
1352	the image is scaled to fill the whole window maintaining the aspect
1353	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1354
1355	=item B<style=stretched>
1356
1357	the image is scaled to fill the whole window. Equivalent to 100x100
1358
1359	=item B<style=centered>
1360
1361	the image is centered with no scaling. Equivalent to 0x0+50+50
1362
1363	=item B<style=root-tiled>
1364
1365	the image is tiled with no scaling and using 'root' positioning.
1366	Equivalent to 0x0:op=tile:op=root-align
1367
1368	=back
1369
1370	If multiple templates are specified the last one wins. Note that a
1371	template overrides all the scale, position and operations settings.
1372
1373	If used in conjunction with pseudo-transparency, the specified pixmap
1374	will be blended over the transparent background using alpha-blending.
1375
1376	=item B<-tr>\|B<+tr>
1377
1378	=item B<transparent:> I<boolean>
1379
1380	Turn on/off pseudo-transparency by using the root pixmap as background.
1381
1382	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1383	will be removed in future versions.
1384
1385	=item B<-tint> I<colour>
1386
1387	=item B<tintColor:> I<colour>
1388
1389	Tint the transparent background with the given colour. Note that a
1390	black tint yields a completely black image while a white tint yields
1391	the image unchanged.
1392
1393	=item B<-sh> I<number>
1394
1395	=item B<shading:> I<number>
1396
1397	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1398	A value of 100 means no shading.
1399
1400	=item B<-blr> I<HxV>
1401
1402	=item B<blurRadius:> I<HxV>
1403
1404	Apply gaussian blur with the specified radius to the transparent
1405	background. If a single number is specified, the vertical and
1406	horizontal radii are considered to be the same. Setting one of the
1407	radii to 1 and the other to a large number creates interesting effects
1408	on some backgrounds. The maximum radius value is 128. An horizontal or
1409	vertical radius of 0 disables blurring.
1410
1411	=item B<path:> I<path>
1412
1413	Specify the colon-delimited search path for finding background image files.
1414		1367
1415	=back	1368	=back
1416		1369
1417	=head1 THE SCROLLBAR	1370	=head1 THE SCROLLBAR
1418		1371
…		…
1570	In addition to the default foreground and background colours,	1523	In addition to the default foreground and background colours,
1571	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
1572	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
1573	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
1574	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.
1575		1537
1576	Here is a list of the ANSI colours with their names.	1538	Here is a list of the ANSI colours with their names.
1577		1539
1578	=begin table	1540	=begin table
1579		1541

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.237 by sf-exg, Thu Aug 21 19:21:14 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.237 by sf-exg, Thu Aug 21 19:21:14 2014 UTC vs.
Revision 1.251 by root, Sat Jul 3 04:04:12 2021 UTC