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.246 by sf-exg, Tue Jun 21 12:03:55 2016 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>.
… …
858are not passed onto the shell; option B<-sk>. B<False>: do not scroll to 871are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
859bottom when a non-special key is pressed; option B<+sk>. 872bottom when a non-special key is pressed; option B<+sk>.
860 873
861=item B<saveLines:> I<number> 874=item B<saveLines:> I<number>
862 875
863Save I<number> lines in the scrollback buffer [default 64]. This 876Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
864resource is limited on most machines to 65535; option B<-sl>.
865 877
866=item B<internalBorder:> I<number> 878=item B<internalBorder:> I<number>
867 879
868Internal border of I<number> pixels. This resource is limited to 100; 880Internal border of I<number> pixels. This resource is limited to 100;
869option B<-b>. 881option B<-b>.
… …
932 944
933=item B<pointerColor2:> I<colour> 945=item B<pointerColor2:> I<colour>
934 946
935Mouse pointer background colour. 947Mouse pointer background colour.
936 948
949=item B<pointerShape:> I<string>
950
951Compile I<frills>: Specifies the name of the mouse pointer shape
952[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
953file for possible values (omit the C<XC_> prefix).
954
937=item B<pointerBlankDelay:> I<number> 955=item B<pointerBlankDelay:> I<number>
938 956
939Specifies number of seconds before blanking the pointer [default 2]. Use a 957Specifies number of seconds before blanking the pointer [default 2]. Use a
940large number (e.g. C<987654321>) to effectively disable the timeout. 958large number (e.g. C<987654321>) to effectively disable the timeout.
941 959
… …
967 985
968B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 986B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
969 987
970=item B<preeditType:> I<style> 988=item B<preeditType:> I<style>
971 989
972B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 990B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
973 991
974=item B<inputMethod:> I<name> 992=item B<inputMethod:> I<name>
975 993
976I<name> of inputMethod to use; option B<-im>. 994I<name> of inputMethod to use; option B<-im>.
977 995
… …
1110 1128
1111 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n 1129 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1112 1130
1113This could in theory be used to completely redefine your keymap. 1131This could in theory be used to completely redefine your keymap.
1114 1132
1133In addition, for actions of this type, you can define a range of
1134keysyms in one shot by loading the C<keysym-list> perl extension and
1135providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1136the delimiter `/' should be a character not used by the strings.
1137
1138Its usage can be demonstrated by an example:
1139
1140 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1141
1142The 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>
1147
1115=item command:STRING 1148=item command:STRING
1116 1149
1117If I<action> takes the form of C<command:STRING>, the specified B<STRING> 1150If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1118is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically 1151is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1119the opposite of C<string:> - instead of sending it to the program running 1152the opposite of C<string:> - instead of sending it to the program running
… …
1178 1211
1179Similarly, to let applications gain access to the C<C-M-c> (copy to 1212Similarly, 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 1213clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1181this: 1214this:
1182 1215
1183 URxvt.keysym.C-S-c: builtin-string: 1216 URxvt.keysym.C-M-c: builtin-string:
1184 URxvt.keysym.C-S-v: builtin-string: 1217 URxvt.keysym.C-M-v: builtin-string:
1185 1218
1186=item EXTENSION:STRING 1219=item EXTENSION:STRING
1187 1220
1188An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3) 1221An action of this form invokes the action B<STRING>, if any, provided
1189extension of the same name. The extension will be loaded automatically if 1222by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1190necessary. 1223be loaded automatically if necessary.
1191 1224
1192Not all extensions define key actions, but popular extensions that do 1225Not all extensions define actions, but popular extensions that do
1193include the I<selection> and I<matcher> extensions (documented in their 1226include the I<selection> and I<matcher> extensions (documented in their
1194own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1), 1227own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1195respectively). 1228respectively).
1196 1229
1197From the silly examples department, this will rot13-"encrypt" 1230From the silly examples department, this will rot13-"encrypt"
… …
1200 1233
1201 URxvt.keysym.M-C-c: selection:rot13 1234 URxvt.keysym.M-C-c: selection:rot13
1202 1235
1203=item perl:STRING *DEPRECATED* 1236=item perl:STRING *DEPRECATED*
1204 1237
1205This is a deprecated way of passing key mappings to perl extensions. It is 1238This is a deprecated way of invoking commands provided by perl
1206still supported, but should not be used anymore. 1239extensions. It is still supported, but should not be used anymore.
1207 1240
1208=back 1241=back
1209 1242
1210=item B<perl-ext-common>: I<string> 1243=item B<perl-ext-common>: I<string>
1211 1244
… …
1219by default, or specified via the C<perl-ext-common> resource. For 1252by default, or specified via the C<perl-ext-common> resource. For
1220example, C<default,-selection> will use all the default extensions except 1253example, C<default,-selection> will use all the default extensions except
1221C<selection>. 1254C<selection>.
1222 1255
1223The default set includes the C<selection>, C<option-popup>, 1256The default set includes the C<selection>, C<option-popup>,
1224C<selection-popup> and C<readline> extensions, any extensions that define 1257C<selection-popup>, C<readline> and C<searchable-scrollback>
1225keybindings via C<BINDING> meta comments, extensions loaded because 1258extensions, and extensions which are mentioned in B<keysym> resources.
1226their resources/commandline switches were used, and extensions which are 1259
1227mentioned in B<keysym> resources. 1260Any extension such that a corresponding resource is given on the
1261command line is automatically appended to B<perl-ext>.
1228 1262
1229Each extension is looked up in the library directories, loaded if 1263Each extension is looked up in the library directories, loaded if
1230necessary, and bound to the current terminal instance. When the library 1264necessary, and bound to the current terminal instance. When the library
1231search path contains multiple extension files of the same name, then the 1265search path contains multiple extension files of the same name, then the
1232first one found will be used. 1266first one found will be used.
… …
1561In addition to the default foreground and background colours, 1595In addition to the default foreground and background colours,
1562B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus 1596B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1563high-intensity (potentially bold/blink) versions of the same, and 72 (or 1597high-intensity (potentially bold/blink) versions of the same, and 72 (or
1564240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB 1598240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1565cube plus a 8 (24) colour greyscale ramp. 1599cube plus a 8 (24) colour greyscale ramp.
1600
1601B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
1602C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
1603number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
1604colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
160524-bit colour space. When indexing collisions happen, the nearest old colour in
1606the cube will be adapted to the new 24-bit RGB colour. That means one cannot
1607use many similar 24-bit colours. It's typically not a problem in common
1608scenarios.
1566 1609
1567Here is a list of the ANSI colours with their names. 1610Here is a list of the ANSI colours with their names.
1568 1611
1569=begin table 1612=begin table
1570 1613

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines