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.65 by root, Thu Jun 30 14:00:49 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
643=item B<scrollBar:> I<boolean> 717=item B<scrollBar:> I<boolean>
644 718
645B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 719B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
646disable the scrollbar; option B<+sb>. 720disable the scrollbar; option B<+sb>.
647 721
667B<+si>. 741B<+si>.
668 742
669=item B<scrollWithBuffer:> I<boolean> 743=item B<scrollWithBuffer:> I<boolean>
670 744
671B<True>: scroll with scrollback buffer when tty receives new lines (and 745B<True>: scroll with scrollback buffer when tty receives new lines (and
672B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 746B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
673with scrollback buffer when tty recieves new lines; option B<-sw>. 747with scrollback buffer when tty recieves new lines; option B<+sw>.
674 748
675=item B<scrollTtyKeypress:> I<boolean> 749=item B<scrollTtyKeypress:> I<boolean>
676 750
677B<True>: scroll to bottom when a non-special key is pressed. Special keys 751B<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 752are those which are intercepted by rxvt-unicode for special handling and
743 817
744Mouse pointer background colour. 818Mouse pointer background colour.
745 819
746=item B<pointerBlankDelay:> I<number> 820=item B<pointerBlankDelay:> I<number>
747 821
748Specifies number of seconds before blanking the pointer [default 2]. 822Specifies number of seconds before blanking the pointer [default 2]. Use a
823large number (e.g. C<987654321>) to effectively disable the timeout.
749 824
750=item B<backspacekey:> I<string> 825=item B<backspacekey:> I<string>
751 826
752The string to send when the backspace key is pressed. If set to B<DEC> 827The 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> 828or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
775 850
776I<name> of inputMethod to use; option B<-im>. 851I<name> of inputMethod to use; option B<-im>.
777 852
778=item B<imLocale:> I<name> 853=item B<imLocale:> I<name>
779 854
780The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 855The 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 856C<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 857input extension to be able to input japanese characters while staying in
783another locale. option B<-imlocale>. 858another locale. option B<-imlocale>.
859
860=item B<imFont:> I<fontset>
861
862Specify the font-set used for XIM styles C<OverTheSpot> or
863C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
864by commas), i.e. it's not in the same format as the other font lists used
865in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
866found, preferably one or two pixels differing in size to the base font.
867option B<-imfont>.
868
869=item B<tripleclickwords:> I<boolean>
870
871Change the meaning of triple-click selection with the left mouse
872button. Instead of selecting a full line it will extend the selection to
873the end of the logical line only. option B<-tcw>.
784 874
785=item B<insecure:> I<boolean> 875=item B<insecure:> I<boolean>
786 876
787Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 877Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
788echo arbitrary strings like the icon name or the locale. This could be 878echo 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>, 919and 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>. 920B<2>, B<3>, B<4>, B<5>.
831 921
832The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 922The 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 923whatever 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 924keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
835current application keymap mode state. 925current application keymap mode state.
836 926
837The spellings of I<key> can be obtained by using B<xev>(1) command or 927The 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 928searching 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 929omitting 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, 934C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
845C<\000>: octal number) or verbatim control characters (C<^?>: delete, 935C<\000>: octal number) or verbatim control characters (C<^?>: delete,
846C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 936C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
847can start or end with whitespace. 937can start or end with whitespace.
848 938
939Please note that you need to double the C<\> when using
940C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
941use C<\033> instead of C<\e> (and so on), which will work with both Xt and
942@@RXVT_NAME@@'s own processing).
943
849You can define a range of keysyms in one shot by providing a I<string> 944You can define a range of keysyms in one shot by providing a I<string>
850with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 945with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
851should be a character not used by the strings. 946should be a character not used by the strings.
852 947
853Its usage can be demonstrated by an example: 948Its usage can be demonstrated by an example:
854 949
855 URxvt.keysym.M-C-0x61: list|\e<M-C-|abc|> 950 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
856 951
857The above line is equivalent to the following three lines: 952The above line is equivalent to the following three lines:
858 953
859 URxvt.keysym.Meta-Control-0x61: \e<M-C-a> 954 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
860 URxvt.keysym.Meta-Control-0x62: \e<M-C-b> 955 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
861 URxvt.keysym.Meta-Control-0x63: \e<M-C-c> 956 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
862 957
863If I<string> takes the form of C<proto:STRING>, the specified B<STRING> is 958If I<string> takes the form of C<command:STRING>, the specified B<STRING>
864interpreted and executed as @@RXVT_NAME@@'s control sequence. For example, 959is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
865C<proto:\033]701;zh_CN.GBK\007> means: change the current locale to 960example the following means "change the current locale to C<zh_CN.GBK>
866C<zh_CN.GBK>. 961when Control-Meta-c is being pressed":
962
963 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
964
965Due the the large number of modifier combinations, a defined key mapping
966will match if at I<at least> the specified identifiers are being set, and
967no other key mappings with those and more bits are being defined. That
968means that defining a key map for C<a> will automatically provide
969definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
970mappings themselves.
971
972Unfortunately, this will override built-in key mappings. For example
973if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
974C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
975user-defined keymap using the C<builtin:> replacement:
976
977 URxvt.keysym.Insert: <my insert key sequence>
978 URxvt.keysym.S-Insert: builtin:
979
980The first line defines a mapping for C<Insert> and I<any> combination
981of modifiers. The second line re-establishes the default mapping for
982C<Shift-Insert>.
983
984The following example will map Control-Meta-1 and Control-Meta-2 to
985the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
986font-switching at runtime:
987
988 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
989 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
990
991Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
992info):
993
994 URxvt.keysym.M-C-3: command:\033[8;25;80t
995 URxvt.keysym.M-C-4: command:\033[8;48;110t
867 996
868=back 997=back
869 998
870=head1 THE SCROLLBAR 999=head1 THE SCROLLBAR
871 1000
885the normal text selection/insertion, hold either the Shift or the Meta 1014the normal text selection/insertion, hold either the Shift or the Meta
886(Alt) key while performing the desired mouse action. 1015(Alt) key while performing the desired mouse action.
887 1016
888If mouse reporting mode is active, the normal scrollbar actions are 1017If mouse reporting mode is active, the normal scrollbar actions are
889disabled -- on the assumption that we are using a fullscreen 1018disabled -- on the assumption that we are using a fullscreen
890application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1019application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
891(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1020(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), 1021up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
893respectively. 1022respectively.
894 1023
895=head1 TEXT SELECTION AND INSERTION 1024=head1 TEXT SELECTION AND INSERTION
896 1025
897The behaviour of text selection and insertion mechanism is similar to 1026The behaviour of text selection and insertion mechanism is similar to
899 1028
900=over 4 1029=over 4
901 1030
902=item B<Selection>: 1031=item B<Selection>:
903 1032
904Left click at the beginning of the region, drag to the end of the 1033Left 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 1034and release; Right click to extend the marked region; Left double-click
906double-click to select a word; Left triple-click to select the entire 1035to select a word; Left triple-click to select the entire logical line
907line. 1036(which can span multiple screen lines), unless modified by resource
1037B<tripleclickwords>.
908 1038
909Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1039Starting 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 1040(Compile: I<frills>) will create a rectangular selection instead of a normal
911one. 1041one.
912 1042
938C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1068C<--enable-frills>, the rest is available when rxvt-unicode was compiled
939with C<--enable-iso14755>. 1069with C<--enable-iso14755>.
940 1070
941=over 4 1071=over 4
942 1072
943=item 5.1: Basic method 1073=item * 5.1: Basic method
944 1074
945This allows you to enter unicode characters using their hexcode. 1075This allows you to enter unicode characters using their hexcode.
946 1076
947Start by pressing and holding both C<Control> and C<Shift>, then enter 1077Start 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 1078hex-digits (between one and six). Releasing C<Control> and C<Shift> will
955address, which you cannot type. Fortunately, the card has the e-mail 1085address, 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 1086address 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>, 1087by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
958followed by releasing the modifier keys. 1088followed by releasing the modifier keys.
959 1089
960=item 5.2: Keyboard symbols entry method 1090=item * 5.2: Keyboard symbols entry method
961 1091
962This mode lets you input characters representing the keycap symbols of 1092This mode lets you input characters representing the keycap symbols of
963your keyboard, if representable in the current locale encoding. 1093your keyboard, if representable in the current locale encoding.
964 1094
965Start by pressing C<Control> and C<Shift> together, then releasing 1095Start by pressing C<Control> and C<Shift> together, then releasing
968keycap symbol. The symbol will only be entered when the key has been 1098keycap symbol. The symbol will only be entered when the key has been
969released, otherwise pressing e.g. C<Shift> would enter the symbol for 1099released, 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 1100C<ISO Level 2 Switch>, although your intention might have been to enter a
971reverse tab (Shift-Tab). 1101reverse tab (Shift-Tab).
972 1102
973=item 5.3: Screen-selection entry method 1103=item * 5.3: Screen-selection entry method
974 1104
975While this is implemented already (it's basically the selection 1105While this is implemented already (it's basically the selection
976mechanism), it could be extended by displaying a unicode character map. 1106mechanism), it could be extended by displaying a unicode character map.
977 1107
978=item 5.4: Feedback method for identifying displayed characters for later input 1108=item * 5.4: Feedback method for identifying displayed characters for later input
979 1109
980This method lets you display the unicode character code associated with 1110This method lets you display the unicode character code associated with
981characters already displayed. 1111characters already displayed.
982 1112
983You enter this mode by holding down C<Control> and C<Shift> together, then 1113You 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 1125With respect to conformance, rxvt-unicode is supposed to be compliant to
996both scenario A and B of ISO 14755, including part 5.2. 1126both scenario A and B of ISO 14755, including part 5.2.
997 1127
998=head1 LOGIN STAMP 1128=head1 LOGIN STAMP
999 1129
1000B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1130B<@@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. 1131it 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 1132allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1003some systems. 1133on some systems or setgid to root or to some other group on others.
1004 1134
1005=head1 COLORS AND GRAPHICS 1135=head1 COLORS AND GRAPHICS
1006 1136
1007In addition to the default foreground and background colours, 1137In addition to the default foreground and background colours,
1008B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1138B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1051 1181
1052=back 1182=back
1053 1183
1054=head1 ENVIRONMENT 1184=head1 ENVIRONMENT
1055 1185
1056B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1186B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1057and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1187
1058window id number of the B<@@RXVT_NAME@@> window and it also uses and 1188=over 4
1059sets the environment variable B<DISPLAY> to specify which display 1189
1060terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1190=item B<TERM>
1061B<RXVTPATH> and B<PATH> to find XPM files. 1191
1192Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1193resources or on the commandline.
1194
1195=item B<COLORTERM>
1196
1197Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
1198compiled with XPM support, and optionally with the added extension
1199C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1200
1201=item B<COLORFGBG>
1202
1203Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1204the colour code used as default foreground/text colour (or the string
1205C<default> to indicate that the default-colour escape sequence is to be
1206used), C<bg> is the colour code used as default background colour (or the
1207string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1208was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1209(and do) use this information to optimize screen output.
1210
1211=item B<WINDOWID>
1212
1213Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1214window, which usually has subwindows for the scrollbar, the terminal
1215window and so on).
1216
1217=item B<TERMINFO>
1218
1219Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1220C<--with-terminfo=PATH>.
1221
1222=item B<DISPLAY>
1223
1224Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1225display in it's child processes.
1226
1227=item B<SHELL>
1228
1229The shell to be used for command execution, defaults to C</bin/sh>.
1230
1231=item B<RXVTPATH>
1232
1233The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1234files.
1235
1236=item B<PATH>
1237
1238Used in the same way as C<RXVTPATH>.
1239
1240=item B<RXVT_SOCKET>
1241
1242The unix domain socket path used by @@RXVT_NAME@@c(1) and
1243@@RXVT_NAME@@d(1).
1244
1245Default C<< $HOME/.rxvt-unicode-<nodename >>.
1246
1247=item B<HOME>
1248
1249Used to locate the default directory for the unix domain socket for
1250daemon communications and to locate various resource files (such as
1251C<.Xdefaults>)
1252
1253=item B<XAPPLRESDIR>
1254
1255Directory where various X resource files are being located.
1256
1257=item B<XENVIRONMENT>
1258
1259If set and accessible, gives the name of a X resource file to be loaded by
1260@@RXVT_NAME@@.
1261
1262=back
1062 1263
1063=head1 FILES 1264=head1 FILES
1064 1265
1065=over 4 1266=over 4
1066 1267
1067=item B</etc/utmp>
1068
1069System file for login records.
1070
1071=item B</usr/lib/X11/rgb.txt> 1268=item B</usr/lib/X11/rgb.txt>
1072 1269
1073Color names. 1270Color names.
1074 1271
1075=back 1272=back
1090 1287
1091=over 4 1288=over 4
1092 1289
1093=item Project Coordinator 1290=item Project Coordinator
1094 1291
1095@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1292Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1096 1293
1097=item Web page maintainter 1294L<http://software.schmorp.de/#rxvt-unicode>
1098
1099@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1100
1101L<@@RXVT_WEBPAGE@@>
1102 1295
1103=back 1296=back
1104 1297
1105=head1 AUTHORS 1298=head1 AUTHORS
1106 1299
1131=item Geoff Wing L<< <gcw@pobox.com> >> 1324=item Geoff Wing L<< <gcw@pobox.com> >>
1132 1325
1133Rewrote screen display and text selection routines. Project Coordinator 1326Rewrote screen display and text selection routines. Project Coordinator
1134(changes.txt 2.4.6 - rxvt-unicode) 1327(changes.txt 2.4.6 - rxvt-unicode)
1135 1328
1136=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1329=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1137 1330
1138Forked rxvt-unicode, rewrote most of the display code and internal 1331Forked rxvt-unicode, rewrote most of the display code and internal
1139character handling to store text in unicode, improve xterm 1332character handling to store text in unicode, improve xterm
1140compatibility and apply numerous other bugfixes and extensions. 1333compatibility and apply numerous other bugfixes and extensions.
1141 1334

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines