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.129 by root, Mon May 28 20:34:56 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
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! Read the FAQ (man 7
122@@RXVT_NAME@@)!>
114 123
115=item B<-fade> I<number> 124=item B<-fade> I<number>
116 125
117Fade 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
118fade a little only, 100 completely replaces all colours by the fade 127fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>. 128colour; resource B<fading>.
120 129
121=item B<-fadecolor> I<colour> 130=item B<-fadecolor> I<colour>
122 131
123Fade 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
124is black. resource B<fadeColor>. 133is opaque black. resource B<fadeColor>.
125 134
126=item B<-tint> I<colour> 135=item B<-tint> I<colour>
127 136
128Tint the transparent background pixmap with the given colour when 137Tint the transparent background pixmap with the given colour when
129transparency 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
135 144
136=item B<-sh> 145=item B<-sh>
137 146
138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 147I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
139background 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
140specified, too, e.g. C<-tint white>). 149specified, too, e.g. C<-tint white>); resource I<shading>.
141 150
142=item B<-bg> I<colour> 151=item B<-bg> I<colour>
143 152
144Window background colour; resource B<background>. 153Window background colour; resource B<background>.
145 154
172resource B<borderColor>. 181resource B<borderColor>.
173 182
174=item B<-fn> I<fontlist> 183=item B<-fn> I<fontlist>
175 184
176Select the fonts to be used. This is a comma separated list of font names 185Select 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 186that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 187first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 188smaller, but not (in general) larger. A (hopefully) reasonable default
180font 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.
181 190
182In 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
183with 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:>,
184e.g.: 193e.g.:
185 194
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 195 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 196 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
296=item B<-bl> 305=item B<-bl>
297 306
298Compile I<frills>: Set MWM hints to request a borderless window, i.e. 307Compile 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 308if honoured by the WM, the rxvt-unicode window will not have window
300decorations; resource B<borderLess>. 309decorations; resource B<borderLess>.
310
311=item B<-override-redirect>
312
313Compile I<frills>: Sets override-redirect on the window; resource
314B<override-redirect>.
301 315
302=item B<-sbg> 316=item B<-sbg>
303 317
304Compile I<frills>: Disable the usage of the built-in block graphics/line 318Compile I<frills>: Disable the usage of the built-in block graphics/line
305drawing characters and just rely on what the specified fonts provide. Use 319drawing characters and just rely on what the specified fonts provide. Use
372for more info. 386for more info.
373 387
374=item B<-tcw> 388=item B<-tcw>
375 389
376Change the meaning of triple-click selection with the left mouse 390Change the meaning of triple-click selection with the left mouse
391button. Only effective when the original (non-perl) selection code is
377button. Instead of selecting a full line it will extend the selection the 392in-use. Instead of selecting a full line it will extend the selection the
378end of the logical line only. resource B<tripleclickwords>. 393end of the logical line only. resource B<tripleclickwords>.
379 394
380=item B<-insecure> 395=item B<-insecure>
381 396
382Enable "insecure" mode, which currently enables most of the escape 397Enable "insecure" mode, which currently enables most of the escape
410 425
411Remap a key symbol. See resource B<keysym>. 426Remap a key symbol. See resource B<keysym>.
412 427
413=item B<-embed> I<windowid> 428=item B<-embed> I<windowid>
414 429
415Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 430Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
416which enables applications to easily embed a terminal. 431which enables applications to easily embed a terminal.
417 432
418Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 433Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
419shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 434shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
420quite a bit, so don't expect it to keep some specific state. It's best to 435quite a bit, so don't expect it to keep some specific state. It's best to
423The window will not be destroyed when @@RXVT_NAME@@ exits. 438The window will not be destroyed when @@RXVT_NAME@@ exits.
424 439
425It might be useful to know that @@RXVT_NAME@@ will not close file 440It might be useful to know that @@RXVT_NAME@@ will not close file
426descriptors passed to it (except for stdin/out/err, of course), so you 441descriptors passed to it (except for stdin/out/err, of course), so you
427can use file descriptors to communicate with the programs within the 442can use file descriptors to communicate with the programs within the
428terminal. This works regardless of wether the C<-embed> option was used or 443terminal. This works regardless of whether the C<-embed> option was used or
429not. 444not.
430 445
431Here is a short Gtk2-perl snippet that illustrates how this option can be 446Here is a short Gtk2-perl snippet that illustrates how this option can be
432used (a longer example is in F<doc/embed>): 447used (a longer example is in F<doc/embed>):
433 448
438 }); 453 });
439 454
440=item B<-pty-fd> I<file descriptor> 455=item B<-pty-fd> I<file descriptor>
441 456
442Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 457Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
443pair but instead use the given filehandle as the tty master. This is 458pair but instead use the given file descriptor as the tty master. This is
444useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 459useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445without having to run a program within it. 460without having to run a program within it.
446 461
447If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 462If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
448entries and will not tinker with pty/tty permissions - you have to do that 463entries and will not tinker with pty/tty permissions - you have to do that
500check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 515check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
501extensions not documented here): 516extensions not documented here):
502 517
503=over 4 518=over 4
504 519
520=item B<depth:> I<bitdepth>
521
522Compile I<xft>: Attempt to find a visual with the given bit depth;
523option B<-depth>.
524
505=item B<geometry:> I<geom> 525=item B<geometry:> I<geom>
506 526
507Create the window with the specified X window geometry [default 80x24]; 527Create the window with the specified X window geometry [default 80x24];
508option B<-geometry>. 528option B<-geometry>.
509 529
545Use the specified colour to display underlined characters when the 565Use the specified colour to display underlined characters when the
546foreground colour is the default. 566foreground colour is the default.
547 567
548=item B<colorRV:> I<colour> 568=item B<colorRV:> I<colour>
549 569
550Use the specified colour as the background for reverse video 570Use the specified colour as the background for reverse video characters
551characters. 571when OPTION_HC is disabled (--disable-frills).
552 572
553=item B<underlineColor:> I<colour> 573=item B<underlineColor:> I<colour>
554 574
555If set, use the specified colour as the colour for the underline 575If set, use the specified colour as the colour for the underline
556itself. If unset, use the foreground colour. 576itself. If unset, use the foreground colour.
582 602
583B<True>: make the background inherit the parent windows' pixmap, giving 603B<True>: make the background inherit the parent windows' pixmap, giving
584artificial transparency. B<False>: do not inherit the parent windows' 604artificial transparency. B<False>: do not inherit the parent windows'
585pixmap. 605pixmap.
586 606
607I<Please note that transparency of any kind if completely unsupported by
608the author. Don't bug him with installation questions!>
609
587=item B<fading:> I<number> 610=item B<fading:> I<number>
588 611
589Fade the text by the given percentage when focus is lost; option B<-fade>. 612Fade the text by the given percentage when focus is lost; option B<-fade>.
590 613
591=item B<fadeColor:> I<colour> 614=item B<fadeColor:> I<colour>
598Tint the transparent background pixmap with the given colour; option 621Tint the transparent background pixmap with the given colour; option
599B<-tint>. 622B<-tint>.
600 623
601=item B<shading:> I<number> 624=item B<shading:> I<number>
602 625
603Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 626Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
604image in addition to tinting it. 627in addition to tinting it; option B<-sh>.
605 628
606=item B<scrollColor:> I<colour> 629=item B<scrollColor:> I<colour>
607 630
608Use the specified colour for the scrollbar [default #B2B2B2]. 631Use the specified colour for the scrollbar [default #B2B2B2].
609 632
627of 1 displays the image without any scaling. A scale of 2 to 9 650of 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 651specifies an integer number of images in that direction. No image will
629be magnified beyond 10 times its original size. The maximum permitted 652be magnified beyond 10 times its original size. The maximum permitted
630scale is 1000. [default 0x0+50+50] 653scale is 1000. [default 0x0+50+50]
631 654
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> 655=item B<path:> I<path>
639 656
640Specify the colon-delimited search path for finding files (XPM and 657Specify 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 658
644=item B<font:> I<fontlist> 659=item B<font:> I<fontlist>
645 660
646Select the fonts to be used. This is a comma separated list of font 661Select 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. 662that are checked in order when trying to find glyphs for characters. The
648The first font defines the cell size for characters; other fonts might 663first font defines the cell size for characters; other fonts might be
649be smaller, but not larger. A reasonable default font list is always 664smaller, but not (in general) larger. A (hopefully) reasonable default
650appended to it; option B<-fn>. 665font list is always appended to it; option B<-fn>.
651 666
652Each font can either be a standard X11 core font (XLFD) name, with 667Each 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:>. 668optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
654 669
655In addition, each font can be prefixed with additional hints and 670In addition, each font can be prefixed with additional hints and
657hint currently is C<codeset=codeset-name>, and this is only used for Xft 672hint currently is C<codeset=codeset-name>, and this is only used for Xft
658fonts. 673fonts.
659 674
660For example, this font resource 675For example, this font resource
661 676
662 URxvt*font: 9x15bold,\ 677 URxvt.font: 9x15bold,\
663 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 678 -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, \ 679 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
665 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 680 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
666 xft:Code2000:antialias=false 681 xft:Code2000:antialias=false
667 682
705 720
706=item B<intensityStyles:> I<boolean> 721=item B<intensityStyles:> I<boolean>
707 722
708When font styles are not enabled, or this option is enabled (B<True>, 723When font styles are not enabled, or this option is enabled (B<True>,
709option B<-is>, the default), bold and italic font styles imply high 724option B<-is>, the default), bold and italic font styles imply high
710intensity foreground/backround colours. Disabling this option (B<False>, 725intensity foreground/background colours. Disabling this option (B<False>,
711option B<+is>) disables this behaviour, the high intensity colours are not 726option B<+is>) disables this behaviour, the high intensity colours are not
712reachable. 727reachable.
713 728
714=item B<selectstyle:> I<mode> 729=item B<selectstyle:> I<mode>
715 730
716Set mouse selection style to B<old> which is 2.20, B<oldword> which is 731Set mouse selection style to B<old> which is 2.20, B<oldword> which
717xterm style with 2.20 old word selection, or anything else which gives 732is xterm style with 2.20 old word selection, or anything else which
718xterm style selection. 733gives xterm style selection. Only effective when the original (non-perl)
734selection code is in use.
719 735
720=item B<scrollstyle:> I<mode> 736=item B<scrollstyle:> I<mode>
721 737
722Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 738Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
723the author's favourite. 739the author's favourite.
737=item B<mapAlert:> I<boolean> 753=item B<mapAlert:> I<boolean>
738 754
739B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 755B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
740de-iconify (map) on receipt of a bell character [default]. 756de-iconify (map) on receipt of a bell character [default].
741 757
758=item B<urgentOnBell:> I<boolean>
759
760B<True>: set the urgency hint for the wm on receipt of a bell character.
761B<False>: do not set the urgency hint [default].
762
742=item B<visualBell:> I<boolean> 763=item B<visualBell:> I<boolean>
743 764
744B<True>: use visual bell on receipt of a bell character; option B<-vb>. 765B<True>: use visual bell on receipt of a bell character; option B<-vb>.
745B<False>: no visual bell [default]; option B<+vb>. 766B<False>: no visual bell [default]; option B<+vb>.
746 767
764 785
765The string will be interpreted as if typed into the shell as-is. 786The string will be interpreted as if typed into the shell as-is.
766 787
767Example: 788Example:
768 789
769 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 790 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
770 791
771This creates a new file in your home directory with the screen contents 792This creates a new file in your home directory with the screen contents
772everytime you hit C<Print>. 793every time you hit C<Print>.
773 794
774=item B<scrollBar:> I<boolean> 795=item B<scrollBar:> I<boolean>
775 796
776B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 797B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
777disable the scrollbar; option B<+sb>. 798disable the scrollbar; option B<+sb>.
799 820
800=item B<scrollWithBuffer:> I<boolean> 821=item B<scrollWithBuffer:> I<boolean>
801 822
802B<True>: scroll with scrollback buffer when tty receives new lines (and 823B<True>: scroll with scrollback buffer when tty receives new lines (and
803B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 824B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
804with scrollback buffer when tty recieves new lines; option B<+sw>. 825with scrollback buffer when tty receives new lines; option B<+sw>.
805 826
806=item B<scrollTtyKeypress:> I<boolean> 827=item B<scrollTtyKeypress:> I<boolean>
807 828
808B<True>: scroll to bottom when a non-special key is pressed. Special keys 829B<True>: scroll to bottom when a non-special key is pressed. Special keys
809are those which are intercepted by rxvt-unicode for special handling and 830are those which are intercepted by rxvt-unicode for special handling and
899pressed. If unset it will send the sequence traditionally associated 920pressed. If unset it will send the sequence traditionally associated
900with the B<Execute> key. 921with the B<Execute> key.
901 922
902=item B<cutchars:> I<string> 923=item B<cutchars:> I<string>
903 924
904The characters used as delimiters for double-click word selection. The 925The characters used as delimiters for double-click word selection
905built-in default: 926(whitespace delimiting is added automatically if resource is given).
927
928When the perl selection extension is in use (the default if compiled
929in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
930characters will be created (if the resource exists, otherwise, no regex
931will be created). In this mode, characters outside ISO-8859-1 can be used.
932
933When the selection extension is not used, only ISO-8859-1 characters can
934be used. If not specified, the built-in default is used:
906 935
907B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 936B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
908 937
909=item B<preeditType:> I<style> 938=item B<preeditType:> I<style>
910 939
946default. (Note that many other terminals, including xterm, have these 975default. (Note that many other terminals, including xterm, have these
947sequences enabled by default, which doesn't make it safer, though). 976sequences enabled by default, which doesn't make it safer, though).
948 977
949You can enable them by setting this boolean resource or specifying 978You can enable them by setting this boolean resource or specifying
950B<-insecure> as an option. At the moment, this enables display-answer, 979B<-insecure> as an option. At the moment, this enables display-answer,
951locale, findfont, icon label and window title requests as well as dynamic 980locale, findfont, icon label and window title requests.
952menubar dispatch.
953 981
954=item B<modifier:> I<modifier> 982=item B<modifier:> I<modifier>
955 983
956Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 984Set 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 985B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
961 989
962Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 990Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
963character is passed through. It may contain escape values as described 991character is passed through. It may contain escape values as described
964in the entry on B<keysym> following. 992in the entry on B<keysym> following.
965 993
966=item B<secondaryScreen:> I<bool> 994=item B<secondaryScreen:> I<boolean>
967 995
968Turn on/off secondary screen (default enabled). 996Turn on/off secondary screen (default enabled).
969 997
970=item B<secondaryScroll:> I<bool> 998=item B<secondaryScroll:> I<boolean>
971 999
972Turn on/off secondary screen scroll (default enabled). If the this 1000Turn on/off secondary screen scroll (default enabled). If this
973option is enabled, scrolls on the secondary screen will change the 1001option is enabled, scrolls on the secondary screen will change the
974scrollback buffer and switching to/from the secondary screen will 1002scrollback buffer and switching to/from the secondary screen will
975instead scroll the screen up. 1003instead scroll the screen up.
976 1004
977=item B<hold>: I<bool> 1005=item B<hold>: I<boolean>
978 1006
979Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1007Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
980will not immediately destroy its window when the program executed within 1008will 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 1009it exits. Instead, it will wait till it is being killed or closed by the
982user. 1010user.
1005 1033
1006I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1034I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
1007C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1035C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
1008C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1036C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1009C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1037C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1010can start or end with whitespace. 1038can start or end with whitespace. B<This feature is deprecated and will
1039be removed>.
1011 1040
1012Please note that you need to double the C<\> in resource files, as 1041Please note that you need to double the C<\> in resource files, as
1013Xlib itself does it's own de-escaping (you can use C<\033> instead of 1042Xlib itself does its own de-escaping (you can use C<\033> instead of
1014C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own 1043C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1015processing). 1044processing).
1016 1045
1017You can define a range of keysyms in one shot by providing a I<string> 1046You can define a range of keysyms in one shot by providing a I<string>
1018with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1047with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1019should be a character not used by the strings. 1048should be a character not used by the strings.
1020 1049
1021Its usage can be demonstrated by an example: 1050Its usage can be demonstrated by an example:
1022 1051
1023 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1052 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1087example, C<default,-selection> will use all the default extension except 1116example, C<default,-selection> will use all the default extension except
1088C<selection>. 1117C<selection>.
1089 1118
1090Extension names can also be followed by an argument in angle brackets 1119Extension names can also be followed by an argument in angle brackets
1091(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1120(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1092searchable scorllback to Alt/Meta-s). Mentioning the same extension 1121searchable scrollback to Alt/Meta-s). Mentioning the same extension
1093multiple times with different arguments will pass multiple arguments to 1122multiple times with different arguments will pass multiple arguments to
1094the extension. 1123the extension.
1095 1124
1096Each extension is looked up in the library directories, loaded if 1125Each extension is looked up in the library directories, loaded if
1097necessary, and bound to the current terminal instance. 1126necessary, and bound to the current terminal instance.
1115F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1144F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1116will be ignored when running setuid/setgid. 1145will be ignored when running setuid/setgid.
1117 1146
1118See the @@RXVT_NAME@@perl(3) manpage. 1147See the @@RXVT_NAME@@perl(3) manpage.
1119 1148
1149=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1150
1151Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1152details.
1153
1154=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1155
1156Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1157for details.
1158
1159=item B<searchable-scrollback:> I<keysym>
1160
1161Sets the hotkey that starts the incremental scrollback buffer search
1162(default: C<M-s>).
1163
1120=item B<urlLauncher>: I<string> 1164=item B<urlLauncher>: I<string>
1121 1165
1122Specifies the program to be started with a URL argument. Used by the 1166Specifies the program to be started with a URL argument. Used by the
1123C<selection-popup> and C<mark-urls> perl extensions. 1167C<selection-popup> and C<matcher> perl extensions.
1124 1168
1125=item B<transient-for>: I<windowid> 1169=item B<transient-for>: I<windowid>
1126 1170
1127Sets the WM_TRANSIENT_FOR property to the given window iw. 1171Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1172
1173=item B<override-redirect>: I<boolean>
1174
1175Compile I<frills>: Sets override-redirect for the terminal window, making
1176it almost invisible to window managers; option B<-override-redirect>.
1128 1177
1129=back 1178=back
1130 1179
1131=head1 THE SCROLLBAR 1180=head1 THE SCROLLBAR
1132 1181
1151application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1200application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1152(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1201(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1153up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1202up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1154respectively. 1203respectively.
1155 1204
1156=head1 TEXT SELECTION AND INSERTION 1205=head1 THE SELECTION: SELECTING AND PASTING TEXT
1157 1206
1158The behaviour of text selection and insertion mechanism is similar to 1207The behaviour of text selection and insertion/pasting mechanism is similar
1159I<xterm>(1). 1208to I<xterm>(1).
1160 1209
1161=over 4 1210=over 4
1162 1211
1163=item B<Selection>: 1212=item B<Selecting>:
1164 1213
1165Left click at the beginning of the region, drag to the end of the region 1214Left click at the beginning of the region, drag to the end of the region
1166and release; Right click to extend the marked region; Left double-click 1215and release; Right click to extend the marked region; Left double-click
1167to select a word; Left triple-click to select the entire logical line 1216to select a word; Left triple-click to select the entire logical line
1168(which can span multiple screen lines), unless modified by resource 1217(which can span multiple screen lines), unless modified by resource
1172(Compile: I<frills>) will create a rectangular selection instead of a 1221(Compile: I<frills>) will create a rectangular selection instead of a
1173normal one. In this mode, every selected row becomes its own line in the 1222normal one. In this mode, every selected row becomes its own line in the
1174selection, and trailing whitespace is visually underlined and removed from 1223selection, and trailing whitespace is visually underlined and removed from
1175the selection. 1224the selection.
1176 1225
1177=item B<Insertion>: 1226=item B<Pasting>:
1178 1227
1179Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1228Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1180an B<@@RXVT_NAME@@> window causes the current text selection to be 1229window causes the value of the PRIMARY selection (or CLIPBOARD with the
1181inserted as if it had been typed on the keyboard. 1230B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1231
1232Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1233inserted too.
1182 1234
1183=back 1235=back
1184 1236
1185=head1 CHANGING FONTS 1237=head1 CHANGING FONTS
1186 1238
1187Changing fonts (or font sizes, respectively) via the keypad is not yet 1239Changing fonts (or font sizes, respectively) via the keypad is not yet
1188supported in rxvt-unicode. Bug me if you need this. 1240supported in rxvt-unicode. Bug me if you need this.
1189 1241
1190You can, however, switch fonts at runtime using escape sequences (and 1242You can, however, switch fonts at runtime using escape sequences, e.g.:
1191therefore using the menubar), e.g.:
1192 1243
1193 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1244 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1245
1246You can use keyboard shortcuts, too:
1247
1248 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1249 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1194 1250
1195rxvt-unicode will automatically re-apply these fonts to the output so far. 1251rxvt-unicode will automatically re-apply these fonts to the output so far.
1196 1252
1197=head1 ISO 14755 SUPPORT 1253=head1 ISO 14755 SUPPORT
1198 1254
1226This mode lets you input characters representing the keycap symbols of 1282This mode lets you input characters representing the keycap symbols of
1227your keyboard, if representable in the current locale encoding. 1283your keyboard, if representable in the current locale encoding.
1228 1284
1229Start by pressing C<Control> and C<Shift> together, then releasing 1285Start by pressing C<Control> and C<Shift> together, then releasing
1230them. The next special key (cursor keys, home etc.) you enter will not 1286them. The next special key (cursor keys, home etc.) you enter will not
1231invoke it's usual function but instead will insert the corresponding 1287invoke its usual function but instead will insert the corresponding
1232keycap symbol. The symbol will only be entered when the key has been 1288keycap symbol. The symbol will only be entered when the key has been
1233released, otherwise pressing e.g. C<Shift> would enter the symbol for 1289released, otherwise pressing e.g. C<Shift> would enter the symbol for
1234C<ISO Level 2 Switch>, although your intention might have been to enter a 1290C<ISO Level 2 Switch>, although your intention might have been to enter a
1235reverse tab (Shift-Tab). 1291reverse tab (Shift-Tab).
1236 1292
1269=head1 COLORS AND GRAPHICS 1325=head1 COLORS AND GRAPHICS
1270 1326
1271In addition to the default foreground and background colours, 1327In addition to the default foreground and background colours,
1272B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1328B<@@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 1329high-intensity bold/blink versions of the same). Here is a list of the
1274colours with their B<rgb.txt> names. 1330colours with their names.
1275 1331
1276=begin table 1332=begin table
1277 1333
1278 B<color0> (black) = Black 1334 B<color0> (black) = Black
1279 B<color1> (red) = Red3 1335 B<color1> (red) = Red3
1299It is also possible to specify the colour values of B<foreground>, 1355It is also possible to specify the colour values of B<foreground>,
1300B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1356B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1301a number 0-15, as a convenient shorthand to reference the colour name of 1357a number 0-15, as a convenient shorthand to reference the colour name of
1302color0-color15. 1358color0-color15.
1303 1359
1360In addition to the colours defined above, @@RXVT_NAME@@ offers an
1361additional 72 colours. The first 64 of those (with indices 16 to 79)
1362consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
136316>), followed by 8 additional shades of gray (with indices 80 to 87).
1364
1365Together, all those colours implement the 88 colour xterm colours. Only
1366the first 16 can be changed using resources currently, the rest can only
1367be changed via command sequences ("escape codes").
1368
1304Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1369Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1305always swapping the foreground/background colours. This is in contrast to 1370always swapping the foreground/background colours. This is in contrast to
1306I<xterm>(1) where the colours are only swapped if they have not otherwise 1371I<xterm>(1) where the colours are only swapped if they have not otherwise
1307been specified. For example, 1372been specified. For example,
1308 1373
1313would yield White on Black, while on I<xterm>(1) it would yield Black 1378would yield White on Black, while on I<xterm>(1) it would yield Black
1314on White. 1379on White.
1315 1380
1316=back 1381=back
1317 1382
1383=head2 ALPHA CHANNEL SUPPORT
1384
1385If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1386their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1387(recommended, but B<MUST> have 4 digits/component) colour specifications,
1388in addition to the ones provided by X, where the additional A component
1389specifies opacity (alpha) values. The minimum value of C<0> is completely
1390transparent). You can also prefix any color with C<[percent]>, where
1391C<percent> is a decimal percentage (0-100) that specifies the opacity of
1392the color, where C<0> is completely transparent and C<100> is completelxy
1393opaque.
1394
1395You probably need to specify B<"-depth 32">, too, and have the luck that
1396your X-server uses ARGB pixel layout, as X is far from just supporting
1397ARGB visuals out of the box, and rxvt-unicode just fudges around.
1398
1399For example, the following selects an almost completely transparent red
1400background, and an almost opaque pink foreground:
1401
1402 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1403
1404I<Please note that transparency of any kind if completely unsupported by
1405the author. Don't bug him with installation questions!>
1406
1318=head1 ENVIRONMENT 1407=head1 ENVIRONMENT
1319 1408
1320B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1409B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1321 1410
1322=over 4 1411=over 4
1323 1412
1324=item B<TERM> 1413=item B<TERM>
1325 1414
1326Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1415Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1327resources or on the commandline. 1416resources or on the command line.
1328 1417
1329=item B<COLORTERM> 1418=item B<COLORTERM>
1330 1419
1331Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1420Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1332compiled with XPM support, and optionally with the added extension 1421compiled with XPM support, and optionally with the added extension
1333C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1422C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1334 1423
1335=item B<COLORFGBG> 1424=item B<COLORFGBG>
1336 1425
1354C<--with-terminfo=PATH>. 1443C<--with-terminfo=PATH>.
1355 1444
1356=item B<DISPLAY> 1445=item B<DISPLAY>
1357 1446
1358Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1447Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1359display in it's child processes. 1448display in its child processes.
1360 1449
1361=item B<SHELL> 1450=item B<SHELL>
1362 1451
1363The shell to be used for command execution, defaults to C</bin/sh>. 1452The shell to be used for command execution, defaults to C</bin/sh>.
1364
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 1453
1374=item B<RXVT_SOCKET> 1454=item B<RXVT_SOCKET>
1375 1455
1376The unix domain socket path used by @@RXVT_NAME@@c(1) and 1456The unix domain socket path used by @@RXVT_NAME@@c(1) and
1377@@RXVT_NAME@@d(1). 1457@@RXVT_NAME@@d(1).
1415 1495
1416=item Project Coordinator 1496=item Project Coordinator
1417 1497
1418Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1498Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1419 1499
1420L<http://software.schmorp.de/#rxvt-unicode> 1500L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1421 1501
1422=back 1502=back
1423 1503
1424=head1 AUTHORS 1504=head1 AUTHORS
1425 1505
1447 1527
1448Project Coordinator (changes.txt 2.21a to 2.4.5) 1528Project Coordinator (changes.txt 2.21a to 2.4.5)
1449 1529
1450=item Geoff Wing L<< <gcw@pobox.com> >> 1530=item Geoff Wing L<< <gcw@pobox.com> >>
1451 1531
1452Rewrote screen display and text selection routines. Project Coordinator 1532Rewrote screen display and text selection routines.
1533
1453(changes.txt 2.4.6 - rxvt-unicode) 1534Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1454 1535
1455=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1536=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1456 1537
1457Forked rxvt-unicode, rewrote most of the display code and internal 1538Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1458character handling to store text in unicode, improve xterm 1539extension, random hacks, numerous bugfixes and extensions.
1459compatibility and apply numerous other bugfixes and extensions.
1460 1540
1461Project Coordinator (Changes 1.0 -) 1541Project Coordinator (Changes 1.0 -)
1462 1542
1543=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1544
1545Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1546
1463=back 1547=back
1464 1548

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines