… | |
… | |
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 |
… | |
… | |
89 | |
92 | |
90 | Print out a message describing available options. |
93 | Print out a message describing available options. |
91 | |
94 | |
92 | =item B<-display> I<displayname> |
95 | =item B<-display> I<displayname> |
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 (the older form B<-d> |
95 | respected). In the absence of this option, the display specified by the |
98 | is still respected. but deprecated). In the absence of this option, the |
96 | B<DISPLAY> environment variable is used. |
99 | display specified by the B<DISPLAY> environment variable is used. |
97 | |
100 | |
98 | =item B<-depth> I<bitdepth> |
101 | =item B<-depth> I<bitdepth> |
99 | |
102 | |
100 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
103 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
101 | resource B<depth>. |
104 | resource B<depth>. |
102 | |
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 | |
103 | =item B<-geometry> I<geom> |
111 | =item B<-geometry> I<geom> |
104 | |
112 | |
105 | Window geometry (B<-g> still respected); resource B<geometry>. |
113 | Window geometry (B<-g> still respected); resource B<geometry>. |
106 | |
114 | |
107 | =item B<-rv>|B<+rv> |
115 | =item B<-rv>|B<+rv> |
108 | |
116 | |
109 | Turn on/off simulated reverse video; resource B<reverseVideo>. |
117 | Turn on/off simulated reverse video; resource B<reverseVideo>. |
110 | |
118 | |
111 | =item B<-j>|B<+j> |
119 | =item B<-j>|B<+j> |
112 | |
120 | |
113 | Turn on/off jump scrolling; resource B<jumpScroll>. |
121 | Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. |
114 | |
122 | |
115 | =item B<-ip>|B<+ip> | B<-tr>|B<+tr> |
123 | =item B<-ss>|B<+ss> |
116 | |
124 | |
117 | 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>. |
118 | 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@@)!> |
119 | |
136 | |
120 | =item B<-fade> I<number> |
137 | =item B<-fade> I<number> |
121 | |
138 | |
122 | 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 |
123 | 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 |
124 | colour; resource B<fading>. |
141 | colour; resource B<fading>. |
125 | |
142 | |
126 | =item B<-fadecolor> I<colour> |
143 | =item B<-fadecolor> I<colour> |
127 | |
144 | |
128 | 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 |
129 | is black. resource B<fadeColor>. |
146 | is opaque black. resource B<fadeColor>. |
130 | |
147 | |
131 | =item B<-tint> I<colour> |
148 | =item B<-tint> I<colour> |
132 | |
149 | |
133 | Tint the transparent background pixmap with the given colour when |
150 | Tint the transparent background pixmap with the given colour when |
134 | transparency is enabled with B<-tr> or B<-ip>. This only works for |
151 | transparency is enabled with B<-tr>. This only works for |
135 | 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 |
136 | 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 colours essentially mean no tinting; resource |
137 | I<tintColor>. Example: |
158 | I<tintColor>. Example: |
138 | |
159 | |
139 | @@RXVT_NAME@@ -tr -tint blue -sh 40 |
160 | @@RXVT_NAME@@ -tr -tint blue -sh 40 |
140 | |
161 | |
141 | =item B<-sh> |
162 | =item B<-sh> I<number> |
142 | |
163 | |
143 | I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
164 | Darken (0 .. 100) or lighten (100 .. 200) the transparent |
144 | background image in addition to tinting it (i.e. B<-tint> must be |
165 | background image in addition to (or instead of) tinting it; |
145 | 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> - colour 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>. |
|
|
186 | |
|
|
187 | =item B<-icon> I<file> |
|
|
188 | |
|
|
189 | Compile I<afterimage>: Use the specified image as application icon. This |
|
|
190 | is used by many window managers, taskbars and pagers to represent the |
|
|
191 | application window; resource I<iconFile>. |
146 | |
192 | |
147 | =item B<-bg> I<colour> |
193 | =item B<-bg> I<colour> |
148 | |
194 | |
149 | Window background colour; resource B<background>. |
195 | Window background colour; resource B<background>. |
150 | |
196 | |
151 | =item B<-fg> I<colour> |
197 | =item B<-fg> I<colour> |
152 | |
198 | |
153 | Window foreground colour; resource B<foreground>. |
199 | Window foreground colour; resource B<foreground>. |
154 | |
200 | |
155 | =item B<-pixmap> I<file[;geom]> |
201 | =item B<-pixmap> I<file[;geom[:op1][:op2][...]]> |
156 | |
202 | |
157 | Compile I<XPM>: Specify XPM file for the background and also optionally |
203 | Compile I<afterimage>: Specify image file for the background and also |
158 | specify its scaling with a geometry string. Note you may need to |
204 | optionally specify its scaling with a geometry string. Note you may need to |
159 | add quotes to avoid special shell interpretation of the C<;> in the |
205 | add quotes to avoid special shell interpretation of the C<;> in the |
160 | command-line; resource B<backgroundPixmap>. |
206 | command-line; for more details see resource B<backgroundPixmap>. |
161 | |
207 | |
162 | =item B<-cr> I<colour> |
208 | =item B<-cr> I<colour> |
163 | |
209 | |
164 | The cursor colour; resource B<cursorColor>. |
210 | The cursor colour; resource B<cursorColor>. |
165 | |
211 | |
… | |
… | |
182 | that are checked in order when trying to find glyphs for characters. The |
228 | that are checked in order when trying to find glyphs for characters. The |
183 | first font defines the cell size for characters; other fonts might be |
229 | first font defines the cell size for characters; other fonts might be |
184 | smaller, but not (in general) larger. A (hopefully) reasonable default |
230 | smaller, but not (in general) larger. A (hopefully) reasonable default |
185 | font list is always appended to it. See resource B<font> for more details. |
231 | font list is always appended to it. See resource B<font> for more details. |
186 | |
232 | |
187 | In short, to specify an X11 core font, just specify it's name or prefix it |
233 | In short, to specify an X11 core font, just specify its name or prefix it |
188 | with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, |
234 | with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, |
189 | e.g.: |
235 | e.g.: |
190 | |
236 | |
191 | @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
237 | @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
192 | @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
238 | @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
… | |
… | |
210 | italic> >> characters are to be printed. See resource B<boldItalicFont> |
256 | italic> >> characters are to be printed. See resource B<boldItalicFont> |
211 | for details. |
257 | for details. |
212 | |
258 | |
213 | =item B<-is>|B<+is> |
259 | =item B<-is>|B<+is> |
214 | |
260 | |
215 | Compile I<font-styles>: Bold/Italic font styles imply high intensity |
261 | Compile I<font-styles>: Bold/Blink font styles imply high intensity |
216 | foreground/background (default). See resource B<intensityStyles> for |
262 | foreground/background (default). See resource B<intensityStyles> for |
217 | details. |
263 | details. |
218 | |
264 | |
219 | =item B<-name> I<name> |
265 | =item B<-name> I<name> |
220 | |
266 | |
… | |
… | |
238 | |
284 | |
239 | =item B<-sb>|B<+sb> |
285 | =item B<-sb>|B<+sb> |
240 | |
286 | |
241 | Turn on/off scrollbar; resource B<scrollBar>. |
287 | Turn on/off scrollbar; resource B<scrollBar>. |
242 | |
288 | |
|
|
289 | =item B<-sr>|B<+sr> |
|
|
290 | |
|
|
291 | Put scrollbar on right/left; resource B<scrollBar_right>. |
|
|
292 | |
|
|
293 | =item B<-st>|B<+st> |
|
|
294 | |
|
|
295 | Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; |
|
|
296 | resource B<scrollBar_floating>. |
|
|
297 | |
243 | =item B<-si>|B<+si> |
298 | =item B<-si>|B<+si> |
244 | |
299 | |
245 | Turn on/off scroll-to-bottom on TTY output inhibit; resource |
300 | Turn on/off scroll-to-bottom on TTY output inhibit; resource |
246 | B<scrollTtyOutput> has opposite effect. |
301 | B<scrollTtyOutput> has opposite effect. |
247 | |
302 | |
… | |
… | |
253 | =item B<-sw>|B<+sw> |
308 | =item B<-sw>|B<+sw> |
254 | |
309 | |
255 | Turn on/off scrolling with the scrollback buffer as new lines appear. |
310 | Turn on/off scrolling with the scrollback buffer as new lines appear. |
256 | This only takes effect if B<-si> is also given; resource |
311 | This only takes effect if B<-si> is also given; resource |
257 | B<scrollWithBuffer>. |
312 | B<scrollWithBuffer>. |
258 | |
|
|
259 | =item B<-sr>|B<+sr> |
|
|
260 | |
|
|
261 | Put scrollbar on right/left; resource B<scrollBar_right>. |
|
|
262 | |
|
|
263 | =item B<-st>|B<+st> |
|
|
264 | |
|
|
265 | Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; |
|
|
266 | resource B<scrollBar_floating>. |
|
|
267 | |
313 | |
268 | =item B<-ptab>|B<+ptab> |
314 | =item B<-ptab>|B<+ptab> |
269 | |
315 | |
270 | If enabled (default), "Horizontal Tab" characters are being stored as |
316 | If enabled (default), "Horizontal Tab" characters are being stored as |
271 | actual wide characters in the screen buffer, which makes it possible to |
317 | actual wide characters in the screen buffer, which makes it possible to |
… | |
… | |
275 | |
321 | |
276 | =item B<-bc>|B<+bc> |
322 | =item B<-bc>|B<+bc> |
277 | |
323 | |
278 | Blink the cursor; resource B<cursorBlink>. |
324 | Blink the cursor; resource B<cursorBlink>. |
279 | |
325 | |
|
|
326 | =item B<-uc>|B<+uc> |
|
|
327 | |
|
|
328 | Make the cursor underlined; resource B<cursorUnderline>. |
|
|
329 | |
280 | =item B<-iconic> |
330 | =item B<-iconic> |
281 | |
331 | |
282 | Start iconified, if the window manager supports that option. |
332 | Start iconified, if the window manager supports that option. |
283 | Alternative form is B<-ic>. |
333 | Alternative form is B<-ic>. |
284 | |
334 | |
… | |
… | |
300 | |
350 | |
301 | =item B<-bl> |
351 | =item B<-bl> |
302 | |
352 | |
303 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
353 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
304 | if honoured by the WM, the rxvt-unicode window will not have window |
354 | if honoured by the WM, the rxvt-unicode window will not have window |
305 | decorations; resource B<borderLess>. |
355 | decorations; resource B<borderLess>. If the window manager does not |
|
|
356 | support MWM hints (e.g. kwin), enables override-redirect mode. |
306 | |
357 | |
307 | =item B<-override-redirect> |
358 | =item B<-override-redirect> |
308 | |
359 | |
309 | Compile I<frills>: Sets override-redirect on the window; resource |
360 | Compile I<frills>: Sets override-redirect on the window; resource |
310 | B<override-redirect>. |
361 | B<override-redirect>. |
… | |
… | |
318 | |
369 | |
319 | =item B<-lsp> I<number> |
370 | =item B<-lsp> I<number> |
320 | |
371 | |
321 | Compile I<frills>: Lines (pixel height) to insert between each row of |
372 | Compile I<frills>: Lines (pixel height) to insert between each row of |
322 | the display. Useful to work around font rendering problems; resource |
373 | the display. Useful to work around font rendering problems; resource |
323 | B<linespace>. |
374 | B<lineSpace>. |
|
|
375 | |
|
|
376 | =item B<-letsp> I<number> |
|
|
377 | |
|
|
378 | Compile I<frills>: Amount to adjust the computed character width by |
|
|
379 | to control overall letter spacing. Negative values will tighten up the |
|
|
380 | letter spacing, positive values will space letters out more. Useful to |
|
|
381 | work around odd font metrics; resource B<letterSpace>. |
324 | |
382 | |
325 | =item B<-tn> I<termname> |
383 | =item B<-tn> I<termname> |
326 | |
384 | |
327 | This option specifies the name of the terminal type to be set in the |
385 | This option specifies the name of the terminal type to be set in the |
328 | B<TERM> environment variable. This terminal type must exist in the |
386 | B<TERM> environment variable. This terminal type must exist in the |
… | |
… | |
382 | for more info. |
440 | for more info. |
383 | |
441 | |
384 | =item B<-tcw> |
442 | =item B<-tcw> |
385 | |
443 | |
386 | Change the meaning of triple-click selection with the left mouse |
444 | Change the meaning of triple-click selection with the left mouse |
|
|
445 | button. Only effective when the original (non-perl) selection code is |
387 | button. Instead of selecting a full line it will extend the selection the |
446 | in-use. Instead of selecting a full line it will extend the selection to |
388 | end of the logical line only. resource B<tripleclickwords>. |
447 | the end of the logical line only. resource B<tripleclickwords>. |
389 | |
448 | |
390 | =item B<-insecure> |
449 | =item B<-insecure> |
391 | |
450 | |
392 | Enable "insecure" mode, which currently enables most of the escape |
451 | Enable "insecure" mode, which currently enables most of the escape |
393 | sequences that echo strings. See the resource B<insecure> for more |
452 | sequences that echo strings. See the resource B<insecure> for more |
… | |
… | |
414 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
473 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
415 | will not immediately destroy its window when the program executed within |
474 | will not immediately destroy its window when the program executed within |
416 | it exits. Instead, it will wait till it is being killed or closed by the |
475 | it exits. Instead, it will wait till it is being killed or closed by the |
417 | user; resource B<hold>. |
476 | user; resource B<hold>. |
418 | |
477 | |
|
|
478 | =item B<-cd> I<path> |
|
|
479 | |
|
|
480 | Sets the working directory for the shell (or the command specified via |
|
|
481 | B<-e>). The I<path> must be an absolute path and it must exist for |
|
|
482 | @@RXVT_NAME@@ to start; resource B<chdir>. |
|
|
483 | |
|
|
484 | =item B<-xrm> I<string> |
|
|
485 | |
|
|
486 | Works like the X Toolkit option of the same name, by adding the I<string> |
|
|
487 | as if it were specified in a resource file. Resource values specified this |
|
|
488 | way take precedence over all other resource specifications. |
|
|
489 | |
|
|
490 | Note that you need to use the I<same> syntax as in the .Xdefaults file, |
|
|
491 | e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific |
|
|
492 | options can be specified as long-options on the commandline, so use |
|
|
493 | of B<-xrm> is mostly limited to cases where you want to specify other |
|
|
494 | resources (e.g. for input methods) or for compatibility with other |
|
|
495 | programs. |
|
|
496 | |
419 | =item B<-keysym.>I<sym> I<string> |
497 | =item B<-keysym.>I<sym> I<string> |
420 | |
498 | |
421 | Remap a key symbol. See resource B<keysym>. |
499 | Remap a key symbol. See resource B<keysym>. |
422 | |
500 | |
423 | =item B<-embed> I<windowid> |
501 | =item B<-embed> I<windowid> |
424 | |
502 | |
425 | Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, |
503 | Tells @@RXVT_NAME@@ to embed its windows into an already-existing window, |
426 | which enables applications to easily embed a terminal. |
504 | which enables applications to easily embed a terminal. |
427 | |
505 | |
428 | Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it |
506 | Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it |
429 | shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it |
507 | shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it |
430 | quite a bit, so don't expect it to keep some specific state. It's best to |
508 | quite a bit, so don't expect it to keep some specific state. It's best to |
… | |
… | |
433 | The window will not be destroyed when @@RXVT_NAME@@ exits. |
511 | The window will not be destroyed when @@RXVT_NAME@@ exits. |
434 | |
512 | |
435 | It might be useful to know that @@RXVT_NAME@@ will not close file |
513 | It might be useful to know that @@RXVT_NAME@@ will not close file |
436 | descriptors passed to it (except for stdin/out/err, of course), so you |
514 | descriptors passed to it (except for stdin/out/err, of course), so you |
437 | can use file descriptors to communicate with the programs within the |
515 | can use file descriptors to communicate with the programs within the |
438 | terminal. This works regardless of wether the C<-embed> option was used or |
516 | terminal. This works regardless of whether the C<-embed> option was used or |
439 | not. |
517 | not. |
440 | |
518 | |
441 | Here is a short Gtk2-perl snippet that illustrates how this option can be |
519 | Here is a short Gtk2-perl snippet that illustrates how this option can be |
442 | used (a longer example is in F<doc/embed>): |
520 | used (a longer example is in F<doc/embed>): |
443 | |
521 | |
… | |
… | |
448 | }); |
526 | }); |
449 | |
527 | |
450 | =item B<-pty-fd> I<file descriptor> |
528 | =item B<-pty-fd> I<file descriptor> |
451 | |
529 | |
452 | Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty |
530 | Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty |
453 | pair but instead use the given filehandle as the tty master. This is |
531 | pair but instead use the given file descriptor as the tty master. This is |
454 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
532 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
455 | without having to run a program within it. |
533 | without having to run a program within it. |
456 | |
534 | |
457 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
535 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
458 | entries and will not tinker with pty/tty permissions - you have to do that |
536 | entries and will not tinker with pty/tty permissions - you have to do that |
459 | yourself if you want that. |
537 | yourself if you want that. |
460 | |
538 | |
461 | As an extremely special case, specifying C<-1> will completely suppress |
539 | As an extremely special case, specifying C<-1> will completely suppress |
462 | pty/tty operations. |
540 | pty/tty operations, which is probably only useful in conjunction with some |
|
|
541 | perl extension that manages the terminal. |
463 | |
542 | |
464 | Here is a example in perl that illustrates how this option can be used (a |
543 | Here is a example in perl that illustrates how this option can be used (a |
465 | longer example is in F<doc/pty-fd>): |
544 | longer example is in F<doc/pty-fd>): |
466 | |
545 | |
467 | use IO::Pty; |
546 | use IO::Pty; |
… | |
… | |
481 | Comma-separated list of perl extension scripts to use (or not to use) in |
560 | Comma-separated list of perl extension scripts to use (or not to use) in |
482 | this terminal instance. See resource B<perl-ext> for details. |
561 | this terminal instance. See resource B<perl-ext> for details. |
483 | |
562 | |
484 | =back |
563 | =back |
485 | |
564 | |
486 | =head1 RESOURCES (available also as long-options) |
565 | =head1 RESOURCES |
487 | |
566 | |
488 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
567 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
489 | options) compiled into your version. |
568 | options) compiled into your version. All resources are also available as |
|
|
569 | long-options. |
490 | |
570 | |
491 | You can set and change the resources using X11 tools like B<xrdb>. Many |
571 | You can set and change the resources using X11 tools like B<xrdb>. Many |
492 | distribution do also load settings from the B<~/.Xresources> file when X |
572 | distribution do also load settings from the B<~/.Xresources> file when X |
493 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
573 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
494 | with later settings overwriting earlier ones: |
574 | with later settings overwriting earlier ones: |
… | |
… | |
496 | 1. system-wide app-defaults file, either locale-dependent OR global |
576 | 1. system-wide app-defaults file, either locale-dependent OR global |
497 | 2. app-defaults file in $XAPPLRESDIR |
577 | 2. app-defaults file in $XAPPLRESDIR |
498 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
578 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
499 | 4. SCREEN_RESOURCES for the current screen |
579 | 4. SCREEN_RESOURCES for the current screen |
500 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
580 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
|
|
581 | 6. resources specified via -xrm on the commandline |
501 | |
582 | |
502 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
583 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
503 | names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
584 | names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
504 | common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily |
585 | common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily |
505 | configured, while the class name B<URxvt> allows resources unique to |
586 | configured, while the class name B<URxvt> allows resources unique to |
… | |
… | |
515 | =item B<depth:> I<bitdepth> |
596 | =item B<depth:> I<bitdepth> |
516 | |
597 | |
517 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
598 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
518 | option B<-depth>. |
599 | option B<-depth>. |
519 | |
600 | |
|
|
601 | =item B<buffered:> I<boolean> |
|
|
602 | |
|
|
603 | Compile I<xft>: Turn on/off double-buffering for xft (default enabled). |
|
|
604 | On some card/driver combination enabling it slightly decreases |
|
|
605 | performance, on most it greatly helps it. The slowdown is small, so it |
|
|
606 | should normally be enabled. |
|
|
607 | |
520 | =item B<geometry:> I<geom> |
608 | =item B<geometry:> I<geom> |
521 | |
609 | |
522 | Create the window with the specified X window geometry [default 80x24]; |
610 | Create the window with the specified X window geometry [default 80x24]; |
523 | option B<-geometry>. |
611 | option B<-geometry>. |
524 | |
612 | |
… | |
… | |
537 | Use the specified colour for the colour value I<n>, where 0-7 |
625 | Use the specified colour for the colour value I<n>, where 0-7 |
538 | corresponds to low-intensity (normal) colours and 8-15 corresponds to |
626 | corresponds to low-intensity (normal) colours and 8-15 corresponds to |
539 | high-intensity (bold = bright foreground, blink = bright background) |
627 | high-intensity (bold = bright foreground, blink = bright background) |
540 | colours. The canonical names are as follows: 0=black, 1=red, 2=green, |
628 | colours. The canonical names are as follows: 0=black, 1=red, 2=green, |
541 | 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour |
629 | 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour |
542 | names used are listed in the B<COLORS AND GRAPHICS> section. |
630 | names used are listed in the B<COLOURS AND GRAPHICS> section. |
543 | |
631 | |
544 | Colours higher than 15 cannot be set using resources (yet), but can be |
632 | Colours higher than 15 cannot be set using resources (yet), but can be |
545 | changed using an escape command (see @@RXVT_NAME@@(7)). |
633 | changed using an escape command (see @@RXVT_NAME@@(7)). |
546 | |
634 | |
547 | Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with |
635 | Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with |
… | |
… | |
558 | =item B<colorUL:> I<colour> |
646 | =item B<colorUL:> I<colour> |
559 | |
647 | |
560 | Use the specified colour to display underlined characters when the |
648 | Use the specified colour to display underlined characters when the |
561 | foreground colour is the default. |
649 | foreground colour is the default. |
562 | |
650 | |
563 | =item B<colorRV:> I<colour> |
|
|
564 | |
|
|
565 | Use the specified colour as the background for reverse video |
|
|
566 | characters. |
|
|
567 | |
|
|
568 | =item B<underlineColor:> I<colour> |
651 | =item B<underlineColor:> I<colour> |
569 | |
652 | |
570 | If set, use the specified colour as the colour for the underline |
653 | If set, use the specified colour as the colour for the underline |
571 | itself. If unset, use the foreground colour. |
654 | itself. If unset, use the foreground colour. |
|
|
655 | |
|
|
656 | =item B<highlightColor:> I<colour> |
|
|
657 | |
|
|
658 | If set, use the specified colour as the background for highlighted |
|
|
659 | characters. If unset, use reverse video. |
|
|
660 | |
|
|
661 | =item B<highlightTextColor:> I<colour> |
|
|
662 | |
|
|
663 | If set and highlightColor is set, use the specified colour as the |
|
|
664 | foreground for highlighted characters. |
572 | |
665 | |
573 | =item B<cursorColor:> I<colour> |
666 | =item B<cursorColor:> I<colour> |
574 | |
667 | |
575 | Use the specified colour for the cursor. The default is to use the |
668 | Use the specified colour for the cursor. The default is to use the |
576 | foreground colour; option B<-cr>. |
669 | foreground colour; option B<-cr>. |
… | |
… | |
583 | |
676 | |
584 | =item B<reverseVideo:> I<boolean> |
677 | =item B<reverseVideo:> I<boolean> |
585 | |
678 | |
586 | B<True>: simulate reverse video by foreground and background colours; |
679 | B<True>: simulate reverse video by foreground and background colours; |
587 | option B<-rv>. B<False>: regular screen colours [default]; option |
680 | option B<-rv>. B<False>: regular screen colours [default]; option |
588 | B<+rv>. See note in B<COLORS AND GRAPHICS> section. |
681 | B<+rv>. See note in B<COLOURS AND GRAPHICS> section. |
589 | |
682 | |
590 | =item B<jumpScroll:> I<boolean> |
683 | =item B<jumpScroll:> I<boolean> |
591 | |
684 | |
592 | B<True>: specify that jump scrolling should be used. When scrolling |
685 | B<True>: specify that jump scrolling should be used. When receiving lots |
593 | quickly, fewer screen updates are performed [default]; option B<-j>. |
686 | of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines |
|
|
687 | has been read, resulting in fewer updates while still displaying every |
|
|
688 | received line; option B<-j>. |
|
|
689 | |
594 | B<False>: specify that smooth scrolling should be used; option B<+j>. |
690 | B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will |
|
|
691 | force a screen refresh on each new line it received; option B<+j>. |
595 | |
692 | |
596 | =item B<inheritPixmap:> I<boolean> |
693 | =item B<skipScroll:> I<boolean> |
597 | |
694 | |
598 | B<True>: make the background inherit the parent windows' pixmap, giving |
695 | B<True>: (the default) specify that skip scrolling should be used. When |
599 | artificial transparency. B<False>: do not inherit the parent windows' |
696 | receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while |
600 | pixmap. |
697 | (around 60 times per second), resulting in far fewer updates. This can |
|
|
698 | result in @@RXVT_NAME@@ not ever displaying some of the lines it receives; |
|
|
699 | option B<-ss>. |
|
|
700 | |
|
|
701 | B<False>: specify that everything is to be displayed, even |
|
|
702 | if the refresh is too fast for the human eye to read anything (or the |
|
|
703 | monitor to display anything); option B<+ss>. |
|
|
704 | |
|
|
705 | =item B<transparent:> I<boolean> |
|
|
706 | |
|
|
707 | Turn on/off illusion of a transparent window background. |
|
|
708 | |
|
|
709 | B<inheritPixmap> is still accepted as an obsolete alias but will be removed in |
|
|
710 | future versions. |
|
|
711 | |
|
|
712 | I<Please address all transparency related issues to Sasha Vasko at |
|
|
713 | sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> |
601 | |
714 | |
602 | =item B<fading:> I<number> |
715 | =item B<fading:> I<number> |
603 | |
716 | |
604 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
717 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
605 | |
718 | |
… | |
… | |
613 | Tint the transparent background pixmap with the given colour; option |
726 | Tint the transparent background pixmap with the given colour; option |
614 | B<-tint>. |
727 | B<-tint>. |
615 | |
728 | |
616 | =item B<shading:> I<number> |
729 | =item B<shading:> I<number> |
617 | |
730 | |
618 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
731 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image |
619 | image in addition to tinting it. |
732 | in addition to tinting it; option B<-sh>. |
|
|
733 | |
|
|
734 | =item B<blendType:> I<string> |
|
|
735 | |
|
|
736 | Specify background blending type; option B<-blt>. |
|
|
737 | |
|
|
738 | =item B<blurRadius:> I<number> |
|
|
739 | |
|
|
740 | Apply gaussian blur with the specified radius to the transparent |
|
|
741 | background image; option B<-blr>. |
|
|
742 | |
|
|
743 | =item B<iconFile:> I<file> |
|
|
744 | |
|
|
745 | Set the application icon pixmap; option B<-icon>. |
620 | |
746 | |
621 | =item B<scrollColor:> I<colour> |
747 | =item B<scrollColor:> I<colour> |
622 | |
748 | |
623 | Use the specified colour for the scrollbar [default #B2B2B2]. |
749 | Use the specified colour for the scrollbar [default #B2B2B2]. |
624 | |
750 | |
… | |
… | |
630 | =item B<borderColor:> I<colour> |
756 | =item B<borderColor:> I<colour> |
631 | |
757 | |
632 | The colour of the border around the text area and between the scrollbar |
758 | The colour of the border around the text area and between the scrollbar |
633 | and the text. |
759 | and the text. |
634 | |
760 | |
635 | =item B<backgroundPixmap:> I<file[;geom]> |
761 | =item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> |
636 | |
762 | |
637 | Use the specified XPM file (note the `.xpm' extension is optional) for |
763 | Use the specified image file for the background and also |
638 | the background and also optionally specify its scaling with a geometry |
764 | optionally specify its scaling with a geometry string B<WxH+X+Y>, |
639 | string B<WxH+X+Y>, in which B<"W" / "H"> specify the |
765 | (default C<0x0+50+50>) in which B<"W" / "H"> specify the |
640 | horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image |
766 | horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image |
641 | centre (percent). A scale of 0 displays the image with tiling. A scale |
767 | centre (percent). A scale of 0 displays the image with tiling. A scale |
642 | of 1 displays the image without any scaling. A scale of 2 to 9 |
768 | of 1 displays the image without any scaling. A scale of 2 to 9 specifies |
643 | specifies an integer number of images in that direction. No image will |
769 | an integer number of images in that direction. No image will be magnified |
644 | be magnified beyond 10 times its original size. The maximum permitted |
770 | beyond 10 times its original size. The maximum permitted scale is 1000. |
645 | scale is 1000. [default 0x0+50+50] |
771 | Additional operations can be specified after colon B<:op1:op2...>. |
|
|
772 | Supported operations are: |
|
|
773 | |
|
|
774 | tile force background image to be tiled and not scaled. Equivalent to 0x0 |
|
|
775 | propscale will scale image keeping proportions |
|
|
776 | auto will scale image to match window size. Equivalent to 100x100 |
|
|
777 | hscale will scale image horizontally to the window size |
|
|
778 | vscale will scale image vertically to the window size |
|
|
779 | scale will scale image to match window size |
|
|
780 | root will tile image as if it was a root window background, auto-adjusting |
|
|
781 | whenever terminal window moves |
|
|
782 | |
|
|
783 | If used in conjunction with B<-tr> option, the specified pixmap will be |
|
|
784 | blended over transparency image using either alpha-blending, or any |
|
|
785 | other blending type, specified with B<-blt "type"> option. |
646 | |
786 | |
647 | =item B<path:> I<path> |
787 | =item B<path:> I<path> |
648 | |
788 | |
649 | Specify the colon-delimited search path for finding XPM files. |
789 | Specify the colon-delimited search path for finding background image files. |
650 | |
790 | |
651 | =item B<font:> I<fontlist> |
791 | =item B<font:> I<fontlist> |
652 | |
792 | |
653 | Select the fonts to be used. This is a comma separated list of font names |
793 | Select the fonts to be used. This is a comma separated list of font names |
654 | that are checked in order when trying to find glyphs for characters. The |
794 | that are checked in order when trying to find glyphs for characters. The |
… | |
… | |
677 | it is named first) and thus defines the character cell grid to be 9 pixels |
817 | it is named first) and thus defines the character cell grid to be 9 pixels |
678 | wide and 15 pixels high. |
818 | wide and 15 pixels high. |
679 | |
819 | |
680 | The second font is just used to add additional unicode characters not in |
820 | The second font is just used to add additional unicode characters not in |
681 | the base font, likewise the third, which is unfortunately non-bold, but |
821 | the base font, likewise the third, which is unfortunately non-bold, but |
682 | the bold version of the font does contain less characters, so this is a |
822 | the bold version of the font does contain fewer characters, so this is a |
683 | useful supplement. |
823 | useful supplement. |
684 | |
824 | |
685 | The third font is an Xft font with aliasing turned off, and the characters |
825 | The third font is an Xft font with aliasing turned off, and the characters |
686 | are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font |
826 | are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font |
687 | contains other characters, but we are not interested in them. |
827 | contains other characters, but we are not interested in them. |
… | |
… | |
711 | text font will being used for the given style. |
851 | text font will being used for the given style. |
712 | |
852 | |
713 | =item B<intensityStyles:> I<boolean> |
853 | =item B<intensityStyles:> I<boolean> |
714 | |
854 | |
715 | When font styles are not enabled, or this option is enabled (B<True>, |
855 | When font styles are not enabled, or this option is enabled (B<True>, |
716 | option B<-is>, the default), bold and italic font styles imply high |
856 | option B<-is>, the default), bold/blink font styles imply high |
717 | intensity foreground/backround colours. Disabling this option (B<False>, |
857 | intensity foreground/background colours. Disabling this option (B<False>, |
718 | option B<+is>) disables this behaviour, the high intensity colours are not |
858 | option B<+is>) disables this behaviour, the high intensity colours are not |
719 | reachable. |
859 | reachable. |
720 | |
|
|
721 | =item B<selectstyle:> I<mode> |
|
|
722 | |
|
|
723 | Set mouse selection style to B<old> which is 2.20, B<oldword> which is |
|
|
724 | xterm style with 2.20 old word selection, or anything else which gives |
|
|
725 | xterm style selection. |
|
|
726 | |
|
|
727 | =item B<scrollstyle:> I<mode> |
|
|
728 | |
|
|
729 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
|
|
730 | the author's favourite. |
|
|
731 | |
860 | |
732 | =item B<title:> I<string> |
861 | =item B<title:> I<string> |
733 | |
862 | |
734 | Set window title string, the default title is the command-line |
863 | Set window title string, the default title is the command-line |
735 | specified after the B<-e> option, if any, otherwise the application |
864 | specified after the B<-e> option, if any, otherwise the application |
… | |
… | |
744 | =item B<mapAlert:> I<boolean> |
873 | =item B<mapAlert:> I<boolean> |
745 | |
874 | |
746 | B<True>: de-iconify (map) on receipt of a bell character. B<False>: no |
875 | B<True>: de-iconify (map) on receipt of a bell character. B<False>: no |
747 | de-iconify (map) on receipt of a bell character [default]. |
876 | de-iconify (map) on receipt of a bell character [default]. |
748 | |
877 | |
|
|
878 | =item B<urgentOnBell:> I<boolean> |
|
|
879 | |
|
|
880 | B<True>: set the urgency hint for the wm on receipt of a bell character. |
|
|
881 | B<False>: do not set the urgency hint [default]. |
|
|
882 | |
|
|
883 | @@RXVT_NAME@@ resets the urgency hint on every focus change. |
|
|
884 | |
749 | =item B<visualBell:> I<boolean> |
885 | =item B<visualBell:> I<boolean> |
750 | |
886 | |
751 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
887 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
752 | B<False>: no visual bell [default]; option B<+vb>. |
888 | B<False>: no visual bell [default]; option B<+vb>. |
753 | |
889 | |
… | |
… | |
774 | Example: |
910 | Example: |
775 | |
911 | |
776 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
912 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
777 | |
913 | |
778 | This creates a new file in your home directory with the screen contents |
914 | This creates a new file in your home directory with the screen contents |
779 | everytime you hit C<Print>. |
915 | every time you hit C<Print>. |
|
|
916 | |
|
|
917 | =item B<scrollstyle:> I<mode> |
|
|
918 | |
|
|
919 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
|
|
920 | the author's favourite. |
780 | |
921 | |
781 | =item B<scrollBar:> I<boolean> |
922 | =item B<scrollBar:> I<boolean> |
782 | |
923 | |
783 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
924 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
784 | disable the scrollbar; option B<+sb>. |
925 | disable the scrollbar; option B<+sb>. |
… | |
… | |
806 | |
947 | |
807 | =item B<scrollWithBuffer:> I<boolean> |
948 | =item B<scrollWithBuffer:> I<boolean> |
808 | |
949 | |
809 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
950 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
810 | B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll |
951 | B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll |
811 | with scrollback buffer when tty recieves new lines; option B<+sw>. |
952 | with scrollback buffer when tty receives new lines; option B<+sw>. |
812 | |
953 | |
813 | =item B<scrollTtyKeypress:> I<boolean> |
954 | =item B<scrollTtyKeypress:> I<boolean> |
814 | |
955 | |
815 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
956 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
816 | are those which are intercepted by rxvt-unicode for special handling and |
957 | are those which are intercepted by rxvt-unicode for special handling and |
… | |
… | |
847 | =item B<termName:> I<termname> |
988 | =item B<termName:> I<termname> |
848 | |
989 | |
849 | Specifies the terminal type name to be set in the B<TERM> environment |
990 | Specifies the terminal type name to be set in the B<TERM> environment |
850 | variable; option B<-tn>. |
991 | variable; option B<-tn>. |
851 | |
992 | |
852 | =item B<linespace:> I<number> |
993 | =item B<lineSpace:> I<number> |
853 | |
994 | |
854 | Specifies number of lines (pixel height) to insert between each row of |
995 | Specifies number of lines (pixel height) to insert between each row of |
855 | the display [default 0]; option B<-lsp>. |
996 | the display [default 0]; option B<-lsp>. |
856 | |
997 | |
857 | =item B<meta8:> I<boolean> |
998 | =item B<meta8:> I<boolean> |
… | |
… | |
871 | |
1012 | |
872 | =item B<cursorBlink:> I<boolean> |
1013 | =item B<cursorBlink:> I<boolean> |
873 | |
1014 | |
874 | B<True>: blink the cursor. B<False>: do not blink the cursor [default]; |
1015 | B<True>: blink the cursor. B<False>: do not blink the cursor [default]; |
875 | option B<-bc>. |
1016 | option B<-bc>. |
|
|
1017 | |
|
|
1018 | =item B<cursorUnderline:> I<boolean> |
|
|
1019 | |
|
|
1020 | B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default]; |
|
|
1021 | option B<-uc>. |
876 | |
1022 | |
877 | =item B<pointerBlank:> I<boolean> |
1023 | =item B<pointerBlank:> I<boolean> |
878 | |
1024 | |
879 | B<True>: blank the pointer when a key is pressed or after a set number |
1025 | B<True>: blank the pointer when a key is pressed or after a set number |
880 | of seconds of inactivity. B<False>: the pointer is always visible |
1026 | of seconds of inactivity. B<False>: the pointer is always visible |
… | |
… | |
909 | =item B<cutchars:> I<string> |
1055 | =item B<cutchars:> I<string> |
910 | |
1056 | |
911 | The characters used as delimiters for double-click word selection |
1057 | The characters used as delimiters for double-click word selection |
912 | (whitespace delimiting is added automatically if resource is given). |
1058 | (whitespace delimiting is added automatically if resource is given). |
913 | |
1059 | |
914 | When the selection extension is in use (the default if compiled in, see |
1060 | When the perl selection extension is in use (the default if compiled |
915 | the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters |
1061 | in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these |
916 | will be created (if the resource exists, otherwise, no regex will be |
1062 | characters will be created (if the resource exists, otherwise, no regex |
917 | created). In this mode, characters outside ISO-8859-1 can be used. |
1063 | will be created). In this mode, characters outside ISO-8859-1 can be used. |
918 | |
1064 | |
919 | When the selection extension is not used, only ISO-8859-1 characters can |
1065 | When the selection extension is not used, only ISO-8859-1 characters can |
920 | be used. If not specified, the built-in default is used: |
1066 | be used. If not specified, the built-in default is used: |
921 | |
1067 | |
922 | B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> |
1068 | B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> |
923 | |
1069 | |
924 | =item B<preeditType:> I<style> |
1070 | =item B<preeditType:> I<style> |
925 | |
1071 | |
926 | B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. |
1072 | B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. |
927 | |
1073 | |
… | |
… | |
981 | |
1127 | |
982 | Turn on/off secondary screen (default enabled). |
1128 | Turn on/off secondary screen (default enabled). |
983 | |
1129 | |
984 | =item B<secondaryScroll:> I<boolean> |
1130 | =item B<secondaryScroll:> I<boolean> |
985 | |
1131 | |
986 | Turn on/off secondary screen scroll (default enabled). If the this |
1132 | Turn on/off secondary screen scroll (default enabled). If this |
987 | option is enabled, scrolls on the secondary screen will change the |
1133 | option is enabled, scrolls on the secondary screen will change the |
988 | scrollback buffer and switching to/from the secondary screen will |
1134 | scrollback buffer and, when secondaryScreen is off, switching |
989 | instead scroll the screen up. |
1135 | to/from the secondary screen will instead scroll the screen up. |
990 | |
1136 | |
991 | =item B<hold>: I<boolean> |
1137 | =item B<hold>: I<boolean> |
992 | |
1138 | |
993 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
1139 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
994 | will not immediately destroy its window when the program executed within |
1140 | will not immediately destroy its window when the program executed within |
995 | it exits. Instead, it will wait till it is being killed or closed by the |
1141 | it exits. Instead, it will wait till it is being killed or closed by the |
996 | user. |
1142 | user. |
|
|
1143 | |
|
|
1144 | =item B<chdir>: I<path> |
|
|
1145 | |
|
|
1146 | Sets the working directory for the shell (or the command specified via |
|
|
1147 | B<-e>). The I<path> must be an absolute path and it must exist for |
|
|
1148 | @@RXVT_NAME@@ to start. If it isn't specified then the current working |
|
|
1149 | directory will be used; option B<-cd>. |
997 | |
1150 | |
998 | =item B<keysym.>I<sym>: I<string> |
1151 | =item B<keysym.>I<sym>: I<string> |
999 | |
1152 | |
1000 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
1153 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
1001 | intervening resource name B<keysym.> cannot be omitted. |
1154 | intervening resource name B<keysym.> cannot be omitted. |
… | |
… | |
1015 | searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and |
1168 | searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and |
1016 | omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex |
1169 | omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex |
1017 | keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not |
1170 | keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not |
1018 | performed in an exact manner; however, the closest match is assured. |
1171 | performed in an exact manner; however, the closest match is assured. |
1019 | |
1172 | |
1020 | I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, |
1173 | I<string> may contain escape values (C<\n>: newline, C<\000>: octal |
1021 | C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, |
1174 | number), see RESOURCES in C<man 7 X> for futher details. |
1022 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
|
|
1023 | C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it |
|
|
1024 | can start or end with whitespace. |
|
|
1025 | |
|
|
1026 | Please note that you need to double the C<\> in resource files, as |
|
|
1027 | Xlib itself does it's own de-escaping (you can use C<\033> instead of |
|
|
1028 | C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own |
|
|
1029 | processing). |
|
|
1030 | |
1175 | |
1031 | You can define a range of keysyms in one shot by providing a I<string> |
1176 | You can define a range of keysyms in one shot by providing a I<string> |
1032 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' |
1177 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' |
1033 | should be a character not used by the strings. |
1178 | should be a character not used by the strings. |
1034 | |
1179 | |
1035 | Its usage can be demonstrated by an example: |
1180 | Its usage can be demonstrated by an example: |
1036 | |
1181 | |
1037 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
1182 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
… | |
… | |
1048 | when Control-Meta-c is being pressed": |
1193 | when Control-Meta-c is being pressed": |
1049 | |
1194 | |
1050 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1195 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1051 | |
1196 | |
1052 | If I<string> takes the form C<perl:STRING>, then the specified B<STRING> |
1197 | If I<string> takes the form C<perl:STRING>, then the specified B<STRING> |
1053 | is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) |
1198 | is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3) |
1054 | manpage. For example, the F<selection> extension (activated via |
1199 | manpage. For example, the F<selection> extension (activated via |
1055 | C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: |
1200 | C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: |
1056 | |
1201 | |
1057 | URxvt.keysym.M-C-c: perl:selection:rot13 |
1202 | URxvt.keysym.M-C-c: perl:selection:rot13 |
1058 | |
1203 | |
… | |
… | |
1101 | example, C<default,-selection> will use all the default extension except |
1246 | example, C<default,-selection> will use all the default extension except |
1102 | C<selection>. |
1247 | C<selection>. |
1103 | |
1248 | |
1104 | Extension names can also be followed by an argument in angle brackets |
1249 | Extension names can also be followed by an argument in angle brackets |
1105 | (e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for |
1250 | (e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for |
1106 | searchable scorllback to Alt/Meta-s). Mentioning the same extension |
1251 | searchable scrollback to Alt/Meta-s). Mentioning the same extension |
1107 | multiple times with different arguments will pass multiple arguments to |
1252 | multiple times with different arguments will pass multiple arguments to |
1108 | the extension. |
1253 | the extension. |
1109 | |
1254 | |
1110 | Each extension is looked up in the library directories, loaded if |
1255 | Each extension is looked up in the library directories, loaded if |
1111 | necessary, and bound to the current terminal instance. |
1256 | necessary, and bound to the current terminal instance. |
… | |
… | |
1116 | all instances, while B<perl-ext> is used for specific instances. |
1261 | all instances, while B<perl-ext> is used for specific instances. |
1117 | |
1262 | |
1118 | =item B<perl-eval>: I<string> |
1263 | =item B<perl-eval>: I<string> |
1119 | |
1264 | |
1120 | Perl code to be evaluated when all extensions have been registered. See |
1265 | Perl code to be evaluated when all extensions have been registered. See |
1121 | the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource |
1266 | the @@RXVT_NAME@@perl(3) manpage. |
1122 | will be ignored when running setuid/setgid. |
|
|
1123 | |
1267 | |
1124 | =item B<perl-lib>: I<path> |
1268 | =item B<perl-lib>: I<path> |
1125 | |
1269 | |
1126 | Colon-separated list of additional directories that hold extension |
1270 | Colon-separated list of additional directories that hold extension |
1127 | scripts. When looking for extensions specified by the C<perl> resource, |
1271 | scripts. When looking for extensions specified by the C<perl> resource, |
1128 | @@RXVT_NAME@@ will first look in these directories and then in |
1272 | @@RXVT_NAME@@ will first look in these directories and then in |
1129 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource |
1273 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
1130 | will be ignored when running setuid/setgid. |
|
|
1131 | |
1274 | |
1132 | See the @@RXVT_NAME@@perl(3) manpage. |
1275 | See the @@RXVT_NAME@@perl(3) manpage. |
1133 | |
1276 | |
1134 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1277 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1135 | |
1278 | |
… | |
… | |
1147 | (default: C<M-s>). |
1290 | (default: C<M-s>). |
1148 | |
1291 | |
1149 | =item B<urlLauncher>: I<string> |
1292 | =item B<urlLauncher>: I<string> |
1150 | |
1293 | |
1151 | Specifies the program to be started with a URL argument. Used by the |
1294 | Specifies the program to be started with a URL argument. Used by the |
1152 | C<selection-popup> and C<mark-urls> perl extensions. |
1295 | C<selection-popup> and C<matcher> perl extensions. |
1153 | |
1296 | |
1154 | =item B<transient-for>: I<windowid> |
1297 | =item B<transient-for>: I<windowid> |
1155 | |
1298 | |
1156 | Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. |
1299 | Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. |
1157 | |
1300 | |
1158 | =item B<override-redirect>: I<boolean> |
1301 | =item B<override-redirect>: I<boolean> |
1159 | |
1302 | |
1160 | Compile I<frills>: Sets override-redirect for the terminal window, making |
1303 | Compile I<frills>: Sets override-redirect for the terminal window, making |
1161 | it almost invisible to window managers; option B<-override-redirect>. |
1304 | it almost invisible to window managers; option B<-override-redirect>. |
|
|
1305 | |
|
|
1306 | =item B<iso14755:> I<boolean> |
|
|
1307 | |
|
|
1308 | Turn on/off ISO 14755 (default enabled). |
|
|
1309 | |
|
|
1310 | =item B<iso14755_52:> I<boolean> |
|
|
1311 | |
|
|
1312 | Turn on/off ISO 14755 5.2 mode (default enabled). |
1162 | |
1313 | |
1163 | =back |
1314 | =back |
1164 | |
1315 | |
1165 | =head1 THE SCROLLBAR |
1316 | =head1 THE SCROLLBAR |
1166 | |
1317 | |
… | |
… | |
1185 | application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> |
1336 | application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> |
1186 | (Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the |
1337 | (Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the |
1187 | up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), |
1338 | up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), |
1188 | respectively. |
1339 | respectively. |
1189 | |
1340 | |
1190 | =head1 TEXT SELECTION AND INSERTION |
1341 | =head1 THE SELECTION: SELECTING AND PASTING TEXT |
1191 | |
1342 | |
1192 | The behaviour of text selection and insertion mechanism is similar to |
1343 | The behaviour of text selection and insertion/pasting mechanism is similar |
1193 | I<xterm>(1). |
1344 | to I<xterm>(1). |
1194 | |
1345 | |
1195 | =over 4 |
1346 | =over 4 |
1196 | |
1347 | |
1197 | =item B<Selection>: |
1348 | =item B<Selecting>: |
1198 | |
1349 | |
1199 | Left click at the beginning of the region, drag to the end of the region |
1350 | Left click at the beginning of the region, drag to the end of the region |
1200 | and release; Right click to extend the marked region; Left double-click |
1351 | and release; Right click to extend the marked region; Left double-click |
1201 | to select a word; Left triple-click to select the entire logical line |
1352 | to select a word; Left triple-click to select the entire logical line |
1202 | (which can span multiple screen lines), unless modified by resource |
1353 | (which can span multiple screen lines), unless modified by resource |
… | |
… | |
1206 | (Compile: I<frills>) will create a rectangular selection instead of a |
1357 | (Compile: I<frills>) will create a rectangular selection instead of a |
1207 | normal one. In this mode, every selected row becomes its own line in the |
1358 | normal one. In this mode, every selected row becomes its own line in the |
1208 | selection, and trailing whitespace is visually underlined and removed from |
1359 | selection, and trailing whitespace is visually underlined and removed from |
1209 | the selection. |
1360 | the selection. |
1210 | |
1361 | |
1211 | =item B<Insertion>: |
1362 | =item B<Pasting>: |
1212 | |
1363 | |
1213 | Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> |
1364 | Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> |
1214 | window causes the value of the PRIMARY selection (or CLIPBOARD with the |
1365 | window causes the value of the PRIMARY selection (or CLIPBOARD with the |
1215 | Meta modifier) to be inserted as if it had been typed on the keyboard. |
1366 | B<Meta> modifier) to be inserted as if it had been typed on the keyboard. |
1216 | |
1367 | |
1217 | Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be |
1368 | Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be |
1218 | inserted too. |
1369 | inserted too. |
1219 | |
1370 | |
1220 | =back |
1371 | =back |
… | |
… | |
1237 | |
1388 | |
1238 | =head1 ISO 14755 SUPPORT |
1389 | =head1 ISO 14755 SUPPORT |
1239 | |
1390 | |
1240 | ISO 14755 is a standard for entering and viewing unicode characters |
1391 | ISO 14755 is a standard for entering and viewing unicode characters |
1241 | and character codes using the keyboard. It consists of 4 parts. The |
1392 | and character codes using the keyboard. It consists of 4 parts. The |
1242 | first part is available rxvt-unicode has been compiled with |
1393 | first part is available if rxvt-unicode has been compiled with |
1243 | C<--enable-frills>, the rest is available when rxvt-unicode was compiled |
1394 | C<--enable-frills>, the rest is available when rxvt-unicode was compiled |
1244 | with C<--enable-iso14755>. |
1395 | with C<--enable-iso14755>. |
1245 | |
1396 | |
1246 | =over 4 |
1397 | =over 4 |
1247 | |
1398 | |
… | |
… | |
1267 | This mode lets you input characters representing the keycap symbols of |
1418 | This mode lets you input characters representing the keycap symbols of |
1268 | your keyboard, if representable in the current locale encoding. |
1419 | your keyboard, if representable in the current locale encoding. |
1269 | |
1420 | |
1270 | Start by pressing C<Control> and C<Shift> together, then releasing |
1421 | Start by pressing C<Control> and C<Shift> together, then releasing |
1271 | them. The next special key (cursor keys, home etc.) you enter will not |
1422 | them. The next special key (cursor keys, home etc.) you enter will not |
1272 | invoke it's usual function but instead will insert the corresponding |
1423 | invoke its usual function but instead will insert the corresponding |
1273 | keycap symbol. The symbol will only be entered when the key has been |
1424 | keycap symbol. The symbol will only be entered when the key has been |
1274 | released, otherwise pressing e.g. C<Shift> would enter the symbol for |
1425 | released, otherwise pressing e.g. C<Shift> would enter the symbol for |
1275 | C<ISO Level 2 Switch>, although your intention might have been to enter a |
1426 | C<ISO Level 2 Switch>, although your intention might have been to enter a |
1276 | reverse tab (Shift-Tab). |
1427 | reverse tab (Shift-Tab). |
1277 | |
1428 | |
… | |
… | |
1305 | B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that |
1456 | B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that |
1306 | it can be seen via the I<who(1)> command, and can accept messages. To |
1457 | it can be seen via the I<who(1)> command, and can accept messages. To |
1307 | allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root |
1458 | allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root |
1308 | on some systems or setgid to root or to some other group on others. |
1459 | on some systems or setgid to root or to some other group on others. |
1309 | |
1460 | |
1310 | =head1 COLORS AND GRAPHICS |
1461 | =head1 COLOURS AND GRAPHICS |
1311 | |
1462 | |
1312 | In addition to the default foreground and background colours, |
1463 | In addition to the default foreground and background colours, |
1313 | B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus |
1464 | B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus |
1314 | high-intensity bold/blink versions of the same). Here is a list of the |
1465 | high-intensity (potentially bold/blink) versions of the same, and 72 (or |
1315 | colours with their names. |
1466 | 240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB |
|
|
1467 | cube plus a 8 (24) colour greyscale ramp. |
|
|
1468 | |
|
|
1469 | Here is a list of the ANSI colours with their names. |
1316 | |
1470 | |
1317 | =begin table |
1471 | =begin table |
1318 | |
1472 | |
1319 | B<color0> (black) = Black |
1473 | B<color0> (black) = Black |
1320 | B<color1> (red) = Red3 |
1474 | B<color1> (red) = Red3 |
… | |
… | |
1340 | It is also possible to specify the colour values of B<foreground>, |
1494 | It is also possible to specify the colour values of B<foreground>, |
1341 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1495 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1342 | a number 0-15, as a convenient shorthand to reference the colour name of |
1496 | a number 0-15, as a convenient shorthand to reference the colour name of |
1343 | color0-color15. |
1497 | color0-color15. |
1344 | |
1498 | |
1345 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1499 | The following text gives values for the standard 88 colour mode (and |
1346 | their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> |
1500 | values for the 256 colour mode in parentheses). |
1347 | (recommended, but B<MUST> have 4 digits/component), C<#ARGB>, C<#AARRGGBB> |
1501 | |
1348 | and C<#AAAARRRRGGGGBBBB> colour specifications, in addition to the ones |
1502 | The RGB cube uses indices 16..79 (16..231) using the following formulas: |
1349 | provided by X, where the additional A component specifies alpha (opacity) |
1503 | |
1350 | values (0 is completely transparent and the maximum is opaque). You |
1504 | index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 |
1351 | probably need to specify B<"-depth 32">, too, and have the luck that your |
1505 | index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15 |
1352 | X-server uses ARGB pixel layout, as X is far from just supporting ARGB |
1506 | |
1353 | visuals out of the box, and rxvt-unicode just fudges around. |
1507 | The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% |
|
|
1508 | steps (1/26 to 25/26 in 1/26 steps). |
|
|
1509 | |
|
|
1510 | Together, all those colours implement the 88 (256) colour xterm |
|
|
1511 | colours. Only the first 16 can be changed using resources currently, the |
|
|
1512 | rest can only be changed via command sequences ("escape codes"). |
1354 | |
1513 | |
1355 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1514 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1356 | always swapping the foreground/background colours. This is in contrast to |
1515 | always swapping the foreground/background colours. This is in contrast to |
1357 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1516 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1358 | been specified. For example, |
1517 | been specified. For example, |
1359 | |
1518 | |
|
|
1519 | @@RXVT_NAME@@ -fg Black -bg White -rv |
|
|
1520 | |
|
|
1521 | would yield White on Black, while on I<xterm>(1) it would yield Black on |
|
|
1522 | White. |
|
|
1523 | |
|
|
1524 | =head2 ALPHA CHANNEL SUPPORT |
|
|
1525 | |
|
|
1526 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
|
|
1527 | their act together, rxvt-unicode will do it's own alpha channel management: |
|
|
1528 | |
|
|
1529 | You can prefix any colour with an opaquenes percentage enclosed in |
|
|
1530 | brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage |
|
|
1531 | (0-100) that specifies the opacity of the colour, where C<0> is completely |
|
|
1532 | transparent and C<100> is completely opaque. For example, C<[50]red> is a |
|
|
1533 | half-transparent red, while C<[95]#00ff00> is an almost opaque green. This |
|
|
1534 | is the recommended format to specify transparency values, and works with |
|
|
1535 | all ways to specify a colour. |
|
|
1536 | |
|
|
1537 | For complete control, rxvt-unicode also supports |
|
|
1538 | C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour |
|
|
1539 | specifications, where the additional C<aaaa> component specifies opacity |
|
|
1540 | (alpha) values. The minimum value of C<0000> is completely transparent, |
|
|
1541 | while C<ffff> is completely opaque). The two example colours from |
|
|
1542 | earlier could also be specified as C<rgba:ff00/0000/0000/8000> and |
|
|
1543 | C<rgba:0000/ff00/0000/f332>. |
|
|
1544 | |
|
|
1545 | You probably need to specify B<"-depth 32">, too, to force a visual with |
|
|
1546 | alpha channels, and have the luck that your X-server uses ARGB pixel |
|
|
1547 | layout, as X is far from just supporting ARGB visuals out of the box, and |
|
|
1548 | rxvt-unicode just fudges around. |
|
|
1549 | |
|
|
1550 | For example, the following selects an almost completely transparent black |
|
|
1551 | background, and an almost opaque pink foreground: |
|
|
1552 | |
|
|
1553 | @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink" |
|
|
1554 | |
|
|
1555 | When not using a background image, then the interpretation of the |
|
|
1556 | alpha channel is up to your compositing manager (most interpret it as |
|
|
1557 | transparency of course). |
|
|
1558 | |
|
|
1559 | When using a background pixmap or pseudo-transparency, then the background |
|
|
1560 | colour will always behave as if it were completely transparent (so the |
|
|
1561 | background image shows instead), regardless of how it was specified, while |
|
|
1562 | other colours will either be transparent as specified (the background |
|
|
1563 | image will show through) on servers supporting the RENDER extension, or |
|
|
1564 | fully opaque on servers not supporting the RENDER EXTENSION. |
|
|
1565 | |
|
|
1566 | Please note that due to bugs in Xft, specifying alpha values might result |
|
|
1567 | in garbage being displayed when the X-server does not support the RENDER |
|
|
1568 | extension. |
|
|
1569 | |
|
|
1570 | =head1 ENVIRONMENT |
|
|
1571 | |
|
|
1572 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
|
|
1573 | |
1360 | =over 4 |
1574 | =over 4 |
1361 | |
1575 | |
1362 | =item B<@@RXVT_NAME@@ -fg Black -bg White -rv> |
|
|
1363 | |
|
|
1364 | would yield White on Black, while on I<xterm>(1) it would yield Black |
|
|
1365 | on White. |
|
|
1366 | |
|
|
1367 | =back |
|
|
1368 | |
|
|
1369 | =head1 ENVIRONMENT |
|
|
1370 | |
|
|
1371 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
|
|
1372 | |
|
|
1373 | =over 4 |
|
|
1374 | |
|
|
1375 | =item B<TERM> |
1576 | =item B<TERM> |
1376 | |
1577 | |
1377 | Normally set to C<rxvt-unicode>, unless overwritten at configure time, via |
1578 | Normally set to C<rxvt-unicode>, unless overwritten at configure time, via |
1378 | resources or on the commandline. |
1579 | resources or on the command line. |
1379 | |
1580 | |
1380 | =item B<COLORTERM> |
1581 | =item B<COLORTERM> |
1381 | |
1582 | |
1382 | Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was |
1583 | Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was |
1383 | compiled with XPM support, and optionally with the added extension |
1584 | compiled with background image support, and optionally with the added |
1384 | C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. |
1585 | extension C<-mono> to indicate that rxvt-unicode runs on a monochrome |
|
|
1586 | screen. |
1385 | |
1587 | |
1386 | =item B<COLORFGBG> |
1588 | =item B<COLORFGBG> |
1387 | |
1589 | |
1388 | Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is |
1590 | Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is |
1389 | the colour code used as default foreground/text colour (or the string |
1591 | the colour code used as default foreground/text colour (or the string |
1390 | C<default> to indicate that the default-colour escape sequence is to be |
1592 | C<default> to indicate that the default-colour escape sequence is to be |
1391 | used), C<bg> is the colour code used as default background colour (or the |
1593 | used), C<bg> is the colour code used as default background colour (or the |
1392 | string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ |
1594 | string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ |
1393 | was compiled with XPM support. Libraries like C<ncurses> and C<slang> can |
1595 | was compiled with background image support. Libraries like C<ncurses> |
1394 | (and do) use this information to optimize screen output. |
1596 | and C<slang> can (and do) use this information to optimize screen output. |
1395 | |
1597 | |
1396 | =item B<WINDOWID> |
1598 | =item B<WINDOWID> |
1397 | |
1599 | |
1398 | Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel |
1600 | Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel |
1399 | window, which usually has subwindows for the scrollbar, the terminal |
1601 | window, which usually has subwindows for the scrollbar, the terminal |
… | |
… | |
1405 | C<--with-terminfo=PATH>. |
1607 | C<--with-terminfo=PATH>. |
1406 | |
1608 | |
1407 | =item B<DISPLAY> |
1609 | =item B<DISPLAY> |
1408 | |
1610 | |
1409 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1611 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1410 | display in it's child processes. |
1612 | display in its child processes if C<-display> isn't used to override. It |
|
|
1613 | defaults to C<:0> if it doesn't exist. |
1411 | |
1614 | |
1412 | =item B<SHELL> |
1615 | =item B<SHELL> |
1413 | |
1616 | |
1414 | The shell to be used for command execution, defaults to C</bin/sh>. |
1617 | The shell to be used for command execution, defaults to C</bin/sh>. |
1415 | |
1618 | |
… | |
… | |
1441 | |
1644 | |
1442 | =over 4 |
1645 | =over 4 |
1443 | |
1646 | |
1444 | =item B</usr/lib/X11/rgb.txt> |
1647 | =item B</usr/lib/X11/rgb.txt> |
1445 | |
1648 | |
1446 | Color names. |
1649 | Colour names. |
1447 | |
1650 | |
1448 | =back |
1651 | =back |
1449 | |
1652 | |
1450 | =head1 SEE ALSO |
1653 | =head1 SEE ALSO |
1451 | |
1654 | |
… | |
… | |
1457 | |
1660 | |
1458 | =item Project Coordinator |
1661 | =item Project Coordinator |
1459 | |
1662 | |
1460 | Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1663 | Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1461 | |
1664 | |
1462 | L<http://software.schmorp.de/#rxvt-unicode> |
1665 | L<http://software.schmorp.de/pkg/rxvt-unicode.html> |
1463 | |
1666 | |
1464 | =back |
1667 | =back |
1465 | |
1668 | |
1466 | =head1 AUTHORS |
1669 | =head1 AUTHORS |
1467 | |
1670 | |
… | |
… | |
1490 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1693 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1491 | |
1694 | |
1492 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1695 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1493 | |
1696 | |
1494 | Rewrote screen display and text selection routines. |
1697 | Rewrote screen display and text selection routines. |
1495 | |
1698 | |
1496 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1699 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1497 | |
1700 | |
1498 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1701 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1499 | |
1702 | |
1500 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |
1703 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |