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.96 by root, Fri Jan 13 12:40:46 2006 UTC vs.
Revision 1.131 by ayin, Sat Jun 9 09:05:38 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
131used to brighten or darken the image in addition to tinting it; resource 140used to brighten or darken the image in addition to tinting it; resource
132I<tintColor>. Example: 141I<tintColor>. Example:
133 142
134 @@RXVT_NAME@@ -tr -tint blue -sh 40 143 @@RXVT_NAME@@ -tr -tint blue -sh 40
135 144
136=item B<-sh> 145=item B<-sh> I<number>
137 146
138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 147Darken (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 (or instead of) tinting it;
140specified, too, e.g. C<-tint white>). 149resource I<shading>.
150
151=item B<-blt> I<string>
152
153Specify background blending type. If background pixmap is specified
154at the same time as transparency - such pixmap will be blended over
155transparency image, using method specified. Supported values are :
156B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
157B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
158B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
159alpha-blending; resource I<blendType>.
160
161=item B<-blr> I<number>
162
163Apply Gaussian Blur with the specified radius to the transparent
164background image; resource I<blurRadius>.
141 165
142=item B<-bg> I<colour> 166=item B<-bg> I<colour>
143 167
144Window background colour; resource B<background>. 168Window background colour; resource B<background>.
145 169
147 171
148Window foreground colour; resource B<foreground>. 172Window foreground colour; resource B<foreground>.
149 173
150=item B<-pixmap> I<file[;geom]> 174=item B<-pixmap> I<file[;geom]>
151 175
152Compile I<XPM>: Specify XPM file for the background and also optionally 176Compile I<afterimage>: Specify image file for the background and also
153specify its scaling with a geometry string. Note you may need to 177optionally specify its scaling with a geometry string. Note you may need to
154add quotes to avoid special shell interpretation of the C<;> in the 178add quotes to avoid special shell interpretation of the C<;> in the
155command-line; resource B<backgroundPixmap>. 179command-line; for more details see resource B<backgroundPixmap>.
156 180
157=item B<-cr> I<colour> 181=item B<-cr> I<colour>
158 182
159The cursor colour; resource B<cursorColor>. 183The cursor colour; resource B<cursorColor>.
160 184
177that are checked in order when trying to find glyphs for characters. The 201that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 202first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 203smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 204font list is always appended to it. See resource B<font> for more details.
181 205
182In short, to specify an X11 core font, just specify it's name or prefix it 206In 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:>, 207with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.: 208e.g.:
185 209
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 210 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 211 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
296=item B<-bl> 320=item B<-bl>
297 321
298Compile I<frills>: Set MWM hints to request a borderless window, i.e. 322Compile 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 323if honoured by the WM, the rxvt-unicode window will not have window
300decorations; resource B<borderLess>. 324decorations; resource B<borderLess>.
325
326=item B<-override-redirect>
327
328Compile I<frills>: Sets override-redirect on the window; resource
329B<override-redirect>.
301 330
302=item B<-sbg> 331=item B<-sbg>
303 332
304Compile I<frills>: Disable the usage of the built-in block graphics/line 333Compile I<frills>: Disable the usage of the built-in block graphics/line
305drawing characters and just rely on what the specified fonts provide. Use 334drawing characters and just rely on what the specified fonts provide. Use
372for more info. 401for more info.
373 402
374=item B<-tcw> 403=item B<-tcw>
375 404
376Change the meaning of triple-click selection with the left mouse 405Change the meaning of triple-click selection with the left mouse
406button. Only effective when the original (non-perl) selection code is
377button. Instead of selecting a full line it will extend the selection the 407in-use. Instead of selecting a full line it will extend the selection the
378end of the logical line only. resource B<tripleclickwords>. 408end of the logical line only. resource B<tripleclickwords>.
379 409
380=item B<-insecure> 410=item B<-insecure>
381 411
382Enable "insecure" mode, which currently enables most of the escape 412Enable "insecure" mode, which currently enables most of the escape
410 440
411Remap a key symbol. See resource B<keysym>. 441Remap a key symbol. See resource B<keysym>.
412 442
413=item B<-embed> I<windowid> 443=item B<-embed> I<windowid>
414 444
415Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 445Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
416which enables applications to easily embed a terminal. 446which enables applications to easily embed a terminal.
417 447
418Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 448Right 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 449shouldn'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 450quite 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. 453The window will not be destroyed when @@RXVT_NAME@@ exits.
424 454
425It might be useful to know that @@RXVT_NAME@@ will not close file 455It 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 456descriptors passed to it (except for stdin/out/err, of course), so you
427can use file descriptors to communicate with the programs within the 457can use file descriptors to communicate with the programs within the
428terminal. This works regardless of wether the C<-embed> option was used or 458terminal. This works regardless of whether the C<-embed> option was used or
429not. 459not.
430 460
431Here is a short Gtk2-perl snippet that illustrates how this option can be 461Here is a short Gtk2-perl snippet that illustrates how this option can be
432used (a longer example is in F<doc/embed>): 462used (a longer example is in F<doc/embed>):
433 463
438 }); 468 });
439 469
440=item B<-pty-fd> I<file descriptor> 470=item B<-pty-fd> I<file descriptor>
441 471
442Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 472Tells @@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 473pair 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 474useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445without having to run a program within it. 475without having to run a program within it.
446 476
447If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 477If 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 478entries 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 530check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
501extensions not documented here): 531extensions not documented here):
502 532
503=over 4 533=over 4
504 534
535=item B<depth:> I<bitdepth>
536
537Compile I<xft>: Attempt to find a visual with the given bit depth;
538option B<-depth>.
539
505=item B<geometry:> I<geom> 540=item B<geometry:> I<geom>
506 541
507Create the window with the specified X window geometry [default 80x24]; 542Create the window with the specified X window geometry [default 80x24];
508option B<-geometry>. 543option B<-geometry>.
509 544
545Use the specified colour to display underlined characters when the 580Use the specified colour to display underlined characters when the
546foreground colour is the default. 581foreground colour is the default.
547 582
548=item B<colorRV:> I<colour> 583=item B<colorRV:> I<colour>
549 584
550Use the specified colour as the background for reverse video 585Use the specified colour as the background for reverse video characters
551characters. 586when OPTION_HC is disabled (--disable-frills).
552 587
553=item B<underlineColor:> I<colour> 588=item B<underlineColor:> I<colour>
554 589
555If set, use the specified colour as the colour for the underline 590If set, use the specified colour as the colour for the underline
556itself. If unset, use the foreground colour. 591itself. If unset, use the foreground colour.
582 617
583B<True>: make the background inherit the parent windows' pixmap, giving 618B<True>: make the background inherit the parent windows' pixmap, giving
584artificial transparency. B<False>: do not inherit the parent windows' 619artificial transparency. B<False>: do not inherit the parent windows'
585pixmap. 620pixmap.
586 621
622I<Please note that transparency of any kind if completely unsupported by
623the author. Don't bug him with installation questions!>
624
587=item B<fading:> I<number> 625=item B<fading:> I<number>
588 626
589Fade the text by the given percentage when focus is lost; option B<-fade>. 627Fade the text by the given percentage when focus is lost; option B<-fade>.
590 628
591=item B<fadeColor:> I<colour> 629=item B<fadeColor:> I<colour>
598Tint the transparent background pixmap with the given colour; option 636Tint the transparent background pixmap with the given colour; option
599B<-tint>. 637B<-tint>.
600 638
601=item B<shading:> I<number> 639=item B<shading:> I<number>
602 640
603Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 641Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
604image in addition to tinting it. 642in addition to tinting it; option B<-sh>.
643
644=item B<blendType:> I<string>
645
646Specify background blending type; option B<-blt>.
647
648=item B<blurRadius:> I<number>
649
650Apply Gaussian Blurr with the specified radius to the transparent
651background image; option B<-blr>.
605 652
606=item B<scrollColor:> I<colour> 653=item B<scrollColor:> I<colour>
607 654
608Use the specified colour for the scrollbar [default #B2B2B2]. 655Use the specified colour for the scrollbar [default #B2B2B2].
609 656
617The colour of the border around the text area and between the scrollbar 664The colour of the border around the text area and between the scrollbar
618and the text. 665and the text.
619 666
620=item B<backgroundPixmap:> I<file[;geom]> 667=item B<backgroundPixmap:> I<file[;geom]>
621 668
622Use the specified XPM file (note the `.xpm' extension is optional) for 669Use the specified image file for the background and also optionally
623the background and also optionally specify its scaling with a geometry 670specify its scaling with a geometry string B<WxH+X+Y>,
624string B<WxH+X+Y>, in which B<"W" / "H"> specify the 671in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
625horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 672and B<"X" / "Y"> locate the image centre (percent).
626centre (percent). A scale of 0 displays the image with tiling. A scale 673A scale of 0 displays the image with tiling. A scale of 1 displays the
627of 1 displays the image without any scaling. A scale of 2 to 9 674image without any scaling. A scale of 2 to 9 specifies an integer
628specifies an integer number of images in that direction. No image will 675number of images in that direction. No image will be magnified beyond
629be magnified beyond 10 times its original size. The maximum permitted 67610 times its original size. The maximum permitted scale is 1000.
630scale is 1000. [default 0x0+50+50] 677Special string of B<"auto"> used as a geometry will cause image to be
631 678automatically scaled to match window size.
632=item B<menu:> I<file[;tag]> 679If used in conjunction with B<-tr> option - specified pixmap will be
633 680blended over transparency image using either alpha-blending, or any
634Read in the specified menu file (note the `.menu' extension is 681other blending type, specified with B<-blt "type"> option.
635optional) and also optionally specify a starting tag to find. See the 682[default 0x0+50+50]
636reference documentation for details on the syntax for the menuBar.
637 683
638=item B<path:> I<path> 684=item B<path:> I<path>
639 685
640Specify the colon-delimited search path for finding files (XPM and 686Specify 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 687
644=item B<font:> I<fontlist> 688=item B<font:> I<fontlist>
645 689
646Select the fonts to be used. This is a comma separated list of font names 690Select the fonts to be used. This is a comma separated list of font names
647that are checked in order when trying to find glyphs for characters. The 691that are checked in order when trying to find glyphs for characters. The
657hint currently is C<codeset=codeset-name>, and this is only used for Xft 701hint currently is C<codeset=codeset-name>, and this is only used for Xft
658fonts. 702fonts.
659 703
660For example, this font resource 704For example, this font resource
661 705
662 URxvt*font: 9x15bold,\ 706 URxvt.font: 9x15bold,\
663 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 707 -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, \ 708 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
665 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 709 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
666 xft:Code2000:antialias=false 710 xft:Code2000:antialias=false
667 711
705 749
706=item B<intensityStyles:> I<boolean> 750=item B<intensityStyles:> I<boolean>
707 751
708When font styles are not enabled, or this option is enabled (B<True>, 752When font styles are not enabled, or this option is enabled (B<True>,
709option B<-is>, the default), bold and italic font styles imply high 753option B<-is>, the default), bold and italic font styles imply high
710intensity foreground/backround colours. Disabling this option (B<False>, 754intensity foreground/background colours. Disabling this option (B<False>,
711option B<+is>) disables this behaviour, the high intensity colours are not 755option B<+is>) disables this behaviour, the high intensity colours are not
712reachable. 756reachable.
713 757
714=item B<selectstyle:> I<mode> 758=item B<selectstyle:> I<mode>
715 759
716Set mouse selection style to B<old> which is 2.20, B<oldword> which is 760Set 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 761is xterm style with 2.20 old word selection, or anything else which
718xterm style selection. 762gives xterm style selection. Only effective when the original (non-perl)
763selection code is in use.
719 764
720=item B<scrollstyle:> I<mode> 765=item B<scrollstyle:> I<mode>
721 766
722Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 767Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
723the author's favourite. 768the author's favourite.
737=item B<mapAlert:> I<boolean> 782=item B<mapAlert:> I<boolean>
738 783
739B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 784B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
740de-iconify (map) on receipt of a bell character [default]. 785de-iconify (map) on receipt of a bell character [default].
741 786
787=item B<urgentOnBell:> I<boolean>
788
789B<True>: set the urgency hint for the wm on receipt of a bell character.
790B<False>: do not set the urgency hint [default].
791
742=item B<visualBell:> I<boolean> 792=item B<visualBell:> I<boolean>
743 793
744B<True>: use visual bell on receipt of a bell character; option B<-vb>. 794B<True>: use visual bell on receipt of a bell character; option B<-vb>.
745B<False>: no visual bell [default]; option B<+vb>. 795B<False>: no visual bell [default]; option B<+vb>.
746 796
764 814
765The string will be interpreted as if typed into the shell as-is. 815The string will be interpreted as if typed into the shell as-is.
766 816
767Example: 817Example:
768 818
769 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 819 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
770 820
771This creates a new file in your home directory with the screen contents 821This creates a new file in your home directory with the screen contents
772everytime you hit C<Print>. 822every time you hit C<Print>.
773 823
774=item B<scrollBar:> I<boolean> 824=item B<scrollBar:> I<boolean>
775 825
776B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 826B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
777disable the scrollbar; option B<+sb>. 827disable the scrollbar; option B<+sb>.
799 849
800=item B<scrollWithBuffer:> I<boolean> 850=item B<scrollWithBuffer:> I<boolean>
801 851
802B<True>: scroll with scrollback buffer when tty receives new lines (and 852B<True>: scroll with scrollback buffer when tty receives new lines (and
803B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 853B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
804with scrollback buffer when tty recieves new lines; option B<+sw>. 854with scrollback buffer when tty receives new lines; option B<+sw>.
805 855
806=item B<scrollTtyKeypress:> I<boolean> 856=item B<scrollTtyKeypress:> I<boolean>
807 857
808B<True>: scroll to bottom when a non-special key is pressed. Special keys 858B<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 859are those which are intercepted by rxvt-unicode for special handling and
899pressed. If unset it will send the sequence traditionally associated 949pressed. If unset it will send the sequence traditionally associated
900with the B<Execute> key. 950with the B<Execute> key.
901 951
902=item B<cutchars:> I<string> 952=item B<cutchars:> I<string>
903 953
904The characters used as delimiters for double-click word selection. The 954The characters used as delimiters for double-click word selection
905built-in default: 955(whitespace delimiting is added automatically if resource is given).
956
957When the perl selection extension is in use (the default if compiled
958in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
959characters will be created (if the resource exists, otherwise, no regex
960will be created). In this mode, characters outside ISO-8859-1 can be used.
961
962When the selection extension is not used, only ISO-8859-1 characters can
963be used. If not specified, the built-in default is used:
906 964
907B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 965B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
908 966
909=item B<preeditType:> I<style> 967=item B<preeditType:> I<style>
910 968
946default. (Note that many other terminals, including xterm, have these 1004default. (Note that many other terminals, including xterm, have these
947sequences enabled by default, which doesn't make it safer, though). 1005sequences enabled by default, which doesn't make it safer, though).
948 1006
949You can enable them by setting this boolean resource or specifying 1007You can enable them by setting this boolean resource or specifying
950B<-insecure> as an option. At the moment, this enables display-answer, 1008B<-insecure> as an option. At the moment, this enables display-answer,
951locale, findfont, icon label and window title requests as well as dynamic 1009locale, findfont, icon label and window title requests.
952menubar dispatch.
953 1010
954=item B<modifier:> I<modifier> 1011=item B<modifier:> I<modifier>
955 1012
956Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 1013Set 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 1014B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
961 1018
962Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1019Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
963character is passed through. It may contain escape values as described 1020character is passed through. It may contain escape values as described
964in the entry on B<keysym> following. 1021in the entry on B<keysym> following.
965 1022
966=item B<secondaryScreen:> I<bool> 1023=item B<secondaryScreen:> I<boolean>
967 1024
968Turn on/off secondary screen (default enabled). 1025Turn on/off secondary screen (default enabled).
969 1026
970=item B<secondaryScroll:> I<bool> 1027=item B<secondaryScroll:> I<boolean>
971 1028
972Turn on/off secondary screen scroll (default enabled). If the this 1029Turn on/off secondary screen scroll (default enabled). If this
973option is enabled, scrolls on the secondary screen will change the 1030option is enabled, scrolls on the secondary screen will change the
974scrollback buffer and switching to/from the secondary screen will 1031scrollback buffer and switching to/from the secondary screen will
975instead scroll the screen up. 1032instead scroll the screen up.
976 1033
977=item B<hold>: I<bool> 1034=item B<hold>: I<boolean>
978 1035
979Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1036Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
980will not immediately destroy its window when the program executed within 1037will 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 1038it exits. Instead, it will wait till it is being killed or closed by the
982user. 1039user.
1005 1062
1006I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1063I<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, 1064C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
1008C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1065C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1009C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1066C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1010can start or end with whitespace. 1067can start or end with whitespace. B<This feature is deprecated and will
1068be removed>.
1011 1069
1012Please note that you need to double the C<\> in resource files, as 1070Please 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 1071Xlib 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 1072C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1015processing). 1073processing).
1016 1074
1017You can define a range of keysyms in one shot by providing a I<string> 1075You can define a range of keysyms in one shot by providing a I<string>
1018with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1076with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1019should be a character not used by the strings. 1077should be a character not used by the strings.
1020 1078
1021Its usage can be demonstrated by an example: 1079Its usage can be demonstrated by an example:
1022 1080
1023 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1081 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1087example, C<default,-selection> will use all the default extension except 1145example, C<default,-selection> will use all the default extension except
1088C<selection>. 1146C<selection>.
1089 1147
1090Extension names can also be followed by an argument in angle brackets 1148Extension names can also be followed by an argument in angle brackets
1091(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1149(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1092searchable scorllback to Alt/Meta-s). Mentioning the same extension 1150searchable scrollback to Alt/Meta-s). Mentioning the same extension
1093multiple times with different arguments will pass multiple arguments to 1151multiple times with different arguments will pass multiple arguments to
1094the extension. 1152the extension.
1095 1153
1096Each extension is looked up in the library directories, loaded if 1154Each extension is looked up in the library directories, loaded if
1097necessary, and bound to the current terminal instance. 1155necessary, and bound to the current terminal instance.
1133(default: C<M-s>). 1191(default: C<M-s>).
1134 1192
1135=item B<urlLauncher>: I<string> 1193=item B<urlLauncher>: I<string>
1136 1194
1137Specifies the program to be started with a URL argument. Used by the 1195Specifies the program to be started with a URL argument. Used by the
1138C<selection-popup> and C<mark-urls> perl extensions. 1196C<selection-popup> and C<matcher> perl extensions.
1139 1197
1140=item B<transient-for>: I<windowid> 1198=item B<transient-for>: I<windowid>
1141 1199
1142Sets the WM_TRANSIENT_FOR property to the given window iw. 1200Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1201
1202=item B<override-redirect>: I<boolean>
1203
1204Compile I<frills>: Sets override-redirect for the terminal window, making
1205it almost invisible to window managers; option B<-override-redirect>.
1206
1207=item B<iso14755_52:> I<boolean>
1208
1209Turn on/off ISO 14755 5.2 mode (default enabled).
1143 1210
1144=back 1211=back
1145 1212
1146=head1 THE SCROLLBAR 1213=head1 THE SCROLLBAR
1147 1214
1166application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1233application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1167(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1234(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1168up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1235up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1169respectively. 1236respectively.
1170 1237
1171=head1 TEXT SELECTION AND INSERTION 1238=head1 THE SELECTION: SELECTING AND PASTING TEXT
1172 1239
1173The behaviour of text selection and insertion mechanism is similar to 1240The behaviour of text selection and insertion/pasting mechanism is similar
1174I<xterm>(1). 1241to I<xterm>(1).
1175 1242
1176=over 4 1243=over 4
1177 1244
1178=item B<Selection>: 1245=item B<Selecting>:
1179 1246
1180Left click at the beginning of the region, drag to the end of the region 1247Left click at the beginning of the region, drag to the end of the region
1181and release; Right click to extend the marked region; Left double-click 1248and release; Right click to extend the marked region; Left double-click
1182to select a word; Left triple-click to select the entire logical line 1249to select a word; Left triple-click to select the entire logical line
1183(which can span multiple screen lines), unless modified by resource 1250(which can span multiple screen lines), unless modified by resource
1187(Compile: I<frills>) will create a rectangular selection instead of a 1254(Compile: I<frills>) will create a rectangular selection instead of a
1188normal one. In this mode, every selected row becomes its own line in the 1255normal one. In this mode, every selected row becomes its own line in the
1189selection, and trailing whitespace is visually underlined and removed from 1256selection, and trailing whitespace is visually underlined and removed from
1190the selection. 1257the selection.
1191 1258
1192=item B<Insertion>: 1259=item B<Pasting>:
1193 1260
1194Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1261Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1195an B<@@RXVT_NAME@@> window causes the current text selection to be 1262window causes the value of the PRIMARY selection (or CLIPBOARD with the
1196inserted as if it had been typed on the keyboard. 1263B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1264
1265Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1266inserted too.
1197 1267
1198=back 1268=back
1199 1269
1200=head1 CHANGING FONTS 1270=head1 CHANGING FONTS
1201 1271
1202Changing fonts (or font sizes, respectively) via the keypad is not yet 1272Changing fonts (or font sizes, respectively) via the keypad is not yet
1203supported in rxvt-unicode. Bug me if you need this. 1273supported in rxvt-unicode. Bug me if you need this.
1204 1274
1205You can, however, switch fonts at runtime using escape sequences (and 1275You can, however, switch fonts at runtime using escape sequences, e.g.:
1206therefore using the menubar), e.g.:
1207 1276
1208 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1277 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1278
1279You can use keyboard shortcuts, too:
1280
1281 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1282 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1209 1283
1210rxvt-unicode will automatically re-apply these fonts to the output so far. 1284rxvt-unicode will automatically re-apply these fonts to the output so far.
1211 1285
1212=head1 ISO 14755 SUPPORT 1286=head1 ISO 14755 SUPPORT
1213 1287
1241This mode lets you input characters representing the keycap symbols of 1315This mode lets you input characters representing the keycap symbols of
1242your keyboard, if representable in the current locale encoding. 1316your keyboard, if representable in the current locale encoding.
1243 1317
1244Start by pressing C<Control> and C<Shift> together, then releasing 1318Start by pressing C<Control> and C<Shift> together, then releasing
1245them. The next special key (cursor keys, home etc.) you enter will not 1319them. The next special key (cursor keys, home etc.) you enter will not
1246invoke it's usual function but instead will insert the corresponding 1320invoke its usual function but instead will insert the corresponding
1247keycap symbol. The symbol will only be entered when the key has been 1321keycap symbol. The symbol will only be entered when the key has been
1248released, otherwise pressing e.g. C<Shift> would enter the symbol for 1322released, otherwise pressing e.g. C<Shift> would enter the symbol for
1249C<ISO Level 2 Switch>, although your intention might have been to enter a 1323C<ISO Level 2 Switch>, although your intention might have been to enter a
1250reverse tab (Shift-Tab). 1324reverse tab (Shift-Tab).
1251 1325
1284=head1 COLORS AND GRAPHICS 1358=head1 COLORS AND GRAPHICS
1285 1359
1286In addition to the default foreground and background colours, 1360In addition to the default foreground and background colours,
1287B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1361B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1288high-intensity bold/blink versions of the same). Here is a list of the 1362high-intensity bold/blink versions of the same). Here is a list of the
1289colours with their B<rgb.txt> names. 1363colours with their names.
1290 1364
1291=begin table 1365=begin table
1292 1366
1293 B<color0> (black) = Black 1367 B<color0> (black) = Black
1294 B<color1> (red) = Red3 1368 B<color1> (red) = Red3
1314It is also possible to specify the colour values of B<foreground>, 1388It is also possible to specify the colour values of B<foreground>,
1315B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1389B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1316a number 0-15, as a convenient shorthand to reference the colour name of 1390a number 0-15, as a convenient shorthand to reference the colour name of
1317color0-color15. 1391color0-color15.
1318 1392
1393In addition to the colours defined above, @@RXVT_NAME@@ offers an
1394additional 72 colours. The first 64 of those (with indices 16 to 79)
1395consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
139616>), followed by 8 additional shades of gray (with indices 80 to 87).
1397
1398Together, all those colours implement the 88 colour xterm colours. Only
1399the first 16 can be changed using resources currently, the rest can only
1400be changed via command sequences ("escape codes").
1401
1319Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1402Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1320always swapping the foreground/background colours. This is in contrast to 1403always swapping the foreground/background colours. This is in contrast to
1321I<xterm>(1) where the colours are only swapped if they have not otherwise 1404I<xterm>(1) where the colours are only swapped if they have not otherwise
1322been specified. For example, 1405been specified. For example,
1323 1406
1328would yield White on Black, while on I<xterm>(1) it would yield Black 1411would yield White on Black, while on I<xterm>(1) it would yield Black
1329on White. 1412on White.
1330 1413
1331=back 1414=back
1332 1415
1416=head2 ALPHA CHANNEL SUPPORT
1417
1418If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1419their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1420(recommended, but B<MUST> have 4 digits/component) colour specifications,
1421in addition to the ones provided by X, where the additional A component
1422specifies opacity (alpha) values. The minimum value of C<0> is completely
1423transparent). You can also prefix any color with C<[percent]>, where
1424C<percent> is a decimal percentage (0-100) that specifies the opacity of
1425the color, where C<0> is completely transparent and C<100> is completelxy
1426opaque.
1427
1428You probably need to specify B<"-depth 32">, too, and have the luck that
1429your X-server uses ARGB pixel layout, as X is far from just supporting
1430ARGB visuals out of the box, and rxvt-unicode just fudges around.
1431
1432For example, the following selects an almost completely transparent red
1433background, and an almost opaque pink foreground:
1434
1435 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1436
1437I<Please note that transparency of any kind if completely unsupported by
1438the author. Don't bug him with installation questions!>
1439
1333=head1 ENVIRONMENT 1440=head1 ENVIRONMENT
1334 1441
1335B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1442B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1336 1443
1337=over 4 1444=over 4
1338 1445
1339=item B<TERM> 1446=item B<TERM>
1340 1447
1341Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1448Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1342resources or on the commandline. 1449resources or on the command line.
1343 1450
1344=item B<COLORTERM> 1451=item B<COLORTERM>
1345 1452
1346Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1453Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1347compiled with XPM support, and optionally with the added extension 1454compiled with XPM support, and optionally with the added extension
1348C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1455C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1349 1456
1350=item B<COLORFGBG> 1457=item B<COLORFGBG>
1351 1458
1369C<--with-terminfo=PATH>. 1476C<--with-terminfo=PATH>.
1370 1477
1371=item B<DISPLAY> 1478=item B<DISPLAY>
1372 1479
1373Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1480Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1374display in it's child processes. 1481display in its child processes.
1375 1482
1376=item B<SHELL> 1483=item B<SHELL>
1377 1484
1378The shell to be used for command execution, defaults to C</bin/sh>. 1485The shell to be used for command execution, defaults to C</bin/sh>.
1379
1380=item B<RXVTPATH>
1381
1382The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1383files.
1384
1385=item B<PATH>
1386
1387Used in the same way as C<RXVTPATH>.
1388 1486
1389=item B<RXVT_SOCKET> 1487=item B<RXVT_SOCKET>
1390 1488
1391The unix domain socket path used by @@RXVT_NAME@@c(1) and 1489The unix domain socket path used by @@RXVT_NAME@@c(1) and
1392@@RXVT_NAME@@d(1). 1490@@RXVT_NAME@@d(1).
1430 1528
1431=item Project Coordinator 1529=item Project Coordinator
1432 1530
1433Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1531Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1434 1532
1435L<http://software.schmorp.de/#rxvt-unicode> 1533L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1436 1534
1437=back 1535=back
1438 1536
1439=head1 AUTHORS 1537=head1 AUTHORS
1440 1538
1462 1560
1463Project Coordinator (changes.txt 2.21a to 2.4.5) 1561Project Coordinator (changes.txt 2.21a to 2.4.5)
1464 1562
1465=item Geoff Wing L<< <gcw@pobox.com> >> 1563=item Geoff Wing L<< <gcw@pobox.com> >>
1466 1564
1467Rewrote screen display and text selection routines. Project Coordinator 1565Rewrote screen display and text selection routines.
1566
1468(changes.txt 2.4.6 - rxvt-unicode) 1567Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1469 1568
1470=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1569=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1471 1570
1472Forked rxvt-unicode, rewrote most of the display code and internal 1571Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1473character handling to store text in unicode, improve xterm 1572extension, random hacks, numerous bugfixes and extensions.
1474compatibility and apply numerous other bugfixes and extensions.
1475 1573
1476Project Coordinator (Changes 1.0 -) 1574Project Coordinator (Changes 1.0 -)
1477 1575
1576=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1577
1578Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1579
1478=back 1580=back
1479 1581

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines