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.66 by root, Thu Jun 30 14:02:17 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
717Example:
718
719 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
720
721This creates a new file in your home directory with the screen contents
722everytime you hit C<Print>.
723
642=item B<scrollBar:> I<boolean> 724=item B<scrollBar:> I<boolean>
643 725
644B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 726B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
645disable the scrollbar; option B<+sb>. 727disable the scrollbar; option B<+sb>.
646 728
666B<+si>. 748B<+si>.
667 749
668=item B<scrollWithBuffer:> I<boolean> 750=item B<scrollWithBuffer:> I<boolean>
669 751
670B<True>: scroll with scrollback buffer when tty receives new lines (and 752B<True>: scroll with scrollback buffer when tty receives new lines (and
671B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 753B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
672with scrollback buffer when tty recieves new lines; option B<-sw>. 754with scrollback buffer when tty recieves new lines; option B<+sw>.
673 755
674=item B<scrollTtyKeypress:> I<boolean> 756=item B<scrollTtyKeypress:> I<boolean>
675 757
676B<True>: scroll to bottom when a non-special key is pressed. Special keys 758B<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 759are those which are intercepted by rxvt-unicode for special handling and
742 824
743Mouse pointer background colour. 825Mouse pointer background colour.
744 826
745=item B<pointerBlankDelay:> I<number> 827=item B<pointerBlankDelay:> I<number>
746 828
747Specifies number of seconds before blanking the pointer [default 2]. 829Specifies number of seconds before blanking the pointer [default 2]. Use a
830large number (e.g. C<987654321>) to effectively disable the timeout.
748 831
749=item B<backspacekey:> I<string> 832=item B<backspacekey:> I<string>
750 833
751The string to send when the backspace key is pressed. If set to B<DEC> 834The 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> 835or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
774 857
775I<name> of inputMethod to use; option B<-im>. 858I<name> of inputMethod to use; option B<-im>.
776 859
777=item B<imLocale:> I<name> 860=item B<imLocale:> I<name>
778 861
779The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 862The 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 863C<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 864input extension to be able to input japanese characters while staying in
782another locale. option B<-imlocale>. 865another locale. option B<-imlocale>.
866
867=item B<imFont:> I<fontset>
868
869Specify the font-set used for XIM styles C<OverTheSpot> or
870C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
871by commas), i.e. it's not in the same format as the other font lists used
872in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
873found, preferably one or two pixels differing in size to the base font.
874option B<-imfont>.
875
876=item B<tripleclickwords:> I<boolean>
877
878Change the meaning of triple-click selection with the left mouse
879button. Instead of selecting a full line it will extend the selection to
880the end of the logical line only. option B<-tcw>.
783 881
784=item B<insecure:> I<boolean> 882=item B<insecure:> I<boolean>
785 883
786Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 884Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
787echo arbitrary strings like the icon name or the locale. This could be 885echo arbitrary strings like the icon name or the locale. This could be
817scrollback buffer and switching to/from the secondary screen will 915scrollback buffer and switching to/from the secondary screen will
818instead scroll the screen up. 916instead scroll the screen up.
819 917
820=item B<keysym.>I<sym>: I<string> 918=item B<keysym.>I<sym>: I<string>
821 919
822Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 920Compile I<frills>: Associate I<string> with keysym I<sym>. The
823contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 921intervening resource name B<keysym.> cannot be omitted.
824newline, \r: return, \t: 922
923The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
924any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
925B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
926and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
927B<2>, B<3>, B<4>, B<5>.
928
929The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
930whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
931keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
932current application keymap mode state.
933
934The spellings of I<key> can be obtained by using B<xev>(1) command or
935searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
936omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
937keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
938performed in an exact manner; however, the closest match is assured.
939
940I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
941C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
825tab, \000: octal number) or control characters (^?: delete, ^@: null, 942C<\000>: octal number) or verbatim control characters (C<^?>: delete,
826^A ...) and may enclosed with double quotes so that it can start or end 943C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
827with whitespace. The intervening resource name B<keysym.> cannot be 944can start or end with whitespace.
828omitted. This resource is only available when compiled with 945
829KEYSYM_RESOURCE. 946Please note that you need to double the C<\> when using
947C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
948use C<\033> instead of C<\e> (and so on), which will work with both Xt and
949@@RXVT_NAME@@'s own processing).
950
951You can define a range of keysyms in one shot by providing a I<string>
952with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
953should be a character not used by the strings.
954
955Its usage can be demonstrated by an example:
956
957 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
958
959The above line is equivalent to the following three lines:
960
961 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
962 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
963 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
964
965If I<string> takes the form of C<command:STRING>, the specified B<STRING>
966is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
967example the following means "change the current locale to C<zh_CN.GBK>
968when Control-Meta-c is being pressed":
969
970 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
971
972Due the the large number of modifier combinations, a defined key mapping
973will match if at I<at least> the specified identifiers are being set, and
974no other key mappings with those and more bits are being defined. That
975means that defining a key map for C<a> will automatically provide
976definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
977mappings themselves.
978
979Unfortunately, this will override built-in key mappings. For example
980if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
981C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
982user-defined keymap using the C<builtin:> replacement:
983
984 URxvt.keysym.Insert: <my insert key sequence>
985 URxvt.keysym.S-Insert: builtin:
986
987The first line defines a mapping for C<Insert> and I<any> combination
988of modifiers. The second line re-establishes the default mapping for
989C<Shift-Insert>.
990
991The following example will map Control-Meta-1 and Control-Meta-2 to
992the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
993font-switching at runtime:
994
995 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
996 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
997
998Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
999info):
1000
1001 URxvt.keysym.M-C-3: command:\033[8;25;80t
1002 URxvt.keysym.M-C-4: command:\033[8;48;110t
830 1003
831=back 1004=back
832 1005
833=head1 THE SCROLLBAR 1006=head1 THE SCROLLBAR
834 1007
848the normal text selection/insertion, hold either the Shift or the Meta 1021the normal text selection/insertion, hold either the Shift or the Meta
849(Alt) key while performing the desired mouse action. 1022(Alt) key while performing the desired mouse action.
850 1023
851If mouse reporting mode is active, the normal scrollbar actions are 1024If mouse reporting mode is active, the normal scrollbar actions are
852disabled -- on the assumption that we are using a fullscreen 1025disabled -- on the assumption that we are using a fullscreen
853application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1026application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
854(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1027(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), 1028up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
856respectively. 1029respectively.
857 1030
858=head1 TEXT SELECTION AND INSERTION 1031=head1 TEXT SELECTION AND INSERTION
859 1032
860The behaviour of text selection and insertion mechanism is similar to 1033The behaviour of text selection and insertion mechanism is similar to
862 1035
863=over 4 1036=over 4
864 1037
865=item B<Selection>: 1038=item B<Selection>:
866 1039
867Left click at the beginning of the region, drag to the end of the 1040Left 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 1041and release; Right click to extend the marked region; Left double-click
869double-click to select a word; Left triple-click to select the entire 1042to select a word; Left triple-click to select the entire logical line
870line. 1043(which can span multiple screen lines), unless modified by resource
1044B<tripleclickwords>.
871 1045
872Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1046Starting 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 1047(Compile: I<frills>) will create a rectangular selection instead of a normal
874one. 1048one.
875 1049
876=item B<Insertion>: 1050=item B<Insertion>:
877 1051
878Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1052Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
901C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1075C<--enable-frills>, the rest is available when rxvt-unicode was compiled
902with C<--enable-iso14755>. 1076with C<--enable-iso14755>.
903 1077
904=over 4 1078=over 4
905 1079
906=item 5.1: Basic method 1080=item * 5.1: Basic method
907 1081
908This allows you to enter unicode characters using their hexcode. 1082This allows you to enter unicode characters using their hexcode.
909 1083
910Start by pressing and holding both C<Control> and C<Shift>, then enter 1084Start 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 1085hex-digits (between one and six). Releasing C<Control> and C<Shift> will
918address, which you cannot type. Fortunately, the card has the e-mail 1092address, 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 1093address 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>, 1094by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
921followed by releasing the modifier keys. 1095followed by releasing the modifier keys.
922 1096
923=item 5.2: Keyboard symbols entry method 1097=item * 5.2: Keyboard symbols entry method
924 1098
925This mode lets you input characters representing the keycap symbols of 1099This mode lets you input characters representing the keycap symbols of
926your keyboard, if representable in the current locale encoding. 1100your keyboard, if representable in the current locale encoding.
927 1101
928Start by pressing C<Control> and C<Shift> together, then releasing 1102Start by pressing C<Control> and C<Shift> together, then releasing
931keycap symbol. The symbol will only be entered when the key has been 1105keycap symbol. The symbol will only be entered when the key has been
932released, otherwise pressing e.g. C<Shift> would enter the symbol for 1106released, 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 1107C<ISO Level 2 Switch>, although your intention might have been to enter a
934reverse tab (Shift-Tab). 1108reverse tab (Shift-Tab).
935 1109
936=item 5.3: Screen-selection entry method 1110=item * 5.3: Screen-selection entry method
937 1111
938While this is implemented already (it's basically the selection 1112While this is implemented already (it's basically the selection
939mechanism), it could be extended by displaying a unicode character map. 1113mechanism), it could be extended by displaying a unicode character map.
940 1114
941=item 5.4: Feedback method for identifying displayed characters for later input 1115=item * 5.4: Feedback method for identifying displayed characters for later input
942 1116
943This method lets you display the unicode character code associated with 1117This method lets you display the unicode character code associated with
944characters already displayed. 1118characters already displayed.
945 1119
946You enter this mode by holding down C<Control> and C<Shift> together, then 1120You 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 1132With respect to conformance, rxvt-unicode is supposed to be compliant to
959both scenario A and B of ISO 14755, including part 5.2. 1133both scenario A and B of ISO 14755, including part 5.2.
960 1134
961=head1 LOGIN STAMP 1135=head1 LOGIN STAMP
962 1136
963B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1137B<@@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. 1138it 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 1139allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
966some systems. 1140on some systems or setgid to root or to some other group on others.
967 1141
968=head1 COLORS AND GRAPHICS 1142=head1 COLORS AND GRAPHICS
969 1143
970In addition to the default foreground and background colours, 1144In addition to the default foreground and background colours,
971B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1145B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1014 1188
1015=back 1189=back
1016 1190
1017=head1 ENVIRONMENT 1191=head1 ENVIRONMENT
1018 1192
1019B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1193B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1020and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1194
1021window id number of the B<@@RXVT_NAME@@> window and it also uses and 1195=over 4
1022sets the environment variable B<DISPLAY> to specify which display 1196
1023terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1197=item B<TERM>
1024B<RXVTPATH> and B<PATH> to find XPM files. 1198
1199Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1200resources or on the commandline.
1201
1202=item B<COLORTERM>
1203
1204Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
1205compiled with XPM support, and optionally with the added extension
1206C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1207
1208=item B<COLORFGBG>
1209
1210Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1211the colour code used as default foreground/text colour (or the string
1212C<default> to indicate that the default-colour escape sequence is to be
1213used), C<bg> is the colour code used as default background colour (or the
1214string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1215was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1216(and do) use this information to optimize screen output.
1217
1218=item B<WINDOWID>
1219
1220Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1221window, which usually has subwindows for the scrollbar, the terminal
1222window and so on).
1223
1224=item B<TERMINFO>
1225
1226Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1227C<--with-terminfo=PATH>.
1228
1229=item B<DISPLAY>
1230
1231Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1232display in it's child processes.
1233
1234=item B<SHELL>
1235
1236The shell to be used for command execution, defaults to C</bin/sh>.
1237
1238=item B<RXVTPATH>
1239
1240The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1241files.
1242
1243=item B<PATH>
1244
1245Used in the same way as C<RXVTPATH>.
1246
1247=item B<RXVT_SOCKET>
1248
1249The unix domain socket path used by @@RXVT_NAME@@c(1) and
1250@@RXVT_NAME@@d(1).
1251
1252Default C<< $HOME/.rxvt-unicode-<nodename >>.
1253
1254=item B<HOME>
1255
1256Used to locate the default directory for the unix domain socket for
1257daemon communications and to locate various resource files (such as
1258C<.Xdefaults>)
1259
1260=item B<XAPPLRESDIR>
1261
1262Directory where various X resource files are being located.
1263
1264=item B<XENVIRONMENT>
1265
1266If set and accessible, gives the name of a X resource file to be loaded by
1267@@RXVT_NAME@@.
1268
1269=back
1025 1270
1026=head1 FILES 1271=head1 FILES
1027 1272
1028=over 4 1273=over 4
1029 1274
1030=item B</etc/utmp>
1031
1032System file for login records.
1033
1034=item B</usr/lib/X11/rgb.txt> 1275=item B</usr/lib/X11/rgb.txt>
1035 1276
1036Color names. 1277Color names.
1037 1278
1038=back 1279=back
1053 1294
1054=over 4 1295=over 4
1055 1296
1056=item Project Coordinator 1297=item Project Coordinator
1057 1298
1058@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1299Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1059 1300
1060=item Web page maintainter 1301L<http://software.schmorp.de/#rxvt-unicode>
1061
1062@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1063
1064L<@@RXVT_WEBPAGE@@>
1065 1302
1066=back 1303=back
1067 1304
1068=head1 AUTHORS 1305=head1 AUTHORS
1069 1306
1094=item Geoff Wing L<< <gcw@pobox.com> >> 1331=item Geoff Wing L<< <gcw@pobox.com> >>
1095 1332
1096Rewrote screen display and text selection routines. Project Coordinator 1333Rewrote screen display and text selection routines. Project Coordinator
1097(changes.txt 2.4.6 - rxvt-unicode) 1334(changes.txt 2.4.6 - rxvt-unicode)
1098 1335
1099=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1336=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1100 1337
1101Forked rxvt-unicode, rewrote most of the display code and internal 1338Forked rxvt-unicode, rewrote most of the display code and internal
1102character handling to store text in unicode, improve xterm 1339character handling to store text in unicode, improve xterm
1103compatibility and apply numerous other bugfixes and extensions. 1340compatibility and apply numerous other bugfixes and extensions.
1104 1341

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines