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.93 by root, Wed Jan 11 23:08:54 2006 UTC vs.
Revision 1.110 by root, Sun Jan 29 22:38:43 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
1150=item B<searchable-scrollback:> I<keysym>
1151
1152Sets the hotkey that starts the incremental scrollback buffer search
1153(default: C<M-s>).
1154
1120=item B<urlLauncher>: I<string> 1155=item B<urlLauncher>: I<string>
1121 1156
1122Specifies 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
1123C<selection-popup> and C<mark-urls> perl extensions. 1158C<selection-popup> and C<mark-urls> perl extensions.
1124 1159
1125=item B<transient-for>: I<windowid> 1160=item B<transient-for>: I<windowid>
1126 1161
1127Sets 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>.
1128 1168
1129=back 1169=back
1130 1170
1131=head1 THE SCROLLBAR 1171=head1 THE SCROLLBAR
1132 1172
… …
1174selection, and trailing whitespace is visually underlined and removed from 1214selection, and trailing whitespace is visually underlined and removed from
1175the selection. 1215the selection.
1176 1216
1177=item B<Insertion>: 1217=item B<Insertion>:
1178 1218
1179Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1219Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1180an B<@@RXVT_NAME@@> window causes the current text selection to be 1220window causes the value of the PRIMARY selection (or CLIPBOARD with the
1181inserted 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.
1182 1225
1183=back 1226=back
1184 1227
1185=head1 CHANGING FONTS 1228=head1 CHANGING FONTS
1186 1229
1187Changing fonts (or font sizes, respectively) via the keypad is not yet 1230Changing fonts (or font sizes, respectively) via the keypad is not yet
1188supported in rxvt-unicode. Bug me if you need this. 1231supported in rxvt-unicode. Bug me if you need this.
1189 1232
1190You can, however, switch fonts at runtime using escape sequences (and 1233You can, however, switch fonts at runtime using escape sequences, e.g.:
1191therefore using the menubar), e.g.:
1192 1234
1193 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
1194 1241
1195rxvt-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.
1196 1243
1197=head1 ISO 14755 SUPPORT 1244=head1 ISO 14755 SUPPORT
1198 1245
… …
1269=head1 COLORS AND GRAPHICS 1316=head1 COLORS AND GRAPHICS
1270 1317
1271In addition to the default foreground and background colours, 1318In addition to the default foreground and background colours,
1272B<@@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
1273high-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
1274colours with their B<rgb.txt> names. 1321colours with their names.
1275 1322
1276=begin table 1323=begin table
1277 1324
1278 B<color0> (black) = Black 1325 B<color0> (black) = Black
1279 B<color1> (red) = Red3 1326 B<color1> (red) = Red3
… …
1299It is also possible to specify the colour values of B<foreground>, 1346It is also possible to specify the colour values of B<foreground>,
1300B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1347B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1301a 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
1302color0-color15. 1349color0-color15.
1303 1350
1351If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1352their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1353(recommended, but B<MUST> have 4 digits/component), C<#ARGB>, C<#AARRGGBB>
1354and C<#AAAARRRRGGGGBBBB> colour specifications, in addition to the ones
1355provided by X, where the additional A component specifies alpha (opacity)
1356values (0 is completely transparent and the maximum is opaque). You
1357probably need to specify B<"-depth 32">, too, and have the luck that your
1358X-server uses ARGB pixel layout, as X is far from just supporting ARGB
1359visuals out of the box, and rxvt-unicode just fudges around.
1360
1361I<Please note that transparency of any kind if completely unsupported by
1362the author. Don't bug him with installation questions!>
1363
1304Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1364Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1305always swapping the foreground/background colours. This is in contrast to 1365always swapping the foreground/background colours. This is in contrast to
1306I<xterm>(1) where the colours are only swapped if they have not otherwise 1366I<xterm>(1) where the colours are only swapped if they have not otherwise
1307been specified. For example, 1367been specified. For example,
1308 1368
… …
1360 1420
1361=item B<SHELL> 1421=item B<SHELL>
1362 1422
1363The shell to be used for command execution, defaults to C</bin/sh>. 1423The shell to be used for command execution, defaults to C</bin/sh>.
1364 1424
1365=item B<RXVTPATH>
1366
1367The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1368files.
1369
1370=item B<PATH>
1371
1372Used in the same way as C<RXVTPATH>.
1373
1374=item B<RXVT_SOCKET> 1425=item B<RXVT_SOCKET>
1375 1426
1376The unix domain socket path used by @@RXVT_NAME@@c(1) and 1427The unix domain socket path used by @@RXVT_NAME@@c(1) and
1377@@RXVT_NAME@@d(1). 1428@@RXVT_NAME@@d(1).
1378 1429
… …
1447 1498
1448Project Coordinator (changes.txt 2.21a to 2.4.5) 1499Project Coordinator (changes.txt 2.21a to 2.4.5)
1449 1500
1450=item Geoff Wing L<< <gcw@pobox.com> >> 1501=item Geoff Wing L<< <gcw@pobox.com> >>
1451 1502
1452Rewrote screen display and text selection routines. Project Coordinator 1503Rewrote screen display and text selection routines.
1504
1453(changes.txt 2.4.6 - rxvt-unicode) 1505Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1454 1506
1455=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1507=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1456 1508
1457Forked rxvt-unicode, rewrote most of the display code and internal 1509Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1458character handling to store text in unicode, improve xterm 1510extension, random hacks, numerous bugfixes and extensions.
1459compatibility and apply numerous other bugfixes and extensions.
1460 1511
1461Project Coordinator (Changes 1.0 -) 1512Project Coordinator (Changes 1.0 -)
1462 1513
1514=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1515
1516Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1517
1463=back 1518=back
1464 1519

Diff Legend

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