… | |
… | |
6 | |
6 | |
7 | B<@@RXVT_NAME@@> [options] [-e command [ args ]] |
7 | B<@@RXVT_NAME@@> [options] [-e command [ args ]] |
8 | |
8 | |
9 | =head1 DESCRIPTION |
9 | =head1 DESCRIPTION |
10 | |
10 | |
11 | B<rxvt-unicode>, version B<@@RXVTVERSION@@>, is a colour vt102 terminal |
11 | B<rxvt-unicode>, version B<@@RXVT_VERSION@@>, is a colour vt102 terminal |
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 | See also @@RXVT_NAME@@(7) for technical reference documentation (escape |
17 | =head1 FREQUENTLY ASKED QUESTIONS |
18 | sequences etc.). |
18 | |
|
|
19 | See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of frequently |
|
|
20 | asked questions and answer to them and some common problems. |
|
|
21 | |
|
|
22 | =head1 RXVT-UNICODE VS. RXVT |
|
|
23 | |
|
|
24 | 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 |
|
|
26 | world. Being a terminal emulator, however, some things are very difficult, |
|
|
27 | especially cursive scripts such as arabic, vertically written scripts |
|
|
28 | like mongolian or scripts requiring extremely complex combining rules, |
|
|
29 | like tibetan or devenagari. Don't expect pretty output when using these |
|
|
30 | scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work |
|
|
31 | fine, though. A somewhat difficult case are left-to-right scripts, such |
|
|
32 | as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms |
|
|
33 | belong into the application, not the terminal emulator (too many things -- |
|
|
34 | such as cursor-movement while editing -- break otherwise), but that might |
|
|
35 | change. |
|
|
36 | |
|
|
37 | 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 |
|
|
39 | 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 |
|
|
41 | another for japanese. |
|
|
42 | |
|
|
43 | Therefore another design rationale was the use of multiple fonts to |
|
|
44 | 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 |
|
|
46 | to choose any font for any script freely. |
|
|
47 | |
|
|
48 | 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 |
|
|
50 | in i18n-environments, is faster, and has a lot less bugs than the original |
|
|
51 | rxvt. This all in addition to dozens of other small improvements. |
|
|
52 | |
|
|
53 | 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 |
|
|
55 | without most of it's features to get a lean binary. It also comes with |
|
|
56 | 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 |
|
|
58 | drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and |
|
|
59 | @@RXVT_NAME@@c(1) (client). |
|
|
60 | |
|
|
61 | It also makes technical information about escape sequences (which have |
|
|
62 | been extended) easier accessible: see @@RXVT_NAME@@(7) for technical |
|
|
63 | reference documentation (escape sequences etc.). |
19 | |
64 | |
20 | =head1 OPTIONS |
65 | =head1 OPTIONS |
21 | |
66 | |
22 | The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed |
67 | The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed |
23 | below. In keeping with the smaller-is-better philosophy, options may be |
68 | below. In keeping with the smaller-is-better philosophy, options may be |
24 | eliminated or default values chosen at compile-time, so options and |
69 | eliminated or default values chosen at compile-time, so options and |
25 | defaults listed may not accurately reflect the version installed on |
70 | defaults listed may not accurately reflect the version installed on |
26 | your system. `rxvt -h' gives a list of major compile-time options on |
71 | your system. `@@RXVT_NAME@@ -h' gives a list of major compile-time options on |
27 | the I<Options> line. Option descriptions may be prefixed with which |
72 | the I<Options> line. Option descriptions may be prefixed with which |
28 | compile option each is dependent upon. e.g. `Compile I<XIM>:' requires |
73 | compile option each is dependent upon. e.g. `Compile I<XIM>:' requires |
29 | I<XIM> on the I<Options> line. Note: `rxvt -help' gives a list of all |
74 | I<XIM> on the I<Options> line. Note: `@@RXVT_NAME@@ -help' gives a list of all |
30 | command-line options compiled into your version. |
75 | command-line options compiled into your version. |
31 | |
76 | |
32 | Note that B<@@RXVT_NAME@@> permits the resource name to be used as a |
77 | Note that B<@@RXVT_NAME@@> permits the resource name to be used as a |
33 | long-option (--/++ option) so the potential command-line options are |
78 | long-option (--/++ option) so the potential command-line options are |
34 | far greater than those listed. For example: `rxvt --loginShell --color1 |
79 | far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1 |
35 | Orange'. |
80 | Orange'. |
36 | |
81 | |
37 | The following options are available: |
82 | The following options are available: |
38 | |
83 | |
39 | =over 4 |
84 | =over 4 |
… | |
… | |
65 | Turn on/off inheriting parent window's pixmap. Alternative form is |
110 | Turn on/off inheriting parent window's pixmap. Alternative form is |
66 | B<-tr>; resource B<inheritPixmap>. |
111 | B<-tr>; resource B<inheritPixmap>. |
67 | |
112 | |
68 | =item B<-fade> I<number> |
113 | =item B<-fade> I<number> |
69 | |
114 | |
70 | Fade the text by the given percentage when focus is lost. |
115 | Fade the text by the given percentage when focus is lost. resource B<fading>. |
71 | |
116 | |
72 | =item B<-tint> I<colour> |
117 | =item B<-tint> I<colour> |
73 | |
118 | |
74 | Tint the transparent background pixmap with the given colour when |
119 | Tint the transparent background pixmap with the given colour when |
75 | transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> |
120 | transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> |
… | |
… | |
78 | |
123 | |
79 | =item B<-sh> |
124 | =item B<-sh> |
80 | |
125 | |
81 | I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
126 | I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
82 | background image in addition to tinting it (i.e. B<-tint> must be |
127 | background image in addition to tinting it (i.e. B<-tint> must be |
83 | specified, too). |
128 | specified, too, e.g. C<-tint white>). |
84 | |
129 | |
85 | =item B<-bg> I<colour> |
130 | =item B<-bg> I<colour> |
86 | |
131 | |
87 | Window background colour; resource B<background>. |
132 | Window background colour; resource B<background>. |
88 | |
133 | |
… | |
… | |
91 | Window foreground colour; resource B<foreground>. |
136 | Window foreground colour; resource B<foreground>. |
92 | |
137 | |
93 | =item B<-pixmap> I<file[;geom]> |
138 | =item B<-pixmap> I<file[;geom]> |
94 | |
139 | |
95 | Compile I<XPM>: Specify XPM file for the background and also optionally |
140 | Compile I<XPM>: Specify XPM file for the background and also optionally |
96 | specify its scaling with a geometry string. Note you may need to add |
141 | specify its scaling with a geometry string. Note you may need to |
97 | quotes to avoid special shell interpretation of the `;' in the |
142 | add quotes to avoid special shell interpretation of the C<;> in the |
98 | command-line; resource B<backgroundPixmap>. |
143 | command-line; resource B<backgroundPixmap>. |
99 | |
144 | |
100 | =item B<-cr> I<colour> |
145 | =item B<-cr> I<colour> |
101 | |
146 | |
102 | The cursor colour; resource B<cursorColor>. |
147 | The cursor colour; resource B<cursorColor>. |
… | |
… | |
109 | |
154 | |
110 | The mouse pointer background colour; resource B<pointerColor2>. |
155 | The mouse pointer background colour; resource B<pointerColor2>. |
111 | |
156 | |
112 | =item B<-bd> I<colour> |
157 | =item B<-bd> I<colour> |
113 | |
158 | |
114 | The colour of the border between the xterm scrollbar and the text; |
159 | The colour of the border around the text area and between the scrollbar and the text; |
115 | resource B<borderColor>. |
160 | resource B<borderColor>. |
116 | |
161 | |
117 | =item B<-fn> I<fontname> |
162 | =item B<-fn> I<fontlist> |
118 | |
163 | |
119 | Select the fonts to be used. This is a comma seperated list of font |
164 | Select the fonts to be used. This is a comma separated list of font names |
120 | names that are used in turn when trying to display Unicode characters. |
165 | that are used in turn when trying to display Unicode characters. The |
121 | The first font defines the cell size for characters; other fonts might |
166 | first font defines the cell size for characters; other fonts might be |
122 | be smaller, but not larger. A reasonable default font list is always |
167 | smaller, but not (in general) larger. A (hopefully) reasonable default |
123 | appended to it. resource B<font>. |
168 | font list is always appended to it. See resource B<font> for more details. |
124 | |
169 | |
125 | =item B<-rb>|B<+rb> |
170 | In short, to specify an X11 core font, just specify it's name or prefix it |
|
|
171 | with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, |
|
|
172 | e.g.: |
126 | |
173 | |
127 | Enable "real bold" support. When this option is on, bold text will be |
174 | @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
128 | displayed using the first available bold font in the font list. Bold |
175 | @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
129 | fonts should thus be specified in the font list after their |
176 | |
130 | corresponding regular fonts. If no bold font can be found, a regular |
177 | See also the question "How does rxvt-unicode choose fonts?" in the FAQ |
131 | font will be used. resource B<realBold>. |
178 | section of @@RXVT_NAME@@(7). |
|
|
179 | |
|
|
180 | =item B<-fb> I<fontlist> |
|
|
181 | |
|
|
182 | Compile font-styles: The bold font list to use when bold characters are to |
|
|
183 | be printed. See resource B<boldFont> for details. |
|
|
184 | |
|
|
185 | =item B<-fi> I<fontlist> |
|
|
186 | |
|
|
187 | Compile font-styles: The italic font list to use when bold characters are to |
|
|
188 | be printed. See resource B<italicFont> for details. |
|
|
189 | |
|
|
190 | =item B<-fbi> I<fontlist> |
|
|
191 | |
|
|
192 | Compile font-styles: The bold italic font list to use when bold characters are to |
|
|
193 | be printed. See resource B<boldItalicFont> for details. |
132 | |
194 | |
133 | =item B<-name> I<name> |
195 | =item B<-name> I<name> |
134 | |
196 | |
135 | Specify the application name under which resources are to be obtained, |
197 | Specify the application name under which resources are to be obtained, |
136 | rather than the default executable file name. Name should not contain |
198 | rather than the default executable file name. Name should not contain |
… | |
… | |
177 | =item B<-st>|B<+st> |
239 | =item B<-st>|B<+st> |
178 | |
240 | |
179 | Display normal (non XTerm/NeXT) scrollbar without/with a trough; |
241 | Display normal (non XTerm/NeXT) scrollbar without/with a trough; |
180 | resource B<scrollBar_floating>. |
242 | resource B<scrollBar_floating>. |
181 | |
243 | |
|
|
244 | =item B<-ptab>|B<+ptab> |
|
|
245 | |
|
|
246 | If enabled (default), "Horizontal Tab" characters are being stored as |
|
|
247 | actual wide characters in the screen buffer, which makes it possible to |
|
|
248 | select and paste them. Since a horizontal tab is a cursor movement and |
|
|
249 | not an actual glyph, this can sometimes be visually annoying as the cursor |
|
|
250 | on a tab character is displayed as a wide cursor; resource B<pastableTabs>. |
|
|
251 | |
182 | =item B<-bc>|B<+bc> |
252 | =item B<-bc>|B<+bc> |
183 | |
253 | |
184 | Blink the cursor; resource B<cursorBlink>. |
254 | Blink the cursor; resource B<cursorBlink>. |
185 | |
255 | |
186 | =item B<-iconic> |
256 | =item B<-iconic> |
… | |
… | |
205 | B<externalBorder>. |
275 | B<externalBorder>. |
206 | |
276 | |
207 | =item B<-bl> |
277 | =item B<-bl> |
208 | |
278 | |
209 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
279 | Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
210 | if honoured by the WM, the rxvt window will not have window |
280 | if honoured by the WM, the rxvt-unicode window will not have window |
211 | decorations; resource B<borderLess>. |
281 | decorations; resource B<borderLess>. |
212 | |
282 | |
213 | =item B<-lsp> I<number> |
283 | =item B<-lsp> I<number> |
214 | |
284 | |
215 | Compile I<linespace>: Lines (pixel height) to insert between each row |
285 | Compile I<frills>: Lines (pixel height) to insert between each row of |
216 | of the display; resource B<linespace>. |
286 | the display. Useful to work around font rendering problems; resource |
|
|
287 | B<linespace>. |
217 | |
288 | |
218 | =item B<-tn> I<termname> |
289 | =item B<-tn> I<termname> |
219 | |
290 | |
220 | This option specifies the name of the terminal type to be set in the |
291 | This option specifies the name of the terminal type to be set in the |
221 | B<TERM> environment variable. This terminal type must exist in the |
292 | B<TERM> environment variable. This terminal type must exist in the |
… | |
… | |
286 | Turn on/off secondary screen scroll (default enabled); resource |
357 | Turn on/off secondary screen scroll (default enabled); resource |
287 | B<secondaryScroll>. |
358 | B<secondaryScroll>. |
288 | |
359 | |
289 | =item B<-xrm> I<resourcestring> |
360 | =item B<-xrm> I<resourcestring> |
290 | |
361 | |
291 | No effect on rxvt. Simply passes through an argument to be made |
362 | No effect on rxvt-unicode. Simply passes through an argument to be made |
292 | available in the instance's argument list. Appears in I<WM_COMMAND> in |
363 | available in the instance's argument list. Appears in I<WM_COMMAND> in |
293 | some window managers. |
364 | some window managers. |
294 | |
365 | |
295 | =back |
366 | =back |
296 | |
367 | |
… | |
… | |
345 | high-intensity (bold = bright foreground, blink = bright background) |
416 | high-intensity (bold = bright foreground, blink = bright background) |
346 | colours. The canonical names are as follows: 0=black, 1=red, 2=green, |
417 | colours. The canonical names are as follows: 0=black, 1=red, 2=green, |
347 | 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour |
418 | 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour |
348 | names used are listed in the B<COLORS AND GRAPHICS> section. |
419 | names used are listed in the B<COLORS AND GRAPHICS> section. |
349 | |
420 | |
|
|
421 | Colours higher than 15 cannot be set using resources (yet), but can be |
|
|
422 | changed using an escape command (see @@RXVT_NAME@@(7)). |
|
|
423 | |
|
|
424 | Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with |
|
|
425 | 88 colour support). Colours 80-87 are evenly spaces grey steps. |
|
|
426 | |
350 | =item B<colorBD:> I<colour> |
427 | =item B<colorBD:> I<colour> |
351 | |
428 | |
|
|
429 | =item B<colorIT:> I<colour> |
|
|
430 | |
352 | Use the specified colour to display bold characters when the foreground |
431 | Use the specified colour to display bold or italic characters when the |
353 | colour is the default. This option will be ignored if B<realBold> is |
432 | foreground colour is the default. If font styles are not available |
354 | enabled. |
433 | (Compile I<styles>) and this option is unset, reverse video is used instead. |
355 | |
434 | |
356 | =item B<colorUL:> I<colour> |
435 | =item B<colorUL:> I<colour> |
357 | |
436 | |
358 | Use the specified colour to display underlined characters when the |
437 | Use the specified colour to display underlined characters when the |
359 | foreground colour is the default. |
438 | foreground colour is the default. |
360 | |
439 | |
361 | =item B<colorRV:> I<colour> |
440 | =item B<colorRV:> I<colour> |
362 | |
441 | |
363 | Use the specified colour as the background for reverse video |
442 | Use the specified colour as the background for reverse video |
364 | characters. |
443 | characters. |
|
|
444 | |
|
|
445 | =item B<underlineColor:> I<colour> |
|
|
446 | |
|
|
447 | If set, use the specified colour as the colour for the underline |
|
|
448 | itself. If unset, use the foreground colour. |
365 | |
449 | |
366 | =item B<cursorColor:> I<colour> |
450 | =item B<cursorColor:> I<colour> |
367 | |
451 | |
368 | Use the specified colour for the cursor. The default is to use the |
452 | Use the specified colour for the cursor. The default is to use the |
369 | foreground colour; option B<-cr>. |
453 | foreground colour; option B<-cr>. |
… | |
… | |
403 | =item B<shading:> I<number> |
487 | =item B<shading:> I<number> |
404 | |
488 | |
405 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
489 | Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
406 | image in addition to tinting it. |
490 | image in addition to tinting it. |
407 | |
491 | |
408 | =item B<fading:> I<number> |
|
|
409 | |
|
|
410 | Scale the tint colour by the given percentage. |
|
|
411 | |
|
|
412 | =item B<scrollColor:> I<colour> |
492 | =item B<scrollColor:> I<colour> |
413 | |
493 | |
414 | Use the specified colour for the scrollbar [default #B2B2B2]. |
494 | Use the specified colour for the scrollbar [default #B2B2B2]. |
415 | |
495 | |
416 | =item B<troughColor:> I<colour> |
496 | =item B<troughColor:> I<colour> |
417 | |
497 | |
418 | Use the specified colour for the scrollbar's trough area [default |
498 | Use the specified colour for the scrollbar's trough area [default |
419 | #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. |
499 | #969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. |
|
|
500 | |
|
|
501 | =item B<borderColor:> I<colour> |
|
|
502 | |
|
|
503 | The colour of the border around the text area and between the scrollbar |
|
|
504 | and the text. |
420 | |
505 | |
421 | =item B<backgroundPixmap:> I<file[;geom]> |
506 | =item B<backgroundPixmap:> I<file[;geom]> |
422 | |
507 | |
423 | Use the specified XPM file (note the `.xpm' extension is optional) for |
508 | Use the specified XPM file (note the `.xpm' extension is optional) for |
424 | the background and also optionally specify its scaling with a geometry |
509 | the background and also optionally specify its scaling with a geometry |
… | |
… | |
440 | |
525 | |
441 | Specify the colon-delimited search path for finding files (XPM and |
526 | Specify the colon-delimited search path for finding files (XPM and |
442 | menus), in addition to the paths specified by the B<RXVTPATH> and |
527 | menus), in addition to the paths specified by the B<RXVTPATH> and |
443 | B<PATH> environment variables. |
528 | B<PATH> environment variables. |
444 | |
529 | |
445 | =item B<font:> I<fontname> |
530 | =item B<font:> I<fontlist> |
446 | |
531 | |
447 | Select the fonts to be used. This is a comma seperated list of font |
532 | Select the fonts to be used. This is a comma separated list of font |
448 | names that are used in turn when trying to display Unicode characters. |
533 | names that are used in turn when trying to display Unicode characters. |
449 | The first font defines the cell size for characters; other fonts might |
534 | The first font defines the cell size for characters; other fonts might |
450 | be smaller, but not larger. A reasonable default font list is always |
535 | be smaller, but not larger. A reasonable default font list is always |
451 | appended to it. option B<-fn>. |
536 | appended to it. option B<-fn>. |
452 | |
537 | |
453 | =item B<realBold:> I<boolean> |
538 | Each font can either be a standard X11 core font (XLFD) name, with |
|
|
539 | optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. |
454 | |
540 | |
455 | B<True>: Enable "real bold" support. When this option is on, bold text |
541 | In addition, each font can be prefixed with additional hints and |
456 | will be displayed using the first available bold font in the font list. |
542 | specifications enclosed in square brackets (C<[]>). The only available |
457 | Bold fonts should thus be specified in the font list after their |
543 | hint currently is C<codeset=codeset-name>, and this is only used for Xft |
458 | corresponding regular fonts. If no bold font can be found, a regular |
544 | fonts. |
459 | font will be used. option B<-rb>. B<False>: Display bold text in a |
545 | |
460 | regular font, using the color specified with B<colorBD>; option B<+rb>. |
546 | For example, this font resource |
|
|
547 | |
|
|
548 | URxvt*font: 9x15bold,\ |
|
|
549 | -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ |
|
|
550 | -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ |
|
|
551 | [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ |
|
|
552 | xft:Code2000:antialias=false |
|
|
553 | |
|
|
554 | specifies five fonts to be used. The first one is C<9x15bold> (actually |
|
|
555 | the iso8859-1 version of the second font), which is the base font (because |
|
|
556 | it is named first) and thus defines the character cell grid to be 9 pixels |
|
|
557 | wide and 15 pixels high. |
|
|
558 | |
|
|
559 | The second font is just used to add additional unicode characters not in |
|
|
560 | the base font, likewise the third, which is unfortunately non-bold, but |
|
|
561 | the bold version of the font does contain less characters, so this is a |
|
|
562 | useful supplement. |
|
|
563 | |
|
|
564 | The third font is an Xft font with aliasing turned off, and the characters |
|
|
565 | are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font |
|
|
566 | contains other characters, but we are not interested in them. |
|
|
567 | |
|
|
568 | The last font is a useful catch-all font that supplies most of the |
|
|
569 | remaining unicode characters. |
|
|
570 | |
|
|
571 | =item B<boldFont:> I<fontlist> |
|
|
572 | |
|
|
573 | =item B<italicFont:> I<fontlist> |
|
|
574 | |
|
|
575 | =item B<boldItalicFont:> I<fontlist> |
|
|
576 | |
|
|
577 | The font list to use for displaying B<bold>, I<italic> or B<< I<bold |
|
|
578 | italic> >> characters, respectively. |
|
|
579 | |
|
|
580 | If specified and non-empty, then the syntax is the same as for the |
|
|
581 | B<font>-resource, and the given font list will be used as is, which makes |
|
|
582 | it possible to substitute completely different font styles for bold and |
|
|
583 | italic. |
|
|
584 | |
|
|
585 | If unset (the default), a suitable font list will be synthesized by |
|
|
586 | "morphing" the normal text font list into the desired shape. If that is |
|
|
587 | not possible, replacement fonts of the desired shape will be tried. |
|
|
588 | |
|
|
589 | If set, but empty, then this specific style is disabled and the normal |
|
|
590 | text font will being used for the given style. |
461 | |
591 | |
462 | =item B<selectstyle:> I<mode> |
592 | =item B<selectstyle:> I<mode> |
463 | |
593 | |
464 | Set mouse selection style to B<old> which is 2.20, B<oldword> which is |
594 | Set mouse selection style to B<old> which is 2.20, B<oldword> which is |
465 | xterm style with 2.20 old word selection, or anything else which gives |
595 | xterm style with 2.20 old word selection, or anything else which gives |
466 | xterm style selection. |
596 | xterm style selection. |
467 | |
597 | |
468 | =item B<scrollstyle:> I<mode> |
598 | =item B<scrollstyle:> I<mode> |
469 | |
599 | |
470 | Set scrollbar style to B<@@RXVT_NAME@@>, B<rxvt>, B<plain>, B<next> or |
600 | Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
471 | B<xterm> |
601 | the author's favourite.. |
472 | |
602 | |
473 | =item B<title:> I<string> |
603 | =item B<title:> I<string> |
474 | |
604 | |
475 | Set window title string, the default title is the command-line |
605 | Set window title string, the default title is the command-line |
476 | specified after the B<-e> option, if any, otherwise the application |
606 | specified after the B<-e> option, if any, otherwise the application |
… | |
… | |
530 | Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar |
660 | Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar |
531 | thumb with the pointer on middle button press/drag. |
661 | thumb with the pointer on middle button press/drag. |
532 | |
662 | |
533 | =item B<scrollTtyOutput:> I<boolean> |
663 | =item B<scrollTtyOutput:> I<boolean> |
534 | |
664 | |
535 | B<True>: scroll to bottom when tty receives output; option B<+si>. |
665 | B<True>: scroll to bottom when tty receives output; option B<-si>. |
536 | B<False>: do not scroll to bottom when tty receives output; option |
666 | B<False>: do not scroll to bottom when tty receives output; option |
537 | B<-si>. |
667 | B<+si>. |
538 | |
668 | |
539 | =item B<scrollWithBuffer:> I<boolean> |
669 | =item B<scrollWithBuffer:> I<boolean> |
540 | |
670 | |
541 | B<True>: scroll with scrollback buffer when tty recieves new lines (and |
671 | B<True>: scroll with scrollback buffer when tty receives new lines (and |
542 | B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll |
672 | B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll |
543 | with scrollback buffer when tty recieves new lines; option B<-sw>. |
673 | with scrollback buffer when tty recieves new lines; option B<-sw>. |
544 | |
674 | |
545 | =item B<scrollTtyKeypress:> I<boolean> |
675 | =item B<scrollTtyKeypress:> I<boolean> |
546 | |
676 | |
547 | B<True>: scroll to bottom when a non-special key is pressed. Special |
677 | B<True>: scroll to bottom when a non-special key is pressed. Special keys |
548 | keys are those which are intercepted by rxvt for special handling and |
678 | are those which are intercepted by rxvt-unicode for special handling and |
549 | are not passed onto the shell; option B<-sk>. B<False>: do not scroll |
679 | are not passed onto the shell; option B<-sk>. B<False>: do not scroll to |
550 | to bottom when a non-special key is pressed; option B<+sk>. |
680 | bottom when a non-special key is pressed; option B<+sk>. |
551 | |
|
|
552 | =item B<smallfont_key:> I<keysym> |
|
|
553 | |
|
|
554 | If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a smaller font |
|
|
555 | [default B<@@HOTKEY@@-@@SMALLFONT@@>] |
|
|
556 | |
|
|
557 | =item B<bigfont_key:> I<keysym> |
|
|
558 | |
|
|
559 | If enabled, use B<@@HOTKEY@@->I<keysym> to toggle to a bigger font |
|
|
560 | [default B<@@HOTKEY@@-@@BIGFONT@@>] |
|
|
561 | |
681 | |
562 | =item B<saveLines:> I<number> |
682 | =item B<saveLines:> I<number> |
563 | |
683 | |
564 | Save I<number> lines in the scrollback buffer [default 64]. This |
684 | Save I<number> lines in the scrollback buffer [default 64]. This |
565 | resource is limited on most machines to 65535; option B<-sl>. |
685 | resource is limited on most machines to 65535; option B<-sl>. |
… | |
… | |
575 | option B<-w>, B<-bw>, B<-borderwidth>. |
695 | option B<-w>, B<-bw>, B<-borderwidth>. |
576 | |
696 | |
577 | =item B<borderLess:> I<boolean> |
697 | =item B<borderLess:> I<boolean> |
578 | |
698 | |
579 | Set MWM hints to request a borderless window, i.e. if honoured by the |
699 | Set MWM hints to request a borderless window, i.e. if honoured by the |
580 | WM, the rxvt window will not have window decorations; option B<-bl>. |
700 | WM, the rxvt-unicode window will not have window decorations; option B<-bl>. |
581 | |
701 | |
582 | =item B<termName:> I<termname> |
702 | =item B<termName:> I<termname> |
583 | |
703 | |
584 | Specifies the terminal type name to be set in the B<TERM> environment |
704 | Specifies the terminal type name to be set in the B<TERM> environment |
585 | variable; option B<-tn>. |
705 | variable; option B<-tn>. |
… | |
… | |
596 | |
716 | |
597 | =item B<mouseWheelScrollPage:> I<boolean> |
717 | =item B<mouseWheelScrollPage:> I<boolean> |
598 | |
718 | |
599 | B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel |
719 | B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel |
600 | scrolls five lines [default]. |
720 | scrolls five lines [default]. |
|
|
721 | |
|
|
722 | =item B<pastableTabs:> I<boolean> |
|
|
723 | |
|
|
724 | B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor |
|
|
725 | movement only; option C<-ptab>. |
601 | |
726 | |
602 | =item B<cursorBlink:> I<boolean> |
727 | =item B<cursorBlink:> I<boolean> |
603 | |
728 | |
604 | B<True>: blink the cursor. B<False>: do not blink the cursor [default]; |
729 | B<True>: blink the cursor. B<False>: do not blink the cursor [default]; |
605 | option B<-bc>. |
730 | option B<-bc>. |
… | |
… | |
655 | The locale to use for opening the IM. You can use an LC_CTYPE of e.g. |
780 | The locale to use for opening the IM. You can use an LC_CTYPE of e.g. |
656 | de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input |
781 | de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input |
657 | extension to be able to input japanese characters while staying in |
782 | extension to be able to input japanese characters while staying in |
658 | another locale. option B<-imlocale>. |
783 | another locale. option B<-imlocale>. |
659 | |
784 | |
660 | =item B<insecure> |
785 | =item B<insecure:> I<boolean> |
661 | |
786 | |
662 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences that |
787 | Enables "insecure" mode. Rxvt-unicode offers some escape sequences that |
663 | echo arbitrary strings like the icon name or the locale. This could be |
788 | echo arbitrary strings like the icon name or the locale. This could be |
664 | abused if somebody gets 8-bit-clean access to your display, wether |
789 | abused if somebody gets 8-bit-clean access to your display, whether |
665 | throuh a mail client displaying mail bodies unfiltered or though |
790 | throuh a mail client displaying mail bodies unfiltered or though |
666 | write(1). Therefore, these sequences are disabled by default. (Note |
791 | write(1). Therefore, these sequences are disabled by default. (Note |
667 | that other terminals, including xterm, have these sequences |
792 | that other terminals, including xterm, have these sequences |
668 | enabled by default). You can enable them by setting this boolean |
793 | enabled by default). You can enable them by setting this boolean |
669 | resource or specifying B<-insecure> as an option. At the moment, this |
794 | resource or specifying B<-insecure> as an option. At the moment, this |
… | |
… | |
676 | B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option |
801 | B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option |
677 | B<-mod>. |
802 | B<-mod>. |
678 | |
803 | |
679 | =item B<answerbackString:> I<string> |
804 | =item B<answerbackString:> I<string> |
680 | |
805 | |
681 | Specify the reply rxvt sends to the shell when an ENQ (control-E) |
806 | Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) |
682 | character is passed through. It may contain escape values as described |
807 | character is passed through. It may contain escape values as described |
683 | in the entry on B<keysym> following. |
808 | in the entry on B<keysym> following. |
684 | |
809 | |
685 | =item B<secondaryScreen:> I<bool> |
810 | =item B<secondaryScreen:> I<bool> |
686 | |
811 | |
… | |
… | |
693 | scrollback buffer and switching to/from the secondary screen will |
818 | scrollback buffer and switching to/from the secondary screen will |
694 | instead scroll the screen up. |
819 | instead scroll the screen up. |
695 | |
820 | |
696 | =item B<keysym.>I<sym>: I<string> |
821 | =item B<keysym.>I<sym>: I<string> |
697 | |
822 | |
698 | Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may |
823 | Compile I<frills>: Associate I<string> with keysym I<sym>. The |
699 | contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: |
824 | intervening resource name B<keysym.> cannot be omitted. |
700 | newline, \r: return, \t: |
825 | |
|
|
826 | The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be |
|
|
827 | any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, |
|
|
828 | B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, |
|
|
829 | and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, |
|
|
830 | B<2>, B<3>, B<4>, B<5>. |
|
|
831 | |
|
|
832 | The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to |
|
|
833 | whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr |
|
|
834 | keys are being mapped. B<AppKeypad> is a artificial modifier mapped to the |
|
|
835 | current application keymap mode state. |
|
|
836 | |
|
|
837 | The spellings of I<key> can be obtained by using B<xev>(1) command or |
|
|
838 | searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and |
|
|
839 | omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex |
|
|
840 | keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not |
|
|
841 | performed in an exact manner; however, the closest match is assured. |
|
|
842 | |
|
|
843 | I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, |
|
|
844 | C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, |
701 | tab, \000: octal number) or control characters (^?: delete, ^@: null, |
845 | C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
702 | ^A ...) and may enclosed with double quotes so that it can start or end |
846 | C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it |
703 | with whitespace. The intervening resource name B<keysym.> cannot be |
847 | can start or end with whitespace. |
704 | omitted. This resource is only available when compiled with |
848 | |
705 | KEYSYM_RESOURCE. |
849 | You can define a range of keysyms in one shot by providing a I<string> |
|
|
850 | with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' |
|
|
851 | should be a character not used by the strings. |
|
|
852 | |
|
|
853 | Its usage can be demonstrated by an example: |
|
|
854 | |
|
|
855 | URxvt.keysym.M-C-0x61: list|\e<M-C-|abc|> |
|
|
856 | |
|
|
857 | The above line is equivalent to the following three lines: |
|
|
858 | |
|
|
859 | URxvt.keysym.Meta-Control-0x61: \e<M-C-a> |
|
|
860 | URxvt.keysym.Meta-Control-0x62: \e<M-C-b> |
|
|
861 | URxvt.keysym.Meta-Control-0x63: \e<M-C-c> |
|
|
862 | |
|
|
863 | If I<string> takes the form of C<proto:STRING>, the specified B<STRING> is |
|
|
864 | interpreted and executed as @@RXVT_NAME@@'s control sequence. For example, |
|
|
865 | C<proto:\033]701;zh_CN.GBK\007> means: change the current locale to |
|
|
866 | C<zh_CN.GBK>. |
706 | |
867 | |
707 | =back |
868 | =back |
708 | |
869 | |
709 | =head1 THE SCROLLBAR |
870 | =head1 THE SCROLLBAR |
710 | |
871 | |
… | |
… | |
743 | Left click at the beginning of the region, drag to the end of the |
904 | Left click at the beginning of the region, drag to the end of the |
744 | region and release; Right click to extend the marked region; Left |
905 | region and release; Right click to extend the marked region; Left |
745 | double-click to select a word; Left triple-click to select the entire |
906 | double-click to select a word; Left triple-click to select the entire |
746 | line. |
907 | line. |
747 | |
908 | |
|
|
909 | Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) |
|
|
910 | (Compile: I<frills>) will create a rectangular selection instead of a normal |
|
|
911 | one. |
|
|
912 | |
748 | =item B<Insertion>: |
913 | =item B<Insertion>: |
749 | |
914 | |
750 | Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in |
915 | Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in |
751 | an B<@@RXVT_NAME@@> window causes the current text selection to be |
916 | an B<@@RXVT_NAME@@> window causes the current text selection to be |
752 | inserted as if it had been typed on the keyboard. |
917 | inserted as if it had been typed on the keyboard. |
753 | |
918 | |
754 | =back |
919 | =back |
755 | |
920 | |
756 | =head1 CHANGING FONTS |
921 | =head1 CHANGING FONTS |
757 | |
922 | |
758 | You can change fonts on-the-fly, which is to say cycle through the |
923 | Changing fonts (or font sizes, respectively) via the keypad is not yet |
759 | default font and others of various sizes, by using B<Shift-KP_Add> and |
924 | supported in rxvt-unicode. Bug me if you need this. |
760 | B<Shift-KP_Subtract>. Or, alternatively (if enabled) with |
925 | |
761 | B<@@HOTKEY@@-@@BIGFONT@@> and B<@@HOTKEY@@-@@SMALLFONT@@>, where the |
926 | You can, however, switch fonts at runtime using escape sequences (and |
762 | actual key can be selected using resources |
927 | therefore using the menubar), e.g.: |
763 | B<smallfont_key>/B<bigfont_key>. |
928 | |
|
|
929 | printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" |
|
|
930 | |
|
|
931 | rxvt-unicode will automatically re-apply these fonts to the output so far. |
764 | |
932 | |
765 | =head1 ISO 14755 SUPPORT |
933 | =head1 ISO 14755 SUPPORT |
766 | |
934 | |
767 | Partial ISO 14755-support is implemented. that means that pressing |
935 | ISO 14755 is a standard for entering and viewing unicode characters |
|
|
936 | and character codes using the keyboard. It consists of 4 parts. The |
|
|
937 | first part is available rxvt-unicode has been compiled with |
|
|
938 | C<--enable-frills>, the rest is available when rxvt-unicode was compiled |
|
|
939 | with C<--enable-iso14755>. |
768 | |
940 | |
769 | Section 5.1: Control and Shift together enters unicode input |
941 | =over 4 |
770 | mode. Entering hex digits composes a Unicode character, pressing space or |
|
|
771 | releasing the modifiers commits the keycode and every other key cancels |
|
|
772 | the current input character. |
|
|
773 | |
942 | |
774 | Section 5.2: Pressing and immediately releasing Control and Shift together |
943 | =item 5.1: Basic method |
775 | enters keycap entry mode for the next key: pressing a function key (tab, |
944 | |
776 | return etc..) will enter the unicode character corresponding to the given |
945 | This allows you to enter unicode characters using their hexcode. |
777 | key. |
946 | |
|
|
947 | Start by pressing and holding both C<Control> and C<Shift>, then enter |
|
|
948 | hex-digits (between one and six). Releasing C<Control> and C<Shift> will |
|
|
949 | commit the character as if it were typed directly. While holding down |
|
|
950 | C<Control> and C<Shift> you can also enter multiple characters by pressing |
|
|
951 | C<Space>, which will commit the current character and lets you start a new |
|
|
952 | one. |
|
|
953 | |
|
|
954 | As an example of use, imagine a business card with a japanese e-mail |
|
|
955 | address, which you cannot type. Fortunately, the card has the e-mail |
|
|
956 | address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily |
|
|
957 | by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>, |
|
|
958 | followed by releasing the modifier keys. |
|
|
959 | |
|
|
960 | =item 5.2: Keyboard symbols entry method |
|
|
961 | |
|
|
962 | This mode lets you input characters representing the keycap symbols of |
|
|
963 | your keyboard, if representable in the current locale encoding. |
|
|
964 | |
|
|
965 | Start by pressing C<Control> and C<Shift> together, then releasing |
|
|
966 | them. The next special key (cursor keys, home etc.) you enter will not |
|
|
967 | invoke it's usual function but instead will insert the corresponding |
|
|
968 | keycap symbol. The symbol will only be entered when the key has been |
|
|
969 | released, otherwise pressing e.g. C<Shift> would enter the symbol for |
|
|
970 | C<ISO Level 2 Switch>, although your intention might have been to enter a |
|
|
971 | reverse tab (Shift-Tab). |
|
|
972 | |
|
|
973 | =item 5.3: Screen-selection entry method |
|
|
974 | |
|
|
975 | While this is implemented already (it's basically the selection |
|
|
976 | mechanism), it could be extended by displaying a unicode character map. |
|
|
977 | |
|
|
978 | =item 5.4: Feedback method for identifying displayed characters for later input |
|
|
979 | |
|
|
980 | This method lets you display the unicode character code associated with |
|
|
981 | characters already displayed. |
|
|
982 | |
|
|
983 | You enter this mode by holding down C<Control> and C<Shift> together, then |
|
|
984 | pressing and holding the left mouse button and moving around. The unicode |
|
|
985 | hex code(s) (it might be a combining character) of the character under the |
|
|
986 | pointer is displayed until you release C<Control> and C<Shift>. |
|
|
987 | |
|
|
988 | In addition to the hex codes it will display the font used to draw this |
|
|
989 | character - due to implementation reasons, characters combined with |
|
|
990 | combining characters, line drawing characters and unknown characters will |
|
|
991 | always be drawn using the built-in support font. |
|
|
992 | |
|
|
993 | =back |
|
|
994 | |
|
|
995 | With respect to conformance, rxvt-unicode is supposed to be compliant to |
|
|
996 | both scenario A and B of ISO 14755, including part 5.2. |
778 | |
997 | |
779 | =head1 LOGIN STAMP |
998 | =head1 LOGIN STAMP |
780 | |
999 | |
781 | B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so |
1000 | B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so |
782 | that it can be seen via the I<who(1)> command, and can accept messages. |
1001 | that it can be seen via the I<who(1)> command, and can accept messages. |
… | |
… | |
823 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
1042 | I<xterm>(1) where the colours are only swapped if they have not otherwise |
824 | been specified. For example, |
1043 | been specified. For example, |
825 | |
1044 | |
826 | =over 4 |
1045 | =over 4 |
827 | |
1046 | |
828 | =item B<rxvt -fg Black -bg White -rv> |
1047 | =item B<@@RXVT_NAME@@ -fg Black -bg White -rv> |
829 | |
1048 | |
830 | would yield White on Black, while on I<xterm>(1) it would yield Black |
1049 | would yield White on Black, while on I<xterm>(1) it would yield Black |
831 | on White. |
1050 | on White. |
832 | |
1051 | |
833 | =back |
1052 | =back |
… | |
… | |
853 | |
1072 | |
854 | Color names. |
1073 | Color names. |
855 | |
1074 | |
856 | =back |
1075 | =back |
857 | |
1076 | |
858 | =head1 SEEALSO |
1077 | =head1 SEE ALSO |
859 | |
1078 | |
860 | I<xterm>(1), I<sh>(1), I<resize>(1), I<X>(1), I<pty>(4), I<tty>(4), I<utmp>(5) |
1079 | @@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) |
861 | |
|
|
862 | See rxvtRef.html rxvtRef.txt for detailed information on recognized escape sequences and menuBar syntax, etc. |
|
|
863 | |
1080 | |
864 | =head1 BUGS |
1081 | =head1 BUGS |
865 | |
1082 | |
866 | Check the BUGS file for an up-to-date list. |
1083 | Check the BUGS file for an up-to-date list. |
867 | |
1084 | |
… | |
… | |
873 | |
1090 | |
874 | =over 4 |
1091 | =over 4 |
875 | |
1092 | |
876 | =item Project Coordinator |
1093 | =item Project Coordinator |
877 | |
1094 | |
878 | @@RXVTMAINT@@ L<@@RXVT_MAINTEMAIL@@> |
1095 | @@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> |
879 | |
1096 | |
880 | =item Web page maintainter |
1097 | =item Web page maintainter |
881 | |
1098 | |
882 | @@RXVTWEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@> |
1099 | @@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@> |
883 | |
1100 | |
884 | L<@@RXVT_WEBPAGE@@> |
1101 | L<@@RXVT_WEBPAGE@@> |
885 | |
1102 | |
886 | =back |
1103 | =back |
887 | |
1104 | |