… | |
… | |
17 | =head1 FREQUENTLY ASKED QUESTIONS |
17 | =head1 FREQUENTLY ASKED QUESTIONS |
18 | |
18 | |
19 | See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of |
19 | See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of |
20 | frequently asked questions and answer to them and some common |
20 | frequently asked questions and answer to them and some common |
21 | problems. That document is also accessible on the World-Wide-Web at |
21 | problems. That document is also accessible on the World-Wide-Web at |
22 | L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. |
22 | L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>. |
23 | |
23 | |
24 | =head1 RXVT-UNICODE VS. RXVT |
24 | =head1 RXVT-UNICODE VS. RXVT |
25 | |
25 | |
26 | Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode |
26 | Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode |
27 | internally. That means it can store and display most scripts in the |
27 | internally. That means it can store and display most scripts in the |
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 devanagari. 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 | |
39 | If you are looking for a terminal that supports more exotic scripts, let |
39 | If you are looking for a terminal that supports more exotic scripts, let |
40 | me recommend C<mlterm>, which is a very userfriendly, lean and clean |
40 | me recommend C<mlterm>, which is a very user friendly, lean and clean |
41 | terminal emulator. In fact, the reason rxvt-unicode was born was solely |
41 | terminal emulator. In fact, the reason rxvt-unicode was born was solely |
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> |
103 | |
108 | |
104 | Turn on/off simulated reverse video; resource B<reverseVideo>. |
109 | Turn on/off simulated reverse video; resource B<reverseVideo>. |
105 | |
110 | |
106 | =item B<-j>|B<+j> |
111 | =item B<-j>|B<+j> |
107 | |
112 | |
108 | Turn on/off jump scrolling; resource B<jumpScroll>. |
113 | Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. |
|
|
114 | |
|
|
115 | =item B<-ss>|B<+ss> |
|
|
116 | |
|
|
117 | Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. |
109 | |
118 | |
110 | =item B<-ip>|B<+ip> | B<-tr>|B<+tr> |
119 | =item B<-ip>|B<+ip> | B<-tr>|B<+tr> |
111 | |
120 | |
112 | Turn on/off inheriting parent window's pixmap. Alternative form is |
121 | Turn on/off inheriting parent window's pixmap. Alternative form is |
113 | B<-tr>; resource B<inheritPixmap>. |
122 | B<-tr>; resource B<inheritPixmap>. |
|
|
123 | |
|
|
124 | I<Please note that transparency of any kind if completely unsupported by |
|
|
125 | the author. Don't bug him with installation questions! Read the FAQ (man 7 |
|
|
126 | @@RXVT_NAME@@)!> |
114 | |
127 | |
115 | =item B<-fade> I<number> |
128 | =item B<-fade> I<number> |
116 | |
129 | |
117 | Fade the text by the given percentage when focus is lost. Small values |
130 | 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 |
131 | fade a little only, 100 completely replaces all colours by the fade |
119 | colour; resource B<fading>. |
132 | colour; resource B<fading>. |
120 | |
133 | |
121 | =item B<-fadecolor> I<colour> |
134 | =item B<-fadecolor> I<colour> |
122 | |
135 | |
123 | Fade to this colour when fading is used (see B<-fade>). The default colour |
136 | Fade to this colour when fading is used (see B<-fade>). The default colour |
124 | is black. resource B<fadeColor>. |
137 | is opaque black. resource B<fadeColor>. |
125 | |
138 | |
126 | =item B<-tint> I<colour> |
139 | =item B<-tint> I<colour> |
127 | |
140 | |
128 | Tint the transparent background pixmap with the given colour when |
141 | Tint the transparent background pixmap with the given colour when |
129 | transparency is enabled with B<-tr> or B<-ip>. This only works for |
142 | transparency is enabled with B<-tr> or B<-ip>. This only works for |
130 | non-tiled backgrounds, currently. See also the B<-sh> option that can be |
143 | non-tiled backgrounds, currently. See also the B<-sh> option that can be |
131 | used to brighten or darken the image in addition to tinting it; resource |
144 | used to brighten or darken the image in addition to tinting it. |
|
|
145 | Please note that certain tint colours can be applied on the server-side, |
|
|
146 | thus yielding performance gain of two orders of magnitude. These colours are: |
|
|
147 | blue, red, green, cyan, magenta, yellow, and those close to them; resource |
132 | I<tintColor>. Example: |
148 | I<tintColor>. Example: |
133 | |
149 | |
134 | @@RXVT_NAME@@ -tr -tint blue -sh 40 |
150 | @@RXVT_NAME@@ -tr -tint blue -sh 40 |
135 | |
151 | |
136 | =item B<-sh> |
152 | =item B<-sh> I<number> |
137 | |
153 | |
138 | I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
154 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
139 | background image in addition to tinting it (i.e. B<-tint> must be |
155 | background image in addition to (or instead of) tinting it; |
140 | specified, too, e.g. C<-tint white>). |
156 | resource I<shading>. |
|
|
157 | |
|
|
158 | =item B<-blt> I<string> |
|
|
159 | |
|
|
160 | Specify background blending type. If background pixmap is specified |
|
|
161 | at the same time as transparency - such pixmap will be blended over |
|
|
162 | transparency image, using method specified. Supported values are : |
|
|
163 | B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, |
|
|
164 | B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, |
|
|
165 | B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is |
|
|
166 | alpha-blending; resource I<blendType>. |
|
|
167 | |
|
|
168 | =item B<-blr> I<HxV> |
|
|
169 | |
|
|
170 | Apply Gaussian Blur with the specified radii to the transparent |
|
|
171 | background image. If single number is specified - both vertical and |
|
|
172 | horizontal radii are considered to be the same. Setting one of the |
|
|
173 | radii to 1 and another to a large number creates interesting effects |
|
|
174 | on some backgrounds. Maximum radius value is 128; resource I<blurRadius>. |
141 | |
175 | |
142 | =item B<-bg> I<colour> |
176 | =item B<-bg> I<colour> |
143 | |
177 | |
144 | Window background colour; resource B<background>. |
178 | Window background colour; resource B<background>. |
145 | |
179 | |
… | |
… | |
147 | |
181 | |
148 | Window foreground colour; resource B<foreground>. |
182 | Window foreground colour; resource B<foreground>. |
149 | |
183 | |
150 | =item B<-pixmap> I<file[;geom]> |
184 | =item B<-pixmap> I<file[;geom]> |
151 | |
185 | |
152 | Compile I<XPM>: Specify XPM file for the background and also optionally |
186 | Compile I<afterimage>: Specify image file for the background and also |
153 | specify its scaling with a geometry string. Note you may need to |
187 | optionally specify its scaling with a geometry string. Note you may need to |
154 | add quotes to avoid special shell interpretation of the C<;> in the |
188 | add quotes to avoid special shell interpretation of the C<;> in the |
155 | command-line; resource B<backgroundPixmap>. |
189 | command-line; for more details see resource B<backgroundPixmap>. |
156 | |
190 | |
157 | =item B<-cr> I<colour> |
191 | =item B<-cr> I<colour> |
158 | |
192 | |
159 | The cursor colour; resource B<cursorColor>. |
193 | The cursor colour; resource B<cursorColor>. |
160 | |
194 | |
… | |
… | |
172 | resource B<borderColor>. |
206 | resource B<borderColor>. |
173 | |
207 | |
174 | =item B<-fn> I<fontlist> |
208 | =item B<-fn> I<fontlist> |
175 | |
209 | |
176 | Select the fonts to be used. This is a comma separated list of font names |
210 | 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 |
211 | 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 |
212 | first font defines the cell size for characters; other fonts might be |
179 | smaller, but not (in general) larger. A (hopefully) reasonable default |
213 | 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. |
214 | font list is always appended to it. See resource B<font> for more details. |
181 | |
215 | |
182 | In short, to specify an X11 core font, just specify it's name or prefix it |
216 | 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:>, |
217 | with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, |
184 | e.g.: |
218 | e.g.: |
185 | |
219 | |
186 | @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
220 | @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
187 | @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
221 | @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
… | |
… | |
296 | =item B<-bl> |
330 | =item B<-bl> |
297 | |
331 | |
298 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
332 | 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 |
333 | if honoured by the WM, the rxvt-unicode window will not have window |
300 | decorations; resource B<borderLess>. |
334 | decorations; resource B<borderLess>. |
|
|
335 | |
|
|
336 | =item B<-override-redirect> |
|
|
337 | |
|
|
338 | Compile I<frills>: Sets override-redirect on the window; resource |
|
|
339 | B<override-redirect>. |
301 | |
340 | |
302 | =item B<-sbg> |
341 | =item B<-sbg> |
303 | |
342 | |
304 | Compile I<frills>: Disable the usage of the built-in block graphics/line |
343 | 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 |
344 | drawing characters and just rely on what the specified fonts provide. Use |
… | |
… | |
372 | for more info. |
411 | for more info. |
373 | |
412 | |
374 | =item B<-tcw> |
413 | =item B<-tcw> |
375 | |
414 | |
376 | Change the meaning of triple-click selection with the left mouse |
415 | Change the meaning of triple-click selection with the left mouse |
|
|
416 | button. Only effective when the original (non-perl) selection code is |
377 | button. Instead of selecting a full line it will extend the selection the |
417 | in-use. Instead of selecting a full line it will extend the selection the |
378 | end of the logical line only. resource B<tripleclickwords>. |
418 | end of the logical line only. resource B<tripleclickwords>. |
379 | |
419 | |
380 | =item B<-insecure> |
420 | =item B<-insecure> |
381 | |
421 | |
382 | Enable "insecure" mode, which currently enables most of the escape |
422 | Enable "insecure" mode, which currently enables most of the escape |
… | |
… | |
410 | |
450 | |
411 | Remap a key symbol. See resource B<keysym>. |
451 | Remap a key symbol. See resource B<keysym>. |
412 | |
452 | |
413 | =item B<-embed> I<windowid> |
453 | =item B<-embed> I<windowid> |
414 | |
454 | |
415 | Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, |
455 | Tells @@RXVT_NAME@@ to embed its windows into an already-existing window, |
416 | which enables applications to easily embed a terminal. |
456 | which enables applications to easily embed a terminal. |
417 | |
457 | |
418 | Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it |
458 | 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 |
459 | 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 |
460 | quite a bit, so don't expect it to keep some specific state. It's best to |
… | |
… | |
423 | The window will not be destroyed when @@RXVT_NAME@@ exits. |
463 | The window will not be destroyed when @@RXVT_NAME@@ exits. |
424 | |
464 | |
425 | It might be useful to know that @@RXVT_NAME@@ will not close file |
465 | It might be useful to know that @@RXVT_NAME@@ will not close file |
426 | descriptors passed to it (except for stdin/out/err, of course), so you |
466 | descriptors passed to it (except for stdin/out/err, of course), so you |
427 | can use file descriptors to communicate with the programs within the |
467 | can use file descriptors to communicate with the programs within the |
428 | terminal. This works regardless of wether the C<-embed> option was used or |
468 | terminal. This works regardless of whether the C<-embed> option was used or |
429 | not. |
469 | not. |
430 | |
470 | |
431 | Here is a short Gtk2-perl snippet that illustrates how this option can be |
471 | Here is a short Gtk2-perl snippet that illustrates how this option can be |
432 | used (a longer example is in F<doc/embed>): |
472 | used (a longer example is in F<doc/embed>): |
433 | |
473 | |
… | |
… | |
435 | $rxvt->signal_connect_after (realize => sub { |
475 | $rxvt->signal_connect_after (realize => sub { |
436 | my $xid = $_[0]->window->get_xid; |
476 | my $xid = $_[0]->window->get_xid; |
437 | system "@@RXVT_NAME@@ -embed $xid &"; |
477 | system "@@RXVT_NAME@@ -embed $xid &"; |
438 | }); |
478 | }); |
439 | |
479 | |
440 | =item B<-pty-fd> I<fileno> |
480 | =item B<-pty-fd> I<file descriptor> |
441 | |
481 | |
442 | Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty |
482 | 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 |
483 | pair but instead use the given file descriptor as the tty master. This is |
444 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
484 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
445 | without having to run a program within it. |
485 | without having to run a program within it. |
446 | |
486 | |
447 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
487 | 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 |
488 | entries and will not tinker with pty/tty permissions - you have to do that |
449 | yourself if you want that. |
489 | yourself if you want that. |
|
|
490 | |
|
|
491 | As an extremely special case, specifying C<-1> will completely suppress |
|
|
492 | pty/tty operations. |
450 | |
493 | |
451 | Here is a example in perl that illustrates how this option can be used (a |
494 | Here is a example in perl that illustrates how this option can be used (a |
452 | longer example is in F<doc/pty-fd>): |
495 | longer example is in F<doc/pty-fd>): |
453 | |
496 | |
454 | use IO::Pty; |
497 | use IO::Pty; |
… | |
… | |
463 | my $slave = $pty->slave; |
506 | my $slave = $pty->slave; |
464 | while (<$slave>) { print $slave "got <$_>\n" } |
507 | while (<$slave>) { print $slave "got <$_>\n" } |
465 | |
508 | |
466 | =item B<-pe> I<string> |
509 | =item B<-pe> I<string> |
467 | |
510 | |
468 | Colon-separated list of perl extension scripts to use in this terminal |
511 | Comma-separated list of perl extension scripts to use (or not to use) in |
469 | instance. See resource B<perl-ext>. |
512 | this terminal instance. See resource B<perl-ext> for details. |
470 | |
513 | |
471 | =back |
514 | =back |
472 | |
515 | |
473 | =head1 RESOURCES (available also as long-options) |
516 | =head1 RESOURCES (available also as long-options) |
474 | |
517 | |
475 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
518 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
476 | options) compiled into your version. |
519 | options) compiled into your version. |
477 | |
520 | |
478 | There are two different methods that @@RXVT_NAME@@ can use to get the |
521 | 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 |
522 | distribution do also load settings from the B<~/.Xresources> file when X |
480 | Xresources reader (B<~/.Xdefaults>). For the first method (ie. |
523 | 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 |
524 | 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 | |
525 | |
487 | 1. system-wide app-defaults file, either locale-dependent OR global |
526 | 1. system-wide app-defaults file, either locale-dependent OR global |
488 | 2. app-defaults file in $XAPPLRESDIR |
527 | 2. app-defaults file in $XAPPLRESDIR |
489 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
528 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
490 | 4. SCREEN_RESOURCES for the current screen |
529 | 4. SCREEN_RESOURCES for the current screen |
491 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
530 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
492 | |
531 | |
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 |
532 | 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 |
533 | 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 |
534 | 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 |
535 | configured, while the class name B<URxvt> allows resources unique to |
502 | unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be |
536 | B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@> |
503 | shared between different B<@@RXVT_NAME@@> configurations. If no |
537 | configurations. If no resources are specified, suitable defaults will |
504 | resources are specified, suitable defaults will be used. Command-line |
538 | be used. Command-line arguments can be used to override resource |
505 | arguments can be used to override resource settings. The following |
539 | settings. The following resources are supported (you might want to |
506 | resources are allowed: |
540 | check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl |
|
|
541 | extensions not documented here): |
507 | |
542 | |
508 | =over 4 |
543 | =over 4 |
|
|
544 | |
|
|
545 | =item B<depth:> I<bitdepth> |
|
|
546 | |
|
|
547 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
|
|
548 | option B<-depth>. |
509 | |
549 | |
510 | =item B<geometry:> I<geom> |
550 | =item B<geometry:> I<geom> |
511 | |
551 | |
512 | Create the window with the specified X window geometry [default 80x24]; |
552 | Create the window with the specified X window geometry [default 80x24]; |
513 | option B<-geometry>. |
553 | option B<-geometry>. |
… | |
… | |
550 | Use the specified colour to display underlined characters when the |
590 | Use the specified colour to display underlined characters when the |
551 | foreground colour is the default. |
591 | foreground colour is the default. |
552 | |
592 | |
553 | =item B<colorRV:> I<colour> |
593 | =item B<colorRV:> I<colour> |
554 | |
594 | |
555 | Use the specified colour as the background for reverse video |
595 | Use the specified colour as the background for reverse video characters |
556 | characters. |
596 | when OPTION_HC is disabled (--disable-frills). |
557 | |
597 | |
558 | =item B<underlineColor:> I<colour> |
598 | =item B<underlineColor:> I<colour> |
559 | |
599 | |
560 | If set, use the specified colour as the colour for the underline |
600 | If set, use the specified colour as the colour for the underline |
561 | itself. If unset, use the foreground colour. |
601 | itself. If unset, use the foreground colour. |
… | |
… | |
577 | option B<-rv>. B<False>: regular screen colours [default]; option |
617 | option B<-rv>. B<False>: regular screen colours [default]; option |
578 | B<+rv>. See note in B<COLORS AND GRAPHICS> section. |
618 | B<+rv>. See note in B<COLORS AND GRAPHICS> section. |
579 | |
619 | |
580 | =item B<jumpScroll:> I<boolean> |
620 | =item B<jumpScroll:> I<boolean> |
581 | |
621 | |
582 | B<True>: specify that jump scrolling should be used. When scrolling |
622 | B<True>: specify that jump scrolling should be used. When receiving lots |
583 | quickly, fewer screen updates are performed [default]; option B<-j>. |
623 | of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines |
|
|
624 | has been read, resulting in fewer updates while still displaying every |
|
|
625 | received line; option B<-j>. |
|
|
626 | |
584 | B<False>: specify that smooth scrolling should be used; option B<+j>. |
627 | B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will |
|
|
628 | force a screen refresh on each new line it received; option B<+j>. |
|
|
629 | |
|
|
630 | =item B<skipScroll:> I<boolean> |
|
|
631 | |
|
|
632 | B<True>: (the default) specify that skip scrolling should be used. When |
|
|
633 | receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while |
|
|
634 | (around 60 times per second), resulting in far fewer updates. This can |
|
|
635 | result in @@RXVT_NAME@@ not ever displaying some of the lines it receives; |
|
|
636 | option B<-ss>. |
|
|
637 | |
|
|
638 | B<False>: specify that everything is to be displayed, even |
|
|
639 | if the refresh is too fast for the human eye to read anything (or the |
|
|
640 | monitor to display anything); option B<+ss>. |
585 | |
641 | |
586 | =item B<inheritPixmap:> I<boolean> |
642 | =item B<inheritPixmap:> I<boolean> |
587 | |
643 | |
588 | B<True>: make the background inherit the parent windows' pixmap, giving |
644 | B<True>: make the background inherit the parent windows' pixmap, giving |
589 | artificial transparency. B<False>: do not inherit the parent windows' |
645 | artificial transparency. B<False>: do not inherit the parent windows' |
590 | pixmap. |
646 | pixmap. |
591 | |
647 | |
|
|
648 | I<Please note that transparency of any kind if completely unsupported by |
|
|
649 | the author. Don't bug him with installation questions!> |
|
|
650 | |
592 | =item B<fading:> I<number> |
651 | =item B<fading:> I<number> |
593 | |
652 | |
594 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
653 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
595 | |
654 | |
596 | =item B<fadeColor:> I<colour> |
655 | =item B<fadeColor:> I<colour> |
… | |
… | |
603 | Tint the transparent background pixmap with the given colour; option |
662 | Tint the transparent background pixmap with the given colour; option |
604 | B<-tint>. |
663 | B<-tint>. |
605 | |
664 | |
606 | =item B<shading:> I<number> |
665 | =item B<shading:> I<number> |
607 | |
666 | |
608 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
667 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image |
609 | image in addition to tinting it. |
668 | in addition to tinting it; option B<-sh>. |
|
|
669 | |
|
|
670 | =item B<blendType:> I<string> |
|
|
671 | |
|
|
672 | Specify background blending type; option B<-blt>. |
|
|
673 | |
|
|
674 | =item B<blurRadius:> I<number> |
|
|
675 | |
|
|
676 | Apply Gaussian Blurr with the specified radius to the transparent |
|
|
677 | background image; option B<-blr>. |
610 | |
678 | |
611 | =item B<scrollColor:> I<colour> |
679 | =item B<scrollColor:> I<colour> |
612 | |
680 | |
613 | Use the specified colour for the scrollbar [default #B2B2B2]. |
681 | Use the specified colour for the scrollbar [default #B2B2B2]. |
614 | |
682 | |
… | |
… | |
622 | The colour of the border around the text area and between the scrollbar |
690 | The colour of the border around the text area and between the scrollbar |
623 | and the text. |
691 | and the text. |
624 | |
692 | |
625 | =item B<backgroundPixmap:> I<file[;geom]> |
693 | =item B<backgroundPixmap:> I<file[;geom]> |
626 | |
694 | |
627 | Use the specified XPM file (note the `.xpm' extension is optional) for |
695 | Use the specified image file for the background and also optionally |
628 | the background and also optionally specify its scaling with a geometry |
696 | specify its scaling with a geometry string B<WxH+X+Y>, |
629 | string B<WxH+X+Y>, in which B<"W" / "H"> specify the |
697 | in which B<"W" / "H"> specify the horizontal/vertical scale (percent), |
630 | horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image |
698 | and B<"X" / "Y"> locate the image centre (percent). |
631 | centre (percent). A scale of 0 displays the image with tiling. A scale |
699 | A scale of 0 displays the image with tiling. A scale of 1 displays the |
632 | of 1 displays the image without any scaling. A scale of 2 to 9 |
700 | image without any scaling. A scale of 2 to 9 specifies an integer |
633 | specifies an integer number of images in that direction. No image will |
701 | number of images in that direction. No image will be magnified beyond |
634 | be magnified beyond 10 times its original size. The maximum permitted |
702 | 10 times its original size. The maximum permitted scale is 1000. |
635 | scale is 1000. [default 0x0+50+50] |
703 | Special string of B<"auto"> used as a geometry will cause image to be |
636 | |
704 | automatically scaled to match window size. |
637 | =item B<menu:> I<file[;tag]> |
705 | If used in conjunction with B<-tr> option - specified pixmap will be |
638 | |
706 | blended over transparency image using either alpha-blending, or any |
639 | Read in the specified menu file (note the `.menu' extension is |
707 | other blending type, specified with B<-blt "type"> option. |
640 | optional) and also optionally specify a starting tag to find. See the |
708 | [default 0x0+50+50] |
641 | reference documentation for details on the syntax for the menuBar. |
|
|
642 | |
709 | |
643 | =item B<path:> I<path> |
710 | =item B<path:> I<path> |
644 | |
711 | |
645 | Specify the colon-delimited search path for finding files (XPM and |
712 | 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 | |
713 | |
649 | =item B<font:> I<fontlist> |
714 | =item B<font:> I<fontlist> |
650 | |
715 | |
651 | Select the fonts to be used. This is a comma separated list of font |
716 | 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. |
717 | 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 |
718 | 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 |
719 | smaller, but not (in general) larger. A (hopefully) reasonable default |
655 | appended to it; option B<-fn>. |
720 | font list is always appended to it; option B<-fn>. |
656 | |
721 | |
657 | Each font can either be a standard X11 core font (XLFD) name, with |
722 | 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:>. |
723 | optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. |
659 | |
724 | |
660 | In addition, each font can be prefixed with additional hints and |
725 | 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 |
727 | hint currently is C<codeset=codeset-name>, and this is only used for Xft |
663 | fonts. |
728 | fonts. |
664 | |
729 | |
665 | For example, this font resource |
730 | For example, this font resource |
666 | |
731 | |
667 | URxvt*font: 9x15bold,\ |
732 | URxvt.font: 9x15bold,\ |
668 | -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ |
733 | -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, \ |
734 | -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ |
670 | [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ |
735 | [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ |
671 | xft:Code2000:antialias=false |
736 | xft:Code2000:antialias=false |
672 | |
737 | |
… | |
… | |
710 | |
775 | |
711 | =item B<intensityStyles:> I<boolean> |
776 | =item B<intensityStyles:> I<boolean> |
712 | |
777 | |
713 | When font styles are not enabled, or this option is enabled (B<True>, |
778 | When font styles are not enabled, or this option is enabled (B<True>, |
714 | option B<-is>, the default), bold and italic font styles imply high |
779 | option B<-is>, the default), bold and italic font styles imply high |
715 | intensity foreground/backround colours. Disabling this option (B<False>, |
780 | intensity foreground/background colours. Disabling this option (B<False>, |
716 | option B<+is>) disables this behaviour, the high intensity colours are not |
781 | option B<+is>) disables this behaviour, the high intensity colours are not |
717 | reachable. |
782 | reachable. |
718 | |
783 | |
719 | =item B<selectstyle:> I<mode> |
784 | =item B<selectstyle:> I<mode> |
720 | |
785 | |
721 | Set mouse selection style to B<old> which is 2.20, B<oldword> which is |
786 | Set mouse selection style to B<old> which is 2.20, B<oldword> which |
722 | xterm style with 2.20 old word selection, or anything else which gives |
787 | is xterm style with 2.20 old word selection, or anything else which |
723 | xterm style selection. |
788 | gives xterm style selection. Only effective when the original (non-perl) |
|
|
789 | selection code is in use. |
724 | |
790 | |
725 | =item B<scrollstyle:> I<mode> |
791 | =item B<scrollstyle:> I<mode> |
726 | |
792 | |
727 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
793 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
728 | the author's favourite. |
794 | the author's favourite. |
… | |
… | |
742 | =item B<mapAlert:> I<boolean> |
808 | =item B<mapAlert:> I<boolean> |
743 | |
809 | |
744 | B<True>: de-iconify (map) on receipt of a bell character. B<False>: no |
810 | B<True>: de-iconify (map) on receipt of a bell character. B<False>: no |
745 | de-iconify (map) on receipt of a bell character [default]. |
811 | de-iconify (map) on receipt of a bell character [default]. |
746 | |
812 | |
|
|
813 | =item B<urgentOnBell:> I<boolean> |
|
|
814 | |
|
|
815 | B<True>: set the urgency hint for the wm on receipt of a bell character. |
|
|
816 | B<False>: do not set the urgency hint [default]. |
|
|
817 | |
747 | =item B<visualBell:> I<boolean> |
818 | =item B<visualBell:> I<boolean> |
748 | |
819 | |
749 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
820 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
750 | B<False>: no visual bell [default]; option B<+vb>. |
821 | B<False>: no visual bell [default]; option B<+vb>. |
751 | |
822 | |
… | |
… | |
769 | |
840 | |
770 | The string will be interpreted as if typed into the shell as-is. |
841 | The string will be interpreted as if typed into the shell as-is. |
771 | |
842 | |
772 | Example: |
843 | Example: |
773 | |
844 | |
774 | URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
845 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
775 | |
846 | |
776 | This creates a new file in your home directory with the screen contents |
847 | This creates a new file in your home directory with the screen contents |
777 | everytime you hit C<Print>. |
848 | every time you hit C<Print>. |
778 | |
849 | |
779 | =item B<scrollBar:> I<boolean> |
850 | =item B<scrollBar:> I<boolean> |
780 | |
851 | |
781 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
852 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
782 | disable the scrollbar; option B<+sb>. |
853 | disable the scrollbar; option B<+sb>. |
… | |
… | |
804 | |
875 | |
805 | =item B<scrollWithBuffer:> I<boolean> |
876 | =item B<scrollWithBuffer:> I<boolean> |
806 | |
877 | |
807 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
878 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
808 | B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll |
879 | B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll |
809 | with scrollback buffer when tty recieves new lines; option B<+sw>. |
880 | with scrollback buffer when tty receives new lines; option B<+sw>. |
810 | |
881 | |
811 | =item B<scrollTtyKeypress:> I<boolean> |
882 | =item B<scrollTtyKeypress:> I<boolean> |
812 | |
883 | |
813 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
884 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
814 | are those which are intercepted by rxvt-unicode for special handling and |
885 | are those which are intercepted by rxvt-unicode for special handling and |
… | |
… | |
904 | pressed. If unset it will send the sequence traditionally associated |
975 | pressed. If unset it will send the sequence traditionally associated |
905 | with the B<Execute> key. |
976 | with the B<Execute> key. |
906 | |
977 | |
907 | =item B<cutchars:> I<string> |
978 | =item B<cutchars:> I<string> |
908 | |
979 | |
909 | The characters used as delimiters for double-click word selection. The |
980 | The characters used as delimiters for double-click word selection |
910 | built-in default: |
981 | (whitespace delimiting is added automatically if resource is given). |
|
|
982 | |
|
|
983 | When the perl selection extension is in use (the default if compiled |
|
|
984 | in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these |
|
|
985 | characters will be created (if the resource exists, otherwise, no regex |
|
|
986 | will be created). In this mode, characters outside ISO-8859-1 can be used. |
|
|
987 | |
|
|
988 | When the selection extension is not used, only ISO-8859-1 characters can |
|
|
989 | be used. If not specified, the built-in default is used: |
911 | |
990 | |
912 | B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> |
991 | B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> |
913 | |
992 | |
914 | =item B<preeditType:> I<style> |
993 | =item B<preeditType:> I<style> |
915 | |
994 | |
… | |
… | |
951 | default. (Note that many other terminals, including xterm, have these |
1030 | default. (Note that many other terminals, including xterm, have these |
952 | sequences enabled by default, which doesn't make it safer, though). |
1031 | sequences enabled by default, which doesn't make it safer, though). |
953 | |
1032 | |
954 | You can enable them by setting this boolean resource or specifying |
1033 | You can enable them by setting this boolean resource or specifying |
955 | B<-insecure> as an option. At the moment, this enables display-answer, |
1034 | 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 |
1035 | locale, findfont, icon label and window title requests. |
957 | menubar dispatch. |
|
|
958 | |
1036 | |
959 | =item B<modifier:> I<modifier> |
1037 | =item B<modifier:> I<modifier> |
960 | |
1038 | |
961 | Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, |
1039 | 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 |
1040 | B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option |
… | |
… | |
966 | |
1044 | |
967 | Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) |
1045 | 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 |
1046 | character is passed through. It may contain escape values as described |
969 | in the entry on B<keysym> following. |
1047 | in the entry on B<keysym> following. |
970 | |
1048 | |
971 | =item B<secondaryScreen:> I<bool> |
1049 | =item B<secondaryScreen:> I<boolean> |
972 | |
1050 | |
973 | Turn on/off secondary screen (default enabled). |
1051 | Turn on/off secondary screen (default enabled). |
974 | |
1052 | |
975 | =item B<secondaryScroll:> I<bool> |
1053 | =item B<secondaryScroll:> I<boolean> |
976 | |
1054 | |
977 | Turn on/off secondary screen scroll (default enabled). If the this |
1055 | Turn on/off secondary screen scroll (default enabled). If this |
978 | option is enabled, scrolls on the secondary screen will change the |
1056 | option is enabled, scrolls on the secondary screen will change the |
979 | scrollback buffer and switching to/from the secondary screen will |
1057 | scrollback buffer and switching to/from the secondary screen will |
980 | instead scroll the screen up. |
1058 | instead scroll the screen up. |
981 | |
1059 | |
982 | =item B<hold>: I<bool> |
1060 | =item B<hold>: I<boolean> |
983 | |
1061 | |
984 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
1062 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
985 | will not immediately destroy its window when the program executed within |
1063 | 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 |
1064 | it exits. Instead, it will wait till it is being killed or closed by the |
987 | user. |
1065 | user. |
… | |
… | |
1010 | |
1088 | |
1011 | I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, |
1089 | I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, |
1012 | C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, |
1090 | 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, |
1091 | 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 |
1092 | C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it |
1015 | can start or end with whitespace. |
1093 | can start or end with whitespace. B<This feature is deprecated and will |
|
|
1094 | be removed>. |
1016 | |
1095 | |
1017 | Please note that you need to double the C<\> when using |
1096 | 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 |
1097 | 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 |
1098 | C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own |
1020 | @@RXVT_NAME@@'s own processing). |
1099 | processing). |
1021 | |
1100 | |
1022 | You can define a range of keysyms in one shot by providing a I<string> |
1101 | 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 `/' |
1102 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' |
1024 | should be a character not used by the strings. |
1103 | should be a character not used by the strings. |
1025 | |
1104 | |
1026 | Its usage can be demonstrated by an example: |
1105 | Its usage can be demonstrated by an example: |
1027 | |
1106 | |
1028 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
1107 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
… | |
… | |
1081 | |
1160 | |
1082 | =item B<perl-ext-common>: I<string> |
1161 | =item B<perl-ext-common>: I<string> |
1083 | |
1162 | |
1084 | =item B<perl-ext>: I<string> |
1163 | =item B<perl-ext>: I<string> |
1085 | |
1164 | |
1086 | Colon-separated list(s) of perl extension scripts to use in this terminal |
1165 | Comma-separated list(s) of perl extension scripts (default: C<default>) to |
|
|
1166 | use in this terminal instance; option B<-pe>. |
|
|
1167 | |
|
|
1168 | Extension names can be prefixed with a C<-> sign to prohibit using |
|
|
1169 | them. This can be useful to selectively disable some extensions loaded |
|
|
1170 | by default, or specified via the C<perl-ext-common> resource. For |
|
|
1171 | example, C<default,-selection> will use all the default extension except |
|
|
1172 | C<selection>. |
|
|
1173 | |
|
|
1174 | Extension names can also be followed by an argument in angle brackets |
|
|
1175 | (e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for |
|
|
1176 | searchable scrollback to Alt/Meta-s). Mentioning the same extension |
|
|
1177 | multiple times with different arguments will pass multiple arguments to |
|
|
1178 | the extension. |
|
|
1179 | |
1087 | instance. Each extension is looked up in the library directories, loaded |
1180 | Each extension is looked up in the library directories, loaded if |
1088 | if necessary, and bound to the current terminal instance. If this |
1181 | necessary, and bound to the current terminal instance. |
1089 | resource is empty or missing, then the perl interpreter will not be |
1182 | |
1090 | initialized. The idea behind two options is that B<perl-ext-common> will |
1183 | 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 |
1184 | interpreter will not be initialized. The idea behind two options is that |
1092 | B<perl-ext> is used for specific instances; option B<-pe>. |
1185 | B<perl-ext-common> will be used for extensions that should be available to |
|
|
1186 | all instances, while B<perl-ext> is used for specific instances. |
1093 | |
1187 | |
1094 | =item B<perl-eval>: I<string> |
1188 | =item B<perl-eval>: I<string> |
1095 | |
1189 | |
1096 | Perl code to be evaluated when all extensions have been registered. See the |
1190 | Perl code to be evaluated when all extensions have been registered. See |
1097 | @@RXVT_NAME@@perl(3) manpage. |
1191 | the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource |
|
|
1192 | will be ignored when running setuid/setgid. |
1098 | |
1193 | |
1099 | =item B<perl-lib>: I<path> |
1194 | =item B<perl-lib>: I<path> |
1100 | |
1195 | |
1101 | Colon-separated list of additional directories that hold extension |
1196 | Colon-separated list of additional directories that hold extension |
1102 | scripts. When looking for extensions specified by the C<perl> resource, |
1197 | scripts. When looking for extensions specified by the C<perl> resource, |
1103 | @@RXVT_NAME@@ will first look in these directories and then in |
1198 | @@RXVT_NAME@@ will first look in these directories and then in |
1104 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
1199 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource |
|
|
1200 | will be ignored when running setuid/setgid. |
1105 | |
1201 | |
1106 | See the @@RXVT_NAME@@perl(3) manpage. |
1202 | See the @@RXVT_NAME@@perl(3) manpage. |
|
|
1203 | |
|
|
1204 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
|
|
1205 | |
|
|
1206 | Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for |
|
|
1207 | details. |
|
|
1208 | |
|
|
1209 | =item B<< selection-autotransform.I<idx> >>: I<perl-transform> |
|
|
1210 | |
|
|
1211 | Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage |
|
|
1212 | for details. |
|
|
1213 | |
|
|
1214 | =item B<searchable-scrollback:> I<keysym> |
|
|
1215 | |
|
|
1216 | Sets the hotkey that starts the incremental scrollback buffer search |
|
|
1217 | (default: C<M-s>). |
|
|
1218 | |
|
|
1219 | =item B<urlLauncher>: I<string> |
|
|
1220 | |
|
|
1221 | Specifies the program to be started with a URL argument. Used by the |
|
|
1222 | C<selection-popup> and C<matcher> perl extensions. |
|
|
1223 | |
|
|
1224 | =item B<transient-for>: I<windowid> |
|
|
1225 | |
|
|
1226 | Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. |
|
|
1227 | |
|
|
1228 | =item B<override-redirect>: I<boolean> |
|
|
1229 | |
|
|
1230 | Compile I<frills>: Sets override-redirect for the terminal window, making |
|
|
1231 | it almost invisible to window managers; option B<-override-redirect>. |
|
|
1232 | |
|
|
1233 | =item B<iso14755_52:> I<boolean> |
|
|
1234 | |
|
|
1235 | Turn on/off ISO 14755 5.2 mode (default enabled). |
1107 | |
1236 | |
1108 | =back |
1237 | =back |
1109 | |
1238 | |
1110 | =head1 THE SCROLLBAR |
1239 | =head1 THE SCROLLBAR |
1111 | |
1240 | |
… | |
… | |
1130 | application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> |
1259 | application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> |
1131 | (Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the |
1260 | (Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the |
1132 | up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), |
1261 | up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), |
1133 | respectively. |
1262 | respectively. |
1134 | |
1263 | |
1135 | =head1 TEXT SELECTION AND INSERTION |
1264 | =head1 THE SELECTION: SELECTING AND PASTING TEXT |
1136 | |
1265 | |
1137 | The behaviour of text selection and insertion mechanism is similar to |
1266 | The behaviour of text selection and insertion/pasting mechanism is similar |
1138 | I<xterm>(1). |
1267 | to I<xterm>(1). |
1139 | |
1268 | |
1140 | =over 4 |
1269 | =over 4 |
1141 | |
1270 | |
1142 | =item B<Selection>: |
1271 | =item B<Selecting>: |
1143 | |
1272 | |
1144 | Left click at the beginning of the region, drag to the end of the region |
1273 | Left click at the beginning of the region, drag to the end of the region |
1145 | and release; Right click to extend the marked region; Left double-click |
1274 | and release; Right click to extend the marked region; Left double-click |
1146 | to select a word; Left triple-click to select the entire logical line |
1275 | to select a word; Left triple-click to select the entire logical line |
1147 | (which can span multiple screen lines), unless modified by resource |
1276 | (which can span multiple screen lines), unless modified by resource |
… | |
… | |
1151 | (Compile: I<frills>) will create a rectangular selection instead of a |
1280 | (Compile: I<frills>) will create a rectangular selection instead of a |
1152 | normal one. In this mode, every selected row becomes its own line in the |
1281 | normal one. In this mode, every selected row becomes its own line in the |
1153 | selection, and trailing whitespace is visually underlined and removed from |
1282 | selection, and trailing whitespace is visually underlined and removed from |
1154 | the selection. |
1283 | the selection. |
1155 | |
1284 | |
1156 | =item B<Insertion>: |
1285 | =item B<Pasting>: |
1157 | |
1286 | |
1158 | Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in |
1287 | 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 |
1288 | window causes the value of the PRIMARY selection (or CLIPBOARD with the |
1160 | inserted as if it had been typed on the keyboard. |
1289 | B<Meta> modifier) to be inserted as if it had been typed on the keyboard. |
|
|
1290 | |
|
|
1291 | Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be |
|
|
1292 | inserted too. |
1161 | |
1293 | |
1162 | =back |
1294 | =back |
1163 | |
1295 | |
1164 | =head1 CHANGING FONTS |
1296 | =head1 CHANGING FONTS |
1165 | |
1297 | |
1166 | Changing fonts (or font sizes, respectively) via the keypad is not yet |
1298 | Changing fonts (or font sizes, respectively) via the keypad is not yet |
1167 | supported in rxvt-unicode. Bug me if you need this. |
1299 | supported in rxvt-unicode. Bug me if you need this. |
1168 | |
1300 | |
1169 | You can, however, switch fonts at runtime using escape sequences (and |
1301 | You can, however, switch fonts at runtime using escape sequences, e.g.: |
1170 | therefore using the menubar), e.g.: |
|
|
1171 | |
1302 | |
1172 | printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" |
1303 | printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" |
|
|
1304 | |
|
|
1305 | You can use keyboard shortcuts, too: |
|
|
1306 | |
|
|
1307 | URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007 |
|
|
1308 | URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007 |
1173 | |
1309 | |
1174 | rxvt-unicode will automatically re-apply these fonts to the output so far. |
1310 | rxvt-unicode will automatically re-apply these fonts to the output so far. |
1175 | |
1311 | |
1176 | =head1 ISO 14755 SUPPORT |
1312 | =head1 ISO 14755 SUPPORT |
1177 | |
1313 | |
1178 | ISO 14755 is a standard for entering and viewing unicode characters |
1314 | ISO 14755 is a standard for entering and viewing unicode characters |
1179 | and character codes using the keyboard. It consists of 4 parts. The |
1315 | and character codes using the keyboard. It consists of 4 parts. The |
1180 | first part is available rxvt-unicode has been compiled with |
1316 | first part is available if rxvt-unicode has been compiled with |
1181 | C<--enable-frills>, the rest is available when rxvt-unicode was compiled |
1317 | C<--enable-frills>, the rest is available when rxvt-unicode was compiled |
1182 | with C<--enable-iso14755>. |
1318 | with C<--enable-iso14755>. |
1183 | |
1319 | |
1184 | =over 4 |
1320 | =over 4 |
1185 | |
1321 | |
… | |
… | |
1205 | This mode lets you input characters representing the keycap symbols of |
1341 | This mode lets you input characters representing the keycap symbols of |
1206 | your keyboard, if representable in the current locale encoding. |
1342 | your keyboard, if representable in the current locale encoding. |
1207 | |
1343 | |
1208 | Start by pressing C<Control> and C<Shift> together, then releasing |
1344 | 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 |
1345 | 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 |
1346 | invoke its usual function but instead will insert the corresponding |
1211 | keycap symbol. The symbol will only be entered when the key has been |
1347 | 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 |
1348 | 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 |
1349 | C<ISO Level 2 Switch>, although your intention might have been to enter a |
1214 | reverse tab (Shift-Tab). |
1350 | reverse tab (Shift-Tab). |
1215 | |
1351 | |
… | |
… | |
1248 | =head1 COLORS AND GRAPHICS |
1384 | =head1 COLORS AND GRAPHICS |
1249 | |
1385 | |
1250 | In addition to the default foreground and background colours, |
1386 | In addition to the default foreground and background colours, |
1251 | B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus |
1387 | 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 |
1388 | high-intensity bold/blink versions of the same). Here is a list of the |
1253 | colours with their B<rgb.txt> names. |
1389 | colours with their names. |
1254 | |
1390 | |
1255 | =begin table |
1391 | =begin table |
1256 | |
1392 | |
1257 | B<color0> (black) = Black |
1393 | B<color0> (black) = Black |
1258 | B<color1> (red) = Red3 |
1394 | B<color1> (red) = Red3 |
… | |
… | |
1278 | It is also possible to specify the colour values of B<foreground>, |
1414 | It is also possible to specify the colour values of B<foreground>, |
1279 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1415 | 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 |
1416 | a number 0-15, as a convenient shorthand to reference the colour name of |
1281 | color0-color15. |
1417 | color0-color15. |
1282 | |
1418 | |
|
|
1419 | In addition to the colours defined above, @@RXVT_NAME@@ offers an |
|
|
1420 | additional 72 colours. The first 64 of those (with indices 16 to 79) |
|
|
1421 | consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b + |
|
|
1422 | 16>), followed by 8 additional shades of gray (with indices 80 to 87). |
|
|
1423 | |
|
|
1424 | Together, all those colours implement the 88 colour xterm colours. Only |
|
|
1425 | the first 16 can be changed using resources currently, the rest can only |
|
|
1426 | be changed via command sequences ("escape codes"). |
|
|
1427 | |
1283 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1428 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1284 | always swapping the foreground/background colours. This is in contrast to |
1429 | 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 |
1430 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1286 | been specified. For example, |
1431 | been specified. For example, |
1287 | |
1432 | |
… | |
… | |
1292 | would yield White on Black, while on I<xterm>(1) it would yield Black |
1437 | would yield White on Black, while on I<xterm>(1) it would yield Black |
1293 | on White. |
1438 | on White. |
1294 | |
1439 | |
1295 | =back |
1440 | =back |
1296 | |
1441 | |
|
|
1442 | =head2 ALPHA CHANNEL SUPPORT |
|
|
1443 | |
|
|
1444 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
|
|
1445 | their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> |
|
|
1446 | (recommended, but B<MUST> have 4 digits/component) colour specifications, |
|
|
1447 | in addition to the ones provided by X, where the additional A component |
|
|
1448 | specifies opacity (alpha) values. The minimum value of C<0> is completely |
|
|
1449 | transparent). You can also prefix any color with C<[percent]>, where |
|
|
1450 | C<percent> is a decimal percentage (0-100) that specifies the opacity of |
|
|
1451 | the color, where C<0> is completely transparent and C<100> is completelxy |
|
|
1452 | opaque. |
|
|
1453 | |
|
|
1454 | You probably need to specify B<"-depth 32">, too, and have the luck that |
|
|
1455 | your X-server uses ARGB pixel layout, as X is far from just supporting |
|
|
1456 | ARGB visuals out of the box, and rxvt-unicode just fudges around. |
|
|
1457 | |
|
|
1458 | For example, the following selects an almost completely transparent red |
|
|
1459 | background, and an almost opaque pink foreground: |
|
|
1460 | |
|
|
1461 | @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" |
|
|
1462 | |
|
|
1463 | I<Please note that transparency of any kind if completely unsupported by |
|
|
1464 | the author. Don't bug him with installation questions!> |
|
|
1465 | |
1297 | =head1 ENVIRONMENT |
1466 | =head1 ENVIRONMENT |
1298 | |
1467 | |
1299 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1468 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1300 | |
1469 | |
1301 | =over 4 |
1470 | =over 4 |
1302 | |
1471 | |
1303 | =item B<TERM> |
1472 | =item B<TERM> |
1304 | |
1473 | |
1305 | Normally set to C<rxvt-unicode>, unless overwritten at configure time, via |
1474 | Normally set to C<rxvt-unicode>, unless overwritten at configure time, via |
1306 | resources or on the commandline. |
1475 | resources or on the command line. |
1307 | |
1476 | |
1308 | =item B<COLORTERM> |
1477 | =item B<COLORTERM> |
1309 | |
1478 | |
1310 | Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was |
1479 | Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was |
1311 | compiled with XPM support, and optionally with the added extension |
1480 | compiled with XPM support, and optionally with the added extension |
1312 | C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. |
1481 | C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. |
1313 | |
1482 | |
1314 | =item B<COLORFGBG> |
1483 | =item B<COLORFGBG> |
1315 | |
1484 | |
… | |
… | |
1333 | C<--with-terminfo=PATH>. |
1502 | C<--with-terminfo=PATH>. |
1334 | |
1503 | |
1335 | =item B<DISPLAY> |
1504 | =item B<DISPLAY> |
1336 | |
1505 | |
1337 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1506 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1338 | display in it's child processes. |
1507 | display in its child processes. |
1339 | |
1508 | |
1340 | =item B<SHELL> |
1509 | =item B<SHELL> |
1341 | |
1510 | |
1342 | The shell to be used for command execution, defaults to C</bin/sh>. |
1511 | 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 | |
1512 | |
1353 | =item B<RXVT_SOCKET> |
1513 | =item B<RXVT_SOCKET> |
1354 | |
1514 | |
1355 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1515 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1356 | @@RXVT_NAME@@d(1). |
1516 | @@RXVT_NAME@@d(1). |
… | |
… | |
1394 | |
1554 | |
1395 | =item Project Coordinator |
1555 | =item Project Coordinator |
1396 | |
1556 | |
1397 | Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1557 | Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1398 | |
1558 | |
1399 | L<http://software.schmorp.de/#rxvt-unicode> |
1559 | L<http://software.schmorp.de/pkg/rxvt-unicode.html> |
1400 | |
1560 | |
1401 | =back |
1561 | =back |
1402 | |
1562 | |
1403 | =head1 AUTHORS |
1563 | =head1 AUTHORS |
1404 | |
1564 | |
… | |
… | |
1426 | |
1586 | |
1427 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1587 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1428 | |
1588 | |
1429 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1589 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1430 | |
1590 | |
1431 | Rewrote screen display and text selection routines. Project Coordinator |
1591 | Rewrote screen display and text selection routines. |
|
|
1592 | |
1432 | (changes.txt 2.4.6 - rxvt-unicode) |
1593 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1433 | |
1594 | |
1434 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1595 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1435 | |
1596 | |
1436 | Forked rxvt-unicode, rewrote most of the display code and internal |
1597 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |
1437 | character handling to store text in unicode, improve xterm |
1598 | extension, random hacks, numerous bugfixes and extensions. |
1438 | compatibility and apply numerous other bugfixes and extensions. |
|
|
1439 | |
1599 | |
1440 | Project Coordinator (Changes 1.0 -) |
1600 | Project Coordinator (Changes 1.0 -) |
1441 | |
1601 | |
|
|
1602 | =item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> |
|
|
1603 | |
|
|
1604 | Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. |
|
|
1605 | |
1442 | =back |
1606 | =back |
1443 | |
1607 | |