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.58 by root, Wed Feb 16 21:49:36 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
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>.
343 372
344=item B<-xrm> I<resourcestring> 373=item B<-keysym.>I<sym>: I<string>
345 374
346No effect on rxvt-unicode. Simply passes through an argument to be made 375Remap a key symbol. See resource B<keysym>.
347available in the instance's argument list. Appears in I<WM_COMMAND> in 376
348some 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.
349 394
350=back 395=back
351 396
352=head1 RESOURCES (available also as long-options) 397=head1 RESOURCES (available also as long-options)
353 398
356 401
357There are two different methods that @@RXVT_NAME@@ can use to get the 402There are two different methods that @@RXVT_NAME@@ can use to get the
358Xresource data: using the X libraries (Xrm*-functions) or internal 403Xresource data: using the X libraries (Xrm*-functions) or internal
359Xresources reader (B<~/.Xdefaults>). For the first method (ie. 404Xresources reader (B<~/.Xdefaults>). For the first method (ie.
360B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 405B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
361resources using X11 tools like B<xset>. Many distribution do also load 406resources using X11 tools like B<xrdb>. Many distribution do also load
362settings from the B<~/.Xresources> file when X starts. 407settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
408will consult the following files/resources in order, with later settings
409overwriting earlier ones:
410
411 1. system-wide app-defaults file, either locale-dependent OR global
412 2. app-defaults file in $XAPPLRESDIR
413 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
414 4. SCREEN_RESOURCES for the current screen
415 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
363 416
364If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 417If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
365lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 418lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
366set in XAPPLOADDIR/URxvt (compile-time defined: usually 419set in XAPPLOADDIR/URxvt (compile-time defined: usually
367B</usr/lib/X11/app-defaults/URxvt>) and resources set in 420B</usr/lib/X11/app-defaults/URxvt>) and resources set in
412 465
413=item B<colorIT:> I<colour> 466=item B<colorIT:> I<colour>
414 467
415Use the specified colour to display bold or italic characters when the 468Use the specified colour to display bold or italic characters when the
416foreground colour is the default. If font styles are not available 469foreground colour is the default. If font styles are not available
417(Compile styles) and this option is unset, reverse video is used instead. 470(Compile I<styles>) and this option is unset, reverse video is used instead.
418 471
419=item B<colorUL:> I<colour> 472=item B<colorUL:> I<colour>
420 473
421Use the specified colour to display underlined characters when the 474Use the specified colour to display underlined characters when the
422foreground colour is the default. 475foreground colour is the default.
423 476
424=item B<colorRV:> I<colour> 477=item B<colorRV:> I<colour>
425 478
426Use the specified colour as the background for reverse video 479Use the specified colour as the background for reverse video
427characters. 480characters.
481
482=item B<underlineColor:> I<colour>
483
484If set, use the specified colour as the colour for the underline
485itself. If unset, use the foreground colour.
428 486
429=item B<cursorColor:> I<colour> 487=item B<cursorColor:> I<colour>
430 488
431Use the specified colour for the cursor. The default is to use the 489Use the specified colour for the cursor. The default is to use the
432foreground colour; option B<-cr>. 490foreground colour; option B<-cr>.
513The first font defines the cell size for characters; other fonts might 571The first font defines the cell size for characters; other fonts might
514be smaller, but not larger. A reasonable default font list is always 572be smaller, but not larger. A reasonable default font list is always
515appended to it. option B<-fn>. 573appended to it. option B<-fn>.
516 574
517Each font can either be a standard X11 core font (XLFD) name, with 575Each 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:>. 576optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
519 577
520In addition, each font can be prefixed with additional hints and 578In addition, each font can be prefixed with additional hints and
521specifications enclosed in square brackets (C<[]>). The only available 579specifications enclosed in square brackets (C<[]>). The only available
522hint currently is C<codeset=codeset-name>, and this is only used for Xft 580hint currently is C<codeset=codeset-name>, and this is only used for Xft
523fonts. 581fonts.
533specifies five fonts to be used. The first one is C<9x15bold> (actually 591specifies 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 592the 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 593it is named first) and thus defines the character cell grid to be 9 pixels
536wide and 15 pixels high. 594wide and 15 pixels high.
537 595
538the second font is just used to add additional unicode characters not in 596The second font is just used to add additional unicode characters not in
539the base font, likewise the third, which is unfortunately non-bold, but 597the 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 598the bold version of the font does contain less characters, so this is a
541useful supplement. 599useful supplement.
542 600
543The third font is an Xft font with aliasing turned off, and the characters 601The third font is an Xft font with aliasing turned off, and the characters
646B<+si>. 704B<+si>.
647 705
648=item B<scrollWithBuffer:> I<boolean> 706=item B<scrollWithBuffer:> I<boolean>
649 707
650B<True>: scroll with scrollback buffer when tty receives new lines (and 708B<True>: scroll with scrollback buffer when tty receives new lines (and
651B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 709B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
652with scrollback buffer when tty recieves new lines; option B<-sw>. 710with scrollback buffer when tty recieves new lines; option B<+sw>.
653 711
654=item B<scrollTtyKeypress:> I<boolean> 712=item B<scrollTtyKeypress:> I<boolean>
655 713
656B<True>: scroll to bottom when a non-special key is pressed. Special keys 714B<True>: scroll to bottom when a non-special key is pressed. Special keys
657are those which are intercepted by rxvt-unicode for special handling and 715are those which are intercepted by rxvt-unicode for special handling and
696=item B<mouseWheelScrollPage:> I<boolean> 754=item B<mouseWheelScrollPage:> I<boolean>
697 755
698B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel 756B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel
699scrolls five lines [default]. 757scrolls five lines [default].
700 758
759=item B<pastableTabs:> I<boolean>
760
761B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor
762movement only; option C<-ptab>.
763
701=item B<cursorBlink:> I<boolean> 764=item B<cursorBlink:> I<boolean>
702 765
703B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 766B<True>: blink the cursor. B<False>: do not blink the cursor [default];
704option B<-bc>. 767option B<-bc>.
705 768
749 812
750I<name> of inputMethod to use; option B<-im>. 813I<name> of inputMethod to use; option B<-im>.
751 814
752=item B<imLocale:> I<name> 815=item B<imLocale:> I<name>
753 816
754The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 817The 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 818C<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 819input extension to be able to input japanese characters while staying in
757another locale. option B<-imlocale>. 820another locale. option B<-imlocale>.
821
822=item B<imFont:> I<fontset>
823
824Specify the font-set used for XIM styles C<OverTheSpot> or
825C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
826by commas), i.e. it's not in the same format as the other font lists used
827in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
828found, preferably one or two pixels differing in size to the base font.
829option B<-imfont>.
830
831=item B<tripleclickwords:> I<boolean>
832
833Change the meaning of triple-click selection with the left mouse
834button. Instead of selecting a full line it will extend the selection to
835the end of the logical line only. option B<-tcw>.
758 836
759=item B<insecure:> I<boolean> 837=item B<insecure:> I<boolean>
760 838
761Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 839Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
762echo arbitrary strings like the icon name or the locale. This could be 840echo arbitrary strings like the icon name or the locale. This could be
792scrollback buffer and switching to/from the secondary screen will 870scrollback buffer and switching to/from the secondary screen will
793instead scroll the screen up. 871instead scroll the screen up.
794 872
795=item B<keysym.>I<sym>: I<string> 873=item B<keysym.>I<sym>: I<string>
796 874
797Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 875Compile I<frills>: Associate I<string> with keysym I<sym>. The
798contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 876intervening resource name B<keysym.> cannot be omitted.
799newline, \r: return, \t: 877
878The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
879any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
880B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
881and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
882B<2>, B<3>, B<4>, B<5>.
883
884The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
885whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
886keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
887current application keymap mode state.
888
889The spellings of I<key> can be obtained by using B<xev>(1) command or
890searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
891omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
892keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
893performed in an exact manner; however, the closest match is assured.
894
895I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
896C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
800tab, \000: octal number) or control characters (^?: delete, ^@: null, 897C<\000>: octal number) or verbatim control characters (C<^?>: delete,
801^A ...) and may enclosed with double quotes so that it can start or end 898C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
802with whitespace. The intervening resource name B<keysym.> cannot be 899can start or end with whitespace.
803omitted. This resource is only available when compiled with 900
804KEYSYM_RESOURCE. 901Please note that you need to double the C<\> when using
902C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
903use C<\033> instead of C<\e> (and so on), which will work with both Xt and
904@@RXVT_NAME@@'s own processing).
905
906You can define a range of keysyms in one shot by providing a I<string>
907with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
908should be a character not used by the strings.
909
910Its usage can be demonstrated by an example:
911
912 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
913
914The above line is equivalent to the following three lines:
915
916 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
917 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
918 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
919
920If I<string> takes the form of C<command:STRING>, the specified B<STRING>
921is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
922example the following means "change the current locale to C<zh_CN.GBK>
923when Control-Meta-c is being pressed":
924
925 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
926
927The following example will map Control-Meta-1 and Control-Meta-2 to
928the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
929font-switching at runtime:
930
931 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
932 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
933
934Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
935info):
936
937 URxvt.keysym.M-C-3: command:\033[8;25;80t
938 URxvt.keysym.M-C-4: command:\033[8;48;110t
805 939
806=back 940=back
807 941
808=head1 THE SCROLLBAR 942=head1 THE SCROLLBAR
809 943
823the normal text selection/insertion, hold either the Shift or the Meta 957the normal text selection/insertion, hold either the Shift or the Meta
824(Alt) key while performing the desired mouse action. 958(Alt) key while performing the desired mouse action.
825 959
826If mouse reporting mode is active, the normal scrollbar actions are 960If mouse reporting mode is active, the normal scrollbar actions are
827disabled -- on the assumption that we are using a fullscreen 961disabled -- on the assumption that we are using a fullscreen
828application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 962application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
829(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 963(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), 964up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
831respectively. 965respectively.
832 966
833=head1 TEXT SELECTION AND INSERTION 967=head1 TEXT SELECTION AND INSERTION
834 968
835The behaviour of text selection and insertion mechanism is similar to 969The behaviour of text selection and insertion mechanism is similar to
837 971
838=over 4 972=over 4
839 973
840=item B<Selection>: 974=item B<Selection>:
841 975
842Left click at the beginning of the region, drag to the end of the 976Left 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 977and release; Right click to extend the marked region; Left double-click
844double-click to select a word; Left triple-click to select the entire 978to select a word; Left triple-click to select the entire logical line
845line. 979(which can span multiple screen lines), unless modified by resource
980B<tripleclickwords>.
846 981
847Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 982Starting 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 983(Compile: I<frills>) will create a rectangular selection instead of a normal
849one. 984one.
850 985
851=item B<Insertion>: 986=item B<Insertion>:
852 987
853Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 988Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
876C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1011C<--enable-frills>, the rest is available when rxvt-unicode was compiled
877with C<--enable-iso14755>. 1012with C<--enable-iso14755>.
878 1013
879=over 4 1014=over 4
880 1015
881=item 5.1: Basic method 1016=item * 5.1: Basic method
882 1017
883This allows you to enter unicode characters using their hexcode. 1018This allows you to enter unicode characters using their hexcode.
884 1019
885Start by pressing and holding both C<Control> and C<Shift>, then enter 1020Start 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 1021hex-digits (between one and six). Releasing C<Control> and C<Shift> will
893address, which you cannot type. Fortunately, the card has the e-mail 1028address, 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 1029address 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>, 1030by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
896followed by releasing the modifier keys. 1031followed by releasing the modifier keys.
897 1032
898=item 5.2: Keyboard symbols entry method 1033=item * 5.2: Keyboard symbols entry method
899 1034
900This mode lets you input characters representing the keycap symbols of 1035This mode lets you input characters representing the keycap symbols of
901your keyboard, if representable in the current locale encoding. 1036your keyboard, if representable in the current locale encoding.
902 1037
903Start by pressing C<Control> and C<Shift> together, then releasing 1038Start by pressing C<Control> and C<Shift> together, then releasing
906keycap symbol. The symbol will only be entered when the key has been 1041keycap symbol. The symbol will only be entered when the key has been
907released, otherwise pressing e.g. C<Shift> would enter the symbol for 1042released, 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 1043C<ISO Level 2 Switch>, although your intention might have been to enter a
909reverse tab (Shift-Tab). 1044reverse tab (Shift-Tab).
910 1045
911=item 5.3: Screen-selection entry method 1046=item * 5.3: Screen-selection entry method
912 1047
913While this is implemented already (it's basically the selection 1048While this is implemented already (it's basically the selection
914mechanism), it could be extended by displaying a unicode character map. 1049mechanism), it could be extended by displaying a unicode character map.
915 1050
916=item 5.4: Feedback method for identifying displayed characters for later input 1051=item * 5.4: Feedback method for identifying displayed characters for later input
917 1052
918This method lets you display the unicode character code associated with 1053This method lets you display the unicode character code associated with
919characters already displayed. 1054characters already displayed.
920 1055
921You enter this mode by holding down C<Control> and C<Shift> together, then 1056You 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 1068With respect to conformance, rxvt-unicode is supposed to be compliant to
934both scenario A and B of ISO 14755, including part 5.2. 1069both scenario A and B of ISO 14755, including part 5.2.
935 1070
936=head1 LOGIN STAMP 1071=head1 LOGIN STAMP
937 1072
938B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1073B<@@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. 1074it 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 1075allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
941some systems. 1076on some systems or setgid to root or to some other group on others.
942 1077
943=head1 COLORS AND GRAPHICS 1078=head1 COLORS AND GRAPHICS
944 1079
945In addition to the default foreground and background colours, 1080In addition to the default foreground and background colours,
946B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1081B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
989 1124
990=back 1125=back
991 1126
992=head1 ENVIRONMENT 1127=head1 ENVIRONMENT
993 1128
994B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1129B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
995and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1130
996window id number of the B<@@RXVT_NAME@@> window and it also uses and 1131=over 4
997sets the environment variable B<DISPLAY> to specify which display 1132
998terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1133=item B<TERM>
999B<RXVTPATH> and B<PATH> to find XPM files. 1134
1135Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1136resources or on the commandline.
1137
1138=item B<COLORTERM>
1139
1140Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
1141compiled with XPM support, and optionally with the added extension
1142C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1143
1144=item B<COLORFGBG>
1145
1146Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1147the colour code used as default foreground/text colour (or the string
1148C<default> to indicate that the default-colour escape sequence is to be
1149used), C<bg> is the colour code used as default background colour (or the
1150string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1151was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1152(and do) use this information to optimize screen output.
1153
1154=item B<WINDOWID>
1155
1156Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1157window, which usually has subwindows for the scrollbar, the terminal
1158window and so on).
1159
1160=item B<TERMINFO>
1161
1162Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1163C<--with-terminfo=PATH>.
1164
1165=item B<DISPLAY>
1166
1167Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1168display in it's child processes.
1169
1170=item B<SHELL>
1171
1172The shell to be used for command execution, defaults to C</bin/sh>.
1173
1174=item B<RXVTPATH>
1175
1176The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1177files.
1178
1179=item B<PATH>
1180
1181Used in the same way as C<RXVTPATH>.
1182
1183=item B<RXVT_SOCKET>
1184
1185The unix domain socket path used by @@RXVT_NAME@@c(1) and
1186@@RXVT_NAME@@d(1).
1187
1188Default C<< $HOME/.rxvt-unicode-<nodename >>.
1189
1190=item B<HOME>
1191
1192Used to locate the default directory for the unix domain socket for
1193daemon communications and to locate various resource files (such as
1194C<.Xdefaults>)
1195
1196=item B<XAPPLRESDIR>
1197
1198Directory where various X resource files are being located.
1199
1200=item B<XENVIRONMENT>
1201
1202If set and accessible, gives the name of a X resource file to be loaded by
1203@@RXVT_NAME@@.
1204
1205=back
1000 1206
1001=head1 FILES 1207=head1 FILES
1002 1208
1003=over 4 1209=over 4
1004 1210
1005=item B</etc/utmp>
1006
1007System file for login records.
1008
1009=item B</usr/lib/X11/rgb.txt> 1211=item B</usr/lib/X11/rgb.txt>
1010 1212
1011Color names. 1213Color names.
1012 1214
1013=back 1215=back
1028 1230
1029=over 4 1231=over 4
1030 1232
1031=item Project Coordinator 1233=item Project Coordinator
1032 1234
1033@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1235Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1034 1236
1035=item Web page maintainter 1237L<http://software.schmorp.de/#rxvt-unicode>
1036
1037@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1038
1039L<@@RXVT_WEBPAGE@@>
1040 1238
1041=back 1239=back
1042 1240
1043=head1 AUTHORS 1241=head1 AUTHORS
1044 1242
1069=item Geoff Wing L<< <gcw@pobox.com> >> 1267=item Geoff Wing L<< <gcw@pobox.com> >>
1070 1268
1071Rewrote screen display and text selection routines. Project Coordinator 1269Rewrote screen display and text selection routines. Project Coordinator
1072(changes.txt 2.4.6 - rxvt-unicode) 1270(changes.txt 2.4.6 - rxvt-unicode)
1073 1271
1074=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1272=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1075 1273
1076Forked rxvt-unicode, rewrote most of the display code and internal 1274Forked rxvt-unicode, rewrote most of the display code and internal
1077character handling to store text in unicode, improve xterm 1275character handling to store text in unicode, improve xterm
1078compatibility and apply numerous other bugfixes and extensions. 1276compatibility and apply numerous other bugfixes and extensions.
1079 1277

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines