… | |
… | |
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<frills>: Attempt to find a visual with the given bit depth; |
|
|
104 | resource B<depth>. |
|
|
105 | |
|
|
106 | [Please note that many X servers (and libXft) are buggy with |
|
|
107 | respect to C<-depth 32> and/or alpha channels, and will cause all sorts |
|
|
108 | of graphical corruption. This is harmless, but we can't do anything about |
|
|
109 | this, so watch out] |
|
|
110 | |
|
|
111 | =item B<-visual> I<visualID> |
|
|
112 | |
|
|
113 | Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible |
|
|
114 | visual ids). |
97 | |
115 | |
98 | =item B<-geometry> I<geom> |
116 | =item B<-geometry> I<geom> |
99 | |
117 | |
100 | Window geometry (B<-g> still respected); resource B<geometry>. |
118 | Window geometry (B<-g> still respected); resource B<geometry>. |
101 | |
119 | |
… | |
… | |
103 | |
121 | |
104 | Turn on/off simulated reverse video; resource B<reverseVideo>. |
122 | Turn on/off simulated reverse video; resource B<reverseVideo>. |
105 | |
123 | |
106 | =item B<-j>|B<+j> |
124 | =item B<-j>|B<+j> |
107 | |
125 | |
108 | Turn on/off jump scrolling; resource B<jumpScroll>. |
126 | Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. |
109 | |
127 | |
110 | =item B<-ip>|B<+ip> |
128 | =item B<-ss>|B<+ss> |
111 | |
129 | |
112 | Turn on/off inheriting parent window's pixmap. Alternative form is |
130 | Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. |
113 | B<-tr>; resource B<inheritPixmap>. |
|
|
114 | |
131 | |
115 | =item B<-fade> I<number> |
132 | =item B<-fade> I<number> |
116 | |
133 | |
117 | Fade the text by the given percentage when focus is lost. resource B<fading>. |
134 | Fade the text by the given percentage when focus is lost. Small values |
|
|
135 | fade a little only, 100 completely replaces all colours by the fade |
|
|
136 | colour; resource B<fading>. |
118 | |
137 | |
119 | =item B<-tint> I<colour> |
138 | =item B<-fadecolor> I<colour> |
120 | |
139 | |
121 | Tint the transparent background pixmap with the given colour when |
140 | Fade to this colour when fading is used (see B<-fade>). The default colour |
122 | transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> |
141 | is opaque black. resource B<fadeColor>. |
123 | option that can be used to brighten or darken the image in addition to |
|
|
124 | tinting it. |
|
|
125 | |
142 | |
126 | =item B<-sh> |
143 | =item B<-icon> I<file> |
127 | |
144 | |
128 | I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
145 | Compile I<pixbuf>: Use the specified image as application icon. This |
129 | background image in addition to tinting it (i.e. B<-tint> must be |
146 | is used by many window managers, taskbars and pagers to represent the |
130 | specified, too, e.g. C<-tint white>). |
147 | application window; resource I<iconFile>. |
131 | |
148 | |
132 | =item B<-bg> I<colour> |
149 | =item B<-bg> I<colour> |
133 | |
150 | |
134 | Window background colour; resource B<background>. |
151 | Window background colour; resource B<background>. |
135 | |
152 | |
136 | =item B<-fg> I<colour> |
153 | =item B<-fg> I<colour> |
137 | |
154 | |
138 | Window foreground colour; resource B<foreground>. |
155 | Window foreground colour; resource B<foreground>. |
139 | |
|
|
140 | =item B<-pixmap> I<file[;geom]> |
|
|
141 | |
|
|
142 | Compile I<XPM>: Specify XPM file for the background and also optionally |
|
|
143 | specify its scaling with a geometry string. Note you may need to |
|
|
144 | add quotes to avoid special shell interpretation of the C<;> in the |
|
|
145 | command-line; resource B<backgroundPixmap>. |
|
|
146 | |
156 | |
147 | =item B<-cr> I<colour> |
157 | =item B<-cr> I<colour> |
148 | |
158 | |
149 | The cursor colour; resource B<cursorColor>. |
159 | The cursor colour; resource B<cursorColor>. |
150 | |
160 | |
… | |
… | |
162 | resource B<borderColor>. |
172 | resource B<borderColor>. |
163 | |
173 | |
164 | =item B<-fn> I<fontlist> |
174 | =item B<-fn> I<fontlist> |
165 | |
175 | |
166 | Select the fonts to be used. This is a comma separated list of font names |
176 | Select the fonts to be used. This is a comma separated list of font names |
167 | that are used in turn when trying to display Unicode characters. The |
177 | that are checked in order when trying to find glyphs for characters. The |
168 | first font defines the cell size for characters; other fonts might be |
178 | first font defines the cell size for characters; other fonts might be |
169 | smaller, but not (in general) larger. A (hopefully) reasonable default |
179 | smaller, but not (in general) larger. A (hopefully) reasonable default |
170 | font list is always appended to it. See resource B<font> for more details. |
180 | font list is always appended to it. See resource B<font> for more details. |
171 | |
181 | |
172 | In short, to specify an X11 core font, just specify it's name or prefix it |
182 | In short, to specify an X11 core font, just specify its name or prefix it |
173 | with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, |
183 | with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, |
174 | e.g.: |
184 | e.g.: |
175 | |
185 | |
176 | @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
186 | @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
177 | @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
187 | @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
… | |
… | |
179 | See also the question "How does rxvt-unicode choose fonts?" in the FAQ |
189 | See also the question "How does rxvt-unicode choose fonts?" in the FAQ |
180 | section of @@RXVT_NAME@@(7). |
190 | section of @@RXVT_NAME@@(7). |
181 | |
191 | |
182 | =item B<-fb> I<fontlist> |
192 | =item B<-fb> I<fontlist> |
183 | |
193 | |
184 | Compile font-styles: The bold font list to use when bold characters are to |
194 | Compile I<font-styles>: The bold font list to use when B<bold> characters |
185 | be printed. See resource B<boldFont> for details. |
195 | are to be printed. See resource B<boldFont> for details. |
186 | |
196 | |
187 | =item B<-fi> I<fontlist> |
197 | =item B<-fi> I<fontlist> |
188 | |
198 | |
189 | Compile font-styles: The italic font list to use when bold characters are to |
199 | Compile I<font-styles>: The italic font list to use when I<italic> |
190 | be printed. See resource B<italicFont> for details. |
200 | characters are to be printed. See resource B<italicFont> for details. |
191 | |
201 | |
192 | =item B<-fbi> I<fontlist> |
202 | =item B<-fbi> I<fontlist> |
193 | |
203 | |
194 | Compile font-styles: The bold italic font list to use when bold characters are to |
204 | Compile I<font-styles>: The bold italic font list to use when B<< I<bold |
195 | be printed. See resource B<boldItalicFont> for details. |
205 | italic> >> characters are to be printed. See resource B<boldItalicFont> |
|
|
206 | for details. |
|
|
207 | |
|
|
208 | =item B<-is>|B<+is> |
|
|
209 | |
|
|
210 | Compile I<font-styles>: Bold/Blink font styles imply high intensity |
|
|
211 | foreground/background (default). See resource B<intensityStyles> for |
|
|
212 | details. |
196 | |
213 | |
197 | =item B<-name> I<name> |
214 | =item B<-name> I<name> |
198 | |
215 | |
199 | Specify the application name under which resources are to be obtained, |
216 | Specify the application name under which resources are to be obtained, |
200 | rather than the default executable file name. Name should not contain |
217 | rather than the default executable file name. Name should not contain |
… | |
… | |
216 | |
233 | |
217 | =item B<-sb>|B<+sb> |
234 | =item B<-sb>|B<+sb> |
218 | |
235 | |
219 | Turn on/off scrollbar; resource B<scrollBar>. |
236 | Turn on/off scrollbar; resource B<scrollBar>. |
220 | |
237 | |
|
|
238 | =item B<-sr>|B<+sr> |
|
|
239 | |
|
|
240 | Put scrollbar on right/left; resource B<scrollBar_right>. |
|
|
241 | |
|
|
242 | =item B<-st>|B<+st> |
|
|
243 | |
|
|
244 | Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; |
|
|
245 | resource B<scrollBar_floating>. |
|
|
246 | |
221 | =item B<-si>|B<+si> |
247 | =item B<-si>|B<+si> |
222 | |
248 | |
223 | Turn on/off scroll-to-bottom on TTY output inhibit; resource |
249 | Turn on/off scroll-to-bottom on TTY output inhibit; resource |
224 | B<scrollTtyOutput> has opposite effect. |
250 | B<scrollTtyOutput> has opposite effect. |
225 | |
251 | |
… | |
… | |
231 | =item B<-sw>|B<+sw> |
257 | =item B<-sw>|B<+sw> |
232 | |
258 | |
233 | Turn on/off scrolling with the scrollback buffer as new lines appear. |
259 | Turn on/off scrolling with the scrollback buffer as new lines appear. |
234 | This only takes effect if B<-si> is also given; resource |
260 | This only takes effect if B<-si> is also given; resource |
235 | B<scrollWithBuffer>. |
261 | B<scrollWithBuffer>. |
236 | |
|
|
237 | =item B<-sr>|B<+sr> |
|
|
238 | |
|
|
239 | Put scrollbar on right/left; resource B<scrollBar_right>. |
|
|
240 | |
|
|
241 | =item B<-st>|B<+st> |
|
|
242 | |
|
|
243 | Display normal (non XTerm/NeXT) scrollbar without/with a trough; |
|
|
244 | resource B<scrollBar_floating>. |
|
|
245 | |
262 | |
246 | =item B<-ptab>|B<+ptab> |
263 | =item B<-ptab>|B<+ptab> |
247 | |
264 | |
248 | If enabled (default), "Horizontal Tab" characters are being stored as |
265 | If enabled (default), "Horizontal Tab" characters are being stored as |
249 | actual wide characters in the screen buffer, which makes it possible to |
266 | actual wide characters in the screen buffer, which makes it possible to |
… | |
… | |
253 | |
270 | |
254 | =item B<-bc>|B<+bc> |
271 | =item B<-bc>|B<+bc> |
255 | |
272 | |
256 | Blink the cursor; resource B<cursorBlink>. |
273 | Blink the cursor; resource B<cursorBlink>. |
257 | |
274 | |
|
|
275 | =item B<-uc>|B<+uc> |
|
|
276 | |
|
|
277 | Make the cursor underlined; resource B<cursorUnderline>. |
|
|
278 | |
258 | =item B<-iconic> |
279 | =item B<-iconic> |
259 | |
280 | |
260 | Start iconified, if the window manager supports that option. |
281 | Start iconified, if the window manager supports that option. |
261 | Alternative form is B<-ic>. |
282 | Alternative form is B<-ic>. |
262 | |
283 | |
… | |
… | |
278 | |
299 | |
279 | =item B<-bl> |
300 | =item B<-bl> |
280 | |
301 | |
281 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
302 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
282 | if honoured by the WM, the rxvt-unicode window will not have window |
303 | if honoured by the WM, the rxvt-unicode window will not have window |
283 | decorations; resource B<borderLess>. |
304 | decorations; resource B<borderLess>. If the window manager does not |
|
|
305 | support MWM hints (e.g. kwin), enables override-redirect mode. |
|
|
306 | |
|
|
307 | =item B<-override-redirect> |
|
|
308 | |
|
|
309 | Compile I<frills>: Sets override-redirect on the window; resource |
|
|
310 | B<override-redirect>. |
|
|
311 | |
|
|
312 | =item B<-sbg> |
|
|
313 | |
|
|
314 | Compile I<frills>: Disable the usage of the built-in block graphics/line |
|
|
315 | drawing characters and just rely on what the specified fonts provide. Use |
|
|
316 | this if you have a good font and want to use its block graphic glyphs; |
|
|
317 | resource B<skipBuiltinGlyphs>. |
284 | |
318 | |
285 | =item B<-lsp> I<number> |
319 | =item B<-lsp> I<number> |
286 | |
320 | |
287 | Compile I<frills>: Lines (pixel height) to insert between each row of |
321 | Compile I<frills>: Lines (pixel height) to insert between each row of |
288 | the display. Useful to work around font rendering problems; resource |
322 | the display. Useful to work around font rendering problems; resource |
289 | B<linespace>. |
323 | B<lineSpace>. |
|
|
324 | |
|
|
325 | =item B<-letsp> I<number> |
|
|
326 | |
|
|
327 | Compile I<frills>: Amount to adjust the computed character width by |
|
|
328 | to control overall letter spacing. Negative values will tighten up the |
|
|
329 | letter spacing, positive values will space letters out more. Useful to |
|
|
330 | work around odd font metrics; resource B<letterSpace>. |
290 | |
331 | |
291 | =item B<-tn> I<termname> |
332 | =item B<-tn> I<termname> |
292 | |
333 | |
293 | This option specifies the name of the terminal type to be set in the |
334 | This option specifies the name of the terminal type to be set in the |
294 | B<TERM> environment variable. This terminal type must exist in the |
335 | B<TERM> environment variable. This terminal type must exist in the |
… | |
… | |
303 | given on the command line. If this option is used, it must be the last |
344 | given on the command line. If this option is used, it must be the last |
304 | on the command-line. If there is no B<-e> option then the default is to |
345 | on the command-line. If there is no B<-e> option then the default is to |
305 | run the program specified by the B<SHELL> environment variable or, |
346 | run the program specified by the B<SHELL> environment variable or, |
306 | failing that, I<sh(1)>. |
347 | failing that, I<sh(1)>. |
307 | |
348 | |
|
|
349 | Please note that you must specify a program with arguments. If you want to |
|
|
350 | run shell commands, you have to specify the shell, like this: |
|
|
351 | |
|
|
352 | @@RXVT_NAME@@ -e sh -c "shell commands" |
|
|
353 | |
308 | =item B<-title> I<text> |
354 | =item B<-title> I<text> |
309 | |
355 | |
310 | Window title (B<-T> still respected); the default title is the basename |
356 | Window title (B<-T> still respected); the default title is the basename |
311 | of the program specified after the B<-e> option, if any, otherwise the |
357 | of the program specified after the B<-e> option, if any, otherwise the |
312 | application name; resource B<title>. |
358 | application name; resource B<title>. |
… | |
… | |
343 | for more info. |
389 | for more info. |
344 | |
390 | |
345 | =item B<-tcw> |
391 | =item B<-tcw> |
346 | |
392 | |
347 | Change the meaning of triple-click selection with the left mouse |
393 | Change the meaning of triple-click selection with the left mouse |
|
|
394 | button. Only effective when the original (non-perl) selection code is |
348 | button. Instead of selecting a full line it will extend the selection the |
395 | in-use. Instead of selecting a full line it will extend the selection to |
349 | end of the logical line only. resource B<tripleclickwords>. |
396 | the end of the logical line only. resource B<tripleclickwords>. |
350 | |
397 | |
351 | =item B<-insecure> |
398 | =item B<-insecure> |
352 | |
399 | |
353 | Enable "insecure" mode, which currently enables most of the escape |
400 | Enable "insecure" mode, which currently enables most of the escape |
354 | sequences that echo strings. See the resource B<insecure> for more |
401 | sequences that echo strings. See the resource B<insecure> for more |
… | |
… | |
368 | =item B<-ssr>|B<+ssr> |
415 | =item B<-ssr>|B<+ssr> |
369 | |
416 | |
370 | Turn on/off secondary screen scroll (default enabled); resource |
417 | Turn on/off secondary screen scroll (default enabled); resource |
371 | B<secondaryScroll>. |
418 | B<secondaryScroll>. |
372 | |
419 | |
|
|
420 | =item B<-hold>|B<+hold> |
|
|
421 | |
|
|
422 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
|
|
423 | will not immediately destroy its window when the program executed within |
|
|
424 | it exits. Instead, it will wait till it is being killed or closed by the |
|
|
425 | user; resource B<hold>. |
|
|
426 | |
|
|
427 | =item B<-cd> I<path> |
|
|
428 | |
|
|
429 | Sets the working directory for the shell (or the command specified via |
|
|
430 | B<-e>). The I<path> must be an absolute path and it must exist for |
|
|
431 | @@RXVT_NAME@@ to start; resource B<chdir>. |
|
|
432 | |
|
|
433 | =item B<-xrm> I<string> |
|
|
434 | |
|
|
435 | Works like the X Toolkit option of the same name, by adding the I<string> |
|
|
436 | as if it were specified in a resource file. Resource values specified this |
|
|
437 | way take precedence over all other resource specifications. |
|
|
438 | |
|
|
439 | Note that you need to use the I<same> syntax as in the .Xdefaults file, |
|
|
440 | e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific |
|
|
441 | options can be specified as long-options on the commandline, so use |
|
|
442 | of B<-xrm> is mostly limited to cases where you want to specify other |
|
|
443 | resources (e.g. for input methods) or for compatibility with other |
|
|
444 | programs. |
|
|
445 | |
373 | =item B<-keysym.>I<sym>: I<string> |
446 | =item B<-keysym.>I<sym> I<string> |
374 | |
447 | |
375 | Remap a key symbol. See resource B<keysym>. |
448 | Remap a key symbol. See resource B<keysym>. |
376 | |
449 | |
377 | =item B<-embed>: I<windowid> |
450 | =item B<-embed> I<windowid> |
378 | |
451 | |
379 | Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, |
452 | Tells @@RXVT_NAME@@ to embed its windows into an already-existing window, |
380 | which enables applications to easily embed a terminal. |
453 | which enables applications to easily embed a terminal. |
381 | |
454 | |
382 | Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it |
455 | Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it |
383 | shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it |
456 | shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it |
384 | quite a bit, so don't expect it to keep some specific state. It's best to |
457 | quite a bit, so don't expect it to keep some specific state. It's best to |
… | |
… | |
387 | The window will not be destroyed when @@RXVT_NAME@@ exits. |
460 | The window will not be destroyed when @@RXVT_NAME@@ exits. |
388 | |
461 | |
389 | It might be useful to know that @@RXVT_NAME@@ will not close file |
462 | It might be useful to know that @@RXVT_NAME@@ will not close file |
390 | descriptors passed to it (except for stdin/out/err, of course), so you |
463 | descriptors passed to it (except for stdin/out/err, of course), so you |
391 | can use file descriptors to communicate with the programs within the |
464 | can use file descriptors to communicate with the programs within the |
392 | terminal. This works regardless of wether the C<-embed> option was used or |
465 | terminal. This works regardless of whether the C<-embed> option was used or |
393 | not. |
466 | not. |
394 | |
467 | |
|
|
468 | Here is a short Gtk2-perl snippet that illustrates how this option can be |
|
|
469 | used (a longer example is in F<doc/embed>): |
|
|
470 | |
|
|
471 | my $rxvt = new Gtk2::Socket; |
|
|
472 | $rxvt->signal_connect_after (realize => sub { |
|
|
473 | my $xid = $_[0]->window->get_xid; |
|
|
474 | system "@@RXVT_NAME@@ -embed $xid &"; |
|
|
475 | }); |
|
|
476 | |
|
|
477 | =item B<-pty-fd> I<file descriptor> |
|
|
478 | |
|
|
479 | Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty |
|
|
480 | pair but instead use the given file descriptor as the tty master. This is |
|
|
481 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
|
|
482 | without having to run a program within it. |
|
|
483 | |
|
|
484 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
|
|
485 | entries and will not tinker with pty/tty permissions - you have to do that |
|
|
486 | yourself if you want that. |
|
|
487 | |
|
|
488 | As an extremely special case, specifying C<-1> will completely suppress |
|
|
489 | pty/tty operations, which is probably only useful in conjunction with some |
|
|
490 | perl extension that manages the terminal. |
|
|
491 | |
|
|
492 | Here is a example in perl that illustrates how this option can be used (a |
|
|
493 | longer example is in F<doc/pty-fd>): |
|
|
494 | |
|
|
495 | use IO::Pty; |
|
|
496 | use Fcntl; |
|
|
497 | |
|
|
498 | my $pty = new IO::Pty; |
|
|
499 | fcntl $pty, F_SETFD, 0; # clear close-on-exec |
|
|
500 | system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&"; |
|
|
501 | close $pty; |
|
|
502 | |
|
|
503 | # now communicate with rxvt |
|
|
504 | my $slave = $pty->slave; |
|
|
505 | while (<$slave>) { print $slave "got <$_>\n" } |
|
|
506 | |
|
|
507 | =item B<-pe> I<string> |
|
|
508 | |
|
|
509 | Comma-separated list of perl extension scripts to use (or not to use) in |
|
|
510 | this terminal instance. See resource B<perl-ext> for details. |
|
|
511 | |
395 | =back |
512 | =back |
396 | |
513 | |
397 | =head1 RESOURCES (available also as long-options) |
514 | =head1 RESOURCES |
398 | |
515 | |
399 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
516 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
400 | options) compiled into your version. |
517 | options) compiled into your version. All resources are also available as |
|
|
518 | long-options. |
401 | |
519 | |
402 | There are two different methods that @@RXVT_NAME@@ can use to get the |
520 | You can set and change the resources using X11 tools like B<xrdb>. Many |
403 | Xresource data: using the X libraries (Xrm*-functions) or internal |
521 | distribution do also load settings from the B<~/.Xresources> file when X |
404 | Xresources reader (B<~/.Xdefaults>). For the first method (ie. |
522 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
405 | B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the |
523 | with later settings overwriting earlier ones: |
406 | resources using X11 tools like B<xrdb>. Many distribution do also load |
|
|
407 | settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@ |
|
|
408 | will consult the following files/resources in order, with later settings |
|
|
409 | overwriting earlier ones: |
|
|
410 | |
524 | |
411 | 1. system-wide app-defaults file, either locale-dependent OR global |
|
|
412 | 2. app-defaults file in $XAPPLRESDIR |
525 | 1. app-defaults file in $XAPPLRESDIR |
|
|
526 | 2. $HOME/.Xdefaults |
413 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
527 | 3. RESOURCE_MANAGER property on root-window of screen 0 |
414 | 4. SCREEN_RESOURCES for the current screen |
528 | 4. SCREEN_RESOURCES property on root-window of the current screen |
415 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
529 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
|
|
530 | 6. resources specified via -xrm on the commandline |
416 | |
531 | |
417 | If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> |
|
|
418 | lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults |
|
|
419 | set in XAPPLOADDIR/URxvt (compile-time defined: usually |
|
|
420 | B</usr/lib/X11/app-defaults/URxvt>) and resources set in |
|
|
421 | B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist. |
|
|
422 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two |
532 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
423 | class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows |
533 | names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
424 | resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be |
534 | common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily |
425 | easily configured, while the class name B<URxvt> allows resources |
535 | configured, while the class name B<URxvt> allows resources unique to |
426 | unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be |
536 | B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@> |
427 | shared between different B<@@RXVT_NAME@@> configurations. If no |
537 | configurations. If no resources are specified, suitable defaults will |
428 | resources are specified, suitable defaults will be used. Command-line |
538 | be used. Command-line arguments can be used to override resource |
429 | arguments can be used to override resource settings. The following |
539 | settings. The following resources are supported (you might want to |
430 | resources are allowed: |
540 | check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl |
|
|
541 | extensions not documented here): |
431 | |
542 | |
432 | =over 4 |
543 | =over 4 |
|
|
544 | |
|
|
545 | =item B<depth:> I<bitdepth> |
|
|
546 | |
|
|
547 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
|
|
548 | option B<-depth>. |
|
|
549 | |
|
|
550 | =item B<buffered:> I<boolean> |
|
|
551 | |
|
|
552 | Compile I<xft>: Turn on/off double-buffering for xft (default enabled). |
|
|
553 | On some card/driver combination enabling it slightly decreases |
|
|
554 | performance, on most it greatly helps it. The slowdown is small, so it |
|
|
555 | should normally be enabled. |
433 | |
556 | |
434 | =item B<geometry:> I<geom> |
557 | =item B<geometry:> I<geom> |
435 | |
558 | |
436 | Create the window with the specified X window geometry [default 80x24]; |
559 | Create the window with the specified X window geometry [default 80x24]; |
437 | option B<-geometry>. |
560 | option B<-geometry>. |
… | |
… | |
451 | Use the specified colour for the colour value I<n>, where 0-7 |
574 | Use the specified colour for the colour value I<n>, where 0-7 |
452 | corresponds to low-intensity (normal) colours and 8-15 corresponds to |
575 | corresponds to low-intensity (normal) colours and 8-15 corresponds to |
453 | high-intensity (bold = bright foreground, blink = bright background) |
576 | high-intensity (bold = bright foreground, blink = bright background) |
454 | colours. The canonical names are as follows: 0=black, 1=red, 2=green, |
577 | colours. The canonical names are as follows: 0=black, 1=red, 2=green, |
455 | 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour |
578 | 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour |
456 | names used are listed in the B<COLORS AND GRAPHICS> section. |
579 | names used are listed in the B<COLOURS AND GRAPHICS> section. |
457 | |
580 | |
458 | Colours higher than 15 cannot be set using resources (yet), but can be |
581 | Colours higher than 15 cannot be set using resources (yet), but can be |
459 | changed using an escape command (see @@RXVT_NAME@@(7)). |
582 | changed using an escape command (see @@RXVT_NAME@@(7)). |
460 | |
583 | |
461 | Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with |
584 | Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with |
… | |
… | |
472 | =item B<colorUL:> I<colour> |
595 | =item B<colorUL:> I<colour> |
473 | |
596 | |
474 | Use the specified colour to display underlined characters when the |
597 | Use the specified colour to display underlined characters when the |
475 | foreground colour is the default. |
598 | foreground colour is the default. |
476 | |
599 | |
477 | =item B<colorRV:> I<colour> |
|
|
478 | |
|
|
479 | Use the specified colour as the background for reverse video |
|
|
480 | characters. |
|
|
481 | |
|
|
482 | =item B<underlineColor:> I<colour> |
600 | =item B<underlineColor:> I<colour> |
483 | |
601 | |
484 | If set, use the specified colour as the colour for the underline |
602 | If set, use the specified colour as the colour for the underline |
485 | itself. If unset, use the foreground colour. |
603 | itself. If unset, use the foreground colour. |
|
|
604 | |
|
|
605 | =item B<highlightColor:> I<colour> |
|
|
606 | |
|
|
607 | If set, use the specified colour as the background for highlighted |
|
|
608 | characters. If unset, use reverse video. |
|
|
609 | |
|
|
610 | =item B<highlightTextColor:> I<colour> |
|
|
611 | |
|
|
612 | If set and highlightColor is set, use the specified colour as the |
|
|
613 | foreground for highlighted characters. |
486 | |
614 | |
487 | =item B<cursorColor:> I<colour> |
615 | =item B<cursorColor:> I<colour> |
488 | |
616 | |
489 | Use the specified colour for the cursor. The default is to use the |
617 | Use the specified colour for the cursor. The default is to use the |
490 | foreground colour; option B<-cr>. |
618 | foreground colour; option B<-cr>. |
… | |
… | |
497 | |
625 | |
498 | =item B<reverseVideo:> I<boolean> |
626 | =item B<reverseVideo:> I<boolean> |
499 | |
627 | |
500 | B<True>: simulate reverse video by foreground and background colours; |
628 | B<True>: simulate reverse video by foreground and background colours; |
501 | option B<-rv>. B<False>: regular screen colours [default]; option |
629 | option B<-rv>. B<False>: regular screen colours [default]; option |
502 | B<+rv>. See note in B<COLORS AND GRAPHICS> section. |
630 | B<+rv>. See note in B<COLOURS AND GRAPHICS> section. |
503 | |
631 | |
504 | =item B<jumpScroll:> I<boolean> |
632 | =item B<jumpScroll:> I<boolean> |
505 | |
633 | |
506 | B<True>: specify that jump scrolling should be used. When scrolling |
634 | B<True>: specify that jump scrolling should be used. When receiving lots |
507 | quickly, fewer screen updates are performed [default]; option B<-j>. |
635 | of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines |
|
|
636 | has been read, resulting in fewer updates while still displaying every |
|
|
637 | received line; option B<-j>. |
|
|
638 | |
508 | B<False>: specify that smooth scrolling should be used; option B<+j>. |
639 | B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will |
|
|
640 | force a screen refresh on each new line it received; option B<+j>. |
509 | |
641 | |
510 | =item B<inheritPixmap:> I<boolean> |
642 | =item B<skipScroll:> I<boolean> |
511 | |
643 | |
512 | B<True>: make the background inherit the parent windows' pixmap, giving |
644 | B<True>: (the default) specify that skip scrolling should be used. When |
513 | artificial transparency. B<False>: do not inherit the parent windows' |
645 | receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while |
514 | pixmap. |
646 | (around 60 times per second), resulting in far fewer updates. This can |
|
|
647 | result in @@RXVT_NAME@@ not ever displaying some of the lines it receives; |
|
|
648 | option B<-ss>. |
|
|
649 | |
|
|
650 | B<False>: specify that everything is to be displayed, even |
|
|
651 | if the refresh is too fast for the human eye to read anything (or the |
|
|
652 | monitor to display anything); option B<+ss>. |
515 | |
653 | |
516 | =item B<fading:> I<number> |
654 | =item B<fading:> I<number> |
517 | |
655 | |
518 | Fade the text by the given percentage when focus is lost. |
656 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
519 | |
657 | |
520 | =item B<tintColor:> I<colour> |
658 | =item B<fadeColor:> I<colour> |
521 | |
659 | |
522 | Tint the transparent background pixmap with the given colour. |
660 | Fade to this colour, when fading is used (see B<fading:>). The default |
|
|
661 | colour is black; option B<-fadecolor>. |
523 | |
662 | |
524 | =item B<shading:> I<number> |
663 | =item B<iconFile:> I<file> |
525 | |
664 | |
526 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
665 | Set the application icon pixmap; option B<-icon>. |
527 | image in addition to tinting it. |
|
|
528 | |
666 | |
529 | =item B<scrollColor:> I<colour> |
667 | =item B<scrollColor:> I<colour> |
530 | |
668 | |
531 | Use the specified colour for the scrollbar [default #B2B2B2]. |
669 | Use the specified colour for the scrollbar [default #B2B2B2]. |
532 | |
670 | |
533 | =item B<troughColor:> I<colour> |
671 | =item B<troughColor:> I<colour> |
534 | |
672 | |
535 | Use the specified colour for the scrollbar's trough area [default |
673 | Use the specified colour for the scrollbar's trough area [default |
536 | #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. |
674 | #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar. |
537 | |
675 | |
538 | =item B<borderColor:> I<colour> |
676 | =item B<borderColor:> I<colour> |
539 | |
677 | |
540 | The colour of the border around the text area and between the scrollbar |
678 | The colour of the border around the text area and between the scrollbar |
541 | and the text. |
679 | and the text. |
542 | |
680 | |
543 | =item B<backgroundPixmap:> I<file[;geom]> |
|
|
544 | |
|
|
545 | Use the specified XPM file (note the `.xpm' extension is optional) for |
|
|
546 | the background and also optionally specify its scaling with a geometry |
|
|
547 | string B<WxH+X+Y>, in which B<"W" / "H"> specify the |
|
|
548 | horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image |
|
|
549 | centre (percent). A scale of 0 displays the image with tiling. A scale |
|
|
550 | of 1 displays the image without any scaling. A scale of 2 to 9 |
|
|
551 | specifies an integer number of images in that direction. No image will |
|
|
552 | be magnified beyond 10 times its original size. The maximum permitted |
|
|
553 | scale is 1000. [default 0x0+50+50] |
|
|
554 | |
|
|
555 | =item B<menu:> I<file[;tag]> |
|
|
556 | |
|
|
557 | Read in the specified menu file (note the `.menu' extension is |
|
|
558 | optional) and also optionally specify a starting tag to find. See the |
|
|
559 | reference documentation for details on the syntax for the menuBar. |
|
|
560 | |
|
|
561 | =item B<path:> I<path> |
|
|
562 | |
|
|
563 | Specify the colon-delimited search path for finding files (XPM and |
|
|
564 | menus), in addition to the paths specified by the B<RXVTPATH> and |
|
|
565 | B<PATH> environment variables. |
|
|
566 | |
|
|
567 | =item B<font:> I<fontlist> |
681 | =item B<font:> I<fontlist> |
568 | |
682 | |
569 | Select the fonts to be used. This is a comma separated list of font |
683 | Select the fonts to be used. This is a comma separated list of font names |
570 | names that are used in turn when trying to display Unicode characters. |
684 | that are checked in order when trying to find glyphs for characters. The |
571 | The first font defines the cell size for characters; other fonts might |
685 | first font defines the cell size for characters; other fonts might be |
572 | be smaller, but not larger. A reasonable default font list is always |
686 | smaller, but not (in general) larger. A (hopefully) reasonable default |
573 | appended to it. option B<-fn>. |
687 | font list is always appended to it; option B<-fn>. |
574 | |
688 | |
575 | Each font can either be a standard X11 core font (XLFD) name, with |
689 | Each font can either be a standard X11 core font (XLFD) name, with |
576 | optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. |
690 | optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. |
577 | |
691 | |
578 | In addition, each font can be prefixed with additional hints and |
692 | In addition, each font can be prefixed with additional hints and |
… | |
… | |
580 | hint currently is C<codeset=codeset-name>, and this is only used for Xft |
694 | hint currently is C<codeset=codeset-name>, and this is only used for Xft |
581 | fonts. |
695 | fonts. |
582 | |
696 | |
583 | For example, this font resource |
697 | For example, this font resource |
584 | |
698 | |
585 | URxvt*font: 9x15bold,\ |
699 | URxvt.font: 9x15bold,\ |
586 | -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ |
700 | -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ |
587 | -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ |
701 | -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ |
588 | [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ |
702 | [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ |
589 | xft:Code2000:antialias=false |
703 | xft:Code2000:antialias=false |
590 | |
704 | |
… | |
… | |
593 | it is named first) and thus defines the character cell grid to be 9 pixels |
707 | it is named first) and thus defines the character cell grid to be 9 pixels |
594 | wide and 15 pixels high. |
708 | wide and 15 pixels high. |
595 | |
709 | |
596 | The second font is just used to add additional unicode characters not in |
710 | The second font is just used to add additional unicode characters not in |
597 | the base font, likewise the third, which is unfortunately non-bold, but |
711 | the base font, likewise the third, which is unfortunately non-bold, but |
598 | the bold version of the font does contain less characters, so this is a |
712 | the bold version of the font does contain fewer characters, so this is a |
599 | useful supplement. |
713 | useful supplement. |
600 | |
714 | |
601 | The third font is an Xft font with aliasing turned off, and the characters |
715 | The third font is an Xft font with aliasing turned off, and the characters |
602 | are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font |
716 | are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font |
603 | contains other characters, but we are not interested in them. |
717 | contains other characters, but we are not interested in them. |
… | |
… | |
624 | not possible, replacement fonts of the desired shape will be tried. |
738 | not possible, replacement fonts of the desired shape will be tried. |
625 | |
739 | |
626 | If set, but empty, then this specific style is disabled and the normal |
740 | If set, but empty, then this specific style is disabled and the normal |
627 | text font will being used for the given style. |
741 | text font will being used for the given style. |
628 | |
742 | |
629 | =item B<selectstyle:> I<mode> |
743 | =item B<intensityStyles:> I<boolean> |
630 | |
744 | |
631 | Set mouse selection style to B<old> which is 2.20, B<oldword> which is |
745 | When font styles are not enabled, or this option is enabled (B<True>, |
632 | xterm style with 2.20 old word selection, or anything else which gives |
746 | option B<-is>, the default), bold/blink font styles imply high |
633 | xterm style selection. |
747 | intensity foreground/background colours. Disabling this option (B<False>, |
634 | |
748 | option B<+is>) disables this behaviour, the high intensity colours are not |
635 | =item B<scrollstyle:> I<mode> |
749 | reachable. |
636 | |
|
|
637 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
|
|
638 | the author's favourite.. |
|
|
639 | |
750 | |
640 | =item B<title:> I<string> |
751 | =item B<title:> I<string> |
641 | |
752 | |
642 | Set window title string, the default title is the command-line |
753 | Set window title string, the default title is the command-line |
643 | specified after the B<-e> option, if any, otherwise the application |
754 | specified after the B<-e> option, if any, otherwise the application |
… | |
… | |
652 | =item B<mapAlert:> I<boolean> |
763 | =item B<mapAlert:> I<boolean> |
653 | |
764 | |
654 | B<True>: de-iconify (map) on receipt of a bell character. B<False>: no |
765 | B<True>: de-iconify (map) on receipt of a bell character. B<False>: no |
655 | de-iconify (map) on receipt of a bell character [default]. |
766 | de-iconify (map) on receipt of a bell character [default]. |
656 | |
767 | |
|
|
768 | =item B<urgentOnBell:> I<boolean> |
|
|
769 | |
|
|
770 | B<True>: set the urgency hint for the wm on receipt of a bell character. |
|
|
771 | B<False>: do not set the urgency hint [default]. |
|
|
772 | |
|
|
773 | @@RXVT_NAME@@ resets the urgency hint on every focus change. |
|
|
774 | |
657 | =item B<visualBell:> I<boolean> |
775 | =item B<visualBell:> I<boolean> |
658 | |
776 | |
659 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
777 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
660 | B<False>: no visual bell [default]; option B<+vb>. |
778 | B<False>: no visual bell [default]; option B<+vb>. |
661 | |
779 | |
… | |
… | |
675 | |
793 | |
676 | Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use |
794 | Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use |
677 | B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or |
795 | B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or |
678 | B<Shift-Print> to include the scrollback as well. |
796 | B<Shift-Print> to include the scrollback as well. |
679 | |
797 | |
|
|
798 | The string will be interpreted as if typed into the shell as-is. |
|
|
799 | |
|
|
800 | Example: |
|
|
801 | |
|
|
802 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
|
|
803 | |
|
|
804 | This creates a new file in your home directory with the screen contents |
|
|
805 | every time you hit C<Print>. |
|
|
806 | |
|
|
807 | =item B<scrollstyle:> I<mode> |
|
|
808 | |
|
|
809 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
|
|
810 | the author's favourite. |
|
|
811 | |
|
|
812 | =item B<thickness:> I<number> |
|
|
813 | |
|
|
814 | Set the scrollbar width in pixels. |
|
|
815 | |
680 | =item B<scrollBar:> I<boolean> |
816 | =item B<scrollBar:> I<boolean> |
681 | |
817 | |
682 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
818 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
683 | disable the scrollbar; option B<+sb>. |
819 | disable the scrollbar; option B<+sb>. |
684 | |
820 | |
… | |
… | |
703 | B<False>: do not scroll to bottom when tty receives output; option |
839 | B<False>: do not scroll to bottom when tty receives output; option |
704 | B<+si>. |
840 | B<+si>. |
705 | |
841 | |
706 | =item B<scrollWithBuffer:> I<boolean> |
842 | =item B<scrollWithBuffer:> I<boolean> |
707 | |
843 | |
708 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
844 | B<True>: scroll with scrollback buffer when tty receives new lines (i.e. |
709 | B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll |
845 | try to show the same lines) and B<scrollTtyOutput> is False; option |
710 | with scrollback buffer when tty recieves new lines; option B<-sw>. |
846 | B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives |
|
|
847 | new lines; option B<+sw>. |
711 | |
848 | |
712 | =item B<scrollTtyKeypress:> I<boolean> |
849 | =item B<scrollTtyKeypress:> I<boolean> |
713 | |
850 | |
714 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
851 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
715 | are those which are intercepted by rxvt-unicode for special handling and |
852 | are those which are intercepted by rxvt-unicode for special handling and |
… | |
… | |
734 | =item B<borderLess:> I<boolean> |
871 | =item B<borderLess:> I<boolean> |
735 | |
872 | |
736 | Set MWM hints to request a borderless window, i.e. if honoured by the |
873 | Set MWM hints to request a borderless window, i.e. if honoured by the |
737 | WM, the rxvt-unicode window will not have window decorations; option B<-bl>. |
874 | WM, the rxvt-unicode window will not have window decorations; option B<-bl>. |
738 | |
875 | |
|
|
876 | =item B<skipBuiltinGlyphs:> I<boolean> |
|
|
877 | |
|
|
878 | Compile I<frills>: Disable the usage of the built-in block graphics/line |
|
|
879 | drawing characters and just rely on what the specified fonts provide. Use |
|
|
880 | this if you have a good font and want to use its block graphic glyphs; |
|
|
881 | option B<-sbg>. |
|
|
882 | |
739 | =item B<termName:> I<termname> |
883 | =item B<termName:> I<termname> |
740 | |
884 | |
741 | Specifies the terminal type name to be set in the B<TERM> environment |
885 | Specifies the terminal type name to be set in the B<TERM> environment |
742 | variable; option B<-tn>. |
886 | variable; option B<-tn>. |
743 | |
887 | |
744 | =item B<linespace:> I<number> |
888 | =item B<lineSpace:> I<number> |
745 | |
889 | |
746 | Specifies number of lines (pixel height) to insert between each row of |
890 | Specifies number of lines (pixel height) to insert between each row of |
747 | the display [default 0]; option B<-lsp>. |
891 | the display [default 0]; option B<-lsp>. |
748 | |
892 | |
749 | =item B<meta8:> I<boolean> |
893 | =item B<meta8:> I<boolean> |
… | |
… | |
763 | |
907 | |
764 | =item B<cursorBlink:> I<boolean> |
908 | =item B<cursorBlink:> I<boolean> |
765 | |
909 | |
766 | B<True>: blink the cursor. B<False>: do not blink the cursor [default]; |
910 | B<True>: blink the cursor. B<False>: do not blink the cursor [default]; |
767 | option B<-bc>. |
911 | option B<-bc>. |
|
|
912 | |
|
|
913 | =item B<cursorUnderline:> I<boolean> |
|
|
914 | |
|
|
915 | B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default]; |
|
|
916 | option B<-uc>. |
768 | |
917 | |
769 | =item B<pointerBlank:> I<boolean> |
918 | =item B<pointerBlank:> I<boolean> |
770 | |
919 | |
771 | B<True>: blank the pointer when a key is pressed or after a set number |
920 | B<True>: blank the pointer when a key is pressed or after a set number |
772 | of seconds of inactivity. B<False>: the pointer is always visible |
921 | of seconds of inactivity. B<False>: the pointer is always visible |
… | |
… | |
780 | |
929 | |
781 | Mouse pointer background colour. |
930 | Mouse pointer background colour. |
782 | |
931 | |
783 | =item B<pointerBlankDelay:> I<number> |
932 | =item B<pointerBlankDelay:> I<number> |
784 | |
933 | |
785 | Specifies number of seconds before blanking the pointer [default 2]. |
934 | Specifies number of seconds before blanking the pointer [default 2]. Use a |
|
|
935 | large number (e.g. C<987654321>) to effectively disable the timeout. |
786 | |
936 | |
787 | =item B<backspacekey:> I<string> |
937 | =item B<backspacekey:> I<string> |
788 | |
938 | |
789 | The string to send when the backspace key is pressed. If set to B<DEC> |
939 | The string to send when the backspace key is pressed. If set to B<DEC> |
790 | or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> |
940 | or unset it will send B<Delete> (code 127) or, with control, B<Backspace> |
791 | (code 8) - which can be reversed with the appropriate DEC private mode |
941 | (code 8) - which can be reversed with the appropriate DEC private mode |
792 | escape sequence. |
942 | escape sequence. |
793 | |
943 | |
794 | =item B<deletekey:> I<string> |
944 | =item B<deletekey:> I<string> |
795 | |
945 | |
… | |
… | |
797 | pressed. If unset it will send the sequence traditionally associated |
947 | pressed. If unset it will send the sequence traditionally associated |
798 | with the B<Execute> key. |
948 | with the B<Execute> key. |
799 | |
949 | |
800 | =item B<cutchars:> I<string> |
950 | =item B<cutchars:> I<string> |
801 | |
951 | |
802 | The characters used as delimiters for double-click word selection. The |
952 | The characters used as delimiters for double-click word selection |
803 | built-in default: |
953 | (whitespace delimiting is added automatically if resource is given). |
804 | |
954 | |
|
|
955 | When the perl selection extension is in use (the default if compiled |
|
|
956 | in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these |
|
|
957 | characters will be created (if the resource exists, otherwise, no regex |
|
|
958 | will be created). In this mode, characters outside ISO-8859-1 can be used. |
|
|
959 | |
|
|
960 | When the selection extension is not used, only ISO-8859-1 characters can |
|
|
961 | be used. If not specified, the built-in default is used: |
|
|
962 | |
805 | B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> |
963 | B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> |
806 | |
964 | |
807 | =item B<preeditType:> I<style> |
965 | =item B<preeditType:> I<style> |
808 | |
966 | |
809 | B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. |
967 | B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. |
810 | |
968 | |
… | |
… | |
815 | =item B<imLocale:> I<name> |
973 | =item B<imLocale:> I<name> |
816 | |
974 | |
817 | The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. |
975 | The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. |
818 | C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the |
976 | C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the |
819 | input extension to be able to input japanese characters while staying in |
977 | input extension to be able to input japanese characters while staying in |
820 | another locale. option B<-imlocale>. |
978 | another locale; option B<-imlocale>. |
821 | |
979 | |
822 | =item B<imFont:> I<fontset> |
980 | =item B<imFont:> I<fontset> |
823 | |
981 | |
824 | Specify the font-set used for XIM styles C<OverTheSpot> or |
982 | Specify the font-set used for XIM styles C<OverTheSpot> or |
825 | C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated |
983 | C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated |
… | |
… | |
830 | |
988 | |
831 | =item B<tripleclickwords:> I<boolean> |
989 | =item B<tripleclickwords:> I<boolean> |
832 | |
990 | |
833 | Change the meaning of triple-click selection with the left mouse |
991 | Change the meaning of triple-click selection with the left mouse |
834 | button. Instead of selecting a full line it will extend the selection to |
992 | button. Instead of selecting a full line it will extend the selection to |
835 | the end of the logical line only. option B<-tcw>. |
993 | the end of the logical line only; option B<-tcw>. |
836 | |
994 | |
837 | =item B<insecure:> I<boolean> |
995 | =item B<insecure:> I<boolean> |
838 | |
996 | |
839 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences that |
997 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences that |
840 | echo arbitrary strings like the icon name or the locale. This could be |
998 | echo arbitrary strings like the icon name or the locale. This could be |
841 | abused if somebody gets 8-bit-clean access to your display, whether |
999 | abused if somebody gets 8-bit-clean access to your display, whether |
842 | throuh a mail client displaying mail bodies unfiltered or though |
1000 | through a mail client displaying mail bodies unfiltered or through |
843 | write(1). Therefore, these sequences are disabled by default. (Note |
1001 | write(1) or any other means. Therefore, these sequences are disabled by |
844 | that other terminals, including xterm, have these sequences |
1002 | default. (Note that many other terminals, including xterm, have these |
845 | enabled by default). You can enable them by setting this boolean |
1003 | sequences enabled by default, which doesn't make it safer, though). |
846 | resource or specifying B<-insecure> as an option. At the moment, this |
1004 | |
847 | enabled display-answer, locale, findfont, icon label and window title |
1005 | You can enable them by setting this boolean resource or specifying |
848 | requests as well as dynamic menubar dispatch. |
1006 | B<-insecure> as an option. At the moment, this enables display-answer, |
|
|
1007 | locale, findfont, icon label and window title requests. |
849 | |
1008 | |
850 | =item B<modifier:> I<modifier> |
1009 | =item B<modifier:> I<modifier> |
851 | |
1010 | |
852 | Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, |
1011 | Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, |
853 | B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option |
1012 | B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option |
… | |
… | |
857 | |
1016 | |
858 | Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) |
1017 | Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) |
859 | character is passed through. It may contain escape values as described |
1018 | character is passed through. It may contain escape values as described |
860 | in the entry on B<keysym> following. |
1019 | in the entry on B<keysym> following. |
861 | |
1020 | |
862 | =item B<secondaryScreen:> I<bool> |
1021 | =item B<secondaryScreen:> I<boolean> |
863 | |
1022 | |
864 | Turn on/off secondary screen (default enabled). |
1023 | Turn on/off secondary screen (default enabled). |
865 | |
1024 | |
866 | =item B<secondaryScroll:> I<bool> |
1025 | =item B<secondaryScroll:> I<boolean> |
867 | |
1026 | |
868 | Turn on/off secondary screen scroll (default enabled). If the this |
1027 | Turn on/off secondary screen scroll (default enabled). If this |
869 | option is enabled, scrolls on the secondary screen will change the |
1028 | option is enabled, scrolls on the secondary screen will change the |
870 | scrollback buffer and switching to/from the secondary screen will |
1029 | scrollback buffer and, when secondaryScreen is off, switching |
871 | instead scroll the screen up. |
1030 | to/from the secondary screen will instead scroll the screen up. |
872 | |
1031 | |
|
|
1032 | =item B<hold>: I<boolean> |
|
|
1033 | |
|
|
1034 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
|
|
1035 | will not immediately destroy its window when the program executed within |
|
|
1036 | it exits. Instead, it will wait till it is being killed or closed by the |
|
|
1037 | user. |
|
|
1038 | |
|
|
1039 | =item B<chdir>: I<path> |
|
|
1040 | |
|
|
1041 | Sets the working directory for the shell (or the command specified via |
|
|
1042 | B<-e>). The I<path> must be an absolute path and it must exist for |
|
|
1043 | @@RXVT_NAME@@ to start. If it isn't specified then the current working |
|
|
1044 | directory will be used; option B<-cd>. |
|
|
1045 | |
873 | =item B<keysym.>I<sym>: I<string> |
1046 | =item B<keysym.>I<sym>: I<action> |
874 | |
1047 | |
875 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
1048 | Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening |
876 | intervening resource name B<keysym.> cannot be omitted. |
1049 | resource name B<keysym.> cannot be omitted. |
877 | |
1050 | |
878 | The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be |
1051 | Using this resource, you can map key combinations such as |
879 | any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, |
1052 | C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different |
880 | B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, |
1053 | string than would normally result from that combination, making the |
881 | and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, |
1054 | terminal scroll up or down the way you want it, or any other thing an |
882 | B<2>, B<3>, B<4>, B<5>. |
1055 | extension might provide. |
|
|
1056 | |
|
|
1057 | The key combination that triggers the action, I<sym>, has the following format: |
|
|
1058 | |
|
|
1059 | (modifiers-)key |
|
|
1060 | |
|
|
1061 | Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>, |
|
|
1062 | B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, |
|
|
1063 | B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>, |
|
|
1064 | B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>. |
883 | |
1065 | |
884 | The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to |
1066 | The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to |
885 | whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr |
1067 | whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr |
886 | keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the |
1068 | keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the |
887 | current application keymap mode state. |
1069 | current application keymap mode state. |
888 | |
1070 | |
889 | The spellings of I<key> can be obtained by using B<xev>(1) command or |
1071 | Due the the large number of modifier combinations, a key mapping will |
890 | searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and |
1072 | match if I<at least> the specified identifiers are being set, and no other |
|
|
1073 | key mappings with those and more bits are being defined. That means that |
|
|
1074 | defining a mapping for C<a> will automatically provide definitions for |
|
|
1075 | C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings |
|
|
1076 | themselves. See the C<builtin:> action, below, for a way to work around |
|
|
1077 | this when this is a problem. |
|
|
1078 | |
|
|
1079 | The spelling of I<key> depends on your implementation of X. An easy way to |
|
|
1080 | find a key name is to use the B<xev>(1) command. You can find a list by |
|
|
1081 | looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit |
891 | omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex |
1082 | the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym |
892 | keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not |
1083 | value (B<0x0000 - 0xFFFF>). |
893 | performed in an exact manner; however, the closest match is assured. |
|
|
894 | |
1084 | |
895 | I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, |
1085 | As with any resource value, the I<action> string may contain backslash |
896 | C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, |
1086 | escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal |
897 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
1087 | number), see RESOURCES in C<man 7 X> for further details. |
898 | C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it |
|
|
899 | can start or end with whitespace. |
|
|
900 | |
1088 | |
901 | Please note that you need to double the C<\> when using |
1089 | An action starts with an action prefix that selects a certain type |
902 | C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can |
1090 | of action, followed by a colon. An action strings without colons is |
903 | use C<\033> instead of C<\e> (and so on), which will work with both Xt and |
1091 | interpreted as a literal string to pass to the tty (as if they were |
904 | @@RXVT_NAME@@'s own processing). |
1092 | prefixed with C<string:>). |
905 | |
1093 | |
906 | You can define a range of keysyms in one shot by providing a I<string> |
1094 | The following action prefixes are known - extensions can provide |
907 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' |
1095 | additional prefixes: |
908 | should be a character not used by the strings. |
|
|
909 | |
1096 | |
910 | Its usage can be demonstrated by an example: |
1097 | =over 4 |
911 | |
1098 | |
912 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
1099 | =item string:STRING |
913 | |
1100 | |
914 | The above line is equivalent to the following three lines: |
1101 | If the I<action> starts with C<string:> (or otherwise contains no colons), |
|
|
1102 | then the remaining C<STRING> will be passed to the program running in the |
|
|
1103 | terminal. For example, you could replace whatever Shift-Tab outputs by the |
|
|
1104 | string C<echo rm -rf /> followed by a newline: |
915 | |
1105 | |
916 | URxvt.keysym.Meta-Control-0x61: \033<M-C-a> |
1106 | URxvt.keysym.Shift-Tab: string:echo rm -rf /\n |
917 | URxvt.keysym.Meta-Control-0x62: \033<M-C-b> |
|
|
918 | URxvt.keysym.Meta-Control-0x63: \033<M-C-c> |
|
|
919 | |
1107 | |
|
|
1108 | This could in theory be used to completely redefine your keymap. |
|
|
1109 | |
|
|
1110 | =item command:STRING |
|
|
1111 | |
920 | If I<string> takes the form of C<command:STRING>, the specified B<STRING> |
1112 | If I<action> takes the form of C<command:STRING>, the specified B<STRING> |
921 | is interpreted and executed as @@RXVT_NAME@@'s control sequence. For |
1113 | is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically |
|
|
1114 | the opposite of C<string:> - instead of sending it to the program running |
|
|
1115 | in the terminal, it will be treated as if it were program output). This is |
|
|
1116 | most useful to feed command sequences into @@RXVT_NAME@@. |
|
|
1117 | |
922 | example the following means "change the current locale to C<zh_CN.GBK> |
1118 | For example the following means "change the current locale to C<zh_CN.GBK> |
923 | when Control-Meta-c is being pressed": |
1119 | when Control-Meta-c is being pressed": |
924 | |
1120 | |
925 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1121 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
926 | |
1122 | |
927 | The following example will map Control-Meta-1 and Control-Meta-2 to |
1123 | The following example will map Control-Meta-1 and Control-Meta-2 to |
… | |
… | |
934 | Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more |
1130 | Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more |
935 | info): |
1131 | info): |
936 | |
1132 | |
937 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
1133 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
938 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
1134 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
|
|
1135 | |
|
|
1136 | =item builtin: |
|
|
1137 | |
|
|
1138 | The builtin action is the action that @@RXVT_NAME@@ would execute if no |
|
|
1139 | key binding existed for the key combination. The obvious use is to undo |
|
|
1140 | the effect of existing bindings. The not so obvious use is to reinstate |
|
|
1141 | bindings when another binding overrides too many modifiers. |
|
|
1142 | |
|
|
1143 | For example if you overwrite the C<Insert> key you will disable |
|
|
1144 | @@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke |
|
|
1145 | "holes" into the user-defined keymap using the C<builtin:> replacement: |
|
|
1146 | |
|
|
1147 | URxvt.keysym.Insert: <my insert key sequence> |
|
|
1148 | URxvt.keysym.S-Insert: builtin: |
|
|
1149 | |
|
|
1150 | The first line defines a mapping for C<Insert> and I<any> combination |
|
|
1151 | of modifiers. The second line re-establishes the default mapping for |
|
|
1152 | C<Shift-Insert>. |
|
|
1153 | |
|
|
1154 | =item builtin-string: |
|
|
1155 | |
|
|
1156 | This action is mainly useful to restore string mappings for keys that |
|
|
1157 | have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit |
|
|
1158 | difficult to explain - basically, this action will send the string to the |
|
|
1159 | application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in |
|
|
1160 | action for it. |
|
|
1161 | |
|
|
1162 | An example might make it clearer: @@RXVT_NAME@@ normally pastes the |
|
|
1163 | selection when you press C<Shift-Insert>. With the following bindings, it |
|
|
1164 | would instead emit the (undocumented, but what applications running in the |
|
|
1165 | terminal might expect) sequence C<ESC [ 2 $> instead: |
|
|
1166 | |
|
|
1167 | URxvt.keysym.S-Insert: builtin-string: |
|
|
1168 | URxvt.keysym.C-S-Insert: builtin: |
|
|
1169 | |
|
|
1170 | The first line disables the paste functionality for that key |
|
|
1171 | combination, and the second reinstates the default behaviour for |
|
|
1172 | C<Control-Shift-Insert>, which would otherwise be overridden. |
|
|
1173 | |
|
|
1174 | Similarly, to let applications gain access to the C<C-M-c> (copy to |
|
|
1175 | clipboard) and C<C-M-v> (paste clipboard) key combination, you can do |
|
|
1176 | this: |
|
|
1177 | |
|
|
1178 | URxvt.keysym.C-S-c: builtin-string: |
|
|
1179 | URxvt.keysym.C-S-v: builtin-string: |
|
|
1180 | |
|
|
1181 | =item EXTENSION:STRING |
|
|
1182 | |
|
|
1183 | An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3) |
|
|
1184 | extension of the same name. The extension will be loaded automatically if |
|
|
1185 | neccessary. |
|
|
1186 | |
|
|
1187 | Not all extensions define key actions, but popular extensions that do |
|
|
1188 | include the I<selection> and I<matcher> extensions (documented in their |
|
|
1189 | own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1), |
|
|
1190 | respectively). |
|
|
1191 | |
|
|
1192 | From the silly examples department, this will rot13-"encrypt" |
|
|
1193 | @@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC |
|
|
1194 | keyboards: |
|
|
1195 | |
|
|
1196 | URxvt.keysym.M-C-c: selection:rot13 |
|
|
1197 | |
|
|
1198 | =item perl:STRING |
|
|
1199 | |
|
|
1200 | This is a deprecated way of passing key mappings to perl extensions. It is |
|
|
1201 | still supported, but should not be used anymore. |
|
|
1202 | |
|
|
1203 | =back |
|
|
1204 | |
|
|
1205 | In addition, you can define a range of keysyms in one shot by loading |
|
|
1206 | the C<keysym-list> perl extension and providing a I<string> with pattern |
|
|
1207 | B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' should be a |
|
|
1208 | character not used by the strings. |
|
|
1209 | |
|
|
1210 | Its usage can be demonstrated by an example: |
|
|
1211 | |
|
|
1212 | URxvt.keysym.M-C-0x61: list|\033<|abc|> |
|
|
1213 | |
|
|
1214 | The above line is equivalent to the following three lines: |
|
|
1215 | |
|
|
1216 | URxvt.keysym.Meta-Control-0x61: \033<a> |
|
|
1217 | URxvt.keysym.Meta-Control-0x62: \033<b> |
|
|
1218 | URxvt.keysym.Meta-Control-0x63: \033<c> |
|
|
1219 | |
|
|
1220 | =item B<perl-ext-common>: I<string> |
|
|
1221 | |
|
|
1222 | =item B<perl-ext>: I<string> |
|
|
1223 | |
|
|
1224 | Comma-separated list(s) of perl extension scripts (default: C<default>) to |
|
|
1225 | use in this terminal instance; option B<-pe>. |
|
|
1226 | |
|
|
1227 | Extension names can be prefixed with a C<-> sign to prohibit using |
|
|
1228 | them. This can be useful to selectively disable some extensions loaded |
|
|
1229 | by default, or specified via the C<perl-ext-common> resource. For |
|
|
1230 | example, C<default,-selection> will use all the default extension except |
|
|
1231 | C<selection>. |
|
|
1232 | |
|
|
1233 | Extension names can also be followed by an argument in angle brackets |
|
|
1234 | (e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for |
|
|
1235 | searchable scrollback to Alt/Meta-s). Mentioning the same extension |
|
|
1236 | multiple times with different arguments will pass multiple arguments to |
|
|
1237 | the extension. |
|
|
1238 | |
|
|
1239 | Each extension is looked up in the library directories, loaded if |
|
|
1240 | necessary, and bound to the current terminal instance. |
|
|
1241 | |
|
|
1242 | If both of these resources are the empty string, then the perl |
|
|
1243 | interpreter will not be initialized. The idea behind two options is that |
|
|
1244 | B<perl-ext-common> will be used for extensions that should be available to |
|
|
1245 | all instances, while B<perl-ext> is used for specific instances. |
|
|
1246 | |
|
|
1247 | =item B<perl-eval>: I<string> |
|
|
1248 | |
|
|
1249 | Perl code to be evaluated when all extensions have been registered. See |
|
|
1250 | the @@RXVT_NAME@@perl(3) manpage. |
|
|
1251 | |
|
|
1252 | =item B<perl-lib>: I<path> |
|
|
1253 | |
|
|
1254 | Colon-separated list of additional directories that hold extension |
|
|
1255 | scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look |
|
|
1256 | in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and |
|
|
1257 | lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
|
|
1258 | |
|
|
1259 | See the @@RXVT_NAME@@perl(3) manpage. |
|
|
1260 | |
|
|
1261 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
|
|
1262 | |
|
|
1263 | Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for |
|
|
1264 | details. |
|
|
1265 | |
|
|
1266 | =item B<< selection-autotransform.I<idx> >>: I<perl-transform> |
|
|
1267 | |
|
|
1268 | Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage |
|
|
1269 | for details. |
|
|
1270 | |
|
|
1271 | =item B<searchable-scrollback:> I<keysym> |
|
|
1272 | |
|
|
1273 | Sets the hotkey that starts the incremental scrollback buffer search |
|
|
1274 | (default: C<M-s>). |
|
|
1275 | |
|
|
1276 | =item B<url-launcher>: I<string> |
|
|
1277 | |
|
|
1278 | Specifies the program to be started with a URL argument. Used by the |
|
|
1279 | C<selection-popup> and C<matcher> perl extensions. |
|
|
1280 | |
|
|
1281 | =item B<transient-for>: I<windowid> |
|
|
1282 | |
|
|
1283 | Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. |
|
|
1284 | |
|
|
1285 | =item B<override-redirect>: I<boolean> |
|
|
1286 | |
|
|
1287 | Compile I<frills>: Sets override-redirect for the terminal window, making |
|
|
1288 | it almost invisible to window managers; option B<-override-redirect>. |
|
|
1289 | |
|
|
1290 | =item B<iso14755:> I<boolean> |
|
|
1291 | |
|
|
1292 | Turn on/off ISO 14755 (default enabled). |
|
|
1293 | |
|
|
1294 | =item B<iso14755_52:> I<boolean> |
|
|
1295 | |
|
|
1296 | Turn on/off ISO 14755 5.2 mode (default enabled). |
|
|
1297 | |
|
|
1298 | =back |
|
|
1299 | |
|
|
1300 | =head1 BACKGROUND IMAGE OPTIONS AND RESOURCES |
|
|
1301 | |
|
|
1302 | =over 4 |
|
|
1303 | |
|
|
1304 | =item B<-pixmap> I<file[;oplist]> |
|
|
1305 | |
|
|
1306 | =item B<backgroundPixmap:> I<file[;oplist]> |
|
|
1307 | |
|
|
1308 | Compile I<pixbuf>: Use the specified image file as the window's |
|
|
1309 | background and also optionally specify a colon separated list of |
|
|
1310 | operations to modify it. Note that you may need to quote the C<;> |
|
|
1311 | character when using the command line option, as C<;> is usually a |
|
|
1312 | metacharacter in shells. Supported operations are: |
|
|
1313 | |
|
|
1314 | =over 4 |
|
|
1315 | |
|
|
1316 | =item B<WxH+X+Y> |
|
|
1317 | |
|
|
1318 | sets scale and position. B<"W" / "H"> specify the horizontal/vertical |
|
|
1319 | scale (percent), and B<"X" / "Y"> locate the image centre (percent). A |
|
|
1320 | scale of 0 disables scaling. |
|
|
1321 | |
|
|
1322 | =item B<op=tile> |
|
|
1323 | |
|
|
1324 | enables tiling |
|
|
1325 | |
|
|
1326 | =item B<op=keep-aspect> |
|
|
1327 | |
|
|
1328 | maintain the image aspect ratio when scaling |
|
|
1329 | |
|
|
1330 | =item B<op=root-align> |
|
|
1331 | |
|
|
1332 | use the position of the terminal window relative to the root window as |
|
|
1333 | the image offset, simulating a root window background |
|
|
1334 | |
|
|
1335 | =back |
|
|
1336 | |
|
|
1337 | The default scale and position setting is C<100x100+50+50>. |
|
|
1338 | Alternatively, a predefined set of templates can be used to achieve |
|
|
1339 | the most common setups: |
|
|
1340 | |
|
|
1341 | =over 4 |
|
|
1342 | |
|
|
1343 | =item B<style=tiled> |
|
|
1344 | |
|
|
1345 | the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile |
|
|
1346 | |
|
|
1347 | =item B<style=aspect-stretched> |
|
|
1348 | |
|
|
1349 | the image is scaled to fill the whole window maintaining the aspect |
|
|
1350 | ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect |
|
|
1351 | |
|
|
1352 | =item B<style=stretched> |
|
|
1353 | |
|
|
1354 | the image is scaled to fill the whole window. Equivalent to 100x100 |
|
|
1355 | |
|
|
1356 | =item B<style=centered> |
|
|
1357 | |
|
|
1358 | the image is centered with no scaling. Equivalent to 0x0+50+50 |
|
|
1359 | |
|
|
1360 | =item B<style=root-tiled> |
|
|
1361 | |
|
|
1362 | the image is tiled with no scaling and using 'root' positioning. |
|
|
1363 | Equivalent to 0x0:op=tile:op=root-align |
|
|
1364 | |
|
|
1365 | =back |
|
|
1366 | |
|
|
1367 | If multiple templates are specified the last one wins. Note that a |
|
|
1368 | template overrides all the scale, position and operations settings. |
|
|
1369 | |
|
|
1370 | If used in conjunction with pseudo-transparency, the specified pixmap |
|
|
1371 | will be blended over the transparent background using alpha-blending. |
|
|
1372 | |
|
|
1373 | =item B<-tr>|B<+tr> |
|
|
1374 | |
|
|
1375 | =item B<transparent:> I<boolean> |
|
|
1376 | |
|
|
1377 | Turn on/off pseudo-transparency by using the root pixmap as background. |
|
|
1378 | |
|
|
1379 | B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but |
|
|
1380 | will be removed in future versions. |
|
|
1381 | |
|
|
1382 | =item B<-tint> I<colour> |
|
|
1383 | |
|
|
1384 | =item B<tintColor:> I<colour> |
|
|
1385 | |
|
|
1386 | Tint the transparent background with the given colour. Note that a |
|
|
1387 | black tint yields a completely black image while a white tint yields |
|
|
1388 | the image unchanged. |
|
|
1389 | |
|
|
1390 | =item B<-sh> I<number> |
|
|
1391 | |
|
|
1392 | =item B<shading:> I<number> |
|
|
1393 | |
|
|
1394 | Darken (0 .. 99) or lighten (101 .. 200) the transparent background. |
|
|
1395 | A value of 100 means no shading. |
|
|
1396 | |
|
|
1397 | =item B<-blr> I<HxV> |
|
|
1398 | |
|
|
1399 | =item B<blurRadius:> I<HxV> |
|
|
1400 | |
|
|
1401 | Apply gaussian blur with the specified radius to the transparent |
|
|
1402 | background. If a single number is specified, the vertical and |
|
|
1403 | horizontal radii are considered to be the same. Setting one of the |
|
|
1404 | radii to 1 and the other to a large number creates interesting effects |
|
|
1405 | on some backgrounds. The maximum radius value is 128. An horizontal or |
|
|
1406 | vertical radius of 0 disables blurring. |
|
|
1407 | |
|
|
1408 | =item B<path:> I<path> |
|
|
1409 | |
|
|
1410 | Specify the colon-delimited search path for finding background image files. |
939 | |
1411 | |
940 | =back |
1412 | =back |
941 | |
1413 | |
942 | =head1 THE SCROLLBAR |
1414 | =head1 THE SCROLLBAR |
943 | |
1415 | |
… | |
… | |
962 | application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> |
1434 | application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> |
963 | (Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the |
1435 | (Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the |
964 | up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), |
1436 | up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), |
965 | respectively. |
1437 | respectively. |
966 | |
1438 | |
967 | =head1 TEXT SELECTION AND INSERTION |
1439 | =head1 THE SELECTION: SELECTING AND PASTING TEXT |
968 | |
1440 | |
969 | The behaviour of text selection and insertion mechanism is similar to |
1441 | The behaviour of text selection and insertion/pasting mechanism is similar |
970 | I<xterm>(1). |
1442 | to I<xterm>(1). |
971 | |
1443 | |
972 | =over 4 |
1444 | =over 4 |
973 | |
1445 | |
974 | =item B<Selection>: |
1446 | =item B<Selecting>: |
975 | |
1447 | |
976 | Left click at the beginning of the region, drag to the end of the region |
1448 | Left click at the beginning of the region, drag to the end of the region |
977 | and release; Right click to extend the marked region; Left double-click |
1449 | and release; Right click to extend the marked region; Left double-click |
978 | to select a word; Left triple-click to select the entire logical line |
1450 | to select a word; Left triple-click to select the entire logical line |
979 | (which can span multiple screen lines), unless modified by resource |
1451 | (which can span multiple screen lines), unless modified by resource |
980 | B<tripleclickwords>. |
1452 | B<tripleclickwords>. |
981 | |
1453 | |
982 | Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) |
1454 | Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) |
983 | (Compile: I<frills>) will create a rectangular selection instead of a normal |
1455 | (Compile: I<frills>) will create a rectangular selection instead of a |
984 | one. |
1456 | normal one. In this mode, every selected row becomes its own line in the |
|
|
1457 | selection, and trailing whitespace is visually underlined and removed from |
|
|
1458 | the selection. |
985 | |
1459 | |
986 | =item B<Insertion>: |
1460 | =item B<Pasting>: |
987 | |
1461 | |
988 | Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in |
1462 | Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> |
989 | an B<@@RXVT_NAME@@> window causes the current text selection to be |
1463 | window causes the value of the PRIMARY selection (or CLIPBOARD with the |
990 | inserted as if it had been typed on the keyboard. |
1464 | B<Meta> modifier) to be inserted as if it had been typed on the keyboard. |
|
|
1465 | |
|
|
1466 | Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be |
|
|
1467 | inserted too. |
|
|
1468 | |
|
|
1469 | rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and |
|
|
1470 | <Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first |
|
|
1471 | binding causes the value of the internal selection to be copied to the |
|
|
1472 | CLIPBOARD selection, while the second binding causes the value of the |
|
|
1473 | CLIPBOARD selection to be inserted. |
991 | |
1474 | |
992 | =back |
1475 | =back |
993 | |
1476 | |
994 | =head1 CHANGING FONTS |
1477 | =head1 CHANGING FONTS |
995 | |
1478 | |
996 | Changing fonts (or font sizes, respectively) via the keypad is not yet |
1479 | Changing fonts (or font sizes, respectively) via the keypad is not yet |
997 | supported in rxvt-unicode. Bug me if you need this. |
1480 | supported in rxvt-unicode. Bug me if you need this. |
998 | |
1481 | |
999 | You can, however, switch fonts at runtime using escape sequences (and |
1482 | You can, however, switch fonts at runtime using escape sequences, e.g.: |
1000 | therefore using the menubar), e.g.: |
|
|
1001 | |
1483 | |
1002 | printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" |
1484 | printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" |
|
|
1485 | |
|
|
1486 | You can use keyboard shortcuts, too: |
|
|
1487 | |
|
|
1488 | URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007 |
|
|
1489 | URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007 |
1003 | |
1490 | |
1004 | rxvt-unicode will automatically re-apply these fonts to the output so far. |
1491 | rxvt-unicode will automatically re-apply these fonts to the output so far. |
1005 | |
1492 | |
1006 | =head1 ISO 14755 SUPPORT |
1493 | =head1 ISO 14755 SUPPORT |
1007 | |
1494 | |
1008 | ISO 14755 is a standard for entering and viewing unicode characters |
1495 | ISO 14755 is a standard for entering and viewing unicode characters |
1009 | and character codes using the keyboard. It consists of 4 parts. The |
1496 | and character codes using the keyboard. It consists of 4 parts. The |
1010 | first part is available rxvt-unicode has been compiled with |
1497 | first part is available if rxvt-unicode has been compiled with |
1011 | C<--enable-frills>, the rest is available when rxvt-unicode was compiled |
1498 | C<--enable-frills>, the rest is available when rxvt-unicode was compiled |
1012 | with C<--enable-iso14755>. |
1499 | with C<--enable-iso14755>. |
1013 | |
1500 | |
1014 | =over 4 |
1501 | =over 4 |
1015 | |
1502 | |
… | |
… | |
1035 | This mode lets you input characters representing the keycap symbols of |
1522 | This mode lets you input characters representing the keycap symbols of |
1036 | your keyboard, if representable in the current locale encoding. |
1523 | your keyboard, if representable in the current locale encoding. |
1037 | |
1524 | |
1038 | Start by pressing C<Control> and C<Shift> together, then releasing |
1525 | Start by pressing C<Control> and C<Shift> together, then releasing |
1039 | them. The next special key (cursor keys, home etc.) you enter will not |
1526 | them. The next special key (cursor keys, home etc.) you enter will not |
1040 | invoke it's usual function but instead will insert the corresponding |
1527 | invoke its usual function but instead will insert the corresponding |
1041 | keycap symbol. The symbol will only be entered when the key has been |
1528 | keycap symbol. The symbol will only be entered when the key has been |
1042 | released, otherwise pressing e.g. C<Shift> would enter the symbol for |
1529 | released, otherwise pressing e.g. C<Shift> would enter the symbol for |
1043 | C<ISO Level 2 Switch>, although your intention might have been to enter a |
1530 | C<ISO Level 2 Switch>, although your intention might have been to enter a |
1044 | reverse tab (Shift-Tab). |
1531 | reverse tab (Shift-Tab). |
1045 | |
1532 | |
… | |
… | |
1073 | B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that |
1560 | B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that |
1074 | it can be seen via the I<who(1)> command, and can accept messages. To |
1561 | it can be seen via the I<who(1)> command, and can accept messages. To |
1075 | allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root |
1562 | allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root |
1076 | on some systems or setgid to root or to some other group on others. |
1563 | on some systems or setgid to root or to some other group on others. |
1077 | |
1564 | |
1078 | =head1 COLORS AND GRAPHICS |
1565 | =head1 COLOURS AND GRAPHICS |
1079 | |
1566 | |
1080 | In addition to the default foreground and background colours, |
1567 | In addition to the default foreground and background colours, |
1081 | B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus |
1568 | B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus |
1082 | high-intensity bold/blink versions of the same). Here is a list of the |
1569 | high-intensity (potentially bold/blink) versions of the same, and 72 (or |
1083 | colours with their B<rgb.txt> names. |
1570 | 240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB |
|
|
1571 | cube plus a 8 (24) colour greyscale ramp. |
|
|
1572 | |
|
|
1573 | Here is a list of the ANSI colours with their names. |
1084 | |
1574 | |
1085 | =begin table |
1575 | =begin table |
1086 | |
1576 | |
1087 | B<color0> (black) = Black |
1577 | B<color0> (black) = Black |
1088 | B<color1> (red) = Red3 |
1578 | B<color1> (red) = Red3 |
… | |
… | |
1108 | It is also possible to specify the colour values of B<foreground>, |
1598 | It is also possible to specify the colour values of B<foreground>, |
1109 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1599 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1110 | a number 0-15, as a convenient shorthand to reference the colour name of |
1600 | a number 0-15, as a convenient shorthand to reference the colour name of |
1111 | color0-color15. |
1601 | color0-color15. |
1112 | |
1602 | |
|
|
1603 | The following text gives values for the standard 88 colour mode (and |
|
|
1604 | values for the 256 colour mode in parentheses). |
|
|
1605 | |
|
|
1606 | The RGB cube uses indices 16..79 (16..231) using the following formulas: |
|
|
1607 | |
|
|
1608 | index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 |
|
|
1609 | index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5 |
|
|
1610 | |
|
|
1611 | The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% |
|
|
1612 | steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of |
|
|
1613 | the RGB cube. |
|
|
1614 | |
|
|
1615 | Together, all those colours implement the 88 (256) colour xterm |
|
|
1616 | colours. Only the first 16 can be changed using resources currently, the |
|
|
1617 | rest can only be changed via command sequences ("escape codes"). |
|
|
1618 | |
|
|
1619 | Applications are advised to use terminfo or command sequences to discover |
|
|
1620 | number and RGB values of all colours (yes, you can query this...). |
|
|
1621 | |
1113 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1622 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1114 | always swapping the foreground/background colours. This is in contrast to |
1623 | always swapping the foreground/background colours. This is in contrast to |
1115 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1624 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1116 | been specified. For example, |
1625 | been specified. For example, |
1117 | |
1626 | |
|
|
1627 | @@RXVT_NAME@@ -fg Black -bg White -rv |
|
|
1628 | |
|
|
1629 | would yield White on Black, while on I<xterm>(1) it would yield Black on |
|
|
1630 | White. |
|
|
1631 | |
|
|
1632 | =head2 ALPHA CHANNEL SUPPORT |
|
|
1633 | |
|
|
1634 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
|
|
1635 | their act together, rxvt-unicode will do its own alpha channel management: |
|
|
1636 | |
|
|
1637 | You can prefix any colour with an opaqueness percentage enclosed in |
|
|
1638 | brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage |
|
|
1639 | (0-100) that specifies the opacity of the colour, where C<0> is completely |
|
|
1640 | transparent and C<100> is completely opaque. For example, C<[50]red> is a |
|
|
1641 | half-transparent red, while C<[95]#00ff00> is an almost opaque green. This |
|
|
1642 | is the recommended format to specify transparency values, and works with |
|
|
1643 | all ways to specify a colour. |
|
|
1644 | |
|
|
1645 | For complete control, rxvt-unicode also supports |
|
|
1646 | C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour |
|
|
1647 | specifications, where the additional C<aaaa> component specifies opacity |
|
|
1648 | (alpha) values. The minimum value of C<0000> is completely transparent, |
|
|
1649 | while C<ffff> is completely opaque). The two example colours from |
|
|
1650 | earlier could also be specified as C<rgba:ff00/0000/0000/8000> and |
|
|
1651 | C<rgba:0000/ff00/0000/f332>. |
|
|
1652 | |
|
|
1653 | You probably need to specify B<"-depth 32">, too, to force a visual with |
|
|
1654 | alpha channels, and have the luck that your X-server uses ARGB pixel |
|
|
1655 | layout, as X is far from just supporting ARGB visuals out of the box, and |
|
|
1656 | rxvt-unicode just fudges around. |
|
|
1657 | |
|
|
1658 | For example, the following selects an almost completely transparent black |
|
|
1659 | background, and an almost opaque pink foreground: |
|
|
1660 | |
|
|
1661 | @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink" |
|
|
1662 | |
|
|
1663 | When not using a background image, then the interpretation of the |
|
|
1664 | alpha channel is up to your compositing manager (most interpret it as |
|
|
1665 | transparency of course). |
|
|
1666 | |
|
|
1667 | When using a background pixmap or pseudo-transparency, then the background |
|
|
1668 | colour will always behave as if it were completely transparent (so the |
|
|
1669 | background image shows instead), regardless of how it was specified, while |
|
|
1670 | other colours will either be transparent as specified (the background |
|
|
1671 | image will show through) on servers supporting the RENDER extension, or |
|
|
1672 | fully opaque on servers not supporting the RENDER EXTENSION. |
|
|
1673 | |
|
|
1674 | Please note that due to bugs in Xft, specifying alpha values might result |
|
|
1675 | in garbage being displayed when the X-server does not support the RENDER |
|
|
1676 | extension. |
|
|
1677 | |
|
|
1678 | =head1 ENVIRONMENT |
|
|
1679 | |
|
|
1680 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
|
|
1681 | |
1118 | =over 4 |
1682 | =over 4 |
1119 | |
1683 | |
1120 | =item B<@@RXVT_NAME@@ -fg Black -bg White -rv> |
|
|
1121 | |
|
|
1122 | would yield White on Black, while on I<xterm>(1) it would yield Black |
|
|
1123 | on White. |
|
|
1124 | |
|
|
1125 | =back |
|
|
1126 | |
|
|
1127 | =head1 ENVIRONMENT |
|
|
1128 | |
|
|
1129 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
|
|
1130 | |
|
|
1131 | =over 4 |
|
|
1132 | |
|
|
1133 | =item B<TERM> |
1684 | =item B<TERM> |
1134 | |
1685 | |
1135 | Normally set to C<rxvt-unicode>, unless overwritten at configure time, via |
1686 | Normally set to C<rxvt-unicode>, unless overwritten at configure time, via |
1136 | resources or on the commandline. |
1687 | resources or on the command line. |
1137 | |
1688 | |
1138 | =item B<COLORTERM> |
1689 | =item B<COLORTERM> |
1139 | |
1690 | |
1140 | Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was |
1691 | Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was |
1141 | compiled with XPM support, and optionally with the added extension |
1692 | compiled with background image support, and optionally with the added |
1142 | C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. |
1693 | extension C<-mono> to indicate that rxvt-unicode runs on a monochrome |
|
|
1694 | screen. |
1143 | |
1695 | |
1144 | =item B<COLORFGBG> |
1696 | =item B<COLORFGBG> |
1145 | |
1697 | |
1146 | Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is |
1698 | Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is |
1147 | the colour code used as default foreground/text colour (or the string |
1699 | the colour code used as default foreground/text colour (or the string |
1148 | C<default> to indicate that the default-colour escape sequence is to be |
1700 | C<default> to indicate that the default-colour escape sequence is to be |
1149 | used), C<bg> is the colour code used as default background colour (or the |
1701 | used), C<bg> is the colour code used as default background colour (or the |
1150 | string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ |
1702 | string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ |
1151 | was compiled with XPM support. Libraries like C<ncurses> and C<slang> can |
1703 | was compiled with background image support. Libraries like C<ncurses> |
1152 | (and do) use this information to optimize screen output. |
1704 | and C<slang> can (and do) use this information to optimize screen output. |
1153 | |
1705 | |
1154 | =item B<WINDOWID> |
1706 | =item B<WINDOWID> |
1155 | |
1707 | |
1156 | Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel |
1708 | Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel |
1157 | window, which usually has subwindows for the scrollbar, the terminal |
1709 | window, which usually has subwindows for the scrollbar, the terminal |
… | |
… | |
1163 | C<--with-terminfo=PATH>. |
1715 | C<--with-terminfo=PATH>. |
1164 | |
1716 | |
1165 | =item B<DISPLAY> |
1717 | =item B<DISPLAY> |
1166 | |
1718 | |
1167 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1719 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1168 | display in it's child processes. |
1720 | display in its child processes if C<-display> isn't used to override. It |
|
|
1721 | defaults to C<:0> if it doesn't exist. |
1169 | |
1722 | |
1170 | =item B<SHELL> |
1723 | =item B<SHELL> |
1171 | |
1724 | |
1172 | The shell to be used for command execution, defaults to C</bin/sh>. |
1725 | The shell to be used for command execution, defaults to C</bin/sh>. |
1173 | |
1726 | |
1174 | =item B<RXVTPATH> |
|
|
1175 | |
|
|
1176 | The path where @@RXVT_NAME@@ looks for support files such as menu and xpm |
|
|
1177 | files. |
|
|
1178 | |
|
|
1179 | =item B<PATH> |
|
|
1180 | |
|
|
1181 | Used in the same way as C<RXVTPATH>. |
|
|
1182 | |
|
|
1183 | =item B<RXVT_SOCKET> |
1727 | =item B<RXVT_SOCKET> [I<sic>] |
1184 | |
1728 | |
1185 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1729 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1186 | @@RXVT_NAME@@d(1). |
1730 | @@RXVT_NAME@@d(1). |
1187 | |
1731 | |
1188 | Default C<< $HOME/.rxvt-unicode-<nodename >>. |
1732 | Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>. |
|
|
1733 | |
|
|
1734 | =item B<URXVT_PERL_LIB> |
|
|
1735 | |
|
|
1736 | Additional F<:>-separated library search path for perl extensions. Will be |
|
|
1737 | searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library |
|
|
1738 | directory. |
|
|
1739 | |
|
|
1740 | =item B<URXVT_PERL_VERBOSITY> |
|
|
1741 | |
|
|
1742 | See L<@@RXVT_NAME@@perl>(3). |
1189 | |
1743 | |
1190 | =item B<HOME> |
1744 | =item B<HOME> |
1191 | |
1745 | |
1192 | Used to locate the default directory for the unix domain socket for |
1746 | Used to locate the default directory for the unix domain socket for |
1193 | daemon communications and to locate various resource files (such as |
1747 | daemon communications and to locate various resource files (such as |
1194 | C<.Xdefaults>) |
1748 | C<.Xdefaults>) |
1195 | |
1749 | |
1196 | =item B<XAPPLRESDIR> |
1750 | =item B<XAPPLRESDIR> |
1197 | |
1751 | |
1198 | Directory where various X resource files are being located. |
1752 | Directory where application-specific X resource files are located. |
1199 | |
1753 | |
1200 | =item B<XENVIRONMENT> |
1754 | =item B<XENVIRONMENT> |
1201 | |
1755 | |
1202 | If set and accessible, gives the name of a X resource file to be loaded by |
1756 | If set and accessible, gives the name of a X resource file to be loaded by |
1203 | @@RXVT_NAME@@. |
1757 | @@RXVT_NAME@@. |
… | |
… | |
1208 | |
1762 | |
1209 | =over 4 |
1763 | =over 4 |
1210 | |
1764 | |
1211 | =item B</usr/lib/X11/rgb.txt> |
1765 | =item B</usr/lib/X11/rgb.txt> |
1212 | |
1766 | |
1213 | Color names. |
1767 | Colour names. |
1214 | |
1768 | |
1215 | =back |
1769 | =back |
1216 | |
1770 | |
1217 | =head1 SEE ALSO |
1771 | =head1 SEE ALSO |
1218 | |
1772 | |
|
|
1773 | @@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1), |
1219 | @@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) |
1774 | @@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) |
1220 | |
|
|
1221 | =head1 BUGS |
|
|
1222 | |
|
|
1223 | Check the BUGS file for an up-to-date list. |
|
|
1224 | |
|
|
1225 | Cursor change support is not yet implemented. |
|
|
1226 | |
|
|
1227 | Click-and-drag doesn't work with X11 mouse report overriding. |
|
|
1228 | |
1775 | |
1229 | =head1 CURRENT PROJECT COORDINATOR |
1776 | =head1 CURRENT PROJECT COORDINATOR |
1230 | |
1777 | |
1231 | =over 4 |
1778 | =over 4 |
1232 | |
1779 | |
1233 | =item Project Coordinator |
1780 | =item Project Coordinator |
1234 | |
1781 | |
1235 | Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1782 | Marc A. Lehmann <rxvt-unicode@schmorp.de>. |
1236 | |
1783 | |
1237 | L<http://software.schmorp.de/#rxvt-unicode> |
1784 | L<http://software.schmorp.de/pkg/rxvt-unicode.html> |
1238 | |
1785 | |
1239 | =back |
1786 | =back |
1240 | |
1787 | |
1241 | =head1 AUTHORS |
1788 | =head1 AUTHORS |
1242 | |
1789 | |
… | |
… | |
1244 | |
1791 | |
1245 | =item John Bovey |
1792 | =item John Bovey |
1246 | |
1793 | |
1247 | University of Kent, 1992, wrote the original Xvt. |
1794 | University of Kent, 1992, wrote the original Xvt. |
1248 | |
1795 | |
1249 | =item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> |
1796 | =item Rob Nation <nation@rocket.sanders.lockheed.com> |
1250 | |
1797 | |
1251 | very heavily modified Xvt and came up with Rxvt |
1798 | very heavily modified Xvt and came up with Rxvt |
1252 | |
1799 | |
1253 | =item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> |
1800 | =item Angelo Haritsis <ah@doc.ic.ac.uk> |
1254 | |
1801 | |
1255 | wrote the Greek Keyboard Input (no longer in code) |
1802 | wrote the Greek Keyboard Input (no longer in code) |
1256 | |
1803 | |
1257 | =item mj olesen L<< <olesen@me.QueensU.CA> >> |
1804 | =item mj olesen <olesen@me.QueensU.CA> |
1258 | |
1805 | |
1259 | Wrote the menu system. |
1806 | Wrote the menu system. |
1260 | |
1807 | |
1261 | Project Coordinator (changes.txt 2.11 to 2.21) |
1808 | Project Coordinator (changes.txt 2.11 to 2.21) |
1262 | |
1809 | |
1263 | =item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> |
1810 | =item Oezguer Kesim <kesim@math.fu-berlin.de> |
1264 | |
1811 | |
1265 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1812 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1266 | |
1813 | |
1267 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1814 | =item Geoff Wing <gcw@pobox.com> |
1268 | |
1815 | |
1269 | Rewrote screen display and text selection routines. Project Coordinator |
1816 | Rewrote screen display and text selection routines. |
|
|
1817 | |
1270 | (changes.txt 2.4.6 - rxvt-unicode) |
1818 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1271 | |
1819 | |
1272 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1820 | =item Marc Alexander Lehmann <rxvt-unicode@schmorp.de> |
1273 | |
1821 | |
1274 | Forked rxvt-unicode, rewrote most of the display code and internal |
1822 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |
1275 | character handling to store text in unicode, improve xterm |
1823 | extension, random hacks, numerous bugfixes and extensions. |
1276 | compatibility and apply numerous other bugfixes and extensions. |
|
|
1277 | |
1824 | |
1278 | Project Coordinator (Changes 1.0 -) |
1825 | Project Coordinator (Changes 1.0 -) |
1279 | |
1826 | |
|
|
1827 | =item Emanuele Giaquinta <emanuele.giaquinta@gmail.com> |
|
|
1828 | |
|
|
1829 | pty/utmp code rewrite, image code improvements, many random hacks and bugfixes. |
|
|
1830 | |
1280 | =back |
1831 | =back |
1281 | |
1832 | |