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.92 by root, Wed Jan 11 02:13:55 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<file descriptor>
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
451As an extremely special case, specifying C<-1> will completely suppress
452pty/tty operations.
453
454Here is a example in perl that illustrates how this option can be used (a
455longer example is in F<doc/pty-fd>):
456
457 use IO::Pty;
458 use Fcntl;
459
460 my $pty = new IO::Pty;
461 fcntl $pty, F_SETFD, 0; # clear close-on-exec
462 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
463 close $pty;
464
465 # now communicate with rxvt
466 my $slave = $pty->slave;
467 while (<$slave>) { print $slave "got <$_>\n" }
468
360=item B<-xrm> I<resourcestring> 469=item B<-pe> I<string>
361 470
362No effect on rxvt-unicode. Simply passes through an argument to be made 471Comma-separated list of perl extension scripts to use (or not to use) in
363available in the instance's argument list. Appears in I<WM_COMMAND> in 472this terminal instance. See resource B<perl-ext> for details.
364some window managers.
365 473
366=back 474=back
367 475
368=head1 RESOURCES (available also as long-options) 476=head1 RESOURCES (available also as long-options)
369 477
372 480
373There are two different methods that @@RXVT_NAME@@ can use to get the 481There are two different methods that @@RXVT_NAME@@ can use to get the
374Xresource data: using the X libraries (Xrm*-functions) or internal 482Xresource data: using the X libraries (Xrm*-functions) or internal
375Xresources reader (B<~/.Xdefaults>). For the first method (ie. 483Xresources reader (B<~/.Xdefaults>). For the first method (ie.
376B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 484B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
377resources using X11 tools like B<xset>. Many distribution do also load 485resources using X11 tools like B<xrdb>. Many distribution do also load
378settings from the B<~/.Xresources> file when X starts. 486settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
487will consult the following files/resources in order, with later settings
488overwriting earlier ones:
489
490 1. system-wide app-defaults file, either locale-dependent OR global
491 2. app-defaults file in $XAPPLRESDIR
492 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
493 4. SCREEN_RESOURCES for the current screen
494 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
379 495
380If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 496If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
381lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 497lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
382set in XAPPLOADDIR/URxvt (compile-time defined: usually 498set in XAPPLOADDIR/URxvt (compile-time defined: usually
383B</usr/lib/X11/app-defaults/URxvt>) and resources set in 499B</usr/lib/X11/app-defaults/URxvt>) and resources set in
476artificial transparency. B<False>: do not inherit the parent windows' 592artificial transparency. B<False>: do not inherit the parent windows'
477pixmap. 593pixmap.
478 594
479=item B<fading:> I<number> 595=item B<fading:> I<number>
480 596
481Fade the text by the given percentage when focus is lost. 597Fade the text by the given percentage when focus is lost; option B<-fade>.
598
599=item B<fadeColor:> I<colour>
600
601Fade to this colour, when fading is used (see B<fading:>). The default
602colour is black; option B<-fadecolor>.
482 603
483=item B<tintColor:> I<colour> 604=item B<tintColor:> I<colour>
484 605
485Tint the transparent background pixmap with the given colour. 606Tint the transparent background pixmap with the given colour; option
607B<-tint>.
486 608
487=item B<shading:> I<number> 609=item B<shading:> I<number>
488 610
489Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 611Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
490image in addition to tinting it. 612image in addition to tinting it.
494Use the specified colour for the scrollbar [default #B2B2B2]. 616Use the specified colour for the scrollbar [default #B2B2B2].
495 617
496=item B<troughColor:> I<colour> 618=item B<troughColor:> I<colour>
497 619
498Use the specified colour for the scrollbar's trough area [default 620Use the specified colour for the scrollbar's trough area [default
499#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 621#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
500 622
501=item B<borderColor:> I<colour> 623=item B<borderColor:> I<colour>
502 624
503The colour of the border around the text area and between the scrollbar 625The colour of the border around the text area and between the scrollbar
504and the text. 626and the text.
531 653
532Select the fonts to be used. This is a comma separated list of font 654Select 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. 655names that are used in turn when trying to display Unicode characters.
534The first font defines the cell size for characters; other fonts might 656The first font defines the cell size for characters; other fonts might
535be smaller, but not larger. A reasonable default font list is always 657be smaller, but not larger. A reasonable default font list is always
536appended to it. option B<-fn>. 658appended to it; option B<-fn>.
537 659
538Each font can either be a standard X11 core font (XLFD) name, with 660Each 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:>. 661optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
540 662
541In addition, each font can be prefixed with additional hints and 663In addition, each font can be prefixed with additional hints and
587not possible, replacement fonts of the desired shape will be tried. 709not possible, replacement fonts of the desired shape will be tried.
588 710
589If set, but empty, then this specific style is disabled and the normal 711If set, but empty, then this specific style is disabled and the normal
590text font will being used for the given style. 712text font will being used for the given style.
591 713
714=item B<intensityStyles:> I<boolean>
715
716When font styles are not enabled, or this option is enabled (B<True>,
717option B<-is>, the default), bold and italic font styles imply high
718intensity foreground/backround colours. Disabling this option (B<False>,
719option B<+is>) disables this behaviour, the high intensity colours are not
720reachable.
721
592=item B<selectstyle:> I<mode> 722=item B<selectstyle:> I<mode>
593 723
594Set mouse selection style to B<old> which is 2.20, B<oldword> which is 724Set 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 725xterm style with 2.20 old word selection, or anything else which gives
596xterm style selection. 726xterm style selection.
597 727
598=item B<scrollstyle:> I<mode> 728=item B<scrollstyle:> I<mode>
599 729
600Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 730Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
601the author's favourite.. 731the author's favourite.
602 732
603=item B<title:> I<string> 733=item B<title:> I<string>
604 734
605Set window title string, the default title is the command-line 735Set window title string, the default title is the command-line
606specified after the B<-e> option, if any, otherwise the application 736specified after the B<-e> option, if any, otherwise the application
638 768
639Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 769Specify 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 770B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
641B<Shift-Print> to include the scrollback as well. 771B<Shift-Print> to include the scrollback as well.
642 772
773The string will be interpreted as if typed into the shell as-is.
774
775Example:
776
777 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
778
779This creates a new file in your home directory with the screen contents
780everytime you hit C<Print>.
781
643=item B<scrollBar:> I<boolean> 782=item B<scrollBar:> I<boolean>
644 783
645B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 784B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
646disable the scrollbar; option B<+sb>. 785disable the scrollbar; option B<+sb>.
647 786
667B<+si>. 806B<+si>.
668 807
669=item B<scrollWithBuffer:> I<boolean> 808=item B<scrollWithBuffer:> I<boolean>
670 809
671B<True>: scroll with scrollback buffer when tty receives new lines (and 810B<True>: scroll with scrollback buffer when tty receives new lines (and
672B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 811B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
673with scrollback buffer when tty recieves new lines; option B<-sw>. 812with scrollback buffer when tty recieves new lines; option B<+sw>.
674 813
675=item B<scrollTtyKeypress:> I<boolean> 814=item B<scrollTtyKeypress:> I<boolean>
676 815
677B<True>: scroll to bottom when a non-special key is pressed. Special keys 816B<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 817are those which are intercepted by rxvt-unicode for special handling and
697=item B<borderLess:> I<boolean> 836=item B<borderLess:> I<boolean>
698 837
699Set MWM hints to request a borderless window, i.e. if honoured by the 838Set 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>. 839WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
701 840
841=item B<skipBuiltinGlyphs:> I<boolean>
842
843Compile I<frills>: Disable the usage of the built-in block graphics/line
844drawing characters and just rely on what the specified fonts provide. Use
845this if you have a good font and want to use its block graphic glyphs;
846option B<-sbg>.
847
702=item B<termName:> I<termname> 848=item B<termName:> I<termname>
703 849
704Specifies the terminal type name to be set in the B<TERM> environment 850Specifies the terminal type name to be set in the B<TERM> environment
705variable; option B<-tn>. 851variable; option B<-tn>.
706 852
743 889
744Mouse pointer background colour. 890Mouse pointer background colour.
745 891
746=item B<pointerBlankDelay:> I<number> 892=item B<pointerBlankDelay:> I<number>
747 893
748Specifies number of seconds before blanking the pointer [default 2]. 894Specifies number of seconds before blanking the pointer [default 2]. Use a
895large number (e.g. C<987654321>) to effectively disable the timeout.
749 896
750=item B<backspacekey:> I<string> 897=item B<backspacekey:> I<string>
751 898
752The string to send when the backspace key is pressed. If set to B<DEC> 899The 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> 900or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
775 922
776I<name> of inputMethod to use; option B<-im>. 923I<name> of inputMethod to use; option B<-im>.
777 924
778=item B<imLocale:> I<name> 925=item B<imLocale:> I<name>
779 926
780The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 927The 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 928C<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 929input extension to be able to input japanese characters while staying in
783another locale. option B<-imlocale>. 930another locale; option B<-imlocale>.
931
932=item B<imFont:> I<fontset>
933
934Specify the font-set used for XIM styles C<OverTheSpot> or
935C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
936by commas), i.e. it's not in the same format as the other font lists used
937in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
938found, preferably one or two pixels differing in size to the base font.
939option B<-imfont>.
940
941=item B<tripleclickwords:> I<boolean>
942
943Change the meaning of triple-click selection with the left mouse
944button. Instead of selecting a full line it will extend the selection to
945the end of the logical line only; option B<-tcw>.
784 946
785=item B<insecure:> I<boolean> 947=item B<insecure:> I<boolean>
786 948
787Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 949Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
788echo arbitrary strings like the icon name or the locale. This could be 950echo arbitrary strings like the icon name or the locale. This could be
789abused if somebody gets 8-bit-clean access to your display, whether 951abused if somebody gets 8-bit-clean access to your display, whether
790throuh a mail client displaying mail bodies unfiltered or though 952through a mail client displaying mail bodies unfiltered or through
791write(1). Therefore, these sequences are disabled by default. (Note 953write(1) or any other means. Therefore, these sequences are disabled by
792that other terminals, including xterm, have these sequences 954default. (Note that many other terminals, including xterm, have these
793enabled by default). You can enable them by setting this boolean 955sequences enabled by default, which doesn't make it safer, though).
794resource or specifying B<-insecure> as an option. At the moment, this 956
795enabled display-answer, locale, findfont, icon label and window title 957You can enable them by setting this boolean resource or specifying
796requests as well as dynamic menubar dispatch. 958B<-insecure> as an option. At the moment, this enables display-answer,
959locale, findfont, icon label and window title requests as well as dynamic
960menubar dispatch.
797 961
798=item B<modifier:> I<modifier> 962=item B<modifier:> I<modifier>
799 963
800Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 964Set 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 965B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
815 979
816Turn on/off secondary screen scroll (default enabled). If the this 980Turn on/off secondary screen scroll (default enabled). If the this
817option is enabled, scrolls on the secondary screen will change the 981option is enabled, scrolls on the secondary screen will change the
818scrollback buffer and switching to/from the secondary screen will 982scrollback buffer and switching to/from the secondary screen will
819instead scroll the screen up. 983instead scroll the screen up.
984
985=item B<hold>: I<bool>
986
987Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
988will not immediately destroy its window when the program executed within
989it exits. Instead, it will wait till it is being killed or closed by the
990user.
820 991
821=item B<keysym.>I<sym>: I<string> 992=item B<keysym.>I<sym>: I<string>
822 993
823Compile I<frills>: Associate I<string> with keysym I<sym>. The 994Compile I<frills>: Associate I<string> with keysym I<sym>. The
824intervening resource name B<keysym.> cannot be omitted. 995intervening 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>, 1000and 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>. 1001B<2>, B<3>, B<4>, B<5>.
831 1002
832The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1003The 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 1004whatever 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 1005keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
835current application keymap mode state. 1006current application keymap mode state.
836 1007
837The spellings of I<key> can be obtained by using B<xev>(1) command or 1008The 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 1009searching 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 1010omitting 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, 1015C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
845C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1016C<\000>: octal number) or verbatim control characters (C<^?>: delete,
846C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1017C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
847can start or end with whitespace. 1018can start or end with whitespace.
848 1019
1020Please note that you need to double the C<\> when using
1021C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
1022use C<\033> instead of C<\e> (and so on), which will work with both Xt and
1023@@RXVT_NAME@@'s own processing).
1024
849You can define a range of keysyms in one shot by providing a I<string> 1025You can define a range of keysyms in one shot by providing a I<string>
850with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1026with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
851should be a character not used by the strings. 1027should be a character not used by the strings.
852 1028
853Its usage can be demonstrated by an example: 1029Its usage can be demonstrated by an example:
854 1030
855 URxvt.keysym.M-C-0x61: list|\e<M-C-|abc|> 1031 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
856 1032
857The above line is equivalent to the following three lines: 1033The above line is equivalent to the following three lines:
858 1034
859 URxvt.keysym.Meta-Control-0x61: \e<M-C-a> 1035 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
860 URxvt.keysym.Meta-Control-0x62: \e<M-C-b> 1036 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
861 URxvt.keysym.Meta-Control-0x63: \e<M-C-c> 1037 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
862 1038
863If I<string> takes the form of C<proto:STRING>, the specified B<STRING> is 1039If I<string> takes the form of C<command:STRING>, the specified B<STRING>
864interpreted and executed as @@RXVT_NAME@@'s control sequence. For example, 1040is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
865C<proto:\033]701;zh_CN.GBK\007> means: change the current locale to 1041example the following means "change the current locale to C<zh_CN.GBK>
866C<zh_CN.GBK>. 1042when Control-Meta-c is being pressed":
1043
1044 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1045
1046If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1047is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1048manpage. For example, the F<selection> extension (activated via
1049C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1050
1051 URxvt.keysym.M-C-c: perl:selection:rot13
1052
1053Due the the large number of modifier combinations, a defined key mapping
1054will match if at I<at least> the specified identifiers are being set, and
1055no other key mappings with those and more bits are being defined. That
1056means that defining a key map for C<a> will automatically provide
1057definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1058mappings themselves.
1059
1060Unfortunately, this will override built-in key mappings. For example
1061if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1062C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1063user-defined keymap using the C<builtin:> replacement:
1064
1065 URxvt.keysym.Insert: <my insert key sequence>
1066 URxvt.keysym.S-Insert: builtin:
1067
1068The first line defines a mapping for C<Insert> and I<any> combination
1069of modifiers. The second line re-establishes the default mapping for
1070C<Shift-Insert>.
1071
1072The following example will map Control-Meta-1 and Control-Meta-2 to
1073the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1074font-switching at runtime:
1075
1076 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1077 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1078
1079Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1080info):
1081
1082 URxvt.keysym.M-C-3: command:\033[8;25;80t
1083 URxvt.keysym.M-C-4: command:\033[8;48;110t
1084
1085=item B<perl-ext-common>: I<string>
1086
1087=item B<perl-ext>: I<string>
1088
1089Comma-separated list(s) of perl extension scripts (default: C<default>) to
1090use in this terminal instance; option B<-pe>.
1091
1092Extension names can be prefixed with a C<-> sign to prohibit using
1093them. This can be useful to selectively disable some extensions loaded
1094by default, or specified via the C<perl-ext-common> resource. For
1095example, C<default,-selection> will use all the default extension except
1096C<selection>.
1097
1098Extension names can also be followed by an argument in angle brackets
1099(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1100searchable scorllback to Alt/Meta-s). Mentioning the same extension
1101multiple times with different arguments will pass multiple arguments to
1102the extension.
1103
1104Each extension is looked up in the library directories, loaded if
1105necessary, and bound to the current terminal instance.
1106
1107If both of these resources are the empty string, then the perl
1108interpreter will not be initialized. The idea behind two options is that
1109B<perl-ext-common> will be used for extensions that should be available to
1110all instances, while B<perl-ext> is used for specific instances.
1111
1112=item B<perl-eval>: I<string>
1113
1114Perl code to be evaluated when all extensions have been registered. See
1115the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1116will be ignored when running setuid/setgid.
1117
1118=item B<perl-lib>: I<path>
1119
1120Colon-separated list of additional directories that hold extension
1121scripts. When looking for extensions specified by the C<perl> resource,
1122@@RXVT_NAME@@ will first look in these directories and then in
1123F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1124will be ignored when running setuid/setgid.
1125
1126See the @@RXVT_NAME@@perl(3) manpage.
1127
1128=item B<urlLauncher>: I<string>
1129
1130Specifies the program to be started with a URL argument. Used by the
1131C<selection-popup> and C<mark-urls> perl extensions.
1132
1133=item B<transient-for>: I<windowid>
1134
1135Sets the WM_TRANSIENT_FOR property to the given window iw.
867 1136
868=back 1137=back
869 1138
870=head1 THE SCROLLBAR 1139=head1 THE SCROLLBAR
871 1140
885the normal text selection/insertion, hold either the Shift or the Meta 1154the normal text selection/insertion, hold either the Shift or the Meta
886(Alt) key while performing the desired mouse action. 1155(Alt) key while performing the desired mouse action.
887 1156
888If mouse reporting mode is active, the normal scrollbar actions are 1157If mouse reporting mode is active, the normal scrollbar actions are
889disabled -- on the assumption that we are using a fullscreen 1158disabled -- on the assumption that we are using a fullscreen
890application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1159application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
891(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1160(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), 1161up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
893respectively. 1162respectively.
894 1163
895=head1 TEXT SELECTION AND INSERTION 1164=head1 TEXT SELECTION AND INSERTION
896 1165
897The behaviour of text selection and insertion mechanism is similar to 1166The behaviour of text selection and insertion mechanism is similar to
899 1168
900=over 4 1169=over 4
901 1170
902=item B<Selection>: 1171=item B<Selection>:
903 1172
904Left click at the beginning of the region, drag to the end of the 1173Left 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 1174and release; Right click to extend the marked region; Left double-click
906double-click to select a word; Left triple-click to select the entire 1175to select a word; Left triple-click to select the entire logical line
907line. 1176(which can span multiple screen lines), unless modified by resource
1177B<tripleclickwords>.
908 1178
909Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1179Starting 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 1180(Compile: I<frills>) will create a rectangular selection instead of a
911one. 1181normal one. In this mode, every selected row becomes its own line in the
1182selection, and trailing whitespace is visually underlined and removed from
1183the selection.
912 1184
913=item B<Insertion>: 1185=item B<Insertion>:
914 1186
915Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1187Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
916an B<@@RXVT_NAME@@> window causes the current text selection to be 1188an B<@@RXVT_NAME@@> window causes the current text selection to be
924supported in rxvt-unicode. Bug me if you need this. 1196supported in rxvt-unicode. Bug me if you need this.
925 1197
926You can, however, switch fonts at runtime using escape sequences (and 1198You can, however, switch fonts at runtime using escape sequences (and
927therefore using the menubar), e.g.: 1199therefore using the menubar), e.g.:
928 1200
929 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1201 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
930 1202
931rxvt-unicode will automatically re-apply these fonts to the output so far. 1203rxvt-unicode will automatically re-apply these fonts to the output so far.
932 1204
933=head1 ISO 14755 SUPPORT 1205=head1 ISO 14755 SUPPORT
934 1206
938C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1210C<--enable-frills>, the rest is available when rxvt-unicode was compiled
939with C<--enable-iso14755>. 1211with C<--enable-iso14755>.
940 1212
941=over 4 1213=over 4
942 1214
943=item 5.1: Basic method 1215=item * 5.1: Basic method
944 1216
945This allows you to enter unicode characters using their hexcode. 1217This allows you to enter unicode characters using their hexcode.
946 1218
947Start by pressing and holding both C<Control> and C<Shift>, then enter 1219Start 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 1220hex-digits (between one and six). Releasing C<Control> and C<Shift> will
955address, which you cannot type. Fortunately, the card has the e-mail 1227address, 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 1228address 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>, 1229by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
958followed by releasing the modifier keys. 1230followed by releasing the modifier keys.
959 1231
960=item 5.2: Keyboard symbols entry method 1232=item * 5.2: Keyboard symbols entry method
961 1233
962This mode lets you input characters representing the keycap symbols of 1234This mode lets you input characters representing the keycap symbols of
963your keyboard, if representable in the current locale encoding. 1235your keyboard, if representable in the current locale encoding.
964 1236
965Start by pressing C<Control> and C<Shift> together, then releasing 1237Start by pressing C<Control> and C<Shift> together, then releasing
968keycap symbol. The symbol will only be entered when the key has been 1240keycap symbol. The symbol will only be entered when the key has been
969released, otherwise pressing e.g. C<Shift> would enter the symbol for 1241released, 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 1242C<ISO Level 2 Switch>, although your intention might have been to enter a
971reverse tab (Shift-Tab). 1243reverse tab (Shift-Tab).
972 1244
973=item 5.3: Screen-selection entry method 1245=item * 5.3: Screen-selection entry method
974 1246
975While this is implemented already (it's basically the selection 1247While this is implemented already (it's basically the selection
976mechanism), it could be extended by displaying a unicode character map. 1248mechanism), it could be extended by displaying a unicode character map.
977 1249
978=item 5.4: Feedback method for identifying displayed characters for later input 1250=item * 5.4: Feedback method for identifying displayed characters for later input
979 1251
980This method lets you display the unicode character code associated with 1252This method lets you display the unicode character code associated with
981characters already displayed. 1253characters already displayed.
982 1254
983You enter this mode by holding down C<Control> and C<Shift> together, then 1255You 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 1267With respect to conformance, rxvt-unicode is supposed to be compliant to
996both scenario A and B of ISO 14755, including part 5.2. 1268both scenario A and B of ISO 14755, including part 5.2.
997 1269
998=head1 LOGIN STAMP 1270=head1 LOGIN STAMP
999 1271
1000B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1272B<@@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. 1273it 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 1274allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1003some systems. 1275on some systems or setgid to root or to some other group on others.
1004 1276
1005=head1 COLORS AND GRAPHICS 1277=head1 COLORS AND GRAPHICS
1006 1278
1007In addition to the default foreground and background colours, 1279In addition to the default foreground and background colours,
1008B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1280B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1051 1323
1052=back 1324=back
1053 1325
1054=head1 ENVIRONMENT 1326=head1 ENVIRONMENT
1055 1327
1056B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1328B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1057and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1329
1058window id number of the B<@@RXVT_NAME@@> window and it also uses and 1330=over 4
1059sets the environment variable B<DISPLAY> to specify which display 1331
1060terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1332=item B<TERM>
1061B<RXVTPATH> and B<PATH> to find XPM files. 1333
1334Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1335resources or on the commandline.
1336
1337=item B<COLORTERM>
1338
1339Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
1340compiled with XPM support, and optionally with the added extension
1341C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1342
1343=item B<COLORFGBG>
1344
1345Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1346the colour code used as default foreground/text colour (or the string
1347C<default> to indicate that the default-colour escape sequence is to be
1348used), C<bg> is the colour code used as default background colour (or the
1349string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1350was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1351(and do) use this information to optimize screen output.
1352
1353=item B<WINDOWID>
1354
1355Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1356window, which usually has subwindows for the scrollbar, the terminal
1357window and so on).
1358
1359=item B<TERMINFO>
1360
1361Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1362C<--with-terminfo=PATH>.
1363
1364=item B<DISPLAY>
1365
1366Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1367display in it's child processes.
1368
1369=item B<SHELL>
1370
1371The shell to be used for command execution, defaults to C</bin/sh>.
1372
1373=item B<RXVTPATH>
1374
1375The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1376files.
1377
1378=item B<PATH>
1379
1380Used in the same way as C<RXVTPATH>.
1381
1382=item B<RXVT_SOCKET>
1383
1384The unix domain socket path used by @@RXVT_NAME@@c(1) and
1385@@RXVT_NAME@@d(1).
1386
1387Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1388
1389=item B<HOME>
1390
1391Used to locate the default directory for the unix domain socket for
1392daemon communications and to locate various resource files (such as
1393C<.Xdefaults>)
1394
1395=item B<XAPPLRESDIR>
1396
1397Directory where various X resource files are being located.
1398
1399=item B<XENVIRONMENT>
1400
1401If set and accessible, gives the name of a X resource file to be loaded by
1402@@RXVT_NAME@@.
1403
1404=back
1062 1405
1063=head1 FILES 1406=head1 FILES
1064 1407
1065=over 4 1408=over 4
1066 1409
1067=item B</etc/utmp>
1068
1069System file for login records.
1070
1071=item B</usr/lib/X11/rgb.txt> 1410=item B</usr/lib/X11/rgb.txt>
1072 1411
1073Color names. 1412Color names.
1074 1413
1075=back 1414=back
1076 1415
1077=head1 SEE ALSO 1416=head1 SEE ALSO
1078 1417
1079@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1418@@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 1419
1089=head1 CURRENT PROJECT COORDINATOR 1420=head1 CURRENT PROJECT COORDINATOR
1090 1421
1091=over 4 1422=over 4
1092 1423
1093=item Project Coordinator 1424=item Project Coordinator
1094 1425
1095@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1426Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1096 1427
1097=item Web page maintainter 1428L<http://software.schmorp.de/#rxvt-unicode>
1098
1099@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1100
1101L<@@RXVT_WEBPAGE@@>
1102 1429
1103=back 1430=back
1104 1431
1105=head1 AUTHORS 1432=head1 AUTHORS
1106 1433
1131=item Geoff Wing L<< <gcw@pobox.com> >> 1458=item Geoff Wing L<< <gcw@pobox.com> >>
1132 1459
1133Rewrote screen display and text selection routines. Project Coordinator 1460Rewrote screen display and text selection routines. Project Coordinator
1134(changes.txt 2.4.6 - rxvt-unicode) 1461(changes.txt 2.4.6 - rxvt-unicode)
1135 1462
1136=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1463=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1137 1464
1138Forked rxvt-unicode, rewrote most of the display code and internal 1465Forked rxvt-unicode, rewrote most of the display code and internal
1139character handling to store text in unicode, improve xterm 1466character handling to store text in unicode, improve xterm
1140compatibility and apply numerous other bugfixes and extensions. 1467compatibility and apply numerous other bugfixes and extensions.
1141 1468

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines