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