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.74 by root, Thu Dec 22 16:44:10 2005 UTC vs.
Revision 1.114 by root, Thu Jul 6 19:43:21 2006 UTC

… …
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 less bugs 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
… …
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.
215
216=item B<-is>|B<+is>
217
218Compile I<font-styles>: Bold/Italic font styles imply high intensity
219foreground/background (default). See resource B<intensityStyles> for
220details.
206 221
207=item B<-name> I<name> 222=item B<-name> I<name>
208 223
209Specify the application name under which resources are to be obtained, 224Specify the application name under which resources are to be obtained,
210rather than the default executable file name. Name should not contain 225rather than the default executable file name. Name should not contain
… …
289=item B<-bl> 304=item B<-bl>
290 305
291Compile 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.
292if 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
293decorations; 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>.
294 321
295=item B<-lsp> I<number> 322=item B<-lsp> I<number>
296 323
297Compile I<frills>: Lines (pixel height) to insert between each row of 324Compile I<frills>: Lines (pixel height) to insert between each row of
298the display. Useful to work around font rendering problems; resource 325the display. Useful to work around font rendering problems; resource
… …
396 423
397Remap a key symbol. See resource B<keysym>. 424Remap a key symbol. See resource B<keysym>.
398 425
399=item B<-embed> I<windowid> 426=item B<-embed> I<windowid>
400 427
401Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 428Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
402which enables applications to easily embed a terminal. 429which enables applications to easily embed a terminal.
403 430
404Right 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
405shouldn'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
406quite 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
… …
421 $rxvt->signal_connect_after (realize => sub { 448 $rxvt->signal_connect_after (realize => sub {
422 my $xid = $_[0]->window->get_xid; 449 my $xid = $_[0]->window->get_xid;
423 system "@@RXVT_NAME@@ -embed $xid &"; 450 system "@@RXVT_NAME@@ -embed $xid &";
424 }); 451 });
425 452
426=item B<-pty-fd> I<fileno> 453=item B<-pty-fd> I<file descriptor>
427 454
428Tells @@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
429pair 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
430useful 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
431without having to run a program within it. 458without having to run a program within it.
432 459
433If 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
434entries 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
435yourself if you want that. 462yourself if you want that.
436 463
464As an extremely special case, specifying C<-1> will completely suppress
465pty/tty operations.
466
437Here 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
438longer example is in F<doc/pty-fd>): 468longer example is in F<doc/pty-fd>):
439 469
440 use IO::Pty; 470 use IO::Pty;
441 use Fcntl; 471 use Fcntl;
… …
447 477
448 # now communicate with rxvt 478 # now communicate with rxvt
449 my $slave = $pty->slave; 479 my $slave = $pty->slave;
450 while (<$slave>) { print $slave "got <$_>\n" } 480 while (<$slave>) { print $slave "got <$_>\n" }
451 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
452=back 487=back
453 488
454=head1 RESOURCES (available also as long-options) 489=head1 RESOURCES (available also as long-options)
455 490
456Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 491Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
457options) compiled into your version. 492options) compiled into your version.
458 493
459There 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
460Xresource data: using the X libraries (Xrm*-functions) or internal 495distribution do also load settings from the B<~/.Xresources> file when X
461Xresources reader (B<~/.Xdefaults>). For the first method (ie. 496starts. @@RXVT_NAME@@ will consult the following files/resources in order,
462B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 497with later settings overwriting earlier ones:
463resources using X11 tools like B<xrdb>. Many distribution do also load
464settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
465will consult the following files/resources in order, with later settings
466overwriting earlier ones:
467 498
468 1. system-wide app-defaults file, either locale-dependent OR global 499 1. system-wide app-defaults file, either locale-dependent OR global
469 2. app-defaults file in $XAPPLRESDIR 500 2. app-defaults file in $XAPPLRESDIR
470 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 501 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
471 4. SCREEN_RESOURCES for the current screen 502 4. SCREEN_RESOURCES for the current screen
472 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 503 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
473 504
474If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
475lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
476set in XAPPLOADDIR/URxvt (compile-time defined: usually
477B</usr/lib/X11/app-defaults/URxvt>) and resources set in
478B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
479Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 505Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
480class 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
481resources 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
482easily configured, while the class name B<URxvt> allows resources 508configured, while the class name B<URxvt> allows resources unique to
483unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 509B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
484shared between different B<@@RXVT_NAME@@> configurations. If no 510configurations. If no resources are specified, suitable defaults will
485resources are specified, suitable defaults will be used. Command-line 511be used. Command-line arguments can be used to override resource
486arguments can be used to override resource settings. The following 512settings. The following resources are supported (you might want to
487resources are allowed: 513check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
514extensions not documented here):
488 515
489=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>.
490 522
491=item B<geometry:> I<geom> 523=item B<geometry:> I<geom>
492 524
493Create the window with the specified X window geometry [default 80x24]; 525Create the window with the specified X window geometry [default 80x24];
494option B<-geometry>. 526option B<-geometry>.
… …
567=item B<inheritPixmap:> I<boolean> 599=item B<inheritPixmap:> I<boolean>
568 600
569B<True>: make the background inherit the parent windows' pixmap, giving 601B<True>: make the background inherit the parent windows' pixmap, giving
570artificial transparency. B<False>: do not inherit the parent windows' 602artificial transparency. B<False>: do not inherit the parent windows'
571pixmap. 603pixmap.
604
605I<Please note that transparency of any kind if completely unsupported by
606the author. Don't bug him with installation questions!>
572 607
573=item B<fading:> I<number> 608=item B<fading:> I<number>
574 609
575Fade 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>.
576 611
… …
613of 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
614specifies an integer number of images in that direction. No image will 649specifies an integer number of images in that direction. No image will
615be magnified beyond 10 times its original size. The maximum permitted 650be magnified beyond 10 times its original size. The maximum permitted
616scale is 1000. [default 0x0+50+50] 651scale is 1000. [default 0x0+50+50]
617 652
618=item B<menu:> I<file[;tag]>
619
620Read in the specified menu file (note the `.menu' extension is
621optional) and also optionally specify a starting tag to find. See the
622reference documentation for details on the syntax for the menuBar.
623
624=item B<path:> I<path> 653=item B<path:> I<path>
625 654
626Specify the colon-delimited search path for finding files (XPM and 655Specify the colon-delimited search path for finding XPM files.
627menus), in addition to the paths specified by the B<RXVTPATH> and
628B<PATH> environment variables.
629 656
630=item B<font:> I<fontlist> 657=item B<font:> I<fontlist>
631 658
632Select 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
633names that are used in turn when trying to display Unicode characters. 660that are checked in order when trying to find glyphs for characters. The
634The first font defines the cell size for characters; other fonts might 661first font defines the cell size for characters; other fonts might be
635be smaller, but not larger. A reasonable default font list is always 662smaller, but not (in general) larger. A (hopefully) reasonable default
636appended to it. option B<-fn>. 663font list is always appended to it; option B<-fn>.
637 664
638Each 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
639optional 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:>.
640 667
641In addition, each font can be prefixed with additional hints and 668In addition, each font can be prefixed with additional hints and
… …
643hint 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
644fonts. 671fonts.
645 672
646For example, this font resource 673For example, this font resource
647 674
648 URxvt*font: 9x15bold,\ 675 URxvt.font: 9x15bold,\
649 -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,\
650 -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, \
651 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 678 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
652 xft:Code2000:antialias=false 679 xft:Code2000:antialias=false
653 680
… …
687not possible, replacement fonts of the desired shape will be tried. 714not possible, replacement fonts of the desired shape will be tried.
688 715
689If set, but empty, then this specific style is disabled and the normal 716If set, but empty, then this specific style is disabled and the normal
690text font will being used for the given style. 717text font will being used for the given style.
691 718
719=item B<intensityStyles:> I<boolean>
720
721When font styles are not enabled, or this option is enabled (B<True>,
722option B<-is>, the default), bold and italic font styles imply high
723intensity foreground/backround colours. Disabling this option (B<False>,
724option B<+is>) disables this behaviour, the high intensity colours are not
725reachable.
726
692=item B<selectstyle:> I<mode> 727=item B<selectstyle:> I<mode>
693 728
694Set mouse selection style to B<old> which is 2.20, B<oldword> which is 729Set mouse selection style to B<old> which is 2.20, B<oldword> which is
695xterm style with 2.20 old word selection, or anything else which gives 730xterm style with 2.20 old word selection, or anything else which gives
696xterm style selection. 731xterm style selection.
… …
742 777
743The 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.
744 779
745Example: 780Example:
746 781
747 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 782 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
748 783
749This 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
750everytime you hit C<Print>. 785everytime you hit C<Print>.
751 786
752=item B<scrollBar:> I<boolean> 787=item B<scrollBar:> I<boolean>
… …
806=item B<borderLess:> I<boolean> 841=item B<borderLess:> I<boolean>
807 842
808Set 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
809WM, 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>.
810 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
811=item B<termName:> I<termname> 853=item B<termName:> I<termname>
812 854
813Specifies 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
814variable; option B<-tn>. 856variable; option B<-tn>.
815 857
… …
870pressed. If unset it will send the sequence traditionally associated 912pressed. If unset it will send the sequence traditionally associated
871with the B<Execute> key. 913with the B<Execute> key.
872 914
873=item B<cutchars:> I<string> 915=item B<cutchars:> I<string>
874 916
875The characters used as delimiters for double-click word selection. The 917The characters used as delimiters for double-click word selection
876built-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:
877 927
878B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 928B<< BACKSLASH `"'&()*,;<=>?@[]{|} >>
879 929
880=item B<preeditType:> I<style> 930=item B<preeditType:> I<style>
881 931
… …
888=item B<imLocale:> I<name> 938=item B<imLocale:> I<name>
889 939
890The 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.
891C<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
892input extension to be able to input japanese characters while staying in 942input extension to be able to input japanese characters while staying in
893another locale. option B<-imlocale>. 943another locale; option B<-imlocale>.
894 944
895=item B<imFont:> I<fontset> 945=item B<imFont:> I<fontset>
896 946
897Specify the font-set used for XIM styles C<OverTheSpot> or 947Specify the font-set used for XIM styles C<OverTheSpot> or
898C<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
… …
903 953
904=item B<tripleclickwords:> I<boolean> 954=item B<tripleclickwords:> I<boolean>
905 955
906Change the meaning of triple-click selection with the left mouse 956Change the meaning of triple-click selection with the left mouse
907button. 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
908the end of the logical line only. option B<-tcw>. 958the end of the logical line only; option B<-tcw>.
909 959
910=item B<insecure:> I<boolean> 960=item B<insecure:> I<boolean>
911 961
912Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 962Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
913echo 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
… …
917default. (Note that many other terminals, including xterm, have these 967default. (Note that many other terminals, including xterm, have these
918sequences enabled by default, which doesn't make it safer, though). 968sequences enabled by default, which doesn't make it safer, though).
919 969
920You can enable them by setting this boolean resource or specifying 970You can enable them by setting this boolean resource or specifying
921B<-insecure> as an option. At the moment, this enables display-answer, 971B<-insecure> as an option. At the moment, this enables display-answer,
922locale, findfont, icon label and window title requests as well as dynamic 972locale, findfont, icon label and window title requests.
923menubar dispatch.
924 973
925=item B<modifier:> I<modifier> 974=item B<modifier:> I<modifier>
926 975
927Set 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>,
928B<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
… …
932 981
933Specify 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)
934character is passed through. It may contain escape values as described 983character is passed through. It may contain escape values as described
935in the entry on B<keysym> following. 984in the entry on B<keysym> following.
936 985
937=item B<secondaryScreen:> I<bool> 986=item B<secondaryScreen:> I<boolean>
938 987
939Turn on/off secondary screen (default enabled). 988Turn on/off secondary screen (default enabled).
940 989
941=item B<secondaryScroll:> I<bool> 990=item B<secondaryScroll:> I<boolean>
942 991
943Turn on/off secondary screen scroll (default enabled). If the this 992Turn on/off secondary screen scroll (default enabled). If the this
944option is enabled, scrolls on the secondary screen will change the 993option is enabled, scrolls on the secondary screen will change the
945scrollback buffer and switching to/from the secondary screen will 994scrollback buffer and switching to/from the secondary screen will
946instead scroll the screen up. 995instead scroll the screen up.
947 996
948=item B<hold>: I<bool> 997=item B<hold>: I<boolean>
949 998
950Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 999Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
951will not immediately destroy its window when the program executed within 1000will not immediately destroy its window when the program executed within
952it 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
953user. 1002user.
… …
978C<\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,
979C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1028C<\000>: octal number) or verbatim control characters (C<^?>: delete,
980C<^@>: 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
981can start or end with whitespace. 1030can start or end with whitespace.
982 1031
983Please note that you need to double the C<\> when using 1032Please note that you need to double the C<\> in resource files, as
984C<--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
985use 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
986@@RXVT_NAME@@'s own processing). 1035processing).
987 1036
988You 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>
989with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1038with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/'
990should be a character not used by the strings. 1039should be a character not used by the strings.
991 1040
… …
1003is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1052is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1004example 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>
1005when Control-Meta-c is being pressed": 1054when Control-Meta-c is being pressed":
1006 1055
1007 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
1008 1064
1009Due the the large number of modifier combinations, a defined key mapping 1065Due the the large number of modifier combinations, a defined key mapping
1010will 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
1011no 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
1012means that defining a key map for C<a> will automatically provide 1068means that defining a key map for C<a> will automatically provide
… …
1036info): 1092info):
1037 1093
1038 URxvt.keysym.M-C-3: command:\033[8;25;80t 1094 URxvt.keysym.M-C-3: command:\033[8;25;80t
1039 URxvt.keysym.M-C-4: command:\033[8;48;110t 1095 URxvt.keysym.M-C-4: command:\033[8;48;110t
1040 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
1041=back 1169=back
1042 1170
1043=head1 THE SCROLLBAR 1171=head1 THE SCROLLBAR
1044 1172
1045Lines 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
… …
1079to select a word; Left triple-click to select the entire logical line 1207to select a word; Left triple-click to select the entire logical line
1080(which can span multiple screen lines), unless modified by resource 1208(which can span multiple screen lines), unless modified by resource
1081B<tripleclickwords>. 1209B<tripleclickwords>.
1082 1210
1083Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1211Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1084(Compile: I<frills>) will create a rectangular selection instead of a normal 1212(Compile: I<frills>) will create a rectangular selection instead of a
1085one. 1213normal one. In this mode, every selected row becomes its own line in the
1214selection, and trailing whitespace is visually underlined and removed from
1215the selection.
1086 1216
1087=item B<Insertion>: 1217=item B<Insertion>:
1088 1218
1089Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1219Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1090an B<@@RXVT_NAME@@> window causes the current text selection to be 1220window causes the value of the PRIMARY selection (or CLIPBOARD with the
1091inserted 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.
1092 1225
1093=back 1226=back
1094 1227
1095=head1 CHANGING FONTS 1228=head1 CHANGING FONTS
1096 1229
1097Changing fonts (or font sizes, respectively) via the keypad is not yet 1230Changing fonts (or font sizes, respectively) via the keypad is not yet
1098supported in rxvt-unicode. Bug me if you need this. 1231supported in rxvt-unicode. Bug me if you need this.
1099 1232
1100You can, however, switch fonts at runtime using escape sequences (and 1233You can, however, switch fonts at runtime using escape sequences, e.g.:
1101therefore using the menubar), e.g.:
1102 1234
1103 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
1104 1241
1105rxvt-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.
1106 1243
1107=head1 ISO 14755 SUPPORT 1244=head1 ISO 14755 SUPPORT
1108 1245
… …
1136This mode lets you input characters representing the keycap symbols of 1273This mode lets you input characters representing the keycap symbols of
1137your keyboard, if representable in the current locale encoding. 1274your keyboard, if representable in the current locale encoding.
1138 1275
1139Start by pressing C<Control> and C<Shift> together, then releasing 1276Start by pressing C<Control> and C<Shift> together, then releasing
1140them. 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
1141invoke it's usual function but instead will insert the corresponding 1278invoke its usual function but instead will insert the corresponding
1142keycap 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
1143released, otherwise pressing e.g. C<Shift> would enter the symbol for 1280released, otherwise pressing e.g. C<Shift> would enter the symbol for
1144C<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
1145reverse tab (Shift-Tab). 1282reverse tab (Shift-Tab).
1146 1283
… …
1179=head1 COLORS AND GRAPHICS 1316=head1 COLORS AND GRAPHICS
1180 1317
1181In addition to the default foreground and background colours, 1318In addition to the default foreground and background colours,
1182B<@@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
1183high-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
1184colours with their B<rgb.txt> names. 1321colours with their names.
1185 1322
1186=begin table 1323=begin table
1187 1324
1188 B<color0> (black) = Black 1325 B<color0> (black) = Black
1189 B<color1> (red) = Red3 1326 B<color1> (red) = Red3
… …
1209It is also possible to specify the colour values of B<foreground>, 1346It is also possible to specify the colour values of B<foreground>,
1210B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1347B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1211a 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
1212color0-color15. 1349color0-color15.
1213 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
1214Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1360Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1215always swapping the foreground/background colours. This is in contrast to 1361always swapping the foreground/background colours. This is in contrast to
1216I<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
1217been specified. For example, 1363been specified. For example,
1218 1364
… …
1222 1368
1223would 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
1224on White. 1370on White.
1225 1371
1226=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!>
1227 1395
1228=head1 ENVIRONMENT 1396=head1 ENVIRONMENT
1229 1397
1230B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1398B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1231 1399
… …
1264C<--with-terminfo=PATH>. 1432C<--with-terminfo=PATH>.
1265 1433
1266=item B<DISPLAY> 1434=item B<DISPLAY>
1267 1435
1268Used 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
1269display in it's child processes. 1437display in its child processes.
1270 1438
1271=item B<SHELL> 1439=item B<SHELL>
1272 1440
1273The 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>.
1274
1275=item B<RXVTPATH>
1276
1277The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1278files.
1279
1280=item B<PATH>
1281
1282Used in the same way as C<RXVTPATH>.
1283 1442
1284=item B<RXVT_SOCKET> 1443=item B<RXVT_SOCKET>
1285 1444
1286The unix domain socket path used by @@RXVT_NAME@@c(1) and 1445The unix domain socket path used by @@RXVT_NAME@@c(1) and
1287@@RXVT_NAME@@d(1). 1446@@RXVT_NAME@@d(1).
… …
1325 1484
1326=item Project Coordinator 1485=item Project Coordinator
1327 1486
1328Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1487Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1329 1488
1330L<http://software.schmorp.de/#rxvt-unicode> 1489L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1331 1490
1332=back 1491=back
1333 1492
1334=head1 AUTHORS 1493=head1 AUTHORS
1335 1494
… …
1357 1516
1358Project Coordinator (changes.txt 2.21a to 2.4.5) 1517Project Coordinator (changes.txt 2.21a to 2.4.5)
1359 1518
1360=item Geoff Wing L<< <gcw@pobox.com> >> 1519=item Geoff Wing L<< <gcw@pobox.com> >>
1361 1520
1362Rewrote screen display and text selection routines. Project Coordinator 1521Rewrote screen display and text selection routines.
1522
1363(changes.txt 2.4.6 - rxvt-unicode) 1523Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1364 1524
1365=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1525=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1366 1526
1367Forked rxvt-unicode, rewrote most of the display code and internal 1527Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1368character handling to store text in unicode, improve xterm 1528extension, random hacks, numerous bugfixes and extensions.
1369compatibility and apply numerous other bugfixes and extensions.
1370 1529
1371Project Coordinator (Changes 1.0 -) 1530Project Coordinator (Changes 1.0 -)
1372 1531
1532=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1533
1534Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1535
1373=back 1536=back
1374 1537

Diff Legend

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