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