[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.240 by sf-exg, Mon Oct 13 17:05:32 2014 UTC

…		…
219		219
220	=item B<-ls>\|B<+ls>	220	=item B<-ls>\|B<+ls>
221		221
222	Start as a login-shell/sub-shell; resource B<loginShell>.	222	Start as a login-shell/sub-shell; resource B<loginShell>.
223		223
		224	=item B<-mc> I<milliseconds>
		225
		226	Specify the maximum time between multi-click selections.
		227
224	=item B<-ut>\|B<+ut>	228	=item B<-ut>\|B<+ut>
225		229
226	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource	230	Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
227	B<utmpInhibit>.	231	B<utmpInhibit>.
228		232
…		…
306		310
307	=item B<-override-redirect>	311	=item B<-override-redirect>
308		312
309	Compile I<frills>: Sets override-redirect on the window; resource	313	Compile I<frills>: Sets override-redirect on the window; resource
310	B<override-redirect>.	314	B<override-redirect>.
		315
		316	=item B<-dockapp>
		317
		318	Sets the initial state of the window to WithdrawnState, which makes
		319	window managers that support this extension treat it as a dockapp.
311		320
312	=item B<-sbg>	321	=item B<-sbg>
313		322
314	Compile I<frills>: Disable the usage of the built-in block graphics/line	323	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	324	drawing characters and just rely on what the specified fonts provide. Use
…		…
781		790
782	B<True>: start as a login shell by prepending a `-' to B<argv[0]> of	791	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	792	the shell; option B<-ls>. B<False>: start as a normal sub-shell
784	[default]; option B<+ls>.	793	[default]; option B<+ls>.
785		794
		795	=item B<multiClickTime:> I<number>
		796
		797	Specify the maximum time in milliseconds between multi-click select
		798	events. The default is 500 milliseconds; option B<-mc>.
		799
786	=item B<utmpInhibit:> I<boolean>	800	=item B<utmpInhibit:> I<boolean>
787		801
788	B<True>: inhibit writing record into the system log file B<utmp>;	802	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>	803	option B<-ut>. B<False>: write record into the system log file B<utmp>
790	[default]; option B<+ut>.	804	[default]; option B<+ut>.
…		…
1055	extension might provide.	1069	extension might provide.
1056		1070
1057	The key combination that triggers the action, I<sym>, has the following format:	1071	The key combination that triggers the action, I<sym>, has the following format:
1058		1072
1059	(modifiers-)key	1073	(modifiers-)key
1060		1074
1061	Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,	1075	Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
1062	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,	1076	B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
1063	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,	1077	B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
1064	B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.	1078	B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1065		1079
…		…
1085	As with any resource value, the I<action> string may contain backslash	1099	As with any resource value, the I<action> string may contain backslash
1086	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal	1100	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1087	number), see RESOURCES in C<man 7 X> for further details.	1101	number), see RESOURCES in C<man 7 X> for further details.
1088		1102
1089	An action starts with an action prefix that selects a certain type	1103	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	1104	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	1105	interpreted as a literal string to pass to the tty (as if it was
1092	prefixed with C<string:>).	1106	prefixed with C<string:>).
1093		1107
1094	The following action prefixes are known - extensions can provide	1108	The following action prefixes are known - extensions can provide
1095	additional prefixes:	1109	additional prefixes:
1096		1110
…		…
1104	string C<echo rm -rf /> followed by a newline:	1118	string C<echo rm -rf /> followed by a newline:
1105		1119
1106	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n	1120	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1107		1121
1108	This could in theory be used to completely redefine your keymap.	1122	This could in theory be used to completely redefine your keymap.
		1123
		1124	In addition, for actions of this type, you can define a range of
		1125	keysyms in one shot by loading the C<keysym-list> perl extension and
		1126	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
		1127	the delimiter `/' should be a character not used by the strings.
		1128
		1129	Its usage can be demonstrated by an example:
		1130
		1131	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
		1132
		1133	The above line is equivalent to the following three lines:
		1134
		1135	URxvt.keysym.Meta-Control-0x61: string:\033<a>
		1136	URxvt.keysym.Meta-Control-0x62: string:\033<b>
		1137	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1109		1138
1110	=item command:STRING	1139	=item command:STRING
1111		1140
1112	If I<action> takes the form of C<command:STRING>, the specified B<STRING>	1141	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	1142	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
…		…
1149		1178
1150	The first line defines a mapping for C<Insert> and I<any> combination	1179	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	1180	of modifiers. The second line re-establishes the default mapping for
1152	C<Shift-Insert>.	1181	C<Shift-Insert>.
1153		1182
		1183	=item builtin-string:
		1184
		1185	This action is mainly useful to restore string mappings for keys that
		1186	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1187	difficult to explain - basically, this action will send the string to the
		1188	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1189	action for it.
		1190
		1191	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
		1192	selection when you press C<Shift-Insert>. With the following bindings, it
		1193	would instead emit the (undocumented, but what applications running in the
		1194	terminal might expect) sequence C<ESC [ 2 $> instead:
		1195
		1196	URxvt.keysym.S-Insert: builtin-string:
		1197	URxvt.keysym.C-S-Insert: builtin:
		1198
		1199	The first line disables the paste functionality for that key
		1200	combination, and the second reinstates the default behaviour for
		1201	C<Control-Shift-Insert>, which would otherwise be overridden.
		1202
		1203	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1204	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1205	this:
		1206
		1207	URxvt.keysym.C-M-c: builtin-string:
		1208	URxvt.keysym.C-M-v: builtin-string:
		1209
1154	=item EXTENSION:STRING	1210	=item EXTENSION:STRING
1155		1211
1156	An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)	1212	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	1213	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1158	neccessary.	1214	be loaded automatically if necessary.
1159		1215
1160	Not all extensions define key actions, but popular extensions that do	1216	Not all extensions define actions, but popular extensions that do
1161	include the I<selection> and I<matcher> extensions (documented in their	1217	include the I<selection> and I<matcher> extensions (documented in their
1162	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),	1218	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1163	respectively).	1219	respectively).
1164		1220
1165	From the silly examples department, this will rot13-"encrypt"	1221	From the silly examples department, this will rot13-"encrypt"
1166	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC	1222	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1167	keyboards:	1223	keyboards:
1168		1224
1169	URxvt.keysym.M-C-c: selection:rot13	1225	URxvt.keysym.M-C-c: selection:rot13
1170		1226
1171	=item perl:STRING	1227	=item perl:STRING DEPRECATED
1172		1228
1173	This is a deprecated way of passing key mappings to perl extensions. It is	1229	This is a deprecated way of invoking commands provided by perl
1174	still supported, but should not be used anymore.	1230	extensions. It is still supported, but should not be used anymore.
1175		1231
1176	=back	1232	=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		1233
1193	=item B<perl-ext-common>: I<string>	1234	=item B<perl-ext-common>: I<string>
1194		1235
1195	=item B<perl-ext>: I<string>	1236	=item B<perl-ext>: I<string>
1196		1237
…		…
1198	use in this terminal instance; option B<-pe>.	1239	use in this terminal instance; option B<-pe>.
1199		1240
1200	Extension names can be prefixed with a C<-> sign to prohibit using	1241	Extension names can be prefixed with a C<-> sign to prohibit using
1201	them. This can be useful to selectively disable some extensions loaded	1242	them. This can be useful to selectively disable some extensions loaded
1202	by default, or specified via the C<perl-ext-common> resource. For	1243	by default, or specified via the C<perl-ext-common> resource. For
1203	example, C<default,-selection> will use all the default extension except	1244	example, C<default,-selection> will use all the default extensions except
1204	C<selection>.	1245	C<selection>.
1205		1246
1206	Extension names can also be followed by an argument in angle brackets	1247	The default set includes the C<selection>, C<option-popup>,
1207	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1248	C<selection-popup> and C<readline> extensions, any extensions that
1208	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1249	define keybindings via C<BINDING> meta comments, and extensions which
1209	multiple times with different arguments will pass multiple arguments to	1250	are mentioned in B<keysym> resources.
1210	the extension.	1251
		1252	Any extension such that a corresponding resource is given on the
		1253	command line is automatically appended to B<perl-ext>.
1211		1254
1212	Each extension is looked up in the library directories, loaded if	1255	Each extension is looked up in the library directories, loaded if
1213	necessary, and bound to the current terminal instance.	1256	necessary, and bound to the current terminal instance. When the library
		1257	search path contains multiple extension files of the same name, then the
		1258	first one found will be used.
1214		1259
1215	If both of these resources are the empty string, then the perl	1260	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	1261	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	1262	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.	1263	all instances, while B<perl-ext> is used for specific instances.
1219		1264
1220	=item B<perl-eval>: I<string>	1265	=item B<perl-eval>: I<string>
1221		1266
…		…
1239	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1284	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1240		1285
1241	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1286	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1242	for details.	1287	for details.
1243		1288
1244	=item B<searchable-scrollback:> I<keysym>	1289	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1245		1290
1246	Sets the hotkey that starts the incremental scrollback buffer search	1291	This resource is deprecated and will be removed. Use a B<keysym> resource
1247	(default: C<M-s>).	1292	instead, e.g.:
		1293
		1294	URxvt.keysym.M-s: searchable-scrollback:start
1248		1295
1249	=item B<url-launcher>: I<string>	1296	=item B<url-launcher>: I<string>
1250		1297
1251	Specifies the program to be started with a URL argument. Used by the	1298	Specifies the program to be started with a URL argument. Used by the
1252	C<selection-popup> and C<matcher> perl extensions.	1299	C<selection-popup> and C<matcher> perl extensions.

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.240 by sf-exg, Mon Oct 13 17:05:32 2014 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.240 by sf-exg, Mon Oct 13 17:05:32 2014 UTC