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.109 by root, Sun Jan 29 22:27:04 2006 UTC vs.
Revision 1.128 by root, Wed May 16 22:37:10 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
46display characters: The idea of a single unicode font which many other 46display characters: The idea of a single unicode font which many other
47programs force onto it's 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
51it's 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 it's features to get a lean binary. It also comes with 57without most of its features to get a lean binary. It also comes with
58a client/daemon pair that lets you open any number of terminal windows 58a client/daemon pair that lets you open any number of terminal windows
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
… …
115=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 115=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
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
121the author. Don't bug him with installation questions! Read the FAQ (man 7
122@@RXVT_NAME@@)!>
123
120=item B<-fade> I<number> 124=item B<-fade> I<number>
121 125
122Fade 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
123fade a little only, 100 completely replaces all colours by the fade 127fade a little only, 100 completely replaces all colours by the fade
124colour; resource B<fading>. 128colour; resource B<fading>.
125 129
126=item B<-fadecolor> I<colour> 130=item B<-fadecolor> I<colour>
127 131
128Fade to this colour when fading is used (see B<-fade>). The default colour 132Fade to this colour when fading is used (see B<-fade>). The default colour
129is black. resource B<fadeColor>. 133is opaque black. resource B<fadeColor>.
130 134
131=item B<-tint> I<colour> 135=item B<-tint> I<colour>
132 136
133Tint the transparent background pixmap with the given colour when 137Tint the transparent background pixmap with the given colour when
134transparency is enabled with B<-tr> or B<-ip>. This only works for 138transparency is enabled with B<-tr> or B<-ip>. This only works for
… …
140 144
141=item B<-sh> 145=item B<-sh>
142 146
143I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 147I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
144background 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
145specified, too, e.g. C<-tint white>). 149specified, too, e.g. C<-tint white>); resource I<shading>.
146 150
147=item B<-bg> I<colour> 151=item B<-bg> I<colour>
148 152
149Window background colour; resource B<background>. 153Window background colour; resource B<background>.
150 154
… …
182that are checked in order when trying to find glyphs for characters. The 186that are checked in order when trying to find glyphs for characters. The
183first font defines the cell size for characters; other fonts might be 187first font defines the cell size for characters; other fonts might be
184smaller, but not (in general) larger. A (hopefully) reasonable default 188smaller, but not (in general) larger. A (hopefully) reasonable default
185font list is always appended to it. See resource B<font> for more details. 189font list is always appended to it. See resource B<font> for more details.
186 190
187In short, to specify an X11 core font, just specify it's name or prefix it 191In short, to specify an X11 core font, just specify its name or prefix it
188with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, 192with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
189e.g.: 193e.g.:
190 194
191 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 195 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
192 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 196 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
… …
420 424
421Remap a key symbol. See resource B<keysym>. 425Remap a key symbol. See resource B<keysym>.
422 426
423=item B<-embed> I<windowid> 427=item B<-embed> I<windowid>
424 428
425Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 429Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
426which enables applications to easily embed a terminal. 430which enables applications to easily embed a terminal.
427 431
428Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 432Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
429shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 433shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
430quite a bit, so don't expect it to keep some specific state. It's best to 434quite a bit, so don't expect it to keep some specific state. It's best to
… …
433The window will not be destroyed when @@RXVT_NAME@@ exits. 437The window will not be destroyed when @@RXVT_NAME@@ exits.
434 438
435It 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
436descriptors 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
437can use file descriptors to communicate with the programs within the 441can use file descriptors to communicate with the programs within the
438terminal. 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
439not. 443not.
440 444
441Here 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
442used (a longer example is in F<doc/embed>): 446used (a longer example is in F<doc/embed>):
443 447
… …
448 }); 452 });
449 453
450=item B<-pty-fd> I<file descriptor> 454=item B<-pty-fd> I<file descriptor>
451 455
452Tells @@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
453pair 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
454useful 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
455without having to run a program within it. 459without having to run a program within it.
456 460
457If 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
458entries 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
… …
560Use the specified colour to display underlined characters when the 564Use the specified colour to display underlined characters when the
561foreground colour is the default. 565foreground colour is the default.
562 566
563=item B<colorRV:> I<colour> 567=item B<colorRV:> I<colour>
564 568
565Use the specified colour as the background for reverse video 569Use the specified colour as the background for reverse video characters
566characters. 570when OPTION_HC is disabled (--disable-frills).
567 571
568=item B<underlineColor:> I<colour> 572=item B<underlineColor:> I<colour>
569 573
570If set, use the specified colour as the colour for the underline 574If set, use the specified colour as the colour for the underline
571itself. If unset, use the foreground colour. 575itself. If unset, use the foreground colour.
… …
597 601
598B<True>: make the background inherit the parent windows' pixmap, giving 602B<True>: make the background inherit the parent windows' pixmap, giving
599artificial transparency. B<False>: do not inherit the parent windows' 603artificial transparency. B<False>: do not inherit the parent windows'
600pixmap. 604pixmap.
601 605
606I<Please note that transparency of any kind if completely unsupported by
607the author. Don't bug him with installation questions!>
608
602=item B<fading:> I<number> 609=item B<fading:> I<number>
603 610
604Fade the text by the given percentage when focus is lost; option B<-fade>. 611Fade the text by the given percentage when focus is lost; option B<-fade>.
605 612
606=item B<fadeColor:> I<colour> 613=item B<fadeColor:> I<colour>
… …
613Tint the transparent background pixmap with the given colour; option 620Tint the transparent background pixmap with the given colour; option
614B<-tint>. 621B<-tint>.
615 622
616=item B<shading:> I<number> 623=item B<shading:> I<number>
617 624
618Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 625Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
619image in addition to tinting it. 626in addition to tinting it; option B<-sh>.
620 627
621=item B<scrollColor:> I<colour> 628=item B<scrollColor:> I<colour>
622 629
623Use the specified colour for the scrollbar [default #B2B2B2]. 630Use the specified colour for the scrollbar [default #B2B2B2].
624 631
… …
712 719
713=item B<intensityStyles:> I<boolean> 720=item B<intensityStyles:> I<boolean>
714 721
715When 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>,
716option B<-is>, the default), bold and italic font styles imply high 723option B<-is>, the default), bold and italic font styles imply high
717intensity foreground/backround colours. Disabling this option (B<False>, 724intensity foreground/background colours. Disabling this option (B<False>,
718option B<+is>) disables this behaviour, the high intensity colours are not 725option B<+is>) disables this behaviour, the high intensity colours are not
719reachable. 726reachable.
720 727
721=item B<selectstyle:> I<mode> 728=item B<selectstyle:> I<mode>
722 729
… …
744=item B<mapAlert:> I<boolean> 751=item B<mapAlert:> I<boolean>
745 752
746B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 753B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
747de-iconify (map) on receipt of a bell character [default]. 754de-iconify (map) on receipt of a bell character [default].
748 755
756=item B<urgentOnBell:> I<boolean>
757
758B<True>: set the urgency hint for the wm on receipt of a bell character.
759B<False>: do not set the urgency hint [default].
760
749=item B<visualBell:> I<boolean> 761=item B<visualBell:> I<boolean>
750 762
751B<True>: use visual bell on receipt of a bell character; option B<-vb>. 763B<True>: use visual bell on receipt of a bell character; option B<-vb>.
752B<False>: no visual bell [default]; option B<+vb>. 764B<False>: no visual bell [default]; option B<+vb>.
753 765
… …
774Example: 786Example:
775 787
776 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 788 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
777 789
778This creates a new file in your home directory with the screen contents 790This creates a new file in your home directory with the screen contents
779everytime you hit C<Print>. 791every time you hit C<Print>.
780 792
781=item B<scrollBar:> I<boolean> 793=item B<scrollBar:> I<boolean>
782 794
783B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 795B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
784disable the scrollbar; option B<+sb>. 796disable the scrollbar; option B<+sb>.
… …
806 818
807=item B<scrollWithBuffer:> I<boolean> 819=item B<scrollWithBuffer:> I<boolean>
808 820
809B<True>: scroll with scrollback buffer when tty receives new lines (and 821B<True>: scroll with scrollback buffer when tty receives new lines (and
810B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 822B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
811with scrollback buffer when tty recieves new lines; option B<+sw>. 823with scrollback buffer when tty receives new lines; option B<+sw>.
812 824
813=item B<scrollTtyKeypress:> I<boolean> 825=item B<scrollTtyKeypress:> I<boolean>
814 826
815B<True>: scroll to bottom when a non-special key is pressed. Special keys 827B<True>: scroll to bottom when a non-special key is pressed. Special keys
816are those which are intercepted by rxvt-unicode for special handling and 828are those which are intercepted by rxvt-unicode for special handling and
… …
981 993
982Turn on/off secondary screen (default enabled). 994Turn on/off secondary screen (default enabled).
983 995
984=item B<secondaryScroll:> I<boolean> 996=item B<secondaryScroll:> I<boolean>
985 997
986Turn on/off secondary screen scroll (default enabled). If the this 998Turn on/off secondary screen scroll (default enabled). If this
987option is enabled, scrolls on the secondary screen will change the 999option is enabled, scrolls on the secondary screen will change the
988scrollback buffer and switching to/from the secondary screen will 1000scrollback buffer and switching to/from the secondary screen will
989instead scroll the screen up. 1001instead scroll the screen up.
990 1002
991=item B<hold>: I<boolean> 1003=item B<hold>: I<boolean>
… …
1019 1031
1020I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1032I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
1021C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1033C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
1022C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1034C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1023C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1035C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1024can start or end with whitespace. 1036can start or end with whitespace. B<This feature is deprecated and will
1037be removed>.
1025 1038
1026Please note that you need to double the C<\> in resource files, as 1039Please note that you need to double the C<\> in resource files, as
1027Xlib itself does it's own de-escaping (you can use C<\033> instead of 1040Xlib itself does its own de-escaping (you can use C<\033> instead of
1028C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own 1041C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1029processing). 1042processing).
1030 1043
1031You can define a range of keysyms in one shot by providing a I<string> 1044You can define a range of keysyms in one shot by providing a I<string>
1032with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1045with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1033should be a character not used by the strings. 1046should be a character not used by the strings.
1034 1047
1035Its usage can be demonstrated by an example: 1048Its usage can be demonstrated by an example:
1036 1049
1037 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1050 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
… …
1101example, C<default,-selection> will use all the default extension except 1114example, C<default,-selection> will use all the default extension except
1102C<selection>. 1115C<selection>.
1103 1116
1104Extension names can also be followed by an argument in angle brackets 1117Extension names can also be followed by an argument in angle brackets
1105(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1118(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1106searchable scorllback to Alt/Meta-s). Mentioning the same extension 1119searchable scrollback to Alt/Meta-s). Mentioning the same extension
1107multiple times with different arguments will pass multiple arguments to 1120multiple times with different arguments will pass multiple arguments to
1108the extension. 1121the extension.
1109 1122
1110Each extension is looked up in the library directories, loaded if 1123Each extension is looked up in the library directories, loaded if
1111necessary, and bound to the current terminal instance. 1124necessary, and bound to the current terminal instance.
… …
1147(default: C<M-s>). 1160(default: C<M-s>).
1148 1161
1149=item B<urlLauncher>: I<string> 1162=item B<urlLauncher>: I<string>
1150 1163
1151Specifies the program to be started with a URL argument. Used by the 1164Specifies the program to be started with a URL argument. Used by the
1152C<selection-popup> and C<mark-urls> perl extensions. 1165C<selection-popup> and C<matcher> perl extensions.
1153 1166
1154=item B<transient-for>: I<windowid> 1167=item B<transient-for>: I<windowid>
1155 1168
1156Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. 1169Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1157 1170
… …
1185application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1198application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1186(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1199(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1187up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1200up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1188respectively. 1201respectively.
1189 1202
1190=head1 TEXT SELECTION AND INSERTION 1203=head1 THE SELECTION: SELECTING AND PASTING TEXT
1191 1204
1192The behaviour of text selection and insertion mechanism is similar to 1205The behaviour of text selection and insertion/pasting mechanism is similar
1193I<xterm>(1). 1206to I<xterm>(1).
1194 1207
1195=over 4 1208=over 4
1196 1209
1197=item B<Selection>: 1210=item B<Selecting>:
1198 1211
1199Left click at the beginning of the region, drag to the end of the region 1212Left click at the beginning of the region, drag to the end of the region
1200and release; Right click to extend the marked region; Left double-click 1213and release; Right click to extend the marked region; Left double-click
1201to select a word; Left triple-click to select the entire logical line 1214to select a word; Left triple-click to select the entire logical line
1202(which can span multiple screen lines), unless modified by resource 1215(which can span multiple screen lines), unless modified by resource
… …
1206(Compile: I<frills>) will create a rectangular selection instead of a 1219(Compile: I<frills>) will create a rectangular selection instead of a
1207normal one. In this mode, every selected row becomes its own line in the 1220normal one. In this mode, every selected row becomes its own line in the
1208selection, and trailing whitespace is visually underlined and removed from 1221selection, and trailing whitespace is visually underlined and removed from
1209the selection. 1222the selection.
1210 1223
1211=item B<Insertion>: 1224=item B<Pasting>:
1212 1225
1213Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> 1226Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1214window causes the value of the PRIMARY selection (or CLIPBOARD with the 1227window causes the value of the PRIMARY selection (or CLIPBOARD with the
1215Meta modifier) to be inserted as if it had been typed on the keyboard. 1228B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1216 1229
1217Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1230Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1218inserted too. 1231inserted too.
1219 1232
1220=back 1233=back
… …
1267This mode lets you input characters representing the keycap symbols of 1280This mode lets you input characters representing the keycap symbols of
1268your keyboard, if representable in the current locale encoding. 1281your keyboard, if representable in the current locale encoding.
1269 1282
1270Start by pressing C<Control> and C<Shift> together, then releasing 1283Start by pressing C<Control> and C<Shift> together, then releasing
1271them. The next special key (cursor keys, home etc.) you enter will not 1284them. The next special key (cursor keys, home etc.) you enter will not
1272invoke it's usual function but instead will insert the corresponding 1285invoke its usual function but instead will insert the corresponding
1273keycap symbol. The symbol will only be entered when the key has been 1286keycap symbol. The symbol will only be entered when the key has been
1274released, otherwise pressing e.g. C<Shift> would enter the symbol for 1287released, otherwise pressing e.g. C<Shift> would enter the symbol for
1275C<ISO Level 2 Switch>, although your intention might have been to enter a 1288C<ISO Level 2 Switch>, although your intention might have been to enter a
1276reverse tab (Shift-Tab). 1289reverse tab (Shift-Tab).
1277 1290
… …
1340It is also possible to specify the colour values of B<foreground>, 1353It is also possible to specify the colour values of B<foreground>,
1341B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1354B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1342a number 0-15, as a convenient shorthand to reference the colour name of 1355a number 0-15, as a convenient shorthand to reference the colour name of
1343color0-color15. 1356color0-color15.
1344 1357
1345If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1358In addition to the colours defined above, @@RXVT_NAME@@ offers an
1346their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1359additional 72 colours. The first 64 of those (with indices 16 to 79)
1347(recommended, but B<MUST> have 4 digits/component), C<#ARGB>, C<#AARRGGBB> 1360consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
1348and C<#AAAARRRRGGGGBBBB> colour specifications, in addition to the ones 136116>), followed by 8 additional shades of gray (with indices 80 to 87).
1349provided by X, where the additional A component specifies alpha (opacity) 1362
1350values (0 is completely transparent and the maximum is opaque). You 1363Together, all those colours implement the 88 colour xterm colours. Only
1351probably need to specify B<"-depth 32">, too, and have the luck that your 1364the first 16 can be changed using resources currently, the rest can only
1352X-server uses ARGB pixel layout, as X is far from just supporting ARGB 1365be changed via command sequences ("escape codes").
1353visuals out of the box, and rxvt-unicode just fudges around.
1354 1366
1355Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1367Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1356always swapping the foreground/background colours. This is in contrast to 1368always swapping the foreground/background colours. This is in contrast to
1357I<xterm>(1) where the colours are only swapped if they have not otherwise 1369I<xterm>(1) where the colours are only swapped if they have not otherwise
1358been specified. For example, 1370been specified. For example,
… …
1364would yield White on Black, while on I<xterm>(1) it would yield Black 1376would yield White on Black, while on I<xterm>(1) it would yield Black
1365on White. 1377on White.
1366 1378
1367=back 1379=back
1368 1380
1381=head2 ALPHA CHANNEL SUPPORT
1382
1383If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1384their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1385(recommended, but B<MUST> have 4 digits/component) colour specifications,
1386in addition to the ones provided by X, where the additional A component
1387specifies opacity (alpha) values. The minimum value of C<0> is completely
1388transparent). You can also prefix any color with C<[percent]>, where
1389C<percent> is a decimal percentage (0-100) that specifies the opacity of
1390the color, where C<0> is completely transparent and C<100> is completelxy
1391opaque.
1392
1393You probably need to specify B<"-depth 32">, too, and have the luck that
1394your X-server uses ARGB pixel layout, as X is far from just supporting
1395ARGB visuals out of the box, and rxvt-unicode just fudges around.
1396
1397For example, the following selects an almost completely transparent red
1398background, and an almost opaque pink foreground:
1399
1400 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1401
1402I<Please note that transparency of any kind if completely unsupported by
1403the author. Don't bug him with installation questions!>
1404
1369=head1 ENVIRONMENT 1405=head1 ENVIRONMENT
1370 1406
1371B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1407B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1372 1408
1373=over 4 1409=over 4
1374 1410
1375=item B<TERM> 1411=item B<TERM>
1376 1412
1377Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1413Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1378resources or on the commandline. 1414resources or on the command line.
1379 1415
1380=item B<COLORTERM> 1416=item B<COLORTERM>
1381 1417
1382Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1418Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1383compiled with XPM support, and optionally with the added extension 1419compiled with XPM support, and optionally with the added extension
1384C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1420C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1385 1421
1386=item B<COLORFGBG> 1422=item B<COLORFGBG>
1387 1423
… …
1405C<--with-terminfo=PATH>. 1441C<--with-terminfo=PATH>.
1406 1442
1407=item B<DISPLAY> 1443=item B<DISPLAY>
1408 1444
1409Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1445Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1410display in it's child processes. 1446display in its child processes.
1411 1447
1412=item B<SHELL> 1448=item B<SHELL>
1413 1449
1414The shell to be used for command execution, defaults to C</bin/sh>. 1450The shell to be used for command execution, defaults to C</bin/sh>.
1415 1451
… …
1457 1493
1458=item Project Coordinator 1494=item Project Coordinator
1459 1495
1460Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1496Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1461 1497
1462L<http://software.schmorp.de/#rxvt-unicode> 1498L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1463 1499
1464=back 1500=back
1465 1501
1466=head1 AUTHORS 1502=head1 AUTHORS
1467 1503

Diff Legend

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