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.53 by root, Fri Feb 11 18:14:07 2005 UTC vs.
Revision 1.107 by root, Sun Jan 29 20:51:27 2006 UTC

93 93
94Attempt to open a window on the named X display (B<-d> still 94Attempt to open a window on the named X display (B<-d> still
95respected). In the absence of this option, the display specified by the 95respected). In the absence of this option, the display specified by the
96B<DISPLAY> environment variable is used. 96B<DISPLAY> environment variable is used.
97 97
98=item B<-depth> I<bitdepth>
99
100Compile I<frills>: Attempt to find a visual with the given bit depth;
101resource B<depth>.
102
98=item B<-geometry> I<geom> 103=item B<-geometry> I<geom>
99 104
100Window geometry (B<-g> still respected); resource B<geometry>. 105Window geometry (B<-g> still respected); resource B<geometry>.
101 106
102=item B<-rv>|B<+rv> 107=item B<-rv>|B<+rv>
105 110
106=item B<-j>|B<+j> 111=item B<-j>|B<+j>
107 112
108Turn on/off jump scrolling; resource B<jumpScroll>. 113Turn on/off jump scrolling; resource B<jumpScroll>.
109 114
110=item B<-ip>|B<+ip> 115=item B<-ip>|B<+ip> | B<-tr>|B<+tr>
111 116
112Turn on/off inheriting parent window's pixmap. Alternative form is 117Turn on/off inheriting parent window's pixmap. Alternative form is
113B<-tr>; resource B<inheritPixmap>. 118B<-tr>; resource B<inheritPixmap>.
114 119
115=item B<-fade> I<number> 120=item B<-fade> I<number>
116 121
117Fade the text by the given percentage when focus is lost. resource B<fading>. 122Fade the text by the given percentage when focus is lost. Small values
123fade a little only, 100 completely replaces all colours by the fade
124colour; resource B<fading>.
125
126=item B<-fadecolor> I<colour>
127
128Fade to this colour when fading is used (see B<-fade>). The default colour
129is black. resource B<fadeColor>.
118 130
119=item B<-tint> I<colour> 131=item B<-tint> I<colour>
120 132
121Tint the transparent background pixmap with the given colour when 133Tint the transparent background pixmap with the given colour when
122transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> 134transparency is enabled with B<-tr> or B<-ip>. This only works for
123option that can be used to brighten or darken the image in addition to 135non-tiled backgrounds, currently. See also the B<-sh> option that can be
124tinting it. 136used to brighten or darken the image in addition to tinting it; resource
137I<tintColor>. Example:
138
139 @@RXVT_NAME@@ -tr -tint blue -sh 40
125 140
126=item B<-sh> 141=item B<-sh>
127 142
128I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 143I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
129background image in addition to tinting it (i.e. B<-tint> must be 144background image in addition to tinting it (i.e. B<-tint> must be
162resource B<borderColor>. 177resource B<borderColor>.
163 178
164=item B<-fn> I<fontlist> 179=item B<-fn> I<fontlist>
165 180
166Select the fonts to be used. This is a comma separated list of font names 181Select the fonts to be used. This is a comma separated list of font names
167that are used in turn when trying to display Unicode characters. The 182that are checked in order when trying to find glyphs for characters. The
168first font defines the cell size for characters; other fonts might be 183first font defines the cell size for characters; other fonts might be
169smaller, but not (in general) larger. A (hopefully) reasonable default 184smaller, but not (in general) larger. A (hopefully) reasonable default
170font list is always appended to it. See resource B<font> for more details. 185font list is always appended to it. See resource B<font> for more details.
171 186
172In short, to specify an X11 core font, just specify it's name or prefix it 187In short, to specify an X11 core font, just specify it's name or prefix it
179See also the question "How does rxvt-unicode choose fonts?" in the FAQ 194See also the question "How does rxvt-unicode choose fonts?" in the FAQ
180section of @@RXVT_NAME@@(7). 195section of @@RXVT_NAME@@(7).
181 196
182=item B<-fb> I<fontlist> 197=item B<-fb> I<fontlist>
183 198
184Compile font-styles: The bold font list to use when bold characters are to 199Compile I<font-styles>: The bold font list to use when B<bold> characters
185be printed. See resource B<boldFont> for details. 200are to be printed. See resource B<boldFont> for details.
186 201
187=item B<-fi> I<fontlist> 202=item B<-fi> I<fontlist>
188 203
189Compile font-styles: The italic font list to use when bold characters are to 204Compile I<font-styles>: The italic font list to use when I<italic>
190be printed. See resource B<italicFont> for details. 205characters are to be printed. See resource B<italicFont> for details.
191 206
192=item B<-fbi> I<fontlist> 207=item B<-fbi> I<fontlist>
193 208
194Compile font-styles: The bold italic font list to use when bold characters are to 209Compile I<font-styles>: The bold italic font list to use when B<< I<bold
195be printed. See resource B<boldItalicFont> for details. 210italic> >> characters are to be printed. See resource B<boldItalicFont>
211for details.
212
213=item B<-is>|B<+is>
214
215Compile I<font-styles>: Bold/Italic font styles imply high intensity
216foreground/background (default). See resource B<intensityStyles> for
217details.
196 218
197=item B<-name> I<name> 219=item B<-name> I<name>
198 220
199Specify the application name under which resources are to be obtained, 221Specify the application name under which resources are to be obtained,
200rather than the default executable file name. Name should not contain 222rather than the default executable file name. Name should not contain
238 260
239Put scrollbar on right/left; resource B<scrollBar_right>. 261Put scrollbar on right/left; resource B<scrollBar_right>.
240 262
241=item B<-st>|B<+st> 263=item B<-st>|B<+st>
242 264
243Display normal (non XTerm/NeXT) scrollbar without/with a trough; 265Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
244resource B<scrollBar_floating>. 266resource B<scrollBar_floating>.
245 267
246=item B<-ptab>|B<+ptab> 268=item B<-ptab>|B<+ptab>
247 269
248If enabled (default), "Horizontal Tab" characters are being stored as 270If enabled (default), "Horizontal Tab" characters are being stored as
279=item B<-bl> 301=item B<-bl>
280 302
281Compile I<frills>: Set MWM hints to request a borderless window, i.e. 303Compile I<frills>: Set MWM hints to request a borderless window, i.e.
282if honoured by the WM, the rxvt-unicode window will not have window 304if honoured by the WM, the rxvt-unicode window will not have window
283decorations; resource B<borderLess>. 305decorations; resource B<borderLess>.
306
307=item B<-override-redirect>
308
309Compile I<frills>: Sets override-redirect on the window; resource
310B<override-redirect>.
311
312=item B<-sbg>
313
314Compile I<frills>: Disable the usage of the built-in block graphics/line
315drawing characters and just rely on what the specified fonts provide. Use
316this if you have a good font and want to use its block graphic glyphs;
317resource B<skipBuiltinGlyphs>.
284 318
285=item B<-lsp> I<number> 319=item B<-lsp> I<number>
286 320
287Compile I<frills>: Lines (pixel height) to insert between each row of 321Compile I<frills>: Lines (pixel height) to insert between each row of
288the display. Useful to work around font rendering problems; resource 322the display. Useful to work around font rendering problems; resource
303given on the command line. If this option is used, it must be the last 337given on the command line. If this option is used, it must be the last
304on the command-line. If there is no B<-e> option then the default is to 338on the command-line. If there is no B<-e> option then the default is to
305run the program specified by the B<SHELL> environment variable or, 339run the program specified by the B<SHELL> environment variable or,
306failing that, I<sh(1)>. 340failing that, I<sh(1)>.
307 341
342Please note that you must specify a program with arguments. If you want to
343run shell commands, you have to specify the shell, like this:
344
345 @@RXVT_NAME@@ -e sh -c "shell commands"
346
308=item B<-title> I<text> 347=item B<-title> I<text>
309 348
310Window title (B<-T> still respected); the default title is the basename 349Window title (B<-T> still respected); the default title is the basename
311of the program specified after the B<-e> option, if any, otherwise the 350of the program specified after the B<-e> option, if any, otherwise the
312application name; resource B<title>. 351application name; resource B<title>.
368=item B<-ssr>|B<+ssr> 407=item B<-ssr>|B<+ssr>
369 408
370Turn on/off secondary screen scroll (default enabled); resource 409Turn on/off secondary screen scroll (default enabled); resource
371B<secondaryScroll>. 410B<secondaryScroll>.
372 411
412=item B<-hold>|B<+hold>
413
414Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
415will not immediately destroy its window when the program executed within
416it exits. Instead, it will wait till it is being killed or closed by the
417user; resource B<hold>.
418
373=item B<-keysym.>I<sym>: I<string> 419=item B<-keysym.>I<sym> I<string>
374 420
375Remap a key symbol. See resource B<keysym>. 421Remap a key symbol. See resource B<keysym>.
376 422
423=item B<-embed> I<windowid>
424
425Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window,
426which enables applications to easily embed a terminal.
427
428Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
429shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
430quite a bit, so don't expect it to keep some specific state. It's best to
431create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
432
433The window will not be destroyed when @@RXVT_NAME@@ exits.
434
435It might be useful to know that @@RXVT_NAME@@ will not close file
436descriptors passed to it (except for stdin/out/err, of course), so you
437can use file descriptors to communicate with the programs within the
438terminal. This works regardless of wether the C<-embed> option was used or
439not.
440
441Here is a short Gtk2-perl snippet that illustrates how this option can be
442used (a longer example is in F<doc/embed>):
443
444 my $rxvt = new Gtk2::Socket;
445 $rxvt->signal_connect_after (realize => sub {
446 my $xid = $_[0]->window->get_xid;
447 system "@@RXVT_NAME@@ -embed $xid &";
448 });
449
450=item B<-pty-fd> I<file descriptor>
451
452Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
453pair but instead use the given filehandle as the tty master. This is
454useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
455without having to run a program within it.
456
457If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
458entries and will not tinker with pty/tty permissions - you have to do that
459yourself if you want that.
460
461As an extremely special case, specifying C<-1> will completely suppress
462pty/tty operations.
463
464Here is a example in perl that illustrates how this option can be used (a
465longer example is in F<doc/pty-fd>):
466
467 use IO::Pty;
468 use Fcntl;
469
470 my $pty = new IO::Pty;
471 fcntl $pty, F_SETFD, 0; # clear close-on-exec
472 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
473 close $pty;
474
475 # now communicate with rxvt
476 my $slave = $pty->slave;
477 while (<$slave>) { print $slave "got <$_>\n" }
478
377=item B<-xrm> I<resourcestring> 479=item B<-pe> I<string>
378 480
379No effect on rxvt-unicode. Simply passes through an argument to be made 481Comma-separated list of perl extension scripts to use (or not to use) in
380available in the instance's argument list. Appears in I<WM_COMMAND> in 482this terminal instance. See resource B<perl-ext> for details.
381some window managers.
382 483
383=back 484=back
384 485
385=head1 RESOURCES (available also as long-options) 486=head1 RESOURCES (available also as long-options)
386 487
387Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 488Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
388options) compiled into your version. 489options) compiled into your version.
389 490
390There are two different methods that @@RXVT_NAME@@ can use to get the 491You can set and change the resources using X11 tools like B<xrdb>. Many
391Xresource data: using the X libraries (Xrm*-functions) or internal 492distribution do also load settings from the B<~/.Xresources> file when X
392Xresources reader (B<~/.Xdefaults>). For the first method (ie. 493starts. @@RXVT_NAME@@ will consult the following files/resources in order,
393B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 494with later settings overwriting earlier ones:
394resources using X11 tools like B<xrdb>. Many distribution do also load
395settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
396will consult the following files/resources in order, with later settings
397overwriting earlier ones:
398 495
399 1. system-wide app-defaults file, either locale-dependent OR global 496 1. system-wide app-defaults file, either locale-dependent OR global
400 2. app-defaults file in $XAPPLRESDIR 497 2. app-defaults file in $XAPPLRESDIR
401 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 498 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
402 4. SCREEN_RESOURCES for the current screen 499 4. SCREEN_RESOURCES for the current screen
403 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 500 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
404 501
405If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
406lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
407set in XAPPLOADDIR/URxvt (compile-time defined: usually
408B</usr/lib/X11/app-defaults/URxvt>) and resources set in
409B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
410Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 502Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
411class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 503names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
412resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 504common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
413easily configured, while the class name B<URxvt> allows resources 505configured, while the class name B<URxvt> allows resources unique to
414unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 506B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
415shared between different B<@@RXVT_NAME@@> configurations. If no 507configurations. If no resources are specified, suitable defaults will
416resources are specified, suitable defaults will be used. Command-line 508be used. Command-line arguments can be used to override resource
417arguments can be used to override resource settings. The following 509settings. The following resources are supported (you might want to
418resources are allowed: 510check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
511extensions not documented here):
419 512
420=over 4 513=over 4
514
515=item B<depth:> I<bitdepth>
516
517Compile I<frills>: Attempt to find a visual with the given bit depth;
518option B<-depth>.
421 519
422=item B<geometry:> I<geom> 520=item B<geometry:> I<geom>
423 521
424Create the window with the specified X window geometry [default 80x24]; 522Create the window with the specified X window geometry [default 80x24];
425option B<-geometry>. 523option B<-geometry>.
501artificial transparency. B<False>: do not inherit the parent windows' 599artificial transparency. B<False>: do not inherit the parent windows'
502pixmap. 600pixmap.
503 601
504=item B<fading:> I<number> 602=item B<fading:> I<number>
505 603
506Fade the text by the given percentage when focus is lost. 604Fade the text by the given percentage when focus is lost; option B<-fade>.
605
606=item B<fadeColor:> I<colour>
607
608Fade to this colour, when fading is used (see B<fading:>). The default
609colour is black; option B<-fadecolor>.
507 610
508=item B<tintColor:> I<colour> 611=item B<tintColor:> I<colour>
509 612
510Tint the transparent background pixmap with the given colour. 613Tint the transparent background pixmap with the given colour; option
614B<-tint>.
511 615
512=item B<shading:> I<number> 616=item B<shading:> I<number>
513 617
514Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 618Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
515image in addition to tinting it. 619image in addition to tinting it.
519Use the specified colour for the scrollbar [default #B2B2B2]. 623Use the specified colour for the scrollbar [default #B2B2B2].
520 624
521=item B<troughColor:> I<colour> 625=item B<troughColor:> I<colour>
522 626
523Use the specified colour for the scrollbar's trough area [default 627Use the specified colour for the scrollbar's trough area [default
524#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 628#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
525 629
526=item B<borderColor:> I<colour> 630=item B<borderColor:> I<colour>
527 631
528The colour of the border around the text area and between the scrollbar 632The colour of the border around the text area and between the scrollbar
529and the text. 633and the text.
538of 1 displays the image without any scaling. A scale of 2 to 9 642of 1 displays the image without any scaling. A scale of 2 to 9
539specifies an integer number of images in that direction. No image will 643specifies an integer number of images in that direction. No image will
540be magnified beyond 10 times its original size. The maximum permitted 644be magnified beyond 10 times its original size. The maximum permitted
541scale is 1000. [default 0x0+50+50] 645scale is 1000. [default 0x0+50+50]
542 646
543=item B<menu:> I<file[;tag]>
544
545Read in the specified menu file (note the `.menu' extension is
546optional) and also optionally specify a starting tag to find. See the
547reference documentation for details on the syntax for the menuBar.
548
549=item B<path:> I<path> 647=item B<path:> I<path>
550 648
551Specify the colon-delimited search path for finding files (XPM and 649Specify the colon-delimited search path for finding XPM files.
552menus), in addition to the paths specified by the B<RXVTPATH> and
553B<PATH> environment variables.
554 650
555=item B<font:> I<fontlist> 651=item B<font:> I<fontlist>
556 652
557Select the fonts to be used. This is a comma separated list of font 653Select the fonts to be used. This is a comma separated list of font names
558names that are used in turn when trying to display Unicode characters. 654that are checked in order when trying to find glyphs for characters. The
559The first font defines the cell size for characters; other fonts might 655first font defines the cell size for characters; other fonts might be
560be smaller, but not larger. A reasonable default font list is always 656smaller, but not (in general) larger. A (hopefully) reasonable default
561appended to it. option B<-fn>. 657font list is always appended to it; option B<-fn>.
562 658
563Each font can either be a standard X11 core font (XLFD) name, with 659Each font can either be a standard X11 core font (XLFD) name, with
564optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 660optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
565 661
566In addition, each font can be prefixed with additional hints and 662In addition, each font can be prefixed with additional hints and
568hint currently is C<codeset=codeset-name>, and this is only used for Xft 664hint currently is C<codeset=codeset-name>, and this is only used for Xft
569fonts. 665fonts.
570 666
571For example, this font resource 667For example, this font resource
572 668
573 URxvt*font: 9x15bold,\ 669 URxvt.font: 9x15bold,\
574 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 670 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
575 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 671 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
576 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 672 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
577 xft:Code2000:antialias=false 673 xft:Code2000:antialias=false
578 674
612not possible, replacement fonts of the desired shape will be tried. 708not possible, replacement fonts of the desired shape will be tried.
613 709
614If set, but empty, then this specific style is disabled and the normal 710If set, but empty, then this specific style is disabled and the normal
615text font will being used for the given style. 711text font will being used for the given style.
616 712
713=item B<intensityStyles:> I<boolean>
714
715When font styles are not enabled, or this option is enabled (B<True>,
716option B<-is>, the default), bold and italic font styles imply high
717intensity foreground/backround colours. Disabling this option (B<False>,
718option B<+is>) disables this behaviour, the high intensity colours are not
719reachable.
720
617=item B<selectstyle:> I<mode> 721=item B<selectstyle:> I<mode>
618 722
619Set mouse selection style to B<old> which is 2.20, B<oldword> which is 723Set mouse selection style to B<old> which is 2.20, B<oldword> which is
620xterm style with 2.20 old word selection, or anything else which gives 724xterm style with 2.20 old word selection, or anything else which gives
621xterm style selection. 725xterm style selection.
622 726
623=item B<scrollstyle:> I<mode> 727=item B<scrollstyle:> I<mode>
624 728
625Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 729Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
626the author's favourite.. 730the author's favourite.
627 731
628=item B<title:> I<string> 732=item B<title:> I<string>
629 733
630Set window title string, the default title is the command-line 734Set window title string, the default title is the command-line
631specified after the B<-e> option, if any, otherwise the application 735specified after the B<-e> option, if any, otherwise the application
663 767
664Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 768Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
665B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 769B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
666B<Shift-Print> to include the scrollback as well. 770B<Shift-Print> to include the scrollback as well.
667 771
772The string will be interpreted as if typed into the shell as-is.
773
774Example:
775
776 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
777
778This creates a new file in your home directory with the screen contents
779everytime you hit C<Print>.
780
668=item B<scrollBar:> I<boolean> 781=item B<scrollBar:> I<boolean>
669 782
670B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 783B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
671disable the scrollbar; option B<+sb>. 784disable the scrollbar; option B<+sb>.
672 785
692B<+si>. 805B<+si>.
693 806
694=item B<scrollWithBuffer:> I<boolean> 807=item B<scrollWithBuffer:> I<boolean>
695 808
696B<True>: scroll with scrollback buffer when tty receives new lines (and 809B<True>: scroll with scrollback buffer when tty receives new lines (and
697B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll 810B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
698with scrollback buffer when tty recieves new lines; option B<-sw>. 811with scrollback buffer when tty recieves new lines; option B<+sw>.
699 812
700=item B<scrollTtyKeypress:> I<boolean> 813=item B<scrollTtyKeypress:> I<boolean>
701 814
702B<True>: scroll to bottom when a non-special key is pressed. Special keys 815B<True>: scroll to bottom when a non-special key is pressed. Special keys
703are those which are intercepted by rxvt-unicode for special handling and 816are those which are intercepted by rxvt-unicode for special handling and
722=item B<borderLess:> I<boolean> 835=item B<borderLess:> I<boolean>
723 836
724Set MWM hints to request a borderless window, i.e. if honoured by the 837Set MWM hints to request a borderless window, i.e. if honoured by the
725WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 838WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
726 839
840=item B<skipBuiltinGlyphs:> I<boolean>
841
842Compile I<frills>: Disable the usage of the built-in block graphics/line
843drawing characters and just rely on what the specified fonts provide. Use
844this if you have a good font and want to use its block graphic glyphs;
845option B<-sbg>.
846
727=item B<termName:> I<termname> 847=item B<termName:> I<termname>
728 848
729Specifies the terminal type name to be set in the B<TERM> environment 849Specifies the terminal type name to be set in the B<TERM> environment
730variable; option B<-tn>. 850variable; option B<-tn>.
731 851
768 888
769Mouse pointer background colour. 889Mouse pointer background colour.
770 890
771=item B<pointerBlankDelay:> I<number> 891=item B<pointerBlankDelay:> I<number>
772 892
773Specifies number of seconds before blanking the pointer [default 2]. 893Specifies number of seconds before blanking the pointer [default 2]. Use a
894large number (e.g. C<987654321>) to effectively disable the timeout.
774 895
775=item B<backspacekey:> I<string> 896=item B<backspacekey:> I<string>
776 897
777The string to send when the backspace key is pressed. If set to B<DEC> 898The string to send when the backspace key is pressed. If set to B<DEC>
778or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 899or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace>
785pressed. If unset it will send the sequence traditionally associated 906pressed. If unset it will send the sequence traditionally associated
786with the B<Execute> key. 907with the B<Execute> key.
787 908
788=item B<cutchars:> I<string> 909=item B<cutchars:> I<string>
789 910
790The characters used as delimiters for double-click word selection. The 911The characters used as delimiters for double-click word selection
791built-in default: 912(whitespace delimiting is added automatically if resource is given).
913
914When the selection extension is in use (the default if compiled in, see
915the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
916will be created (if the resource exists, otherwise, no regex will be
917created). In this mode, characters outside ISO-8859-1 can be used.
918
919When the selection extension is not used, only ISO-8859-1 characters can
920be used. If not specified, the built-in default is used:
792 921
793B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 922B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
794 923
795=item B<preeditType:> I<style> 924=item B<preeditType:> I<style>
796 925
803=item B<imLocale:> I<name> 932=item B<imLocale:> I<name>
804 933
805The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 934The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
806C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the 935C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
807input extension to be able to input japanese characters while staying in 936input extension to be able to input japanese characters while staying in
808another locale. option B<-imlocale>. 937another locale; option B<-imlocale>.
809 938
810=item B<imFont:> I<fontset> 939=item B<imFont:> I<fontset>
811 940
812Specify the font-set used for XIM styles C<OverTheSpot> or 941Specify the font-set used for XIM styles C<OverTheSpot> or
813C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 942C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
818 947
819=item B<tripleclickwords:> I<boolean> 948=item B<tripleclickwords:> I<boolean>
820 949
821Change the meaning of triple-click selection with the left mouse 950Change the meaning of triple-click selection with the left mouse
822button. Instead of selecting a full line it will extend the selection to 951button. Instead of selecting a full line it will extend the selection to
823the end of the logical line only. option B<-tcw>. 952the end of the logical line only; option B<-tcw>.
824 953
825=item B<insecure:> I<boolean> 954=item B<insecure:> I<boolean>
826 955
827Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 956Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
828echo arbitrary strings like the icon name or the locale. This could be 957echo arbitrary strings like the icon name or the locale. This could be
829abused if somebody gets 8-bit-clean access to your display, whether 958abused if somebody gets 8-bit-clean access to your display, whether
830throuh a mail client displaying mail bodies unfiltered or though 959through a mail client displaying mail bodies unfiltered or through
831write(1). Therefore, these sequences are disabled by default. (Note 960write(1) or any other means. Therefore, these sequences are disabled by
832that other terminals, including xterm, have these sequences 961default. (Note that many other terminals, including xterm, have these
833enabled by default). You can enable them by setting this boolean 962sequences enabled by default, which doesn't make it safer, though).
834resource or specifying B<-insecure> as an option. At the moment, this 963
835enabled display-answer, locale, findfont, icon label and window title 964You can enable them by setting this boolean resource or specifying
836requests as well as dynamic menubar dispatch. 965B<-insecure> as an option. At the moment, this enables display-answer,
966locale, findfont, icon label and window title requests.
837 967
838=item B<modifier:> I<modifier> 968=item B<modifier:> I<modifier>
839 969
840Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 970Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
841B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 971B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
845 975
846Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 976Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
847character is passed through. It may contain escape values as described 977character is passed through. It may contain escape values as described
848in the entry on B<keysym> following. 978in the entry on B<keysym> following.
849 979
850=item B<secondaryScreen:> I<bool> 980=item B<secondaryScreen:> I<boolean>
851 981
852Turn on/off secondary screen (default enabled). 982Turn on/off secondary screen (default enabled).
853 983
854=item B<secondaryScroll:> I<bool> 984=item B<secondaryScroll:> I<boolean>
855 985
856Turn on/off secondary screen scroll (default enabled). If the this 986Turn on/off secondary screen scroll (default enabled). If the this
857option is enabled, scrolls on the secondary screen will change the 987option is enabled, scrolls on the secondary screen will change the
858scrollback buffer and switching to/from the secondary screen will 988scrollback buffer and switching to/from the secondary screen will
859instead scroll the screen up. 989instead scroll the screen up.
990
991=item B<hold>: I<boolean>
992
993Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
994will not immediately destroy its window when the program executed within
995it exits. Instead, it will wait till it is being killed or closed by the
996user.
860 997
861=item B<keysym.>I<sym>: I<string> 998=item B<keysym.>I<sym>: I<string>
862 999
863Compile I<frills>: Associate I<string> with keysym I<sym>. The 1000Compile I<frills>: Associate I<string> with keysym I<sym>. The
864intervening resource name B<keysym.> cannot be omitted. 1001intervening resource name B<keysym.> cannot be omitted.
884C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1021C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
885C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1022C<\000>: octal number) or verbatim control characters (C<^?>: delete,
886C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1023C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
887can start or end with whitespace. 1024can start or end with whitespace.
888 1025
889Please note that you need to double the C<\> when using 1026Please note that you need to double the C<\> in resource files, as
890C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can 1027Xlib itself does it's own de-escaping (you can use C<\033> instead of
891use C<\033> instead of C<\e> (and so on), which will work with both Xt and 1028C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
892@@RXVT_NAME@@'s own processing). 1029processing).
893 1030
894You can define a range of keysyms in one shot by providing a I<string> 1031You can define a range of keysyms in one shot by providing a I<string>
895with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1032with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
896should be a character not used by the strings. 1033should be a character not used by the strings.
897 1034
910example the following means "change the current locale to C<zh_CN.GBK> 1047example the following means "change the current locale to C<zh_CN.GBK>
911when Control-Meta-c is being pressed": 1048when Control-Meta-c is being pressed":
912 1049
913 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1050 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
914 1051
1052If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1053is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1054manpage. For example, the F<selection> extension (activated via
1055C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1056
1057 URxvt.keysym.M-C-c: perl:selection:rot13
1058
1059Due the the large number of modifier combinations, a defined key mapping
1060will match if at I<at least> the specified identifiers are being set, and
1061no other key mappings with those and more bits are being defined. That
1062means that defining a key map for C<a> will automatically provide
1063definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1064mappings themselves.
1065
1066Unfortunately, this will override built-in key mappings. For example
1067if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s
1068C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the
1069user-defined keymap using the C<builtin:> replacement:
1070
1071 URxvt.keysym.Insert: <my insert key sequence>
1072 URxvt.keysym.S-Insert: builtin:
1073
1074The first line defines a mapping for C<Insert> and I<any> combination
1075of modifiers. The second line re-establishes the default mapping for
1076C<Shift-Insert>.
1077
915The following example will map Control-Meta-1 and Control-Meta-2 to 1078The following example will map Control-Meta-1 and Control-Meta-2 to
916the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited 1079the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
917font-switching at runtime: 1080font-switching at runtime:
918 1081
919 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1082 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
922Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1085Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
923info): 1086info):
924 1087
925 URxvt.keysym.M-C-3: command:\033[8;25;80t 1088 URxvt.keysym.M-C-3: command:\033[8;25;80t
926 URxvt.keysym.M-C-4: command:\033[8;48;110t 1089 URxvt.keysym.M-C-4: command:\033[8;48;110t
1090
1091=item B<perl-ext-common>: I<string>
1092
1093=item B<perl-ext>: I<string>
1094
1095Comma-separated list(s) of perl extension scripts (default: C<default>) to
1096use in this terminal instance; option B<-pe>.
1097
1098Extension names can be prefixed with a C<-> sign to prohibit using
1099them. This can be useful to selectively disable some extensions loaded
1100by default, or specified via the C<perl-ext-common> resource. For
1101example, C<default,-selection> will use all the default extension except
1102C<selection>.
1103
1104Extension names can also be followed by an argument in angle brackets
1105(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1106searchable scorllback to Alt/Meta-s). Mentioning the same extension
1107multiple times with different arguments will pass multiple arguments to
1108the extension.
1109
1110Each extension is looked up in the library directories, loaded if
1111necessary, and bound to the current terminal instance.
1112
1113If both of these resources are the empty string, then the perl
1114interpreter will not be initialized. The idea behind two options is that
1115B<perl-ext-common> will be used for extensions that should be available to
1116all instances, while B<perl-ext> is used for specific instances.
1117
1118=item B<perl-eval>: I<string>
1119
1120Perl code to be evaluated when all extensions have been registered. See
1121the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1122will be ignored when running setuid/setgid.
1123
1124=item B<perl-lib>: I<path>
1125
1126Colon-separated list of additional directories that hold extension
1127scripts. When looking for extensions specified by the C<perl> resource,
1128@@RXVT_NAME@@ will first look in these directories and then in
1129F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1130will be ignored when running setuid/setgid.
1131
1132See the @@RXVT_NAME@@perl(3) manpage.
1133
1134=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1135
1136Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1137details.
1138
1139=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1140
1141Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1142for details.
1143
1144=item B<searchable-scrollback:> I<keysym>
1145
1146Sets the hotkey that starts the incremental scrollback buffer search
1147(default: C<M-s>).
1148
1149=item B<urlLauncher>: I<string>
1150
1151Specifies the program to be started with a URL argument. Used by the
1152C<selection-popup> and C<mark-urls> perl extensions.
1153
1154=item B<transient-for>: I<windowid>
1155
1156Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1157
1158=item B<override-redirect>: I<boolean>
1159
1160Compile I<frills>: Sets override-redirect for the terminal window, making
1161it almost invisible to window managers; option B<-override-redirect>.
927 1162
928=back 1163=back
929 1164
930=head1 THE SCROLLBAR 1165=head1 THE SCROLLBAR
931 1166
966to select a word; Left triple-click to select the entire logical line 1201to select a word; Left triple-click to select the entire logical line
967(which can span multiple screen lines), unless modified by resource 1202(which can span multiple screen lines), unless modified by resource
968B<tripleclickwords>. 1203B<tripleclickwords>.
969 1204
970Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1205Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
971(Compile: I<frills>) will create a rectangular selection instead of a normal 1206(Compile: I<frills>) will create a rectangular selection instead of a
972one. 1207normal one. In this mode, every selected row becomes its own line in the
1208selection, and trailing whitespace is visually underlined and removed from
1209the selection.
973 1210
974=item B<Insertion>: 1211=item B<Insertion>:
975 1212
976Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1213Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
977an B<@@RXVT_NAME@@> window causes the current text selection to be 1214window causes the value of the PRIMARY selection (or CLIPBOARD with the
978inserted as if it had been typed on the keyboard. 1215Meta modifier) to be inserted as if it had been typed on the keyboard.
1216
1217Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1218inserted too.
979 1219
980=back 1220=back
981 1221
982=head1 CHANGING FONTS 1222=head1 CHANGING FONTS
983 1223
984Changing fonts (or font sizes, respectively) via the keypad is not yet 1224Changing fonts (or font sizes, respectively) via the keypad is not yet
985supported in rxvt-unicode. Bug me if you need this. 1225supported in rxvt-unicode. Bug me if you need this.
986 1226
987You can, however, switch fonts at runtime using escape sequences (and 1227You can, however, switch fonts at runtime using escape sequences, e.g.:
988therefore using the menubar), e.g.:
989 1228
990 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1229 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1230
1231You can use keyboard shortcuts, too:
1232
1233 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1234 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
991 1235
992rxvt-unicode will automatically re-apply these fonts to the output so far. 1236rxvt-unicode will automatically re-apply these fonts to the output so far.
993 1237
994=head1 ISO 14755 SUPPORT 1238=head1 ISO 14755 SUPPORT
995 1239
1066=head1 COLORS AND GRAPHICS 1310=head1 COLORS AND GRAPHICS
1067 1311
1068In addition to the default foreground and background colours, 1312In addition to the default foreground and background colours,
1069B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1313B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1070high-intensity bold/blink versions of the same). Here is a list of the 1314high-intensity bold/blink versions of the same). Here is a list of the
1071colours with their B<rgb.txt> names. 1315colours with their names.
1072 1316
1073=begin table 1317=begin table
1074 1318
1075 B<color0> (black) = Black 1319 B<color0> (black) = Black
1076 B<color1> (red) = Red3 1320 B<color1> (red) = Red3
1096It is also possible to specify the colour values of B<foreground>, 1340It is also possible to specify the colour values of B<foreground>,
1097B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1341B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1098a number 0-15, as a convenient shorthand to reference the colour name of 1342a number 0-15, as a convenient shorthand to reference the colour name of
1099color0-color15. 1343color0-color15.
1100 1344
1345If Xft support has been compiled in and as long as Xft/Xrender don't get
1346their act together, rxvt-unicode will support C<#ARGB>, C<#AARRGGBB>
1347and C<#AAAARRRRGGGGBBBB> colour specifications, in addition to the ones
1348provided by X, where the additional A component specifies alpha (opacity)
1349values (0 is completely transparent and the maximum is opaque). You
1350probably need to specify B<"-depth 32">, too, as X is far from just
1351supporting ARGB visuals out of the box.
1352
1101Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1353Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1102always swapping the foreground/background colours. This is in contrast to 1354always swapping the foreground/background colours. This is in contrast to
1103I<xterm>(1) where the colours are only swapped if they have not otherwise 1355I<xterm>(1) where the colours are only swapped if they have not otherwise
1104been specified. For example, 1356been specified. For example,
1105 1357
1134Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1386Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1135the colour code used as default foreground/text colour (or the string 1387the colour code used as default foreground/text colour (or the string
1136C<default> to indicate that the default-colour escape sequence is to be 1388C<default> to indicate that the default-colour escape sequence is to be
1137used), C<bg> is the colour code used as default background colour (or the 1389used), C<bg> is the colour code used as default background colour (or the
1138string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1390string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1139was compiled with XPM support. Libraries like C<slang> can (and do) use 1391was compiled with XPM support. Libraries like C<ncurses> and C<slang> can
1140this information to optimize screen output. 1392(and do) use this information to optimize screen output.
1141 1393
1142=item B<WINDOWID> 1394=item B<WINDOWID>
1143 1395
1144Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1396Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1145window, which usually has subwindows for the scrollbar, the terminal 1397window, which usually has subwindows for the scrollbar, the terminal
1157 1409
1158=item B<SHELL> 1410=item B<SHELL>
1159 1411
1160The shell to be used for command execution, defaults to C</bin/sh>. 1412The shell to be used for command execution, defaults to C</bin/sh>.
1161 1413
1162=item B<RXVTPATH>
1163
1164The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1165files.
1166
1167=item B<PATH>
1168
1169Used in the same way as C<RXVTPATH>.
1170
1171=item B<RXVT_SOCKET> 1414=item B<RXVT_SOCKET>
1172 1415
1173The unix domain socket path used by @@RXVT_NAME@@c(1) and 1416The unix domain socket path used by @@RXVT_NAME@@c(1) and
1174@@RXVT_NAME@@d(1). 1417@@RXVT_NAME@@d(1).
1175 1418
1176Default C<< $HOME/.rxvt-unicode-<nodename >>. 1419Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>.
1177 1420
1178=item B<HOME> 1421=item B<HOME>
1179 1422
1180Used to locate the default directory for the unix domain socket for 1423Used to locate the default directory for the unix domain socket for
1181daemon communications and to locate various resource files (such as 1424daemon communications and to locate various resource files (such as
1202 1445
1203=back 1446=back
1204 1447
1205=head1 SEE ALSO 1448=head1 SEE ALSO
1206 1449
1207@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1450@@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)
1208
1209=head1 BUGS
1210
1211Check the BUGS file for an up-to-date list.
1212
1213Cursor change support is not yet implemented.
1214
1215Click-and-drag doesn't work with X11 mouse report overriding.
1216 1451
1217=head1 CURRENT PROJECT COORDINATOR 1452=head1 CURRENT PROJECT COORDINATOR
1218 1453
1219=over 4 1454=over 4
1220 1455
1221=item Project Coordinator 1456=item Project Coordinator
1222 1457
1223@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> 1458Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1224 1459
1225L<@@RXVT_WEBPAGE@@> 1460L<http://software.schmorp.de/#rxvt-unicode>
1226 1461
1227=back 1462=back
1228 1463
1229=head1 AUTHORS 1464=head1 AUTHORS
1230 1465
1252 1487
1253Project Coordinator (changes.txt 2.21a to 2.4.5) 1488Project Coordinator (changes.txt 2.21a to 2.4.5)
1254 1489
1255=item Geoff Wing L<< <gcw@pobox.com> >> 1490=item Geoff Wing L<< <gcw@pobox.com> >>
1256 1491
1257Rewrote screen display and text selection routines. Project Coordinator 1492Rewrote screen display and text selection routines.
1493
1258(changes.txt 2.4.6 - rxvt-unicode) 1494Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1259 1495
1260=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> 1496=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1261 1497
1262Forked rxvt-unicode, rewrote most of the display code and internal 1498Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1263character handling to store text in unicode, improve xterm 1499extension, random hacks, numerous bugfixes and extensions.
1264compatibility and apply numerous other bugfixes and extensions.
1265 1500
1266Project Coordinator (Changes 1.0 -) 1501Project Coordinator (Changes 1.0 -)
1267 1502
1503=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1504
1505Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1506
1268=back 1507=back
1269 1508

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines