1 |
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 |
2 |
.\" |
3 |
.\" Standard preamble: |
4 |
.\" ======================================================================== |
5 |
.de Sh \" Subsection heading |
6 |
.br |
7 |
.if t .Sp |
8 |
.ne 5 |
9 |
.PP |
10 |
\fB\\$1\fR |
11 |
.PP |
12 |
.. |
13 |
.de Sp \" Vertical space (when we can't use .PP) |
14 |
.if t .sp .5v |
15 |
.if n .sp |
16 |
.. |
17 |
.de Vb \" Begin verbatim text |
18 |
.ft CW |
19 |
.nf |
20 |
.ne \\$1 |
21 |
.. |
22 |
.de Ve \" End verbatim text |
23 |
.ft R |
24 |
.fi |
25 |
.. |
26 |
.\" Set up some character translations and predefined strings. \*(-- will |
27 |
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left |
28 |
.\" double quote, and \*(R" will give a right double quote. | will give a |
29 |
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to |
30 |
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' |
31 |
.\" expand to `' in nroff, nothing in troff, for use with C<>. |
32 |
.tr \(*W-|\(bv\*(Tr |
33 |
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' |
34 |
.ie n \{\ |
35 |
. ds -- \(*W- |
36 |
. ds PI pi |
37 |
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch |
38 |
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch |
39 |
. ds L" "" |
40 |
. ds R" "" |
41 |
. ds C` |
42 |
. ds C' |
43 |
'br\} |
44 |
.el\{\ |
45 |
. ds -- \|\(em\| |
46 |
. ds PI \(*p |
47 |
. ds L" `` |
48 |
. ds R" '' |
49 |
'br\} |
50 |
.\" |
51 |
.\" If the F register is turned on, we'll generate index entries on stderr for |
52 |
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index |
53 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
54 |
.\" output yourself in some meaningful fashion. |
55 |
.if \nF \{\ |
56 |
. de IX |
57 |
. tm Index:\\$1\t\\n%\t"\\$2" |
58 |
.. |
59 |
. nr % 0 |
60 |
. rr F |
61 |
.\} |
62 |
.\" |
63 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
64 |
.\" way too many mistakes in technical documents. |
65 |
.hy 0 |
66 |
.if n .na |
67 |
.\" |
68 |
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). |
69 |
.\" Fear. Run. Save yourself. No user-serviceable parts. |
70 |
. \" fudge factors for nroff and troff |
71 |
.if n \{\ |
72 |
. ds #H 0 |
73 |
. ds #V .8m |
74 |
. ds #F .3m |
75 |
. ds #[ \f1 |
76 |
. ds #] \fP |
77 |
.\} |
78 |
.if t \{\ |
79 |
. ds #H ((1u-(\\\\n(.fu%2u))*.13m) |
80 |
. ds #V .6m |
81 |
. ds #F 0 |
82 |
. ds #[ \& |
83 |
. ds #] \& |
84 |
.\} |
85 |
. \" simple accents for nroff and troff |
86 |
.if n \{\ |
87 |
. ds ' \& |
88 |
. ds ` \& |
89 |
. ds ^ \& |
90 |
. ds , \& |
91 |
. ds ~ ~ |
92 |
. ds / |
93 |
.\} |
94 |
.if t \{\ |
95 |
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" |
96 |
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' |
97 |
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' |
98 |
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' |
99 |
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' |
100 |
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' |
101 |
.\} |
102 |
. \" troff and (daisy-wheel) nroff accents |
103 |
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' |
104 |
.ds 8 \h'\*(#H'\(*b\h'-\*(#H' |
105 |
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] |
106 |
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' |
107 |
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' |
108 |
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] |
109 |
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] |
110 |
.ds ae a\h'-(\w'a'u*4/10)'e |
111 |
.ds Ae A\h'-(\w'A'u*4/10)'E |
112 |
. \" corrections for vroff |
113 |
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' |
114 |
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' |
115 |
. \" for low resolution devices (crt and lpr) |
116 |
.if \n(.H>23 .if \n(.V>19 \ |
117 |
\{\ |
118 |
. ds : e |
119 |
. ds 8 ss |
120 |
. ds o a |
121 |
. ds d- d\h'-1'\(ga |
122 |
. ds D- D\h'-1'\(hy |
123 |
. ds th \o'bp' |
124 |
. ds Th \o'LP' |
125 |
. ds ae ae |
126 |
. ds Ae AE |
127 |
.\} |
128 |
.rm #[ #] #H #V #F C |
129 |
.\" ======================================================================== |
130 |
.\" |
131 |
.IX Title "rxvt 1" |
132 |
.TH rxvt 1 "2005-01-11" "4.8" "RXVT-UNICODE" |
133 |
.SH "NAME" |
134 |
rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system) |
135 |
.SH "SYNOPSIS" |
136 |
.IX Header "SYNOPSIS" |
137 |
\&\fB@@RXVT_NAME@@\fR [options] [\-e command [ args ]] |
138 |
.SH "DESCRIPTION" |
139 |
.IX Header "DESCRIPTION" |
140 |
\&\fBrxvt-unicode\fR, version \fB@@RXVT_VERSION@@\fR, is a colour vt102 terminal |
141 |
emulator intended as an \fIxterm\fR(1) replacement for users who do not |
142 |
require features such as Tektronix 4014 emulation and toolkit-style |
143 |
configurability. As a result, \fBrxvt-unicode\fR uses much less swap space \*(-- |
144 |
a significant advantage on a machine serving many X sessions. |
145 |
.SH "FREQUENTLY ASKED QUESTIONS" |
146 |
.IX Header "FREQUENTLY ASKED QUESTIONS" |
147 |
See @@RXVT_NAME@@(7) (try \f(CW\*(C`man 7 @@RXVT_NAME@@\*(C'\fR) for a list of frequently |
148 |
asked questions and answer to them and some common problems. |
149 |
.SH "RXVT-UNICODE VS. RXVT" |
150 |
.IX Header "RXVT-UNICODE VS. RXVT" |
151 |
Unlike the original rxvt, \fBrxvt-unicode\fR stores all text in Unicode |
152 |
internally. That means it can store and display most scripts in the |
153 |
world. Being a terminal emulator, however, some things are very difficult, |
154 |
especially cursive scripts such as arabic, vertically written scripts |
155 |
like mongolian or scripts requiring extremely complex combining rules, |
156 |
like tibetan or devenagari. Don't expect pretty output when using these |
157 |
scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work |
158 |
fine, though. A somewhat difficult case are left-to-right scripts, such |
159 |
as hebrew: \fBrxvt-unicode\fR adopts the view that bidirectional algorithms |
160 |
belong into the application, not the terminal emulator (too many things \*(-- |
161 |
such as cursor-movement while editing \*(-- break otherwise), but that might |
162 |
change. |
163 |
.PP |
164 |
If you are looking for a terminal that supports more exotic scripts, let |
165 |
me recommend \f(CW\*(C`mlterm\*(C'\fR, which is a very userfriendly, lean and clean |
166 |
terminal emulator. In fact, the reason rxvt-unicode was born was solely |
167 |
because the author couldn't get \f(CW\*(C`mlterm\*(C'\fR to use one font for latin1 and |
168 |
another for japanese. |
169 |
.PP |
170 |
Therefore another design rationale was the use of multiple fonts to |
171 |
display characters: The idea of a single unicode font which many other |
172 |
programs force onto it's users never made sense to me: You should be able |
173 |
to choose any font for any script freely. |
174 |
.PP |
175 |
Apart from that, rxvt-unicode is also much better internationalised than |
176 |
it's predecessor, supports things such as \s-1XFT\s0 and \s-1ISO\s0 14755 that are handy |
177 |
in i18n\-environments, is faster, and has a lot less bugs than the original |
178 |
rxvt. This all in addition to dozens of other small improvements. |
179 |
.PP |
180 |
It is still faithfully following the original rxvt idea of being lean |
181 |
and nice on resources: for example, you can still configure rxvt-unicode |
182 |
without most of it's features to get a lean binary. It also comes with |
183 |
a client/daemon pair that lets you open any number of terminal windows |
184 |
from within a single process, which makes startup time very fast and |
185 |
drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and |
186 |
@@RXVT_NAME@@c(1) (client). |
187 |
.PP |
188 |
It also makes technical information about escape sequences (which have |
189 |
been extended) easier accessible: see @@RXVT_NAME@@(7) for technical |
190 |
reference documentation (escape sequences etc.). |
191 |
.SH "OPTIONS" |
192 |
.IX Header "OPTIONS" |
193 |
The \fB@@RXVT_NAME@@\fR options (mostly a subset of \fIxterm\fR's) are listed |
194 |
below. In keeping with the smaller-is-better philosophy, options may be |
195 |
eliminated or default values chosen at compile\-time, so options and |
196 |
defaults listed may not accurately reflect the version installed on |
197 |
your system. `@@RXVT_NAME@@ \-h' gives a list of major compile-time options on |
198 |
the \fIOptions\fR line. Option descriptions may be prefixed with which |
199 |
compile option each is dependent upon. e.g. `Compile \fI\s-1XIM\s0\fR:' requires |
200 |
\&\fI\s-1XIM\s0\fR on the \fIOptions\fR line. Note: `@@RXVT_NAME@@ \-help' gives a list of all |
201 |
command-line options compiled into your version. |
202 |
.PP |
203 |
Note that \fB@@RXVT_NAME@@\fR permits the resource name to be used as a |
204 |
long-option (\-\-/++ option) so the potential command-line options are |
205 |
far greater than those listed. For example: `@@RXVT_NAME@@ \-\-loginShell \-\-color1 |
206 |
Orange'. |
207 |
.PP |
208 |
The following options are available: |
209 |
.IP "\fB\-help\fR, \fB\-\-help\fR" 4 |
210 |
.IX Item "-help, --help" |
211 |
Print out a message describing available options. |
212 |
.IP "\fB\-display\fR \fIdisplayname\fR" 4 |
213 |
.IX Item "-display displayname" |
214 |
Attempt to open a window on the named X display (\fB\-d\fR still |
215 |
respected). In the absence of this option, the display specified by the |
216 |
\&\fB\s-1DISPLAY\s0\fR environment variable is used. |
217 |
.IP "\fB\-geometry\fR \fIgeom\fR" 4 |
218 |
.IX Item "-geometry geom" |
219 |
Window geometry (\fB\-g\fR still respected); resource \fBgeometry\fR. |
220 |
.IP "\fB\-rv\fR|\fB+rv\fR" 4 |
221 |
.IX Item "-rv|+rv" |
222 |
Turn on/off simulated reverse video; resource \fBreverseVideo\fR. |
223 |
.IP "\fB\-j\fR|\fB+j\fR" 4 |
224 |
.IX Item "-j|+j" |
225 |
Turn on/off jump scrolling; resource \fBjumpScroll\fR. |
226 |
.IP "\fB\-ip\fR|\fB+ip\fR" 4 |
227 |
.IX Item "-ip|+ip" |
228 |
Turn on/off inheriting parent window's pixmap. Alternative form is |
229 |
\&\fB\-tr\fR; resource \fBinheritPixmap\fR. |
230 |
.IP "\fB\-fade\fR \fInumber\fR" 4 |
231 |
.IX Item "-fade number" |
232 |
Fade the text by the given percentage when focus is lost. resource \fBfading\fR. |
233 |
.IP "\fB\-tint\fR \fIcolour\fR" 4 |
234 |
.IX Item "-tint colour" |
235 |
Tint the transparent background pixmap with the given colour when |
236 |
transparency is enabled with \fB\-tr\fR or \fB\-ip\fR. See also the \fB\-sh\fR |
237 |
option that can be used to brighten or darken the image in addition to |
238 |
tinting it. |
239 |
.IP "\fB\-sh\fR" 4 |
240 |
.IX Item "-sh" |
241 |
\&\fInumber\fR Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent |
242 |
background image in addition to tinting it (i.e. \fB\-tint\fR must be |
243 |
specified, too, e.g. \f(CW\*(C`\-tint white\*(C'\fR). |
244 |
.IP "\fB\-bg\fR \fIcolour\fR" 4 |
245 |
.IX Item "-bg colour" |
246 |
Window background colour; resource \fBbackground\fR. |
247 |
.IP "\fB\-fg\fR \fIcolour\fR" 4 |
248 |
.IX Item "-fg colour" |
249 |
Window foreground colour; resource \fBforeground\fR. |
250 |
.IP "\fB\-pixmap\fR \fIfile[;geom]\fR" 4 |
251 |
.IX Item "-pixmap file[;geom]" |
252 |
Compile \fI\s-1XPM\s0\fR: Specify \s-1XPM\s0 file for the background and also optionally |
253 |
specify its scaling with a geometry string. Note you may need to add |
254 |
quotes to avoid special shell interpretation of the `;' in the |
255 |
command\-line; resource \fBbackgroundPixmap\fR. |
256 |
.IP "\fB\-cr\fR \fIcolour\fR" 4 |
257 |
.IX Item "-cr colour" |
258 |
The cursor colour; resource \fBcursorColor\fR. |
259 |
.IP "\fB\-pr\fR \fIcolour\fR" 4 |
260 |
.IX Item "-pr colour" |
261 |
The mouse pointer foreground colour; resource \fBpointerColor\fR. |
262 |
.IP "\fB\-pr2\fR \fIcolour\fR" 4 |
263 |
.IX Item "-pr2 colour" |
264 |
The mouse pointer background colour; resource \fBpointerColor2\fR. |
265 |
.IP "\fB\-bd\fR \fIcolour\fR" 4 |
266 |
.IX Item "-bd colour" |
267 |
The colour of the border around the text area and between the scrollbar and the text; |
268 |
resource \fBborderColor\fR. |
269 |
.IP "\fB\-fn\fR \fIfontlist\fR" 4 |
270 |
.IX Item "-fn fontlist" |
271 |
Select the fonts to be used. This is a comma separated list of font names |
272 |
that are used in turn when trying to display Unicode characters. The |
273 |
first font defines the cell size for characters; other fonts might be |
274 |
smaller, but not (in general) larger. A (hopefully) reasonable default |
275 |
font list is always appended to it. See resource \fBfont\fR for more details. |
276 |
.Sp |
277 |
In short, to specify an X11 core font, just specify it's name or prefix it |
278 |
with \f(CW\*(C`x:\*(C'\fR. To specify an XFT\-font, you need to prefix it with \f(CW\*(C`xft:\*(C'\fR, |
279 |
e.g.: |
280 |
.Sp |
281 |
.Vb 2 |
282 |
\& @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" |
283 |
\& @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" |
284 |
.Ve |
285 |
.Sp |
286 |
See also the question \*(L"How does rxvt-unicode choose fonts?\*(R" in the \s-1FAQ\s0 |
287 |
section of @@RXVT_NAME@@(7). |
288 |
.IP "\fB\-fb\fR \fIfontlist\fR" 4 |
289 |
.IX Item "-fb fontlist" |
290 |
Compile font\-styles: The bold font list to use when bold characters are to |
291 |
be printed. See resource \fBboldFont\fR for details. |
292 |
.IP "\fB\-fi\fR \fIfontlist\fR" 4 |
293 |
.IX Item "-fi fontlist" |
294 |
Compile font\-styles: The italic font list to use when bold characters are to |
295 |
be printed. See resource \fBitalicFont\fR for details. |
296 |
.IP "\fB\-fbi\fR \fIfontlist\fR" 4 |
297 |
.IX Item "-fbi fontlist" |
298 |
Compile font\-styles: The bold italic font list to use when bold characters are to |
299 |
be printed. See resource \fBboldItalicFont\fR for details. |
300 |
.IP "\fB\-name\fR \fIname\fR" 4 |
301 |
.IX Item "-name name" |
302 |
Specify the application name under which resources are to be obtained, |
303 |
rather than the default executable file name. Name should not contain |
304 |
`.' or `*' characters. Also sets the icon and title name. |
305 |
.IP "\fB\-ls\fR|\fB+ls\fR" 4 |
306 |
.IX Item "-ls|+ls" |
307 |
Start as a login\-shell/sub\-shell; resource \fBloginShell\fR. |
308 |
.IP "\fB\-ut\fR|\fB+ut\fR" 4 |
309 |
.IX Item "-ut|+ut" |
310 |
Compile \fIutmp\fR: Inhibit/enable writing a utmp entry; resource |
311 |
\&\fButmpInhibit\fR. |
312 |
.IP "\fB\-vb\fR|\fB+vb\fR" 4 |
313 |
.IX Item "-vb|+vb" |
314 |
Turn on/off visual bell on receipt of a bell character; resource |
315 |
\&\fBvisualBell\fR. |
316 |
.IP "\fB\-sb\fR|\fB+sb\fR" 4 |
317 |
.IX Item "-sb|+sb" |
318 |
Turn on/off scrollbar; resource \fBscrollBar\fR. |
319 |
.IP "\fB\-si\fR|\fB+si\fR" 4 |
320 |
.IX Item "-si|+si" |
321 |
Turn on/off scroll-to-bottom on \s-1TTY\s0 output inhibit; resource |
322 |
\&\fBscrollTtyOutput\fR has opposite effect. |
323 |
.IP "\fB\-sk\fR|\fB+sk\fR" 4 |
324 |
.IX Item "-sk|+sk" |
325 |
Turn on/off scroll-to-bottom on keypress; resource |
326 |
\&\fBscrollTtyKeypress\fR. |
327 |
.IP "\fB\-sw\fR|\fB+sw\fR" 4 |
328 |
.IX Item "-sw|+sw" |
329 |
Turn on/off scrolling with the scrollback buffer as new lines appear. |
330 |
This only takes effect if \fB\-si\fR is also given; resource |
331 |
\&\fBscrollWithBuffer\fR. |
332 |
.IP "\fB\-sr\fR|\fB+sr\fR" 4 |
333 |
.IX Item "-sr|+sr" |
334 |
Put scrollbar on right/left; resource \fBscrollBar_right\fR. |
335 |
.IP "\fB\-st\fR|\fB+st\fR" 4 |
336 |
.IX Item "-st|+st" |
337 |
Display normal (non XTerm/NeXT) scrollbar without/with a trough; |
338 |
resource \fBscrollBar_floating\fR. |
339 |
.IP "\fB\-ptab\fR|\fB+ptab\fR" 4 |
340 |
.IX Item "-ptab|+ptab" |
341 |
If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as |
342 |
actual wide characters in the screen buffer, which makes it possible to |
343 |
select and paste them. Since a horizontal tab is a cursor movement and |
344 |
not an actual glyph, this can sometimes be visually annoying as the cursor |
345 |
on a tab character is displayed as a wide cursor; resource \fBpastableTabs\fR. |
346 |
.IP "\fB\-bc\fR|\fB+bc\fR" 4 |
347 |
.IX Item "-bc|+bc" |
348 |
Blink the cursor; resource \fBcursorBlink\fR. |
349 |
.IP "\fB\-iconic\fR" 4 |
350 |
.IX Item "-iconic" |
351 |
Start iconified, if the window manager supports that option. |
352 |
Alternative form is \fB\-ic\fR. |
353 |
.IP "\fB\-sl\fR \fInumber\fR" 4 |
354 |
.IX Item "-sl number" |
355 |
Save \fInumber\fR lines in the scrollback buffer. See resource entry for |
356 |
limits; resource \fBsaveLines\fR. |
357 |
.IP "\fB\-b\fR \fInumber\fR" 4 |
358 |
.IX Item "-b number" |
359 |
Compile \fIfrills\fR: Internal border of \fInumber\fR pixels. See resource |
360 |
entry for limits; resource \fBinternalBorder\fR. |
361 |
.IP "\fB\-w\fR \fInumber\fR" 4 |
362 |
.IX Item "-w number" |
363 |
Compile \fIfrills\fR: External border of \fInumber\fR pixels. Also, \fB\-bw\fR |
364 |
and \fB\-borderwidth\fR. See resource entry for limits; resource |
365 |
\&\fBexternalBorder\fR. |
366 |
.IP "\fB\-bl\fR" 4 |
367 |
.IX Item "-bl" |
368 |
Compile \fIfrills\fR: Set \s-1MWM\s0 hints to request a borderless window, i.e. |
369 |
if honoured by the \s-1WM\s0, the rxvt-unicode window will not have window |
370 |
decorations; resource \fBborderLess\fR. |
371 |
.IP "\fB\-lsp\fR \fInumber\fR" 4 |
372 |
.IX Item "-lsp number" |
373 |
Compile \fIfrills\fR: Lines (pixel height) to insert between each row of |
374 |
the display. Useful to work around font rendering problems; resource |
375 |
\&\fBlinespace\fR. |
376 |
.IP "\fB\-tn\fR \fItermname\fR" 4 |
377 |
.IX Item "-tn termname" |
378 |
This option specifies the name of the terminal type to be set in the |
379 |
\&\fB\s-1TERM\s0\fR environment variable. This terminal type must exist in the |
380 |
\&\fI\fItermcap\fI\|(5)\fR database and should have \fIli#\fR and \fIco#\fR entries; |
381 |
resource \fBtermName\fR. |
382 |
.IP "\fB\-e\fR \fIcommand [arguments]\fR" 4 |
383 |
.IX Item "-e command [arguments]" |
384 |
Run the command with its command-line arguments in the \fB@@RXVT_NAME@@\fR |
385 |
window; also sets the window title and icon name to be the basename of |
386 |
the program being executed if neither \fI\-title\fR (\fI\-T\fR) nor \fI\-n\fR are |
387 |
given on the command line. If this option is used, it must be the last |
388 |
on the command\-line. If there is no \fB\-e\fR option then the default is to |
389 |
run the program specified by the \fB\s-1SHELL\s0\fR environment variable or, |
390 |
failing that, \fI\fIsh\fI\|(1)\fR. |
391 |
.IP "\fB\-title\fR \fItext\fR" 4 |
392 |
.IX Item "-title text" |
393 |
Window title (\fB\-T\fR still respected); the default title is the basename |
394 |
of the program specified after the \fB\-e\fR option, if any, otherwise the |
395 |
application name; resource \fBtitle\fR. |
396 |
.IP "\fB\-n\fR \fItext\fR" 4 |
397 |
.IX Item "-n text" |
398 |
Icon name; the default name is the basename of the program specified |
399 |
after the \fB\-e\fR option, if any, otherwise the application name; |
400 |
resource \fBiconName\fR. |
401 |
.IP "\fB\-C\fR" 4 |
402 |
.IX Item "-C" |
403 |
Capture system console messages. |
404 |
.IP "\fB\-pt\fR \fIstyle\fR" 4 |
405 |
.IX Item "-pt style" |
406 |
Compile \fI\s-1XIM\s0\fR: input style for input method; \fBOverTheSpot\fR, |
407 |
\&\fBOffTheSpot\fR, \fBRoot\fR; resource \fBpreeditType\fR. |
408 |
.IP "\fB\-im\fR \fItext\fR" 4 |
409 |
.IX Item "-im text" |
410 |
Compile \fI\s-1XIM\s0\fR: input method name. resource \fBinputMethod\fR. |
411 |
.IP "\fB\-imlocale\fR \fIstring\fR" 4 |
412 |
.IX Item "-imlocale string" |
413 |
The locale to use for opening the \s-1IM\s0. You can use an \s-1LC_CTYPE\s0 of e.g. |
414 |
de_DE.UTF\-8 for normal text processing but ja_JP.EUC\-JP for the input |
415 |
extension to be able to input japanese characters while staying in |
416 |
another locale. |
417 |
.IP "\fB\-insecure\fR" 4 |
418 |
.IX Item "-insecure" |
419 |
Enable \*(L"insecure\*(R" mode, which currently enables most of the escape |
420 |
sequences that echo strings. See the resource \fBinsecure\fR for more |
421 |
info. |
422 |
.IP "\fB\-mod\fR \fImodifier\fR" 4 |
423 |
.IX Item "-mod modifier" |
424 |
Override detection of Meta modifier with specified key: \fBalt\fR, |
425 |
\&\fBmeta\fR, \fBhyper\fR, \fBsuper\fR, \fBmod1\fR, \fBmod2\fR, \fBmod3\fR, \fBmod4\fR, |
426 |
\&\fBmod5\fR; resource \fImodifier\fR. |
427 |
.IP "\fB\-ssc\fR|\fB+ssc\fR" 4 |
428 |
.IX Item "-ssc|+ssc" |
429 |
Turn on/off secondary screen (default enabled); resource |
430 |
\&\fBsecondaryScreen\fR. |
431 |
.IP "\fB\-ssr\fR|\fB+ssr\fR" 4 |
432 |
.IX Item "-ssr|+ssr" |
433 |
Turn on/off secondary screen scroll (default enabled); resource |
434 |
\&\fBsecondaryScroll\fR. |
435 |
.IP "\fB\-xrm\fR \fIresourcestring\fR" 4 |
436 |
.IX Item "-xrm resourcestring" |
437 |
No effect on rxvt\-unicode. Simply passes through an argument to be made |
438 |
available in the instance's argument list. Appears in \fI\s-1WM_COMMAND\s0\fR in |
439 |
some window managers. |
440 |
.SH "RESOURCES (available also as long\-options)" |
441 |
.IX Header "RESOURCES (available also as long-options)" |
442 |
Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long |
443 |
options) compiled into your version. |
444 |
.PP |
445 |
There are two different methods that @@RXVT_NAME@@ can use to get the |
446 |
Xresource data: using the X libraries (Xrm*\-functions) or internal |
447 |
Xresources reader (\fB~/.Xdefaults\fR). For the first method (ie. |
448 |
\&\fB@@RXVT_NAME@@ \-h\fR lists \fBXGetDefaults\fR), you can set and change the |
449 |
resources using X11 tools like \fBxset\fR. Many distribution do also load |
450 |
settings from the \fB~/.Xresources\fR file when X starts. |
451 |
.PP |
452 |
If compiled with internal Xresources support (i.e. \fB@@RXVT_NAME@@ \-h\fR |
453 |
lists \fB.Xdefaults\fR) then \fB@@RXVT_NAME@@\fR accepts application defaults |
454 |
set in XAPPLOADDIR/URxvt (compile\-time defined: usually |
455 |
\&\fB/usr/lib/X11/app\-defaults/URxvt\fR) and resources set in |
456 |
\&\fB~/.Xdefaults\fR, or \fB~/.Xresources\fR if \fB~/.Xdefaults\fR does not exist. |
457 |
Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two |
458 |
class names: \fBXTerm\fR and \fBURxvt\fR. The class name \fBRxvt\fR allows |
459 |
resources common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be |
460 |
easily configured, while the class name \fBURxvt\fR allows resources |
461 |
unique to \fB@@RXVT_NAME@@\fR, notably colours and key\-handling, to be |
462 |
shared between different \fB@@RXVT_NAME@@\fR configurations. If no |
463 |
resources are specified, suitable defaults will be used. Command-line |
464 |
arguments can be used to override resource settings. The following |
465 |
resources are allowed: |
466 |
.IP "\fBgeometry:\fR \fIgeom\fR" 4 |
467 |
.IX Item "geometry: geom" |
468 |
Create the window with the specified X window geometry [default 80x24]; |
469 |
option \fB\-geometry\fR. |
470 |
.IP "\fBbackground:\fR \fIcolour\fR" 4 |
471 |
.IX Item "background: colour" |
472 |
Use the specified colour as the window's background colour [default |
473 |
White]; option \fB\-bg\fR. |
474 |
.IP "\fBforeground:\fR \fIcolour\fR" 4 |
475 |
.IX Item "foreground: colour" |
476 |
Use the specified colour as the window's foreground colour [default |
477 |
Black]; option \fB\-fg\fR. |
478 |
.IP "\fBcolor\fR\fIn\fR\fB:\fR \fIcolour\fR" 4 |
479 |
.IX Item "colorn: colour" |
480 |
Use the specified colour for the colour value \fIn\fR, where 0\-7 |
481 |
corresponds to low-intensity (normal) colours and 8\-15 corresponds to |
482 |
high-intensity (bold = bright foreground, blink = bright background) |
483 |
colours. The canonical names are as follows: 0=black, 1=red, 2=green, |
484 |
3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour |
485 |
names used are listed in the \fB\s-1COLORS\s0 \s-1AND\s0 \s-1GRAPHICS\s0\fR section. |
486 |
.Sp |
487 |
Colours higher than 15 cannot be set using resources (yet), but can be |
488 |
changed using an escape command (see @@RXVT_NAME@@(7)). |
489 |
.Sp |
490 |
Colours 16\-79 form a standard 4x4x4 colour cube (the same as xterm with |
491 |
88 colour support). Colours 80\-87 are evenly spaces grey steps. |
492 |
.IP "\fBcolorBD:\fR \fIcolour\fR" 4 |
493 |
.IX Item "colorBD: colour" |
494 |
.PD 0 |
495 |
.IP "\fBcolorIT:\fR \fIcolour\fR" 4 |
496 |
.IX Item "colorIT: colour" |
497 |
.PD |
498 |
Use the specified colour to display bold or italic characters when the |
499 |
foreground colour is the default. If font styles are not available |
500 |
(Compile styles) and this option is unset, reverse video is used instead. |
501 |
.IP "\fBcolorUL:\fR \fIcolour\fR" 4 |
502 |
.IX Item "colorUL: colour" |
503 |
Use the specified colour to display underlined characters when the |
504 |
foreground colour is the default. |
505 |
.IP "\fBcolorRV:\fR \fIcolour\fR" 4 |
506 |
.IX Item "colorRV: colour" |
507 |
Use the specified colour as the background for reverse video |
508 |
characters. |
509 |
.IP "\fBunderlineColor:\fR \fIcolour\fR" 4 |
510 |
.IX Item "underlineColor: colour" |
511 |
If set, use the specified colour as the colour for the underline |
512 |
itself. If unset, use the foreground colour. |
513 |
.IP "\fBcursorColor:\fR \fIcolour\fR" 4 |
514 |
.IX Item "cursorColor: colour" |
515 |
Use the specified colour for the cursor. The default is to use the |
516 |
foreground colour; option \fB\-cr\fR. |
517 |
.IP "\fBcursorColor2:\fR \fIcolour\fR" 4 |
518 |
.IX Item "cursorColor2: colour" |
519 |
Use the specified colour for the colour of the cursor text. For this to |
520 |
take effect, \fBcursorColor\fR must also be specified. The default is to |
521 |
use the background colour. |
522 |
.IP "\fBreverseVideo:\fR \fIboolean\fR" 4 |
523 |
.IX Item "reverseVideo: boolean" |
524 |
\&\fBTrue\fR: simulate reverse video by foreground and background colours; |
525 |
option \fB\-rv\fR. \fBFalse\fR: regular screen colours [default]; option |
526 |
\&\fB+rv\fR. See note in \fB\s-1COLORS\s0 \s-1AND\s0 \s-1GRAPHICS\s0\fR section. |
527 |
.IP "\fBjumpScroll:\fR \fIboolean\fR" 4 |
528 |
.IX Item "jumpScroll: boolean" |
529 |
\&\fBTrue\fR: specify that jump scrolling should be used. When scrolling |
530 |
quickly, fewer screen updates are performed [default]; option \fB\-j\fR. |
531 |
\&\fBFalse\fR: specify that smooth scrolling should be used; option \fB+j\fR. |
532 |
.IP "\fBinheritPixmap:\fR \fIboolean\fR" 4 |
533 |
.IX Item "inheritPixmap: boolean" |
534 |
\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving |
535 |
artificial transparency. \fBFalse\fR: do not inherit the parent windows' |
536 |
pixmap. |
537 |
.IP "\fBfading:\fR \fInumber\fR" 4 |
538 |
.IX Item "fading: number" |
539 |
Fade the text by the given percentage when focus is lost. |
540 |
.IP "\fBtintColor:\fR \fIcolour\fR" 4 |
541 |
.IX Item "tintColor: colour" |
542 |
Tint the transparent background pixmap with the given colour. |
543 |
.IP "\fBshading:\fR \fInumber\fR" 4 |
544 |
.IX Item "shading: number" |
545 |
Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background |
546 |
image in addition to tinting it. |
547 |
.IP "\fBscrollColor:\fR \fIcolour\fR" 4 |
548 |
.IX Item "scrollColor: colour" |
549 |
Use the specified colour for the scrollbar [default #B2B2B2]. |
550 |
.IP "\fBtroughColor:\fR \fIcolour\fR" 4 |
551 |
.IX Item "troughColor: colour" |
552 |
Use the specified colour for the scrollbar's trough area [default |
553 |
#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. |
554 |
.IP "\fBborderColor:\fR \fIcolour\fR" 4 |
555 |
.IX Item "borderColor: colour" |
556 |
The colour of the border around the text area and between the scrollbar |
557 |
and the text. |
558 |
.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4 |
559 |
.IX Item "backgroundPixmap: file[;geom]" |
560 |
Use the specified \s-1XPM\s0 file (note the `.xpm' extension is optional) for |
561 |
the background and also optionally specify its scaling with a geometry |
562 |
string \fBWxH+X+Y\fR, in which \fB\*(L"W\*(R" / \*(L"H\*(R"\fR specify the |
563 |
horizontal/vertical scale (percent) and \fB\*(L"X\*(R" / \*(L"Y\*(R"\fR locate the image |
564 |
centre (percent). A scale of 0 displays the image with tiling. A scale |
565 |
of 1 displays the image without any scaling. A scale of 2 to 9 |
566 |
specifies an integer number of images in that direction. No image will |
567 |
be magnified beyond 10 times its original size. The maximum permitted |
568 |
scale is 1000. [default 0x0+50+50] |
569 |
.IP "\fBmenu:\fR \fIfile[;tag]\fR" 4 |
570 |
.IX Item "menu: file[;tag]" |
571 |
Read in the specified menu file (note the `.menu' extension is |
572 |
optional) and also optionally specify a starting tag to find. See the |
573 |
reference documentation for details on the syntax for the menuBar. |
574 |
.IP "\fBpath:\fR \fIpath\fR" 4 |
575 |
.IX Item "path: path" |
576 |
Specify the colon-delimited search path for finding files (\s-1XPM\s0 and |
577 |
menus), in addition to the paths specified by the \fB\s-1RXVTPATH\s0\fR and |
578 |
\&\fB\s-1PATH\s0\fR environment variables. |
579 |
.IP "\fBfont:\fR \fIfontlist\fR" 4 |
580 |
.IX Item "font: fontlist" |
581 |
Select the fonts to be used. This is a comma separated list of font |
582 |
names that are used in turn when trying to display Unicode characters. |
583 |
The first font defines the cell size for characters; other fonts might |
584 |
be smaller, but not larger. A reasonable default font list is always |
585 |
appended to it. option \fB\-fn\fR. |
586 |
.Sp |
587 |
Each font can either be a standard X11 core font (\s-1XLFD\s0) name, with |
588 |
optional prefix \f(CW\*(C`x:\*(C'\fR or a Xft font (Compile xft), prefixed with \f(CW\*(C`xft:\*(C'\fR. |
589 |
.Sp |
590 |
In addition, each font can be prefixed with additional hints and |
591 |
specifications enclosed in square brackets (\f(CW\*(C`[]\*(C'\fR). The only available |
592 |
hint currently is \f(CW\*(C`codeset=codeset\-name\*(C'\fR, and this is only used for Xft |
593 |
fonts. |
594 |
.Sp |
595 |
For example, this font resource |
596 |
.Sp |
597 |
.Vb 5 |
598 |
\& URxvt*font: 9x15bold,\e |
599 |
\& -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\e |
600 |
\& -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \e |
601 |
\& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e |
602 |
\& xft:Code2000:antialias=false |
603 |
.Ve |
604 |
.Sp |
605 |
specifies five fonts to be used. The first one is \f(CW\*(C`9x15bold\*(C'\fR (actually |
606 |
the iso8859\-1 version of the second font), which is the base font (because |
607 |
it is named first) and thus defines the character cell grid to be 9 pixels |
608 |
wide and 15 pixels high. |
609 |
.Sp |
610 |
The second font is just used to add additional unicode characters not in |
611 |
the base font, likewise the third, which is unfortunately non\-bold, but |
612 |
the bold version of the font does contain less characters, so this is a |
613 |
useful supplement. |
614 |
.Sp |
615 |
The third font is an Xft font with aliasing turned off, and the characters |
616 |
are limited to the \fB\s-1JIS\s0 0208\fR codeset (i.e. japanese kanji). The font |
617 |
contains other characters, but we are not interested in them. |
618 |
.Sp |
619 |
The last font is a useful catch-all font that supplies most of the |
620 |
remaining unicode characters. |
621 |
.IP "\fBboldFont:\fR \fIfontlist\fR" 4 |
622 |
.IX Item "boldFont: fontlist" |
623 |
.PD 0 |
624 |
.IP "\fBitalicFont:\fR \fIfontlist\fR" 4 |
625 |
.IX Item "italicFont: fontlist" |
626 |
.IP "\fBboldItalicFont:\fR \fIfontlist\fR" 4 |
627 |
.IX Item "boldItalicFont: fontlist" |
628 |
.PD |
629 |
The font list to use for displaying \fBbold\fR, \fIitalic\fR or \fB\f(BIbold |
630 |
italic\fB\fR characters, respectively. |
631 |
.Sp |
632 |
If specified and non\-empty, then the syntax is the same as for the |
633 |
\&\fBfont\fR\-resource, and the given font list will be used as is, which makes |
634 |
it possible to substitute completely different font styles for bold and |
635 |
italic. |
636 |
.Sp |
637 |
If unset (the default), a suitable font list will be synthesized by |
638 |
\&\*(L"morphing\*(R" the normal text font list into the desired shape. If that is |
639 |
not possible, replacement fonts of the desired shape will be tried. |
640 |
.Sp |
641 |
If set, but empty, then this specific style is disabled and the normal |
642 |
text font will being used for the given style. |
643 |
.IP "\fBselectstyle:\fR \fImode\fR" 4 |
644 |
.IX Item "selectstyle: mode" |
645 |
Set mouse selection style to \fBold\fR which is 2.20, \fBoldword\fR which is |
646 |
xterm style with 2.20 old word selection, or anything else which gives |
647 |
xterm style selection. |
648 |
.IP "\fBscrollstyle:\fR \fImode\fR" 4 |
649 |
.IX Item "scrollstyle: mode" |
650 |
Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is |
651 |
the author's favourite.. |
652 |
.IP "\fBtitle:\fR \fIstring\fR" 4 |
653 |
.IX Item "title: string" |
654 |
Set window title string, the default title is the command-line |
655 |
specified after the \fB\-e\fR option, if any, otherwise the application |
656 |
name; option \fB\-title\fR. |
657 |
.IP "\fBiconName:\fR \fIstring\fR" 4 |
658 |
.IX Item "iconName: string" |
659 |
Set the name used to label the window's icon or displayed in an icon |
660 |
manager window, it also sets the window's title unless it is explicitly |
661 |
set; option \fB\-n\fR. |
662 |
.IP "\fBmapAlert:\fR \fIboolean\fR" 4 |
663 |
.IX Item "mapAlert: boolean" |
664 |
\&\fBTrue\fR: de-iconify (map) on receipt of a bell character. \fBFalse\fR: no |
665 |
de-iconify (map) on receipt of a bell character [default]. |
666 |
.IP "\fBvisualBell:\fR \fIboolean\fR" 4 |
667 |
.IX Item "visualBell: boolean" |
668 |
\&\fBTrue\fR: use visual bell on receipt of a bell character; option \fB\-vb\fR. |
669 |
\&\fBFalse\fR: no visual bell [default]; option \fB+vb\fR. |
670 |
.IP "\fBloginShell:\fR \fIboolean\fR" 4 |
671 |
.IX Item "loginShell: boolean" |
672 |
\&\fBTrue\fR: start as a login shell by prepending a `\-' to \fBargv[0]\fR of |
673 |
the shell; option \fB\-ls\fR. \fBFalse\fR: start as a normal sub-shell |
674 |
[default]; option \fB+ls\fR. |
675 |
.IP "\fButmpInhibit:\fR \fIboolean\fR" 4 |
676 |
.IX Item "utmpInhibit: boolean" |
677 |
\&\fBTrue\fR: inhibit writing record into the system log file \fButmp\fR; |
678 |
option \fB\-ut\fR. \fBFalse\fR: write record into the system log file \fButmp\fR |
679 |
[default]; option \fB+ut\fR. |
680 |
.IP "\fBprint\-pipe:\fR \fIstring\fR" 4 |
681 |
.IX Item "print-pipe: string" |
682 |
Specify a command pipe for vt100 printer [default \fI\fIlpr\fI\|(1)\fR]. Use |
683 |
\&\fBPrint\fR to initiate a screen dump to the printer and \fBCtrl-Print\fR or |
684 |
\&\fBShift-Print\fR to include the scrollback as well. |
685 |
.IP "\fBscrollBar:\fR \fIboolean\fR" 4 |
686 |
.IX Item "scrollBar: boolean" |
687 |
\&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR: |
688 |
disable the scrollbar; option \fB+sb\fR. |
689 |
.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4 |
690 |
.IX Item "scrollBar_right: boolean" |
691 |
\&\fBTrue\fR: place the scrollbar on the right of the window; option \fB\-sr\fR. |
692 |
\&\fBFalse\fR: place the scrollbar on the left of the window; option \fB+sr\fR. |
693 |
.IP "\fBscrollBar_floating:\fR \fIboolean\fR" 4 |
694 |
.IX Item "scrollBar_floating: boolean" |
695 |
\&\fBTrue\fR: display an rxvt scrollbar without a trough; option \fB\-st\fR. |
696 |
\&\fBFalse\fR: display an rxvt scrollbar with a trough; option \fB+st\fR. |
697 |
.IP "\fBscrollBar_align:\fR \fImode\fR" 4 |
698 |
.IX Item "scrollBar_align: mode" |
699 |
Align the \fBtop\fR, \fBbottom\fR or \fBcentre\fR [default] of the scrollbar |
700 |
thumb with the pointer on middle button press/drag. |
701 |
.IP "\fBscrollTtyOutput:\fR \fIboolean\fR" 4 |
702 |
.IX Item "scrollTtyOutput: boolean" |
703 |
\&\fBTrue\fR: scroll to bottom when tty receives output; option \fB\-si\fR. |
704 |
\&\fBFalse\fR: do not scroll to bottom when tty receives output; option |
705 |
\&\fB+si\fR. |
706 |
.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4 |
707 |
.IX Item "scrollWithBuffer: boolean" |
708 |
\&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and |
709 |
\&\fBscrollTtyOutput\fR is False); option \fB+sw\fR. \fBFalse\fR: do not scroll |
710 |
with scrollback buffer when tty recieves new lines; option \fB\-sw\fR. |
711 |
.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4 |
712 |
.IX Item "scrollTtyKeypress: boolean" |
713 |
\&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys |
714 |
are those which are intercepted by rxvt-unicode for special handling and |
715 |
are not passed onto the shell; option \fB\-sk\fR. \fBFalse\fR: do not scroll to |
716 |
bottom when a non-special key is pressed; option \fB+sk\fR. |
717 |
.IP "\fBsaveLines:\fR \fInumber\fR" 4 |
718 |
.IX Item "saveLines: number" |
719 |
Save \fInumber\fR lines in the scrollback buffer [default 64]. This |
720 |
resource is limited on most machines to 65535; option \fB\-sl\fR. |
721 |
.IP "\fBinternalBorder:\fR \fInumber\fR" 4 |
722 |
.IX Item "internalBorder: number" |
723 |
Internal border of \fInumber\fR pixels. This resource is limited to 100; |
724 |
option \fB\-b\fR. |
725 |
.IP "\fBexternalBorder:\fR \fInumber\fR" 4 |
726 |
.IX Item "externalBorder: number" |
727 |
External border of \fInumber\fR pixels. This resource is limited to 100; |
728 |
option \fB\-w\fR, \fB\-bw\fR, \fB\-borderwidth\fR. |
729 |
.IP "\fBborderLess:\fR \fIboolean\fR" 4 |
730 |
.IX Item "borderLess: boolean" |
731 |
Set \s-1MWM\s0 hints to request a borderless window, i.e. if honoured by the |
732 |
\&\s-1WM\s0, the rxvt-unicode window will not have window decorations; option \fB\-bl\fR. |
733 |
.IP "\fBtermName:\fR \fItermname\fR" 4 |
734 |
.IX Item "termName: termname" |
735 |
Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment |
736 |
variable; option \fB\-tn\fR. |
737 |
.IP "\fBlinespace:\fR \fInumber\fR" 4 |
738 |
.IX Item "linespace: number" |
739 |
Specifies number of lines (pixel height) to insert between each row of |
740 |
the display [default 0]; option \fB\-lsp\fR. |
741 |
.IP "\fBmeta8:\fR \fIboolean\fR" 4 |
742 |
.IX Item "meta8: boolean" |
743 |
\&\fBTrue\fR: handle Meta (Alt) + keypress to set the 8th bit. \fBFalse\fR: |
744 |
handle Meta (Alt) + keypress as an escape prefix [default]. |
745 |
.IP "\fBmouseWheelScrollPage:\fR \fIboolean\fR" 4 |
746 |
.IX Item "mouseWheelScrollPage: boolean" |
747 |
\&\fBTrue\fR: the mouse wheel scrolls a page full. \fBFalse\fR: the mouse wheel |
748 |
scrolls five lines [default]. |
749 |
.IP "\fBpastableTabs:\fR \fIboolean\fR" 4 |
750 |
.IX Item "pastableTabs: boolean" |
751 |
\&\fBTrue\fR: store tabs as wide characters. \fBFalse\fR: interpret tabs as cursor |
752 |
movement only; option \f(CW\*(C`\-ptab\*(C'\fR. |
753 |
.IP "\fBcursorBlink:\fR \fIboolean\fR" 4 |
754 |
.IX Item "cursorBlink: boolean" |
755 |
\&\fBTrue\fR: blink the cursor. \fBFalse\fR: do not blink the cursor [default]; |
756 |
option \fB\-bc\fR. |
757 |
.IP "\fBpointerBlank:\fR \fIboolean\fR" 4 |
758 |
.IX Item "pointerBlank: boolean" |
759 |
\&\fBTrue\fR: blank the pointer when a key is pressed or after a set number |
760 |
of seconds of inactivity. \fBFalse\fR: the pointer is always visible |
761 |
[default]. |
762 |
.IP "\fBpointerColor:\fR \fIcolour\fR" 4 |
763 |
.IX Item "pointerColor: colour" |
764 |
Mouse pointer foreground colour. |
765 |
.IP "\fBpointerColor2:\fR \fIcolour\fR" 4 |
766 |
.IX Item "pointerColor2: colour" |
767 |
Mouse pointer background colour. |
768 |
.IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4 |
769 |
.IX Item "pointerBlankDelay: number" |
770 |
Specifies number of seconds before blanking the pointer [default 2]. |
771 |
.IP "\fBbackspacekey:\fR \fIstring\fR" 4 |
772 |
.IX Item "backspacekey: string" |
773 |
The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR |
774 |
or unset it will send \fBDelete\fR (code 127) or, if shifted, \fBBackspace\fR |
775 |
(code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode |
776 |
escape sequence. |
777 |
.IP "\fBdeletekey:\fR \fIstring\fR" 4 |
778 |
.IX Item "deletekey: string" |
779 |
The string to send when the delete key (not the keypad delete key) is |
780 |
pressed. If unset it will send the sequence traditionally associated |
781 |
with the \fBExecute\fR key. |
782 |
.IP "\fBcutchars:\fR \fIstring\fR" 4 |
783 |
.IX Item "cutchars: string" |
784 |
The characters used as delimiters for double-click word selection. The |
785 |
built-in default: |
786 |
.Sp |
787 |
\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]{|}\fR |
788 |
.IP "\fBpreeditType:\fR \fIstyle\fR" 4 |
789 |
.IX Item "preeditType: style" |
790 |
\&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR. |
791 |
.IP "\fBinputMethod:\fR \fIname\fR" 4 |
792 |
.IX Item "inputMethod: name" |
793 |
\&\fIname\fR of inputMethod to use; option \fB\-im\fR. |
794 |
.IP "\fBimLocale:\fR \fIname\fR" 4 |
795 |
.IX Item "imLocale: name" |
796 |
The locale to use for opening the \s-1IM\s0. You can use an \s-1LC_CTYPE\s0 of e.g. |
797 |
de_DE.UTF\-8 for normal text processing but ja_JP.EUC\-JP for the input |
798 |
extension to be able to input japanese characters while staying in |
799 |
another locale. option \fB\-imlocale\fR. |
800 |
.IP "\fBinsecure:\fR \fIboolean\fR" 4 |
801 |
.IX Item "insecure: boolean" |
802 |
Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that |
803 |
echo arbitrary strings like the icon name or the locale. This could be |
804 |
abused if somebody gets 8\-bit\-clean access to your display, whether |
805 |
throuh a mail client displaying mail bodies unfiltered or though |
806 |
\&\fIwrite\fR\|(1). Therefore, these sequences are disabled by default. (Note |
807 |
that other terminals, including xterm, have these sequences |
808 |
enabled by default). You can enable them by setting this boolean |
809 |
resource or specifying \fB\-insecure\fR as an option. At the moment, this |
810 |
enabled display\-answer, locale, findfont, icon label and window title |
811 |
requests as well as dynamic menubar dispatch. |
812 |
.IP "\fBmodifier:\fR \fImodifier\fR" 4 |
813 |
.IX Item "modifier: modifier" |
814 |
Set the key to be interpreted as the Meta key to: \fBalt\fR, \fBmeta\fR, |
815 |
\&\fBhyper\fR, \fBsuper\fR, \fBmod1\fR, \fBmod2\fR, \fBmod3\fR, \fBmod4\fR, \fBmod5\fR; option |
816 |
\&\fB\-mod\fR. |
817 |
.IP "\fBanswerbackString:\fR \fIstring\fR" 4 |
818 |
.IX Item "answerbackString: string" |
819 |
Specify the reply rxvt-unicode sends to the shell when an \s-1ENQ\s0 (control\-E) |
820 |
character is passed through. It may contain escape values as described |
821 |
in the entry on \fBkeysym\fR following. |
822 |
.IP "\fBsecondaryScreen:\fR \fIbool\fR" 4 |
823 |
.IX Item "secondaryScreen: bool" |
824 |
Turn on/off secondary screen (default enabled). |
825 |
.IP "\fBsecondaryScroll:\fR \fIbool\fR" 4 |
826 |
.IX Item "secondaryScroll: bool" |
827 |
Turn on/off secondary screen scroll (default enabled). If the this |
828 |
option is enabled, scrolls on the secondary screen will change the |
829 |
scrollback buffer and switching to/from the secondary screen will |
830 |
instead scroll the screen up. |
831 |
.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4 |
832 |
.IX Item "keysym.sym: string" |
833 |
Associate \fIstring\fR with keysym \fIsym\fR (\fB0xFF00 \- 0xFFFF\fR). It may |
834 |
contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, \en: |
835 |
newline, \er: return, \et: |
836 |
tab, \e000: octal number) or control characters (^?: delete, ^@: null, |
837 |
^A ...) and may enclosed with double quotes so that it can start or end |
838 |
with whitespace. The intervening resource name \fBkeysym.\fR cannot be |
839 |
omitted. This resource is only available when compiled with |
840 |
\&\s-1KEYSYM_RESOURCE\s0. |
841 |
.SH "THE SCROLLBAR" |
842 |
.IX Header "THE SCROLLBAR" |
843 |
Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window |
844 |
(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar |
845 |
or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and |
846 |
its behaviour is fairly intuitive. The \fBxterm-scrollbar\fR is without |
847 |
arrows and its behaviour mimics that of \fIxterm\fR |
848 |
.PP |
849 |
Scroll down with \fBButton1\fR (\fBxterm-scrollbar\fR) or \fBShift-Next\fR. |
850 |
Scroll up with \fBButton3\fR (\fBxterm-scrollbar\fR) or \fBShift-Prior\fR. |
851 |
Continuous scroll with \fBButton2\fR. |
852 |
.SH "MOUSE REPORTING" |
853 |
.IX Header "MOUSE REPORTING" |
854 |
To temporarily override mouse reporting, for either the scrollbar or |
855 |
the normal text selection/insertion, hold either the Shift or the Meta |
856 |
(Alt) key while performing the desired mouse action. |
857 |
.PP |
858 |
If mouse reporting mode is active, the normal scrollbar actions are |
859 |
disabled \*(-- on the assumption that we are using a fullscreen |
860 |
application. Instead, pressing Button1 and Button3 sends \fBESC[6~\fR |
861 |
(Next) and \fBESC[5~\fR (Prior), respectively. Similarly, clicking on the |
862 |
up and down arrows sends \fBESC[A\fR (Up) and \fBESC[B\fR (Down), |
863 |
respectively. |
864 |
.SH "TEXT SELECTION AND INSERTION" |
865 |
.IX Header "TEXT SELECTION AND INSERTION" |
866 |
The behaviour of text selection and insertion mechanism is similar to |
867 |
\&\fIxterm\fR(1). |
868 |
.IP "\fBSelection\fR:" 4 |
869 |
.IX Item "Selection:" |
870 |
Left click at the beginning of the region, drag to the end of the |
871 |
region and release; Right click to extend the marked region; Left |
872 |
double-click to select a word; Left triple-click to select the entire |
873 |
line. |
874 |
.Sp |
875 |
Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys) |
876 |
(Compile: frills) will create a rectangular selection instead of a normal |
877 |
one. |
878 |
.IP "\fBInsertion\fR:" 4 |
879 |
.IX Item "Insertion:" |
880 |
Pressing and releasing the Middle mouse button (or \fBShift-Insert\fR) in |
881 |
an \fB@@RXVT_NAME@@\fR window causes the current text selection to be |
882 |
inserted as if it had been typed on the keyboard. |
883 |
.SH "CHANGING FONTS" |
884 |
.IX Header "CHANGING FONTS" |
885 |
Changing fonts (or font sizes, respectively) via the keypad is not yet |
886 |
supported in rxvt\-unicode. Bug me if you need this. |
887 |
.PP |
888 |
You can, however, switch fonts at runtime using escape sequences (and |
889 |
therefore using the menubar), e.g.: |
890 |
.PP |
891 |
.Vb 1 |
892 |
\& printf '\ee]701;%s\e007' "9x15bold,xft:Kochi Gothic" |
893 |
.Ve |
894 |
.PP |
895 |
rxvt-unicode will automatically re-apply these fonts to the output so far. |
896 |
.SH "ISO 14755 SUPPORT" |
897 |
.IX Header "ISO 14755 SUPPORT" |
898 |
\&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters |
899 |
and character codes using the keyboard. It consists of 4 parts. The |
900 |
first part is available rxvt-unicode has been compiled with |
901 |
\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled |
902 |
with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR. |
903 |
.IP "5.1: Basic method" 4 |
904 |
.IX Item "5.1: Basic method" |
905 |
This allows you to enter unicode characters using their hexcode. |
906 |
.Sp |
907 |
Start by pressing and holding both \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, then enter |
908 |
hex-digits (between one and six). Releasing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR will |
909 |
commit the character as if it were typed directly. While holding down |
910 |
\&\f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR you can also enter multiple characters by pressing |
911 |
\&\f(CW\*(C`Space\*(C'\fR, which will commit the current character and lets you start a new |
912 |
one. |
913 |
.Sp |
914 |
As an example of use, imagine a business card with a japanese e\-mail |
915 |
address, which you cannot type. Fortunately, the card has the e\-mail |
916 |
address printed as hexcodes, e.g. \f(CW\*(C`671d 65e5\*(C'\fR. You can enter this easily |
917 |
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, |
918 |
followed by releasing the modifier keys. |
919 |
.IP "5.2: Keyboard symbols entry method" 4 |
920 |
.IX Item "5.2: Keyboard symbols entry method" |
921 |
This mode lets you input characters representing the keycap symbols of |
922 |
your keyboard, if representable in the current locale encoding. |
923 |
.Sp |
924 |
Start by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then releasing |
925 |
them. The next special key (cursor keys, home etc.) you enter will not |
926 |
invoke it's usual function but instead will insert the corresponding |
927 |
keycap symbol. The symbol will only be entered when the key has been |
928 |
released, otherwise pressing e.g. \f(CW\*(C`Shift\*(C'\fR would enter the symbol for |
929 |
\&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a |
930 |
reverse tab (Shift\-Tab). |
931 |
.IP "5.3: Screen-selection entry method" 4 |
932 |
.IX Item "5.3: Screen-selection entry method" |
933 |
While this is implemented already (it's basically the selection |
934 |
mechanism), it could be extended by displaying a unicode character map. |
935 |
.IP "5.4: Feedback method for identifying displayed characters for later input" 4 |
936 |
.IX Item "5.4: Feedback method for identifying displayed characters for later input" |
937 |
This method lets you display the unicode character code associated with |
938 |
characters already displayed. |
939 |
.Sp |
940 |
You enter this mode by holding down \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then |
941 |
pressing and holding the left mouse button and moving around. The unicode |
942 |
hex code(s) (it might be a combining character) of the character under the |
943 |
pointer is displayed until you release \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR. |
944 |
.Sp |
945 |
In addition to the hex codes it will display the font used to draw this |
946 |
character \- due to implementation reasons, characters combined with |
947 |
combining characters, line drawing characters and unknown characters will |
948 |
always be drawn using the built-in support font. |
949 |
.PP |
950 |
With respect to conformance, rxvt-unicode is supposed to be compliant to |
951 |
both scenario A and B of \s-1ISO\s0 14755, including part 5.2. |
952 |
.SH "LOGIN STAMP" |
953 |
.IX Header "LOGIN STAMP" |
954 |
\&\fB@@RXVT_NAME@@\fR tries to write an entry into the \fIutmp\fR(5) file so |
955 |
that it can be seen via the \fI\fIwho\fI\|(1)\fR command, and can accept messages. |
956 |
To allow this feature, \fB@@RXVT_NAME@@\fR must be installed setuid root on |
957 |
some systems. |
958 |
.SH "COLORS AND GRAPHICS" |
959 |
.IX Header "COLORS AND GRAPHICS" |
960 |
In addition to the default foreground and background colours, |
961 |
\&\fB@@RXVT_NAME@@\fR can display up to 16 colours (8 \s-1ANSI\s0 colours plus |
962 |
high-intensity bold/blink versions of the same). Here is a list of the |
963 |
colours with their \fBrgb.txt\fR names. |
964 |
.TS |
965 |
l l l . |
966 |
color0 (black) = Black |
967 |
color1 (red) = Red3 |
968 |
color2 (green) = Green3 |
969 |
color3 (yellow) = Yellow3 |
970 |
color4 (blue) = Blue3 |
971 |
color5 (magenta) = Magenta3 |
972 |
color6 (cyan) = Cyan3 |
973 |
color7 (white) = AntiqueWhite |
974 |
color8 (bright black) = Grey25 |
975 |
color9 (bright red) = Red |
976 |
color10 (bright green) = Green |
977 |
color11 (bright yellow) = Yellow |
978 |
color12 (bright blue) = Blue |
979 |
color13 (bright magenta) = Magenta |
980 |
color14 (bright cyan) = Cyan |
981 |
color15 (bright white) = White |
982 |
foreground = Black |
983 |
background = White |
984 |
.TE |
985 |
|
986 |
.PP |
987 |
It is also possible to specify the colour values of \fBforeground\fR, |
988 |
\&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as |
989 |
a number 0\-15, as a convenient shorthand to reference the colour name of |
990 |
color0\-color15. |
991 |
.PP |
992 |
Note that \fB\-rv\fR (\fB\*(L"reverseVideo: True\*(R"\fR) simulates reverse video by |
993 |
always swapping the foreground/background colours. This is in contrast to |
994 |
\&\fIxterm\fR(1) where the colours are only swapped if they have not otherwise |
995 |
been specified. For example, |
996 |
.IP "\fB@@RXVT_NAME@@ \-fg Black \-bg White \-rv\fR" 4 |
997 |
.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv" |
998 |
would yield White on Black, while on \fIxterm\fR(1) it would yield Black |
999 |
on White. |
1000 |
.SH "ENVIRONMENT" |
1001 |
.IX Header "ENVIRONMENT" |
1002 |
\&\fB@@RXVT_NAME@@\fR sets the environment variables \fB\s-1TERM\s0\fR, \fB\s-1COLORTERM\s0\fR |
1003 |
and \fB\s-1COLORFGBG\s0\fR. The environment variable \fB\s-1WINDOWID\s0\fR is set to the X |
1004 |
window id number of the \fB@@RXVT_NAME@@\fR window and it also uses and |
1005 |
sets the environment variable \fB\s-1DISPLAY\s0\fR to specify which display |
1006 |
terminal to use. \fB@@RXVT_NAME@@\fR uses the environment variables |
1007 |
\&\fB\s-1RXVTPATH\s0\fR and \fB\s-1PATH\s0\fR to find \s-1XPM\s0 files. |
1008 |
.SH "FILES" |
1009 |
.IX Header "FILES" |
1010 |
.IP "\fB/etc/utmp\fR" 4 |
1011 |
.IX Item "/etc/utmp" |
1012 |
System file for login records. |
1013 |
.IP "\fB/usr/lib/X11/rgb.txt\fR" 4 |
1014 |
.IX Item "/usr/lib/X11/rgb.txt" |
1015 |
Color names. |
1016 |
.SH "SEE ALSO" |
1017 |
.IX Header "SEE ALSO" |
1018 |
@@RXVT_NAME@@(7), \fIxterm\fR\|(1), \fIsh\fR\|(1), \fIresize\fR\|(1), X(1), \fIpty\fR\|(4), \fItty\fR\|(4), \fIutmp\fR\|(5) |
1019 |
.SH "BUGS" |
1020 |
.IX Header "BUGS" |
1021 |
Check the \s-1BUGS\s0 file for an up-to-date list. |
1022 |
.PP |
1023 |
Cursor change support is not yet implemented. |
1024 |
.PP |
1025 |
Click-and-drag doesn't work with X11 mouse report overriding. |
1026 |
.SH "CURRENT PROJECT COORDINATOR" |
1027 |
.IX Header "CURRENT PROJECT COORDINATOR" |
1028 |
.IP "Project Coordinator" 4 |
1029 |
.IX Item "Project Coordinator" |
1030 |
@@RXVT_MAINT@@ @@RXVT_MAINTEMAIL@@ |
1031 |
.IP "Web page maintainter" 4 |
1032 |
.IX Item "Web page maintainter" |
1033 |
@@RXVT_WEBMAINT@@ @@RXVT_WEBMAINTEMAIL@@ |
1034 |
.Sp |
1035 |
@@RXVT_WEBPAGE@@ |
1036 |
.SH "AUTHORS" |
1037 |
.IX Header "AUTHORS" |
1038 |
.IP "John Bovey" 4 |
1039 |
.IX Item "John Bovey" |
1040 |
University of Kent, 1992, wrote the original Xvt. |
1041 |
.IP "Rob Nation <nation@rocket.sanders.lockheed.com>" 4 |
1042 |
.IX Item "Rob Nation <nation@rocket.sanders.lockheed.com>" |
1043 |
very heavily modified Xvt and came up with Rxvt |
1044 |
.IP "Angelo Haritsis <ah@doc.ic.ac.uk>" 4 |
1045 |
.IX Item "Angelo Haritsis <ah@doc.ic.ac.uk>" |
1046 |
wrote the Greek Keyboard Input (no longer in code) |
1047 |
.IP "mj olesen <olesen@me.QueensU.CA>" 4 |
1048 |
.IX Item "mj olesen <olesen@me.QueensU.CA>" |
1049 |
Wrote the menu system. |
1050 |
.Sp |
1051 |
Project Coordinator (changes.txt 2.11 to 2.21) |
1052 |
.IP "Oezguer Kesim <kesim@math.fu\-berlin.de>" 4 |
1053 |
.IX Item "Oezguer Kesim <kesim@math.fu-berlin.de>" |
1054 |
Project Coordinator (changes.txt 2.21a to 2.4.5) |
1055 |
.IP "Geoff Wing <gcw@pobox.com>" 4 |
1056 |
.IX Item "Geoff Wing <gcw@pobox.com>" |
1057 |
Rewrote screen display and text selection routines. Project Coordinator |
1058 |
(changes.txt 2.4.6 \- rxvt\-unicode) |
1059 |
.IP "Marc Alexander Lehmann <rxvt@schmorp.de>" 4 |
1060 |
.IX Item "Marc Alexander Lehmann <rxvt@schmorp.de>" |
1061 |
Forked rxvt\-unicode, rewrote most of the display code and internal |
1062 |
character handling to store text in unicode, improve xterm |
1063 |
compatibility and apply numerous other bugfixes and extensions. |
1064 |
.Sp |
1065 |
Project Coordinator (Changes 1.0 \-) |