… | |
… | |
12 | emulator intended as an I<xterm>(1) replacement for users who do not |
12 | emulator intended as an I<xterm>(1) replacement for users who do not |
13 | require features such as Tektronix 4014 emulation and toolkit-style |
13 | require features such as Tektronix 4014 emulation and toolkit-style |
14 | configurability. As a result, B<rxvt-unicode> uses much less swap space -- |
14 | configurability. As a result, B<rxvt-unicode> uses much less swap space -- |
15 | a significant advantage on a machine serving many X sessions. |
15 | a significant advantage on a machine serving many X sessions. |
16 | |
16 | |
|
|
17 | This document is also available on the World-Wide-Web at |
|
|
18 | L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>. |
|
|
19 | |
17 | =head1 FREQUENTLY ASKED QUESTIONS |
20 | =head1 FREQUENTLY ASKED QUESTIONS |
18 | |
21 | |
19 | See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of |
22 | 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 |
23 | frequently asked questions and answer to them and some common |
21 | problems. That document is also accessible on the World-Wide-Web at |
24 | 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>. |
25 | L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>. |
23 | |
26 | |
24 | =head1 RXVT-UNICODE VS. RXVT |
27 | =head1 RXVT-UNICODE VS. RXVT |
25 | |
28 | |
26 | Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode |
29 | 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 |
30 | internally. That means it can store and display most scripts in the |
28 | world. Being a terminal emulator, however, some things are very difficult, |
31 | world. Being a terminal emulator, however, some things are very difficult, |
29 | especially cursive scripts such as arabic, vertically written scripts |
32 | especially cursive scripts such as arabic, vertically written scripts |
30 | like mongolian or scripts requiring extremely complex combining rules, |
33 | like mongolian or scripts requiring extremely complex combining rules, |
31 | like tibetan or devenagari. Don't expect pretty output when using these |
34 | like tibetan or devanagari. Don't expect pretty output when using these |
32 | scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work |
35 | scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work |
33 | fine, though. A somewhat difficult case are left-to-right scripts, such |
36 | fine, though. A somewhat difficult case are right-to-left scripts, such |
34 | as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms |
37 | as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms |
35 | belong into the application, not the terminal emulator (too many things -- |
38 | belong in the application, not the terminal emulator (too many things -- |
36 | such as cursor-movement while editing -- break otherwise), but that might |
39 | such as cursor-movement while editing -- break otherwise), but that might |
37 | change. |
40 | change. |
38 | |
41 | |
39 | If you are looking for a terminal that supports more exotic scripts, let |
42 | 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 |
43 | 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 |
44 | 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 |
45 | because the author couldn't get C<mlterm> to use one font for latin1 and |
43 | another for japanese. |
46 | another for japanese. |
44 | |
47 | |
45 | Therefore another design rationale was the use of multiple fonts to |
48 | Therefore another design rationale was the use of multiple fonts to |
46 | display characters: The idea of a single unicode font which many other |
49 | 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 |
50 | programs force onto its users never made sense to me: You should be able |
48 | to choose any font for any script freely. |
51 | to choose any font for any script freely. |
49 | |
52 | |
50 | Apart from that, rxvt-unicode is also much better internationalised than |
53 | 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 |
54 | 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 |
55 | 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. |
56 | rxvt. This all in addition to dozens of other small improvements. |
54 | |
57 | |
55 | It is still faithfully following the original rxvt idea of being lean |
58 | 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 |
59 | 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 |
60 | 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 |
61 | 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 |
62 | from within a single process, which makes startup time very fast and |
60 | drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and |
63 | drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and |
61 | @@RXVT_NAME@@c(1) (client). |
64 | @@RXVT_NAME@@c(1) (client). |
62 | |
65 | |
63 | It also makes technical information about escape sequences (which have |
66 | It also makes technical information about escape sequences (which have |
64 | been extended) easier accessible: see @@RXVT_NAME@@(7) for technical |
67 | been extended) more accessible: see @@RXVT_NAME@@(7) for technical |
65 | reference documentation (escape sequences etc.). |
68 | reference documentation (escape sequences etc.). |
66 | |
69 | |
67 | =head1 OPTIONS |
70 | =head1 OPTIONS |
68 | |
71 | |
69 | The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed |
72 | The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed |
… | |
… | |
93 | |
96 | |
94 | Attempt to open a window on the named X display (B<-d> still |
97 | 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 |
98 | respected). In the absence of this option, the display specified by the |
96 | B<DISPLAY> environment variable is used. |
99 | B<DISPLAY> environment variable is used. |
97 | |
100 | |
|
|
101 | =item B<-depth> I<bitdepth> |
|
|
102 | |
|
|
103 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
|
|
104 | resource B<depth>. |
|
|
105 | |
|
|
106 | [Please note that many X servers (and libXft) are buggy with |
|
|
107 | respect to C<-depth 32> and/or alpha channels, and will cause all sorts |
|
|
108 | of graphical corruption. This is harmless, but we can't do anything about |
|
|
109 | this, so watch out] |
|
|
110 | |
98 | =item B<-geometry> I<geom> |
111 | =item B<-geometry> I<geom> |
99 | |
112 | |
100 | Window geometry (B<-g> still respected); resource B<geometry>. |
113 | Window geometry (B<-g> still respected); resource B<geometry>. |
101 | |
114 | |
102 | =item B<-rv>|B<+rv> |
115 | =item B<-rv>|B<+rv> |
103 | |
116 | |
104 | Turn on/off simulated reverse video; resource B<reverseVideo>. |
117 | Turn on/off simulated reverse video; resource B<reverseVideo>. |
105 | |
118 | |
106 | =item B<-j>|B<+j> |
119 | =item B<-j>|B<+j> |
107 | |
120 | |
108 | Turn on/off jump scrolling; resource B<jumpScroll>. |
121 | Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. |
109 | |
122 | |
110 | =item B<-ip>|B<+ip> | B<-tr>|B<+tr> |
123 | =item B<-ss>|B<+ss> |
111 | |
124 | |
112 | Turn on/off inheriting parent window's pixmap. Alternative form is |
125 | Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. |
113 | B<-tr>; resource B<inheritPixmap>. |
126 | |
|
|
127 | =item B<-tr>|B<+tr> |
|
|
128 | |
|
|
129 | Turn on/off illusion of a transparent window background; resource B<transparent>. |
|
|
130 | |
|
|
131 | B<-ip> is still accepted as an obsolete alias but will be removed in |
|
|
132 | future versions. |
|
|
133 | |
|
|
134 | I<Please address all transparency related issues to Sasha Vasko at |
|
|
135 | sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> |
114 | |
136 | |
115 | =item B<-fade> I<number> |
137 | =item B<-fade> I<number> |
116 | |
138 | |
117 | Fade the text by the given percentage when focus is lost. Small values |
139 | 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 |
140 | fade a little only, 100 completely replaces all colours by the fade |
119 | colour; resource B<fading>. |
141 | colour; resource B<fading>. |
120 | |
142 | |
121 | =item B<-fadecolor> I<colour> |
143 | =item B<-fadecolor> I<colour> |
122 | |
144 | |
123 | Fade to this colour when fading is used (see B<-fade>). The default colour |
145 | Fade to this colour when fading is used (see B<-fade>). The default colour |
124 | is black. resource B<fadeColor>. |
146 | is opaque black. resource B<fadeColor>. |
125 | |
147 | |
126 | =item B<-tint> I<colour> |
148 | =item B<-tint> I<colour> |
127 | |
149 | |
128 | Tint the transparent background pixmap with the given colour when |
150 | Tint the transparent background pixmap with the given colour when |
129 | transparency is enabled with B<-tr> or B<-ip>. This only works for |
151 | transparency is enabled with B<-tr>. This only works for |
130 | non-tiled backgrounds, currently. See also the B<-sh> option that can be |
152 | 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 |
153 | used to brighten or darken the image in addition to tinting it. |
|
|
154 | Please note that certain tint colours can be applied on the server-side, |
|
|
155 | thus yielding performance gain of two orders of magnitude. These colours are: |
|
|
156 | blue, red, green, cyan, magenta, yellow, and those close to them. Also |
|
|
157 | pure black and pure white colors essentially mean no tinting; resource |
132 | I<tintColor>. Example: |
158 | I<tintColor>. Example: |
133 | |
159 | |
134 | @@RXVT_NAME@@ -tr -tint blue -sh 40 |
160 | @@RXVT_NAME@@ -tr -tint blue -sh 40 |
135 | |
161 | |
136 | =item B<-sh> |
162 | =item B<-sh> I<number> |
137 | |
163 | |
138 | I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
164 | Darken (0 .. 100) or lighten (100 .. 200) the transparent |
139 | background image in addition to tinting it (i.e. B<-tint> must be |
165 | background image in addition to (or instead of) tinting it; |
140 | specified, too, e.g. C<-tint white>). |
166 | resource I<shading>. |
|
|
167 | |
|
|
168 | =item B<-blt> I<string> |
|
|
169 | |
|
|
170 | Specify background blending type. If background pixmap is specified |
|
|
171 | at the same time as transparency - such pixmap will be blended over |
|
|
172 | transparency image, using method specified. Supported values are : |
|
|
173 | B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, |
|
|
174 | B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, |
|
|
175 | B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is |
|
|
176 | alpha-blending. Compile I<afterimage>; resource I<blendType>. |
|
|
177 | |
|
|
178 | =item B<-blr> I<HxV> |
|
|
179 | |
|
|
180 | Apply Gaussian Blur with the specified radii to the transparent |
|
|
181 | background image. If single number is specified - both vertical and |
|
|
182 | horizontal radii are considered to be the same. Setting one of the |
|
|
183 | radii to 1 and another to a large number creates interesting effects |
|
|
184 | on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; |
|
|
185 | resource I<blurRadius>. |
141 | |
186 | |
142 | =item B<-bg> I<colour> |
187 | =item B<-bg> I<colour> |
143 | |
188 | |
144 | Window background colour; resource B<background>. |
189 | Window background colour; resource B<background>. |
145 | |
190 | |
146 | =item B<-fg> I<colour> |
191 | =item B<-fg> I<colour> |
147 | |
192 | |
148 | Window foreground colour; resource B<foreground>. |
193 | Window foreground colour; resource B<foreground>. |
149 | |
194 | |
150 | =item B<-pixmap> I<file[;geom]> |
195 | =item B<-pixmap> I<file[;geom[:op1][:op2][...]]> |
151 | |
196 | |
152 | Compile I<XPM>: Specify XPM file for the background and also optionally |
197 | Compile I<afterimage>: Specify image file for the background and also |
153 | specify its scaling with a geometry string. Note you may need to |
198 | 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 |
199 | add quotes to avoid special shell interpretation of the C<;> in the |
155 | command-line; resource B<backgroundPixmap>. |
200 | command-line; for more details see resource B<backgroundPixmap>. |
156 | |
201 | |
157 | =item B<-cr> I<colour> |
202 | =item B<-cr> I<colour> |
158 | |
203 | |
159 | The cursor colour; resource B<cursorColor>. |
204 | The cursor colour; resource B<cursorColor>. |
160 | |
205 | |
… | |
… | |
177 | that are checked in order when trying to find glyphs for characters. The |
222 | 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 |
223 | first font defines the cell size for characters; other fonts might be |
179 | smaller, but not (in general) larger. A (hopefully) reasonable default |
224 | 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. |
225 | font list is always appended to it. See resource B<font> for more details. |
181 | |
226 | |
182 | In short, to specify an X11 core font, just specify it's name or prefix it |
227 | 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:>, |
228 | with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, |
184 | e.g.: |
229 | e.g.: |
185 | |
230 | |
186 | @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
231 | @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
187 | @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
232 | @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
… | |
… | |
205 | italic> >> characters are to be printed. See resource B<boldItalicFont> |
250 | italic> >> characters are to be printed. See resource B<boldItalicFont> |
206 | for details. |
251 | for details. |
207 | |
252 | |
208 | =item B<-is>|B<+is> |
253 | =item B<-is>|B<+is> |
209 | |
254 | |
210 | Compile I<font-styles>: Bold/Italic font styles imply high intensity |
255 | Compile I<font-styles>: Bold/Blink font styles imply high intensity |
211 | foreground/background (default). See resource B<intensityStyles> for |
256 | foreground/background (default). See resource B<intensityStyles> for |
212 | details. |
257 | details. |
213 | |
258 | |
214 | =item B<-name> I<name> |
259 | =item B<-name> I<name> |
215 | |
260 | |
… | |
… | |
233 | |
278 | |
234 | =item B<-sb>|B<+sb> |
279 | =item B<-sb>|B<+sb> |
235 | |
280 | |
236 | Turn on/off scrollbar; resource B<scrollBar>. |
281 | Turn on/off scrollbar; resource B<scrollBar>. |
237 | |
282 | |
|
|
283 | =item B<-sr>|B<+sr> |
|
|
284 | |
|
|
285 | Put scrollbar on right/left; resource B<scrollBar_right>. |
|
|
286 | |
|
|
287 | =item B<-st>|B<+st> |
|
|
288 | |
|
|
289 | Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; |
|
|
290 | resource B<scrollBar_floating>. |
|
|
291 | |
238 | =item B<-si>|B<+si> |
292 | =item B<-si>|B<+si> |
239 | |
293 | |
240 | Turn on/off scroll-to-bottom on TTY output inhibit; resource |
294 | Turn on/off scroll-to-bottom on TTY output inhibit; resource |
241 | B<scrollTtyOutput> has opposite effect. |
295 | B<scrollTtyOutput> has opposite effect. |
242 | |
296 | |
… | |
… | |
248 | =item B<-sw>|B<+sw> |
302 | =item B<-sw>|B<+sw> |
249 | |
303 | |
250 | Turn on/off scrolling with the scrollback buffer as new lines appear. |
304 | Turn on/off scrolling with the scrollback buffer as new lines appear. |
251 | This only takes effect if B<-si> is also given; resource |
305 | This only takes effect if B<-si> is also given; resource |
252 | B<scrollWithBuffer>. |
306 | B<scrollWithBuffer>. |
253 | |
|
|
254 | =item B<-sr>|B<+sr> |
|
|
255 | |
|
|
256 | Put scrollbar on right/left; resource B<scrollBar_right>. |
|
|
257 | |
|
|
258 | =item B<-st>|B<+st> |
|
|
259 | |
|
|
260 | Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; |
|
|
261 | resource B<scrollBar_floating>. |
|
|
262 | |
307 | |
263 | =item B<-ptab>|B<+ptab> |
308 | =item B<-ptab>|B<+ptab> |
264 | |
309 | |
265 | If enabled (default), "Horizontal Tab" characters are being stored as |
310 | If enabled (default), "Horizontal Tab" characters are being stored as |
266 | actual wide characters in the screen buffer, which makes it possible to |
311 | actual wide characters in the screen buffer, which makes it possible to |
… | |
… | |
313 | |
358 | |
314 | =item B<-lsp> I<number> |
359 | =item B<-lsp> I<number> |
315 | |
360 | |
316 | Compile I<frills>: Lines (pixel height) to insert between each row of |
361 | Compile I<frills>: Lines (pixel height) to insert between each row of |
317 | the display. Useful to work around font rendering problems; resource |
362 | the display. Useful to work around font rendering problems; resource |
318 | B<linespace>. |
363 | B<lineSpace>. |
319 | |
364 | |
320 | =item B<-tn> I<termname> |
365 | =item B<-tn> I<termname> |
321 | |
366 | |
322 | This option specifies the name of the terminal type to be set in the |
367 | This option specifies the name of the terminal type to be set in the |
323 | B<TERM> environment variable. This terminal type must exist in the |
368 | B<TERM> environment variable. This terminal type must exist in the |
… | |
… | |
377 | for more info. |
422 | for more info. |
378 | |
423 | |
379 | =item B<-tcw> |
424 | =item B<-tcw> |
380 | |
425 | |
381 | Change the meaning of triple-click selection with the left mouse |
426 | Change the meaning of triple-click selection with the left mouse |
|
|
427 | button. Only effective when the original (non-perl) selection code is |
382 | button. Instead of selecting a full line it will extend the selection the |
428 | in-use. Instead of selecting a full line it will extend the selection to |
383 | end of the logical line only. resource B<tripleclickwords>. |
429 | the end of the logical line only. resource B<tripleclickwords>. |
384 | |
430 | |
385 | =item B<-insecure> |
431 | =item B<-insecure> |
386 | |
432 | |
387 | Enable "insecure" mode, which currently enables most of the escape |
433 | Enable "insecure" mode, which currently enables most of the escape |
388 | sequences that echo strings. See the resource B<insecure> for more |
434 | sequences that echo strings. See the resource B<insecure> for more |
… | |
… | |
409 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
455 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
410 | will not immediately destroy its window when the program executed within |
456 | will not immediately destroy its window when the program executed within |
411 | it exits. Instead, it will wait till it is being killed or closed by the |
457 | it exits. Instead, it will wait till it is being killed or closed by the |
412 | user; resource B<hold>. |
458 | user; resource B<hold>. |
413 | |
459 | |
|
|
460 | =item B<-xrm> I<string> |
|
|
461 | |
|
|
462 | Works like the X Toolkit option of the same name, by adding the I<string> |
|
|
463 | as if it were specified in a resource file. Resource values specified this |
|
|
464 | way take precedence over all other resource specifications. |
|
|
465 | |
|
|
466 | Note that you need to use the I<same> syntax as in the .Xdefaults file, |
|
|
467 | e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific |
|
|
468 | options can be specified as long-options on the commandline, so use |
|
|
469 | of B<-xrm> is mostly limited to cases where you want to specify other |
|
|
470 | resources (e.g. for input methods) or for compatibility with other |
|
|
471 | programs. |
|
|
472 | |
414 | =item B<-keysym.>I<sym> I<string> |
473 | =item B<-keysym.>I<sym> I<string> |
415 | |
474 | |
416 | Remap a key symbol. See resource B<keysym>. |
475 | Remap a key symbol. See resource B<keysym>. |
417 | |
476 | |
418 | =item B<-embed> I<windowid> |
477 | =item B<-embed> I<windowid> |
419 | |
478 | |
420 | Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, |
479 | Tells @@RXVT_NAME@@ to embed its windows into an already-existing window, |
421 | which enables applications to easily embed a terminal. |
480 | which enables applications to easily embed a terminal. |
422 | |
481 | |
423 | Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it |
482 | Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it |
424 | shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it |
483 | shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it |
425 | quite a bit, so don't expect it to keep some specific state. It's best to |
484 | quite a bit, so don't expect it to keep some specific state. It's best to |
… | |
… | |
428 | The window will not be destroyed when @@RXVT_NAME@@ exits. |
487 | The window will not be destroyed when @@RXVT_NAME@@ exits. |
429 | |
488 | |
430 | It might be useful to know that @@RXVT_NAME@@ will not close file |
489 | It might be useful to know that @@RXVT_NAME@@ will not close file |
431 | descriptors passed to it (except for stdin/out/err, of course), so you |
490 | descriptors passed to it (except for stdin/out/err, of course), so you |
432 | can use file descriptors to communicate with the programs within the |
491 | can use file descriptors to communicate with the programs within the |
433 | terminal. This works regardless of wether the C<-embed> option was used or |
492 | terminal. This works regardless of whether the C<-embed> option was used or |
434 | not. |
493 | not. |
435 | |
494 | |
436 | Here is a short Gtk2-perl snippet that illustrates how this option can be |
495 | Here is a short Gtk2-perl snippet that illustrates how this option can be |
437 | used (a longer example is in F<doc/embed>): |
496 | used (a longer example is in F<doc/embed>): |
438 | |
497 | |
… | |
… | |
443 | }); |
502 | }); |
444 | |
503 | |
445 | =item B<-pty-fd> I<file descriptor> |
504 | =item B<-pty-fd> I<file descriptor> |
446 | |
505 | |
447 | Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty |
506 | Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty |
448 | pair but instead use the given filehandle as the tty master. This is |
507 | pair but instead use the given file descriptor as the tty master. This is |
449 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
508 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
450 | without having to run a program within it. |
509 | without having to run a program within it. |
451 | |
510 | |
452 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
511 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
453 | entries and will not tinker with pty/tty permissions - you have to do that |
512 | entries and will not tinker with pty/tty permissions - you have to do that |
454 | yourself if you want that. |
513 | yourself if you want that. |
455 | |
514 | |
456 | As an extremely special case, specifying C<-1> will completely suppress |
515 | As an extremely special case, specifying C<-1> will completely suppress |
457 | pty/tty operations. |
516 | pty/tty operations, which is probably only useful in conjunction with some |
|
|
517 | perl extension that manages the terminal. |
458 | |
518 | |
459 | Here is a example in perl that illustrates how this option can be used (a |
519 | Here is a example in perl that illustrates how this option can be used (a |
460 | longer example is in F<doc/pty-fd>): |
520 | longer example is in F<doc/pty-fd>): |
461 | |
521 | |
462 | use IO::Pty; |
522 | use IO::Pty; |
… | |
… | |
476 | Comma-separated list of perl extension scripts to use (or not to use) in |
536 | Comma-separated list of perl extension scripts to use (or not to use) in |
477 | this terminal instance. See resource B<perl-ext> for details. |
537 | this terminal instance. See resource B<perl-ext> for details. |
478 | |
538 | |
479 | =back |
539 | =back |
480 | |
540 | |
481 | =head1 RESOURCES (available also as long-options) |
541 | =head1 RESOURCES |
482 | |
542 | |
483 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
543 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
484 | options) compiled into your version. |
544 | options) compiled into your version. All resources are also available as |
|
|
545 | long-options. |
485 | |
546 | |
486 | You can set and change the resources using X11 tools like B<xrdb>. Many |
547 | You can set and change the resources using X11 tools like B<xrdb>. Many |
487 | distribution do also load settings from the B<~/.Xresources> file when X |
548 | distribution do also load settings from the B<~/.Xresources> file when X |
488 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
549 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
489 | with later settings overwriting earlier ones: |
550 | with later settings overwriting earlier ones: |
… | |
… | |
491 | 1. system-wide app-defaults file, either locale-dependent OR global |
552 | 1. system-wide app-defaults file, either locale-dependent OR global |
492 | 2. app-defaults file in $XAPPLRESDIR |
553 | 2. app-defaults file in $XAPPLRESDIR |
493 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
554 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
494 | 4. SCREEN_RESOURCES for the current screen |
555 | 4. SCREEN_RESOURCES for the current screen |
495 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
556 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
|
|
557 | 6. resources specified via -xrm on the commandline |
496 | |
558 | |
497 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
559 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
498 | names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
560 | names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
499 | common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily |
561 | common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily |
500 | configured, while the class name B<URxvt> allows resources unique to |
562 | configured, while the class name B<URxvt> allows resources unique to |
… | |
… | |
505 | check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl |
567 | check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl |
506 | extensions not documented here): |
568 | extensions not documented here): |
507 | |
569 | |
508 | =over 4 |
570 | =over 4 |
509 | |
571 | |
|
|
572 | =item B<depth:> I<bitdepth> |
|
|
573 | |
|
|
574 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
|
|
575 | option B<-depth>. |
|
|
576 | |
510 | =item B<geometry:> I<geom> |
577 | =item B<geometry:> I<geom> |
511 | |
578 | |
512 | Create the window with the specified X window geometry [default 80x24]; |
579 | Create the window with the specified X window geometry [default 80x24]; |
513 | option B<-geometry>. |
580 | option B<-geometry>. |
514 | |
581 | |
… | |
… | |
550 | Use the specified colour to display underlined characters when the |
617 | Use the specified colour to display underlined characters when the |
551 | foreground colour is the default. |
618 | foreground colour is the default. |
552 | |
619 | |
553 | =item B<colorRV:> I<colour> |
620 | =item B<colorRV:> I<colour> |
554 | |
621 | |
555 | Use the specified colour as the background for reverse video |
622 | Use the specified colour as the background for reverse video characters |
556 | characters. |
623 | when OPTION_HC is disabled (--disable-frills). |
557 | |
624 | |
558 | =item B<underlineColor:> I<colour> |
625 | =item B<underlineColor:> I<colour> |
559 | |
626 | |
560 | If set, use the specified colour as the colour for the underline |
627 | If set, use the specified colour as the colour for the underline |
561 | itself. If unset, use the foreground colour. |
628 | itself. If unset, use the foreground colour. |
… | |
… | |
577 | option B<-rv>. B<False>: regular screen colours [default]; option |
644 | option B<-rv>. B<False>: regular screen colours [default]; option |
578 | B<+rv>. See note in B<COLORS AND GRAPHICS> section. |
645 | B<+rv>. See note in B<COLORS AND GRAPHICS> section. |
579 | |
646 | |
580 | =item B<jumpScroll:> I<boolean> |
647 | =item B<jumpScroll:> I<boolean> |
581 | |
648 | |
582 | B<True>: specify that jump scrolling should be used. When scrolling |
649 | B<True>: specify that jump scrolling should be used. When receiving lots |
583 | quickly, fewer screen updates are performed [default]; option B<-j>. |
650 | of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines |
|
|
651 | has been read, resulting in fewer updates while still displaying every |
|
|
652 | received line; option B<-j>. |
|
|
653 | |
584 | B<False>: specify that smooth scrolling should be used; option B<+j>. |
654 | B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will |
|
|
655 | force a screen refresh on each new line it received; option B<+j>. |
585 | |
656 | |
586 | =item B<inheritPixmap:> I<boolean> |
657 | =item B<skipScroll:> I<boolean> |
587 | |
658 | |
588 | B<True>: make the background inherit the parent windows' pixmap, giving |
659 | B<True>: (the default) specify that skip scrolling should be used. When |
589 | artificial transparency. B<False>: do not inherit the parent windows' |
660 | receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while |
590 | pixmap. |
661 | (around 60 times per second), resulting in far fewer updates. This can |
|
|
662 | result in @@RXVT_NAME@@ not ever displaying some of the lines it receives; |
|
|
663 | option B<-ss>. |
|
|
664 | |
|
|
665 | B<False>: specify that everything is to be displayed, even |
|
|
666 | if the refresh is too fast for the human eye to read anything (or the |
|
|
667 | monitor to display anything); option B<+ss>. |
|
|
668 | |
|
|
669 | =item B<transparent:> I<boolean> |
|
|
670 | |
|
|
671 | Turn on/off illusion of a transparent window background. |
|
|
672 | |
|
|
673 | B<inheritPixmap> is still accepted as an obsolete alias but will be removed in |
|
|
674 | future versions. |
|
|
675 | |
|
|
676 | I<Please address all transparency related issues to Sasha Vasko at |
|
|
677 | sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> |
591 | |
678 | |
592 | =item B<fading:> I<number> |
679 | =item B<fading:> I<number> |
593 | |
680 | |
594 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
681 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
595 | |
682 | |
… | |
… | |
603 | Tint the transparent background pixmap with the given colour; option |
690 | Tint the transparent background pixmap with the given colour; option |
604 | B<-tint>. |
691 | B<-tint>. |
605 | |
692 | |
606 | =item B<shading:> I<number> |
693 | =item B<shading:> I<number> |
607 | |
694 | |
608 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
695 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image |
609 | image in addition to tinting it. |
696 | in addition to tinting it; option B<-sh>. |
|
|
697 | |
|
|
698 | =item B<blendType:> I<string> |
|
|
699 | |
|
|
700 | Specify background blending type; option B<-blt>. |
|
|
701 | |
|
|
702 | =item B<blurRadius:> I<number> |
|
|
703 | |
|
|
704 | Apply Gaussian Blurr with the specified radius to the transparent |
|
|
705 | background image; option B<-blr>. |
610 | |
706 | |
611 | =item B<scrollColor:> I<colour> |
707 | =item B<scrollColor:> I<colour> |
612 | |
708 | |
613 | Use the specified colour for the scrollbar [default #B2B2B2]. |
709 | Use the specified colour for the scrollbar [default #B2B2B2]. |
614 | |
710 | |
… | |
… | |
620 | =item B<borderColor:> I<colour> |
716 | =item B<borderColor:> I<colour> |
621 | |
717 | |
622 | The colour of the border around the text area and between the scrollbar |
718 | The colour of the border around the text area and between the scrollbar |
623 | and the text. |
719 | and the text. |
624 | |
720 | |
625 | =item B<backgroundPixmap:> I<file[;geom]> |
721 | =item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> |
626 | |
722 | |
627 | Use the specified XPM file (note the `.xpm' extension is optional) for |
723 | Use the specified image file for the background and also |
628 | the background and also optionally specify its scaling with a geometry |
724 | optionally specify its scaling with a geometry string B<WxH+X+Y>, |
629 | string B<WxH+X+Y>, in which B<"W" / "H"> specify the |
725 | (default C<0x0+50+50>) in which B<"W" / "H"> specify the |
630 | horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image |
726 | horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image |
631 | centre (percent). A scale of 0 displays the image with tiling. A scale |
727 | centre (percent). A scale of 0 displays the image with tiling. A scale |
632 | of 1 displays the image without any scaling. A scale of 2 to 9 |
728 | of 1 displays the image without any scaling. A scale of 2 to 9 specifies |
633 | specifies an integer number of images in that direction. No image will |
729 | an integer number of images in that direction. No image will be magnified |
634 | be magnified beyond 10 times its original size. The maximum permitted |
730 | beyond 10 times its original size. The maximum permitted scale is 1000. |
635 | scale is 1000. [default 0x0+50+50] |
731 | Additional operations can be specified after colon B<:op1:op2...>. |
|
|
732 | Supported operations are: |
|
|
733 | |
|
|
734 | tile force background image to be tiled and not scaled. Equivalent to 0x0 |
|
|
735 | propscale will scale image keeping proportions |
|
|
736 | auto will scale image to match window size. Equivalent to 100x100 |
|
|
737 | hscale will scale image horizontally to the window size |
|
|
738 | vscale will scale image vertically to the window size |
|
|
739 | scale will scale image to match window size |
|
|
740 | root will tile image as if it was a root window background, auto-adjusting |
|
|
741 | whenever terminal window moves |
|
|
742 | |
|
|
743 | If used in conjunction with B<-tr> option, the specified pixmap will be |
|
|
744 | blended over transparency image using either alpha-blending, or any |
|
|
745 | other blending type, specified with B<-blt "type"> option. |
636 | |
746 | |
637 | =item B<path:> I<path> |
747 | =item B<path:> I<path> |
638 | |
748 | |
639 | Specify the colon-delimited search path for finding XPM files. |
749 | Specify the colon-delimited search path for finding background image files. |
640 | |
750 | |
641 | =item B<font:> I<fontlist> |
751 | =item B<font:> I<fontlist> |
642 | |
752 | |
643 | Select the fonts to be used. This is a comma separated list of font names |
753 | Select the fonts to be used. This is a comma separated list of font names |
644 | that are checked in order when trying to find glyphs for characters. The |
754 | that are checked in order when trying to find glyphs for characters. The |
… | |
… | |
701 | text font will being used for the given style. |
811 | text font will being used for the given style. |
702 | |
812 | |
703 | =item B<intensityStyles:> I<boolean> |
813 | =item B<intensityStyles:> I<boolean> |
704 | |
814 | |
705 | When font styles are not enabled, or this option is enabled (B<True>, |
815 | When font styles are not enabled, or this option is enabled (B<True>, |
706 | option B<-is>, the default), bold and italic font styles imply high |
816 | option B<-is>, the default), bold/blink font styles imply high |
707 | intensity foreground/backround colours. Disabling this option (B<False>, |
817 | intensity foreground/background colours. Disabling this option (B<False>, |
708 | option B<+is>) disables this behaviour, the high intensity colours are not |
818 | option B<+is>) disables this behaviour, the high intensity colours are not |
709 | reachable. |
819 | reachable. |
710 | |
|
|
711 | =item B<selectstyle:> I<mode> |
|
|
712 | |
|
|
713 | Set mouse selection style to B<old> which is 2.20, B<oldword> which is |
|
|
714 | xterm style with 2.20 old word selection, or anything else which gives |
|
|
715 | xterm style selection. |
|
|
716 | |
|
|
717 | =item B<scrollstyle:> I<mode> |
|
|
718 | |
|
|
719 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
|
|
720 | the author's favourite. |
|
|
721 | |
820 | |
722 | =item B<title:> I<string> |
821 | =item B<title:> I<string> |
723 | |
822 | |
724 | Set window title string, the default title is the command-line |
823 | Set window title string, the default title is the command-line |
725 | specified after the B<-e> option, if any, otherwise the application |
824 | specified after the B<-e> option, if any, otherwise the application |
… | |
… | |
734 | =item B<mapAlert:> I<boolean> |
833 | =item B<mapAlert:> I<boolean> |
735 | |
834 | |
736 | B<True>: de-iconify (map) on receipt of a bell character. B<False>: no |
835 | B<True>: de-iconify (map) on receipt of a bell character. B<False>: no |
737 | de-iconify (map) on receipt of a bell character [default]. |
836 | de-iconify (map) on receipt of a bell character [default]. |
738 | |
837 | |
|
|
838 | =item B<urgentOnBell:> I<boolean> |
|
|
839 | |
|
|
840 | B<True>: set the urgency hint for the wm on receipt of a bell character. |
|
|
841 | B<False>: do not set the urgency hint [default]. |
|
|
842 | |
739 | =item B<visualBell:> I<boolean> |
843 | =item B<visualBell:> I<boolean> |
740 | |
844 | |
741 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
845 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
742 | B<False>: no visual bell [default]; option B<+vb>. |
846 | B<False>: no visual bell [default]; option B<+vb>. |
743 | |
847 | |
… | |
… | |
764 | Example: |
868 | Example: |
765 | |
869 | |
766 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
870 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
767 | |
871 | |
768 | This creates a new file in your home directory with the screen contents |
872 | This creates a new file in your home directory with the screen contents |
769 | everytime you hit C<Print>. |
873 | every time you hit C<Print>. |
|
|
874 | |
|
|
875 | =item B<scrollstyle:> I<mode> |
|
|
876 | |
|
|
877 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
|
|
878 | the author's favourite. |
770 | |
879 | |
771 | =item B<scrollBar:> I<boolean> |
880 | =item B<scrollBar:> I<boolean> |
772 | |
881 | |
773 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
882 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
774 | disable the scrollbar; option B<+sb>. |
883 | disable the scrollbar; option B<+sb>. |
… | |
… | |
796 | |
905 | |
797 | =item B<scrollWithBuffer:> I<boolean> |
906 | =item B<scrollWithBuffer:> I<boolean> |
798 | |
907 | |
799 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
908 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
800 | B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll |
909 | B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll |
801 | with scrollback buffer when tty recieves new lines; option B<+sw>. |
910 | with scrollback buffer when tty receives new lines; option B<+sw>. |
802 | |
911 | |
803 | =item B<scrollTtyKeypress:> I<boolean> |
912 | =item B<scrollTtyKeypress:> I<boolean> |
804 | |
913 | |
805 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
914 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
806 | are those which are intercepted by rxvt-unicode for special handling and |
915 | are those which are intercepted by rxvt-unicode for special handling and |
… | |
… | |
837 | =item B<termName:> I<termname> |
946 | =item B<termName:> I<termname> |
838 | |
947 | |
839 | Specifies the terminal type name to be set in the B<TERM> environment |
948 | Specifies the terminal type name to be set in the B<TERM> environment |
840 | variable; option B<-tn>. |
949 | variable; option B<-tn>. |
841 | |
950 | |
842 | =item B<linespace:> I<number> |
951 | =item B<lineSpace:> I<number> |
843 | |
952 | |
844 | Specifies number of lines (pixel height) to insert between each row of |
953 | Specifies number of lines (pixel height) to insert between each row of |
845 | the display [default 0]; option B<-lsp>. |
954 | the display [default 0]; option B<-lsp>. |
846 | |
955 | |
847 | =item B<meta8:> I<boolean> |
956 | =item B<meta8:> I<boolean> |
… | |
… | |
896 | pressed. If unset it will send the sequence traditionally associated |
1005 | pressed. If unset it will send the sequence traditionally associated |
897 | with the B<Execute> key. |
1006 | with the B<Execute> key. |
898 | |
1007 | |
899 | =item B<cutchars:> I<string> |
1008 | =item B<cutchars:> I<string> |
900 | |
1009 | |
901 | The characters used as delimiters for double-click word selection. The |
1010 | The characters used as delimiters for double-click word selection |
902 | built-in default: |
1011 | (whitespace delimiting is added automatically if resource is given). |
903 | |
1012 | |
|
|
1013 | When the perl selection extension is in use (the default if compiled |
|
|
1014 | in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these |
|
|
1015 | characters will be created (if the resource exists, otherwise, no regex |
|
|
1016 | will be created). In this mode, characters outside ISO-8859-1 can be used. |
|
|
1017 | |
|
|
1018 | When the selection extension is not used, only ISO-8859-1 characters can |
|
|
1019 | be used. If not specified, the built-in default is used: |
|
|
1020 | |
904 | B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> |
1021 | B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> |
905 | |
1022 | |
906 | =item B<preeditType:> I<style> |
1023 | =item B<preeditType:> I<style> |
907 | |
1024 | |
908 | B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. |
1025 | B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. |
909 | |
1026 | |
… | |
… | |
963 | |
1080 | |
964 | Turn on/off secondary screen (default enabled). |
1081 | Turn on/off secondary screen (default enabled). |
965 | |
1082 | |
966 | =item B<secondaryScroll:> I<boolean> |
1083 | =item B<secondaryScroll:> I<boolean> |
967 | |
1084 | |
968 | Turn on/off secondary screen scroll (default enabled). If the this |
1085 | Turn on/off secondary screen scroll (default enabled). If this |
969 | option is enabled, scrolls on the secondary screen will change the |
1086 | option is enabled, scrolls on the secondary screen will change the |
970 | scrollback buffer and switching to/from the secondary screen will |
1087 | scrollback buffer and switching to/from the secondary screen will |
971 | instead scroll the screen up. |
1088 | instead scroll the screen up. |
972 | |
1089 | |
973 | =item B<hold>: I<boolean> |
1090 | =item B<hold>: I<boolean> |
… | |
… | |
997 | searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and |
1114 | searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and |
998 | omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex |
1115 | omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex |
999 | keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not |
1116 | keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not |
1000 | performed in an exact manner; however, the closest match is assured. |
1117 | performed in an exact manner; however, the closest match is assured. |
1001 | |
1118 | |
1002 | I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, |
1119 | I<string> may contain escape values (C<\n>: newline, C<\000>: octal |
1003 | C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, |
1120 | number), see RESOURCES in C<man 7 X> for futher details. |
1004 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
|
|
1005 | C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it |
|
|
1006 | can start or end with whitespace. |
|
|
1007 | |
|
|
1008 | Please note that you need to double the C<\> in resource files, as |
|
|
1009 | Xlib itself does it's own de-escaping (you can use C<\033> instead of |
|
|
1010 | C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own |
|
|
1011 | processing). |
|
|
1012 | |
1121 | |
1013 | You can define a range of keysyms in one shot by providing a I<string> |
1122 | You can define a range of keysyms in one shot by providing a I<string> |
1014 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' |
1123 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' |
1015 | should be a character not used by the strings. |
1124 | should be a character not used by the strings. |
1016 | |
1125 | |
1017 | Its usage can be demonstrated by an example: |
1126 | Its usage can be demonstrated by an example: |
1018 | |
1127 | |
1019 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
1128 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
… | |
… | |
1083 | example, C<default,-selection> will use all the default extension except |
1192 | example, C<default,-selection> will use all the default extension except |
1084 | C<selection>. |
1193 | C<selection>. |
1085 | |
1194 | |
1086 | Extension names can also be followed by an argument in angle brackets |
1195 | Extension names can also be followed by an argument in angle brackets |
1087 | (e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for |
1196 | (e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for |
1088 | searchable scorllback to Alt/Meta-s). Mentioning the same extension |
1197 | searchable scrollback to Alt/Meta-s). Mentioning the same extension |
1089 | multiple times with different arguments will pass multiple arguments to |
1198 | multiple times with different arguments will pass multiple arguments to |
1090 | the extension. |
1199 | the extension. |
1091 | |
1200 | |
1092 | Each extension is looked up in the library directories, loaded if |
1201 | Each extension is looked up in the library directories, loaded if |
1093 | necessary, and bound to the current terminal instance. |
1202 | necessary, and bound to the current terminal instance. |
… | |
… | |
1129 | (default: C<M-s>). |
1238 | (default: C<M-s>). |
1130 | |
1239 | |
1131 | =item B<urlLauncher>: I<string> |
1240 | =item B<urlLauncher>: I<string> |
1132 | |
1241 | |
1133 | Specifies the program to be started with a URL argument. Used by the |
1242 | Specifies the program to be started with a URL argument. Used by the |
1134 | C<selection-popup> and C<mark-urls> perl extensions. |
1243 | C<selection-popup> and C<matcher> perl extensions. |
1135 | |
1244 | |
1136 | =item B<transient-for>: I<windowid> |
1245 | =item B<transient-for>: I<windowid> |
1137 | |
1246 | |
1138 | Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. |
1247 | Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. |
1139 | |
1248 | |
1140 | =item B<override-redirect>: I<boolean> |
1249 | =item B<override-redirect>: I<boolean> |
1141 | |
1250 | |
1142 | Compile I<frills>: Sets override-redirect for the terminal window, making |
1251 | Compile I<frills>: Sets override-redirect for the terminal window, making |
1143 | it almost invisible to window managers; option B<-override-redirect>. |
1252 | it almost invisible to window managers; option B<-override-redirect>. |
|
|
1253 | |
|
|
1254 | =item B<iso14755_52:> I<boolean> |
|
|
1255 | |
|
|
1256 | Turn on/off ISO 14755 5.2 mode (default enabled). |
1144 | |
1257 | |
1145 | =back |
1258 | =back |
1146 | |
1259 | |
1147 | =head1 THE SCROLLBAR |
1260 | =head1 THE SCROLLBAR |
1148 | |
1261 | |
… | |
… | |
1167 | application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> |
1280 | application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> |
1168 | (Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the |
1281 | (Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the |
1169 | up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), |
1282 | up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), |
1170 | respectively. |
1283 | respectively. |
1171 | |
1284 | |
1172 | =head1 TEXT SELECTION AND INSERTION |
1285 | =head1 THE SELECTION: SELECTING AND PASTING TEXT |
1173 | |
1286 | |
1174 | The behaviour of text selection and insertion mechanism is similar to |
1287 | The behaviour of text selection and insertion/pasting mechanism is similar |
1175 | I<xterm>(1). |
1288 | to I<xterm>(1). |
1176 | |
1289 | |
1177 | =over 4 |
1290 | =over 4 |
1178 | |
1291 | |
1179 | =item B<Selection>: |
1292 | =item B<Selecting>: |
1180 | |
1293 | |
1181 | Left click at the beginning of the region, drag to the end of the region |
1294 | Left click at the beginning of the region, drag to the end of the region |
1182 | and release; Right click to extend the marked region; Left double-click |
1295 | and release; Right click to extend the marked region; Left double-click |
1183 | to select a word; Left triple-click to select the entire logical line |
1296 | to select a word; Left triple-click to select the entire logical line |
1184 | (which can span multiple screen lines), unless modified by resource |
1297 | (which can span multiple screen lines), unless modified by resource |
… | |
… | |
1188 | (Compile: I<frills>) will create a rectangular selection instead of a |
1301 | (Compile: I<frills>) will create a rectangular selection instead of a |
1189 | normal one. In this mode, every selected row becomes its own line in the |
1302 | normal one. In this mode, every selected row becomes its own line in the |
1190 | selection, and trailing whitespace is visually underlined and removed from |
1303 | selection, and trailing whitespace is visually underlined and removed from |
1191 | the selection. |
1304 | the selection. |
1192 | |
1305 | |
1193 | =item B<Insertion>: |
1306 | =item B<Pasting>: |
1194 | |
1307 | |
1195 | Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in |
1308 | Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> |
1196 | an B<@@RXVT_NAME@@> window causes the current text selection to be |
1309 | window causes the value of the PRIMARY selection (or CLIPBOARD with the |
1197 | inserted as if it had been typed on the keyboard. |
1310 | B<Meta> modifier) to be inserted as if it had been typed on the keyboard. |
|
|
1311 | |
|
|
1312 | Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be |
|
|
1313 | inserted too. |
1198 | |
1314 | |
1199 | =back |
1315 | =back |
1200 | |
1316 | |
1201 | =head1 CHANGING FONTS |
1317 | =head1 CHANGING FONTS |
1202 | |
1318 | |
… | |
… | |
1216 | |
1332 | |
1217 | =head1 ISO 14755 SUPPORT |
1333 | =head1 ISO 14755 SUPPORT |
1218 | |
1334 | |
1219 | ISO 14755 is a standard for entering and viewing unicode characters |
1335 | ISO 14755 is a standard for entering and viewing unicode characters |
1220 | and character codes using the keyboard. It consists of 4 parts. The |
1336 | and character codes using the keyboard. It consists of 4 parts. The |
1221 | first part is available rxvt-unicode has been compiled with |
1337 | first part is available if rxvt-unicode has been compiled with |
1222 | C<--enable-frills>, the rest is available when rxvt-unicode was compiled |
1338 | C<--enable-frills>, the rest is available when rxvt-unicode was compiled |
1223 | with C<--enable-iso14755>. |
1339 | with C<--enable-iso14755>. |
1224 | |
1340 | |
1225 | =over 4 |
1341 | =over 4 |
1226 | |
1342 | |
… | |
… | |
1246 | This mode lets you input characters representing the keycap symbols of |
1362 | This mode lets you input characters representing the keycap symbols of |
1247 | your keyboard, if representable in the current locale encoding. |
1363 | your keyboard, if representable in the current locale encoding. |
1248 | |
1364 | |
1249 | Start by pressing C<Control> and C<Shift> together, then releasing |
1365 | Start by pressing C<Control> and C<Shift> together, then releasing |
1250 | them. The next special key (cursor keys, home etc.) you enter will not |
1366 | them. The next special key (cursor keys, home etc.) you enter will not |
1251 | invoke it's usual function but instead will insert the corresponding |
1367 | invoke its usual function but instead will insert the corresponding |
1252 | keycap symbol. The symbol will only be entered when the key has been |
1368 | keycap symbol. The symbol will only be entered when the key has been |
1253 | released, otherwise pressing e.g. C<Shift> would enter the symbol for |
1369 | released, otherwise pressing e.g. C<Shift> would enter the symbol for |
1254 | C<ISO Level 2 Switch>, although your intention might have been to enter a |
1370 | C<ISO Level 2 Switch>, although your intention might have been to enter a |
1255 | reverse tab (Shift-Tab). |
1371 | reverse tab (Shift-Tab). |
1256 | |
1372 | |
… | |
… | |
1289 | =head1 COLORS AND GRAPHICS |
1405 | =head1 COLORS AND GRAPHICS |
1290 | |
1406 | |
1291 | In addition to the default foreground and background colours, |
1407 | In addition to the default foreground and background colours, |
1292 | B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus |
1408 | B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus |
1293 | high-intensity bold/blink versions of the same). Here is a list of the |
1409 | high-intensity bold/blink versions of the same). Here is a list of the |
1294 | colours with their B<rgb.txt> names. |
1410 | colours with their names. |
1295 | |
1411 | |
1296 | =begin table |
1412 | =begin table |
1297 | |
1413 | |
1298 | B<color0> (black) = Black |
1414 | B<color0> (black) = Black |
1299 | B<color1> (red) = Red3 |
1415 | B<color1> (red) = Red3 |
… | |
… | |
1319 | It is also possible to specify the colour values of B<foreground>, |
1435 | It is also possible to specify the colour values of B<foreground>, |
1320 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1436 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1321 | a number 0-15, as a convenient shorthand to reference the colour name of |
1437 | a number 0-15, as a convenient shorthand to reference the colour name of |
1322 | color0-color15. |
1438 | color0-color15. |
1323 | |
1439 | |
|
|
1440 | In addition to the colours defined above, @@RXVT_NAME@@ offers an |
|
|
1441 | additional 72 colours. The first 64 of those (with indices 16 to 79) |
|
|
1442 | consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b + |
|
|
1443 | 16>), followed by 8 additional shades of gray (with indices 80 to 87). |
|
|
1444 | |
|
|
1445 | Together, all those colours implement the 88 colour xterm colours. Only |
|
|
1446 | the first 16 can be changed using resources currently, the rest can only |
|
|
1447 | be changed via command sequences ("escape codes"). |
|
|
1448 | |
1324 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1449 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1325 | always swapping the foreground/background colours. This is in contrast to |
1450 | always swapping the foreground/background colours. This is in contrast to |
1326 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1451 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1327 | been specified. For example, |
1452 | been specified. For example, |
1328 | |
1453 | |
… | |
… | |
1333 | would yield White on Black, while on I<xterm>(1) it would yield Black |
1458 | would yield White on Black, while on I<xterm>(1) it would yield Black |
1334 | on White. |
1459 | on White. |
1335 | |
1460 | |
1336 | =back |
1461 | =back |
1337 | |
1462 | |
|
|
1463 | =head2 ALPHA CHANNEL SUPPORT |
|
|
1464 | |
|
|
1465 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
|
|
1466 | their act together, rxvt-unicode will do it's own alpha channel management: |
|
|
1467 | |
|
|
1468 | You can prefix any color with an opaquenes percentage enclosed in |
|
|
1469 | brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage |
|
|
1470 | (0-100) that specifies the opacity of the color, where C<0> is completely |
|
|
1471 | transparent and C<100> is completely opaque. For example, C<[50]red> is a |
|
|
1472 | half-transparent red, while C<[95]#00ff00> is an almost opaque green. This |
|
|
1473 | is the recommended format to specify transparency values, and works with |
|
|
1474 | all ways to specify a colour. |
|
|
1475 | |
|
|
1476 | For complete control, rxvt-unicode also supports |
|
|
1477 | C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour |
|
|
1478 | specifications, where the additional C<aaaa> component specifies opacity |
|
|
1479 | (alpha) values. The minimum value of C<0000> is completely transparent, |
|
|
1480 | while C<ffff> is completely opaque). The two example colours from |
|
|
1481 | earlier could also be specified as C<rgba:ff00/0000/0000/8000> and |
|
|
1482 | C<rgba:0000/ff00/0000/f332>. |
|
|
1483 | |
|
|
1484 | You probably need to specify B<"-depth 32">, too, to force a visual with |
|
|
1485 | alpha channels, and have the luck that your X-server uses ARGB pixel |
|
|
1486 | layout, as X is far from just supporting ARGB visuals out of the box, and |
|
|
1487 | rxvt-unicode just fudges around. |
|
|
1488 | |
|
|
1489 | For example, the following selects an almost completely transparent black |
|
|
1490 | background, and an almost opaque pink foreground: |
|
|
1491 | |
|
|
1492 | @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink" |
|
|
1493 | |
|
|
1494 | When not using a background image, then the interpretation of the |
|
|
1495 | alpha channel is up to your compositing manager (most interpret it as |
|
|
1496 | transparency of course). |
|
|
1497 | |
|
|
1498 | When using a background pixmap or pseudo-transparency, then the background |
|
|
1499 | colour will always behave as if it were completely transparent (so the |
|
|
1500 | background image shows instead), regardless of how it was specified, while |
|
|
1501 | other colours will either be transparent as specified (the background |
|
|
1502 | image will show through) on servers supporting the RENDER extension, or |
|
|
1503 | fully opaque on servers not supporting the RENDER EXTENSION. |
|
|
1504 | |
|
|
1505 | Please note that due to bugs in Xft, specifying alpha values might result |
|
|
1506 | in garbage being displayed when the X-server does not support the RENDER |
|
|
1507 | extension. |
|
|
1508 | |
1338 | =head1 ENVIRONMENT |
1509 | =head1 ENVIRONMENT |
1339 | |
1510 | |
1340 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1511 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1341 | |
1512 | |
1342 | =over 4 |
1513 | =over 4 |
1343 | |
1514 | |
1344 | =item B<TERM> |
1515 | =item B<TERM> |
1345 | |
1516 | |
1346 | Normally set to C<rxvt-unicode>, unless overwritten at configure time, via |
1517 | Normally set to C<rxvt-unicode>, unless overwritten at configure time, via |
1347 | resources or on the commandline. |
1518 | resources or on the command line. |
1348 | |
1519 | |
1349 | =item B<COLORTERM> |
1520 | =item B<COLORTERM> |
1350 | |
1521 | |
1351 | Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was |
1522 | Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was |
1352 | compiled with XPM support, and optionally with the added extension |
1523 | compiled with background image support, and optionally with the added |
1353 | C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. |
1524 | extension C<-mono> to indicate that rxvt-unicode runs on a monochrome |
|
|
1525 | screen. |
1354 | |
1526 | |
1355 | =item B<COLORFGBG> |
1527 | =item B<COLORFGBG> |
1356 | |
1528 | |
1357 | Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is |
1529 | Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is |
1358 | the colour code used as default foreground/text colour (or the string |
1530 | the colour code used as default foreground/text colour (or the string |
1359 | C<default> to indicate that the default-colour escape sequence is to be |
1531 | C<default> to indicate that the default-colour escape sequence is to be |
1360 | used), C<bg> is the colour code used as default background colour (or the |
1532 | used), C<bg> is the colour code used as default background colour (or the |
1361 | string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ |
1533 | string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ |
1362 | was compiled with XPM support. Libraries like C<ncurses> and C<slang> can |
1534 | was compiled with background image support. Libraries like C<ncurses> |
1363 | (and do) use this information to optimize screen output. |
1535 | and C<slang> can (and do) use this information to optimize screen output. |
1364 | |
1536 | |
1365 | =item B<WINDOWID> |
1537 | =item B<WINDOWID> |
1366 | |
1538 | |
1367 | Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel |
1539 | Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel |
1368 | window, which usually has subwindows for the scrollbar, the terminal |
1540 | window, which usually has subwindows for the scrollbar, the terminal |
… | |
… | |
1374 | C<--with-terminfo=PATH>. |
1546 | C<--with-terminfo=PATH>. |
1375 | |
1547 | |
1376 | =item B<DISPLAY> |
1548 | =item B<DISPLAY> |
1377 | |
1549 | |
1378 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1550 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1379 | display in it's child processes. |
1551 | display in its child processes. |
1380 | |
1552 | |
1381 | =item B<SHELL> |
1553 | =item B<SHELL> |
1382 | |
1554 | |
1383 | The shell to be used for command execution, defaults to C</bin/sh>. |
1555 | The shell to be used for command execution, defaults to C</bin/sh>. |
1384 | |
1556 | |
… | |
… | |
1426 | |
1598 | |
1427 | =item Project Coordinator |
1599 | =item Project Coordinator |
1428 | |
1600 | |
1429 | Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1601 | Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1430 | |
1602 | |
1431 | L<http://software.schmorp.de/#rxvt-unicode> |
1603 | L<http://software.schmorp.de/pkg/rxvt-unicode.html> |
1432 | |
1604 | |
1433 | =back |
1605 | =back |
1434 | |
1606 | |
1435 | =head1 AUTHORS |
1607 | =head1 AUTHORS |
1436 | |
1608 | |
… | |
… | |
1459 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1631 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1460 | |
1632 | |
1461 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1633 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1462 | |
1634 | |
1463 | Rewrote screen display and text selection routines. |
1635 | Rewrote screen display and text selection routines. |
1464 | |
1636 | |
1465 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1637 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1466 | |
1638 | |
1467 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1639 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1468 | |
1640 | |
1469 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |
1641 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |