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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines