… | |
… | |
12 | emulator intended as an I<xterm>(1) replacement for users who do not |
12 | emulator intended as an I<xterm>(1) replacement for users who do not |
13 | require features such as Tektronix 4014 emulation and toolkit-style |
13 | require features such as Tektronix 4014 emulation and toolkit-style |
14 | configurability. As a result, B<rxvt-unicode> uses much less swap space -- |
14 | configurability. As a result, B<rxvt-unicode> uses much less swap space -- |
15 | a significant advantage on a machine serving many X sessions. |
15 | a significant advantage on a machine serving many X sessions. |
16 | |
16 | |
|
|
17 | This document is also available on the World-Wide-Web at |
|
|
18 | L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>. |
|
|
19 | |
17 | =head1 FREQUENTLY ASKED QUESTIONS |
20 | =head1 FREQUENTLY ASKED QUESTIONS |
18 | |
21 | |
19 | See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of |
22 | See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of |
20 | frequently asked questions and answer to them and some common |
23 | frequently asked questions and answer to them and some common |
21 | problems. That document is also accessible on the World-Wide-Web at |
24 | problems. That document is also accessible on the World-Wide-Web at |
22 | L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. |
25 | L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>. |
23 | |
26 | |
24 | =head1 RXVT-UNICODE VS. RXVT |
27 | =head1 RXVT-UNICODE VS. RXVT |
25 | |
28 | |
26 | Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode |
29 | Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode |
27 | internally. That means it can store and display most scripts in the |
30 | internally. That means it can store and display most scripts in the |
28 | world. Being a terminal emulator, however, some things are very difficult, |
31 | world. Being a terminal emulator, however, some things are very difficult, |
29 | especially cursive scripts such as arabic, vertically written scripts |
32 | especially cursive scripts such as arabic, vertically written scripts |
30 | like mongolian or scripts requiring extremely complex combining rules, |
33 | like mongolian or scripts requiring extremely complex combining rules, |
31 | like tibetan or devenagari. Don't expect pretty output when using these |
34 | like tibetan or devanagari. Don't expect pretty output when using these |
32 | scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work |
35 | scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work |
33 | fine, though. A somewhat difficult case are left-to-right scripts, such |
36 | fine, though. A somewhat difficult case are right-to-left scripts, such |
34 | as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms |
37 | as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms |
35 | belong into the application, not the terminal emulator (too many things -- |
38 | belong in the application, not the terminal emulator (too many things -- |
36 | such as cursor-movement while editing -- break otherwise), but that might |
39 | such as cursor-movement while editing -- break otherwise), but that might |
37 | change. |
40 | change. |
38 | |
41 | |
39 | If you are looking for a terminal that supports more exotic scripts, let |
42 | If you are looking for a terminal that supports more exotic scripts, let |
40 | me recommend C<mlterm>, which is a very userfriendly, lean and clean |
43 | me recommend C<mlterm>, which is a very user friendly, lean and clean |
41 | terminal emulator. In fact, the reason rxvt-unicode was born was solely |
44 | terminal emulator. In fact, the reason rxvt-unicode was born was solely |
42 | because the author couldn't get C<mlterm> to use one font for latin1 and |
45 | because the author couldn't get C<mlterm> to use one font for latin1 and |
43 | another for japanese. |
46 | another for japanese. |
44 | |
47 | |
45 | Therefore another design rationale was the use of multiple fonts to |
48 | Therefore another design rationale was the use of multiple fonts to |
46 | display characters: The idea of a single unicode font which many other |
49 | display characters: The idea of a single unicode font which many other |
47 | programs force onto it's users never made sense to me: You should be able |
50 | programs force onto its users never made sense to me: You should be able |
48 | to choose any font for any script freely. |
51 | to choose any font for any script freely. |
49 | |
52 | |
50 | Apart from that, rxvt-unicode is also much better internationalised than |
53 | Apart from that, rxvt-unicode is also much better internationalised than |
51 | it's predecessor, supports things such as XFT and ISO 14755 that are handy |
54 | its predecessor, supports things such as XFT and ISO 14755 that are handy |
52 | in i18n-environments, is faster, and has a lot less bugs than the original |
55 | in i18n-environments, is faster, and has a lot bugs less than the original |
53 | rxvt. This all in addition to dozens of other small improvements. |
56 | rxvt. This all in addition to dozens of other small improvements. |
54 | |
57 | |
55 | It is still faithfully following the original rxvt idea of being lean |
58 | It is still faithfully following the original rxvt idea of being lean |
56 | and nice on resources: for example, you can still configure rxvt-unicode |
59 | and nice on resources: for example, you can still configure rxvt-unicode |
57 | without most of it's features to get a lean binary. It also comes with |
60 | without most of its features to get a lean binary. It also comes with |
58 | a client/daemon pair that lets you open any number of terminal windows |
61 | a client/daemon pair that lets you open any number of terminal windows |
59 | from within a single process, which makes startup time very fast and |
62 | from within a single process, which makes startup time very fast and |
60 | drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and |
63 | drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and |
61 | @@RXVT_NAME@@c(1) (client). |
64 | @@RXVT_NAME@@c(1) (client). |
62 | |
65 | |
63 | It also makes technical information about escape sequences (which have |
66 | It also makes technical information about escape sequences (which have |
64 | been extended) easier accessible: see @@RXVT_NAME@@(7) for technical |
67 | been extended) more accessible: see @@RXVT_NAME@@(7) for technical |
65 | reference documentation (escape sequences etc.). |
68 | reference documentation (escape sequences etc.). |
66 | |
69 | |
67 | =head1 OPTIONS |
70 | =head1 OPTIONS |
68 | |
71 | |
69 | The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed |
72 | The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed |
… | |
… | |
89 | |
92 | |
90 | Print out a message describing available options. |
93 | Print out a message describing available options. |
91 | |
94 | |
92 | =item B<-display> I<displayname> |
95 | =item B<-display> I<displayname> |
93 | |
96 | |
94 | Attempt to open a window on the named X display (B<-d> still |
97 | Attempt to open a window on the named X display (the older form B<-d> |
95 | respected). In the absence of this option, the display specified by the |
98 | is still respected. but deprecated). In the absence of this option, the |
96 | B<DISPLAY> environment variable is used. |
99 | display specified by the B<DISPLAY> environment variable is used. |
97 | |
100 | |
98 | =item B<-depth> I<bitdepth> |
101 | =item B<-depth> I<bitdepth> |
99 | |
102 | |
100 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
103 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
101 | resource B<depth>. |
104 | resource B<depth>. |
102 | |
105 | |
|
|
106 | [Please note that many X servers (and libXft) are buggy with |
|
|
107 | respect to C<-depth 32> and/or alpha channels, and will cause all sorts |
|
|
108 | of graphical corruption. This is harmless, but we can't do anything about |
|
|
109 | this, so watch out] |
|
|
110 | |
103 | =item B<-geometry> I<geom> |
111 | =item B<-geometry> I<geom> |
104 | |
112 | |
105 | Window geometry (B<-g> still respected); resource B<geometry>. |
113 | Window geometry (B<-g> still respected); resource B<geometry>. |
106 | |
114 | |
107 | =item B<-rv>|B<+rv> |
115 | =item B<-rv>|B<+rv> |
108 | |
116 | |
109 | Turn on/off simulated reverse video; resource B<reverseVideo>. |
117 | Turn on/off simulated reverse video; resource B<reverseVideo>. |
110 | |
118 | |
111 | =item B<-j>|B<+j> |
119 | =item B<-j>|B<+j> |
112 | |
120 | |
113 | Turn on/off jump scrolling; resource B<jumpScroll>. |
121 | Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. |
114 | |
122 | |
115 | =item B<-ip>|B<+ip> | B<-tr>|B<+tr> |
123 | =item B<-ss>|B<+ss> |
116 | |
124 | |
117 | Turn on/off inheriting parent window's pixmap. Alternative form is |
125 | Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. |
118 | B<-tr>; resource B<inheritPixmap>. |
|
|
119 | |
126 | |
120 | I<Please note that transparency of any kind if completely unsupported by |
127 | =item B<-tr>|B<+tr> |
121 | the author. Don't bug him with installation questions!> |
128 | |
|
|
129 | Turn on/off illusion of a transparent window background; resource B<transparent>. |
|
|
130 | |
|
|
131 | B<-ip> is still accepted as an obsolete alias but will be removed in |
|
|
132 | future versions. |
|
|
133 | |
|
|
134 | I<Please address all transparency related issues to Sasha Vasko at |
|
|
135 | sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> |
122 | |
136 | |
123 | =item B<-fade> I<number> |
137 | =item B<-fade> I<number> |
124 | |
138 | |
125 | Fade the text by the given percentage when focus is lost. Small values |
139 | Fade the text by the given percentage when focus is lost. Small values |
126 | fade a little only, 100 completely replaces all colours by the fade |
140 | fade a little only, 100 completely replaces all colours by the fade |
… | |
… | |
132 | is opaque black. resource B<fadeColor>. |
146 | is opaque black. resource B<fadeColor>. |
133 | |
147 | |
134 | =item B<-tint> I<colour> |
148 | =item B<-tint> I<colour> |
135 | |
149 | |
136 | Tint the transparent background pixmap with the given colour when |
150 | Tint the transparent background pixmap with the given colour when |
137 | transparency is enabled with B<-tr> or B<-ip>. This only works for |
151 | transparency is enabled with B<-tr>. This only works for |
138 | non-tiled backgrounds, currently. See also the B<-sh> option that can be |
152 | non-tiled backgrounds, currently. See also the B<-sh> option that can be |
139 | used to brighten or darken the image in addition to tinting it; resource |
153 | used to brighten or darken the image in addition to tinting it. |
|
|
154 | Please note that certain tint colours can be applied on the server-side, |
|
|
155 | thus yielding performance gain of two orders of magnitude. These colours are: |
|
|
156 | blue, red, green, cyan, magenta, yellow, and those close to them. Also |
|
|
157 | pure black and pure white colors essentially mean no tinting; resource |
140 | I<tintColor>. Example: |
158 | I<tintColor>. Example: |
141 | |
159 | |
142 | @@RXVT_NAME@@ -tr -tint blue -sh 40 |
160 | @@RXVT_NAME@@ -tr -tint blue -sh 40 |
143 | |
161 | |
144 | =item B<-sh> |
162 | =item B<-sh> I<number> |
145 | |
163 | |
146 | I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
164 | Darken (0 .. 100) or lighten (100 .. 200) the transparent |
147 | background image in addition to tinting it (i.e. B<-tint> must be |
165 | background image in addition to (or instead of) tinting it; |
148 | specified, too, e.g. C<-tint white>). |
166 | resource I<shading>. |
|
|
167 | |
|
|
168 | =item B<-blt> I<string> |
|
|
169 | |
|
|
170 | Specify background blending type. If background pixmap is specified |
|
|
171 | at the same time as transparency - such pixmap will be blended over |
|
|
172 | transparency image, using method specified. Supported values are : |
|
|
173 | B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, |
|
|
174 | B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, |
|
|
175 | B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is |
|
|
176 | alpha-blending. Compile I<afterimage>; resource I<blendType>. |
|
|
177 | |
|
|
178 | =item B<-blr> I<HxV> |
|
|
179 | |
|
|
180 | Apply Gaussian Blur with the specified radii to the transparent |
|
|
181 | background image. If single number is specified - both vertical and |
|
|
182 | horizontal radii are considered to be the same. Setting one of the |
|
|
183 | radii to 1 and another to a large number creates interesting effects |
|
|
184 | on some backgrounds. Maximum radius value is 128. Compile I<afterimage>; |
|
|
185 | resource I<blurRadius>. |
|
|
186 | |
|
|
187 | =item B<-icon> I<file> |
|
|
188 | |
|
|
189 | Compile I<afterimage>: Use the specified image as application icon. This |
|
|
190 | is used by many window managers, taskbars and pagers to represent the |
|
|
191 | appliation window; resource I<iconFile>. |
149 | |
192 | |
150 | =item B<-bg> I<colour> |
193 | =item B<-bg> I<colour> |
151 | |
194 | |
152 | Window background colour; resource B<background>. |
195 | Window background colour; resource B<background>. |
153 | |
196 | |
154 | =item B<-fg> I<colour> |
197 | =item B<-fg> I<colour> |
155 | |
198 | |
156 | Window foreground colour; resource B<foreground>. |
199 | Window foreground colour; resource B<foreground>. |
157 | |
200 | |
158 | =item B<-pixmap> I<file[;geom]> |
201 | =item B<-pixmap> I<file[;geom[:op1][:op2][...]]> |
159 | |
202 | |
160 | Compile I<XPM>: Specify XPM file for the background and also optionally |
203 | Compile I<afterimage>: Specify image file for the background and also |
161 | specify its scaling with a geometry string. Note you may need to |
204 | optionally specify its scaling with a geometry string. Note you may need to |
162 | add quotes to avoid special shell interpretation of the C<;> in the |
205 | add quotes to avoid special shell interpretation of the C<;> in the |
163 | command-line; resource B<backgroundPixmap>. |
206 | command-line; for more details see resource B<backgroundPixmap>. |
164 | |
207 | |
165 | =item B<-cr> I<colour> |
208 | =item B<-cr> I<colour> |
166 | |
209 | |
167 | The cursor colour; resource B<cursorColor>. |
210 | The cursor colour; resource B<cursorColor>. |
168 | |
211 | |
… | |
… | |
185 | that are checked in order when trying to find glyphs for characters. The |
228 | that are checked in order when trying to find glyphs for characters. The |
186 | first font defines the cell size for characters; other fonts might be |
229 | first font defines the cell size for characters; other fonts might be |
187 | smaller, but not (in general) larger. A (hopefully) reasonable default |
230 | smaller, but not (in general) larger. A (hopefully) reasonable default |
188 | font list is always appended to it. See resource B<font> for more details. |
231 | font list is always appended to it. See resource B<font> for more details. |
189 | |
232 | |
190 | In short, to specify an X11 core font, just specify it's name or prefix it |
233 | In short, to specify an X11 core font, just specify its name or prefix it |
191 | with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, |
234 | with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, |
192 | e.g.: |
235 | e.g.: |
193 | |
236 | |
194 | @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
237 | @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
195 | @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
238 | @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
… | |
… | |
213 | italic> >> characters are to be printed. See resource B<boldItalicFont> |
256 | italic> >> characters are to be printed. See resource B<boldItalicFont> |
214 | for details. |
257 | for details. |
215 | |
258 | |
216 | =item B<-is>|B<+is> |
259 | =item B<-is>|B<+is> |
217 | |
260 | |
218 | Compile I<font-styles>: Bold/Italic font styles imply high intensity |
261 | Compile I<font-styles>: Bold/Blink font styles imply high intensity |
219 | foreground/background (default). See resource B<intensityStyles> for |
262 | foreground/background (default). See resource B<intensityStyles> for |
220 | details. |
263 | details. |
221 | |
264 | |
222 | =item B<-name> I<name> |
265 | =item B<-name> I<name> |
223 | |
266 | |
… | |
… | |
241 | |
284 | |
242 | =item B<-sb>|B<+sb> |
285 | =item B<-sb>|B<+sb> |
243 | |
286 | |
244 | Turn on/off scrollbar; resource B<scrollBar>. |
287 | Turn on/off scrollbar; resource B<scrollBar>. |
245 | |
288 | |
|
|
289 | =item B<-sr>|B<+sr> |
|
|
290 | |
|
|
291 | Put scrollbar on right/left; resource B<scrollBar_right>. |
|
|
292 | |
|
|
293 | =item B<-st>|B<+st> |
|
|
294 | |
|
|
295 | Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; |
|
|
296 | resource B<scrollBar_floating>. |
|
|
297 | |
246 | =item B<-si>|B<+si> |
298 | =item B<-si>|B<+si> |
247 | |
299 | |
248 | Turn on/off scroll-to-bottom on TTY output inhibit; resource |
300 | Turn on/off scroll-to-bottom on TTY output inhibit; resource |
249 | B<scrollTtyOutput> has opposite effect. |
301 | B<scrollTtyOutput> has opposite effect. |
250 | |
302 | |
… | |
… | |
256 | =item B<-sw>|B<+sw> |
308 | =item B<-sw>|B<+sw> |
257 | |
309 | |
258 | Turn on/off scrolling with the scrollback buffer as new lines appear. |
310 | Turn on/off scrolling with the scrollback buffer as new lines appear. |
259 | This only takes effect if B<-si> is also given; resource |
311 | This only takes effect if B<-si> is also given; resource |
260 | B<scrollWithBuffer>. |
312 | B<scrollWithBuffer>. |
261 | |
|
|
262 | =item B<-sr>|B<+sr> |
|
|
263 | |
|
|
264 | Put scrollbar on right/left; resource B<scrollBar_right>. |
|
|
265 | |
|
|
266 | =item B<-st>|B<+st> |
|
|
267 | |
|
|
268 | Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; |
|
|
269 | resource B<scrollBar_floating>. |
|
|
270 | |
313 | |
271 | =item B<-ptab>|B<+ptab> |
314 | =item B<-ptab>|B<+ptab> |
272 | |
315 | |
273 | If enabled (default), "Horizontal Tab" characters are being stored as |
316 | If enabled (default), "Horizontal Tab" characters are being stored as |
274 | actual wide characters in the screen buffer, which makes it possible to |
317 | actual wide characters in the screen buffer, which makes it possible to |
… | |
… | |
303 | |
346 | |
304 | =item B<-bl> |
347 | =item B<-bl> |
305 | |
348 | |
306 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
349 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
307 | if honoured by the WM, the rxvt-unicode window will not have window |
350 | if honoured by the WM, the rxvt-unicode window will not have window |
308 | decorations; resource B<borderLess>. |
351 | decorations; resource B<borderLess>. If the window manager does not |
|
|
352 | support MWM hints (e.g. kwin), enables override-redirect mode. |
309 | |
353 | |
310 | =item B<-override-redirect> |
354 | =item B<-override-redirect> |
311 | |
355 | |
312 | Compile I<frills>: Sets override-redirect on the window; resource |
356 | Compile I<frills>: Sets override-redirect on the window; resource |
313 | B<override-redirect>. |
357 | B<override-redirect>. |
… | |
… | |
321 | |
365 | |
322 | =item B<-lsp> I<number> |
366 | =item B<-lsp> I<number> |
323 | |
367 | |
324 | Compile I<frills>: Lines (pixel height) to insert between each row of |
368 | Compile I<frills>: Lines (pixel height) to insert between each row of |
325 | the display. Useful to work around font rendering problems; resource |
369 | the display. Useful to work around font rendering problems; resource |
326 | B<linespace>. |
370 | B<lineSpace>. |
327 | |
371 | |
328 | =item B<-tn> I<termname> |
372 | =item B<-tn> I<termname> |
329 | |
373 | |
330 | This option specifies the name of the terminal type to be set in the |
374 | This option specifies the name of the terminal type to be set in the |
331 | B<TERM> environment variable. This terminal type must exist in the |
375 | B<TERM> environment variable. This terminal type must exist in the |
… | |
… | |
385 | for more info. |
429 | for more info. |
386 | |
430 | |
387 | =item B<-tcw> |
431 | =item B<-tcw> |
388 | |
432 | |
389 | Change the meaning of triple-click selection with the left mouse |
433 | Change the meaning of triple-click selection with the left mouse |
|
|
434 | button. Only effective when the original (non-perl) selection code is |
390 | button. Instead of selecting a full line it will extend the selection the |
435 | in-use. Instead of selecting a full line it will extend the selection to |
391 | end of the logical line only. resource B<tripleclickwords>. |
436 | the end of the logical line only. resource B<tripleclickwords>. |
392 | |
437 | |
393 | =item B<-insecure> |
438 | =item B<-insecure> |
394 | |
439 | |
395 | Enable "insecure" mode, which currently enables most of the escape |
440 | Enable "insecure" mode, which currently enables most of the escape |
396 | sequences that echo strings. See the resource B<insecure> for more |
441 | sequences that echo strings. See the resource B<insecure> for more |
… | |
… | |
417 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
462 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
418 | will not immediately destroy its window when the program executed within |
463 | will not immediately destroy its window when the program executed within |
419 | it exits. Instead, it will wait till it is being killed or closed by the |
464 | it exits. Instead, it will wait till it is being killed or closed by the |
420 | user; resource B<hold>. |
465 | user; resource B<hold>. |
421 | |
466 | |
|
|
467 | =item B<-cd> I<path> |
|
|
468 | |
|
|
469 | Sets the working directory for the shell (or the command specified via |
|
|
470 | B<-e>). The I<path> must be an absolute path and it must exist for |
|
|
471 | @@RXVT_NAME@@ to start; resource B<chdir>. |
|
|
472 | |
|
|
473 | =item B<-xrm> I<string> |
|
|
474 | |
|
|
475 | Works like the X Toolkit option of the same name, by adding the I<string> |
|
|
476 | as if it were specified in a resource file. Resource values specified this |
|
|
477 | way take precedence over all other resource specifications. |
|
|
478 | |
|
|
479 | Note that you need to use the I<same> syntax as in the .Xdefaults file, |
|
|
480 | e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific |
|
|
481 | options can be specified as long-options on the commandline, so use |
|
|
482 | of B<-xrm> is mostly limited to cases where you want to specify other |
|
|
483 | resources (e.g. for input methods) or for compatibility with other |
|
|
484 | programs. |
|
|
485 | |
422 | =item B<-keysym.>I<sym> I<string> |
486 | =item B<-keysym.>I<sym> I<string> |
423 | |
487 | |
424 | Remap a key symbol. See resource B<keysym>. |
488 | Remap a key symbol. See resource B<keysym>. |
425 | |
489 | |
426 | =item B<-embed> I<windowid> |
490 | =item B<-embed> I<windowid> |
427 | |
491 | |
428 | Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, |
492 | Tells @@RXVT_NAME@@ to embed its windows into an already-existing window, |
429 | which enables applications to easily embed a terminal. |
493 | which enables applications to easily embed a terminal. |
430 | |
494 | |
431 | Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it |
495 | Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it |
432 | shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it |
496 | shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it |
433 | quite a bit, so don't expect it to keep some specific state. It's best to |
497 | quite a bit, so don't expect it to keep some specific state. It's best to |
… | |
… | |
436 | The window will not be destroyed when @@RXVT_NAME@@ exits. |
500 | The window will not be destroyed when @@RXVT_NAME@@ exits. |
437 | |
501 | |
438 | It might be useful to know that @@RXVT_NAME@@ will not close file |
502 | It might be useful to know that @@RXVT_NAME@@ will not close file |
439 | descriptors passed to it (except for stdin/out/err, of course), so you |
503 | descriptors passed to it (except for stdin/out/err, of course), so you |
440 | can use file descriptors to communicate with the programs within the |
504 | can use file descriptors to communicate with the programs within the |
441 | terminal. This works regardless of wether the C<-embed> option was used or |
505 | terminal. This works regardless of whether the C<-embed> option was used or |
442 | not. |
506 | not. |
443 | |
507 | |
444 | Here is a short Gtk2-perl snippet that illustrates how this option can be |
508 | Here is a short Gtk2-perl snippet that illustrates how this option can be |
445 | used (a longer example is in F<doc/embed>): |
509 | used (a longer example is in F<doc/embed>): |
446 | |
510 | |
… | |
… | |
451 | }); |
515 | }); |
452 | |
516 | |
453 | =item B<-pty-fd> I<file descriptor> |
517 | =item B<-pty-fd> I<file descriptor> |
454 | |
518 | |
455 | Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty |
519 | Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty |
456 | pair but instead use the given filehandle as the tty master. This is |
520 | pair but instead use the given file descriptor as the tty master. This is |
457 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
521 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
458 | without having to run a program within it. |
522 | without having to run a program within it. |
459 | |
523 | |
460 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
524 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
461 | entries and will not tinker with pty/tty permissions - you have to do that |
525 | entries and will not tinker with pty/tty permissions - you have to do that |
462 | yourself if you want that. |
526 | yourself if you want that. |
463 | |
527 | |
464 | As an extremely special case, specifying C<-1> will completely suppress |
528 | As an extremely special case, specifying C<-1> will completely suppress |
465 | pty/tty operations. |
529 | pty/tty operations, which is probably only useful in conjunction with some |
|
|
530 | perl extension that manages the terminal. |
466 | |
531 | |
467 | Here is a example in perl that illustrates how this option can be used (a |
532 | Here is a example in perl that illustrates how this option can be used (a |
468 | longer example is in F<doc/pty-fd>): |
533 | longer example is in F<doc/pty-fd>): |
469 | |
534 | |
470 | use IO::Pty; |
535 | use IO::Pty; |
… | |
… | |
484 | Comma-separated list of perl extension scripts to use (or not to use) in |
549 | Comma-separated list of perl extension scripts to use (or not to use) in |
485 | this terminal instance. See resource B<perl-ext> for details. |
550 | this terminal instance. See resource B<perl-ext> for details. |
486 | |
551 | |
487 | =back |
552 | =back |
488 | |
553 | |
489 | =head1 RESOURCES (available also as long-options) |
554 | =head1 RESOURCES |
490 | |
555 | |
491 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
556 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
492 | options) compiled into your version. |
557 | options) compiled into your version. All resources are also available as |
|
|
558 | long-options. |
493 | |
559 | |
494 | You can set and change the resources using X11 tools like B<xrdb>. Many |
560 | You can set and change the resources using X11 tools like B<xrdb>. Many |
495 | distribution do also load settings from the B<~/.Xresources> file when X |
561 | distribution do also load settings from the B<~/.Xresources> file when X |
496 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
562 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
497 | with later settings overwriting earlier ones: |
563 | with later settings overwriting earlier ones: |
… | |
… | |
499 | 1. system-wide app-defaults file, either locale-dependent OR global |
565 | 1. system-wide app-defaults file, either locale-dependent OR global |
500 | 2. app-defaults file in $XAPPLRESDIR |
566 | 2. app-defaults file in $XAPPLRESDIR |
501 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
567 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
502 | 4. SCREEN_RESOURCES for the current screen |
568 | 4. SCREEN_RESOURCES for the current screen |
503 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
569 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
|
|
570 | 6. resources specified via -xrm on the commandline |
504 | |
571 | |
505 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
572 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
506 | names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
573 | names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
507 | common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily |
574 | common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily |
508 | configured, while the class name B<URxvt> allows resources unique to |
575 | configured, while the class name B<URxvt> allows resources unique to |
… | |
… | |
518 | =item B<depth:> I<bitdepth> |
585 | =item B<depth:> I<bitdepth> |
519 | |
586 | |
520 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
587 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
521 | option B<-depth>. |
588 | option B<-depth>. |
522 | |
589 | |
|
|
590 | =item B<buffered:> I<boolean> |
|
|
591 | |
|
|
592 | Compile I<xft>: Turn on/off double-buffering for xft (default enabled). |
|
|
593 | On some card/driver combination enabling it slightly decreases |
|
|
594 | performance, on most it greatly helps it. The slowdown is small, so it |
|
|
595 | should normally be enabled. |
|
|
596 | |
523 | =item B<geometry:> I<geom> |
597 | =item B<geometry:> I<geom> |
524 | |
598 | |
525 | Create the window with the specified X window geometry [default 80x24]; |
599 | Create the window with the specified X window geometry [default 80x24]; |
526 | option B<-geometry>. |
600 | option B<-geometry>. |
527 | |
601 | |
… | |
… | |
563 | Use the specified colour to display underlined characters when the |
637 | Use the specified colour to display underlined characters when the |
564 | foreground colour is the default. |
638 | foreground colour is the default. |
565 | |
639 | |
566 | =item B<colorRV:> I<colour> |
640 | =item B<colorRV:> I<colour> |
567 | |
641 | |
568 | Use the specified colour as the background for reverse video |
642 | Use the specified colour as the background for reverse video characters |
569 | characters. |
643 | when OPTION_HC is disabled (--disable-frills). |
570 | |
644 | |
571 | =item B<underlineColor:> I<colour> |
645 | =item B<underlineColor:> I<colour> |
572 | |
646 | |
573 | If set, use the specified colour as the colour for the underline |
647 | If set, use the specified colour as the colour for the underline |
574 | itself. If unset, use the foreground colour. |
648 | itself. If unset, use the foreground colour. |
… | |
… | |
590 | option B<-rv>. B<False>: regular screen colours [default]; option |
664 | option B<-rv>. B<False>: regular screen colours [default]; option |
591 | B<+rv>. See note in B<COLORS AND GRAPHICS> section. |
665 | B<+rv>. See note in B<COLORS AND GRAPHICS> section. |
592 | |
666 | |
593 | =item B<jumpScroll:> I<boolean> |
667 | =item B<jumpScroll:> I<boolean> |
594 | |
668 | |
595 | B<True>: specify that jump scrolling should be used. When scrolling |
669 | B<True>: specify that jump scrolling should be used. When receiving lots |
596 | quickly, fewer screen updates are performed [default]; option B<-j>. |
670 | of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines |
|
|
671 | has been read, resulting in fewer updates while still displaying every |
|
|
672 | received line; option B<-j>. |
|
|
673 | |
597 | B<False>: specify that smooth scrolling should be used; option B<+j>. |
674 | B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will |
|
|
675 | force a screen refresh on each new line it received; option B<+j>. |
598 | |
676 | |
599 | =item B<inheritPixmap:> I<boolean> |
677 | =item B<skipScroll:> I<boolean> |
600 | |
678 | |
601 | B<True>: make the background inherit the parent windows' pixmap, giving |
679 | B<True>: (the default) specify that skip scrolling should be used. When |
602 | artificial transparency. B<False>: do not inherit the parent windows' |
680 | receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while |
603 | pixmap. |
681 | (around 60 times per second), resulting in far fewer updates. This can |
|
|
682 | result in @@RXVT_NAME@@ not ever displaying some of the lines it receives; |
|
|
683 | option B<-ss>. |
604 | |
684 | |
605 | I<Please note that transparency of any kind if completely unsupported by |
685 | B<False>: specify that everything is to be displayed, even |
606 | the author. Don't bug him with installation questions!> |
686 | if the refresh is too fast for the human eye to read anything (or the |
|
|
687 | monitor to display anything); option B<+ss>. |
|
|
688 | |
|
|
689 | =item B<transparent:> I<boolean> |
|
|
690 | |
|
|
691 | Turn on/off illusion of a transparent window background. |
|
|
692 | |
|
|
693 | B<inheritPixmap> is still accepted as an obsolete alias but will be removed in |
|
|
694 | future versions. |
|
|
695 | |
|
|
696 | I<Please address all transparency related issues to Sasha Vasko at |
|
|
697 | sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!> |
607 | |
698 | |
608 | =item B<fading:> I<number> |
699 | =item B<fading:> I<number> |
609 | |
700 | |
610 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
701 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
611 | |
702 | |
… | |
… | |
619 | Tint the transparent background pixmap with the given colour; option |
710 | Tint the transparent background pixmap with the given colour; option |
620 | B<-tint>. |
711 | B<-tint>. |
621 | |
712 | |
622 | =item B<shading:> I<number> |
713 | =item B<shading:> I<number> |
623 | |
714 | |
624 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
715 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image |
625 | image in addition to tinting it. |
716 | in addition to tinting it; option B<-sh>. |
|
|
717 | |
|
|
718 | =item B<blendType:> I<string> |
|
|
719 | |
|
|
720 | Specify background blending type; option B<-blt>. |
|
|
721 | |
|
|
722 | =item B<blurRadius:> I<number> |
|
|
723 | |
|
|
724 | Apply gaussian blur with the specified radius to the transparent |
|
|
725 | background image; option B<-blr>. |
|
|
726 | |
|
|
727 | =item B<iconFile:> I<file> |
|
|
728 | |
|
|
729 | Set the application icon pixmap; option B<-icon>. |
626 | |
730 | |
627 | =item B<scrollColor:> I<colour> |
731 | =item B<scrollColor:> I<colour> |
628 | |
732 | |
629 | Use the specified colour for the scrollbar [default #B2B2B2]. |
733 | Use the specified colour for the scrollbar [default #B2B2B2]. |
630 | |
734 | |
… | |
… | |
636 | =item B<borderColor:> I<colour> |
740 | =item B<borderColor:> I<colour> |
637 | |
741 | |
638 | The colour of the border around the text area and between the scrollbar |
742 | The colour of the border around the text area and between the scrollbar |
639 | and the text. |
743 | and the text. |
640 | |
744 | |
641 | =item B<backgroundPixmap:> I<file[;geom]> |
745 | =item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]> |
642 | |
746 | |
643 | Use the specified XPM file (note the `.xpm' extension is optional) for |
747 | Use the specified image file for the background and also |
644 | the background and also optionally specify its scaling with a geometry |
748 | optionally specify its scaling with a geometry string B<WxH+X+Y>, |
645 | string B<WxH+X+Y>, in which B<"W" / "H"> specify the |
749 | (default C<0x0+50+50>) in which B<"W" / "H"> specify the |
646 | horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image |
750 | horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image |
647 | centre (percent). A scale of 0 displays the image with tiling. A scale |
751 | centre (percent). A scale of 0 displays the image with tiling. A scale |
648 | of 1 displays the image without any scaling. A scale of 2 to 9 |
752 | of 1 displays the image without any scaling. A scale of 2 to 9 specifies |
649 | specifies an integer number of images in that direction. No image will |
753 | an integer number of images in that direction. No image will be magnified |
650 | be magnified beyond 10 times its original size. The maximum permitted |
754 | beyond 10 times its original size. The maximum permitted scale is 1000. |
651 | scale is 1000. [default 0x0+50+50] |
755 | Additional operations can be specified after colon B<:op1:op2...>. |
|
|
756 | Supported operations are: |
|
|
757 | |
|
|
758 | tile force background image to be tiled and not scaled. Equivalent to 0x0 |
|
|
759 | propscale will scale image keeping proportions |
|
|
760 | auto will scale image to match window size. Equivalent to 100x100 |
|
|
761 | hscale will scale image horizontally to the window size |
|
|
762 | vscale will scale image vertically to the window size |
|
|
763 | scale will scale image to match window size |
|
|
764 | root will tile image as if it was a root window background, auto-adjusting |
|
|
765 | whenever terminal window moves |
|
|
766 | |
|
|
767 | If used in conjunction with B<-tr> option, the specified pixmap will be |
|
|
768 | blended over transparency image using either alpha-blending, or any |
|
|
769 | other blending type, specified with B<-blt "type"> option. |
652 | |
770 | |
653 | =item B<path:> I<path> |
771 | =item B<path:> I<path> |
654 | |
772 | |
655 | Specify the colon-delimited search path for finding XPM files. |
773 | Specify the colon-delimited search path for finding background image files. |
656 | |
774 | |
657 | =item B<font:> I<fontlist> |
775 | =item B<font:> I<fontlist> |
658 | |
776 | |
659 | Select the fonts to be used. This is a comma separated list of font names |
777 | Select the fonts to be used. This is a comma separated list of font names |
660 | that are checked in order when trying to find glyphs for characters. The |
778 | that are checked in order when trying to find glyphs for characters. The |
… | |
… | |
717 | text font will being used for the given style. |
835 | text font will being used for the given style. |
718 | |
836 | |
719 | =item B<intensityStyles:> I<boolean> |
837 | =item B<intensityStyles:> I<boolean> |
720 | |
838 | |
721 | When font styles are not enabled, or this option is enabled (B<True>, |
839 | When font styles are not enabled, or this option is enabled (B<True>, |
722 | option B<-is>, the default), bold and italic font styles imply high |
840 | option B<-is>, the default), bold/blink font styles imply high |
723 | intensity foreground/backround colours. Disabling this option (B<False>, |
841 | intensity foreground/background colours. Disabling this option (B<False>, |
724 | option B<+is>) disables this behaviour, the high intensity colours are not |
842 | option B<+is>) disables this behaviour, the high intensity colours are not |
725 | reachable. |
843 | reachable. |
726 | |
|
|
727 | =item B<selectstyle:> I<mode> |
|
|
728 | |
|
|
729 | Set mouse selection style to B<old> which is 2.20, B<oldword> which is |
|
|
730 | xterm style with 2.20 old word selection, or anything else which gives |
|
|
731 | xterm style selection. |
|
|
732 | |
|
|
733 | =item B<scrollstyle:> I<mode> |
|
|
734 | |
|
|
735 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
|
|
736 | the author's favourite. |
|
|
737 | |
844 | |
738 | =item B<title:> I<string> |
845 | =item B<title:> I<string> |
739 | |
846 | |
740 | Set window title string, the default title is the command-line |
847 | Set window title string, the default title is the command-line |
741 | specified after the B<-e> option, if any, otherwise the application |
848 | specified after the B<-e> option, if any, otherwise the application |
… | |
… | |
750 | =item B<mapAlert:> I<boolean> |
857 | =item B<mapAlert:> I<boolean> |
751 | |
858 | |
752 | B<True>: de-iconify (map) on receipt of a bell character. B<False>: no |
859 | B<True>: de-iconify (map) on receipt of a bell character. B<False>: no |
753 | de-iconify (map) on receipt of a bell character [default]. |
860 | de-iconify (map) on receipt of a bell character [default]. |
754 | |
861 | |
|
|
862 | =item B<urgentOnBell:> I<boolean> |
|
|
863 | |
|
|
864 | B<True>: set the urgency hint for the wm on receipt of a bell character. |
|
|
865 | B<False>: do not set the urgency hint [default]. |
|
|
866 | |
|
|
867 | @@RXVT_NAME@@ resets the urgency hint on every focus change. |
|
|
868 | |
755 | =item B<visualBell:> I<boolean> |
869 | =item B<visualBell:> I<boolean> |
756 | |
870 | |
757 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
871 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
758 | B<False>: no visual bell [default]; option B<+vb>. |
872 | B<False>: no visual bell [default]; option B<+vb>. |
759 | |
873 | |
… | |
… | |
780 | Example: |
894 | Example: |
781 | |
895 | |
782 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
896 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
783 | |
897 | |
784 | This creates a new file in your home directory with the screen contents |
898 | This creates a new file in your home directory with the screen contents |
785 | everytime you hit C<Print>. |
899 | every time you hit C<Print>. |
|
|
900 | |
|
|
901 | =item B<scrollstyle:> I<mode> |
|
|
902 | |
|
|
903 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
|
|
904 | the author's favourite. |
786 | |
905 | |
787 | =item B<scrollBar:> I<boolean> |
906 | =item B<scrollBar:> I<boolean> |
788 | |
907 | |
789 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
908 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
790 | disable the scrollbar; option B<+sb>. |
909 | disable the scrollbar; option B<+sb>. |
… | |
… | |
812 | |
931 | |
813 | =item B<scrollWithBuffer:> I<boolean> |
932 | =item B<scrollWithBuffer:> I<boolean> |
814 | |
933 | |
815 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
934 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
816 | B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll |
935 | B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll |
817 | with scrollback buffer when tty recieves new lines; option B<+sw>. |
936 | with scrollback buffer when tty receives new lines; option B<+sw>. |
818 | |
937 | |
819 | =item B<scrollTtyKeypress:> I<boolean> |
938 | =item B<scrollTtyKeypress:> I<boolean> |
820 | |
939 | |
821 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
940 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
822 | are those which are intercepted by rxvt-unicode for special handling and |
941 | are those which are intercepted by rxvt-unicode for special handling and |
… | |
… | |
853 | =item B<termName:> I<termname> |
972 | =item B<termName:> I<termname> |
854 | |
973 | |
855 | Specifies the terminal type name to be set in the B<TERM> environment |
974 | Specifies the terminal type name to be set in the B<TERM> environment |
856 | variable; option B<-tn>. |
975 | variable; option B<-tn>. |
857 | |
976 | |
858 | =item B<linespace:> I<number> |
977 | =item B<lineSpace:> I<number> |
859 | |
978 | |
860 | Specifies number of lines (pixel height) to insert between each row of |
979 | Specifies number of lines (pixel height) to insert between each row of |
861 | the display [default 0]; option B<-lsp>. |
980 | the display [default 0]; option B<-lsp>. |
862 | |
981 | |
863 | =item B<meta8:> I<boolean> |
982 | =item B<meta8:> I<boolean> |
… | |
… | |
915 | =item B<cutchars:> I<string> |
1034 | =item B<cutchars:> I<string> |
916 | |
1035 | |
917 | The characters used as delimiters for double-click word selection |
1036 | The characters used as delimiters for double-click word selection |
918 | (whitespace delimiting is added automatically if resource is given). |
1037 | (whitespace delimiting is added automatically if resource is given). |
919 | |
1038 | |
920 | When the selection extension is in use (the default if compiled in, see |
1039 | When the perl selection extension is in use (the default if compiled |
921 | the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters |
1040 | in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these |
922 | will be created (if the resource exists, otherwise, no regex will be |
1041 | characters will be created (if the resource exists, otherwise, no regex |
923 | created). In this mode, characters outside ISO-8859-1 can be used. |
1042 | will be created). In this mode, characters outside ISO-8859-1 can be used. |
924 | |
1043 | |
925 | When the selection extension is not used, only ISO-8859-1 characters can |
1044 | When the selection extension is not used, only ISO-8859-1 characters can |
926 | be used. If not specified, the built-in default is used: |
1045 | be used. If not specified, the built-in default is used: |
927 | |
1046 | |
928 | B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> |
1047 | B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >> |
929 | |
1048 | |
930 | =item B<preeditType:> I<style> |
1049 | =item B<preeditType:> I<style> |
931 | |
1050 | |
932 | B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. |
1051 | B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. |
933 | |
1052 | |
… | |
… | |
987 | |
1106 | |
988 | Turn on/off secondary screen (default enabled). |
1107 | Turn on/off secondary screen (default enabled). |
989 | |
1108 | |
990 | =item B<secondaryScroll:> I<boolean> |
1109 | =item B<secondaryScroll:> I<boolean> |
991 | |
1110 | |
992 | Turn on/off secondary screen scroll (default enabled). If the this |
1111 | Turn on/off secondary screen scroll (default enabled). If this |
993 | option is enabled, scrolls on the secondary screen will change the |
1112 | option is enabled, scrolls on the secondary screen will change the |
994 | scrollback buffer and switching to/from the secondary screen will |
1113 | scrollback buffer and, when secondaryScreen is off, switching |
995 | instead scroll the screen up. |
1114 | to/from the secondary screen will instead scroll the screen up. |
996 | |
1115 | |
997 | =item B<hold>: I<boolean> |
1116 | =item B<hold>: I<boolean> |
998 | |
1117 | |
999 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
1118 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
1000 | will not immediately destroy its window when the program executed within |
1119 | will not immediately destroy its window when the program executed within |
1001 | it exits. Instead, it will wait till it is being killed or closed by the |
1120 | it exits. Instead, it will wait till it is being killed or closed by the |
1002 | user. |
1121 | user. |
|
|
1122 | |
|
|
1123 | =item B<chdir>: I<path> |
|
|
1124 | |
|
|
1125 | Sets the working directory for the shell (or the command specified via |
|
|
1126 | B<-e>). The I<path> must be an absolute path and it must exist for |
|
|
1127 | @@RXVT_NAME@@ to start. If it isn't specified then the current working |
|
|
1128 | directory will be used; option B<-cd>. |
1003 | |
1129 | |
1004 | =item B<keysym.>I<sym>: I<string> |
1130 | =item B<keysym.>I<sym>: I<string> |
1005 | |
1131 | |
1006 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
1132 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
1007 | intervening resource name B<keysym.> cannot be omitted. |
1133 | intervening resource name B<keysym.> cannot be omitted. |
… | |
… | |
1021 | searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and |
1147 | searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and |
1022 | omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex |
1148 | omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex |
1023 | keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not |
1149 | keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not |
1024 | performed in an exact manner; however, the closest match is assured. |
1150 | performed in an exact manner; however, the closest match is assured. |
1025 | |
1151 | |
1026 | I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, |
1152 | I<string> may contain escape values (C<\n>: newline, C<\000>: octal |
1027 | C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, |
1153 | number), see RESOURCES in C<man 7 X> for futher details. |
1028 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
|
|
1029 | C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it |
|
|
1030 | can start or end with whitespace. |
|
|
1031 | |
|
|
1032 | Please note that you need to double the C<\> in resource files, as |
|
|
1033 | Xlib itself does it's own de-escaping (you can use C<\033> instead of |
|
|
1034 | C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own |
|
|
1035 | processing). |
|
|
1036 | |
1154 | |
1037 | You can define a range of keysyms in one shot by providing a I<string> |
1155 | You can define a range of keysyms in one shot by providing a I<string> |
1038 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' |
1156 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' |
1039 | should be a character not used by the strings. |
1157 | should be a character not used by the strings. |
1040 | |
1158 | |
1041 | Its usage can be demonstrated by an example: |
1159 | Its usage can be demonstrated by an example: |
1042 | |
1160 | |
1043 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
1161 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
… | |
… | |
1107 | example, C<default,-selection> will use all the default extension except |
1225 | example, C<default,-selection> will use all the default extension except |
1108 | C<selection>. |
1226 | C<selection>. |
1109 | |
1227 | |
1110 | Extension names can also be followed by an argument in angle brackets |
1228 | Extension names can also be followed by an argument in angle brackets |
1111 | (e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for |
1229 | (e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for |
1112 | searchable scorllback to Alt/Meta-s). Mentioning the same extension |
1230 | searchable scrollback to Alt/Meta-s). Mentioning the same extension |
1113 | multiple times with different arguments will pass multiple arguments to |
1231 | multiple times with different arguments will pass multiple arguments to |
1114 | the extension. |
1232 | the extension. |
1115 | |
1233 | |
1116 | Each extension is looked up in the library directories, loaded if |
1234 | Each extension is looked up in the library directories, loaded if |
1117 | necessary, and bound to the current terminal instance. |
1235 | necessary, and bound to the current terminal instance. |
… | |
… | |
1122 | all instances, while B<perl-ext> is used for specific instances. |
1240 | all instances, while B<perl-ext> is used for specific instances. |
1123 | |
1241 | |
1124 | =item B<perl-eval>: I<string> |
1242 | =item B<perl-eval>: I<string> |
1125 | |
1243 | |
1126 | Perl code to be evaluated when all extensions have been registered. See |
1244 | Perl code to be evaluated when all extensions have been registered. See |
1127 | the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource |
1245 | the @@RXVT_NAME@@perl(3) manpage. |
1128 | will be ignored when running setuid/setgid. |
|
|
1129 | |
1246 | |
1130 | =item B<perl-lib>: I<path> |
1247 | =item B<perl-lib>: I<path> |
1131 | |
1248 | |
1132 | Colon-separated list of additional directories that hold extension |
1249 | Colon-separated list of additional directories that hold extension |
1133 | scripts. When looking for extensions specified by the C<perl> resource, |
1250 | scripts. When looking for extensions specified by the C<perl> resource, |
1134 | @@RXVT_NAME@@ will first look in these directories and then in |
1251 | @@RXVT_NAME@@ will first look in these directories and then in |
1135 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource |
1252 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. |
1136 | will be ignored when running setuid/setgid. |
|
|
1137 | |
1253 | |
1138 | See the @@RXVT_NAME@@perl(3) manpage. |
1254 | See the @@RXVT_NAME@@perl(3) manpage. |
1139 | |
1255 | |
1140 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1256 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1141 | |
1257 | |
… | |
… | |
1153 | (default: C<M-s>). |
1269 | (default: C<M-s>). |
1154 | |
1270 | |
1155 | =item B<urlLauncher>: I<string> |
1271 | =item B<urlLauncher>: I<string> |
1156 | |
1272 | |
1157 | Specifies the program to be started with a URL argument. Used by the |
1273 | Specifies the program to be started with a URL argument. Used by the |
1158 | C<selection-popup> and C<mark-urls> perl extensions. |
1274 | C<selection-popup> and C<matcher> perl extensions. |
1159 | |
1275 | |
1160 | =item B<transient-for>: I<windowid> |
1276 | =item B<transient-for>: I<windowid> |
1161 | |
1277 | |
1162 | Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. |
1278 | Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. |
1163 | |
1279 | |
1164 | =item B<override-redirect>: I<boolean> |
1280 | =item B<override-redirect>: I<boolean> |
1165 | |
1281 | |
1166 | Compile I<frills>: Sets override-redirect for the terminal window, making |
1282 | Compile I<frills>: Sets override-redirect for the terminal window, making |
1167 | it almost invisible to window managers; option B<-override-redirect>. |
1283 | it almost invisible to window managers; option B<-override-redirect>. |
|
|
1284 | |
|
|
1285 | =item B<iso14755_52:> I<boolean> |
|
|
1286 | |
|
|
1287 | Turn on/off ISO 14755 5.2 mode (default enabled). |
1168 | |
1288 | |
1169 | =back |
1289 | =back |
1170 | |
1290 | |
1171 | =head1 THE SCROLLBAR |
1291 | =head1 THE SCROLLBAR |
1172 | |
1292 | |
… | |
… | |
1191 | application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> |
1311 | application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> |
1192 | (Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the |
1312 | (Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the |
1193 | up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), |
1313 | up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), |
1194 | respectively. |
1314 | respectively. |
1195 | |
1315 | |
1196 | =head1 TEXT SELECTION AND INSERTION |
1316 | =head1 THE SELECTION: SELECTING AND PASTING TEXT |
1197 | |
1317 | |
1198 | The behaviour of text selection and insertion mechanism is similar to |
1318 | The behaviour of text selection and insertion/pasting mechanism is similar |
1199 | I<xterm>(1). |
1319 | to I<xterm>(1). |
1200 | |
1320 | |
1201 | =over 4 |
1321 | =over 4 |
1202 | |
1322 | |
1203 | =item B<Selection>: |
1323 | =item B<Selecting>: |
1204 | |
1324 | |
1205 | Left click at the beginning of the region, drag to the end of the region |
1325 | Left click at the beginning of the region, drag to the end of the region |
1206 | and release; Right click to extend the marked region; Left double-click |
1326 | and release; Right click to extend the marked region; Left double-click |
1207 | to select a word; Left triple-click to select the entire logical line |
1327 | to select a word; Left triple-click to select the entire logical line |
1208 | (which can span multiple screen lines), unless modified by resource |
1328 | (which can span multiple screen lines), unless modified by resource |
… | |
… | |
1212 | (Compile: I<frills>) will create a rectangular selection instead of a |
1332 | (Compile: I<frills>) will create a rectangular selection instead of a |
1213 | normal one. In this mode, every selected row becomes its own line in the |
1333 | normal one. In this mode, every selected row becomes its own line in the |
1214 | selection, and trailing whitespace is visually underlined and removed from |
1334 | selection, and trailing whitespace is visually underlined and removed from |
1215 | the selection. |
1335 | the selection. |
1216 | |
1336 | |
1217 | =item B<Insertion>: |
1337 | =item B<Pasting>: |
1218 | |
1338 | |
1219 | Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> |
1339 | Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> |
1220 | window causes the value of the PRIMARY selection (or CLIPBOARD with the |
1340 | window causes the value of the PRIMARY selection (or CLIPBOARD with the |
1221 | Meta modifier) to be inserted as if it had been typed on the keyboard. |
1341 | B<Meta> modifier) to be inserted as if it had been typed on the keyboard. |
1222 | |
1342 | |
1223 | Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be |
1343 | Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be |
1224 | inserted too. |
1344 | inserted too. |
1225 | |
1345 | |
1226 | =back |
1346 | =back |
… | |
… | |
1243 | |
1363 | |
1244 | =head1 ISO 14755 SUPPORT |
1364 | =head1 ISO 14755 SUPPORT |
1245 | |
1365 | |
1246 | ISO 14755 is a standard for entering and viewing unicode characters |
1366 | ISO 14755 is a standard for entering and viewing unicode characters |
1247 | and character codes using the keyboard. It consists of 4 parts. The |
1367 | and character codes using the keyboard. It consists of 4 parts. The |
1248 | first part is available rxvt-unicode has been compiled with |
1368 | first part is available if rxvt-unicode has been compiled with |
1249 | C<--enable-frills>, the rest is available when rxvt-unicode was compiled |
1369 | C<--enable-frills>, the rest is available when rxvt-unicode was compiled |
1250 | with C<--enable-iso14755>. |
1370 | with C<--enable-iso14755>. |
1251 | |
1371 | |
1252 | =over 4 |
1372 | =over 4 |
1253 | |
1373 | |
… | |
… | |
1273 | This mode lets you input characters representing the keycap symbols of |
1393 | This mode lets you input characters representing the keycap symbols of |
1274 | your keyboard, if representable in the current locale encoding. |
1394 | your keyboard, if representable in the current locale encoding. |
1275 | |
1395 | |
1276 | Start by pressing C<Control> and C<Shift> together, then releasing |
1396 | Start by pressing C<Control> and C<Shift> together, then releasing |
1277 | them. The next special key (cursor keys, home etc.) you enter will not |
1397 | them. The next special key (cursor keys, home etc.) you enter will not |
1278 | invoke it's usual function but instead will insert the corresponding |
1398 | invoke its usual function but instead will insert the corresponding |
1279 | keycap symbol. The symbol will only be entered when the key has been |
1399 | keycap symbol. The symbol will only be entered when the key has been |
1280 | released, otherwise pressing e.g. C<Shift> would enter the symbol for |
1400 | released, otherwise pressing e.g. C<Shift> would enter the symbol for |
1281 | C<ISO Level 2 Switch>, although your intention might have been to enter a |
1401 | C<ISO Level 2 Switch>, although your intention might have been to enter a |
1282 | reverse tab (Shift-Tab). |
1402 | reverse tab (Shift-Tab). |
1283 | |
1403 | |
… | |
… | |
1372 | =back |
1492 | =back |
1373 | |
1493 | |
1374 | =head2 ALPHA CHANNEL SUPPORT |
1494 | =head2 ALPHA CHANNEL SUPPORT |
1375 | |
1495 | |
1376 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1496 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1377 | their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> |
1497 | their act together, rxvt-unicode will do it's own alpha channel management: |
1378 | (recommended, but B<MUST> have 4 digits/component) colour specifications, |
1498 | |
1379 | in addition to the ones provided by X, where the additional A component |
1499 | You can prefix any color with an opaquenes percentage enclosed in |
|
|
1500 | brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage |
|
|
1501 | (0-100) that specifies the opacity of the color, where C<0> is completely |
|
|
1502 | transparent and C<100> is completely opaque. For example, C<[50]red> is a |
|
|
1503 | half-transparent red, while C<[95]#00ff00> is an almost opaque green. This |
|
|
1504 | is the recommended format to specify transparency values, and works with |
|
|
1505 | all ways to specify a colour. |
|
|
1506 | |
|
|
1507 | For complete control, rxvt-unicode also supports |
|
|
1508 | C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour |
|
|
1509 | specifications, where the additional C<aaaa> component specifies opacity |
1380 | specifies opacity (alpha) values. The minimum value of C<0> is completely |
1510 | (alpha) values. The minimum value of C<0000> is completely transparent, |
1381 | transparent). You can also prefix any color with C<[a]>, where C<a> is on |
1511 | while C<ffff> is completely opaque). The two example colours from |
1382 | to four hex digits specifiying the opacity value. |
1512 | earlier could also be specified as C<rgba:ff00/0000/0000/8000> and |
|
|
1513 | C<rgba:0000/ff00/0000/f332>. |
1383 | |
1514 | |
1384 | You probably need to specify B<"-depth 32">, too, and have the luck that |
1515 | You probably need to specify B<"-depth 32">, too, to force a visual with |
1385 | your X-server uses ARGB pixel layout, as X is far from just supporting |
1516 | alpha channels, and have the luck that your X-server uses ARGB pixel |
1386 | ARGB visuals out of the box, and rxvt-unicode just fudges around. |
1517 | layout, as X is far from just supporting ARGB visuals out of the box, and |
|
|
1518 | rxvt-unicode just fudges around. |
1387 | |
1519 | |
1388 | For example, the following selects an almost completely transparent red |
1520 | For example, the following selects an almost completely transparent black |
1389 | background, and an almost opaque pink foreground: |
1521 | background, and an almost opaque pink foreground: |
1390 | |
1522 | |
1391 | @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink" |
1523 | @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink" |
1392 | |
1524 | |
1393 | I<Please note that transparency of any kind if completely unsupported by |
1525 | When not using a background image, then the interpretation of the |
1394 | the author. Don't bug him with installation questions!> |
1526 | alpha channel is up to your compositing manager (most interpret it as |
|
|
1527 | transparency of course). |
|
|
1528 | |
|
|
1529 | When using a background pixmap or pseudo-transparency, then the background |
|
|
1530 | colour will always behave as if it were completely transparent (so the |
|
|
1531 | background image shows instead), regardless of how it was specified, while |
|
|
1532 | other colours will either be transparent as specified (the background |
|
|
1533 | image will show through) on servers supporting the RENDER extension, or |
|
|
1534 | fully opaque on servers not supporting the RENDER EXTENSION. |
|
|
1535 | |
|
|
1536 | Please note that due to bugs in Xft, specifying alpha values might result |
|
|
1537 | in garbage being displayed when the X-server does not support the RENDER |
|
|
1538 | extension. |
1395 | |
1539 | |
1396 | =head1 ENVIRONMENT |
1540 | =head1 ENVIRONMENT |
1397 | |
1541 | |
1398 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1542 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1399 | |
1543 | |
1400 | =over 4 |
1544 | =over 4 |
1401 | |
1545 | |
1402 | =item B<TERM> |
1546 | =item B<TERM> |
1403 | |
1547 | |
1404 | Normally set to C<rxvt-unicode>, unless overwritten at configure time, via |
1548 | Normally set to C<rxvt-unicode>, unless overwritten at configure time, via |
1405 | resources or on the commandline. |
1549 | resources or on the command line. |
1406 | |
1550 | |
1407 | =item B<COLORTERM> |
1551 | =item B<COLORTERM> |
1408 | |
1552 | |
1409 | Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was |
1553 | Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was |
1410 | compiled with XPM support, and optionally with the added extension |
1554 | compiled with background image support, and optionally with the added |
1411 | C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. |
1555 | extension C<-mono> to indicate that rxvt-unicode runs on a monochrome |
|
|
1556 | screen. |
1412 | |
1557 | |
1413 | =item B<COLORFGBG> |
1558 | =item B<COLORFGBG> |
1414 | |
1559 | |
1415 | Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is |
1560 | Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is |
1416 | the colour code used as default foreground/text colour (or the string |
1561 | the colour code used as default foreground/text colour (or the string |
1417 | C<default> to indicate that the default-colour escape sequence is to be |
1562 | C<default> to indicate that the default-colour escape sequence is to be |
1418 | used), C<bg> is the colour code used as default background colour (or the |
1563 | used), C<bg> is the colour code used as default background colour (or the |
1419 | string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ |
1564 | string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ |
1420 | was compiled with XPM support. Libraries like C<ncurses> and C<slang> can |
1565 | was compiled with background image support. Libraries like C<ncurses> |
1421 | (and do) use this information to optimize screen output. |
1566 | and C<slang> can (and do) use this information to optimize screen output. |
1422 | |
1567 | |
1423 | =item B<WINDOWID> |
1568 | =item B<WINDOWID> |
1424 | |
1569 | |
1425 | Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel |
1570 | Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel |
1426 | window, which usually has subwindows for the scrollbar, the terminal |
1571 | window, which usually has subwindows for the scrollbar, the terminal |
… | |
… | |
1432 | C<--with-terminfo=PATH>. |
1577 | C<--with-terminfo=PATH>. |
1433 | |
1578 | |
1434 | =item B<DISPLAY> |
1579 | =item B<DISPLAY> |
1435 | |
1580 | |
1436 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1581 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1437 | display in it's child processes. |
1582 | display in its child processes if C<-display> isn't used to override. It |
|
|
1583 | defaults to C<:0> if it doesn't exist. |
1438 | |
1584 | |
1439 | =item B<SHELL> |
1585 | =item B<SHELL> |
1440 | |
1586 | |
1441 | The shell to be used for command execution, defaults to C</bin/sh>. |
1587 | The shell to be used for command execution, defaults to C</bin/sh>. |
1442 | |
1588 | |
… | |
… | |
1517 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1663 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1518 | |
1664 | |
1519 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1665 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1520 | |
1666 | |
1521 | Rewrote screen display and text selection routines. |
1667 | Rewrote screen display and text selection routines. |
1522 | |
1668 | |
1523 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1669 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1524 | |
1670 | |
1525 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1671 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1526 | |
1672 | |
1527 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |
1673 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |