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