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