| 1 |
.TH "RXVT" "1" "2004-07-26" "X Version 11" "X Tools" |
| 2 |
.SH "NAME" |
| 3 |
rxvt-unicode (ouR XVT, unicode) \- a VT102 emulator for the X window system |
| 4 |
.PP |
| 5 |
.SH "SYNOPSIS" |
| 6 |
.PP |
| 7 |
\fBrxvt\fP [options] [-e command [ args ]] |
| 8 |
.PP |
| 9 |
.SH "DESCRIPTION" |
| 10 |
.PP |
| 11 |
\fBrxvt-unicode\fP, version \fB3\&.3\fP, is a colour vt102 terminal emulator |
| 12 |
intended as an \fIxterm\fP(1) replacement for users who do not require |
| 13 |
features such as Tektronix 4014 emulation and toolkit-style configurability\&. |
| 14 |
As a result, \fBrxvt-unicode\fP uses much less swap space -- a significant |
| 15 |
advantage on a machine serving many X sessions\&. |
| 16 |
.PP |
| 17 |
.PP |
| 18 |
.SH "OPTIONS" |
| 19 |
.PP |
| 20 |
The \fBrxvt\fP options (mostly a subset of \fIxterm\fP\&'s) are listed below\&. |
| 21 |
In keeping with the smaller-is-better philosophy, options may be eliminated |
| 22 |
or default values chosen at compile-time, so options and defaults listed |
| 23 |
may not accurately reflect the version installed on your system\&. |
| 24 |
`rxvt -h\&' gives a list of major compile-time options on the \fIOptions\fP line\&. |
| 25 |
Option descriptions may be prefixed with which compile option each is |
| 26 |
dependent upon\&. e\&.g\&. `Compile \fIXIM\fP:\&' requires \fIXIM\fP on the \fIOptions\fP |
| 27 |
line\&. Note: `rxvt -help\&' gives a list of all command-line options compiled |
| 28 |
into your version\&. |
| 29 |
.PP |
| 30 |
Note that \fBrxvt\fP permits the resource name to be used as a long-option |
| 31 |
(--/++ option) so the potential command-line options are far greater than |
| 32 |
those listed\&. |
| 33 |
For example: `rxvt --loginShell --color1 Orange\&'\&. |
| 34 |
.PP |
| 35 |
The following options are available: |
| 36 |
.PP |
| 37 |
.IP "\fB-help\fP, \fB--help\fP" |
| 38 |
Print out a message describing available options\&. |
| 39 |
.IP "\fB-display\fP \fIdisplayname\fP" |
| 40 |
Attempt to open a window on the named X display (\fB-d\fP still |
| 41 |
respected)\&. In the absence of this option, the display specified |
| 42 |
by the \fBDISPLAY\fP environment variable is used\&. |
| 43 |
.IP "\fB-geometry\fP \fIgeom\fP" |
| 44 |
Window geometry (\fB-g\fP still respected); |
| 45 |
resource \fBgeometry\fP\&. |
| 46 |
.IP "\fB-rv\fP|\fB+rv\fP" |
| 47 |
Turn on/off simulated reverse video; |
| 48 |
resource \fBreverseVideo\fP\&. |
| 49 |
.IP "\fB-j\fP|\fB+j\fP" |
| 50 |
Turn on/off jump scrolling; |
| 51 |
resource \fBjumpScroll\fP\&. |
| 52 |
.IP "\fB-ip\fP|\fB+ip\fP" |
| 53 |
Turn on/off inheriting parent window\&'s pixmap\&. Alternative form |
| 54 |
is \fB-tr\fP; |
| 55 |
resource \fBinheritPixmap\fP\&. |
| 56 |
.IP "\fB-tint\fP \fIcolour\fP" |
| 57 |
Tint the transparent background pixmap with the given colour\&. |
| 58 |
.IP "\fB-bg\fP \fIcolour\fP" |
| 59 |
Window background colour; |
| 60 |
resource \fBbackground\fP\&. |
| 61 |
.IP "\fB-fg\fP \fIcolour\fP" |
| 62 |
Window foreground colour; |
| 63 |
resource \fBforeground\fP\&. |
| 64 |
.IP "\fB-pixmap:\fP \fIfile[;geom]\fP" |
| 65 |
Compile \fIXPM\fP: Specify XPM file for the background and also |
| 66 |
optionally specify its scaling with a geometry string\&. Note you |
| 67 |
may need to add quotes to avoid special shell interpretation of |
| 68 |
the `;\&' in the command-line; |
| 69 |
resource \fBbackgroundPixmap\fP\&. |
| 70 |
.IP "\fB-cr\fP \fIcolour\fP" |
| 71 |
The cursor colour; |
| 72 |
resource \fBcursorColor\fP\&. |
| 73 |
.IP "\fB-pr\fP \fIcolour\fP" |
| 74 |
The mouse pointer foreground colour; |
| 75 |
resource \fBpointerColor\fP\&. |
| 76 |
.IP "\fB-pr2\fP \fIcolour\fP" |
| 77 |
The mouse pointer background colour; |
| 78 |
resource \fBpointerColor2\fP\&. |
| 79 |
.IP "\fB-bd\fP \fIcolour\fP" |
| 80 |
The colour of the border between the xterm scrollbar and the text; |
| 81 |
resource \fBborderColor\fP\&. |
| 82 |
.IP "\fB-fn\fP \fIfontname\fP" |
| 83 |
Select the fonts to be used\&. |
| 84 |
This is a comma seperated list of font names that are used in turn when |
| 85 |
trying to display Unicode characters\&. |
| 86 |
The first font defines the cell size for characters; other fonts might |
| 87 |
be smaller, but not larger\&. |
| 88 |
A reasonable default font list is always appended to it\&. |
| 89 |
resource \fBfont\fP\&. |
| 90 |
.IP "\fB-rb\fP|\fB+rb\fP" |
| 91 |
Enable "real bold" support\&. |
| 92 |
When this option is on, bold text will be displayed using the first |
| 93 |
available bold font in the font list\&. |
| 94 |
Bold fonts should thus be specified in the font list after their |
| 95 |
corresponding regular fonts\&. |
| 96 |
If no bold font can be found, a regular font will be used\&. |
| 97 |
resource \fBrealBold\fP\&. |
| 98 |
.IP "\fB-name\fP \fIname\fP" |
| 99 |
Specify the application name under which resources |
| 100 |
are to be obtained, rather than the default executable file name\&. |
| 101 |
Name should not contain `\&.\&' or `*\&' characters\&. |
| 102 |
Also sets the icon and title name\&. |
| 103 |
.IP "\fB-ls\fP|\fB+ls\fP" |
| 104 |
Start as a login-shell/sub-shell; |
| 105 |
resource \fBloginShell\fP\&. |
| 106 |
.IP "\fB-ut\fP|\fB+ut\fP" |
| 107 |
Compile \fIutmp\fP: Inhibit/enable writing a utmp entry; |
| 108 |
resource \fButmpInhibit\fP\&. |
| 109 |
.IP "\fB-vb\fP|\fB+vb\fP" |
| 110 |
Turn on/off visual bell on receipt of a bell character; |
| 111 |
resource \fBvisualBell\fP\&. |
| 112 |
.IP "\fB-sb\fP|\fB+sb\fP" |
| 113 |
Turn on/off scrollbar; |
| 114 |
resource \fBscrollBar\fP\&. |
| 115 |
.IP "\fB-si\fP|\fB+si\fP" |
| 116 |
Turn on/off scroll-to-bottom on TTY output inhibit; |
| 117 |
resource \fBscrollTtyOutput\fP has opposite effect\&. |
| 118 |
.IP "\fB-sk\fP|\fB+sk\fP" |
| 119 |
Turn on/off scroll-to-bottom on keypress; |
| 120 |
resource \fBscrollTtyKeypress\fP\&. |
| 121 |
.IP "\fB-sw\fP|\fB+sw\fP" |
| 122 |
Turn on/off scrolling with the scrollback buffer as new |
| 123 |
lines appear\&. This only takes effect if \fB-si\fP is also given; |
| 124 |
resource \fBscrollWithBuffer\fP\&. |
| 125 |
.IP "\fB-sr\fP|\fB+sr\fP" |
| 126 |
Put scrollbar on right/left; |
| 127 |
resource \fBscrollBar_right\fP\&. |
| 128 |
.IP "\fB-st\fP|\fB+st\fP" |
| 129 |
Display normal (non XTerm/NeXT) scrollbar without/with a trough; |
| 130 |
resource \fBscrollBar_floating\fP\&. |
| 131 |
.IP "\fB-bc\fP|\fB+bc\fP" |
| 132 |
Blink the cursor; resource \fBcursorBlink\fP\&. |
| 133 |
.IP "\fB-iconic\fP" |
| 134 |
Start iconified, if the window manager supports that option\&. |
| 135 |
Alternative form is \fB-ic\fP\&. |
| 136 |
.IP "\fB-sl\fP \fInumber\fP" |
| 137 |
Save \fInumber\fP lines in the scrollback buffer\&. See resource entry |
| 138 |
for limits; |
| 139 |
resource \fBsaveLines\fP\&. |
| 140 |
.IP "\fB-b\fP \fInumber\fP" |
| 141 |
Compile \fIfrills\fP: Internal border of \fInumber\fP pixels\&. See |
| 142 |
resource entry for limits; |
| 143 |
resource \fBinternalBorder\fP\&. |
| 144 |
.IP "\fB-w\fP \fInumber\fP" |
| 145 |
Compile \fIfrills\fP: External border of \fInumber\fP pixels\&. |
| 146 |
Also, \fB-bw\fP and \fB-borderwidth\fP\&. See resource entry for limits; |
| 147 |
resource \fBexternalBorder\fP\&. |
| 148 |
.IP "\fB-lsp\fP \fInumber\fP" |
| 149 |
Compile \fIlinespace\fP: Lines (pixel height) to insert between each |
| 150 |
row of the display; |
| 151 |
resource \fBlinespace\fP\&. |
| 152 |
.IP "\fB-tn\fP \fItermname\fP" |
| 153 |
This option specifies the name of the terminal type to be set in the |
| 154 |
\fBTERM\fP environment variable\&. This terminal type must exist in the |
| 155 |
\fItermcap(5)\fP database and should have \fIli#\fP and \fIco#\fP entries; |
| 156 |
resource \fBtermName\fP\&. |
| 157 |
.IP "\fB-e\fP \fIcommand [arguments]\fP" |
| 158 |
Run the command with its command-line arguments in the \fBrxvt\fP |
| 159 |
window; also sets the window title and icon name to be the basename |
| 160 |
of the program being executed if neither \fI-title\fP (\fI-T\fP) nor |
| 161 |
\fI-n\fP are given on the command line\&. If this option is used, it |
| 162 |
must be the last on the command-line\&. If there is no \fB-e\fP option |
| 163 |
then the default is to run the program specified by the \fBSHELL\fP |
| 164 |
environment variable or, failing that, \fIsh(1)\fP\&. |
| 165 |
.IP "\fB-title\fP \fItext\fP" |
| 166 |
Window title (\fB-T\fP still respected); the default title is the |
| 167 |
basename of the program specified after the \fB-e\fP option, if |
| 168 |
any, otherwise the application name; |
| 169 |
resource \fBtitle\fP\&. |
| 170 |
.IP "\fB-n\fP \fItext\fP" |
| 171 |
Icon name; the default name is the basename of the program specified |
| 172 |
after the \fB-e\fP option, if any, otherwise the application name; |
| 173 |
resource \fBiconName\fP\&. |
| 174 |
.IP "\fB-C\fP" |
| 175 |
Capture system console messages\&. |
| 176 |
.IP "\fB-pt\fP \fIstyle\fP" |
| 177 |
Compile \fIXIM\fP: input style for input method; |
| 178 |
\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP; |
| 179 |
resource \fBpreeditType\fP\&. |
| 180 |
.IP "\fB-im\fP \fItext\fP" |
| 181 |
Compile \fIXIM\fP: input method name\&. |
| 182 |
resource \fBinputMethod\fP\&. |
| 183 |
.IP "\fB-imlocale\fP \fIstring\fP" |
| 184 |
The locale to use for opening the IM\&. You can use an LC_CTYPE |
| 185 |
of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP |
| 186 |
for the input extension to be able to input japanese characters |
| 187 |
while staying in another locale\&. |
| 188 |
.IP "\fB-insecure\fP" |
| 189 |
Enable "insecure" mode, which currently enables most of the escape |
| 190 |
sequences that echo strings\&. See the resource \fBinsecure\fP for |
| 191 |
more info\&. |
| 192 |
.IP "\fB-mod\fP \fImodifier\fP" |
| 193 |
Override detection of Meta modifier with specified key: |
| 194 |
\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, |
| 195 |
\fBmod4\fP, \fBmod5\fP; |
| 196 |
resource \fImodifier\fP\&. |
| 197 |
.IP "\fB-ssc\fP|\fB+ssc\fP" |
| 198 |
Turn on/off secondary screen (default enabled); |
| 199 |
resource \fBsecondaryScreen\fP\&. |
| 200 |
.IP "\fB-ssr\fP|\fB+ssr\fP" |
| 201 |
Turn on/off secondary screen scroll (default enabled); |
| 202 |
resource \fBsecondaryScroll\fP\&. |
| 203 |
.IP "\fB-xrm\fP \fIresourcestring\fP" |
| 204 |
No effect on rxvt\&. Simply passes through an argument to be made |
| 205 |
available in the instance\&'s argument list\&. Appears in \fIWM_COMMAND\fP |
| 206 |
in some window managers\&. |
| 207 |
.SH "RESOURCES (available also as long-options)" |
| 208 |
.PP |
| 209 |
Note: `rxvt --help\&' gives a list of all resources (long options) compiled |
| 210 |
into your version\&. |
| 211 |
If compiled with internal Xresources support (i\&.e\&. \fBrxvt -h\fP lists |
| 212 |
\fB\&.Xdefaults\fP) then \fBrxvt\fP accepts application defaults set in |
| 213 |
XAPPLOADDIR/Rxvt (compile-time defined: usually |
| 214 |
\fB/usr/lib/X11/app-defaults/Rxvt\fP) and resources set in \fB~/\&.Xdefaults\fP, |
| 215 |
or \fB~/\&.Xresources\fP if \fB~/\&.Xdefaults\fP does not exist\&. Note that when |
| 216 |
reading X resources, \fBrxvt\fP recognizes two class names: \fBXTerm\fP and |
| 217 |
\fBRxvt\fP\&. The class name \fBXTerm\fP allows resources common to both |
| 218 |
\fBrxvt\fP and \fIxterm\fP to be easily configured, while the class name |
| 219 |
\fBRxvt\fP allows resources unique to \fBrxvt\fP, notably colours and |
| 220 |
key-handling, to be shared between different \fBrxvt\fP configurations\&. |
| 221 |
If no resources are specified, suitable defaults will be used\&. |
| 222 |
Command-line arguments can be used to override resource settings\&. The |
| 223 |
following resources are allowed: |
| 224 |
.PP |
| 225 |
.IP "\fBgeometry:\fP \fIgeom\fP" |
| 226 |
Create the window with the specified X window geometry [default |
| 227 |
80x24]; |
| 228 |
option \fB-geometry\fP\&. |
| 229 |
.IP "\fBbackground:\fP \fIcolour\fP" |
| 230 |
Use the specified colour as the window\&'s background colour [default |
| 231 |
White]; |
| 232 |
option \fB-bg\fP\&. |
| 233 |
.IP "\fBforeground:\fP \fIcolour\fP" |
| 234 |
Use the specified colour as the window\&'s foreground colour [default |
| 235 |
Black]; |
| 236 |
option \fB-fg\fP\&. |
| 237 |
.IP "\fBcolor\fP\fIn\fP\fB:\fP \fIcolour\fP" |
| 238 |
Use the specified colour for the colour value \fIn\fP, where 0-7 |
| 239 |
corresponds to low-intensity (normal) colours and 8-15 corresponds to |
| 240 |
high-intensity (bold = bright foreground, blink = bright |
| 241 |
background) colours\&. The canonical names are as follows: |
| 242 |
0=black, 1=red, 2=green, 3=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, |
| 243 |
but the actual colour names used are listed in the |
| 244 |
\fBCOLORS AND GRAPHICS\fP section\&. |
| 245 |
.IP "\fBcolorBD:\fP \fIcolour\fP" |
| 246 |
Use the specified colour to display bold characters when the |
| 247 |
foreground colour is the default\&. |
| 248 |
This option will be ignored if \fBrealBold\fP is enabled\&. |
| 249 |
.IP "\fBcolorUL:\fP \fIcolour\fP" |
| 250 |
Use the specified colour to display underlined characters when the |
| 251 |
foreground colour is the default\&. |
| 252 |
.IP "\fBcolorRV:\fP \fIcolour\fP" |
| 253 |
Use the specified colour as the background for reverse video |
| 254 |
characters\&. |
| 255 |
.IP "\fBcursorColor:\fP \fIcolour\fP" |
| 256 |
Use the specified colour for the cursor\&. The default is to use the |
| 257 |
foreground colour; |
| 258 |
option \fB-cr\fP\&. |
| 259 |
.IP "\fBcursorColor2:\fP \fIcolour\fP" |
| 260 |
Use the specified colour for the colour of the cursor text\&. For this |
| 261 |
to take effect, \fBcursorColor\fP must also be specified\&. The default |
| 262 |
is to use the background colour\&. |
| 263 |
.IP "\fBreverseVideo:\fP \fIboolean\fP" |
| 264 |
\fBTrue\fP: simulate reverse video by foreground and background colours; |
| 265 |
option \fB-rv\fP\&. |
| 266 |
\fBFalse\fP: regular screen colours [default]; |
| 267 |
option \fB+rv\fP\&. |
| 268 |
See note in \fBCOLORS AND GRAPHICS\fP section\&. |
| 269 |
.IP "\fBjumpScroll:\fP \fIboolean\fP" |
| 270 |
\fBTrue\fP: specify that jump scrolling should be used\&. When scrolling |
| 271 |
quickly, fewer screen updates are performed [default]; |
| 272 |
option \fB-j\fP\&. |
| 273 |
\fBFalse\fP: specify that smooth scrolling should be used; |
| 274 |
option \fB+j\fP\&. |
| 275 |
.IP "\fBinheritPixmap:\fP \fIboolean\fP" |
| 276 |
\fBTrue\fP: make the background inherit the parent windows\&' pixmap, |
| 277 |
giving artificial transparency\&. |
| 278 |
\fBFalse\fP: do not inherit the parent windows\&' pixmap\&. |
| 279 |
.IP "\fBtintColor:\fP \fIcolour\fP" |
| 280 |
Tint the transparent background pixmap with the given colour\&. |
| 281 |
.IP "\fBscrollColor:\fP \fIcolour\fP" |
| 282 |
Use the specified colour for the scrollbar [default #B2B2B2]\&. |
| 283 |
.IP "\fBtroughColor:\fP \fIcolour\fP" |
| 284 |
Use the specified colour for the scrollbar\&'s trough area [default |
| 285 |
#969696]\&. Only relevant for normal (non XTerm/NeXT) scrollbar\&. |
| 286 |
.IP "\fBbackgroundPixmap:\fP \fIfile[;geom]\fP" |
| 287 |
Use the specified XPM file (note the `\&.xpm\&' extension is optional) |
| 288 |
for the background and also optionally specify its scaling with a |
| 289 |
geometry string \fBWxH+X+Y\fP, in which \fB"W" / "H"\fP specify the |
| 290 |
horizontal/vertical scale (percent) and \fB"X" / "Y"\fP locate the |
| 291 |
image centre (percent)\&. A scale of 0 displays the image with tiling\&. |
| 292 |
A scale of 1 displays the image without any scaling\&. A scale of 2 to |
| 293 |
9 specifies an integer number of images in that direction\&. No image |
| 294 |
will be magnified beyond 10 times its original size\&. The maximum |
| 295 |
permitted scale is 1000\&. [default 0x0+50+50] |
| 296 |
.IP "\fBmenu:\fP \fIfile[;tag]\fP" |
| 297 |
Read in the specified menu file (note the `\&.menu\&' extension is |
| 298 |
optional) and also optionally specify a starting tag to find\&. See |
| 299 |
the reference documentation for details on the syntax for the menuBar\&. |
| 300 |
.IP "\fBpath:\fP \fIpath\fP" |
| 301 |
Specify the colon-delimited search path for finding files (XPM and |
| 302 |
menus), in addition to the paths specified by the \fBRXVTPATH\fP and |
| 303 |
\fBPATH\fP environment variables\&. |
| 304 |
.IP "\fBfont:\fP \fIfontname\fP" |
| 305 |
Select the fonts to be used\&. |
| 306 |
This is a comma seperated list of font names that are used in turn when |
| 307 |
trying to display Unicode characters\&. |
| 308 |
The first font defines the cell size for characters; other fonts might |
| 309 |
be smaller, but not larger\&. |
| 310 |
A reasonable default font list is always appended to it\&. |
| 311 |
option \fB-fn\fP\&. |
| 312 |
.IP "\fBrealBold:\fP \fIboolean\fP" |
| 313 |
\fBTrue\fP: Enable "real bold" support\&. |
| 314 |
When this option is on, bold text will be displayed using the first |
| 315 |
available bold font in the font list\&. |
| 316 |
Bold fonts should thus be specified in the font list after their |
| 317 |
corresponding regular fonts\&. |
| 318 |
If no bold font can be found, a regular font will be used\&. |
| 319 |
option \fB-rb\fP\&. |
| 320 |
\fBFalse\fP: Display bold text in a regular font, using the color |
| 321 |
specified with \fBcolorBD\fP; |
| 322 |
option \fB+rb\fP\&. |
| 323 |
.IP "\fBselectstyle:\fP \fImode\fP" |
| 324 |
Set mouse selection style to \fBold\fP which is 2\&.20, \fBoldword\fP which |
| 325 |
is xterm style with 2\&.20 old word selection, or anything else which |
| 326 |
gives xterm style selection\&. |
| 327 |
.IP "\fBscrollstyle:\fP \fImode\fP" |
| 328 |
Set scrollbar style to \fBrxvt\fP, \fBrxvt\fP, \fBplain\fP, \fBnext\fP or \fBxterm\fP |
| 329 |
.IP "\fBtitle:\fP \fIstring\fP" |
| 330 |
Set window title string, the default title is the command-line |
| 331 |
specified after the \fB-e\fP option, if any, otherwise the application |
| 332 |
name; |
| 333 |
option \fB-title\fP\&. |
| 334 |
.IP "\fBiconName:\fP \fIstring\fP" |
| 335 |
Set the name used to label the window\&'s icon or displayed in an icon |
| 336 |
manager window, it also sets the window\&'s title unless it is |
| 337 |
explicitly set; |
| 338 |
option \fB-n\fP\&. |
| 339 |
.IP "\fBmapAlert:\fP \fIboolean\fP" |
| 340 |
\fBTrue\fP: de-iconify (map) on receipt of a bell character\&. |
| 341 |
\fBFalse\fP: no de-iconify (map) on receipt of a bell character |
| 342 |
[default]\&. |
| 343 |
.IP "\fBvisualBell:\fP \fIboolean\fP" |
| 344 |
\fBTrue\fP: use visual bell on receipt of a bell character; |
| 345 |
option \fB-vb\fP\&. |
| 346 |
\fBFalse\fP: no visual bell [default]; |
| 347 |
option \fB+vb\fP\&. |
| 348 |
.IP "\fBloginShell:\fP \fIboolean\fP" |
| 349 |
\fBTrue\fP: start as a login shell by prepending a `-\&' to \fBargv[0]\fP |
| 350 |
of the shell; |
| 351 |
option \fB-ls\fP\&. |
| 352 |
\fBFalse\fP: start as a normal sub-shell [default]; |
| 353 |
option \fB+ls\fP\&. |
| 354 |
.IP "\fButmpInhibit:\fP \fIboolean\fP" |
| 355 |
\fBTrue\fP: inhibit writing record into the system log file \fButmp\fP; |
| 356 |
option \fB-ut\fP\&. |
| 357 |
\fBFalse\fP: write record into the system log file \fButmp\fP [default]; |
| 358 |
option \fB+ut\fP\&. |
| 359 |
.IP "\fBprint-pipe:\fP \fIstring\fP" |
| 360 |
Specify a command pipe for vt100 printer [default \fIlpr(1)\fP]\&. Use |
| 361 |
\fBPrint\fP to initiate a screen dump to the printer and \fBCtrl-Print\fP |
| 362 |
or \fBShift-Print\fP to include the scrollback as well\&. |
| 363 |
.IP "\fBscrollBar:\fP \fIboolean\fP" |
| 364 |
\fBTrue\fP: enable the scrollbar [default]; |
| 365 |
option \fB-sb\fP\&. |
| 366 |
\fBFalse\fP: disable the scrollbar; |
| 367 |
option \fB+sb\fP\&. |
| 368 |
.IP "\fBscrollBar_right:\fP \fIboolean\fP" |
| 369 |
\fBTrue\fP: place the scrollbar on the right of the window; |
| 370 |
option \fB-sr\fP\&. |
| 371 |
\fBFalse\fP: place the scrollbar on the left of the window; |
| 372 |
option \fB+sr\fP\&. |
| 373 |
.IP "\fBscrollBar_floating:\fP \fIboolean\fP" |
| 374 |
\fBTrue\fP: display an rxvt scrollbar without a trough; |
| 375 |
option \fB-st\fP\&. |
| 376 |
\fBFalse\fP: display an rxvt scrollbar with a trough; |
| 377 |
option \fB+st\fP\&. |
| 378 |
.IP "\fBscrollBar_align:\fP \fImode\fP" |
| 379 |
Align the \fBtop\fP, \fBbottom\fP or \fBcentre\fP [default] of |
| 380 |
the scrollbar thumb with the pointer on middle button |
| 381 |
press/drag\&. |
| 382 |
.IP "\fBscrollTtyOutput:\fP \fIboolean\fP" |
| 383 |
\fBTrue\fP: scroll to bottom when tty receives output; |
| 384 |
option(+si)\&. |
| 385 |
\fBFalse\fP: do not scroll to bottom when tty receives output; |
| 386 |
option(-si)\&. |
| 387 |
.IP "\fBscrollWithBuffer:\fP \fIboolean\fP" |
| 388 |
\fBTrue\fP: scroll with scrollback buffer when tty recieves |
| 389 |
new lines (and \fBscrollTtyOutput\fP is False); |
| 390 |
option(+sw)\&. |
| 391 |
\fBFalse\fP: do not scroll with scrollback buffer when tty |
| 392 |
recieves new lines; |
| 393 |
option(-sw)\&. |
| 394 |
.IP "\fBscrollTtyKeypress:\fP \fIboolean\fP" |
| 395 |
\fBTrue\fP: scroll to bottom when a non-special key is pressed\&. |
| 396 |
Special keys are those which are intercepted by rxvt for special |
| 397 |
handling and are not passed onto the shell; |
| 398 |
option(-sk)\&. |
| 399 |
\fBFalse\fP: do not scroll to bottom when a non-special key is pressed; |
| 400 |
option(+sk)\&. |
| 401 |
.IP "\fBsmallfont_key:\fP \fIkeysym\fP" |
| 402 |
If enabled, use \fBAlt-\fP\fIkeysym\fP to toggle to a smaller font |
| 403 |
[default \fBAlt-<\fP] |
| 404 |
.IP "\fBbigfont_key:\fP \fIkeysym\fP" |
| 405 |
If enabled, use \fBAlt-\fP\fIkeysym\fP to toggle to a bigger font |
| 406 |
[default \fBAlt->\fP] |
| 407 |
.IP "\fBsaveLines:\fP \fInumber\fP" |
| 408 |
Save \fInumber\fP lines in the scrollback buffer [default 64]\&. This |
| 409 |
resource is limited on most machines to 65535; |
| 410 |
option \fB-sl\fP\&. |
| 411 |
.IP "\fBinternalBorder:\fP \fInumber\fP" |
| 412 |
Internal border of \fInumber\fP pixels\&. This resource is limited to 100; |
| 413 |
option \fB-b\fP\&. |
| 414 |
.IP "\fBexternalBorder:\fP \fInumber\fP" |
| 415 |
External border of \fInumber\fP pixels\&. This resource is limited to 100; |
| 416 |
option \fB-w\fP, \fB-bw\fP, \fB-borderwidth\fP\&. |
| 417 |
.IP "\fBtermName:\fP \fItermname\fP" |
| 418 |
Specifies the terminal type name to be set in the \fBTERM\fP |
| 419 |
environment variable; |
| 420 |
option \fB-tn\fP\&. |
| 421 |
.IP "\fBlinespace:\fP \fInumber\fP" |
| 422 |
Specifies number of lines (pixel height) to insert between each row |
| 423 |
of the display [default 0]; |
| 424 |
option \fB-lsp\fP\&. |
| 425 |
.IP "\fBmeta8:\fP \fIboolean\fP" |
| 426 |
\fBTrue\fP: handle Meta (Alt) + keypress to set the 8th bit\&. |
| 427 |
\fBFalse\fP: handle Meta (Alt) + keypress as an escape prefix [default]\&. |
| 428 |
.IP "\fBmouseWheelScrollPage:\fP \fIboolean\fP" |
| 429 |
\fBTrue\fP: the mouse wheel scrolls a page full\&. |
| 430 |
\fBFalse\fP: the mouse wheel scrolls five lines [default]\&. |
| 431 |
.IP "\fBcursorBlink:\fP \fIboolean\fP" |
| 432 |
\fBTrue\fP: blink the cursor\&. |
| 433 |
\fBFalse\fP: do not blink the cursor [default]; |
| 434 |
option \fB-bc\fP\&. |
| 435 |
.IP "\fBpointerBlank:\fP \fIboolean\fP" |
| 436 |
\fBTrue\fP: blank the pointer when a key is pressed or after a set number |
| 437 |
of seconds of inactivity\&. |
| 438 |
\fBFalse\fP: the pointer is always visible [default]\&. |
| 439 |
.IP "\fBpointerColor:\fP \fIcolour\fP" |
| 440 |
Mouse pointer foreground colour\&. |
| 441 |
.IP "\fBpointerColor2:\fP \fIcolour\fP" |
| 442 |
Mouse pointer background colour\&. |
| 443 |
.IP "\fBpointerBlankDelay:\fP \fInumber\fP" |
| 444 |
Specifies number of seconds before blanking the pointer [default 2]\&. |
| 445 |
.IP "\fBbackspacekey:\fP \fIstring\fP" |
| 446 |
The string to send when the backspace key is pressed\&. If set to |
| 447 |
\fBDEC\fP or unset it will send \fBDelete\fP (code 127) or, if shifted, |
| 448 |
\fBBackspace\fP (code 8) - which can be reversed with the appropriate |
| 449 |
DEC private mode escape sequence\&. |
| 450 |
.IP "\fBdeletekey:\fP \fIstring\fP" |
| 451 |
The string to send when the delete key (not the keypad delete key) is |
| 452 |
pressed\&. If unset it will send the sequence traditionally associated |
| 453 |
with the \fBExecute\fP key\&. |
| 454 |
.IP "\fBcutchars:\fP \fIstring\fP" |
| 455 |
The characters used as delimiters for double-click word selection\&. |
| 456 |
The built-in default: |
| 457 |
.br |
| 458 |
\fBBACKSLASH `"\&'&()*,;<=>?@[]{|}\fP |
| 459 |
.IP "\fBpreeditType:\fP \fIstyle\fP" |
| 460 |
\fBOverTheSpot\fP, \fBOffTheSpot\fP, \fBRoot\fP; |
| 461 |
option \fB-pt\fP\&. |
| 462 |
.IP "\fBinputMethod:\fP \fIname\fP" |
| 463 |
\fIname\fP of inputMethod to use; |
| 464 |
option \fB-im\fP\&. |
| 465 |
.IP "\fBimLocale:\fP \fIname\fP" |
| 466 |
The locale to use for opening the IM\&. You can use an LC_CTYPE |
| 467 |
of e\&.g\&. de_DE\&.UTF-8 for normal text processing but ja_JP\&.EUC-JP |
| 468 |
for the input extension to be able to input japanese characters |
| 469 |
while staying in another locale\&. |
| 470 |
option \fB-imlocale\fP\&. |
| 471 |
.IP "\fBinsecure\fP" |
| 472 |
Enables "insecure" mode\&. Rxvt-unicode offers some escape sequences |
| 473 |
that echo arbitrary strings like the icon name or the locale\&. This |
| 474 |
could be abused if somebody gets 8-bit-clean access to your |
| 475 |
display, wether throuh a mail client displaying mail bodies |
| 476 |
unfiltered or though write(1)\&. Therefore, these sequences are |
| 477 |
disabled by default\&. (Note that other terminals, including xterm, |
| 478 |
have these sequences enabled by default)\&. You can enable them |
| 479 |
by setting this boolean resource or specifying \fB-insecure\fP as |
| 480 |
an option\&. At the moment, this enabled display-answer, locale, |
| 481 |
findfont, icon label and window title requests as well as dynamic |
| 482 |
menubar dispatch\&. |
| 483 |
.IP "\fBmodifier:\fP \fImodifier\fP" |
| 484 |
Set the key to be interpreted as the Meta key to: |
| 485 |
\fBalt\fP, \fBmeta\fP, \fBhyper\fP, \fBsuper\fP, \fBmod1\fP, \fBmod2\fP, \fBmod3\fP, |
| 486 |
\fBmod4\fP, \fBmod5\fP; |
| 487 |
option \fB-mod\fP\&. |
| 488 |
.IP "\fBanswerbackString:\fP \fIstring\fP" |
| 489 |
Specify the reply rxvt sends to the shell when an ENQ (control-E) |
| 490 |
character is passed through\&. It may contain escape values as |
| 491 |
described in the entry on \fBkeysym\fP following\&. |
| 492 |
.IP "\fBsecondaryScreen:\fP \fIbool\fP" |
| 493 |
Turn on/off secondary screen (default enabled)\&. |
| 494 |
.IP "\fBsecondaryScroll:\fP \fIbool\fP" |
| 495 |
Turn on/off secondary screen scroll (default enabled)\&. If |
| 496 |
the this option is enabled, scrolls on the secondary screen will |
| 497 |
change the scrollback buffer and switching to/from the secondary screen |
| 498 |
will instead scroll the screen up\&. |
| 499 |
.IP "\fBkeysym\&.\fP\fIsym\fP: \fIstring\fP" |
| 500 |
Associate \fIstring\fP with keysym \fIsym\fP (\fB0xFF00 - 0xFFFF\fP)\&. It |
| 501 |
may contain escape values (\ea: bell, \eb: backspace, \ee, \eE: escape, |
| 502 |
\en: newline, \er: return, \et: tab, \e000: octal number) or control |
| 503 |
characters (^?: delete, ^@: null, ^A \&.\&.\&.) and may enclosed with |
| 504 |
double quotes so that it can start or end with whitespace\&. The |
| 505 |
intervening resource name \fBkeysym\&.\fP cannot be omitted\&. This |
| 506 |
resource is only available when compiled with KEYSYM_RESOURCE\&. |
| 507 |
.SH "THE SCROLLBAR" |
| 508 |
.PP |
| 509 |
Lines of text that scroll off the top of the \fBrxvt\fP window (resource: |
| 510 |
\fBsaveLines\fP) and can be scrolled back using the scrollbar or by keystrokes\&. |
| 511 |
The normal \fBrxvt\fP scrollbar has arrows and its behaviour is fairly |
| 512 |
intuitive\&. The \fBxterm-scrollbar\fP is without arrows and its behaviour |
| 513 |
mimics that of \fIxterm\fP |
| 514 |
.PP |
| 515 |
Scroll down with \fBButton1\fP (\fBxterm-scrollbar\fP) or \fBShift-Next\fP\&. |
| 516 |
Scroll up with \fBButton3\fP (\fBxterm-scrollbar\fP) or \fBShift-Prior\fP\&. |
| 517 |
Continuous scroll with \fBButton2\fP\&. |
| 518 |
.SH "MOUSE REPORTING" |
| 519 |
.PP |
| 520 |
To temporarily override mouse reporting, for either the scrollbar or the |
| 521 |
normal text selection/insertion, hold either the Shift or the Meta (Alt) key |
| 522 |
while performing the desired mouse action\&. |
| 523 |
.PP |
| 524 |
If mouse reporting mode is active, the normal scrollbar actions are disabled |
| 525 |
-- on the assumption that we are using a fullscreen application\&. |
| 526 |
Instead, pressing Button1 and Button3 sends |
| 527 |
\fBESC[6~\fP (Next) and \fBESC[5~\fP (Prior), respectively\&. |
| 528 |
Similarly, clicking on the up and down arrows sends \fBESC[A\fP (Up) and |
| 529 |
\fBESC[B\fP (Down), respectively\&. |
| 530 |
.SH "TEXT SELECTION AND INSERTION" |
| 531 |
.PP |
| 532 |
The behaviour of text selection and insertion mechanism is similar to |
| 533 |
\fIxterm\fP(1)\&. |
| 534 |
.PP |
| 535 |
.IP "\fBSelection\fP:" |
| 536 |
Left click at the beginning of the region, drag to the end of the |
| 537 |
region and release; Right click to extend the marked region; |
| 538 |
Left double-click to select a word; Left triple-click to select |
| 539 |
the entire line\&. |
| 540 |
.IP "\fBInsertion\fP:" |
| 541 |
Pressing and releasing the Middle mouse button (or \fBShift-Insert\fP) |
| 542 |
in an \fBrxvt\fP window causes the current text selection to be inserted |
| 543 |
as if it had been typed on the keyboard\&. |
| 544 |
.SH "CHANGING FONTS" |
| 545 |
.PP |
| 546 |
You can change fonts on-the-fly, which is to say cycle through the default |
| 547 |
font and others of various sizes, by using \fBShift-KP_Add\fP and |
| 548 |
\fBShift-KP_Subtract\fP\&. Or, alternatively (if enabled) with |
| 549 |
\fBAlt->\fP and \fBAlt-<\fP, where the actual key |
| 550 |
can be selected using resources \fBsmallfont_key\fP/\fBbigfont_key\fP\&. |
| 551 |
.SH "LOGIN STAMP" |
| 552 |
.PP |
| 553 |
\fBrxvt\fP tries to write an entry into the \fIutmp\fP(5) file so that it can be |
| 554 |
seen via the \fIwho(1)\fP command, and can accept messages\&. To allow this |
| 555 |
feature, \fBrxvt\fP must be installed setuid root on some systems\&. |
| 556 |
.SH "COLORS AND GRAPHICS" |
| 557 |
.PP |
| 558 |
In addition to the default foreground and background colours, \fBrxvt\fP |
| 559 |
can display up to 16 colours (8 ANSI colours plus high-intensity bold/blink |
| 560 |
versions of the same)\&. |
| 561 |
Here is a list of the colours with their \fBrgb\&.txt\fP names\&. |
| 562 |
.PP |
| 563 |
.TS |
| 564 |
tab(`); |
| 565 |
l l l . |
| 566 |
\fBcolor0\fP `\ (black) `\ = Black |
| 567 |
\fBcolor1\fP `\ (red) `\ = Red3 |
| 568 |
\fBcolor2\fP `\ (green) `\ = Green3 |
| 569 |
\fBcolor3\fP `\ (yellow) `\ = Yellow3 |
| 570 |
\fBcolor4\fP `\ (blue) `\ = Blue3 |
| 571 |
\fBcolor5\fP `\ (magenta) `\ = Magenta3 |
| 572 |
\fBcolor6\fP `\ (cyan) `\ = Cyan3 |
| 573 |
\fBcolor7\fP `\ (white) `\ = AntiqueWhite |
| 574 |
\fBcolor8\fP `\ (bright black) `\ = Grey25 |
| 575 |
\fBcolor9\fP `\ (bright red) `\ = Red |
| 576 |
\fBcolor10\fP `\ (bright green) `\ = Green |
| 577 |
\fBcolor11\fP `\ (bright yellow) `\ = Yellow |
| 578 |
\fBcolor12\fP `\ (bright blue) `\ = Blue |
| 579 |
\fBcolor13\fP `\ (bright magenta) `\ = Magenta |
| 580 |
\fBcolor14\fP `\ (bright cyan) `\ = Cyan |
| 581 |
\fBcolor15\fP `\ (bright white) `\ = White |
| 582 |
\fBforeground\fP `\ `\ = Black |
| 583 |
\fBbackground\fP `\ `\ = White |
| 584 |
.TE |
| 585 |
.PP |
| 586 |
It is also possible to specify the colour values of \fBforeground\fP, |
| 587 |
\fBbackground\fP, \fBcursorColor\fP, \fBcursorColor2\fP, \fBcolorBD\fP, \fBcolorUL\fP |
| 588 |
as a number 0-15, as a convenient shorthand to reference the colour name of |
| 589 |
color0-color15\&. |
| 590 |
.PP |
| 591 |
Note that \fB-rv\fP (\fB"reverseVideo: True"\fP) simulates reverse video by |
| 592 |
always swapping the foreground/background colours\&. This is in contrast to |
| 593 |
\fIxterm\fP(1) where the colours are only swapped if they have not otherwise been |
| 594 |
specified\&. |
| 595 |
For example, |
| 596 |
.PP |
| 597 |
.IP "\fBrxvt -fg Black -bg White -rv\fP" |
| 598 |
would yield White on Black, while on \fIxterm\fP(1) it would yield |
| 599 |
Black on White\&. |
| 600 |
.SH "ENVIRONMENT" |
| 601 |
.PP |
| 602 |
\fBrxvt\fP sets the environment variables \fBTERM\fP, \fBCOLORTERM\fP and |
| 603 |
\fBCOLORFGBG\fP\&. The environment variable \fBWINDOWID\fP is set to the X window |
| 604 |
id number of the \fBrxvt\fP window and it also uses and sets the environment |
| 605 |
variable \fBDISPLAY\fP to specify which display terminal to use\&. \fBrxvt\fP uses |
| 606 |
the environment variables \fBRXVTPATH\fP and \fBPATH\fP to find XPM files\&. |
| 607 |
.SH "FILES" |
| 608 |
.PP |
| 609 |
.IP "\fB/etc/utmp\fP" |
| 610 |
System file for login records\&. |
| 611 |
.IP "\fB/usr/lib/X11/rgb\&.txt\fP" |
| 612 |
Color names\&. |
| 613 |
.PP |
| 614 |
.SH "SEE ALSO" |
| 615 |
.PP |
| 616 |
\fIxterm\fP(1), \fIsh\fP(1), \fIresize\fP(1), \fIX\fP(1), \fIpty\fP(4), \fItty\fP(4), |
| 617 |
\fIutmp\fP(5) |
| 618 |
.PP |
| 619 |
See rxvtRef\&.html rxvtRef\&.txt for detailed information on recognized escape |
| 620 |
sequences and menuBar syntax, etc\&. |
| 621 |
.PP |
| 622 |
.SH "BUGS" |
| 623 |
.PP |
| 624 |
Check the BUGS file for an up-to-date list\&. |
| 625 |
.PP |
| 626 |
Cursor change support is not yet implemented\&. |
| 627 |
.PP |
| 628 |
Click-and-drag doesn\&'t work with X11 mouse report overriding\&. |
| 629 |
.PP |
| 630 |
.SH "FTP LOCATION" |
| 631 |
.PP |
| 632 |
rxvt-3\&.3\&.tar\&.gz can be found at the following ftp sites |
| 633 |
ftp://ftp\&.rxvt\&.org/pub/rxvt |
| 634 |
.PP |
| 635 |
.SH "CURRENT PROJECT COORDINATOR" |
| 636 |
.PP |
| 637 |
.IP "Project Coordinator" |
| 638 |
Marc A\&. Lehmann <rxvt@schmorp\&.de> |
| 639 |
.br |
| 640 |
.IP "Web page maintainter" |
| 641 |
Marc A\&. Lehmann <rxvt@schmorp\&.de> |
| 642 |
.br |
| 643 |
<http://www\&.sourceforge\&.net/projects/rxvt-unicode/> |
| 644 |
.br |
| 645 |
.PP |
| 646 |
.SH "AUTHORS" |
| 647 |
.PP |
| 648 |
.IP "John Bovey" |
| 649 |
University of Kent, 1992, wrote the original Xvt\&. |
| 650 |
.IP "Rob Nation <nation@rocket\&.sanders\&.lockheed\&.com>" |
| 651 |
very heavily modified Xvt and came up with Rxvt |
| 652 |
.IP "Angelo Haritsis <ah@doc\&.ic\&.ac\&.uk>" |
| 653 |
wrote the Greek Keyboard Input (no longer in code) |
| 654 |
.IP "mj olesen <olesen@me\&.QueensU\&.CA>" |
| 655 |
Wrote the menu system\&. |
| 656 |
.br |
| 657 |
Project Coordinator (changes\&.txt 2\&.11 to 2\&.21) |
| 658 |
.IP "Oezguer Kesim <kesim@math\&.fu-berlin\&.de>" |
| 659 |
Project Coordinator (changes\&.txt 2\&.21a to 2\&.4\&.5) |
| 660 |
.IP "Geoff Wing <gcw@pobox\&.com>" |
| 661 |
Rewrote screen display and text selection routines\&. |
| 662 |
Project Coordinator (changes\&.txt 2\&.4\&.6 - rxvt-unicode) |
| 663 |
.IP "Marc Alexander Lehmann <rxvt@schmorp\&.de>" |
| 664 |
Forked rxvt-unicode, rewrote most of the display code and |
| 665 |
internal character handling to store text in unicode, |
| 666 |
improve xterm compatibility and apply numerous other bugfixes |
| 667 |
and extensions\&. |
| 668 |
.br |
| 669 |
Project Coordinator (Changes 1\&.0 - ) |
| 670 |
.PP |
