[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.246 by sf-exg, Tue Jun 21 12:03:55 2016 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>.
…		…
853	are not passed onto the shell; option B<-sk>. B<False>: do not scroll to	871	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>.	872	bottom when a non-special key is pressed; option B<+sk>.
855		873
856	=item B<saveLines:> I<number>	874	=item B<saveLines:> I<number>
857		875
858	Save I<number> lines in the scrollback buffer [default 64]. This	876	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		877
861	=item B<internalBorder:> I<number>	878	=item B<internalBorder:> I<number>
862		879
863	Internal border of I<number> pixels. This resource is limited to 100;	880	Internal border of I<number> pixels. This resource is limited to 100;
864	option B<-b>.	881	option B<-b>.
…		…
927		944
928	=item B<pointerColor2:> I<colour>	945	=item B<pointerColor2:> I<colour>
929		946
930	Mouse pointer background colour.	947	Mouse pointer background colour.
931		948
		949	=item B<pointerShape:> I<string>
		950
		951	Compile I<frills>: Specifies the name of the mouse pointer shape
		952	[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
		953	file for possible values (omit the C<XC_> prefix).
		954
932	=item B<pointerBlankDelay:> I<number>	955	=item B<pointerBlankDelay:> I<number>
933		956
934	Specifies number of seconds before blanking the pointer [default 2]. Use a	957	Specifies number of seconds before blanking the pointer [default 2]. Use a
935	large number (e.g. C<987654321>) to effectively disable the timeout.	958	large number (e.g. C<987654321>) to effectively disable the timeout.
936		959
…		…
962		985
963	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>	986	B<< BACKSLASH `"'&()*,;<=>?@[]^{\|} >>
964		987
965	=item B<preeditType:> I<style>	988	=item B<preeditType:> I<style>
966		989
967	B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.	990	B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
968		991
969	=item B<inputMethod:> I<name>	992	=item B<inputMethod:> I<name>
970		993
971	I<name> of inputMethod to use; option B<-im>.	994	I<name> of inputMethod to use; option B<-im>.
972		995
…		…
1055	extension might provide.	1078	extension might provide.
1056		1079
1057	The key combination that triggers the action, I<sym>, has the following format:	1080	The key combination that triggers the action, I<sym>, has the following format:
1058		1081
1059	(modifiers-)key	1082	(modifiers-)key
1060		1083
1061	Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,	1084	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>,	1085	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>,	1086	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>.	1087	B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
1065		1088
…		…
1085	As with any resource value, the I<action> string may contain backslash	1108	As with any resource value, the I<action> string may contain backslash
1086	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal	1109	escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1087	number), see RESOURCES in C<man 7 X> for further details.	1110	number), see RESOURCES in C<man 7 X> for further details.
1088		1111
1089	An action starts with an action prefix that selects a certain type	1112	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	1113	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	1114	interpreted as a literal string to pass to the tty (as if it was
1092	prefixed with C<string:>).	1115	prefixed with C<string:>).
1093		1116
1094	The following action prefixes are known - extensions can provide	1117	The following action prefixes are known - extensions can provide
1095	additional prefixes:	1118	additional prefixes:
1096		1119
…		…
1104	string C<echo rm -rf /> followed by a newline:	1127	string C<echo rm -rf /> followed by a newline:
1105		1128
1106	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n	1129	URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1107		1130
1108	This could in theory be used to completely redefine your keymap.	1131	This could in theory be used to completely redefine your keymap.
		1132
		1133	In addition, for actions of this type, you can define a range of
		1134	keysyms in one shot by loading the C<keysym-list> perl extension and
		1135	providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
		1136	the delimiter `/' should be a character not used by the strings.
		1137
		1138	Its usage can be demonstrated by an example:
		1139
		1140	URxvt.keysym.M-C-0x61: list\|\033<\|abc\|>
		1141
		1142	The above line is equivalent to the following three lines:
		1143
		1144	URxvt.keysym.Meta-Control-0x61: string:\033<a>
		1145	URxvt.keysym.Meta-Control-0x62: string:\033<b>
		1146	URxvt.keysym.Meta-Control-0x63: string:\033<c>
1109		1147
1110	=item command:STRING	1148	=item command:STRING
1111		1149
1112	If I<action> takes the form of C<command:STRING>, the specified B<STRING>	1150	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	1151	is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
…		…
1149		1187
1150	The first line defines a mapping for C<Insert> and I<any> combination	1188	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	1189	of modifiers. The second line re-establishes the default mapping for
1152	C<Shift-Insert>.	1190	C<Shift-Insert>.
1153		1191
		1192	=item builtin-string:
		1193
		1194	This action is mainly useful to restore string mappings for keys that
		1195	have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
		1196	difficult to explain - basically, this action will send the string to the
		1197	application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
		1198	action for it.
		1199
		1200	An example might make it clearer: @@RXVT_NAME@@ normally pastes the
		1201	selection when you press C<Shift-Insert>. With the following bindings, it
		1202	would instead emit the (undocumented, but what applications running in the
		1203	terminal might expect) sequence C<ESC [ 2 $> instead:
		1204
		1205	URxvt.keysym.S-Insert: builtin-string:
		1206	URxvt.keysym.C-S-Insert: builtin:
		1207
		1208	The first line disables the paste functionality for that key
		1209	combination, and the second reinstates the default behaviour for
		1210	C<Control-Shift-Insert>, which would otherwise be overridden.
		1211
		1212	Similarly, to let applications gain access to the C<C-M-c> (copy to
		1213	clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
		1214	this:
		1215
		1216	URxvt.keysym.C-M-c: builtin-string:
		1217	URxvt.keysym.C-M-v: builtin-string:
		1218
1154	=item EXTENSION:STRING	1219	=item EXTENSION:STRING
1155		1220
1156	An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)	1221	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	1222	by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1158	neccessary.	1223	be loaded automatically if necessary.
1159		1224
1160	Not all extensions define key actions, but popular extensions that do	1225	Not all extensions define actions, but popular extensions that do
1161	include the I<selection> and I<matcher> extensions (documented in their	1226	include the I<selection> and I<matcher> extensions (documented in their
1162	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),	1227	own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1163	respectively).	1228	respectively).
1164		1229
1165	From the silly examples department, this will rot13-"encrypt"	1230	From the silly examples department, this will rot13-"encrypt"
1166	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC	1231	@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1167	keyboards:	1232	keyboards:
1168		1233
1169	URxvt.keysym.M-C-c: selection:rot13	1234	URxvt.keysym.M-C-c: selection:rot13
1170		1235
1171	=item perl:STRING	1236	=item perl:STRING DEPRECATED
1172		1237
1173	This is a deprecated way of passing key mappings to perl extensions. It is	1238	This is a deprecated way of invoking commands provided by perl
1174	still supported, but should not be used anymore.	1239	extensions. It is still supported, but should not be used anymore.
1175		1240
1176	=back	1241	=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		1242
1193	=item B<perl-ext-common>: I<string>	1243	=item B<perl-ext-common>: I<string>
1194		1244
1195	=item B<perl-ext>: I<string>	1245	=item B<perl-ext>: I<string>
1196		1246
…		…
1198	use in this terminal instance; option B<-pe>.	1248	use in this terminal instance; option B<-pe>.
1199		1249
1200	Extension names can be prefixed with a C<-> sign to prohibit using	1250	Extension names can be prefixed with a C<-> sign to prohibit using
1201	them. This can be useful to selectively disable some extensions loaded	1251	them. This can be useful to selectively disable some extensions loaded
1202	by default, or specified via the C<perl-ext-common> resource. For	1252	by default, or specified via the C<perl-ext-common> resource. For
1203	example, C<default,-selection> will use all the default extension except	1253	example, C<default,-selection> will use all the default extensions except
1204	C<selection>.	1254	C<selection>.
1205		1255
1206	Extension names can also be followed by an argument in angle brackets	1256	The default set includes the C<selection>, C<option-popup>,
1207	(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for	1257	C<selection-popup>, C<readline> and C<searchable-scrollback>
1208	searchable scrollback to Alt/Meta-s). Mentioning the same extension	1258	extensions, and extensions which are mentioned in B<keysym> resources.
1209	multiple times with different arguments will pass multiple arguments to	1259
1210	the extension.	1260	Any extension such that a corresponding resource is given on the
		1261	command line is automatically appended to B<perl-ext>.
1211		1262
1212	Each extension is looked up in the library directories, loaded if	1263	Each extension is looked up in the library directories, loaded if
1213	necessary, and bound to the current terminal instance.	1264	necessary, and bound to the current terminal instance. When the library
		1265	search path contains multiple extension files of the same name, then the
		1266	first one found will be used.
1214		1267
1215	If both of these resources are the empty string, then the perl	1268	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	1269	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	1270	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.	1271	all instances, while B<perl-ext> is used for specific instances.
1219		1272
1220	=item B<perl-eval>: I<string>	1273	=item B<perl-eval>: I<string>
1221		1274
…		…
1239	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>	1292	=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1240		1293
1241	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage	1294	Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1242	for details.	1295	for details.
1243		1296
1244	=item B<searchable-scrollback:> I<keysym>	1297	=item B<searchable-scrollback:> I<keysym> DEPRECATED
1245		1298
1246	Sets the hotkey that starts the incremental scrollback buffer search	1299	This resource is deprecated and will be removed. Use a B<keysym> resource
1247	(default: C<M-s>).	1300	instead, e.g.:
		1301
		1302	URxvt.keysym.M-s: searchable-scrollback:start
1248		1303
1249	=item B<url-launcher>: I<string>	1304	=item B<url-launcher>: I<string>
1250		1305
1251	Specifies the program to be started with a URL argument. Used by the	1306	Specifies the program to be started with a URL argument. Used by the
1252	C<selection-popup> and C<matcher> perl extensions.	1307	C<selection-popup> and C<matcher> perl extensions.
…		…
1540	In addition to the default foreground and background colours,	1595	In addition to the default foreground and background colours,
1541	B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus	1596	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	1597	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	1598	240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1544	cube plus a 8 (24) colour greyscale ramp.	1599	cube plus a 8 (24) colour greyscale ramp.
		1600
		1601	B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
		1602	C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
		1603	number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
		1604	colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
		1605	24-bit colour space. When indexing collisions happen, the nearest old colour in
		1606	the cube will be adapted to the new 24-bit RGB colour. That means one cannot
		1607	use many similar 24-bit colours. It's typically not a problem in common
		1608	scenarios.
1545		1609
1546	Here is a list of the ANSI colours with their names.	1610	Here is a list of the ANSI colours with their names.
1547		1611
1548	=begin table	1612	=begin table
1549		1613

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.246 by sf-exg, Tue Jun 21 12:03:55 2016 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.246 by sf-exg, Tue Jun 21 12:03:55 2016 UTC