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.61 by root, Sat Feb 19 01:07:57 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
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" }
364 429
365=back 430=back
366 431
367=head1 RESOURCES (available also as long-options) 432=head1 RESOURCES (available also as long-options)
368 433
371 436
372There 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
373Xresource data: using the X libraries (Xrm*-functions) or internal 438Xresource data: using the X libraries (Xrm*-functions) or internal
374Xresources reader (B<~/.Xdefaults>). For the first method (ie. 439Xresources reader (B<~/.Xdefaults>). For the first method (ie.
375B<@@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
376resources using X11 tools like B<xset>. Many distribution do also load 441resources using X11 tools like B<xrdb>. Many distribution do also load
377settings 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>
378 451
379If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 452If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
380lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 453lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
381set in XAPPLOADDIR/URxvt (compile-time defined: usually 454set in XAPPLOADDIR/URxvt (compile-time defined: usually
382B</usr/lib/X11/app-defaults/URxvt>) and resources set in 455B</usr/lib/X11/app-defaults/URxvt>) and resources set in
427 500
428=item B<colorIT:> I<colour> 501=item B<colorIT:> I<colour>
429 502
430Use the specified colour to display bold or italic characters when the 503Use the specified colour to display bold or italic characters when the
431foreground colour is the default. If font styles are not available 504foreground colour is the default. If font styles are not available
432(Compile styles) and this option is unset, reverse video is used instead. 505(Compile I<styles>) and this option is unset, reverse video is used instead.
433 506
434=item B<colorUL:> I<colour> 507=item B<colorUL:> I<colour>
435 508
436Use the specified colour to display underlined characters when the 509Use the specified colour to display underlined characters when the
437foreground colour is the default. 510foreground colour is the default.
438 511
439=item B<colorRV:> I<colour> 512=item B<colorRV:> I<colour>
440 513
441Use the specified colour as the background for reverse video 514Use the specified colour as the background for reverse video
442characters. 515characters.
516
517=item B<underlineColor:> I<colour>
518
519If set, use the specified colour as the colour for the underline
520itself. If unset, use the foreground colour.
443 521
444=item B<cursorColor:> I<colour> 522=item B<cursorColor:> I<colour>
445 523
446Use the specified colour for the cursor. The default is to use the 524Use the specified colour for the cursor. The default is to use the
447foreground colour; option B<-cr>. 525foreground colour; option B<-cr>.
528The first font defines the cell size for characters; other fonts might 606The first font defines the cell size for characters; other fonts might
529be smaller, but not larger. A reasonable default font list is always 607be smaller, but not larger. A reasonable default font list is always
530appended to it. option B<-fn>. 608appended to it. option B<-fn>.
531 609
532Each font can either be a standard X11 core font (XLFD) name, with 610Each 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:>. 611optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
534 612
535In addition, each font can be prefixed with additional hints and 613In addition, each font can be prefixed with additional hints and
536specifications enclosed in square brackets (C<[]>). The only available 614specifications enclosed in square brackets (C<[]>). The only available
537hint currently is C<codeset=codeset-name>, and this is only used for Xft 615hint currently is C<codeset=codeset-name>, and this is only used for Xft
538fonts. 616fonts.
661B<+si>. 739B<+si>.
662 740
663=item B<scrollWithBuffer:> I<boolean> 741=item B<scrollWithBuffer:> I<boolean>
664 742
665B<True>: scroll with scrollback buffer when tty receives new lines (and 743B<True>: scroll with scrollback buffer when tty receives new lines (and
666B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 744B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
667with scrollback buffer when tty recieves new lines; option B<-sw>. 745with scrollback buffer when tty recieves new lines; option B<+sw>.
668 746
669=item B<scrollTtyKeypress:> I<boolean> 747=item B<scrollTtyKeypress:> I<boolean>
670 748
671B<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
672are those which are intercepted by rxvt-unicode for special handling and 750are those which are intercepted by rxvt-unicode for special handling and
769 847
770I<name> of inputMethod to use; option B<-im>. 848I<name> of inputMethod to use; option B<-im>.
771 849
772=item B<imLocale:> I<name> 850=item B<imLocale:> I<name>
773 851
774The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 852The 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 853C<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 854input extension to be able to input japanese characters while staying in
777another locale. option B<-imlocale>. 855another locale. option B<-imlocale>.
856
857=item B<imFont:> I<fontset>
858
859Specify the font-set used for XIM styles C<OverTheSpot> or
860C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
861by commas), i.e. it's not in the same format as the other font lists used
862in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
863found, preferably one or two pixels differing in size to the base font.
864option B<-imfont>.
865
866=item B<tripleclickwords:> I<boolean>
867
868Change the meaning of triple-click selection with the left mouse
869button. Instead of selecting a full line it will extend the selection to
870the end of the logical line only. option B<-tcw>.
778 871
779=item B<insecure:> I<boolean> 872=item B<insecure:> I<boolean>
780 873
781Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 874Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
782echo arbitrary strings like the icon name or the locale. This could be 875echo arbitrary strings like the icon name or the locale. This could be
812scrollback buffer and switching to/from the secondary screen will 905scrollback buffer and switching to/from the secondary screen will
813instead scroll the screen up. 906instead scroll the screen up.
814 907
815=item B<keysym.>I<sym>: I<string> 908=item B<keysym.>I<sym>: I<string>
816 909
817Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 910Compile I<frills>: Associate I<string> with keysym I<sym>. The
818contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 911intervening resource name B<keysym.> cannot be omitted.
819newline, \r: return, \t: 912
913The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
914any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
915B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
916and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
917B<2>, B<3>, B<4>, B<5>.
918
919The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
920whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
921keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
922current application keymap mode state.
923
924The spellings of I<key> can be obtained by using B<xev>(1) command or
925searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
926omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
927keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
928performed in an exact manner; however, the closest match is assured.
929
930I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
931C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
820tab, \000: octal number) or control characters (^?: delete, ^@: null, 932C<\000>: octal number) or verbatim control characters (C<^?>: delete,
821^A ...) and may enclosed with double quotes so that it can start or end 933C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
822with whitespace. The intervening resource name B<keysym.> cannot be 934can start or end with whitespace.
823omitted. This resource is only available when compiled with 935
824KEYSYM_RESOURCE. 936Please note that you need to double the C<\> when using
937C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
938use C<\033> instead of C<\e> (and so on), which will work with both Xt and
939@@RXVT_NAME@@'s own processing).
940
941You can define a range of keysyms in one shot by providing a I<string>
942with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
943should be a character not used by the strings.
944
945Its usage can be demonstrated by an example:
946
947 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
948
949The above line is equivalent to the following three lines:
950
951 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
952 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
953 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
954
955If I<string> takes the form of C<command:STRING>, the specified B<STRING>
956is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
957example the following means "change the current locale to C<zh_CN.GBK>
958when Control-Meta-c is being pressed":
959
960 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
961
962The following example will map Control-Meta-1 and Control-Meta-2 to
963the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
964font-switching at runtime:
965
966 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
967 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
968
969Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
970info):
971
972 URxvt.keysym.M-C-3: command:\033[8;25;80t
973 URxvt.keysym.M-C-4: command:\033[8;48;110t
825 974
826=back 975=back
827 976
828=head1 THE SCROLLBAR 977=head1 THE SCROLLBAR
829 978
843the normal text selection/insertion, hold either the Shift or the Meta 992the normal text selection/insertion, hold either the Shift or the Meta
844(Alt) key while performing the desired mouse action. 993(Alt) key while performing the desired mouse action.
845 994
846If mouse reporting mode is active, the normal scrollbar actions are 995If mouse reporting mode is active, the normal scrollbar actions are
847disabled -- on the assumption that we are using a fullscreen 996disabled -- on the assumption that we are using a fullscreen
848application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 997application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
849(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 998(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), 999up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
851respectively. 1000respectively.
852 1001
853=head1 TEXT SELECTION AND INSERTION 1002=head1 TEXT SELECTION AND INSERTION
854 1003
855The behaviour of text selection and insertion mechanism is similar to 1004The behaviour of text selection and insertion mechanism is similar to
857 1006
858=over 4 1007=over 4
859 1008
860=item B<Selection>: 1009=item B<Selection>:
861 1010
862Left click at the beginning of the region, drag to the end of the 1011Left 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 1012and release; Right click to extend the marked region; Left double-click
864double-click to select a word; Left triple-click to select the entire 1013to select a word; Left triple-click to select the entire logical line
865line. 1014(which can span multiple screen lines), unless modified by resource
1015B<tripleclickwords>.
866 1016
867Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1017Starting 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 1018(Compile: I<frills>) will create a rectangular selection instead of a normal
869one. 1019one.
870 1020
871=item B<Insertion>: 1021=item B<Insertion>:
872 1022
873Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1023Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
896C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1046C<--enable-frills>, the rest is available when rxvt-unicode was compiled
897with C<--enable-iso14755>. 1047with C<--enable-iso14755>.
898 1048
899=over 4 1049=over 4
900 1050
901=item 5.1: Basic method 1051=item * 5.1: Basic method
902 1052
903This allows you to enter unicode characters using their hexcode. 1053This allows you to enter unicode characters using their hexcode.
904 1054
905Start by pressing and holding both C<Control> and C<Shift>, then enter 1055Start 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 1056hex-digits (between one and six). Releasing C<Control> and C<Shift> will
913address, which you cannot type. Fortunately, the card has the e-mail 1063address, 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 1064address 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>, 1065by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
916followed by releasing the modifier keys. 1066followed by releasing the modifier keys.
917 1067
918=item 5.2: Keyboard symbols entry method 1068=item * 5.2: Keyboard symbols entry method
919 1069
920This mode lets you input characters representing the keycap symbols of 1070This mode lets you input characters representing the keycap symbols of
921your keyboard, if representable in the current locale encoding. 1071your keyboard, if representable in the current locale encoding.
922 1072
923Start by pressing C<Control> and C<Shift> together, then releasing 1073Start by pressing C<Control> and C<Shift> together, then releasing
926keycap symbol. The symbol will only be entered when the key has been 1076keycap symbol. The symbol will only be entered when the key has been
927released, otherwise pressing e.g. C<Shift> would enter the symbol for 1077released, 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 1078C<ISO Level 2 Switch>, although your intention might have been to enter a
929reverse tab (Shift-Tab). 1079reverse tab (Shift-Tab).
930 1080
931=item 5.3: Screen-selection entry method 1081=item * 5.3: Screen-selection entry method
932 1082
933While this is implemented already (it's basically the selection 1083While this is implemented already (it's basically the selection
934mechanism), it could be extended by displaying a unicode character map. 1084mechanism), it could be extended by displaying a unicode character map.
935 1085
936=item 5.4: Feedback method for identifying displayed characters for later input 1086=item * 5.4: Feedback method for identifying displayed characters for later input
937 1087
938This method lets you display the unicode character code associated with 1088This method lets you display the unicode character code associated with
939characters already displayed. 1089characters already displayed.
940 1090
941You enter this mode by holding down C<Control> and C<Shift> together, then 1091You 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 1103With respect to conformance, rxvt-unicode is supposed to be compliant to
954both scenario A and B of ISO 14755, including part 5.2. 1104both scenario A and B of ISO 14755, including part 5.2.
955 1105
956=head1 LOGIN STAMP 1106=head1 LOGIN STAMP
957 1107
958B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1108B<@@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. 1109it 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 1110allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
961some systems. 1111on some systems or setgid to root or to some other group on others.
962 1112
963=head1 COLORS AND GRAPHICS 1113=head1 COLORS AND GRAPHICS
964 1114
965In addition to the default foreground and background colours, 1115In addition to the default foreground and background colours,
966B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1116B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1009 1159
1010=back 1160=back
1011 1161
1012=head1 ENVIRONMENT 1162=head1 ENVIRONMENT
1013 1163
1014B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1164B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1015and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1165
1016window id number of the B<@@RXVT_NAME@@> window and it also uses and 1166=over 4
1017sets the environment variable B<DISPLAY> to specify which display 1167
1018terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1168=item B<TERM>
1019B<RXVTPATH> and B<PATH> to find XPM files. 1169
1170Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1171resources or on the commandline.
1172
1173=item B<COLORTERM>
1174
1175Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
1176compiled with XPM support, and optionally with the added extension
1177C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1178
1179=item B<COLORFGBG>
1180
1181Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1182the colour code used as default foreground/text colour (or the string
1183C<default> to indicate that the default-colour escape sequence is to be
1184used), C<bg> is the colour code used as default background colour (or the
1185string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1186was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1187(and do) use this information to optimize screen output.
1188
1189=item B<WINDOWID>
1190
1191Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1192window, which usually has subwindows for the scrollbar, the terminal
1193window and so on).
1194
1195=item B<TERMINFO>
1196
1197Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1198C<--with-terminfo=PATH>.
1199
1200=item B<DISPLAY>
1201
1202Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1203display in it's child processes.
1204
1205=item B<SHELL>
1206
1207The shell to be used for command execution, defaults to C</bin/sh>.
1208
1209=item B<RXVTPATH>
1210
1211The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1212files.
1213
1214=item B<PATH>
1215
1216Used in the same way as C<RXVTPATH>.
1217
1218=item B<RXVT_SOCKET>
1219
1220The unix domain socket path used by @@RXVT_NAME@@c(1) and
1221@@RXVT_NAME@@d(1).
1222
1223Default C<< $HOME/.rxvt-unicode-<nodename >>.
1224
1225=item B<HOME>
1226
1227Used to locate the default directory for the unix domain socket for
1228daemon communications and to locate various resource files (such as
1229C<.Xdefaults>)
1230
1231=item B<XAPPLRESDIR>
1232
1233Directory where various X resource files are being located.
1234
1235=item B<XENVIRONMENT>
1236
1237If set and accessible, gives the name of a X resource file to be loaded by
1238@@RXVT_NAME@@.
1239
1240=back
1020 1241
1021=head1 FILES 1242=head1 FILES
1022 1243
1023=over 4 1244=over 4
1024 1245
1025=item B</etc/utmp>
1026
1027System file for login records.
1028
1029=item B</usr/lib/X11/rgb.txt> 1246=item B</usr/lib/X11/rgb.txt>
1030 1247
1031Color names. 1248Color names.
1032 1249
1033=back 1250=back
1048 1265
1049=over 4 1266=over 4
1050 1267
1051=item Project Coordinator 1268=item Project Coordinator
1052 1269
1053@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1270Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1054 1271
1055=item Web page maintainter 1272L<http://software.schmorp.de/#rxvt-unicode>
1056
1057@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1058
1059L<@@RXVT_WEBPAGE@@>
1060 1273
1061=back 1274=back
1062 1275
1063=head1 AUTHORS 1276=head1 AUTHORS
1064 1277
1089=item Geoff Wing L<< <gcw@pobox.com> >> 1302=item Geoff Wing L<< <gcw@pobox.com> >>
1090 1303
1091Rewrote screen display and text selection routines. Project Coordinator 1304Rewrote screen display and text selection routines. Project Coordinator
1092(changes.txt 2.4.6 - rxvt-unicode) 1305(changes.txt 2.4.6 - rxvt-unicode)
1093 1306
1094=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1307=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1095 1308
1096Forked rxvt-unicode, rewrote most of the display code and internal 1309Forked rxvt-unicode, rewrote most of the display code and internal
1097character handling to store text in unicode, improve xterm 1310character handling to store text in unicode, improve xterm
1098compatibility and apply numerous other bugfixes and extensions. 1311compatibility and apply numerous other bugfixes and extensions.
1099 1312

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines