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.94 by root, Thu Jan 12 05:37:34 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
… …
172resource B<borderColor>. 180resource B<borderColor>.
173 181
174=item B<-fn> I<fontlist> 182=item B<-fn> I<fontlist>
175 183
176Select the fonts to be used. This is a comma separated list of font names 184Select the fonts to be used. This is a comma separated list of font names
177that are used in turn when trying to display Unicode characters. The 185that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 186first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 187smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 188font list is always appended to it. See resource B<font> for more details.
181 189
182In short, to specify an X11 core font, just specify it's name or prefix it 190In short, to specify an X11 core font, just specify it's name or prefix it
… …
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
… …
627of 1 displays the image without any scaling. A scale of 2 to 9 648of 1 displays the image without any scaling. A scale of 2 to 9
628specifies an integer number of images in that direction. No image will 649specifies an integer number of images in that direction. No image will
629be magnified beyond 10 times its original size. The maximum permitted 650be magnified beyond 10 times its original size. The maximum permitted
630scale is 1000. [default 0x0+50+50] 651scale is 1000. [default 0x0+50+50]
631 652
632=item B<menu:> I<file[;tag]>
633
634Read in the specified menu file (note the `.menu' extension is
635optional) and also optionally specify a starting tag to find. See the
636reference documentation for details on the syntax for the menuBar.
637
638=item B<path:> I<path> 653=item B<path:> I<path>
639 654
640Specify the colon-delimited search path for finding files (XPM and 655Specify the colon-delimited search path for finding XPM files.
641menus), in addition to the paths specified by the B<RXVTPATH> and
642B<PATH> environment variables.
643 656
644=item B<font:> I<fontlist> 657=item B<font:> I<fontlist>
645 658
646Select the fonts to be used. This is a comma separated list of font 659Select the fonts to be used. This is a comma separated list of font names
647names that are used in turn when trying to display Unicode characters. 660that are checked in order when trying to find glyphs for characters. The
648The first font defines the cell size for characters; other fonts might 661first font defines the cell size for characters; other fonts might be
649be smaller, but not larger. A reasonable default font list is always 662smaller, but not (in general) larger. A (hopefully) reasonable default
650appended to it; option B<-fn>. 663font list is always appended to it; option B<-fn>.
651 664
652Each font can either be a standard X11 core font (XLFD) name, with 665Each font can either be a standard X11 core font (XLFD) name, with
653optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 666optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
654 667
655In addition, each font can be prefixed with additional hints and 668In addition, each font can be prefixed with additional hints and
… …
657hint currently is C<codeset=codeset-name>, and this is only used for Xft 670hint currently is C<codeset=codeset-name>, and this is only used for Xft
658fonts. 671fonts.
659 672
660For example, this font resource 673For example, this font resource
661 674
662 URxvt*font: 9x15bold,\ 675 URxvt.font: 9x15bold,\
663 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 676 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
664 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 677 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
665 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 678 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
666 xft:Code2000:antialias=false 679 xft:Code2000:antialias=false
667 680
… …
764 777
765The string will be interpreted as if typed into the shell as-is. 778The string will be interpreted as if typed into the shell as-is.
766 779
767Example: 780Example:
768 781
769 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 782 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
770 783
771This creates a new file in your home directory with the screen contents 784This creates a new file in your home directory with the screen contents
772everytime you hit C<Print>. 785everytime you hit C<Print>.
773 786
774=item B<scrollBar:> I<boolean> 787=item B<scrollBar:> I<boolean>
… …
899pressed. If unset it will send the sequence traditionally associated 912pressed. If unset it will send the sequence traditionally associated
900with the B<Execute> key. 913with the B<Execute> key.
901 914
902=item B<cutchars:> I<string> 915=item B<cutchars:> I<string>
903 916
904The characters used as delimiters for double-click word selection. The 917The characters used as delimiters for double-click word selection
905built-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:
906 927
907B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 928B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
908 929
909=item B<preeditType:> I<style> 930=item B<preeditType:> I<style>
910 931
… …
946default. (Note that many other terminals, including xterm, have these 967default. (Note that many other terminals, including xterm, have these
947sequences enabled by default, which doesn't make it safer, though). 968sequences enabled by default, which doesn't make it safer, though).
948 969
949You can enable them by setting this boolean resource or specifying 970You can enable them by setting this boolean resource or specifying
950B<-insecure> as an option. At the moment, this enables display-answer, 971B<-insecure> as an option. At the moment, this enables display-answer,
951locale, findfont, icon label and window title requests as well as dynamic 972locale, findfont, icon label and window title requests.
952menubar dispatch.
953 973
954=item B<modifier:> I<modifier> 974=item B<modifier:> I<modifier>
955 975
956Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 976Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
957B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 977B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
… …
961 981
962Specify 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)
963character is passed through. It may contain escape values as described 983character is passed through. It may contain escape values as described
964in the entry on B<keysym> following. 984in the entry on B<keysym> following.
965 985
966=item B<secondaryScreen:> I<bool> 986=item B<secondaryScreen:> I<boolean>
967 987
968Turn on/off secondary screen (default enabled). 988Turn on/off secondary screen (default enabled).
969 989
970=item B<secondaryScroll:> I<bool> 990=item B<secondaryScroll:> I<boolean>
971 991
972Turn on/off secondary screen scroll (default enabled). If the this 992Turn on/off secondary screen scroll (default enabled). If the this
973option is enabled, scrolls on the secondary screen will change the 993option is enabled, scrolls on the secondary screen will change the
974scrollback buffer and switching to/from the secondary screen will 994scrollback buffer and switching to/from the secondary screen will
975instead scroll the screen up. 995instead scroll the screen up.
976 996
977=item B<hold>: I<bool> 997=item B<hold>: I<boolean>
978 998
979Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 999Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
980will not immediately destroy its window when the program executed within 1000will not immediately destroy its window when the program executed within
981it 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
982user. 1002user.
… …
1115F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1135F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1116will be ignored when running setuid/setgid. 1136will be ignored when running setuid/setgid.
1117 1137
1118See the @@RXVT_NAME@@perl(3) manpage. 1138See the @@RXVT_NAME@@perl(3) manpage.
1119 1139
1140=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1141
1142Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1143details.
1144
1145=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1146
1147Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1148for details.
1149
1120=item B<searchable-scrollback:> I<keysym> 1150=item B<searchable-scrollback:> I<keysym>
1121 1151
1122Sets the hotkey that starts the incremental scrollback buffer search 1152Sets the hotkey that starts the incremental scrollback buffer search
1123(default: C<M-s>). 1153(default: C<M-s>).
1124 1154
… …
1127Specifies 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
1128C<selection-popup> and C<mark-urls> perl extensions. 1158C<selection-popup> and C<mark-urls> perl extensions.
1129 1159
1130=item B<transient-for>: I<windowid> 1160=item B<transient-for>: I<windowid>
1131 1161
1132Sets 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>.
1133 1168
1134=back 1169=back
1135 1170
1136=head1 THE SCROLLBAR 1171=head1 THE SCROLLBAR
1137 1172
… …
1179selection, and trailing whitespace is visually underlined and removed from 1214selection, and trailing whitespace is visually underlined and removed from
1180the selection. 1215the selection.
1181 1216
1182=item B<Insertion>: 1217=item B<Insertion>:
1183 1218
1184Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1219Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1185an B<@@RXVT_NAME@@> window causes the current text selection to be 1220window causes the value of the PRIMARY selection (or CLIPBOARD with the
1186inserted 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.
1187 1225
1188=back 1226=back
1189 1227
1190=head1 CHANGING FONTS 1228=head1 CHANGING FONTS
1191 1229
1192Changing fonts (or font sizes, respectively) via the keypad is not yet 1230Changing fonts (or font sizes, respectively) via the keypad is not yet
1193supported in rxvt-unicode. Bug me if you need this. 1231supported in rxvt-unicode. Bug me if you need this.
1194 1232
1195You can, however, switch fonts at runtime using escape sequences (and 1233You can, however, switch fonts at runtime using escape sequences, e.g.:
1196therefore using the menubar), e.g.:
1197 1234
1198 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1235 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1236
1237You can use keyboard shortcuts, too:
1238
1239 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1240 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1199 1241
1200rxvt-unicode will automatically re-apply these fonts to the output so far. 1242rxvt-unicode will automatically re-apply these fonts to the output so far.
1201 1243
1202=head1 ISO 14755 SUPPORT 1244=head1 ISO 14755 SUPPORT
1203 1245
… …
1274=head1 COLORS AND GRAPHICS 1316=head1 COLORS AND GRAPHICS
1275 1317
1276In addition to the default foreground and background colours, 1318In addition to the default foreground and background colours,
1277B<@@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
1278high-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
1279colours with their B<rgb.txt> names. 1321colours with their names.
1280 1322
1281=begin table 1323=begin table
1282 1324
1283 B<color0> (black) = Black 1325 B<color0> (black) = Black
1284 B<color1> (red) = Red3 1326 B<color1> (red) = Red3
… …
1304It is also possible to specify the colour values of B<foreground>, 1346It is also possible to specify the colour values of B<foreground>,
1305B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1347B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1306a 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
1307color0-color15. 1349color0-color15.
1308 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
1309Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1360Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1310always swapping the foreground/background colours. This is in contrast to 1361always swapping the foreground/background colours. This is in contrast to
1311I<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
1312been specified. For example, 1363been specified. For example,
1313 1364
… …
1317 1368
1318would 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
1319on White. 1370on White.
1320 1371
1321=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!>
1322 1395
1323=head1 ENVIRONMENT 1396=head1 ENVIRONMENT
1324 1397
1325B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1398B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1326 1399
… …
1365 1438
1366=item B<SHELL> 1439=item B<SHELL>
1367 1440
1368The shell to be used for command execution, defaults to C</bin/sh>. 1441The shell to be used for command execution, defaults to C</bin/sh>.
1369 1442
1370=item B<RXVTPATH>
1371
1372The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1373files.
1374
1375=item B<PATH>
1376
1377Used in the same way as C<RXVTPATH>.
1378
1379=item B<RXVT_SOCKET> 1443=item B<RXVT_SOCKET>
1380 1444
1381The unix domain socket path used by @@RXVT_NAME@@c(1) and 1445The unix domain socket path used by @@RXVT_NAME@@c(1) and
1382@@RXVT_NAME@@d(1). 1446@@RXVT_NAME@@d(1).
1383 1447
… …
1420 1484
1421=item Project Coordinator 1485=item Project Coordinator
1422 1486
1423Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1487Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1424 1488
1425L<http://software.schmorp.de/#rxvt-unicode> 1489L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1426 1490
1427=back 1491=back
1428 1492
1429=head1 AUTHORS 1493=head1 AUTHORS
1430 1494
… …
1452 1516
1453Project Coordinator (changes.txt 2.21a to 2.4.5) 1517Project Coordinator (changes.txt 2.21a to 2.4.5)
1454 1518
1455=item Geoff Wing L<< <gcw@pobox.com> >> 1519=item Geoff Wing L<< <gcw@pobox.com> >>
1456 1520
1457Rewrote screen display and text selection routines. Project Coordinator 1521Rewrote screen display and text selection routines.
1522
1458(changes.txt 2.4.6 - rxvt-unicode) 1523Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1459 1524
1460=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1525=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1461 1526
1462Forked rxvt-unicode, rewrote most of the display code and internal 1527Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1463character handling to store text in unicode, improve xterm 1528extension, random hacks, numerous bugfixes and extensions.
1464compatibility and apply numerous other bugfixes and extensions.
1465 1529
1466Project Coordinator (Changes 1.0 -) 1530Project Coordinator (Changes 1.0 -)
1467 1531
1532=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1533
1534Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1535
1468=back 1536=back
1469 1537

Diff Legend

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