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<@@RXVTVERSION@@>, 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 |
See also @@RXVT_NAME@@(7) for technical reference documentation (escape |
18 |
sequences etc.). |
19 |
|
20 |
=head1 OPTIONS |
21 |
|
22 |
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 |
24 |
eliminated or default values chosen at compile-time, so options and |
25 |
defaults listed may not accurately reflect the version installed on |
26 |
your system. `rxvt -h' gives a list of major compile-time options on |
27 |
the I<Options> line. Option descriptions may be prefixed with which |
28 |
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 |
30 |
command-line options compiled into your version. |
31 |
|
32 |
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 |
34 |
far greater than those listed. For example: `rxvt --loginShell --color1 |
35 |
Orange'. |
36 |
|
37 |
The following options are available: |
38 |
|
39 |
=over 4 |
40 |
|
41 |
=item B<-help>, B<--help> |
42 |
|
43 |
Print out a message describing available options. |
44 |
|
45 |
=item B<-display> I<displayname> |
46 |
|
47 |
Attempt to open a window on the named X display (B<-d> still |
48 |
respected). In the absence of this option, the display specified by the |
49 |
B<DISPLAY> environment variable is used. |
50 |
|
51 |
=item B<-geometry> I<geom> |
52 |
|
53 |
Window geometry (B<-g> still respected); resource B<geometry>. |
54 |
|
55 |
=item B<-rv>|B<+rv> |
56 |
|
57 |
Turn on/off simulated reverse video; resource B<reverseVideo>. |
58 |
|
59 |
=item B<-j>|B<+j> |
60 |
|
61 |
Turn on/off jump scrolling; resource B<jumpScroll>. |
62 |
|
63 |
=item B<-ip>|B<+ip> |
64 |
|
65 |
Turn on/off inheriting parent window's pixmap. Alternative form is |
66 |
B<-tr>; resource B<inheritPixmap>. |
67 |
|
68 |
=item B<-fade> I<number> |
69 |
|
70 |
Fade the text by the given percentage when focus is lost. |
71 |
|
72 |
=item B<-tint> I<colour> |
73 |
|
74 |
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> |
76 |
option that can be used to brighten or darken the image in addition to |
77 |
tinting it. |
78 |
|
79 |
=item B<-sh> |
80 |
|
81 |
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 |
83 |
specified, too). |
84 |
|
85 |
=item B<-bg> I<colour> |
86 |
|
87 |
Window background colour; resource B<background>. |
88 |
|
89 |
=item B<-fg> I<colour> |
90 |
|
91 |
Window foreground colour; resource B<foreground>. |
92 |
|
93 |
=item B<-pixmap> I<file[;geom]> |
94 |
|
95 |
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 |
97 |
quotes to avoid special shell interpretation of the `;' in the |
98 |
command-line; resource B<backgroundPixmap>. |
99 |
|
100 |
=item B<-cr> I<colour> |
101 |
|
102 |
The cursor colour; resource B<cursorColor>. |
103 |
|
104 |
=item B<-pr> I<colour> |
105 |
|
106 |
The mouse pointer foreground colour; resource B<pointerColor>. |
107 |
|
108 |
=item B<-pr2> I<colour> |
109 |
|
110 |
The mouse pointer background colour; resource B<pointerColor2>. |
111 |
|
112 |
=item B<-bd> I<colour> |
113 |
|
114 |
The colour of the border between the xterm scrollbar and the text; |
115 |
resource B<borderColor>. |
116 |
|
117 |
=item B<-fn> I<fontname> |
118 |
|
119 |
Select the fonts to be used. This is a comma seperated list of font |
120 |
names that are used in turn when trying to display Unicode characters. |
121 |
The first font defines the cell size for characters; other fonts might |
122 |
be smaller, but not larger. A reasonable default font list is always |
123 |
appended to it. resource B<font>. |
124 |
|
125 |
=item B<-rb>|B<+rb> |
126 |
|
127 |
Enable "real bold" support. When this option is on, bold text will be |
128 |
displayed using the first available bold font in the font list. Bold |
129 |
fonts should thus be specified in the font list after their |
130 |
corresponding regular fonts. If no bold font can be found, a regular |
131 |
font will be used. resource B<realBold>. |
132 |
|
133 |
=item B<-name> I<name> |
134 |
|
135 |
Specify the application name under which resources are to be obtained, |
136 |
rather than the default executable file name. Name should not contain |
137 |
`.' or `*' characters. Also sets the icon and title name. |
138 |
|
139 |
=item B<-ls>|B<+ls> |
140 |
|
141 |
Start as a login-shell/sub-shell; resource B<loginShell>. |
142 |
|
143 |
=item B<-ut>|B<+ut> |
144 |
|
145 |
Compile I<utmp>: Inhibit/enable writing a utmp entry; resource |
146 |
B<utmpInhibit>. |
147 |
|
148 |
=item B<-vb>|B<+vb> |
149 |
|
150 |
Turn on/off visual bell on receipt of a bell character; resource |
151 |
B<visualBell>. |
152 |
|
153 |
=item B<-sb>|B<+sb> |
154 |
|
155 |
Turn on/off scrollbar; resource B<scrollBar>. |
156 |
|
157 |
=item B<-si>|B<+si> |
158 |
|
159 |
Turn on/off scroll-to-bottom on TTY output inhibit; resource |
160 |
B<scrollTtyOutput> has opposite effect. |
161 |
|
162 |
=item B<-sk>|B<+sk> |
163 |
|
164 |
Turn on/off scroll-to-bottom on keypress; resource |
165 |
B<scrollTtyKeypress>. |
166 |
|
167 |
=item B<-sw>|B<+sw> |
168 |
|
169 |
Turn on/off scrolling with the scrollback buffer as new lines appear. |
170 |
This only takes effect if B<-si> is also given; resource |
171 |
B<scrollWithBuffer>. |
172 |
|
173 |
=item B<-sr>|B<+sr> |
174 |
|
175 |
Put scrollbar on right/left; resource B<scrollBar_right>. |
176 |
|
177 |
=item B<-st>|B<+st> |
178 |
|
179 |
Display normal (non XTerm/NeXT) scrollbar without/with a trough; |
180 |
resource B<scrollBar_floating>. |
181 |
|
182 |
=item B<-bc>|B<+bc> |
183 |
|
184 |
Blink the cursor; resource B<cursorBlink>. |
185 |
|
186 |
=item B<-iconic> |
187 |
|
188 |
Start iconified, if the window manager supports that option. |
189 |
Alternative form is B<-ic>. |
190 |
|
191 |
=item B<-sl> I<number> |
192 |
|
193 |
Save I<number> lines in the scrollback buffer. See resource entry for |
194 |
limits; resource B<saveLines>. |
195 |
|
196 |
=item B<-b> I<number> |
197 |
|
198 |
Compile I<frills>: Internal border of I<number> pixels. See resource |
199 |
entry for limits; resource B<internalBorder>. |
200 |
|
201 |
=item B<-w> I<number> |
202 |
|
203 |
Compile I<frills>: External border of I<number> pixels. Also, B<-bw> |
204 |
and B<-borderwidth>. See resource entry for limits; resource |
205 |
B<externalBorder>. |
206 |
|
207 |
=item B<-bl> |
208 |
|
209 |
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 |
211 |
decorations; resource B<borderLess>. |
212 |
|
213 |
=item B<-lsp> I<number> |
214 |
|
215 |
Compile I<linespace>: Lines (pixel height) to insert between each row |
216 |
of the display; resource B<linespace>. |
217 |
|
218 |
=item B<-tn> I<termname> |
219 |
|
220 |
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 |
222 |
I<termcap(5)> database and should have I<li#> and I<co#> entries; |
223 |
resource B<termName>. |
224 |
|
225 |
=item B<-e> I<command [arguments]> |
226 |
|
227 |
Run the command with its command-line arguments in the B<@@RXVT_NAME@@> |
228 |
window; also sets the window title and icon name to be the basename of |
229 |
the program being executed if neither I<-title> (I<-T>) nor I<-n> are |
230 |
given on the command line. If this option is used, it must be the last |
231 |
on the command-line. If there is no B<-e> option then the default is to |
232 |
run the program specified by the B<SHELL> environment variable or, |
233 |
failing that, I<sh(1)>. |
234 |
|
235 |
=item B<-title> I<text> |
236 |
|
237 |
Window title (B<-T> still respected); the default title is the basename |
238 |
of the program specified after the B<-e> option, if any, otherwise the |
239 |
application name; resource B<title>. |
240 |
|
241 |
=item B<-n> I<text> |
242 |
|
243 |
Icon name; the default name is the basename of the program specified |
244 |
after the B<-e> option, if any, otherwise the application name; |
245 |
resource B<iconName>. |
246 |
|
247 |
=item B<-C> |
248 |
|
249 |
Capture system console messages. |
250 |
|
251 |
=item B<-pt> I<style> |
252 |
|
253 |
Compile I<XIM>: input style for input method; B<OverTheSpot>, |
254 |
B<OffTheSpot>, B<Root>; resource B<preeditType>. |
255 |
|
256 |
=item B<-im> I<text> |
257 |
|
258 |
Compile I<XIM>: input method name. resource B<inputMethod>. |
259 |
|
260 |
=item B<-imlocale> I<string> |
261 |
|
262 |
The locale to use for opening the IM. You can use an LC_CTYPE of e.g. |
263 |
de_DE.UTF-8 for normal text processing but ja_JP.EUC-JP for the input |
264 |
extension to be able to input japanese characters while staying in |
265 |
another locale. |
266 |
|
267 |
=item B<-insecure> |
268 |
|
269 |
Enable "insecure" mode, which currently enables most of the escape |
270 |
sequences that echo strings. See the resource B<insecure> for more |
271 |
info. |
272 |
|
273 |
=item B<-mod> I<modifier> |
274 |
|
275 |
Override detection of Meta modifier with specified key: B<alt>, |
276 |
B<meta>, B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, |
277 |
B<mod5>; resource I<modifier>. |
278 |
|
279 |
=item B<-ssc>|B<+ssc> |
280 |
|
281 |
Turn on/off secondary screen (default enabled); resource |
282 |
B<secondaryScreen>. |
283 |
|
284 |
=item B<-ssr>|B<+ssr> |
285 |
|
286 |
Turn on/off secondary screen scroll (default enabled); resource |
287 |
B<secondaryScroll>. |
288 |
|
289 |
=item B<-xrm> I<resourcestring> |
290 |
|
291 |
No effect on rxvt. Simply passes through an argument to be made |
292 |
available in the instance's argument list. Appears in I<WM_COMMAND> in |
293 |
some window managers. |
294 |
|
295 |
=back |
296 |
|
297 |
=head1 RESOURCES (available also as long-options) |
298 |
|
299 |
Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
300 |
options) compiled into your version. |
301 |
|
302 |
There are two different methods that @@RXVT_NAME@@ can use to get the |
303 |
Xresource data: using the X libraries (Xrm*-functions) or internal |
304 |
Xresources reader (B<~/.Xdefaults>). For the first method (ie. |
305 |
B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the |
306 |
resources using X11 tools like B<xset>. Many distribution do also load |
307 |
settings from the B<~/.Xresources> file when X starts. |
308 |
|
309 |
If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h> |
310 |
lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults |
311 |
set in XAPPLOADDIR/URxvt (compile-time defined: usually |
312 |
B</usr/lib/X11/app-defaults/URxvt>) and resources set in |
313 |
B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist. |
314 |
Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two |
315 |
class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows |
316 |
resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be |
317 |
easily configured, while the class name B<URxvt> allows resources |
318 |
unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be |
319 |
shared between different B<@@RXVT_NAME@@> configurations. If no |
320 |
resources are specified, suitable defaults will be used. Command-line |
321 |
arguments can be used to override resource settings. The following |
322 |
resources are allowed: |
323 |
|
324 |
=over 4 |
325 |
|
326 |
=item B<geometry:> I<geom> |
327 |
|
328 |
Create the window with the specified X window geometry [default 80x24]; |
329 |
option B<-geometry>. |
330 |
|
331 |
=item B<background:> I<colour> |
332 |
|
333 |
Use the specified colour as the window's background colour [default |
334 |
White]; option B<-bg>. |
335 |
|
336 |
=item B<foreground:> I<colour> |
337 |
|
338 |
Use the specified colour as the window's foreground colour [default |
339 |
Black]; option B<-fg>. |
340 |
|
341 |
=item B<color>I<n>B<:> I<colour> |
342 |
|
343 |
Use the specified colour for the colour value I<n>, where 0-7 |
344 |
corresponds to low-intensity (normal) colours and 8-15 corresponds to |
345 |
high-intensity (bold = bright foreground, blink = bright background) |
346 |
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 |
348 |
names used are listed in the B<COLORS AND GRAPHICS> section. |
349 |
|
350 |
=item B<colorBD:> I<colour> |
351 |
|
352 |
Use the specified colour to display bold characters when the foreground |
353 |
colour is the default. This option will be ignored if B<realBold> is |
354 |
enabled. |
355 |
|
356 |
=item B<colorUL:> I<colour> |
357 |
|
358 |
Use the specified colour to display underlined characters when the |
359 |
foreground colour is the default. |
360 |
|
361 |
=item B<colorRV:> I<colour> |
362 |
|
363 |
Use the specified colour as the background for reverse video |
364 |
characters. |
365 |
|
366 |
=item B<cursorColor:> I<colour> |
367 |
|
368 |
Use the specified colour for the cursor. The default is to use the |
369 |
foreground colour; option B<-cr>. |
370 |
|
371 |
=item B<cursorColor2:> I<colour> |
372 |
|
373 |
Use the specified colour for the colour of the cursor text. For this to |
374 |
take effect, B<cursorColor> must also be specified. The default is to |
375 |
use the background colour. |
376 |
|
377 |
=item B<reverseVideo:> I<boolean> |
378 |
|
379 |
B<True>: simulate reverse video by foreground and background colours; |
380 |
option B<-rv>. B<False>: regular screen colours [default]; option |
381 |
B<+rv>. See note in B<COLORS AND GRAPHICS> section. |
382 |
|
383 |
=item B<jumpScroll:> I<boolean> |
384 |
|
385 |
B<True>: specify that jump scrolling should be used. When scrolling |
386 |
quickly, fewer screen updates are performed [default]; option B<-j>. |
387 |
B<False>: specify that smooth scrolling should be used; option B<+j>. |
388 |
|
389 |
=item B<inheritPixmap:> I<boolean> |
390 |
|
391 |
B<True>: make the background inherit the parent windows' pixmap, giving |
392 |
artificial transparency. B<False>: do not inherit the parent windows' |
393 |
pixmap. |
394 |
|
395 |
=item B<fading:> I<number> |
396 |
|
397 |
Fade the text by the given percentage when focus is lost. |
398 |
|
399 |
=item B<tintColor:> I<colour> |
400 |
|
401 |
Tint the transparent background pixmap with the given colour. |
402 |
|
403 |
=item B<shading:> I<number> |
404 |
|
405 |
Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
406 |
image in addition to tinting it. |
407 |
|
408 |
=item B<fading:> I<number> |
409 |
|
410 |
Scale the tint colour by the given percentage. |
411 |
|
412 |
=item B<scrollColor:> I<colour> |
413 |
|
414 |
Use the specified colour for the scrollbar [default #B2B2B2]. |
415 |
|
416 |
=item B<troughColor:> I<colour> |
417 |
|
418 |
Use the specified colour for the scrollbar's trough area [default |
419 |
#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. |
420 |
|
421 |
=item B<backgroundPixmap:> I<file[;geom]> |
422 |
|
423 |
Use the specified XPM file (note the `.xpm' extension is optional) for |
424 |
the background and also optionally specify its scaling with a geometry |
425 |
string B<WxH+X+Y>, in which B<"W" / "H"> specify the |
426 |
horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image |
427 |
centre (percent). A scale of 0 displays the image with tiling. A scale |
428 |
of 1 displays the image without any scaling. A scale of 2 to 9 |
429 |
specifies an integer number of images in that direction. No image will |
430 |
be magnified beyond 10 times its original size. The maximum permitted |
431 |
scale is 1000. [default 0x0+50+50] |
432 |
|
433 |
=item B<menu:> I<file[;tag]> |
434 |
|
435 |
Read in the specified menu file (note the `.menu' extension is |
436 |
optional) and also optionally specify a starting tag to find. See the |
437 |
reference documentation for details on the syntax for the menuBar. |
438 |
|
439 |
=item B<path:> I<path> |
440 |
|
441 |
Specify the colon-delimited search path for finding files (XPM and |
442 |
menus), in addition to the paths specified by the B<RXVTPATH> and |
443 |
B<PATH> environment variables. |
444 |
|
445 |
=item B<font:> I<fontname> |
446 |
|
447 |
Select the fonts to be used. This is a comma seperated list of font |
448 |
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 |
450 |
be smaller, but not larger. A reasonable default font list is always |
451 |
appended to it. option B<-fn>. |
452 |
|
453 |
=item B<realBold:> I<boolean> |
454 |
|
455 |
B<True>: Enable "real bold" support. When this option is on, bold text |
456 |
will be displayed using the first available bold font in the font list. |
457 |
Bold fonts should thus be specified in the font list after their |
458 |
corresponding regular fonts. If no bold font can be found, a regular |
459 |
font will be used. option B<-rb>. B<False>: Display bold text in a |
460 |
regular font, using the color specified with B<colorBD>; option B<+rb>. |
461 |
|
462 |
=item B<selectstyle:> I<mode> |
463 |
|
464 |
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 |
466 |
xterm style selection. |
467 |
|
468 |
=item B<scrollstyle:> I<mode> |
469 |
|
470 |
Set scrollbar style to B<@@RXVT_NAME@@>, B<rxvt>, B<plain>, B<next> or |
471 |
B<xterm> |
472 |
|
473 |
=item B<title:> I<string> |
474 |
|
475 |
Set window title string, the default title is the command-line |
476 |
specified after the B<-e> option, if any, otherwise the application |
477 |
name; option B<-title>. |
478 |
|
479 |
=item B<iconName:> I<string> |
480 |
|
481 |
Set the name used to label the window's icon or displayed in an icon |
482 |
manager window, it also sets the window's title unless it is explicitly |
483 |
set; option B<-n>. |
484 |
|
485 |
=item B<mapAlert:> I<boolean> |
486 |
|
487 |
B<True>: de-iconify (map) on receipt of a bell character. B<False>: no |
488 |
de-iconify (map) on receipt of a bell character [default]. |
489 |
|
490 |
=item B<visualBell:> I<boolean> |
491 |
|
492 |
B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
493 |
B<False>: no visual bell [default]; option B<+vb>. |
494 |
|
495 |
=item B<loginShell:> I<boolean> |
496 |
|
497 |
B<True>: start as a login shell by prepending a `-' to B<argv[0]> of |
498 |
the shell; option B<-ls>. B<False>: start as a normal sub-shell |
499 |
[default]; option B<+ls>. |
500 |
|
501 |
=item B<utmpInhibit:> I<boolean> |
502 |
|
503 |
B<True>: inhibit writing record into the system log file B<utmp>; |
504 |
option B<-ut>. B<False>: write record into the system log file B<utmp> |
505 |
[default]; option B<+ut>. |
506 |
|
507 |
=item B<print-pipe:> I<string> |
508 |
|
509 |
Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use |
510 |
B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or |
511 |
B<Shift-Print> to include the scrollback as well. |
512 |
|
513 |
=item B<scrollBar:> I<boolean> |
514 |
|
515 |
B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
516 |
disable the scrollbar; option B<+sb>. |
517 |
|
518 |
=item B<scrollBar_right:> I<boolean> |
519 |
|
520 |
B<True>: place the scrollbar on the right of the window; option B<-sr>. |
521 |
B<False>: place the scrollbar on the left of the window; option B<+sr>. |
522 |
|
523 |
=item B<scrollBar_floating:> I<boolean> |
524 |
|
525 |
B<True>: display an rxvt scrollbar without a trough; option B<-st>. |
526 |
B<False>: display an rxvt scrollbar with a trough; option B<+st>. |
527 |
|
528 |
=item B<scrollBar_align:> I<mode> |
529 |
|
530 |
Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar |
531 |
thumb with the pointer on middle button press/drag. |
532 |
|
533 |
=item B<scrollTtyOutput:> I<boolean> |
534 |
|
535 |
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 |
537 |
B<-si>. |
538 |
|
539 |
=item B<scrollWithBuffer:> I<boolean> |
540 |
|
541 |
B<True>: scroll with scrollback buffer when tty recieves new lines (and |
542 |
B<scrollTtyOutput> is False); option B<+sw>. B<False>: do not scroll |
543 |
with scrollback buffer when tty recieves new lines; option B<-sw>. |
544 |
|
545 |
=item B<scrollTtyKeypress:> I<boolean> |
546 |
|
547 |
B<True>: scroll to bottom when a non-special key is pressed. Special |
548 |
keys are those which are intercepted by rxvt for special handling and |
549 |
are not passed onto the shell; option B<-sk>. B<False>: do not scroll |
550 |
to 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 |
|
562 |
=item B<saveLines:> I<number> |
563 |
|
564 |
Save I<number> lines in the scrollback buffer [default 64]. This |
565 |
resource is limited on most machines to 65535; option B<-sl>. |
566 |
|
567 |
=item B<internalBorder:> I<number> |
568 |
|
569 |
Internal border of I<number> pixels. This resource is limited to 100; |
570 |
option B<-b>. |
571 |
|
572 |
=item B<externalBorder:> I<number> |
573 |
|
574 |
External border of I<number> pixels. This resource is limited to 100; |
575 |
option B<-w>, B<-bw>, B<-borderwidth>. |
576 |
|
577 |
=item B<borderLess:> I<boolean> |
578 |
|
579 |
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>. |
581 |
|
582 |
=item B<termName:> I<termname> |
583 |
|
584 |
Specifies the terminal type name to be set in the B<TERM> environment |
585 |
variable; option B<-tn>. |
586 |
|
587 |
=item B<linespace:> I<number> |
588 |
|
589 |
Specifies number of lines (pixel height) to insert between each row of |
590 |
the display [default 0]; option B<-lsp>. |
591 |
|
592 |
=item B<meta8:> I<boolean> |
593 |
|
594 |
B<True>: handle Meta (Alt) + keypress to set the 8th bit. B<False>: |
595 |
handle Meta (Alt) + keypress as an escape prefix [default]. |
596 |
|
597 |
=item B<mouseWheelScrollPage:> I<boolean> |
598 |
|
599 |
B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel |
600 |
scrolls five lines [default]. |
601 |
|
602 |
=item B<cursorBlink:> I<boolean> |
603 |
|
604 |
B<True>: blink the cursor. B<False>: do not blink the cursor [default]; |
605 |
option B<-bc>. |
606 |
|
607 |
=item B<pointerBlank:> I<boolean> |
608 |
|
609 |
B<True>: blank the pointer when a key is pressed or after a set number |
610 |
of seconds of inactivity. B<False>: the pointer is always visible |
611 |
[default]. |
612 |
|
613 |
=item B<pointerColor:> I<colour> |
614 |
|
615 |
Mouse pointer foreground colour. |
616 |
|
617 |
=item B<pointerColor2:> I<colour> |
618 |
|
619 |
Mouse pointer background colour. |
620 |
|
621 |
=item B<pointerBlankDelay:> I<number> |
622 |
|
623 |
Specifies number of seconds before blanking the pointer [default 2]. |
624 |
|
625 |
=item B<backspacekey:> I<string> |
626 |
|
627 |
The string to send when the backspace key is pressed. If set to B<DEC> |
628 |
or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> |
629 |
(code 8) - which can be reversed with the appropriate DEC private mode |
630 |
escape sequence. |
631 |
|
632 |
=item B<deletekey:> I<string> |
633 |
|
634 |
The string to send when the delete key (not the keypad delete key) is |
635 |
pressed. If unset it will send the sequence traditionally associated |
636 |
with the B<Execute> key. |
637 |
|
638 |
=item B<cutchars:> I<string> |
639 |
|
640 |
The characters used as delimiters for double-click word selection. The |
641 |
built-in default: |
642 |
|
643 |
B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> |
644 |
|
645 |
=item B<preeditType:> I<style> |
646 |
|
647 |
B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. |
648 |
|
649 |
=item B<inputMethod:> I<name> |
650 |
|
651 |
I<name> of inputMethod to use; option B<-im>. |
652 |
|
653 |
=item B<imLocale:> I<name> |
654 |
|
655 |
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 |
657 |
extension to be able to input japanese characters while staying in |
658 |
another locale. option B<-imlocale>. |
659 |
|
660 |
=item B<insecure> |
661 |
|
662 |
Enables "insecure" mode. Rxvt-unicode offers some escape sequences that |
663 |
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 |
665 |
throuh a mail client displaying mail bodies unfiltered or though |
666 |
write(1). Therefore, these sequences are disabled by default. (Note |
667 |
that other terminals, including xterm, have these sequences |
668 |
enabled by default). You can enable them by setting this boolean |
669 |
resource or specifying B<-insecure> as an option. At the moment, this |
670 |
enabled display-answer, locale, findfont, icon label and window title |
671 |
requests as well as dynamic menubar dispatch. |
672 |
|
673 |
=item B<modifier:> I<modifier> |
674 |
|
675 |
Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, |
676 |
B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option |
677 |
B<-mod>. |
678 |
|
679 |
=item B<answerbackString:> I<string> |
680 |
|
681 |
Specify the reply rxvt sends to the shell when an ENQ (control-E) |
682 |
character is passed through. It may contain escape values as described |
683 |
in the entry on B<keysym> following. |
684 |
|
685 |
=item B<secondaryScreen:> I<bool> |
686 |
|
687 |
Turn on/off secondary screen (default enabled). |
688 |
|
689 |
=item B<secondaryScroll:> I<bool> |
690 |
|
691 |
Turn on/off secondary screen scroll (default enabled). If the this |
692 |
option is enabled, scrolls on the secondary screen will change the |
693 |
scrollback buffer and switching to/from the secondary screen will |
694 |
instead scroll the screen up. |
695 |
|
696 |
=item B<keysym.>I<sym>: I<string> |
697 |
|
698 |
Associate I<string> with keysym I<sym> (B<0xFF00 - 0xFFFF>). It may |
699 |
contain escape values (\a: bell, \b: backspace, \e, \E: escape, \n: |
700 |
newline, \r: return, \t: |
701 |
tab, \000: octal number) or control characters (^?: delete, ^@: null, |
702 |
^A ...) and may enclosed with double quotes so that it can start or end |
703 |
with whitespace. The intervening resource name B<keysym.> cannot be |
704 |
omitted. This resource is only available when compiled with |
705 |
KEYSYM_RESOURCE. |
706 |
|
707 |
=back |
708 |
|
709 |
=head1 THE SCROLLBAR |
710 |
|
711 |
Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window |
712 |
(resource: B<saveLines>) and can be scrolled back using the scrollbar |
713 |
or by keystrokes. The normal B<@@RXVT_NAME@@> scrollbar has arrows and |
714 |
its behaviour is fairly intuitive. The B<xterm-scrollbar> is without |
715 |
arrows and its behaviour mimics that of I<xterm> |
716 |
|
717 |
Scroll down with B<Button1> (B<xterm-scrollbar>) or B<Shift-Next>. |
718 |
Scroll up with B<Button3> (B<xterm-scrollbar>) or B<Shift-Prior>. |
719 |
Continuous scroll with B<Button2>. |
720 |
|
721 |
=head1 MOUSE REPORTING |
722 |
|
723 |
To temporarily override mouse reporting, for either the scrollbar or |
724 |
the normal text selection/insertion, hold either the Shift or the Meta |
725 |
(Alt) key while performing the desired mouse action. |
726 |
|
727 |
If mouse reporting mode is active, the normal scrollbar actions are |
728 |
disabled -- on the assumption that we are using a fullscreen |
729 |
application. Instead, pressing Button1 and Button3 sends B<ESC[6~> |
730 |
(Next) and B<ESC[5~> (Prior), respectively. Similarly, clicking on the |
731 |
up and down arrows sends B<ESC[A> (Up) and B<ESC[B> (Down), |
732 |
respectively. |
733 |
|
734 |
=head1 TEXT SELECTION AND INSERTION |
735 |
|
736 |
The behaviour of text selection and insertion mechanism is similar to |
737 |
I<xterm>(1). |
738 |
|
739 |
=over 4 |
740 |
|
741 |
=item B<Selection>: |
742 |
|
743 |
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 |
745 |
double-click to select a word; Left triple-click to select the entire |
746 |
line. |
747 |
|
748 |
=item B<Insertion>: |
749 |
|
750 |
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 |
752 |
inserted as if it had been typed on the keyboard. |
753 |
|
754 |
=back |
755 |
|
756 |
=head1 CHANGING FONTS |
757 |
|
758 |
You can change fonts on-the-fly, which is to say cycle through the |
759 |
default font and others of various sizes, by using B<Shift-KP_Add> and |
760 |
B<Shift-KP_Subtract>. Or, alternatively (if enabled) with |
761 |
B<@@HOTKEY@@-@@BIGFONT@@> and B<@@HOTKEY@@-@@SMALLFONT@@>, where the |
762 |
actual key can be selected using resources |
763 |
B<smallfont_key>/B<bigfont_key>. |
764 |
|
765 |
=head1 ISO 14755 SUPPORT |
766 |
|
767 |
Partial ISO 14755-support is implemented. that means that pressing |
768 |
|
769 |
Section 5.1: Control and Shift together enters unicode input |
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 |
|
774 |
Section 5.2: Pressing and immediately releasing Control and Shift together |
775 |
enters keycap entry mode for the next key: pressing a function key (tab, |
776 |
return etc..) will enter the unicode character corresponding to the given |
777 |
key. |
778 |
|
779 |
=head1 LOGIN STAMP |
780 |
|
781 |
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. |
783 |
To allow this feature, B<@@RXVT_NAME@@> must be installed setuid root on |
784 |
some systems. |
785 |
|
786 |
=head1 COLORS AND GRAPHICS |
787 |
|
788 |
In addition to the default foreground and background colours, |
789 |
B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus |
790 |
high-intensity bold/blink versions of the same). Here is a list of the |
791 |
colours with their B<rgb.txt> names. |
792 |
|
793 |
=begin table |
794 |
|
795 |
B<color0> (black) = Black |
796 |
B<color1> (red) = Red3 |
797 |
B<color2> (green) = Green3 |
798 |
B<color3> (yellow) = Yellow3 |
799 |
B<color4> (blue) = Blue3 |
800 |
B<color5> (magenta) = Magenta3 |
801 |
B<color6> (cyan) = Cyan3 |
802 |
B<color7> (white) = AntiqueWhite |
803 |
B<color8> (bright black) = Grey25 |
804 |
B<color9> (bright red) = Red |
805 |
B<color10> (bright green) = Green |
806 |
B<color11> (bright yellow) = Yellow |
807 |
B<color12> (bright blue) = Blue |
808 |
B<color13> (bright magenta) = Magenta |
809 |
B<color14> (bright cyan) = Cyan |
810 |
B<color15> (bright white) = White |
811 |
B<foreground> = Black |
812 |
B<background> = White |
813 |
|
814 |
=end table |
815 |
|
816 |
It is also possible to specify the colour values of B<foreground>, |
817 |
B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
818 |
a number 0-15, as a convenient shorthand to reference the colour name of |
819 |
color0-color15. |
820 |
|
821 |
Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
822 |
always swapping the foreground/background colours. This is in contrast to |
823 |
I<xterm>(1) where the colours are only swapped if they have not otherwise |
824 |
been specified. For example, |
825 |
|
826 |
=over 4 |
827 |
|
828 |
=item B<rxvt -fg Black -bg White -rv> |
829 |
|
830 |
would yield White on Black, while on I<xterm>(1) it would yield Black |
831 |
on White. |
832 |
|
833 |
=back |
834 |
|
835 |
=head1 ENVIRONMENT |
836 |
|
837 |
B<@@RXVT_NAME@@> sets the environment variables B<TERM>, B<COLORTERM> |
838 |
and B<COLORFGBG>. The environment variable B<WINDOWID> is set to the X |
839 |
window id number of the B<@@RXVT_NAME@@> window and it also uses and |
840 |
sets the environment variable B<DISPLAY> to specify which display |
841 |
terminal to use. B<@@RXVT_NAME@@> uses the environment variables |
842 |
B<RXVTPATH> and B<PATH> to find XPM files. |
843 |
|
844 |
=head1 FILES |
845 |
|
846 |
=over 4 |
847 |
|
848 |
=item B</etc/utmp> |
849 |
|
850 |
System file for login records. |
851 |
|
852 |
=item B</usr/lib/X11/rgb.txt> |
853 |
|
854 |
Color names. |
855 |
|
856 |
=back |
857 |
|
858 |
=head1 SEEALSO |
859 |
|
860 |
I<xterm>(1), I<sh>(1), I<resize>(1), I<X>(1), I<pty>(4), I<tty>(4), I<utmp>(5) |
861 |
|
862 |
See rxvtRef.html rxvtRef.txt for detailed information on recognized escape sequences and menuBar syntax, etc. |
863 |
|
864 |
=head1 BUGS |
865 |
|
866 |
Check the BUGS file for an up-to-date list. |
867 |
|
868 |
Cursor change support is not yet implemented. |
869 |
|
870 |
Click-and-drag doesn't work with X11 mouse report overriding. |
871 |
|
872 |
=head1 CURRENT PROJECT COORDINATOR |
873 |
|
874 |
=over 4 |
875 |
|
876 |
=item Project Coordinator |
877 |
|
878 |
@@RXVTMAINT@@ L<@@RXVT_MAINTEMAIL@@> |
879 |
|
880 |
=item Web page maintainter |
881 |
|
882 |
@@RXVTWEBMAINT@@ L<@@RXVT_WEBMAINTEMAIL@@> |
883 |
|
884 |
L<@@RXVT_WEBPAGE@@> |
885 |
|
886 |
=back |
887 |
|
888 |
=head1 AUTHORS |
889 |
|
890 |
=over 4 |
891 |
|
892 |
=item John Bovey |
893 |
|
894 |
University of Kent, 1992, wrote the original Xvt. |
895 |
|
896 |
=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> |
897 |
|
898 |
very heavily modified Xvt and came up with Rxvt |
899 |
|
900 |
=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> |
901 |
|
902 |
wrote the Greek Keyboard Input (no longer in code) |
903 |
|
904 |
=item mj olesen L<< <olesen@me.QueensU.CA> >> |
905 |
|
906 |
Wrote the menu system. |
907 |
|
908 |
Project Coordinator (changes.txt 2.11 to 2.21) |
909 |
|
910 |
=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> |
911 |
|
912 |
Project Coordinator (changes.txt 2.21a to 2.4.5) |
913 |
|
914 |
=item Geoff Wing L<< <gcw@pobox.com> >> |
915 |
|
916 |
Rewrote screen display and text selection routines. Project Coordinator |
917 |
(changes.txt 2.4.6 - rxvt-unicode) |
918 |
|
919 |
=item Marc Alexander Lehmann L<< <rxvt@schmorp.de> >> |
920 |
|
921 |
Forked rxvt-unicode, rewrote most of the display code and internal |
922 |
character handling to store text in unicode, improve xterm |
923 |
compatibility and apply numerous other bugfixes and extensions. |
924 |
|
925 |
Project Coordinator (Changes 1.0 -) |
926 |
|
927 |
=back |
928 |
|