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.43 by root, Sun Jan 16 19:22:16 2005 UTC vs.
Revision 1.73 by root, Thu Dec 15 18:14:08 2005 UTC

14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16 16
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 frequently 19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20asked questions and answer to them and some common problems. 20frequently asked questions and answer to them and some common
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>.
21 23
22=head1 RXVT-UNICODE VS. RXVT 24=head1 RXVT-UNICODE VS. RXVT
23 25
24Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
25internally. That means it can store and display most scripts in the 27internally. That means it can store and display most scripts in the
103 105
104=item B<-j>|B<+j> 106=item B<-j>|B<+j>
105 107
106Turn on/off jump scrolling; resource B<jumpScroll>. 108Turn on/off jump scrolling; resource B<jumpScroll>.
107 109
108=item B<-ip>|B<+ip> 110=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
109 111
110Turn on/off inheriting parent window's pixmap. Alternative form is 112Turn on/off inheriting parent window's pixmap. Alternative form is
111B<-tr>; resource B<inheritPixmap>. 113B<-tr>; resource B<inheritPixmap>.
112 114
113=item B<-fade> I<number> 115=item B<-fade> I<number>
114 116
115Fade the text by the given percentage when focus is lost. resource B<fading>. 117Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>.
120
121=item B<-fadecolor> I<colour>
122
123Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>.
116 125
117=item B<-tint> I<colour> 126=item B<-tint> I<colour>
118 127
119Tint the transparent background pixmap with the given colour when 128Tint the transparent background pixmap with the given colour when
120transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> 129transparency is enabled with B<-tr> or B<-ip>. This only works for
121option that can be used to brighten or darken the image in addition to 130non-tiled backgrounds, currently. See also the B<-sh> option that can be
122tinting it. 131used to brighten or darken the image in addition to tinting it; resource
132I<tintColor>. Example:
133
134 @@RXVT_NAME@@ -tr -tint blue -sh 40
123 135
124=item B<-sh> 136=item B<-sh>
125 137
126I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
127background image in addition to tinting it (i.e. B<-tint> must be 139background image in addition to tinting it (i.e. B<-tint> must be
236 248
237Put scrollbar on right/left; resource B<scrollBar_right>. 249Put scrollbar on right/left; resource B<scrollBar_right>.
238 250
239=item B<-st>|B<+st> 251=item B<-st>|B<+st>
240 252
241Display normal (non XTerm/NeXT) scrollbar without/with a trough; 253Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
242resource B<scrollBar_floating>. 254resource B<scrollBar_floating>.
243 255
244=item B<-ptab>|B<+ptab> 256=item B<-ptab>|B<+ptab>
245 257
246If enabled (default), "Horizontal Tab" characters are being stored as 258If enabled (default), "Horizontal Tab" characters are being stored as
328 340
329Compile I<XIM>: input method name. resource B<inputMethod>. 341Compile I<XIM>: input method name. resource B<inputMethod>.
330 342
331=item B<-imlocale> I<string> 343=item B<-imlocale> I<string>
332 344
333The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 345The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
334de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 346C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
335extension to be able to input japanese characters while staying in 347input extension to be able to input japanese characters while staying in
336another locale. 348another locale. resource B<imLocale>.
349
350=item B<-imfont> I<fontset>
351
352Set the font set to use for the X Input Method, see resource B<imFont>
353for more info.
354
355=item B<-tcw>
356
357Change the meaning of triple-click selection with the left mouse
358button. Instead of selecting a full line it will extend the selection the
359end of the logical line only. resource B<tripleclickwords>.
337 360
338=item B<-insecure> 361=item B<-insecure>
339 362
340Enable "insecure" mode, which currently enables most of the escape 363Enable "insecure" mode, which currently enables most of the escape
341sequences that echo strings. See the resource B<insecure> for more 364sequences that echo strings. See the resource B<insecure> for more
355=item B<-ssr>|B<+ssr> 378=item B<-ssr>|B<+ssr>
356 379
357Turn on/off secondary screen scroll (default enabled); resource 380Turn on/off secondary screen scroll (default enabled); resource
358B<secondaryScroll>. 381B<secondaryScroll>.
359 382
360=item B<-xrm> I<resourcestring> 383=item B<-keysym.>I<sym> I<string>
361 384
362No effect on rxvt-unicode. Simply passes through an argument to be made 385Remap a key symbol. See resource B<keysym>.
363available in the instance's argument list. Appears in I<WM_COMMAND> in 386
364some window managers. 387=item B<-embed> I<windowid>
388
389Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
390which enables applications to easily embed a terminal.
391
392Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
393shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
394quite a bit, so don't expect it to keep some specific state. It's best to
395create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
396
397The window will not be destroyed when @@RXVT_NAME@@ exits.
398
399It might be useful to know that @@RXVT_NAME@@ will not close file
400descriptors passed to it (except for stdin/out/err, of course), so you
401can use file descriptors to communicate with the programs within the
402terminal. This works regardless of wether the C<-embed> option was used or
403not.
404
405Here is a short Gtk2-perl snippet that illustrates how this option can be
406used (a longer example is in F<doc/embed>):
407
408 my $rxvt = new Gtk2::Socket;
409 $rxvt->signal_connect_after (realize => sub {
410 my $xid = $_[0]->window->get_xid;
411 system "@@RXVT_NAME@@ -embed $xid &";
412 });
413
414=item B<-pty-fd> I<fileno>
415
416Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
417pair but instead use the given filehandle as the tty master. This is
418useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
419without having to run a program within it.
420
421If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
422entries and will not tinker with pty/tty permissions - you have to do that
423yourself if you want that.
424
425Here is a example in perl that illustrates how this option can be used (a
426longer example is in F<doc/pty-fd>):
427
428 use IO::Pty;
429 use Fcntl;
430
431 my $pty = new IO::Pty;
432 fcntl $pty, F_SETFD, 0; # clear close-on-exec
433 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
434 close $pty;
435
436 # now communicate with rxvt
437 my $slave = $pty->slave;
438 while (<$slave>) { print $slave "got <$_>\n" }
365 439
366=back 440=back
367 441
368=head1 RESOURCES (available also as long-options) 442=head1 RESOURCES (available also as long-options)
369 443
372 446
373There are two different methods that @@RXVT_NAME@@ can use to get the 447There are two different methods that @@RXVT_NAME@@ can use to get the
374Xresource data: using the X libraries (Xrm*-functions) or internal 448Xresource data: using the X libraries (Xrm*-functions) or internal
375Xresources reader (B<~/.Xdefaults>). For the first method (ie. 449Xresources reader (B<~/.Xdefaults>). For the first method (ie.
376B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 450B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
377resources using X11 tools like B<xset>. Many distribution do also load 451resources using X11 tools like B<xrdb>. Many distribution do also load
378settings from the B<~/.Xresources> file when X starts. 452settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
453will consult the following files/resources in order, with later settings
454overwriting earlier ones:
455
456 1. system-wide app-defaults file, either locale-dependent OR global
457 2. app-defaults file in $XAPPLRESDIR
458 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
459 4. SCREEN_RESOURCES for the current screen
460 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
379 461
380If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 462If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
381lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 463lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
382set in XAPPLOADDIR/URxvt (compile-time defined: usually 464set in XAPPLOADDIR/URxvt (compile-time defined: usually
383B</usr/lib/X11/app-defaults/URxvt>) and resources set in 465B</usr/lib/X11/app-defaults/URxvt>) and resources set in
476artificial transparency. B<False>: do not inherit the parent windows' 558artificial transparency. B<False>: do not inherit the parent windows'
477pixmap. 559pixmap.
478 560
479=item B<fading:> I<number> 561=item B<fading:> I<number>
480 562
481Fade the text by the given percentage when focus is lost. 563Fade the text by the given percentage when focus is lost; option B<-fade>.
564
565=item B<fadeColor:> I<colour>
566
567Fade to this colour, when fading is used (see B<fading:>). The default
568colour is black; option B<-fadecolor>.
482 569
483=item B<tintColor:> I<colour> 570=item B<tintColor:> I<colour>
484 571
485Tint the transparent background pixmap with the given colour. 572Tint the transparent background pixmap with the given colour; option
573B<-tint>.
486 574
487=item B<shading:> I<number> 575=item B<shading:> I<number>
488 576
489Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 577Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
490image in addition to tinting it. 578image in addition to tinting it.
494Use the specified colour for the scrollbar [default #B2B2B2]. 582Use the specified colour for the scrollbar [default #B2B2B2].
495 583
496=item B<troughColor:> I<colour> 584=item B<troughColor:> I<colour>
497 585
498Use the specified colour for the scrollbar's trough area [default 586Use the specified colour for the scrollbar's trough area [default
499#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 587#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
500 588
501=item B<borderColor:> I<colour> 589=item B<borderColor:> I<colour>
502 590
503The colour of the border around the text area and between the scrollbar 591The colour of the border around the text area and between the scrollbar
504and the text. 592and the text.
596xterm style selection. 684xterm style selection.
597 685
598=item B<scrollstyle:> I<mode> 686=item B<scrollstyle:> I<mode>
599 687
600Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 688Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
601the author's favourite.. 689the author's favourite.
602 690
603=item B<title:> I<string> 691=item B<title:> I<string>
604 692
605Set window title string, the default title is the command-line 693Set window title string, the default title is the command-line
606specified after the B<-e> option, if any, otherwise the application 694specified after the B<-e> option, if any, otherwise the application
638 726
639Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 727Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
640B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 728B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
641B<Shift-Print> to include the scrollback as well. 729B<Shift-Print> to include the scrollback as well.
642 730
731The string will be interpreted as if typed into the shell as-is.
732
733Example:
734
735 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
736
737This creates a new file in your home directory with the screen contents
738everytime you hit C<Print>.
739
643=item B<scrollBar:> I<boolean> 740=item B<scrollBar:> I<boolean>
644 741
645B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 742B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
646disable the scrollbar; option B<+sb>. 743disable the scrollbar; option B<+sb>.
647 744
667B<+si>. 764B<+si>.
668 765
669=item B<scrollWithBuffer:> I<boolean> 766=item B<scrollWithBuffer:> I<boolean>
670 767
671B<True>: scroll with scrollback buffer when tty receives new lines (and 768B<True>: scroll with scrollback buffer when tty receives new lines (and
672B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 769B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
673with scrollback buffer when tty recieves new lines; option B<-sw>. 770with scrollback buffer when tty recieves new lines; option B<+sw>.
674 771
675=item B<scrollTtyKeypress:> I<boolean> 772=item B<scrollTtyKeypress:> I<boolean>
676 773
677B<True>: scroll to bottom when a non-special key is pressed. Special keys 774B<True>: scroll to bottom when a non-special key is pressed. Special keys
678are those which are intercepted by rxvt-unicode for special handling and 775are those which are intercepted by rxvt-unicode for special handling and
743 840
744Mouse pointer background colour. 841Mouse pointer background colour.
745 842
746=item B<pointerBlankDelay:> I<number> 843=item B<pointerBlankDelay:> I<number>
747 844
748Specifies number of seconds before blanking the pointer [default 2]. 845Specifies number of seconds before blanking the pointer [default 2]. Use a
846large number (e.g. C<987654321>) to effectively disable the timeout.
749 847
750=item B<backspacekey:> I<string> 848=item B<backspacekey:> I<string>
751 849
752The string to send when the backspace key is pressed. If set to B<DEC> 850The string to send when the backspace key is pressed. If set to B<DEC>
753or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 851or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
775 873
776I<name> of inputMethod to use; option B<-im>. 874I<name> of inputMethod to use; option B<-im>.
777 875
778=item B<imLocale:> I<name> 876=item B<imLocale:> I<name>
779 877
780The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 878The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
781de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 879C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
782extension to be able to input japanese characters while staying in 880input extension to be able to input japanese characters while staying in
783another locale. option B<-imlocale>. 881another locale. option B<-imlocale>.
882
883=item B<imFont:> I<fontset>
884
885Specify the font-set used for XIM styles C<OverTheSpot> or
886C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
887by commas), i.e. it's not in the same format as the other font lists used
888in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
889found, preferably one or two pixels differing in size to the base font.
890option B<-imfont>.
891
892=item B<tripleclickwords:> I<boolean>
893
894Change the meaning of triple-click selection with the left mouse
895button. Instead of selecting a full line it will extend the selection to
896the end of the logical line only. option B<-tcw>.
784 897
785=item B<insecure:> I<boolean> 898=item B<insecure:> I<boolean>
786 899
787Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 900Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
788echo arbitrary strings like the icon name or the locale. This could be 901echo arbitrary strings like the icon name or the locale. This could be
789abused if somebody gets 8-bit-clean access to your display, whether 902abused if somebody gets 8-bit-clean access to your display, whether
790throuh a mail client displaying mail bodies unfiltered or though 903through a mail client displaying mail bodies unfiltered or through
791write(1). Therefore, these sequences are disabled by default. (Note 904write(1) or any other means. Therefore, these sequences are disabled by
792that other terminals, including xterm, have these sequences 905default. (Note that many other terminals, including xterm, have these
793enabled by default). You can enable them by setting this boolean 906sequences enabled by default, which doesn't make it safer, though).
794resource or specifying B<-insecure> as an option. At the moment, this 907
795enabled display-answer, locale, findfont, icon label and window title 908You can enable them by setting this boolean resource or specifying
796requests as well as dynamic menubar dispatch. 909B<-insecure> as an option. At the moment, this enables display-answer,
910locale, findfont, icon label and window title requests as well as dynamic
911menubar dispatch.
797 912
798=item B<modifier:> I<modifier> 913=item B<modifier:> I<modifier>
799 914
800Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 915Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
801B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 916B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
829and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 944and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
830B<2>, B<3>, B<4>, B<5>. 945B<2>, B<3>, B<4>, B<5>.
831 946
832The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 947The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
833whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 948whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
834keys are being mapped. B<AppKeypad> is a artificial modifier mapped to the 949keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
835current application keymap mode state. 950current application keymap mode state.
836 951
837The spellings of I<key> can be obtained by using B<xev>(1) command or 952The spellings of I<key> can be obtained by using B<xev>(1) command or
838searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 953searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
839omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 954omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
844C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 959C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
845C<\000>: octal number) or verbatim control characters (C<^?>: delete, 960C<\000>: octal number) or verbatim control characters (C<^?>: delete,
846C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 961C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
847can start or end with whitespace. 962can start or end with whitespace.
848 963
964Please note that you need to double the C<\> when using
965C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
966use C<\033> instead of C<\e> (and so on), which will work with both Xt and
967@@RXVT_NAME@@'s own processing).
968
849You can define a range of keysyms in one shot by providing a I<string> 969You can define a range of keysyms in one shot by providing a I<string>
850with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 970with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
851should be a character not used by the strings. 971should be a character not used by the strings.
852 972
853Its usage can be demonstrated by an example: 973Its usage can be demonstrated by an example:
854 974
855 URxvt.keysym.M-C-0x61: list|\e<M-C-|abc|> 975 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
856 976
857The above line is equivalent to the following three lines: 977The above line is equivalent to the following three lines:
858 978
859 URxvt.keysym.Meta-Control-0x61: \e<M-C-a> 979 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
860 URxvt.keysym.Meta-Control-0x62: \e<M-C-b> 980 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
861 URxvt.keysym.Meta-Control-0x63: \e<M-C-c> 981 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
862 982
863If I<string> takes the form of C<proto:STRING>, the specified B<STRING> is 983If I<string> takes the form of C<command:STRING>, the specified B<STRING>
864interpreted and executed as @@RXVT_NAME@@'s control sequence. For example, 984is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
865C<proto:\033]701;zh_CN.GBK\007> means: change the current locale to 985example the following means "change the current locale to C<zh_CN.GBK>
866C<zh_CN.GBK>. 986when Control-Meta-c is being pressed":
987
988 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
989
990Due the the large number of modifier combinations, a defined key mapping
991will match if at I<at least> the specified identifiers are being set, and
992no other key mappings with those and more bits are being defined. That
993means that defining a key map for C<a> will automatically provide
994definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
995mappings themselves.
996
997Unfortunately, this will override built-in key mappings. For example
998if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
999C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1000user-defined keymap using the C<builtin:> replacement:
1001
1002 URxvt.keysym.Insert: <my insert key sequence>
1003 URxvt.keysym.S-Insert: builtin:
1004
1005The first line defines a mapping for C<Insert> and I<any> combination
1006of modifiers. The second line re-establishes the default mapping for
1007C<Shift-Insert>.
1008
1009The following example will map Control-Meta-1 and Control-Meta-2 to
1010the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1011font-switching at runtime:
1012
1013 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1014 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1015
1016Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1017info):
1018
1019 URxvt.keysym.M-C-3: command:\033[8;25;80t
1020 URxvt.keysym.M-C-4: command:\033[8;48;110t
867 1021
868=back 1022=back
869 1023
870=head1 THE SCROLLBAR 1024=head1 THE SCROLLBAR
871 1025
885the normal text selection/insertion, hold either the Shift or the Meta 1039the normal text selection/insertion, hold either the Shift or the Meta
886(Alt) key while performing the desired mouse action. 1040(Alt) key while performing the desired mouse action.
887 1041
888If mouse reporting mode is active, the normal scrollbar actions are 1042If mouse reporting mode is active, the normal scrollbar actions are
889disabled -- on the assumption that we are using a fullscreen 1043disabled -- on the assumption that we are using a fullscreen
890application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1044application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
891(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1045(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
892up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), 1046up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
893respectively. 1047respectively.
894 1048
895=head1 TEXT SELECTION AND INSERTION 1049=head1 TEXT SELECTION AND INSERTION
896 1050
897The behaviour of text selection and insertion mechanism is similar to 1051The behaviour of text selection and insertion mechanism is similar to
899 1053
900=over 4 1054=over 4
901 1055
902=item B<Selection>: 1056=item B<Selection>:
903 1057
904Left click at the beginning of the region, drag to the end of the 1058Left click at the beginning of the region, drag to the end of the region
905region and release; Right click to extend the marked region; Left 1059and release; Right click to extend the marked region; Left double-click
906double-click to select a word; Left triple-click to select the entire 1060to select a word; Left triple-click to select the entire logical line
907line. 1061(which can span multiple screen lines), unless modified by resource
1062B<tripleclickwords>.
908 1063
909Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1064Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
910(Compile: I<frills>) will create a rectangular selection instead of a normal 1065(Compile: I<frills>) will create a rectangular selection instead of a normal
911one. 1066one.
912 1067
924supported in rxvt-unicode. Bug me if you need this. 1079supported in rxvt-unicode. Bug me if you need this.
925 1080
926You can, however, switch fonts at runtime using escape sequences (and 1081You can, however, switch fonts at runtime using escape sequences (and
927therefore using the menubar), e.g.: 1082therefore using the menubar), e.g.:
928 1083
929 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1084 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
930 1085
931rxvt-unicode will automatically re-apply these fonts to the output so far. 1086rxvt-unicode will automatically re-apply these fonts to the output so far.
932 1087
933=head1 ISO 14755 SUPPORT 1088=head1 ISO 14755 SUPPORT
934 1089
938C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1093C<--enable-frills>, the rest is available when rxvt-unicode was compiled
939with C<--enable-iso14755>. 1094with C<--enable-iso14755>.
940 1095
941=over 4 1096=over 4
942 1097
943=item 5.1: Basic method 1098=item * 5.1: Basic method
944 1099
945This allows you to enter unicode characters using their hexcode. 1100This allows you to enter unicode characters using their hexcode.
946 1101
947Start by pressing and holding both C<Control> and C<Shift>, then enter 1102Start by pressing and holding both C<Control> and C<Shift>, then enter
948hex-digits (between one and six). Releasing C<Control> and C<Shift> will 1103hex-digits (between one and six). Releasing C<Control> and C<Shift> will
955address, which you cannot type. Fortunately, the card has the e-mail 1110address, which you cannot type. Fortunately, the card has the e-mail
956address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily 1111address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
957by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>, 1112by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
958followed by releasing the modifier keys. 1113followed by releasing the modifier keys.
959 1114
960=item 5.2: Keyboard symbols entry method 1115=item * 5.2: Keyboard symbols entry method
961 1116
962This mode lets you input characters representing the keycap symbols of 1117This mode lets you input characters representing the keycap symbols of
963your keyboard, if representable in the current locale encoding. 1118your keyboard, if representable in the current locale encoding.
964 1119
965Start by pressing C<Control> and C<Shift> together, then releasing 1120Start by pressing C<Control> and C<Shift> together, then releasing
968keycap symbol. The symbol will only be entered when the key has been 1123keycap symbol. The symbol will only be entered when the key has been
969released, otherwise pressing e.g. C<Shift> would enter the symbol for 1124released, otherwise pressing e.g. C<Shift> would enter the symbol for
970C<ISO Level 2 Switch>, although your intention might have been to enter a 1125C<ISO Level 2 Switch>, although your intention might have been to enter a
971reverse tab (Shift-Tab). 1126reverse tab (Shift-Tab).
972 1127
973=item 5.3: Screen-selection entry method 1128=item * 5.3: Screen-selection entry method
974 1129
975While this is implemented already (it's basically the selection 1130While this is implemented already (it's basically the selection
976mechanism), it could be extended by displaying a unicode character map. 1131mechanism), it could be extended by displaying a unicode character map.
977 1132
978=item 5.4: Feedback method for identifying displayed characters for later input 1133=item * 5.4: Feedback method for identifying displayed characters for later input
979 1134
980This method lets you display the unicode character code associated with 1135This method lets you display the unicode character code associated with
981characters already displayed. 1136characters already displayed.
982 1137
983You enter this mode by holding down C<Control> and C<Shift> together, then 1138You enter this mode by holding down C<Control> and C<Shift> together, then
995With respect to conformance, rxvt-unicode is supposed to be compliant to 1150With respect to conformance, rxvt-unicode is supposed to be compliant to
996both scenario A and B of ISO 14755, including part 5.2. 1151both scenario A and B of ISO 14755, including part 5.2.
997 1152
998=head1 LOGIN STAMP 1153=head1 LOGIN STAMP
999 1154
1000B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1155B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1001that it can be seen via the I<who(1)> command, and can accept messages. 1156it can be seen via the I<who(1)> command, and can accept messages. To
1002To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on 1157allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1003some systems. 1158on some systems or setgid to root or to some other group on others.
1004 1159
1005=head1 COLORS AND GRAPHICS 1160=head1 COLORS AND GRAPHICS
1006 1161
1007In addition to the default foreground and background colours, 1162In addition to the default foreground and background colours,
1008B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1163B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1051 1206
1052=back 1207=back
1053 1208
1054=head1 ENVIRONMENT 1209=head1 ENVIRONMENT
1055 1210
1056B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1211B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1057and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1212
1058window id number of the B<@@RXVT_NAME@@> window and it also uses and 1213=over 4
1059sets the environment variable B<DISPLAY> to specify which display 1214
1060terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1215=item B<TERM>
1061B<RXVTPATH> and B<PATH> to find XPM files. 1216
1217Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1218resources or on the commandline.
1219
1220=item B<COLORTERM>
1221
1222Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
1223compiled with XPM support, and optionally with the added extension
1224C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1225
1226=item B<COLORFGBG>
1227
1228Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1229the colour code used as default foreground/text colour (or the string
1230C<default> to indicate that the default-colour escape sequence is to be
1231used), C<bg> is the colour code used as default background colour (or the
1232string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1233was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1234(and do) use this information to optimize screen output.
1235
1236=item B<WINDOWID>
1237
1238Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1239window, which usually has subwindows for the scrollbar, the terminal
1240window and so on).
1241
1242=item B<TERMINFO>
1243
1244Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1245C<--with-terminfo=PATH>.
1246
1247=item B<DISPLAY>
1248
1249Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1250display in it's child processes.
1251
1252=item B<SHELL>
1253
1254The shell to be used for command execution, defaults to C</bin/sh>.
1255
1256=item B<RXVTPATH>
1257
1258The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1259files.
1260
1261=item B<PATH>
1262
1263Used in the same way as C<RXVTPATH>.
1264
1265=item B<RXVT_SOCKET>
1266
1267The unix domain socket path used by @@RXVT_NAME@@c(1) and
1268@@RXVT_NAME@@d(1).
1269
1270Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1271
1272=item B<HOME>
1273
1274Used to locate the default directory for the unix domain socket for
1275daemon communications and to locate various resource files (such as
1276C<.Xdefaults>)
1277
1278=item B<XAPPLRESDIR>
1279
1280Directory where various X resource files are being located.
1281
1282=item B<XENVIRONMENT>
1283
1284If set and accessible, gives the name of a X resource file to be loaded by
1285@@RXVT_NAME@@.
1286
1287=back
1062 1288
1063=head1 FILES 1289=head1 FILES
1064 1290
1065=over 4 1291=over 4
1066 1292
1067=item B</etc/utmp>
1068
1069System file for login records.
1070
1071=item B</usr/lib/X11/rgb.txt> 1293=item B</usr/lib/X11/rgb.txt>
1072 1294
1073Color names. 1295Color names.
1074 1296
1075=back 1297=back
1076 1298
1077=head1 SEE ALSO 1299=head1 SEE ALSO
1078 1300
1079@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1301@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1080
1081=head1 BUGS
1082
1083Check the BUGS file for an up-to-date list.
1084
1085Cursor change support is not yet implemented.
1086
1087Click-and-drag doesn't work with X11 mouse report overriding.
1088 1302
1089=head1 CURRENT PROJECT COORDINATOR 1303=head1 CURRENT PROJECT COORDINATOR
1090 1304
1091=over 4 1305=over 4
1092 1306
1093=item Project Coordinator 1307=item Project Coordinator
1094 1308
1095@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1309Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1096 1310
1097=item Web page maintainter 1311L<http://software.schmorp.de/#rxvt-unicode>
1098
1099@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1100
1101L<@@RXVT_WEBPAGE@@>
1102 1312
1103=back 1313=back
1104 1314
1105=head1 AUTHORS 1315=head1 AUTHORS
1106 1316
1131=item Geoff Wing L<< <gcw@pobox.com> >> 1341=item Geoff Wing L<< <gcw@pobox.com> >>
1132 1342
1133Rewrote screen display and text selection routines. Project Coordinator 1343Rewrote screen display and text selection routines. Project Coordinator
1134(changes.txt 2.4.6 - rxvt-unicode) 1344(changes.txt 2.4.6 - rxvt-unicode)
1135 1345
1136=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1346=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1137 1347
1138Forked rxvt-unicode, rewrote most of the display code and internal 1348Forked rxvt-unicode, rewrote most of the display code and internal
1139character handling to store text in unicode, improve xterm 1349character handling to store text in unicode, improve xterm
1140compatibility and apply numerous other bugfixes and extensions. 1350compatibility and apply numerous other bugfixes and extensions.
1141 1351

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines