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.34 by root, Wed Dec 1 02:29:14 2004 UTC vs.
Revision 1.56 by root, Mon Feb 14 18:47:54 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. 117Fade the text by the given percentage when focus is lost. resource B<fading>.
116 118
117=item B<-tint> I<colour> 119=item B<-tint> I<colour>
118 120
119Tint the transparent background pixmap with the given colour when 121Tint the transparent background pixmap with the given colour when
120transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> 122transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh>
123 125
124=item B<-sh> 126=item B<-sh>
125 127
126I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 128I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
127background image in addition to tinting it (i.e. B<-tint> must be 129background image in addition to tinting it (i.e. B<-tint> must be
128specified, too). 130specified, too, e.g. C<-tint white>).
129 131
130=item B<-bg> I<colour> 132=item B<-bg> I<colour>
131 133
132Window background colour; resource B<background>. 134Window background colour; resource B<background>.
133 135
136Window foreground colour; resource B<foreground>. 138Window foreground colour; resource B<foreground>.
137 139
138=item B<-pixmap> I<file[;geom]> 140=item B<-pixmap> I<file[;geom]>
139 141
140Compile I<XPM>: Specify XPM file for the background and also optionally 142Compile I<XPM>: Specify XPM file for the background and also optionally
141specify its scaling with a geometry string. Note you may need to add 143specify its scaling with a geometry string. Note you may need to
142quotes to avoid special shell interpretation of the `;' in the 144add quotes to avoid special shell interpretation of the C<;> in the
143command-line; resource B<backgroundPixmap>. 145command-line; resource B<backgroundPixmap>.
144 146
145=item B<-cr> I<colour> 147=item B<-cr> I<colour>
146 148
147The cursor colour; resource B<cursorColor>. 149The cursor colour; resource B<cursorColor>.
280if honoured by the WM, the rxvt-unicode window will not have window 282if honoured by the WM, the rxvt-unicode window will not have window
281decorations; resource B<borderLess>. 283decorations; resource B<borderLess>.
282 284
283=item B<-lsp> I<number> 285=item B<-lsp> I<number>
284 286
285Compile I<linespace>: Lines (pixel height) to insert between each row 287Compile I<frills>: Lines (pixel height) to insert between each row of
286of the display; resource B<linespace>. 288the display. Useful to work around font rendering problems; resource
289B<linespace>.
287 290
288=item B<-tn> I<termname> 291=item B<-tn> I<termname>
289 292
290This option specifies the name of the terminal type to be set in the 293This option specifies the name of the terminal type to be set in the
291B<TERM> environment variable. This terminal type must exist in the 294B<TERM> environment variable. This terminal type must exist in the
327 330
328Compile I<XIM>: input method name. resource B<inputMethod>. 331Compile I<XIM>: input method name. resource B<inputMethod>.
329 332
330=item B<-imlocale> I<string> 333=item B<-imlocale> I<string>
331 334
332The 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.
333de_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
334extension to be able to input japanese characters while staying in 337input extension to be able to input japanese characters while staying in
335another 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>.
336 350
337=item B<-insecure> 351=item B<-insecure>
338 352
339Enable "insecure" mode, which currently enables most of the escape 353Enable "insecure" mode, which currently enables most of the escape
340sequences that echo strings. See the resource B<insecure> for more 354sequences that echo strings. See the resource B<insecure> for more
354=item B<-ssr>|B<+ssr> 368=item B<-ssr>|B<+ssr>
355 369
356Turn on/off secondary screen scroll (default enabled); resource 370Turn on/off secondary screen scroll (default enabled); resource
357B<secondaryScroll>. 371B<secondaryScroll>.
358 372
359=item B<-xrm> I<resourcestring> 373=item B<-keysym.>I<sym>: I<string>
360 374
361No effect on rxvt-unicode. Simply passes through an argument to be made 375Remap a key symbol. See resource B<keysym>.
362available in the instance's argument list. Appears in I<WM_COMMAND> in 376
363some 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
387It might be useful to know that @@RXVT_NAME@@ will not close file
388descriptors passed to it (except for stdin/out/err, of course), so you
389can use file descriptors to communicate with the programs within the
390terminal. This works regardless of wether the C<-embed> option was used or
391not.
364 392
365=back 393=back
366 394
367=head1 RESOURCES (available also as long-options) 395=head1 RESOURCES (available also as long-options)
368 396
371 399
372There are two different methods that @@RXVT_NAME@@ can use to get the 400There are two different methods that @@RXVT_NAME@@ can use to get the
373Xresource data: using the X libraries (Xrm*-functions) or internal 401Xresource data: using the X libraries (Xrm*-functions) or internal
374Xresources reader (B<~/.Xdefaults>). For the first method (ie. 402Xresources reader (B<~/.Xdefaults>). For the first method (ie.
375B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 403B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
376resources using X11 tools like B<xset>. Many distribution do also load 404resources using X11 tools like B<xrdb>. Many distribution do also load
377settings from the B<~/.Xresources> file when X starts. 405settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
406will consult the following files/resources in order, with later settings
407overwriting earlier ones:
408
409 1. system-wide app-defaults file, either locale-dependent OR global
410 2. app-defaults file in $XAPPLRESDIR
411 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
412 4. SCREEN_RESOURCES for the current screen
413 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
378 414
379If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 415If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
380lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 416lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
381set in XAPPLOADDIR/URxvt (compile-time defined: usually 417set in XAPPLOADDIR/URxvt (compile-time defined: usually
382B</usr/lib/X11/app-defaults/URxvt>) and resources set in 418B</usr/lib/X11/app-defaults/URxvt>) and resources set in
427 463
428=item B<colorIT:> I<colour> 464=item B<colorIT:> I<colour>
429 465
430Use the specified colour to display bold or italic characters when the 466Use the specified colour to display bold or italic characters when the
431foreground colour is the default. If font styles are not available 467foreground colour is the default. If font styles are not available
432(Compile styles) and this option is unset, reverse video is used instead. 468(Compile I<styles>) and this option is unset, reverse video is used instead.
433 469
434=item B<colorUL:> I<colour> 470=item B<colorUL:> I<colour>
435 471
436Use the specified colour to display underlined characters when the 472Use the specified colour to display underlined characters when the
437foreground colour is the default. 473foreground colour is the default.
438 474
439=item B<colorRV:> I<colour> 475=item B<colorRV:> I<colour>
440 476
441Use the specified colour as the background for reverse video 477Use the specified colour as the background for reverse video
442characters. 478characters.
479
480=item B<underlineColor:> I<colour>
481
482If set, use the specified colour as the colour for the underline
483itself. If unset, use the foreground colour.
443 484
444=item B<cursorColor:> I<colour> 485=item B<cursorColor:> I<colour>
445 486
446Use the specified colour for the cursor. The default is to use the 487Use the specified colour for the cursor. The default is to use the
447foreground colour; option B<-cr>. 488foreground colour; option B<-cr>.
528The first font defines the cell size for characters; other fonts might 569The first font defines the cell size for characters; other fonts might
529be smaller, but not larger. A reasonable default font list is always 570be smaller, but not larger. A reasonable default font list is always
530appended to it. option B<-fn>. 571appended to it. option B<-fn>.
531 572
532Each font can either be a standard X11 core font (XLFD) name, with 573Each font can either be a standard X11 core font (XLFD) name, with
533optional prefix C<x:> or a Xft font (Compile xft), prefixed with C<xft:>. 574optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
534 575
535In addition, each font can be prefixed with additional hints and 576In addition, each font can be prefixed with additional hints and
536specifications enclosed in square brackets (C<[]>). The only available 577specifications enclosed in square brackets (C<[]>). The only available
537hint currently is C<codeset=codeset-name>, and this is only used for Xft 578hint currently is C<codeset=codeset-name>, and this is only used for Xft
538fonts. 579fonts.
769 810
770I<name> of inputMethod to use; option B<-im>. 811I<name> of inputMethod to use; option B<-im>.
771 812
772=item B<imLocale:> I<name> 813=item B<imLocale:> I<name>
773 814
774The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 815The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
775de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 816C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
776extension to be able to input japanese characters while staying in 817input extension to be able to input japanese characters while staying in
777another locale. option B<-imlocale>. 818another locale. option B<-imlocale>.
819
820=item B<imFont:> I<fontset>
821
822Specify the font-set used for XIM styles C<OverTheSpot> or
823C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
824by commas), i.e. it's not in the same format as the other font lists used
825in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
826found, preferably one or two pixels differing in size to the base font.
827option B<-imfont>.
828
829=item B<tripleclickwords:> I<boolean>
830
831Change the meaning of triple-click selection with the left mouse
832button. Instead of selecting a full line it will extend the selection to
833the end of the logical line only. option B<-tcw>.
778 834
779=item B<insecure:> I<boolean> 835=item B<insecure:> I<boolean>
780 836
781Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 837Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
782echo arbitrary strings like the icon name or the locale. This could be 838echo arbitrary strings like the icon name or the locale. This could be
812scrollback buffer and switching to/from the secondary screen will 868scrollback buffer and switching to/from the secondary screen will
813instead scroll the screen up. 869instead scroll the screen up.
814 870
815=item B<keysym.>I<sym>: I<string> 871=item B<keysym.>I<sym>: I<string>
816 872
817Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 873Compile I<frills>: Associate I<string> with keysym I<sym>. The
818contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 874intervening resource name B<keysym.> cannot be omitted.
819newline, \r: return, \t: 875
876The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
877any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
878B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
879and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
880B<2>, B<3>, B<4>, B<5>.
881
882The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
883whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
884keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
885current application keymap mode state.
886
887The spellings of I<key> can be obtained by using B<xev>(1) command or
888searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
889omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
890keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
891performed in an exact manner; however, the closest match is assured.
892
893I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
894C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
820tab, \000: octal number) or control characters (^?: delete, ^@: null, 895C<\000>: octal number) or verbatim control characters (C<^?>: delete,
821^A ...) and may enclosed with double quotes so that it can start or end 896C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
822with whitespace. The intervening resource name B<keysym.> cannot be 897can start or end with whitespace.
823omitted. This resource is only available when compiled with 898
824KEYSYM_RESOURCE. 899Please note that you need to double the C<\> when using
900C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
901use C<\033> instead of C<\e> (and so on), which will work with both Xt and
902@@RXVT_NAME@@'s own processing).
903
904You can define a range of keysyms in one shot by providing a I<string>
905with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
906should be a character not used by the strings.
907
908Its usage can be demonstrated by an example:
909
910 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
911
912The above line is equivalent to the following three lines:
913
914 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
915 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
916 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
917
918If I<string> takes the form of C<command:STRING>, the specified B<STRING>
919is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
920example the following means "change the current locale to C<zh_CN.GBK>
921when Control-Meta-c is being pressed":
922
923 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
924
925The following example will map Control-Meta-1 and Control-Meta-2 to
926the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
927font-switching at runtime:
928
929 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
930 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
931
932Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
933info):
934
935 URxvt.keysym.M-C-3: command:\033[8;25;80t
936 URxvt.keysym.M-C-4: command:\033[8;48;110t
825 937
826=back 938=back
827 939
828=head1 THE SCROLLBAR 940=head1 THE SCROLLBAR
829 941
843the normal text selection/insertion, hold either the Shift or the Meta 955the normal text selection/insertion, hold either the Shift or the Meta
844(Alt) key while performing the desired mouse action. 956(Alt) key while performing the desired mouse action.
845 957
846If mouse reporting mode is active, the normal scrollbar actions are 958If mouse reporting mode is active, the normal scrollbar actions are
847disabled -- on the assumption that we are using a fullscreen 959disabled -- on the assumption that we are using a fullscreen
848application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 960application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
849(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 961(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
850up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), 962up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
851respectively. 963respectively.
852 964
853=head1 TEXT SELECTION AND INSERTION 965=head1 TEXT SELECTION AND INSERTION
854 966
855The behaviour of text selection and insertion mechanism is similar to 967The behaviour of text selection and insertion mechanism is similar to
857 969
858=over 4 970=over 4
859 971
860=item B<Selection>: 972=item B<Selection>:
861 973
862Left click at the beginning of the region, drag to the end of the 974Left click at the beginning of the region, drag to the end of the region
863region and release; Right click to extend the marked region; Left 975and release; Right click to extend the marked region; Left double-click
864double-click to select a word; Left triple-click to select the entire 976to select a word; Left triple-click to select the entire logical line
865line. 977(which can span multiple screen lines), unless modified by resource
978B<tripleclickwords>.
866 979
867Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 980Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
868(Compile: frills) will create a rectangular selection instead of a normal 981(Compile: I<frills>) will create a rectangular selection instead of a normal
869one. 982one.
870 983
871=item B<Insertion>: 984=item B<Insertion>:
872 985
873Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 986Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
896C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1009C<--enable-frills>, the rest is available when rxvt-unicode was compiled
897with C<--enable-iso14755>. 1010with C<--enable-iso14755>.
898 1011
899=over 4 1012=over 4
900 1013
901=item 5.1: Basic method 1014=item * 5.1: Basic method
902 1015
903This allows you to enter unicode characters using their hexcode. 1016This allows you to enter unicode characters using their hexcode.
904 1017
905Start by pressing and holding both C<Control> and C<Shift>, then enter 1018Start by pressing and holding both C<Control> and C<Shift>, then enter
906hex-digits (between one and six). Releasing C<Control> and C<Shift> will 1019hex-digits (between one and six). Releasing C<Control> and C<Shift> will
913address, which you cannot type. Fortunately, the card has the e-mail 1026address, which you cannot type. Fortunately, the card has the e-mail
914address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily 1027address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
915by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>, 1028by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
916followed by releasing the modifier keys. 1029followed by releasing the modifier keys.
917 1030
918=item 5.2: Keyboard symbols entry method 1031=item * 5.2: Keyboard symbols entry method
919 1032
920This mode lets you input characters representing the keycap symbols of 1033This mode lets you input characters representing the keycap symbols of
921your keyboard, if representable in the current locale encoding. 1034your keyboard, if representable in the current locale encoding.
922 1035
923Start by pressing C<Control> and C<Shift> together, then releasing 1036Start by pressing C<Control> and C<Shift> together, then releasing
926keycap symbol. The symbol will only be entered when the key has been 1039keycap symbol. The symbol will only be entered when the key has been
927released, otherwise pressing e.g. C<Shift> would enter the symbol for 1040released, otherwise pressing e.g. C<Shift> would enter the symbol for
928C<ISO Level 2 Switch>, although your intention might have been to enter a 1041C<ISO Level 2 Switch>, although your intention might have been to enter a
929reverse tab (Shift-Tab). 1042reverse tab (Shift-Tab).
930 1043
931=item 5.3: Screen-selection entry method 1044=item * 5.3: Screen-selection entry method
932 1045
933While this is implemented already (it's basically the selection 1046While this is implemented already (it's basically the selection
934mechanism), it could be extended by displaying a unicode character map. 1047mechanism), it could be extended by displaying a unicode character map.
935 1048
936=item 5.4: Feedback method for identifying displayed characters for later input 1049=item * 5.4: Feedback method for identifying displayed characters for later input
937 1050
938This method lets you display the unicode character code associated with 1051This method lets you display the unicode character code associated with
939characters already displayed. 1052characters already displayed.
940 1053
941You enter this mode by holding down C<Control> and C<Shift> together, then 1054You enter this mode by holding down C<Control> and C<Shift> together, then
953With respect to conformance, rxvt-unicode is supposed to be compliant to 1066With respect to conformance, rxvt-unicode is supposed to be compliant to
954both scenario A and B of ISO 14755, including part 5.2. 1067both scenario A and B of ISO 14755, including part 5.2.
955 1068
956=head1 LOGIN STAMP 1069=head1 LOGIN STAMP
957 1070
958B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1071B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
959that it can be seen via the I<who(1)> command, and can accept messages. 1072it can be seen via the I<who(1)> command, and can accept messages. To
960To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on 1073allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
961some systems. 1074on some systems or setgid to root or to some other group on others.
962 1075
963=head1 COLORS AND GRAPHICS 1076=head1 COLORS AND GRAPHICS
964 1077
965In addition to the default foreground and background colours, 1078In addition to the default foreground and background colours,
966B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1079B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1009 1122
1010=back 1123=back
1011 1124
1012=head1 ENVIRONMENT 1125=head1 ENVIRONMENT
1013 1126
1014B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1127B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1015and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1128
1016window id number of the B<@@RXVT_NAME@@> window and it also uses and 1129=over 4
1017sets the environment variable B<DISPLAY> to specify which display 1130
1018terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1131=item B<TERM>
1019B<RXVTPATH> and B<PATH> to find XPM files. 1132
1133Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1134resources or on the commandline.
1135
1136=item B<COLORTERM>
1137
1138Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
1139compiled with XPM support, and optionally with the added extension
1140C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1141
1142=item B<COLORFGBG>
1143
1144Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1145the colour code used as default foreground/text colour (or the string
1146C<default> to indicate that the default-colour escape sequence is to be
1147used), C<bg> is the colour code used as default background colour (or the
1148string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1149was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1150(and do) use this information to optimize screen output.
1151
1152=item B<WINDOWID>
1153
1154Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1155window, which usually has subwindows for the scrollbar, the terminal
1156window and so on).
1157
1158=item B<TERMINFO>
1159
1160Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1161C<--with-terminfo=PATH>.
1162
1163=item B<DISPLAY>
1164
1165Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1166display in it's child processes.
1167
1168=item B<SHELL>
1169
1170The shell to be used for command execution, defaults to C</bin/sh>.
1171
1172=item B<RXVTPATH>
1173
1174The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1175files.
1176
1177=item B<PATH>
1178
1179Used in the same way as C<RXVTPATH>.
1180
1181=item B<RXVT_SOCKET>
1182
1183The unix domain socket path used by @@RXVT_NAME@@c(1) and
1184@@RXVT_NAME@@d(1).
1185
1186Default C<< $HOME/.rxvt-unicode-<nodename >>.
1187
1188=item B<HOME>
1189
1190Used to locate the default directory for the unix domain socket for
1191daemon communications and to locate various resource files (such as
1192C<.Xdefaults>)
1193
1194=item B<XAPPLRESDIR>
1195
1196Directory where various X resource files are being located.
1197
1198=item B<XENVIRONMENT>
1199
1200If set and accessible, gives the name of a X resource file to be loaded by
1201@@RXVT_NAME@@.
1202
1203=back
1020 1204
1021=head1 FILES 1205=head1 FILES
1022 1206
1023=over 4 1207=over 4
1024 1208
1025=item B</etc/utmp>
1026
1027System file for login records.
1028
1029=item B</usr/lib/X11/rgb.txt> 1209=item B</usr/lib/X11/rgb.txt>
1030 1210
1031Color names. 1211Color names.
1032 1212
1033=back 1213=back
1048 1228
1049=over 4 1229=over 4
1050 1230
1051=item Project Coordinator 1231=item Project Coordinator
1052 1232
1053@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1233Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1054 1234
1055=item Web page maintainter 1235L<http://software.schmorp.de/#rxvt-unicode>
1056
1057@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1058
1059L<@@RXVT_WEBPAGE@@>
1060 1236
1061=back 1237=back
1062 1238
1063=head1 AUTHORS 1239=head1 AUTHORS
1064 1240
1089=item Geoff Wing L<< <gcw@pobox.com> >> 1265=item Geoff Wing L<< <gcw@pobox.com> >>
1090 1266
1091Rewrote screen display and text selection routines. Project Coordinator 1267Rewrote screen display and text selection routines. Project Coordinator
1092(changes.txt 2.4.6 - rxvt-unicode) 1268(changes.txt 2.4.6 - rxvt-unicode)
1093 1269
1094=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1270=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1095 1271
1096Forked rxvt-unicode, rewrote most of the display code and internal 1272Forked rxvt-unicode, rewrote most of the display code and internal
1097character handling to store text in unicode, improve xterm 1273character handling to store text in unicode, improve xterm
1098compatibility and apply numerous other bugfixes and extensions. 1274compatibility and apply numerous other bugfixes and extensions.
1099 1275

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines