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.244 by sf-exg, Tue Jun 16 11:58:26 2015 UTC vs.
Revision 1.247 by sf-exg, Thu Jul 14 05:33:25 2016 UTC

871are 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
872bottom when a non-special key is pressed; option B<+sk>. 872bottom when a non-special key is pressed; option B<+sk>.
873 873
874=item B<saveLines:> I<number> 874=item B<saveLines:> I<number>
875 875
876Save I<number> lines in the scrollback buffer [default 64]. This 876Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
877resource is limited on most machines to 65535; option B<-sl>.
878 877
879=item B<internalBorder:> I<number> 878=item B<internalBorder:> I<number>
880 879
881Internal border of I<number> pixels. This resource is limited to 100; 880Internal border of I<number> pixels. This resource is limited to 100;
882option B<-b>. 881option B<-b>.
1324 1323
1325Turn on/off ISO 14755 5.2 mode (default enabled). 1324Turn on/off ISO 14755 5.2 mode (default enabled).
1326 1325
1327=back 1326=back
1328 1327
1329=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1330
1331=over 4
1332
1333=item B<-pixmap> I<file[;oplist]>
1334
1335=item B<backgroundPixmap:> I<file[;oplist]>
1336
1337Compile I<pixbuf>: Use the specified image file as the window's
1338background and also optionally specify a colon separated list of
1339operations to modify it. Note that you may need to quote the C<;>
1340character when using the command line option, as C<;> is usually a
1341metacharacter in shells. Supported operations are:
1342
1343=over 4
1344
1345=item B<WxH+X+Y>
1346
1347sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1348scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1349scale of 0 disables scaling.
1350
1351=item B<op=tile>
1352
1353enables tiling
1354
1355=item B<op=keep-aspect>
1356
1357maintain the image aspect ratio when scaling
1358
1359=item B<op=root-align>
1360
1361use the position of the terminal window relative to the root window as
1362the image offset, simulating a root window background
1363
1364=back
1365
1366The default scale and position setting is C<100x100+50+50>.
1367Alternatively, a predefined set of templates can be used to achieve
1368the most common setups:
1369
1370=over 4
1371
1372=item B<style=tiled>
1373
1374the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1375
1376=item B<style=aspect-stretched>
1377
1378the image is scaled to fill the whole window maintaining the aspect
1379ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1380
1381=item B<style=stretched>
1382
1383the image is scaled to fill the whole window. Equivalent to 100x100
1384
1385=item B<style=centered>
1386
1387the image is centered with no scaling. Equivalent to 0x0+50+50
1388
1389=item B<style=root-tiled>
1390
1391the image is tiled with no scaling and using 'root' positioning.
1392Equivalent to 0x0:op=tile:op=root-align
1393
1394=back
1395
1396If multiple templates are specified the last one wins. Note that a
1397template overrides all the scale, position and operations settings.
1398
1399If used in conjunction with pseudo-transparency, the specified pixmap
1400will be blended over the transparent background using alpha-blending.
1401
1402=item B<-tr>|B<+tr>
1403
1404=item B<transparent:> I<boolean>
1405
1406Turn on/off pseudo-transparency by using the root pixmap as background.
1407
1408B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1409will be removed in future versions.
1410
1411=item B<-tint> I<colour>
1412
1413=item B<tintColor:> I<colour>
1414
1415Tint the transparent background with the given colour. Note that a
1416black tint yields a completely black image while a white tint yields
1417the image unchanged.
1418
1419=item B<-sh> I<number>
1420
1421=item B<shading:> I<number>
1422
1423Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1424A value of 100 means no shading.
1425
1426=item B<-blr> I<HxV>
1427
1428=item B<blurRadius:> I<HxV>
1429
1430Apply gaussian blur with the specified radius to the transparent
1431background. If a single number is specified, the vertical and
1432horizontal radii are considered to be the same. Setting one of the
1433radii to 1 and the other to a large number creates interesting effects
1434on some backgrounds. The maximum radius value is 128. An horizontal or
1435vertical radius of 0 disables blurring.
1436
1437=item B<path:> I<path>
1438
1439Specify the colon-delimited search path for finding background image files.
1440
1441=back
1442
1443=head1 THE SCROLLBAR 1328=head1 THE SCROLLBAR
1444 1329
1445Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1330Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
1446(resource: B<saveLines>) and can be scrolled back using the scrollbar 1331(resource: B<saveLines>) and can be scrolled back using the scrollbar
1447or by keystrokes. The normal B<@@RXVT_NAME@@> scrollbar has arrows and 1332or by keystrokes. The normal B<@@RXVT_NAME@@> scrollbar has arrows and
1596In addition to the default foreground and background colours, 1481In addition to the default foreground and background colours,
1597B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus 1482B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1598high-intensity (potentially bold/blink) versions of the same, and 72 (or 1483high-intensity (potentially bold/blink) versions of the same, and 72 (or
1599240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB 1484240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1600cube plus a 8 (24) colour greyscale ramp. 1485cube plus a 8 (24) colour greyscale ramp.
1486
1487B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
1488C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
1489number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
1490colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
149124-bit colour space. When indexing collisions happen, the nearest old colour in
1492the cube will be adapted to the new 24-bit RGB colour. That means one cannot
1493use many similar 24-bit colours. It's typically not a problem in common
1494scenarios.
1601 1495
1602Here is a list of the ANSI colours with their names. 1496Here is a list of the ANSI colours with their names.
1603 1497
1604=begin table 1498=begin table
1605 1499

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines