… | |
… | |
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. |
|
|
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] |
97 | |
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 | |
… | |
… | |
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 pseudo-transparency by using the root pixmap as background; resource B<transparent>. |
|
|
130 | |
|
|
131 | B<-ip> is still accepted as an obsolete alias but will be removed in |
|
|
132 | future versions. |
114 | |
133 | |
115 | =item B<-fade> I<number> |
134 | =item B<-fade> I<number> |
116 | |
135 | |
117 | Fade the text by the given percentage when focus is lost. Small values |
136 | 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 |
137 | fade a little only, 100 completely replaces all colours by the fade |
119 | colour; resource B<fading>. |
138 | colour; resource B<fading>. |
120 | |
139 | |
121 | =item B<-fadecolor> I<colour> |
140 | =item B<-fadecolor> I<colour> |
122 | |
141 | |
123 | Fade to this colour when fading is used (see B<-fade>). The default colour |
142 | Fade to this colour when fading is used (see B<-fade>). The default colour |
124 | is black. resource B<fadeColor>. |
143 | is opaque black. resource B<fadeColor>. |
125 | |
144 | |
126 | =item B<-tint> I<colour> |
145 | =item B<-tint> I<colour> |
127 | |
146 | |
128 | Tint the transparent background pixmap with the given colour when |
147 | Tint the transparent background with the given colour; |
129 | transparency is enabled with B<-tr> or B<-ip>. This only works for |
148 | resource I<tintColor>. |
130 | 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 |
|
|
132 | I<tintColor>. Example: |
|
|
133 | |
149 | |
134 | @@RXVT_NAME@@ -tr -tint blue -sh 40 |
150 | =item B<-sh> I<number> |
135 | |
151 | |
136 | =item B<-sh> |
|
|
137 | |
|
|
138 | I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
152 | Darken (0 .. 99) or lighten (101 .. 200) the transparent background. |
139 | background image in addition to tinting it (i.e. B<-tint> must be |
153 | A value of 100 means no shading; resource I<shading>. |
140 | specified, too, e.g. C<-tint white>). |
154 | |
|
|
155 | =item B<-blr> I<HxV> |
|
|
156 | |
|
|
157 | Apply Gaussian Blur with the specified radii to the transparent |
|
|
158 | background. If a single number is specified, the vertical and |
|
|
159 | horizontal radii are considered to be the same. Setting one of the |
|
|
160 | radii to 1 and the other to a large number creates interesting effects |
|
|
161 | on some backgrounds. The maximum radius value is 128. An horizontal or |
|
|
162 | vertical radius of 0 disables blurring; |
|
|
163 | resource I<blurRadius>. |
|
|
164 | |
|
|
165 | =item B<-icon> I<file> |
|
|
166 | |
|
|
167 | Compile I<pixbuf>: Use the specified image as application icon. This |
|
|
168 | is used by many window managers, taskbars and pagers to represent the |
|
|
169 | application window; resource I<iconFile>. |
141 | |
170 | |
142 | =item B<-bg> I<colour> |
171 | =item B<-bg> I<colour> |
143 | |
172 | |
144 | Window background colour; resource B<background>. |
173 | Window background colour; resource B<background>. |
145 | |
174 | |
146 | =item B<-fg> I<colour> |
175 | =item B<-fg> I<colour> |
147 | |
176 | |
148 | Window foreground colour; resource B<foreground>. |
177 | Window foreground colour; resource B<foreground>. |
149 | |
178 | |
150 | =item B<-pixmap> I<file[;geom]> |
179 | =item B<-pixmap> I<file[;oplist]> |
151 | |
180 | |
152 | Compile I<XPM>: Specify XPM file for the background and also optionally |
181 | Compile I<pixbuf>: Specify image file for the background and also |
153 | specify its scaling with a geometry string. Note you may need to |
182 | optionally specify a list of operations to modify it. Note you may need to |
154 | add quotes to avoid special shell interpretation of the C<;> in the |
183 | add quotes to avoid special shell interpretation of the C<;> in the |
155 | command-line; resource B<backgroundPixmap>. |
184 | command-line; for more details see resource B<backgroundPixmap>. |
156 | |
185 | |
157 | =item B<-cr> I<colour> |
186 | =item B<-cr> I<colour> |
158 | |
187 | |
159 | The cursor colour; resource B<cursorColor>. |
188 | The cursor colour; resource B<cursorColor>. |
160 | |
189 | |
… | |
… | |
177 | that are checked in order when trying to find glyphs for characters. The |
206 | 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 |
207 | first font defines the cell size for characters; other fonts might be |
179 | smaller, but not (in general) larger. A (hopefully) reasonable default |
208 | 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. |
209 | font list is always appended to it. See resource B<font> for more details. |
181 | |
210 | |
182 | In short, to specify an X11 core font, just specify it's name or prefix it |
211 | 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:>, |
212 | with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, |
184 | e.g.: |
213 | e.g.: |
185 | |
214 | |
186 | @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
215 | @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
187 | @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
216 | @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
… | |
… | |
205 | italic> >> characters are to be printed. See resource B<boldItalicFont> |
234 | italic> >> characters are to be printed. See resource B<boldItalicFont> |
206 | for details. |
235 | for details. |
207 | |
236 | |
208 | =item B<-is>|B<+is> |
237 | =item B<-is>|B<+is> |
209 | |
238 | |
210 | Compile I<font-styles>: Bold/Italic font styles imply high intensity |
239 | Compile I<font-styles>: Bold/Blink font styles imply high intensity |
211 | foreground/background (default). See resource B<intensityStyles> for |
240 | foreground/background (default). See resource B<intensityStyles> for |
212 | details. |
241 | details. |
213 | |
242 | |
214 | =item B<-name> I<name> |
243 | =item B<-name> I<name> |
215 | |
244 | |
… | |
… | |
233 | |
262 | |
234 | =item B<-sb>|B<+sb> |
263 | =item B<-sb>|B<+sb> |
235 | |
264 | |
236 | Turn on/off scrollbar; resource B<scrollBar>. |
265 | Turn on/off scrollbar; resource B<scrollBar>. |
237 | |
266 | |
|
|
267 | =item B<-sr>|B<+sr> |
|
|
268 | |
|
|
269 | Put scrollbar on right/left; resource B<scrollBar_right>. |
|
|
270 | |
|
|
271 | =item B<-st>|B<+st> |
|
|
272 | |
|
|
273 | Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; |
|
|
274 | resource B<scrollBar_floating>. |
|
|
275 | |
238 | =item B<-si>|B<+si> |
276 | =item B<-si>|B<+si> |
239 | |
277 | |
240 | Turn on/off scroll-to-bottom on TTY output inhibit; resource |
278 | Turn on/off scroll-to-bottom on TTY output inhibit; resource |
241 | B<scrollTtyOutput> has opposite effect. |
279 | B<scrollTtyOutput> has opposite effect. |
242 | |
280 | |
… | |
… | |
248 | =item B<-sw>|B<+sw> |
286 | =item B<-sw>|B<+sw> |
249 | |
287 | |
250 | Turn on/off scrolling with the scrollback buffer as new lines appear. |
288 | Turn on/off scrolling with the scrollback buffer as new lines appear. |
251 | This only takes effect if B<-si> is also given; resource |
289 | This only takes effect if B<-si> is also given; resource |
252 | B<scrollWithBuffer>. |
290 | 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 | |
291 | |
263 | =item B<-ptab>|B<+ptab> |
292 | =item B<-ptab>|B<+ptab> |
264 | |
293 | |
265 | If enabled (default), "Horizontal Tab" characters are being stored as |
294 | If enabled (default), "Horizontal Tab" characters are being stored as |
266 | actual wide characters in the screen buffer, which makes it possible to |
295 | actual wide characters in the screen buffer, which makes it possible to |
… | |
… | |
270 | |
299 | |
271 | =item B<-bc>|B<+bc> |
300 | =item B<-bc>|B<+bc> |
272 | |
301 | |
273 | Blink the cursor; resource B<cursorBlink>. |
302 | Blink the cursor; resource B<cursorBlink>. |
274 | |
303 | |
|
|
304 | =item B<-uc>|B<+uc> |
|
|
305 | |
|
|
306 | Make the cursor underlined; resource B<cursorUnderline>. |
|
|
307 | |
275 | =item B<-iconic> |
308 | =item B<-iconic> |
276 | |
309 | |
277 | Start iconified, if the window manager supports that option. |
310 | Start iconified, if the window manager supports that option. |
278 | Alternative form is B<-ic>. |
311 | Alternative form is B<-ic>. |
279 | |
312 | |
… | |
… | |
295 | |
328 | |
296 | =item B<-bl> |
329 | =item B<-bl> |
297 | |
330 | |
298 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
331 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
299 | if honoured by the WM, the rxvt-unicode window will not have window |
332 | if honoured by the WM, the rxvt-unicode window will not have window |
300 | decorations; resource B<borderLess>. |
333 | decorations; resource B<borderLess>. If the window manager does not |
|
|
334 | support MWM hints (e.g. kwin), enables override-redirect mode. |
301 | |
335 | |
302 | =item B<-override-redirect> |
336 | =item B<-override-redirect> |
303 | |
337 | |
304 | Compile I<frills>: Sets override-redirect on the window; resource |
338 | Compile I<frills>: Sets override-redirect on the window; resource |
305 | B<override-redirect>. |
339 | B<override-redirect>. |
… | |
… | |
313 | |
347 | |
314 | =item B<-lsp> I<number> |
348 | =item B<-lsp> I<number> |
315 | |
349 | |
316 | Compile I<frills>: Lines (pixel height) to insert between each row of |
350 | Compile I<frills>: Lines (pixel height) to insert between each row of |
317 | the display. Useful to work around font rendering problems; resource |
351 | the display. Useful to work around font rendering problems; resource |
318 | B<linespace>. |
352 | B<lineSpace>. |
|
|
353 | |
|
|
354 | =item B<-letsp> I<number> |
|
|
355 | |
|
|
356 | Compile I<frills>: Amount to adjust the computed character width by |
|
|
357 | to control overall letter spacing. Negative values will tighten up the |
|
|
358 | letter spacing, positive values will space letters out more. Useful to |
|
|
359 | work around odd font metrics; resource B<letterSpace>. |
319 | |
360 | |
320 | =item B<-tn> I<termname> |
361 | =item B<-tn> I<termname> |
321 | |
362 | |
322 | This option specifies the name of the terminal type to be set in the |
363 | 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 |
364 | B<TERM> environment variable. This terminal type must exist in the |
… | |
… | |
377 | for more info. |
418 | for more info. |
378 | |
419 | |
379 | =item B<-tcw> |
420 | =item B<-tcw> |
380 | |
421 | |
381 | Change the meaning of triple-click selection with the left mouse |
422 | Change the meaning of triple-click selection with the left mouse |
|
|
423 | 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 |
424 | in-use. Instead of selecting a full line it will extend the selection to |
383 | end of the logical line only. resource B<tripleclickwords>. |
425 | the end of the logical line only. resource B<tripleclickwords>. |
384 | |
426 | |
385 | =item B<-insecure> |
427 | =item B<-insecure> |
386 | |
428 | |
387 | Enable "insecure" mode, which currently enables most of the escape |
429 | Enable "insecure" mode, which currently enables most of the escape |
388 | sequences that echo strings. See the resource B<insecure> for more |
430 | sequences that echo strings. See the resource B<insecure> for more |
… | |
… | |
409 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
451 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
410 | will not immediately destroy its window when the program executed within |
452 | 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 |
453 | it exits. Instead, it will wait till it is being killed or closed by the |
412 | user; resource B<hold>. |
454 | user; resource B<hold>. |
413 | |
455 | |
|
|
456 | =item B<-cd> I<path> |
|
|
457 | |
|
|
458 | Sets the working directory for the shell (or the command specified via |
|
|
459 | B<-e>). The I<path> must be an absolute path and it must exist for |
|
|
460 | @@RXVT_NAME@@ to start; resource B<chdir>. |
|
|
461 | |
|
|
462 | =item B<-xrm> I<string> |
|
|
463 | |
|
|
464 | Works like the X Toolkit option of the same name, by adding the I<string> |
|
|
465 | as if it were specified in a resource file. Resource values specified this |
|
|
466 | way take precedence over all other resource specifications. |
|
|
467 | |
|
|
468 | Note that you need to use the I<same> syntax as in the .Xdefaults file, |
|
|
469 | e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific |
|
|
470 | options can be specified as long-options on the commandline, so use |
|
|
471 | of B<-xrm> is mostly limited to cases where you want to specify other |
|
|
472 | resources (e.g. for input methods) or for compatibility with other |
|
|
473 | programs. |
|
|
474 | |
414 | =item B<-keysym.>I<sym> I<string> |
475 | =item B<-keysym.>I<sym> I<string> |
415 | |
476 | |
416 | Remap a key symbol. See resource B<keysym>. |
477 | Remap a key symbol. See resource B<keysym>. |
417 | |
478 | |
418 | =item B<-embed> I<windowid> |
479 | =item B<-embed> I<windowid> |
419 | |
480 | |
420 | Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, |
481 | Tells @@RXVT_NAME@@ to embed its windows into an already-existing window, |
421 | which enables applications to easily embed a terminal. |
482 | which enables applications to easily embed a terminal. |
422 | |
483 | |
423 | Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it |
484 | 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 |
485 | 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 |
486 | 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. |
489 | The window will not be destroyed when @@RXVT_NAME@@ exits. |
429 | |
490 | |
430 | It might be useful to know that @@RXVT_NAME@@ will not close file |
491 | 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 |
492 | 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 |
493 | 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 |
494 | terminal. This works regardless of whether the C<-embed> option was used or |
434 | not. |
495 | not. |
435 | |
496 | |
436 | Here is a short Gtk2-perl snippet that illustrates how this option can be |
497 | Here is a short Gtk2-perl snippet that illustrates how this option can be |
437 | used (a longer example is in F<doc/embed>): |
498 | used (a longer example is in F<doc/embed>): |
438 | |
499 | |
… | |
… | |
443 | }); |
504 | }); |
444 | |
505 | |
445 | =item B<-pty-fd> I<file descriptor> |
506 | =item B<-pty-fd> I<file descriptor> |
446 | |
507 | |
447 | Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty |
508 | 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 |
509 | 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 |
510 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
450 | without having to run a program within it. |
511 | without having to run a program within it. |
451 | |
512 | |
452 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
513 | 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 |
514 | entries and will not tinker with pty/tty permissions - you have to do that |
454 | yourself if you want that. |
515 | yourself if you want that. |
455 | |
516 | |
456 | As an extremely special case, specifying C<-1> will completely suppress |
517 | As an extremely special case, specifying C<-1> will completely suppress |
457 | pty/tty operations. |
518 | pty/tty operations, which is probably only useful in conjunction with some |
|
|
519 | perl extension that manages the terminal. |
458 | |
520 | |
459 | Here is a example in perl that illustrates how this option can be used (a |
521 | Here is a example in perl that illustrates how this option can be used (a |
460 | longer example is in F<doc/pty-fd>): |
522 | longer example is in F<doc/pty-fd>): |
461 | |
523 | |
462 | use IO::Pty; |
524 | use IO::Pty; |
… | |
… | |
476 | Comma-separated list of perl extension scripts to use (or not to use) in |
538 | 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. |
539 | this terminal instance. See resource B<perl-ext> for details. |
478 | |
540 | |
479 | =back |
541 | =back |
480 | |
542 | |
481 | =head1 RESOURCES (available also as long-options) |
543 | =head1 RESOURCES |
482 | |
544 | |
483 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
545 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
484 | options) compiled into your version. |
546 | options) compiled into your version. All resources are also available as |
|
|
547 | long-options. |
485 | |
548 | |
486 | You can set and change the resources using X11 tools like B<xrdb>. Many |
549 | 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 |
550 | distribution do also load settings from the B<~/.Xresources> file when X |
488 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
551 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
489 | with later settings overwriting earlier ones: |
552 | with later settings overwriting earlier ones: |
490 | |
553 | |
491 | 1. system-wide app-defaults file, either locale-dependent OR global |
|
|
492 | 2. app-defaults file in $XAPPLRESDIR |
554 | 1. app-defaults file in $XAPPLRESDIR |
|
|
555 | 2. $HOME/.Xdefaults |
493 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
556 | 3. RESOURCE_MANAGER property on root-window of screen 0 |
494 | 4. SCREEN_RESOURCES for the current screen |
557 | 4. SCREEN_RESOURCES property on root-window of the current screen |
495 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
558 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
|
|
559 | 6. resources specified via -xrm on the commandline |
496 | |
560 | |
497 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
561 | 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 |
562 | 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 |
563 | 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 |
564 | configured, while the class name B<URxvt> allows resources unique to |
… | |
… | |
505 | check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl |
569 | check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl |
506 | extensions not documented here): |
570 | extensions not documented here): |
507 | |
571 | |
508 | =over 4 |
572 | =over 4 |
509 | |
573 | |
|
|
574 | =item B<depth:> I<bitdepth> |
|
|
575 | |
|
|
576 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
|
|
577 | option B<-depth>. |
|
|
578 | |
|
|
579 | =item B<buffered:> I<boolean> |
|
|
580 | |
|
|
581 | Compile I<xft>: Turn on/off double-buffering for xft (default enabled). |
|
|
582 | On some card/driver combination enabling it slightly decreases |
|
|
583 | performance, on most it greatly helps it. The slowdown is small, so it |
|
|
584 | should normally be enabled. |
|
|
585 | |
510 | =item B<geometry:> I<geom> |
586 | =item B<geometry:> I<geom> |
511 | |
587 | |
512 | Create the window with the specified X window geometry [default 80x24]; |
588 | Create the window with the specified X window geometry [default 80x24]; |
513 | option B<-geometry>. |
589 | option B<-geometry>. |
514 | |
590 | |
… | |
… | |
527 | Use the specified colour for the colour value I<n>, where 0-7 |
603 | Use the specified colour for the colour value I<n>, where 0-7 |
528 | corresponds to low-intensity (normal) colours and 8-15 corresponds to |
604 | corresponds to low-intensity (normal) colours and 8-15 corresponds to |
529 | high-intensity (bold = bright foreground, blink = bright background) |
605 | high-intensity (bold = bright foreground, blink = bright background) |
530 | colours. The canonical names are as follows: 0=black, 1=red, 2=green, |
606 | colours. The canonical names are as follows: 0=black, 1=red, 2=green, |
531 | 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour |
607 | 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour |
532 | names used are listed in the B<COLORS AND GRAPHICS> section. |
608 | names used are listed in the B<COLOURS AND GRAPHICS> section. |
533 | |
609 | |
534 | Colours higher than 15 cannot be set using resources (yet), but can be |
610 | Colours higher than 15 cannot be set using resources (yet), but can be |
535 | changed using an escape command (see @@RXVT_NAME@@(7)). |
611 | changed using an escape command (see @@RXVT_NAME@@(7)). |
536 | |
612 | |
537 | Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with |
613 | Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with |
… | |
… | |
548 | =item B<colorUL:> I<colour> |
624 | =item B<colorUL:> I<colour> |
549 | |
625 | |
550 | Use the specified colour to display underlined characters when the |
626 | Use the specified colour to display underlined characters when the |
551 | foreground colour is the default. |
627 | foreground colour is the default. |
552 | |
628 | |
553 | =item B<colorRV:> I<colour> |
|
|
554 | |
|
|
555 | Use the specified colour as the background for reverse video |
|
|
556 | characters. |
|
|
557 | |
|
|
558 | =item B<underlineColor:> I<colour> |
629 | =item B<underlineColor:> I<colour> |
559 | |
630 | |
560 | If set, use the specified colour as the colour for the underline |
631 | If set, use the specified colour as the colour for the underline |
561 | itself. If unset, use the foreground colour. |
632 | itself. If unset, use the foreground colour. |
|
|
633 | |
|
|
634 | =item B<highlightColor:> I<colour> |
|
|
635 | |
|
|
636 | If set, use the specified colour as the background for highlighted |
|
|
637 | characters. If unset, use reverse video. |
|
|
638 | |
|
|
639 | =item B<highlightTextColor:> I<colour> |
|
|
640 | |
|
|
641 | If set and highlightColor is set, use the specified colour as the |
|
|
642 | foreground for highlighted characters. |
562 | |
643 | |
563 | =item B<cursorColor:> I<colour> |
644 | =item B<cursorColor:> I<colour> |
564 | |
645 | |
565 | Use the specified colour for the cursor. The default is to use the |
646 | Use the specified colour for the cursor. The default is to use the |
566 | foreground colour; option B<-cr>. |
647 | foreground colour; option B<-cr>. |
… | |
… | |
573 | |
654 | |
574 | =item B<reverseVideo:> I<boolean> |
655 | =item B<reverseVideo:> I<boolean> |
575 | |
656 | |
576 | B<True>: simulate reverse video by foreground and background colours; |
657 | B<True>: simulate reverse video by foreground and background colours; |
577 | option B<-rv>. B<False>: regular screen colours [default]; option |
658 | option B<-rv>. B<False>: regular screen colours [default]; option |
578 | B<+rv>. See note in B<COLORS AND GRAPHICS> section. |
659 | B<+rv>. See note in B<COLOURS AND GRAPHICS> section. |
579 | |
660 | |
580 | =item B<jumpScroll:> I<boolean> |
661 | =item B<jumpScroll:> I<boolean> |
581 | |
662 | |
582 | B<True>: specify that jump scrolling should be used. When scrolling |
663 | B<True>: specify that jump scrolling should be used. When receiving lots |
583 | quickly, fewer screen updates are performed [default]; option B<-j>. |
664 | of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines |
|
|
665 | has been read, resulting in fewer updates while still displaying every |
|
|
666 | received line; option B<-j>. |
|
|
667 | |
584 | B<False>: specify that smooth scrolling should be used; option B<+j>. |
668 | B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will |
|
|
669 | force a screen refresh on each new line it received; option B<+j>. |
585 | |
670 | |
586 | =item B<inheritPixmap:> I<boolean> |
671 | =item B<skipScroll:> I<boolean> |
587 | |
672 | |
588 | B<True>: make the background inherit the parent windows' pixmap, giving |
673 | B<True>: (the default) specify that skip scrolling should be used. When |
589 | artificial transparency. B<False>: do not inherit the parent windows' |
674 | receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while |
590 | pixmap. |
675 | (around 60 times per second), resulting in far fewer updates. This can |
|
|
676 | result in @@RXVT_NAME@@ not ever displaying some of the lines it receives; |
|
|
677 | option B<-ss>. |
|
|
678 | |
|
|
679 | B<False>: specify that everything is to be displayed, even |
|
|
680 | if the refresh is too fast for the human eye to read anything (or the |
|
|
681 | monitor to display anything); option B<+ss>. |
|
|
682 | |
|
|
683 | =item B<transparent:> I<boolean> |
|
|
684 | |
|
|
685 | Turn on/off pseudo-transparency by using the root pixmap as background. |
|
|
686 | |
|
|
687 | B<inheritPixmap> is still accepted as an obsolete alias but will be removed in |
|
|
688 | future versions. |
591 | |
689 | |
592 | =item B<fading:> I<number> |
690 | =item B<fading:> I<number> |
593 | |
691 | |
594 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
692 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
595 | |
693 | |
… | |
… | |
598 | Fade to this colour, when fading is used (see B<fading:>). The default |
696 | Fade to this colour, when fading is used (see B<fading:>). The default |
599 | colour is black; option B<-fadecolor>. |
697 | colour is black; option B<-fadecolor>. |
600 | |
698 | |
601 | =item B<tintColor:> I<colour> |
699 | =item B<tintColor:> I<colour> |
602 | |
700 | |
603 | Tint the transparent background pixmap with the given colour; option |
701 | Tint the transparent background with the given colour. If the RENDER |
604 | B<-tint>. |
702 | extension is not available only black, red, green, yellow, blue, |
|
|
703 | magenta, cyan and white tints can be performed server-side. Note that |
|
|
704 | a black tint yields a completely black image while a white tint yields |
|
|
705 | the image unchanged; option B<-tint>. |
605 | |
706 | |
606 | =item B<shading:> I<number> |
707 | =item B<shading:> I<number> |
607 | |
708 | |
608 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
709 | Darken (0 .. 99) or lighten (101 .. 200) the transparent background. |
609 | image in addition to tinting it. |
710 | A value of 100 means no shading; option B<-sh>. |
|
|
711 | |
|
|
712 | =item B<blurRadius:> I<number> |
|
|
713 | |
|
|
714 | Apply gaussian blur with the specified radius to the transparent |
|
|
715 | background; option B<-blr>. |
|
|
716 | |
|
|
717 | =item B<iconFile:> I<file> |
|
|
718 | |
|
|
719 | Set the application icon pixmap; option B<-icon>. |
610 | |
720 | |
611 | =item B<scrollColor:> I<colour> |
721 | =item B<scrollColor:> I<colour> |
612 | |
722 | |
613 | Use the specified colour for the scrollbar [default #B2B2B2]. |
723 | Use the specified colour for the scrollbar [default #B2B2B2]. |
614 | |
724 | |
… | |
… | |
620 | =item B<borderColor:> I<colour> |
730 | =item B<borderColor:> I<colour> |
621 | |
731 | |
622 | The colour of the border around the text area and between the scrollbar |
732 | The colour of the border around the text area and between the scrollbar |
623 | and the text. |
733 | and the text. |
624 | |
734 | |
625 | =item B<backgroundPixmap:> I<file[;geom]> |
735 | =item B<backgroundPixmap:> I<file[;oplist]> |
626 | |
736 | |
627 | Use the specified XPM file (note the `.xpm' extension is optional) for |
737 | Use the specified image file for the background and also |
628 | the background and also optionally specify its scaling with a geometry |
738 | optionally specify a colon separated list of operations to modify it. |
629 | string B<WxH+X+Y>, in which B<"W" / "H"> specify the |
739 | Supported operations are: |
630 | horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image |
740 | |
631 | centre (percent). A scale of 0 displays the image with tiling. A scale |
741 | =over 4 |
632 | of 1 displays the image without any scaling. A scale of 2 to 9 |
742 | |
633 | specifies an integer number of images in that direction. No image will |
743 | =item B<WxH+X+Y> |
634 | be magnified beyond 10 times its original size. The maximum permitted |
744 | |
635 | scale is 1000. [default 0x0+50+50] |
745 | sets scale and position. B<"W" / "H"> specify the horizontal/vertical |
|
|
746 | scale (percent), and B<"X" / "Y"> locate the image centre (percent). A |
|
|
747 | scale of 0 disables scaling. |
|
|
748 | |
|
|
749 | =item B<op=tile> |
|
|
750 | |
|
|
751 | enables tiling |
|
|
752 | |
|
|
753 | =item B<op=keep-aspect> |
|
|
754 | |
|
|
755 | maintain the image aspect ratio when scaling |
|
|
756 | |
|
|
757 | =item B<op=root-align> |
|
|
758 | |
|
|
759 | use the position of the terminal window relative to the root window as |
|
|
760 | the image offset, simulating a root window background |
|
|
761 | |
|
|
762 | =back |
|
|
763 | |
|
|
764 | The default scale and position setting is C<100x100+50+50>. |
|
|
765 | Alternatively, a predefined set of templates can be used to achieve |
|
|
766 | the most common setups: |
|
|
767 | |
|
|
768 | =over 4 |
|
|
769 | |
|
|
770 | =item B<style=tiled> |
|
|
771 | |
|
|
772 | the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile |
|
|
773 | |
|
|
774 | =item B<style=aspect-stretched> |
|
|
775 | |
|
|
776 | the image is scaled to fill the whole window maintaining the aspect |
|
|
777 | ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect |
|
|
778 | |
|
|
779 | =item B<style=stretched> |
|
|
780 | |
|
|
781 | the image is scaled to fill the whole window. Equivalent to 100x100 |
|
|
782 | |
|
|
783 | =item B<style=centered> |
|
|
784 | |
|
|
785 | the image is centered with no scaling. Equivalent to 0x0+50+50 |
|
|
786 | |
|
|
787 | =item B<style=root-tiled> |
|
|
788 | |
|
|
789 | the image is tiled with no scaling and using 'root' positioning. |
|
|
790 | Equivalent to 0x0:op=tile:op=root-align |
|
|
791 | |
|
|
792 | =back |
|
|
793 | |
|
|
794 | If multiple templates are specified the last one wins. Note that a |
|
|
795 | template overrides all the scale, position and operations settings. |
|
|
796 | |
|
|
797 | If used in conjunction with B<-tr> option, the specified pixmap will be |
|
|
798 | blended over the transparent background using alpha-blending. |
636 | |
799 | |
637 | =item B<path:> I<path> |
800 | =item B<path:> I<path> |
638 | |
801 | |
639 | Specify the colon-delimited search path for finding XPM files. |
802 | Specify the colon-delimited search path for finding background image files. |
640 | |
803 | |
641 | =item B<font:> I<fontlist> |
804 | =item B<font:> I<fontlist> |
642 | |
805 | |
643 | Select the fonts to be used. This is a comma separated list of font names |
806 | 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 |
807 | that are checked in order when trying to find glyphs for characters. The |
… | |
… | |
667 | it is named first) and thus defines the character cell grid to be 9 pixels |
830 | it is named first) and thus defines the character cell grid to be 9 pixels |
668 | wide and 15 pixels high. |
831 | wide and 15 pixels high. |
669 | |
832 | |
670 | The second font is just used to add additional unicode characters not in |
833 | The second font is just used to add additional unicode characters not in |
671 | the base font, likewise the third, which is unfortunately non-bold, but |
834 | the base font, likewise the third, which is unfortunately non-bold, but |
672 | the bold version of the font does contain less characters, so this is a |
835 | the bold version of the font does contain fewer characters, so this is a |
673 | useful supplement. |
836 | useful supplement. |
674 | |
837 | |
675 | The third font is an Xft font with aliasing turned off, and the characters |
838 | The third font is an Xft font with aliasing turned off, and the characters |
676 | are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font |
839 | are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font |
677 | contains other characters, but we are not interested in them. |
840 | contains other characters, but we are not interested in them. |
… | |
… | |
701 | text font will being used for the given style. |
864 | text font will being used for the given style. |
702 | |
865 | |
703 | =item B<intensityStyles:> I<boolean> |
866 | =item B<intensityStyles:> I<boolean> |
704 | |
867 | |
705 | When font styles are not enabled, or this option is enabled (B<True>, |
868 | 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 |
869 | option B<-is>, the default), bold/blink font styles imply high |
707 | intensity foreground/backround colours. Disabling this option (B<False>, |
870 | intensity foreground/background colours. Disabling this option (B<False>, |
708 | option B<+is>) disables this behaviour, the high intensity colours are not |
871 | option B<+is>) disables this behaviour, the high intensity colours are not |
709 | reachable. |
872 | 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 | |
873 | |
722 | =item B<title:> I<string> |
874 | =item B<title:> I<string> |
723 | |
875 | |
724 | Set window title string, the default title is the command-line |
876 | Set window title string, the default title is the command-line |
725 | specified after the B<-e> option, if any, otherwise the application |
877 | specified after the B<-e> option, if any, otherwise the application |
… | |
… | |
734 | =item B<mapAlert:> I<boolean> |
886 | =item B<mapAlert:> I<boolean> |
735 | |
887 | |
736 | B<True>: de-iconify (map) on receipt of a bell character. B<False>: no |
888 | 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]. |
889 | de-iconify (map) on receipt of a bell character [default]. |
738 | |
890 | |
|
|
891 | =item B<urgentOnBell:> I<boolean> |
|
|
892 | |
|
|
893 | B<True>: set the urgency hint for the wm on receipt of a bell character. |
|
|
894 | B<False>: do not set the urgency hint [default]. |
|
|
895 | |
|
|
896 | @@RXVT_NAME@@ resets the urgency hint on every focus change. |
|
|
897 | |
739 | =item B<visualBell:> I<boolean> |
898 | =item B<visualBell:> I<boolean> |
740 | |
899 | |
741 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
900 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
742 | B<False>: no visual bell [default]; option B<+vb>. |
901 | B<False>: no visual bell [default]; option B<+vb>. |
743 | |
902 | |
… | |
… | |
764 | Example: |
923 | Example: |
765 | |
924 | |
766 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
925 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
767 | |
926 | |
768 | This creates a new file in your home directory with the screen contents |
927 | This creates a new file in your home directory with the screen contents |
769 | everytime you hit C<Print>. |
928 | every time you hit C<Print>. |
|
|
929 | |
|
|
930 | =item B<scrollstyle:> I<mode> |
|
|
931 | |
|
|
932 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
|
|
933 | the author's favourite. |
|
|
934 | |
|
|
935 | =item B<thickness:> I<number> |
|
|
936 | |
|
|
937 | Set the scrollbar width in pixels. |
770 | |
938 | |
771 | =item B<scrollBar:> I<boolean> |
939 | =item B<scrollBar:> I<boolean> |
772 | |
940 | |
773 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
941 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
774 | disable the scrollbar; option B<+sb>. |
942 | disable the scrollbar; option B<+sb>. |
… | |
… | |
794 | B<False>: do not scroll to bottom when tty receives output; option |
962 | B<False>: do not scroll to bottom when tty receives output; option |
795 | B<+si>. |
963 | B<+si>. |
796 | |
964 | |
797 | =item B<scrollWithBuffer:> I<boolean> |
965 | =item B<scrollWithBuffer:> I<boolean> |
798 | |
966 | |
799 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
967 | B<True>: scroll with scrollback buffer when tty receives new lines (i.e. |
800 | B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll |
968 | try to show the same lines) and B<scrollTtyOutput> is False; option |
801 | with scrollback buffer when tty recieves new lines; option B<+sw>. |
969 | B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives |
|
|
970 | new lines; option B<+sw>. |
802 | |
971 | |
803 | =item B<scrollTtyKeypress:> I<boolean> |
972 | =item B<scrollTtyKeypress:> I<boolean> |
804 | |
973 | |
805 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
974 | 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 |
975 | are those which are intercepted by rxvt-unicode for special handling and |
… | |
… | |
837 | =item B<termName:> I<termname> |
1006 | =item B<termName:> I<termname> |
838 | |
1007 | |
839 | Specifies the terminal type name to be set in the B<TERM> environment |
1008 | Specifies the terminal type name to be set in the B<TERM> environment |
840 | variable; option B<-tn>. |
1009 | variable; option B<-tn>. |
841 | |
1010 | |
842 | =item B<linespace:> I<number> |
1011 | =item B<lineSpace:> I<number> |
843 | |
1012 | |
844 | Specifies number of lines (pixel height) to insert between each row of |
1013 | Specifies number of lines (pixel height) to insert between each row of |
845 | the display [default 0]; option B<-lsp>. |
1014 | the display [default 0]; option B<-lsp>. |
846 | |
1015 | |
847 | =item B<meta8:> I<boolean> |
1016 | =item B<meta8:> I<boolean> |
… | |
… | |
861 | |
1030 | |
862 | =item B<cursorBlink:> I<boolean> |
1031 | =item B<cursorBlink:> I<boolean> |
863 | |
1032 | |
864 | B<True>: blink the cursor. B<False>: do not blink the cursor [default]; |
1033 | B<True>: blink the cursor. B<False>: do not blink the cursor [default]; |
865 | option B<-bc>. |
1034 | option B<-bc>. |
|
|
1035 | |
|
|
1036 | =item B<cursorUnderline:> I<boolean> |
|
|
1037 | |
|
|
1038 | B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default]; |
|
|
1039 | option B<-uc>. |
866 | |
1040 | |
867 | =item B<pointerBlank:> I<boolean> |
1041 | =item B<pointerBlank:> I<boolean> |
868 | |
1042 | |
869 | B<True>: blank the pointer when a key is pressed or after a set number |
1043 | B<True>: blank the pointer when a key is pressed or after a set number |
870 | of seconds of inactivity. B<False>: the pointer is always visible |
1044 | of seconds of inactivity. B<False>: the pointer is always visible |
… | |
… | |
884 | large number (e.g. C<987654321>) to effectively disable the timeout. |
1058 | large number (e.g. C<987654321>) to effectively disable the timeout. |
885 | |
1059 | |
886 | =item B<backspacekey:> I<string> |
1060 | =item B<backspacekey:> I<string> |
887 | |
1061 | |
888 | The string to send when the backspace key is pressed. If set to B<DEC> |
1062 | The string to send when the backspace key is pressed. If set to B<DEC> |
889 | or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> |
1063 | or unset it will send B<Delete> (code 127) or, with control, B<Backspace> |
890 | (code 8) - which can be reversed with the appropriate DEC private mode |
1064 | (code 8) - which can be reversed with the appropriate DEC private mode |
891 | escape sequence. |
1065 | escape sequence. |
892 | |
1066 | |
893 | =item B<deletekey:> I<string> |
1067 | =item B<deletekey:> I<string> |
894 | |
1068 | |
… | |
… | |
896 | pressed. If unset it will send the sequence traditionally associated |
1070 | pressed. If unset it will send the sequence traditionally associated |
897 | with the B<Execute> key. |
1071 | with the B<Execute> key. |
898 | |
1072 | |
899 | =item B<cutchars:> I<string> |
1073 | =item B<cutchars:> I<string> |
900 | |
1074 | |
901 | The characters used as delimiters for double-click word selection. The |
1075 | The characters used as delimiters for double-click word selection |
902 | built-in default: |
1076 | (whitespace delimiting is added automatically if resource is given). |
903 | |
1077 | |
|
|
1078 | When the perl selection extension is in use (the default if compiled |
|
|
1079 | in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these |
|
|
1080 | characters will be created (if the resource exists, otherwise, no regex |
|
|
1081 | will be created). In this mode, characters outside ISO-8859-1 can be used. |
|
|
1082 | |
|
|
1083 | When the selection extension is not used, only ISO-8859-1 characters can |
|
|
1084 | be used. If not specified, the built-in default is used: |
|
|
1085 | |
904 | B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> |
1086 | B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> |
905 | |
1087 | |
906 | =item B<preeditType:> I<style> |
1088 | =item B<preeditType:> I<style> |
907 | |
1089 | |
908 | B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. |
1090 | B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. |
909 | |
1091 | |
… | |
… | |
963 | |
1145 | |
964 | Turn on/off secondary screen (default enabled). |
1146 | Turn on/off secondary screen (default enabled). |
965 | |
1147 | |
966 | =item B<secondaryScroll:> I<boolean> |
1148 | =item B<secondaryScroll:> I<boolean> |
967 | |
1149 | |
968 | Turn on/off secondary screen scroll (default enabled). If the this |
1150 | Turn on/off secondary screen scroll (default enabled). If this |
969 | option is enabled, scrolls on the secondary screen will change the |
1151 | option is enabled, scrolls on the secondary screen will change the |
970 | scrollback buffer and switching to/from the secondary screen will |
1152 | scrollback buffer and, when secondaryScreen is off, switching |
971 | instead scroll the screen up. |
1153 | to/from the secondary screen will instead scroll the screen up. |
972 | |
1154 | |
973 | =item B<hold>: I<boolean> |
1155 | =item B<hold>: I<boolean> |
974 | |
1156 | |
975 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
1157 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
976 | will not immediately destroy its window when the program executed within |
1158 | will not immediately destroy its window when the program executed within |
977 | it exits. Instead, it will wait till it is being killed or closed by the |
1159 | it exits. Instead, it will wait till it is being killed or closed by the |
978 | user. |
1160 | user. |
|
|
1161 | |
|
|
1162 | =item B<chdir>: I<path> |
|
|
1163 | |
|
|
1164 | Sets the working directory for the shell (or the command specified via |
|
|
1165 | B<-e>). The I<path> must be an absolute path and it must exist for |
|
|
1166 | @@RXVT_NAME@@ to start. If it isn't specified then the current working |
|
|
1167 | directory will be used; option B<-cd>. |
979 | |
1168 | |
980 | =item B<keysym.>I<sym>: I<string> |
1169 | =item B<keysym.>I<sym>: I<string> |
981 | |
1170 | |
982 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
1171 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
983 | intervening resource name B<keysym.> cannot be omitted. |
1172 | intervening resource name B<keysym.> cannot be omitted. |
… | |
… | |
997 | searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and |
1186 | 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 |
1187 | 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 |
1188 | 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. |
1189 | performed in an exact manner; however, the closest match is assured. |
1001 | |
1190 | |
1002 | I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, |
1191 | 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, |
1192 | number), see RESOURCES in C<man 7 X> for further 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 | |
1193 | |
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 | |
|
|
1013 | You can define a range of keysyms in one shot by providing a I<string> |
1194 | You can define a range of keysyms in one shot by |
|
|
1195 | loading the C<keysym-list> perl extension and providing a I<string> |
1014 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' |
1196 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' |
1015 | should be a character not used by the strings. |
1197 | should be a character not used by the strings. |
1016 | |
1198 | |
1017 | Its usage can be demonstrated by an example: |
1199 | Its usage can be demonstrated by an example: |
1018 | |
1200 | |
1019 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
1201 | URxvt.keysym.M-C-0x61: list|\033<|abc|> |
1020 | |
1202 | |
1021 | The above line is equivalent to the following three lines: |
1203 | The above line is equivalent to the following three lines: |
1022 | |
1204 | |
1023 | URxvt.keysym.Meta-Control-0x61: \033<M-C-a> |
1205 | URxvt.keysym.Meta-Control-0x61: \033<a> |
1024 | URxvt.keysym.Meta-Control-0x62: \033<M-C-b> |
1206 | URxvt.keysym.Meta-Control-0x62: \033<b> |
1025 | URxvt.keysym.Meta-Control-0x63: \033<M-C-c> |
1207 | URxvt.keysym.Meta-Control-0x63: \033<c> |
1026 | |
1208 | |
1027 | If I<string> takes the form of C<command:STRING>, the specified B<STRING> |
1209 | If I<string> takes the form of C<command:STRING>, the specified B<STRING> |
1028 | is interpreted and executed as @@RXVT_NAME@@'s control sequence. For |
1210 | is interpreted and executed as @@RXVT_NAME@@'s control sequence. For |
1029 | example the following means "change the current locale to C<zh_CN.GBK> |
1211 | example the following means "change the current locale to C<zh_CN.GBK> |
1030 | when Control-Meta-c is being pressed": |
1212 | when Control-Meta-c is being pressed": |
1031 | |
1213 | |
1032 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1214 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1033 | |
1215 | |
1034 | If I<string> takes the form C<perl:STRING>, then the specified B<STRING> |
1216 | If I<string> takes the form C<perl:STRING>, then the specified B<STRING> |
1035 | is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) |
1217 | is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3) |
1036 | manpage. For example, the F<selection> extension (activated via |
1218 | manpage. For example, the F<selection> extension (activated via |
1037 | C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: |
1219 | C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: |
1038 | |
1220 | |
1039 | URxvt.keysym.M-C-c: perl:selection:rot13 |
1221 | URxvt.keysym.M-C-c: perl:selection:rot13 |
1040 | |
1222 | |
1041 | Due the the large number of modifier combinations, a defined key mapping |
1223 | Due the the large number of modifier combinations, a defined key mapping |
1042 | will match if at I<at least> the specified identifiers are being set, and |
1224 | will match if I<at least> the specified identifiers are being set, and |
1043 | no other key mappings with those and more bits are being defined. That |
1225 | no other key mappings with those and more bits are being defined. That |
1044 | means that defining a key map for C<a> will automatically provide |
1226 | means that defining a key map for C<a> will automatically provide |
1045 | definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined |
1227 | definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined |
1046 | mappings themselves. |
1228 | mappings themselves. |
1047 | |
1229 | |
… | |
… | |
1083 | example, C<default,-selection> will use all the default extension except |
1265 | example, C<default,-selection> will use all the default extension except |
1084 | C<selection>. |
1266 | C<selection>. |
1085 | |
1267 | |
1086 | Extension names can also be followed by an argument in angle brackets |
1268 | 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 |
1269 | (e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for |
1088 | searchable scorllback to Alt/Meta-s). Mentioning the same extension |
1270 | searchable scrollback to Alt/Meta-s). Mentioning the same extension |
1089 | multiple times with different arguments will pass multiple arguments to |
1271 | multiple times with different arguments will pass multiple arguments to |
1090 | the extension. |
1272 | the extension. |
1091 | |
1273 | |
1092 | Each extension is looked up in the library directories, loaded if |
1274 | Each extension is looked up in the library directories, loaded if |
1093 | necessary, and bound to the current terminal instance. |
1275 | necessary, and bound to the current terminal instance. |
… | |
… | |
1098 | all instances, while B<perl-ext> is used for specific instances. |
1280 | all instances, while B<perl-ext> is used for specific instances. |
1099 | |
1281 | |
1100 | =item B<perl-eval>: I<string> |
1282 | =item B<perl-eval>: I<string> |
1101 | |
1283 | |
1102 | Perl code to be evaluated when all extensions have been registered. See |
1284 | Perl code to be evaluated when all extensions have been registered. See |
1103 | the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource |
1285 | the @@RXVT_NAME@@perl(3) manpage. |
1104 | will be ignored when running setuid/setgid. |
|
|
1105 | |
1286 | |
1106 | =item B<perl-lib>: I<path> |
1287 | =item B<perl-lib>: I<path> |
1107 | |
1288 | |
1108 | Colon-separated list of additional directories that hold extension |
1289 | Colon-separated list of additional directories that hold extension |
1109 | scripts. When looking for extensions specified by the C<perl> resource, |
1290 | scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look |
1110 | @@RXVT_NAME@@ will first look in these directories and then in |
1291 | in these directories, then in C<$RXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and |
1111 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource |
1292 | lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
1112 | will be ignored when running setuid/setgid. |
|
|
1113 | |
1293 | |
1114 | See the @@RXVT_NAME@@perl(3) manpage. |
1294 | See the @@RXVT_NAME@@perl(3) manpage. |
1115 | |
1295 | |
1116 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1296 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1117 | |
1297 | |
… | |
… | |
1129 | (default: C<M-s>). |
1309 | (default: C<M-s>). |
1130 | |
1310 | |
1131 | =item B<urlLauncher>: I<string> |
1311 | =item B<urlLauncher>: I<string> |
1132 | |
1312 | |
1133 | Specifies the program to be started with a URL argument. Used by the |
1313 | Specifies the program to be started with a URL argument. Used by the |
1134 | C<selection-popup> and C<mark-urls> perl extensions. |
1314 | C<selection-popup> and C<matcher> perl extensions. |
1135 | |
1315 | |
1136 | =item B<transient-for>: I<windowid> |
1316 | =item B<transient-for>: I<windowid> |
1137 | |
1317 | |
1138 | Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. |
1318 | Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. |
1139 | |
1319 | |
1140 | =item B<override-redirect>: I<boolean> |
1320 | =item B<override-redirect>: I<boolean> |
1141 | |
1321 | |
1142 | Compile I<frills>: Sets override-redirect for the terminal window, making |
1322 | Compile I<frills>: Sets override-redirect for the terminal window, making |
1143 | it almost invisible to window managers; option B<-override-redirect>. |
1323 | it almost invisible to window managers; option B<-override-redirect>. |
|
|
1324 | |
|
|
1325 | =item B<iso14755:> I<boolean> |
|
|
1326 | |
|
|
1327 | Turn on/off ISO 14755 (default enabled). |
|
|
1328 | |
|
|
1329 | =item B<iso14755_52:> I<boolean> |
|
|
1330 | |
|
|
1331 | Turn on/off ISO 14755 5.2 mode (default enabled). |
1144 | |
1332 | |
1145 | =back |
1333 | =back |
1146 | |
1334 | |
1147 | =head1 THE SCROLLBAR |
1335 | =head1 THE SCROLLBAR |
1148 | |
1336 | |
… | |
… | |
1167 | application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> |
1355 | application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> |
1168 | (Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the |
1356 | (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), |
1357 | up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), |
1170 | respectively. |
1358 | respectively. |
1171 | |
1359 | |
1172 | =head1 TEXT SELECTION AND INSERTION |
1360 | =head1 THE SELECTION: SELECTING AND PASTING TEXT |
1173 | |
1361 | |
1174 | The behaviour of text selection and insertion mechanism is similar to |
1362 | The behaviour of text selection and insertion/pasting mechanism is similar |
1175 | I<xterm>(1). |
1363 | to I<xterm>(1). |
1176 | |
1364 | |
1177 | =over 4 |
1365 | =over 4 |
1178 | |
1366 | |
1179 | =item B<Selection>: |
1367 | =item B<Selecting>: |
1180 | |
1368 | |
1181 | Left click at the beginning of the region, drag to the end of the region |
1369 | 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 |
1370 | 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 |
1371 | to select a word; Left triple-click to select the entire logical line |
1184 | (which can span multiple screen lines), unless modified by resource |
1372 | (which can span multiple screen lines), unless modified by resource |
… | |
… | |
1188 | (Compile: I<frills>) will create a rectangular selection instead of a |
1376 | (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 |
1377 | 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 |
1378 | selection, and trailing whitespace is visually underlined and removed from |
1191 | the selection. |
1379 | the selection. |
1192 | |
1380 | |
1193 | =item B<Insertion>: |
1381 | =item B<Pasting>: |
1194 | |
1382 | |
1195 | Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in |
1383 | 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 |
1384 | window causes the value of the PRIMARY selection (or CLIPBOARD with the |
1197 | inserted as if it had been typed on the keyboard. |
1385 | B<Meta> modifier) to be inserted as if it had been typed on the keyboard. |
|
|
1386 | |
|
|
1387 | Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be |
|
|
1388 | inserted too. |
1198 | |
1389 | |
1199 | =back |
1390 | =back |
1200 | |
1391 | |
1201 | =head1 CHANGING FONTS |
1392 | =head1 CHANGING FONTS |
1202 | |
1393 | |
… | |
… | |
1216 | |
1407 | |
1217 | =head1 ISO 14755 SUPPORT |
1408 | =head1 ISO 14755 SUPPORT |
1218 | |
1409 | |
1219 | ISO 14755 is a standard for entering and viewing unicode characters |
1410 | ISO 14755 is a standard for entering and viewing unicode characters |
1220 | and character codes using the keyboard. It consists of 4 parts. The |
1411 | and character codes using the keyboard. It consists of 4 parts. The |
1221 | first part is available rxvt-unicode has been compiled with |
1412 | first part is available if rxvt-unicode has been compiled with |
1222 | C<--enable-frills>, the rest is available when rxvt-unicode was compiled |
1413 | C<--enable-frills>, the rest is available when rxvt-unicode was compiled |
1223 | with C<--enable-iso14755>. |
1414 | with C<--enable-iso14755>. |
1224 | |
1415 | |
1225 | =over 4 |
1416 | =over 4 |
1226 | |
1417 | |
… | |
… | |
1246 | This mode lets you input characters representing the keycap symbols of |
1437 | This mode lets you input characters representing the keycap symbols of |
1247 | your keyboard, if representable in the current locale encoding. |
1438 | your keyboard, if representable in the current locale encoding. |
1248 | |
1439 | |
1249 | Start by pressing C<Control> and C<Shift> together, then releasing |
1440 | 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 |
1441 | 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 |
1442 | invoke its usual function but instead will insert the corresponding |
1252 | keycap symbol. The symbol will only be entered when the key has been |
1443 | 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 |
1444 | 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 |
1445 | C<ISO Level 2 Switch>, although your intention might have been to enter a |
1255 | reverse tab (Shift-Tab). |
1446 | reverse tab (Shift-Tab). |
1256 | |
1447 | |
… | |
… | |
1284 | B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that |
1475 | B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that |
1285 | it can be seen via the I<who(1)> command, and can accept messages. To |
1476 | it can be seen via the I<who(1)> command, and can accept messages. To |
1286 | allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root |
1477 | allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root |
1287 | on some systems or setgid to root or to some other group on others. |
1478 | on some systems or setgid to root or to some other group on others. |
1288 | |
1479 | |
1289 | =head1 COLORS AND GRAPHICS |
1480 | =head1 COLOURS AND GRAPHICS |
1290 | |
1481 | |
1291 | In addition to the default foreground and background colours, |
1482 | In addition to the default foreground and background colours, |
1292 | B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus |
1483 | B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus |
1293 | high-intensity bold/blink versions of the same). Here is a list of the |
1484 | high-intensity (potentially bold/blink) versions of the same, and 72 (or |
1294 | colours with their B<rgb.txt> names. |
1485 | 240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB |
|
|
1486 | cube plus a 8 (24) colour greyscale ramp. |
|
|
1487 | |
|
|
1488 | Here is a list of the ANSI colours with their names. |
1295 | |
1489 | |
1296 | =begin table |
1490 | =begin table |
1297 | |
1491 | |
1298 | B<color0> (black) = Black |
1492 | B<color0> (black) = Black |
1299 | B<color1> (red) = Red3 |
1493 | B<color1> (red) = Red3 |
… | |
… | |
1319 | It is also possible to specify the colour values of B<foreground>, |
1513 | It is also possible to specify the colour values of B<foreground>, |
1320 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1514 | 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 |
1515 | a number 0-15, as a convenient shorthand to reference the colour name of |
1322 | color0-color15. |
1516 | color0-color15. |
1323 | |
1517 | |
|
|
1518 | The following text gives values for the standard 88 colour mode (and |
|
|
1519 | values for the 256 colour mode in parentheses). |
|
|
1520 | |
|
|
1521 | The RGB cube uses indices 16..79 (16..231) using the following formulas: |
|
|
1522 | |
|
|
1523 | index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 |
|
|
1524 | index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15 |
|
|
1525 | |
|
|
1526 | The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% |
|
|
1527 | steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of |
|
|
1528 | the RGB cube. |
|
|
1529 | |
|
|
1530 | Together, all those colours implement the 88 (256) colour xterm |
|
|
1531 | colours. Only the first 16 can be changed using resources currently, the |
|
|
1532 | rest can only be changed via command sequences ("escape codes"). |
|
|
1533 | |
|
|
1534 | Applications are advised to use terminfo or command sequences to discover |
|
|
1535 | number and RGB values of all colours (yes, you can query this...). |
|
|
1536 | |
1324 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1537 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1325 | always swapping the foreground/background colours. This is in contrast to |
1538 | 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 |
1539 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1327 | been specified. For example, |
1540 | been specified. For example, |
1328 | |
1541 | |
|
|
1542 | @@RXVT_NAME@@ -fg Black -bg White -rv |
|
|
1543 | |
|
|
1544 | would yield White on Black, while on I<xterm>(1) it would yield Black on |
|
|
1545 | White. |
|
|
1546 | |
|
|
1547 | =head2 ALPHA CHANNEL SUPPORT |
|
|
1548 | |
|
|
1549 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
|
|
1550 | their act together, rxvt-unicode will do its own alpha channel management: |
|
|
1551 | |
|
|
1552 | You can prefix any colour with an opaqueness percentage enclosed in |
|
|
1553 | brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage |
|
|
1554 | (0-100) that specifies the opacity of the colour, where C<0> is completely |
|
|
1555 | transparent and C<100> is completely opaque. For example, C<[50]red> is a |
|
|
1556 | half-transparent red, while C<[95]#00ff00> is an almost opaque green. This |
|
|
1557 | is the recommended format to specify transparency values, and works with |
|
|
1558 | all ways to specify a colour. |
|
|
1559 | |
|
|
1560 | For complete control, rxvt-unicode also supports |
|
|
1561 | C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour |
|
|
1562 | specifications, where the additional C<aaaa> component specifies opacity |
|
|
1563 | (alpha) values. The minimum value of C<0000> is completely transparent, |
|
|
1564 | while C<ffff> is completely opaque). The two example colours from |
|
|
1565 | earlier could also be specified as C<rgba:ff00/0000/0000/8000> and |
|
|
1566 | C<rgba:0000/ff00/0000/f332>. |
|
|
1567 | |
|
|
1568 | You probably need to specify B<"-depth 32">, too, to force a visual with |
|
|
1569 | alpha channels, and have the luck that your X-server uses ARGB pixel |
|
|
1570 | layout, as X is far from just supporting ARGB visuals out of the box, and |
|
|
1571 | rxvt-unicode just fudges around. |
|
|
1572 | |
|
|
1573 | For example, the following selects an almost completely transparent black |
|
|
1574 | background, and an almost opaque pink foreground: |
|
|
1575 | |
|
|
1576 | @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink" |
|
|
1577 | |
|
|
1578 | When not using a background image, then the interpretation of the |
|
|
1579 | alpha channel is up to your compositing manager (most interpret it as |
|
|
1580 | transparency of course). |
|
|
1581 | |
|
|
1582 | When using a background pixmap or pseudo-transparency, then the background |
|
|
1583 | colour will always behave as if it were completely transparent (so the |
|
|
1584 | background image shows instead), regardless of how it was specified, while |
|
|
1585 | other colours will either be transparent as specified (the background |
|
|
1586 | image will show through) on servers supporting the RENDER extension, or |
|
|
1587 | fully opaque on servers not supporting the RENDER EXTENSION. |
|
|
1588 | |
|
|
1589 | Please note that due to bugs in Xft, specifying alpha values might result |
|
|
1590 | in garbage being displayed when the X-server does not support the RENDER |
|
|
1591 | extension. |
|
|
1592 | |
|
|
1593 | =head1 ENVIRONMENT |
|
|
1594 | |
|
|
1595 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
|
|
1596 | |
1329 | =over 4 |
1597 | =over 4 |
1330 | |
1598 | |
1331 | =item B<@@RXVT_NAME@@ -fg Black -bg White -rv> |
|
|
1332 | |
|
|
1333 | would yield White on Black, while on I<xterm>(1) it would yield Black |
|
|
1334 | on White. |
|
|
1335 | |
|
|
1336 | =back |
|
|
1337 | |
|
|
1338 | =head1 ENVIRONMENT |
|
|
1339 | |
|
|
1340 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
|
|
1341 | |
|
|
1342 | =over 4 |
|
|
1343 | |
|
|
1344 | =item B<TERM> |
1599 | =item B<TERM> |
1345 | |
1600 | |
1346 | Normally set to C<rxvt-unicode>, unless overwritten at configure time, via |
1601 | Normally set to C<rxvt-unicode>, unless overwritten at configure time, via |
1347 | resources or on the commandline. |
1602 | resources or on the command line. |
1348 | |
1603 | |
1349 | =item B<COLORTERM> |
1604 | =item B<COLORTERM> |
1350 | |
1605 | |
1351 | Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was |
1606 | Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was |
1352 | compiled with XPM support, and optionally with the added extension |
1607 | compiled with background image support, and optionally with the added |
1353 | C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. |
1608 | extension C<-mono> to indicate that rxvt-unicode runs on a monochrome |
|
|
1609 | screen. |
1354 | |
1610 | |
1355 | =item B<COLORFGBG> |
1611 | =item B<COLORFGBG> |
1356 | |
1612 | |
1357 | Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is |
1613 | 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 |
1614 | 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 |
1615 | 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 |
1616 | 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@@ |
1617 | 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 |
1618 | was compiled with background image support. Libraries like C<ncurses> |
1363 | (and do) use this information to optimize screen output. |
1619 | and C<slang> can (and do) use this information to optimize screen output. |
1364 | |
1620 | |
1365 | =item B<WINDOWID> |
1621 | =item B<WINDOWID> |
1366 | |
1622 | |
1367 | Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel |
1623 | 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 |
1624 | window, which usually has subwindows for the scrollbar, the terminal |
… | |
… | |
1374 | C<--with-terminfo=PATH>. |
1630 | C<--with-terminfo=PATH>. |
1375 | |
1631 | |
1376 | =item B<DISPLAY> |
1632 | =item B<DISPLAY> |
1377 | |
1633 | |
1378 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1634 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1379 | display in it's child processes. |
1635 | display in its child processes if C<-display> isn't used to override. It |
|
|
1636 | defaults to C<:0> if it doesn't exist. |
1380 | |
1637 | |
1381 | =item B<SHELL> |
1638 | =item B<SHELL> |
1382 | |
1639 | |
1383 | The shell to be used for command execution, defaults to C</bin/sh>. |
1640 | The shell to be used for command execution, defaults to C</bin/sh>. |
1384 | |
1641 | |
1385 | =item B<RXVT_SOCKET> |
1642 | =item B<RXVT_SOCKET> (sic) |
1386 | |
1643 | |
1387 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1644 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1388 | @@RXVT_NAME@@d(1). |
1645 | @@RXVT_NAME@@d(1). |
1389 | |
1646 | |
1390 | Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. |
1647 | Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>. |
|
|
1648 | |
|
|
1649 | =item B<RXVT_PERL_LIB> (sic) |
|
|
1650 | |
|
|
1651 | Additional F<:>-separated library search path for perl extensions. Will be |
|
|
1652 | searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library |
|
|
1653 | directory. |
1391 | |
1654 | |
1392 | =item B<HOME> |
1655 | =item B<HOME> |
1393 | |
1656 | |
1394 | Used to locate the default directory for the unix domain socket for |
1657 | Used to locate the default directory for the unix domain socket for |
1395 | daemon communications and to locate various resource files (such as |
1658 | daemon communications and to locate various resource files (such as |
1396 | C<.Xdefaults>) |
1659 | C<.Xdefaults>) |
1397 | |
1660 | |
1398 | =item B<XAPPLRESDIR> |
1661 | =item B<XAPPLRESDIR> |
1399 | |
1662 | |
1400 | Directory where various X resource files are being located. |
1663 | Directory where application-specific X resource files are located. |
1401 | |
1664 | |
1402 | =item B<XENVIRONMENT> |
1665 | =item B<XENVIRONMENT> |
1403 | |
1666 | |
1404 | If set and accessible, gives the name of a X resource file to be loaded by |
1667 | If set and accessible, gives the name of a X resource file to be loaded by |
1405 | @@RXVT_NAME@@. |
1668 | @@RXVT_NAME@@. |
… | |
… | |
1410 | |
1673 | |
1411 | =over 4 |
1674 | =over 4 |
1412 | |
1675 | |
1413 | =item B</usr/lib/X11/rgb.txt> |
1676 | =item B</usr/lib/X11/rgb.txt> |
1414 | |
1677 | |
1415 | Color names. |
1678 | Colour names. |
1416 | |
1679 | |
1417 | =back |
1680 | =back |
1418 | |
1681 | |
1419 | =head1 SEE ALSO |
1682 | =head1 SEE ALSO |
1420 | |
1683 | |
… | |
… | |
1426 | |
1689 | |
1427 | =item Project Coordinator |
1690 | =item Project Coordinator |
1428 | |
1691 | |
1429 | Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1692 | Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1430 | |
1693 | |
1431 | L<http://software.schmorp.de/#rxvt-unicode> |
1694 | L<http://software.schmorp.de/pkg/rxvt-unicode.html> |
1432 | |
1695 | |
1433 | =back |
1696 | =back |
1434 | |
1697 | |
1435 | =head1 AUTHORS |
1698 | =head1 AUTHORS |
1436 | |
1699 | |
… | |
… | |
1459 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1722 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1460 | |
1723 | |
1461 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1724 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1462 | |
1725 | |
1463 | Rewrote screen display and text selection routines. |
1726 | Rewrote screen display and text selection routines. |
1464 | |
1727 | |
1465 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1728 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1466 | |
1729 | |
1467 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1730 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1468 | |
1731 | |
1469 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |
1732 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |
… | |
… | |
1471 | |
1734 | |
1472 | Project Coordinator (Changes 1.0 -) |
1735 | Project Coordinator (Changes 1.0 -) |
1473 | |
1736 | |
1474 | =item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> |
1737 | =item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> |
1475 | |
1738 | |
1476 | Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. |
1739 | pty/utmp code rewrite, image code improvements, many random hacks and bugfixes. |
1477 | |
1740 | |
1478 | =back |
1741 | =back |
1479 | |
1742 | |