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.238 by sf-exg, Sat Oct 11 22:02:50 2014 UTC vs.
Revision 1.249 by root, Sat Oct 10 20:03:39 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>, 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.
1119 1143
1120 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n 1144 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1121 1145
1122This could in theory be used to completely redefine your keymap. 1146This could in theory be used to completely redefine your keymap.
1123 1147
1148In addition, for actions of this type, you can define a range of
1149keysyms in one shot by loading the C<keysym-list> perl extension and
1150providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1151the delimiter `/' should be a character not used by the strings.
1152
1153Its usage can be demonstrated by an example:
1154
1155 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1156
1157The above line is equivalent to the following three lines:
1158
1159 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1160 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1161 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1162
1124=item command:STRING 1163=item command:STRING
1125 1164
1126If I<action> takes the form of C<command:STRING>, the specified B<STRING> 1165If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1127is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically 1166is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1128the opposite of C<string:> - instead of sending it to the program running 1167the opposite of C<string:> - instead of sending it to the program running
1192 URxvt.keysym.C-M-c: builtin-string: 1231 URxvt.keysym.C-M-c: builtin-string:
1193 URxvt.keysym.C-M-v: builtin-string: 1232 URxvt.keysym.C-M-v: builtin-string:
1194 1233
1195=item EXTENSION:STRING 1234=item EXTENSION:STRING
1196 1235
1197An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3) 1236An action of this form invokes the action B<STRING>, if any, provided
1198extension of the same name. The extension will be loaded automatically if 1237by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1199necessary. 1238be loaded automatically if necessary.
1200 1239
1201Not all extensions define key actions, but popular extensions that do 1240Not all extensions define actions, but popular extensions that do
1202include the I<selection> and I<matcher> extensions (documented in their 1241include the I<selection> and I<matcher> extensions (documented in their
1203own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1), 1242own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1204respectively). 1243respectively).
1205 1244
1206From the silly examples department, this will rot13-"encrypt" 1245From the silly examples department, this will rot13-"encrypt"
1209 1248
1210 URxvt.keysym.M-C-c: selection:rot13 1249 URxvt.keysym.M-C-c: selection:rot13
1211 1250
1212=item perl:STRING *DEPRECATED* 1251=item perl:STRING *DEPRECATED*
1213 1252
1214This is a deprecated way of passing key mappings to perl extensions. It is 1253This is a deprecated way of invoking commands provided by perl
1215still supported, but should not be used anymore. 1254extensions. It is still supported, but should not be used anymore.
1216 1255
1217=back 1256=back
1218 1257
1219=item B<perl-ext-common>: I<string> 1258=item B<perl-ext-common>: I<string>
1220 1259
1228by default, or specified via the C<perl-ext-common> resource. For 1267by default, or specified via the C<perl-ext-common> resource. For
1229example, C<default,-selection> will use all the default extensions except 1268example, C<default,-selection> will use all the default extensions except
1230C<selection>. 1269C<selection>.
1231 1270
1232The default set includes the C<selection>, C<option-popup>, 1271The default set includes the C<selection>, C<option-popup>,
1233C<selection-popup> and C<readline> extensions, any extensions that 1272C<selection-popup>, C<readline> and C<searchable-scrollback>
1234define keybindings via C<BINDING> meta comments, and extensions which 1273extensions, and extensions which are mentioned in B<keysym> resources.
1235are mentioned in B<keysym> resources.
1236 1274
1237Any extension such that a corresponding resource is given on the 1275Any extension such that a corresponding resource is given on the
1238command line is automatically appended to B<perl-ext>. 1276command line is automatically appended to B<perl-ext>.
1239 1277
1240Each extension is looked up in the library directories, loaded if 1278Each extension is looked up in the library directories, loaded if
1297Turn on/off ISO 14755 (default enabled). 1335Turn on/off ISO 14755 (default enabled).
1298 1336
1299=item B<iso14755_52:> I<boolean> 1337=item B<iso14755_52:> I<boolean>
1300 1338
1301Turn on/off ISO 14755 5.2 mode (default enabled). 1339Turn on/off ISO 14755 5.2 mode (default enabled).
1302
1303=back
1304
1305=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1306
1307=over 4
1308
1309=item B<-pixmap> I<file[;oplist]>
1310
1311=item B<backgroundPixmap:> I<file[;oplist]>
1312
1313Compile I<pixbuf>: Use the specified image file as the window's
1314background and also optionally specify a colon separated list of
1315operations to modify it. Note that you may need to quote the C<;>
1316character when using the command line option, as C<;> is usually a
1317metacharacter in shells. Supported operations are:
1318
1319=over 4
1320
1321=item B<WxH+X+Y>
1322
1323sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1324scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1325scale of 0 disables scaling.
1326
1327=item B<op=tile>
1328
1329enables tiling
1330
1331=item B<op=keep-aspect>
1332
1333maintain the image aspect ratio when scaling
1334
1335=item B<op=root-align>
1336
1337use the position of the terminal window relative to the root window as
1338the image offset, simulating a root window background
1339
1340=back
1341
1342The default scale and position setting is C<100x100+50+50>.
1343Alternatively, a predefined set of templates can be used to achieve
1344the most common setups:
1345
1346=over 4
1347
1348=item B<style=tiled>
1349
1350the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1351
1352=item B<style=aspect-stretched>
1353
1354the image is scaled to fill the whole window maintaining the aspect
1355ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1356
1357=item B<style=stretched>
1358
1359the image is scaled to fill the whole window. Equivalent to 100x100
1360
1361=item B<style=centered>
1362
1363the image is centered with no scaling. Equivalent to 0x0+50+50
1364
1365=item B<style=root-tiled>
1366
1367the image is tiled with no scaling and using 'root' positioning.
1368Equivalent to 0x0:op=tile:op=root-align
1369
1370=back
1371
1372If multiple templates are specified the last one wins. Note that a
1373template overrides all the scale, position and operations settings.
1374
1375If used in conjunction with pseudo-transparency, the specified pixmap
1376will be blended over the transparent background using alpha-blending.
1377
1378=item B<-tr>|B<+tr>
1379
1380=item B<transparent:> I<boolean>
1381
1382Turn on/off pseudo-transparency by using the root pixmap as background.
1383
1384B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1385will be removed in future versions.
1386
1387=item B<-tint> I<colour>
1388
1389=item B<tintColor:> I<colour>
1390
1391Tint the transparent background with the given colour. Note that a
1392black tint yields a completely black image while a white tint yields
1393the image unchanged.
1394
1395=item B<-sh> I<number>
1396
1397=item B<shading:> I<number>
1398
1399Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1400A value of 100 means no shading.
1401
1402=item B<-blr> I<HxV>
1403
1404=item B<blurRadius:> I<HxV>
1405
1406Apply gaussian blur with the specified radius to the transparent
1407background. If a single number is specified, the vertical and
1408horizontal radii are considered to be the same. Setting one of the
1409radii to 1 and the other to a large number creates interesting effects
1410on some backgrounds. The maximum radius value is 128. An horizontal or
1411vertical radius of 0 disables blurring.
1412
1413=item B<path:> I<path>
1414
1415Specify the colon-delimited search path for finding background image files.
1416 1340
1417=back 1341=back
1418 1342
1419=head1 THE SCROLLBAR 1343=head1 THE SCROLLBAR
1420 1344
1572In addition to the default foreground and background colours, 1496In addition to the default foreground and background colours,
1573B<@@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
1574high-intensity (potentially bold/blink) versions of the same, and 72 (or 1498high-intensity (potentially bold/blink) versions of the same, and 72 (or
1575240 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
1576cube 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.
1577 1510
1578Here is a list of the ANSI colours with their names. 1511Here is a list of the ANSI colours with their names.
1579 1512
1580=begin table 1513=begin table
1581 1514

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines