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.243 by root, Sat May 30 21:02:05 2015 UTC vs.
Revision 1.253 by root, Sat Jul 3 15:34:35 2021 UTC

406Change the meaning of triple-click selection with the left mouse 406Change the meaning of triple-click selection with the left mouse
407button. Only effective when the original (non-perl) selection code is 407button. Only effective when the original (non-perl) selection code is
408in-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
409the end of the logical line only. resource B<tripleclickwords>. 409the end of the logical line only. resource B<tripleclickwords>.
410 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
411=item B<-insecure> 421=item B<-insecure>
412 422
413Enable "insecure" mode, which currently enables most of the escape 423Enable "insecure" mode, which currently enables most of the escape
414sequences that echo strings. See the resource B<insecure> for more 424sequences that echo strings. See the resource B<insecure> for more
415info. 425info.
427 437
428=item B<-ssr>|B<+ssr> 438=item B<-ssr>|B<+ssr>
429 439
430Turn on/off secondary screen scroll (default enabled); resource 440Turn on/off secondary screen scroll (default enabled); resource
431B<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>.
432 450
433=item B<-hold>|B<+hold> 451=item B<-hold>|B<+hold>
434 452
435Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 453Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
436will not immediately destroy its window when the program executed within 454will not immediately destroy its window when the program executed within
871are 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
872bottom when a non-special key is pressed; option B<+sk>. 890bottom when a non-special key is pressed; option B<+sk>.
873 891
874=item B<saveLines:> I<number> 892=item B<saveLines:> I<number>
875 893
876Save I<number> lines in the scrollback buffer [default 64]. This 894Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
877resource is limited on most machines to 65535; option B<-sl>.
878 895
879=item B<internalBorder:> I<number> 896=item B<internalBorder:> I<number>
880 897
881Internal border of I<number> pixels. This resource is limited to 100; 898Internal border of I<number> pixels. This resource is limited to 100;
882option B<-b>. 899option B<-b>.
944Mouse pointer foreground colour. 961Mouse pointer foreground colour.
945 962
946=item B<pointerColor2:> I<colour> 963=item B<pointerColor2:> I<colour>
947 964
948Mouse pointer background colour. 965Mouse pointer background colour.
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).
949 972
950=item B<pointerBlankDelay:> I<number> 973=item B<pointerBlankDelay:> I<number>
951 974
952Specifies number of seconds before blanking the pointer [default 2]. Use a 975Specifies number of seconds before blanking the pointer [default 2]. Use a
953large number (e.g. C<987654321>) to effectively disable the timeout. 976large number (e.g. C<987654321>) to effectively disable the timeout.
1008 1031
1009Change the meaning of triple-click selection with the left mouse 1032Change the meaning of triple-click selection with the left mouse
1010button. 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
1011the end of the logical line only; option B<-tcw>. 1034the end of the logical line only; option B<-tcw>.
1012 1035
1036=item B<disablePasteBrackets:> I<boolean>
1037
1038Prevent emission of paste bracket sequences; option B<-dpb>.
1039
1013=item B<insecure:> I<boolean> 1040=item B<insecure:> I<boolean>
1014 1041
1015Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1042Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1016echo 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
1017abused if somebody gets 8-bit-clean access to your display, whether 1044abused if somebody gets 8-bit-clean access to your display, whether
1018through a mail client displaying mail bodies unfiltered or through 1045through a mail client displaying mail bodies unfiltered or through
1019write(1) or any other means. Therefore, these sequences are disabled by 1046write(1) or any other means. Therefore, these sequences are disabled by
1020default. (Note that many other terminals, including xterm, have these 1047default. (Note that many other terminals, including xterm, have these
1038 1065
1039=item B<secondaryScreen:> I<boolean> 1066=item B<secondaryScreen:> I<boolean>
1040 1067
1041Turn on/off secondary screen (default enabled). 1068Turn on/off secondary screen (default enabled).
1042 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
1043=item B<secondaryScroll:> I<boolean> 1075=item B<secondaryScroll:> I<boolean>
1044 1076
1045Turn on/off secondary screen scroll (default enabled). If this 1077Turn on/off secondary screen scroll (default enabled). If this
1046option is enabled, scrolls on the secondary screen will change the 1078option is enabled, scrolls on the secondary screen will change the
1047scrollback buffer and, when secondaryScreen is off, switching 1079scrollback buffer and, when secondaryScreen is off, switching
1074 1106
1075The 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:
1076 1108
1077 (modifiers-)key 1109 (modifiers-)key
1078 1110
1079Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>, 1111Where I<modifiers> can be any combination of the following full or
1080B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, 1112abbreviated modifier names:
1081B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>, 1113
1082B<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
1083 1130
1084The 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
1085whatever 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
1086keys 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
1087current application keymap mode state. 1134current application keymap mode state.
1318 1365
1319Turn on/off ISO 14755 5.2 mode (default enabled). 1366Turn on/off ISO 14755 5.2 mode (default enabled).
1320 1367
1321=back 1368=back
1322 1369
1323=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1324
1325=over 4
1326
1327=item B<-pixmap> I<file[;oplist]>
1328
1329=item B<backgroundPixmap:> I<file[;oplist]>
1330
1331Compile I<pixbuf>: Use the specified image file as the window's
1332background and also optionally specify a colon separated list of
1333operations to modify it. Note that you may need to quote the C<;>
1334character when using the command line option, as C<;> is usually a
1335metacharacter in shells. Supported operations are:
1336
1337=over 4
1338
1339=item B<WxH+X+Y>
1340
1341sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1342scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1343scale of 0 disables scaling.
1344
1345=item B<op=tile>
1346
1347enables tiling
1348
1349=item B<op=keep-aspect>
1350
1351maintain the image aspect ratio when scaling
1352
1353=item B<op=root-align>
1354
1355use the position of the terminal window relative to the root window as
1356the image offset, simulating a root window background
1357
1358=back
1359
1360The default scale and position setting is C<100x100+50+50>.
1361Alternatively, a predefined set of templates can be used to achieve
1362the most common setups:
1363
1364=over 4
1365
1366=item B<style=tiled>
1367
1368the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1369
1370=item B<style=aspect-stretched>
1371
1372the image is scaled to fill the whole window maintaining the aspect
1373ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1374
1375=item B<style=stretched>
1376
1377the image is scaled to fill the whole window. Equivalent to 100x100
1378
1379=item B<style=centered>
1380
1381the image is centered with no scaling. Equivalent to 0x0+50+50
1382
1383=item B<style=root-tiled>
1384
1385the image is tiled with no scaling and using 'root' positioning.
1386Equivalent to 0x0:op=tile:op=root-align
1387
1388=back
1389
1390If multiple templates are specified the last one wins. Note that a
1391template overrides all the scale, position and operations settings.
1392
1393If used in conjunction with pseudo-transparency, the specified pixmap
1394will be blended over the transparent background using alpha-blending.
1395
1396=item B<-tr>|B<+tr>
1397
1398=item B<transparent:> I<boolean>
1399
1400Turn on/off pseudo-transparency by using the root pixmap as background.
1401
1402B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1403will be removed in future versions.
1404
1405=item B<-tint> I<colour>
1406
1407=item B<tintColor:> I<colour>
1408
1409Tint the transparent background with the given colour. Note that a
1410black tint yields a completely black image while a white tint yields
1411the image unchanged.
1412
1413=item B<-sh> I<number>
1414
1415=item B<shading:> I<number>
1416
1417Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1418A value of 100 means no shading.
1419
1420=item B<-blr> I<HxV>
1421
1422=item B<blurRadius:> I<HxV>
1423
1424Apply gaussian blur with the specified radius to the transparent
1425background. If a single number is specified, the vertical and
1426horizontal radii are considered to be the same. Setting one of the
1427radii to 1 and the other to a large number creates interesting effects
1428on some backgrounds. The maximum radius value is 128. An horizontal or
1429vertical radius of 0 disables blurring.
1430
1431=item B<path:> I<path>
1432
1433Specify the colon-delimited search path for finding background image files.
1434
1435=back
1436
1437=head1 THE SCROLLBAR 1370=head1 THE SCROLLBAR
1438 1371
1439Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1372Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
1440(resource: B<saveLines>) and can be scrolled back using the scrollbar 1373(resource: B<saveLines>) and can be scrolled back using the scrollbar
1441or by keystrokes. The normal B<@@RXVT_NAME@@> scrollbar has arrows and 1374or by keystrokes. The normal B<@@RXVT_NAME@@> scrollbar has arrows and
1590In addition to the default foreground and background colours, 1523In addition to the default foreground and background colours,
1591B<@@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
1592high-intensity (potentially bold/blink) versions of the same, and 72 (or 1525high-intensity (potentially bold/blink) versions of the same, and 72 (or
1593240 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
1594cube 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.
1595 1537
1596Here is a list of the ANSI colours with their names. 1538Here is a list of the ANSI colours with their names.
1597 1539
1598=begin table 1540=begin table
1599 1541

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines