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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines