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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines