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.241 by root, Wed Dec 17 15:22:10 2014 UTC vs.
Revision 1.250 by root, Sat Oct 10 20:06:45 2020 UTC

380=item B<-pt> I<style> 380=item B<-pt> I<style>
381 381
382Compile I<XIM>: input style for input method; B<OverTheSpot>, 382Compile I<XIM>: input style for input method; B<OverTheSpot>,
383B<OffTheSpot>, B<Root>; resource B<preeditType>. 383B<OffTheSpot>, B<Root>; resource B<preeditType>.
384 384
385If the perl extension C<xim-onthespot> is used (which is the default),
386then additionally the C<OnTheSpot> preedit type is available.
387
385=item B<-im> I<text> 388=item B<-im> I<text>
386 389
387Compile I<XIM>: input method name. resource B<inputMethod>. 390Compile I<XIM>: input method name. resource B<inputMethod>.
388 391
389=item B<-imlocale> I<string> 392=item B<-imlocale> I<string>
868are 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
869bottom when a non-special key is pressed; option B<+sk>. 872bottom when a non-special key is pressed; option B<+sk>.
870 873
871=item B<saveLines:> I<number> 874=item B<saveLines:> I<number>
872 875
873Save I<number> lines in the scrollback buffer [default 64]. This 876Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
874resource is limited on most machines to 65535; option B<-sl>.
875 877
876=item B<internalBorder:> I<number> 878=item B<internalBorder:> I<number>
877 879
878Internal border of I<number> pixels. This resource is limited to 100; 880Internal border of I<number> pixels. This resource is limited to 100;
879option B<-b>. 881option B<-b>.
942 944
943=item B<pointerColor2:> I<colour> 945=item B<pointerColor2:> I<colour>
944 946
945Mouse pointer background colour. 947Mouse pointer background colour.
946 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
947=item B<pointerBlankDelay:> I<number> 955=item B<pointerBlankDelay:> I<number>
948 956
949Specifies number of seconds before blanking the pointer [default 2]. Use a 957Specifies number of seconds before blanking the pointer [default 2]. Use a
950large number (e.g. C<987654321>) to effectively disable the timeout. 958large number (e.g. C<987654321>) to effectively disable the timeout.
951 959
977 985
978B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> 986B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
979 987
980=item B<preeditType:> I<style> 988=item B<preeditType:> I<style>
981 989
982B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 990B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
983 991
984=item B<inputMethod:> I<name> 992=item B<inputMethod:> I<name>
985 993
986I<name> of inputMethod to use; option B<-im>. 994I<name> of inputMethod to use; option B<-im>.
987 995
1071 1079
1072The key combination that triggers the action, I<sym>, has the following format: 1080The key combination that triggers the action, I<sym>, has the following format:
1073 1081
1074 (modifiers-)key 1082 (modifiers-)key
1075 1083
1076Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>, 1084Where I<modifiers> can be any combination of the following full or
1077B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, 1085abbreviated modifier names:
1078B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>, 1086
1079B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>. 1087=begin table
1088
1089 B<ISOLevel3> B<I>
1090 B<AppKeypad> B<K>
1091 B<Control> B<C>
1092 B<NumLock> B<N>
1093 B<Shift> B<S>
1094 B<Meta> B<M> I<or> B<A>
1095 B<Lock> B<L>
1096 B<Mod1> B<1>
1097 B<Mod2> B<2>
1098 B<Mod3> B<3>
1099 B<Mod4> B<4>
1100 B<Mod5> B<5>
1101
1102=end table
1080 1103
1081The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1104The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1082whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1105whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1083keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1106keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1084current application keymap mode state. 1107current application keymap mode state.
1244by default, or specified via the C<perl-ext-common> resource. For 1267by default, or specified via the C<perl-ext-common> resource. For
1245example, C<default,-selection> will use all the default extensions except 1268example, C<default,-selection> will use all the default extensions except
1246C<selection>. 1269C<selection>.
1247 1270
1248The default set includes the C<selection>, C<option-popup>, 1271The default set includes the C<selection>, C<option-popup>,
1249C<selection-popup> and C<readline> extensions, any extensions that 1272C<selection-popup>, C<readline> and C<searchable-scrollback>
1250define keybindings via C<BINDING> meta comments, and extensions which 1273extensions, and extensions which are mentioned in B<keysym> resources.
1251are mentioned in B<keysym> resources.
1252 1274
1253Any extension such that a corresponding resource is given on the 1275Any extension such that a corresponding resource is given on the
1254command line is automatically appended to B<perl-ext>. 1276command line is automatically appended to B<perl-ext>.
1255 1277
1256Each extension is looked up in the library directories, loaded if 1278Each extension is looked up in the library directories, loaded if
1313Turn on/off ISO 14755 (default enabled). 1335Turn on/off ISO 14755 (default enabled).
1314 1336
1315=item B<iso14755_52:> I<boolean> 1337=item B<iso14755_52:> I<boolean>
1316 1338
1317Turn on/off ISO 14755 5.2 mode (default enabled). 1339Turn on/off ISO 14755 5.2 mode (default enabled).
1318
1319=back
1320
1321=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1322
1323=over 4
1324
1325=item B<-pixmap> I<file[;oplist]>
1326
1327=item B<backgroundPixmap:> I<file[;oplist]>
1328
1329Compile I<pixbuf>: Use the specified image file as the window's
1330background and also optionally specify a colon separated list of
1331operations to modify it. Note that you may need to quote the C<;>
1332character when using the command line option, as C<;> is usually a
1333metacharacter in shells. Supported operations are:
1334
1335=over 4
1336
1337=item B<WxH+X+Y>
1338
1339sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1340scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1341scale of 0 disables scaling.
1342
1343=item B<op=tile>
1344
1345enables tiling
1346
1347=item B<op=keep-aspect>
1348
1349maintain the image aspect ratio when scaling
1350
1351=item B<op=root-align>
1352
1353use the position of the terminal window relative to the root window as
1354the image offset, simulating a root window background
1355
1356=back
1357
1358The default scale and position setting is C<100x100+50+50>.
1359Alternatively, a predefined set of templates can be used to achieve
1360the most common setups:
1361
1362=over 4
1363
1364=item B<style=tiled>
1365
1366the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1367
1368=item B<style=aspect-stretched>
1369
1370the image is scaled to fill the whole window maintaining the aspect
1371ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1372
1373=item B<style=stretched>
1374
1375the image is scaled to fill the whole window. Equivalent to 100x100
1376
1377=item B<style=centered>
1378
1379the image is centered with no scaling. Equivalent to 0x0+50+50
1380
1381=item B<style=root-tiled>
1382
1383the image is tiled with no scaling and using 'root' positioning.
1384Equivalent to 0x0:op=tile:op=root-align
1385
1386=back
1387
1388If multiple templates are specified the last one wins. Note that a
1389template overrides all the scale, position and operations settings.
1390
1391If used in conjunction with pseudo-transparency, the specified pixmap
1392will be blended over the transparent background using alpha-blending.
1393
1394=item B<-tr>|B<+tr>
1395
1396=item B<transparent:> I<boolean>
1397
1398Turn on/off pseudo-transparency by using the root pixmap as background.
1399
1400B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1401will be removed in future versions.
1402
1403=item B<-tint> I<colour>
1404
1405=item B<tintColor:> I<colour>
1406
1407Tint the transparent background with the given colour. Note that a
1408black tint yields a completely black image while a white tint yields
1409the image unchanged.
1410
1411=item B<-sh> I<number>
1412
1413=item B<shading:> I<number>
1414
1415Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1416A value of 100 means no shading.
1417
1418=item B<-blr> I<HxV>
1419
1420=item B<blurRadius:> I<HxV>
1421
1422Apply gaussian blur with the specified radius to the transparent
1423background. If a single number is specified, the vertical and
1424horizontal radii are considered to be the same. Setting one of the
1425radii to 1 and the other to a large number creates interesting effects
1426on some backgrounds. The maximum radius value is 128. An horizontal or
1427vertical radius of 0 disables blurring.
1428
1429=item B<path:> I<path>
1430
1431Specify the colon-delimited search path for finding background image files.
1432 1340
1433=back 1341=back
1434 1342
1435=head1 THE SCROLLBAR 1343=head1 THE SCROLLBAR
1436 1344
1588In addition to the default foreground and background colours, 1496In addition to the default foreground and background colours,
1589B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus 1497B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1590high-intensity (potentially bold/blink) versions of the same, and 72 (or 1498high-intensity (potentially bold/blink) versions of the same, and 72 (or
1591240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB 1499240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1592cube plus a 8 (24) colour greyscale ramp. 1500cube plus a 8 (24) colour greyscale ramp.
1501
1502B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
1503C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
1504number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
1505colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
150624-bit colour space. When indexing collisions happen, the nearest old colour in
1507the cube will be adapted to the new 24-bit RGB colour. That means one cannot
1508use many similar 24-bit colours. It's typically not a problem in common
1509scenarios.
1593 1510
1594Here is a list of the ANSI colours with their names. 1511Here is a list of the ANSI colours with their names.
1595 1512
1596=begin table 1513=begin table
1597 1514

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines