… | |
… | |
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/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 |
… | |
… | |
30 | like mongolian or scripts requiring extremely complex combining rules, |
33 | like mongolian or scripts requiring extremely complex combining rules, |
31 | like tibetan or devanagari. 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 right-to-left 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 user friendly, lean and clean |
43 | me recommend C<mlterm>, which is a very user friendly, lean and clean |
… | |
… | |
89 | |
92 | |
90 | Print out a message describing available options. |
93 | Print out a message describing available options. |
91 | |
94 | |
92 | =item B<-display> I<displayname> |
95 | =item B<-display> I<displayname> |
93 | |
96 | |
94 | Attempt to open a window on the named X display (B<-d> still |
97 | Attempt to open a window on the named X display (the older form B<-d> |
95 | respected). In the absence of this option, the display specified by the |
98 | is still respected. but deprecated). In the absence of this option, the |
96 | B<DISPLAY> environment variable is used. |
99 | display specified by the B<DISPLAY> environment variable is used. |
97 | |
100 | |
98 | =item B<-depth> I<bitdepth> |
101 | =item B<-depth> I<bitdepth> |
99 | |
102 | |
100 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
103 | Compile I<frills>: Attempt to find a visual with the given bit depth; |
101 | resource B<depth>. |
104 | resource B<depth>. |
102 | |
105 | |
|
|
106 | [Please note that many X servers (and libXft) are buggy with |
|
|
107 | respect to C<-depth 32> and/or alpha channels, and will cause all sorts |
|
|
108 | of graphical corruption. This is harmless, but we can't do anything about |
|
|
109 | this, so watch out] |
|
|
110 | |
|
|
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). |
|
|
115 | |
103 | =item B<-geometry> I<geom> |
116 | =item B<-geometry> I<geom> |
104 | |
117 | |
105 | Window geometry (B<-g> still respected); resource B<geometry>. |
118 | Window geometry (B<-g> still respected); resource B<geometry>. |
106 | |
119 | |
107 | =item B<-rv>|B<+rv> |
120 | =item B<-rv>|B<+rv> |
… | |
… | |
113 | Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. |
126 | Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. |
114 | |
127 | |
115 | =item B<-ss>|B<+ss> |
128 | =item B<-ss>|B<+ss> |
116 | |
129 | |
117 | Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. |
130 | Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. |
118 | |
|
|
119 | =item B<-tr>|B<+tr> |
|
|
120 | |
|
|
121 | Turn on/off illusion of a transparent window background; resource B<transparent>. |
|
|
122 | |
|
|
123 | B<-ip> is still accepted as an obsolete alias but will be removed in |
|
|
124 | future versions. |
|
|
125 | |
|
|
126 | I<Please address all transparency related issues to Sasha Vasko at |
|
|
127 | sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> |
|
|
128 | |
131 | |
129 | =item B<-fade> I<number> |
132 | =item B<-fade> I<number> |
130 | |
133 | |
131 | 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 |
132 | 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 |
… | |
… | |
135 | =item B<-fadecolor> I<colour> |
138 | =item B<-fadecolor> I<colour> |
136 | |
139 | |
137 | 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 |
138 | is opaque black. resource B<fadeColor>. |
141 | is opaque black. resource B<fadeColor>. |
139 | |
142 | |
140 | =item B<-tint> I<colour> |
143 | =item B<-icon> I<file> |
141 | |
144 | |
142 | Tint the transparent background pixmap with the given colour when |
145 | Compile I<pixbuf>: Use the specified image as application icon. This |
143 | transparency is enabled with B<-tr>. This only works for |
146 | is used by many window managers, taskbars and pagers to represent the |
144 | non-tiled backgrounds, currently. See also the B<-sh> option that can be |
147 | application window; resource I<iconFile>. |
145 | used to brighten or darken the image in addition to tinting it. |
|
|
146 | Please note that certain tint colours can be applied on the server-side, |
|
|
147 | thus yielding performance gain of two orders of magnitude. These colours are: |
|
|
148 | blue, red, green, cyan, magenta, yellow, and those close to them. Also |
|
|
149 | pure black and pure white colors essentially mean no tinting; resource |
|
|
150 | I<tintColor>. Example: |
|
|
151 | |
|
|
152 | @@RXVT_NAME@@ -tr -tint blue -sh 40 |
|
|
153 | |
|
|
154 | =item B<-sh> I<number> |
|
|
155 | |
|
|
156 | Darken (0 .. 100) or lighten (100 .. 200) the transparent |
|
|
157 | background image in addition to (or instead of) tinting it; |
|
|
158 | resource I<shading>. |
|
|
159 | |
|
|
160 | =item B<-blt> I<string> |
|
|
161 | |
|
|
162 | Specify background blending type. If background pixmap is specified |
|
|
163 | at the same time as transparency - such pixmap will be blended over |
|
|
164 | transparency image, using method specified. Supported values are : |
|
|
165 | B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, |
|
|
166 | B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, |
|
|
167 | B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is |
|
|
168 | alpha-blending. Compile I<afterimage>; resource I<blendType>. |
|
|
169 | |
|
|
170 | =item B<-blr> I<HxV> |
|
|
171 | |
|
|
172 | Apply Gaussian Blur with the specified radii to the transparent |
|
|
173 | background image. If single number is specified - both vertical and |
|
|
174 | horizontal radii are considered to be the same. Setting one of the |
|
|
175 | radii to 1 and another to a large number creates interesting effects |
|
|
176 | on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; |
|
|
177 | resource I<blurRadius>. |
|
|
178 | |
148 | |
179 | =item B<-bg> I<colour> |
149 | =item B<-bg> I<colour> |
180 | |
150 | |
181 | Window background colour; resource B<background>. |
151 | Window background colour; resource B<background>. |
182 | |
152 | |
183 | =item B<-fg> I<colour> |
153 | =item B<-fg> I<colour> |
184 | |
154 | |
185 | Window foreground colour; resource B<foreground>. |
155 | Window foreground colour; resource B<foreground>. |
186 | |
|
|
187 | =item B<-pixmap> I<file[;geom[:op1][:op2][...]]> |
|
|
188 | |
|
|
189 | Compile I<afterimage>: Specify image file for the background and also |
|
|
190 | optionally specify its scaling with a geometry string. Note you may need to |
|
|
191 | add quotes to avoid special shell interpretation of the C<;> in the |
|
|
192 | command-line; for more details see resource B<backgroundPixmap>. |
|
|
193 | |
156 | |
194 | =item B<-cr> I<colour> |
157 | =item B<-cr> I<colour> |
195 | |
158 | |
196 | The cursor colour; resource B<cursorColor>. |
159 | The cursor colour; resource B<cursorColor>. |
197 | |
160 | |
… | |
… | |
242 | italic> >> characters are to be printed. See resource B<boldItalicFont> |
205 | italic> >> characters are to be printed. See resource B<boldItalicFont> |
243 | for details. |
206 | for details. |
244 | |
207 | |
245 | =item B<-is>|B<+is> |
208 | =item B<-is>|B<+is> |
246 | |
209 | |
247 | Compile I<font-styles>: Bold/Italic font styles imply high intensity |
210 | Compile I<font-styles>: Bold/Blink font styles imply high intensity |
248 | foreground/background (default). See resource B<intensityStyles> for |
211 | foreground/background (default). See resource B<intensityStyles> for |
249 | details. |
212 | details. |
250 | |
213 | |
251 | =item B<-name> I<name> |
214 | =item B<-name> I<name> |
252 | |
215 | |
… | |
… | |
256 | |
219 | |
257 | =item B<-ls>|B<+ls> |
220 | =item B<-ls>|B<+ls> |
258 | |
221 | |
259 | Start as a login-shell/sub-shell; resource B<loginShell>. |
222 | Start as a login-shell/sub-shell; resource B<loginShell>. |
260 | |
223 | |
|
|
224 | =item B<-mc> I<milliseconds> |
|
|
225 | |
|
|
226 | Specify the maximum time between multi-click selections. |
|
|
227 | |
261 | =item B<-ut>|B<+ut> |
228 | =item B<-ut>|B<+ut> |
262 | |
229 | |
263 | Compile I<utmp>: Inhibit/enable writing a utmp entry; resource |
230 | Compile I<utmp>: Inhibit/enable writing a utmp entry; resource |
264 | B<utmpInhibit>. |
231 | B<utmpInhibit>. |
265 | |
232 | |
… | |
… | |
269 | B<visualBell>. |
236 | B<visualBell>. |
270 | |
237 | |
271 | =item B<-sb>|B<+sb> |
238 | =item B<-sb>|B<+sb> |
272 | |
239 | |
273 | 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>. |
274 | |
250 | |
275 | =item B<-si>|B<+si> |
251 | =item B<-si>|B<+si> |
276 | |
252 | |
277 | Turn on/off scroll-to-bottom on TTY output inhibit; resource |
253 | Turn on/off scroll-to-bottom on TTY output inhibit; resource |
278 | B<scrollTtyOutput> has opposite effect. |
254 | B<scrollTtyOutput> has opposite effect. |
… | |
… | |
285 | =item B<-sw>|B<+sw> |
261 | =item B<-sw>|B<+sw> |
286 | |
262 | |
287 | 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. |
288 | This only takes effect if B<-si> is also given; resource |
264 | This only takes effect if B<-si> is also given; resource |
289 | B<scrollWithBuffer>. |
265 | B<scrollWithBuffer>. |
290 | |
|
|
291 | =item B<-sr>|B<+sr> |
|
|
292 | |
|
|
293 | Put scrollbar on right/left; resource B<scrollBar_right>. |
|
|
294 | |
|
|
295 | =item B<-st>|B<+st> |
|
|
296 | |
|
|
297 | Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; |
|
|
298 | resource B<scrollBar_floating>. |
|
|
299 | |
266 | |
300 | =item B<-ptab>|B<+ptab> |
267 | =item B<-ptab>|B<+ptab> |
301 | |
268 | |
302 | If enabled (default), "Horizontal Tab" characters are being stored as |
269 | If enabled (default), "Horizontal Tab" characters are being stored as |
303 | 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 |
… | |
… | |
307 | |
274 | |
308 | =item B<-bc>|B<+bc> |
275 | =item B<-bc>|B<+bc> |
309 | |
276 | |
310 | Blink the cursor; resource B<cursorBlink>. |
277 | Blink the cursor; resource B<cursorBlink>. |
311 | |
278 | |
|
|
279 | =item B<-uc>|B<+uc> |
|
|
280 | |
|
|
281 | Make the cursor underlined; resource B<cursorUnderline>. |
|
|
282 | |
312 | =item B<-iconic> |
283 | =item B<-iconic> |
313 | |
284 | |
314 | Start iconified, if the window manager supports that option. |
285 | Start iconified, if the window manager supports that option. |
315 | Alternative form is B<-ic>. |
286 | Alternative form is B<-ic>. |
316 | |
287 | |
… | |
… | |
332 | |
303 | |
333 | =item B<-bl> |
304 | =item B<-bl> |
334 | |
305 | |
335 | 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. |
336 | 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 |
337 | 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. |
338 | |
310 | |
339 | =item B<-override-redirect> |
311 | =item B<-override-redirect> |
340 | |
312 | |
341 | Compile I<frills>: Sets override-redirect on the window; resource |
313 | Compile I<frills>: Sets override-redirect on the window; resource |
342 | B<override-redirect>. |
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. |
343 | |
320 | |
344 | =item B<-sbg> |
321 | =item B<-sbg> |
345 | |
322 | |
346 | 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 |
347 | 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 |
… | |
… | |
351 | =item B<-lsp> I<number> |
328 | =item B<-lsp> I<number> |
352 | |
329 | |
353 | 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 |
354 | the display. Useful to work around font rendering problems; resource |
331 | the display. Useful to work around font rendering problems; resource |
355 | 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>. |
356 | |
340 | |
357 | =item B<-tn> I<termname> |
341 | =item B<-tn> I<termname> |
358 | |
342 | |
359 | 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 |
360 | B<TERM> environment variable. This terminal type must exist in the |
344 | B<TERM> environment variable. This terminal type must exist in the |
… | |
… | |
447 | 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@@ |
448 | will not immediately destroy its window when the program executed within |
432 | will not immediately destroy its window when the program executed within |
449 | 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 |
450 | user; resource B<hold>. |
434 | user; resource B<hold>. |
451 | |
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 | |
452 | =item B<-xrm> I<string> |
442 | =item B<-xrm> I<string> |
453 | |
443 | |
454 | Works like the X Toolkit option of the same name, by adding the I<string> |
444 | Works like the X Toolkit option of the same name, by adding the I<string> |
455 | as if it were specified in a resource file. Resource values specified this |
445 | as if it were specified in a resource file. Resource values specified this |
456 | way take precedence over all other resource specifications. |
446 | way take precedence over all other resource specifications. |
… | |
… | |
503 | 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 |
504 | 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 |
505 | yourself if you want that. |
495 | yourself if you want that. |
506 | |
496 | |
507 | As an extremely special case, specifying C<-1> will completely suppress |
497 | As an extremely special case, specifying C<-1> will completely suppress |
508 | pty/tty operations. |
498 | pty/tty operations, which is probably only useful in conjunction with some |
|
|
499 | perl extension that manages the terminal. |
509 | |
500 | |
510 | 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 |
511 | longer example is in F<doc/pty-fd>): |
502 | longer example is in F<doc/pty-fd>): |
512 | |
503 | |
513 | use IO::Pty; |
504 | use IO::Pty; |
… | |
… | |
527 | 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 |
528 | this terminal instance. See resource B<perl-ext> for details. |
519 | this terminal instance. See resource B<perl-ext> for details. |
529 | |
520 | |
530 | =back |
521 | =back |
531 | |
522 | |
532 | =head1 RESOURCES (available also as long-options) |
523 | =head1 RESOURCES |
533 | |
524 | |
534 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
525 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
535 | options) compiled into your version. |
526 | options) compiled into your version. All resources are also available as |
|
|
527 | long-options. |
536 | |
528 | |
537 | You can set and change the resources using X11 tools like B<xrdb>. Many |
529 | You can set and change the resources using X11 tools like B<xrdb>. Many |
538 | distribution do also load settings from the B<~/.Xresources> file when X |
530 | distribution do also load settings from the B<~/.Xresources> file when X |
539 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
531 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
540 | with later settings overwriting earlier ones: |
532 | with later settings overwriting earlier ones: |
541 | |
533 | |
542 | 1. system-wide app-defaults file, either locale-dependent OR global |
|
|
543 | 2. app-defaults file in $XAPPLRESDIR |
534 | 1. app-defaults file in $XAPPLRESDIR |
|
|
535 | 2. $HOME/.Xdefaults |
544 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
536 | 3. RESOURCE_MANAGER property on root-window of screen 0 |
545 | 4. SCREEN_RESOURCES for the current screen |
537 | 4. SCREEN_RESOURCES property on root-window of the current screen |
546 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
538 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
547 | 6. resources specified via -xrm on the commandline |
539 | 6. resources specified via -xrm on the commandline |
548 | |
540 | |
549 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
541 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
550 | names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
542 | names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
… | |
… | |
562 | =item B<depth:> I<bitdepth> |
554 | =item B<depth:> I<bitdepth> |
563 | |
555 | |
564 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
556 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
565 | option B<-depth>. |
557 | option B<-depth>. |
566 | |
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. |
|
|
565 | |
567 | =item B<geometry:> I<geom> |
566 | =item B<geometry:> I<geom> |
568 | |
567 | |
569 | Create the window with the specified X window geometry [default 80x24]; |
568 | Create the window with the specified X window geometry [default 80x24]; |
570 | option B<-geometry>. |
569 | option B<-geometry>. |
571 | |
570 | |
… | |
… | |
584 | 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 |
585 | corresponds to low-intensity (normal) colours and 8-15 corresponds to |
584 | corresponds to low-intensity (normal) colours and 8-15 corresponds to |
586 | high-intensity (bold = bright foreground, blink = bright background) |
585 | high-intensity (bold = bright foreground, blink = bright background) |
587 | 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, |
588 | 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 |
589 | names used are listed in the B<COLORS AND GRAPHICS> section. |
588 | names used are listed in the B<COLOURS AND GRAPHICS> section. |
590 | |
589 | |
591 | 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 |
592 | changed using an escape command (see @@RXVT_NAME@@(7)). |
591 | changed using an escape command (see @@RXVT_NAME@@(7)). |
593 | |
592 | |
594 | 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 |
… | |
… | |
605 | =item B<colorUL:> I<colour> |
604 | =item B<colorUL:> I<colour> |
606 | |
605 | |
607 | Use the specified colour to display underlined characters when the |
606 | Use the specified colour to display underlined characters when the |
608 | foreground colour is the default. |
607 | foreground colour is the default. |
609 | |
608 | |
610 | =item B<colorRV:> I<colour> |
|
|
611 | |
|
|
612 | Use the specified colour as the background for reverse video characters |
|
|
613 | when OPTION_HC is disabled (--disable-frills). |
|
|
614 | |
|
|
615 | =item B<underlineColor:> I<colour> |
609 | =item B<underlineColor:> I<colour> |
616 | |
610 | |
617 | 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 |
618 | 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. |
619 | |
623 | |
620 | =item B<cursorColor:> I<colour> |
624 | =item B<cursorColor:> I<colour> |
621 | |
625 | |
622 | 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 |
623 | foreground colour; option B<-cr>. |
627 | foreground colour; option B<-cr>. |
… | |
… | |
630 | |
634 | |
631 | =item B<reverseVideo:> I<boolean> |
635 | =item B<reverseVideo:> I<boolean> |
632 | |
636 | |
633 | B<True>: simulate reverse video by foreground and background colours; |
637 | B<True>: simulate reverse video by foreground and background colours; |
634 | option B<-rv>. B<False>: regular screen colours [default]; option |
638 | option B<-rv>. B<False>: regular screen colours [default]; option |
635 | B<+rv>. See note in B<COLORS AND GRAPHICS> section. |
639 | B<+rv>. See note in B<COLOURS AND GRAPHICS> section. |
636 | |
640 | |
637 | =item B<jumpScroll:> I<boolean> |
641 | =item B<jumpScroll:> I<boolean> |
638 | |
642 | |
639 | B<True>: specify that jump scrolling should be used. When receiving lots |
643 | B<True>: specify that jump scrolling should be used. When receiving lots |
640 | of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines |
644 | of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines |
… | |
… | |
654 | |
658 | |
655 | B<False>: specify that everything is to be displayed, even |
659 | B<False>: specify that everything is to be displayed, even |
656 | if the refresh is too fast for the human eye to read anything (or the |
660 | if the refresh is too fast for the human eye to read anything (or the |
657 | monitor to display anything); option B<+ss>. |
661 | monitor to display anything); option B<+ss>. |
658 | |
662 | |
659 | =item B<transparent:> I<boolean> |
|
|
660 | |
|
|
661 | Turn on/off illusion of a transparent window background. |
|
|
662 | |
|
|
663 | B<inheritPixmap> is still accepted as an obsolete alias but will be removed in |
|
|
664 | future versions. |
|
|
665 | |
|
|
666 | I<Please address all transparency related issues to Sasha Vasko at |
|
|
667 | sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> |
|
|
668 | |
|
|
669 | =item B<fading:> I<number> |
663 | =item B<fading:> I<number> |
670 | |
664 | |
671 | 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>. |
672 | |
666 | |
673 | =item B<fadeColor:> I<colour> |
667 | =item B<fadeColor:> I<colour> |
674 | |
668 | |
675 | 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 |
676 | colour is black; option B<-fadecolor>. |
670 | colour is black; option B<-fadecolor>. |
677 | |
671 | |
678 | =item B<tintColor:> I<colour> |
672 | =item B<iconFile:> I<file> |
679 | |
673 | |
680 | Tint the transparent background pixmap with the given colour; option |
674 | Set the application icon pixmap; option B<-icon>. |
681 | B<-tint>. |
|
|
682 | |
|
|
683 | =item B<shading:> I<number> |
|
|
684 | |
|
|
685 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image |
|
|
686 | in addition to tinting it; option B<-sh>. |
|
|
687 | |
|
|
688 | =item B<blendType:> I<string> |
|
|
689 | |
|
|
690 | Specify background blending type; option B<-blt>. |
|
|
691 | |
|
|
692 | =item B<blurRadius:> I<number> |
|
|
693 | |
|
|
694 | Apply Gaussian Blurr with the specified radius to the transparent |
|
|
695 | background image; option B<-blr>. |
|
|
696 | |
675 | |
697 | =item B<scrollColor:> I<colour> |
676 | =item B<scrollColor:> I<colour> |
698 | |
677 | |
699 | Use the specified colour for the scrollbar [default #B2B2B2]. |
678 | Use the specified colour for the scrollbar [default #B2B2B2]. |
700 | |
679 | |
… | |
… | |
705 | |
684 | |
706 | =item B<borderColor:> I<colour> |
685 | =item B<borderColor:> I<colour> |
707 | |
686 | |
708 | 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 |
709 | and the text. |
688 | and the text. |
710 | |
|
|
711 | =item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> |
|
|
712 | |
|
|
713 | Use the specified image file for the background and also |
|
|
714 | optionally specify its scaling with a geometry string B<WxH+X+Y>, |
|
|
715 | (default C<0x0+50+50>) in which B<"W" / "H"> specify the |
|
|
716 | horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image |
|
|
717 | centre (percent). A scale of 0 displays the image with tiling. A scale |
|
|
718 | of 1 displays the image without any scaling. A scale of 2 to 9 specifies |
|
|
719 | an integer number of images in that direction. No image will be magnified |
|
|
720 | beyond 10 times its original size. The maximum permitted scale is 1000. |
|
|
721 | Additional operations can be specified after colon B<:op1:op2...>. |
|
|
722 | Supported operations are: |
|
|
723 | |
|
|
724 | tile force background image to be tiled and not scaled. Equivalent to 0x0, |
|
|
725 | propscale will scale image keeping proportions, |
|
|
726 | auto will scale image to match window size. Equivalent to 100x100; |
|
|
727 | hscale will scale image horizontally to the window size; |
|
|
728 | vscale will scale image vertically to the window size; |
|
|
729 | scale will scale image to match window size; |
|
|
730 | root will tile image as if it was a root window background, auto-adjusting |
|
|
731 | whenever terminal window moves. |
|
|
732 | |
|
|
733 | If used in conjunction with B<-tr> option, the specified pixmap will be |
|
|
734 | blended over transparency image using either alpha-blending, or any |
|
|
735 | other blending type, specified with B<-blt "type"> option. |
|
|
736 | |
|
|
737 | =item B<path:> I<path> |
|
|
738 | |
|
|
739 | Specify the colon-delimited search path for finding background image files. |
|
|
740 | |
689 | |
741 | =item B<font:> I<fontlist> |
690 | =item B<font:> I<fontlist> |
742 | |
691 | |
743 | Select the fonts to be used. This is a comma separated list of font names |
692 | Select the fonts to be used. This is a comma separated list of font names |
744 | that are checked in order when trying to find glyphs for characters. The |
693 | that are checked in order when trying to find glyphs for characters. The |
… | |
… | |
767 | 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 |
768 | wide and 15 pixels high. |
717 | wide and 15 pixels high. |
769 | |
718 | |
770 | 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 |
771 | 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 |
772 | 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 |
773 | useful supplement. |
722 | useful supplement. |
774 | |
723 | |
775 | 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 |
776 | 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 |
777 | contains other characters, but we are not interested in them. |
726 | contains other characters, but we are not interested in them. |
… | |
… | |
801 | text font will being used for the given style. |
750 | text font will being used for the given style. |
802 | |
751 | |
803 | =item B<intensityStyles:> I<boolean> |
752 | =item B<intensityStyles:> I<boolean> |
804 | |
753 | |
805 | 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>, |
806 | option B<-is>, the default), bold and italic font styles imply high |
755 | option B<-is>, the default), bold/blink font styles imply high |
807 | intensity foreground/background colours. Disabling this option (B<False>, |
756 | intensity foreground/background colours. Disabling this option (B<False>, |
808 | 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 |
809 | reachable. |
758 | reachable. |
810 | |
759 | |
811 | =item B<selectstyle:> I<mode> |
|
|
812 | |
|
|
813 | Set mouse selection style to B<old> which is 2.20, B<oldword> which |
|
|
814 | is xterm style with 2.20 old word selection, or anything else which |
|
|
815 | gives xterm style selection. Only effective when the original (non-perl) |
|
|
816 | selection code is in use. |
|
|
817 | |
|
|
818 | =item B<scrollstyle:> I<mode> |
|
|
819 | |
|
|
820 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
|
|
821 | the author's favourite. |
|
|
822 | |
|
|
823 | =item B<title:> I<string> |
760 | =item B<title:> I<string> |
824 | |
761 | |
825 | Set window title string, the default title is the command-line |
762 | Set window title string, the default title is the command-line |
826 | specified after the B<-e> option, if any, otherwise the application |
763 | specified after the B<-e> option, if any, otherwise the application |
827 | name; option B<-title>. |
764 | name; option B<-title>. |
… | |
… | |
840 | =item B<urgentOnBell:> I<boolean> |
777 | =item B<urgentOnBell:> I<boolean> |
841 | |
778 | |
842 | B<True>: set the urgency hint for the wm on receipt of a bell character. |
779 | B<True>: set the urgency hint for the wm on receipt of a bell character. |
843 | B<False>: do not set the urgency hint [default]. |
780 | B<False>: do not set the urgency hint [default]. |
844 | |
781 | |
|
|
782 | @@RXVT_NAME@@ resets the urgency hint on every focus change. |
|
|
783 | |
845 | =item B<visualBell:> I<boolean> |
784 | =item B<visualBell:> I<boolean> |
846 | |
785 | |
847 | 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>. |
848 | B<False>: no visual bell [default]; option B<+vb>. |
787 | B<False>: no visual bell [default]; option B<+vb>. |
849 | |
788 | |
… | |
… | |
851 | |
790 | |
852 | 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 |
853 | 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 |
854 | [default]; option B<+ls>. |
793 | [default]; option B<+ls>. |
855 | |
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 | |
856 | =item B<utmpInhibit:> I<boolean> |
800 | =item B<utmpInhibit:> I<boolean> |
857 | |
801 | |
858 | 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>; |
859 | 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> |
860 | [default]; option B<+ut>. |
804 | [default]; option B<+ut>. |
… | |
… | |
872 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
816 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
873 | |
817 | |
874 | 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 |
875 | every time you hit C<Print>. |
819 | every time you hit C<Print>. |
876 | |
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. |
|
|
829 | |
877 | =item B<scrollBar:> I<boolean> |
830 | =item B<scrollBar:> I<boolean> |
878 | |
831 | |
879 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
832 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
880 | disable the scrollbar; option B<+sb>. |
833 | disable the scrollbar; option B<+sb>. |
881 | |
834 | |
… | |
… | |
900 | 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 |
901 | B<+si>. |
854 | B<+si>. |
902 | |
855 | |
903 | =item B<scrollWithBuffer:> I<boolean> |
856 | =item B<scrollWithBuffer:> I<boolean> |
904 | |
857 | |
905 | 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. |
906 | 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 |
907 | with scrollback buffer when tty receives 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>. |
908 | |
862 | |
909 | =item B<scrollTtyKeypress:> I<boolean> |
863 | =item B<scrollTtyKeypress:> I<boolean> |
910 | |
864 | |
911 | 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 |
912 | 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 |
… | |
… | |
968 | =item B<cursorBlink:> I<boolean> |
922 | =item B<cursorBlink:> I<boolean> |
969 | |
923 | |
970 | 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]; |
971 | option B<-bc>. |
925 | option B<-bc>. |
972 | |
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>. |
|
|
931 | |
973 | =item B<pointerBlank:> I<boolean> |
932 | =item B<pointerBlank:> I<boolean> |
974 | |
933 | |
975 | 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 |
976 | of seconds of inactivity. B<False>: the pointer is always visible |
935 | of seconds of inactivity. B<False>: the pointer is always visible |
977 | [default]. |
936 | [default]. |
… | |
… | |
990 | large number (e.g. C<987654321>) to effectively disable the timeout. |
949 | large number (e.g. C<987654321>) to effectively disable the timeout. |
991 | |
950 | |
992 | =item B<backspacekey:> I<string> |
951 | =item B<backspacekey:> I<string> |
993 | |
952 | |
994 | 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> |
995 | 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> |
996 | (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 |
997 | escape sequence. |
956 | escape sequence. |
998 | |
957 | |
999 | =item B<deletekey:> I<string> |
958 | =item B<deletekey:> I<string> |
1000 | |
959 | |
… | |
… | |
1079 | |
1038 | |
1080 | =item B<secondaryScroll:> I<boolean> |
1039 | =item B<secondaryScroll:> I<boolean> |
1081 | |
1040 | |
1082 | Turn on/off secondary screen scroll (default enabled). If this |
1041 | Turn on/off secondary screen scroll (default enabled). If this |
1083 | option is enabled, scrolls on the secondary screen will change the |
1042 | option is enabled, scrolls on the secondary screen will change the |
1084 | scrollback buffer and switching to/from the secondary screen will |
1043 | scrollback buffer and, when secondaryScreen is off, switching |
1085 | instead scroll the screen up. |
1044 | to/from the secondary screen will instead scroll the screen up. |
1086 | |
1045 | |
1087 | =item B<hold>: I<boolean> |
1046 | =item B<hold>: I<boolean> |
1088 | |
1047 | |
1089 | 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@@ |
1090 | will not immediately destroy its window when the program executed within |
1049 | will not immediately destroy its window when the program executed within |
1091 | 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 |
1092 | user. |
1051 | user. |
1093 | |
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 | |
1094 | =item B<keysym.>I<sym>: I<string> |
1060 | =item B<keysym.>I<sym>: I<action> |
1095 | |
1061 | |
1096 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
1062 | Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening |
1097 | intervening resource name B<keysym.> cannot be omitted. |
1063 | resource name B<keysym.> cannot be omitted. |
1098 | |
1064 | |
1099 | 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 |
1100 | any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, |
1066 | C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different |
1101 | 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 |
1102 | 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 |
1103 | 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>. |
1104 | |
1079 | |
1105 | 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 |
1106 | 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 |
1107 | 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 |
1108 | current application keymap mode state. |
1083 | current application keymap mode state. |
1109 | |
1084 | |
1110 | 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 |
1111 | 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 |
1112 | 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 |
1113 | keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not |
1097 | value (B<0x0000 - 0xFFFF>). |
1114 | performed in an exact manner; however, the closest match is assured. |
|
|
1115 | |
1098 | |
1116 | I<string> may contain escape values (C<\n>: newline, C<\000>: octal |
1099 | As with any resource value, the I<action> string may contain backslash |
|
|
1100 | escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal |
1117 | number), see RESOURCES in C<man 7 X> for futher details. |
1101 | number), see RESOURCES in C<man 7 X> for further details. |
1118 | |
1102 | |
1119 | You can define a range of keysyms in one shot by providing a I<string> |
1103 | An action starts with an action prefix that selects a certain type |
1120 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' |
1104 | of action, followed by a colon. An action string without colons is |
1121 | should be a character not used by the strings. |
1105 | interpreted as a literal string to pass to the tty (as if it was |
|
|
1106 | prefixed with C<string:>). |
1122 | |
1107 | |
1123 | Its usage can be demonstrated by an example: |
1108 | The following action prefixes are known - extensions can provide |
|
|
1109 | additional prefixes: |
1124 | |
1110 | |
1125 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
1111 | =over 4 |
1126 | |
1112 | |
1127 | The above line is equivalent to the following three lines: |
1113 | =item string:STRING |
1128 | |
1114 | |
1129 | URxvt.keysym.Meta-Control-0x61: \033<M-C-a> |
1115 | If the I<action> starts with C<string:> (or otherwise contains no colons), |
1130 | URxvt.keysym.Meta-Control-0x62: \033<M-C-b> |
1116 | then the remaining C<STRING> will be passed to the program running in the |
1131 | URxvt.keysym.Meta-Control-0x63: \033<M-C-c> |
1117 | terminal. For example, you could replace whatever Shift-Tab outputs by the |
|
|
1118 | string C<echo rm -rf /> followed by a newline: |
1132 | |
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 | =item command:STRING |
|
|
1125 | |
1133 | If I<string> takes the form of C<command:STRING>, the specified B<STRING> |
1126 | If I<action> takes the form of C<command:STRING>, the specified B<STRING> |
1134 | is interpreted and executed as @@RXVT_NAME@@'s control sequence. For |
1127 | is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically |
|
|
1128 | the opposite of C<string:> - instead of sending it to the program running |
|
|
1129 | in the terminal, it will be treated as if it were program output). This is |
|
|
1130 | most useful to feed command sequences into @@RXVT_NAME@@. |
|
|
1131 | |
1135 | example the following means "change the current locale to C<zh_CN.GBK> |
1132 | For example the following means "change the current locale to C<zh_CN.GBK> |
1136 | when Control-Meta-c is being pressed": |
1133 | when Control-Meta-c is being pressed": |
1137 | |
1134 | |
1138 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1135 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1139 | |
1136 | |
1140 | If I<string> takes the form C<perl:STRING>, then the specified B<STRING> |
1137 | The following example will map Control-Meta-1 and Control-Meta-2 to |
1141 | is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) |
1138 | the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited |
1142 | manpage. For example, the F<selection> extension (activated via |
1139 | font-switching at runtime: |
1143 | C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: |
|
|
1144 | |
1140 | |
1145 | URxvt.keysym.M-C-c: perl:selection:rot13 |
1141 | URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 |
|
|
1142 | URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 |
1146 | |
1143 | |
1147 | Due the the large number of modifier combinations, a defined key mapping |
1144 | Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more |
1148 | will match if at I<at least> the specified identifiers are being set, and |
1145 | info): |
1149 | no other key mappings with those and more bits are being defined. That |
|
|
1150 | means that defining a key map for C<a> will automatically provide |
|
|
1151 | definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined |
|
|
1152 | mappings themselves. |
|
|
1153 | |
1146 | |
1154 | Unfortunately, this will override built-in key mappings. For example |
1147 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
|
|
1148 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
|
|
1149 | |
|
|
1150 | =item builtin: |
|
|
1151 | |
|
|
1152 | The builtin action is the action that @@RXVT_NAME@@ would execute if no |
|
|
1153 | key binding existed for the key combination. The obvious use is to undo |
|
|
1154 | the effect of existing bindings. The not so obvious use is to reinstate |
|
|
1155 | bindings when another binding overrides too many modifiers. |
|
|
1156 | |
1155 | if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s |
1157 | For example if you overwrite the C<Insert> key you will disable |
1156 | C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the |
1158 | @@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke |
1157 | user-defined keymap using the C<builtin:> replacement: |
1159 | "holes" into the user-defined keymap using the C<builtin:> replacement: |
1158 | |
1160 | |
1159 | URxvt.keysym.Insert: <my insert key sequence> |
1161 | URxvt.keysym.Insert: <my insert key sequence> |
1160 | URxvt.keysym.S-Insert: builtin: |
1162 | URxvt.keysym.S-Insert: builtin: |
1161 | |
1163 | |
1162 | The first line defines a mapping for C<Insert> and I<any> combination |
1164 | The first line defines a mapping for C<Insert> and I<any> combination |
1163 | of modifiers. The second line re-establishes the default mapping for |
1165 | of modifiers. The second line re-establishes the default mapping for |
1164 | C<Shift-Insert>. |
1166 | C<Shift-Insert>. |
1165 | |
1167 | |
1166 | The following example will map Control-Meta-1 and Control-Meta-2 to |
1168 | =item builtin-string: |
1167 | the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited |
|
|
1168 | font-switching at runtime: |
|
|
1169 | |
1169 | |
1170 | URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 |
1170 | This action is mainly useful to restore string mappings for keys that |
1171 | URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 |
1171 | have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit |
|
|
1172 | difficult to explain - basically, this action will send the string to the |
|
|
1173 | application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in |
|
|
1174 | action for it. |
1172 | |
1175 | |
1173 | Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more |
1176 | An example might make it clearer: @@RXVT_NAME@@ normally pastes the |
1174 | info): |
1177 | selection when you press C<Shift-Insert>. With the following bindings, it |
|
|
1178 | would instead emit the (undocumented, but what applications running in the |
|
|
1179 | terminal might expect) sequence C<ESC [ 2 $> instead: |
1175 | |
1180 | |
1176 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
1181 | URxvt.keysym.S-Insert: builtin-string: |
1177 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
1182 | URxvt.keysym.C-S-Insert: builtin: |
|
|
1183 | |
|
|
1184 | The first line disables the paste functionality for that key |
|
|
1185 | combination, and the second reinstates the default behaviour for |
|
|
1186 | C<Control-Shift-Insert>, which would otherwise be overridden. |
|
|
1187 | |
|
|
1188 | Similarly, to let applications gain access to the C<C-M-c> (copy to |
|
|
1189 | clipboard) and C<C-M-v> (paste clipboard) key combination, you can do |
|
|
1190 | this: |
|
|
1191 | |
|
|
1192 | URxvt.keysym.C-M-c: builtin-string: |
|
|
1193 | URxvt.keysym.C-M-v: builtin-string: |
|
|
1194 | |
|
|
1195 | =item EXTENSION:STRING |
|
|
1196 | |
|
|
1197 | An action of this form invokes the action B<STRING>, if any, provided |
|
|
1198 | by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will |
|
|
1199 | be loaded automatically if necessary. |
|
|
1200 | |
|
|
1201 | Not all extensions define actions, but popular extensions that do |
|
|
1202 | include the I<selection> and I<matcher> extensions (documented in their |
|
|
1203 | own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1), |
|
|
1204 | respectively). |
|
|
1205 | |
|
|
1206 | From the silly examples department, this will rot13-"encrypt" |
|
|
1207 | @@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC |
|
|
1208 | keyboards: |
|
|
1209 | |
|
|
1210 | URxvt.keysym.M-C-c: selection:rot13 |
|
|
1211 | |
|
|
1212 | =item perl:STRING *DEPRECATED* |
|
|
1213 | |
|
|
1214 | This is a deprecated way of invoking commands provided by perl |
|
|
1215 | extensions. It is still supported, but should not be used anymore. |
|
|
1216 | |
|
|
1217 | =back |
1178 | |
1218 | |
1179 | =item B<perl-ext-common>: I<string> |
1219 | =item B<perl-ext-common>: I<string> |
1180 | |
1220 | |
1181 | =item B<perl-ext>: I<string> |
1221 | =item B<perl-ext>: I<string> |
1182 | |
1222 | |
… | |
… | |
1184 | use in this terminal instance; option B<-pe>. |
1224 | use in this terminal instance; option B<-pe>. |
1185 | |
1225 | |
1186 | Extension names can be prefixed with a C<-> sign to prohibit using |
1226 | Extension names can be prefixed with a C<-> sign to prohibit using |
1187 | them. This can be useful to selectively disable some extensions loaded |
1227 | them. This can be useful to selectively disable some extensions loaded |
1188 | by default, or specified via the C<perl-ext-common> resource. For |
1228 | by default, or specified via the C<perl-ext-common> resource. For |
1189 | example, C<default,-selection> will use all the default extension except |
1229 | example, C<default,-selection> will use all the default extensions except |
1190 | C<selection>. |
1230 | C<selection>. |
1191 | |
1231 | |
1192 | Extension names can also be followed by an argument in angle brackets |
1232 | The default set includes the C<selection>, C<option-popup>, |
1193 | (e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for |
1233 | C<selection-popup> and C<readline> extensions, any extensions that |
1194 | searchable scrollback to Alt/Meta-s). Mentioning the same extension |
1234 | define keybindings via C<BINDING> meta comments, and extensions which |
1195 | multiple times with different arguments will pass multiple arguments to |
1235 | are mentioned in B<keysym> resources. |
1196 | the extension. |
1236 | |
|
|
1237 | Any extension such that a corresponding resource is given on the |
|
|
1238 | command line is automatically appended to B<perl-ext>. |
1197 | |
1239 | |
1198 | Each extension is looked up in the library directories, loaded if |
1240 | Each extension is looked up in the library directories, loaded if |
1199 | necessary, and bound to the current terminal instance. |
1241 | necessary, and bound to the current terminal instance. When the library |
|
|
1242 | search path contains multiple extension files of the same name, then the |
|
|
1243 | first one found will be used. |
1200 | |
1244 | |
1201 | If both of these resources are the empty string, then the perl |
1245 | If both of these resources are the empty string, then the perl interpreter |
1202 | interpreter will not be initialized. The idea behind two options is that |
1246 | will not be initialized. The rationale for having two options is that |
1203 | B<perl-ext-common> will be used for extensions that should be available to |
1247 | B<perl-ext-common> will be used for extensions that should be available to |
1204 | all instances, while B<perl-ext> is used for specific instances. |
1248 | all instances, while B<perl-ext> is used for specific instances. |
1205 | |
1249 | |
1206 | =item B<perl-eval>: I<string> |
1250 | =item B<perl-eval>: I<string> |
1207 | |
1251 | |
1208 | Perl code to be evaluated when all extensions have been registered. See |
1252 | Perl code to be evaluated when all extensions have been registered. See |
1209 | the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource |
1253 | the @@RXVT_NAME@@perl(3) manpage. |
1210 | will be ignored when running setuid/setgid. |
|
|
1211 | |
1254 | |
1212 | =item B<perl-lib>: I<path> |
1255 | =item B<perl-lib>: I<path> |
1213 | |
1256 | |
1214 | Colon-separated list of additional directories that hold extension |
1257 | Colon-separated list of additional directories that hold extension |
1215 | scripts. When looking for extensions specified by the C<perl> resource, |
1258 | scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look |
1216 | @@RXVT_NAME@@ will first look in these directories and then in |
1259 | in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and |
1217 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource |
1260 | lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
1218 | will be ignored when running setuid/setgid. |
|
|
1219 | |
1261 | |
1220 | See the @@RXVT_NAME@@perl(3) manpage. |
1262 | See the @@RXVT_NAME@@perl(3) manpage. |
1221 | |
1263 | |
1222 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1264 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1223 | |
1265 | |
… | |
… | |
1227 | =item B<< selection-autotransform.I<idx> >>: I<perl-transform> |
1269 | =item B<< selection-autotransform.I<idx> >>: I<perl-transform> |
1228 | |
1270 | |
1229 | Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage |
1271 | Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage |
1230 | for details. |
1272 | for details. |
1231 | |
1273 | |
1232 | =item B<searchable-scrollback:> I<keysym> |
1274 | =item B<searchable-scrollback:> I<keysym> *DEPRECATED* |
1233 | |
1275 | |
1234 | Sets the hotkey that starts the incremental scrollback buffer search |
1276 | This resource is deprecated and will be removed. Use a B<keysym> resource |
1235 | (default: C<M-s>). |
1277 | instead, e.g.: |
1236 | |
1278 | |
|
|
1279 | URxvt.keysym.M-s: searchable-scrollback:start |
|
|
1280 | |
1237 | =item B<urlLauncher>: I<string> |
1281 | =item B<url-launcher>: I<string> |
1238 | |
1282 | |
1239 | Specifies the program to be started with a URL argument. Used by the |
1283 | Specifies the program to be started with a URL argument. Used by the |
1240 | C<selection-popup> and C<matcher> perl extensions. |
1284 | C<selection-popup> and C<matcher> perl extensions. |
1241 | |
1285 | |
1242 | =item B<transient-for>: I<windowid> |
1286 | =item B<transient-for>: I<windowid> |
… | |
… | |
1246 | =item B<override-redirect>: I<boolean> |
1290 | =item B<override-redirect>: I<boolean> |
1247 | |
1291 | |
1248 | Compile I<frills>: Sets override-redirect for the terminal window, making |
1292 | Compile I<frills>: Sets override-redirect for the terminal window, making |
1249 | it almost invisible to window managers; option B<-override-redirect>. |
1293 | it almost invisible to window managers; option B<-override-redirect>. |
1250 | |
1294 | |
|
|
1295 | =item B<iso14755:> I<boolean> |
|
|
1296 | |
|
|
1297 | Turn on/off ISO 14755 (default enabled). |
|
|
1298 | |
1251 | =item B<iso14755_52:> I<boolean> |
1299 | =item B<iso14755_52:> I<boolean> |
1252 | |
1300 | |
1253 | Turn on/off ISO 14755 5.2 mode (default enabled). |
1301 | Turn on/off ISO 14755 5.2 mode (default enabled). |
|
|
1302 | |
|
|
1303 | =back |
|
|
1304 | |
|
|
1305 | =head1 BACKGROUND IMAGE OPTIONS AND RESOURCES |
|
|
1306 | |
|
|
1307 | =over 4 |
|
|
1308 | |
|
|
1309 | =item B<-pixmap> I<file[;oplist]> |
|
|
1310 | |
|
|
1311 | =item B<backgroundPixmap:> I<file[;oplist]> |
|
|
1312 | |
|
|
1313 | Compile I<pixbuf>: Use the specified image file as the window's |
|
|
1314 | background and also optionally specify a colon separated list of |
|
|
1315 | operations to modify it. Note that you may need to quote the C<;> |
|
|
1316 | character when using the command line option, as C<;> is usually a |
|
|
1317 | metacharacter in shells. Supported operations are: |
|
|
1318 | |
|
|
1319 | =over 4 |
|
|
1320 | |
|
|
1321 | =item B<WxH+X+Y> |
|
|
1322 | |
|
|
1323 | sets scale and position. B<"W" / "H"> specify the horizontal/vertical |
|
|
1324 | scale (percent), and B<"X" / "Y"> locate the image centre (percent). A |
|
|
1325 | scale of 0 disables scaling. |
|
|
1326 | |
|
|
1327 | =item B<op=tile> |
|
|
1328 | |
|
|
1329 | enables tiling |
|
|
1330 | |
|
|
1331 | =item B<op=keep-aspect> |
|
|
1332 | |
|
|
1333 | maintain the image aspect ratio when scaling |
|
|
1334 | |
|
|
1335 | =item B<op=root-align> |
|
|
1336 | |
|
|
1337 | use the position of the terminal window relative to the root window as |
|
|
1338 | the image offset, simulating a root window background |
|
|
1339 | |
|
|
1340 | =back |
|
|
1341 | |
|
|
1342 | The default scale and position setting is C<100x100+50+50>. |
|
|
1343 | Alternatively, a predefined set of templates can be used to achieve |
|
|
1344 | the most common setups: |
|
|
1345 | |
|
|
1346 | =over 4 |
|
|
1347 | |
|
|
1348 | =item B<style=tiled> |
|
|
1349 | |
|
|
1350 | the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile |
|
|
1351 | |
|
|
1352 | =item B<style=aspect-stretched> |
|
|
1353 | |
|
|
1354 | the image is scaled to fill the whole window maintaining the aspect |
|
|
1355 | ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect |
|
|
1356 | |
|
|
1357 | =item B<style=stretched> |
|
|
1358 | |
|
|
1359 | the image is scaled to fill the whole window. Equivalent to 100x100 |
|
|
1360 | |
|
|
1361 | =item B<style=centered> |
|
|
1362 | |
|
|
1363 | the image is centered with no scaling. Equivalent to 0x0+50+50 |
|
|
1364 | |
|
|
1365 | =item B<style=root-tiled> |
|
|
1366 | |
|
|
1367 | the image is tiled with no scaling and using 'root' positioning. |
|
|
1368 | Equivalent to 0x0:op=tile:op=root-align |
|
|
1369 | |
|
|
1370 | =back |
|
|
1371 | |
|
|
1372 | If multiple templates are specified the last one wins. Note that a |
|
|
1373 | template overrides all the scale, position and operations settings. |
|
|
1374 | |
|
|
1375 | If used in conjunction with pseudo-transparency, the specified pixmap |
|
|
1376 | will be blended over the transparent background using alpha-blending. |
|
|
1377 | |
|
|
1378 | =item B<-tr>|B<+tr> |
|
|
1379 | |
|
|
1380 | =item B<transparent:> I<boolean> |
|
|
1381 | |
|
|
1382 | Turn on/off pseudo-transparency by using the root pixmap as background. |
|
|
1383 | |
|
|
1384 | B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but |
|
|
1385 | will be removed in future versions. |
|
|
1386 | |
|
|
1387 | =item B<-tint> I<colour> |
|
|
1388 | |
|
|
1389 | =item B<tintColor:> I<colour> |
|
|
1390 | |
|
|
1391 | Tint the transparent background with the given colour. Note that a |
|
|
1392 | black tint yields a completely black image while a white tint yields |
|
|
1393 | the image unchanged. |
|
|
1394 | |
|
|
1395 | =item B<-sh> I<number> |
|
|
1396 | |
|
|
1397 | =item B<shading:> I<number> |
|
|
1398 | |
|
|
1399 | Darken (0 .. 99) or lighten (101 .. 200) the transparent background. |
|
|
1400 | A value of 100 means no shading. |
|
|
1401 | |
|
|
1402 | =item B<-blr> I<HxV> |
|
|
1403 | |
|
|
1404 | =item B<blurRadius:> I<HxV> |
|
|
1405 | |
|
|
1406 | Apply gaussian blur with the specified radius to the transparent |
|
|
1407 | background. If a single number is specified, the vertical and |
|
|
1408 | horizontal radii are considered to be the same. Setting one of the |
|
|
1409 | radii to 1 and the other to a large number creates interesting effects |
|
|
1410 | on some backgrounds. The maximum radius value is 128. An horizontal or |
|
|
1411 | vertical radius of 0 disables blurring. |
|
|
1412 | |
|
|
1413 | =item B<path:> I<path> |
|
|
1414 | |
|
|
1415 | Specify the colon-delimited search path for finding background image files. |
1254 | |
1416 | |
1255 | =back |
1417 | =back |
1256 | |
1418 | |
1257 | =head1 THE SCROLLBAR |
1419 | =head1 THE SCROLLBAR |
1258 | |
1420 | |
… | |
… | |
1306 | window causes the value of the PRIMARY selection (or CLIPBOARD with the |
1468 | window causes the value of the PRIMARY selection (or CLIPBOARD with the |
1307 | B<Meta> modifier) to be inserted as if it had been typed on the keyboard. |
1469 | B<Meta> modifier) to be inserted as if it had been typed on the keyboard. |
1308 | |
1470 | |
1309 | Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be |
1471 | Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be |
1310 | inserted too. |
1472 | inserted too. |
|
|
1473 | |
|
|
1474 | rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and |
|
|
1475 | <Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first |
|
|
1476 | binding causes the value of the internal selection to be copied to the |
|
|
1477 | CLIPBOARD selection, while the second binding causes the value of the |
|
|
1478 | CLIPBOARD selection to be inserted. |
1311 | |
1479 | |
1312 | =back |
1480 | =back |
1313 | |
1481 | |
1314 | =head1 CHANGING FONTS |
1482 | =head1 CHANGING FONTS |
1315 | |
1483 | |
… | |
… | |
1397 | B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that |
1565 | B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that |
1398 | it can be seen via the I<who(1)> command, and can accept messages. To |
1566 | it can be seen via the I<who(1)> command, and can accept messages. To |
1399 | allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root |
1567 | allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root |
1400 | on some systems or setgid to root or to some other group on others. |
1568 | on some systems or setgid to root or to some other group on others. |
1401 | |
1569 | |
1402 | =head1 COLORS AND GRAPHICS |
1570 | =head1 COLOURS AND GRAPHICS |
1403 | |
1571 | |
1404 | In addition to the default foreground and background colours, |
1572 | In addition to the default foreground and background colours, |
1405 | B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus |
1573 | B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus |
1406 | high-intensity bold/blink versions of the same). Here is a list of the |
1574 | high-intensity (potentially bold/blink) versions of the same, and 72 (or |
1407 | colours with their names. |
1575 | 240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB |
|
|
1576 | cube plus a 8 (24) colour greyscale ramp. |
|
|
1577 | |
|
|
1578 | Here is a list of the ANSI colours with their names. |
1408 | |
1579 | |
1409 | =begin table |
1580 | =begin table |
1410 | |
1581 | |
1411 | B<color0> (black) = Black |
1582 | B<color0> (black) = Black |
1412 | B<color1> (red) = Red3 |
1583 | B<color1> (red) = Red3 |
… | |
… | |
1432 | It is also possible to specify the colour values of B<foreground>, |
1603 | It is also possible to specify the colour values of B<foreground>, |
1433 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1604 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1434 | a number 0-15, as a convenient shorthand to reference the colour name of |
1605 | a number 0-15, as a convenient shorthand to reference the colour name of |
1435 | color0-color15. |
1606 | color0-color15. |
1436 | |
1607 | |
1437 | In addition to the colours defined above, @@RXVT_NAME@@ offers an |
1608 | The following text gives values for the standard 88 colour mode (and |
1438 | additional 72 colours. The first 64 of those (with indices 16 to 79) |
1609 | values for the 256 colour mode in parentheses). |
1439 | consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b + |
|
|
1440 | 16>), followed by 8 additional shades of gray (with indices 80 to 87). |
|
|
1441 | |
1610 | |
|
|
1611 | The RGB cube uses indices 16..79 (16..231) using the following formulas: |
|
|
1612 | |
|
|
1613 | index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3 |
|
|
1614 | index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5 |
|
|
1615 | |
|
|
1616 | The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10% |
|
|
1617 | steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of |
|
|
1618 | the RGB cube. |
|
|
1619 | |
1442 | Together, all those colours implement the 88 colour xterm colours. Only |
1620 | Together, all those colours implement the 88 (256) colour xterm |
1443 | the first 16 can be changed using resources currently, the rest can only |
1621 | colours. Only the first 16 can be changed using resources currently, the |
1444 | be changed via command sequences ("escape codes"). |
1622 | rest can only be changed via command sequences ("escape codes"). |
|
|
1623 | |
|
|
1624 | Applications are advised to use terminfo or command sequences to discover |
|
|
1625 | number and RGB values of all colours (yes, you can query this...). |
1445 | |
1626 | |
1446 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1627 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1447 | always swapping the foreground/background colours. This is in contrast to |
1628 | always swapping the foreground/background colours. This is in contrast to |
1448 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1629 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1449 | been specified. For example, |
1630 | been specified. For example, |
1450 | |
1631 | |
1451 | =over 4 |
|
|
1452 | |
|
|
1453 | =item B<@@RXVT_NAME@@ -fg Black -bg White -rv> |
1632 | @@RXVT_NAME@@ -fg Black -bg White -rv |
1454 | |
1633 | |
1455 | would yield White on Black, while on I<xterm>(1) it would yield Black |
1634 | would yield White on Black, while on I<xterm>(1) it would yield Black on |
1456 | on White. |
1635 | White. |
1457 | |
|
|
1458 | =back |
|
|
1459 | |
1636 | |
1460 | =head2 ALPHA CHANNEL SUPPORT |
1637 | =head2 ALPHA CHANNEL SUPPORT |
1461 | |
1638 | |
1462 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1639 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1463 | their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> |
1640 | their act together, rxvt-unicode will do its own alpha channel management: |
1464 | (recommended, but B<MUST> have 4 digits/component) colour specifications, |
1641 | |
1465 | in addition to the ones provided by X, where the additional A component |
1642 | You can prefix any colour with an opaqueness percentage enclosed in |
|
|
1643 | brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage |
|
|
1644 | (0-100) that specifies the opacity of the colour, where C<0> is completely |
|
|
1645 | transparent and C<100> is completely opaque. For example, C<[50]red> is a |
|
|
1646 | half-transparent red, while C<[95]#00ff00> is an almost opaque green. This |
|
|
1647 | is the recommended format to specify transparency values, and works with |
|
|
1648 | all ways to specify a colour. |
|
|
1649 | |
|
|
1650 | For complete control, rxvt-unicode also supports |
|
|
1651 | C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour |
|
|
1652 | specifications, where the additional C<aaaa> component specifies opacity |
1466 | specifies opacity (alpha) values. The minimum value of C<0> is completely |
1653 | (alpha) values. The minimum value of C<0000> is completely transparent, |
1467 | transparent). You can also prefix any color with C<[percent]>, where |
1654 | while C<ffff> is completely opaque). The two example colours from |
1468 | C<percent> is a decimal percentage (0-100) that specifies the opacity of |
1655 | earlier could also be specified as C<rgba:ff00/0000/0000/8000> and |
1469 | the color, where C<0> is completely transparent and C<100> is completelxy |
1656 | C<rgba:0000/ff00/0000/f332>. |
1470 | opaque. |
|
|
1471 | |
1657 | |
1472 | You probably need to specify B<"-depth 32">, too, and have the luck that |
1658 | You probably need to specify B<"-depth 32">, too, to force a visual with |
1473 | your X-server uses ARGB pixel layout, as X is far from just supporting |
1659 | alpha channels, and have the luck that your X-server uses ARGB pixel |
1474 | ARGB visuals out of the box, and rxvt-unicode just fudges around. |
1660 | layout, as X is far from just supporting ARGB visuals out of the box, and |
|
|
1661 | rxvt-unicode just fudges around. |
1475 | |
1662 | |
1476 | For example, the following selects an almost completely transparent red |
1663 | For example, the following selects an almost completely transparent black |
1477 | background, and an almost opaque pink foreground: |
1664 | background, and an almost opaque pink foreground: |
1478 | |
1665 | |
1479 | @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" |
1666 | @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink" |
1480 | |
1667 | |
1481 | I<Please note that transparency of any kind if completely unsupported by |
1668 | When not using a background image, then the interpretation of the |
1482 | the author. Don't bug him with installation questions!> |
1669 | alpha channel is up to your compositing manager (most interpret it as |
|
|
1670 | transparency of course). |
|
|
1671 | |
|
|
1672 | When using a background pixmap or pseudo-transparency, then the background |
|
|
1673 | colour will always behave as if it were completely transparent (so the |
|
|
1674 | background image shows instead), regardless of how it was specified, while |
|
|
1675 | other colours will either be transparent as specified (the background |
|
|
1676 | image will show through) on servers supporting the RENDER extension, or |
|
|
1677 | fully opaque on servers not supporting the RENDER EXTENSION. |
|
|
1678 | |
|
|
1679 | Please note that due to bugs in Xft, specifying alpha values might result |
|
|
1680 | in garbage being displayed when the X-server does not support the RENDER |
|
|
1681 | extension. |
1483 | |
1682 | |
1484 | =head1 ENVIRONMENT |
1683 | =head1 ENVIRONMENT |
1485 | |
1684 | |
1486 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1685 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1487 | |
1686 | |
… | |
… | |
1521 | C<--with-terminfo=PATH>. |
1720 | C<--with-terminfo=PATH>. |
1522 | |
1721 | |
1523 | =item B<DISPLAY> |
1722 | =item B<DISPLAY> |
1524 | |
1723 | |
1525 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1724 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1526 | display in its child processes. |
1725 | display in its child processes if C<-display> isn't used to override. It |
|
|
1726 | defaults to C<:0> if it doesn't exist. |
1527 | |
1727 | |
1528 | =item B<SHELL> |
1728 | =item B<SHELL> |
1529 | |
1729 | |
1530 | The shell to be used for command execution, defaults to C</bin/sh>. |
1730 | The shell to be used for command execution, defaults to C</bin/sh>. |
1531 | |
1731 | |
1532 | =item B<RXVT_SOCKET> |
1732 | =item B<RXVT_SOCKET> [I<sic>] |
1533 | |
1733 | |
1534 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1734 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1535 | @@RXVT_NAME@@d(1). |
1735 | @@RXVT_NAME@@d(1). |
1536 | |
1736 | |
1537 | Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. |
1737 | Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>. |
|
|
1738 | |
|
|
1739 | =item B<URXVT_PERL_LIB> |
|
|
1740 | |
|
|
1741 | Additional F<:>-separated library search path for perl extensions. Will be |
|
|
1742 | searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library |
|
|
1743 | directory. |
|
|
1744 | |
|
|
1745 | =item B<URXVT_PERL_VERBOSITY> |
|
|
1746 | |
|
|
1747 | See L<@@RXVT_NAME@@perl>(3). |
1538 | |
1748 | |
1539 | =item B<HOME> |
1749 | =item B<HOME> |
1540 | |
1750 | |
1541 | Used to locate the default directory for the unix domain socket for |
1751 | Used to locate the default directory for the unix domain socket for |
1542 | daemon communications and to locate various resource files (such as |
1752 | daemon communications and to locate various resource files (such as |
1543 | C<.Xdefaults>) |
1753 | C<.Xdefaults>) |
1544 | |
1754 | |
1545 | =item B<XAPPLRESDIR> |
1755 | =item B<XAPPLRESDIR> |
1546 | |
1756 | |
1547 | Directory where various X resource files are being located. |
1757 | Directory where application-specific X resource files are located. |
1548 | |
1758 | |
1549 | =item B<XENVIRONMENT> |
1759 | =item B<XENVIRONMENT> |
1550 | |
1760 | |
1551 | If set and accessible, gives the name of a X resource file to be loaded by |
1761 | If set and accessible, gives the name of a X resource file to be loaded by |
1552 | @@RXVT_NAME@@. |
1762 | @@RXVT_NAME@@. |
… | |
… | |
1557 | |
1767 | |
1558 | =over 4 |
1768 | =over 4 |
1559 | |
1769 | |
1560 | =item B</usr/lib/X11/rgb.txt> |
1770 | =item B</usr/lib/X11/rgb.txt> |
1561 | |
1771 | |
1562 | Color names. |
1772 | Colour names. |
1563 | |
1773 | |
1564 | =back |
1774 | =back |
1565 | |
1775 | |
1566 | =head1 SEE ALSO |
1776 | =head1 SEE ALSO |
1567 | |
1777 | |
|
|
1778 | @@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1), |
1568 | @@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) |
1779 | @@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) |
1569 | |
1780 | |
1570 | =head1 CURRENT PROJECT COORDINATOR |
1781 | =head1 CURRENT PROJECT COORDINATOR |
1571 | |
1782 | |
1572 | =over 4 |
1783 | =over 4 |
1573 | |
1784 | |
1574 | =item Project Coordinator |
1785 | =item Project Coordinator |
1575 | |
1786 | |
1576 | Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1787 | Marc A. Lehmann <rxvt-unicode@schmorp.de>. |
1577 | |
1788 | |
1578 | L<http://software.schmorp.de/pkg/rxvt-unicode.html> |
1789 | L<http://software.schmorp.de/pkg/rxvt-unicode.html> |
1579 | |
1790 | |
1580 | =back |
1791 | =back |
1581 | |
1792 | |
… | |
… | |
1585 | |
1796 | |
1586 | =item John Bovey |
1797 | =item John Bovey |
1587 | |
1798 | |
1588 | University of Kent, 1992, wrote the original Xvt. |
1799 | University of Kent, 1992, wrote the original Xvt. |
1589 | |
1800 | |
1590 | =item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> |
1801 | =item Rob Nation <nation@rocket.sanders.lockheed.com> |
1591 | |
1802 | |
1592 | very heavily modified Xvt and came up with Rxvt |
1803 | very heavily modified Xvt and came up with Rxvt |
1593 | |
1804 | |
1594 | =item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> |
1805 | =item Angelo Haritsis <ah@doc.ic.ac.uk> |
1595 | |
1806 | |
1596 | wrote the Greek Keyboard Input (no longer in code) |
1807 | wrote the Greek Keyboard Input (no longer in code) |
1597 | |
1808 | |
1598 | =item mj olesen L<< <olesen@me.QueensU.CA> >> |
1809 | =item mj olesen <olesen@me.QueensU.CA> |
1599 | |
1810 | |
1600 | Wrote the menu system. |
1811 | Wrote the menu system. |
1601 | |
1812 | |
1602 | Project Coordinator (changes.txt 2.11 to 2.21) |
1813 | Project Coordinator (changes.txt 2.11 to 2.21) |
1603 | |
1814 | |
1604 | =item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> |
1815 | =item Oezguer Kesim <kesim@math.fu-berlin.de> |
1605 | |
1816 | |
1606 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1817 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1607 | |
1818 | |
1608 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1819 | =item Geoff Wing <gcw@pobox.com> |
1609 | |
1820 | |
1610 | Rewrote screen display and text selection routines. |
1821 | Rewrote screen display and text selection routines. |
1611 | |
1822 | |
1612 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1823 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1613 | |
1824 | |
1614 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1825 | =item Marc Alexander Lehmann <rxvt-unicode@schmorp.de> |
1615 | |
1826 | |
1616 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |
1827 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |
1617 | extension, random hacks, numerous bugfixes and extensions. |
1828 | extension, random hacks, numerous bugfixes and extensions. |
1618 | |
1829 | |
1619 | Project Coordinator (Changes 1.0 -) |
1830 | Project Coordinator (Changes 1.0 -) |
1620 | |
1831 | |
1621 | =item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> |
1832 | =item Emanuele Giaquinta <emanuele.giaquinta@gmail.com> |
1622 | |
1833 | |
1623 | Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. |
1834 | pty/utmp code rewrite, image code improvements, many random hacks and bugfixes. |
1624 | |
1835 | |
1625 | =back |
1836 | =back |
1626 | |
1837 | |