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.231 by root, Sat May 17 17:12:29 2014 UTC vs.
Revision 1.247 by sf-exg, Thu Jul 14 05:33:25 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
… …
1210use in this terminal instance; option B<-pe>. 1248use in this terminal instance; option B<-pe>.
1211 1249
1212Extension names can be prefixed with a C<-> sign to prohibit using 1250Extension names can be prefixed with a C<-> sign to prohibit using
1213them. This can be useful to selectively disable some extensions loaded 1251them. This can be useful to selectively disable some extensions loaded
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 extension except 1253example, C<default,-selection> will use all the default extensions except
1216C<selection>. 1254C<selection>.
1217 1255
1218Some extensions define resources or command line switches, and will 1256The default set includes the C<selection>, C<option-popup>,
1219automatically be used when their resource or switch is specified. 1257C<selection-popup>, C<readline> and C<searchable-scrollback>
1258extensions, and extensions which are mentioned in B<keysym> resources.
1259
1260Any extension such that a corresponding resource is given on the
1261command line is automatically appended to B<perl-ext>.
1220 1262
1221Each extension is looked up in the library directories, loaded if 1263Each extension is looked up in the library directories, loaded if
1222necessary, and bound to the current terminal instance. 1264necessary, and bound to the current terminal instance. When the library
1265search path contains multiple extension files of the same name, then the
1266first one found will be used.
1223 1267
1224If both of these resources are the empty string, then the perl interpreter 1268If both of these resources are the empty string, then the perl interpreter
1225will not be initialized. The rationale for having two options is that 1269will not be initialized. The rationale for having two options is that
1226B<perl-ext-common> will be used for extensions that should be available to 1270B<perl-ext-common> will be used for extensions that should be available to
1227all instances, while B<perl-ext> is used for specific instances. 1271all instances, while B<perl-ext> is used for specific instances.
… …
1276Turn on/off ISO 14755 (default enabled). 1320Turn on/off ISO 14755 (default enabled).
1277 1321
1278=item B<iso14755_52:> I<boolean> 1322=item B<iso14755_52:> I<boolean>
1279 1323
1280Turn on/off ISO 14755 5.2 mode (default enabled). 1324Turn on/off ISO 14755 5.2 mode (default enabled).
1281
1282=back
1283
1284=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1285
1286=over 4
1287
1288=item B<-pixmap> I<file[;oplist]>
1289
1290=item B<backgroundPixmap:> I<file[;oplist]>
1291
1292Compile I<pixbuf>: Use the specified image file as the window's
1293background and also optionally specify a colon separated list of
1294operations to modify it. Note that you may need to quote the C<;>
1295character when using the command line option, as C<;> is usually a
1296metacharacter in shells. Supported operations are:
1297
1298=over 4
1299
1300=item B<WxH+X+Y>
1301
1302sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1303scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1304scale of 0 disables scaling.
1305
1306=item B<op=tile>
1307
1308enables tiling
1309
1310=item B<op=keep-aspect>
1311
1312maintain the image aspect ratio when scaling
1313
1314=item B<op=root-align>
1315
1316use the position of the terminal window relative to the root window as
1317the image offset, simulating a root window background
1318
1319=back
1320
1321The default scale and position setting is C<100x100+50+50>.
1322Alternatively, a predefined set of templates can be used to achieve
1323the most common setups:
1324
1325=over 4
1326
1327=item B<style=tiled>
1328
1329the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1330
1331=item B<style=aspect-stretched>
1332
1333the image is scaled to fill the whole window maintaining the aspect
1334ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1335
1336=item B<style=stretched>
1337
1338the image is scaled to fill the whole window. Equivalent to 100x100
1339
1340=item B<style=centered>
1341
1342the image is centered with no scaling. Equivalent to 0x0+50+50
1343
1344=item B<style=root-tiled>
1345
1346the image is tiled with no scaling and using 'root' positioning.
1347Equivalent to 0x0:op=tile:op=root-align
1348
1349=back
1350
1351If multiple templates are specified the last one wins. Note that a
1352template overrides all the scale, position and operations settings.
1353
1354If used in conjunction with pseudo-transparency, the specified pixmap
1355will be blended over the transparent background using alpha-blending.
1356
1357=item B<-tr>|B<+tr>
1358
1359=item B<transparent:> I<boolean>
1360
1361Turn on/off pseudo-transparency by using the root pixmap as background.
1362
1363B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1364will be removed in future versions.
1365
1366=item B<-tint> I<colour>
1367
1368=item B<tintColor:> I<colour>
1369
1370Tint the transparent background with the given colour. Note that a
1371black tint yields a completely black image while a white tint yields
1372the image unchanged.
1373
1374=item B<-sh> I<number>
1375
1376=item B<shading:> I<number>
1377
1378Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1379A value of 100 means no shading.
1380
1381=item B<-blr> I<HxV>
1382
1383=item B<blurRadius:> I<HxV>
1384
1385Apply gaussian blur with the specified radius to the transparent
1386background. If a single number is specified, the vertical and
1387horizontal radii are considered to be the same. Setting one of the
1388radii to 1 and the other to a large number creates interesting effects
1389on some backgrounds. The maximum radius value is 128. An horizontal or
1390vertical radius of 0 disables blurring.
1391
1392=item B<path:> I<path>
1393
1394Specify the colon-delimited search path for finding background image files.
1395 1325
1396=back 1326=back
1397 1327
1398=head1 THE SCROLLBAR 1328=head1 THE SCROLLBAR
1399 1329
… …
1551In addition to the default foreground and background colours, 1481In addition to the default foreground and background colours,
1552B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus 1482B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1553high-intensity (potentially bold/blink) versions of the same, and 72 (or 1483high-intensity (potentially bold/blink) versions of the same, and 72 (or
1554240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB 1484240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1555cube plus a 8 (24) colour greyscale ramp. 1485cube plus a 8 (24) colour greyscale ramp.
1486
1487B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
1488C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
1489number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
1490colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
149124-bit colour space. When indexing collisions happen, the nearest old colour in
1492the cube will be adapted to the new 24-bit RGB colour. That means one cannot
1493use many similar 24-bit colours. It's typically not a problem in common
1494scenarios.
1556 1495
1557Here is a list of the ANSI colours with their names. 1496Here is a list of the ANSI colours with their names.
1558 1497
1559=begin table 1498=begin table
1560 1499

Diff Legend

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