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