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.233 by sf-exg, Sat May 24 18:41:29 2014 UTC vs.
Revision 1.253 by root, Sat Jul 3 15:34:35 2021 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
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>.
374 384
385If the perl extension C<xim-onthespot> is used (which is the default),
386then additionally the C<OnTheSpot> preedit type is available.
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
379=item B<-imlocale> I<string> 392=item B<-imlocale> I<string>
393Change the meaning of triple-click selection with the left mouse 406Change the meaning of triple-click selection with the left mouse
394button. Only effective when the original (non-perl) selection code is 407button. Only effective when the original (non-perl) selection code is
395in-use. Instead of selecting a full line it will extend the selection to 408in-use. Instead of selecting a full line it will extend the selection to
396the end of the logical line only. resource B<tripleclickwords>. 409the end of the logical line only. resource B<tripleclickwords>.
397 410
411=item B<-dpb>|B<+dpb>
412
413Compile frills: Disable (or enable) emitting bracketed paste mode
414sequences (default enabled). Bracketed paste mode allows programs
415to detect when something is pasted. Since more and more programs
416abuse this, these sequences can be disabled. The command sequences to
417enable and query paste mode will still work, but the actual bracket
418sequences will no longer be emitted. You can also toggle this from the
419ctrl-middle-mouse-button menu; resource B<disablePasteBrackets>.
420
398=item B<-insecure> 421=item B<-insecure>
399 422
400Enable "insecure" mode, which currently enables most of the escape 423Enable "insecure" mode, which currently enables most of the escape
401sequences that echo strings. See the resource B<insecure> for more 424sequences that echo strings. See the resource B<insecure> for more
402info. 425info.
414 437
415=item B<-ssr>|B<+ssr> 438=item B<-ssr>|B<+ssr>
416 439
417Turn on/off secondary screen scroll (default enabled); resource 440Turn on/off secondary screen scroll (default enabled); resource
418B<secondaryScroll>. 441B<secondaryScroll>.
442
443=item B<-rm> I<mode>
444
445Compile I<frills>: Sets long line rewrapping behaviour on window resizes
446to one of B<auto> (the default), B<always> or B<never>. The latter two
447modes do the obvious, B<auto> rewraps (acts like B<always>) if scrollback
448is non-empty, and wings lines (acts like B<never>) otherwise; resource
449B<rewrapMode>.
419 450
420=item B<-hold>|B<+hold> 451=item B<-hold>|B<+hold>
421 452
422Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 453Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
423will not immediately destroy its window when the program executed within 454will not immediately destroy its window when the program executed within
781 812
782B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 813B<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 814the shell; option B<-ls>. B<False>: start as a normal sub-shell
784[default]; option B<+ls>. 815[default]; option B<+ls>.
785 816
817=item B<multiClickTime:> I<number>
818
819Specify the maximum time in milliseconds between multi-click select
820events. The default is 500 milliseconds; option B<-mc>.
821
786=item B<utmpInhibit:> I<boolean> 822=item B<utmpInhibit:> I<boolean>
787 823
788B<True>: inhibit writing record into the system log file B<utmp>; 824B<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> 825option B<-ut>. B<False>: write record into the system log file B<utmp>
790[default]; option B<+ut>. 826[default]; option B<+ut>.
853are not passed onto the shell; option B<-sk>. B<False>: do not scroll to 889are 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>. 890bottom when a non-special key is pressed; option B<+sk>.
855 891
856=item B<saveLines:> I<number> 892=item B<saveLines:> I<number>
857 893
858Save I<number> lines in the scrollback buffer [default 64]. This 894Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
859resource is limited on most machines to 65535; option B<-sl>.
860 895
861=item B<internalBorder:> I<number> 896=item B<internalBorder:> I<number>
862 897
863Internal border of I<number> pixels. This resource is limited to 100; 898Internal border of I<number> pixels. This resource is limited to 100;
864option B<-b>. 899option B<-b>.
927 962
928=item B<pointerColor2:> I<colour> 963=item B<pointerColor2:> I<colour>
929 964
930Mouse pointer background colour. 965Mouse pointer background colour.
931 966
967=item B<pointerShape:> I<string>
968
969Compile I<frills>: Specifies the name of the mouse pointer shape
970[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
971file for possible values (omit the C<XC_> prefix).
972
932=item B<pointerBlankDelay:> I<number> 973=item B<pointerBlankDelay:> I<number>
933 974
934Specifies number of seconds before blanking the pointer [default 2]. Use a 975Specifies number of seconds before blanking the pointer [default 2]. Use a
935large number (e.g. C<987654321>) to effectively disable the timeout. 976large number (e.g. C<987654321>) to effectively disable the timeout.
936 977
962 1003
963B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 1004B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
964 1005
965=item B<preeditType:> I<style> 1006=item B<preeditType:> I<style>
966 1007
967B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1008B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
968 1009
969=item B<inputMethod:> I<name> 1010=item B<inputMethod:> I<name>
970 1011
971I<name> of inputMethod to use; option B<-im>. 1012I<name> of inputMethod to use; option B<-im>.
972 1013
990 1031
991Change the meaning of triple-click selection with the left mouse 1032Change the meaning of triple-click selection with the left mouse
992button. Instead of selecting a full line it will extend the selection to 1033button. Instead of selecting a full line it will extend the selection to
993the end of the logical line only; option B<-tcw>. 1034the end of the logical line only; option B<-tcw>.
994 1035
1036=item B<disablePasteBrackets:> I<boolean>
1037
1038Prevent emission of paste bracket sequences; option B<-dpb>.
1039
995=item B<insecure:> I<boolean> 1040=item B<insecure:> I<boolean>
996 1041
997Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1042Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
998echo arbitrary strings like the icon name or the locale. This could be 1043echo arbitrary strings like the icon name or the locale. This could be
999abused if somebody gets 8-bit-clean access to your display, whether 1044abused if somebody gets 8-bit-clean access to your display, whether
1000through a mail client displaying mail bodies unfiltered or through 1045through a mail client displaying mail bodies unfiltered or through
1001write(1) or any other means. Therefore, these sequences are disabled by 1046write(1) or any other means. Therefore, these sequences are disabled by
1002default. (Note that many other terminals, including xterm, have these 1047default. (Note that many other terminals, including xterm, have these
1020 1065
1021=item B<secondaryScreen:> I<boolean> 1066=item B<secondaryScreen:> I<boolean>
1022 1067
1023Turn on/off secondary screen (default enabled). 1068Turn on/off secondary screen (default enabled).
1024 1069
1070=item B<rewrapMode:> I<mode>
1071
1072Sets long line rewrap behaviour on window resize to one of B<auto>
1073(default), B<always> or B<never>.
1074
1025=item B<secondaryScroll:> I<boolean> 1075=item B<secondaryScroll:> I<boolean>
1026 1076
1027Turn on/off secondary screen scroll (default enabled). If this 1077Turn on/off secondary screen scroll (default enabled). If this
1028option is enabled, scrolls on the secondary screen will change the 1078option is enabled, scrolls on the secondary screen will change the
1029scrollback buffer and, when secondaryScreen is off, switching 1079scrollback buffer and, when secondaryScreen is off, switching
1056 1106
1057The key combination that triggers the action, I<sym>, has the following format: 1107The key combination that triggers the action, I<sym>, has the following format:
1058 1108
1059 (modifiers-)key 1109 (modifiers-)key
1060 1110
1061Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>, 1111Where I<modifiers> can be any combination of the following full or
1062B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, 1112abbreviated modifier names:
1063B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>, 1113
1064B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>. 1114=begin table
1115
1116 B<ISOLevel3> B<I>
1117 B<AppKeypad> B<K>
1118 B<Control> B<C>
1119 B<NumLock> B<N>
1120 B<Shift> B<S>
1121 B<Meta> B<M> I<or> B<A>
1122 B<Lock> B<L>
1123 B<Mod1> B<1>
1124 B<Mod2> B<2>
1125 B<Mod3> B<3>
1126 B<Mod4> B<4>
1127 B<Mod5> B<5>
1128
1129=end table
1065 1130
1066The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1131The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1067whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1132whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1068keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1133keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1069current application keymap mode state. 1134current application keymap mode state.
1105 1170
1106 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n 1171 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1107 1172
1108This could in theory be used to completely redefine your keymap. 1173This could in theory be used to completely redefine your keymap.
1109 1174
1175In addition, for actions of this type, you can define a range of
1176keysyms in one shot by loading the C<keysym-list> perl extension and
1177providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1178the delimiter `/' should be a character not used by the strings.
1179
1180Its usage can be demonstrated by an example:
1181
1182 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1183
1184The above line is equivalent to the following three lines:
1185
1186 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1187 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1188 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1189
1110=item command:STRING 1190=item command:STRING
1111 1191
1112If I<action> takes the form of C<command:STRING>, the specified B<STRING> 1192If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1113is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically 1193is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1114the opposite of C<string:> - instead of sending it to the program running 1194the opposite of C<string:> - instead of sending it to the program running
1173 1253
1174Similarly, to let applications gain access to the C<C-M-c> (copy to 1254Similarly, 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 1255clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1176this: 1256this:
1177 1257
1178 URxvt.keysym.C-S-c: builtin-string: 1258 URxvt.keysym.C-M-c: builtin-string:
1179 URxvt.keysym.C-S-v: builtin-string: 1259 URxvt.keysym.C-M-v: builtin-string:
1180 1260
1181=item EXTENSION:STRING 1261=item EXTENSION:STRING
1182 1262
1183An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3) 1263An action of this form invokes the action B<STRING>, if any, provided
1184extension of the same name. The extension will be loaded automatically if 1264by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1185neccessary. 1265be loaded automatically if necessary.
1186 1266
1187Not all extensions define key actions, but popular extensions that do 1267Not all extensions define actions, but popular extensions that do
1188include the I<selection> and I<matcher> extensions (documented in their 1268include the I<selection> and I<matcher> extensions (documented in their
1189own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1), 1269own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1190respectively). 1270respectively).
1191 1271
1192From the silly examples department, this will rot13-"encrypt" 1272From the silly examples department, this will rot13-"encrypt"
1195 1275
1196 URxvt.keysym.M-C-c: selection:rot13 1276 URxvt.keysym.M-C-c: selection:rot13
1197 1277
1198=item perl:STRING *DEPRECATED* 1278=item perl:STRING *DEPRECATED*
1199 1279
1200This is a deprecated way of passing key mappings to perl extensions. It is 1280This is a deprecated way of invoking commands provided by perl
1201still supported, but should not be used anymore. 1281extensions. It is still supported, but should not be used anymore.
1202 1282
1203=back 1283=back
1204 1284
1205=item B<perl-ext-common>: I<string> 1285=item B<perl-ext-common>: I<string>
1206 1286
1214by default, or specified via the C<perl-ext-common> resource. For 1294by default, or specified via the C<perl-ext-common> resource. For
1215example, C<default,-selection> will use all the default extensions except 1295example, C<default,-selection> will use all the default extensions except
1216C<selection>. 1296C<selection>.
1217 1297
1218The default set includes the C<selection>, C<option-popup>, 1298The default set includes the C<selection>, C<option-popup>,
1219C<selection-popup> and C<readline> extensions, any extensions that define 1299C<selection-popup>, C<readline> and C<searchable-scrollback>
1220keybindings via C<BINDING> meta comments, extensions loaded because 1300extensions, and extensions which are mentioned in B<keysym> resources.
1221their resources/commandline switches were used, and extensions which are 1301
1222mentioned in B<keysym> resources. 1302Any extension such that a corresponding resource is given on the
1303command line is automatically appended to B<perl-ext>.
1223 1304
1224Each extension is looked up in the library directories, loaded if 1305Each extension is looked up in the library directories, loaded if
1225necessary, and bound to the current terminal instance. When the library 1306necessary, and bound to the current terminal instance. When the library
1226search path contains multiple extension files of the same name, then the 1307search path contains multiple extension files of the same name, then the
1227first one found will be used. 1308first one found will be used.
1281Turn on/off ISO 14755 (default enabled). 1362Turn on/off ISO 14755 (default enabled).
1282 1363
1283=item B<iso14755_52:> I<boolean> 1364=item B<iso14755_52:> I<boolean>
1284 1365
1285Turn on/off ISO 14755 5.2 mode (default enabled). 1366Turn on/off ISO 14755 5.2 mode (default enabled).
1286
1287=back
1288
1289=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1290
1291=over 4
1292
1293=item B<-pixmap> I<file[;oplist]>
1294
1295=item B<backgroundPixmap:> I<file[;oplist]>
1296
1297Compile I<pixbuf>: Use the specified image file as the window's
1298background and also optionally specify a colon separated list of
1299operations to modify it. Note that you may need to quote the C<;>
1300character when using the command line option, as C<;> is usually a
1301metacharacter in shells. Supported operations are:
1302
1303=over 4
1304
1305=item B<WxH+X+Y>
1306
1307sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1308scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1309scale of 0 disables scaling.
1310
1311=item B<op=tile>
1312
1313enables tiling
1314
1315=item B<op=keep-aspect>
1316
1317maintain the image aspect ratio when scaling
1318
1319=item B<op=root-align>
1320
1321use the position of the terminal window relative to the root window as
1322the image offset, simulating a root window background
1323
1324=back
1325
1326The default scale and position setting is C<100x100+50+50>.
1327Alternatively, a predefined set of templates can be used to achieve
1328the most common setups:
1329
1330=over 4
1331
1332=item B<style=tiled>
1333
1334the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1335
1336=item B<style=aspect-stretched>
1337
1338the image is scaled to fill the whole window maintaining the aspect
1339ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1340
1341=item B<style=stretched>
1342
1343the image is scaled to fill the whole window. Equivalent to 100x100
1344
1345=item B<style=centered>
1346
1347the image is centered with no scaling. Equivalent to 0x0+50+50
1348
1349=item B<style=root-tiled>
1350
1351the image is tiled with no scaling and using 'root' positioning.
1352Equivalent to 0x0:op=tile:op=root-align
1353
1354=back
1355
1356If multiple templates are specified the last one wins. Note that a
1357template overrides all the scale, position and operations settings.
1358
1359If used in conjunction with pseudo-transparency, the specified pixmap
1360will be blended over the transparent background using alpha-blending.
1361
1362=item B<-tr>|B<+tr>
1363
1364=item B<transparent:> I<boolean>
1365
1366Turn on/off pseudo-transparency by using the root pixmap as background.
1367
1368B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1369will be removed in future versions.
1370
1371=item B<-tint> I<colour>
1372
1373=item B<tintColor:> I<colour>
1374
1375Tint the transparent background with the given colour. Note that a
1376black tint yields a completely black image while a white tint yields
1377the image unchanged.
1378
1379=item B<-sh> I<number>
1380
1381=item B<shading:> I<number>
1382
1383Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1384A value of 100 means no shading.
1385
1386=item B<-blr> I<HxV>
1387
1388=item B<blurRadius:> I<HxV>
1389
1390Apply gaussian blur with the specified radius to the transparent
1391background. If a single number is specified, the vertical and
1392horizontal radii are considered to be the same. Setting one of the
1393radii to 1 and the other to a large number creates interesting effects
1394on some backgrounds. The maximum radius value is 128. An horizontal or
1395vertical radius of 0 disables blurring.
1396
1397=item B<path:> I<path>
1398
1399Specify the colon-delimited search path for finding background image files.
1400 1367
1401=back 1368=back
1402 1369
1403=head1 THE SCROLLBAR 1370=head1 THE SCROLLBAR
1404 1371
1556In addition to the default foreground and background colours, 1523In addition to the default foreground and background colours,
1557B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus 1524B<@@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 1525high-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 1526240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1560cube plus a 8 (24) colour greyscale ramp. 1527cube plus a 8 (24) colour greyscale ramp.
1528
1529B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
1530C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
1531number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
1532colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
153324-bit colour space. When indexing collisions happen, the nearest old colour in
1534the cube will be adapted to the new 24-bit RGB colour. That means one cannot
1535use many similar 24-bit colours. It's typically not a problem in common
1536scenarios.
1561 1537
1562Here is a list of the ANSI colours with their names. 1538Here is a list of the ANSI colours with their names.
1563 1539
1564=begin table 1540=begin table
1565 1541

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines