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 FREQUENTLY ASKED QUESTIONS |
18 |
|
19 |
See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of |
20 |
frequently asked questions and answer to them and some common |
21 |
problems. That document is also accessible on the World-Wide-Web at |
22 |
L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. |
23 |
|
24 |
=head1 RXVT-UNICODE VS. RXVT |
25 |
|
26 |
Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode |
27 |
internally. That means it can store and display most scripts in the |
28 |
world. Being a terminal emulator, however, some things are very difficult, |
29 |
especially cursive scripts such as arabic, vertically written scripts |
30 |
like mongolian or scripts requiring extremely complex combining rules, |
31 |
like tibetan or devenagari. Don't expect pretty output when using these |
32 |
scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work |
33 |
fine, though. A somewhat difficult case are right-to-left scripts, such |
34 |
as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms |
35 |
belong into the application, not the terminal emulator (too many things -- |
36 |
such as cursor-movement while editing -- break otherwise), but that might |
37 |
change. |
38 |
|
39 |
If you are looking for a terminal that supports more exotic scripts, let |
40 |
me recommend C<mlterm>, which is a very userfriendly, lean and clean |
41 |
terminal emulator. In fact, the reason rxvt-unicode was born was solely |
42 |
because the author couldn't get C<mlterm> to use one font for latin1 and |
43 |
another for japanese. |
44 |
|
45 |
Therefore another design rationale was the use of multiple fonts to |
46 |
display characters: The idea of a single unicode font which many other |
47 |
programs force onto its users never made sense to me: You should be able |
48 |
to choose any font for any script freely. |
49 |
|
50 |
Apart from that, rxvt-unicode is also much better internationalised than |
51 |
its predecessor, supports things such as XFT and ISO 14755 that are handy |
52 |
in i18n-environments, is faster, and has a lot bugs less than the original |
53 |
rxvt. This all in addition to dozens of other small improvements. |
54 |
|
55 |
It is still faithfully following the original rxvt idea of being lean |
56 |
and nice on resources: for example, you can still configure rxvt-unicode |
57 |
without most of its features to get a lean binary. It also comes with |
58 |
a client/daemon pair that lets you open any number of terminal windows |
59 |
from within a single process, which makes startup time very fast and |
60 |
drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and |
61 |
@@RXVT_NAME@@c(1) (client). |
62 |
|
63 |
It also makes technical information about escape sequences (which have |
64 |
been extended) more accessible: see @@RXVT_NAME@@(7) for technical |
65 |
reference documentation (escape sequences etc.). |
66 |
|
67 |
=head1 OPTIONS |
68 |
|
69 |
The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed |
70 |
below. In keeping with the smaller-is-better philosophy, options may be |
71 |
eliminated or default values chosen at compile-time, so options and |
72 |
defaults listed may not accurately reflect the version installed on |
73 |
your system. `@@RXVT_NAME@@ -h' gives a list of major compile-time options on |
74 |
the I<Options> line. Option descriptions may be prefixed with which |
75 |
compile option each is dependent upon. e.g. `Compile I<XIM>:' requires |
76 |
I<XIM> on the I<Options> line. Note: `@@RXVT_NAME@@ -help' gives a list of all |
77 |
command-line options compiled into your version. |
78 |
|
79 |
Note that B<@@RXVT_NAME@@> permits the resource name to be used as a |
80 |
long-option (--/++ option) so the potential command-line options are |
81 |
far greater than those listed. For example: `@@RXVT_NAME@@ --loginShell --color1 |
82 |
Orange'. |
83 |
|
84 |
The following options are available: |
85 |
|
86 |
=over 4 |
87 |
|
88 |
=item B<-help>, B<--help> |
89 |
|
90 |
Print out a message describing available options. |
91 |
|
92 |
=item B<-display> I<displayname> |
93 |
|
94 |
Attempt to open a window on the named X display (B<-d> still |
95 |
respected). In the absence of this option, the display specified by the |
96 |
B<DISPLAY> environment variable is used. |
97 |
|
98 |
=item B<-depth> I<bitdepth> |
99 |
|
100 |
Compile I<xft>: Attempt to find a visual with the given bit depth; |
101 |
resource B<depth>. |
102 |
|
103 |
=item B<-geometry> I<geom> |
104 |
|
105 |
Window geometry (B<-g> still respected); resource B<geometry>. |
106 |
|
107 |
=item B<-rv>|B<+rv> |
108 |
|
109 |
Turn on/off simulated reverse video; resource B<reverseVideo>. |
110 |
|
111 |
=item B<-j>|B<+j> |
112 |
|
113 |
Turn on/off jump scrolling; resource B<jumpScroll>. |
114 |
|
115 |
=item B<-ip>|B<+ip> | B<-tr>|B<+tr> |
116 |
|
117 |
Turn on/off inheriting parent window's pixmap. Alternative form is |
118 |
B<-tr>; resource B<inheritPixmap>. |
119 |
|
120 |
I<Please note that transparency of any kind if completely unsupported by |
121 |
the author. Don't bug him with installation questions! Read the FAQ (man 7 |
122 |
@@RXVT_NAME@@)!> |
123 |
|
124 |
=item B<-fade> I<number> |
125 |
|
126 |
Fade the text by the given percentage when focus is lost. Small values |
127 |
fade a little only, 100 completely replaces all colours by the fade |
128 |
colour; resource B<fading>. |
129 |
|
130 |
=item B<-fadecolor> I<colour> |
131 |
|
132 |
Fade to this colour when fading is used (see B<-fade>). The default colour |
133 |
is opaque black. resource B<fadeColor>. |
134 |
|
135 |
=item B<-tint> I<colour> |
136 |
|
137 |
Tint the transparent background pixmap with the given colour when |
138 |
transparency is enabled with B<-tr> or B<-ip>. This only works for |
139 |
non-tiled backgrounds, currently. See also the B<-sh> option that can be |
140 |
used to brighten or darken the image in addition to tinting it; resource |
141 |
I<tintColor>. Example: |
142 |
|
143 |
@@RXVT_NAME@@ -tr -tint blue -sh 40 |
144 |
|
145 |
=item B<-sh> |
146 |
|
147 |
I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent |
148 |
background image in addition to tinting it (i.e. B<-tint> must be |
149 |
specified, too, e.g. C<-tint white>). |
150 |
|
151 |
=item B<-bg> I<colour> |
152 |
|
153 |
Window background colour; resource B<background>. |
154 |
|
155 |
=item B<-fg> I<colour> |
156 |
|
157 |
Window foreground colour; resource B<foreground>. |
158 |
|
159 |
=item B<-pixmap> I<file[;geom]> |
160 |
|
161 |
Compile I<XPM>: Specify XPM file for the background and also optionally |
162 |
specify its scaling with a geometry string. Note you may need to |
163 |
add quotes to avoid special shell interpretation of the C<;> in the |
164 |
command-line; resource B<backgroundPixmap>. |
165 |
|
166 |
=item B<-cr> I<colour> |
167 |
|
168 |
The cursor colour; resource B<cursorColor>. |
169 |
|
170 |
=item B<-pr> I<colour> |
171 |
|
172 |
The mouse pointer foreground colour; resource B<pointerColor>. |
173 |
|
174 |
=item B<-pr2> I<colour> |
175 |
|
176 |
The mouse pointer background colour; resource B<pointerColor2>. |
177 |
|
178 |
=item B<-bd> I<colour> |
179 |
|
180 |
The colour of the border around the text area and between the scrollbar and the text; |
181 |
resource B<borderColor>. |
182 |
|
183 |
=item B<-fn> I<fontlist> |
184 |
|
185 |
Select the fonts to be used. This is a comma separated list of font names |
186 |
that are checked in order when trying to find glyphs for characters. The |
187 |
first font defines the cell size for characters; other fonts might be |
188 |
smaller, but not (in general) larger. A (hopefully) reasonable default |
189 |
font list is always appended to it. See resource B<font> for more details. |
190 |
|
191 |
In short, to specify an X11 core font, just specify its name or prefix it |
192 |
with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, |
193 |
e.g.: |
194 |
|
195 |
@@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
196 |
@@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
197 |
|
198 |
See also the question "How does rxvt-unicode choose fonts?" in the FAQ |
199 |
section of @@RXVT_NAME@@(7). |
200 |
|
201 |
=item B<-fb> I<fontlist> |
202 |
|
203 |
Compile I<font-styles>: The bold font list to use when B<bold> characters |
204 |
are to be printed. See resource B<boldFont> for details. |
205 |
|
206 |
=item B<-fi> I<fontlist> |
207 |
|
208 |
Compile I<font-styles>: The italic font list to use when I<italic> |
209 |
characters are to be printed. See resource B<italicFont> for details. |
210 |
|
211 |
=item B<-fbi> I<fontlist> |
212 |
|
213 |
Compile I<font-styles>: The bold italic font list to use when B<< I<bold |
214 |
italic> >> characters are to be printed. See resource B<boldItalicFont> |
215 |
for details. |
216 |
|
217 |
=item B<-is>|B<+is> |
218 |
|
219 |
Compile I<font-styles>: Bold/Italic font styles imply high intensity |
220 |
foreground/background (default). See resource B<intensityStyles> for |
221 |
details. |
222 |
|
223 |
=item B<-name> I<name> |
224 |
|
225 |
Specify the application name under which resources are to be obtained, |
226 |
rather than the default executable file name. Name should not contain |
227 |
`.' or `*' characters. Also sets the icon and title name. |
228 |
|
229 |
=item B<-ls>|B<+ls> |
230 |
|
231 |
Start as a login-shell/sub-shell; resource B<loginShell>. |
232 |
|
233 |
=item B<-ut>|B<+ut> |
234 |
|
235 |
Compile I<utmp>: Inhibit/enable writing a utmp entry; resource |
236 |
B<utmpInhibit>. |
237 |
|
238 |
=item B<-vb>|B<+vb> |
239 |
|
240 |
Turn on/off visual bell on receipt of a bell character; resource |
241 |
B<visualBell>. |
242 |
|
243 |
=item B<-sb>|B<+sb> |
244 |
|
245 |
Turn on/off scrollbar; resource B<scrollBar>. |
246 |
|
247 |
=item B<-si>|B<+si> |
248 |
|
249 |
Turn on/off scroll-to-bottom on TTY output inhibit; resource |
250 |
B<scrollTtyOutput> has opposite effect. |
251 |
|
252 |
=item B<-sk>|B<+sk> |
253 |
|
254 |
Turn on/off scroll-to-bottom on keypress; resource |
255 |
B<scrollTtyKeypress>. |
256 |
|
257 |
=item B<-sw>|B<+sw> |
258 |
|
259 |
Turn on/off scrolling with the scrollback buffer as new lines appear. |
260 |
This only takes effect if B<-si> is also given; resource |
261 |
B<scrollWithBuffer>. |
262 |
|
263 |
=item B<-sr>|B<+sr> |
264 |
|
265 |
Put scrollbar on right/left; resource B<scrollBar_right>. |
266 |
|
267 |
=item B<-st>|B<+st> |
268 |
|
269 |
Display rxvt (non XTerm/NeXT) scrollbar without/with a trough; |
270 |
resource B<scrollBar_floating>. |
271 |
|
272 |
=item B<-ptab>|B<+ptab> |
273 |
|
274 |
If enabled (default), "Horizontal Tab" characters are being stored as |
275 |
actual wide characters in the screen buffer, which makes it possible to |
276 |
select and paste them. Since a horizontal tab is a cursor movement and |
277 |
not an actual glyph, this can sometimes be visually annoying as the cursor |
278 |
on a tab character is displayed as a wide cursor; resource B<pastableTabs>. |
279 |
|
280 |
=item B<-bc>|B<+bc> |
281 |
|
282 |
Blink the cursor; resource B<cursorBlink>. |
283 |
|
284 |
=item B<-iconic> |
285 |
|
286 |
Start iconified, if the window manager supports that option. |
287 |
Alternative form is B<-ic>. |
288 |
|
289 |
=item B<-sl> I<number> |
290 |
|
291 |
Save I<number> lines in the scrollback buffer. See resource entry for |
292 |
limits; resource B<saveLines>. |
293 |
|
294 |
=item B<-b> I<number> |
295 |
|
296 |
Compile I<frills>: Internal border of I<number> pixels. See resource |
297 |
entry for limits; resource B<internalBorder>. |
298 |
|
299 |
=item B<-w> I<number> |
300 |
|
301 |
Compile I<frills>: External border of I<number> pixels. Also, B<-bw> |
302 |
and B<-borderwidth>. See resource entry for limits; resource |
303 |
B<externalBorder>. |
304 |
|
305 |
=item B<-bl> |
306 |
|
307 |
Compile I<frills>: Set MWM hints to request a borderless window, i.e. |
308 |
if honoured by the WM, the rxvt-unicode window will not have window |
309 |
decorations; resource B<borderLess>. |
310 |
|
311 |
=item B<-override-redirect> |
312 |
|
313 |
Compile I<frills>: Sets override-redirect on the window; resource |
314 |
B<override-redirect>. |
315 |
|
316 |
=item B<-sbg> |
317 |
|
318 |
Compile I<frills>: Disable the usage of the built-in block graphics/line |
319 |
drawing characters and just rely on what the specified fonts provide. Use |
320 |
this if you have a good font and want to use its block graphic glyphs; |
321 |
resource B<skipBuiltinGlyphs>. |
322 |
|
323 |
=item B<-lsp> I<number> |
324 |
|
325 |
Compile I<frills>: Lines (pixel height) to insert between each row of |
326 |
the display. Useful to work around font rendering problems; resource |
327 |
B<linespace>. |
328 |
|
329 |
=item B<-tn> I<termname> |
330 |
|
331 |
This option specifies the name of the terminal type to be set in the |
332 |
B<TERM> environment variable. This terminal type must exist in the |
333 |
I<termcap(5)> database and should have I<li#> and I<co#> entries; |
334 |
resource B<termName>. |
335 |
|
336 |
=item B<-e> I<command [arguments]> |
337 |
|
338 |
Run the command with its command-line arguments in the B<@@RXVT_NAME@@> |
339 |
window; also sets the window title and icon name to be the basename of |
340 |
the program being executed if neither I<-title> (I<-T>) nor I<-n> are |
341 |
given on the command line. If this option is used, it must be the last |
342 |
on the command-line. If there is no B<-e> option then the default is to |
343 |
run the program specified by the B<SHELL> environment variable or, |
344 |
failing that, I<sh(1)>. |
345 |
|
346 |
Please note that you must specify a program with arguments. If you want to |
347 |
run shell commands, you have to specify the shell, like this: |
348 |
|
349 |
@@RXVT_NAME@@ -e sh -c "shell commands" |
350 |
|
351 |
=item B<-title> I<text> |
352 |
|
353 |
Window title (B<-T> still respected); the default title is the basename |
354 |
of the program specified after the B<-e> option, if any, otherwise the |
355 |
application name; resource B<title>. |
356 |
|
357 |
=item B<-n> I<text> |
358 |
|
359 |
Icon name; the default name is the basename of the program specified |
360 |
after the B<-e> option, if any, otherwise the application name; |
361 |
resource B<iconName>. |
362 |
|
363 |
=item B<-C> |
364 |
|
365 |
Capture system console messages. |
366 |
|
367 |
=item B<-pt> I<style> |
368 |
|
369 |
Compile I<XIM>: input style for input method; B<OverTheSpot>, |
370 |
B<OffTheSpot>, B<Root>; resource B<preeditType>. |
371 |
|
372 |
=item B<-im> I<text> |
373 |
|
374 |
Compile I<XIM>: input method name. resource B<inputMethod>. |
375 |
|
376 |
=item B<-imlocale> I<string> |
377 |
|
378 |
The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. |
379 |
C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the |
380 |
input extension to be able to input japanese characters while staying in |
381 |
another locale. resource B<imLocale>. |
382 |
|
383 |
=item B<-imfont> I<fontset> |
384 |
|
385 |
Set the font set to use for the X Input Method, see resource B<imFont> |
386 |
for more info. |
387 |
|
388 |
=item B<-tcw> |
389 |
|
390 |
Change the meaning of triple-click selection with the left mouse |
391 |
button. Instead of selecting a full line it will extend the selection the |
392 |
end of the logical line only. resource B<tripleclickwords>. |
393 |
|
394 |
=item B<-insecure> |
395 |
|
396 |
Enable "insecure" mode, which currently enables most of the escape |
397 |
sequences that echo strings. See the resource B<insecure> for more |
398 |
info. |
399 |
|
400 |
=item B<-mod> I<modifier> |
401 |
|
402 |
Override detection of Meta modifier with specified key: B<alt>, |
403 |
B<meta>, B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, |
404 |
B<mod5>; resource I<modifier>. |
405 |
|
406 |
=item B<-ssc>|B<+ssc> |
407 |
|
408 |
Turn on/off secondary screen (default enabled); resource |
409 |
B<secondaryScreen>. |
410 |
|
411 |
=item B<-ssr>|B<+ssr> |
412 |
|
413 |
Turn on/off secondary screen scroll (default enabled); resource |
414 |
B<secondaryScroll>. |
415 |
|
416 |
=item B<-hold>|B<+hold> |
417 |
|
418 |
Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
419 |
will not immediately destroy its window when the program executed within |
420 |
it exits. Instead, it will wait till it is being killed or closed by the |
421 |
user; resource B<hold>. |
422 |
|
423 |
=item B<-keysym.>I<sym> I<string> |
424 |
|
425 |
Remap a key symbol. See resource B<keysym>. |
426 |
|
427 |
=item B<-embed> I<windowid> |
428 |
|
429 |
Tells @@RXVT_NAME@@ to embed its windows into an already-existing window, |
430 |
which enables applications to easily embed a terminal. |
431 |
|
432 |
Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it |
433 |
shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it |
434 |
quite a bit, so don't expect it to keep some specific state. It's best to |
435 |
create an extra subwindow for @@RXVT_NAME@@ and leave it alone. |
436 |
|
437 |
The window will not be destroyed when @@RXVT_NAME@@ exits. |
438 |
|
439 |
It might be useful to know that @@RXVT_NAME@@ will not close file |
440 |
descriptors passed to it (except for stdin/out/err, of course), so you |
441 |
can use file descriptors to communicate with the programs within the |
442 |
terminal. This works regardless of wether the C<-embed> option was used or |
443 |
not. |
444 |
|
445 |
Here is a short Gtk2-perl snippet that illustrates how this option can be |
446 |
used (a longer example is in F<doc/embed>): |
447 |
|
448 |
my $rxvt = new Gtk2::Socket; |
449 |
$rxvt->signal_connect_after (realize => sub { |
450 |
my $xid = $_[0]->window->get_xid; |
451 |
system "@@RXVT_NAME@@ -embed $xid &"; |
452 |
}); |
453 |
|
454 |
=item B<-pty-fd> I<file descriptor> |
455 |
|
456 |
Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty |
457 |
pair but instead use the given filehandle as the tty master. This is |
458 |
useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator |
459 |
without having to run a program within it. |
460 |
|
461 |
If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp |
462 |
entries and will not tinker with pty/tty permissions - you have to do that |
463 |
yourself if you want that. |
464 |
|
465 |
As an extremely special case, specifying C<-1> will completely suppress |
466 |
pty/tty operations. |
467 |
|
468 |
Here is a example in perl that illustrates how this option can be used (a |
469 |
longer example is in F<doc/pty-fd>): |
470 |
|
471 |
use IO::Pty; |
472 |
use Fcntl; |
473 |
|
474 |
my $pty = new IO::Pty; |
475 |
fcntl $pty, F_SETFD, 0; # clear close-on-exec |
476 |
system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&"; |
477 |
close $pty; |
478 |
|
479 |
# now communicate with rxvt |
480 |
my $slave = $pty->slave; |
481 |
while (<$slave>) { print $slave "got <$_>\n" } |
482 |
|
483 |
=item B<-pe> I<string> |
484 |
|
485 |
Comma-separated list of perl extension scripts to use (or not to use) in |
486 |
this terminal instance. See resource B<perl-ext> for details. |
487 |
|
488 |
=back |
489 |
|
490 |
=head1 RESOURCES (available also as long-options) |
491 |
|
492 |
Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long |
493 |
options) compiled into your version. |
494 |
|
495 |
You can set and change the resources using X11 tools like B<xrdb>. Many |
496 |
distribution do also load settings from the B<~/.Xresources> file when X |
497 |
starts. @@RXVT_NAME@@ will consult the following files/resources in order, |
498 |
with later settings overwriting earlier ones: |
499 |
|
500 |
1. system-wide app-defaults file, either locale-dependent OR global |
501 |
2. app-defaults file in $XAPPLRESDIR |
502 |
3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults |
503 |
4. SCREEN_RESOURCES for the current screen |
504 |
5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> |
505 |
|
506 |
Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class |
507 |
names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources |
508 |
common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily |
509 |
configured, while the class name B<URxvt> allows resources unique to |
510 |
B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@> |
511 |
configurations. If no resources are specified, suitable defaults will |
512 |
be used. Command-line arguments can be used to override resource |
513 |
settings. The following resources are supported (you might want to |
514 |
check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl |
515 |
extensions not documented here): |
516 |
|
517 |
=over 4 |
518 |
|
519 |
=item B<depth:> I<bitdepth> |
520 |
|
521 |
Compile I<xft>: Attempt to find a visual with the given bit depth; |
522 |
option B<-depth>. |
523 |
|
524 |
=item B<geometry:> I<geom> |
525 |
|
526 |
Create the window with the specified X window geometry [default 80x24]; |
527 |
option B<-geometry>. |
528 |
|
529 |
=item B<background:> I<colour> |
530 |
|
531 |
Use the specified colour as the window's background colour [default |
532 |
White]; option B<-bg>. |
533 |
|
534 |
=item B<foreground:> I<colour> |
535 |
|
536 |
Use the specified colour as the window's foreground colour [default |
537 |
Black]; option B<-fg>. |
538 |
|
539 |
=item B<color>I<n>B<:> I<colour> |
540 |
|
541 |
Use the specified colour for the colour value I<n>, where 0-7 |
542 |
corresponds to low-intensity (normal) colours and 8-15 corresponds to |
543 |
high-intensity (bold = bright foreground, blink = bright background) |
544 |
colours. The canonical names are as follows: 0=black, 1=red, 2=green, |
545 |
3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour |
546 |
names used are listed in the B<COLORS AND GRAPHICS> section. |
547 |
|
548 |
Colours higher than 15 cannot be set using resources (yet), but can be |
549 |
changed using an escape command (see @@RXVT_NAME@@(7)). |
550 |
|
551 |
Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with |
552 |
88 colour support). Colours 80-87 are evenly spaces grey steps. |
553 |
|
554 |
=item B<colorBD:> I<colour> |
555 |
|
556 |
=item B<colorIT:> I<colour> |
557 |
|
558 |
Use the specified colour to display bold or italic characters when the |
559 |
foreground colour is the default. If font styles are not available |
560 |
(Compile I<styles>) and this option is unset, reverse video is used instead. |
561 |
|
562 |
=item B<colorUL:> I<colour> |
563 |
|
564 |
Use the specified colour to display underlined characters when the |
565 |
foreground colour is the default. |
566 |
|
567 |
=item B<colorRV:> I<colour> |
568 |
|
569 |
Use the specified colour as the background for reverse video |
570 |
characters. |
571 |
|
572 |
=item B<underlineColor:> I<colour> |
573 |
|
574 |
If set, use the specified colour as the colour for the underline |
575 |
itself. If unset, use the foreground colour. |
576 |
|
577 |
=item B<cursorColor:> I<colour> |
578 |
|
579 |
Use the specified colour for the cursor. The default is to use the |
580 |
foreground colour; option B<-cr>. |
581 |
|
582 |
=item B<cursorColor2:> I<colour> |
583 |
|
584 |
Use the specified colour for the colour of the cursor text. For this to |
585 |
take effect, B<cursorColor> must also be specified. The default is to |
586 |
use the background colour. |
587 |
|
588 |
=item B<reverseVideo:> I<boolean> |
589 |
|
590 |
B<True>: simulate reverse video by foreground and background colours; |
591 |
option B<-rv>. B<False>: regular screen colours [default]; option |
592 |
B<+rv>. See note in B<COLORS AND GRAPHICS> section. |
593 |
|
594 |
=item B<jumpScroll:> I<boolean> |
595 |
|
596 |
B<True>: specify that jump scrolling should be used. When scrolling |
597 |
quickly, fewer screen updates are performed [default]; option B<-j>. |
598 |
B<False>: specify that smooth scrolling should be used; option B<+j>. |
599 |
|
600 |
=item B<inheritPixmap:> I<boolean> |
601 |
|
602 |
B<True>: make the background inherit the parent windows' pixmap, giving |
603 |
artificial transparency. B<False>: do not inherit the parent windows' |
604 |
pixmap. |
605 |
|
606 |
I<Please note that transparency of any kind if completely unsupported by |
607 |
the author. Don't bug him with installation questions!> |
608 |
|
609 |
=item B<fading:> I<number> |
610 |
|
611 |
Fade the text by the given percentage when focus is lost; option B<-fade>. |
612 |
|
613 |
=item B<fadeColor:> I<colour> |
614 |
|
615 |
Fade to this colour, when fading is used (see B<fading:>). The default |
616 |
colour is black; option B<-fadecolor>. |
617 |
|
618 |
=item B<tintColor:> I<colour> |
619 |
|
620 |
Tint the transparent background pixmap with the given colour; option |
621 |
B<-tint>. |
622 |
|
623 |
=item B<shading:> I<number> |
624 |
|
625 |
Darken (0 .. 100) or lighten (-1 .. -100) the transparent background |
626 |
image in addition to tinting it. |
627 |
|
628 |
=item B<scrollColor:> I<colour> |
629 |
|
630 |
Use the specified colour for the scrollbar [default #B2B2B2]. |
631 |
|
632 |
=item B<troughColor:> I<colour> |
633 |
|
634 |
Use the specified colour for the scrollbar's trough area [default |
635 |
#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar. |
636 |
|
637 |
=item B<borderColor:> I<colour> |
638 |
|
639 |
The colour of the border around the text area and between the scrollbar |
640 |
and the text. |
641 |
|
642 |
=item B<backgroundPixmap:> I<file[;geom]> |
643 |
|
644 |
Use the specified XPM file (note the `.xpm' extension is optional) for |
645 |
the background and also optionally specify its scaling with a geometry |
646 |
string B<WxH+X+Y>, in which B<"W" / "H"> specify the |
647 |
horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image |
648 |
centre (percent). A scale of 0 displays the image with tiling. A scale |
649 |
of 1 displays the image without any scaling. A scale of 2 to 9 |
650 |
specifies an integer number of images in that direction. No image will |
651 |
be magnified beyond 10 times its original size. The maximum permitted |
652 |
scale is 1000. [default 0x0+50+50] |
653 |
|
654 |
=item B<path:> I<path> |
655 |
|
656 |
Specify the colon-delimited search path for finding XPM files. |
657 |
|
658 |
=item B<font:> I<fontlist> |
659 |
|
660 |
Select the fonts to be used. This is a comma separated list of font names |
661 |
that are checked in order when trying to find glyphs for characters. The |
662 |
first font defines the cell size for characters; other fonts might be |
663 |
smaller, but not (in general) larger. A (hopefully) reasonable default |
664 |
font list is always appended to it; option B<-fn>. |
665 |
|
666 |
Each font can either be a standard X11 core font (XLFD) name, with |
667 |
optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. |
668 |
|
669 |
In addition, each font can be prefixed with additional hints and |
670 |
specifications enclosed in square brackets (C<[]>). The only available |
671 |
hint currently is C<codeset=codeset-name>, and this is only used for Xft |
672 |
fonts. |
673 |
|
674 |
For example, this font resource |
675 |
|
676 |
URxvt.font: 9x15bold,\ |
677 |
-misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ |
678 |
-misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ |
679 |
[codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ |
680 |
xft:Code2000:antialias=false |
681 |
|
682 |
specifies five fonts to be used. The first one is C<9x15bold> (actually |
683 |
the iso8859-1 version of the second font), which is the base font (because |
684 |
it is named first) and thus defines the character cell grid to be 9 pixels |
685 |
wide and 15 pixels high. |
686 |
|
687 |
The second font is just used to add additional unicode characters not in |
688 |
the base font, likewise the third, which is unfortunately non-bold, but |
689 |
the bold version of the font does contain less characters, so this is a |
690 |
useful supplement. |
691 |
|
692 |
The third font is an Xft font with aliasing turned off, and the characters |
693 |
are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font |
694 |
contains other characters, but we are not interested in them. |
695 |
|
696 |
The last font is a useful catch-all font that supplies most of the |
697 |
remaining unicode characters. |
698 |
|
699 |
=item B<boldFont:> I<fontlist> |
700 |
|
701 |
=item B<italicFont:> I<fontlist> |
702 |
|
703 |
=item B<boldItalicFont:> I<fontlist> |
704 |
|
705 |
The font list to use for displaying B<bold>, I<italic> or B<< I<bold |
706 |
italic> >> characters, respectively. |
707 |
|
708 |
If specified and non-empty, then the syntax is the same as for the |
709 |
B<font>-resource, and the given font list will be used as is, which makes |
710 |
it possible to substitute completely different font styles for bold and |
711 |
italic. |
712 |
|
713 |
If unset (the default), a suitable font list will be synthesized by |
714 |
"morphing" the normal text font list into the desired shape. If that is |
715 |
not possible, replacement fonts of the desired shape will be tried. |
716 |
|
717 |
If set, but empty, then this specific style is disabled and the normal |
718 |
text font will being used for the given style. |
719 |
|
720 |
=item B<intensityStyles:> I<boolean> |
721 |
|
722 |
When font styles are not enabled, or this option is enabled (B<True>, |
723 |
option B<-is>, the default), bold and italic font styles imply high |
724 |
intensity foreground/backround colours. Disabling this option (B<False>, |
725 |
option B<+is>) disables this behaviour, the high intensity colours are not |
726 |
reachable. |
727 |
|
728 |
=item B<selectstyle:> I<mode> |
729 |
|
730 |
Set mouse selection style to B<old> which is 2.20, B<oldword> which is |
731 |
xterm style with 2.20 old word selection, or anything else which gives |
732 |
xterm style selection. |
733 |
|
734 |
=item B<scrollstyle:> I<mode> |
735 |
|
736 |
Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is |
737 |
the author's favourite. |
738 |
|
739 |
=item B<title:> I<string> |
740 |
|
741 |
Set window title string, the default title is the command-line |
742 |
specified after the B<-e> option, if any, otherwise the application |
743 |
name; option B<-title>. |
744 |
|
745 |
=item B<iconName:> I<string> |
746 |
|
747 |
Set the name used to label the window's icon or displayed in an icon |
748 |
manager window, it also sets the window's title unless it is explicitly |
749 |
set; option B<-n>. |
750 |
|
751 |
=item B<mapAlert:> I<boolean> |
752 |
|
753 |
B<True>: de-iconify (map) on receipt of a bell character. B<False>: no |
754 |
de-iconify (map) on receipt of a bell character [default]. |
755 |
|
756 |
=item B<visualBell:> I<boolean> |
757 |
|
758 |
B<True>: use visual bell on receipt of a bell character; option B<-vb>. |
759 |
B<False>: no visual bell [default]; option B<+vb>. |
760 |
|
761 |
=item B<loginShell:> I<boolean> |
762 |
|
763 |
B<True>: start as a login shell by prepending a `-' to B<argv[0]> of |
764 |
the shell; option B<-ls>. B<False>: start as a normal sub-shell |
765 |
[default]; option B<+ls>. |
766 |
|
767 |
=item B<utmpInhibit:> I<boolean> |
768 |
|
769 |
B<True>: inhibit writing record into the system log file B<utmp>; |
770 |
option B<-ut>. B<False>: write record into the system log file B<utmp> |
771 |
[default]; option B<+ut>. |
772 |
|
773 |
=item B<print-pipe:> I<string> |
774 |
|
775 |
Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use |
776 |
B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or |
777 |
B<Shift-Print> to include the scrollback as well. |
778 |
|
779 |
The string will be interpreted as if typed into the shell as-is. |
780 |
|
781 |
Example: |
782 |
|
783 |
URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) |
784 |
|
785 |
This creates a new file in your home directory with the screen contents |
786 |
everytime you hit C<Print>. |
787 |
|
788 |
=item B<scrollBar:> I<boolean> |
789 |
|
790 |
B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: |
791 |
disable the scrollbar; option B<+sb>. |
792 |
|
793 |
=item B<scrollBar_right:> I<boolean> |
794 |
|
795 |
B<True>: place the scrollbar on the right of the window; option B<-sr>. |
796 |
B<False>: place the scrollbar on the left of the window; option B<+sr>. |
797 |
|
798 |
=item B<scrollBar_floating:> I<boolean> |
799 |
|
800 |
B<True>: display an rxvt scrollbar without a trough; option B<-st>. |
801 |
B<False>: display an rxvt scrollbar with a trough; option B<+st>. |
802 |
|
803 |
=item B<scrollBar_align:> I<mode> |
804 |
|
805 |
Align the B<top>, B<bottom> or B<centre> [default] of the scrollbar |
806 |
thumb with the pointer on middle button press/drag. |
807 |
|
808 |
=item B<scrollTtyOutput:> I<boolean> |
809 |
|
810 |
B<True>: scroll to bottom when tty receives output; option B<-si>. |
811 |
B<False>: do not scroll to bottom when tty receives output; option |
812 |
B<+si>. |
813 |
|
814 |
=item B<scrollWithBuffer:> I<boolean> |
815 |
|
816 |
B<True>: scroll with scrollback buffer when tty receives new lines (and |
817 |
B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll |
818 |
with scrollback buffer when tty recieves new lines; option B<+sw>. |
819 |
|
820 |
=item B<scrollTtyKeypress:> I<boolean> |
821 |
|
822 |
B<True>: scroll to bottom when a non-special key is pressed. Special keys |
823 |
are those which are intercepted by rxvt-unicode for special handling and |
824 |
are not passed onto the shell; option B<-sk>. B<False>: do not scroll to |
825 |
bottom when a non-special key is pressed; option B<+sk>. |
826 |
|
827 |
=item B<saveLines:> I<number> |
828 |
|
829 |
Save I<number> lines in the scrollback buffer [default 64]. This |
830 |
resource is limited on most machines to 65535; option B<-sl>. |
831 |
|
832 |
=item B<internalBorder:> I<number> |
833 |
|
834 |
Internal border of I<number> pixels. This resource is limited to 100; |
835 |
option B<-b>. |
836 |
|
837 |
=item B<externalBorder:> I<number> |
838 |
|
839 |
External border of I<number> pixels. This resource is limited to 100; |
840 |
option B<-w>, B<-bw>, B<-borderwidth>. |
841 |
|
842 |
=item B<borderLess:> I<boolean> |
843 |
|
844 |
Set MWM hints to request a borderless window, i.e. if honoured by the |
845 |
WM, the rxvt-unicode window will not have window decorations; option B<-bl>. |
846 |
|
847 |
=item B<skipBuiltinGlyphs:> I<boolean> |
848 |
|
849 |
Compile I<frills>: Disable the usage of the built-in block graphics/line |
850 |
drawing characters and just rely on what the specified fonts provide. Use |
851 |
this if you have a good font and want to use its block graphic glyphs; |
852 |
option B<-sbg>. |
853 |
|
854 |
=item B<termName:> I<termname> |
855 |
|
856 |
Specifies the terminal type name to be set in the B<TERM> environment |
857 |
variable; option B<-tn>. |
858 |
|
859 |
=item B<linespace:> I<number> |
860 |
|
861 |
Specifies number of lines (pixel height) to insert between each row of |
862 |
the display [default 0]; option B<-lsp>. |
863 |
|
864 |
=item B<meta8:> I<boolean> |
865 |
|
866 |
B<True>: handle Meta (Alt) + keypress to set the 8th bit. B<False>: |
867 |
handle Meta (Alt) + keypress as an escape prefix [default]. |
868 |
|
869 |
=item B<mouseWheelScrollPage:> I<boolean> |
870 |
|
871 |
B<True>: the mouse wheel scrolls a page full. B<False>: the mouse wheel |
872 |
scrolls five lines [default]. |
873 |
|
874 |
=item B<pastableTabs:> I<boolean> |
875 |
|
876 |
B<True>: store tabs as wide characters. B<False>: interpret tabs as cursor |
877 |
movement only; option C<-ptab>. |
878 |
|
879 |
=item B<cursorBlink:> I<boolean> |
880 |
|
881 |
B<True>: blink the cursor. B<False>: do not blink the cursor [default]; |
882 |
option B<-bc>. |
883 |
|
884 |
=item B<pointerBlank:> I<boolean> |
885 |
|
886 |
B<True>: blank the pointer when a key is pressed or after a set number |
887 |
of seconds of inactivity. B<False>: the pointer is always visible |
888 |
[default]. |
889 |
|
890 |
=item B<pointerColor:> I<colour> |
891 |
|
892 |
Mouse pointer foreground colour. |
893 |
|
894 |
=item B<pointerColor2:> I<colour> |
895 |
|
896 |
Mouse pointer background colour. |
897 |
|
898 |
=item B<pointerBlankDelay:> I<number> |
899 |
|
900 |
Specifies number of seconds before blanking the pointer [default 2]. Use a |
901 |
large number (e.g. C<987654321>) to effectively disable the timeout. |
902 |
|
903 |
=item B<backspacekey:> I<string> |
904 |
|
905 |
The string to send when the backspace key is pressed. If set to B<DEC> |
906 |
or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> |
907 |
(code 8) - which can be reversed with the appropriate DEC private mode |
908 |
escape sequence. |
909 |
|
910 |
=item B<deletekey:> I<string> |
911 |
|
912 |
The string to send when the delete key (not the keypad delete key) is |
913 |
pressed. If unset it will send the sequence traditionally associated |
914 |
with the B<Execute> key. |
915 |
|
916 |
=item B<cutchars:> I<string> |
917 |
|
918 |
The characters used as delimiters for double-click word selection |
919 |
(whitespace delimiting is added automatically if resource is given). |
920 |
|
921 |
When the selection extension is in use (the default if compiled in, see |
922 |
the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these characters |
923 |
will be created (if the resource exists, otherwise, no regex will be |
924 |
created). In this mode, characters outside ISO-8859-1 can be used. |
925 |
|
926 |
When the selection extension is not used, only ISO-8859-1 characters can |
927 |
be used. If not specified, the built-in default is used: |
928 |
|
929 |
B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> |
930 |
|
931 |
=item B<preeditType:> I<style> |
932 |
|
933 |
B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. |
934 |
|
935 |
=item B<inputMethod:> I<name> |
936 |
|
937 |
I<name> of inputMethod to use; option B<-im>. |
938 |
|
939 |
=item B<imLocale:> I<name> |
940 |
|
941 |
The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. |
942 |
C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the |
943 |
input extension to be able to input japanese characters while staying in |
944 |
another locale; option B<-imlocale>. |
945 |
|
946 |
=item B<imFont:> I<fontset> |
947 |
|
948 |
Specify the font-set used for XIM styles C<OverTheSpot> or |
949 |
C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated |
950 |
by commas), i.e. it's not in the same format as the other font lists used |
951 |
in @@RXVT_NAME@@. The default will be set-up to chose *any* suitable found |
952 |
found, preferably one or two pixels differing in size to the base font. |
953 |
option B<-imfont>. |
954 |
|
955 |
=item B<tripleclickwords:> I<boolean> |
956 |
|
957 |
Change the meaning of triple-click selection with the left mouse |
958 |
button. Instead of selecting a full line it will extend the selection to |
959 |
the end of the logical line only; option B<-tcw>. |
960 |
|
961 |
=item B<insecure:> I<boolean> |
962 |
|
963 |
Enables "insecure" mode. Rxvt-unicode offers some escape sequences that |
964 |
echo arbitrary strings like the icon name or the locale. This could be |
965 |
abused if somebody gets 8-bit-clean access to your display, whether |
966 |
through a mail client displaying mail bodies unfiltered or through |
967 |
write(1) or any other means. Therefore, these sequences are disabled by |
968 |
default. (Note that many other terminals, including xterm, have these |
969 |
sequences enabled by default, which doesn't make it safer, though). |
970 |
|
971 |
You can enable them by setting this boolean resource or specifying |
972 |
B<-insecure> as an option. At the moment, this enables display-answer, |
973 |
locale, findfont, icon label and window title requests. |
974 |
|
975 |
=item B<modifier:> I<modifier> |
976 |
|
977 |
Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, |
978 |
B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option |
979 |
B<-mod>. |
980 |
|
981 |
=item B<answerbackString:> I<string> |
982 |
|
983 |
Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) |
984 |
character is passed through. It may contain escape values as described |
985 |
in the entry on B<keysym> following. |
986 |
|
987 |
=item B<secondaryScreen:> I<boolean> |
988 |
|
989 |
Turn on/off secondary screen (default enabled). |
990 |
|
991 |
=item B<secondaryScroll:> I<boolean> |
992 |
|
993 |
Turn on/off secondary screen scroll (default enabled). If the this |
994 |
option is enabled, scrolls on the secondary screen will change the |
995 |
scrollback buffer and switching to/from the secondary screen will |
996 |
instead scroll the screen up. |
997 |
|
998 |
=item B<hold>: I<boolean> |
999 |
|
1000 |
Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ |
1001 |
will not immediately destroy its window when the program executed within |
1002 |
it exits. Instead, it will wait till it is being killed or closed by the |
1003 |
user. |
1004 |
|
1005 |
=item B<keysym.>I<sym>: I<string> |
1006 |
|
1007 |
Compile I<frills>: Associate I<string> with keysym I<sym>. The |
1008 |
intervening resource name B<keysym.> cannot be omitted. |
1009 |
|
1010 |
The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be |
1011 |
any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, |
1012 |
B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, |
1013 |
and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, |
1014 |
B<2>, B<3>, B<4>, B<5>. |
1015 |
|
1016 |
The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to |
1017 |
whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr |
1018 |
keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the |
1019 |
current application keymap mode state. |
1020 |
|
1021 |
The spellings of I<key> can be obtained by using B<xev>(1) command or |
1022 |
searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and |
1023 |
omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex |
1024 |
keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not |
1025 |
performed in an exact manner; however, the closest match is assured. |
1026 |
|
1027 |
I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, |
1028 |
C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, |
1029 |
C<\000>: octal number) or verbatim control characters (C<^?>: delete, |
1030 |
C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it |
1031 |
can start or end with whitespace. |
1032 |
|
1033 |
Please note that you need to double the C<\> in resource files, as |
1034 |
Xlib itself does its own de-escaping (you can use C<\033> instead of |
1035 |
C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own |
1036 |
processing). |
1037 |
|
1038 |
You can define a range of keysyms in one shot by providing a I<string> |
1039 |
with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' |
1040 |
should be a character not used by the strings. |
1041 |
|
1042 |
Its usage can be demonstrated by an example: |
1043 |
|
1044 |
URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> |
1045 |
|
1046 |
The above line is equivalent to the following three lines: |
1047 |
|
1048 |
URxvt.keysym.Meta-Control-0x61: \033<M-C-a> |
1049 |
URxvt.keysym.Meta-Control-0x62: \033<M-C-b> |
1050 |
URxvt.keysym.Meta-Control-0x63: \033<M-C-c> |
1051 |
|
1052 |
If I<string> takes the form of C<command:STRING>, the specified B<STRING> |
1053 |
is interpreted and executed as @@RXVT_NAME@@'s control sequence. For |
1054 |
example the following means "change the current locale to C<zh_CN.GBK> |
1055 |
when Control-Meta-c is being pressed": |
1056 |
|
1057 |
URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 |
1058 |
|
1059 |
If I<string> takes the form C<perl:STRING>, then the specified B<STRING> |
1060 |
is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) |
1061 |
manpage. For example, the F<selection> extension (activated via |
1062 |
C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: |
1063 |
|
1064 |
URxvt.keysym.M-C-c: perl:selection:rot13 |
1065 |
|
1066 |
Due the the large number of modifier combinations, a defined key mapping |
1067 |
will match if at I<at least> the specified identifiers are being set, and |
1068 |
no other key mappings with those and more bits are being defined. That |
1069 |
means that defining a key map for C<a> will automatically provide |
1070 |
definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined |
1071 |
mappings themselves. |
1072 |
|
1073 |
Unfortunately, this will override built-in key mappings. For example |
1074 |
if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s |
1075 |
C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the |
1076 |
user-defined keymap using the C<builtin:> replacement: |
1077 |
|
1078 |
URxvt.keysym.Insert: <my insert key sequence> |
1079 |
URxvt.keysym.S-Insert: builtin: |
1080 |
|
1081 |
The first line defines a mapping for C<Insert> and I<any> combination |
1082 |
of modifiers. The second line re-establishes the default mapping for |
1083 |
C<Shift-Insert>. |
1084 |
|
1085 |
The following example will map Control-Meta-1 and Control-Meta-2 to |
1086 |
the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited |
1087 |
font-switching at runtime: |
1088 |
|
1089 |
URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 |
1090 |
URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 |
1091 |
|
1092 |
Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more |
1093 |
info): |
1094 |
|
1095 |
URxvt.keysym.M-C-3: command:\033[8;25;80t |
1096 |
URxvt.keysym.M-C-4: command:\033[8;48;110t |
1097 |
|
1098 |
=item B<perl-ext-common>: I<string> |
1099 |
|
1100 |
=item B<perl-ext>: I<string> |
1101 |
|
1102 |
Comma-separated list(s) of perl extension scripts (default: C<default>) to |
1103 |
use in this terminal instance; option B<-pe>. |
1104 |
|
1105 |
Extension names can be prefixed with a C<-> sign to prohibit using |
1106 |
them. This can be useful to selectively disable some extensions loaded |
1107 |
by default, or specified via the C<perl-ext-common> resource. For |
1108 |
example, C<default,-selection> will use all the default extension except |
1109 |
C<selection>. |
1110 |
|
1111 |
Extension names can also be followed by an argument in angle brackets |
1112 |
(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for |
1113 |
searchable scorllback to Alt/Meta-s). Mentioning the same extension |
1114 |
multiple times with different arguments will pass multiple arguments to |
1115 |
the extension. |
1116 |
|
1117 |
Each extension is looked up in the library directories, loaded if |
1118 |
necessary, and bound to the current terminal instance. |
1119 |
|
1120 |
If both of these resources are the empty string, then the perl |
1121 |
interpreter will not be initialized. The idea behind two options is that |
1122 |
B<perl-ext-common> will be used for extensions that should be available to |
1123 |
all instances, while B<perl-ext> is used for specific instances. |
1124 |
|
1125 |
=item B<perl-eval>: I<string> |
1126 |
|
1127 |
Perl code to be evaluated when all extensions have been registered. See |
1128 |
the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource |
1129 |
will be ignored when running setuid/setgid. |
1130 |
|
1131 |
=item B<perl-lib>: I<path> |
1132 |
|
1133 |
Colon-separated list of additional directories that hold extension |
1134 |
scripts. When looking for extensions specified by the C<perl> resource, |
1135 |
@@RXVT_NAME@@ will first look in these directories and then in |
1136 |
F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource |
1137 |
will be ignored when running setuid/setgid. |
1138 |
|
1139 |
See the @@RXVT_NAME@@perl(3) manpage. |
1140 |
|
1141 |
=item B<< selection.pattern-I<idx> >>: I<perl-regex> |
1142 |
|
1143 |
Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for |
1144 |
details. |
1145 |
|
1146 |
=item B<< selection-autotransform.I<idx> >>: I<perl-transform> |
1147 |
|
1148 |
Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage |
1149 |
for details. |
1150 |
|
1151 |
=item B<searchable-scrollback:> I<keysym> |
1152 |
|
1153 |
Sets the hotkey that starts the incremental scrollback buffer search |
1154 |
(default: C<M-s>). |
1155 |
|
1156 |
=item B<urlLauncher>: I<string> |
1157 |
|
1158 |
Specifies the program to be started with a URL argument. Used by the |
1159 |
C<selection-popup> and C<mark-urls> perl extensions. |
1160 |
|
1161 |
=item B<transient-for>: I<windowid> |
1162 |
|
1163 |
Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. |
1164 |
|
1165 |
=item B<override-redirect>: I<boolean> |
1166 |
|
1167 |
Compile I<frills>: Sets override-redirect for the terminal window, making |
1168 |
it almost invisible to window managers; option B<-override-redirect>. |
1169 |
|
1170 |
=back |
1171 |
|
1172 |
=head1 THE SCROLLBAR |
1173 |
|
1174 |
Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window |
1175 |
(resource: B<saveLines>) and can be scrolled back using the scrollbar |
1176 |
or by keystrokes. The normal B<@@RXVT_NAME@@> scrollbar has arrows and |
1177 |
its behaviour is fairly intuitive. The B<xterm-scrollbar> is without |
1178 |
arrows and its behaviour mimics that of I<xterm> |
1179 |
|
1180 |
Scroll down with B<Button1> (B<xterm-scrollbar>) or B<Shift-Next>. |
1181 |
Scroll up with B<Button3> (B<xterm-scrollbar>) or B<Shift-Prior>. |
1182 |
Continuous scroll with B<Button2>. |
1183 |
|
1184 |
=head1 MOUSE REPORTING |
1185 |
|
1186 |
To temporarily override mouse reporting, for either the scrollbar or |
1187 |
the normal text selection/insertion, hold either the Shift or the Meta |
1188 |
(Alt) key while performing the desired mouse action. |
1189 |
|
1190 |
If mouse reporting mode is active, the normal scrollbar actions are |
1191 |
disabled -- on the assumption that we are using a fullscreen |
1192 |
application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> |
1193 |
(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the |
1194 |
up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), |
1195 |
respectively. |
1196 |
|
1197 |
=head1 TEXT SELECTION AND INSERTION |
1198 |
|
1199 |
The behaviour of text selection and insertion mechanism is similar to |
1200 |
I<xterm>(1). |
1201 |
|
1202 |
=over 4 |
1203 |
|
1204 |
=item B<Selection>: |
1205 |
|
1206 |
Left click at the beginning of the region, drag to the end of the region |
1207 |
and release; Right click to extend the marked region; Left double-click |
1208 |
to select a word; Left triple-click to select the entire logical line |
1209 |
(which can span multiple screen lines), unless modified by resource |
1210 |
B<tripleclickwords>. |
1211 |
|
1212 |
Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) |
1213 |
(Compile: I<frills>) will create a rectangular selection instead of a |
1214 |
normal one. In this mode, every selected row becomes its own line in the |
1215 |
selection, and trailing whitespace is visually underlined and removed from |
1216 |
the selection. |
1217 |
|
1218 |
=item B<Insertion>: |
1219 |
|
1220 |
Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@> |
1221 |
window causes the value of the PRIMARY selection (or CLIPBOARD with the |
1222 |
Meta modifier) to be inserted as if it had been typed on the keyboard. |
1223 |
|
1224 |
Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be |
1225 |
inserted too. |
1226 |
|
1227 |
=back |
1228 |
|
1229 |
=head1 CHANGING FONTS |
1230 |
|
1231 |
Changing fonts (or font sizes, respectively) via the keypad is not yet |
1232 |
supported in rxvt-unicode. Bug me if you need this. |
1233 |
|
1234 |
You can, however, switch fonts at runtime using escape sequences, e.g.: |
1235 |
|
1236 |
printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" |
1237 |
|
1238 |
You can use keyboard shortcuts, too: |
1239 |
|
1240 |
URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007 |
1241 |
URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007 |
1242 |
|
1243 |
rxvt-unicode will automatically re-apply these fonts to the output so far. |
1244 |
|
1245 |
=head1 ISO 14755 SUPPORT |
1246 |
|
1247 |
ISO 14755 is a standard for entering and viewing unicode characters |
1248 |
and character codes using the keyboard. It consists of 4 parts. The |
1249 |
first part is available rxvt-unicode has been compiled with |
1250 |
C<--enable-frills>, the rest is available when rxvt-unicode was compiled |
1251 |
with C<--enable-iso14755>. |
1252 |
|
1253 |
=over 4 |
1254 |
|
1255 |
=item * 5.1: Basic method |
1256 |
|
1257 |
This allows you to enter unicode characters using their hexcode. |
1258 |
|
1259 |
Start by pressing and holding both C<Control> and C<Shift>, then enter |
1260 |
hex-digits (between one and six). Releasing C<Control> and C<Shift> will |
1261 |
commit the character as if it were typed directly. While holding down |
1262 |
C<Control> and C<Shift> you can also enter multiple characters by pressing |
1263 |
C<Space>, which will commit the current character and lets you start a new |
1264 |
one. |
1265 |
|
1266 |
As an example of use, imagine a business card with a japanese e-mail |
1267 |
address, which you cannot type. Fortunately, the card has the e-mail |
1268 |
address printed as hexcodes, e.g. C<671d 65e5>. You can enter this easily |
1269 |
by pressing C<Control> and C<Shift>, followed by C<6-7-1-D-SPACE-6-5-E-5>, |
1270 |
followed by releasing the modifier keys. |
1271 |
|
1272 |
=item * 5.2: Keyboard symbols entry method |
1273 |
|
1274 |
This mode lets you input characters representing the keycap symbols of |
1275 |
your keyboard, if representable in the current locale encoding. |
1276 |
|
1277 |
Start by pressing C<Control> and C<Shift> together, then releasing |
1278 |
them. The next special key (cursor keys, home etc.) you enter will not |
1279 |
invoke its usual function but instead will insert the corresponding |
1280 |
keycap symbol. The symbol will only be entered when the key has been |
1281 |
released, otherwise pressing e.g. C<Shift> would enter the symbol for |
1282 |
C<ISO Level 2 Switch>, although your intention might have been to enter a |
1283 |
reverse tab (Shift-Tab). |
1284 |
|
1285 |
=item * 5.3: Screen-selection entry method |
1286 |
|
1287 |
While this is implemented already (it's basically the selection |
1288 |
mechanism), it could be extended by displaying a unicode character map. |
1289 |
|
1290 |
=item * 5.4: Feedback method for identifying displayed characters for later input |
1291 |
|
1292 |
This method lets you display the unicode character code associated with |
1293 |
characters already displayed. |
1294 |
|
1295 |
You enter this mode by holding down C<Control> and C<Shift> together, then |
1296 |
pressing and holding the left mouse button and moving around. The unicode |
1297 |
hex code(s) (it might be a combining character) of the character under the |
1298 |
pointer is displayed until you release C<Control> and C<Shift>. |
1299 |
|
1300 |
In addition to the hex codes it will display the font used to draw this |
1301 |
character - due to implementation reasons, characters combined with |
1302 |
combining characters, line drawing characters and unknown characters will |
1303 |
always be drawn using the built-in support font. |
1304 |
|
1305 |
=back |
1306 |
|
1307 |
With respect to conformance, rxvt-unicode is supposed to be compliant to |
1308 |
both scenario A and B of ISO 14755, including part 5.2. |
1309 |
|
1310 |
=head1 LOGIN STAMP |
1311 |
|
1312 |
B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that |
1313 |
it can be seen via the I<who(1)> command, and can accept messages. To |
1314 |
allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root |
1315 |
on some systems or setgid to root or to some other group on others. |
1316 |
|
1317 |
=head1 COLORS AND GRAPHICS |
1318 |
|
1319 |
In addition to the default foreground and background colours, |
1320 |
B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus |
1321 |
high-intensity bold/blink versions of the same). Here is a list of the |
1322 |
colours with their names. |
1323 |
|
1324 |
=begin table |
1325 |
|
1326 |
B<color0> (black) = Black |
1327 |
B<color1> (red) = Red3 |
1328 |
B<color2> (green) = Green3 |
1329 |
B<color3> (yellow) = Yellow3 |
1330 |
B<color4> (blue) = Blue3 |
1331 |
B<color5> (magenta) = Magenta3 |
1332 |
B<color6> (cyan) = Cyan3 |
1333 |
B<color7> (white) = AntiqueWhite |
1334 |
B<color8> (bright black) = Grey25 |
1335 |
B<color9> (bright red) = Red |
1336 |
B<color10> (bright green) = Green |
1337 |
B<color11> (bright yellow) = Yellow |
1338 |
B<color12> (bright blue) = Blue |
1339 |
B<color13> (bright magenta) = Magenta |
1340 |
B<color14> (bright cyan) = Cyan |
1341 |
B<color15> (bright white) = White |
1342 |
B<foreground> = Black |
1343 |
B<background> = White |
1344 |
|
1345 |
=end table |
1346 |
|
1347 |
It is also possible to specify the colour values of B<foreground>, |
1348 |
B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as |
1349 |
a number 0-15, as a convenient shorthand to reference the colour name of |
1350 |
color0-color15. |
1351 |
|
1352 |
In addition to the colours defined above, @@RXVT_NAME@@ offers an |
1353 |
additional 72 colours. The first 64 of those (with indices 16 to 79) |
1354 |
consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b + |
1355 |
16>), followed by 8 additional shades of gray (with indices 80 to 87). |
1356 |
|
1357 |
Together, all those colours implement the 88 colour xterm colours. Only |
1358 |
the first 16 can be changed using resources currently, the rest can only |
1359 |
be changed via command sequences ("escape codes"). |
1360 |
|
1361 |
Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by |
1362 |
always swapping the foreground/background colours. This is in contrast to |
1363 |
I<xterm>(1) where the colours are only swapped if they have not otherwise |
1364 |
been specified. For example, |
1365 |
|
1366 |
=over 4 |
1367 |
|
1368 |
=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> |
1369 |
|
1370 |
would yield White on Black, while on I<xterm>(1) it would yield Black |
1371 |
on White. |
1372 |
|
1373 |
=back |
1374 |
|
1375 |
=head2 ALPHA CHANNEL SUPPORT |
1376 |
|
1377 |
If Xft support has been compiled in and as long as Xft/Xrender/X don't get |
1378 |
their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> |
1379 |
(recommended, but B<MUST> have 4 digits/component) colour specifications, |
1380 |
in addition to the ones provided by X, where the additional A component |
1381 |
specifies opacity (alpha) values. The minimum value of C<0> is completely |
1382 |
transparent). You can also prefix any color with C<[a]>, where C<a> is on |
1383 |
to four hex digits specifiying the opacity value. |
1384 |
|
1385 |
You probably need to specify B<"-depth 32">, too, and have the luck that |
1386 |
your X-server uses ARGB pixel layout, as X is far from just supporting |
1387 |
ARGB visuals out of the box, and rxvt-unicode just fudges around. |
1388 |
|
1389 |
For example, the following selects an almost completely transparent red |
1390 |
background, and an almost opaque pink foreground: |
1391 |
|
1392 |
@@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/2222 -fg "[e]pink" |
1393 |
|
1394 |
I<Please note that transparency of any kind if completely unsupported by |
1395 |
the author. Don't bug him with installation questions!> |
1396 |
|
1397 |
=head1 ENVIRONMENT |
1398 |
|
1399 |
B<@@RXVT_NAME@@> sets and/or uses the following environment variables: |
1400 |
|
1401 |
=over 4 |
1402 |
|
1403 |
=item B<TERM> |
1404 |
|
1405 |
Normally set to C<rxvt-unicode>, unless overwritten at configure time, via |
1406 |
resources or on the commandline. |
1407 |
|
1408 |
=item B<COLORTERM> |
1409 |
|
1410 |
Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was |
1411 |
compiled with XPM support, and optionally with the added extension |
1412 |
C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. |
1413 |
|
1414 |
=item B<COLORFGBG> |
1415 |
|
1416 |
Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is |
1417 |
the colour code used as default foreground/text colour (or the string |
1418 |
C<default> to indicate that the default-colour escape sequence is to be |
1419 |
used), C<bg> is the colour code used as default background colour (or the |
1420 |
string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ |
1421 |
was compiled with XPM support. Libraries like C<ncurses> and C<slang> can |
1422 |
(and do) use this information to optimize screen output. |
1423 |
|
1424 |
=item B<WINDOWID> |
1425 |
|
1426 |
Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel |
1427 |
window, which usually has subwindows for the scrollbar, the terminal |
1428 |
window and so on). |
1429 |
|
1430 |
=item B<TERMINFO> |
1431 |
|
1432 |
Set to the terminfo directory iff @@RXVT_NAME@@ was configured with |
1433 |
C<--with-terminfo=PATH>. |
1434 |
|
1435 |
=item B<DISPLAY> |
1436 |
|
1437 |
Used by @@RXVT_NAME@@ to connect to the display and set to the correct |
1438 |
display in its child processes. |
1439 |
|
1440 |
=item B<SHELL> |
1441 |
|
1442 |
The shell to be used for command execution, defaults to C</bin/sh>. |
1443 |
|
1444 |
=item B<RXVT_SOCKET> |
1445 |
|
1446 |
The unix domain socket path used by @@RXVT_NAME@@c(1) and |
1447 |
@@RXVT_NAME@@d(1). |
1448 |
|
1449 |
Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. |
1450 |
|
1451 |
=item B<HOME> |
1452 |
|
1453 |
Used to locate the default directory for the unix domain socket for |
1454 |
daemon communications and to locate various resource files (such as |
1455 |
C<.Xdefaults>) |
1456 |
|
1457 |
=item B<XAPPLRESDIR> |
1458 |
|
1459 |
Directory where various X resource files are being located. |
1460 |
|
1461 |
=item B<XENVIRONMENT> |
1462 |
|
1463 |
If set and accessible, gives the name of a X resource file to be loaded by |
1464 |
@@RXVT_NAME@@. |
1465 |
|
1466 |
=back |
1467 |
|
1468 |
=head1 FILES |
1469 |
|
1470 |
=over 4 |
1471 |
|
1472 |
=item B</usr/lib/X11/rgb.txt> |
1473 |
|
1474 |
Color names. |
1475 |
|
1476 |
=back |
1477 |
|
1478 |
=head1 SEE ALSO |
1479 |
|
1480 |
@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) |
1481 |
|
1482 |
=head1 CURRENT PROJECT COORDINATOR |
1483 |
|
1484 |
=over 4 |
1485 |
|
1486 |
=item Project Coordinator |
1487 |
|
1488 |
Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1489 |
|
1490 |
L<http://software.schmorp.de/pkg/rxvt-unicode.html> |
1491 |
|
1492 |
=back |
1493 |
|
1494 |
=head1 AUTHORS |
1495 |
|
1496 |
=over 4 |
1497 |
|
1498 |
=item John Bovey |
1499 |
|
1500 |
University of Kent, 1992, wrote the original Xvt. |
1501 |
|
1502 |
=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> |
1503 |
|
1504 |
very heavily modified Xvt and came up with Rxvt |
1505 |
|
1506 |
=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> |
1507 |
|
1508 |
wrote the Greek Keyboard Input (no longer in code) |
1509 |
|
1510 |
=item mj olesen L<< <olesen@me.QueensU.CA> >> |
1511 |
|
1512 |
Wrote the menu system. |
1513 |
|
1514 |
Project Coordinator (changes.txt 2.11 to 2.21) |
1515 |
|
1516 |
=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> |
1517 |
|
1518 |
Project Coordinator (changes.txt 2.21a to 2.4.5) |
1519 |
|
1520 |
=item Geoff Wing L<< <gcw@pobox.com> >> |
1521 |
|
1522 |
Rewrote screen display and text selection routines. |
1523 |
|
1524 |
Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) |
1525 |
|
1526 |
=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> |
1527 |
|
1528 |
Forked rxvt-unicode, unicode support, rewrote almost all the code, perl |
1529 |
extension, random hacks, numerous bugfixes and extensions. |
1530 |
|
1531 |
Project Coordinator (Changes 1.0 -) |
1532 |
|
1533 |
=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> |
1534 |
|
1535 |
Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. |
1536 |
|
1537 |
=back |
1538 |
|