ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.235 by mikachu, Tue Jul 29 13:50:05 2014 UTC vs.
Revision 1.243 by root, Sat May 30 21:02:05 2015 UTC

108of graphical corruption. This is harmless, but we can't do anything about 108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out] 109this, so watch out]
110 110
111=item B<-visual> I<visualID> 111=item B<-visual> I<visualID>
112 112
113Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible 113Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for
114visual ids). 114possible visual ids) instead of the default, and also allocate a private
115colormap. All visual types except for DirectColor are supported.
115 116
116=item B<-geometry> I<geom> 117=item B<-geometry> I<geom>
117 118
118Window geometry (B<-g> still respected); resource B<geometry>. 119Window geometry (B<-g> still respected); resource B<geometry>.
119 120
218`.' or `*' characters. Also sets the icon and title name. 219`.' or `*' characters. Also sets the icon and title name.
219 220
220=item B<-ls>|B<+ls> 221=item B<-ls>|B<+ls>
221 222
222Start as a login-shell/sub-shell; resource B<loginShell>. 223Start as a login-shell/sub-shell; resource B<loginShell>.
224
225=item B<-mc> I<milliseconds>
226
227Specify the maximum time between multi-click selections.
223 228
224=item B<-ut>|B<+ut> 229=item B<-ut>|B<+ut>
225 230
226Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 231Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
227B<utmpInhibit>. 232B<utmpInhibit>.
374 379
375=item B<-pt> I<style> 380=item B<-pt> I<style>
376 381
377Compile I<XIM>: input style for input method; B<OverTheSpot>, 382Compile I<XIM>: input style for input method; B<OverTheSpot>,
378B<OffTheSpot>, B<Root>; resource B<preeditType>. 383B<OffTheSpot>, B<Root>; resource B<preeditType>.
384
385If the perl extension C<xim-onthespot> is used (which is the default),
386then additionally the C<OnTheSpot> preedit type is available.
379 387
380=item B<-im> I<text> 388=item B<-im> I<text>
381 389
382Compile I<XIM>: input method name. resource B<inputMethod>. 390Compile I<XIM>: input method name. resource B<inputMethod>.
383 391
786 794
787B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 795B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
788the shell; option B<-ls>. B<False>: start as a normal sub-shell 796the shell; option B<-ls>. B<False>: start as a normal sub-shell
789[default]; option B<+ls>. 797[default]; option B<+ls>.
790 798
799=item B<multiClickTime:> I<number>
800
801Specify the maximum time in milliseconds between multi-click select
802events. The default is 500 milliseconds; option B<-mc>.
803
791=item B<utmpInhibit:> I<boolean> 804=item B<utmpInhibit:> I<boolean>
792 805
793B<True>: inhibit writing record into the system log file B<utmp>; 806B<True>: inhibit writing record into the system log file B<utmp>;
794option B<-ut>. B<False>: write record into the system log file B<utmp> 807option B<-ut>. B<False>: write record into the system log file B<utmp>
795[default]; option B<+ut>. 808[default]; option B<+ut>.
967 980
968B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 981B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
969 982
970=item B<preeditType:> I<style> 983=item B<preeditType:> I<style>
971 984
972B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 985B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
973 986
974=item B<inputMethod:> I<name> 987=item B<inputMethod:> I<name>
975 988
976I<name> of inputMethod to use; option B<-im>. 989I<name> of inputMethod to use; option B<-im>.
977 990
1110 1123
1111 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n 1124 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1112 1125
1113This could in theory be used to completely redefine your keymap. 1126This could in theory be used to completely redefine your keymap.
1114 1127
1128In addition, for actions of this type, you can define a range of
1129keysyms in one shot by loading the C<keysym-list> perl extension and
1130providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1131the delimiter `/' should be a character not used by the strings.
1132
1133Its usage can be demonstrated by an example:
1134
1135 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1136
1137The 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>
1142
1115=item command:STRING 1143=item command:STRING
1116 1144
1117If I<action> takes the form of C<command:STRING>, the specified B<STRING> 1145If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1118is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically 1146is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1119the opposite of C<string:> - instead of sending it to the program running 1147the opposite of C<string:> - instead of sending it to the program running
1178 1206
1179Similarly, to let applications gain access to the C<C-M-c> (copy to 1207Similarly, to let applications gain access to the C<C-M-c> (copy to
1180clipboard) and C<C-M-v> (paste clipboard) key combination, you can do 1208clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1181this: 1209this:
1182 1210
1183 URxvt.keysym.C-S-c: builtin-string: 1211 URxvt.keysym.C-M-c: builtin-string:
1184 URxvt.keysym.C-S-v: builtin-string: 1212 URxvt.keysym.C-M-v: builtin-string:
1185 1213
1186=item EXTENSION:STRING 1214=item EXTENSION:STRING
1187 1215
1188An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3) 1216An action of this form invokes the action B<STRING>, if any, provided
1189extension of the same name. The extension will be loaded automatically if 1217by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1190necessary. 1218be loaded automatically if necessary.
1191 1219
1192Not all extensions define key actions, but popular extensions that do 1220Not all extensions define actions, but popular extensions that do
1193include the I<selection> and I<matcher> extensions (documented in their 1221include the I<selection> and I<matcher> extensions (documented in their
1194own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1), 1222own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1195respectively). 1223respectively).
1196 1224
1197From the silly examples department, this will rot13-"encrypt" 1225From the silly examples department, this will rot13-"encrypt"
1200 1228
1201 URxvt.keysym.M-C-c: selection:rot13 1229 URxvt.keysym.M-C-c: selection:rot13
1202 1230
1203=item perl:STRING *DEPRECATED* 1231=item perl:STRING *DEPRECATED*
1204 1232
1205This is a deprecated way of passing key mappings to perl extensions. It is 1233This is a deprecated way of invoking commands provided by perl
1206still supported, but should not be used anymore. 1234extensions. It is still supported, but should not be used anymore.
1207 1235
1208=back 1236=back
1209 1237
1210=item B<perl-ext-common>: I<string> 1238=item B<perl-ext-common>: I<string>
1211 1239
1219by default, or specified via the C<perl-ext-common> resource. For 1247by default, or specified via the C<perl-ext-common> resource. For
1220example, C<default,-selection> will use all the default extensions except 1248example, C<default,-selection> will use all the default extensions except
1221C<selection>. 1249C<selection>.
1222 1250
1223The default set includes the C<selection>, C<option-popup>, 1251The default set includes the C<selection>, C<option-popup>,
1224C<selection-popup> and C<readline> extensions, any extensions that define 1252C<selection-popup>, C<readline> and C<searchable-scrollback>
1225keybindings via C<BINDING> meta comments, extensions loaded because 1253extensions, and extensions which are mentioned in B<keysym> resources.
1226their resources/commandline switches were used, and extensions which are 1254
1227mentioned in B<keysym> resources. 1255Any extension such that a corresponding resource is given on the
1256command line is automatically appended to B<perl-ext>.
1228 1257
1229Each extension is looked up in the library directories, loaded if 1258Each extension is looked up in the library directories, loaded if
1230necessary, and bound to the current terminal instance. When the library 1259necessary, and bound to the current terminal instance. When the library
1231search path contains multiple extension files of the same name, then the 1260search path contains multiple extension files of the same name, then the
1232first one found will be used. 1261first one found will be used.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines