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