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.114 by root, Thu Jul 6 19:43:21 2006 UTC vs.
Revision 1.125 by root, Fri Jan 19 23:45:03 2007 UTC

… …
17=head1 FREQUENTLY ASKED QUESTIONS 17=head1 FREQUENTLY ASKED QUESTIONS
18 18
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 20frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 21problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 22L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
23 23
24=head1 RXVT-UNICODE VS. RXVT 24=head1 RXVT-UNICODE VS. RXVT
25 25
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 27internally. That means it can store and display most scripts in the
28world. Being a terminal emulator, however, some things are very difficult, 28world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts 29especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules, 30like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. Don't expect pretty output when using these 31like tibetan or devenagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are left-to-right scripts, such 33fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 35belong into the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 36such as cursor-movement while editing -- break otherwise), but that might
37change. 37change.
38 38
39If you are looking for a terminal that supports more exotic scripts, let 39If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very userfriendly, lean and clean 40me recommend C<mlterm>, which is a very user friendly, lean and clean
41terminal emulator. In fact, the reason rxvt-unicode was born was solely 41terminal emulator. In fact, the reason rxvt-unicode was born was solely
42because the author couldn't get C<mlterm> to use one font for latin1 and 42because the author couldn't get C<mlterm> to use one font for latin1 and
43another for japanese. 43another for japanese.
44 44
45Therefore another design rationale was the use of multiple fonts to 45Therefore another design rationale was the use of multiple fonts to
… …
47programs force onto its users never made sense to me: You should be able 47programs force onto its users never made sense to me: You should be able
48to choose any font for any script freely. 48to choose any font for any script freely.
49 49
50Apart from that, rxvt-unicode is also much better internationalised than 50Apart from that, rxvt-unicode is also much better internationalised than
51its predecessor, supports things such as XFT and ISO 14755 that are handy 51its predecessor, supports things such as XFT and ISO 14755 that are handy
52in i18n-environments, is faster, and has a lot less bugs than the original 52in i18n-environments, is faster, and has a lot bugs less than the original
53rxvt. This all in addition to dozens of other small improvements. 53rxvt. This all in addition to dozens of other small improvements.
54 54
55It is still faithfully following the original rxvt idea of being lean 55It is still faithfully following the original rxvt idea of being lean
56and nice on resources: for example, you can still configure rxvt-unicode 56and nice on resources: for example, you can still configure rxvt-unicode
57without most of its features to get a lean binary. It also comes with 57without most of its features to get a lean binary. It also comes with
… …
59from within a single process, which makes startup time very fast and 59from within a single process, which makes startup time very fast and
60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61@@RXVT_NAME@@c(1) (client). 61@@RXVT_NAME@@c(1) (client).
62 62
63It also makes technical information about escape sequences (which have 63It also makes technical information about escape sequences (which have
64been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 64been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65reference documentation (escape sequences etc.). 65reference documentation (escape sequences etc.).
66 66
67=head1 OPTIONS 67=head1 OPTIONS
68 68
69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed 69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
… …
116 116
117Turn on/off inheriting parent window's pixmap. Alternative form is 117Turn on/off inheriting parent window's pixmap. Alternative form is
118B<-tr>; resource B<inheritPixmap>. 118B<-tr>; resource B<inheritPixmap>.
119 119
120I<Please note that transparency of any kind if completely unsupported by 120I<Please note that transparency of any kind if completely unsupported by
121the author. Don't bug him with installation questions!> 121the author. Don't bug him with installation questions! Read the FAQ (man 7
122@@RXVT_NAME@@)!>
122 123
123=item B<-fade> I<number> 124=item B<-fade> I<number>
124 125
125Fade the text by the given percentage when focus is lost. Small values 126Fade the text by the given percentage when focus is lost. Small values
126fade a little only, 100 completely replaces all colours by the fade 127fade a little only, 100 completely replaces all colours by the fade
… …
143 144
144=item B<-sh> 145=item B<-sh>
145 146
146I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 147I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
147background image in addition to tinting it (i.e. B<-tint> must be 148background image in addition to tinting it (i.e. B<-tint> must be
148specified, too, e.g. C<-tint white>). 149specified, too, e.g. C<-tint white>); resource I<shading>.
149 150
150=item B<-bg> I<colour> 151=item B<-bg> I<colour>
151 152
152Window background colour; resource B<background>. 153Window background colour; resource B<background>.
153 154
… …
436The window will not be destroyed when @@RXVT_NAME@@ exits. 437The window will not be destroyed when @@RXVT_NAME@@ exits.
437 438
438It might be useful to know that @@RXVT_NAME@@ will not close file 439It might be useful to know that @@RXVT_NAME@@ will not close file
439descriptors passed to it (except for stdin/out/err, of course), so you 440descriptors passed to it (except for stdin/out/err, of course), so you
440can use file descriptors to communicate with the programs within the 441can use file descriptors to communicate with the programs within the
441terminal. This works regardless of wether the C<-embed> option was used or 442terminal. This works regardless of whether the C<-embed> option was used or
442not. 443not.
443 444
444Here is a short Gtk2-perl snippet that illustrates how this option can be 445Here is a short Gtk2-perl snippet that illustrates how this option can be
445used (a longer example is in F<doc/embed>): 446used (a longer example is in F<doc/embed>):
446 447
… …
451 }); 452 });
452 453
453=item B<-pty-fd> I<file descriptor> 454=item B<-pty-fd> I<file descriptor>
454 455
455Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 456Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
456pair but instead use the given filehandle as the tty master. This is 457pair but instead use the given file descriptor as the tty master. This is
457useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 458useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
458without having to run a program within it. 459without having to run a program within it.
459 460
460If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 461If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
461entries and will not tinker with pty/tty permissions - you have to do that 462entries and will not tinker with pty/tty permissions - you have to do that
… …
563Use the specified colour to display underlined characters when the 564Use the specified colour to display underlined characters when the
564foreground colour is the default. 565foreground colour is the default.
565 566
566=item B<colorRV:> I<colour> 567=item B<colorRV:> I<colour>
567 568
568Use the specified colour as the background for reverse video 569Use the specified colour as the background for reverse video characters
569characters. 570when OPTION_HC is disabled (--disable-frills).
570 571
571=item B<underlineColor:> I<colour> 572=item B<underlineColor:> I<colour>
572 573
573If set, use the specified colour as the colour for the underline 574If set, use the specified colour as the colour for the underline
574itself. If unset, use the foreground colour. 575itself. If unset, use the foreground colour.
… …
619Tint the transparent background pixmap with the given colour; option 620Tint the transparent background pixmap with the given colour; option
620B<-tint>. 621B<-tint>.
621 622
622=item B<shading:> I<number> 623=item B<shading:> I<number>
623 624
624Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 625Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
625image in addition to tinting it. 626in addition to tinting it; option B<-sh>.
626 627
627=item B<scrollColor:> I<colour> 628=item B<scrollColor:> I<colour>
628 629
629Use the specified colour for the scrollbar [default #B2B2B2]. 630Use the specified colour for the scrollbar [default #B2B2B2].
630 631
… …
718 719
719=item B<intensityStyles:> I<boolean> 720=item B<intensityStyles:> I<boolean>
720 721
721When font styles are not enabled, or this option is enabled (B<True>, 722When font styles are not enabled, or this option is enabled (B<True>,
722option B<-is>, the default), bold and italic font styles imply high 723option B<-is>, the default), bold and italic font styles imply high
723intensity foreground/backround colours. Disabling this option (B<False>, 724intensity foreground/background colours. Disabling this option (B<False>,
724option B<+is>) disables this behaviour, the high intensity colours are not 725option B<+is>) disables this behaviour, the high intensity colours are not
725reachable. 726reachable.
726 727
727=item B<selectstyle:> I<mode> 728=item B<selectstyle:> I<mode>
728 729
… …
780Example: 781Example:
781 782
782 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 783 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
783 784
784This creates a new file in your home directory with the screen contents 785This creates a new file in your home directory with the screen contents
785everytime you hit C<Print>. 786every time you hit C<Print>.
786 787
787=item B<scrollBar:> I<boolean> 788=item B<scrollBar:> I<boolean>
788 789
789B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 790B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
790disable the scrollbar; option B<+sb>. 791disable the scrollbar; option B<+sb>.
… …
812 813
813=item B<scrollWithBuffer:> I<boolean> 814=item B<scrollWithBuffer:> I<boolean>
814 815
815B<True>: scroll with scrollback buffer when tty receives new lines (and 816B<True>: scroll with scrollback buffer when tty receives new lines (and
816B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 817B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
817with scrollback buffer when tty recieves new lines; option B<+sw>. 818with scrollback buffer when tty receives new lines; option B<+sw>.
818 819
819=item B<scrollTtyKeypress:> I<boolean> 820=item B<scrollTtyKeypress:> I<boolean>
820 821
821B<True>: scroll to bottom when a non-special key is pressed. Special keys 822B<True>: scroll to bottom when a non-special key is pressed. Special keys
822are those which are intercepted by rxvt-unicode for special handling and 823are those which are intercepted by rxvt-unicode for special handling and
… …
1025 1026
1026I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1027I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
1027C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1028C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
1028C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1029C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1029C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1030C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1030can start or end with whitespace. 1031can start or end with whitespace. B<This feature is deprecated and will
1032be removed>.
1031 1033
1032Please note that you need to double the C<\> in resource files, as 1034Please note that you need to double the C<\> in resource files, as
1033Xlib itself does its own de-escaping (you can use C<\033> instead of 1035Xlib itself does its own de-escaping (you can use C<\033> instead of
1034C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own 1036C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1035processing). 1037processing).
1036 1038
1037You can define a range of keysyms in one shot by providing a I<string> 1039You can define a range of keysyms in one shot by providing a I<string>
1038with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1040with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1039should be a character not used by the strings. 1041should be a character not used by the strings.
1040 1042
1041Its usage can be demonstrated by an example: 1043Its usage can be demonstrated by an example:
1042 1044
1043 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1045 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
… …
1107example, C<default,-selection> will use all the default extension except 1109example, C<default,-selection> will use all the default extension except
1108C<selection>. 1110C<selection>.
1109 1111
1110Extension names can also be followed by an argument in angle brackets 1112Extension names can also be followed by an argument in angle brackets
1111(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1113(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1112searchable scorllback to Alt/Meta-s). Mentioning the same extension 1114searchable scrollback to Alt/Meta-s). Mentioning the same extension
1113multiple times with different arguments will pass multiple arguments to 1115multiple times with different arguments will pass multiple arguments to
1114the extension. 1116the extension.
1115 1117
1116Each extension is looked up in the library directories, loaded if 1118Each extension is looked up in the library directories, loaded if
1117necessary, and bound to the current terminal instance. 1119necessary, and bound to the current terminal instance.
… …
1153(default: C<M-s>). 1155(default: C<M-s>).
1154 1156
1155=item B<urlLauncher>: I<string> 1157=item B<urlLauncher>: I<string>
1156 1158
1157Specifies the program to be started with a URL argument. Used by the 1159Specifies the program to be started with a URL argument. Used by the
1158C<selection-popup> and C<mark-urls> perl extensions. 1160C<selection-popup> and C<matcher> perl extensions.
1159 1161
1160=item B<transient-for>: I<windowid> 1162=item B<transient-for>: I<windowid>
1161 1163
1162Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. 1164Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1163 1165
… …
1376If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1378If 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> 1379their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1378(recommended, but B<MUST> have 4 digits/component) colour specifications, 1380(recommended, but B<MUST> have 4 digits/component) colour specifications,
1379in addition to the ones provided by X, where the additional A component 1381in addition to the ones provided by X, where the additional A component
1380specifies opacity (alpha) values. The minimum value of C<0> is completely 1382specifies 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 1383transparent). You can also prefix any color with C<[percent]>, where
1382to four hex digits specifiying the opacity value. 1384C<percent> is a decimal percentage (0-100) that specifies the opacity of
1385the color, where C<0> is completely transparent and C<100> is completelxy
1386opaque.
1383 1387
1384You probably need to specify B<"-depth 32">, too, and have the luck that 1388You 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 1389your 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. 1390ARGB visuals out of the box, and rxvt-unicode just fudges around.
1387 1391
1388For example, the following selects an almost completely transparent red 1392For example, the following selects an almost completely transparent red
1389background, and an almost opaque pink foreground: 1393background, and an almost opaque pink foreground:
1390 1394
1391 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink" 1395 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1392 1396
1393I<Please note that transparency of any kind if completely unsupported by 1397I<Please note that transparency of any kind if completely unsupported by
1394the author. Don't bug him with installation questions!> 1398the author. Don't bug him with installation questions!>
1395 1399
1396=head1 ENVIRONMENT 1400=head1 ENVIRONMENT
… …
1400=over 4 1404=over 4
1401 1405
1402=item B<TERM> 1406=item B<TERM>
1403 1407
1404Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1408Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1405resources or on the commandline. 1409resources or on the command line.
1406 1410
1407=item B<COLORTERM> 1411=item B<COLORTERM>
1408 1412
1409Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1413Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1410compiled with XPM support, and optionally with the added extension 1414compiled with XPM support, and optionally with the added extension
1411C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1415C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1412 1416
1413=item B<COLORFGBG> 1417=item B<COLORFGBG>
1414 1418

Diff Legend

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