ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.36 by root, Wed Dec 15 05:10:57 2004 UTC vs.
Revision 1.83 by root, Tue Jan 3 22:28:07 2006 UTC

14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16 16
17=head1 FREQUENTLY ASKED QUESTIONS 17=head1 FREQUENTLY ASKED QUESTIONS
18 18
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of frequently 19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20asked questions and answer to them and some common problems. 20frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
21 23
22=head1 RXVT-UNICODE VS. RXVT 24=head1 RXVT-UNICODE VS. RXVT
23 25
24Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
25internally. That means it can store and display most scripts in the 27internally. That means it can store and display most scripts in the
103 105
104=item B<-j>|B<+j> 106=item B<-j>|B<+j>
105 107
106Turn on/off jump scrolling; resource B<jumpScroll>. 108Turn on/off jump scrolling; resource B<jumpScroll>.
107 109
108=item B<-ip>|B<+ip> 110=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
109 111
110Turn on/off inheriting parent window's pixmap. Alternative form is 112Turn on/off inheriting parent window's pixmap. Alternative form is
111B<-tr>; resource B<inheritPixmap>. 113B<-tr>; resource B<inheritPixmap>.
112 114
113=item B<-fade> I<number> 115=item B<-fade> I<number>
114 116
115Fade the text by the given percentage when focus is lost. 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
136Window foreground colour; resource B<foreground>. 148Window foreground colour; resource B<foreground>.
137 149
138=item B<-pixmap> I<file[;geom]> 150=item B<-pixmap> I<file[;geom]>
139 151
140Compile I<XPM>: Specify XPM file for the background and also optionally 152Compile I<XPM>: Specify XPM file for the background and also optionally
141specify its scaling with a geometry string. Note you may need to add 153specify its scaling with a geometry string. Note you may need to
142quotes to avoid special shell interpretation of the `;' in the 154add quotes to avoid special shell interpretation of the C<;> in the
143command-line; resource B<backgroundPixmap>. 155command-line; resource B<backgroundPixmap>.
144 156
145=item B<-cr> I<colour> 157=item B<-cr> I<colour>
146 158
147The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
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 font-styles: The bold font list to use when B<bold> characters are to
183be printed. See resource B<boldFont> for details. 195be 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 font-styles: The italic font list to use when I<italic> characters are to
188be printed. See resource B<italicFont> for details. 200be 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 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 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
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>.
282 301
283=item B<-lsp> I<number> 302=item B<-lsp> I<number>
284 303
285Compile I<linespace>: Lines (pixel height) to insert between each row 304Compile I<frills>: Lines (pixel height) to insert between each row of
286of the display; resource B<linespace>. 305the display. Useful to work around font rendering problems; resource
306B<linespace>.
287 307
288=item B<-tn> I<termname> 308=item B<-tn> I<termname>
289 309
290This option specifies the name of the terminal type to be set in the 310This option specifies the name of the terminal type to be set in the
291B<TERM> environment variable. This terminal type must exist in the 311B<TERM> environment variable. This terminal type must exist in the
300given on the command line. If this option is used, it must be the last 320given on the command line. If this option is used, it must be the last
301on the command-line. If there is no B<-e> option then the default is to 321on the command-line. If there is no B<-e> option then the default is to
302run the program specified by the B<SHELL> environment variable or, 322run the program specified by the B<SHELL> environment variable or,
303failing that, I<sh(1)>. 323failing that, I<sh(1)>.
304 324
325Please note that you must specify a program with arguments. If you want to
326run shell commands, you have to specify the shell, like this:
327
328 @@RXVT_NAME@@ -e sh -c "shell commands"
329
305=item B<-title> I<text> 330=item B<-title> I<text>
306 331
307Window title (B<-T> still respected); the default title is the basename 332Window title (B<-T> still respected); the default title is the basename
308of the program specified after the B<-e> option, if any, otherwise the 333of the program specified after the B<-e> option, if any, otherwise the
309application name; resource B<title>. 334application name; resource B<title>.
327 352
328Compile I<XIM>: input method name. resource B<inputMethod>. 353Compile I<XIM>: input method name. resource B<inputMethod>.
329 354
330=item B<-imlocale> I<string> 355=item B<-imlocale> I<string>
331 356
332The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 357The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
333de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 358C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
334extension to be able to input japanese characters while staying in 359input extension to be able to input japanese characters while staying in
335another locale. 360another locale. resource B<imLocale>.
361
362=item B<-imfont> I<fontset>
363
364Set the font set to use for the X Input Method, see resource B<imFont>
365for more info.
366
367=item B<-tcw>
368
369Change the meaning of triple-click selection with the left mouse
370button. Instead of selecting a full line it will extend the selection the
371end of the logical line only. resource B<tripleclickwords>.
336 372
337=item B<-insecure> 373=item B<-insecure>
338 374
339Enable "insecure" mode, which currently enables most of the escape 375Enable "insecure" mode, which currently enables most of the escape
340sequences that echo strings. See the resource B<insecure> for more 376sequences that echo strings. See the resource B<insecure> for more
354=item B<-ssr>|B<+ssr> 390=item B<-ssr>|B<+ssr>
355 391
356Turn on/off secondary screen scroll (default enabled); resource 392Turn on/off secondary screen scroll (default enabled); resource
357B<secondaryScroll>. 393B<secondaryScroll>.
358 394
395=item B<-hold>|B<+hold>
396
397Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
398will not immediately destroy its window when the program executed within
399it exits. Instead, it will wait till it is being killed or closed by the
400user; resource B<hold>.
401
402=item B<-keysym.>I<sym> I<string>
403
404Remap a key symbol. See resource B<keysym>.
405
406=item B<-embed> I<windowid>
407
408Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
409which enables applications to easily embed a terminal.
410
411Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
412shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
413quite a bit, so don't expect it to keep some specific state. It's best to
414create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
415
416The window will not be destroyed when @@RXVT_NAME@@ exits.
417
418It might be useful to know that @@RXVT_NAME@@ will not close file
419descriptors passed to it (except for stdin/out/err, of course), so you
420can use file descriptors to communicate with the programs within the
421terminal. This works regardless of wether the C<-embed> option was used or
422not.
423
424Here is a short Gtk2-perl snippet that illustrates how this option can be
425used (a longer example is in F<doc/embed>):
426
427 my $rxvt = new Gtk2::Socket;
428 $rxvt->signal_connect_after (realize => sub {
429 my $xid = $_[0]->window->get_xid;
430 system "@@RXVT_NAME@@ -embed $xid &";
431 });
432
433=item B<-pty-fd> I<fileno>
434
435Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
436pair but instead use the given filehandle as the tty master. This is
437useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
438without having to run a program within it.
439
440If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
441entries and will not tinker with pty/tty permissions - you have to do that
442yourself if you want that.
443
444Here is a example in perl that illustrates how this option can be used (a
445longer example is in F<doc/pty-fd>):
446
447 use IO::Pty;
448 use Fcntl;
449
450 my $pty = new IO::Pty;
451 fcntl $pty, F_SETFD, 0; # clear close-on-exec
452 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
453 close $pty;
454
455 # now communicate with rxvt
456 my $slave = $pty->slave;
457 while (<$slave>) { print $slave "got <$_>\n" }
458
359=item B<-xrm> I<resourcestring> 459=item B<-pe> I<string>
360 460
361No effect on rxvt-unicode. Simply passes through an argument to be made 461Colon-separated list of perl extension scripts to use in this terminal instance. See resource B<perl-ext>.
362available in the instance's argument list. Appears in I<WM_COMMAND> in
363some window managers.
364 462
365=back 463=back
366 464
367=head1 RESOURCES (available also as long-options) 465=head1 RESOURCES (available also as long-options)
368 466
371 469
372There are two different methods that @@RXVT_NAME@@ can use to get the 470There are two different methods that @@RXVT_NAME@@ can use to get the
373Xresource data: using the X libraries (Xrm*-functions) or internal 471Xresource data: using the X libraries (Xrm*-functions) or internal
374Xresources reader (B<~/.Xdefaults>). For the first method (ie. 472Xresources reader (B<~/.Xdefaults>). For the first method (ie.
375B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 473B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the
376resources using X11 tools like B<xset>. Many distribution do also load 474resources using X11 tools like B<xrdb>. Many distribution do also load
377settings from the B<~/.Xresources> file when X starts. 475settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
476will consult the following files/resources in order, with later settings
477overwriting earlier ones:
478
479 1. system-wide app-defaults file, either locale-dependent OR global
480 2. app-defaults file in $XAPPLRESDIR
481 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
482 4. SCREEN_RESOURCES for the current screen
483 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
378 484
379If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 485If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
380lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 486lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
381set in XAPPLOADDIR/URxvt (compile-time defined: usually 487set in XAPPLOADDIR/URxvt (compile-time defined: usually
382B</usr/lib/X11/app-defaults/URxvt>) and resources set in 488B</usr/lib/X11/app-defaults/URxvt>) and resources set in
427 533
428=item B<colorIT:> I<colour> 534=item B<colorIT:> I<colour>
429 535
430Use the specified colour to display bold or italic characters when the 536Use the specified colour to display bold or italic characters when the
431foreground colour is the default. If font styles are not available 537foreground colour is the default. If font styles are not available
432(Compile styles) and this option is unset, reverse video is used instead. 538(Compile I<styles>) and this option is unset, reverse video is used instead.
433 539
434=item B<colorUL:> I<colour> 540=item B<colorUL:> I<colour>
435 541
436Use the specified colour to display underlined characters when the 542Use the specified colour to display underlined characters when the
437foreground colour is the default. 543foreground colour is the default.
475artificial transparency. B<False>: do not inherit the parent windows' 581artificial transparency. B<False>: do not inherit the parent windows'
476pixmap. 582pixmap.
477 583
478=item B<fading:> I<number> 584=item B<fading:> I<number>
479 585
480Fade the text by the given percentage when focus is lost. 586Fade the text by the given percentage when focus is lost; option B<-fade>.
587
588=item B<fadeColor:> I<colour>
589
590Fade to this colour, when fading is used (see B<fading:>). The default
591colour is black; option B<-fadecolor>.
481 592
482=item B<tintColor:> I<colour> 593=item B<tintColor:> I<colour>
483 594
484Tint the transparent background pixmap with the given colour. 595Tint the transparent background pixmap with the given colour; option
596B<-tint>.
485 597
486=item B<shading:> I<number> 598=item B<shading:> I<number>
487 599
488Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 600Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
489image in addition to tinting it. 601image in addition to tinting it.
493Use the specified colour for the scrollbar [default #B2B2B2]. 605Use the specified colour for the scrollbar [default #B2B2B2].
494 606
495=item B<troughColor:> I<colour> 607=item B<troughColor:> I<colour>
496 608
497Use the specified colour for the scrollbar's trough area [default 609Use the specified colour for the scrollbar's trough area [default
498#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 610#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
499 611
500=item B<borderColor:> I<colour> 612=item B<borderColor:> I<colour>
501 613
502The colour of the border around the text area and between the scrollbar 614The colour of the border around the text area and between the scrollbar
503and the text. 615and the text.
530 642
531Select the fonts to be used. This is a comma separated list of font 643Select the fonts to be used. This is a comma separated list of font
532names that are used in turn when trying to display Unicode characters. 644names that are used in turn when trying to display Unicode characters.
533The first font defines the cell size for characters; other fonts might 645The first font defines the cell size for characters; other fonts might
534be smaller, but not larger. A reasonable default font list is always 646be smaller, but not larger. A reasonable default font list is always
535appended to it. option B<-fn>. 647appended to it; option B<-fn>.
536 648
537Each font can either be a standard X11 core font (XLFD) name, with 649Each font can either be a standard X11 core font (XLFD) name, with
538optional prefix C<x:> or a Xft font (Compile xft), prefixed with C<xft:>. 650optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
539 651
540In addition, each font can be prefixed with additional hints and 652In addition, each font can be prefixed with additional hints and
541specifications enclosed in square brackets (C<[]>). The only available 653specifications enclosed in square brackets (C<[]>). The only available
542hint currently is C<codeset=codeset-name>, and this is only used for Xft 654hint currently is C<codeset=codeset-name>, and this is only used for Xft
543fonts. 655fonts.
586not possible, replacement fonts of the desired shape will be tried. 698not possible, replacement fonts of the desired shape will be tried.
587 699
588If set, but empty, then this specific style is disabled and the normal 700If set, but empty, then this specific style is disabled and the normal
589text font will being used for the given style. 701text font will being used for the given style.
590 702
703=item B<intensityStyles:> I<boolean>
704
705When font styles are not enabled, or this option is enabled (B<True>,
706option B<-is>, the default), bold and italic font styles imply high
707intensity foreground/backround colours. Disabling this option (B<False>,
708option B<+is>) disables this behaviour, the high intensity colours are not
709reachable.
710
591=item B<selectstyle:> I<mode> 711=item B<selectstyle:> I<mode>
592 712
593Set mouse selection style to B<old> which is 2.20, B<oldword> which is 713Set mouse selection style to B<old> which is 2.20, B<oldword> which is
594xterm style with 2.20 old word selection, or anything else which gives 714xterm style with 2.20 old word selection, or anything else which gives
595xterm style selection. 715xterm style selection.
596 716
597=item B<scrollstyle:> I<mode> 717=item B<scrollstyle:> I<mode>
598 718
599Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 719Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
600the author's favourite.. 720the author's favourite.
601 721
602=item B<title:> I<string> 722=item B<title:> I<string>
603 723
604Set window title string, the default title is the command-line 724Set window title string, the default title is the command-line
605specified after the B<-e> option, if any, otherwise the application 725specified after the B<-e> option, if any, otherwise the application
637 757
638Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 758Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
639B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 759B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
640B<Shift-Print> to include the scrollback as well. 760B<Shift-Print> to include the scrollback as well.
641 761
762The string will be interpreted as if typed into the shell as-is.
763
764Example:
765
766 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
767
768This creates a new file in your home directory with the screen contents
769everytime you hit C<Print>.
770
642=item B<scrollBar:> I<boolean> 771=item B<scrollBar:> I<boolean>
643 772
644B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 773B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
645disable the scrollbar; option B<+sb>. 774disable the scrollbar; option B<+sb>.
646 775
666B<+si>. 795B<+si>.
667 796
668=item B<scrollWithBuffer:> I<boolean> 797=item B<scrollWithBuffer:> I<boolean>
669 798
670B<True>: scroll with scrollback buffer when tty receives new lines (and 799B<True>: scroll with scrollback buffer when tty receives new lines (and
671B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 800B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
672with scrollback buffer when tty recieves new lines; option B<-sw>. 801with scrollback buffer when tty recieves new lines; option B<+sw>.
673 802
674=item B<scrollTtyKeypress:> I<boolean> 803=item B<scrollTtyKeypress:> I<boolean>
675 804
676B<True>: scroll to bottom when a non-special key is pressed. Special keys 805B<True>: scroll to bottom when a non-special key is pressed. Special keys
677are those which are intercepted by rxvt-unicode for special handling and 806are those which are intercepted by rxvt-unicode for special handling and
742 871
743Mouse pointer background colour. 872Mouse pointer background colour.
744 873
745=item B<pointerBlankDelay:> I<number> 874=item B<pointerBlankDelay:> I<number>
746 875
747Specifies number of seconds before blanking the pointer [default 2]. 876Specifies number of seconds before blanking the pointer [default 2]. Use a
877large number (e.g. C<987654321>) to effectively disable the timeout.
748 878
749=item B<backspacekey:> I<string> 879=item B<backspacekey:> I<string>
750 880
751The string to send when the backspace key is pressed. If set to B<DEC> 881The string to send when the backspace key is pressed. If set to B<DEC>
752or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 882or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
774 904
775I<name> of inputMethod to use; option B<-im>. 905I<name> of inputMethod to use; option B<-im>.
776 906
777=item B<imLocale:> I<name> 907=item B<imLocale:> I<name>
778 908
779The locale to use for opening the IM. You can use an LC_CTYPE of e.g. 909The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
780de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input 910C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
781extension to be able to input japanese characters while staying in 911input extension to be able to input japanese characters while staying in
782another locale. option B<-imlocale>. 912another locale; option B<-imlocale>.
913
914=item B<imFont:> I<fontset>
915
916Specify the font-set used for XIM styles C<OverTheSpot> or
917C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
918by commas), i.e. it's not in the same format as the other font lists used
919in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found
920found, preferably one or two pixels differing in size to the base font.
921option B<-imfont>.
922
923=item B<tripleclickwords:> I<boolean>
924
925Change the meaning of triple-click selection with the left mouse
926button. Instead of selecting a full line it will extend the selection to
927the end of the logical line only; option B<-tcw>.
783 928
784=item B<insecure:> I<boolean> 929=item B<insecure:> I<boolean>
785 930
786Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 931Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
787echo arbitrary strings like the icon name or the locale. This could be 932echo arbitrary strings like the icon name or the locale. This could be
788abused if somebody gets 8-bit-clean access to your display, whether 933abused if somebody gets 8-bit-clean access to your display, whether
789throuh a mail client displaying mail bodies unfiltered or though 934through a mail client displaying mail bodies unfiltered or through
790write(1). Therefore, these sequences are disabled by default. (Note 935write(1) or any other means. Therefore, these sequences are disabled by
791that other terminals, including xterm, have these sequences 936default. (Note that many other terminals, including xterm, have these
792enabled by default). You can enable them by setting this boolean 937sequences enabled by default, which doesn't make it safer, though).
793resource or specifying B<-insecure> as an option. At the moment, this 938
794enabled display-answer, locale, findfont, icon label and window title 939You can enable them by setting this boolean resource or specifying
795requests as well as dynamic menubar dispatch. 940B<-insecure> as an option. At the moment, this enables display-answer,
941locale, findfont, icon label and window title requests as well as dynamic
942menubar dispatch.
796 943
797=item B<modifier:> I<modifier> 944=item B<modifier:> I<modifier>
798 945
799Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 946Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
800B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 947B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
815Turn on/off secondary screen scroll (default enabled). If the this 962Turn on/off secondary screen scroll (default enabled). If the this
816option is enabled, scrolls on the secondary screen will change the 963option is enabled, scrolls on the secondary screen will change the
817scrollback buffer and switching to/from the secondary screen will 964scrollback buffer and switching to/from the secondary screen will
818instead scroll the screen up. 965instead scroll the screen up.
819 966
967=item B<hold>: I<bool>
968
969Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
970will not immediately destroy its window when the program executed within
971it exits. Instead, it will wait till it is being killed or closed by the
972user.
973
820=item B<keysym.>I<sym>: I<string> 974=item B<keysym.>I<sym>: I<string>
821 975
822Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may 976Compile I<frills>: Associate I<string> with keysym I<sym>. The
823contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: 977intervening resource name B<keysym.> cannot be omitted.
824newline, \r: return, \t: 978
979The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be
980any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>,
981B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>,
982and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>,
983B<2>, B<3>, B<4>, B<5>.
984
985The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
986whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
987keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
988current application keymap mode state.
989
990The spellings of I<key> can be obtained by using B<xev>(1) command or
991searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
992omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
993keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
994performed in an exact manner; however, the closest match is assured.
995
996I<string> may contain escape values (C<\a>: bell, C<\b>: backspace,
997C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
825tab, \000: octal number) or control characters (^?: delete, ^@: null, 998C<\000>: octal number) or verbatim control characters (C<^?>: delete,
826^A ...) and may enclosed with double quotes so that it can start or end 999C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
827with whitespace. The intervening resource name B<keysym.> cannot be 1000can start or end with whitespace.
828omitted. This resource is only available when compiled with 1001
829KEYSYM_RESOURCE. 1002Please note that you need to double the C<\> when using
1003C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
1004use C<\033> instead of C<\e> (and so on), which will work with both Xt and
1005@@RXVT_NAME@@'s own processing).
1006
1007You can define a range of keysyms in one shot by providing a I<string>
1008with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
1009should be a character not used by the strings.
1010
1011Its usage can be demonstrated by an example:
1012
1013 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1014
1015The above line is equivalent to the following three lines:
1016
1017 URxvt.keysym.Meta-Control-0x61: \033<M-C-a>
1018 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
1019 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
1020
1021If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1022is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1023example the following means "change the current locale to C<zh_CN.GBK>
1024when Control-Meta-c is being pressed":
1025
1026 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1027
1028If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1029is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1030manpage. For example, the F<selection> extension (activated via
1031C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1032
1033 URxvt.keysym.M-C-c: perl:selection:rot13
1034
1035Due the the large number of modifier combinations, a defined key mapping
1036will match if at I<at least> the specified identifiers are being set, and
1037no other key mappings with those and more bits are being defined. That
1038means that defining a key map for C<a> will automatically provide
1039definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1040mappings themselves.
1041
1042Unfortunately, this will override built-in key mappings. For example
1043if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1044C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1045user-defined keymap using the C<builtin:> replacement:
1046
1047 URxvt.keysym.Insert: <my insert key sequence>
1048 URxvt.keysym.S-Insert: builtin:
1049
1050The first line defines a mapping for C<Insert> and I<any> combination
1051of modifiers. The second line re-establishes the default mapping for
1052C<Shift-Insert>.
1053
1054The following example will map Control-Meta-1 and Control-Meta-2 to
1055the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1056font-switching at runtime:
1057
1058 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1059 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1060
1061Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1062info):
1063
1064 URxvt.keysym.M-C-3: command:\033[8;25;80t
1065 URxvt.keysym.M-C-4: command:\033[8;48;110t
1066
1067=item B<perl-ext>: I<string>
1068
1069Colon-separated list of perl extension scripts to use in this terminal
1070instance. Each extension is looked up in the library directories, loaded
1071if necessary, and bound to the current terminal instance. If this resource
1072is empty or missing, then the perl interpreter will not be initialized;
1073option B<-pe>.
1074
1075=item B<perl-eval>: I<string>
1076
1077Perl code to be evaluated when all extensions have been registered. See the
1078@@RXVT_NAME@@perl(3) manpage.
1079
1080=item B<perl-lib>: I<path>
1081
1082Colon-separated list of additional directories that hold extension
1083scripts. When looking for extensions specified by the C<perl> resource,
1084@@RXVT_NAME@@ will first look in these directories and then in
1085F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1086
1087See the @@RXVT_NAME@@perl(3) manpage.
830 1088
831=back 1089=back
832 1090
833=head1 THE SCROLLBAR 1091=head1 THE SCROLLBAR
834 1092
848the normal text selection/insertion, hold either the Shift or the Meta 1106the normal text selection/insertion, hold either the Shift or the Meta
849(Alt) key while performing the desired mouse action. 1107(Alt) key while performing the desired mouse action.
850 1108
851If mouse reporting mode is active, the normal scrollbar actions are 1109If mouse reporting mode is active, the normal scrollbar actions are
852disabled -- on the assumption that we are using a fullscreen 1110disabled -- on the assumption that we are using a fullscreen
853application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1111application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
854(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1112(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
855up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), 1113up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
856respectively. 1114respectively.
857 1115
858=head1 TEXT SELECTION AND INSERTION 1116=head1 TEXT SELECTION AND INSERTION
859 1117
860The behaviour of text selection and insertion mechanism is similar to 1118The behaviour of text selection and insertion mechanism is similar to
862 1120
863=over 4 1121=over 4
864 1122
865=item B<Selection>: 1123=item B<Selection>:
866 1124
867Left click at the beginning of the region, drag to the end of the 1125Left click at the beginning of the region, drag to the end of the region
868region and release; Right click to extend the marked region; Left 1126and release; Right click to extend the marked region; Left double-click
869double-click to select a word; Left triple-click to select the entire 1127to select a word; Left triple-click to select the entire logical line
870line. 1128(which can span multiple screen lines), unless modified by resource
1129B<tripleclickwords>.
871 1130
872Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1131Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
873(Compile: frills) will create a rectangular selection instead of a normal 1132(Compile: I<frills>) will create a rectangular selection instead of a
874one. 1133normal one. In this mode, every selected row becomes its own line in the
1134selection, and trailing whitespace is visually underlined and removed from
1135the selection.
875 1136
876=item B<Insertion>: 1137=item B<Insertion>:
877 1138
878Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1139Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in
879an B<@@RXVT_NAME@@> window causes the current text selection to be 1140an B<@@RXVT_NAME@@> window causes the current text selection to be
887supported in rxvt-unicode. Bug me if you need this. 1148supported in rxvt-unicode. Bug me if you need this.
888 1149
889You can, however, switch fonts at runtime using escape sequences (and 1150You can, however, switch fonts at runtime using escape sequences (and
890therefore using the menubar), e.g.: 1151therefore using the menubar), e.g.:
891 1152
892 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1153 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
893 1154
894rxvt-unicode will automatically re-apply these fonts to the output so far. 1155rxvt-unicode will automatically re-apply these fonts to the output so far.
895 1156
896=head1 ISO 14755 SUPPORT 1157=head1 ISO 14755 SUPPORT
897 1158
901C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1162C<--enable-frills>, the rest is available when rxvt-unicode was compiled
902with C<--enable-iso14755>. 1163with C<--enable-iso14755>.
903 1164
904=over 4 1165=over 4
905 1166
906=item 5.1: Basic method 1167=item * 5.1: Basic method
907 1168
908This allows you to enter unicode characters using their hexcode. 1169This allows you to enter unicode characters using their hexcode.
909 1170
910Start by pressing and holding both C<Control> and C<Shift>, then enter 1171Start by pressing and holding both C<Control> and C<Shift>, then enter
911hex-digits (between one and six). Releasing C<Control> and C<Shift> will 1172hex-digits (between one and six). Releasing C<Control> and C<Shift> will
918address, which you cannot type. Fortunately, the card has the e-mail 1179address, which you cannot type. Fortunately, the card has the e-mail
919address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily 1180address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily
920by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>, 1181by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>,
921followed by releasing the modifier keys. 1182followed by releasing the modifier keys.
922 1183
923=item 5.2: Keyboard symbols entry method 1184=item * 5.2: Keyboard symbols entry method
924 1185
925This mode lets you input characters representing the keycap symbols of 1186This mode lets you input characters representing the keycap symbols of
926your keyboard, if representable in the current locale encoding. 1187your keyboard, if representable in the current locale encoding.
927 1188
928Start by pressing C<Control> and C<Shift> together, then releasing 1189Start by pressing C<Control> and C<Shift> together, then releasing
931keycap symbol. The symbol will only be entered when the key has been 1192keycap symbol. The symbol will only be entered when the key has been
932released, otherwise pressing e.g. C<Shift> would enter the symbol for 1193released, otherwise pressing e.g. C<Shift> would enter the symbol for
933C<ISO Level 2 Switch>, although your intention might have been to enter a 1194C<ISO Level 2 Switch>, although your intention might have been to enter a
934reverse tab (Shift-Tab). 1195reverse tab (Shift-Tab).
935 1196
936=item 5.3: Screen-selection entry method 1197=item * 5.3: Screen-selection entry method
937 1198
938While this is implemented already (it's basically the selection 1199While this is implemented already (it's basically the selection
939mechanism), it could be extended by displaying a unicode character map. 1200mechanism), it could be extended by displaying a unicode character map.
940 1201
941=item 5.4: Feedback method for identifying displayed characters for later input 1202=item * 5.4: Feedback method for identifying displayed characters for later input
942 1203
943This method lets you display the unicode character code associated with 1204This method lets you display the unicode character code associated with
944characters already displayed. 1205characters already displayed.
945 1206
946You enter this mode by holding down C<Control> and C<Shift> together, then 1207You enter this mode by holding down C<Control> and C<Shift> together, then
958With respect to conformance, rxvt-unicode is supposed to be compliant to 1219With respect to conformance, rxvt-unicode is supposed to be compliant to
959both scenario A and B of ISO 14755, including part 5.2. 1220both scenario A and B of ISO 14755, including part 5.2.
960 1221
961=head1 LOGIN STAMP 1222=head1 LOGIN STAMP
962 1223
963B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so 1224B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
964that it can be seen via the I<who(1)> command, and can accept messages. 1225it can be seen via the I<who(1)> command, and can accept messages. To
965To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on 1226allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
966some systems. 1227on some systems or setgid to root or to some other group on others.
967 1228
968=head1 COLORS AND GRAPHICS 1229=head1 COLORS AND GRAPHICS
969 1230
970In addition to the default foreground and background colours, 1231In addition to the default foreground and background colours,
971B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1232B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1014 1275
1015=back 1276=back
1016 1277
1017=head1 ENVIRONMENT 1278=head1 ENVIRONMENT
1018 1279
1019B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1280B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1020and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1281
1021window id number of the B<@@RXVT_NAME@@> window and it also uses and 1282=over 4
1022sets the environment variable B<DISPLAY> to specify which display 1283
1023terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1284=item B<TERM>
1024B<RXVTPATH> and B<PATH> to find XPM files. 1285
1286Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1287resources or on the commandline.
1288
1289=item B<COLORTERM>
1290
1291Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
1292compiled with XPM support, and optionally with the added extension
1293C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1294
1295=item B<COLORFGBG>
1296
1297Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1298the colour code used as default foreground/text colour (or the string
1299C<default> to indicate that the default-colour escape sequence is to be
1300used), C<bg> is the colour code used as default background colour (or the
1301string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1302was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1303(and do) use this information to optimize screen output.
1304
1305=item B<WINDOWID>
1306
1307Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1308window, which usually has subwindows for the scrollbar, the terminal
1309window and so on).
1310
1311=item B<TERMINFO>
1312
1313Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1314C<--with-terminfo=PATH>.
1315
1316=item B<DISPLAY>
1317
1318Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1319display in it's child processes.
1320
1321=item B<SHELL>
1322
1323The shell to be used for command execution, defaults to C</bin/sh>.
1324
1325=item B<RXVTPATH>
1326
1327The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1328files.
1329
1330=item B<PATH>
1331
1332Used in the same way as C<RXVTPATH>.
1333
1334=item B<RXVT_SOCKET>
1335
1336The unix domain socket path used by @@RXVT_NAME@@c(1) and
1337@@RXVT_NAME@@d(1).
1338
1339Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1340
1341=item B<HOME>
1342
1343Used to locate the default directory for the unix domain socket for
1344daemon communications and to locate various resource files (such as
1345C<.Xdefaults>)
1346
1347=item B<XAPPLRESDIR>
1348
1349Directory where various X resource files are being located.
1350
1351=item B<XENVIRONMENT>
1352
1353If set and accessible, gives the name of a X resource file to be loaded by
1354@@RXVT_NAME@@.
1355
1356=back
1025 1357
1026=head1 FILES 1358=head1 FILES
1027 1359
1028=over 4 1360=over 4
1029 1361
1030=item B</etc/utmp>
1031
1032System file for login records.
1033
1034=item B</usr/lib/X11/rgb.txt> 1362=item B</usr/lib/X11/rgb.txt>
1035 1363
1036Color names. 1364Color names.
1037 1365
1038=back 1366=back
1039 1367
1040=head1 SEE ALSO 1368=head1 SEE ALSO
1041 1369
1042@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1370@@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)
1043
1044=head1 BUGS
1045
1046Check the BUGS file for an up-to-date list.
1047
1048Cursor change support is not yet implemented.
1049
1050Click-and-drag doesn't work with X11 mouse report overriding.
1051 1371
1052=head1 CURRENT PROJECT COORDINATOR 1372=head1 CURRENT PROJECT COORDINATOR
1053 1373
1054=over 4 1374=over 4
1055 1375
1056=item Project Coordinator 1376=item Project Coordinator
1057 1377
1058@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1378Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1059 1379
1060=item Web page maintainter 1380L<http://software.schmorp.de/#rxvt-unicode>
1061
1062@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1063
1064L<@@RXVT_WEBPAGE@@>
1065 1381
1066=back 1382=back
1067 1383
1068=head1 AUTHORS 1384=head1 AUTHORS
1069 1385
1094=item Geoff Wing L<< <gcw@pobox.com> >> 1410=item Geoff Wing L<< <gcw@pobox.com> >>
1095 1411
1096Rewrote screen display and text selection routines. Project Coordinator 1412Rewrote screen display and text selection routines. Project Coordinator
1097(changes.txt 2.4.6 - rxvt-unicode) 1413(changes.txt 2.4.6 - rxvt-unicode)
1098 1414
1099=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1415=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1100 1416
1101Forked rxvt-unicode, rewrote most of the display code and internal 1417Forked rxvt-unicode, rewrote most of the display code and internal
1102character handling to store text in unicode, improve xterm 1418character handling to store text in unicode, improve xterm
1103compatibility and apply numerous other bugfixes and extensions. 1419compatibility and apply numerous other bugfixes and extensions.
1104 1420

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines