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.32 by root, Sat Oct 9 11:18:12 2004 UTC vs.
Revision 1.53 by root, Fri Feb 11 18:14:07 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>.
162=item B<-fn> I<fontlist> 164=item B<-fn> I<fontlist>
163 165
164Select the fonts to be used. This is a comma separated list of font names 166Select the fonts to be used. This is a comma separated list of font names
165that are used in turn when trying to display Unicode characters. The 167that are used in turn when trying to display Unicode characters. The
166first font defines the cell size for characters; other fonts might be 168first font defines the cell size for characters; other fonts might be
167smaller, but not (in general) larger. A reasonable default font list is 169smaller, but not (in general) larger. A (hopefully) reasonable default
168always appended to it. See resource B<font> for details. 170font list is always appended to it. See resource B<font> for more details.
171
172In short, to specify an X11 core font, just specify it's name or prefix it
173with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
174e.g.:
175
176 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
177 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
169 178
170See also the question "How does rxvt-unicode choose fonts?" in the FAQ 179See also the question "How does rxvt-unicode choose fonts?" in the FAQ
171section of @@RXVT_NAME@@(7). 180section of @@RXVT_NAME@@(7).
172 181
173=item B<-fb> I<fontlist> 182=item B<-fb> I<fontlist>
232=item B<-st>|B<+st> 241=item B<-st>|B<+st>
233 242
234Display normal (non XTerm/NeXT) scrollbar without/with a trough; 243Display normal (non XTerm/NeXT) scrollbar without/with a trough;
235resource B<scrollBar_floating>. 244resource B<scrollBar_floating>.
236 245
246=item B<-ptab>|B<+ptab>
247
248If enabled (default), "Horizontal Tab" characters are being stored as
249actual wide characters in the screen buffer, which makes it possible to
250select and paste them. Since a horizontal tab is a cursor movement and
251not an actual glyph, this can sometimes be visually annoying as the cursor
252on a tab character is displayed as a wide cursor; resource B<pastableTabs>.
253
237=item B<-bc>|B<+bc> 254=item B<-bc>|B<+bc>
238 255
239Blink the cursor; resource B<cursorBlink>. 256Blink the cursor; resource B<cursorBlink>.
240 257
241=item B<-iconic> 258=item B<-iconic>
265if 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
266decorations; resource B<borderLess>. 283decorations; resource B<borderLess>.
267 284
268=item B<-lsp> I<number> 285=item B<-lsp> I<number>
269 286
270Compile I<linespace>: Lines (pixel height) to insert between each row 287Compile I<frills>: Lines (pixel height) to insert between each row of
271of the display; resource B<linespace>. 288the display. Useful to work around font rendering problems; resource
289B<linespace>.
272 290
273=item B<-tn> I<termname> 291=item B<-tn> I<termname>
274 292
275This 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
276B<TERM> environment variable. This terminal type must exist in the 294B<TERM> environment variable. This terminal type must exist in the
312 330
313Compile I<XIM>: input method name. resource B<inputMethod>. 331Compile I<XIM>: input method name. resource B<inputMethod>.
314 332
315=item B<-imlocale> I<string> 333=item B<-imlocale> I<string>
316 334
317The 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.
318de_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
319extension to be able to input japanese characters while staying in 337input extension to be able to input japanese characters while staying in
320another 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>.
321 350
322=item B<-insecure> 351=item B<-insecure>
323 352
324Enable "insecure" mode, which currently enables most of the escape 353Enable "insecure" mode, which currently enables most of the escape
325sequences that echo strings. See the resource B<insecure> for more 354sequences that echo strings. See the resource B<insecure> for more
338 367
339=item B<-ssr>|B<+ssr> 368=item B<-ssr>|B<+ssr>
340 369
341Turn on/off secondary screen scroll (default enabled); resource 370Turn on/off secondary screen scroll (default enabled); resource
342B<secondaryScroll>. 371B<secondaryScroll>.
372
373=item B<-keysym.>I<sym>: I<string>
374
375Remap a key symbol. See resource B<keysym>.
343 376
344=item B<-xrm> I<resourcestring> 377=item B<-xrm> I<resourcestring>
345 378
346No effect on rxvt-unicode. Simply passes through an argument to be made 379No effect on rxvt-unicode. Simply passes through an argument to be made
347available in the instance's argument list. Appears in I<WM_COMMAND> in 380available in the instance's argument list. Appears in I<WM_COMMAND> in
356 389
357There are two different methods that @@RXVT_NAME@@ can use to get the 390There are two different methods that @@RXVT_NAME@@ can use to get the
358Xresource data: using the X libraries (Xrm*-functions) or internal 391Xresource data: using the X libraries (Xrm*-functions) or internal
359Xresources reader (B<~/.Xdefaults>). For the first method (ie. 392Xresources reader (B<~/.Xdefaults>). For the first method (ie.
360B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 393B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
361resources using X11 tools like B<xset>. Many distribution do also load 394resources using X11 tools like B<xrdb>. Many distribution do also load
362settings from the B<~/.Xresources> file when X starts. 395settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
396will consult the following files/resources in order, with later settings
397overwriting earlier ones:
398
399 1. system-wide app-defaults file, either locale-dependent OR global
400 2. app-defaults file in $XAPPLRESDIR
401 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
402 4. SCREEN_RESOURCES for the current screen
403 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
363 404
364If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 405If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
365lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 406lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
366set in XAPPLOADDIR/URxvt (compile-time defined: usually 407set in XAPPLOADDIR/URxvt (compile-time defined: usually
367B</usr/lib/X11/app-defaults/URxvt>) and resources set in 408B</usr/lib/X11/app-defaults/URxvt>) and resources set in
412 453
413=item B<colorIT:> I<colour> 454=item B<colorIT:> I<colour>
414 455
415Use the specified colour to display bold or italic characters when the 456Use the specified colour to display bold or italic characters when the
416foreground colour is the default. If font styles are not available 457foreground colour is the default. If font styles are not available
417(Compile styles) and this option is unset, reverse video is used instead. 458(Compile I<styles>) and this option is unset, reverse video is used instead.
418 459
419=item B<colorUL:> I<colour> 460=item B<colorUL:> I<colour>
420 461
421Use the specified colour to display underlined characters when the 462Use the specified colour to display underlined characters when the
422foreground colour is the default. 463foreground colour is the default.
423 464
424=item B<colorRV:> I<colour> 465=item B<colorRV:> I<colour>
425 466
426Use the specified colour as the background for reverse video 467Use the specified colour as the background for reverse video
427characters. 468characters.
469
470=item B<underlineColor:> I<colour>
471
472If set, use the specified colour as the colour for the underline
473itself. If unset, use the foreground colour.
428 474
429=item B<cursorColor:> I<colour> 475=item B<cursorColor:> I<colour>
430 476
431Use the specified colour for the cursor. The default is to use the 477Use the specified colour for the cursor. The default is to use the
432foreground colour; option B<-cr>. 478foreground colour; option B<-cr>.
513The first font defines the cell size for characters; other fonts might 559The first font defines the cell size for characters; other fonts might
514be smaller, but not larger. A reasonable default font list is always 560be smaller, but not larger. A reasonable default font list is always
515appended to it. option B<-fn>. 561appended to it. option B<-fn>.
516 562
517Each font can either be a standard X11 core font (XLFD) name, with 563Each font can either be a standard X11 core font (XLFD) name, with
518optional prefix C<x:> or a Xft font (Compile xft), prefixed with C<xft:>. 564optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
519 565
520In addition, each font can be prefixed with additional hints and 566In addition, each font can be prefixed with additional hints and
521specifications enclosed in square brackets (C<[]>). The only available 567specifications enclosed in square brackets (C<[]>). The only available
522hint currently is C<codeset=codeset-name>, and this is only used for Xft 568hint currently is C<codeset=codeset-name>, and this is only used for Xft
523fonts. 569fonts.
533specifies five fonts to be used. The first one is C<9x15bold> (actually 579specifies five fonts to be used. The first one is C<9x15bold> (actually
534the iso8859-1 version of the second font), which is the base font (because 580the iso8859-1 version of the second font), which is the base font (because
535it is named first) and thus defines the character cell grid to be 9 pixels 581it is named first) and thus defines the character cell grid to be 9 pixels
536wide and 15 pixels high. 582wide and 15 pixels high.
537 583
538the second font is just used to add additional unicode characters not in 584The second font is just used to add additional unicode characters not in
539the base font, likewise the third, which is unfortunately non-bold, but 585the base font, likewise the third, which is unfortunately non-bold, but
540the bold version of the font does contain less characters, so this is a 586the bold version of the font does contain less characters, so this is a
541useful supplement. 587useful supplement.
542 588
543The third font is an Xft font with aliasing turned off, and the characters 589The third font is an Xft font with aliasing turned off, and the characters
696=item B<mouseWheelScrollPage:> I<boolean> 742=item B<mouseWheelScrollPage:> I<boolean>
697 743
698B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel 744B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
699scrolls five lines [default]. 745scrolls five lines [default].
700 746
747=item B<pastableTabs:> I<boolean>
748
749B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
750movement only; option C<-ptab>.
751
701=item B<cursorBlink:> I<boolean> 752=item B<cursorBlink:> I<boolean>
702 753
703B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 754B<True>: blink the cursor. B<False>: do not blink the cursor [default];
704option B<-bc>. 755option B<-bc>.
705 756
749 800
750I<name> of inputMethod to use; option B<-im>. 801I<name> of inputMethod to use; option B<-im>.
751 802
752=item B<imLocale:> I<name> 803=item B<imLocale:> I<name>
753 804
754The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 805The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
755de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 806C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
756extension to be able to input japanese characters while staying in 807input extension to be able to input japanese characters while staying in
757another locale. option B<-imlocale>. 808another locale. option B<-imlocale>.
809
810=item B<imFont:> I<fontset>
811
812Specify the font-set used for XIM styles C<OverTheSpot> or
813C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
814by commas), i.e. it's not in the same format as the other font lists used
815in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
816found, preferably one or two pixels differing in size to the base font.
817option B<-imfont>.
818
819=item B<tripleclickwords:> I<boolean>
820
821Change the meaning of triple-click selection with the left mouse
822button. Instead of selecting a full line it will extend the selection to
823the end of the logical line only. option B<-tcw>.
758 824
759=item B<insecure:> I<boolean> 825=item B<insecure:> I<boolean>
760 826
761Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 827Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
762echo arbitrary strings like the icon name or the locale. This could be 828echo arbitrary strings like the icon name or the locale. This could be
792scrollback buffer and switching to/from the secondary screen will 858scrollback buffer and switching to/from the secondary screen will
793instead scroll the screen up. 859instead scroll the screen up.
794 860
795=item B<keysym.>I<sym>: I<string> 861=item B<keysym.>I<sym>: I<string>
796 862
797Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 863Compile I<frills>: Associate I<string> with keysym I<sym>. The
798contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 864intervening resource name B<keysym.> cannot be omitted.
799newline, \r: return, \t: 865
866The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
867any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
868B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
869and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
870B<2>, B<3>, B<4>, B<5>.
871
872The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
873whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
874keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
875current application keymap mode state.
876
877The spellings of I<key> can be obtained by using B<xev>(1) command or
878searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
879omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
880keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
881performed in an exact manner; however, the closest match is assured.
882
883I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
884C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
800tab, \000: octal number) or control characters (^?: delete, ^@: null, 885C<\000>: octal number) or verbatim control characters (C<^?>: delete,
801^A ...) and may enclosed with double quotes so that it can start or end 886C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
802with whitespace. The intervening resource name B<keysym.> cannot be 887can start or end with whitespace.
803omitted. This resource is only available when compiled with 888
804KEYSYM_RESOURCE. 889Please note that you need to double the C<\> when using
890C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
891use C<\033> instead of C<\e> (and so on), which will work with both Xt and
892@@RXVT_NAME@@'s own processing).
893
894You can define a range of keysyms in one shot by providing a I<string>
895with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
896should be a character not used by the strings.
897
898Its usage can be demonstrated by an example:
899
900 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
901
902The above line is equivalent to the following three lines:
903
904 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
905 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
906 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
907
908If I<string> takes the form of C<command:STRING>, the specified B<STRING>
909is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
910example the following means "change the current locale to C<zh_CN.GBK>
911when Control-Meta-c is being pressed":
912
913 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
914
915The following example will map Control-Meta-1 and Control-Meta-2 to
916the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
917font-switching at runtime:
918
919 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
920 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
921
922Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
923info):
924
925 URxvt.keysym.M-C-3: command:\033[8;25;80t
926 URxvt.keysym.M-C-4: command:\033[8;48;110t
805 927
806=back 928=back
807 929
808=head1 THE SCROLLBAR 930=head1 THE SCROLLBAR
809 931
823the normal text selection/insertion, hold either the Shift or the Meta 945the normal text selection/insertion, hold either the Shift or the Meta
824(Alt) key while performing the desired mouse action. 946(Alt) key while performing the desired mouse action.
825 947
826If mouse reporting mode is active, the normal scrollbar actions are 948If mouse reporting mode is active, the normal scrollbar actions are
827disabled -- on the assumption that we are using a fullscreen 949disabled -- on the assumption that we are using a fullscreen
828application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 950application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
829(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 951(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
830up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), 952up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
831respectively. 953respectively.
832 954
833=head1 TEXT SELECTION AND INSERTION 955=head1 TEXT SELECTION AND INSERTION
834 956
835The behaviour of text selection and insertion mechanism is similar to 957The behaviour of text selection and insertion mechanism is similar to
837 959
838=over 4 960=over 4
839 961
840=item B<Selection>: 962=item B<Selection>:
841 963
842Left click at the beginning of the region, drag to the end of the 964Left click at the beginning of the region, drag to the end of the region
843region and release; Right click to extend the marked region; Left 965and release; Right click to extend the marked region; Left double-click
844double-click to select a word; Left triple-click to select the entire 966to select a word; Left triple-click to select the entire logical line
845line. 967(which can span multiple screen lines), unless modified by resource
968B<tripleclickwords>.
846 969
847Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 970Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
848(Compile: frills) will create a rectangular selection instead of a normal 971(Compile: I<frills>) will create a rectangular selection instead of a normal
849one. 972one.
850 973
851=item B<Insertion>: 974=item B<Insertion>:
852 975
853Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 976Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
876C<--enable-frills>, the rest is available when rxvt-unicode was compiled 999C<--enable-frills>, the rest is available when rxvt-unicode was compiled
877with C<--enable-iso14755>. 1000with C<--enable-iso14755>.
878 1001
879=over 4 1002=over 4
880 1003
881=item 5.1: Basic method 1004=item * 5.1: Basic method
882 1005
883This allows you to enter unicode characters using their hexcode. 1006This allows you to enter unicode characters using their hexcode.
884 1007
885Start by pressing and holding both C<Control> and C<Shift>, then enter 1008Start by pressing and holding both C<Control> and C<Shift>, then enter
886hex-digits (between one and six). Releasing C<Control> and C<Shift> will 1009hex-digits (between one and six). Releasing C<Control> and C<Shift> will
893address, which you cannot type. Fortunately, the card has the e-mail 1016address, which you cannot type. Fortunately, the card has the e-mail
894address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily 1017address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
895by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>, 1018by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
896followed by releasing the modifier keys. 1019followed by releasing the modifier keys.
897 1020
898=item 5.2: Keyboard symbols entry method 1021=item * 5.2: Keyboard symbols entry method
899 1022
900This mode lets you input characters representing the keycap symbols of 1023This mode lets you input characters representing the keycap symbols of
901your keyboard, if representable in the current locale encoding. 1024your keyboard, if representable in the current locale encoding.
902 1025
903Start by pressing C<Control> and C<Shift> together, then releasing 1026Start by pressing C<Control> and C<Shift> together, then releasing
906keycap symbol. The symbol will only be entered when the key has been 1029keycap symbol. The symbol will only be entered when the key has been
907released, otherwise pressing e.g. C<Shift> would enter the symbol for 1030released, otherwise pressing e.g. C<Shift> would enter the symbol for
908C<ISO Level 2 Switch>, although your intention might have been to enter a 1031C<ISO Level 2 Switch>, although your intention might have been to enter a
909reverse tab (Shift-Tab). 1032reverse tab (Shift-Tab).
910 1033
911=item 5.3: Screen-selection entry method 1034=item * 5.3: Screen-selection entry method
912 1035
913While this is implemented already (it's basically the selection 1036While this is implemented already (it's basically the selection
914mechanism), it could be extended by displaying a unicode character map. 1037mechanism), it could be extended by displaying a unicode character map.
915 1038
916=item 5.4: Feedback method for identifying displayed characters for later input 1039=item * 5.4: Feedback method for identifying displayed characters for later input
917 1040
918This method lets you display the unicode character code associated with 1041This method lets you display the unicode character code associated with
919characters already displayed. 1042characters already displayed.
920 1043
921You enter this mode by holding down C<Control> and C<Shift> together, then 1044You enter this mode by holding down C<Control> and C<Shift> together, then
933With respect to conformance, rxvt-unicode is supposed to be compliant to 1056With respect to conformance, rxvt-unicode is supposed to be compliant to
934both scenario A and B of ISO 14755, including part 5.2. 1057both scenario A and B of ISO 14755, including part 5.2.
935 1058
936=head1 LOGIN STAMP 1059=head1 LOGIN STAMP
937 1060
938B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1061B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
939that it can be seen via the I<who(1)> command, and can accept messages. 1062it can be seen via the I<who(1)> command, and can accept messages. To
940To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on 1063allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
941some systems. 1064on some systems or setgid to root or to some other group on others.
942 1065
943=head1 COLORS AND GRAPHICS 1066=head1 COLORS AND GRAPHICS
944 1067
945In addition to the default foreground and background colours, 1068In addition to the default foreground and background colours,
946B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1069B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
989 1112
990=back 1113=back
991 1114
992=head1 ENVIRONMENT 1115=head1 ENVIRONMENT
993 1116
994B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1117B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
995and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1118
996window id number of the B<@@RXVT_NAME@@> window and it also uses and 1119=over 4
997sets the environment variable B<DISPLAY> to specify which display 1120
998terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1121=item B<TERM>
999B<RXVTPATH> and B<PATH> to find XPM files. 1122
1123Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1124resources or on the commandline.
1125
1126=item B<COLORTERM>
1127
1128Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
1129compiled with XPM support, and optionally with the added extension
1130C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1131
1132=item B<COLORFGBG>
1133
1134Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1135the colour code used as default foreground/text colour (or the string
1136C<default> to indicate that the default-colour escape sequence is to be
1137used), C<bg> is the colour code used as default background colour (or the
1138string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1139was compiled with XPM support. Libraries like C<slang> can (and do) use
1140this information to optimize screen output.
1141
1142=item B<WINDOWID>
1143
1144Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1145window, which usually has subwindows for the scrollbar, the terminal
1146window and so on).
1147
1148=item B<TERMINFO>
1149
1150Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1151C<--with-terminfo=PATH>.
1152
1153=item B<DISPLAY>
1154
1155Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1156display in it's child processes.
1157
1158=item B<SHELL>
1159
1160The shell to be used for command execution, defaults to C</bin/sh>.
1161
1162=item B<RXVTPATH>
1163
1164The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1165files.
1166
1167=item B<PATH>
1168
1169Used in the same way as C<RXVTPATH>.
1170
1171=item B<RXVT_SOCKET>
1172
1173The unix domain socket path used by @@RXVT_NAME@@c(1) and
1174@@RXVT_NAME@@d(1).
1175
1176Default C<< $HOME/.rxvt-unicode-<nodename >>.
1177
1178=item B<HOME>
1179
1180Used to locate the default directory for the unix domain socket for
1181daemon communications and to locate various resource files (such as
1182C<.Xdefaults>)
1183
1184=item B<XAPPLRESDIR>
1185
1186Directory where various X resource files are being located.
1187
1188=item B<XENVIRONMENT>
1189
1190If set and accessible, gives the name of a X resource file to be loaded by
1191@@RXVT_NAME@@.
1192
1193=back
1000 1194
1001=head1 FILES 1195=head1 FILES
1002 1196
1003=over 4 1197=over 4
1004 1198
1005=item B</etc/utmp>
1006
1007System file for login records.
1008
1009=item B</usr/lib/X11/rgb.txt> 1199=item B</usr/lib/X11/rgb.txt>
1010 1200
1011Color names. 1201Color names.
1012 1202
1013=back 1203=back
1029=over 4 1219=over 4
1030 1220
1031=item Project Coordinator 1221=item Project Coordinator
1032 1222
1033@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1223@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@>
1034
1035=item Web page maintainter
1036
1037@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1038 1224
1039L<@@RXVT_WEBPAGE@@> 1225L<@@RXVT_WEBPAGE@@>
1040 1226
1041=back 1227=back
1042 1228

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines