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.43 by root, Sun Jan 16 19:22:16 2005 UTC vs.
Revision 1.85 by root, Wed Jan 4 20:43:37 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
177See also the question "How does rxvt-unicode choose fonts?" in the FAQ 189See also the question "How does rxvt-unicode choose fonts?" in the FAQ
178section of @@RXVT_NAME@@(7). 190section of @@RXVT_NAME@@(7).
179 191
180=item B<-fb> I<fontlist> 192=item B<-fb> I<fontlist>
181 193
182Compile font-styles: The bold font list to use when bold characters are to 194Compile I<font-styles>: The bold font list to use when B<bold> characters
183be printed. See resource B<boldFont> for details. 195are to be printed. See resource B<boldFont> for details.
184 196
185=item B<-fi> I<fontlist> 197=item B<-fi> I<fontlist>
186 198
187Compile font-styles: The italic font list to use when bold characters are to 199Compile I<font-styles>: The italic font list to use when I<italic>
188be printed. See resource B<italicFont> for details. 200characters are to be printed. See resource B<italicFont> for details.
189 201
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 I<font-styles>: The bold italic font list to use when B<< I<bold
193be printed. See resource B<boldItalicFont> for details. 205italic> >> characters are to be printed. See resource B<boldItalicFont>
206for details.
207
208=item B<-is>|B<+is>
209
210Compile I<font-styles>: Bold/Italic font styles imply high intensity
211foreground/background (default). See resource B<intensityStyles> for
212details.
194 213
195=item B<-name> I<name> 214=item B<-name> I<name>
196 215
197Specify the application name under which resources are to be obtained, 216Specify the application name under which resources are to be obtained,
198rather than the default executable file name. Name should not contain 217rather than the default executable file name. Name should not contain
236 255
237Put scrollbar on right/left; resource B<scrollBar_right>. 256Put scrollbar on right/left; resource B<scrollBar_right>.
238 257
239=item B<-st>|B<+st> 258=item B<-st>|B<+st>
240 259
241Display normal (non XTerm/NeXT) scrollbar without/with a trough; 260Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
242resource B<scrollBar_floating>. 261resource B<scrollBar_floating>.
243 262
244=item B<-ptab>|B<+ptab> 263=item B<-ptab>|B<+ptab>
245 264
246If enabled (default), "Horizontal Tab" characters are being stored as 265If enabled (default), "Horizontal Tab" characters are being stored as
277=item B<-bl> 296=item B<-bl>
278 297
279Compile I<frills>: Set MWM hints to request a borderless window, i.e. 298Compile I<frills>: Set MWM hints to request a borderless window, i.e.
280if honoured by the WM, the rxvt-unicode window will not have window 299if honoured by the WM, the rxvt-unicode window will not have window
281decorations; resource B<borderLess>. 300decorations; resource B<borderLess>.
301
302=item B<-sbg>
303
304Compile I<frills>: Disable the usage of the built-in block graphics/line
305drawing characters and just rely on what the specified fonts provide. Use
306this if you have a good font and want to use its block graphic glyphs;
307resource B<skipBuiltinGlyphs>.
282 308
283=item B<-lsp> I<number> 309=item B<-lsp> I<number>
284 310
285Compile I<frills>: Lines (pixel height) to insert between each row of 311Compile I<frills>: Lines (pixel height) to insert between each row of
286the display. Useful to work around font rendering problems; resource 312the display. Useful to work around font rendering problems; resource
301given on the command line. If this option is used, it must be the last 327given 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 328on 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, 329run the program specified by the B<SHELL> environment variable or,
304failing that, I<sh(1)>. 330failing that, I<sh(1)>.
305 331
332Please note that you must specify a program with arguments. If you want to
333run shell commands, you have to specify the shell, like this:
334
335 @@RXVT_NAME@@ -e sh -c "shell commands"
336
306=item B<-title> I<text> 337=item B<-title> I<text>
307 338
308Window title (B<-T> still respected); the default title is the basename 339Window title (B<-T> still respected); the default title is the basename
309of the program specified after the B<-e> option, if any, otherwise the 340of the program specified after the B<-e> option, if any, otherwise the
310application name; resource B<title>. 341application name; resource B<title>.
328 359
329Compile I<XIM>: input method name. resource B<inputMethod>. 360Compile I<XIM>: input method name. resource B<inputMethod>.
330 361
331=item B<-imlocale> I<string> 362=item B<-imlocale> I<string>
332 363
333The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 364The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
334de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 365C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
335extension to be able to input japanese characters while staying in 366input extension to be able to input japanese characters while staying in
336another locale. 367another locale. resource B<imLocale>.
368
369=item B<-imfont> I<fontset>
370
371Set the font set to use for the X Input Method, see resource B<imFont>
372for more info.
373
374=item B<-tcw>
375
376Change the meaning of triple-click selection with the left mouse
377button. Instead of selecting a full line it will extend the selection the
378end of the logical line only. resource B<tripleclickwords>.
337 379
338=item B<-insecure> 380=item B<-insecure>
339 381
340Enable "insecure" mode, which currently enables most of the escape 382Enable "insecure" mode, which currently enables most of the escape
341sequences that echo strings. See the resource B<insecure> for more 383sequences that echo strings. See the resource B<insecure> for more
355=item B<-ssr>|B<+ssr> 397=item B<-ssr>|B<+ssr>
356 398
357Turn on/off secondary screen scroll (default enabled); resource 399Turn on/off secondary screen scroll (default enabled); resource
358B<secondaryScroll>. 400B<secondaryScroll>.
359 401
402=item B<-hold>|B<+hold>
403
404Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
405will not immediately destroy its window when the program executed within
406it exits. Instead, it will wait till it is being killed or closed by the
407user; resource B<hold>.
408
409=item B<-keysym.>I<sym> I<string>
410
411Remap a key symbol. See resource B<keysym>.
412
413=item B<-embed> I<windowid>
414
415Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
416which enables applications to easily embed a terminal.
417
418Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
419shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
420quite a bit, so don't expect it to keep some specific state. It's best to
421create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
422
423The window will not be destroyed when @@RXVT_NAME@@ exits.
424
425It might be useful to know that @@RXVT_NAME@@ will not close file
426descriptors passed to it (except for stdin/out/err, of course), so you
427can use file descriptors to communicate with the programs within the
428terminal. This works regardless of wether the C<-embed> option was used or
429not.
430
431Here is a short Gtk2-perl snippet that illustrates how this option can be
432used (a longer example is in F<doc/embed>):
433
434 my $rxvt = new Gtk2::Socket;
435 $rxvt->signal_connect_after (realize => sub {
436 my $xid = $_[0]->window->get_xid;
437 system "@@RXVT_NAME@@ -embed $xid &";
438 });
439
440=item B<-pty-fd> I<fileno>
441
442Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
443pair but instead use the given filehandle as the tty master. This is
444useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445without having to run a program within it.
446
447If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
448entries and will not tinker with pty/tty permissions - you have to do that
449yourself if you want that.
450
451Here is a example in perl that illustrates how this option can be used (a
452longer example is in F<doc/pty-fd>):
453
454 use IO::Pty;
455 use Fcntl;
456
457 my $pty = new IO::Pty;
458 fcntl $pty, F_SETFD, 0; # clear close-on-exec
459 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
460 close $pty;
461
462 # now communicate with rxvt
463 my $slave = $pty->slave;
464 while (<$slave>) { print $slave "got <$_>\n" }
465
360=item B<-xrm> I<resourcestring> 466=item B<-pe> I<string>
361 467
362No effect on rxvt-unicode. Simply passes through an argument to be made 468Colon-separated list of perl extension scripts to use in this terminal
363available in the instance's argument list. Appears in I<WM_COMMAND> in 469instance. See resource B<perl-ext>.
364some window managers.
365 470
366=back 471=back
367 472
368=head1 RESOURCES (available also as long-options) 473=head1 RESOURCES (available also as long-options)
369 474
372 477
373There are two different methods that @@RXVT_NAME@@ can use to get the 478There are two different methods that @@RXVT_NAME@@ can use to get the
374Xresource data: using the X libraries (Xrm*-functions) or internal 479Xresource data: using the X libraries (Xrm*-functions) or internal
375Xresources reader (B<~/.Xdefaults>). For the first method (ie. 480Xresources reader (B<~/.Xdefaults>). For the first method (ie.
376B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 481B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
377resources using X11 tools like B<xset>. Many distribution do also load 482resources using X11 tools like B<xrdb>. Many distribution do also load
378settings from the B<~/.Xresources> file when X starts. 483settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
484will consult the following files/resources in order, with later settings
485overwriting earlier ones:
486
487 1. system-wide app-defaults file, either locale-dependent OR global
488 2. app-defaults file in $XAPPLRESDIR
489 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
490 4. SCREEN_RESOURCES for the current screen
491 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
379 492
380If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 493If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
381lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 494lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
382set in XAPPLOADDIR/URxvt (compile-time defined: usually 495set in XAPPLOADDIR/URxvt (compile-time defined: usually
383B</usr/lib/X11/app-defaults/URxvt>) and resources set in 496B</usr/lib/X11/app-defaults/URxvt>) and resources set in
476artificial transparency. B<False>: do not inherit the parent windows' 589artificial transparency. B<False>: do not inherit the parent windows'
477pixmap. 590pixmap.
478 591
479=item B<fading:> I<number> 592=item B<fading:> I<number>
480 593
481Fade the text by the given percentage when focus is lost. 594Fade the text by the given percentage when focus is lost; option B<-fade>.
595
596=item B<fadeColor:> I<colour>
597
598Fade to this colour, when fading is used (see B<fading:>). The default
599colour is black; option B<-fadecolor>.
482 600
483=item B<tintColor:> I<colour> 601=item B<tintColor:> I<colour>
484 602
485Tint the transparent background pixmap with the given colour. 603Tint the transparent background pixmap with the given colour; option
604B<-tint>.
486 605
487=item B<shading:> I<number> 606=item B<shading:> I<number>
488 607
489Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 608Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
490image in addition to tinting it. 609image in addition to tinting it.
494Use the specified colour for the scrollbar [default #B2B2B2]. 613Use the specified colour for the scrollbar [default #B2B2B2].
495 614
496=item B<troughColor:> I<colour> 615=item B<troughColor:> I<colour>
497 616
498Use the specified colour for the scrollbar's trough area [default 617Use the specified colour for the scrollbar's trough area [default
499#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 618#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
500 619
501=item B<borderColor:> I<colour> 620=item B<borderColor:> I<colour>
502 621
503The colour of the border around the text area and between the scrollbar 622The colour of the border around the text area and between the scrollbar
504and the text. 623and the text.
531 650
532Select the fonts to be used. This is a comma separated list of font 651Select the fonts to be used. This is a comma separated list of font
533names that are used in turn when trying to display Unicode characters. 652names that are used in turn when trying to display Unicode characters.
534The first font defines the cell size for characters; other fonts might 653The first font defines the cell size for characters; other fonts might
535be smaller, but not larger. A reasonable default font list is always 654be smaller, but not larger. A reasonable default font list is always
536appended to it. option B<-fn>. 655appended to it; option B<-fn>.
537 656
538Each font can either be a standard X11 core font (XLFD) name, with 657Each font can either be a standard X11 core font (XLFD) name, with
539optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 658optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
540 659
541In addition, each font can be prefixed with additional hints and 660In addition, each font can be prefixed with additional hints and
587not possible, replacement fonts of the desired shape will be tried. 706not possible, replacement fonts of the desired shape will be tried.
588 707
589If set, but empty, then this specific style is disabled and the normal 708If set, but empty, then this specific style is disabled and the normal
590text font will being used for the given style. 709text font will being used for the given style.
591 710
711=item B<intensityStyles:> I<boolean>
712
713When font styles are not enabled, or this option is enabled (B<True>,
714option B<-is>, the default), bold and italic font styles imply high
715intensity foreground/backround colours. Disabling this option (B<False>,
716option B<+is>) disables this behaviour, the high intensity colours are not
717reachable.
718
592=item B<selectstyle:> I<mode> 719=item B<selectstyle:> I<mode>
593 720
594Set mouse selection style to B<old> which is 2.20, B<oldword> which is 721Set mouse selection style to B<old> which is 2.20, B<oldword> which is
595xterm style with 2.20 old word selection, or anything else which gives 722xterm style with 2.20 old word selection, or anything else which gives
596xterm style selection. 723xterm style selection.
597 724
598=item B<scrollstyle:> I<mode> 725=item B<scrollstyle:> I<mode>
599 726
600Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 727Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
601the author's favourite.. 728the author's favourite.
602 729
603=item B<title:> I<string> 730=item B<title:> I<string>
604 731
605Set window title string, the default title is the command-line 732Set window title string, the default title is the command-line
606specified after the B<-e> option, if any, otherwise the application 733specified after the B<-e> option, if any, otherwise the application
638 765
639Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 766Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
640B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 767B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
641B<Shift-Print> to include the scrollback as well. 768B<Shift-Print> to include the scrollback as well.
642 769
770The string will be interpreted as if typed into the shell as-is.
771
772Example:
773
774 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
775
776This creates a new file in your home directory with the screen contents
777everytime you hit C<Print>.
778
643=item B<scrollBar:> I<boolean> 779=item B<scrollBar:> I<boolean>
644 780
645B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 781B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
646disable the scrollbar; option B<+sb>. 782disable the scrollbar; option B<+sb>.
647 783
667B<+si>. 803B<+si>.
668 804
669=item B<scrollWithBuffer:> I<boolean> 805=item B<scrollWithBuffer:> I<boolean>
670 806
671B<True>: scroll with scrollback buffer when tty receives new lines (and 807B<True>: scroll with scrollback buffer when tty receives new lines (and
672B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 808B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
673with scrollback buffer when tty recieves new lines; option B<-sw>. 809with scrollback buffer when tty recieves new lines; option B<+sw>.
674 810
675=item B<scrollTtyKeypress:> I<boolean> 811=item B<scrollTtyKeypress:> I<boolean>
676 812
677B<True>: scroll to bottom when a non-special key is pressed. Special keys 813B<True>: scroll to bottom when a non-special key is pressed. Special keys
678are those which are intercepted by rxvt-unicode for special handling and 814are those which are intercepted by rxvt-unicode for special handling and
697=item B<borderLess:> I<boolean> 833=item B<borderLess:> I<boolean>
698 834
699Set MWM hints to request a borderless window, i.e. if honoured by the 835Set MWM hints to request a borderless window, i.e. if honoured by the
700WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 836WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
701 837
838=item B<skipBuiltinGlyphs:> I<boolean>
839
840Compile I<frills>: Disable the usage of the built-in block graphics/line
841drawing characters and just rely on what the specified fonts provide. Use
842this if you have a good font and want to use its block graphic glyphs;
843option B<-sbg>.
844
702=item B<termName:> I<termname> 845=item B<termName:> I<termname>
703 846
704Specifies the terminal type name to be set in the B<TERM> environment 847Specifies the terminal type name to be set in the B<TERM> environment
705variable; option B<-tn>. 848variable; option B<-tn>.
706 849
743 886
744Mouse pointer background colour. 887Mouse pointer background colour.
745 888
746=item B<pointerBlankDelay:> I<number> 889=item B<pointerBlankDelay:> I<number>
747 890
748Specifies number of seconds before blanking the pointer [default 2]. 891Specifies number of seconds before blanking the pointer [default 2]. Use a
892large number (e.g. C<987654321>) to effectively disable the timeout.
749 893
750=item B<backspacekey:> I<string> 894=item B<backspacekey:> I<string>
751 895
752The string to send when the backspace key is pressed. If set to B<DEC> 896The string to send when the backspace key is pressed. If set to B<DEC>
753or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 897or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
775 919
776I<name> of inputMethod to use; option B<-im>. 920I<name> of inputMethod to use; option B<-im>.
777 921
778=item B<imLocale:> I<name> 922=item B<imLocale:> I<name>
779 923
780The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 924The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
781de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 925C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
782extension to be able to input japanese characters while staying in 926input extension to be able to input japanese characters while staying in
783another locale. option B<-imlocale>. 927another locale; option B<-imlocale>.
928
929=item B<imFont:> I<fontset>
930
931Specify the font-set used for XIM styles C<OverTheSpot> or
932C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
933by commas), i.e. it's not in the same format as the other font lists used
934in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
935found, preferably one or two pixels differing in size to the base font.
936option B<-imfont>.
937
938=item B<tripleclickwords:> I<boolean>
939
940Change the meaning of triple-click selection with the left mouse
941button. Instead of selecting a full line it will extend the selection to
942the end of the logical line only; option B<-tcw>.
784 943
785=item B<insecure:> I<boolean> 944=item B<insecure:> I<boolean>
786 945
787Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 946Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
788echo arbitrary strings like the icon name or the locale. This could be 947echo arbitrary strings like the icon name or the locale. This could be
789abused if somebody gets 8-bit-clean access to your display, whether 948abused if somebody gets 8-bit-clean access to your display, whether
790throuh a mail client displaying mail bodies unfiltered or though 949through a mail client displaying mail bodies unfiltered or through
791write(1). Therefore, these sequences are disabled by default. (Note 950write(1) or any other means. Therefore, these sequences are disabled by
792that other terminals, including xterm, have these sequences 951default. (Note that many other terminals, including xterm, have these
793enabled by default). You can enable them by setting this boolean 952sequences enabled by default, which doesn't make it safer, though).
794resource or specifying B<-insecure> as an option. At the moment, this 953
795enabled display-answer, locale, findfont, icon label and window title 954You can enable them by setting this boolean resource or specifying
796requests as well as dynamic menubar dispatch. 955B<-insecure> as an option. At the moment, this enables display-answer,
956locale, findfont, icon label and window title requests as well as dynamic
957menubar dispatch.
797 958
798=item B<modifier:> I<modifier> 959=item B<modifier:> I<modifier>
799 960
800Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 961Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
801B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 962B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
815 976
816Turn on/off secondary screen scroll (default enabled). If the this 977Turn on/off secondary screen scroll (default enabled). If the this
817option is enabled, scrolls on the secondary screen will change the 978option is enabled, scrolls on the secondary screen will change the
818scrollback buffer and switching to/from the secondary screen will 979scrollback buffer and switching to/from the secondary screen will
819instead scroll the screen up. 980instead scroll the screen up.
981
982=item B<hold>: I<bool>
983
984Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
985will not immediately destroy its window when the program executed within
986it exits. Instead, it will wait till it is being killed or closed by the
987user.
820 988
821=item B<keysym.>I<sym>: I<string> 989=item B<keysym.>I<sym>: I<string>
822 990
823Compile I<frills>: Associate I<string> with keysym I<sym>. The 991Compile I<frills>: Associate I<string> with keysym I<sym>. The
824intervening resource name B<keysym.> cannot be omitted. 992intervening resource name B<keysym.> cannot be omitted.
829and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 997and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
830B<2>, B<3>, B<4>, B<5>. 998B<2>, B<3>, B<4>, B<5>.
831 999
832The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1000The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
833whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1001whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
834keys are being mapped. B<AppKeypad> is a artificial modifier mapped to the 1002keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
835current application keymap mode state. 1003current application keymap mode state.
836 1004
837The spellings of I<key> can be obtained by using B<xev>(1) command or 1005The spellings of I<key> can be obtained by using B<xev>(1) command or
838searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1006searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
839omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1007omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
844C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1012C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
845C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1013C<\000>: octal number) or verbatim control characters (C<^?>: delete,
846C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1014C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
847can start or end with whitespace. 1015can start or end with whitespace.
848 1016
1017Please note that you need to double the C<\> when using
1018C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
1019use C<\033> instead of C<\e> (and so on), which will work with both Xt and
1020@@RXVT_NAME@@'s own processing).
1021
849You can define a range of keysyms in one shot by providing a I<string> 1022You can define a range of keysyms in one shot by providing a I<string>
850with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1023with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
851should be a character not used by the strings. 1024should be a character not used by the strings.
852 1025
853Its usage can be demonstrated by an example: 1026Its usage can be demonstrated by an example:
854 1027
855 URxvt.keysym.M-C-0x61: list|\e<M-C-|abc|> 1028 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
856 1029
857The above line is equivalent to the following three lines: 1030The above line is equivalent to the following three lines:
858 1031
859 URxvt.keysym.Meta-Control-0x61: \e<M-C-a> 1032 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
860 URxvt.keysym.Meta-Control-0x62: \e<M-C-b> 1033 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
861 URxvt.keysym.Meta-Control-0x63: \e<M-C-c> 1034 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
862 1035
863If I<string> takes the form of C<proto:STRING>, the specified B<STRING> is 1036If I<string> takes the form of C<command:STRING>, the specified B<STRING>
864interpreted and executed as @@RXVT_NAME@@'s control sequence. For example, 1037is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
865C<proto:\033]701;zh_CN.GBK\007> means: change the current locale to 1038example the following means "change the current locale to C<zh_CN.GBK>
866C<zh_CN.GBK>. 1039when Control-Meta-c is being pressed":
1040
1041 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1042
1043If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1044is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1045manpage. For example, the F<selection> extension (activated via
1046C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1047
1048 URxvt.keysym.M-C-c: perl:selection:rot13
1049
1050Due the the large number of modifier combinations, a defined key mapping
1051will match if at I<at least> the specified identifiers are being set, and
1052no other key mappings with those and more bits are being defined. That
1053means that defining a key map for C<a> will automatically provide
1054definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1055mappings themselves.
1056
1057Unfortunately, this will override built-in key mappings. For example
1058if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1059C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1060user-defined keymap using the C<builtin:> replacement:
1061
1062 URxvt.keysym.Insert: <my insert key sequence>
1063 URxvt.keysym.S-Insert: builtin:
1064
1065The first line defines a mapping for C<Insert> and I<any> combination
1066of modifiers. The second line re-establishes the default mapping for
1067C<Shift-Insert>.
1068
1069The following example will map Control-Meta-1 and Control-Meta-2 to
1070the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1071font-switching at runtime:
1072
1073 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1074 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1075
1076Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1077info):
1078
1079 URxvt.keysym.M-C-3: command:\033[8;25;80t
1080 URxvt.keysym.M-C-4: command:\033[8;48;110t
1081
1082=item B<perl-ext-common>: I<string>
1083
1084=item B<perl-ext>: I<string>
1085
1086Colon-separated list(s) of perl extension scripts to use in this terminal
1087instance. Each extension is looked up in the library directories, loaded
1088if necessary, and bound to the current terminal instance. If this
1089resource is empty or missing, then the perl interpreter will not be
1090initialized. The idea behind two options is that B<perl-ext-common> will
1091be used for extensions that should be available to all instances, while
1092B<perl-ext> is used for specific instances; option B<-pe>.
1093
1094=item B<perl-eval>: I<string>
1095
1096Perl code to be evaluated when all extensions have been registered. See the
1097@@RXVT_NAME@@perl(3) manpage.
1098
1099=item B<perl-lib>: I<path>
1100
1101Colon-separated list of additional directories that hold extension
1102scripts. When looking for extensions specified by the C<perl> resource,
1103@@RXVT_NAME@@ will first look in these directories and then in
1104F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1105
1106See the @@RXVT_NAME@@perl(3) manpage.
867 1107
868=back 1108=back
869 1109
870=head1 THE SCROLLBAR 1110=head1 THE SCROLLBAR
871 1111
885the normal text selection/insertion, hold either the Shift or the Meta 1125the normal text selection/insertion, hold either the Shift or the Meta
886(Alt) key while performing the desired mouse action. 1126(Alt) key while performing the desired mouse action.
887 1127
888If mouse reporting mode is active, the normal scrollbar actions are 1128If mouse reporting mode is active, the normal scrollbar actions are
889disabled -- on the assumption that we are using a fullscreen 1129disabled -- on the assumption that we are using a fullscreen
890application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1130application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
891(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1131(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
892up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), 1132up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
893respectively. 1133respectively.
894 1134
895=head1 TEXT SELECTION AND INSERTION 1135=head1 TEXT SELECTION AND INSERTION
896 1136
897The behaviour of text selection and insertion mechanism is similar to 1137The behaviour of text selection and insertion mechanism is similar to
899 1139
900=over 4 1140=over 4
901 1141
902=item B<Selection>: 1142=item B<Selection>:
903 1143
904Left click at the beginning of the region, drag to the end of the 1144Left click at the beginning of the region, drag to the end of the region
905region and release; Right click to extend the marked region; Left 1145and release; Right click to extend the marked region; Left double-click
906double-click to select a word; Left triple-click to select the entire 1146to select a word; Left triple-click to select the entire logical line
907line. 1147(which can span multiple screen lines), unless modified by resource
1148B<tripleclickwords>.
908 1149
909Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1150Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
910(Compile: I<frills>) will create a rectangular selection instead of a normal 1151(Compile: I<frills>) will create a rectangular selection instead of a
911one. 1152normal one. In this mode, every selected row becomes its own line in the
1153selection, and trailing whitespace is visually underlined and removed from
1154the selection.
912 1155
913=item B<Insertion>: 1156=item B<Insertion>:
914 1157
915Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1158Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
916an B<@@RXVT_NAME@@> window causes the current text selection to be 1159an B<@@RXVT_NAME@@> window causes the current text selection to be
924supported in rxvt-unicode. Bug me if you need this. 1167supported in rxvt-unicode. Bug me if you need this.
925 1168
926You can, however, switch fonts at runtime using escape sequences (and 1169You can, however, switch fonts at runtime using escape sequences (and
927therefore using the menubar), e.g.: 1170therefore using the menubar), e.g.:
928 1171
929 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1172 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
930 1173
931rxvt-unicode will automatically re-apply these fonts to the output so far. 1174rxvt-unicode will automatically re-apply these fonts to the output so far.
932 1175
933=head1 ISO 14755 SUPPORT 1176=head1 ISO 14755 SUPPORT
934 1177
938C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1181C<--enable-frills>, the rest is available when rxvt-unicode was compiled
939with C<--enable-iso14755>. 1182with C<--enable-iso14755>.
940 1183
941=over 4 1184=over 4
942 1185
943=item 5.1: Basic method 1186=item * 5.1: Basic method
944 1187
945This allows you to enter unicode characters using their hexcode. 1188This allows you to enter unicode characters using their hexcode.
946 1189
947Start by pressing and holding both C<Control> and C<Shift>, then enter 1190Start by pressing and holding both C<Control> and C<Shift>, then enter
948hex-digits (between one and six). Releasing C<Control> and C<Shift> will 1191hex-digits (between one and six). Releasing C<Control> and C<Shift> will
955address, which you cannot type. Fortunately, the card has the e-mail 1198address, which you cannot type. Fortunately, the card has the e-mail
956address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily 1199address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
957by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>, 1200by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
958followed by releasing the modifier keys. 1201followed by releasing the modifier keys.
959 1202
960=item 5.2: Keyboard symbols entry method 1203=item * 5.2: Keyboard symbols entry method
961 1204
962This mode lets you input characters representing the keycap symbols of 1205This mode lets you input characters representing the keycap symbols of
963your keyboard, if representable in the current locale encoding. 1206your keyboard, if representable in the current locale encoding.
964 1207
965Start by pressing C<Control> and C<Shift> together, then releasing 1208Start by pressing C<Control> and C<Shift> together, then releasing
968keycap symbol. The symbol will only be entered when the key has been 1211keycap symbol. The symbol will only be entered when the key has been
969released, otherwise pressing e.g. C<Shift> would enter the symbol for 1212released, otherwise pressing e.g. C<Shift> would enter the symbol for
970C<ISO Level 2 Switch>, although your intention might have been to enter a 1213C<ISO Level 2 Switch>, although your intention might have been to enter a
971reverse tab (Shift-Tab). 1214reverse tab (Shift-Tab).
972 1215
973=item 5.3: Screen-selection entry method 1216=item * 5.3: Screen-selection entry method
974 1217
975While this is implemented already (it's basically the selection 1218While this is implemented already (it's basically the selection
976mechanism), it could be extended by displaying a unicode character map. 1219mechanism), it could be extended by displaying a unicode character map.
977 1220
978=item 5.4: Feedback method for identifying displayed characters for later input 1221=item * 5.4: Feedback method for identifying displayed characters for later input
979 1222
980This method lets you display the unicode character code associated with 1223This method lets you display the unicode character code associated with
981characters already displayed. 1224characters already displayed.
982 1225
983You enter this mode by holding down C<Control> and C<Shift> together, then 1226You enter this mode by holding down C<Control> and C<Shift> together, then
995With respect to conformance, rxvt-unicode is supposed to be compliant to 1238With respect to conformance, rxvt-unicode is supposed to be compliant to
996both scenario A and B of ISO 14755, including part 5.2. 1239both scenario A and B of ISO 14755, including part 5.2.
997 1240
998=head1 LOGIN STAMP 1241=head1 LOGIN STAMP
999 1242
1000B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1243B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1001that it can be seen via the I<who(1)> command, and can accept messages. 1244it can be seen via the I<who(1)> command, and can accept messages. To
1002To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on 1245allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1003some systems. 1246on some systems or setgid to root or to some other group on others.
1004 1247
1005=head1 COLORS AND GRAPHICS 1248=head1 COLORS AND GRAPHICS
1006 1249
1007In addition to the default foreground and background colours, 1250In addition to the default foreground and background colours,
1008B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1251B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1051 1294
1052=back 1295=back
1053 1296
1054=head1 ENVIRONMENT 1297=head1 ENVIRONMENT
1055 1298
1056B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1299B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1057and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1300
1058window id number of the B<@@RXVT_NAME@@> window and it also uses and 1301=over 4
1059sets the environment variable B<DISPLAY> to specify which display 1302
1060terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1303=item B<TERM>
1061B<RXVTPATH> and B<PATH> to find XPM files. 1304
1305Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1306resources or on the commandline.
1307
1308=item B<COLORTERM>
1309
1310Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
1311compiled with XPM support, and optionally with the added extension
1312C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1313
1314=item B<COLORFGBG>
1315
1316Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1317the colour code used as default foreground/text colour (or the string
1318C<default> to indicate that the default-colour escape sequence is to be
1319used), C<bg> is the colour code used as default background colour (or the
1320string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1321was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1322(and do) use this information to optimize screen output.
1323
1324=item B<WINDOWID>
1325
1326Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1327window, which usually has subwindows for the scrollbar, the terminal
1328window and so on).
1329
1330=item B<TERMINFO>
1331
1332Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1333C<--with-terminfo=PATH>.
1334
1335=item B<DISPLAY>
1336
1337Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1338display in it's child processes.
1339
1340=item B<SHELL>
1341
1342The shell to be used for command execution, defaults to C</bin/sh>.
1343
1344=item B<RXVTPATH>
1345
1346The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1347files.
1348
1349=item B<PATH>
1350
1351Used in the same way as C<RXVTPATH>.
1352
1353=item B<RXVT_SOCKET>
1354
1355The unix domain socket path used by @@RXVT_NAME@@c(1) and
1356@@RXVT_NAME@@d(1).
1357
1358Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1359
1360=item B<HOME>
1361
1362Used to locate the default directory for the unix domain socket for
1363daemon communications and to locate various resource files (such as
1364C<.Xdefaults>)
1365
1366=item B<XAPPLRESDIR>
1367
1368Directory where various X resource files are being located.
1369
1370=item B<XENVIRONMENT>
1371
1372If set and accessible, gives the name of a X resource file to be loaded by
1373@@RXVT_NAME@@.
1374
1375=back
1062 1376
1063=head1 FILES 1377=head1 FILES
1064 1378
1065=over 4 1379=over 4
1066 1380
1067=item B</etc/utmp>
1068
1069System file for login records.
1070
1071=item B</usr/lib/X11/rgb.txt> 1381=item B</usr/lib/X11/rgb.txt>
1072 1382
1073Color names. 1383Color names.
1074 1384
1075=back 1385=back
1076 1386
1077=head1 SEE ALSO 1387=head1 SEE ALSO
1078 1388
1079@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1389@@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)
1080
1081=head1 BUGS
1082
1083Check the BUGS file for an up-to-date list.
1084
1085Cursor change support is not yet implemented.
1086
1087Click-and-drag doesn't work with X11 mouse report overriding.
1088 1390
1089=head1 CURRENT PROJECT COORDINATOR 1391=head1 CURRENT PROJECT COORDINATOR
1090 1392
1091=over 4 1393=over 4
1092 1394
1093=item Project Coordinator 1395=item Project Coordinator
1094 1396
1095@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1397Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1096 1398
1097=item Web page maintainter 1399L<http://software.schmorp.de/#rxvt-unicode>
1098
1099@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1100
1101L<@@RXVT_WEBPAGE@@>
1102 1400
1103=back 1401=back
1104 1402
1105=head1 AUTHORS 1403=head1 AUTHORS
1106 1404
1131=item Geoff Wing L<< <gcw@pobox.com> >> 1429=item Geoff Wing L<< <gcw@pobox.com> >>
1132 1430
1133Rewrote screen display and text selection routines. Project Coordinator 1431Rewrote screen display and text selection routines. Project Coordinator
1134(changes.txt 2.4.6 - rxvt-unicode) 1432(changes.txt 2.4.6 - rxvt-unicode)
1135 1433
1136=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1434=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1137 1435
1138Forked rxvt-unicode, rewrote most of the display code and internal 1436Forked rxvt-unicode, rewrote most of the display code and internal
1139character handling to store text in unicode, improve xterm 1437character handling to store text in unicode, improve xterm
1140compatibility and apply numerous other bugfixes and extensions. 1438compatibility and apply numerous other bugfixes and extensions.
1141 1439

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines