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.100 by root, Thu Jan 19 18:02:28 2006 UTC vs.
Revision 1.113 by root, Sun Apr 2 17:07:32 2006 UTC

… …
93 93
94Attempt to open a window on the named X display (B<-d> still 94Attempt to open a window on the named X display (B<-d> still
95respected). In the absence of this option, the display specified by the 95respected). In the absence of this option, the display specified by the
96B<DISPLAY> environment variable is used. 96B<DISPLAY> environment variable is used.
97 97
98=item B<-depth> I<bitdepth>
99
100Compile I<xft>: Attempt to find a visual with the given bit depth;
101resource B<depth>.
102
98=item B<-geometry> I<geom> 103=item B<-geometry> I<geom>
99 104
100Window geometry (B<-g> still respected); resource B<geometry>. 105Window geometry (B<-g> still respected); resource B<geometry>.
101 106
102=item B<-rv>|B<+rv> 107=item B<-rv>|B<+rv>
… …
109 114
110=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 115=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
111 116
112Turn on/off inheriting parent window's pixmap. Alternative form is 117Turn on/off inheriting parent window's pixmap. Alternative form is
113B<-tr>; resource B<inheritPixmap>. 118B<-tr>; resource B<inheritPixmap>.
119
120I<Please note that transparency of any kind if completely unsupported by
121the author. Don't bug him with installation questions!>
114 122
115=item B<-fade> I<number> 123=item B<-fade> I<number>
116 124
117Fade the text by the given percentage when focus is lost. Small values 125Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade 126fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>. 127colour; resource B<fading>.
120 128
121=item B<-fadecolor> I<colour> 129=item B<-fadecolor> I<colour>
122 130
123Fade to this colour when fading is used (see B<-fade>). The default colour 131Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>. 132is opaque black. resource B<fadeColor>.
125 133
126=item B<-tint> I<colour> 134=item B<-tint> I<colour>
127 135
128Tint the transparent background pixmap with the given colour when 136Tint the transparent background pixmap with the given colour when
129transparency is enabled with B<-tr> or B<-ip>. This only works for 137transparency is enabled with B<-tr> or B<-ip>. This only works for
… …
505check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 513check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
506extensions not documented here): 514extensions not documented here):
507 515
508=over 4 516=over 4
509 517
518=item B<depth:> I<bitdepth>
519
520Compile I<xft>: Attempt to find a visual with the given bit depth;
521option B<-depth>.
522
510=item B<geometry:> I<geom> 523=item B<geometry:> I<geom>
511 524
512Create the window with the specified X window geometry [default 80x24]; 525Create the window with the specified X window geometry [default 80x24];
513option B<-geometry>. 526option B<-geometry>.
514 527
… …
586=item B<inheritPixmap:> I<boolean> 599=item B<inheritPixmap:> I<boolean>
587 600
588B<True>: make the background inherit the parent windows' pixmap, giving 601B<True>: make the background inherit the parent windows' pixmap, giving
589artificial transparency. B<False>: do not inherit the parent windows' 602artificial transparency. B<False>: do not inherit the parent windows'
590pixmap. 603pixmap.
604
605I<Please note that transparency of any kind if completely unsupported by
606the author. Don't bug him with installation questions!>
591 607
592=item B<fading:> I<number> 608=item B<fading:> I<number>
593 609
594Fade the text by the given percentage when focus is lost; option B<-fade>. 610Fade the text by the given percentage when focus is lost; option B<-fade>.
595 611
… …
896pressed. If unset it will send the sequence traditionally associated 912pressed. If unset it will send the sequence traditionally associated
897with the B<Execute> key. 913with the B<Execute> key.
898 914
899=item B<cutchars:> I<string> 915=item B<cutchars:> I<string>
900 916
901The characters used as delimiters for double-click word selection. The 917The characters used as delimiters for double-click word selection
902built-in default: 918(whitespace delimiting is added automatically if resource is given).
919
920When the selection extension is in use (the default if compiled in, see
921the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
922will be created (if the resource exists, otherwise, no regex will be
923created). In this mode, characters outside ISO-8859-1 can be used.
924
925When the selection extension is not used, only ISO-8859-1 characters can
926be used. If not specified, the built-in default is used:
903 927
904B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 928B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
905 929
906=item B<preeditType:> I<style> 930=item B<preeditType:> I<style>
907 931
… …
1190selection, and trailing whitespace is visually underlined and removed from 1214selection, and trailing whitespace is visually underlined and removed from
1191the selection. 1215the selection.
1192 1216
1193=item B<Insertion>: 1217=item B<Insertion>:
1194 1218
1195Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1219Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1196an B<@@RXVT_NAME@@> window causes the current text selection to be 1220window causes the value of the PRIMARY selection (or CLIPBOARD with the
1197inserted as if it had been typed on the keyboard. 1221Meta modifier) to be inserted as if it had been typed on the keyboard.
1222
1223Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1224inserted too.
1198 1225
1199=back 1226=back
1200 1227
1201=head1 CHANGING FONTS 1228=head1 CHANGING FONTS
1202 1229
… …
1289=head1 COLORS AND GRAPHICS 1316=head1 COLORS AND GRAPHICS
1290 1317
1291In addition to the default foreground and background colours, 1318In addition to the default foreground and background colours,
1292B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1319B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1293high-intensity bold/blink versions of the same). Here is a list of the 1320high-intensity bold/blink versions of the same). Here is a list of the
1294colours with their B<rgb.txt> names. 1321colours with their names.
1295 1322
1296=begin table 1323=begin table
1297 1324
1298 B<color0> (black) = Black 1325 B<color0> (black) = Black
1299 B<color1> (red) = Red3 1326 B<color1> (red) = Red3
… …
1319It is also possible to specify the colour values of B<foreground>, 1346It is also possible to specify the colour values of B<foreground>,
1320B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1347B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1321a number 0-15, as a convenient shorthand to reference the colour name of 1348a number 0-15, as a convenient shorthand to reference the colour name of
1322color0-color15. 1349color0-color15.
1323 1350
1351In addition to the colours defined above, @@RXVT_NAME@@ offers an
1352additional 72 colours. The first 64 of those (with indices 16 to 79)
1353consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
135416>), followed by 8 additional shades of gray (with indices 80 to 87).
1355
1356Together, all those colours implement the 88 colour xterm colours. Only
1357the first 16 can be changed using resources currently, the rest can only
1358be changed via command sequences ("escape codes").
1359
1324Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1360Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1325always swapping the foreground/background colours. This is in contrast to 1361always swapping the foreground/background colours. This is in contrast to
1326I<xterm>(1) where the colours are only swapped if they have not otherwise 1362I<xterm>(1) where the colours are only swapped if they have not otherwise
1327been specified. For example, 1363been specified. For example,
1328 1364
… …
1332 1368
1333would yield White on Black, while on I<xterm>(1) it would yield Black 1369would yield White on Black, while on I<xterm>(1) it would yield Black
1334on White. 1370on White.
1335 1371
1336=back 1372=back
1373
1374=head2 ALPHA CHANNEL SUPPORT
1375
1376If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1377their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1378(recommended, but B<MUST> have 4 digits/component) colour specifications,
1379in addition to the ones provided by X, where the additional A component
1380specifies opacity (alpha) values. The minimum value of C<0> is completely
1381transparent). You can also prefix any color with C<[a]>, where C<a> is on
1382to four hex digits specifiying the opacity value.
1383
1384You probably need to specify B<"-depth 32">, too, and have the luck that
1385your X-server uses ARGB pixel layout, as X is far from just supporting
1386ARGB visuals out of the box, and rxvt-unicode just fudges around.
1387
1388For example, the following selects an almost completely transparent red
1389background, and an almost opaque pink foreground:
1390
1391 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1392
1393I<Please note that transparency of any kind if completely unsupported by
1394the author. Don't bug him with installation questions!>
1337 1395
1338=head1 ENVIRONMENT 1396=head1 ENVIRONMENT
1339 1397
1340B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1398B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1341 1399
… …
1426 1484
1427=item Project Coordinator 1485=item Project Coordinator
1428 1486
1429Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1487Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1430 1488
1431L<http://software.schmorp.de/#rxvt-unicode> 1489L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1432 1490
1433=back 1491=back
1434 1492
1435=head1 AUTHORS 1493=head1 AUTHORS
1436 1494
… …
1471 1529
1472Project Coordinator (Changes 1.0 -) 1530Project Coordinator (Changes 1.0 -)
1473 1531
1474=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1532=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1475 1533
1476Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugxifing. 1534Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1477 1535
1478=back 1536=back
1479 1537

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines