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