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.98 by root, Mon Jan 16 15:12:48 2006 UTC vs.
Revision 1.111 by root, Tue Jan 31 00:25:16 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
… …
296=item B<-bl> 304=item B<-bl>
297 305
298Compile I<frills>: Set MWM hints to request a borderless window, i.e. 306Compile I<frills>: Set MWM hints to request a borderless window, i.e.
299if honoured by the WM, the rxvt-unicode window will not have window 307if honoured by the WM, the rxvt-unicode window will not have window
300decorations; resource B<borderLess>. 308decorations; resource B<borderLess>.
309
310=item B<-override-redirect>
311
312Compile I<frills>: Sets override-redirect on the window; resource
313B<override-redirect>.
301 314
302=item B<-sbg> 315=item B<-sbg>
303 316
304Compile I<frills>: Disable the usage of the built-in block graphics/line 317Compile I<frills>: Disable the usage of the built-in block graphics/line
305drawing characters and just rely on what the specified fonts provide. Use 318drawing characters and just rely on what the specified fonts provide. Use
… …
500check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 513check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
501extensions not documented here): 514extensions not documented here):
502 515
503=over 4 516=over 4
504 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
505=item B<geometry:> I<geom> 523=item B<geometry:> I<geom>
506 524
507Create the window with the specified X window geometry [default 80x24]; 525Create the window with the specified X window geometry [default 80x24];
508option B<-geometry>. 526option B<-geometry>.
509 527
… …
581=item B<inheritPixmap:> I<boolean> 599=item B<inheritPixmap:> I<boolean>
582 600
583B<True>: make the background inherit the parent windows' pixmap, giving 601B<True>: make the background inherit the parent windows' pixmap, giving
584artificial transparency. B<False>: do not inherit the parent windows' 602artificial transparency. B<False>: do not inherit the parent windows'
585pixmap. 603pixmap.
604
605I<Please note that transparency of any kind if completely unsupported by
606the author. Don't bug him with installation questions!>
586 607
587=item B<fading:> I<number> 608=item B<fading:> I<number>
588 609
589Fade 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>.
590 611
… …
891pressed. If unset it will send the sequence traditionally associated 912pressed. If unset it will send the sequence traditionally associated
892with the B<Execute> key. 913with the B<Execute> key.
893 914
894=item B<cutchars:> I<string> 915=item B<cutchars:> I<string>
895 916
896The characters used as delimiters for double-click word selection. The 917The characters used as delimiters for double-click word selection
897built-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:
898 927
899B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 928B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
900 929
901=item B<preeditType:> I<style> 930=item B<preeditType:> I<style>
902 931
… …
952 981
953Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 982Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
954character is passed through. It may contain escape values as described 983character is passed through. It may contain escape values as described
955in the entry on B<keysym> following. 984in the entry on B<keysym> following.
956 985
957=item B<secondaryScreen:> I<bool> 986=item B<secondaryScreen:> I<boolean>
958 987
959Turn on/off secondary screen (default enabled). 988Turn on/off secondary screen (default enabled).
960 989
961=item B<secondaryScroll:> I<bool> 990=item B<secondaryScroll:> I<boolean>
962 991
963Turn on/off secondary screen scroll (default enabled). If the this 992Turn on/off secondary screen scroll (default enabled). If the this
964option is enabled, scrolls on the secondary screen will change the 993option is enabled, scrolls on the secondary screen will change the
965scrollback buffer and switching to/from the secondary screen will 994scrollback buffer and switching to/from the secondary screen will
966instead scroll the screen up. 995instead scroll the screen up.
967 996
968=item B<hold>: I<bool> 997=item B<hold>: I<boolean>
969 998
970Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 999Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
971will not immediately destroy its window when the program executed within 1000will not immediately destroy its window when the program executed within
972it exits. Instead, it will wait till it is being killed or closed by the 1001it exits. Instead, it will wait till it is being killed or closed by the
973user. 1002user.
… …
1128Specifies the program to be started with a URL argument. Used by the 1157Specifies the program to be started with a URL argument. Used by the
1129C<selection-popup> and C<mark-urls> perl extensions. 1158C<selection-popup> and C<mark-urls> perl extensions.
1130 1159
1131=item B<transient-for>: I<windowid> 1160=item B<transient-for>: I<windowid>
1132 1161
1133Sets the WM_TRANSIENT_FOR property to the given window iw. 1162Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1163
1164=item B<override-redirect>: I<boolean>
1165
1166Compile I<frills>: Sets override-redirect for the terminal window, making
1167it almost invisible to window managers; option B<-override-redirect>.
1134 1168
1135=back 1169=back
1136 1170
1137=head1 THE SCROLLBAR 1171=head1 THE SCROLLBAR
1138 1172
… …
1180selection, and trailing whitespace is visually underlined and removed from 1214selection, and trailing whitespace is visually underlined and removed from
1181the selection. 1215the selection.
1182 1216
1183=item B<Insertion>: 1217=item B<Insertion>:
1184 1218
1185Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1219Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1186an B<@@RXVT_NAME@@> window causes the current text selection to be 1220window causes the value of the PRIMARY selection (or CLIPBOARD with the
1187inserted 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.
1188 1225
1189=back 1226=back
1190 1227
1191=head1 CHANGING FONTS 1228=head1 CHANGING FONTS
1192 1229
… …
1279=head1 COLORS AND GRAPHICS 1316=head1 COLORS AND GRAPHICS
1280 1317
1281In addition to the default foreground and background colours, 1318In addition to the default foreground and background colours,
1282B<@@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
1283high-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
1284colours with their B<rgb.txt> names. 1321colours with their names.
1285 1322
1286=begin table 1323=begin table
1287 1324
1288 B<color0> (black) = Black 1325 B<color0> (black) = Black
1289 B<color1> (red) = Red3 1326 B<color1> (red) = Red3
… …
1323would yield White on Black, while on I<xterm>(1) it would yield Black 1360would yield White on Black, while on I<xterm>(1) it would yield Black
1324on White. 1361on White.
1325 1362
1326=back 1363=back
1327 1364
1365=head2 ALPHA CHANNEL SUPPORT
1366
1367If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1368their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1369(recommended, but B<MUST> have 4 digits/component) colour specifications,
1370in addition to the ones provided by X, where the additional A component
1371specifies opacity (alpha) values. The minimum value of C<0> is completely
1372transparent). You can also prefix any color with C<[a]>, where C<a> is on
1373to four hex digits specifiying the opacity value.
1374
1375You probably need to specify B<"-depth 32">, too, and have the luck that
1376your X-server uses ARGB pixel layout, as X is far from just supporting
1377ARGB visuals out of the box, and rxvt-unicode just fudges around.
1378
1379For example, the following selects an almost completely transparent red
1380background, and an almost opaque pink foreground:
1381
1382 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1383
1384I<Please note that transparency of any kind if completely unsupported by
1385the author. Don't bug him with installation questions!>
1386
1328=head1 ENVIRONMENT 1387=head1 ENVIRONMENT
1329 1388
1330B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1389B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1331 1390
1332=over 4 1391=over 4
… …
1448 1507
1449Project Coordinator (changes.txt 2.21a to 2.4.5) 1508Project Coordinator (changes.txt 2.21a to 2.4.5)
1450 1509
1451=item Geoff Wing L<< <gcw@pobox.com> >> 1510=item Geoff Wing L<< <gcw@pobox.com> >>
1452 1511
1453Rewrote screen display and text selection routines. Project Coordinator 1512Rewrote screen display and text selection routines.
1513
1454(changes.txt 2.4.6 - rxvt-unicode) 1514Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1455 1515
1456=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1516=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1457 1517
1458Forked rxvt-unicode, rewrote most of the display code and internal 1518Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1459character handling to store text in unicode, improve xterm 1519extension, random hacks, numerous bugfixes and extensions.
1460compatibility and apply numerous other bugfixes and extensions.
1461 1520
1462Project Coordinator (Changes 1.0 -) 1521Project Coordinator (Changes 1.0 -)
1463 1522
1523=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1524
1525Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1526
1464=back 1527=back
1465 1528

Diff Legend

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