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