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