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.149 by ayin, Fri Dec 7 13:49:43 2007 UTC vs.
Revision 1.167 by root, Wed Oct 15 14:48:22 2008 UTC

12emulator intended as an I<xterm>(1) replacement for users who do not 12emulator intended as an I<xterm>(1) replacement for users who do not
13require features such as Tektronix 4014 emulation and toolkit-style 13require features such as Tektronix 4014 emulation and toolkit-style
14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16 16
17This document is also available on the World-Wide-Web at
18L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
19
17=head1 FREQUENTLY ASKED QUESTIONS 20=head1 FREQUENTLY ASKED QUESTIONS
18 21
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 22See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 23frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 24problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>. 25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23 26
24=head1 RXVT-UNICODE VS. RXVT 27=head1 RXVT-UNICODE VS. RXVT
25 28
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 29Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 30internally. That means it can store and display most scripts in the
30like mongolian or scripts requiring extremely complex combining rules, 33like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devanagari. Don't expect pretty output when using these 34like tibetan or devanagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 35scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are right-to-left scripts, such 36fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 37as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 38belong in the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 39such as cursor-movement while editing -- break otherwise), but that might
37change. 40change.
38 41
39If you are looking for a terminal that supports more exotic scripts, let 42If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very user friendly, lean and clean 43me recommend C<mlterm>, which is a very user friendly, lean and clean
89 92
90Print out a message describing available options. 93Print out a message describing available options.
91 94
92=item B<-display> I<displayname> 95=item B<-display> I<displayname>
93 96
94Attempt to open a window on the named X display (B<-d> still 97Attempt to open a window on the named X display (the older form B<-d>
95respected). In the absence of this option, the display specified by the 98is still respected. but deprecated). In the absence of this option, the
96B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
97 100
98=item B<-depth> I<bitdepth> 101=item B<-depth> I<bitdepth>
99 102
100Compile I<xft>: Attempt to find a visual with the given bit depth; 103Compile I<xft>: Attempt to find a visual with the given bit depth;
101resource B<depth>. 104resource B<depth>.
105
106[Please note that many X servers (and libXft) are buggy with
107respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out]
102 110
103=item B<-geometry> I<geom> 111=item B<-geometry> I<geom>
104 112
105Window geometry (B<-g> still respected); resource B<geometry>. 113Window geometry (B<-g> still respected); resource B<geometry>.
106 114
242italic> >> characters are to be printed. See resource B<boldItalicFont> 250italic> >> characters are to be printed. See resource B<boldItalicFont>
243for details. 251for details.
244 252
245=item B<-is>|B<+is> 253=item B<-is>|B<+is>
246 254
247Compile I<font-styles>: Bold/Italic font styles imply high intensity 255Compile I<font-styles>: Bold/Blink font styles imply high intensity
248foreground/background (default). See resource B<intensityStyles> for 256foreground/background (default). See resource B<intensityStyles> for
249details. 257details.
250 258
251=item B<-name> I<name> 259=item B<-name> I<name>
252 260
270 278
271=item B<-sb>|B<+sb> 279=item B<-sb>|B<+sb>
272 280
273Turn on/off scrollbar; resource B<scrollBar>. 281Turn on/off scrollbar; resource B<scrollBar>.
274 282
283=item B<-sr>|B<+sr>
284
285Put scrollbar on right/left; resource B<scrollBar_right>.
286
287=item B<-st>|B<+st>
288
289Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
290resource B<scrollBar_floating>.
291
275=item B<-si>|B<+si> 292=item B<-si>|B<+si>
276 293
277Turn on/off scroll-to-bottom on TTY output inhibit; resource 294Turn on/off scroll-to-bottom on TTY output inhibit; resource
278B<scrollTtyOutput> has opposite effect. 295B<scrollTtyOutput> has opposite effect.
279 296
285=item B<-sw>|B<+sw> 302=item B<-sw>|B<+sw>
286 303
287Turn on/off scrolling with the scrollback buffer as new lines appear. 304Turn on/off scrolling with the scrollback buffer as new lines appear.
288This only takes effect if B<-si> is also given; resource 305This only takes effect if B<-si> is also given; resource
289B<scrollWithBuffer>. 306B<scrollWithBuffer>.
290
291=item B<-sr>|B<+sr>
292
293Put scrollbar on right/left; resource B<scrollBar_right>.
294
295=item B<-st>|B<+st>
296
297Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
298resource B<scrollBar_floating>.
299 307
300=item B<-ptab>|B<+ptab> 308=item B<-ptab>|B<+ptab>
301 309
302If enabled (default), "Horizontal Tab" characters are being stored as 310If enabled (default), "Horizontal Tab" characters are being stored as
303actual wide characters in the screen buffer, which makes it possible to 311actual wide characters in the screen buffer, which makes it possible to
332 340
333=item B<-bl> 341=item B<-bl>
334 342
335Compile I<frills>: Set MWM hints to request a borderless window, i.e. 343Compile I<frills>: Set MWM hints to request a borderless window, i.e.
336if honoured by the WM, the rxvt-unicode window will not have window 344if honoured by the WM, the rxvt-unicode window will not have window
337decorations; resource B<borderLess>. 345decorations; resource B<borderLess>. If the window manager does not
346support MWM hints (e.g. kwin), enables override-redirect mode.
338 347
339=item B<-override-redirect> 348=item B<-override-redirect>
340 349
341Compile I<frills>: Sets override-redirect on the window; resource 350Compile I<frills>: Sets override-redirect on the window; resource
342B<override-redirect>. 351B<override-redirect>.
447Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 456Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
448will not immediately destroy its window when the program executed within 457will not immediately destroy its window when the program executed within
449it exits. Instead, it will wait till it is being killed or closed by the 458it exits. Instead, it will wait till it is being killed or closed by the
450user; resource B<hold>. 459user; resource B<hold>.
451 460
461=item B<-cd> I<path>
462
463Sets the working directory for the shell (or the command specified via
464B<-e>). The I<path> must be an absolute path and it must exist for
465@@RXVT_NAME@@ to start; resource B<chdir>.
466
452=item B<-xrm> I<string> 467=item B<-xrm> I<string>
453 468
454Works like the X Toolkit option of the same name, by adding the I<string> 469Works like the X Toolkit option of the same name, by adding the I<string>
455as if it were specified in a resource file. Resource values specified this 470as if it were specified in a resource file. Resource values specified this
456way take precedence over all other resource specifications. 471way take precedence over all other resource specifications.
503If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 518If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
504entries and will not tinker with pty/tty permissions - you have to do that 519entries and will not tinker with pty/tty permissions - you have to do that
505yourself if you want that. 520yourself if you want that.
506 521
507As an extremely special case, specifying C<-1> will completely suppress 522As an extremely special case, specifying C<-1> will completely suppress
508pty/tty operations. 523pty/tty operations, which is probably only useful in conjunction with some
524perl extension that manages the terminal.
509 525
510Here is a example in perl that illustrates how this option can be used (a 526Here is a example in perl that illustrates how this option can be used (a
511longer example is in F<doc/pty-fd>): 527longer example is in F<doc/pty-fd>):
512 528
513 use IO::Pty; 529 use IO::Pty;
527Comma-separated list of perl extension scripts to use (or not to use) in 543Comma-separated list of perl extension scripts to use (or not to use) in
528this terminal instance. See resource B<perl-ext> for details. 544this terminal instance. See resource B<perl-ext> for details.
529 545
530=back 546=back
531 547
532=head1 RESOURCES (available also as long-options) 548=head1 RESOURCES
533 549
534Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 550Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
535options) compiled into your version. 551options) compiled into your version. All resources are also available as
552long-options.
536 553
537You can set and change the resources using X11 tools like B<xrdb>. Many 554You can set and change the resources using X11 tools like B<xrdb>. Many
538distribution do also load settings from the B<~/.Xresources> file when X 555distribution do also load settings from the B<~/.Xresources> file when X
539starts. @@RXVT_NAME@@ will consult the following files/resources in order, 556starts. @@RXVT_NAME@@ will consult the following files/resources in order,
540with later settings overwriting earlier ones: 557with later settings overwriting earlier ones:
562=item B<depth:> I<bitdepth> 579=item B<depth:> I<bitdepth>
563 580
564Compile I<xft>: Attempt to find a visual with the given bit depth; 581Compile I<xft>: Attempt to find a visual with the given bit depth;
565option B<-depth>. 582option B<-depth>.
566 583
584=item B<buffered:> I<boolean>
585
586Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
587On some card/driver combination enabling it slightly decreases
588performance, on most it greatly helps it. The slowdown is small, so it
589should normally be enabled.
590
567=item B<geometry:> I<geom> 591=item B<geometry:> I<geom>
568 592
569Create the window with the specified X window geometry [default 80x24]; 593Create the window with the specified X window geometry [default 80x24];
570option B<-geometry>. 594option B<-geometry>.
571 595
719an integer number of images in that direction. No image will be magnified 743an integer number of images in that direction. No image will be magnified
720beyond 10 times its original size. The maximum permitted scale is 1000. 744beyond 10 times its original size. The maximum permitted scale is 1000.
721Additional operations can be specified after colon B<:op1:op2...>. 745Additional operations can be specified after colon B<:op1:op2...>.
722Supported operations are: 746Supported operations are:
723 747
724 tile force background image to be tiled and not scaled. Equivalent to 0x0, 748 tile force background image to be tiled and not scaled. Equivalent to 0x0
725 propscale will scale image keeping proportions, 749 propscale will scale image keeping proportions
726 auto will scale image to match window size. Equivalent to 100x100; 750 auto will scale image to match window size. Equivalent to 100x100
727 hscale will scale image horizontally to the window size; 751 hscale will scale image horizontally to the window size
728 vscale will scale image vertically to the window size; 752 vscale will scale image vertically to the window size
729 scale will scale image to match window size; 753 scale will scale image to match window size
730 root will tile image as if it was a root window background, auto-adjusting 754 root will tile image as if it was a root window background, auto-adjusting
731 whenever terminal window moves. 755 whenever terminal window moves
732 756
733If used in conjunction with B<-tr> option, the specified pixmap will be 757If used in conjunction with B<-tr> option, the specified pixmap will be
734blended over transparency image using either alpha-blending, or any 758blended over transparency image using either alpha-blending, or any
735other blending type, specified with B<-blt "type"> option. 759other blending type, specified with B<-blt "type"> option.
736 760
801text font will being used for the given style. 825text font will being used for the given style.
802 826
803=item B<intensityStyles:> I<boolean> 827=item B<intensityStyles:> I<boolean>
804 828
805When font styles are not enabled, or this option is enabled (B<True>, 829When font styles are not enabled, or this option is enabled (B<True>,
806option B<-is>, the default), bold and italic font styles imply high 830option B<-is>, the default), bold/blink font styles imply high
807intensity foreground/background colours. Disabling this option (B<False>, 831intensity foreground/background colours. Disabling this option (B<False>,
808option B<+is>) disables this behaviour, the high intensity colours are not 832option B<+is>) disables this behaviour, the high intensity colours are not
809reachable. 833reachable.
810 834
811=item B<selectstyle:> I<mode>
812
813Set mouse selection style to B<old> which is 2.20, B<oldword> which
814is xterm style with 2.20 old word selection, or anything else which
815gives xterm style selection. Only effective when the original (non-perl)
816selection code is in use.
817
818=item B<scrollstyle:> I<mode>
819
820Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
821the author's favourite.
822
823=item B<title:> I<string> 835=item B<title:> I<string>
824 836
825Set window title string, the default title is the command-line 837Set window title string, the default title is the command-line
826specified after the B<-e> option, if any, otherwise the application 838specified after the B<-e> option, if any, otherwise the application
827name; option B<-title>. 839name; option B<-title>.
840=item B<urgentOnBell:> I<boolean> 852=item B<urgentOnBell:> I<boolean>
841 853
842B<True>: set the urgency hint for the wm on receipt of a bell character. 854B<True>: set the urgency hint for the wm on receipt of a bell character.
843B<False>: do not set the urgency hint [default]. 855B<False>: do not set the urgency hint [default].
844 856
857@@RXVT_NAME@@ resets the urgency hint on every focus change.
858
845=item B<visualBell:> I<boolean> 859=item B<visualBell:> I<boolean>
846 860
847B<True>: use visual bell on receipt of a bell character; option B<-vb>. 861B<True>: use visual bell on receipt of a bell character; option B<-vb>.
848B<False>: no visual bell [default]; option B<+vb>. 862B<False>: no visual bell [default]; option B<+vb>.
849 863
871 885
872 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 886 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
873 887
874This creates a new file in your home directory with the screen contents 888This creates a new file in your home directory with the screen contents
875every time you hit C<Print>. 889every time you hit C<Print>.
890
891=item B<scrollstyle:> I<mode>
892
893Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
894the author's favourite.
876 895
877=item B<scrollBar:> I<boolean> 896=item B<scrollBar:> I<boolean>
878 897
879B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 898B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
880disable the scrollbar; option B<+sb>. 899disable the scrollbar; option B<+sb>.
1079 1098
1080=item B<secondaryScroll:> I<boolean> 1099=item B<secondaryScroll:> I<boolean>
1081 1100
1082Turn on/off secondary screen scroll (default enabled). If this 1101Turn on/off secondary screen scroll (default enabled). If this
1083option is enabled, scrolls on the secondary screen will change the 1102option is enabled, scrolls on the secondary screen will change the
1084scrollback buffer and switching to/from the secondary screen will 1103scrollback buffer and, when secondaryScreen is off, switching
1085instead scroll the screen up. 1104to/from the secondary screen will instead scroll the screen up.
1086 1105
1087=item B<hold>: I<boolean> 1106=item B<hold>: I<boolean>
1088 1107
1089Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1108Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1090will not immediately destroy its window when the program executed within 1109will not immediately destroy its window when the program executed within
1091it exits. Instead, it will wait till it is being killed or closed by the 1110it exits. Instead, it will wait till it is being killed or closed by the
1092user. 1111user.
1112
1113=item B<chdir>: I<path>
1114
1115Sets the working directory for the shell (or the command specified via
1116B<-e>). The I<path> must be an absolute path and it must exist for
1117@@RXVT_NAME@@ to start. If it isn't specified then the current working
1118directory will be used; option B<-cd>.
1093 1119
1094=item B<keysym.>I<sym>: I<string> 1120=item B<keysym.>I<sym>: I<string>
1095 1121
1096Compile I<frills>: Associate I<string> with keysym I<sym>. The 1122Compile I<frills>: Associate I<string> with keysym I<sym>. The
1097intervening resource name B<keysym.> cannot be omitted. 1123intervening resource name B<keysym.> cannot be omitted.
1204all instances, while B<perl-ext> is used for specific instances. 1230all instances, while B<perl-ext> is used for specific instances.
1205 1231
1206=item B<perl-eval>: I<string> 1232=item B<perl-eval>: I<string>
1207 1233
1208Perl code to be evaluated when all extensions have been registered. See 1234Perl code to be evaluated when all extensions have been registered. See
1209the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1235the @@RXVT_NAME@@perl(3) manpage.
1210will be ignored when running setuid/setgid.
1211 1236
1212=item B<perl-lib>: I<path> 1237=item B<perl-lib>: I<path>
1213 1238
1214Colon-separated list of additional directories that hold extension 1239Colon-separated list of additional directories that hold extension
1215scripts. When looking for extensions specified by the C<perl> resource, 1240scripts. When looking for extensions specified by the C<perl> resource,
1216@@RXVT_NAME@@ will first look in these directories and then in 1241@@RXVT_NAME@@ will first look in these directories and then in
1217F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1242F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1218will be ignored when running setuid/setgid.
1219 1243
1220See the @@RXVT_NAME@@perl(3) manpage. 1244See the @@RXVT_NAME@@perl(3) manpage.
1221 1245
1222=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1246=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1223 1247
1458=back 1482=back
1459 1483
1460=head2 ALPHA CHANNEL SUPPORT 1484=head2 ALPHA CHANNEL SUPPORT
1461 1485
1462If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1486If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1463their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1487their act together, rxvt-unicode will do it's own alpha channel management:
1464(recommended, but B<MUST> have 4 digits/component) colour specifications, 1488
1465in addition to the ones provided by X, where the additional A component 1489You can prefix any color with an opaquenes percentage enclosed in
1490brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1491(0-100) that specifies the opacity of the color, where C<0> is completely
1492transparent and C<100> is completely opaque. For example, C<[50]red> is a
1493half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1494is the recommended format to specify transparency values, and works with
1495all ways to specify a colour.
1496
1497For complete control, rxvt-unicode also supports
1498C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1499specifications, where the additional C<aaaa> component specifies opacity
1466specifies opacity (alpha) values. The minimum value of C<0> is completely 1500(alpha) values. The minimum value of C<0000> is completely transparent,
1467transparent). You can also prefix any color with C<[percent]>, where 1501while C<ffff> is completely opaque). The two example colours from
1468C<percent> is a decimal percentage (0-100) that specifies the opacity of 1502earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1469the color, where C<0> is completely transparent and C<100> is completelxy 1503C<rgba:0000/ff00/0000/f332>.
1470opaque.
1471 1504
1472You probably need to specify B<"-depth 32">, too, and have the luck that 1505You probably need to specify B<"-depth 32">, too, to force a visual with
1473your X-server uses ARGB pixel layout, as X is far from just supporting 1506alpha channels, and have the luck that your X-server uses ARGB pixel
1474ARGB visuals out of the box, and rxvt-unicode just fudges around. 1507layout, as X is far from just supporting ARGB visuals out of the box, and
1508rxvt-unicode just fudges around.
1475 1509
1476For example, the following selects an almost completely transparent red 1510For example, the following selects an almost completely transparent black
1477background, and an almost opaque pink foreground: 1511background, and an almost opaque pink foreground:
1478 1512
1479 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" 1513 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1480 1514
1481I<Please note that transparency of any kind if completely unsupported by 1515When not using a background image, then the interpretation of the
1482the author. Don't bug him with installation questions!> 1516alpha channel is up to your compositing manager (most interpret it as
1517transparency of course).
1518
1519When using a background pixmap or pseudo-transparency, then the background
1520colour will always behave as if it were completely transparent (so the
1521background image shows instead), regardless of how it was specified, while
1522other colours will either be transparent as specified (the background
1523image will show through) on servers supporting the RENDER extension, or
1524fully opaque on servers not supporting the RENDER EXTENSION.
1525
1526Please note that due to bugs in Xft, specifying alpha values might result
1527in garbage being displayed when the X-server does not support the RENDER
1528extension.
1483 1529
1484=head1 ENVIRONMENT 1530=head1 ENVIRONMENT
1485 1531
1486B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1532B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1487 1533
1521C<--with-terminfo=PATH>. 1567C<--with-terminfo=PATH>.
1522 1568
1523=item B<DISPLAY> 1569=item B<DISPLAY>
1524 1570
1525Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1571Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1526display in its child processes. 1572display in its child processes if C<-display> isn't used to override. It
1573defaults to C<:0> if it doesn't exist.
1527 1574
1528=item B<SHELL> 1575=item B<SHELL>
1529 1576
1530The shell to be used for command execution, defaults to C</bin/sh>. 1577The shell to be used for command execution, defaults to C</bin/sh>.
1531 1578

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines