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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.48 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.105 by root, Wed Jan 25 13:26:48 2006 UTC

14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16 16
17=head1 FREQUENTLY ASKED QUESTIONS 17=head1 FREQUENTLY ASKED QUESTIONS
18 18
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of frequently 19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20asked questions and answer to them and some common problems. 20frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>.
21 23
22=head1 RXVT-UNICODE VS. RXVT 24=head1 RXVT-UNICODE VS. RXVT
23 25
24Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
25internally. That means it can store and display most scripts in the 27internally. That means it can store and display most scripts in the
103 105
104=item B<-j>|B<+j> 106=item B<-j>|B<+j>
105 107
106Turn on/off jump scrolling; resource B<jumpScroll>. 108Turn on/off jump scrolling; resource B<jumpScroll>.
107 109
108=item B<-ip>|B<+ip> 110=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
109 111
110Turn on/off inheriting parent window's pixmap. Alternative form is 112Turn on/off inheriting parent window's pixmap. Alternative form is
111B<-tr>; resource B<inheritPixmap>. 113B<-tr>; resource B<inheritPixmap>.
112 114
113=item B<-fade> I<number> 115=item B<-fade> I<number>
114 116
115Fade the text by the given percentage when focus is lost. resource B<fading>. 117Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>.
120
121=item B<-fadecolor> I<colour>
122
123Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>.
116 125
117=item B<-tint> I<colour> 126=item B<-tint> I<colour>
118 127
119Tint the transparent background pixmap with the given colour when 128Tint the transparent background pixmap with the given colour when
120transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> 129transparency is enabled with B<-tr> or B<-ip>. This only works for
121option that can be used to brighten or darken the image in addition to 130non-tiled backgrounds, currently. See also the B<-sh> option that can be
122tinting it. 131used to brighten or darken the image in addition to tinting it; resource
132I<tintColor>. Example:
133
134 @@RXVT_NAME@@ -tr -tint blue -sh 40
123 135
124=item B<-sh> 136=item B<-sh>
125 137
126I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
127background image in addition to tinting it (i.e. B<-tint> must be 139background image in addition to tinting it (i.e. B<-tint> must be
160resource B<borderColor>. 172resource B<borderColor>.
161 173
162=item B<-fn> I<fontlist> 174=item B<-fn> I<fontlist>
163 175
164Select the fonts to be used. This is a comma separated list of font names 176Select the fonts to be used. This is a comma separated list of font names
165that are used in turn when trying to display Unicode characters. The 177that are checked in order when trying to find glyphs for characters. The
166first font defines the cell size for characters; other fonts might be 178first font defines the cell size for characters; other fonts might be
167smaller, but not (in general) larger. A (hopefully) reasonable default 179smaller, but not (in general) larger. A (hopefully) reasonable default
168font list is always appended to it. See resource B<font> for more details. 180font list is always appended to it. See resource B<font> for more details.
169 181
170In short, to specify an X11 core font, just specify it's name or prefix it 182In short, to specify an X11 core font, just specify it's name or prefix it
177See also the question "How does rxvt-unicode choose fonts?" in the FAQ 189See also the question "How does rxvt-unicode choose fonts?" in the FAQ
178section of @@RXVT_NAME@@(7). 190section of @@RXVT_NAME@@(7).
179 191
180=item B<-fb> I<fontlist> 192=item B<-fb> I<fontlist>
181 193
182Compile font-styles: The bold font list to use when bold characters are to 194Compile I<font-styles>: The bold font list to use when B<bold> characters
183be printed. See resource B<boldFont> for details. 195are to be printed. See resource B<boldFont> for details.
184 196
185=item B<-fi> I<fontlist> 197=item B<-fi> I<fontlist>
186 198
187Compile font-styles: The italic font list to use when bold characters are to 199Compile I<font-styles>: The italic font list to use when I<italic>
188be printed. See resource B<italicFont> for details. 200characters are to be printed. See resource B<italicFont> for details.
189 201
190=item B<-fbi> I<fontlist> 202=item B<-fbi> I<fontlist>
191 203
192Compile font-styles: The bold italic font list to use when bold characters are to 204Compile I<font-styles>: The bold italic font list to use when B<< I<bold
193be printed. See resource B<boldItalicFont> for details. 205italic> >> characters are to be printed. See resource B<boldItalicFont>
206for details.
207
208=item B<-is>|B<+is>
209
210Compile I<font-styles>: Bold/Italic font styles imply high intensity
211foreground/background (default). See resource B<intensityStyles> for
212details.
194 213
195=item B<-name> I<name> 214=item B<-name> I<name>
196 215
197Specify the application name under which resources are to be obtained, 216Specify the application name under which resources are to be obtained,
198rather than the default executable file name. Name should not contain 217rather than the default executable file name. Name should not contain
236 255
237Put scrollbar on right/left; resource B<scrollBar_right>. 256Put scrollbar on right/left; resource B<scrollBar_right>.
238 257
239=item B<-st>|B<+st> 258=item B<-st>|B<+st>
240 259
241Display normal (non XTerm/NeXT) scrollbar without/with a trough; 260Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
242resource B<scrollBar_floating>. 261resource B<scrollBar_floating>.
243 262
244=item B<-ptab>|B<+ptab> 263=item B<-ptab>|B<+ptab>
245 264
246If enabled (default), "Horizontal Tab" characters are being stored as 265If enabled (default), "Horizontal Tab" characters are being stored as
277=item B<-bl> 296=item B<-bl>
278 297
279Compile I<frills>: Set MWM hints to request a borderless window, i.e. 298Compile I<frills>: Set MWM hints to request a borderless window, i.e.
280if honoured by the WM, the rxvt-unicode window will not have window 299if honoured by the WM, the rxvt-unicode window will not have window
281decorations; resource B<borderLess>. 300decorations; resource B<borderLess>.
301
302=item B<-override-redirect>
303
304Compile I<frills>: Sets override-redirect on the window; resource
305B<override-redirect>.
306
307=item B<-sbg>
308
309Compile I<frills>: Disable the usage of the built-in block graphics/line
310drawing characters and just rely on what the specified fonts provide. Use
311this if you have a good font and want to use its block graphic glyphs;
312resource B<skipBuiltinGlyphs>.
282 313
283=item B<-lsp> I<number> 314=item B<-lsp> I<number>
284 315
285Compile I<frills>: Lines (pixel height) to insert between each row of 316Compile I<frills>: Lines (pixel height) to insert between each row of
286the display. Useful to work around font rendering problems; resource 317the display. Useful to work around font rendering problems; resource
301given on the command line. If this option is used, it must be the last 332given on the command line. If this option is used, it must be the last
302on the command-line. If there is no B<-e> option then the default is to 333on the command-line. If there is no B<-e> option then the default is to
303run the program specified by the B<SHELL> environment variable or, 334run the program specified by the B<SHELL> environment variable or,
304failing that, I<sh(1)>. 335failing that, I<sh(1)>.
305 336
337Please note that you must specify a program with arguments. If you want to
338run shell commands, you have to specify the shell, like this:
339
340 @@RXVT_NAME@@ -e sh -c "shell commands"
341
306=item B<-title> I<text> 342=item B<-title> I<text>
307 343
308Window title (B<-T> still respected); the default title is the basename 344Window title (B<-T> still respected); the default title is the basename
309of the program specified after the B<-e> option, if any, otherwise the 345of the program specified after the B<-e> option, if any, otherwise the
310application name; resource B<title>. 346application name; resource B<title>.
366=item B<-ssr>|B<+ssr> 402=item B<-ssr>|B<+ssr>
367 403
368Turn on/off secondary screen scroll (default enabled); resource 404Turn on/off secondary screen scroll (default enabled); resource
369B<secondaryScroll>. 405B<secondaryScroll>.
370 406
407=item B<-hold>|B<+hold>
408
409Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
410will not immediately destroy its window when the program executed within
411it exits. Instead, it will wait till it is being killed or closed by the
412user; resource B<hold>.
413
414=item B<-keysym.>I<sym> I<string>
415
416Remap a key symbol. See resource B<keysym>.
417
418=item B<-embed> I<windowid>
419
420Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
421which enables applications to easily embed a terminal.
422
423Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
424shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
425quite a bit, so don't expect it to keep some specific state. It's best to
426create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
427
428The window will not be destroyed when @@RXVT_NAME@@ exits.
429
430It might be useful to know that @@RXVT_NAME@@ will not close file
431descriptors passed to it (except for stdin/out/err, of course), so you
432can use file descriptors to communicate with the programs within the
433terminal. This works regardless of wether the C<-embed> option was used or
434not.
435
436Here is a short Gtk2-perl snippet that illustrates how this option can be
437used (a longer example is in F<doc/embed>):
438
439 my $rxvt = new Gtk2::Socket;
440 $rxvt->signal_connect_after (realize => sub {
441 my $xid = $_[0]->window->get_xid;
442 system "@@RXVT_NAME@@ -embed $xid &";
443 });
444
445=item B<-pty-fd> I<file descriptor>
446
447Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
448pair but instead use the given filehandle as the tty master. This is
449useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
450without having to run a program within it.
451
452If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
453entries and will not tinker with pty/tty permissions - you have to do that
454yourself if you want that.
455
456As an extremely special case, specifying C<-1> will completely suppress
457pty/tty operations.
458
459Here is a example in perl that illustrates how this option can be used (a
460longer example is in F<doc/pty-fd>):
461
462 use IO::Pty;
463 use Fcntl;
464
465 my $pty = new IO::Pty;
466 fcntl $pty, F_SETFD, 0; # clear close-on-exec
467 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
468 close $pty;
469
470 # now communicate with rxvt
471 my $slave = $pty->slave;
472 while (<$slave>) { print $slave "got <$_>\n" }
473
371=item B<-xrm> I<resourcestring> 474=item B<-pe> I<string>
372 475
373No effect on rxvt-unicode. Simply passes through an argument to be made 476Comma-separated list of perl extension scripts to use (or not to use) in
374available in the instance's argument list. Appears in I<WM_COMMAND> in 477this terminal instance. See resource B<perl-ext> for details.
375some window managers.
376 478
377=back 479=back
378 480
379=head1 RESOURCES (available also as long-options) 481=head1 RESOURCES (available also as long-options)
380 482
381Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 483Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
382options) compiled into your version. 484options) compiled into your version.
383 485
384There are two different methods that @@RXVT_NAME@@ can use to get the 486You can set and change the resources using X11 tools like B<xrdb>. Many
385Xresource data: using the X libraries (Xrm*-functions) or internal 487distribution do also load settings from the B<~/.Xresources> file when X
386Xresources reader (B<~/.Xdefaults>). For the first method (ie. 488starts. @@RXVT_NAME@@ will consult the following files/resources in order,
387B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 489with later settings overwriting earlier ones:
388resources using X11 tools like B<xset>. Many distribution do also load
389settings from the B<~/.Xresources> file when X starts.
390 490
391If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> 491 1. system-wide app-defaults file, either locale-dependent OR global
392lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults 492 2. app-defaults file in $XAPPLRESDIR
393set in XAPPLOADDIR/URxvt (compile-time defined: usually 493 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
394B</usr/lib/X11/app-defaults/URxvt>) and resources set in 494 4. SCREEN_RESOURCES for the current screen
395B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist. 495 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
496
396Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 497Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
397class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 498names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
398resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 499common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
399easily configured, while the class name B<URxvt> allows resources 500configured, while the class name B<URxvt> allows resources unique to
400unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 501B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
401shared between different B<@@RXVT_NAME@@> configurations. If no 502configurations. If no resources are specified, suitable defaults will
402resources are specified, suitable defaults will be used. Command-line 503be used. Command-line arguments can be used to override resource
403arguments can be used to override resource settings. The following 504settings. The following resources are supported (you might want to
404resources are allowed: 505check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
506extensions not documented here):
405 507
406=over 4 508=over 4
407 509
408=item B<geometry:> I<geom> 510=item B<geometry:> I<geom>
409 511
487artificial transparency. B<False>: do not inherit the parent windows' 589artificial transparency. B<False>: do not inherit the parent windows'
488pixmap. 590pixmap.
489 591
490=item B<fading:> I<number> 592=item B<fading:> I<number>
491 593
492Fade the text by the given percentage when focus is lost. 594Fade the text by the given percentage when focus is lost; option B<-fade>.
595
596=item B<fadeColor:> I<colour>
597
598Fade to this colour, when fading is used (see B<fading:>). The default
599colour is black; option B<-fadecolor>.
493 600
494=item B<tintColor:> I<colour> 601=item B<tintColor:> I<colour>
495 602
496Tint the transparent background pixmap with the given colour. 603Tint the transparent background pixmap with the given colour; option
604B<-tint>.
497 605
498=item B<shading:> I<number> 606=item B<shading:> I<number>
499 607
500Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 608Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
501image in addition to tinting it. 609image in addition to tinting it.
505Use the specified colour for the scrollbar [default #B2B2B2]. 613Use the specified colour for the scrollbar [default #B2B2B2].
506 614
507=item B<troughColor:> I<colour> 615=item B<troughColor:> I<colour>
508 616
509Use the specified colour for the scrollbar's trough area [default 617Use the specified colour for the scrollbar's trough area [default
510#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 618#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
511 619
512=item B<borderColor:> I<colour> 620=item B<borderColor:> I<colour>
513 621
514The colour of the border around the text area and between the scrollbar 622The colour of the border around the text area and between the scrollbar
515and the text. 623and the text.
524of 1 displays the image without any scaling. A scale of 2 to 9 632of 1 displays the image without any scaling. A scale of 2 to 9
525specifies an integer number of images in that direction. No image will 633specifies an integer number of images in that direction. No image will
526be magnified beyond 10 times its original size. The maximum permitted 634be magnified beyond 10 times its original size. The maximum permitted
527scale is 1000. [default 0x0+50+50] 635scale is 1000. [default 0x0+50+50]
528 636
529=item B<menu:> I<file[;tag]>
530
531Read in the specified menu file (note the `.menu' extension is
532optional) and also optionally specify a starting tag to find. See the
533reference documentation for details on the syntax for the menuBar.
534
535=item B<path:> I<path> 637=item B<path:> I<path>
536 638
537Specify the colon-delimited search path for finding files (XPM and 639Specify the colon-delimited search path for finding XPM files.
538menus), in addition to the paths specified by the B<RXVTPATH> and
539B<PATH> environment variables.
540 640
541=item B<font:> I<fontlist> 641=item B<font:> I<fontlist>
542 642
543Select 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 names
544names that are used in turn when trying to display Unicode characters. 644that are checked in order when trying to find glyphs for characters. The
545The first font defines the cell size for characters; other fonts might 645first font defines the cell size for characters; other fonts might be
546be smaller, but not larger. A reasonable default font list is always 646smaller, but not (in general) larger. A (hopefully) reasonable default
547appended to it. option B<-fn>. 647font list is always appended to it; option B<-fn>.
548 648
549Each 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
550optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 650optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
551 651
552In addition, each font can be prefixed with additional hints and 652In addition, each font can be prefixed with additional hints and
554hint 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
555fonts. 655fonts.
556 656
557For example, this font resource 657For example, this font resource
558 658
559 URxvt*font: 9x15bold,\ 659 URxvt.font: 9x15bold,\
560 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 660 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
561 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 661 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
562 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 662 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
563 xft:Code2000:antialias=false 663 xft:Code2000:antialias=false
564 664
598not possible, replacement fonts of the desired shape will be tried. 698not possible, replacement fonts of the desired shape will be tried.
599 699
600If 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
601text font will being used for the given style. 701text font will being used for the given style.
602 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
603=item B<selectstyle:> I<mode> 711=item B<selectstyle:> I<mode>
604 712
605Set 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
606xterm 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
607xterm style selection. 715xterm style selection.
608 716
609=item B<scrollstyle:> I<mode> 717=item B<scrollstyle:> I<mode>
610 718
611Set 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
612the author's favourite.. 720the author's favourite.
613 721
614=item B<title:> I<string> 722=item B<title:> I<string>
615 723
616Set window title string, the default title is the command-line 724Set window title string, the default title is the command-line
617specified after the B<-e> option, if any, otherwise the application 725specified after the B<-e> option, if any, otherwise the application
649 757
650Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 758Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
651B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 759B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
652B<Shift-Print> to include the scrollback as well. 760B<Shift-Print> to include the scrollback as well.
653 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
654=item B<scrollBar:> I<boolean> 771=item B<scrollBar:> I<boolean>
655 772
656B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 773B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
657disable the scrollbar; option B<+sb>. 774disable the scrollbar; option B<+sb>.
658 775
678B<+si>. 795B<+si>.
679 796
680=item B<scrollWithBuffer:> I<boolean> 797=item B<scrollWithBuffer:> I<boolean>
681 798
682B<True>: scroll with scrollback buffer when tty receives new lines (and 799B<True>: scroll with scrollback buffer when tty receives new lines (and
683B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 800B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
684with scrollback buffer when tty recieves new lines; option B<-sw>. 801with scrollback buffer when tty recieves new lines; option B<+sw>.
685 802
686=item B<scrollTtyKeypress:> I<boolean> 803=item B<scrollTtyKeypress:> I<boolean>
687 804
688B<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
689are those which are intercepted by rxvt-unicode for special handling and 806are those which are intercepted by rxvt-unicode for special handling and
708=item B<borderLess:> I<boolean> 825=item B<borderLess:> I<boolean>
709 826
710Set MWM hints to request a borderless window, i.e. if honoured by the 827Set MWM hints to request a borderless window, i.e. if honoured by the
711WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 828WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
712 829
830=item B<skipBuiltinGlyphs:> I<boolean>
831
832Compile I<frills>: Disable the usage of the built-in block graphics/line
833drawing characters and just rely on what the specified fonts provide. Use
834this if you have a good font and want to use its block graphic glyphs;
835option B<-sbg>.
836
713=item B<termName:> I<termname> 837=item B<termName:> I<termname>
714 838
715Specifies the terminal type name to be set in the B<TERM> environment 839Specifies the terminal type name to be set in the B<TERM> environment
716variable; option B<-tn>. 840variable; option B<-tn>.
717 841
754 878
755Mouse pointer background colour. 879Mouse pointer background colour.
756 880
757=item B<pointerBlankDelay:> I<number> 881=item B<pointerBlankDelay:> I<number>
758 882
759Specifies number of seconds before blanking the pointer [default 2]. 883Specifies number of seconds before blanking the pointer [default 2]. Use a
884large number (e.g. C<987654321>) to effectively disable the timeout.
760 885
761=item B<backspacekey:> I<string> 886=item B<backspacekey:> I<string>
762 887
763The string to send when the backspace key is pressed. If set to B<DEC> 888The string to send when the backspace key is pressed. If set to B<DEC>
764or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 889or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
771pressed. If unset it will send the sequence traditionally associated 896pressed. If unset it will send the sequence traditionally associated
772with the B<Execute> key. 897with the B<Execute> key.
773 898
774=item B<cutchars:> I<string> 899=item B<cutchars:> I<string>
775 900
776The characters used as delimiters for double-click word selection. The 901The characters used as delimiters for double-click word selection
777built-in default: 902(whitespace delimiting is added automatically if resource is given).
903
904When the selection extension is in use (the default if compiled in, see
905the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
906will be created (if the resource exists, otherwise, no regex will be
907created). In this mode, characters outside ISO-8859-1 can be used.
908
909When the selection extension is not used, only ISO-8859-1 characters can
910be used. If not specified, the built-in default is used:
778 911
779B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 912B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
780 913
781=item B<preeditType:> I<style> 914=item B<preeditType:> I<style>
782 915
789=item B<imLocale:> I<name> 922=item B<imLocale:> I<name>
790 923
791The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 924The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
792C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the 925C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
793input extension to be able to input japanese characters while staying in 926input extension to be able to input japanese characters while staying in
794another locale. option B<-imlocale>. 927another locale; option B<-imlocale>.
795 928
796=item B<imFont:> I<fontset> 929=item B<imFont:> I<fontset>
797 930
798Specify the font-set used for XIM styles C<OverTheSpot> or 931Specify the font-set used for XIM styles C<OverTheSpot> or
799C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 932C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
804 937
805=item B<tripleclickwords:> I<boolean> 938=item B<tripleclickwords:> I<boolean>
806 939
807Change the meaning of triple-click selection with the left mouse 940Change the meaning of triple-click selection with the left mouse
808button. Instead of selecting a full line it will extend the selection to 941button. Instead of selecting a full line it will extend the selection to
809the end of the logical line only. option B<-tcw>. 942the end of the logical line only; option B<-tcw>.
810 943
811=item B<insecure:> I<boolean> 944=item B<insecure:> I<boolean>
812 945
813Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 946Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
814echo arbitrary strings like the icon name or the locale. This could be 947echo arbitrary strings like the icon name or the locale. This could be
815abused if somebody gets 8-bit-clean access to your display, whether 948abused if somebody gets 8-bit-clean access to your display, whether
816throuh a mail client displaying mail bodies unfiltered or though 949through a mail client displaying mail bodies unfiltered or through
817write(1). Therefore, these sequences are disabled by default. (Note 950write(1) or any other means. Therefore, these sequences are disabled by
818that other terminals, including xterm, have these sequences 951default. (Note that many other terminals, including xterm, have these
819enabled by default). You can enable them by setting this boolean 952sequences enabled by default, which doesn't make it safer, though).
820resource or specifying B<-insecure> as an option. At the moment, this 953
821enabled display-answer, locale, findfont, icon label and window title 954You can enable them by setting this boolean resource or specifying
822requests as well as dynamic menubar dispatch. 955B<-insecure> as an option. At the moment, this enables display-answer,
956locale, findfont, icon label and window title requests.
823 957
824=item B<modifier:> I<modifier> 958=item B<modifier:> I<modifier>
825 959
826Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 960Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
827B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 961B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
831 965
832Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 966Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
833character is passed through. It may contain escape values as described 967character is passed through. It may contain escape values as described
834in the entry on B<keysym> following. 968in the entry on B<keysym> following.
835 969
836=item B<secondaryScreen:> I<bool> 970=item B<secondaryScreen:> I<boolean>
837 971
838Turn on/off secondary screen (default enabled). 972Turn on/off secondary screen (default enabled).
839 973
840=item B<secondaryScroll:> I<bool> 974=item B<secondaryScroll:> I<boolean>
841 975
842Turn on/off secondary screen scroll (default enabled). If the this 976Turn on/off secondary screen scroll (default enabled). If the this
843option is enabled, scrolls on the secondary screen will change the 977option is enabled, scrolls on the secondary screen will change the
844scrollback buffer and switching to/from the secondary screen will 978scrollback buffer and switching to/from the secondary screen will
845instead scroll the screen up. 979instead scroll the screen up.
980
981=item B<hold>: I<boolean>
982
983Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
984will not immediately destroy its window when the program executed within
985it exits. Instead, it will wait till it is being killed or closed by the
986user.
846 987
847=item B<keysym.>I<sym>: I<string> 988=item B<keysym.>I<sym>: I<string>
848 989
849Compile I<frills>: Associate I<string> with keysym I<sym>. The 990Compile I<frills>: Associate I<string> with keysym I<sym>. The
850intervening resource name B<keysym.> cannot be omitted. 991intervening resource name B<keysym.> cannot be omitted.
870C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1011C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
871C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1012C<\000>: octal number) or verbatim control characters (C<^?>: delete,
872C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1013C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
873can start or end with whitespace. 1014can start or end with whitespace.
874 1015
875Please note that you need to double the C<\> when using 1016Please note that you need to double the C<\> in resource files, as
876C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can 1017Xlib itself does it's own de-escaping (you can use C<\033> instead of
877use C<\033> instead of C<\e> (and so on), which will work with both Xt and 1018C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
878@@RXVT_NAME@@'s own processing). 1019processing).
879 1020
880You can define a range of keysyms in one shot by providing a I<string> 1021You can define a range of keysyms in one shot by providing a I<string>
881with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1022with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
882should be a character not used by the strings. 1023should be a character not used by the strings.
883 1024
896example the following means "change the current locale to C<zh_CN.GBK> 1037example the following means "change the current locale to C<zh_CN.GBK>
897when Control-Meta-c is being pressed": 1038when Control-Meta-c is being pressed":
898 1039
899 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1040 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
900 1041
1042If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1043is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1044manpage. For example, the F<selection> extension (activated via
1045C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1046
1047 URxvt.keysym.M-C-c: perl:selection:rot13
1048
1049Due the the large number of modifier combinations, a defined key mapping
1050will match if at I<at least> the specified identifiers are being set, and
1051no other key mappings with those and more bits are being defined. That
1052means that defining a key map for C<a> will automatically provide
1053definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1054mappings themselves.
1055
1056Unfortunately, this will override built-in key mappings. For example
1057if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1058C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1059user-defined keymap using the C<builtin:> replacement:
1060
1061 URxvt.keysym.Insert: <my insert key sequence>
1062 URxvt.keysym.S-Insert: builtin:
1063
1064The first line defines a mapping for C<Insert> and I<any> combination
1065of modifiers. The second line re-establishes the default mapping for
1066C<Shift-Insert>.
1067
901The following example will map Control-Meta-1 and Control-Meta-2 to 1068The following example will map Control-Meta-1 and Control-Meta-2 to
902the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited 1069the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
903font-switching at runtime: 1070font-switching at runtime:
904 1071
905 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1072 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
908Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1075Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
909info): 1076info):
910 1077
911 URxvt.keysym.M-C-3: command:\033[8;25;80t 1078 URxvt.keysym.M-C-3: command:\033[8;25;80t
912 URxvt.keysym.M-C-4: command:\033[8;48;110t 1079 URxvt.keysym.M-C-4: command:\033[8;48;110t
1080
1081=item B<perl-ext-common>: I<string>
1082
1083=item B<perl-ext>: I<string>
1084
1085Comma-separated list(s) of perl extension scripts (default: C<default>) to
1086use in this terminal instance; option B<-pe>.
1087
1088Extension names can be prefixed with a C<-> sign to prohibit using
1089them. This can be useful to selectively disable some extensions loaded
1090by default, or specified via the C<perl-ext-common> resource. For
1091example, C<default,-selection> will use all the default extension except
1092C<selection>.
1093
1094Extension names can also be followed by an argument in angle brackets
1095(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1096searchable scorllback to Alt/Meta-s). Mentioning the same extension
1097multiple times with different arguments will pass multiple arguments to
1098the extension.
1099
1100Each extension is looked up in the library directories, loaded if
1101necessary, and bound to the current terminal instance.
1102
1103If both of these resources are the empty string, then the perl
1104interpreter will not be initialized. The idea behind two options is that
1105B<perl-ext-common> will be used for extensions that should be available to
1106all instances, while B<perl-ext> is used for specific instances.
1107
1108=item B<perl-eval>: I<string>
1109
1110Perl code to be evaluated when all extensions have been registered. See
1111the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1112will be ignored when running setuid/setgid.
1113
1114=item B<perl-lib>: I<path>
1115
1116Colon-separated list of additional directories that hold extension
1117scripts. When looking for extensions specified by the C<perl> resource,
1118@@RXVT_NAME@@ will first look in these directories and then in
1119F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1120will be ignored when running setuid/setgid.
1121
1122See the @@RXVT_NAME@@perl(3) manpage.
1123
1124=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1125
1126Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1127details.
1128
1129=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1130
1131Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1132for details.
1133
1134=item B<searchable-scrollback:> I<keysym>
1135
1136Sets the hotkey that starts the incremental scrollback buffer search
1137(default: C<M-s>).
1138
1139=item B<urlLauncher>: I<string>
1140
1141Specifies the program to be started with a URL argument. Used by the
1142C<selection-popup> and C<mark-urls> perl extensions.
1143
1144=item B<transient-for>: I<windowid>
1145
1146Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1147
1148=item B<override-redirect>: I<boolean>
1149
1150Compile I<frills>: Sets override-redirect for the terminal window, making
1151it almost invisible to window managers; option B<-override-redirect>.
913 1152
914=back 1153=back
915 1154
916=head1 THE SCROLLBAR 1155=head1 THE SCROLLBAR
917 1156
931the normal text selection/insertion, hold either the Shift or the Meta 1170the normal text selection/insertion, hold either the Shift or the Meta
932(Alt) key while performing the desired mouse action. 1171(Alt) key while performing the desired mouse action.
933 1172
934If mouse reporting mode is active, the normal scrollbar actions are 1173If mouse reporting mode is active, the normal scrollbar actions are
935disabled -- on the assumption that we are using a fullscreen 1174disabled -- on the assumption that we are using a fullscreen
936application. Instead, pressing Button1 and Button3 sends B<ESC[6~> 1175application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
937(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the 1176(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
938up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), 1177up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
939respectively. 1178respectively.
940 1179
941=head1 TEXT SELECTION AND INSERTION 1180=head1 TEXT SELECTION AND INSERTION
942 1181
943The behaviour of text selection and insertion mechanism is similar to 1182The behaviour of text selection and insertion mechanism is similar to
952to select a word; Left triple-click to select the entire logical line 1191to select a word; Left triple-click to select the entire logical line
953(which can span multiple screen lines), unless modified by resource 1192(which can span multiple screen lines), unless modified by resource
954B<tripleclickwords>. 1193B<tripleclickwords>.
955 1194
956Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1195Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
957(Compile: I<frills>) will create a rectangular selection instead of a normal 1196(Compile: I<frills>) will create a rectangular selection instead of a
958one. 1197normal one. In this mode, every selected row becomes its own line in the
1198selection, and trailing whitespace is visually underlined and removed from
1199the selection.
959 1200
960=item B<Insertion>: 1201=item B<Insertion>:
961 1202
962Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1203Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
963an B<@@RXVT_NAME@@> window causes the current text selection to be 1204window causes the value of the PRIMARY selection (or CLIPBOARD with the
964inserted as if it had been typed on the keyboard. 1205Meta modifier) to be inserted as if it had been typed on the keyboard.
1206
1207Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1208inserted too.
965 1209
966=back 1210=back
967 1211
968=head1 CHANGING FONTS 1212=head1 CHANGING FONTS
969 1213
970Changing fonts (or font sizes, respectively) via the keypad is not yet 1214Changing fonts (or font sizes, respectively) via the keypad is not yet
971supported in rxvt-unicode. Bug me if you need this. 1215supported in rxvt-unicode. Bug me if you need this.
972 1216
973You can, however, switch fonts at runtime using escape sequences (and 1217You can, however, switch fonts at runtime using escape sequences, e.g.:
974therefore using the menubar), e.g.:
975 1218
976 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1219 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1220
1221You can use keyboard shortcuts, too:
1222
1223 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1224 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
977 1225
978rxvt-unicode will automatically re-apply these fonts to the output so far. 1226rxvt-unicode will automatically re-apply these fonts to the output so far.
979 1227
980=head1 ISO 14755 SUPPORT 1228=head1 ISO 14755 SUPPORT
981 1229
1098 1346
1099=back 1347=back
1100 1348
1101=head1 ENVIRONMENT 1349=head1 ENVIRONMENT
1102 1350
1103B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> 1351B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1104and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X 1352
1105window id number of the B<@@RXVT_NAME@@> window and it also uses and 1353=over 4
1106sets the environment variable B<DISPLAY> to specify which display 1354
1107terminal to use. B<@@RXVT_NAME@@> uses the environment variables 1355=item B<TERM>
1108B<RXVTPATH> and B<PATH> to find XPM files. 1356
1357Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1358resources or on the commandline.
1359
1360=item B<COLORTERM>
1361
1362Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was
1363compiled with XPM support, and optionally with the added extension
1364C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1365
1366=item B<COLORFGBG>
1367
1368Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1369the colour code used as default foreground/text colour (or the string
1370C<default> to indicate that the default-colour escape sequence is to be
1371used), C<bg> is the colour code used as default background colour (or the
1372string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1373was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1374(and do) use this information to optimize screen output.
1375
1376=item B<WINDOWID>
1377
1378Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1379window, which usually has subwindows for the scrollbar, the terminal
1380window and so on).
1381
1382=item B<TERMINFO>
1383
1384Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1385C<--with-terminfo=PATH>.
1386
1387=item B<DISPLAY>
1388
1389Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1390display in it's child processes.
1391
1392=item B<SHELL>
1393
1394The shell to be used for command execution, defaults to C</bin/sh>.
1395
1396=item B<RXVT_SOCKET>
1397
1398The unix domain socket path used by @@RXVT_NAME@@c(1) and
1399@@RXVT_NAME@@d(1).
1400
1401Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1402
1403=item B<HOME>
1404
1405Used to locate the default directory for the unix domain socket for
1406daemon communications and to locate various resource files (such as
1407C<.Xdefaults>)
1408
1409=item B<XAPPLRESDIR>
1410
1411Directory where various X resource files are being located.
1412
1413=item B<XENVIRONMENT>
1414
1415If set and accessible, gives the name of a X resource file to be loaded by
1416@@RXVT_NAME@@.
1417
1418=back
1109 1419
1110=head1 FILES 1420=head1 FILES
1111 1421
1112=over 4 1422=over 4
1113 1423
1117 1427
1118=back 1428=back
1119 1429
1120=head1 SEE ALSO 1430=head1 SEE ALSO
1121 1431
1122@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1432@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1123
1124=head1 BUGS
1125
1126Check the BUGS file for an up-to-date list.
1127
1128Cursor change support is not yet implemented.
1129
1130Click-and-drag doesn't work with X11 mouse report overriding.
1131 1433
1132=head1 CURRENT PROJECT COORDINATOR 1434=head1 CURRENT PROJECT COORDINATOR
1133 1435
1134=over 4 1436=over 4
1135 1437
1136=item Project Coordinator 1438=item Project Coordinator
1137 1439
1138@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1440Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1139 1441
1140=item Web page maintainter 1442L<http://software.schmorp.de/#rxvt-unicode>
1141
1142@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@>
1143
1144L<@@RXVT_WEBPAGE@@>
1145 1443
1146=back 1444=back
1147 1445
1148=head1 AUTHORS 1446=head1 AUTHORS
1149 1447
1171 1469
1172Project Coordinator (changes.txt 2.21a to 2.4.5) 1470Project Coordinator (changes.txt 2.21a to 2.4.5)
1173 1471
1174=item Geoff Wing L<< <gcw@pobox.com> >> 1472=item Geoff Wing L<< <gcw@pobox.com> >>
1175 1473
1176Rewrote screen display and text selection routines. Project Coordinator 1474Rewrote screen display and text selection routines.
1475
1177(changes.txt 2.4.6 - rxvt-unicode) 1476Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1178 1477
1179=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1478=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1180 1479
1181Forked rxvt-unicode, rewrote most of the display code and internal 1480Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1182character handling to store text in unicode, improve xterm 1481extension, random hacks, numerous bugfixes and extensions.
1183compatibility and apply numerous other bugfixes and extensions.
1184 1482
1185Project Coordinator (Changes 1.0 -) 1483Project Coordinator (Changes 1.0 -)
1186 1484
1485=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1486
1487Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1488
1187=back 1489=back
1188 1490

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines