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.36 by root, Wed Dec 15 05:10:57 2004 UTC vs.
Revision 1.65 by root, Thu Jun 30 14:00:49 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>
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>.
236 238
237Put scrollbar on right/left; resource B<scrollBar_right>. 239Put scrollbar on right/left; resource B<scrollBar_right>.
238 240
239=item B<-st>|B<+st> 241=item B<-st>|B<+st>
240 242
241Display normal (non XTerm/NeXT) scrollbar without/with a trough; 243Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
242resource B<scrollBar_floating>. 244resource B<scrollBar_floating>.
243 245
244=item B<-ptab>|B<+ptab> 246=item B<-ptab>|B<+ptab>
245 247
246If enabled (default), "Horizontal Tab" characters are being stored as 248If enabled (default), "Horizontal Tab" characters are being stored as
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.
493Use the specified colour for the scrollbar [default #B2B2B2]. 566Use the specified colour for the scrollbar [default #B2B2B2].
494 567
495=item B<troughColor:> I<colour> 568=item B<troughColor:> I<colour>
496 569
497Use the specified colour for the scrollbar's trough area [default 570Use the specified colour for the scrollbar's trough area [default
498#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 571#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
499 572
500=item B<borderColor:> I<colour> 573=item B<borderColor:> I<colour>
501 574
502The colour of the border around the text area and between the scrollbar 575The colour of the border around the text area and between the scrollbar
503and the text. 576and the text.
533The first font defines the cell size for characters; other fonts might 606The first font defines the cell size for characters; other fonts might
534be smaller, but not larger. A reasonable default font list is always 607be smaller, but not larger. A reasonable default font list is always
535appended to it. option B<-fn>. 608appended to it. option B<-fn>.
536 609
537Each 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
538optional 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:>.
539 612
540In addition, each font can be prefixed with additional hints and 613In addition, each font can be prefixed with additional hints and
541specifications enclosed in square brackets (C<[]>). The only available 614specifications enclosed in square brackets (C<[]>). The only available
542hint 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
543fonts. 616fonts.
595xterm style selection. 668xterm style selection.
596 669
597=item B<scrollstyle:> I<mode> 670=item B<scrollstyle:> I<mode>
598 671
599Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 672Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
600the author's favourite.. 673the author's favourite.
601 674
602=item B<title:> I<string> 675=item B<title:> I<string>
603 676
604Set window title string, the default title is the command-line 677Set window title string, the default title is the command-line
605specified after the B<-e> option, if any, otherwise the application 678specified after the B<-e> option, if any, otherwise the application
637 710
638Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 711Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
639B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 712B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
640B<Shift-Print> to include the scrollback as well. 713B<Shift-Print> to include the scrollback as well.
641 714
715The string will be interpreted as if typed into the shell as-is.
716
642=item B<scrollBar:> I<boolean> 717=item B<scrollBar:> I<boolean>
643 718
644B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 719B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
645disable the scrollbar; option B<+sb>. 720disable the scrollbar; option B<+sb>.
646 721
666B<+si>. 741B<+si>.
667 742
668=item B<scrollWithBuffer:> I<boolean> 743=item B<scrollWithBuffer:> I<boolean>
669 744
670B<True>: scroll with scrollback buffer when tty receives new lines (and 745B<True>: scroll with scrollback buffer when tty receives new lines (and
671B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 746B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
672with scrollback buffer when tty recieves new lines; option B<-sw>. 747with scrollback buffer when tty recieves new lines; option B<+sw>.
673 748
674=item B<scrollTtyKeypress:> I<boolean> 749=item B<scrollTtyKeypress:> I<boolean>
675 750
676B<True>: scroll to bottom when a non-special key is pressed. Special keys 751B<True>: scroll to bottom when a non-special key is pressed. Special keys
677are those which are intercepted by rxvt-unicode for special handling and 752are those which are intercepted by rxvt-unicode for special handling and
742 817
743Mouse pointer background colour. 818Mouse pointer background colour.
744 819
745=item B<pointerBlankDelay:> I<number> 820=item B<pointerBlankDelay:> I<number>
746 821
747Specifies number of seconds before blanking the pointer [default 2]. 822Specifies number of seconds before blanking the pointer [default 2]. Use a
823large number (e.g. C<987654321>) to effectively disable the timeout.
748 824
749=item B<backspacekey:> I<string> 825=item B<backspacekey:> I<string>
750 826
751The string to send when the backspace key is pressed. If set to B<DEC> 827The string to send when the backspace key is pressed. If set to B<DEC>
752or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 828or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
774 850
775I<name> of inputMethod to use; option B<-im>. 851I<name> of inputMethod to use; option B<-im>.
776 852
777=item B<imLocale:> I<name> 853=item B<imLocale:> I<name>
778 854
779The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 855The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
780de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 856C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
781extension to be able to input japanese characters while staying in 857input extension to be able to input japanese characters while staying in
782another locale. option B<-imlocale>. 858another locale. option B<-imlocale>.
859
860=item B<imFont:> I<fontset>
861
862Specify the font-set used for XIM styles C<OverTheSpot> or
863C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
864by commas), i.e. it's not in the same format as the other font lists used
865in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
866found, preferably one or two pixels differing in size to the base font.
867option B<-imfont>.
868
869=item B<tripleclickwords:> I<boolean>
870
871Change the meaning of triple-click selection with the left mouse
872button. Instead of selecting a full line it will extend the selection to
873the end of the logical line only. option B<-tcw>.
783 874
784=item B<insecure:> I<boolean> 875=item B<insecure:> I<boolean>
785 876
786Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 877Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
787echo arbitrary strings like the icon name or the locale. This could be 878echo arbitrary strings like the icon name or the locale. This could be
817scrollback buffer and switching to/from the secondary screen will 908scrollback buffer and switching to/from the secondary screen will
818instead scroll the screen up. 909instead scroll the screen up.
819 910
820=item B<keysym.>I<sym>: I<string> 911=item B<keysym.>I<sym>: I<string>
821 912
822Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 913Compile I<frills>: Associate I<string> with keysym I<sym>. The
823contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 914intervening resource name B<keysym.> cannot be omitted.
824newline, \r: return, \t: 915
916The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
917any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
918B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
919and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
920B<2>, B<3>, B<4>, B<5>.
921
922The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
923whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
924keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
925current application keymap mode state.
926
927The spellings of I<key> can be obtained by using B<xev>(1) command or
928searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
929omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
930keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
931performed in an exact manner; however, the closest match is assured.
932
933I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
934C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
825tab, \000: octal number) or control characters (^?: delete, ^@: null, 935C<\000>: octal number) or verbatim control characters (C<^?>: delete,
826^A ...) and may enclosed with double quotes so that it can start or end 936C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
827with whitespace. The intervening resource name B<keysym.> cannot be 937can start or end with whitespace.
828omitted. This resource is only available when compiled with 938
829KEYSYM_RESOURCE. 939Please note that you need to double the C<\> when using
940C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
941use C<\033> instead of C<\e> (and so on), which will work with both Xt and
942@@RXVT_NAME@@'s own processing).
943
944You can define a range of keysyms in one shot by providing a I<string>
945with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
946should be a character not used by the strings.
947
948Its usage can be demonstrated by an example:
949
950 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
951
952The above line is equivalent to the following three lines:
953
954 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
955 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
956 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
957
958If I<string> takes the form of C<command:STRING>, the specified B<STRING>
959is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
960example the following means "change the current locale to C<zh_CN.GBK>
961when Control-Meta-c is being pressed":
962
963 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
964
965Due the the large number of modifier combinations, a defined key mapping
966will match if at I<at least> the specified identifiers are being set, and
967no other key mappings with those and more bits are being defined. That
968means that defining a key map for C<a> will automatically provide
969definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
970mappings themselves.
971
972Unfortunately, this will override built-in key mappings. For example
973if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
974C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
975user-defined keymap using the C<builtin:> replacement:
976
977 URxvt.keysym.Insert: <my insert key sequence>
978 URxvt.keysym.S-Insert: builtin:
979
980The first line defines a mapping for C<Insert> and I<any> combination
981of modifiers. The second line re-establishes the default mapping for
982C<Shift-Insert>.
983
984The following example will map Control-Meta-1 and Control-Meta-2 to
985the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
986font-switching at runtime:
987
988 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
989 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
990
991Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
992info):
993
994 URxvt.keysym.M-C-3: command:\033[8;25;80t
995 URxvt.keysym.M-C-4: command:\033[8;48;110t
830 996
831=back 997=back
832 998
833=head1 THE SCROLLBAR 999=head1 THE SCROLLBAR
834 1000
848the normal text selection/insertion, hold either the Shift or the Meta 1014the normal text selection/insertion, hold either the Shift or the Meta
849(Alt) key while performing the desired mouse action. 1015(Alt) key while performing the desired mouse action.
850 1016
851If mouse reporting mode is active, the normal scrollbar actions are 1017If mouse reporting mode is active, the normal scrollbar actions are
852disabled -- on the assumption that we are using a fullscreen 1018disabled -- on the assumption that we are using a fullscreen
853application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1019application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
854(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1020(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
855up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), 1021up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
856respectively. 1022respectively.
857 1023
858=head1 TEXT SELECTION AND INSERTION 1024=head1 TEXT SELECTION AND INSERTION
859 1025
860The behaviour of text selection and insertion mechanism is similar to 1026The behaviour of text selection and insertion mechanism is similar to
862 1028
863=over 4 1029=over 4
864 1030
865=item B<Selection>: 1031=item B<Selection>:
866 1032
867Left click at the beginning of the region, drag to the end of the 1033Left click at the beginning of the region, drag to the end of the region
868region and release; Right click to extend the marked region; Left 1034and release; Right click to extend the marked region; Left double-click
869double-click to select a word; Left triple-click to select the entire 1035to select a word; Left triple-click to select the entire logical line
870line. 1036(which can span multiple screen lines), unless modified by resource
1037B<tripleclickwords>.
871 1038
872Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1039Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
873(Compile: frills) will create a rectangular selection instead of a normal 1040(Compile: I<frills>) will create a rectangular selection instead of a normal
874one. 1041one.
875 1042
876=item B<Insertion>: 1043=item B<Insertion>:
877 1044
878Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1045Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
901C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1068C<--enable-frills>, the rest is available when rxvt-unicode was compiled
902with C<--enable-iso14755>. 1069with C<--enable-iso14755>.
903 1070
904=over 4 1071=over 4
905 1072
906=item 5.1: Basic method 1073=item * 5.1: Basic method
907 1074
908This allows you to enter unicode characters using their hexcode. 1075This allows you to enter unicode characters using their hexcode.
909 1076
910Start by pressing and holding both C<Control> and C<Shift>, then enter 1077Start by pressing and holding both C<Control> and C<Shift>, then enter
911hex-digits (between one and six). Releasing C<Control> and C<Shift> will 1078hex-digits (between one and six). Releasing C<Control> and C<Shift> will
918address, which you cannot type. Fortunately, the card has the e-mail 1085address, which you cannot type. Fortunately, the card has the e-mail
919address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily 1086address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
920by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>, 1087by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
921followed by releasing the modifier keys. 1088followed by releasing the modifier keys.
922 1089
923=item 5.2: Keyboard symbols entry method 1090=item * 5.2: Keyboard symbols entry method
924 1091
925This mode lets you input characters representing the keycap symbols of 1092This mode lets you input characters representing the keycap symbols of
926your keyboard, if representable in the current locale encoding. 1093your keyboard, if representable in the current locale encoding.
927 1094
928Start by pressing C<Control> and C<Shift> together, then releasing 1095Start by pressing C<Control> and C<Shift> together, then releasing
931keycap symbol. The symbol will only be entered when the key has been 1098keycap symbol. The symbol will only be entered when the key has been
932released, otherwise pressing e.g. C<Shift> would enter the symbol for 1099released, otherwise pressing e.g. C<Shift> would enter the symbol for
933C<ISO Level 2 Switch>, although your intention might have been to enter a 1100C<ISO Level 2 Switch>, although your intention might have been to enter a
934reverse tab (Shift-Tab). 1101reverse tab (Shift-Tab).
935 1102
936=item 5.3: Screen-selection entry method 1103=item * 5.3: Screen-selection entry method
937 1104
938While this is implemented already (it's basically the selection 1105While this is implemented already (it's basically the selection
939mechanism), it could be extended by displaying a unicode character map. 1106mechanism), it could be extended by displaying a unicode character map.
940 1107
941=item 5.4: Feedback method for identifying displayed characters for later input 1108=item * 5.4: Feedback method for identifying displayed characters for later input
942 1109
943This method lets you display the unicode character code associated with 1110This method lets you display the unicode character code associated with
944characters already displayed. 1111characters already displayed.
945 1112
946You enter this mode by holding down C<Control> and C<Shift> together, then 1113You enter this mode by holding down C<Control> and C<Shift> together, then
958With respect to conformance, rxvt-unicode is supposed to be compliant to 1125With respect to conformance, rxvt-unicode is supposed to be compliant to
959both scenario A and B of ISO 14755, including part 5.2. 1126both scenario A and B of ISO 14755, including part 5.2.
960 1127
961=head1 LOGIN STAMP 1128=head1 LOGIN STAMP
962 1129
963B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1130B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
964that it can be seen via the I<who(1)> command, and can accept messages. 1131it can be seen via the I<who(1)> command, and can accept messages. To
965To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on 1132allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
966some systems. 1133on some systems or setgid to root or to some other group on others.
967 1134
968=head1 COLORS AND GRAPHICS 1135=head1 COLORS AND GRAPHICS
969 1136
970In addition to the default foreground and background colours, 1137In addition to the default foreground and background colours,
971B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1138B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1014 1181
1015=back 1182=back
1016 1183
1017=head1 ENVIRONMENT 1184=head1 ENVIRONMENT
1018 1185
1019B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1186B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1020and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1187
1021window id number of the B<@@RXVT_NAME@@> window and it also uses and 1188=over 4
1022sets the environment variable B<DISPLAY> to specify which display 1189
1023terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1190=item B<TERM>
1024B<RXVTPATH> and B<PATH> to find XPM files. 1191
1192Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1193resources or on the commandline.
1194
1195=item B<COLORTERM>
1196
1197Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
1198compiled with XPM support, and optionally with the added extension
1199C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1200
1201=item B<COLORFGBG>
1202
1203Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1204the colour code used as default foreground/text colour (or the string
1205C<default> to indicate that the default-colour escape sequence is to be
1206used), C<bg> is the colour code used as default background colour (or the
1207string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1208was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1209(and do) use this information to optimize screen output.
1210
1211=item B<WINDOWID>
1212
1213Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1214window, which usually has subwindows for the scrollbar, the terminal
1215window and so on).
1216
1217=item B<TERMINFO>
1218
1219Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1220C<--with-terminfo=PATH>.
1221
1222=item B<DISPLAY>
1223
1224Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1225display in it's child processes.
1226
1227=item B<SHELL>
1228
1229The shell to be used for command execution, defaults to C</bin/sh>.
1230
1231=item B<RXVTPATH>
1232
1233The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1234files.
1235
1236=item B<PATH>
1237
1238Used in the same way as C<RXVTPATH>.
1239
1240=item B<RXVT_SOCKET>
1241
1242The unix domain socket path used by @@RXVT_NAME@@c(1) and
1243@@RXVT_NAME@@d(1).
1244
1245Default C<< $HOME/.rxvt-unicode-<nodename >>.
1246
1247=item B<HOME>
1248
1249Used to locate the default directory for the unix domain socket for
1250daemon communications and to locate various resource files (such as
1251C<.Xdefaults>)
1252
1253=item B<XAPPLRESDIR>
1254
1255Directory where various X resource files are being located.
1256
1257=item B<XENVIRONMENT>
1258
1259If set and accessible, gives the name of a X resource file to be loaded by
1260@@RXVT_NAME@@.
1261
1262=back
1025 1263
1026=head1 FILES 1264=head1 FILES
1027 1265
1028=over 4 1266=over 4
1029 1267
1030=item B</etc/utmp>
1031
1032System file for login records.
1033
1034=item B</usr/lib/X11/rgb.txt> 1268=item B</usr/lib/X11/rgb.txt>
1035 1269
1036Color names. 1270Color names.
1037 1271
1038=back 1272=back
1053 1287
1054=over 4 1288=over 4
1055 1289
1056=item Project Coordinator 1290=item Project Coordinator
1057 1291
1058@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1292Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1059 1293
1060=item Web page maintainter 1294L<http://software.schmorp.de/#rxvt-unicode>
1061
1062@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1063
1064L<@@RXVT_WEBPAGE@@>
1065 1295
1066=back 1296=back
1067 1297
1068=head1 AUTHORS 1298=head1 AUTHORS
1069 1299
1094=item Geoff Wing L<< <gcw@pobox.com> >> 1324=item Geoff Wing L<< <gcw@pobox.com> >>
1095 1325
1096Rewrote screen display and text selection routines. Project Coordinator 1326Rewrote screen display and text selection routines. Project Coordinator
1097(changes.txt 2.4.6 - rxvt-unicode) 1327(changes.txt 2.4.6 - rxvt-unicode)
1098 1328
1099=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1329=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1100 1330
1101Forked rxvt-unicode, rewrote most of the display code and internal 1331Forked rxvt-unicode, rewrote most of the display code and internal
1102character handling to store text in unicode, improve xterm 1332character handling to store text in unicode, improve xterm
1103compatibility and apply numerous other bugfixes and extensions. 1333compatibility and apply numerous other bugfixes and extensions.
1104 1334

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines