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.244 by sf-exg, Tue Jun 16 11:58:26 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>.
932 945
933=item B<pointerColor2:> I<colour> 946=item B<pointerColor2:> I<colour>
934 947
935Mouse pointer background colour. 948Mouse pointer background colour.
936 949
950=item B<pointerShape:> I<string>
951
952Compile I<frills>: Specifies the name of the mouse pointer shape
953[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
954file for possible values (omit the C<XC_> prefix).
955
937=item B<pointerBlankDelay:> I<number> 956=item B<pointerBlankDelay:> I<number>
938 957
939Specifies number of seconds before blanking the pointer [default 2]. Use a 958Specifies number of seconds before blanking the pointer [default 2]. Use a
940large number (e.g. C<987654321>) to effectively disable the timeout. 959large number (e.g. C<987654321>) to effectively disable the timeout.
941 960
967 986
968B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 987B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
969 988
970=item B<preeditType:> I<style> 989=item B<preeditType:> I<style>
971 990
972B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 991B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
973 992
974=item B<inputMethod:> I<name> 993=item B<inputMethod:> I<name>
975 994
976I<name> of inputMethod to use; option B<-im>. 995I<name> of inputMethod to use; option B<-im>.
977 996
1110 1129
1111 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n 1130 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1112 1131
1113This could in theory be used to completely redefine your keymap. 1132This could in theory be used to completely redefine your keymap.
1114 1133
1134In addition, for actions of this type, you can define a range of
1135keysyms in one shot by loading the C<keysym-list> perl extension and
1136providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1137the delimiter `/' should be a character not used by the strings.
1138
1139Its usage can be demonstrated by an example:
1140
1141 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1142
1143The above line is equivalent to the following three lines:
1144
1145 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1146 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1147 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1148
1115=item command:STRING 1149=item command:STRING
1116 1150
1117If I<action> takes the form of C<command:STRING>, the specified B<STRING> 1151If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1118is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically 1152is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1119the opposite of C<string:> - instead of sending it to the program running 1153the opposite of C<string:> - instead of sending it to the program running
1178 1212
1179Similarly, to let applications gain access to the C<C-M-c> (copy to 1213Similarly, 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 1214clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1181this: 1215this:
1182 1216
1183 URxvt.keysym.C-S-c: builtin-string: 1217 URxvt.keysym.C-M-c: builtin-string:
1184 URxvt.keysym.C-S-v: builtin-string: 1218 URxvt.keysym.C-M-v: builtin-string:
1185 1219
1186=item EXTENSION:STRING 1220=item EXTENSION:STRING
1187 1221
1188An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3) 1222An action of this form invokes the action B<STRING>, if any, provided
1189extension of the same name. The extension will be loaded automatically if 1223by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1190necessary. 1224be loaded automatically if necessary.
1191 1225
1192Not all extensions define key actions, but popular extensions that do 1226Not all extensions define actions, but popular extensions that do
1193include the I<selection> and I<matcher> extensions (documented in their 1227include the I<selection> and I<matcher> extensions (documented in their
1194own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1), 1228own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1195respectively). 1229respectively).
1196 1230
1197From the silly examples department, this will rot13-"encrypt" 1231From the silly examples department, this will rot13-"encrypt"
1200 1234
1201 URxvt.keysym.M-C-c: selection:rot13 1235 URxvt.keysym.M-C-c: selection:rot13
1202 1236
1203=item perl:STRING *DEPRECATED* 1237=item perl:STRING *DEPRECATED*
1204 1238
1205This is a deprecated way of passing key mappings to perl extensions. It is 1239This is a deprecated way of invoking commands provided by perl
1206still supported, but should not be used anymore. 1240extensions. It is still supported, but should not be used anymore.
1207 1241
1208=back 1242=back
1209 1243
1210=item B<perl-ext-common>: I<string> 1244=item B<perl-ext-common>: I<string>
1211 1245
1219by default, or specified via the C<perl-ext-common> resource. For 1253by default, or specified via the C<perl-ext-common> resource. For
1220example, C<default,-selection> will use all the default extensions except 1254example, C<default,-selection> will use all the default extensions except
1221C<selection>. 1255C<selection>.
1222 1256
1223The default set includes the C<selection>, C<option-popup>, 1257The default set includes the C<selection>, C<option-popup>,
1224C<selection-popup> and C<readline> extensions, any extensions that define 1258C<selection-popup>, C<readline> and C<searchable-scrollback>
1225keybindings via C<BINDING> meta comments, extensions loaded because 1259extensions, and extensions which are mentioned in B<keysym> resources.
1226their resources/commandline switches were used, and extensions which are 1260
1227mentioned in B<keysym> resources. 1261Any extension such that a corresponding resource is given on the
1262command line is automatically appended to B<perl-ext>.
1228 1263
1229Each extension is looked up in the library directories, loaded if 1264Each extension is looked up in the library directories, loaded if
1230necessary, and bound to the current terminal instance. When the library 1265necessary, and bound to the current terminal instance. When the library
1231search path contains multiple extension files of the same name, then the 1266search path contains multiple extension files of the same name, then the
1232first one found will be used. 1267first one found will be used.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines