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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.228 by root, Sun Apr 27 19:43:46 2014 UTC vs.
Revision 1.257 by root, Mon Nov 22 17:01:05 2021 UTC

…		…
84	far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1	84	far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1
85	Orange'.	85	Orange'.
86		86
87	The following options are available:	87	The following options are available:
88		88
89	=over 4	89	=over
90		90
91	=item B<-help>, B<--help>	91	=item B<-help>, B<--help>
92		92
93	Print out a message describing available options.	93	Print out a message describing available options.
94		94
…		…
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
…		…
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>.
374		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
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
379	=item B<-imlocale> I<string>	392	=item B<-imlocale> I<string>
…		…
393	Change the meaning of triple-click selection with the left mouse	406	Change the meaning of triple-click selection with the left mouse
394	button. Only effective when the original (non-perl) selection code is	407	button. Only effective when the original (non-perl) selection code is
395	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
396	the end of the logical line only. resource B<tripleclickwords>.	409	the end of the logical line only. resource B<tripleclickwords>.
397		410
		411	=item B<-dpb>\|B<+dpb>
		412
		413	Compile frills: Disable (or enable) 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 emitted. You can also toggle this from the
		419	ctrl-middle-mouse-button menu; resource B<disablePasteBrackets>.
		420
398	=item B<-insecure>	421	=item B<-insecure>
399		422
400	Enable "insecure" mode, which currently enables most of the escape	423	Enable "insecure" mode, which currently enables most of the escape
401	sequences that echo strings. See the resource B<insecure> for more	424	sequences that echo strings. See the resource B<insecure> for more
402	info.	425	info.
…		…
414		437
415	=item B<-ssr>\|B<+ssr>	438	=item B<-ssr>\|B<+ssr>
416		439
417	Turn on/off secondary screen scroll (default enabled); resource	440	Turn on/off secondary screen scroll (default enabled); resource
418	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>.
419		450
420	=item B<-hold>\|B<+hold>	451	=item B<-hold>\|B<+hold>
421		452
422	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@@
423	will not immediately destroy its window when the program executed within	454	will not immediately destroy its window when the program executed within
…		…
501	close $pty;	532	close $pty;
502		533
503	# now communicate with rxvt	534	# now communicate with rxvt
504	my $slave = $pty->slave;	535	my $slave = $pty->slave;
505	while (<$slave>) { print $slave "got <$_>\n" }	536	while (<$slave>) { print $slave "got <$_>\n" }
		537
		538	Note that, despite what the name might imply, the file descriptor does not
		539	need to be a pty, it can be a bi-directional pipe as well (e.g. a unix
		540	domain or tcp socket). While tty operations cannot be done in this case,
		541	B<@@RXVT_NAME@@> can still be remote controlled with it:
		542
		543	use Socket;
		544	use Fcntl;
		545
		546	socketpair my $URXVT, my $slave, Socket::AF_UNIX, Socket::SOCK_STREAM, Socket::PF_UNSPEC;
		547	fcntl $slave, Fcntl::F_SETFD, 0;
		548	system "exec @@RXVT_NAME\|\| -pty-fd " . (fileno $slave) . " &";
		549	close $slave;
		550
		551	syswrite $URXVT, "Type a secret password: ";
		552	my $secret = do { local $/ = "\r"; <$URXVT> };
		553	print "Not so secret anymore: $secret\n";
