1 |
=head1 NAME |
2 |
|
3 |
rxvt-unicode (ouR XVT, unicode) - (a VT102 emulator for the X window system) |
4 |
|
5 |
=head1 SYNOPSIS |
6 |
|
7 |
B<@@RXVT_NAME@@> [options] [-e command [ args ]] |
8 |
|
9 |
=head1 DESCRIPTION |
10 |
|
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 |
13 |
require features such as Tektronix 4014 emulation and toolkit-style |
14 |
configurability. As a result, B<rxvt-unicode> uses much less swap space -- |
15 |
a significant advantage on a machine serving many X sessions. |
16 |
|
17 |
=head1 RXVT-UNICODE VS. RXVT |
18 |
|
19 |
Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode |
20 |
internally. That means it can store and display most scripts in the |
21 |
world. Being a terminal emulator, however, some things are very difficult, |
22 |
especially cursive scripts such as arabic, vertically written scripts |
23 |
like mongolian or scripts requiring extremely complex combining rules, |
24 |
like tibetan or devenagari. Don't expect pretty output when using these |
25 |
scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work |
26 |
fine, though. A somewhat difficult case are left-to-right scripts, such |
27 |
as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms |
28 |
belong into the application, not the terminal emulator (too many things -- |
29 |
such as cursor-movement while editing -- break othwerwise), but that might |
30 |
change. |
31 |
|
32 |
If you are looking for a terminal that supports more exotic scripts, let |
33 |
me recommend C<mlterm>, which is a very userfriendly, lean and clean |
34 |
terminal emulator. In fact, the reason rxvt-unicode was born was solely |
35 |
because the author couldn't get C<mlterm> to use one font for latin1 and |
36 |
another for japanese. |
37 |
|
38 |
Therefore another design rationale was the use of multiple fonts to |
39 |
display characters: The idea of a single unicode font which many other |
40 |
programs force onto it's users never made sense to me: You should be able |
41 |
to choose any font for any script freely. |
42 |
|
43 |
Apart from that, rxvt-unicode is also much better internationalised than |
44 |
it's predecessor, supports things such as XFT and ISO 14755 that are handy |
45 |
in i18n-environments, is faster, and has a lot less bugs than the original |
46 |
rxvt. This all in addition to dozens of other small improvements. |
47 |
|
48 |
It is still faithfully following the original rxvt idea of being lean |
49 |
and nice on resources: for example, you can still configure rxvt-unicode |
50 |
without most of it's features to get a lean binary. It also comes with |
51 |
a client/daemon pair that lets you open any number of terminal windows |
52 |
from within a single process, which makes startup time very fast and |
53 |
drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and |
54 |
@@RXVT_NAME@@c(1) (client). |
55 |
|
56 |
It also makes technical information about escape sequences (which have |
57 |
been extended) easier accessible: see @@RXVT_NAME@@(7) for technical |
58 |
reference documentation (escape sequences etc.) and the FAQ section at the |
59 |
end of this document. |
60 |
|
61 |
=head1 OPTIONS |
62 |
|
63 |
The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed |
64 |
below. In keeping with the smaller-is-better philosophy, options may be |
65 |
eliminated or default values chosen at compile-time, so options and |
66 |
defaults listed may not accurately reflect the version installed on |
67 |
your system. `@@RXVT_NAME@@ -h' gives a list of major compile-time options on |
68 |
the I<Options> line. Option descriptions may be prefixed with which |
69 |
compile option each is dependent upon. e.g. `Compile I<XIM>:' requires |
70 |
I<XIM> on the I<Options> line. Note: `@@RXVT_NAME@@ -help' gives a list of all |
71 |
command-line options compiled into your version. |
72 |
|
73 |
Note that B<@@RXVT_NAME@@> permits the resource name to be used as a |
74 |
long-option (--/++ option) so the potential command-line options are |
75 |
far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1 |
76 |
Orange'. |
77 |
|
78 |
The following options are available: |
79 |
|
80 |
=over 4 |
81 |
|
82 |
=item B<-help>, B<--help> |
83 |
|
84 |
Print out a message describing available options. |
85 |
|
86 |
=item B<-display> I<displayname> |
87 |
|
88 |
Attempt to open a window on the named X display (B<-d> still |
89 |
respected). In the absence of this option, the display specified by the |
90 |
B<DISPLAY> environment variable is used. |
91 |
|
92 |
=item B<-geometry> I<geom> |
93 |
|
94 |
Window geometry (B<-g> still respected); resource B<geometry>. |
95 |
|
96 |
=item B<-rv>|B<+rv> |
97 |
|
98 |
Turn on/off simulated reverse video; resource B<reverseVideo>. |
99 |
|
100 |
=item B<-j>|B<+j> |
101 |
|
102 |
Turn on/off jump scrolling; resource B<jumpScroll>. |
103 |
|
104 |
=item B<-ip>|B<+ip> |
105 |
|
106 |
Turn on/off inheriting parent window's pixmap. Alternative form is |
107 |
B<-tr>; resource B<inheritPixmap>. |
108 |
|
109 |
=item B<-fade> I<number> |
110 |
|
111 |
Fade the text by the given percentage when focus is lost. |
112 |
|
113 |
=item B<-tint> I<colour> |
114 |
|
115 |
Tint the transparent background pixmap with the given colour when |
116 |
transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> |
117 |
option that can be used to brighten or darken the image in addition to |
118 |
tinting it. |
119 |
|
120 |
=item B<-sh> |
121 |
|
122 |
I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
123 |
background image in addition to tinting it (i.e. B<-tint> must be |
124 |
specified, too). |
125 |
|
126 |
=item B<-bg> I<colour> |
127 |
|
128 |
Window background colour; resource B<background>. |
129 |
|
130 |
=item B<-fg> I<colour> |
131 |
|
132 |
Window foreground colour; resource B<foreground>. |
133 |
|
134 |
=item B<-pixmap> I<file[;geom]> |
135 |
|
136 |
Compile I<XPM>: Specify XPM file for the background and also optionally |
137 |
specify its scaling with a geometry string. Note you may need to add |
138 |
quotes to avoid special shell interpretation of the `;' in the |
139 |
command-line; resource B<backgroundPixmap>. |
140 |
|
141 |
=item B<-cr> I<colour> |
142 |
|
143 |
The cursor colour; resource B<cursorColor>. |
144 |
|
145 |
=item B<-pr> I<colour> |
146 |
|
147 |
The mouse pointer foreground colour; resource B<pointerColor>. |
148 |
|
149 |
=item B<-pr2> I<colour> |
150 |
|
151 |
The mouse pointer background colour; resource B<pointerColor2>. |
152 |
|
153 |
=item B<-bd> I<colour> |
154 |
|
155 |
The colour of the border between the xterm scrollbar and the text; |
156 |
resource B<borderColor>. |
157 |
|
158 |
=item B<-fn> I<fontname> |
159 |
|
160 |
Select the fonts to be used. This is a comma seperated list of font |
161 |
names that are used in turn when trying to display Unicode characters. |
162 |
The first font defines the cell size for characters; other fonts might |
163 |
be smaller, but not larger. A reasonable default font list is always |
164 |
appended to it. resource B<font>. |
165 |
|
166 |
See also the question "How does rxvt-unicode choose fonts?" in the FAQ |
167 |
section. |
168 |
|
169 |
=item B<-rb>|B<+rb> |
170 |
|
171 |
Enable "real bold" support. When this option is on, bold text will be |
172 |
displayed using the first available bold font in the font list. Bold |
173 |
fonts should thus be specified in the font list after their |
174 |
corresponding regular fonts. If no bold font can be found, a regular |
175 |
font will be used. resource B<realBold>. |
176 |
|
177 |
=item B<-name> I<name> |
178 |
|
179 |
Specify the application name under which resources are to be obtained, |
180 |
rather than the default executable file name. Name should not contain |
181 |
`.' or `*' characters. Also sets the icon and title name. |
182 |
|
183 |
=item B<-ls>|B<+ls> |
184 |
|
185 |
Start as a login-shell/sub-shell; resource B<loginShell>. |
186 |
|
187 |
=item B<-ut>|B<+ut> |
188 |
|
189 |
Compile I<utmp>: Inhibit/enable writing a utmp entry; resource |
190 |
B<utmpInhibit>. |
191 |
|
192 |
=item B<-vb>|B<+vb> |
193 |
|
194 |
Turn on/off visual bell on receipt of a bell character; resource |
195 |
B<visualBell>. |
196 |
|
197 |
=item B<-sb>|B<+sb> |
198 |
|
199 |
Turn on/off scrollbar; resource B<scrollBar>. |
200 |
|
201 |
=item B<-si>|B<+si> |
202 |
|
203 |
Turn on/off scroll-to-bottom on TTY output inhibit; resource |
204 |
B<scrollTtyOutput> has opposite effect. |
205 |
|
206 |
=item B<-sk>|B<+sk> |
207 |
|
208 |
Turn on/off scroll-to-bottom on keypress; resource |
209 |
B<scrollTtyKeypress>. |
210 |
|
211 |
=item B<-sw>|B<+sw> |
212 |
|
213 |
Turn on/off scrolling with the scrollback buffer as new lines appear. |
214 |
This only takes effect if B<-si> is also given; resource |
215 |
B<scrollWithBuffer>. |
216 |
|
217 |
=item B<-sr>|B<+sr> |
218 |
|
219 |
Put scrollbar on right/left; resource B<scrollBar_right>. |
220 |
|
221 |
=item B<-st>|B<+st> |
222 |
|
223 |
Display normal (non XTerm/NeXT) scrollbar without/with a trough; |
224 |
resource B<scrollBar_floating>. |
225 |
|
226 |
=item B<-bc>|B<+bc> |
227 |
|
228 |
Blink the cursor; resource B<cursorBlink>. |
229 |
|
230 |
=item B<-iconic> |
231 |
|
232 |
Start iconified, if the window manager supports that option. |
233 |
Alternative form is B<-ic>. |
234 |
|
235 |
=item B<-sl> I<number> |
236 |
|
237 |
Save I<number> lines in the scrollback buffer. See resource entry for |
238 |
limits; resource B<saveLines>. |
239 |
|
240 |
=item B<-b> I<number> |
241 |
|
242 |
Compile I<frills>: Internal border of I<number> pixels. See resource |
243 |
entry for limits; resource B<internalBorder>. |
244 |
|
245 |
=item B<-w> I<number> |
246 |
|
247 |
Compile I<frills>: External border of I<number> pixels. Also, B<-bw> |
248 |
and B<-borderwidth>. See resource entry for limits; resource |
249 |
B<externalBorder>. |
250 |
|
251 |
=item B<-bl> |
252 |
|
253 |
Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
254 |
if honoured by the WM, the rxvt-unicode window will not have window |
255 |
decorations; resource B<borderLess>. |
256 |
|
257 |
=item B<-lsp> I<number> |
258 |
|
259 |
Compile I<linespace>: Lines (pixel height) to insert between each row |
260 |
of the display; resource B<linespace>. |
261 |
|
262 |
=item B<-tn> I<termname> |
263 |
|
264 |
This option specifies the name of the terminal type to be set in the |
265 |
B<TERM> environment variable. This terminal type must exist in the |
266 |
I<termcap(5)> database and should have I<li#> and I<co#> entries; |
267 |
resource B<termName>. |
268 |
|
269 |
=item B<-e> I<command [arguments]> |
270 |
|
271 |
Run the command with its command-line arguments in the B<@@RXVT_NAME@@> |
272 |
window; also sets the window title and icon name to be the basename of |
273 |
the program being executed if neither I<-title> (I<-T>) nor I<-n> are |
274 |
given on the command line. If this option is used, it must be the last |
275 |
on the command-line. If there is no B<-e> option then the default is to |
276 |
run the program specified by the B<SHELL> environment variable or, |
277 |
failing that, I<sh(1)>. |
278 |
|
279 |
=item B<-title> I<text> |
280 |
|
281 |
Window title (B<-T> still respected); the default title is the basename |
282 |
of the program specified after the B<-e> option, if any, otherwise the |
283 |
application name; resource B<title>. |
284 |
|
285 |
=item B<-n> I<text> |
286 |
|
287 |
Icon name; the default name is the basename of the program specified |
288 |
after the B<-e> option, if any, otherwise the application name; |
289 |
resource B<iconName>. |
290 |
|
291 |
=item B<-C> |
292 |
|
293 |
Capture system console messages. |
294 |
|
295 |
=item B<-pt> I<style> |
296 |
|
297 |
Compile I<XIM>: input style for input method; B<OverTheSpot>, |
298 |
B<OffTheSpot>, B<Root>; resource B<preeditType>. |
299 |
|
300 |
=item B<-im> I<text> |
301 |
|
302 |
Compile I<XIM>: input method name. resource B<inputMethod>. |
303 |
|
304 |
=item B<-imlocale> I<string> |
305 |
|
306 |
The locale to use for opening the IM. You can use an LC_CTYPE of e.g. |
307 |
de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input |
308 |
extension to be able to input japanese characters while staying in |
309 |
another locale. |
310 |
|
311 |
=item B<-insecure> |
312 |
|
313 |
Enable "insecure" mode, which currently enables most of the escape |
314 |
sequences that echo strings. See the resource B<insecure> for more |
315 |
info. |
316 |
|
317 |
=item B<-mod> I<modifier> |
318 |
|
319 |
Override detection of Meta modifier with specified key: B<alt>, |
320 |
B<meta>, B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, |
321 |
B<mod5>; resource I<modifier>. |
322 |
|
323 |
=item B<-ssc>|B<+ssc> |
324 |
|
325 |
Turn on/off secondary screen (default enabled); resource |
326 |
B<secondaryScreen>. |
327 |
|
328 |
=item B<-ssr>|B<+ssr> |
329 |
|
330 |
Turn on/off secondary screen scroll (default enabled); resource |
331 |
B<secondaryScroll>. |
332 |
|
333 |
=item B<-xrm> I<resourcestring> |
334 |
|
335 |
No effect on rxvt-unicode. Simply passes through an argument to be made |
336 |
available in the instance's argument list. Appears in I<WM_COMMAND> in |
337 |
some window managers. |
338 |
|
339 |
=back |
340 |
|
341 |
=head1 RESOURCES (available also as long-options) |
342 |
|
343 |
Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
344 |
options) compiled into your version. |
345 |
|
346 |
There are two different methods that @@RXVT_NAME@@ can use to get the |
347 |
Xresource data: using the X libraries (Xrm*-functions) or internal |
348 |
Xresources reader (B<~/.Xdefaults>). For the first method (ie. |
349 |
B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the |
350 |
resources using X11 tools like B<xset>. Many distribution do also load |
351 |
settings from the B<~/.Xresources> file when X starts. |
352 |
|
353 |
If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> |
354 |
lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults |
355 |
set in XAPPLOADDIR/URxvt (compile-time defined: usually |
356 |
B</usr/lib/X11/app-defaults/URxvt>) and resources set in |
357 |
B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist. |
358 |
Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two |
359 |
class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows |
360 |
resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be |
361 |
easily configured, while the class name B<URxvt> allows resources |
362 |
unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be |
363 |
shared between different B<@@RXVT_NAME@@> configurations. If no |
364 |
resources are specified, suitable defaults will be used. Command-line |
365 |
arguments can be used to override resource settings. The following |
366 |
resources are allowed: |
367 |
|
368 |
=over 4 |
369 |
|
370 |
=item B<geometry:> I<geom> |
371 |
|
372 |
Create the window with the specified X window geometry [default 80x24]; |
373 |
option B<-geometry>. |
374 |
|
375 |
=item B<background:> I<colour> |
376 |
|
377 |
Use the specified colour as the window's background colour [default |
378 |
White]; option B<-bg>. |
379 |
|
380 |
=item B<foreground:> I<colour> |
381 |
|
382 |
Use the specified colour as the window's foreground colour [default |
383 |
Black]; option B<-fg>. |
384 |
|
385 |
=item B<color>I<n>B<:> I<colour> |
386 |
|
387 |
Use the specified colour for the colour value I<n>, where 0-7 |
388 |
corresponds to low-intensity (normal) colours and 8-15 corresponds to |
389 |
high-intensity (bold = bright foreground, blink = bright background) |
390 |
colours. The canonical names are as follows: 0=black, 1=red, 2=green, |
391 |
3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour |
392 |
names used are listed in the B<COLORS AND GRAPHICS> section. |
393 |
|
394 |
=item B<colorBD:> I<colour> |
395 |
|
396 |
Use the specified colour to display bold characters when the foreground |
397 |
colour is the default. This option will be ignored if B<realBold> is |
398 |
enabled. |
399 |
|
400 |
=item B<colorUL:> I<colour> |
401 |
|
402 |
Use the specified colour to display underlined characters when the |
403 |
foreground colour is the default. |
404 |
|
405 |
=item B<colorRV:> I<colour> |
406 |
|
407 |
Use the specified colour as the background for reverse video |
408 |
characters. |
409 |
|
410 |
=item B<cursorColor:> I<colour> |
411 |
|
412 |
Use the specified colour for the cursor. The default is to use the |
413 |
foreground colour; option B<-cr>. |
414 |
|
415 |
=item B<cursorColor2:> I<colour> |
416 |
|
417 |
Use the specified colour for the colour of the cursor text. For this to |
418 |
take effect, B<cursorColor> must also be specified. The default is to |
419 |
use the background colour. |
420 |
|
421 |
=item B<reverseVideo:> I<boolean> |
422 |
|
423 |
B<True>: simulate reverse video by foreground and background colours; |
424 |
option B<-rv>. B<False>: regular screen colours [default]; option |
425 |
B<+rv>. See note in B<COLORS AND GRAPHICS> section. |
426 |
|
427 |
=item B<jumpScroll:> I<boolean> |
428 |
|
429 |
B<True>: specify that jump scrolling should be used. When scrolling |
430 |
quickly, fewer screen updates are performed [default]; option B<-j>. |
431 |
B<False>: specify that smooth scrolling should be used; option B<+j>. |
432 |
|
433 |
=item B<inheritPixmap:> I<boolean> |
434 |
|
435 |
B<True>: make the background inherit the parent windows' pixmap, giving |
436 |
artificial transparency. B<False>: do not inherit the parent windows' |
437 |
pixmap. |
438 |
|
439 |
=item B<fading:> I<number> |
440 |
|
441 |
Fade the text by the given percentage when focus is lost. |
442 |
|
443 |
=item B<tintColor:> I<colour> |
444 |
|
445 |
Tint the transparent background pixmap with the given colour. |
446 |
|
447 |
=item B<shading:> I<number> |
448 |
|
449 |
Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
450 |
image in addition to tinting it. |
451 |
|
452 |
=item B<fading:> I<number> |
453 |
|
454 |
Scale the tint colour by the given percentage. |
455 |
|
456 |
=item B<scrollColor:> I<colour> |
457 |
|
458 |
Use the specified colour for the scrollbar [default #B2B2B2]. |
459 |
|
460 |
=item B<troughColor:> I<colour> |
461 |
|
462 |
Use the specified colour for the scrollbar's trough area [default |
463 |
#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. |
464 |
|
465 |
=item B<backgroundPixmap:> I<file[;geom]> |
466 |
|
467 |
Use the specified XPM file (note the `.xpm' extension is optional) for |
468 |
the background and also optionally specify its scaling with a geometry |
469 |
string B<WxH+X+Y>, in which B<"W" / "H"> specify the |
470 |
horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image |
471 |
centre (percent). A scale of 0 displays the image with tiling. A scale |
472 |
of 1 displays the image without any scaling. A scale of 2 to 9 |
473 |
specifies an integer number of images in that direction. No image will |
474 |
be magnified beyond 10 times its original size. The maximum permitted |
475 |
scale is 1000. [default 0x0+50+50] |
476 |
|
477 |
=item B<menu:> I<file[;tag]> |
478 |
|
479 |
Read in the specified menu file (note the `.menu' extension is |
480 |
optional) and also optionally specify a starting tag to find. See the |
481 |
reference documentation for details on the syntax for the menuBar. |
482 |
|
483 |
=item B<path:> I<path> |
484 |
|
485 |
Specify the colon-delimited search path for finding files (XPM and |
486 |
menus), in addition to the paths specified by the B<RXVTPATH> and |
487 |
B<PATH> environment variables. |
488 |
|
489 |
=item B<font:> I<fontname> |
490 |
|
491 |
Select the fonts to be used. This is a comma seperated list of font |
492 |
names that are used in turn when trying to display Unicode characters. |
493 |
The first font defines the cell size for characters; other fonts might |
494 |
be smaller, but not larger. A reasonable default font list is always |
495 |
appended to it. option B<-fn>. |
496 |
|
497 |
=item B<realBold:> I<boolean> |
498 |
|
499 |
B<True>: Enable "real bold" support. When this option is on, bold text |
500 |
will be displayed using the first available bold font in the font list. |
501 |
Bold fonts should thus be specified in the font list after their |
502 |
corresponding regular fonts. If no bold font can be found, a regular |
503 |
font will be used. option B<-rb>. B<False>: Display bold text in a |
504 |
regular font, using the color specified with B<colorBD>; option B<+rb>. |
505 |
|
506 |
=item B<selectstyle:> I<mode> |
507 |
|
508 |
Set mouse selection style to B<old> which is 2.20, B<oldword> which is |
509 |
xterm style with 2.20 old word selection, or anything else which gives |
510 |
xterm style selection. |
511 |
|
512 |
=item B<scrollstyle:> I<mode> |
513 |
|
514 |
Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
515 |
the author's favourite.. |
516 |
|
517 |
=item B<title:> I<string> |
518 |
|
519 |
Set window title string, the default title is the command-line |
520 |
specified after the B<-e> option, if any, otherwise the application |
521 |
name; option B<-title>. |
522 |
|
523 |
=item B<iconName:> I<string> |
524 |
|
525 |
Set the name used to label the window's icon or displayed in an icon |
526 |
manager window, it also sets the window's title unless it is explicitly |
527 |
set; option B<-n>. |
528 |
|
529 |
=item B<mapAlert:> I<boolean> |
530 |
|
531 |
B<True>: de-iconify (map) on receipt of a bell character. B<False>: no |
532 |
de-iconify (map) on receipt of a bell character [default]. |
533 |
|
534 |
=item B<visualBell:> I<boolean> |
535 |
|
536 |
B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
537 |
B<False>: no visual bell [default]; option B<+vb>. |
538 |
|
539 |
=item B<loginShell:> I<boolean> |
540 |
|
541 |
B<True>: start as a login shell by prepending a `-' to B<argv[0]> of |
542 |
the shell; option B<-ls>. B<False>: start as a normal sub-shell |
543 |
[default]; option B<+ls>. |
544 |
|
545 |
=item B<utmpInhibit:> I<boolean> |
546 |
|
547 |
B<True>: inhibit writing record into the system log file B<utmp>; |
548 |
option B<-ut>. B<False>: write record into the system log file B<utmp> |
549 |
[default]; option B<+ut>. |
550 |
|
551 |
=item B<print-pipe:> I<string> |
552 |
|
553 |
Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use |
554 |
B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or |
555 |
B<Shift-Print> to include the scrollback as well. |
556 |
|
557 |
=item B<scrollBar:> I<boolean> |
558 |
|
559 |
B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
560 |
disable the scrollbar; option B<+sb>. |
561 |
|
562 |
=item B<scrollBar_right:> I<boolean> |
563 |
|
564 |
B<True>: place the scrollbar on the right of the window; option B<-sr>. |
565 |
B<False>: place the scrollbar on the left of the window; option B<+sr>. |
566 |
|
567 |
=item B<scrollBar_floating:> I<boolean> |
568 |
|
569 |
B<True>: display an rxvt scrollbar without a trough; option B<-st>. |
570 |
B<False>: display an rxvt scrollbar with a trough; option B<+st>. |
571 |
|
572 |
=item B<scrollBar_align:> I<mode> |
573 |
|
574 |
Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar |
575 |
thumb with the pointer on middle button press/drag. |
576 |
|
577 |
=item B<scrollTtyOutput:> I<boolean> |
578 |
|
579 |
B<True>: scroll to bottom when tty receives output; option B<-si>. |
580 |
B<False>: do not scroll to bottom when tty receives output; option |
581 |
B<+si>. |
582 |
|
583 |
=item B<scrollWithBuffer:> I<boolean> |
584 |
|
585 |
B<True>: scroll with scrollback buffer when tty recieves new lines (and |
586 |
B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll |
587 |
with scrollback buffer when tty recieves new lines; option B<-sw>. |
588 |
|
589 |
=item B<scrollTtyKeypress:> I<boolean> |
590 |
|
591 |
B<True>: scroll to bottom when a non-special key is pressed. Special keys |
592 |
are those which are intercepted by rxvt-unicode for special handling and |
593 |
are not passed onto the shell; option B<-sk>. B<False>: do not scroll to |
594 |
bottom when a non-special key is pressed; option B<+sk>. |
595 |
|
596 |
=item B<saveLines:> I<number> |
597 |
|
598 |
Save I<number> lines in the scrollback buffer [default 64]. This |
599 |
resource is limited on most machines to 65535; option B<-sl>. |
600 |
|
601 |
=item B<internalBorder:> I<number> |
602 |
|
603 |
Internal border of I<number> pixels. This resource is limited to 100; |
604 |
option B<-b>. |
605 |
|
606 |
=item B<externalBorder:> I<number> |
607 |
|
608 |
External border of I<number> pixels. This resource is limited to 100; |
609 |
option B<-w>, B<-bw>, B<-borderwidth>. |
610 |
|
611 |
=item B<borderLess:> I<boolean> |
612 |
|
613 |
Set MWM hints to request a borderless window, i.e. if honoured by the |
614 |
WM, the rxvt-unicode window will not have window decorations; option B<-bl>. |
615 |
|
616 |
=item B<termName:> I<termname> |
617 |
|
618 |
Specifies the terminal type name to be set in the B<TERM> environment |
619 |
variable; option B<-tn>. |
620 |
|
621 |
=item B<linespace:> I<number> |
622 |
|
623 |
Specifies number of lines (pixel height) to insert between each row of |
624 |
the display [default 0]; option B<-lsp>. |
625 |
|
626 |
=item B<meta8:> I<boolean> |
627 |
|
628 |
B<True>: handle Meta (Alt) + keypress to set the 8th bit. B<False>: |
629 |
handle Meta (Alt) + keypress as an escape prefix [default]. |
630 |
|
631 |
=item B<mouseWheelScrollPage:> I<boolean> |
632 |
|
633 |
B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel |
634 |
scrolls five lines [default]. |
635 |
|
636 |
=item B<cursorBlink:> I<boolean> |
637 |
|
638 |
B<True>: blink the cursor. B<False>: do not blink the cursor [default]; |
639 |
option B<-bc>. |
640 |
|
641 |
=item B<pointerBlank:> I<boolean> |
642 |
|
643 |
B<True>: blank the pointer when a key is pressed or after a set number |
644 |
of seconds of inactivity. B<False>: the pointer is always visible |
645 |
[default]. |
646 |
|
647 |
=item B<pointerColor:> I<colour> |
648 |
|
649 |
Mouse pointer foreground colour. |
650 |
|
651 |
=item B<pointerColor2:> I<colour> |
652 |
|
653 |
Mouse pointer background colour. |
654 |
|
655 |
=item B<pointerBlankDelay:> I<number> |
656 |
|
657 |
Specifies number of seconds before blanking the pointer [default 2]. |
658 |
|
659 |
=item B<backspacekey:> I<string> |
660 |
|
661 |
The string to send when the backspace key is pressed. If set to B<DEC> |
662 |
or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> |
663 |
(code 8) - which can be reversed with the appropriate DEC private mode |
664 |
escape sequence. |
665 |
|
666 |
=item B<deletekey:> I<string> |
667 |
|
668 |
The string to send when the delete key (not the keypad delete key) is |
669 |
pressed. If unset it will send the sequence traditionally associated |
670 |
with the B<Execute> key. |
671 |
|
672 |
=item B<cutchars:> I<string> |
673 |
|
674 |
The characters used as delimiters for double-click word selection. The |
675 |
built-in default: |
676 |
|
677 |
B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> |
678 |
|
679 |
=item B<preeditType:> I<style> |
680 |
|
681 |
B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. |
682 |
|
683 |
=item B<inputMethod:> I<name> |
684 |
|
685 |
I<name> of inputMethod to use; option B<-im>. |
686 |
|
687 |
=item B<imLocale:> I<name> |
688 |
|
689 |
The locale to use for opening the IM. You can use an LC_CTYPE of e.g. |
690 |
de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input |
691 |
extension to be able to input japanese characters while staying in |
692 |
another locale. option B<-imlocale>. |
693 |
|
694 |
=item B<insecure> |
695 |
|
696 |
Enables "insecure" mode. Rxvt-unicode offers some escape sequences that |
697 |
echo arbitrary strings like the icon name or the locale. This could be |
698 |
abused if somebody gets 8-bit-clean access to your display, wether |
699 |
throuh a mail client displaying mail bodies unfiltered or though |
700 |
write(1). Therefore, these sequences are disabled by default. (Note |
701 |
that other terminals, including xterm, have these sequences |
702 |
enabled by default). You can enable them by setting this boolean |
703 |
resource or specifying B<-insecure> as an option. At the moment, this |
704 |
enabled display-answer, locale, findfont, icon label and window title |
705 |
requests as well as dynamic menubar dispatch. |
706 |
|
707 |
=item B<modifier:> I<modifier> |
708 |
|
709 |
Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, |
710 |
B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option |
711 |
B<-mod>. |
712 |
|
713 |
=item B<answerbackString:> I<string> |
714 |
|
715 |
Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) |
716 |
character is passed through. It may contain escape values as described |
717 |
in the entry on B<keysym> following. |
718 |
|
719 |
=item B<secondaryScreen:> I<bool> |
720 |
|
721 |
Turn on/off secondary screen (default enabled). |
722 |
|
723 |
=item B<secondaryScroll:> I<bool> |
724 |
|
725 |
Turn on/off secondary screen scroll (default enabled). If the this |
726 |
option is enabled, scrolls on the secondary screen will change the |
727 |
scrollback buffer and switching to/from the secondary screen will |
728 |
instead scroll the screen up. |
729 |
|
730 |
=item B<keysym.>I<sym>: I<string> |
731 |
|
732 |
Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may |
733 |
contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: |
734 |
newline, \r: return, \t: |
735 |
tab, \000: octal number) or control characters (^?: delete, ^@: null, |
736 |
^A ...) and may enclosed with double quotes so that it can start or end |
737 |
with whitespace. The intervening resource name B<keysym.> cannot be |
738 |
omitted. This resource is only available when compiled with |
739 |
KEYSYM_RESOURCE. |
740 |
|
741 |
=back |
742 |
|
743 |
=head1 THE SCROLLBAR |
744 |
|
745 |
Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window |
746 |
(resource: B<saveLines>) and can be scrolled back using the scrollbar |
747 |
or by keystrokes. The normal B<@@RXVT_NAME@@> scrollbar has arrows and |
748 |
its behaviour is fairly intuitive. The B<xterm-scrollbar> is without |
749 |
arrows and its behaviour mimics that of I<xterm> |
750 |
|
751 |
Scroll down with B<Button1> (B<xterm-scrollbar>) or B<Shift-Next>. |
752 |
Scroll up with B<Button3> (B<xterm-scrollbar>) or B<Shift-Prior>. |
753 |
Continuous scroll with B<Button2>. |
754 |
|
755 |
=head1 MOUSE REPORTING |
756 |
|
757 |
To temporarily override mouse reporting, for either the scrollbar or |
758 |
the normal text selection/insertion, hold either the Shift or the Meta |
759 |
(Alt) key while performing the desired mouse action. |
760 |
|
761 |
If mouse reporting mode is active, the normal scrollbar actions are |
762 |
disabled -- on the assumption that we are using a fullscreen |
763 |
application. Instead, pressing Button1 and Button3 sends B<ESC[6~> |
764 |
(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the |
765 |
up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), |
766 |
respectively. |
767 |
|
768 |
=head1 TEXT SELECTION AND INSERTION |
769 |
|
770 |
The behaviour of text selection and insertion mechanism is similar to |
771 |
I<xterm>(1). |
772 |
|
773 |
=over 4 |
774 |
|
775 |
=item B<Selection>: |
776 |
|
777 |
Left click at the beginning of the region, drag to the end of the |
778 |
region and release; Right click to extend the marked region; Left |
779 |
double-click to select a word; Left triple-click to select the entire |
780 |
line. |
781 |
|
782 |
=item B<Insertion>: |
783 |
|
784 |
Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in |
785 |
an B<@@RXVT_NAME@@> window causes the current text selection to be |
786 |
inserted as if it had been typed on the keyboard. |
787 |
|
788 |
=back |
789 |
|
790 |
=head1 CHANGING FONTS |
791 |
|
792 |
Changing fonts (or font sizes, respectively) via the keypad is not yet |
793 |
supported in rxvt-unicode. Bug me if you need this. |
794 |
|
795 |
You can, however, switch fonts at runtime using escape sequences (and |
796 |
therefore using the menubar), e.g.: |
797 |
|
798 |
printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" |
799 |
|
800 |
rxvt-unicode will automatically re-apply these fonts to the output so far. |
801 |
|
802 |
=head1 ISO 14755 SUPPORT |
803 |
|
804 |
ISO 14755 is a standard for entering and viewing unicode characters |
805 |
and character codes using the keyboard. It consists of 4 parts. The |
806 |
first part is available rxvt-unicode has been compiled with |
807 |
C<--enable-frills>, the rest is available when rxvt-unicode was compiled |
808 |
with C<--enable-iso14755>. |
809 |
|
810 |
=over 4 |
811 |
|
812 |
=item 5.1: Basic method |
813 |
|
814 |
This allows you to enter unicode characters using their hexcode. |
815 |
|
816 |
Start by pressing and holding both C<Control> and C<Shift>, then enter |
817 |
hex-digits (between one and six). Releasing C<Control> and C<Shift> will |
818 |
commit the character as if it were typed directly. While holding down |
819 |
C<Control> and C<Shift> you can also enter multiple characters by pressing |
820 |
C<Space>, which will commit the current character and lets you start a new |
821 |
one. |
822 |
|
823 |
As an example of use, imagine a business card with a japanese e-mail |
824 |
address, which you cannot type. Fortunately, the card has the e-mail |
825 |
address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily |
826 |
by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>, |
827 |
followed by releasing the modifier keys. |
828 |
|
829 |
=item 5.2: Keyboard symbols entry method |
830 |
|
831 |
This mode lets you input characters representing the keycap symbols of |
832 |
your keyboard, if representable in the current locale encoding. |
833 |
|
834 |
Start by pressing C<Control> and C<Shift> together, then releasing |
835 |
them. The next special key (cursor keys, home etc.) you enter will not |
836 |
invoke it's usual function but instead will insert the corresponding |
837 |
keycap symbol. The symbol will only be entered when the key has been |
838 |
released, otherwise pressing e.g. C<Shift> would enter the symbol for |
839 |
C<ISO Level 2 Switch>, although your intention might have beenm to enter a |
840 |
reverse tab (Shift-Tab). |
841 |
|
842 |
=item 5.3: Screen-selection entry method |
843 |
|
844 |
While this is implemented already (it's basically the selection |
845 |
mechanism), it could be extended by displaying a unicode character map. |
846 |
|
847 |
=item 5.4: Feedback method for identifying displayed characters for later input |
848 |
|
849 |
This method lets you display the unicode character code associated with |
850 |
characters already displayed. |
851 |
|
852 |
You enter this mode by holding down C<Control> and C<Shift> together, then |
853 |
pressing and holding the left mouse button and moving around. The unicode |
854 |
hex code(s) (it might be a combining character) of the character under the |
855 |
pointer is displayed until you release C<Control> and C<Shift>. |
856 |
|
857 |
=back |
858 |
|
859 |
With respect to conformance, rxvt-unicode is supposed to be compliant to |
860 |
both scenario A and B of ISO 14755, including part 5.2. |
861 |
|
862 |
=head1 LOGIN STAMP |
863 |
|
864 |
B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so |
865 |
that it can be seen via the I<who(1)> command, and can accept messages. |
866 |
To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on |
867 |
some systems. |
868 |
|
869 |
=head1 COLORS AND GRAPHICS |
870 |
|
871 |
In addition to the default foreground and background colours, |
872 |
B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus |
873 |
high-intensity bold/blink versions of the same). Here is a list of the |
874 |
colours with their B<rgb.txt> names. |
875 |
|
876 |
=begin table |
877 |
|
878 |
B<color0> (black) = Black |
879 |
B<color1> (red) = Red3 |
880 |
B<color2> (green) = Green3 |
881 |
B<color3> (yellow) = Yellow3 |
882 |
B<color4> (blue) = Blue3 |
883 |
B<color5> (magenta) = Magenta3 |
884 |
B<color6> (cyan) = Cyan3 |
885 |
B<color7> (white) = AntiqueWhite |
886 |
B<color8> (bright black) = Grey25 |
887 |
B<color9> (bright red) = Red |
888 |
B<color10> (bright green) = Green |
889 |
B<color11> (bright yellow) = Yellow |
890 |
B<color12> (bright blue) = Blue |
891 |
B<color13> (bright magenta) = Magenta |
892 |
B<color14> (bright cyan) = Cyan |
893 |
B<color15> (bright white) = White |
894 |
B<foreground> = Black |
895 |
B<background> = White |
896 |
|
897 |
=end table |
898 |
|
899 |
It is also possible to specify the colour values of B<foreground>, |
900 |
B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
901 |
a number 0-15, as a convenient shorthand to reference the colour name of |
902 |
color0-color15. |
903 |
|
904 |
Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
905 |
always swapping the foreground/background colours. This is in contrast to |
906 |
I<xterm>(1) where the colours are only swapped if they have not otherwise |
907 |
been specified. For example, |
908 |
|
909 |
=over 4 |
910 |
|
911 |
=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> |
912 |
|
913 |
would yield White on Black, while on I<xterm>(1) it would yield Black |
914 |
on White. |
915 |
|
916 |
=back |
917 |
|
918 |
=head1 FREQUENTLY ASKED QUESTIONS (FAQ) |
919 |
|
920 |
=over 4 |
921 |
|
922 |
=item How do I know which rxvt-unicode version I'm using? |
923 |
|
924 |
The version number is displayed with the usage (-h). For rxvt-unicode |
925 |
version 2.14 and later, the escape sequence C<ESC[8n> sets the window |
926 |
title to the version number. |
927 |
|
928 |
=item Rxvt-unicode does not seem to understand the selected encoding? |
929 |
|
930 |
=item Unicode does not seem to work? |
931 |
|
932 |
If you encounter strange problems like typing an accented character but |
933 |
getting two unrelated other characters or similar, or if program output is |
934 |
subtly garbled, then you should check your locale settings. |
935 |
|
936 |
Rxvt-unicode must be started with the same C<LC_CTYPE> setting as the |
937 |
programs. Often rxvt-unicode is started in the C<C> locale, while the |
938 |
login script running within the rxvt-unicode window changes the locale to |
939 |
sth. else, e.h. C<en_GB.UTF-8>. Needless to say, this is not going to work. |
940 |
|
941 |
The best thing is to fix your startup environment, as you will likely run |
942 |
into other problems. If nothing works you can try this in your .profile. |
943 |
|
944 |
printf '\e]701;%s\007' "$LC_CTYPE" |
945 |
|
946 |
If this doesn't work, then maybe you use a C<LC_CTYPE> specification not |
947 |
supported on your systems. Some systems have a C<locale> comamnd which |
948 |
displays this. If it displays sth. like: |
949 |
|
950 |
locale: Cannot set LC_CTYPE to default locale: ... |
951 |
|
952 |
Then the locale you specified is not supported on your system. |
953 |
|
954 |
If nothing works and you are sure that everything is set correctly then |
955 |
you will need to remember a little known fact: Some programs just don't |
956 |
support locales :( |
957 |
|
958 |
=item Why do the characters look ugly? |
959 |
|
960 |
=item How does rxvt-unicode choose fonts? |
961 |
|
962 |
Most fonts do not contain the full range of Unicode, which is |
963 |
fine. Chances are that the font you (or the admin/package maintainer of |
964 |
your system/os) have specified does not cover all the characters you want |
965 |
to display. |
966 |
|
967 |
B<rxvt-unicode> makes a best-effort try at finding a replacement |
968 |
font. Often the result is fine, but sometimes the chosen font looks |
969 |
bad. In that case, select a font of your taste and add it to the font |
970 |
list, e.g.: |
971 |
|
972 |
@@RXVT_NAME@@ -fn basefont,font2,font3... |
973 |
|
974 |
When rxvt-unicode sees a character, it will first look at the base |
975 |
font. If the base font does not contain the character, it will go to the |
976 |
next font, and so on. |
977 |
|
978 |
The only limitation is that all the fonts must not be larger than the base |
979 |
font, as the base font defines the principial cell size, which must be the |
980 |
same due to the way terminals work. |
981 |
|
982 |
=item Why do some chinese characters look so different than others? |
983 |
|
984 |
This is because there is a difference between script and language -- |
985 |
rxvt-unicode does not know which language the text that is output |
986 |
is, as it only knows the unicode character codes. If rxvt-unicode |
987 |
first sees a japanese character, it might choose a japanese font for |
988 |
it. Subseqzuent japanese characters will take that font. Now, many chinese |
989 |
characters aren't represented in japanese fonts, so when the first |
990 |
non-japanese character comes up, rxvt-unicode will look for a chinese font |
991 |
-- unfortunately at this point, it will still use the japanese font for |
992 |
japanese characters that are also chinese. |
993 |
|
994 |
The workaround is easy: just tag a chinese font at the end of your font |
995 |
list (see the previous question). The key is to view the font list as |
996 |
a preference list: If you expect more japanese, list a japanese font |
997 |
first. If you expect more chinese, put a chinese font first. |
998 |
|
999 |
In the future it might be possible to switch preferences at runtime (the |
1000 |
internal data structure has no problem with using different fonts for |
1001 |
the same character at the same time, but no interface for this has been |
1002 |
designed yet). |
1003 |
|
1004 |
=item How does rxvt-unicode determine the encoding to use? |
1005 |
|
1006 |
=item Is there an option to switch encodings? |
1007 |
|
1008 |
Unlike some other terminals, rxvt-unicode has no encoding switch, and no |
1009 |
specific "utf-8" mode, such as xterm. In fact, it doesn't even know about |
1010 |
UTF-8 or any other encodings with respect to terminal I/O. |
1011 |
|
1012 |
The reasons is that there exists a perfectly fine mechanism for selecting |
1013 |
the encoding, doing I/O and (most important) communicating this to all |
1014 |
applications so everybody agrees on character properties such as width and |
1015 |
code number. This mechanism is the I<locale>. |
1016 |
|
1017 |
Rxvt-unicode uses the C<LC_CTYPE> locale category to select encoding. All |
1018 |
programs doing the same (that is, most) will automatically agree in the |
1019 |
interpretation of characters. |
1020 |
|
1021 |
Unfortunately, there is no system-independent way to select locales, nor |
1022 |
is there a standard on how locale specifiers will look like. |
1023 |
|
1024 |
On most systems, the content of the C<LC_CTYPE> environment variable |
1025 |
contains an arbitrary string which corresponds to an already-installed |
1026 |
locale. Common names for locales are C<en_US.UTF-8>, C<de_DE.ISO-8859-15>, |
1027 |
C<ja_JP.EUC-JP>, i.e. C<language_country.encoding>, but other forms |
1028 |
(i.e. C<de> or C<german>) are also common. |
1029 |
|
1030 |
Rxvt-unicode ignores all other locale categories, and except for |
1031 |
the encoding, ignores country or language-specific settings, |
1032 |
i.e. C<de_DE.UTF-8> and C<ja_JP.UTF-8> are the same for rxvt-unicode. |
1033 |
|
1034 |
If you want to use a specific encoding you have to make sure you start |
1035 |
rxvt-unicode with the correct C<LC_CTYPE> category. |
1036 |
|
1037 |
=item Can I switch locales at runtime? |
1038 |
|
1039 |
Yes, using an escape sequence. Try sth. like this, which sets |
1040 |
rxvt-unicode's idea of C<LC_CTYPE>. |
1041 |
|
1042 |
printf '\e]701;%s\007' ja_JP.SJIS |
1043 |
|
1044 |
See also the previous question. |
1045 |
|
1046 |
Sometimes this capability is rather handy when you want to work in one |
1047 |
locale (e.g. C<de_DE.UTF-8>) but some programs don't support UTF-8. For |
1048 |
example, I use this script to start C<xjdic>, which first switches to a |
1049 |
locale supported by xjdic and back later: |
1050 |
|
1051 |
printf '\e]701;%s\007' ja_JP.SJIS |
1052 |
xjdic -js |
1053 |
printf '\e]701;%s\007' de_DE.UTF-8 |
1054 |
|
1055 |
=item Can I switch the fonts at runtime? |
1056 |
|
1057 |
Yes, using an escape sequence. Try sth. like this, which has the same |
1058 |
effect as using the C<-fn> switch, and takes effect immediately: |
1059 |
|
1060 |
printf '\e]50;%s\007' "9x15bold,xft:Kochi Gothic" |
1061 |
|
1062 |
This is useful if you e.g. work primarily with japanese (and prefer a |
1063 |
japanese font), but you have to switch to chinese temporarily, where |
1064 |
japanese fonts would only be in your way. |
1065 |
|
1066 |
You can think of this as a kind of manual ISO-2022 switching. |
1067 |
|
1068 |
=item Mouse cut/paste suddenly no longer works. |
1069 |
|
1070 |
Make sure that mouse reporting is actually turned off since killing |
1071 |
some editors prematurely may leave the mouse in mouse report mode. I've |
1072 |
heard that tcsh may use mouse reporting unless it otherwise specified. A |
1073 |
quick check is to see if cut/paste works when the Alt or Shift keys are |
1074 |
depressed. See @@RXVT_NAME@@(7) |
1075 |
|
1076 |
=item What's with this bold/blink stuff? |
1077 |
|
1078 |
If no bold colour is set via C<colorBD:>, bold will invert text using the |
1079 |
standard foreground colour. |
1080 |
|
1081 |
For the standard background colour, blinking will actually make the |
1082 |
text blink when compiled with C<--enable-blinking>. with standard |
1083 |
colours. Without C<--enable-blinking>, the blink attribute will be |
1084 |
ignored. |
1085 |
|
1086 |
On ANSI colours, bold/blink attributes are used to set high-intensity |
1087 |
foreground/background colors. |
1088 |
|
1089 |
color0-7 are the low-intensity colors. |
1090 |
|
1091 |
color8-15 are the corresponding high-intensity colors. |
1092 |
|
1093 |
=item I don't like the screen colors. How do I change them? |
1094 |
|
1095 |
You can change the screen colors at run-time using F<~/.Xdefaults> |
1096 |
resources (or as long-options). |
1097 |
|
1098 |
Here are values that are supposed to resemble a VGA screen, |
1099 |
including the murky brown that passes for low-intensity yellow: |
1100 |
|
1101 |
Rxvt*color0: #000000 |
1102 |
Rxvt*color1: #A80000 |
1103 |
Rxvt*color2: #00A800 |
1104 |
Rxvt*color3: #A8A800 |
1105 |
Rxvt*color4: #0000A8 |
1106 |
Rxvt*color5: #A800A8 |
1107 |
Rxvt*color6: #00A8A8 |
1108 |
Rxvt*color7: #A8A8A8 |
1109 |
|
1110 |
Rxvt*color8: #000054 |
1111 |
Rxvt*color9: #FF0054 |
1112 |
Rxvt*color10: #00FF54 |
1113 |
Rxvt*color11: #FFFF54 |
1114 |
Rxvt*color12: #0000FF |
1115 |
Rxvt*color13: #FF00FF |
1116 |
Rxvt*color14: #00FFFF |
1117 |
Rxvt*color15: #FFFFFF |
1118 |
|
1119 |
=item What's with the strange Backspace/Delete key behaviour? |
1120 |
|
1121 |
Assuming that the physical Backspace key corresponds to the |
1122 |
BackSpace keysym (not likely for Linux ... see the following |
1123 |
question) there are two standard values that can be used for |
1124 |
Backspace: C<^H> and C<^?>. |
1125 |
|
1126 |
Historically, either value is correct, but rxvt-unicode adopts the debian |
1127 |
policy of using C<^?> when unsure, because it's the one only only correct |
1128 |
choice :). |
1129 |
|
1130 |
Rxvt-unicode tries to inherit the current stty settings and uses the value |
1131 |
of `erase' to guess the value for backspace. If rxvt-unicode wasn't |
1132 |
started from a terminal (say, from a menu or by remote shell), then the |
1133 |
system value of `erase', which corresponds to CERASE in <termios.h>, will |
1134 |
be used (which may not be the same as your stty setting). |
1135 |
|
1136 |
For starting a new rxvt-unicode: |
1137 |
|
1138 |
# use Backspace = ^H |
1139 |
$ stty erase ^H |
1140 |
$ @@RXVT_NAME@@ |
1141 |
|
1142 |
# use Backspace = ^? |
1143 |
$ stty erase ^? |
1144 |
$ @@RXVT_NAME@@ |
1145 |
|
1146 |
Toggle with "ESC[36h" / "ESC[36l" as documented in @@RXVT_NAME@@(7). |
1147 |
|
1148 |
For an existing rxvt-unicode: |
1149 |
|
1150 |
# use Backspace = ^H |
1151 |
$ stty erase ^H |
1152 |
$ echo -n "^[[36h" |
1153 |
|
1154 |
# use Backspace = ^? |
1155 |
$ stty erase ^? |
1156 |
$ echo -n "^[[36l" |
1157 |
|
1158 |
This helps satisfy some of the Backspace discrepancies that occur, but |
1159 |
if you use Backspace = C<^H>, make sure that the termcap/terminfo value |
1160 |
properly reflects that. |
1161 |
|
1162 |
The Delete key is a another casualty of the ill-defined Backspace problem. |
1163 |
To avoid confusion between the Backspace and Delete keys, the Delete |
1164 |
key has been assigned an escape sequence to match the vt100 for Execute |
1165 |
(ESC[3~) and is in the supplied termcap/terminfo. |
1166 |
|
1167 |
Some other Backspace problems: |
1168 |
|
1169 |
some editors use termcap/terminfo, |
1170 |
some editors (vim I'm told) expect Backspace = ^H, |
1171 |
GNU Emacs (and Emacs-like editors) use ^H for help. |
1172 |
|
1173 |
Perhaps someday this will all be resolved in a consistent manner. |
1174 |
|
1175 |
=item I don't like the key-bindings. How do I change them? |
1176 |
|
1177 |
There are some compile-time selections available via configure. Unless |
1178 |
you have run "configure" with the C<--disable-resources> option you can |
1179 |
use the `keysym' resource to alter the keystrings associated with keysym |
1180 |
0xFF00 - 0xFFFF (function, cursor keys, etc). |
1181 |
|
1182 |
Here's an example for a tn3270 session started using `@@RXVT_NAME@@ -name tn3270' |
1183 |
|
1184 |
!# ----- special uses ------: |
1185 |
! tn3270 login, remap function and arrow keys. |
1186 |
tn3270*font: *clean-bold-*-*--15-* |
1187 |
|
1188 |
! keysym - used by rxvt only |
1189 |
! Delete - ^D |
1190 |
tn3270*keysym.0xFFFF: \004 |
1191 |
|
1192 |
! Home - ^A |
1193 |
tn3270*keysym.0xFF50: \001 |
1194 |
! Left - ^B |
1195 |
tn3270*keysym.0xFF51: \002 |
1196 |
! Up - ^P |
1197 |
tn3270*keysym.0xFF52: \020 |
1198 |
! Right - ^F |
1199 |
tn3270*keysym.0xFF53: \006 |
1200 |
! Down - ^N |
1201 |
tn3270*keysym.0xFF54: \016 |
1202 |
! End - ^E |
1203 |
tn3270*keysym.0xFF57: \005 |
1204 |
|
1205 |
! F1 - F12 |
1206 |
tn3270*keysym.0xFFBE: \e1 |
1207 |
tn3270*keysym.0xFFBF: \e2 |
1208 |
tn3270*keysym.0xFFC0: \e3 |
1209 |
tn3270*keysym.0xFFC1: \e4 |
1210 |
tn3270*keysym.0xFFC2: \e5 |
1211 |
tn3270*keysym.0xFFC3: \e6 |
1212 |
tn3270*keysym.0xFFC4: \e7 |
1213 |
tn3270*keysym.0xFFC5: \e8 |
1214 |
tn3270*keysym.0xFFC6: \e9 |
1215 |
tn3270*keysym.0xFFC7: \e0 |
1216 |
tn3270*keysym.0xFFC8: \e- |
1217 |
tn3270*keysym.0xFFC9: \e= |
1218 |
|
1219 |
! map Prior/Next to F7/F8 |
1220 |
tn3270*keysym.0xFF55: \e7 |
1221 |
tn3270*keysym.0xFF56: \e8 |
1222 |
|
1223 |
=item I'm using keyboard model XXX that has extra Prior/Next/Insert keys. |
1224 |
How do I make use of them? For example, the Sun Keyboard type 4 |
1225 |
has the following mappings that rxvt-unicode doesn't recognize. |
1226 |
|
1227 |
KP_Insert == Insert |
1228 |
F22 == Print |
1229 |
F27 == Home |
1230 |
F29 == Prior |
1231 |
F33 == End |
1232 |
F35 == Next |
1233 |
|
1234 |
Rather than have rxvt-unicode try to accomodate all the various possible keyboard |
1235 |
mappings, it is better to use `xmodmap' to remap the keys as required for |
1236 |
your particular machine. |
1237 |
|
1238 |
=item How do I distinguish if I'm running rxvt-unicode or a regular xterm? |
1239 |
I need this to decide about setting colors etc. |
1240 |
|
1241 |
rxvt and rxvt-unicode always export the variable "COLORTERM", so you can |
1242 |
check and see if that is set. Note that several programs, JED, slrn, |
1243 |
Midnight Commander automatically check this variable to decide whether or |
1244 |
not to use color. |
1245 |
|
1246 |
=item How do I set the correct, full IP address for the DISPLAY variable? |
1247 |
|
1248 |
If you've compiled rxvt-unicode with DISPLAY_IS_IP and ahve enabled |
1249 |
insecure mode then it is possible to use the following shell script |
1250 |
snippets to correctly set the display. If your version of rxvt-unicode |
1251 |
wasn't also compiled with ESCZ_ANSWER (as assumed in these snippets) then |
1252 |
the COLORTERM variable can be used to distinguish rxvt-unicode from a |
1253 |
regular xterm. |
1254 |
|
1255 |
Courtesy of Chuck Blake <cblake@BBN.COM> with the following shell script |
1256 |
snippets: |
1257 |
|
1258 |
# Bourne/Korn/POSIX family of shells: |
1259 |
[ ${TERM:-foo} = foo ] && TERM=xterm # assume an xterm if we don't know |
1260 |
if [ ${TERM:-foo} = xterm ]; then |
1261 |
stty -icanon -echo min 0 time 15 # see if enhanced rxvt or not |
1262 |
echo -n '^[Z' |
1263 |
read term_id |
1264 |
stty icanon echo |
1265 |
if [ ""${term_id} = '^[[?1;2C' -a ${DISPLAY:-foo} = foo ]; then |
1266 |
echo -n '^[[7n' # query the rxvt we are in for the DISPLAY string |
1267 |
read DISPLAY # set it in our local shell |
1268 |
fi |
1269 |
fi |
1270 |
|
1271 |
=item How do I compile the manual pages for myself? |
1272 |
|
1273 |
You need to have a recent version of perl installed as F</usr/bin/perl>, |
1274 |
one that comes with F<pod2man>, F<pod2text> and F<pod2html>. Then go to |
1275 |
the doc subdirectory and enter C<make alldoc>. |
1276 |
|
1277 |
=back |
1278 |
|
1279 |
=head1 ENVIRONMENT |
1280 |
|
1281 |
B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> |
1282 |
and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X |
1283 |
window id number of the B<@@RXVT_NAME@@> window and it also uses and |
1284 |
sets the environment variable B<DISPLAY> to specify which display |
1285 |
terminal to use. B<@@RXVT_NAME@@> uses the environment variables |
1286 |
B<RXVTPATH> and B<PATH> to find XPM files. |
1287 |
|
1288 |
=head1 FILES |
1289 |
|
1290 |
=over 4 |
1291 |
|
1292 |
=item B</etc/utmp> |
1293 |
|
1294 |
System file for login records. |
1295 |
|
1296 |
=item B</usr/lib/X11/rgb.txt> |
1297 |
|
1298 |
Color names. |
1299 |
|
1300 |
=back |
1301 |
|
1302 |
=head1 SEE ALSO |
1303 |
|
1304 |
@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) |
1305 |
|
1306 |
=head1 BUGS |
1307 |
|
1308 |
Check the BUGS file for an up-to-date list. |
1309 |
|
1310 |
Cursor change support is not yet implemented. |
1311 |
|
1312 |
Click-and-drag doesn't work with X11 mouse report overriding. |
1313 |
|
1314 |
=head1 CURRENT PROJECT COORDINATOR |
1315 |
|
1316 |
=over 4 |
1317 |
|
1318 |
=item Project Coordinator |
1319 |
|
1320 |
@@RXVT_MAINT@@ L<@@RXVT_MAINTEMAIL@@> |
1321 |
|
1322 |
=item Web page maintainter |
1323 |
|
1324 |
@@RXVT_WEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@> |
1325 |
|
1326 |
L<@@RXVT_WEBPAGE@@> |
1327 |
|
1328 |
=back |
1329 |
|
1330 |
=head1 AUTHORS |
1331 |
|
1332 |
=over 4 |
1333 |
|
1334 |
=item John Bovey |
1335 |
|
1336 |
University of Kent, 1992, wrote the original Xvt. |
1337 |
|
1338 |
=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> |
1339 |
|
1340 |
very heavily modified Xvt and came up with Rxvt |
1341 |
|
1342 |
=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> |
1343 |
|
1344 |
wrote the Greek Keyboard Input (no longer in code) |
1345 |
|
1346 |
=item mj olesen L<< <olesen@me.QueensU.CA> >> |
1347 |
|
1348 |
Wrote the menu system. |
1349 |
|
1350 |
Project Coordinator (changes.txt 2.11 to 2.21) |
1351 |
|
1352 |
=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> |
1353 |
|
1354 |
Project Coordinator (changes.txt 2.21a to 2.4.5) |
1355 |
|
1356 |
=item Geoff Wing L<< <gcw@pobox.com> >> |
1357 |
|
1358 |
Rewrote screen display and text selection routines. Project Coordinator |
1359 |
(changes.txt 2.4.6 - rxvt-unicode) |
1360 |
|
1361 |
=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> |
1362 |
|
1363 |
Forked rxvt-unicode, rewrote most of the display code and internal |
1364 |
character handling to store text in unicode, improve xterm |
1365 |
compatibility and apply numerous other bugfixes and extensions. |
1366 |
|
1367 |
Project Coordinator (Changes 1.0 -) |
1368 |
|
1369 |
=back |
1370 |
|