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