506		554
507	=item B<-pe> I<string>	555	=item B<-pe> I<string>
508		556
509	Comma-separated list of perl extension scripts to use (or not to use) in	557	Comma-separated list of perl extension scripts to use (or not to use) in
510	this terminal instance. See resource B<perl-ext> for details.	558	this terminal instance. See resource B<perl-ext> for details.
…		…
538	be used. Command-line arguments can be used to override resource	586	be used. Command-line arguments can be used to override resource
539	settings. The following resources are supported (you might want to	587	settings. The following resources are supported (you might want to
540	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl	588	check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
541	extensions not documented here):	589	extensions not documented here):
542		590
543	=over 4	591	=over
544		592
545	=item B<depth:> I<bitdepth>	593	=item B<depth:> I<bitdepth>
546		594
547	Compile I<xft>: Attempt to find a visual with the given bit depth;	595	Compile I<xft>: Attempt to find a visual with the given bit depth;
548	option B<-depth>.	596	option B<-depth>.
…		…
781		829
782	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of	830	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	831	the shell; option B<-ls>. B<False>: start as a normal sub-shell
784	[default]; option B<+ls>.	832	[default]; option B<+ls>.
785		833
		834	=item B<multiClickTime:> I<number>
		835
		836	Specify the maximum time in milliseconds between multi-click select
		837	events. The default is 500 milliseconds; option B<-mc>.
		838
