… | |
… | |
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 | =head1 FREQUENTLY ASKED QUESTIONS |
17 | =head1 FREQUENTLY ASKED QUESTIONS |
18 | |
18 | |
19 | See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of frequently |
19 | See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of |
20 | asked questions and answer to them and some common problems. |
20 | frequently asked questions and answer to them and some common |
|
|
21 | 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>. |
21 | |
23 | |
22 | =head1 RXVT-UNICODE VS. RXVT |
24 | =head1 RXVT-UNICODE VS. RXVT |
23 | |
25 | |
24 | Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode |
26 | Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode |
25 | internally. That means it can store and display most scripts in the |
27 | internally. That means it can store and display most scripts in the |
26 | world. Being a terminal emulator, however, some things are very difficult, |
28 | world. Being a terminal emulator, however, some things are very difficult, |
27 | especially cursive scripts such as arabic, vertically written scripts |
29 | especially cursive scripts such as arabic, vertically written scripts |
28 | like mongolian or scripts requiring extremely complex combining rules, |
30 | like mongolian or scripts requiring extremely complex combining rules, |
29 | like tibetan or devenagari. Don't expect pretty output when using these |
31 | like tibetan or devanagari. Don't expect pretty output when using these |
30 | scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work |
32 | scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work |
31 | fine, though. A somewhat difficult case are left-to-right scripts, such |
33 | fine, though. A somewhat difficult case are right-to-left scripts, such |
32 | as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms |
34 | as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms |
33 | belong into the application, not the terminal emulator (too many things -- |
35 | belong into the application, not the terminal emulator (too many things -- |
34 | such as cursor-movement while editing -- break otherwise), but that might |
36 | such as cursor-movement while editing -- break otherwise), but that might |
35 | change. |
37 | change. |
36 | |
38 | |
37 | If you are looking for a terminal that supports more exotic scripts, let |
39 | If you are looking for a terminal that supports more exotic scripts, let |
38 | me recommend C<mlterm>, which is a very userfriendly, lean and clean |
40 | me recommend C<mlterm>, which is a very user friendly, lean and clean |
39 | terminal emulator. In fact, the reason rxvt-unicode was born was solely |
41 | terminal emulator. In fact, the reason rxvt-unicode was born was solely |
40 | because the author couldn't get C<mlterm> to use one font for latin1 and |
42 | because the author couldn't get C<mlterm> to use one font for latin1 and |
41 | another for japanese. |
43 | another for japanese. |
42 | |
44 | |
43 | Therefore another design rationale was the use of multiple fonts to |
45 | Therefore another design rationale was the use of multiple fonts to |
44 | display characters: The idea of a single unicode font which many other |
46 | display characters: The idea of a single unicode font which many other |
45 | programs force onto it's users never made sense to me: You should be able |
47 | programs force onto its users never made sense to me: You should be able |
46 | to choose any font for any script freely. |
48 | to choose any font for any script freely. |
47 | |
49 | |
48 | Apart from that, rxvt-unicode is also much better internationalised than |
50 | Apart from that, rxvt-unicode is also much better internationalised than |
49 | it's predecessor, supports things such as XFT and ISO 14755 that are handy |
51 | its predecessor, supports things such as XFT and ISO 14755 that are handy |
50 | in i18n-environments, is faster, and has a lot less bugs than the original |
52 | in i18n-environments, is faster, and has a lot bugs less than the original |
51 | rxvt. This all in addition to dozens of other small improvements. |
53 | rxvt. This all in addition to dozens of other small improvements. |
52 | |
54 | |
53 | It is still faithfully following the original rxvt idea of being lean |
55 | It is still faithfully following the original rxvt idea of being lean |
54 | and nice on resources: for example, you can still configure rxvt-unicode |
56 | and nice on resources: for example, you can still configure rxvt-unicode |
55 | without most of it's features to get a lean binary. It also comes with |
57 | without most of its features to get a lean binary. It also comes with |
56 | a client/daemon pair that lets you open any number of terminal windows |
58 | a client/daemon pair that lets you open any number of terminal windows |
57 | from within a single process, which makes startup time very fast and |
59 | from within a single process, which makes startup time very fast and |
58 | drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and |
60 | drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and |
59 | @@RXVT_NAME@@c(1) (client). |
61 | @@RXVT_NAME@@c(1) (client). |
60 | |
62 | |
61 | It also makes technical information about escape sequences (which have |
63 | It also makes technical information about escape sequences (which have |
62 | been extended) easier accessible: see @@RXVT_NAME@@(7) for technical |
64 | been extended) more accessible: see @@RXVT_NAME@@(7) for technical |
63 | reference documentation (escape sequences etc.). |
65 | reference documentation (escape sequences etc.). |
64 | |
66 | |
65 | =head1 OPTIONS |
67 | =head1 OPTIONS |
66 | |
68 | |
67 | The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed |
69 | The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed |
… | |
… | |
91 | |
93 | |
92 | Attempt to open a window on the named X display (B<-d> still |
94 | Attempt to open a window on the named X display (B<-d> still |
93 | respected). In the absence of this option, the display specified by the |
95 | respected). In the absence of this option, the display specified by the |
94 | B<DISPLAY> environment variable is used. |
96 | B<DISPLAY> environment variable is used. |
95 | |
97 | |
|
|
98 | =item B<-depth> I<bitdepth> |
|
|
99 | |
|
|
100 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
|
|
101 | resource B<depth>. |
|
|
102 | |
96 | =item B<-geometry> I<geom> |
103 | =item B<-geometry> I<geom> |
97 | |
104 | |
98 | Window geometry (B<-g> still respected); resource B<geometry>. |
105 | Window geometry (B<-g> still respected); resource B<geometry>. |
99 | |
106 | |
100 | =item B<-rv>|B<+rv> |
107 | =item B<-rv>|B<+rv> |
101 | |
108 | |
102 | Turn on/off simulated reverse video; resource B<reverseVideo>. |
109 | Turn on/off simulated reverse video; resource B<reverseVideo>. |
103 | |
110 | |
104 | =item B<-j>|B<+j> |
111 | =item B<-j>|B<+j> |
105 | |
112 | |
106 | Turn on/off jump scrolling; resource B<jumpScroll>. |
113 | Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. |
107 | |
114 | |
108 | =item B<-ip>|B<+ip> |
115 | =item B<-ss>|B<+ss> |
|
|
116 | |
|
|
117 | Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. |
|
|
118 | |
|
|
119 | =item B<-ip>|B<+ip> | B<-tr>|B<+tr> |
109 | |
120 | |
110 | Turn on/off inheriting parent window's pixmap. Alternative form is |
121 | Turn on/off inheriting parent window's pixmap. Alternative form is |
111 | B<-tr>; resource B<inheritPixmap>. |
122 | B<-tr>; resource B<inheritPixmap>. |
112 | |
123 | |
|
|
124 | I<Please note that transparency of any kind if completely unsupported by |
|
|
125 | the author. Don't bug him with installation questions! Read the FAQ (man 7 |
|
|
126 | @@RXVT_NAME@@)!> |
|
|
127 | |
113 | =item B<-fade> I<number> |
128 | =item B<-fade> I<number> |
114 | |
129 | |
115 | Fade the text by the given percentage when focus is lost. resource B<fading>. |
130 | Fade the text by the given percentage when focus is lost. Small values |
|
|
131 | fade a little only, 100 completely replaces all colours by the fade |
|
|
132 | colour; resource B<fading>. |
|
|
133 | |
|
|
134 | =item B<-fadecolor> I<colour> |
|
|
135 | |
|
|
136 | Fade to this colour when fading is used (see B<-fade>). The default colour |
|
|
137 | is opaque black. resource B<fadeColor>. |
116 | |
138 | |
117 | =item B<-tint> I<colour> |
139 | =item B<-tint> I<colour> |
118 | |
140 | |
119 | Tint the transparent background pixmap with the given colour when |
141 | Tint the transparent background pixmap with the given colour when |
120 | transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> |
142 | transparency is enabled with B<-tr> or B<-ip>. This only works for |
|
|
143 | non-tiled backgrounds, currently. See also the B<-sh> option that can be |
121 | option that can be used to brighten or darken the image in addition to |
144 | used to brighten or darken the image in addition to tinting it. |
122 | tinting it. |
145 | Please note that certain tint colours can be applied on the server-side, |
|
|
146 | thus yielding performance gain of two orders of magnitude. These colours are: |
|
|
147 | blue, red, green, cyan, magenta, yellow, and those close to them; resource |
|
|
148 | I<tintColor>. Example: |
123 | |
149 | |
124 | =item B<-sh> |
150 | @@RXVT_NAME@@ -tr -tint blue -sh 40 |
125 | |
151 | |
|
|
152 | =item B<-sh> I<number> |
|
|
153 | |
126 | I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
154 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
127 | background image in addition to tinting it (i.e. B<-tint> must be |
155 | background image in addition to (or instead of) tinting it; |
128 | specified, too, e.g. C<-tint white>). |
156 | resource I<shading>. |
|
|
157 | |
|
|
158 | =item B<-blt> I<string> |
|
|
159 | |
|
|
160 | Specify background blending type. If background pixmap is specified |
|
|
161 | at the same time as transparency - such pixmap will be blended over |
|
|
162 | transparency image, using method specified. Supported values are : |
|
|
163 | B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>, |
|
|
164 | B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>, |
|
|
165 | B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is |
|
|
166 | alpha-blending; resource I<blendType>. |
|
|
167 | |
|
|
168 | =item B<-blr> I<HxV> |
|
|
169 | |
|
|
170 | Apply Gaussian Blur with the specified radii to the transparent |
|
|
171 | background image. If single number is specified - both vertical and |
|
|
172 | horizontal radii are considered to be the same. Setting one of the |
|
|
173 | radii to 1 and another to a large number creates interesting effects |
|
|
174 | on some backgrounds. Maximum radius value is 128; resource I<blurRadius>. |
129 | |
175 | |
130 | =item B<-bg> I<colour> |
176 | =item B<-bg> I<colour> |
131 | |
177 | |
132 | Window background colour; resource B<background>. |
178 | Window background colour; resource B<background>. |
133 | |
179 | |
… | |
… | |
135 | |
181 | |
136 | Window foreground colour; resource B<foreground>. |
182 | Window foreground colour; resource B<foreground>. |
137 | |
183 | |
138 | =item B<-pixmap> I<file[;geom]> |
184 | =item B<-pixmap> I<file[;geom]> |
139 | |
185 | |
140 | Compile I<XPM>: Specify XPM file for the background and also optionally |
186 | Compile I<afterimage>: Specify image file for the background and also |
141 | specify its scaling with a geometry string. Note you may need to |
187 | optionally specify its scaling with a geometry string. Note you may need to |
142 | add quotes to avoid special shell interpretation of the C<;> in the |
188 | add quotes to avoid special shell interpretation of the C<;> in the |
143 | command-line; resource B<backgroundPixmap>. |
189 | command-line; for more details see resource B<backgroundPixmap>. |
144 | |
190 | |
145 | =item B<-cr> I<colour> |
191 | =item B<-cr> I<colour> |
146 | |
192 | |
147 | The cursor colour; resource B<cursorColor>. |
193 | The cursor colour; resource B<cursorColor>. |
148 | |
194 | |
… | |
… | |
160 | resource B<borderColor>. |
206 | resource B<borderColor>. |
161 | |
207 | |
162 | =item B<-fn> I<fontlist> |
208 | =item B<-fn> I<fontlist> |
163 | |
209 | |
164 | Select the fonts to be used. This is a comma separated list of font names |
210 | Select the fonts to be used. This is a comma separated list of font names |
165 | that are used in turn when trying to display Unicode characters. The |
211 | that are checked in order when trying to find glyphs for characters. The |
166 | first font defines the cell size for characters; other fonts might be |
212 | first font defines the cell size for characters; other fonts might be |
167 | smaller, but not (in general) larger. A (hopefully) reasonable default |
213 | smaller, but not (in general) larger. A (hopefully) reasonable default |
168 | font list is always appended to it. See resource B<font> for more details. |
214 | font list is always appended to it. See resource B<font> for more details. |
169 | |
215 | |
170 | In short, to specify an X11 core font, just specify it's name or prefix it |
216 | In short, to specify an X11 core font, just specify its name or prefix it |
171 | with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, |
217 | with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, |
172 | e.g.: |
218 | e.g.: |
173 | |
219 | |
174 | @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
220 | @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
175 | @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
221 | @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
… | |
… | |
177 | See also the question "How does rxvt-unicode choose fonts?" in the FAQ |
223 | See also the question "How does rxvt-unicode choose fonts?" in the FAQ |
178 | section of @@RXVT_NAME@@(7). |
224 | section of @@RXVT_NAME@@(7). |
179 | |
225 | |
180 | =item B<-fb> I<fontlist> |
226 | =item B<-fb> I<fontlist> |
181 | |
227 | |
182 | Compile font-styles: The bold font list to use when bold characters are to |
228 | Compile I<font-styles>: The bold font list to use when B<bold> characters |
183 | be printed. See resource B<boldFont> for details. |
229 | are to be printed. See resource B<boldFont> for details. |
184 | |
230 | |
185 | =item B<-fi> I<fontlist> |
231 | =item B<-fi> I<fontlist> |
186 | |
232 | |
187 | Compile font-styles: The italic font list to use when bold characters are to |
233 | Compile I<font-styles>: The italic font list to use when I<italic> |
188 | be printed. See resource B<italicFont> for details. |
234 | characters are to be printed. See resource B<italicFont> for details. |
189 | |
235 | |
190 | =item B<-fbi> I<fontlist> |
236 | =item B<-fbi> I<fontlist> |
191 | |
237 | |
192 | Compile font-styles: The bold italic font list to use when bold characters are to |
238 | Compile I<font-styles>: The bold italic font list to use when B<< I<bold |
193 | be printed. See resource B<boldItalicFont> for details. |
239 | italic> >> characters are to be printed. See resource B<boldItalicFont> |
|
|
240 | for details. |
|
|
241 | |
|
|
242 | =item B<-is>|B<+is> |
|
|
243 | |
|
|
244 | Compile I<font-styles>: Bold/Italic font styles imply high intensity |
|
|
245 | foreground/background (default). See resource B<intensityStyles> for |
|
|
246 | details. |
194 | |
247 | |
195 | =item B<-name> I<name> |
248 | =item B<-name> I<name> |
196 | |
249 | |
197 | Specify the application name under which resources are to be obtained, |
250 | Specify the application name under which resources are to be obtained, |
198 | rather than the default executable file name. Name should not contain |
251 | rather than the default executable file name. Name should not contain |
… | |
… | |
236 | |
289 | |
237 | Put scrollbar on right/left; resource B<scrollBar_right>. |
290 | Put scrollbar on right/left; resource B<scrollBar_right>. |
238 | |
291 | |
239 | =item B<-st>|B<+st> |
292 | =item B<-st>|B<+st> |
240 | |
293 | |
241 | Display normal (non XTerm/NeXT) scrollbar without/with a trough; |
294 | Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; |
242 | resource B<scrollBar_floating>. |
295 | resource B<scrollBar_floating>. |
243 | |
296 | |
244 | =item B<-ptab>|B<+ptab> |
297 | =item B<-ptab>|B<+ptab> |
245 | |
298 | |
246 | If enabled (default), "Horizontal Tab" characters are being stored as |
299 | If enabled (default), "Horizontal Tab" characters are being stored as |
… | |
… | |
277 | =item B<-bl> |
330 | =item B<-bl> |
278 | |
331 | |
279 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
332 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
280 | if honoured by the WM, the rxvt-unicode window will not have window |
333 | if honoured by the WM, the rxvt-unicode window will not have window |
281 | decorations; resource B<borderLess>. |
334 | decorations; resource B<borderLess>. |
|
|
335 | |
|
|
336 | =item B<-override-redirect> |
|
|
337 | |
|
|
338 | Compile I<frills>: Sets override-redirect on the window; resource |
|
|
339 | B<override-redirect>. |
|
|
340 | |
|
|
341 | =item B<-sbg> |
|
|
342 | |
|
|
343 | Compile I<frills>: Disable the usage of the built-in block graphics/line |
|
|
344 | drawing characters and just rely on what the specified fonts provide. Use |
|
|
345 | this if you have a good font and want to use its block graphic glyphs; |
|
|
346 | resource B<skipBuiltinGlyphs>. |
282 | |
347 | |
283 | =item B<-lsp> I<number> |
348 | =item B<-lsp> I<number> |
284 | |
349 | |
285 | Compile I<frills>: Lines (pixel height) to insert between each row of |
350 | Compile I<frills>: Lines (pixel height) to insert between each row of |
286 | the display. Useful to work around font rendering problems; resource |
351 | the display. Useful to work around font rendering problems; resource |
… | |
… | |
301 | given on the command line. If this option is used, it must be the last |
366 | given on the command line. If this option is used, it must be the last |
302 | on the command-line. If there is no B<-e> option then the default is to |
367 | on the command-line. If there is no B<-e> option then the default is to |
303 | run the program specified by the B<SHELL> environment variable or, |
368 | run the program specified by the B<SHELL> environment variable or, |
304 | failing that, I<sh(1)>. |
369 | failing that, I<sh(1)>. |
305 | |
370 | |
|
|
371 | Please note that you must specify a program with arguments. If you want to |
|
|
372 | run shell commands, you have to specify the shell, like this: |
|
|
373 | |
|
|
374 | @@RXVT_NAME@@ -e sh -c "shell commands" |
|
|
375 | |
306 | =item B<-title> I<text> |
376 | =item B<-title> I<text> |
307 | |
377 | |
308 | Window title (B<-T> still respected); the default title is the basename |
378 | Window title (B<-T> still respected); the default title is the basename |
309 | of the program specified after the B<-e> option, if any, otherwise the |
379 | of the program specified after the B<-e> option, if any, otherwise the |
310 | application name; resource B<title>. |
380 | application name; resource B<title>. |
… | |
… | |
341 | for more info. |
411 | for more info. |
342 | |
412 | |
343 | =item B<-tcw> |
413 | =item B<-tcw> |
344 | |
414 | |
345 | Change the meaning of triple-click selection with the left mouse |
415 | Change the meaning of triple-click selection with the left mouse |
|
|
416 | button. Only effective when the original (non-perl) selection code is |
346 | button. Instead of selecting a full line it will extend the selection the |
417 | in-use. Instead of selecting a full line it will extend the selection the |
347 | end of the logical line only. resource B<tripleclickwords>. |
418 | end of the logical line only. resource B<tripleclickwords>. |
348 | |
419 | |
349 | =item B<-insecure> |
420 | =item B<-insecure> |
350 | |
421 | |
351 | Enable "insecure" mode, which currently enables most of the escape |
422 | Enable "insecure" mode, which currently enables most of the escape |
… | |
… | |
366 | =item B<-ssr>|B<+ssr> |
437 | =item B<-ssr>|B<+ssr> |
367 | |
438 | |
368 | Turn on/off secondary screen scroll (default enabled); resource |
439 | Turn on/off secondary screen scroll (default enabled); resource |
369 | B<secondaryScroll>. |
440 | B<secondaryScroll>. |
370 | |
441 | |
|
|
442 | =item B<-hold>|B<+hold> |
|
|
443 | |
|
|
444 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
|
|
445 | will not immediately destroy its window when the program executed within |
|
|
446 | it exits. Instead, it will wait till it is being killed or closed by the |
|
|
447 | user; resource B<hold>. |
|
|
448 | |
|
|
449 | =item B<-keysym.>I<sym> I<string> |
|
|
450 | |
|
|
451 | Remap a key symbol. See resource B<keysym>. |
|
|
452 | |
|
|
453 | =item B<-embed> I<windowid> |
|
|
454 | |
|
|
455 | Tells @@RXVT_NAME@@ to embed its windows into an already-existing window, |
|
|
456 | which enables applications to easily embed a terminal. |
|
|
457 | |
|
|
458 | Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it |
|
|
459 | shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it |
|
|
460 | quite a bit, so don't expect it to keep some specific state. It's best to |
|
|
461 | create an extra subwindow for @@RXVT_NAME@@ and leave it alone. |
|
|
462 | |
|
|
463 | The window will not be destroyed when @@RXVT_NAME@@ exits. |
|
|
464 | |
|
|
465 | It might be useful to know that @@RXVT_NAME@@ will not close file |
|
|
466 | descriptors passed to it (except for stdin/out/err, of course), so you |
|
|
467 | can use file descriptors to communicate with the programs within the |
|
|
468 | terminal. This works regardless of whether the C<-embed> option was used or |
|
|
469 | not. |
|
|
470 | |
|
|
471 | Here is a short Gtk2-perl snippet that illustrates how this option can be |
|
|
472 | used (a longer example is in F<doc/embed>): |
|
|
473 | |
|
|
474 | my $rxvt = new Gtk2::Socket; |
|
|
475 | $rxvt->signal_connect_after (realize => sub { |
|
|
476 | my $xid = $_[0]->window->get_xid; |
|
|
477 | system "@@RXVT_NAME@@ -embed $xid &"; |
|
|
478 | }); |
|
|
479 | |
|
|
480 | =item B<-pty-fd> I<file descriptor> |
|
|
481 | |
|
|
482 | Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty |
|
|
483 | pair but instead use the given file descriptor as the tty master. This is |
|
|
484 | useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
|
|
485 | without having to run a program within it. |
|
|
486 | |
|
|
487 | If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
|
|
488 | entries and will not tinker with pty/tty permissions - you have to do that |
|
|
489 | yourself if you want that. |
|
|
490 | |
|
|
491 | As an extremely special case, specifying C<-1> will completely suppress |
|
|
492 | pty/tty operations. |
|
|
493 | |
|
|
494 | Here is a example in perl that illustrates how this option can be used (a |
|
|
495 | longer example is in F<doc/pty-fd>): |
|
|
496 | |
|
|
497 | use IO::Pty; |
|
|
498 | use Fcntl; |
|
|
499 | |
|
|
500 | my $pty = new IO::Pty; |
|
|
501 | fcntl $pty, F_SETFD, 0; # clear close-on-exec |
|
|
502 | system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&"; |
|
|
503 | close $pty; |
|
|
504 | |
|
|
505 | # now communicate with rxvt |
|
|
506 | my $slave = $pty->slave; |
|
|
507 | while (<$slave>) { print $slave "got <$_>\n" } |
|
|
508 | |
371 | =item B<-xrm> I<resourcestring> |
509 | =item B<-pe> I<string> |
372 | |
510 | |
373 | No effect on rxvt-unicode. Simply passes through an argument to be made |
511 | Comma-separated list of perl extension scripts to use (or not to use) in |
374 | available in the instance's argument list. Appears in I<WM_COMMAND> in |
512 | this terminal instance. See resource B<perl-ext> for details. |
375 | some window managers. |
|
|
376 | |
513 | |
377 | =back |
514 | =back |
378 | |
515 | |
379 | =head1 RESOURCES (available also as long-options) |
516 | =head1 RESOURCES (available also as long-options) |
380 | |
517 | |
381 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
518 | Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
382 | options) compiled into your version. |
519 | options) compiled into your version. |
383 | |
520 | |
384 | There are two different methods that @@RXVT_NAME@@ can use to get the |
521 | You can set and change the resources using X11 tools like B<xrdb>. Many |
385 | Xresource data: using the X libraries (Xrm*-functions) or internal |
522 | distribution do also load settings from the B<~/.Xresources> file when X |
386 | Xresources reader (B<~/.Xdefaults>). For the first method (ie. |
523 | starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
387 | B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the |
524 | with later settings overwriting earlier ones: |
388 | resources using X11 tools like B<xset>. Many distribution do also load |
|
|
389 | settings from the B<~/.Xresources> file when X starts. |
|
|
390 | |
525 | |
391 | If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> |
526 | 1. system-wide app-defaults file, either locale-dependent OR global |
392 | lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults |
527 | 2. app-defaults file in $XAPPLRESDIR |
393 | set in XAPPLOADDIR/URxvt (compile-time defined: usually |
528 | 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
394 | B</usr/lib/X11/app-defaults/URxvt>) and resources set in |
529 | 4. SCREEN_RESOURCES for the current screen |
395 | B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist. |
530 | 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
|
|
531 | |
396 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two |
532 | Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
397 | class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows |
533 | names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
398 | resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be |
534 | common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily |
399 | easily configured, while the class name B<URxvt> allows resources |
535 | configured, while the class name B<URxvt> allows resources unique to |
400 | unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be |
536 | B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@> |
401 | shared between different B<@@RXVT_NAME@@> configurations. If no |
537 | configurations. If no resources are specified, suitable defaults will |
402 | resources are specified, suitable defaults will be used. Command-line |
538 | be used. Command-line arguments can be used to override resource |
403 | arguments can be used to override resource settings. The following |
539 | settings. The following resources are supported (you might want to |
404 | resources are allowed: |
540 | check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl |
|
|
541 | extensions not documented here): |
405 | |
542 | |
406 | =over 4 |
543 | =over 4 |
|
|
544 | |
|
|
545 | =item B<depth:> I<bitdepth> |
|
|
546 | |
|
|
547 | Compile I<xft>: Attempt to find a visual with the given bit depth; |
|
|
548 | option B<-depth>. |
407 | |
549 | |
408 | =item B<geometry:> I<geom> |
550 | =item B<geometry:> I<geom> |
409 | |
551 | |
410 | Create the window with the specified X window geometry [default 80x24]; |
552 | Create the window with the specified X window geometry [default 80x24]; |
411 | option B<-geometry>. |
553 | option B<-geometry>. |
… | |
… | |
448 | Use the specified colour to display underlined characters when the |
590 | Use the specified colour to display underlined characters when the |
449 | foreground colour is the default. |
591 | foreground colour is the default. |
450 | |
592 | |
451 | =item B<colorRV:> I<colour> |
593 | =item B<colorRV:> I<colour> |
452 | |
594 | |
453 | Use the specified colour as the background for reverse video |
595 | Use the specified colour as the background for reverse video characters |
454 | characters. |
596 | when OPTION_HC is disabled (--disable-frills). |
455 | |
597 | |
456 | =item B<underlineColor:> I<colour> |
598 | =item B<underlineColor:> I<colour> |
457 | |
599 | |
458 | If set, use the specified colour as the colour for the underline |
600 | If set, use the specified colour as the colour for the underline |
459 | itself. If unset, use the foreground colour. |
601 | itself. If unset, use the foreground colour. |
… | |
… | |
475 | option B<-rv>. B<False>: regular screen colours [default]; option |
617 | option B<-rv>. B<False>: regular screen colours [default]; option |
476 | B<+rv>. See note in B<COLORS AND GRAPHICS> section. |
618 | B<+rv>. See note in B<COLORS AND GRAPHICS> section. |
477 | |
619 | |
478 | =item B<jumpScroll:> I<boolean> |
620 | =item B<jumpScroll:> I<boolean> |
479 | |
621 | |
480 | B<True>: specify that jump scrolling should be used. When scrolling |
622 | B<True>: specify that jump scrolling should be used. When receiving lots |
481 | quickly, fewer screen updates are performed [default]; option B<-j>. |
623 | of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines |
|
|
624 | has been read, resulting in fewer updates while still displaying every |
|
|
625 | received line; option B<-j>. |
|
|
626 | |
482 | B<False>: specify that smooth scrolling should be used; option B<+j>. |
627 | B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will |
|
|
628 | force a screen refresh on each new line it received; option B<+j>. |
|
|
629 | |
|
|
630 | =item B<skipScroll:> I<boolean> |
|
|
631 | |
|
|
632 | B<True>: (the default) specify that skip scrolling should be used. When |
|
|
633 | receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while |
|
|
634 | (around 60 times per second), resulting in far fewer updates. This can |
|
|
635 | result in @@RXVT_NAME@@ not ever displaying some of the lines it receives; |
|
|
636 | option B<-ss>. |
|
|
637 | |
|
|
638 | B<False>: specify that everything is to be displayed, even |
|
|
639 | if the refresh is too fast for the human eye to read anything (or the |
|
|
640 | monitor to display anything); option B<+ss>. |
483 | |
641 | |
484 | =item B<inheritPixmap:> I<boolean> |
642 | =item B<inheritPixmap:> I<boolean> |
485 | |
643 | |
486 | B<True>: make the background inherit the parent windows' pixmap, giving |
644 | B<True>: make the background inherit the parent windows' pixmap, giving |
487 | artificial transparency. B<False>: do not inherit the parent windows' |
645 | artificial transparency. B<False>: do not inherit the parent windows' |
488 | pixmap. |
646 | pixmap. |
489 | |
647 | |
|
|
648 | I<Please note that transparency of any kind if completely unsupported by |
|
|
649 | the author. Don't bug him with installation questions!> |
|
|
650 | |
490 | =item B<fading:> I<number> |
651 | =item B<fading:> I<number> |
491 | |
652 | |
492 | Fade the text by the given percentage when focus is lost. |
653 | Fade the text by the given percentage when focus is lost; option B<-fade>. |
|
|
654 | |
|
|
655 | =item B<fadeColor:> I<colour> |
|
|
656 | |
|
|
657 | Fade to this colour, when fading is used (see B<fading:>). The default |
|
|
658 | colour is black; option B<-fadecolor>. |
493 | |
659 | |
494 | =item B<tintColor:> I<colour> |
660 | =item B<tintColor:> I<colour> |
495 | |
661 | |
496 | Tint the transparent background pixmap with the given colour. |
662 | Tint the transparent background pixmap with the given colour; option |
|
|
663 | B<-tint>. |
497 | |
664 | |
498 | =item B<shading:> I<number> |
665 | =item B<shading:> I<number> |
499 | |
666 | |
500 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
667 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image |
501 | image in addition to tinting it. |
668 | in addition to tinting it; option B<-sh>. |
|
|
669 | |
|
|
670 | =item B<blendType:> I<string> |
|
|
671 | |
|
|
672 | Specify background blending type; option B<-blt>. |
|
|
673 | |
|
|
674 | =item B<blurRadius:> I<number> |
|
|
675 | |
|
|
676 | Apply Gaussian Blurr with the specified radius to the transparent |
|
|
677 | background image; option B<-blr>. |
502 | |
678 | |
503 | =item B<scrollColor:> I<colour> |
679 | =item B<scrollColor:> I<colour> |
504 | |
680 | |
505 | Use the specified colour for the scrollbar [default #B2B2B2]. |
681 | Use the specified colour for the scrollbar [default #B2B2B2]. |
506 | |
682 | |
507 | =item B<troughColor:> I<colour> |
683 | =item B<troughColor:> I<colour> |
508 | |
684 | |
509 | Use the specified colour for the scrollbar's trough area [default |
685 | Use the specified colour for the scrollbar's trough area [default |
510 | #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. |
686 | #969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar. |
511 | |
687 | |
512 | =item B<borderColor:> I<colour> |
688 | =item B<borderColor:> I<colour> |
513 | |
689 | |
514 | The colour of the border around the text area and between the scrollbar |
690 | The colour of the border around the text area and between the scrollbar |
515 | and the text. |
691 | and the text. |
516 | |
692 | |
517 | =item B<backgroundPixmap:> I<file[;geom]> |
693 | =item B<backgroundPixmap:> I<file[;geom]> |
518 | |
694 | |
519 | Use the specified XPM file (note the `.xpm' extension is optional) for |
695 | Use the specified image file for the background and also optionally |
520 | the background and also optionally specify its scaling with a geometry |
696 | specify its scaling with a geometry string B<WxH+X+Y>, |
521 | string B<WxH+X+Y>, in which B<"W" / "H"> specify the |
697 | in which B<"W" / "H"> specify the horizontal/vertical scale (percent), |
522 | horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image |
698 | and B<"X" / "Y"> locate the image centre (percent). |
523 | centre (percent). A scale of 0 displays the image with tiling. A scale |
699 | A scale of 0 displays the image with tiling. A scale of 1 displays the |
524 | of 1 displays the image without any scaling. A scale of 2 to 9 |
700 | image without any scaling. A scale of 2 to 9 specifies an integer |
525 | specifies an integer number of images in that direction. No image will |
701 | number of images in that direction. No image will be magnified beyond |
526 | be magnified beyond 10 times its original size. The maximum permitted |
702 | 10 times its original size. The maximum permitted scale is 1000. |
527 | scale is 1000. [default 0x0+50+50] |
703 | Special string of B<"auto"> used as a geometry will cause image to be |
528 | |
704 | automatically scaled to match window size. |
529 | =item B<menu:> I<file[;tag]> |
705 | If used in conjunction with B<-tr> option - specified pixmap will be |
530 | |
706 | blended over transparency image using either alpha-blending, or any |
531 | Read in the specified menu file (note the `.menu' extension is |
707 | other blending type, specified with B<-blt "type"> option. |
532 | optional) and also optionally specify a starting tag to find. See the |
708 | [default 0x0+50+50] |
533 | reference documentation for details on the syntax for the menuBar. |
|
|
534 | |
709 | |
535 | =item B<path:> I<path> |
710 | =item B<path:> I<path> |
536 | |
711 | |
537 | Specify the colon-delimited search path for finding files (XPM and |
712 | Specify the colon-delimited search path for finding XPM files. |
538 | menus), in addition to the paths specified by the B<RXVTPATH> and |
|
|
539 | B<PATH> environment variables. |
|
|
540 | |
713 | |
541 | =item B<font:> I<fontlist> |
714 | =item B<font:> I<fontlist> |
542 | |
715 | |
543 | Select the fonts to be used. This is a comma separated list of font |
716 | Select the fonts to be used. This is a comma separated list of font names |
544 | names that are used in turn when trying to display Unicode characters. |
717 | that are checked in order when trying to find glyphs for characters. The |
545 | The first font defines the cell size for characters; other fonts might |
718 | first font defines the cell size for characters; other fonts might be |
546 | be smaller, but not larger. A reasonable default font list is always |
719 | smaller, but not (in general) larger. A (hopefully) reasonable default |
547 | appended to it. option B<-fn>. |
720 | font list is always appended to it; option B<-fn>. |
548 | |
721 | |
549 | Each font can either be a standard X11 core font (XLFD) name, with |
722 | Each font can either be a standard X11 core font (XLFD) name, with |
550 | optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. |
723 | optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. |
551 | |
724 | |
552 | In addition, each font can be prefixed with additional hints and |
725 | In addition, each font can be prefixed with additional hints and |
… | |
… | |
554 | hint currently is C<codeset=codeset-name>, and this is only used for Xft |
727 | hint currently is C<codeset=codeset-name>, and this is only used for Xft |
555 | fonts. |
728 | fonts. |
556 | |
729 | |
557 | For example, this font resource |
730 | For example, this font resource |
558 | |
731 | |
559 | URxvt*font: 9x15bold,\ |
732 | URxvt.font: 9x15bold,\ |
560 | -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ |
733 | -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ |
561 | -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ |
734 | -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ |
562 | [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ |
735 | [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ |
563 | xft:Code2000:antialias=false |
736 | xft:Code2000:antialias=false |
564 | |
737 | |
… | |
… | |
598 | not possible, replacement fonts of the desired shape will be tried. |
771 | not possible, replacement fonts of the desired shape will be tried. |
599 | |
772 | |
600 | If set, but empty, then this specific style is disabled and the normal |
773 | If set, but empty, then this specific style is disabled and the normal |
601 | text font will being used for the given style. |
774 | text font will being used for the given style. |
602 | |
775 | |
|
|
776 | =item B<intensityStyles:> I<boolean> |
|
|
777 | |
|
|
778 | When font styles are not enabled, or this option is enabled (B<True>, |
|
|
779 | option B<-is>, the default), bold and italic font styles imply high |
|
|
780 | intensity foreground/background colours. Disabling this option (B<False>, |
|
|
781 | option B<+is>) disables this behaviour, the high intensity colours are not |
|
|
782 | reachable. |
|
|
783 | |
603 | =item B<selectstyle:> I<mode> |
784 | =item B<selectstyle:> I<mode> |
604 | |
785 | |
605 | Set mouse selection style to B<old> which is 2.20, B<oldword> which is |
786 | Set mouse selection style to B<old> which is 2.20, B<oldword> which |
606 | xterm style with 2.20 old word selection, or anything else which gives |
787 | is xterm style with 2.20 old word selection, or anything else which |
607 | xterm style selection. |
788 | gives xterm style selection. Only effective when the original (non-perl) |
|
|
789 | selection code is in use. |
608 | |
790 | |
609 | =item B<scrollstyle:> I<mode> |
791 | =item B<scrollstyle:> I<mode> |
610 | |
792 | |
611 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
793 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
612 | the author's favourite.. |
794 | the author's favourite. |
613 | |
795 | |
614 | =item B<title:> I<string> |
796 | =item B<title:> I<string> |
615 | |
797 | |
616 | Set window title string, the default title is the command-line |
798 | Set window title string, the default title is the command-line |
617 | specified after the B<-e> option, if any, otherwise the application |
799 | specified after the B<-e> option, if any, otherwise the application |
… | |
… | |
626 | =item B<mapAlert:> I<boolean> |
808 | =item B<mapAlert:> I<boolean> |
627 | |
809 | |
628 | B<True>: de-iconify (map) on receipt of a bell character. B<False>: no |
810 | B<True>: de-iconify (map) on receipt of a bell character. B<False>: no |
629 | de-iconify (map) on receipt of a bell character [default]. |
811 | de-iconify (map) on receipt of a bell character [default]. |
630 | |
812 | |
|
|
813 | =item B<urgentOnBell:> I<boolean> |
|
|
814 | |
|
|
815 | B<True>: set the urgency hint for the wm on receipt of a bell character. |
|
|
816 | B<False>: do not set the urgency hint [default]. |
|
|
817 | |
631 | =item B<visualBell:> I<boolean> |
818 | =item B<visualBell:> I<boolean> |
632 | |
819 | |
633 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
820 | B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
634 | B<False>: no visual bell [default]; option B<+vb>. |
821 | B<False>: no visual bell [default]; option B<+vb>. |
635 | |
822 | |
… | |
… | |
649 | |
836 | |
650 | Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use |
837 | Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use |
651 | B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or |
838 | B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or |
652 | B<Shift-Print> to include the scrollback as well. |
839 | B<Shift-Print> to include the scrollback as well. |
653 | |
840 | |
|
|
841 | The string will be interpreted as if typed into the shell as-is. |
|
|
842 | |
|
|
843 | Example: |
|
|
844 | |
|
|
845 | URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
|
|
846 | |
|
|
847 | This creates a new file in your home directory with the screen contents |
|
|
848 | every time you hit C<Print>. |
|
|
849 | |
654 | =item B<scrollBar:> I<boolean> |
850 | =item B<scrollBar:> I<boolean> |
655 | |
851 | |
656 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
852 | B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
657 | disable the scrollbar; option B<+sb>. |
853 | disable the scrollbar; option B<+sb>. |
658 | |
854 | |
… | |
… | |
678 | B<+si>. |
874 | B<+si>. |
679 | |
875 | |
680 | =item B<scrollWithBuffer:> I<boolean> |
876 | =item B<scrollWithBuffer:> I<boolean> |
681 | |
877 | |
682 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
878 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
683 | B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll |
879 | B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll |
684 | with scrollback buffer when tty recieves new lines; option B<-sw>. |
880 | with scrollback buffer when tty receives new lines; option B<+sw>. |
685 | |
881 | |
686 | =item B<scrollTtyKeypress:> I<boolean> |
882 | =item B<scrollTtyKeypress:> I<boolean> |
687 | |
883 | |
688 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
884 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
689 | are those which are intercepted by rxvt-unicode for special handling and |
885 | are those which are intercepted by rxvt-unicode for special handling and |
… | |
… | |
708 | =item B<borderLess:> I<boolean> |
904 | =item B<borderLess:> I<boolean> |
709 | |
905 | |
710 | Set MWM hints to request a borderless window, i.e. if honoured by the |
906 | Set MWM hints to request a borderless window, i.e. if honoured by the |
711 | WM, the rxvt-unicode window will not have window decorations; option B<-bl>. |
907 | WM, the rxvt-unicode window will not have window decorations; option B<-bl>. |
712 | |
908 | |
|
|
909 | =item B<skipBuiltinGlyphs:> I<boolean> |
|
|
910 | |
|
|
911 | Compile I<frills>: Disable the usage of the built-in block graphics/line |
|
|
912 | drawing characters and just rely on what the specified fonts provide. Use |
|
|
913 | this if you have a good font and want to use its block graphic glyphs; |
|
|
914 | option B<-sbg>. |
|
|
915 | |
713 | =item B<termName:> I<termname> |
916 | =item B<termName:> I<termname> |
714 | |
917 | |
715 | Specifies the terminal type name to be set in the B<TERM> environment |
918 | Specifies the terminal type name to be set in the B<TERM> environment |
716 | variable; option B<-tn>. |
919 | variable; option B<-tn>. |
717 | |
920 | |
… | |
… | |
754 | |
957 | |
755 | Mouse pointer background colour. |
958 | Mouse pointer background colour. |
756 | |
959 | |
757 | =item B<pointerBlankDelay:> I<number> |
960 | =item B<pointerBlankDelay:> I<number> |
758 | |
961 | |
759 | Specifies number of seconds before blanking the pointer [default 2]. |
962 | Specifies number of seconds before blanking the pointer [default 2]. Use a |
|
|
963 | large number (e.g. C<987654321>) to effectively disable the timeout. |
760 | |
964 | |
761 | =item B<backspacekey:> I<string> |
965 | =item B<backspacekey:> I<string> |
762 | |
966 | |
763 | The string to send when the backspace key is pressed. If set to B<DEC> |
967 | The string to send when the backspace key is pressed. If set to B<DEC> |
764 | or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> |
968 | or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> |
… | |
… | |
771 | pressed. If unset it will send the sequence traditionally associated |
975 | pressed. If unset it will send the sequence traditionally associated |
772 | with the B<Execute> key. |
976 | with the B<Execute> key. |
773 | |
977 | |
774 | =item B<cutchars:> I<string> |
978 | =item B<cutchars:> I<string> |
775 | |
979 | |
776 | The characters used as delimiters for double-click word selection. The |
980 | The characters used as delimiters for double-click word selection |
777 | built-in default: |
981 | (whitespace delimiting is added automatically if resource is given). |
|
|
982 | |
|
|
983 | When the perl selection extension is in use (the default if compiled |
|
|
984 | in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these |
|
|
985 | characters will be created (if the resource exists, otherwise, no regex |
|
|
986 | will be created). In this mode, characters outside ISO-8859-1 can be used. |
|
|
987 | |
|
|
988 | When the selection extension is not used, only ISO-8859-1 characters can |
|
|
989 | be used. If not specified, the built-in default is used: |
778 | |
990 | |
779 | B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> |
991 | B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> |
780 | |
992 | |
781 | =item B<preeditType:> I<style> |
993 | =item B<preeditType:> I<style> |
782 | |
994 | |
… | |
… | |
789 | =item B<imLocale:> I<name> |
1001 | =item B<imLocale:> I<name> |
790 | |
1002 | |
791 | The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. |
1003 | The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. |
792 | C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the |
1004 | C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the |
793 | input extension to be able to input japanese characters while staying in |
1005 | input extension to be able to input japanese characters while staying in |
794 | another locale. option B<-imlocale>. |
1006 | another locale; option B<-imlocale>. |
795 | |
1007 | |
796 | =item B<imFont:> I<fontset> |
1008 | =item B<imFont:> I<fontset> |
797 | |
1009 | |
798 | Specify the font-set used for XIM styles C<OverTheSpot> or |
1010 | Specify the font-set used for XIM styles C<OverTheSpot> or |
799 | C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated |
1011 | C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated |
… | |
… | |
804 | |
1016 | |
805 | =item B<tripleclickwords:> I<boolean> |
1017 | =item B<tripleclickwords:> I<boolean> |
806 | |
1018 | |
807 | Change the meaning of triple-click selection with the left mouse |
1019 | Change the meaning of triple-click selection with the left mouse |
808 | button. Instead of selecting a full line it will extend the selection to |
1020 | button. Instead of selecting a full line it will extend the selection to |
809 | the end of the logical line only. option B<-tcw>. |
1021 | the end of the logical line only; option B<-tcw>. |
810 | |
1022 | |
811 | =item B<insecure:> I<boolean> |
1023 | =item B<insecure:> I<boolean> |
812 | |
1024 | |
813 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences that |
1025 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences that |
814 | echo arbitrary strings like the icon name or the locale. This could be |
1026 | echo arbitrary strings like the icon name or the locale. This could be |
815 | abused if somebody gets 8-bit-clean access to your display, whether |
1027 | abused if somebody gets 8-bit-clean access to your display, whether |
816 | throuh a mail client displaying mail bodies unfiltered or though |
1028 | through a mail client displaying mail bodies unfiltered or through |
817 | write(1). Therefore, these sequences are disabled by default. (Note |
1029 | write(1) or any other means. Therefore, these sequences are disabled by |
818 | that other terminals, including xterm, have these sequences |
1030 | default. (Note that many other terminals, including xterm, have these |
819 | enabled by default). You can enable them by setting this boolean |
1031 | sequences enabled by default, which doesn't make it safer, though). |
820 | resource or specifying B<-insecure> as an option. At the moment, this |
1032 | |
821 | enabled display-answer, locale, findfont, icon label and window title |
1033 | You can enable them by setting this boolean resource or specifying |
822 | requests as well as dynamic menubar dispatch. |
1034 | B<-insecure> as an option. At the moment, this enables display-answer, |
|
|
1035 | locale, findfont, icon label and window title requests. |
823 | |
1036 | |
824 | =item B<modifier:> I<modifier> |
1037 | =item B<modifier:> I<modifier> |
825 | |
1038 | |
826 | Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, |
1039 | Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, |
827 | B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option |
1040 | B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option |
… | |
… | |
831 | |
1044 | |
832 | Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) |
1045 | Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) |
833 | character is passed through. It may contain escape values as described |
1046 | character is passed through. It may contain escape values as described |
834 | in the entry on B<keysym> following. |
1047 | in the entry on B<keysym> following. |
835 | |
1048 | |
836 | =item B<secondaryScreen:> I<bool> |
1049 | =item B<secondaryScreen:> I<boolean> |
837 | |
1050 | |
838 | Turn on/off secondary screen (default enabled). |
1051 | Turn on/off secondary screen (default enabled). |
839 | |
1052 | |
840 | =item B<secondaryScroll:> I<bool> |
1053 | =item B<secondaryScroll:> I<boolean> |
841 | |
1054 | |
842 | Turn on/off secondary screen scroll (default enabled). If the this |
1055 | Turn on/off secondary screen scroll (default enabled). If this |
843 | option is enabled, scrolls on the secondary screen will change the |
1056 | option is enabled, scrolls on the secondary screen will change the |
844 | scrollback buffer and switching to/from the secondary screen will |
1057 | scrollback buffer and switching to/from the secondary screen will |
845 | instead scroll the screen up. |
1058 | instead scroll the screen up. |
|
|
1059 | |
|
|
1060 | =item B<hold>: I<boolean> |
|
|
1061 | |
|
|
1062 | Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
|
|
1063 | will not immediately destroy its window when the program executed within |
|
|
1064 | it exits. Instead, it will wait till it is being killed or closed by the |
|
|
1065 | user. |
846 | |
1066 | |
847 | =item B<keysym.>I<sym>: I<string> |
1067 | =item B<keysym.>I<sym>: I<string> |
848 | |
1068 | |
849 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
1069 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
850 | intervening resource name B<keysym.> cannot be omitted. |
1070 | intervening resource name B<keysym.> cannot be omitted. |
… | |
… | |
868 | |
1088 | |
869 | I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, |
1089 | I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, |
870 | C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, |
1090 | C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, |
871 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
1091 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
872 | C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it |
1092 | C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it |
873 | can start or end with whitespace. |
1093 | can start or end with whitespace. B<This feature is deprecated and will |
|
|
1094 | be removed>. |
874 | |
1095 | |
875 | Please note that you need to double the C<\> when using |
1096 | Please note that you need to double the C<\> in resource files, as |
876 | C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can |
1097 | Xlib itself does its own de-escaping (you can use C<\033> instead of |
877 | use C<\033> instead of C<\e> (and so on), which will work with both Xt and |
1098 | C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own |
878 | @@RXVT_NAME@@'s own processing). |
1099 | processing). |
879 | |
1100 | |
880 | You can define a range of keysyms in one shot by providing a I<string> |
1101 | You can define a range of keysyms in one shot by providing a I<string> |
881 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' |
1102 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' |
882 | should be a character not used by the strings. |
1103 | should be a character not used by the strings. |
883 | |
1104 | |
884 | Its usage can be demonstrated by an example: |
1105 | Its usage can be demonstrated by an example: |
885 | |
1106 | |
886 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
1107 | URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
… | |
… | |
896 | example the following means "change the current locale to C<zh_CN.GBK> |
1117 | example the following means "change the current locale to C<zh_CN.GBK> |
897 | when Control-Meta-c is being pressed": |
1118 | when Control-Meta-c is being pressed": |
898 | |
1119 | |
899 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1120 | URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
900 | |
1121 | |
|
|
1122 | If I<string> takes the form C<perl:STRING>, then the specified B<STRING> |
|
|
1123 | is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) |
|
|
1124 | manpage. For example, the F<selection> extension (activated via |
|
|
1125 | C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: |
|
|
1126 | |
|
|
1127 | URxvt.keysym.M-C-c: perl:selection:rot13 |
|
|
1128 | |
|
|
1129 | Due the the large number of modifier combinations, a defined key mapping |
|
|
1130 | will match if at I<at least> the specified identifiers are being set, and |
|
|
1131 | no other key mappings with those and more bits are being defined. That |
|
|
1132 | means that defining a key map for C<a> will automatically provide |
|
|
1133 | definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined |
|
|
1134 | mappings themselves. |
|
|
1135 | |
|
|
1136 | Unfortunately, this will override built-in key mappings. For example |
|
|
1137 | if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s |
|
|
1138 | C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the |
|
|
1139 | user-defined keymap using the C<builtin:> replacement: |
|
|
1140 | |
|
|
1141 | URxvt.keysym.Insert: <my insert key sequence> |
|
|
1142 | URxvt.keysym.S-Insert: builtin: |
|
|
1143 | |
|
|
1144 | The first line defines a mapping for C<Insert> and I<any> combination |
|
|
1145 | of modifiers. The second line re-establishes the default mapping for |
|
|
1146 | C<Shift-Insert>. |
|
|
1147 | |
901 | The following example will map Control-Meta-1 and Control-Meta-2 to |
1148 | The following example will map Control-Meta-1 and Control-Meta-2 to |
902 | the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited |
1149 | the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited |
903 | font-switching at runtime: |
1150 | font-switching at runtime: |
904 | |
1151 | |
905 | URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 |
1152 | URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 |
… | |
… | |
908 | Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more |
1155 | Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more |
909 | info): |
1156 | info): |
910 | |
1157 | |
911 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
1158 | URxvt.keysym.M-C-3: command:\033[8;25;80t |
912 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
1159 | URxvt.keysym.M-C-4: command:\033[8;48;110t |
|
|
1160 | |
|
|
1161 | =item B<perl-ext-common>: I<string> |
|
|
1162 | |
|
|
1163 | =item B<perl-ext>: I<string> |
|
|
1164 | |
|
|
1165 | Comma-separated list(s) of perl extension scripts (default: C<default>) to |
|
|
1166 | use in this terminal instance; option B<-pe>. |
|
|
1167 | |
|
|
1168 | Extension names can be prefixed with a C<-> sign to prohibit using |
|
|
1169 | them. This can be useful to selectively disable some extensions loaded |
|
|
1170 | by default, or specified via the C<perl-ext-common> resource. For |
|
|
1171 | example, C<default,-selection> will use all the default extension except |
|
|
1172 | C<selection>. |
|
|
1173 | |
|
|
1174 | Extension names can also be followed by an argument in angle brackets |
|
|
1175 | (e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for |
|
|
1176 | searchable scrollback to Alt/Meta-s). Mentioning the same extension |
|
|
1177 | multiple times with different arguments will pass multiple arguments to |
|
|
1178 | the extension. |
|
|
1179 | |
|
|
1180 | Each extension is looked up in the library directories, loaded if |
|
|
1181 | necessary, and bound to the current terminal instance. |
|
|
1182 | |
|
|
1183 | If both of these resources are the empty string, then the perl |
|
|
1184 | interpreter will not be initialized. The idea behind two options is that |
|
|
1185 | B<perl-ext-common> will be used for extensions that should be available to |
|
|
1186 | all instances, while B<perl-ext> is used for specific instances. |
|
|
1187 | |
|
|
1188 | =item B<perl-eval>: I<string> |
|
|
1189 | |
|
|
1190 | Perl code to be evaluated when all extensions have been registered. See |
|
|
1191 | the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource |
|
|
1192 | will be ignored when running setuid/setgid. |
|
|
1193 | |
|
|
1194 | =item B<perl-lib>: I<path> |
|
|
1195 | |
|
|
1196 | Colon-separated list of additional directories that hold extension |
|
|
1197 | scripts. When looking for extensions specified by the C<perl> resource, |
|
|
1198 | @@RXVT_NAME@@ will first look in these directories and then in |
|
|
1199 | F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource |
|
|
1200 | will be ignored when running setuid/setgid. |
|
|
1201 | |
|
|
1202 | See the @@RXVT_NAME@@perl(3) manpage. |
|
|
1203 | |
|
|
1204 | =item B<< selection.pattern-I<idx> >>: I<perl-regex> |
|
|
1205 | |
|
|
1206 | Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for |
|
|
1207 | details. |
|
|
1208 | |
|
|
1209 | =item B<< selection-autotransform.I<idx> >>: I<perl-transform> |
|
|
1210 | |
|
|
1211 | Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage |
|
|
1212 | for details. |
|
|
1213 | |
|
|
1214 | =item B<searchable-scrollback:> I<keysym> |
|
|
1215 | |
|
|
1216 | Sets the hotkey that starts the incremental scrollback buffer search |
|
|
1217 | (default: C<M-s>). |
|
|
1218 | |
|
|
1219 | =item B<urlLauncher>: I<string> |
|
|
1220 | |
|
|
1221 | Specifies the program to be started with a URL argument. Used by the |
|
|
1222 | C<selection-popup> and C<matcher> perl extensions. |
|
|
1223 | |
|
|
1224 | =item B<transient-for>: I<windowid> |
|
|
1225 | |
|
|
1226 | Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. |
|
|
1227 | |
|
|
1228 | =item B<override-redirect>: I<boolean> |
|
|
1229 | |
|
|
1230 | Compile I<frills>: Sets override-redirect for the terminal window, making |
|
|
1231 | it almost invisible to window managers; option B<-override-redirect>. |
|
|
1232 | |
|
|
1233 | =item B<iso14755_52:> I<boolean> |
|
|
1234 | |
|
|
1235 | Turn on/off ISO 14755 5.2 mode (default enabled). |
913 | |
1236 | |
914 | =back |
1237 | =back |
915 | |
1238 | |
916 | =head1 THE SCROLLBAR |
1239 | =head1 THE SCROLLBAR |
917 | |
1240 | |
… | |
… | |
931 | the normal text selection/insertion, hold either the Shift or the Meta |
1254 | the normal text selection/insertion, hold either the Shift or the Meta |
932 | (Alt) key while performing the desired mouse action. |
1255 | (Alt) key while performing the desired mouse action. |
933 | |
1256 | |
934 | If mouse reporting mode is active, the normal scrollbar actions are |
1257 | If mouse reporting mode is active, the normal scrollbar actions are |
935 | disabled -- on the assumption that we are using a fullscreen |
1258 | disabled -- on the assumption that we are using a fullscreen |
936 | application. Instead, pressing Button1 and Button3 sends B<ESC[6~> |
1259 | application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> |
937 | (Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the |
1260 | (Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the |
938 | up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), |
1261 | up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), |
939 | respectively. |
1262 | respectively. |
940 | |
1263 | |
941 | =head1 TEXT SELECTION AND INSERTION |
1264 | =head1 THE SELECTION: SELECTING AND PASTING TEXT |
942 | |
1265 | |
943 | The behaviour of text selection and insertion mechanism is similar to |
1266 | The behaviour of text selection and insertion/pasting mechanism is similar |
944 | I<xterm>(1). |
1267 | to I<xterm>(1). |
945 | |
1268 | |
946 | =over 4 |
1269 | =over 4 |
947 | |
1270 | |
948 | =item B<Selection>: |
1271 | =item B<Selecting>: |
949 | |
1272 | |
950 | Left click at the beginning of the region, drag to the end of the region |
1273 | Left click at the beginning of the region, drag to the end of the region |
951 | and release; Right click to extend the marked region; Left double-click |
1274 | and release; Right click to extend the marked region; Left double-click |
952 | to select a word; Left triple-click to select the entire logical line |
1275 | to select a word; Left triple-click to select the entire logical line |
953 | (which can span multiple screen lines), unless modified by resource |
1276 | (which can span multiple screen lines), unless modified by resource |
954 | B<tripleclickwords>. |
1277 | B<tripleclickwords>. |
955 | |
1278 | |
956 | Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) |
1279 | Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) |
957 | (Compile: I<frills>) will create a rectangular selection instead of a normal |
1280 | (Compile: I<frills>) will create a rectangular selection instead of a |
958 | one. |
1281 | normal one. In this mode, every selected row becomes its own line in the |
|
|
1282 | selection, and trailing whitespace is visually underlined and removed from |
|
|
1283 | the selection. |
959 | |
1284 | |
960 | =item B<Insertion>: |
1285 | =item B<Pasting>: |
961 | |
1286 | |
962 | Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in |
1287 | Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> |
963 | an B<@@RXVT_NAME@@> window causes the current text selection to be |
1288 | window causes the value of the PRIMARY selection (or CLIPBOARD with the |
964 | inserted as if it had been typed on the keyboard. |
1289 | B<Meta> modifier) to be inserted as if it had been typed on the keyboard. |
|
|
1290 | |
|
|
1291 | Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be |
|
|
1292 | inserted too. |
965 | |
1293 | |
966 | =back |
1294 | =back |
967 | |
1295 | |
968 | =head1 CHANGING FONTS |
1296 | =head1 CHANGING FONTS |
969 | |
1297 | |
970 | Changing fonts (or font sizes, respectively) via the keypad is not yet |
1298 | Changing fonts (or font sizes, respectively) via the keypad is not yet |
971 | supported in rxvt-unicode. Bug me if you need this. |
1299 | supported in rxvt-unicode. Bug me if you need this. |
972 | |
1300 | |
973 | You can, however, switch fonts at runtime using escape sequences (and |
1301 | You can, however, switch fonts at runtime using escape sequences, e.g.: |
974 | therefore using the menubar), e.g.: |
|
|
975 | |
1302 | |
976 | printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" |
1303 | printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" |
|
|
1304 | |
|
|
1305 | You can use keyboard shortcuts, too: |
|
|
1306 | |
|
|
1307 | URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007 |
|
|
1308 | URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007 |
977 | |
1309 | |
978 | rxvt-unicode will automatically re-apply these fonts to the output so far. |
1310 | rxvt-unicode will automatically re-apply these fonts to the output so far. |
979 | |
1311 | |
980 | =head1 ISO 14755 SUPPORT |
1312 | =head1 ISO 14755 SUPPORT |
981 | |
1313 | |
982 | ISO 14755 is a standard for entering and viewing unicode characters |
1314 | ISO 14755 is a standard for entering and viewing unicode characters |
983 | and character codes using the keyboard. It consists of 4 parts. The |
1315 | and character codes using the keyboard. It consists of 4 parts. The |
984 | first part is available rxvt-unicode has been compiled with |
1316 | first part is available if rxvt-unicode has been compiled with |
985 | C<--enable-frills>, the rest is available when rxvt-unicode was compiled |
1317 | C<--enable-frills>, the rest is available when rxvt-unicode was compiled |
986 | with C<--enable-iso14755>. |
1318 | with C<--enable-iso14755>. |
987 | |
1319 | |
988 | =over 4 |
1320 | =over 4 |
989 | |
1321 | |
… | |
… | |
1009 | This mode lets you input characters representing the keycap symbols of |
1341 | This mode lets you input characters representing the keycap symbols of |
1010 | your keyboard, if representable in the current locale encoding. |
1342 | your keyboard, if representable in the current locale encoding. |
1011 | |
1343 | |
1012 | Start by pressing C<Control> and C<Shift> together, then releasing |
1344 | Start by pressing C<Control> and C<Shift> together, then releasing |
1013 | them. The next special key (cursor keys, home etc.) you enter will not |
1345 | them. The next special key (cursor keys, home etc.) you enter will not |
1014 | invoke it's usual function but instead will insert the corresponding |
1346 | invoke its usual function but instead will insert the corresponding |
1015 | keycap symbol. The symbol will only be entered when the key has been |
1347 | keycap symbol. The symbol will only be entered when the key has been |
1016 | released, otherwise pressing e.g. C<Shift> would enter the symbol for |
1348 | released, otherwise pressing e.g. C<Shift> would enter the symbol for |
1017 | C<ISO Level 2 Switch>, although your intention might have been to enter a |
1349 | C<ISO Level 2 Switch>, although your intention might have been to enter a |
1018 | reverse tab (Shift-Tab). |
1350 | reverse tab (Shift-Tab). |
1019 | |
1351 | |
… | |
… | |
1052 | =head1 COLORS AND GRAPHICS |
1384 | =head1 COLORS AND GRAPHICS |
1053 | |
1385 | |
1054 | In addition to the default foreground and background colours, |
1386 | In addition to the default foreground and background colours, |
1055 | B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus |
1387 | B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus |
1056 | high-intensity bold/blink versions of the same). Here is a list of the |
1388 | high-intensity bold/blink versions of the same). Here is a list of the |
1057 | colours with their B<rgb.txt> names. |
1389 | colours with their names. |
1058 | |
1390 | |
1059 | =begin table |
1391 | =begin table |
1060 | |
1392 | |
1061 | B<color0> (black) = Black |
1393 | B<color0> (black) = Black |
1062 | B<color1> (red) = Red3 |
1394 | B<color1> (red) = Red3 |
… | |
… | |
1082 | It is also possible to specify the colour values of B<foreground>, |
1414 | It is also possible to specify the colour values of B<foreground>, |
1083 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1415 | B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1084 | a number 0-15, as a convenient shorthand to reference the colour name of |
1416 | a number 0-15, as a convenient shorthand to reference the colour name of |
1085 | color0-color15. |
1417 | color0-color15. |
1086 | |
1418 | |
|
|
1419 | In addition to the colours defined above, @@RXVT_NAME@@ offers an |
|
|
1420 | additional 72 colours. The first 64 of those (with indices 16 to 79) |
|
|
1421 | consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b + |
|
|
1422 | 16>), followed by 8 additional shades of gray (with indices 80 to 87). |
|
|
1423 | |
|
|
1424 | Together, all those colours implement the 88 colour xterm colours. Only |
|
|
1425 | the first 16 can be changed using resources currently, the rest can only |
|
|
1426 | be changed via command sequences ("escape codes"). |
|
|
1427 | |
1087 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1428 | Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1088 | always swapping the foreground/background colours. This is in contrast to |
1429 | always swapping the foreground/background colours. This is in contrast to |
1089 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1430 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1090 | been specified. For example, |
1431 | been specified. For example, |
1091 | |
1432 | |
… | |
… | |
1096 | would yield White on Black, while on I<xterm>(1) it would yield Black |
1437 | would yield White on Black, while on I<xterm>(1) it would yield Black |
1097 | on White. |
1438 | on White. |
1098 | |
1439 | |
1099 | =back |
1440 | =back |
1100 | |
1441 | |
|
|
1442 | =head2 ALPHA CHANNEL SUPPORT |
|
|
1443 | |
|
|
1444 | If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
|
|
1445 | their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> |
|
|
1446 | (recommended, but B<MUST> have 4 digits/component) colour specifications, |
|
|
1447 | in addition to the ones provided by X, where the additional A component |
|
|
1448 | specifies opacity (alpha) values. The minimum value of C<0> is completely |
|
|
1449 | transparent). You can also prefix any color with C<[percent]>, where |
|
|
1450 | C<percent> is a decimal percentage (0-100) that specifies the opacity of |
|
|
1451 | the color, where C<0> is completely transparent and C<100> is completelxy |
|
|
1452 | opaque. |
|
|
1453 | |
|
|
1454 | You probably need to specify B<"-depth 32">, too, and have the luck that |
|
|
1455 | your X-server uses ARGB pixel layout, as X is far from just supporting |
|
|
1456 | ARGB visuals out of the box, and rxvt-unicode just fudges around. |
|
|
1457 | |
|
|
1458 | For example, the following selects an almost completely transparent red |
|
|
1459 | background, and an almost opaque pink foreground: |
|
|
1460 | |
|
|
1461 | @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" |
|
|
1462 | |
|
|
1463 | I<Please note that transparency of any kind if completely unsupported by |
|
|
1464 | the author. Don't bug him with installation questions!> |
|
|
1465 | |
1101 | =head1 ENVIRONMENT |
1466 | =head1 ENVIRONMENT |
1102 | |
1467 | |
1103 | B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> |
1468 | B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1104 | and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X |
1469 | |
1105 | window id number of the B<@@RXVT_NAME@@> window and it also uses and |
1470 | =over 4 |
1106 | sets the environment variable B<DISPLAY> to specify which display |
1471 | |
1107 | terminal to use. B<@@RXVT_NAME@@> uses the environment variables |
1472 | =item B<TERM> |
1108 | B<RXVTPATH> and B<PATH> to find XPM files. |
1473 | |
|
|
1474 | Normally set to C<rxvt-unicode>, unless overwritten at configure time, via |
|
|
1475 | resources or on the command line. |
|
|
1476 | |
|
|
1477 | =item B<COLORTERM> |
|
|
1478 | |
|
|
1479 | Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was |
|
|
1480 | compiled with XPM support, and optionally with the added extension |
|
|
1481 | C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. |
|
|
1482 | |
|
|
1483 | =item B<COLORFGBG> |
|
|
1484 | |
|
|
1485 | Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is |
|
|
1486 | the colour code used as default foreground/text colour (or the string |
|
|
1487 | C<default> to indicate that the default-colour escape sequence is to be |
|
|
1488 | used), C<bg> is the colour code used as default background colour (or the |
|
|
1489 | string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ |
|
|
1490 | was compiled with XPM support. Libraries like C<ncurses> and C<slang> can |
|
|
1491 | (and do) use this information to optimize screen output. |
|
|
1492 | |
|
|
1493 | =item B<WINDOWID> |
|
|
1494 | |
|
|
1495 | Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel |
|
|
1496 | window, which usually has subwindows for the scrollbar, the terminal |
|
|
1497 | window and so on). |
|
|
1498 | |
|
|
1499 | =item B<TERMINFO> |
|
|
1500 | |
|
|
1501 | Set to the terminfo directory iff @@RXVT_NAME@@ was configured with |
|
|
1502 | C<--with-terminfo=PATH>. |
|
|
1503 | |
|
|
1504 | =item B<DISPLAY> |
|
|
1505 | |
|
|
1506 | Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
|
|
1507 | display in its child processes. |
|
|
1508 | |
|
|
1509 | =item B<SHELL> |
|
|
1510 | |
|
|
1511 | The shell to be used for command execution, defaults to C</bin/sh>. |
|
|
1512 | |
|
|
1513 | =item B<RXVT_SOCKET> |
|
|
1514 | |
|
|
1515 | The unix domain socket path used by @@RXVT_NAME@@c(1) and |
|
|
1516 | @@RXVT_NAME@@d(1). |
|
|
1517 | |
|
|
1518 | Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. |
|
|
1519 | |
|
|
1520 | =item B<HOME> |
|
|
1521 | |
|
|
1522 | Used to locate the default directory for the unix domain socket for |
|
|
1523 | daemon communications and to locate various resource files (such as |
|
|
1524 | C<.Xdefaults>) |
|
|
1525 | |
|
|
1526 | =item B<XAPPLRESDIR> |
|
|
1527 | |
|
|
1528 | Directory where various X resource files are being located. |
|
|
1529 | |
|
|
1530 | =item B<XENVIRONMENT> |
|
|
1531 | |
|
|
1532 | If set and accessible, gives the name of a X resource file to be loaded by |
|
|
1533 | @@RXVT_NAME@@. |
|
|
1534 | |
|
|
1535 | =back |
1109 | |
1536 | |
1110 | =head1 FILES |
1537 | =head1 FILES |
1111 | |
1538 | |
1112 | =over 4 |
1539 | =over 4 |
1113 | |
1540 | |
… | |
… | |
1117 | |
1544 | |
1118 | =back |
1545 | =back |
1119 | |
1546 | |
1120 | =head1 SEE ALSO |
1547 | =head1 SEE ALSO |
1121 | |
1548 | |
1122 | @@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) |
1549 | @@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) |
1123 | |
|
|
1124 | =head1 BUGS |
|
|
1125 | |
|
|
1126 | Check the BUGS file for an up-to-date list. |
|
|
1127 | |
|
|
1128 | Cursor change support is not yet implemented. |
|
|
1129 | |
|
|
1130 | Click-and-drag doesn't work with X11 mouse report overriding. |
|
|
1131 | |
1550 | |
1132 | =head1 CURRENT PROJECT COORDINATOR |
1551 | =head1 CURRENT PROJECT COORDINATOR |
1133 | |
1552 | |
1134 | =over 4 |
1553 | =over 4 |
1135 | |
1554 | |
1136 | =item Project Coordinator |
1555 | =item Project Coordinator |
1137 | |
1556 | |
1138 | @@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> |
1557 | Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1139 | |
1558 | |
1140 | =item Web page maintainter |
1559 | L<http://software.schmorp.de/pkg/rxvt-unicode.html> |
1141 | |
|
|
1142 | @@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@> |
|
|
1143 | |
|
|
1144 | L<@@RXVT_WEBPAGE@@> |
|
|
1145 | |
1560 | |
1146 | =back |
1561 | =back |
1147 | |
1562 | |
1148 | =head1 AUTHORS |
1563 | =head1 AUTHORS |
1149 | |
1564 | |
… | |
… | |
1171 | |
1586 | |
1172 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1587 | Project Coordinator (changes.txt 2.21a to 2.4.5) |
1173 | |
1588 | |
1174 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1589 | =item Geoff Wing L<< <gcw@pobox.com> >> |
1175 | |
1590 | |
1176 | Rewrote screen display and text selection routines. Project Coordinator |
1591 | Rewrote screen display and text selection routines. |
|
|
1592 | |
1177 | (changes.txt 2.4.6 - rxvt-unicode) |
1593 | Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1178 | |
1594 | |
1179 | =item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> |
1595 | =item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1180 | |
1596 | |
1181 | Forked rxvt-unicode, rewrote most of the display code and internal |
1597 | Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |
1182 | character handling to store text in unicode, improve xterm |
1598 | extension, random hacks, numerous bugfixes and extensions. |
1183 | compatibility and apply numerous other bugfixes and extensions. |
|
|
1184 | |
1599 | |
1185 | Project Coordinator (Changes 1.0 -) |
1600 | Project Coordinator (Changes 1.0 -) |
1186 | |
1601 | |
|
|
1602 | =item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> |
|
|
1603 | |
|
|
1604 | Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. |
|
|
1605 | |
1187 | =back |
1606 | =back |
1188 | |
1607 | |