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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines