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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.222 by sf-exg, Mon Nov 5 13:05:51 2012 UTC vs.
Revision 1.252 by sf-exg, Sat Jul 3 15:32:32 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
…		…
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: Disables (or enables) 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
…		…
781		812
782	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
783	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
784	[default]; option B<+ls>.	815	[default]; option B<+ls>.
785		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
786	=item B<utmpInhibit:> I<boolean>	822	=item B<utmpInhibit:> I<boolean>
787		823
788	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>;
789	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>
790	[default]; option B<+ut>.	826	[default]; option B<+ut>.
…		…
853	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
854	bottom when a non-special key is pressed; option B<+sk>.	890	bottom when a non-special key is pressed; option B<+sk>.
855		891
856	=item B<saveLines:> I<number>	892	=item B<saveLines:> I<number>
857		893
858	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>.
859	resource is limited on most machines to 65535; option B<-sl>.
860		895
861	=item B<internalBorder:> I<number>	896	=item B<internalBorder:> I<number>
862		897
863	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;
864	option B<-b>.	899	option B<-b>.
…		…
927		962
928	=item B<pointerColor2:> I<colour>	963	=item B<pointerColor2:> I<colour>
929		964
930	Mouse pointer background colour.	965	Mouse pointer background colour.
931		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
932	=item B<pointerBlankDelay:> I<number>	973	=item B<pointerBlankDelay:> I<number>
933		974
934	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
935	large number (e.g. C<987654321>) to effectively disable the timeout.	976	large number (e.g. C<987654321>) to effectively disable the timeout.
936		977
…		…
962		1003
963	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>	1004	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
964		1005
965	=item B<preeditType:> I<style>	1006	=item B<preeditType:> I<style>
966		1007
967	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	1008	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
968		1009
969	=item B<inputMethod:> I<name>	1010	=item B<inputMethod:> I<name>
970		1011
971	I<name> of inputMethod to use; option B<-im>.	1012	I<name> of inputMethod to use; option B<-im>.
972		1013
…		…
989	=item B<tripleclickwords:> I<boolean>	1030	=item B<tripleclickwords:> I<boolean>
990		1031
991	Change the meaning of triple-click selection with the left mouse	1032	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	1033	button. Instead of selecting a full line it will extend the selection to
993	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>.
994		1039
995	=item B<insecure:> I<boolean>	1040	=item B<insecure:> I<boolean>
996		1041
997	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that	1042	Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
998	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
…		…
1020		1065
1021	=item B<secondaryScreen:> I<boolean>	1066	=item B<secondaryScreen:> I<boolean>
1022		1067
1023	Turn on/off secondary screen (default enabled).	1068	Turn on/off secondary screen (default enabled).
1024		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
1025	=item B<secondaryScroll:> I<boolean>	1075	=item B<secondaryScroll:> I<boolean>
1026		1076
1027	Turn on/off secondary screen scroll (default enabled). If this	1077	Turn on/off secondary screen scroll (default enabled). If this
1028	option is enabled, scrolls on the secondary screen will change the	1078	option is enabled, scrolls on the secondary screen will change the
1029	scrollback buffer and, when secondaryScreen is off, switching	1079	scrollback buffer and, when secondaryScreen is off, switching
…		…
1041	Sets the working directory for the shell (or the command specified via	1091	Sets the working directory for the shell (or the command specified via
1042	B<-e>). The I<path> must be an absolute path and it must exist for	1092	B<-e>). The I<path> must be an absolute path and it must exist for
1043	@@RXVT_NAME@@ to start. If it isn't specified then the current working	1093	@@RXVT_NAME@@ to start. If it isn't specified then the current working
1044	directory will be used; option B<-cd>.	1094	directory will be used; option B<-cd>.
1045		1095
1046	=item B<keysym.>I<sym>: I<string>	1096	=item B<keysym.>I<sym>: I<action>
1047		1097
1048	Compile I<frills>: Associate I<string> with keysym I<sym>. The	1098	Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1049	intervening resource name B<keysym.> cannot be omitted.	1099	resource name B<keysym.> cannot be omitted.
1050		1100
1051	The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be	1101	Using this resource, you can map key combinations such as
1052	any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,	1102	C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1053	B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,	1103	string than would normally result from that combination, making the
1054	and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,	1104	terminal scroll up or down the way you want it, or any other thing an
1055	B<2>, B<3>, B<4>, B<5>.	1105	extension might provide.
		1106
		1107	The key combination that triggers the action, I<sym>, has the following format:
		1108
		1109	(modifiers-)key
		1110
		1111	Where I<modifiers> can be any combination of the following full or
		1112	abbreviated modifier names:
		1113
		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
1056		1130
1057	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
1058	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
1059	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
1060	current application keymap mode state.	1134	current application keymap mode state.
1061		1135
1062	The spellings of I<key> can be obtained by using B<xev>(1) command or	1136	Due the the large number of modifier combinations, a key mapping will
1063	searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and	1137	match if I<at least> the specified identifiers are being set, and no other
		1138	key mappings with those and more bits are being defined. That means that
		1139	defining a mapping for C<a> will automatically provide definitions for
		1140	C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
		1141	themselves. See the C<builtin:> action, below, for a way to work around
		1142	this when this is a problem.
		1143
		1144	The spelling of I<key> depends on your implementation of X. An easy way to
		1145	find a key name is to use the B<xev>(1) command. You can find a list by
		1146	looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1064	omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex	1147	the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1065	keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not	1148	value (B<0x0000 - 0xFFFF>).
1066	performed in an exact manner; however, the closest match is assured.
1067		1149
1068	I<string> may contain escape values (C<\n>: newline, C<\000>: octal	1150	As with any resource value, the I<action> string may contain backslash
		1151	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1069	number), see RESOURCES in C<man 7 X> for further details.	1152	number), see RESOURCES in C<man 7 X> for further details.
1070		1153
1071	You can define a range of keysyms in one shot by	1154	An action starts with an action prefix that selects a certain type
1072	loading the C<keysym-list> perl extension and providing a I<string>	1155	of action, followed by a colon. An action string without colons is
1073	with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'	1156	interpreted as a literal string to pass to the tty (as if it was
		1157	prefixed with C<string:>).
		1158
		1159	The following action prefixes are known - extensions can provide
		1160	additional prefixes:
		1161
		1162	=over 4
		1163
		1164	=item string:STRING
		1165
		1166	If the I<action> starts with C<string:> (or otherwise contains no colons),
		1167	then the remaining C<STRING> will be passed to the program running in the
		1168	terminal. For example, you could replace whatever Shift-Tab outputs by the
		1169	string C<echo rm -rf /> followed by a newline:
		1170
		1171	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
		1172
		1173	This could in theory be used to completely redefine your keymap.
		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
1074	should be a character not used by the strings.	1178	the delimiter `/' should be a character not used by the strings.
1075		1179
1076	Its usage can be demonstrated by an example:	1180	Its usage can be demonstrated by an example:
1077		1181
1078	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>	1182	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
1079		1183
1080	The above line is equivalent to the following three lines:	1184	The above line is equivalent to the following three lines:
1081		1185
1082	URxvt.keysym.Meta-Control-0x61: \033<a>	1186	URxvt.keysym.Meta-Control-0x61: string:\033<a>
1083	URxvt.keysym.Meta-Control-0x62: \033<b>	1187	URxvt.keysym.Meta-Control-0x62: string:\033<b>
1084	URxvt.keysym.Meta-Control-0x63: \033<c>	1188	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1085		1189
		1190	=item command:STRING
		1191
1086	If I<string> 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>
1087	is interpreted and executed as @@RXVT_NAME@@'s control sequence. For	1193	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
		1194	the opposite of C<string:> - instead of sending it to the program running
		1195	in the terminal, it will be treated as if it were program output). This is
		1196	most useful to feed command sequences into @@RXVT_NAME@@.
		1197
1088	example the following means "change the current locale to C<zh_CN.GBK>	1198	For example the following means "change the current locale to C<zh_CN.GBK>
1089	when Control-Meta-c is being pressed":	1199	when Control-Meta-c is being pressed":
1090		1200
1091	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007	1201	URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1092		1202
1093	If I<string> takes the form C<perl:STRING>, then the specified B<STRING>	1203	The following example will map Control-Meta-1 and Control-Meta-2 to
1094	is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)	1204	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1095	manpage. For example, the F<selection> extension (activated via	1205	font-switching at runtime:
1096	C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1097		1206
1098	URxvt.keysym.M-C-c: perl:selection:rot13	1207	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
		1208	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1099		1209
1100	Due the the large number of modifier combinations, a defined key mapping	1210	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1101	will match if I<at least> the specified identifiers are being set, and	1211	info):
1102	no other key mappings with those and more bits are being defined. That
1103	means that defining a key map for C<a> will automatically provide
1104	definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1105	mappings themselves.
1106		1212
1107	Unfortunately, this will override built-in key mappings. For example	1213	URxvt.keysym.M-C-3: command:\033[8;25;80t
		1214	URxvt.keysym.M-C-4: command:\033[8;48;110t
		1215
		1216	=item builtin:
		1217
		1218	The builtin action is the action that @@RXVT_NAME@@ would execute if no
		1219	key binding existed for the key combination. The obvious use is to undo
		1220	the effect of existing bindings. The not so obvious use is to reinstate
		1221	bindings when another binding overrides too many modifiers.
		1222
1108	if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s	1223	For example if you overwrite the C<Insert> key you will disable
1109	C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the	1224	@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1110	user-defined keymap using the C<builtin:> replacement:	1225	"holes" into the user-defined keymap using the C<builtin:> replacement:
1111		1226
1112	URxvt.keysym.Insert: <my insert key sequence>	1227	URxvt.keysym.Insert: <my insert key sequence>
1113	URxvt.keysym.S-Insert: builtin:	1228	URxvt.keysym.S-Insert: builtin:
1114		1229
1115	The first line defines a mapping for C<Insert> and I<any> combination	1230	The first line defines a mapping for C<Insert> and I<any> combination
1116	of modifiers. The second line re-establishes the default mapping for	1231	of modifiers. The second line re-establishes the default mapping for
1117	C<Shift-Insert>.	1232	C<Shift-Insert>.
1118		1233
1119	The following example will map Control-Meta-1 and Control-Meta-2 to	1234	=item builtin-string:
1120	the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1121	font-switching at runtime:
1122		1235
1123	URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007	1236	This action is mainly useful to restore string mappings for keys that
1124	URxvt.keysym.M-C-2: command:\033]50;9x15bold\007	1237	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1238	difficult to explain - basically, this action will send the string to the
		1239	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1240	action for it.
1125		1241
1126	Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more	1242	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1127	info):	1243	selection when you press C<Shift-Insert>. With the following bindings, it
		1244	would instead emit the (undocumented, but what applications running in the
		1245	terminal might expect) sequence C<ESC [ 2 $> instead:
1128		1246
1129	URxvt.keysym.M-C-3: command:\033[8;25;80t	1247	URxvt.keysym.S-Insert: builtin-string:
1130	URxvt.keysym.M-C-4: command:\033[8;48;110t	1248	URxvt.keysym.C-S-Insert: builtin:
		1249
		1250	The first line disables the paste functionality for that key
		1251	combination, and the second reinstates the default behaviour for
		1252	C<Control-Shift-Insert>, which would otherwise be overridden.
		1253
		1254	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1255	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1256	this:
		1257
		1258	URxvt.keysym.C-M-c: builtin-string:
		1259	URxvt.keysym.C-M-v: builtin-string:
		1260
		1261	=item EXTENSION:STRING
		1262
		1263	An action of this form invokes the action B<STRING>, if any, provided
		1264	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
		1265	be loaded automatically if necessary.
		1266
		1267	Not all extensions define actions, but popular extensions that do
		1268	include the I<selection> and I<matcher> extensions (documented in their
		1269	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
		1270	respectively).
		1271
		1272	From the silly examples department, this will rot13-"encrypt"
		1273	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
		1274	keyboards:
		1275
		1276	URxvt.keysym.M-C-c: selection:rot13
		1277
		1278	=item perl:STRING DEPRECATED
		1279
		1280	This is a deprecated way of invoking commands provided by perl
		1281	extensions. It is still supported, but should not be used anymore.
		1282
		1283	=back
1131		1284
1132	=item B<perl-ext-common>: I<string>	1285	=item B<perl-ext-common>: I<string>
1133		1286
1134	=item B<perl-ext>: I<string>	1287	=item B<perl-ext>: I<string>
1135		1288
…		…
1137	use in this terminal instance; option B<-pe>.	1290	use in this terminal instance; option B<-pe>.
1138		1291
1139	Extension names can be prefixed with a C<-> sign to prohibit using	1292	Extension names can be prefixed with a C<-> sign to prohibit using
1140	them. This can be useful to selectively disable some extensions loaded	1293	them. This can be useful to selectively disable some extensions loaded
1141	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
1142	example, C<default,-selection> will use all the default extension except	1295	example, C<default,-selection> will use all the default extensions except
1143	C<selection>.	1296	C<selection>.
1144		1297
1145	Extension names can also be followed by an argument in angle brackets	1298	The default set includes the C<selection>, C<option-popup>,
1146	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1299	C<selection-popup>, C<readline> and C<searchable-scrollback>
1147	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1300	extensions, and extensions which are mentioned in B<keysym> resources.
1148	multiple times with different arguments will pass multiple arguments to	1301
1149	the extension.	1302	Any extension such that a corresponding resource is given on the
		1303	command line is automatically appended to B<perl-ext>.
1150		1304
1151	Each extension is looked up in the library directories, loaded if	1305	Each extension is looked up in the library directories, loaded if
1152	necessary, and bound to the current terminal instance.	1306	necessary, and bound to the current terminal instance. When the library
		1307	search path contains multiple extension files of the same name, then the
		1308	first one found will be used.
1153		1309
1154	If both of these resources are the empty string, then the perl	1310	If both of these resources are the empty string, then the perl interpreter
1155	interpreter will not be initialized. The idea behind two options is that	1311	will not be initialized. The rationale for having two options is that
1156	B<perl-ext-common> will be used for extensions that should be available to	1312	B<perl-ext-common> will be used for extensions that should be available to
1157	all instances, while B<perl-ext> is used for specific instances.	1313	all instances, while B<perl-ext> is used for specific instances.
1158		1314
1159	=item B<perl-eval>: I<string>	1315	=item B<perl-eval>: I<string>
1160		1316
…		…
1178	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1334	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1179		1335
1180	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1336	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1181	for details.	1337	for details.
1182		1338
1183	=item B<searchable-scrollback:> I<keysym>	1339	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1184		1340
1185	Sets the hotkey that starts the incremental scrollback buffer search	1341	This resource is deprecated and will be removed. Use a B<keysym> resource
1186	(default: C<M-s>).	1342	instead, e.g.:
		1343
		1344	URxvt.keysym.M-s: searchable-scrollback:start
1187		1345
1188	=item B<url-launcher>: I<string>	1346	=item B<url-launcher>: I<string>
1189		1347
1190	Specifies the program to be started with a URL argument. Used by the	1348	Specifies the program to be started with a URL argument. Used by the
1191	C<selection-popup> and C<matcher> perl extensions.	1349	C<selection-popup> and C<matcher> perl extensions.
…		…
1204	Turn on/off ISO 14755 (default enabled).	1362	Turn on/off ISO 14755 (default enabled).
1205		1363
1206	=item B<iso14755_52:> I<boolean>	1364	=item B<iso14755_52:> I<boolean>
1207		1365
1208	Turn on/off ISO 14755 5.2 mode (default enabled).	1366	Turn on/off ISO 14755 5.2 mode (default enabled).
1209
1210	=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1211
1212	=item B<-pixmap> I<file[;oplist]>
1213
1214	=item B<backgroundPixmap:> I<file[;oplist]>
1215
1216	Compile I<pixbuf>: Use the specified image file as the window's
1217	background and also optionally specify a colon separated list of
1218	operations to modify it. Note that you may need to quote the C<;>
1219	character when using the command line option, as C<;> is usually a
1220	metacharacter in shells. Supported operations are:
1221
1222	=over 4
1223
1224	=item B<WxH+X+Y>
1225
1226	sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1227	scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1228	scale of 0 disables scaling.
1229
1230	=item B<op=tile>
1231
1232	enables tiling
1233
1234	=item B<op=keep-aspect>
1235
1236	maintain the image aspect ratio when scaling
1237
1238	=item B<op=root-align>
1239
1240	use the position of the terminal window relative to the root window as
1241	the image offset, simulating a root window background
1242
1243	=back
1244
1245	The default scale and position setting is C<100x100+50+50>.
1246	Alternatively, a predefined set of templates can be used to achieve
1247	the most common setups:
1248
1249	=over 4
1250
1251	=item B<style=tiled>
1252
1253	the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1254
1255	=item B<style=aspect-stretched>
1256
1257	the image is scaled to fill the whole window maintaining the aspect
1258	ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1259
1260	=item B<style=stretched>
1261
1262	the image is scaled to fill the whole window. Equivalent to 100x100
1263
1264	=item B<style=centered>
1265
1266	the image is centered with no scaling. Equivalent to 0x0+50+50
1267
1268	=item B<style=root-tiled>
1269
1270	the image is tiled with no scaling and using 'root' positioning.
1271	Equivalent to 0x0:op=tile:op=root-align
1272
1273	=back
1274
1275	If multiple templates are specified the last one wins. Note that a
1276	template overrides all the scale, position and operations settings.
1277
1278	If used in conjunction with pseudo-transparency, the specified pixmap
1279	will be blended over the transparent background using alpha-blending.
1280
1281	=item B<-tr>\|B<+tr>
1282
1283	=item B<transparent:> I<boolean>
1284
1285	Turn on/off pseudo-transparency by using the root pixmap as background.
1286
1287	B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1288	will be removed in future versions.
1289
1290	=item B<-tint> I<colour>
1291
1292	=item B<tintColor:> I<colour>
1293
1294	Tint the transparent background with the given colour. Note that a
1295	black tint yields a completely black image while a white tint yields
1296	the image unchanged.
1297
1298	=item B<-sh> I<number>
1299
1300	=item B<shading:> I<number>
1301
1302	Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1303	A value of 100 means no shading.
1304
1305	=item B<-blr> I<HxV>
1306
1307	=item B<blurRadius:> I<HxV>
1308
1309	Apply gaussian blur with the specified radius to the transparent
1310	background. If a single number is specified, the vertical and
1311	horizontal radii are considered to be the same. Setting one of the
1312	radii to 1 and the other to a large number creates interesting effects
1313	on some backgrounds. The maximum radius value is 128. An horizontal or
1314	vertical radius of 0 disables blurring.
1315
1316	=item B<path:> I<path>
1317
1318	Specify the colon-delimited search path for finding background image files.
1319		1367
1320	=back	1368	=back
1321		1369
1322	=head1 THE SCROLLBAR	1370	=head1 THE SCROLLBAR
1323		1371
…		…
1371	window causes the value of the PRIMARY selection (or CLIPBOARD with the	1419	window causes the value of the PRIMARY selection (or CLIPBOARD with the
1372	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.	1420	B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1373		1421
1374	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be	1422	Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1375	inserted too.	1423	inserted too.
		1424
		1425	rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
		1426	<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
		1427	binding causes the value of the internal selection to be copied to the
		1428	CLIPBOARD selection, while the second binding causes the value of the
		1429	CLIPBOARD selection to be inserted.
1376		1430
1377	=back	1431	=back
1378		1432
1379	=head1 CHANGING FONTS	1433	=head1 CHANGING FONTS
1380		1434
…		…
1469	In addition to the default foreground and background colours,	1523	In addition to the default foreground and background colours,
1470	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
1471	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
1472	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
1473	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.
1474		1537
1475	Here is a list of the ANSI colours with their names.	1538	Here is a list of the ANSI colours with their names.
1476		1539
1477	=begin table	1540	=begin table
1478		1541
…		…
1505	The following text gives values for the standard 88 colour mode (and	1568	The following text gives values for the standard 88 colour mode (and
1506	values for the 256 colour mode in parentheses).	1569	values for the 256 colour mode in parentheses).
1507		1570
1508	The RGB cube uses indices 16..79 (16..231) using the following formulas:	1571	The RGB cube uses indices 16..79 (16..231) using the following formulas:
1509		1572
1510	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3	1573	index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1511	index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15	1574	index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1512		1575
1513	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%	1576	The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1514	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of	1577	steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1515	the RGB cube.	1578	the RGB cube.
1516		1579
…		…
1679		1742
1680	=over 4	1743	=over 4
1681		1744
1682	=item Project Coordinator	1745	=item Project Coordinator
1683		1746
1684	Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>	1747	Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1685		1748
1686	L<http://software.schmorp.de/pkg/rxvt-unicode.html>	1749	L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1687		1750
1688	=back	1751	=back
1689		1752
…		…
1693		1756
1694	=item John Bovey	1757	=item John Bovey
1695		1758
1696	University of Kent, 1992, wrote the original Xvt.	1759	University of Kent, 1992, wrote the original Xvt.
1697		1760
1698	=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >>	1761	=item Rob Nation <nation@rocket.sanders.lockheed.com>
1699		1762
1700	very heavily modified Xvt and came up with Rxvt	1763	very heavily modified Xvt and came up with Rxvt
1701		1764
1702	=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >>	1765	=item Angelo Haritsis <ah@doc.ic.ac.uk>
1703		1766
1704	wrote the Greek Keyboard Input (no longer in code)	1767	wrote the Greek Keyboard Input (no longer in code)
1705		1768
1706	=item mj olesen L<< <olesen@me.QueensU.CA> >>	1769	=item mj olesen <olesen@me.QueensU.CA>
1707		1770
1708	Wrote the menu system.	1771	Wrote the menu system.
1709		1772
1710	Project Coordinator (changes.txt 2.11 to 2.21)	1773	Project Coordinator (changes.txt 2.11 to 2.21)
1711		1774
1712	=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >>	1775	=item Oezguer Kesim <kesim@math.fu-berlin.de>
1713		1776
1714	Project Coordinator (changes.txt 2.21a to 2.4.5)	1777	Project Coordinator (changes.txt 2.21a to 2.4.5)
1715		1778
1716	=item Geoff Wing L<< <gcw@pobox.com> >>	1779	=item Geoff Wing <gcw@pobox.com>
1717		1780
1718	Rewrote screen display and text selection routines.	1781	Rewrote screen display and text selection routines.
1719		1782
1720	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)	1783	Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1721		1784
1722	=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>	1785	=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1723		1786
1724	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl	1787	Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1725	extension, random hacks, numerous bugfixes and extensions.	1788	extension, random hacks, numerous bugfixes and extensions.
1726		1789
1727	Project Coordinator (Changes 1.0 -)	1790	Project Coordinator (Changes 1.0 -)
1728		1791
1729	=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>	1792	=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1730		1793
1731	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.	1794	pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1732		1795
1733	=back	1796	=back
1734		1797

Diff Legend

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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents): Revision 1.222 by sf-exg, Mon Nov 5 13:05:51 2012 UTC vs. Revision 1.252 by sf-exg, Sat Jul 3 15:32:32 2021 UTC

Diff Legend

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.222 by sf-exg, Mon Nov 5 13:05:51 2012 UTC vs.
Revision 1.252 by sf-exg, Sat Jul 3 15:32:32 2021 UTC