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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines