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.48 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.77 by root, Mon Jan 2 19:36:07 2006 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
103 105
104=item B<-j>|B<+j> 106=item B<-j>|B<+j>
105 107
106Turn on/off jump scrolling; resource B<jumpScroll>. 108Turn on/off jump scrolling; resource B<jumpScroll>.
107 109
108=item B<-ip>|B<+ip> 110=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
109 111
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. resource B<fading>. 117Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>.
120
121=item B<-fadecolor> I<colour>
122
123Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>.
116 125
117=item B<-tint> I<colour> 126=item B<-tint> I<colour>
118 127
119Tint the transparent background pixmap with the given colour when 128Tint the transparent background pixmap with the given colour when
120transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> 129transparency is enabled with B<-tr> or B<-ip>. This only works for
121option that can be used to brighten or darken the image in addition to 130non-tiled backgrounds, currently. See also the B<-sh> option that can be
122tinting it. 131used to brighten or darken the image in addition to tinting it; resource
132I<tintColor>. Example:
133
134 @@RXVT_NAME@@ -tr -tint blue -sh 40
123 135
124=item B<-sh> 136=item B<-sh>
125 137
126I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
127background image in addition to tinting it (i.e. B<-tint> must be 139background image in addition to tinting it (i.e. B<-tint> must be
190=item B<-fbi> I<fontlist> 202=item B<-fbi> I<fontlist>
191 203
192Compile font-styles: The bold italic font list to use when bold characters are to 204Compile font-styles: The bold italic font list to use when bold characters are to
193be printed. See resource B<boldItalicFont> for details. 205be printed. See resource B<boldItalicFont> for details.
194 206
207=item B<-is>|B<+is>
208
209Compile font-styles: Bold/Italic font styles imply high intensity
210foreground/background (default). See resource B<intensityStyles> for
211details.
212
195=item B<-name> I<name> 213=item B<-name> I<name>
196 214
197Specify the application name under which resources are to be obtained, 215Specify the application name under which resources are to be obtained,
198rather than the default executable file name. Name should not contain 216rather than the default executable file name. Name should not contain
199`.' or `*' characters. Also sets the icon and title name. 217`.' or `*' characters. Also sets the icon and title name.
236 254
237Put scrollbar on right/left; resource B<scrollBar_right>. 255Put scrollbar on right/left; resource B<scrollBar_right>.
238 256
239=item B<-st>|B<+st> 257=item B<-st>|B<+st>
240 258
241Display normal (non XTerm/NeXT) scrollbar without/with a trough; 259Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
242resource B<scrollBar_floating>. 260resource B<scrollBar_floating>.
243 261
244=item B<-ptab>|B<+ptab> 262=item B<-ptab>|B<+ptab>
245 263
246If enabled (default), "Horizontal Tab" characters are being stored as 264If enabled (default), "Horizontal Tab" characters are being stored as
301given on the command line. If this option is used, it must be the last 319given on the command line. If this option is used, it must be the last
302on the command-line. If there is no B<-e> option then the default is to 320on the command-line. If there is no B<-e> option then the default is to
303run the program specified by the B<SHELL> environment variable or, 321run the program specified by the B<SHELL> environment variable or,
304failing that, I<sh(1)>. 322failing that, I<sh(1)>.
305 323
324Please note that you must specify a program with arguments. If you want to
325run shell commands, you have to specify the shell, like this:
326
327 @@RXVT_NAME@@ -e sh -c "shell commands"
328
306=item B<-title> I<text> 329=item B<-title> I<text>
307 330
308Window title (B<-T> still respected); the default title is the basename 331Window title (B<-T> still respected); the default title is the basename
309of the program specified after the B<-e> option, if any, otherwise the 332of the program specified after the B<-e> option, if any, otherwise the
310application name; resource B<title>. 333application name; resource B<title>.
366=item B<-ssr>|B<+ssr> 389=item B<-ssr>|B<+ssr>
367 390
368Turn on/off secondary screen scroll (default enabled); resource 391Turn on/off secondary screen scroll (default enabled); resource
369B<secondaryScroll>. 392B<secondaryScroll>.
370 393
394=item B<-hold>|B<+hold>
395
396Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
397will not immediately destroy its window when the program executed within
398it exits. Instead, it will wait till it is being killed or closed by the
399user; resource B<hold>.
400
401=item B<-keysym.>I<sym> I<string>
402
403Remap a key symbol. See resource B<keysym>.
404
405=item B<-embed> I<windowid>
406
407Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
408which enables applications to easily embed a terminal.
409
410Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
411shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
412quite a bit, so don't expect it to keep some specific state. It's best to
413create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
414
415The window will not be destroyed when @@RXVT_NAME@@ exits.
416
417It might be useful to know that @@RXVT_NAME@@ will not close file
418descriptors passed to it (except for stdin/out/err, of course), so you
419can use file descriptors to communicate with the programs within the
420terminal. This works regardless of wether the C<-embed> option was used or
421not.
422
423Here is a short Gtk2-perl snippet that illustrates how this option can be
424used (a longer example is in F<doc/embed>):
425
426 my $rxvt = new Gtk2::Socket;
427 $rxvt->signal_connect_after (realize => sub {
428 my $xid = $_[0]->window->get_xid;
429 system "@@RXVT_NAME@@ -embed $xid &";
430 });
431
432=item B<-pty-fd> I<fileno>
433
434Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
435pair but instead use the given filehandle as the tty master. This is
436useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
437without having to run a program within it.
438
439If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
440entries and will not tinker with pty/tty permissions - you have to do that
441yourself if you want that.
442
443Here is a example in perl that illustrates how this option can be used (a
444longer example is in F<doc/pty-fd>):
445
446 use IO::Pty;
447 use Fcntl;
448
449 my $pty = new IO::Pty;
450 fcntl $pty, F_SETFD, 0; # clear close-on-exec
451 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
452 close $pty;
453
454 # now communicate with rxvt
455 my $slave = $pty->slave;
456 while (<$slave>) { print $slave "got <$_>\n" }
457
371=item B<-xrm> I<resourcestring> 458=item B<-perl> I<string>
372 459
373No effect on rxvt-unicode. Simply passes through an argument to be made 460Used by perl extension. See resource B<perl>.
374available in the instance's argument list. Appears in I<WM_COMMAND> in
375some window managers.
376 461
377=back 462=back
378 463
379=head1 RESOURCES (available also as long-options) 464=head1 RESOURCES (available also as long-options)
380 465
383 468
384There are two different methods that @@RXVT_NAME@@ can use to get the 469There are two different methods that @@RXVT_NAME@@ can use to get the
385Xresource data: using the X libraries (Xrm*-functions) or internal 470Xresource data: using the X libraries (Xrm*-functions) or internal
386Xresources reader (B<~/.Xdefaults>). For the first method (ie. 471Xresources reader (B<~/.Xdefaults>). For the first method (ie.
387B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 472B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
388resources using X11 tools like B<xset>. Many distribution do also load 473resources using X11 tools like B<xrdb>. Many distribution do also load
389settings from the B<~/.Xresources> file when X starts. 474settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
475will consult the following files/resources in order, with later settings
476overwriting earlier ones:
477
478 1. system-wide app-defaults file, either locale-dependent OR global
479 2. app-defaults file in $XAPPLRESDIR
480 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
481 4. SCREEN_RESOURCES for the current screen
482 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
390 483
391If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 484If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
392lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 485lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
393set in XAPPLOADDIR/URxvt (compile-time defined: usually 486set in XAPPLOADDIR/URxvt (compile-time defined: usually
394B</usr/lib/X11/app-defaults/URxvt>) and resources set in 487B</usr/lib/X11/app-defaults/URxvt>) and resources set in
487artificial transparency. B<False>: do not inherit the parent windows' 580artificial transparency. B<False>: do not inherit the parent windows'
488pixmap. 581pixmap.
489 582
490=item B<fading:> I<number> 583=item B<fading:> I<number>
491 584
492Fade the text by the given percentage when focus is lost. 585Fade the text by the given percentage when focus is lost; option B<-fade>.
586
587=item B<fadeColor:> I<colour>
588
589Fade to this colour, when fading is used (see B<fading:>). The default
590colour is black; option B<-fadecolor>.
493 591
494=item B<tintColor:> I<colour> 592=item B<tintColor:> I<colour>
495 593
496Tint the transparent background pixmap with the given colour. 594Tint the transparent background pixmap with the given colour; option
595B<-tint>.
497 596
498=item B<shading:> I<number> 597=item B<shading:> I<number>
499 598
500Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 599Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
501image in addition to tinting it. 600image in addition to tinting it.
505Use the specified colour for the scrollbar [default #B2B2B2]. 604Use the specified colour for the scrollbar [default #B2B2B2].
506 605
507=item B<troughColor:> I<colour> 606=item B<troughColor:> I<colour>
508 607
509Use the specified colour for the scrollbar's trough area [default 608Use the specified colour for the scrollbar's trough area [default
510#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 609#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
511 610
512=item B<borderColor:> I<colour> 611=item B<borderColor:> I<colour>
513 612
514The colour of the border around the text area and between the scrollbar 613The colour of the border around the text area and between the scrollbar
515and the text. 614and the text.
542 641
543Select the fonts to be used. This is a comma separated list of font 642Select the fonts to be used. This is a comma separated list of font
544names that are used in turn when trying to display Unicode characters. 643names that are used in turn when trying to display Unicode characters.
545The first font defines the cell size for characters; other fonts might 644The first font defines the cell size for characters; other fonts might
546be smaller, but not larger. A reasonable default font list is always 645be smaller, but not larger. A reasonable default font list is always
547appended to it. option B<-fn>. 646appended to it; option B<-fn>.
548 647
549Each font can either be a standard X11 core font (XLFD) name, with 648Each font can either be a standard X11 core font (XLFD) name, with
550optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 649optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
551 650
552In addition, each font can be prefixed with additional hints and 651In addition, each font can be prefixed with additional hints and
598not possible, replacement fonts of the desired shape will be tried. 697not possible, replacement fonts of the desired shape will be tried.
599 698
600If set, but empty, then this specific style is disabled and the normal 699If set, but empty, then this specific style is disabled and the normal
601text font will being used for the given style. 700text font will being used for the given style.
602 701
702=item B<intensityStyles:> I<boolean>
703
704When font styles are not enabled, or this option is enabled (B<True>,
705option B<-is>, the default), bold and italic font styles imply high
706intensity foreground/backround colours. Disabling this option (B<False>,
707option B<+is>) disables this behaviour, the high intensity colours are not
708reachable.
709
603=item B<selectstyle:> I<mode> 710=item B<selectstyle:> I<mode>
604 711
605Set mouse selection style to B<old> which is 2.20, B<oldword> which is 712Set mouse selection style to B<old> which is 2.20, B<oldword> which is
606xterm style with 2.20 old word selection, or anything else which gives 713xterm style with 2.20 old word selection, or anything else which gives
607xterm style selection. 714xterm style selection.
608 715
609=item B<scrollstyle:> I<mode> 716=item B<scrollstyle:> I<mode>
610 717
611Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 718Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
612the author's favourite.. 719the author's favourite.
613 720
614=item B<title:> I<string> 721=item B<title:> I<string>
615 722
616Set window title string, the default title is the command-line 723Set window title string, the default title is the command-line
617specified after the B<-e> option, if any, otherwise the application 724specified after the B<-e> option, if any, otherwise the application
649 756
650Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 757Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
651B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 758B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
652B<Shift-Print> to include the scrollback as well. 759B<Shift-Print> to include the scrollback as well.
653 760
761The string will be interpreted as if typed into the shell as-is.
762
763Example:
764
765 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
766
767This creates a new file in your home directory with the screen contents
768everytime you hit C<Print>.
769
654=item B<scrollBar:> I<boolean> 770=item B<scrollBar:> I<boolean>
655 771
656B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 772B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
657disable the scrollbar; option B<+sb>. 773disable the scrollbar; option B<+sb>.
658 774
678B<+si>. 794B<+si>.
679 795
680=item B<scrollWithBuffer:> I<boolean> 796=item B<scrollWithBuffer:> I<boolean>
681 797
682B<True>: scroll with scrollback buffer when tty receives new lines (and 798B<True>: scroll with scrollback buffer when tty receives new lines (and
683B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 799B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
684with scrollback buffer when tty recieves new lines; option B<-sw>. 800with scrollback buffer when tty recieves new lines; option B<+sw>.
685 801
686=item B<scrollTtyKeypress:> I<boolean> 802=item B<scrollTtyKeypress:> I<boolean>
687 803
688B<True>: scroll to bottom when a non-special key is pressed. Special keys 804B<True>: scroll to bottom when a non-special key is pressed. Special keys
689are those which are intercepted by rxvt-unicode for special handling and 805are those which are intercepted by rxvt-unicode for special handling and
754 870
755Mouse pointer background colour. 871Mouse pointer background colour.
756 872
757=item B<pointerBlankDelay:> I<number> 873=item B<pointerBlankDelay:> I<number>
758 874
759Specifies number of seconds before blanking the pointer [default 2]. 875Specifies number of seconds before blanking the pointer [default 2]. Use a
876large number (e.g. C<987654321>) to effectively disable the timeout.
760 877
761=item B<backspacekey:> I<string> 878=item B<backspacekey:> I<string>
762 879
763The string to send when the backspace key is pressed. If set to B<DEC> 880The string to send when the backspace key is pressed. If set to B<DEC>
764or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 881or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
789=item B<imLocale:> I<name> 906=item B<imLocale:> I<name>
790 907
791The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 908The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
792C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the 909C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
793input extension to be able to input japanese characters while staying in 910input extension to be able to input japanese characters while staying in
794another locale. option B<-imlocale>. 911another locale; option B<-imlocale>.
795 912
796=item B<imFont:> I<fontset> 913=item B<imFont:> I<fontset>
797 914
798Specify the font-set used for XIM styles C<OverTheSpot> or 915Specify the font-set used for XIM styles C<OverTheSpot> or
799C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 916C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
804 921
805=item B<tripleclickwords:> I<boolean> 922=item B<tripleclickwords:> I<boolean>
806 923
807Change the meaning of triple-click selection with the left mouse 924Change the meaning of triple-click selection with the left mouse
808button. Instead of selecting a full line it will extend the selection to 925button. Instead of selecting a full line it will extend the selection to
809the end of the logical line only. option B<-tcw>. 926the end of the logical line only; option B<-tcw>.
810 927
811=item B<insecure:> I<boolean> 928=item B<insecure:> I<boolean>
812 929
813Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 930Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
814echo arbitrary strings like the icon name or the locale. This could be 931echo arbitrary strings like the icon name or the locale. This could be
815abused if somebody gets 8-bit-clean access to your display, whether 932abused if somebody gets 8-bit-clean access to your display, whether
816throuh a mail client displaying mail bodies unfiltered or though 933through a mail client displaying mail bodies unfiltered or through
817write(1). Therefore, these sequences are disabled by default. (Note 934write(1) or any other means. Therefore, these sequences are disabled by
818that other terminals, including xterm, have these sequences 935default. (Note that many other terminals, including xterm, have these
819enabled by default). You can enable them by setting this boolean 936sequences enabled by default, which doesn't make it safer, though).
820resource or specifying B<-insecure> as an option. At the moment, this 937
821enabled display-answer, locale, findfont, icon label and window title 938You can enable them by setting this boolean resource or specifying
822requests as well as dynamic menubar dispatch. 939B<-insecure> as an option. At the moment, this enables display-answer,
940locale, findfont, icon label and window title requests as well as dynamic
941menubar dispatch.
823 942
824=item B<modifier:> I<modifier> 943=item B<modifier:> I<modifier>
825 944
826Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 945Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
827B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 946B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
841 960
842Turn on/off secondary screen scroll (default enabled). If the this 961Turn on/off secondary screen scroll (default enabled). If the this
843option is enabled, scrolls on the secondary screen will change the 962option is enabled, scrolls on the secondary screen will change the
844scrollback buffer and switching to/from the secondary screen will 963scrollback buffer and switching to/from the secondary screen will
845instead scroll the screen up. 964instead scroll the screen up.
965
966=item B<hold>: I<bool>
967
968Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
969will not immediately destroy its window when the program executed within
970it exits. Instead, it will wait till it is being killed or closed by the
971user.
846 972
847=item B<keysym.>I<sym>: I<string> 973=item B<keysym.>I<sym>: I<string>
848 974
849Compile I<frills>: Associate I<string> with keysym I<sym>. The 975Compile I<frills>: Associate I<string> with keysym I<sym>. The
850intervening resource name B<keysym.> cannot be omitted. 976intervening resource name B<keysym.> cannot be omitted.
896example the following means "change the current locale to C<zh_CN.GBK> 1022example the following means "change the current locale to C<zh_CN.GBK>
897when Control-Meta-c is being pressed": 1023when Control-Meta-c is being pressed":
898 1024
899 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1025 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
900 1026
1027Due the the large number of modifier combinations, a defined key mapping
1028will match if at I<at least> the specified identifiers are being set, and
1029no other key mappings with those and more bits are being defined. That
1030means that defining a key map for C<a> will automatically provide
1031definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1032mappings themselves.
1033
1034Unfortunately, this will override built-in key mappings. For example
1035if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1036C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1037user-defined keymap using the C<builtin:> replacement:
1038
1039 URxvt.keysym.Insert: <my insert key sequence>
1040 URxvt.keysym.S-Insert: builtin:
1041
1042The first line defines a mapping for C<Insert> and I<any> combination
1043of modifiers. The second line re-establishes the default mapping for
1044C<Shift-Insert>.
1045
901The following example will map Control-Meta-1 and Control-Meta-2 to 1046The following example will map Control-Meta-1 and Control-Meta-2 to
902the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited 1047the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
903font-switching at runtime: 1048font-switching at runtime:
904 1049
905 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1050 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
908Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1053Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
909info): 1054info):
910 1055
911 URxvt.keysym.M-C-3: command:\033[8;25;80t 1056 URxvt.keysym.M-C-3: command:\033[8;25;80t
912 URxvt.keysym.M-C-4: command:\033[8;48;110t 1057 URxvt.keysym.M-C-4: command:\033[8;48;110t
1058
1059=item B<perl>: I<string>
1060
1061Used by perl extension and is free for any use, as it is not interpreted
1062by rxvt-unicode itself; option B<perl>.
1063
1064=item B<perl-eval>: I<string>
1065
1066Perl code to be evaluated when all extensions have been loaded. See the
1067rxvtperl(3) manpage.
1068
1069=item B<perl-lib>: I<path>
1070
1071Additional directory that holds extension scripts that are loaded and
1072enabled for this terminal instance, in addition to scripts stored in
1073F<@@RXVT_LIBDIR@@/urxvt/perl-ext/>, which are global to all terminal
1074instances.
1075
1076See the rxvtperl(3) manpage.
913 1077
914=back 1078=back
915 1079
916=head1 THE SCROLLBAR 1080=head1 THE SCROLLBAR
917 1081
931the normal text selection/insertion, hold either the Shift or the Meta 1095the normal text selection/insertion, hold either the Shift or the Meta
932(Alt) key while performing the desired mouse action. 1096(Alt) key while performing the desired mouse action.
933 1097
934If mouse reporting mode is active, the normal scrollbar actions are 1098If mouse reporting mode is active, the normal scrollbar actions are
935disabled -- on the assumption that we are using a fullscreen 1099disabled -- on the assumption that we are using a fullscreen
936application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1100application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
937(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1101(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
938up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), 1102up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
939respectively. 1103respectively.
940 1104
941=head1 TEXT SELECTION AND INSERTION 1105=head1 TEXT SELECTION AND INSERTION
942 1106
943The behaviour of text selection and insertion mechanism is similar to 1107The behaviour of text selection and insertion mechanism is similar to
952to select a word; Left triple-click to select the entire logical line 1116to select a word; Left triple-click to select the entire logical line
953(which can span multiple screen lines), unless modified by resource 1117(which can span multiple screen lines), unless modified by resource
954B<tripleclickwords>. 1118B<tripleclickwords>.
955 1119
956Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1120Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
957(Compile: I<frills>) will create a rectangular selection instead of a normal 1121(Compile: I<frills>) will create a rectangular selection instead of a
958one. 1122normal one. In this mode, every selected row becomes its own line in the
1123selection, and trailing whitespace is visually underlined and removed from
1124the selection.
959 1125
960=item B<Insertion>: 1126=item B<Insertion>:
961 1127
962Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1128Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
963an B<@@RXVT_NAME@@> window causes the current text selection to be 1129an B<@@RXVT_NAME@@> window causes the current text selection to be
971supported in rxvt-unicode. Bug me if you need this. 1137supported in rxvt-unicode. Bug me if you need this.
972 1138
973You can, however, switch fonts at runtime using escape sequences (and 1139You can, however, switch fonts at runtime using escape sequences (and
974therefore using the menubar), e.g.: 1140therefore using the menubar), e.g.:
975 1141
976 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1142 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
977 1143
978rxvt-unicode will automatically re-apply these fonts to the output so far. 1144rxvt-unicode will automatically re-apply these fonts to the output so far.
979 1145
980=head1 ISO 14755 SUPPORT 1146=head1 ISO 14755 SUPPORT
981 1147
1098 1264
1099=back 1265=back
1100 1266
1101=head1 ENVIRONMENT 1267=head1 ENVIRONMENT
1102 1268
1103B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1269B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1104and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1270
1105window id number of the B<@@RXVT_NAME@@> window and it also uses and 1271=over 4
1106sets the environment variable B<DISPLAY> to specify which display 1272
1107terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1273=item B<TERM>
1108B<RXVTPATH> and B<PATH> to find XPM files. 1274
1275Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1276resources or on the commandline.
1277
1278=item B<COLORTERM>
1279
1280Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
1281compiled with XPM support, and optionally with the added extension
1282C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1283
1284=item B<COLORFGBG>
1285
1286Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1287the colour code used as default foreground/text colour (or the string
1288C<default> to indicate that the default-colour escape sequence is to be
1289used), C<bg> is the colour code used as default background colour (or the
1290string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1291was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1292(and do) use this information to optimize screen output.
1293
1294=item B<WINDOWID>
1295
1296Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1297window, which usually has subwindows for the scrollbar, the terminal
1298window and so on).
1299
1300=item B<TERMINFO>
1301
1302Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1303C<--with-terminfo=PATH>.
1304
1305=item B<DISPLAY>
1306
1307Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1308display in it's child processes.
1309
1310=item B<SHELL>
1311
1312The shell to be used for command execution, defaults to C</bin/sh>.
1313
1314=item B<RXVTPATH>
1315
1316The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1317files.
1318
1319=item B<PATH>
1320
1321Used in the same way as C<RXVTPATH>.
1322
1323=item B<RXVT_SOCKET>
1324
1325The unix domain socket path used by @@RXVT_NAME@@c(1) and
1326@@RXVT_NAME@@d(1).
1327
1328Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1329
1330=item B<HOME>
1331
1332Used to locate the default directory for the unix domain socket for
1333daemon communications and to locate various resource files (such as
1334C<.Xdefaults>)
1335
1336=item B<XAPPLRESDIR>
1337
1338Directory where various X resource files are being located.
1339
1340=item B<XENVIRONMENT>
1341
1342If set and accessible, gives the name of a X resource file to be loaded by
1343@@RXVT_NAME@@.
1344
1345=back
1109 1346
1110=head1 FILES 1347=head1 FILES
1111 1348
1112=over 4 1349=over 4
1113 1350
1117 1354
1118=back 1355=back
1119 1356
1120=head1 SEE ALSO 1357=head1 SEE ALSO
1121 1358
1122@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1359@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1123
1124=head1 BUGS
1125
1126Check the BUGS file for an up-to-date list.
1127
1128Cursor change support is not yet implemented.
1129
1130Click-and-drag doesn't work with X11 mouse report overriding.
1131 1360
1132=head1 CURRENT PROJECT COORDINATOR 1361=head1 CURRENT PROJECT COORDINATOR
1133 1362
1134=over 4 1363=over 4
1135 1364
1136=item Project Coordinator 1365=item Project Coordinator
1137 1366
1138@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1367Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1139 1368
1140=item Web page maintainter 1369L<http://software.schmorp.de/#rxvt-unicode>
1141
1142@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1143
1144L<@@RXVT_WEBPAGE@@>
1145 1370
1146=back 1371=back
1147 1372
1148=head1 AUTHORS 1373=head1 AUTHORS
1149 1374
1174=item Geoff Wing L<< <gcw@pobox.com> >> 1399=item Geoff Wing L<< <gcw@pobox.com> >>
1175 1400
1176Rewrote screen display and text selection routines. Project Coordinator 1401Rewrote screen display and text selection routines. Project Coordinator
1177(changes.txt 2.4.6 - rxvt-unicode) 1402(changes.txt 2.4.6 - rxvt-unicode)
1178 1403
1179=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1404=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1180 1405
1181Forked rxvt-unicode, rewrote most of the display code and internal 1406Forked rxvt-unicode, rewrote most of the display code and internal
1182character handling to store text in unicode, improve xterm 1407character handling to store text in unicode, improve xterm
1183compatibility and apply numerous other bugfixes and extensions. 1408compatibility and apply numerous other bugfixes and extensions.
1184 1409

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines