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.76 by root, Sat Dec 31 16:06:48 2005 UTC vs.
Revision 1.116 by root, Mon Jul 10 04:03:09 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
… …
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!>
114 122
115=item B<-fade> I<number> 123=item B<-fade> I<number>
116 124
117Fade the text by the given percentage when focus is lost. Small values 125Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade 126fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>. 127colour; resource B<fading>.
120 128
121=item B<-fadecolor> I<colour> 129=item B<-fadecolor> I<colour>
122 130
123Fade to this colour when fading is used (see B<-fade>). The default colour 131Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>. 132is opaque black. resource B<fadeColor>.
125 133
126=item B<-tint> I<colour> 134=item B<-tint> I<colour>
127 135
128Tint the transparent background pixmap with the given colour when 136Tint the transparent background pixmap with the given colour when
129transparency is enabled with B<-tr> or B<-ip>. This only works for 137transparency is enabled with B<-tr> or B<-ip>. This only works for
… …
172resource B<borderColor>. 180resource B<borderColor>.
173 181
174=item B<-fn> I<fontlist> 182=item B<-fn> I<fontlist>
175 183
176Select the fonts to be used. This is a comma separated list of font names 184Select 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 185that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 186first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 187smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 188font list is always appended to it. See resource B<font> for more details.
181 189
182In short, to specify an X11 core font, just specify it's name or prefix it 190In 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:>, 191with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.: 192e.g.:
185 193
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 194 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 195 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
… …
189See also the question "How does rxvt-unicode choose fonts?" in the FAQ 197See also the question "How does rxvt-unicode choose fonts?" in the FAQ
190section of @@RXVT_NAME@@(7). 198section of @@RXVT_NAME@@(7).
191 199
192=item B<-fb> I<fontlist> 200=item B<-fb> I<fontlist>
193 201
194Compile font-styles: The bold font list to use when bold characters are to 202Compile I<font-styles>: The bold font list to use when B<bold> characters
195be printed. See resource B<boldFont> for details. 203are to be printed. See resource B<boldFont> for details.
196 204
197=item B<-fi> I<fontlist> 205=item B<-fi> I<fontlist>
198 206
199Compile font-styles: The italic font list to use when bold characters are to 207Compile I<font-styles>: The italic font list to use when I<italic>
200be printed. See resource B<italicFont> for details. 208characters are to be printed. See resource B<italicFont> for details.
201 209
202=item B<-fbi> I<fontlist> 210=item B<-fbi> I<fontlist>
203 211
204Compile font-styles: The bold italic font list to use when bold characters are to 212Compile I<font-styles>: The bold italic font list to use when B<< I<bold
205be printed. See resource B<boldItalicFont> for details. 213italic> >> characters are to be printed. See resource B<boldItalicFont>
214for details.
206 215
207=item B<-is>|B<+is> 216=item B<-is>|B<+is>
208 217
209Compile font-styles: Bold/Italic font styles imply high intensity 218Compile I<font-styles>: Bold/Italic font styles imply high intensity
210foreground/background (default). See resource B<intensityStyles> for 219foreground/background (default). See resource B<intensityStyles> for
211details. 220details.
212 221
213=item B<-name> I<name> 222=item B<-name> I<name>
214 223
… …
295=item B<-bl> 304=item B<-bl>
296 305
297Compile I<frills>: Set MWM hints to request a borderless window, i.e. 306Compile I<frills>: Set MWM hints to request a borderless window, i.e.
298if honoured by the WM, the rxvt-unicode window will not have window 307if honoured by the WM, the rxvt-unicode window will not have window
299decorations; resource B<borderLess>. 308decorations; resource B<borderLess>.
309
310=item B<-override-redirect>
311
312Compile I<frills>: Sets override-redirect on the window; resource
313B<override-redirect>.
314
315=item B<-sbg>
316
317Compile I<frills>: Disable the usage of the built-in block graphics/line
318drawing characters and just rely on what the specified fonts provide. Use
319this if you have a good font and want to use its block graphic glyphs;
320resource B<skipBuiltinGlyphs>.
300 321
301=item B<-lsp> I<number> 322=item B<-lsp> I<number>
302 323
303Compile I<frills>: Lines (pixel height) to insert between each row of 324Compile I<frills>: Lines (pixel height) to insert between each row of
304the display. Useful to work around font rendering problems; resource 325the display. Useful to work around font rendering problems; resource
… …
402 423
403Remap a key symbol. See resource B<keysym>. 424Remap a key symbol. See resource B<keysym>.
404 425
405=item B<-embed> I<windowid> 426=item B<-embed> I<windowid>
406 427
407Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 428Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
408which enables applications to easily embed a terminal. 429which enables applications to easily embed a terminal.
409 430
410Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 431Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
411shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 432shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
412quite a bit, so don't expect it to keep some specific state. It's best to 433quite a bit, so don't expect it to keep some specific state. It's best to
… …
427 $rxvt->signal_connect_after (realize => sub { 448 $rxvt->signal_connect_after (realize => sub {
428 my $xid = $_[0]->window->get_xid; 449 my $xid = $_[0]->window->get_xid;
429 system "@@RXVT_NAME@@ -embed $xid &"; 450 system "@@RXVT_NAME@@ -embed $xid &";
430 }); 451 });
431 452
432=item B<-pty-fd> I<fileno> 453=item B<-pty-fd> I<file descriptor>
433 454
434Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 455Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
435pair but instead use the given filehandle as the tty master. This is 456pair but instead use the given filehandle as the tty master. This is
436useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 457useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
437without having to run a program within it. 458without having to run a program within it.
438 459
439If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 460If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
440entries and will not tinker with pty/tty permissions - you have to do that 461entries and will not tinker with pty/tty permissions - you have to do that
441yourself if you want that. 462yourself if you want that.
442 463
464As an extremely special case, specifying C<-1> will completely suppress
465pty/tty operations.
466
443Here is a example in perl that illustrates how this option can be used (a 467Here is a example in perl that illustrates how this option can be used (a
444longer example is in F<doc/pty-fd>): 468longer example is in F<doc/pty-fd>):
445 469
446 use IO::Pty; 470 use IO::Pty;
447 use Fcntl; 471 use Fcntl;
… …
453 477
454 # now communicate with rxvt 478 # now communicate with rxvt
455 my $slave = $pty->slave; 479 my $slave = $pty->slave;
456 while (<$slave>) { print $slave "got <$_>\n" } 480 while (<$slave>) { print $slave "got <$_>\n" }
457 481
482=item B<-pe> I<string>
483
484Comma-separated list of perl extension scripts to use (or not to use) in
485this terminal instance. See resource B<perl-ext> for details.
486
458=back 487=back
459 488
460=head1 RESOURCES (available also as long-options) 489=head1 RESOURCES (available also as long-options)
461 490
462Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 491Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
463options) compiled into your version. 492options) compiled into your version.
464 493
465There are two different methods that @@RXVT_NAME@@ can use to get the 494You can set and change the resources using X11 tools like B<xrdb>. Many
466Xresource data: using the X libraries (Xrm*-functions) or internal 495distribution do also load settings from the B<~/.Xresources> file when X
467Xresources reader (B<~/.Xdefaults>). For the first method (ie. 496starts. @@RXVT_NAME@@ will consult the following files/resources in order,
468B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 497with later settings overwriting earlier ones:
469resources using X11 tools like B<xrdb>. Many distribution do also load
470settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
471will consult the following files/resources in order, with later settings
472overwriting earlier ones:
473 498
474 1. system-wide app-defaults file, either locale-dependent OR global 499 1. system-wide app-defaults file, either locale-dependent OR global
475 2. app-defaults file in $XAPPLRESDIR 500 2. app-defaults file in $XAPPLRESDIR
476 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 501 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
477 4. SCREEN_RESOURCES for the current screen 502 4. SCREEN_RESOURCES for the current screen
478 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 503 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
479 504
480If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
481lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
482set in XAPPLOADDIR/URxvt (compile-time defined: usually
483B</usr/lib/X11/app-defaults/URxvt>) and resources set in
484B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
485Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 505Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
486class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 506names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
487resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 507common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
488easily configured, while the class name B<URxvt> allows resources 508configured, while the class name B<URxvt> allows resources unique to
489unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 509B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
490shared between different B<@@RXVT_NAME@@> configurations. If no 510configurations. If no resources are specified, suitable defaults will
491resources are specified, suitable defaults will be used. Command-line 511be used. Command-line arguments can be used to override resource
492arguments can be used to override resource settings. The following 512settings. The following resources are supported (you might want to
493resources are allowed: 513check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
514extensions not documented here):
494 515
495=over 4 516=over 4
517
518=item B<depth:> I<bitdepth>
519
520Compile I<xft>: Attempt to find a visual with the given bit depth;
521option B<-depth>.
496 522
497=item B<geometry:> I<geom> 523=item B<geometry:> I<geom>
498 524
499Create the window with the specified X window geometry [default 80x24]; 525Create the window with the specified X window geometry [default 80x24];
500option B<-geometry>. 526option B<-geometry>.
… …
573=item B<inheritPixmap:> I<boolean> 599=item B<inheritPixmap:> I<boolean>
574 600
575B<True>: make the background inherit the parent windows' pixmap, giving 601B<True>: make the background inherit the parent windows' pixmap, giving
576artificial transparency. B<False>: do not inherit the parent windows' 602artificial transparency. B<False>: do not inherit the parent windows'
577pixmap. 603pixmap.
604
605I<Please note that transparency of any kind if completely unsupported by
606the author. Don't bug him with installation questions!>
578 607
579=item B<fading:> I<number> 608=item B<fading:> I<number>
580 609
581Fade the text by the given percentage when focus is lost; option B<-fade>. 610Fade the text by the given percentage when focus is lost; option B<-fade>.
582 611
… …
619of 1 displays the image without any scaling. A scale of 2 to 9 648of 1 displays the image without any scaling. A scale of 2 to 9
620specifies an integer number of images in that direction. No image will 649specifies an integer number of images in that direction. No image will
621be magnified beyond 10 times its original size. The maximum permitted 650be magnified beyond 10 times its original size. The maximum permitted
622scale is 1000. [default 0x0+50+50] 651scale is 1000. [default 0x0+50+50]
623 652
624=item B<menu:> I<file[;tag]>
625
626Read in the specified menu file (note the `.menu' extension is
627optional) and also optionally specify a starting tag to find. See the
628reference documentation for details on the syntax for the menuBar.
629
630=item B<path:> I<path> 653=item B<path:> I<path>
631 654
632Specify the colon-delimited search path for finding files (XPM and 655Specify the colon-delimited search path for finding XPM files.
633menus), in addition to the paths specified by the B<RXVTPATH> and
634B<PATH> environment variables.
635 656
636=item B<font:> I<fontlist> 657=item B<font:> I<fontlist>
637 658
638Select the fonts to be used. This is a comma separated list of font 659Select the fonts to be used. This is a comma separated list of font names
639names that are used in turn when trying to display Unicode characters. 660that are checked in order when trying to find glyphs for characters. The
640The first font defines the cell size for characters; other fonts might 661first font defines the cell size for characters; other fonts might be
641be smaller, but not larger. A reasonable default font list is always 662smaller, but not (in general) larger. A (hopefully) reasonable default
642appended to it. option B<-fn>. 663font list is always appended to it; option B<-fn>.
643 664
644Each font can either be a standard X11 core font (XLFD) name, with 665Each font can either be a standard X11 core font (XLFD) name, with
645optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 666optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
646 667
647In addition, each font can be prefixed with additional hints and 668In addition, each font can be prefixed with additional hints and
… …
649hint currently is C<codeset=codeset-name>, and this is only used for Xft 670hint currently is C<codeset=codeset-name>, and this is only used for Xft
650fonts. 671fonts.
651 672
652For example, this font resource 673For example, this font resource
653 674
654 URxvt*font: 9x15bold,\ 675 URxvt.font: 9x15bold,\
655 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 676 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
656 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 677 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
657 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 678 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
658 xft:Code2000:antialias=false 679 xft:Code2000:antialias=false
659 680
… …
756 777
757The string will be interpreted as if typed into the shell as-is. 778The string will be interpreted as if typed into the shell as-is.
758 779
759Example: 780Example:
760 781
761 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 782 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
762 783
763This creates a new file in your home directory with the screen contents 784This creates a new file in your home directory with the screen contents
764everytime you hit C<Print>. 785everytime you hit C<Print>.
765 786
766=item B<scrollBar:> I<boolean> 787=item B<scrollBar:> I<boolean>
… …
820=item B<borderLess:> I<boolean> 841=item B<borderLess:> I<boolean>
821 842
822Set MWM hints to request a borderless window, i.e. if honoured by the 843Set MWM hints to request a borderless window, i.e. if honoured by the
823WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 844WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
824 845
846=item B<skipBuiltinGlyphs:> I<boolean>
847
848Compile I<frills>: Disable the usage of the built-in block graphics/line
849drawing characters and just rely on what the specified fonts provide. Use
850this if you have a good font and want to use its block graphic glyphs;
851option B<-sbg>.
852
825=item B<termName:> I<termname> 853=item B<termName:> I<termname>
826 854
827Specifies the terminal type name to be set in the B<TERM> environment 855Specifies the terminal type name to be set in the B<TERM> environment
828variable; option B<-tn>. 856variable; option B<-tn>.
829 857
… …
884pressed. If unset it will send the sequence traditionally associated 912pressed. If unset it will send the sequence traditionally associated
885with the B<Execute> key. 913with the B<Execute> key.
886 914
887=item B<cutchars:> I<string> 915=item B<cutchars:> I<string>
888 916
889The characters used as delimiters for double-click word selection. The 917The characters used as delimiters for double-click word selection
890built-in default: 918(whitespace delimiting is added automatically if resource is given).
919
920When the selection extension is in use (the default if compiled in, see
921the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters
922will be created (if the resource exists, otherwise, no regex will be
923created). In this mode, characters outside ISO-8859-1 can be used.
924
925When the selection extension is not used, only ISO-8859-1 characters can
926be used. If not specified, the built-in default is used:
891 927
892B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 928B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
893 929
894=item B<preeditType:> I<style> 930=item B<preeditType:> I<style>
895 931
… …
902=item B<imLocale:> I<name> 938=item B<imLocale:> I<name>
903 939
904The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 940The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
905C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the 941C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
906input extension to be able to input japanese characters while staying in 942input extension to be able to input japanese characters while staying in
907another locale. option B<-imlocale>. 943another locale; option B<-imlocale>.
908 944
909=item B<imFont:> I<fontset> 945=item B<imFont:> I<fontset>
910 946
911Specify the font-set used for XIM styles C<OverTheSpot> or 947Specify the font-set used for XIM styles C<OverTheSpot> or
912C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 948C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
… …
917 953
918=item B<tripleclickwords:> I<boolean> 954=item B<tripleclickwords:> I<boolean>
919 955
920Change the meaning of triple-click selection with the left mouse 956Change the meaning of triple-click selection with the left mouse
921button. Instead of selecting a full line it will extend the selection to 957button. Instead of selecting a full line it will extend the selection to
922the end of the logical line only. option B<-tcw>. 958the end of the logical line only; option B<-tcw>.
923 959
924=item B<insecure:> I<boolean> 960=item B<insecure:> I<boolean>
925 961
926Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 962Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
927echo arbitrary strings like the icon name or the locale. This could be 963echo arbitrary strings like the icon name or the locale. This could be
… …
931default. (Note that many other terminals, including xterm, have these 967default. (Note that many other terminals, including xterm, have these
932sequences enabled by default, which doesn't make it safer, though). 968sequences enabled by default, which doesn't make it safer, though).
933 969
934You can enable them by setting this boolean resource or specifying 970You can enable them by setting this boolean resource or specifying
935B<-insecure> as an option. At the moment, this enables display-answer, 971B<-insecure> as an option. At the moment, this enables display-answer,
936locale, findfont, icon label and window title requests as well as dynamic 972locale, findfont, icon label and window title requests.
937menubar dispatch.
938 973
939=item B<modifier:> I<modifier> 974=item B<modifier:> I<modifier>
940 975
941Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 976Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
942B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 977B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
… …
946 981
947Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 982Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
948character is passed through. It may contain escape values as described 983character is passed through. It may contain escape values as described
949in the entry on B<keysym> following. 984in the entry on B<keysym> following.
950 985
951=item B<secondaryScreen:> I<bool> 986=item B<secondaryScreen:> I<boolean>
952 987
953Turn on/off secondary screen (default enabled). 988Turn on/off secondary screen (default enabled).
954 989
955=item B<secondaryScroll:> I<bool> 990=item B<secondaryScroll:> I<boolean>
956 991
957Turn on/off secondary screen scroll (default enabled). If the this 992Turn on/off secondary screen scroll (default enabled). If the this
958option is enabled, scrolls on the secondary screen will change the 993option is enabled, scrolls on the secondary screen will change the
959scrollback buffer and switching to/from the secondary screen will 994scrollback buffer and switching to/from the secondary screen will
960instead scroll the screen up. 995instead scroll the screen up.
961 996
962=item B<hold>: I<bool> 997=item B<hold>: I<boolean>
963 998
964Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 999Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
965will not immediately destroy its window when the program executed within 1000will not immediately destroy its window when the program executed within
966it exits. Instead, it will wait till it is being killed or closed by the 1001it exits. Instead, it will wait till it is being killed or closed by the
967user. 1002user.
… …
992C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1027C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab,
993C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1028C<\000>: octal number) or verbatim control characters (C<^?>: delete,
994C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it 1029C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
995can start or end with whitespace. 1030can start or end with whitespace.
996 1031
997Please note that you need to double the C<\> when using 1032Please note that you need to double the C<\> in resource files, as
998C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can 1033Xlib itself does its own de-escaping (you can use C<\033> instead of
999use C<\033> instead of C<\e> (and so on), which will work with both Xt and 1034C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1000@@RXVT_NAME@@'s own processing). 1035processing).
1001 1036
1002You can define a range of keysyms in one shot by providing a I<string> 1037You can define a range of keysyms in one shot by providing a I<string>
1003with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1038with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
1004should be a character not used by the strings. 1039should be a character not used by the strings.
1005 1040
… …
1017is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1052is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1018example the following means "change the current locale to C<zh_CN.GBK> 1053example the following means "change the current locale to C<zh_CN.GBK>
1019when Control-Meta-c is being pressed": 1054when Control-Meta-c is being pressed":
1020 1055
1021 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1056 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1057
1058If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1059is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1060manpage. For example, the F<selection> extension (activated via
1061C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1062
1063 URxvt.keysym.M-C-c: perl:selection:rot13
1022 1064
1023Due the the large number of modifier combinations, a defined key mapping 1065Due the the large number of modifier combinations, a defined key mapping
1024will match if at I<at least> the specified identifiers are being set, and 1066will match if at I<at least> the specified identifiers are being set, and
1025no other key mappings with those and more bits are being defined. That 1067no other key mappings with those and more bits are being defined. That
1026means that defining a key map for C<a> will automatically provide 1068means that defining a key map for C<a> will automatically provide
… …
1050info): 1092info):
1051 1093
1052 URxvt.keysym.M-C-3: command:\033[8;25;80t 1094 URxvt.keysym.M-C-3: command:\033[8;25;80t
1053 URxvt.keysym.M-C-4: command:\033[8;48;110t 1095 URxvt.keysym.M-C-4: command:\033[8;48;110t
1054 1096
1097=item B<perl-ext-common>: I<string>
1098
1099=item B<perl-ext>: I<string>
1100
1101Comma-separated list(s) of perl extension scripts (default: C<default>) to
1102use in this terminal instance; option B<-pe>.
1103
1104Extension names can be prefixed with a C<-> sign to prohibit using
1105them. This can be useful to selectively disable some extensions loaded
1106by default, or specified via the C<perl-ext-common> resource. For
1107example, C<default,-selection> will use all the default extension except
1108C<selection>.
1109
1110Extension names can also be followed by an argument in angle brackets
1111(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1112searchable scorllback to Alt/Meta-s). Mentioning the same extension
1113multiple times with different arguments will pass multiple arguments to
1114the extension.
1115
1116Each extension is looked up in the library directories, loaded if
1117necessary, and bound to the current terminal instance.
1118
1119If both of these resources are the empty string, then the perl
1120interpreter will not be initialized. The idea behind two options is that
1121B<perl-ext-common> will be used for extensions that should be available to
1122all instances, while B<perl-ext> is used for specific instances.
1123
1124=item B<perl-eval>: I<string>
1125
1126Perl code to be evaluated when all extensions have been registered. See
1127the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1128will be ignored when running setuid/setgid.
1129
1130=item B<perl-lib>: I<path>
1131
1132Colon-separated list of additional directories that hold extension
1133scripts. When looking for extensions specified by the C<perl> resource,
1134@@RXVT_NAME@@ will first look in these directories and then in
1135F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1136will be ignored when running setuid/setgid.
1137
1138See the @@RXVT_NAME@@perl(3) manpage.
1139
1140=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1141
1142Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1143details.
1144
1145=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1146
1147Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1148for details.
1149
1150=item B<searchable-scrollback:> I<keysym>
1151
1152Sets the hotkey that starts the incremental scrollback buffer search
1153(default: C<M-s>).
1154
1155=item B<urlLauncher>: I<string>
1156
1157Specifies the program to be started with a URL argument. Used by the
1158C<selection-popup> and C<mark-urls> perl extensions.
1159
1160=item B<transient-for>: I<windowid>
1161
1162Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1163
1164=item B<override-redirect>: I<boolean>
1165
1166Compile I<frills>: Sets override-redirect for the terminal window, making
1167it almost invisible to window managers; option B<-override-redirect>.
1168
1055=back 1169=back
1056 1170
1057=head1 THE SCROLLBAR 1171=head1 THE SCROLLBAR
1058 1172
1059Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1173Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
… …
1100selection, and trailing whitespace is visually underlined and removed from 1214selection, and trailing whitespace is visually underlined and removed from
1101the selection. 1215the selection.
1102 1216
1103=item B<Insertion>: 1217=item B<Insertion>:
1104 1218
1105Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1219Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1106an B<@@RXVT_NAME@@> window causes the current text selection to be 1220window causes the value of the PRIMARY selection (or CLIPBOARD with the
1107inserted as if it had been typed on the keyboard. 1221Meta modifier) to be inserted as if it had been typed on the keyboard.
1222
1223Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1224inserted too.
1108 1225
1109=back 1226=back
1110 1227
1111=head1 CHANGING FONTS 1228=head1 CHANGING FONTS
1112 1229
1113Changing fonts (or font sizes, respectively) via the keypad is not yet 1230Changing fonts (or font sizes, respectively) via the keypad is not yet
1114supported in rxvt-unicode. Bug me if you need this. 1231supported in rxvt-unicode. Bug me if you need this.
1115 1232
1116You can, however, switch fonts at runtime using escape sequences (and 1233You can, however, switch fonts at runtime using escape sequences, e.g.:
1117therefore using the menubar), e.g.:
1118 1234
1119 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1235 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1236
1237You can use keyboard shortcuts, too:
1238
1239 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1240 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1120 1241
1121rxvt-unicode will automatically re-apply these fonts to the output so far. 1242rxvt-unicode will automatically re-apply these fonts to the output so far.
1122 1243
1123=head1 ISO 14755 SUPPORT 1244=head1 ISO 14755 SUPPORT
1124 1245
… …
1152This mode lets you input characters representing the keycap symbols of 1273This mode lets you input characters representing the keycap symbols of
1153your keyboard, if representable in the current locale encoding. 1274your keyboard, if representable in the current locale encoding.
1154 1275
1155Start by pressing C<Control> and C<Shift> together, then releasing 1276Start by pressing C<Control> and C<Shift> together, then releasing
1156them. The next special key (cursor keys, home etc.) you enter will not 1277them. The next special key (cursor keys, home etc.) you enter will not
1157invoke it's usual function but instead will insert the corresponding 1278invoke its usual function but instead will insert the corresponding
1158keycap symbol. The symbol will only be entered when the key has been 1279keycap symbol. The symbol will only be entered when the key has been
1159released, otherwise pressing e.g. C<Shift> would enter the symbol for 1280released, otherwise pressing e.g. C<Shift> would enter the symbol for
1160C<ISO Level 2 Switch>, although your intention might have been to enter a 1281C<ISO Level 2 Switch>, although your intention might have been to enter a
1161reverse tab (Shift-Tab). 1282reverse tab (Shift-Tab).
1162 1283
… …
1195=head1 COLORS AND GRAPHICS 1316=head1 COLORS AND GRAPHICS
1196 1317
1197In addition to the default foreground and background colours, 1318In addition to the default foreground and background colours,
1198B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1319B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1199high-intensity bold/blink versions of the same). Here is a list of the 1320high-intensity bold/blink versions of the same). Here is a list of the
1200colours with their B<rgb.txt> names. 1321colours with their names.
1201 1322
1202=begin table 1323=begin table
1203 1324
1204 B<color0> (black) = Black 1325 B<color0> (black) = Black
1205 B<color1> (red) = Red3 1326 B<color1> (red) = Red3
… …
1225It is also possible to specify the colour values of B<foreground>, 1346It is also possible to specify the colour values of B<foreground>,
1226B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1347B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1227a number 0-15, as a convenient shorthand to reference the colour name of 1348a number 0-15, as a convenient shorthand to reference the colour name of
1228color0-color15. 1349color0-color15.
1229 1350
1351In addition to the colours defined above, @@RXVT_NAME@@ offers an
1352additional 72 colours. The first 64 of those (with indices 16 to 79)
1353consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
135416>), followed by 8 additional shades of gray (with indices 80 to 87).
1355
1356Together, all those colours implement the 88 colour xterm colours. Only
1357the first 16 can be changed using resources currently, the rest can only
1358be changed via command sequences ("escape codes").
1359
1230Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1360Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1231always swapping the foreground/background colours. This is in contrast to 1361always swapping the foreground/background colours. This is in contrast to
1232I<xterm>(1) where the colours are only swapped if they have not otherwise 1362I<xterm>(1) where the colours are only swapped if they have not otherwise
1233been specified. For example, 1363been specified. For example,
1234 1364
… …
1238 1368
1239would yield White on Black, while on I<xterm>(1) it would yield Black 1369would yield White on Black, while on I<xterm>(1) it would yield Black
1240on White. 1370on White.
1241 1371
1242=back 1372=back
1373
1374=head2 ALPHA CHANNEL SUPPORT
1375
1376If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1377their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1378(recommended, but B<MUST> have 4 digits/component) colour specifications,
1379in addition to the ones provided by X, where the additional A component
1380specifies opacity (alpha) values. The minimum value of C<0> is completely
1381transparent). You can also prefix any color with C<[a]>, where C<a> is on
1382to four hex digits specifiying the opacity value.
1383
1384You probably need to specify B<"-depth 32">, too, and have the luck that
1385your X-server uses ARGB pixel layout, as X is far from just supporting
1386ARGB visuals out of the box, and rxvt-unicode just fudges around.
1387
1388For example, the following selects an almost completely transparent red
1389background, and an almost opaque pink foreground:
1390
1391 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink"
1392
1393I<Please note that transparency of any kind if completely unsupported by
1394the author. Don't bug him with installation questions!>
1243 1395
1244=head1 ENVIRONMENT 1396=head1 ENVIRONMENT
1245 1397
1246B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1398B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1247 1399
… …
1280C<--with-terminfo=PATH>. 1432C<--with-terminfo=PATH>.
1281 1433
1282=item B<DISPLAY> 1434=item B<DISPLAY>
1283 1435
1284Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1436Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1285display in it's child processes. 1437display in its child processes.
1286 1438
1287=item B<SHELL> 1439=item B<SHELL>
1288 1440
1289The shell to be used for command execution, defaults to C</bin/sh>. 1441The shell to be used for command execution, defaults to C</bin/sh>.
1290
1291=item B<RXVTPATH>
1292
1293The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1294files.
1295
1296=item B<PATH>
1297
1298Used in the same way as C<RXVTPATH>.
1299 1442
1300=item B<RXVT_SOCKET> 1443=item B<RXVT_SOCKET>
1301 1444
1302The unix domain socket path used by @@RXVT_NAME@@c(1) and 1445The unix domain socket path used by @@RXVT_NAME@@c(1) and
1303@@RXVT_NAME@@d(1). 1446@@RXVT_NAME@@d(1).
… …
1341 1484
1342=item Project Coordinator 1485=item Project Coordinator
1343 1486
1344Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1487Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1345 1488
1346L<http://software.schmorp.de/#rxvt-unicode> 1489L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1347 1490
1348=back 1491=back
1349 1492
1350=head1 AUTHORS 1493=head1 AUTHORS
1351 1494
… …
1373 1516
1374Project Coordinator (changes.txt 2.21a to 2.4.5) 1517Project Coordinator (changes.txt 2.21a to 2.4.5)
1375 1518
1376=item Geoff Wing L<< <gcw@pobox.com> >> 1519=item Geoff Wing L<< <gcw@pobox.com> >>
1377 1520
1378Rewrote screen display and text selection routines. Project Coordinator 1521Rewrote screen display and text selection routines.
1522
1379(changes.txt 2.4.6 - rxvt-unicode) 1523Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1380 1524
1381=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1525=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1382 1526
1383Forked rxvt-unicode, rewrote most of the display code and internal 1527Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1384character handling to store text in unicode, improve xterm 1528extension, random hacks, numerous bugfixes and extensions.
1385compatibility and apply numerous other bugfixes and extensions.
1386 1529
1387Project Coordinator (Changes 1.0 -) 1530Project Coordinator (Changes 1.0 -)
1388 1531
1532=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1533
1534Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1535
1389=back 1536=back
1390 1537

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines