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.232 by root, Sun May 18 18:19:10 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
… …
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>.
223 224
225=item B<-mc> I<milliseconds>
226
227Specify the maximum time between multi-click selections.
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>.
228 233
… …
306 311
307=item B<-override-redirect> 312=item B<-override-redirect>
308 313
309Compile I<frills>: Sets override-redirect on the window; resource 314Compile I<frills>: Sets override-redirect on the window; resource
310B<override-redirect>. 315B<override-redirect>.
316
317=item B<-dockapp>
318
319Sets the initial state of the window to WithdrawnState, which makes
320window managers that support this extension treat it as a dockapp.
311 321
312=item B<-sbg> 322=item B<-sbg>
313 323
314Compile I<frills>: Disable the usage of the built-in block graphics/line 324Compile I<frills>: Disable the usage of the built-in block graphics/line
315drawing characters and just rely on what the specified fonts provide. Use 325drawing 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
372Compile I<XIM>: input style for input method; B<OverTheSpot>, 382Compile I<XIM>: input style for input method; B<OverTheSpot>,
373B<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.
374 387
375=item B<-im> I<text> 388=item B<-im> I<text>
376 389
377Compile I<XIM>: input method name. resource B<inputMethod>. 390Compile I<XIM>: input method name. resource B<inputMethod>.
378 391
… …
781 794
782B<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
783the 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
784[default]; option B<+ls>. 797[default]; option B<+ls>.
785 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
786=item B<utmpInhibit:> I<boolean> 804=item B<utmpInhibit:> I<boolean>
787 805
788B<True>: inhibit writing record into the system log file B<utmp>; 806B<True>: inhibit writing record into the system log file B<utmp>;
789option 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>
790[default]; option B<+ut>. 808[default]; option B<+ut>.
… …
853are 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
854bottom when a non-special key is pressed; option B<+sk>. 872bottom 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
858Save I<number> lines in the scrollback buffer [default 64]. This 876Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
859resource 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
863Internal border of I<number> pixels. This resource is limited to 100; 880Internal border of I<number> pixels. This resource is limited to 100;
864option B<-b>. 881option B<-b>.
… …
927 944
928=item B<pointerColor2:> I<colour> 945=item B<pointerColor2:> I<colour>
929 946
930Mouse pointer background colour. 947Mouse pointer background colour.
931 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
932=item B<pointerBlankDelay:> I<number> 955=item B<pointerBlankDelay:> I<number>
933 956
934Specifies number of seconds before blanking the pointer [default 2]. Use a 957Specifies number of seconds before blanking the pointer [default 2]. Use a
935large number (e.g. C<987654321>) to effectively disable the timeout. 958large number (e.g. C<987654321>) to effectively disable the timeout.
936 959
… …
962 985
963B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 986B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
964 987
965=item B<preeditType:> I<style> 988=item B<preeditType:> I<style>
966 989
967B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 990B<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
971I<name> of inputMethod to use; option B<-im>. 994I<name> of inputMethod to use; option B<-im>.
972 995
… …
1085As with any resource value, the I<action> string may contain backslash 1108As with any resource value, the I<action> string may contain backslash
1086escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal 1109escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1087number), see RESOURCES in C<man 7 X> for further details. 1110number), see RESOURCES in C<man 7 X> for further details.
1088 1111
1089An action starts with an action prefix that selects a certain type 1112An action starts with an action prefix that selects a certain type
1090of action, followed by a colon. An action strings without colons is 1113of action, followed by a colon. An action string without colons is
1091interpreted as a literal string to pass to the tty (as if they were 1114interpreted as a literal string to pass to the tty (as if it was
1092prefixed with C<string:>). 1115prefixed with C<string:>).
1093 1116
1094The following action prefixes are known - extensions can provide 1117The following action prefixes are known - extensions can provide
1095additional prefixes: 1118additional prefixes:
1096 1119
… …
1104string C<echo rm -rf /> followed by a newline: 1127string 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
1108This could in theory be used to completely redefine your keymap. 1131This could in theory be used to completely redefine your keymap.
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>
1109 1147
1110=item command:STRING 1148=item command:STRING
1111 1149
1112If 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>
1113is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically 1151is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
… …
1173 1211
1174Similarly, 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
1175clipboard) 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
1176this: 1214this:
1177 1215
1178 URxvt.keysym.C-S-c: builtin-string: 1216 URxvt.keysym.C-M-c: builtin-string:
1179 URxvt.keysym.C-S-v: builtin-string: 1217 URxvt.keysym.C-M-v: builtin-string:
1180 1218
1181=item EXTENSION:STRING 1219=item EXTENSION:STRING
1182 1220
1183An 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
1184extension of the same name. The extension will be loaded automatically if 1222by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1185neccessary. 1223be loaded automatically if necessary.
1186 1224
1187Not all extensions define key actions, but popular extensions that do 1225Not all extensions define actions, but popular extensions that do
1188include the I<selection> and I<matcher> extensions (documented in their 1226include the I<selection> and I<matcher> extensions (documented in their
1189own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1), 1227own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1190respectively). 1228respectively).
1191 1229
1192From the silly examples department, this will rot13-"encrypt" 1230From the silly examples department, this will rot13-"encrypt"
… …
1195 1233
1196 URxvt.keysym.M-C-c: selection:rot13 1234 URxvt.keysym.M-C-c: selection:rot13
1197 1235
1198=item perl:STRING *DEPRECATED* 1236=item perl:STRING *DEPRECATED*
1199 1237
1200This is a deprecated way of passing key mappings to perl extensions. It is 1238This is a deprecated way of invoking commands provided by perl
1201still supported, but should not be used anymore. 1239extensions. It is still supported, but should not be used anymore.
1202 1240
1203=back 1241=back
1204 1242
1205=item B<perl-ext-common>: I<string> 1243=item B<perl-ext-common>: I<string>
1206 1244
… …
1214by default, or specified via the C<perl-ext-common> resource. For 1252by default, or specified via the C<perl-ext-common> resource. For
1215example, C<default,-selection> will use all the default extensions except 1253example, C<default,-selection> will use all the default extensions except
1216C<selection>. 1254C<selection>.
1217 1255
1218The default set includes the C<selection>, C<option-popup>, 1256The default set includes the C<selection>, C<option-popup>,
1219C<selection-popup> and C<readline> extensions, any extensions that define 1257C<selection-popup>, C<readline> and C<searchable-scrollback>
1220keybindings via C<BINDING> meta comments, extensions loaded because 1258extensions, and extensions which are mentioned in B<keysym> resources.
1221their resources/commandline switches were used, and extensions which are 1259
1222mentioned in B<keysym> resources. 1260Any extension such that a corresponding resource is given on the
1261command line is automatically appended to B<perl-ext>.
1223 1262
1224Each extension is looked up in the library directories, loaded if 1263Each extension is looked up in the library directories, loaded if
1225necessary, and bound to the current terminal instance. When the library 1264necessary, and bound to the current terminal instance. When the library
1226search path contains multiple extension files of the same name, then the 1265search path contains multiple extension files of the same name, then the
1227first one found will be used. 1266first one found will be used.
… …
1556In addition to the default foreground and background colours, 1595In addition to the default foreground and background colours,
1557B<@@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
1558high-intensity (potentially bold/blink) versions of the same, and 72 (or 1597high-intensity (potentially bold/blink) versions of the same, and 72 (or
1559240 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
1560cube 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.
1561 1609
1562Here is a list of the ANSI colours with their names. 1610Here is a list of the ANSI colours with their names.
1563 1611
1564=begin table 1612=begin table
1565 1613

Diff Legend

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