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