[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.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
…		…
378		379
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>.
		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.
383		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
…		…
867	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
868	bottom when a non-special key is pressed; option B<+sk>.	872	bottom when a non-special key is pressed; option B<+sk>.
869		873
870	=item B<saveLines:> I<number>	874	=item B<saveLines:> I<number>
871		875
872	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>.
873	resource is limited on most machines to 65535; option B<-sl>.
874		877
875	=item B<internalBorder:> I<number>	878	=item B<internalBorder:> I<number>
876		879
877	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;
878	option B<-b>.	881	option B<-b>.
…		…
941		944
942	=item B<pointerColor2:> I<colour>	945	=item B<pointerColor2:> I<colour>
943		946
944	Mouse pointer background colour.	947	Mouse pointer background colour.
945		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
946	=item B<pointerBlankDelay:> I<number>	955	=item B<pointerBlankDelay:> I<number>
947		956
948	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
949	large number (e.g. C<987654321>) to effectively disable the timeout.	958	large number (e.g. C<987654321>) to effectively disable the timeout.
950		959
…		…
976		985
977	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>	986	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
978		987
979	=item B<preeditType:> I<style>	988	=item B<preeditType:> I<style>
980		989
981	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	990	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
982		991
983	=item B<inputMethod:> I<name>	992	=item B<inputMethod:> I<name>
984		993
985	I<name> of inputMethod to use; option B<-im>.	994	I<name> of inputMethod to use; option B<-im>.
986		995
…		…
1070		1079
1071	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:
1072		1081
1073	(modifiers-)key	1082	(modifiers-)key
1074		1083
1075	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
1076	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,	1085	abbreviated modifier names:
1077	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,	1086
1078	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
1079		1103
1080	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
1081	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
1082	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
1083	current application keymap mode state.	1107	current application keymap mode state.
…		…
1119		1143
1120	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n	1144	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1121		1145
1122	This could in theory be used to completely redefine your keymap.	1146	This could in theory be used to completely redefine your keymap.
1123		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>
		1162
1124	=item command:STRING	1163	=item command:STRING
1125		1164
1126	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>
1127	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically	1166	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	1167	the opposite of C<string:> - instead of sending it to the program running
…		…
1192	URxvt.keysym.C-M-c: builtin-string:	1231	URxvt.keysym.C-M-c: builtin-string:
1193	URxvt.keysym.C-M-v: builtin-string:	1232	URxvt.keysym.C-M-v: builtin-string:
1194		1233
1195	=item EXTENSION:STRING	1234	=item EXTENSION:STRING
1196		1235
1197	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
1198	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
1199	necessary.	1238	be loaded automatically if necessary.
1200		1239
1201	Not all extensions define key actions, but popular extensions that do	1240	Not all extensions define actions, but popular extensions that do
1202	include the I<selection> and I<matcher> extensions (documented in their	1241	include the I<selection> and I<matcher> extensions (documented in their
1203	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),	1242	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1204	respectively).	1243	respectively).
1205		1244
1206	From the silly examples department, this will rot13-"encrypt"	1245	From the silly examples department, this will rot13-"encrypt"
…		…
1209		1248
1210	URxvt.keysym.M-C-c: selection:rot13	1249	URxvt.keysym.M-C-c: selection:rot13
1211		1250
1212	=item perl:STRING DEPRECATED	1251	=item perl:STRING DEPRECATED
1213		1252
1214	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
1215	still supported, but should not be used anymore.	1254	extensions. It is still supported, but should not be used anymore.
1216		1255
1217	=back	1256	=back
1218		1257
1219	=item B<perl-ext-common>: I<string>	1258	=item B<perl-ext-common>: I<string>
1220		1259
…		…
1228	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
1229	example, C<default,-selection> will use all the default extensions except	1268	example, C<default,-selection> will use all the default extensions except
1230	C<selection>.	1269	C<selection>.
1231		1270
1232	The default set includes the C<selection>, C<option-popup>,	1271	The default set includes the C<selection>, C<option-popup>,
1233	C<selection-popup> and C<readline> extensions, any extensions that define	1272	C<selection-popup>, C<readline> and C<searchable-scrollback>
1234	keybindings via C<BINDING> meta comments, extensions loaded because	1273	extensions, and extensions which are mentioned in B<keysym> resources.
1235	their resources/commandline switches were used, and extensions which are	1274
1236	mentioned in B<keysym> resources.	1275	Any extension such that a corresponding resource is given on the
		1276	command line is automatically appended to B<perl-ext>.
1237		1277
1238	Each extension is looked up in the library directories, loaded if	1278	Each extension is looked up in the library directories, loaded if
1239	necessary, and bound to the current terminal instance. When the library	1279	necessary, and bound to the current terminal instance. When the library
1240	search path contains multiple extension files of the same name, then the	1280	search path contains multiple extension files of the same name, then the
1241	first one found will be used.	1281	first one found will be used.
…		…
1295	Turn on/off ISO 14755 (default enabled).	1335	Turn on/off ISO 14755 (default enabled).
1296		1336
1297	=item B<iso14755_52:> I<boolean>	1337	=item B<iso14755_52:> I<boolean>
1298		1338
1299	Turn on/off ISO 14755 5.2 mode (default enabled).	1339	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		1340
1415	=back	1341	=back
1416		1342
1417	=head1 THE SCROLLBAR	1343	=head1 THE SCROLLBAR
1418		1344
…		…
1570	In addition to the default foreground and background colours,	1496	In addition to the default foreground and background colours,
1571	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
1572	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
1573	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
1574	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.
1575		1510
1576	Here is a list of the ANSI colours with their names.	1511	Here is a list of the ANSI colours with their names.
1577		1512
1578	=begin table	1513	=begin table
1579		1514

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.250 by root, Sat Oct 10 20:06:45 2020 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.250 by root, Sat Oct 10 20:06:45 2020 UTC