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.86 by root, Fri Jan 6 05:28:55 2006 UTC vs.
Revision 1.119 by root, Mon Aug 7 16:04:29 2006 UTC

28world. Being a terminal emulator, however, some things are very difficult, 28world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts 29especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules, 30like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. Don't expect pretty output when using these 31like tibetan or devenagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are left-to-right scripts, such 33fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 35belong into the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 36such as cursor-movement while editing -- break otherwise), but that might
37change. 37change.
38 38
39If you are looking for a terminal that supports more exotic scripts, let 39If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very userfriendly, lean and clean 40me recommend C<mlterm>, which is a very user friendly, lean and clean
41terminal emulator. In fact, the reason rxvt-unicode was born was solely 41terminal emulator. In fact, the reason rxvt-unicode was born was solely
42because the author couldn't get C<mlterm> to use one font for latin1 and 42because the author couldn't get C<mlterm> to use one font for latin1 and
43another for japanese. 43another for japanese.
44 44
45Therefore another design rationale was the use of multiple fonts to 45Therefore another design rationale was the use of multiple fonts to
46display characters: The idea of a single unicode font which many other 46display characters: The idea of a single unicode font which many other
47programs force onto it's users never made sense to me: You should be able 47programs force onto its users never made sense to me: You should be able
48to choose any font for any script freely. 48to choose any font for any script freely.
49 49
50Apart from that, rxvt-unicode is also much better internationalised than 50Apart from that, rxvt-unicode is also much better internationalised than
51it's predecessor, supports things such as XFT and ISO 14755 that are handy 51its predecessor, supports things such as XFT and ISO 14755 that are handy
52in i18n-environments, is faster, and has a lot less bugs than the original 52in i18n-environments, is faster, and has a lot bugs less than the original
53rxvt. This all in addition to dozens of other small improvements. 53rxvt. This all in addition to dozens of other small improvements.
54 54
55It is still faithfully following the original rxvt idea of being lean 55It is still faithfully following the original rxvt idea of being lean
56and nice on resources: for example, you can still configure rxvt-unicode 56and nice on resources: for example, you can still configure rxvt-unicode
57without most of it's features to get a lean binary. It also comes with 57without most of its features to get a lean binary. It also comes with
58a client/daemon pair that lets you open any number of terminal windows 58a client/daemon pair that lets you open any number of terminal windows
59from within a single process, which makes startup time very fast and 59from within a single process, which makes startup time very fast and
60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61@@RXVT_NAME@@c(1) (client). 61@@RXVT_NAME@@c(1) (client).
62 62
63It also makes technical information about escape sequences (which have 63It also makes technical information about escape sequences (which have
64been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 64been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65reference documentation (escape sequences etc.). 65reference documentation (escape sequences etc.).
66 66
67=head1 OPTIONS 67=head1 OPTIONS
68 68
69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed 69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
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<xft>: 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>
109 114
110=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 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>.
119
120I<Please note that transparency of any kind if completely unsupported by
121the author. Don't bug him with installation questions! Read the FAQ (man 7
122@@RXVT_NAME@@)!>
114 123
115=item B<-fade> I<number> 124=item B<-fade> I<number>
116 125
117Fade the text by the given percentage when focus is lost. Small values 126Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade 127fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>. 128colour; resource B<fading>.
120 129
121=item B<-fadecolor> I<colour> 130=item B<-fadecolor> I<colour>
122 131
123Fade to this colour when fading is used (see B<-fade>). The default colour 132Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>. 133is opaque black. resource B<fadeColor>.
125 134
126=item B<-tint> I<colour> 135=item B<-tint> I<colour>
127 136
128Tint the transparent background pixmap with the given colour when 137Tint the transparent background pixmap with the given colour when
129transparency is enabled with B<-tr> or B<-ip>. This only works for 138transparency is enabled with B<-tr> or B<-ip>. This only works for
172resource B<borderColor>. 181resource B<borderColor>.
173 182
174=item B<-fn> I<fontlist> 183=item B<-fn> I<fontlist>
175 184
176Select the fonts to be used. This is a comma separated list of font names 185Select the fonts to be used. This is a comma separated list of font names
177that are used in turn when trying to display Unicode characters. The 186that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 187first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 188smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 189font list is always appended to it. See resource B<font> for more details.
181 190
182In short, to specify an X11 core font, just specify it's name or prefix it 191In short, to specify an X11 core font, just specify its name or prefix it
183with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, 192with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.: 193e.g.:
185 194
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 195 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 196 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
296=item B<-bl> 305=item B<-bl>
297 306
298Compile I<frills>: Set MWM hints to request a borderless window, i.e. 307Compile I<frills>: Set MWM hints to request a borderless window, i.e.
299if honoured by the WM, the rxvt-unicode window will not have window 308if honoured by the WM, the rxvt-unicode window will not have window
300decorations; resource B<borderLess>. 309decorations; resource B<borderLess>.
310
311=item B<-override-redirect>
312
313Compile I<frills>: Sets override-redirect on the window; resource
314B<override-redirect>.
301 315
302=item B<-sbg> 316=item B<-sbg>
303 317
304Compile I<frills>: Disable the usage of the built-in block graphics/line 318Compile I<frills>: Disable the usage of the built-in block graphics/line
305drawing characters and just rely on what the specified fonts provide. Use 319drawing characters and just rely on what the specified fonts provide. Use
410 424
411Remap a key symbol. See resource B<keysym>. 425Remap a key symbol. See resource B<keysym>.
412 426
413=item B<-embed> I<windowid> 427=item B<-embed> I<windowid>
414 428
415Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 429Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
416which enables applications to easily embed a terminal. 430which enables applications to easily embed a terminal.
417 431
418Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 432Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
419shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 433shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
420quite a bit, so don't expect it to keep some specific state. It's best to 434quite a bit, so don't expect it to keep some specific state. It's best to
423The window will not be destroyed when @@RXVT_NAME@@ exits. 437The window will not be destroyed when @@RXVT_NAME@@ exits.
424 438
425It might be useful to know that @@RXVT_NAME@@ will not close file 439It might be useful to know that @@RXVT_NAME@@ will not close file
426descriptors passed to it (except for stdin/out/err, of course), so you 440descriptors passed to it (except for stdin/out/err, of course), so you
427can use file descriptors to communicate with the programs within the 441can use file descriptors to communicate with the programs within the
428terminal. This works regardless of wether the C<-embed> option was used or 442terminal. This works regardless of whether the C<-embed> option was used or
429not. 443not.
430 444
431Here is a short Gtk2-perl snippet that illustrates how this option can be 445Here is a short Gtk2-perl snippet that illustrates how this option can be
432used (a longer example is in F<doc/embed>): 446used (a longer example is in F<doc/embed>):
433 447
438 }); 452 });
439 453
440=item B<-pty-fd> I<file descriptor> 454=item B<-pty-fd> I<file descriptor>
441 455
442Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 456Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
443pair but instead use the given filehandle as the tty master. This is 457pair but instead use the given file descriptor as the tty master. This is
444useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 458useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445without having to run a program within it. 459without having to run a program within it.
446 460
447If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 461If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
448entries and will not tinker with pty/tty permissions - you have to do that 462entries and will not tinker with pty/tty permissions - you have to do that
466 my $slave = $pty->slave; 480 my $slave = $pty->slave;
467 while (<$slave>) { print $slave "got <$_>\n" } 481 while (<$slave>) { print $slave "got <$_>\n" }
468 482
469=item B<-pe> I<string> 483=item B<-pe> I<string>
470 484
471Colon-separated list of perl extension scripts to use in this terminal 485Comma-separated list of perl extension scripts to use (or not to use) in
472instance. See resource B<perl-ext>. 486this terminal instance. See resource B<perl-ext> for details.
473 487
474=back 488=back
475 489
476=head1 RESOURCES (available also as long-options) 490=head1 RESOURCES (available also as long-options)
477 491
478Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 492Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
479options) compiled into your version. 493options) compiled into your version.
480 494
481There are two different methods that @@RXVT_NAME@@ can use to get the 495You can set and change the resources using X11 tools like B<xrdb>. Many
482Xresource data: using the X libraries (Xrm*-functions) or internal 496distribution do also load settings from the B<~/.Xresources> file when X
483Xresources reader (B<~/.Xdefaults>). For the first method (ie. 497starts. @@RXVT_NAME@@ will consult the following files/resources in order,
484B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 498with later settings overwriting earlier ones:
485resources using X11 tools like B<xrdb>. Many distribution do also load
486settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
487will consult the following files/resources in order, with later settings
488overwriting earlier ones:
489 499
490 1. system-wide app-defaults file, either locale-dependent OR global 500 1. system-wide app-defaults file, either locale-dependent OR global
491 2. app-defaults file in $XAPPLRESDIR 501 2. app-defaults file in $XAPPLRESDIR
492 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 502 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
493 4. SCREEN_RESOURCES for the current screen 503 4. SCREEN_RESOURCES for the current screen
494 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 504 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
495 505
496If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
497lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
498set in XAPPLOADDIR/URxvt (compile-time defined: usually
499B</usr/lib/X11/app-defaults/URxvt>) and resources set in
500B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
501Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 506Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
502class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 507names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
503resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 508common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
504easily configured, while the class name B<URxvt> allows resources 509configured, while the class name B<URxvt> allows resources unique to
505unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 510B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
506shared between different B<@@RXVT_NAME@@> configurations. If no 511configurations. If no resources are specified, suitable defaults will
507resources are specified, suitable defaults will be used. Command-line 512be used. Command-line arguments can be used to override resource
508arguments can be used to override resource settings. The following 513settings. The following resources are supported (you might want to
509resources are allowed: 514check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
515extensions not documented here):
510 516
511=over 4 517=over 4
518
519=item B<depth:> I<bitdepth>
520
521Compile I<xft>: Attempt to find a visual with the given bit depth;
522option B<-depth>.
512 523
513=item B<geometry:> I<geom> 524=item B<geometry:> I<geom>
514 525
515Create the window with the specified X window geometry [default 80x24]; 526Create the window with the specified X window geometry [default 80x24];
516option B<-geometry>. 527option B<-geometry>.
589=item B<inheritPixmap:> I<boolean> 600=item B<inheritPixmap:> I<boolean>
590 601
591B<True>: make the background inherit the parent windows' pixmap, giving 602B<True>: make the background inherit the parent windows' pixmap, giving
592artificial transparency. B<False>: do not inherit the parent windows' 603artificial transparency. B<False>: do not inherit the parent windows'
593pixmap. 604pixmap.
605
606I<Please note that transparency of any kind if completely unsupported by
607the author. Don't bug him with installation questions!>
594 608
595=item B<fading:> I<number> 609=item B<fading:> I<number>
596 610
597Fade the text by the given percentage when focus is lost; option B<-fade>. 611Fade the text by the given percentage when focus is lost; option B<-fade>.
598 612
635of 1 displays the image without any scaling. A scale of 2 to 9 649of 1 displays the image without any scaling. A scale of 2 to 9
636specifies an integer number of images in that direction. No image will 650specifies an integer number of images in that direction. No image will
637be magnified beyond 10 times its original size. The maximum permitted 651be magnified beyond 10 times its original size. The maximum permitted
638scale is 1000. [default 0x0+50+50] 652scale is 1000. [default 0x0+50+50]
639 653
640=item B<menu:> I<file[;tag]>
641
642Read in the specified menu file (note the `.menu' extension is
643optional) and also optionally specify a starting tag to find. See the
644reference documentation for details on the syntax for the menuBar.
645
646=item B<path:> I<path> 654=item B<path:> I<path>
647 655
648Specify the colon-delimited search path for finding files (XPM and 656Specify the colon-delimited search path for finding XPM files.
649menus), in addition to the paths specified by the B<RXVTPATH> and
650B<PATH> environment variables.
651 657
652=item B<font:> I<fontlist> 658=item B<font:> I<fontlist>
653 659
654Select the fonts to be used. This is a comma separated list of font 660Select the fonts to be used. This is a comma separated list of font names
655names that are used in turn when trying to display Unicode characters. 661that are checked in order when trying to find glyphs for characters. The
656The first font defines the cell size for characters; other fonts might 662first font defines the cell size for characters; other fonts might be
657be smaller, but not larger. A reasonable default font list is always 663smaller, but not (in general) larger. A (hopefully) reasonable default
658appended to it; option B<-fn>. 664font list is always appended to it; option B<-fn>.
659 665
660Each font can either be a standard X11 core font (XLFD) name, with 666Each font can either be a standard X11 core font (XLFD) name, with
661optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 667optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
662 668
663In addition, each font can be prefixed with additional hints and 669In addition, each font can be prefixed with additional hints and
665hint currently is C<codeset=codeset-name>, and this is only used for Xft 671hint currently is C<codeset=codeset-name>, and this is only used for Xft
666fonts. 672fonts.
667 673
668For example, this font resource 674For example, this font resource
669 675
670 URxvt*font: 9x15bold,\ 676 URxvt.font: 9x15bold,\
671 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 677 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
672 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 678 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
673 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 679 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
674 xft:Code2000:antialias=false 680 xft:Code2000:antialias=false
675 681
713 719
714=item B<intensityStyles:> I<boolean> 720=item B<intensityStyles:> I<boolean>
715 721
716When font styles are not enabled, or this option is enabled (B<True>, 722When font styles are not enabled, or this option is enabled (B<True>,
717option B<-is>, the default), bold and italic font styles imply high 723option B<-is>, the default), bold and italic font styles imply high
718intensity foreground/backround colours. Disabling this option (B<False>, 724intensity foreground/background colours. Disabling this option (B<False>,
719option B<+is>) disables this behaviour, the high intensity colours are not 725option B<+is>) disables this behaviour, the high intensity colours are not
720reachable. 726reachable.
721 727
722=item B<selectstyle:> I<mode> 728=item B<selectstyle:> I<mode>
723 729
772 778
773The string will be interpreted as if typed into the shell as-is. 779The string will be interpreted as if typed into the shell as-is.
774 780
775Example: 781Example:
776 782
777 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 783 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
778 784
779This creates a new file in your home directory with the screen contents 785This creates a new file in your home directory with the screen contents
780everytime you hit C<Print>. 786every time you hit C<Print>.
781 787
782=item B<scrollBar:> I<boolean> 788=item B<scrollBar:> I<boolean>
783 789
784B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 790B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
785disable the scrollbar; option B<+sb>. 791disable the scrollbar; option B<+sb>.
807 813
808=item B<scrollWithBuffer:> I<boolean> 814=item B<scrollWithBuffer:> I<boolean>
809 815
810B<True>: scroll with scrollback buffer when tty receives new lines (and 816B<True>: scroll with scrollback buffer when tty receives new lines (and
811B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 817B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
812with scrollback buffer when tty recieves new lines; option B<+sw>. 818with scrollback buffer when tty receives new lines; option B<+sw>.
813 819
814=item B<scrollTtyKeypress:> I<boolean> 820=item B<scrollTtyKeypress:> I<boolean>
815 821
816B<True>: scroll to bottom when a non-special key is pressed. Special keys 822B<True>: scroll to bottom when a non-special key is pressed. Special keys
817are those which are intercepted by rxvt-unicode for special handling and 823are those which are intercepted by rxvt-unicode for special handling and
907pressed. If unset it will send the sequence traditionally associated 913pressed. If unset it will send the sequence traditionally associated
908with the B<Execute> key. 914with the B<Execute> key.
909 915
910=item B<cutchars:> I<string> 916=item B<cutchars:> I<string>
911 917
912The characters used as delimiters for double-click word selection. The 918The characters used as delimiters for double-click word selection
913built-in default: 919(whitespace delimiting is added automatically if resource is given).
920
921When the selection extension is in use (the default if compiled in, see
922the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
923will be created (if the resource exists, otherwise, no regex will be
924created). In this mode, characters outside ISO-8859-1 can be used.
925
926When the selection extension is not used, only ISO-8859-1 characters can
927be used. If not specified, the built-in default is used:
914 928
915B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 929B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
916 930
917=item B<preeditType:> I<style> 931=item B<preeditType:> I<style>
918 932
954default. (Note that many other terminals, including xterm, have these 968default. (Note that many other terminals, including xterm, have these
955sequences enabled by default, which doesn't make it safer, though). 969sequences enabled by default, which doesn't make it safer, though).
956 970
957You can enable them by setting this boolean resource or specifying 971You can enable them by setting this boolean resource or specifying
958B<-insecure> as an option. At the moment, this enables display-answer, 972B<-insecure> as an option. At the moment, this enables display-answer,
959locale, findfont, icon label and window title requests as well as dynamic 973locale, findfont, icon label and window title requests.
960menubar dispatch.
961 974
962=item B<modifier:> I<modifier> 975=item B<modifier:> I<modifier>
963 976
964Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 977Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
965B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 978B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
969 982
970Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 983Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
971character is passed through. It may contain escape values as described 984character is passed through. It may contain escape values as described
972in the entry on B<keysym> following. 985in the entry on B<keysym> following.
973 986
974=item B<secondaryScreen:> I<bool> 987=item B<secondaryScreen:> I<boolean>
975 988
976Turn on/off secondary screen (default enabled). 989Turn on/off secondary screen (default enabled).
977 990
978=item B<secondaryScroll:> I<bool> 991=item B<secondaryScroll:> I<boolean>
979 992
980Turn on/off secondary screen scroll (default enabled). If the this 993Turn on/off secondary screen scroll (default enabled). If the this
981option is enabled, scrolls on the secondary screen will change the 994option is enabled, scrolls on the secondary screen will change the
982scrollback buffer and switching to/from the secondary screen will 995scrollback buffer and switching to/from the secondary screen will
983instead scroll the screen up. 996instead scroll the screen up.
984 997
985=item B<hold>: I<bool> 998=item B<hold>: I<boolean>
986 999
987Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1000Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
988will not immediately destroy its window when the program executed within 1001will not immediately destroy its window when the program executed within
989it exits. Instead, it will wait till it is being killed or closed by the 1002it exits. Instead, it will wait till it is being killed or closed by the
990user. 1003user.
1015C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1028C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
1016C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1029C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1017C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1030C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1018can start or end with whitespace. 1031can start or end with whitespace.
1019 1032
1020Please note that you need to double the C<\> when using 1033Please note that you need to double the C<\> in resource files, as
1021C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can 1034Xlib itself does its own de-escaping (you can use C<\033> instead of
1022use C<\033> instead of C<\e> (and so on), which will work with both Xt and 1035C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1023@@RXVT_NAME@@'s own processing). 1036processing).
1024 1037
1025You can define a range of keysyms in one shot by providing a I<string> 1038You can define a range of keysyms in one shot by providing a I<string>
1026with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1039with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1027should be a character not used by the strings. 1040should be a character not used by the strings.
1028 1041
1029Its usage can be demonstrated by an example: 1042Its usage can be demonstrated by an example:
1030 1043
1031 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1044 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1084 1097
1085=item B<perl-ext-common>: I<string> 1098=item B<perl-ext-common>: I<string>
1086 1099
1087=item B<perl-ext>: I<string> 1100=item B<perl-ext>: I<string>
1088 1101
1089Colon-separated list(s) of perl extension scripts to use in this terminal 1102Comma-separated list(s) of perl extension scripts (default: C<default>) to
1103use in this terminal instance; option B<-pe>.
1104
1105Extension names can be prefixed with a C<-> sign to prohibit using
1106them. This can be useful to selectively disable some extensions loaded
1107by default, or specified via the C<perl-ext-common> resource. For
1108example, C<default,-selection> will use all the default extension except
1109C<selection>.
1110
1111Extension names can also be followed by an argument in angle brackets
1112(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1113searchable scrollback to Alt/Meta-s). Mentioning the same extension
1114multiple times with different arguments will pass multiple arguments to
1115the extension.
1116
1090instance. Each extension is looked up in the library directories, loaded 1117Each extension is looked up in the library directories, loaded if
1091if necessary, and bound to the current terminal instance. If this 1118necessary, and bound to the current terminal instance.
1092resource is empty or missing, then the perl interpreter will not be 1119
1093initialized. The idea behind two options is that B<perl-ext-common> will 1120If both of these resources are the empty string, then the perl
1094be used for extensions that should be available to all instances, while 1121interpreter will not be initialized. The idea behind two options is that
1095B<perl-ext> is used for specific instances; option B<-pe>. 1122B<perl-ext-common> will be used for extensions that should be available to
1123all instances, while B<perl-ext> is used for specific instances.
1096 1124
1097=item B<perl-eval>: I<string> 1125=item B<perl-eval>: I<string>
1098 1126
1099Perl code to be evaluated when all extensions have been registered. See the 1127Perl code to be evaluated when all extensions have been registered. See
1100@@RXVT_NAME@@perl(3) manpage. 1128the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1129will be ignored when running setuid/setgid.
1101 1130
1102=item B<perl-lib>: I<path> 1131=item B<perl-lib>: I<path>
1103 1132
1104Colon-separated list of additional directories that hold extension 1133Colon-separated list of additional directories that hold extension
1105scripts. When looking for extensions specified by the C<perl> resource, 1134scripts. When looking for extensions specified by the C<perl> resource,
1106@@RXVT_NAME@@ will first look in these directories and then in 1135@@RXVT_NAME@@ will first look in these directories and then in
1107F<@@RXVT_LIBDIR@@/urxvt/perl/>. 1136F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1137will be ignored when running setuid/setgid.
1108 1138
1109See the @@RXVT_NAME@@perl(3) manpage. 1139See the @@RXVT_NAME@@perl(3) manpage.
1140
1141=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1142
1143Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1144details.
1145
1146=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1147
1148Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1149for details.
1150
1151=item B<searchable-scrollback:> I<keysym>
1152
1153Sets the hotkey that starts the incremental scrollback buffer search
1154(default: C<M-s>).
1155
1156=item B<urlLauncher>: I<string>
1157
1158Specifies the program to be started with a URL argument. Used by the
1159C<selection-popup> and C<mark-urls> perl extensions.
1160
1161=item B<transient-for>: I<windowid>
1162
1163Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1164
1165=item B<override-redirect>: I<boolean>
1166
1167Compile I<frills>: Sets override-redirect for the terminal window, making
1168it almost invisible to window managers; option B<-override-redirect>.
1110 1169
1111=back 1170=back
1112 1171
1113=head1 THE SCROLLBAR 1172=head1 THE SCROLLBAR
1114 1173
1156selection, and trailing whitespace is visually underlined and removed from 1215selection, and trailing whitespace is visually underlined and removed from
1157the selection. 1216the selection.
1158 1217
1159=item B<Insertion>: 1218=item B<Insertion>:
1160 1219
1161Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1220Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1162an B<@@RXVT_NAME@@> window causes the current text selection to be 1221window causes the value of the PRIMARY selection (or CLIPBOARD with the
1163inserted as if it had been typed on the keyboard. 1222Meta modifier) to be inserted as if it had been typed on the keyboard.
1223
1224Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1225inserted too.
1164 1226
1165=back 1227=back
1166 1228
1167=head1 CHANGING FONTS 1229=head1 CHANGING FONTS
1168 1230
1169Changing fonts (or font sizes, respectively) via the keypad is not yet 1231Changing fonts (or font sizes, respectively) via the keypad is not yet
1170supported in rxvt-unicode. Bug me if you need this. 1232supported in rxvt-unicode. Bug me if you need this.
1171 1233
1172You can, however, switch fonts at runtime using escape sequences (and 1234You can, however, switch fonts at runtime using escape sequences, e.g.:
1173therefore using the menubar), e.g.:
1174 1235
1175 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1236 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1237
1238You can use keyboard shortcuts, too:
1239
1240 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1241 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1176 1242
1177rxvt-unicode will automatically re-apply these fonts to the output so far. 1243rxvt-unicode will automatically re-apply these fonts to the output so far.
1178 1244
1179=head1 ISO 14755 SUPPORT 1245=head1 ISO 14755 SUPPORT
1180 1246
1208This mode lets you input characters representing the keycap symbols of 1274This mode lets you input characters representing the keycap symbols of
1209your keyboard, if representable in the current locale encoding. 1275your keyboard, if representable in the current locale encoding.
1210 1276
1211Start by pressing C<Control> and C<Shift> together, then releasing 1277Start by pressing C<Control> and C<Shift> together, then releasing
1212them. The next special key (cursor keys, home etc.) you enter will not 1278them. The next special key (cursor keys, home etc.) you enter will not
1213invoke it's usual function but instead will insert the corresponding 1279invoke its usual function but instead will insert the corresponding
1214keycap symbol. The symbol will only be entered when the key has been 1280keycap symbol. The symbol will only be entered when the key has been
1215released, otherwise pressing e.g. C<Shift> would enter the symbol for 1281released, otherwise pressing e.g. C<Shift> would enter the symbol for
1216C<ISO Level 2 Switch>, although your intention might have been to enter a 1282C<ISO Level 2 Switch>, although your intention might have been to enter a
1217reverse tab (Shift-Tab). 1283reverse tab (Shift-Tab).
1218 1284
1251=head1 COLORS AND GRAPHICS 1317=head1 COLORS AND GRAPHICS
1252 1318
1253In addition to the default foreground and background colours, 1319In addition to the default foreground and background colours,
1254B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1320B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1255high-intensity bold/blink versions of the same). Here is a list of the 1321high-intensity bold/blink versions of the same). Here is a list of the
1256colours with their B<rgb.txt> names. 1322colours with their names.
1257 1323
1258=begin table 1324=begin table
1259 1325
1260 B<color0> (black) = Black 1326 B<color0> (black) = Black
1261 B<color1> (red) = Red3 1327 B<color1> (red) = Red3
1281It is also possible to specify the colour values of B<foreground>, 1347It is also possible to specify the colour values of B<foreground>,
1282B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1348B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1283a number 0-15, as a convenient shorthand to reference the colour name of 1349a number 0-15, as a convenient shorthand to reference the colour name of
1284color0-color15. 1350color0-color15.
1285 1351
1352In addition to the colours defined above, @@RXVT_NAME@@ offers an
1353additional 72 colours. The first 64 of those (with indices 16 to 79)
1354consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
135516>), followed by 8 additional shades of gray (with indices 80 to 87).
1356
1357Together, all those colours implement the 88 colour xterm colours. Only
1358the first 16 can be changed using resources currently, the rest can only
1359be changed via command sequences ("escape codes").
1360
1286Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1361Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1287always swapping the foreground/background colours. This is in contrast to 1362always swapping the foreground/background colours. This is in contrast to
1288I<xterm>(1) where the colours are only swapped if they have not otherwise 1363I<xterm>(1) where the colours are only swapped if they have not otherwise
1289been specified. For example, 1364been specified. For example,
1290 1365
1295would yield White on Black, while on I<xterm>(1) it would yield Black 1370would yield White on Black, while on I<xterm>(1) it would yield Black
1296on White. 1371on White.
1297 1372
1298=back 1373=back
1299 1374
1375=head2 ALPHA CHANNEL SUPPORT
1376
1377If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1378their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1379(recommended, but B<MUST> have 4 digits/component) colour specifications,
1380in addition to the ones provided by X, where the additional A component
1381specifies opacity (alpha) values. The minimum value of C<0> is completely
1382transparent). You can also prefix any color with C<[a]>, where C<a> is on
1383to four hex digits specifiying the opacity value.
1384
1385You probably need to specify B<"-depth 32">, too, and have the luck that
1386your X-server uses ARGB pixel layout, as X is far from just supporting
1387ARGB visuals out of the box, and rxvt-unicode just fudges around.
1388
1389For example, the following selects an almost completely transparent red
1390background, and an almost opaque pink foreground:
1391
1392 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1393
1394I<Please note that transparency of any kind if completely unsupported by
1395the author. Don't bug him with installation questions!>
1396
1300=head1 ENVIRONMENT 1397=head1 ENVIRONMENT
1301 1398
1302B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1399B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1303 1400
1304=over 4 1401=over 4
1305 1402
1306=item B<TERM> 1403=item B<TERM>
1307 1404
1308Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1405Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1309resources or on the commandline. 1406resources or on the command line.
1310 1407
1311=item B<COLORTERM> 1408=item B<COLORTERM>
1312 1409
1313Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1410Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1314compiled with XPM support, and optionally with the added extension 1411compiled with XPM support, and optionally with the added extension
1315C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1412C<-mono> to indicate that rxvt-unicode runs on a monochrome screen.
1316 1413
1317=item B<COLORFGBG> 1414=item B<COLORFGBG>
1318 1415
1336C<--with-terminfo=PATH>. 1433C<--with-terminfo=PATH>.
1337 1434
1338=item B<DISPLAY> 1435=item B<DISPLAY>
1339 1436
1340Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1437Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1341display in it's child processes. 1438display in its child processes.
1342 1439
1343=item B<SHELL> 1440=item B<SHELL>
1344 1441
1345The shell to be used for command execution, defaults to C</bin/sh>. 1442The shell to be used for command execution, defaults to C</bin/sh>.
1346
1347=item B<RXVTPATH>
1348
1349The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1350files.
1351
1352=item B<PATH>
1353
1354Used in the same way as C<RXVTPATH>.
1355 1443
1356=item B<RXVT_SOCKET> 1444=item B<RXVT_SOCKET>
1357 1445
1358The unix domain socket path used by @@RXVT_NAME@@c(1) and 1446The unix domain socket path used by @@RXVT_NAME@@c(1) and
1359@@RXVT_NAME@@d(1). 1447@@RXVT_NAME@@d(1).
1397 1485
1398=item Project Coordinator 1486=item Project Coordinator
1399 1487
1400Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1488Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1401 1489
1402L<http://software.schmorp.de/#rxvt-unicode> 1490L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1403 1491
1404=back 1492=back
1405 1493
1406=head1 AUTHORS 1494=head1 AUTHORS
1407 1495
1429 1517
1430Project Coordinator (changes.txt 2.21a to 2.4.5) 1518Project Coordinator (changes.txt 2.21a to 2.4.5)
1431 1519
1432=item Geoff Wing L<< <gcw@pobox.com> >> 1520=item Geoff Wing L<< <gcw@pobox.com> >>
1433 1521
1434Rewrote screen display and text selection routines. Project Coordinator 1522Rewrote screen display and text selection routines.
1523
1435(changes.txt 2.4.6 - rxvt-unicode) 1524Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1436 1525
1437=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1526=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1438 1527
1439Forked rxvt-unicode, rewrote most of the display code and internal 1528Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1440character handling to store text in unicode, improve xterm 1529extension, random hacks, numerous bugfixes and extensions.
1441compatibility and apply numerous other bugfixes and extensions.
1442 1530
1443Project Coordinator (Changes 1.0 -) 1531Project Coordinator (Changes 1.0 -)
1444 1532
1533=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1534
1535Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1536
1445=back 1537=back
1446 1538

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines