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