786	=item B<utmpInhibit:> I<boolean>	839	=item B<utmpInhibit:> I<boolean>
787		840
788	B<True>: inhibit writing record into the system log file B<utmp>;	841	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>	842	option B<-ut>. B<False>: write record into the system log file B<utmp>
790	[default]; option B<+ut>.	843	[default]; option B<+ut>.
…		…
853	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to	906	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>.	907	bottom when a non-special key is pressed; option B<+sk>.
855		908
856	=item B<saveLines:> I<number>	909	=item B<saveLines:> I<number>
857		910
858	Save I<number> lines in the scrollback buffer [default 64]. This	911	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		912
861	=item B<internalBorder:> I<number>	913	=item B<internalBorder:> I<number>
862		914
863	Internal border of I<number> pixels. This resource is limited to 100;	915	Internal border of I<number> pixels. This resource is limited to 100;
864	option B<-b>.	916	option B<-b>.
…		…
927		979
928	=item B<pointerColor2:> I<colour>	980	=item B<pointerColor2:> I<colour>
929		981
930	Mouse pointer background colour.	982	Mouse pointer background colour.
931		983
		984	=item B<pointerShape:> I<string>
		985
		986	Compile I<frills>: Specifies the name of the mouse pointer shape
		987	[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
		988	file for possible values (omit the C<XC_> prefix).
		989
932	=item B<pointerBlankDelay:> I<number>	990	=item B<pointerBlankDelay:> I<number>
933		991
934	Specifies number of seconds before blanking the pointer [default 2]. Use a	992	Specifies number of seconds before blanking the pointer [default 2]. Use a
935	large number (e.g. C<987654321>) to effectively disable the timeout.	993	large number (e.g. C<987654321>) to effectively disable the timeout.
936		994
…		…
962		1020
963	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>	1021	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
964		1022
965	=item B<preeditType:> I<style>	1023	=item B<preeditType:> I<style>
966		1024
967	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1025	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
968		1026
969	=item B<inputMethod:> I<name>	1027	=item B<inputMethod:> I<name>
970		1028
971	I<name> of inputMethod to use; option B<-im>.	1029	I<name> of inputMethod to use; option B<-im>.
972		1030
…		…
990		1048
991	Change the meaning of triple-click selection with the left mouse	1049	Change the meaning of triple-click selection with the left mouse
992	button. Instead of selecting a full line it will extend the selection to	1050	button. Instead of selecting a full line it will extend the selection to
993	the end of the logical line only; option B<-tcw>.	1051	the end of the logical line only; option B<-tcw>.
994		1052
		1053	=item B<disablePasteBrackets:> I<boolean>
		1054
		1055	Prevent emission of paste bracket sequences; option B<-dpb>.
		1056
995	=item B<insecure:> I<boolean>	1057	=item B<insecure:> I<boolean>
996		1058
997	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1059	Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
998	echo arbitrary strings like the icon name or the locale. This could be	1060	echo arbitrary strings like the icon name or the locale. This could be
999	abused if somebody gets 8-bit-clean access to your display, whether	1061	abused if somebody gets 8-bit-clean access to your display, whether
1000	through a mail client displaying mail bodies unfiltered or through	1062	through a mail client displaying mail bodies unfiltered or through
1001	write(1) or any other means. Therefore, these sequences are disabled by	1063	write(1) or any other means. Therefore, these sequences are disabled by
1002	default. (Note that many other terminals, including xterm, have these	1064	default. (Note that many other terminals, including xterm, have these
…		…
1020		1082
1021	=item B<secondaryScreen:> I<boolean>	1083	=item B<secondaryScreen:> I<boolean>
1022		1084
1023	Turn on/off secondary screen (default enabled).	1085	Turn on/off secondary screen (default enabled).
1024		1086
		1087	=item B<rewrapMode:> I<mode>
		1088
		1089	Sets long line rewrap behaviour on window resize to one of B<auto>
		1090	(default), B<always> or B<never>.
		1091
1025	=item B<secondaryScroll:> I<boolean>	1092	=item B<secondaryScroll:> I<boolean>
1026		1093
1027	Turn on/off secondary screen scroll (default enabled). If this	1094	Turn on/off secondary screen scroll (default enabled). If this
1028	option is enabled, scrolls on the secondary screen will change the	1095	option is enabled, scrolls on the secondary screen will change the
1029	scrollback buffer and, when secondaryScreen is off, switching	1096	scrollback buffer and, when secondaryScreen is off, switching
…		…
1055	extension might provide.	1122	extension might provide.
1056		1123
1057	The key combination that triggers the action, I<sym>, has the following format:	1124	The key combination that triggers the action, I<sym>, has the following format:
1058		1125
1059	(modifiers-)key	1126	(modifiers-)key
1060		1127
1061	Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,	1128	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>,	1129	abbreviated modifier names:
1063	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,	1130
1064	B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.	1131	=begin table
		1132
		1133	B<ISOLevel3> B<I>
		1134	B<AppKeypad> B<K>
		1135	B<Control> B<C>
		1136	B<NumLock> B<N>
		1137	B<Shift> B<S>
		1138	B<Meta> B<M> I<or> B<A>
		1139	B<Lock> B<L>
		1140	B<Mod1> B<1>
		1141	B<Mod2> B<2>
		1142	B<Mod3> B<3>
		1143	B<Mod4> B<4>
		1144	B<Mod5> B<5>
		1145
		1146	=end table
1065		1147
1066	The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to	1148	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	1149	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	1150	keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1069	current application keymap mode state.	1151	current application keymap mode state.
…		…
1085	As with any resource value, the I<action> string may contain backslash	1167	As with any resource value, the I<action> string may contain backslash
1086	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal	1168	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1087	number), see RESOURCES in C<man 7 X> for further details.	1169	number), see RESOURCES in C<man 7 X> for further details.
1088		1170
1089	An action starts with an action prefix that selects a certain type	1171	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	1172	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	1173	interpreted as a literal string to pass to the tty (as if it was
1092	prefixed with C<string:>).	1174	prefixed with C<string:>).
1093		1175
1094	The following action prefixes are known - extensions can provide	1176	The following action prefixes are known - extensions can provide
1095	additional prefixes:	1177	additional prefixes:
1096		1178
1097	=over 4	1179	=over
1098		1180
1099	=item string:STRING	1181	=item string:STRING
1100		1182
1101	If the I<action> starts with C<string:> (or otherwise contains no colons),	1183	If the I<action> starts with C<string:> (or otherwise contains no colons),
1102	then the remaining C<STRING> will be passed to the program running in the	1184	then the remaining C<STRING> will be passed to the program running in the
…		…
1104	string C<echo rm -rf /> followed by a newline:	1186	string C<echo rm -rf /> followed by a newline:
1105		1187
1106	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n	1188	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1107		1189
1108	This could in theory be used to completely redefine your keymap.	1190	This could in theory be used to completely redefine your keymap.
		1191
		1192	In addition, for actions of this type, you can define a range of
		1193	keysyms in one shot by loading the C<keysym-list> perl extension and
		1194	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
		1195	the delimiter `/' should be a character not used by the strings.
		1196
		1197	Its usage can be demonstrated by an example:
		1198
		1199	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
		1200
		1201	The above line is equivalent to the following three lines:
		1202
		1203	URxvt.keysym.Meta-Control-0x61: string:\033<a>
		1204	URxvt.keysym.Meta-Control-0x62: string:\033<b>
		1205	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1109		1206
1110	=item command:STRING	1207	=item command:STRING
1111		1208
1112	If I<action> takes the form of C<command:STRING>, the specified B<STRING>	1209	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	1210	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
…		…
1149		1246
1150	The first line defines a mapping for C<Insert> and I<any> combination	1247	The first line defines a mapping for C<Insert> and I<any> combination
1151	of modifiers. The second line re-establishes the default mapping for	1248	of modifiers. The second line re-establishes the default mapping for
1152	C<Shift-Insert>.	1249	C<Shift-Insert>.
1153		1250
		1251	=item builtin-string:
		1252
		1253	This action is mainly useful to restore string mappings for keys that
		1254	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1255	difficult to explain - basically, this action will send the string to the
		1256	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1257	action for it.
		1258
		1259	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
		1260	selection when you press C<Shift-Insert>. With the following bindings, it
		1261	would instead emit the (undocumented, but what applications running in the
		1262	terminal might expect) sequence C<ESC [ 2 $> instead:
		1263
		1264	URxvt.keysym.S-Insert: builtin-string:
		1265	URxvt.keysym.C-S-Insert: builtin:
		1266
		1267	The first line disables the paste functionality for that key
		1268	combination, and the second reinstates the default behaviour for
		1269	C<Control-Shift-Insert>, which would otherwise be overridden.
		1270
		1271	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1272	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1273	this:
		1274
		1275	URxvt.keysym.C-M-c: builtin-string:
		1276	URxvt.keysym.C-M-v: builtin-string:
		1277
1154	=item EXTENSION:STRING	1278	=item EXTENSION:STRING
1155		1279
1156	An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)	1280	An action of this form invokes the action B<STRING>, if any, provided
1157	extension of the same name. The extension will be loaded automatically if	1281	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1158	neccessary.	1282	be loaded automatically if necessary.
1159		1283
1160	Not all extensions define key actions, but popular extensions that do	1284	Not all extensions define actions, but popular extensions that do
1161	include the I<selection> and I<matcher> extensions (documented in their	1285	include the I<selection> and I<matcher> extensions (documented in their
1162	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),	1286	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1163	respectively).	1287	respectively).
1164		1288
1165	From the silly examples department, this will rot13-"encrypt"	1289	From the silly examples department, this will rot13-"encrypt"
1166	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC	1290	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1167	keyboards:	1291	keyboards:
1168		1292
1169	URxvt.keysym.M-C-c: selection:rot13	1293	URxvt.keysym.M-C-c: selection:rot13
1170		1294
1171	=item perl:STRING	1295	=item perl:STRING DEPRECATED
1172		1296
1173	This is a deprecated way of passing key mappings to perl extensions. It is	1297	This is a deprecated way of invoking commands provided by perl
1174	still supported, but should not be used anymore.	1298	extensions. It is still supported, but should not be used anymore.
1175		1299
1176	=back	1300	=back
1177
1178	In addition, you can define a range of keysyms in one shot by loading
1179	the C<keysym-list> perl extension and providing a I<string> with pattern
1180	B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' should be a
1181	character not used by the strings.
1182
1183	Its usage can be demonstrated by an example:
1184
1185	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1186
1187	The above line is equivalent to the following three lines:
1188
1189	URxvt.keysym.Meta-Control-0x61: \033<a>
1190	URxvt.keysym.Meta-Control-0x62: \033<b>
1191	URxvt.keysym.Meta-Control-0x63: \033<c>
1192		1301
1193	=item B<perl-ext-common>: I<string>	1302	=item B<perl-ext-common>: I<string>
1194		1303
1195	=item B<perl-ext>: I<string>	1304	=item B<perl-ext>: I<string>
1196		1305
1197	Comma-separated list(s) of perl extension scripts (default: C<default>) to	1306	Comma-separated list(s) of perl extension scripts (default: C<default>) to
1198	use in this terminal instance; option B<-pe>.	1307	use in this terminal instance; option B<-pe>.
1199		1308
1200	Extension names can be prefixed with a C<-> sign to prohibit using	1309	Extension names can be prefixed with a C<-> sign to remove them again, in
1201	them. This can be useful to selectively disable some extensions loaded	1310	case they had been specified earlier. This can be useful to selectively
1202	by default, or specified via the C<perl-ext-common> resource. For	1311	disable some extensions loaded by default, or specified via the
1203	example, C<default,-selection> will use all the default extension except	1312	C<perl-ext-common> resource. For example, C<default,-selection> will use
1204	C<selection>.	1313	all the default extensions except C<selection>.
1205		1314
1206	Extension names can also be followed by an argument in angle brackets	1315	To prohibit autoloading of extensions, you can prefix them with C</>,
1207	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1316	which will make urxvt refuse to automatically load them (this can be
1208	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1317	overriden, however, by specifying the extension name again without a
1209	multiple times with different arguments will pass multiple arguments to	1318	prefix, though). This does not prohibit extensions themselves loading
1210	the extension.	1319	other extensions. For example, C<default,/background> will keep the
		1320	C<background> extension from being loaded when a background OSC sequence
		1321	is received.
		1322
		1323	The default set includes the C<selection>, C<option-popup>,
		1324	C<selection-popup>, C<readline>, C<searchable-scrollback> and
		1325	C<confirm-paste> extensions, as well as any extensions which are mentioned
		1326	in B<keysym> resources.
		1327
		1328	Any extension such that a corresponding resource is given on the
		1329	command line is automatically appended to B<perl-ext>.
1211		1330
1212	Each extension is looked up in the library directories, loaded if	1331	Each extension is looked up in the library directories, loaded if
1213	necessary, and bound to the current terminal instance.	1332	necessary, and bound to the current terminal instance. When the library
		1333	search path contains multiple extension files of the same name, then the
		1334	first one found will be used.
1214		1335
1215	If both of these resources are the empty string, then the perl	1336	If both of these resources are the empty string, then the perl interpreter
1216	interpreter will not be initialized. The idea behind two options is that	1337	will not be initialized. The rationale for having two options is that
1217	B<perl-ext-common> will be used for extensions that should be available to	1338	B<perl-ext-common> will be used for extensions that should be available to
1218	all instances, while B<perl-ext> is used for specific instances.	1339	all instances, while B<perl-ext> is used for specific instances.
1219		1340
1220	=item B<perl-eval>: I<string>	1341	=item B<perl-eval>: I<string>
1221		1342
…		…
1239	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1360	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1240		1361
1241	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1362	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1242	for details.	1363	for details.
1243		1364
1244	=item B<searchable-scrollback:> I<keysym>	1365	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1245		1366
1246	Sets the hotkey that starts the incremental scrollback buffer search	1367	This resource is deprecated and will be removed. Use a B<keysym> resource
1247	(default: C<M-s>).	1368	instead, e.g.:
		1369
		1370	URxvt.keysym.M-s: searchable-scrollback:start
1248		1371
1249	=item B<url-launcher>: I<string>	1372	=item B<url-launcher>: I<string>
1250		1373
1251	Specifies the program to be started with a URL argument. Used by the	1374	Specifies the program to be started with a URL argument. Used by the
1252	C<selection-popup> and C<matcher> perl extensions.	1375	C<selection-popup> and C<matcher> perl extensions.
…		…
1265	Turn on/off ISO 14755 (default enabled).	1388	Turn on/off ISO 14755 (default enabled).
1266		1389
1267	=item B<iso14755_52:> I<boolean>	1390	=item B<iso14755_52:> I<boolean>
1268		1391
1269	Turn on/off ISO 14755 5.2 mode (default enabled).	1392	Turn on/off ISO 14755 5.2 mode (default enabled).
1270
1271	=back
1272
1273	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1274
1275	=over 4
1276
1277	=item B<-pixmap> I<file[;oplist]>
1278
1279	=item B<backgroundPixmap:> I<file[;oplist]>
1280
1281	Compile I<pixbuf>: Use the specified image file as the window's
1282	background and also optionally specify a colon separated list of
1283	operations to modify it. Note that you may need to quote the C<;>
1284	character when using the command line option, as C<;> is usually a
1285	metacharacter in shells. Supported operations are:
1286
1287	=over 4
1288
1289	=item B<WxH+X+Y>
1290
1291	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1292	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1293	scale of 0 disables scaling.
1294
1295	=item B<op=tile>
1296
1297	enables tiling
1298
1299	=item B<op=keep-aspect>
1300
1301	maintain the image aspect ratio when scaling
1302
1303	=item B<op=root-align>
1304
1305	use the position of the terminal window relative to the root window as
1306	the image offset, simulating a root window background
1307
1308	=back
1309
1310	The default scale and position setting is C<100x100+50+50>.
1311	Alternatively, a predefined set of templates can be used to achieve
1312	the most common setups:
1313
1314	=over 4
1315
1316	=item B<style=tiled>
1317
1318	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1319
1320	=item B<style=aspect-stretched>
1321
1322	the image is scaled to fill the whole window maintaining the aspect
1323	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1324
1325	=item B<style=stretched>
1326
1327	the image is scaled to fill the whole window. Equivalent to 100x100
1328
1329	=item B<style=centered>
1330
1331	the image is centered with no scaling. Equivalent to 0x0+50+50
1332
1333	=item B<style=root-tiled>
1334
1335	the image is tiled with no scaling and using 'root' positioning.
1336	Equivalent to 0x0:op=tile:op=root-align
1337
1338	=back
1339
1340	If multiple templates are specified the last one wins. Note that a
1341	template overrides all the scale, position and operations settings.
1342
1343	If used in conjunction with pseudo-transparency, the specified pixmap
1344	will be blended over the transparent background using alpha-blending.
1345
1346	=item B<-tr>\|B<+tr>
1347
1348	=item B<transparent:> I<boolean>
1349
1350	Turn on/off pseudo-transparency by using the root pixmap as background.
1351
1352	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1353	will be removed in future versions.
1354
1355	=item B<-tint> I<colour>
1356
1357	=item B<tintColor:> I<colour>
1358
1359	Tint the transparent background with the given colour. Note that a
1360	black tint yields a completely black image while a white tint yields
1361	the image unchanged.
1362
1363	=item B<-sh> I<number>
1364
1365	=item B<shading:> I<number>
1366
1367	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1368	A value of 100 means no shading.
1369
1370	=item B<-blr> I<HxV>
1371
1372	=item B<blurRadius:> I<HxV>
1373
1374	Apply gaussian blur with the specified radius to the transparent
1375	background. If a single number is specified, the vertical and
1376	horizontal radii are considered to be the same. Setting one of the
1377	radii to 1 and the other to a large number creates interesting effects
1378	on some backgrounds. The maximum radius value is 128. An horizontal or
1379	vertical radius of 0 disables blurring.
1380
1381	=item B<path:> I<path>
1382
1383	Specify the colon-delimited search path for finding background image files.
1384		1393
1385	=back	1394	=back
1386		1395
1387	=head1 THE SCROLLBAR	1396	=head1 THE SCROLLBAR
1388		1397
…		…
1412	=head1 THE SELECTION: SELECTING AND PASTING TEXT	1421	=head1 THE SELECTION: SELECTING AND PASTING TEXT
1413		1422
1414	The behaviour of text selection and insertion/pasting mechanism is similar	1423	The behaviour of text selection and insertion/pasting mechanism is similar
1415	to I<xterm>(1).	1424	to I<xterm>(1).
1416		1425
1417	=over 4	1426	=over
1418		1427
1419	=item B<Selecting>:	1428	=item B<Selecting>:
1420		1429
1421	Left click at the beginning of the region, drag to the end of the region	1430	Left click at the beginning of the region, drag to the end of the region
1422	and release; Right click to extend the marked region; Left double-click	1431	and release; Right click to extend the marked region; Left double-click
…		…
1469	and character codes using the keyboard. It consists of 4 parts. The	1478	and character codes using the keyboard. It consists of 4 parts. The
1470	first part is available if rxvt-unicode has been compiled with	1479	first part is available if rxvt-unicode has been compiled with
1471	C<--enable-frills>, the rest is available when rxvt-unicode was compiled	1480	C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1472	with C<--enable-iso14755>.	1481	with C<--enable-iso14755>.
1473		1482
1474	=over 4	1483	=over
1475		1484
1476	=item * 5.1: Basic method	1485	=item * 5.1: Basic method
1477		1486
1478	This allows you to enter unicode characters using their hexcode.	1487	This allows you to enter unicode characters using their hexcode.
1479		1488
…		…
1540	In addition to the default foreground and background colours,	1549	In addition to the default foreground and background colours,
1541	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus	1550	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1542	high-intensity (potentially bold/blink) versions of the same, and 72 (or	1551	high-intensity (potentially bold/blink) versions of the same, and 72 (or
1543	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB	1552	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1544	cube plus a 8 (24) colour greyscale ramp.	1553	cube plus a 8 (24) colour greyscale ramp.
		1554
		1555	B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
		1556	C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
		1557	number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
		1558	colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
		1559	24-bit colour space. When indexing collisions happen, the nearest old colour in
		1560	the cube will be adapted to the new 24-bit RGB colour. That means one cannot
		1561	use many similar 24-bit colours. It's typically not a problem in common
		1562	scenarios.
1545		1563
1546	Here is a list of the ANSI colours with their names.	1564	Here is a list of the ANSI colours with their names.
1547		1565
1548	=begin table	1566	=begin table
1549		1567
…		…
1650		1668
1651	=head1 ENVIRONMENT	1669	=head1 ENVIRONMENT
1652		1670
1653	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:	1671	B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1654		1672
1655	=over 4	1673	=over
1656		1674
1657	=item B<TERM>	1675	=item B<TERM>
1658		1676
1659	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via	1677	Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1660	resources or on the command line.	1678	resources or on the command line.
…		…
1731		1749
1732	=back	1750	=back
1733		1751
1734	=head1 FILES	1752	=head1 FILES
1735		1753
1736	=over 4	1754	=over
1737		1755
1738	=item B</usr/lib/X11/rgb.txt>	1756	=item B</usr/lib/X11/rgb.txt>
1739		1757
1740	Colour names.	1758	Colour names.
1741		1759
…		…
1746	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),	1764	@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1747	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)	1765	@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1748		1766
1749	=head1 CURRENT PROJECT COORDINATOR	1767	=head1 CURRENT PROJECT COORDINATOR
1750		1768
1751	=over 4	1769	=over
1752		1770
1753	=item Project Coordinator	1771	=item Project Coordinator
1754		1772
1755	Marc A. Lehmann <rxvt-unicode@schmorp.de>.	1773	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1756		1774
…		…
1758		1776
1759	=back	1777	=back
1760		1778
1761	=head1 AUTHORS	1779	=head1 AUTHORS
1762		1780
1763	=over 4	1781	=over
1764		1782
1765	=item John Bovey	1783	=item John Bovey
1766		1784
1767	University of Kent, 1992, wrote the original Xvt.	1785	University of Kent, 1992, wrote the original Xvt.
1768		1786

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.228 by root, Sun Apr 27 19:43:46 2014 UTC vs. Revision 1.257 by root, Mon Nov 22 17:01:05 2021 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.228 by root, Sun Apr 27 19:43:46 2014 UTC vs.
Revision 1.257 by root, Mon Nov 22 17:01:05 2021 UTC