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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines