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