ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.man.in
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.man.in (file contents):
Revision 1.7 by root, Thu Feb 3 10:24:10 2005 UTC vs.
Revision 1.63 by root, Mon Aug 7 16:17:30 2006 UTC

1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 1.\" Automatically generated by Pod::Man 2.09 (Pod::Simple 3.04)
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sh \" Subsection heading 5.de Sh \" Subsection heading
6.br 6.br
… …
36. ds PI pi 36. ds PI pi
37. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch 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 38. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39. ds L" "" 39. ds L" ""
40. ds R" "" 40. ds R" ""
41. ds C` 41. ds C` ""
42. ds C' 42. ds C' ""
43'br\} 43'br\}
44.el\{\ 44.el\{\
45. ds -- \|\(em\| 45. ds -- \|\(em\|
46. ds PI \(*p 46. ds PI \(*p
47. ds L" `` 47. ds L" ``
… …
126. ds Ae AE 126. ds Ae AE
127.\} 127.\}
128.rm #[ #] #H #V #F C 128.rm #[ #] #H #V #F C
129.\" ======================================================================== 129.\" ========================================================================
130.\" 130.\"
131.IX Title "rxvt 1" 131.IX Title "@@RXVT_NAME@@ 1"
132.TH rxvt 1 "2005-02-03" "4.9" "RXVT-UNICODE" 132.TH @@RXVT_NAME@@ 1 "2006-08-07" "7.9" "RXVT-UNICODE"
133.SH "NAME" 133.SH "NAME"
134rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system) 134rxvt\-unicode (ouR XVT, unicode) \- (a VT102 emulator for the X window system)
135.SH "SYNOPSIS" 135.SH "SYNOPSIS"
136.IX Header "SYNOPSIS" 136.IX Header "SYNOPSIS"
137\&\fB@@RXVT_NAME@@\fR [options] [\-e command [ args ]] 137\&\fB@@RXVT_NAME@@\fR [options] [\-e command [ args ]]
… …
142require features such as Tektronix 4014 emulation and toolkit-style 142require features such as Tektronix 4014 emulation and toolkit-style
143configurability. As a result, \fBrxvt-unicode\fR uses much less swap space \*(-- 143configurability. As a result, \fBrxvt-unicode\fR uses much less swap space \*(--
144a significant advantage on a machine serving many X sessions. 144a significant advantage on a machine serving many X sessions.
145.SH "FREQUENTLY ASKED QUESTIONS" 145.SH "FREQUENTLY ASKED QUESTIONS"
146.IX Header "FREQUENTLY ASKED QUESTIONS" 146.IX Header "FREQUENTLY ASKED QUESTIONS"
147See @@RXVT_NAME@@(7) (try \f(CW\*(C`man 7 @@RXVT_NAME@@\*(C'\fR) for a list of frequently 147See @@RXVT_NAME@@(7) (try \f(CW\*(C`man 7 @@RXVT_NAME@@\*(C'\fR) for a list of
148asked questions and answer to them and some common problems. 148frequently asked questions and answer to them and some common
149problems. That document is also accessible on the World-Wide-Web at
150<http://cvs.schmorp.de/browse/*checkout*/rxvt\-unicode/doc/rxvt.7.html>.
149.SH "RXVT-UNICODE VS. RXVT" 151.SH "RXVT-UNICODE VS. RXVT"
150.IX Header "RXVT-UNICODE VS. RXVT" 152.IX Header "RXVT-UNICODE VS. RXVT"
151Unlike the original rxvt, \fBrxvt-unicode\fR stores all text in Unicode 153Unlike the original rxvt, \fBrxvt-unicode\fR stores all text in Unicode
152internally. That means it can store and display most scripts in the 154internally. That means it can store and display most scripts in the
153world. Being a terminal emulator, however, some things are very difficult, 155world. Being a terminal emulator, however, some things are very difficult,
154especially cursive scripts such as arabic, vertically written scripts 156especially cursive scripts such as arabic, vertically written scripts
155like mongolian or scripts requiring extremely complex combining rules, 157like mongolian or scripts requiring extremely complex combining rules,
156like tibetan or devenagari. Don't expect pretty output when using these 158like tibetan or devenagari. Don't expect pretty output when using these
157scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 159scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
158fine, though. A somewhat difficult case are left-to-right scripts, such 160fine, though. A somewhat difficult case are right-to-left scripts, such
159as hebrew: \fBrxvt-unicode\fR adopts the view that bidirectional algorithms 161as hebrew: \fBrxvt-unicode\fR adopts the view that bidirectional algorithms
160belong into the application, not the terminal emulator (too many things \*(-- 162belong into the application, not the terminal emulator (too many things \*(--
161such as cursor-movement while editing \*(-- break otherwise), but that might 163such as cursor-movement while editing \*(-- break otherwise), but that might
162change. 164change.
163.PP 165.PP
164If you are looking for a terminal that supports more exotic scripts, let 166If you are looking for a terminal that supports more exotic scripts, let
165me recommend \f(CW\*(C`mlterm\*(C'\fR, which is a very userfriendly, lean and clean 167me recommend \f(CW\*(C`mlterm\*(C'\fR, which is a very user friendly, lean and clean
166terminal emulator. In fact, the reason rxvt-unicode was born was solely 168terminal emulator. In fact, the reason rxvt-unicode was born was solely
167because the author couldn't get \f(CW\*(C`mlterm\*(C'\fR to use one font for latin1 and 169because the author couldn't get \f(CW\*(C`mlterm\*(C'\fR to use one font for latin1 and
168another for japanese. 170another for japanese.
169.PP 171.PP
170Therefore another design rationale was the use of multiple fonts to 172Therefore another design rationale was the use of multiple fonts to
171display characters: The idea of a single unicode font which many other 173display characters: The idea of a single unicode font which many other
172programs force onto it's users never made sense to me: You should be able 174programs force onto its users never made sense to me: You should be able
173to choose any font for any script freely. 175to choose any font for any script freely.
174.PP 176.PP
175Apart from that, rxvt-unicode is also much better internationalised than 177Apart from that, rxvt-unicode is also much better internationalised than
176it's predecessor, supports things such as \s-1XFT\s0 and \s-1ISO\s0 14755 that are handy 178its predecessor, supports things such as \s-1XFT\s0 and \s-1ISO\s0 14755 that are handy
177in i18n\-environments, is faster, and has a lot less bugs than the original 179in i18n\-environments, is faster, and has a lot bugs less than the original
178rxvt. This all in addition to dozens of other small improvements. 180rxvt. This all in addition to dozens of other small improvements.
179.PP 181.PP
180It is still faithfully following the original rxvt idea of being lean 182It is still faithfully following the original rxvt idea of being lean
181and nice on resources: for example, you can still configure rxvt-unicode 183and nice on resources: for example, you can still configure rxvt-unicode
182without most of it's features to get a lean binary. It also comes with 184without most of its features to get a lean binary. It also comes with
183a client/daemon pair that lets you open any number of terminal windows 185a client/daemon pair that lets you open any number of terminal windows
184from within a single process, which makes startup time very fast and 186from within a single process, which makes startup time very fast and
185drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 187drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
186@@RXVT_NAME@@c(1) (client). 188@@RXVT_NAME@@c(1) (client).
187.PP 189.PP
188It also makes technical information about escape sequences (which have 190It also makes technical information about escape sequences (which have
189been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 191been extended) more accessible: see @@RXVT_NAME@@(7) for technical
190reference documentation (escape sequences etc.). 192reference documentation (escape sequences etc.).
191.SH "OPTIONS" 193.SH "OPTIONS"
192.IX Header "OPTIONS" 194.IX Header "OPTIONS"
193The \fB@@RXVT_NAME@@\fR options (mostly a subset of \fIxterm\fR's) are listed 195The \fB@@RXVT_NAME@@\fR options (mostly a subset of \fIxterm\fR's) are listed
194below. In keeping with the smaller-is-better philosophy, options may be 196below. In keeping with the smaller-is-better philosophy, options may be
… …
212.IP "\fB\-display\fR \fIdisplayname\fR" 4 214.IP "\fB\-display\fR \fIdisplayname\fR" 4
213.IX Item "-display displayname" 215.IX Item "-display displayname"
214Attempt to open a window on the named X display (\fB\-d\fR still 216Attempt to open a window on the named X display (\fB\-d\fR still
215respected). In the absence of this option, the display specified by the 217respected). In the absence of this option, the display specified by the
216\&\fB\s-1DISPLAY\s0\fR environment variable is used. 218\&\fB\s-1DISPLAY\s0\fR environment variable is used.
219.IP "\fB\-depth\fR \fIbitdepth\fR" 4
220.IX Item "-depth bitdepth"
221Compile \fIxft\fR: Attempt to find a visual with the given bit depth;
222resource \fBdepth\fR.
217.IP "\fB\-geometry\fR \fIgeom\fR" 4 223.IP "\fB\-geometry\fR \fIgeom\fR" 4
218.IX Item "-geometry geom" 224.IX Item "-geometry geom"
219Window geometry (\fB\-g\fR still respected); resource \fBgeometry\fR. 225Window geometry (\fB\-g\fR still respected); resource \fBgeometry\fR.
220.IP "\fB\-rv\fR|\fB+rv\fR" 4 226.IP "\fB\-rv\fR|\fB+rv\fR" 4
221.IX Item "-rv|+rv" 227.IX Item "-rv|+rv"
222Turn on/off simulated reverse video; resource \fBreverseVideo\fR. 228Turn on/off simulated reverse video; resource \fBreverseVideo\fR.
223.IP "\fB\-j\fR|\fB+j\fR" 4 229.IP "\fB\-j\fR|\fB+j\fR" 4
224.IX Item "-j|+j" 230.IX Item "-j|+j"
225Turn on/off jump scrolling; resource \fBjumpScroll\fR. 231Turn on/off jump scrolling; resource \fBjumpScroll\fR.
226.IP "\fB\-ip\fR|\fB+ip\fR" 4 232.IP "\fB\-ip\fR|\fB+ip\fR | \fB\-tr\fR|\fB+tr\fR" 4
227.IX Item "-ip|+ip" 233.IX Item "-ip|+ip | -tr|+tr"
228Turn on/off inheriting parent window's pixmap. Alternative form is 234Turn on/off inheriting parent window's pixmap. Alternative form is
229\&\fB\-tr\fR; resource \fBinheritPixmap\fR. 235\&\fB\-tr\fR; resource \fBinheritPixmap\fR.
236.Sp
237\&\fIPlease note that transparency of any kind if completely unsupported by
238the author. Don't bug him with installation questions! Read the \s-1FAQ\s0 (man 7
239@@RXVT_NAME@@)!\fR
230.IP "\fB\-fade\fR \fInumber\fR" 4 240.IP "\fB\-fade\fR \fInumber\fR" 4
231.IX Item "-fade number" 241.IX Item "-fade number"
232Fade the text by the given percentage when focus is lost. resource \fBfading\fR. 242Fade the text by the given percentage when focus is lost. Small values
243fade a little only, 100 completely replaces all colours by the fade
244colour; resource \fBfading\fR.
245.IP "\fB\-fadecolor\fR \fIcolour\fR" 4
246.IX Item "-fadecolor colour"
247Fade to this colour when fading is used (see \fB\-fade\fR). The default colour
248is opaque black. resource \fBfadeColor\fR.
233.IP "\fB\-tint\fR \fIcolour\fR" 4 249.IP "\fB\-tint\fR \fIcolour\fR" 4
234.IX Item "-tint colour" 250.IX Item "-tint colour"
235Tint the transparent background pixmap with the given colour when 251Tint the transparent background pixmap with the given colour when
236transparency is enabled with \fB\-tr\fR or \fB\-ip\fR. See also the \fB\-sh\fR 252transparency is enabled with \fB\-tr\fR or \fB\-ip\fR. This only works for
237option that can be used to brighten or darken the image in addition to 253non-tiled backgrounds, currently. See also the \fB\-sh\fR option that can be
238tinting it. 254used to brighten or darken the image in addition to tinting it; resource
255\&\fItintColor\fR. Example:
256.Sp
257.Vb 1
258\& @@RXVT_NAME@@ \-tr \-tint blue \-sh 40
259.Ve
239.IP "\fB\-sh\fR" 4 260.IP "\fB\-sh\fR" 4
240.IX Item "-sh" 261.IX Item "-sh"
241\&\fInumber\fR Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent 262\&\fInumber\fR Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent
242background image in addition to tinting it (i.e. \fB\-tint\fR must be 263background image in addition to tinting it (i.e. \fB\-tint\fR must be
243specified, too, e.g. \f(CW\*(C`\-tint white\*(C'\fR). 264specified, too, e.g. \f(CW\*(C`\-tint white\*(C'\fR).
… …
267The colour of the border around the text area and between the scrollbar and the text; 288The colour of the border around the text area and between the scrollbar and the text;
268resource \fBborderColor\fR. 289resource \fBborderColor\fR.
269.IP "\fB\-fn\fR \fIfontlist\fR" 4 290.IP "\fB\-fn\fR \fIfontlist\fR" 4
270.IX Item "-fn fontlist" 291.IX Item "-fn fontlist"
271Select the fonts to be used. This is a comma separated list of font names 292Select the fonts to be used. This is a comma separated list of font names
272that are used in turn when trying to display Unicode characters. The 293that are checked in order when trying to find glyphs for characters. The
273first font defines the cell size for characters; other fonts might be 294first font defines the cell size for characters; other fonts might be
274smaller, but not (in general) larger. A (hopefully) reasonable default 295smaller, but not (in general) larger. A (hopefully) reasonable default
275font list is always appended to it. See resource \fBfont\fR for more details. 296font list is always appended to it. See resource \fBfont\fR for more details.
276.Sp 297.Sp
277In short, to specify an X11 core font, just specify it's name or prefix it 298In short, to specify an X11 core font, just specify its name or prefix it
278with \f(CW\*(C`x:\*(C'\fR. To specify an XFT\-font, you need to prefix it with \f(CW\*(C`xft:\*(C'\fR, 299with \f(CW\*(C`x:\*(C'\fR. To specify an XFT\-font, you need to prefix it with \f(CW\*(C`xft:\*(C'\fR,
279e.g.: 300e.g.:
280.Sp 301.Sp
281.Vb 2 302.Vb 2
282\& @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 303\& @@RXVT_NAME@@ \-fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
283\& @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 304\& @@RXVT_NAME@@ \-fn "9x15bold,xft:Bitstream Vera Sans Mono"
284.Ve 305.Ve
285.Sp 306.Sp
286See also the question \*(L"How does rxvt-unicode choose fonts?\*(R" in the \s-1FAQ\s0 307See also the question \*(L"How does rxvt-unicode choose fonts?\*(R" in the \s-1FAQ\s0
287section of @@RXVT_NAME@@(7). 308section of @@RXVT_NAME@@(7).
288.IP "\fB\-fb\fR \fIfontlist\fR" 4 309.IP "\fB\-fb\fR \fIfontlist\fR" 4
289.IX Item "-fb fontlist" 310.IX Item "-fb fontlist"
290Compile font\-styles: The bold font list to use when bold characters are to 311Compile \fIfont-styles\fR: The bold font list to use when \fBbold\fR characters
291be printed. See resource \fBboldFont\fR for details. 312are to be printed. See resource \fBboldFont\fR for details.
292.IP "\fB\-fi\fR \fIfontlist\fR" 4 313.IP "\fB\-fi\fR \fIfontlist\fR" 4
293.IX Item "-fi fontlist" 314.IX Item "-fi fontlist"
294Compile font\-styles: The italic font list to use when bold characters are to 315Compile \fIfont-styles\fR: The italic font list to use when \fIitalic\fR
295be printed. See resource \fBitalicFont\fR for details. 316characters are to be printed. See resource \fBitalicFont\fR for details.
296.IP "\fB\-fbi\fR \fIfontlist\fR" 4 317.IP "\fB\-fbi\fR \fIfontlist\fR" 4
297.IX Item "-fbi fontlist" 318.IX Item "-fbi fontlist"
298Compile font\-styles: The bold italic font list to use when bold characters are to 319Compile \fIfont-styles\fR: The bold italic font list to use when \fB\f(BIbold
299be printed. See resource \fBboldItalicFont\fR for details. 320italic\fB\fR characters are to be printed. See resource \fBboldItalicFont\fR
321for details.
322.IP "\fB\-is\fR|\fB+is\fR" 4
323.IX Item "-is|+is"
324Compile \fIfont-styles\fR: Bold/Italic font styles imply high intensity
325foreground/background (default). See resource \fBintensityStyles\fR for
326details.
300.IP "\fB\-name\fR \fIname\fR" 4 327.IP "\fB\-name\fR \fIname\fR" 4
301.IX Item "-name name" 328.IX Item "-name name"
302Specify the application name under which resources are to be obtained, 329Specify the application name under which resources are to be obtained,
303rather than the default executable file name. Name should not contain 330rather than the default executable file name. Name should not contain
304`.' or `*' characters. Also sets the icon and title name. 331`.' or `*' characters. Also sets the icon and title name.
… …
332.IP "\fB\-sr\fR|\fB+sr\fR" 4 359.IP "\fB\-sr\fR|\fB+sr\fR" 4
333.IX Item "-sr|+sr" 360.IX Item "-sr|+sr"
334Put scrollbar on right/left; resource \fBscrollBar_right\fR. 361Put scrollbar on right/left; resource \fBscrollBar_right\fR.
335.IP "\fB\-st\fR|\fB+st\fR" 4 362.IP "\fB\-st\fR|\fB+st\fR" 4
336.IX Item "-st|+st" 363.IX Item "-st|+st"
337Display normal (non XTerm/NeXT) scrollbar without/with a trough; 364Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
338resource \fBscrollBar_floating\fR. 365resource \fBscrollBar_floating\fR.
339.IP "\fB\-ptab\fR|\fB+ptab\fR" 4 366.IP "\fB\-ptab\fR|\fB+ptab\fR" 4
340.IX Item "-ptab|+ptab" 367.IX Item "-ptab|+ptab"
341If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as 368If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as
342actual wide characters in the screen buffer, which makes it possible to 369actual wide characters in the screen buffer, which makes it possible to
… …
366.IP "\fB\-bl\fR" 4 393.IP "\fB\-bl\fR" 4
367.IX Item "-bl" 394.IX Item "-bl"
368Compile \fIfrills\fR: Set \s-1MWM\s0 hints to request a borderless window, i.e. 395Compile \fIfrills\fR: Set \s-1MWM\s0 hints to request a borderless window, i.e.
369if honoured by the \s-1WM\s0, the rxvt-unicode window will not have window 396if honoured by the \s-1WM\s0, the rxvt-unicode window will not have window
370decorations; resource \fBborderLess\fR. 397decorations; resource \fBborderLess\fR.
398.IP "\fB\-override\-redirect\fR" 4
399.IX Item "-override-redirect"
400Compile \fIfrills\fR: Sets override-redirect on the window; resource
401\&\fBoverride-redirect\fR.
402.IP "\fB\-sbg\fR" 4
403.IX Item "-sbg"
404Compile \fIfrills\fR: Disable the usage of the built-in block graphics/line
405drawing characters and just rely on what the specified fonts provide. Use
406this if you have a good font and want to use its block graphic glyphs;
407resource \fBskipBuiltinGlyphs\fR.
371.IP "\fB\-lsp\fR \fInumber\fR" 4 408.IP "\fB\-lsp\fR \fInumber\fR" 4
372.IX Item "-lsp number" 409.IX Item "-lsp number"
373Compile \fIfrills\fR: Lines (pixel height) to insert between each row of 410Compile \fIfrills\fR: Lines (pixel height) to insert between each row of
374the display. Useful to work around font rendering problems; resource 411the display. Useful to work around font rendering problems; resource
375\&\fBlinespace\fR. 412\&\fBlinespace\fR.
… …
386the program being executed if neither \fI\-title\fR (\fI\-T\fR) nor \fI\-n\fR are 423the program being executed if neither \fI\-title\fR (\fI\-T\fR) nor \fI\-n\fR are
387given on the command line. If this option is used, it must be the last 424given on the command line. If this option is used, it must be the last
388on the command\-line. If there is no \fB\-e\fR option then the default is to 425on the command\-line. If there is no \fB\-e\fR option then the default is to
389run the program specified by the \fB\s-1SHELL\s0\fR environment variable or, 426run the program specified by the \fB\s-1SHELL\s0\fR environment variable or,
390failing that, \fI\fIsh\fI\|(1)\fR. 427failing that, \fI\fIsh\fI\|(1)\fR.
428.Sp
429Please note that you must specify a program with arguments. If you want to
430run shell commands, you have to specify the shell, like this:
431.Sp
432.Vb 1
433\& @@RXVT_NAME@@ \-e sh \-c "shell commands"
434.Ve
391.IP "\fB\-title\fR \fItext\fR" 4 435.IP "\fB\-title\fR \fItext\fR" 4
392.IX Item "-title text" 436.IX Item "-title text"
393Window title (\fB\-T\fR still respected); the default title is the basename 437Window title (\fB\-T\fR still respected); the default title is the basename
394of the program specified after the \fB\-e\fR option, if any, otherwise the 438of the program specified after the \fB\-e\fR option, if any, otherwise the
395application name; resource \fBtitle\fR. 439application name; resource \fBtitle\fR.
… …
439\&\fBsecondaryScreen\fR. 483\&\fBsecondaryScreen\fR.
440.IP "\fB\-ssr\fR|\fB+ssr\fR" 4 484.IP "\fB\-ssr\fR|\fB+ssr\fR" 4
441.IX Item "-ssr|+ssr" 485.IX Item "-ssr|+ssr"
442Turn on/off secondary screen scroll (default enabled); resource 486Turn on/off secondary screen scroll (default enabled); resource
443\&\fBsecondaryScroll\fR. 487\&\fBsecondaryScroll\fR.
488.IP "\fB\-hold\fR|\fB+hold\fR" 4
489.IX Item "-hold|+hold"
490Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
491will not immediately destroy its window when the program executed within
492it exits. Instead, it will wait till it is being killed or closed by the
493user; resource \fBhold\fR.
494.IP "\fB\-keysym.\fR\fIsym\fR \fIstring\fR" 4
495.IX Item "-keysym.sym string"
496Remap a key symbol. See resource \fBkeysym\fR.
497.IP "\fB\-embed\fR \fIwindowid\fR" 4
498.IX Item "-embed windowid"
499Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
500which enables applications to easily embed a terminal.
501.Sp
502Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
503shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
504quite a bit, so don't expect it to keep some specific state. It's best to
505create an extra subwindow for @@RXVT_NAME@@ and leave it alone.
506.Sp
507The window will not be destroyed when @@RXVT_NAME@@ exits.
508.Sp
509It might be useful to know that @@RXVT_NAME@@ will not close file
510descriptors passed to it (except for stdin/out/err, of course), so you
511can use file descriptors to communicate with the programs within the
512terminal. This works regardless of whether the \f(CW\*(C`\-embed\*(C'\fR option was used or
513not.
514.Sp
515Here is a short Gtk2\-perl snippet that illustrates how this option can be
516used (a longer example is in \fIdoc/embed\fR):
517.Sp
518.Vb 5
519\& my $rxvt = new Gtk2::Socket;
520\& $rxvt\->signal_connect_after (realize => sub {
521\& my $xid = $_[0]\->window\->get_xid;
522\& system "@@RXVT_NAME@@ \-embed $xid &";
523\& });
524.Ve
525.IP "\fB\-pty\-fd\fR \fIfile descriptor\fR" 4
526.IX Item "-pty-fd file descriptor"
527Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty
528pair but instead use the given file descriptor as the tty master. This is
529useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
530without having to run a program within it.
531.Sp
532If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
533entries and will not tinker with pty/tty permissions \- you have to do that
534yourself if you want that.
535.Sp
536As an extremely special case, specifying \f(CW\*(C`\-1\*(C'\fR will completely suppress
537pty/tty operations.
538.Sp
539Here is a example in perl that illustrates how this option can be used (a
540longer example is in \fIdoc/pty\-fd\fR):
541.Sp
542.Vb 2
543\& use IO::Pty;
544\& use Fcntl;
545\&
546\& my $pty = new IO::Pty;
547\& fcntl $pty, F_SETFD, 0; # clear close\-on\-exec
548\& system "@@RXVT_NAME@@ \-pty\-fd " . (fileno $pty) . "&";
549\& close $pty;
550\&
551\& # now communicate with rxvt
552\& my $slave = $pty\->slave;
553\& while (<$slave>) { print $slave "got <$_>\en" }
554.Ve
444.IP "\fB\-xrm\fR \fIresourcestring\fR" 4 555.IP "\fB\-pe\fR \fIstring\fR" 4
445.IX Item "-xrm resourcestring" 556.IX Item "-pe string"
446No effect on rxvt\-unicode. Simply passes through an argument to be made 557Comma-separated list of perl extension scripts to use (or not to use) in
447available in the instance's argument list. Appears in \fI\s-1WM_COMMAND\s0\fR in 558this terminal instance. See resource \fBperl-ext\fR for details.
448some window managers.
449.SH "RESOURCES (available also as long\-options)" 559.SH "RESOURCES (available also as long\-options)"
450.IX Header "RESOURCES (available also as long-options)" 560.IX Header "RESOURCES (available also as long-options)"
451Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long 561Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long
452options) compiled into your version. 562options) compiled into your version.
453.PP 563.PP
454There are two different methods that @@RXVT_NAME@@ can use to get the 564You can set and change the resources using X11 tools like \fBxrdb\fR. Many
455Xresource data: using the X libraries (Xrm*\-functions) or internal 565distribution do also load settings from the \fB~/.Xresources\fR file when X
456Xresources reader (\fB~/.Xdefaults\fR). For the first method (ie. 566starts. @@RXVT_NAME@@ will consult the following files/resources in order,
457\&\fB@@RXVT_NAME@@ \-h\fR lists \fBXGetDefaults\fR), you can set and change the 567with later settings overwriting earlier ones:
458resources using X11 tools like \fBxset\fR. Many distribution do also load
459settings from the \fB~/.Xresources\fR file when X starts.
460.PP 568.PP
461If compiled with internal Xresources support (i.e. \fB@@RXVT_NAME@@ \-h\fR 569.Vb 5
462lists \fB.Xdefaults\fR) then \fB@@RXVT_NAME@@\fR accepts application defaults 570\& 1. system\-wide app\-defaults file, either locale\-dependent OR global
463set in XAPPLOADDIR/URxvt (compile\-time defined: usually 571\& 2. app\-defaults file in $XAPPLRESDIR
464\&\fB/usr/lib/X11/app\-defaults/URxvt\fR) and resources set in 572\& 3. RESOURCE_MANAGER property on root\-window OR $HOME/.Xdefaults
465\&\fB~/.Xdefaults\fR, or \fB~/.Xresources\fR if \fB~/.Xdefaults\fR does not exist. 573\& 4. SCREEN_RESOURCES for the current screen
574\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults\-<nodename>
575.Ve
576.PP
466Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two 577Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two class
467class names: \fBXTerm\fR and \fBURxvt\fR. The class name \fBRxvt\fR allows 578names: \fBRxvt\fR and \fBURxvt\fR. The class name \fBRxvt\fR allows resources
468resources common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be 579common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be easily
469easily configured, while the class name \fBURxvt\fR allows resources 580configured, while the class name \fBURxvt\fR allows resources unique to
470unique to \fB@@RXVT_NAME@@\fR, notably colours and key\-handling, to be 581\&\fB@@RXVT_NAME@@\fR, to be shared between different \fB@@RXVT_NAME@@\fR
471shared between different \fB@@RXVT_NAME@@\fR configurations. If no 582configurations. If no resources are specified, suitable defaults will
472resources are specified, suitable defaults will be used. Command-line 583be used. Command-line arguments can be used to override resource
473arguments can be used to override resource settings. The following 584settings. The following resources are supported (you might want to
474resources are allowed: 585check the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for additional settings by perl
586extensions not documented here):
587.IP "\fBdepth:\fR \fIbitdepth\fR" 4
588.IX Item "depth: bitdepth"
589Compile \fIxft\fR: Attempt to find a visual with the given bit depth;
590option \fB\-depth\fR.
475.IP "\fBgeometry:\fR \fIgeom\fR" 4 591.IP "\fBgeometry:\fR \fIgeom\fR" 4
476.IX Item "geometry: geom" 592.IX Item "geometry: geom"
477Create the window with the specified X window geometry [default 80x24]; 593Create the window with the specified X window geometry [default 80x24];
478option \fB\-geometry\fR. 594option \fB\-geometry\fR.
479.IP "\fBbackground:\fR \fIcolour\fR" 4 595.IP "\fBbackground:\fR \fIcolour\fR" 4
… …
541.IP "\fBinheritPixmap:\fR \fIboolean\fR" 4 657.IP "\fBinheritPixmap:\fR \fIboolean\fR" 4
542.IX Item "inheritPixmap: boolean" 658.IX Item "inheritPixmap: boolean"
543\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving 659\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving
544artificial transparency. \fBFalse\fR: do not inherit the parent windows' 660artificial transparency. \fBFalse\fR: do not inherit the parent windows'
545pixmap. 661pixmap.
662.Sp
663\&\fIPlease note that transparency of any kind if completely unsupported by
664the author. Don't bug him with installation questions!\fR
546.IP "\fBfading:\fR \fInumber\fR" 4 665.IP "\fBfading:\fR \fInumber\fR" 4
547.IX Item "fading: number" 666.IX Item "fading: number"
548Fade the text by the given percentage when focus is lost. 667Fade the text by the given percentage when focus is lost; option \fB\-fade\fR.
668.IP "\fBfadeColor:\fR \fIcolour\fR" 4
669.IX Item "fadeColor: colour"
670Fade to this colour, when fading is used (see \fBfading:\fR). The default
671colour is black; option \fB\-fadecolor\fR.
549.IP "\fBtintColor:\fR \fIcolour\fR" 4 672.IP "\fBtintColor:\fR \fIcolour\fR" 4
550.IX Item "tintColor: colour" 673.IX Item "tintColor: colour"
551Tint the transparent background pixmap with the given colour. 674Tint the transparent background pixmap with the given colour; option
675\&\fB\-tint\fR.
552.IP "\fBshading:\fR \fInumber\fR" 4 676.IP "\fBshading:\fR \fInumber\fR" 4
553.IX Item "shading: number" 677.IX Item "shading: number"
554Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background 678Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background
555image in addition to tinting it. 679image in addition to tinting it.
556.IP "\fBscrollColor:\fR \fIcolour\fR" 4 680.IP "\fBscrollColor:\fR \fIcolour\fR" 4
557.IX Item "scrollColor: colour" 681.IX Item "scrollColor: colour"
558Use the specified colour for the scrollbar [default #B2B2B2]. 682Use the specified colour for the scrollbar [default #B2B2B2].
559.IP "\fBtroughColor:\fR \fIcolour\fR" 4 683.IP "\fBtroughColor:\fR \fIcolour\fR" 4
560.IX Item "troughColor: colour" 684.IX Item "troughColor: colour"
561Use the specified colour for the scrollbar's trough area [default 685Use the specified colour for the scrollbar's trough area [default
562#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 686#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
563.IP "\fBborderColor:\fR \fIcolour\fR" 4 687.IP "\fBborderColor:\fR \fIcolour\fR" 4
564.IX Item "borderColor: colour" 688.IX Item "borderColor: colour"
565The colour of the border around the text area and between the scrollbar 689The colour of the border around the text area and between the scrollbar
566and the text. 690and the text.
567.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4 691.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4
… …
573centre (percent). A scale of 0 displays the image with tiling. A scale 697centre (percent). A scale of 0 displays the image with tiling. A scale
574of 1 displays the image without any scaling. A scale of 2 to 9 698of 1 displays the image without any scaling. A scale of 2 to 9
575specifies an integer number of images in that direction. No image will 699specifies an integer number of images in that direction. No image will
576be magnified beyond 10 times its original size. The maximum permitted 700be magnified beyond 10 times its original size. The maximum permitted
577scale is 1000. [default 0x0+50+50] 701scale is 1000. [default 0x0+50+50]
578.IP "\fBmenu:\fR \fIfile[;tag]\fR" 4
579.IX Item "menu: file[;tag]"
580Read in the specified menu file (note the `.menu' extension is
581optional) and also optionally specify a starting tag to find. See the
582reference documentation for details on the syntax for the menuBar.
583.IP "\fBpath:\fR \fIpath\fR" 4 702.IP "\fBpath:\fR \fIpath\fR" 4
584.IX Item "path: path" 703.IX Item "path: path"
585Specify the colon-delimited search path for finding files (\s-1XPM\s0 and 704Specify the colon-delimited search path for finding \s-1XPM\s0 files.
586menus), in addition to the paths specified by the \fB\s-1RXVTPATH\s0\fR and
587\&\fB\s-1PATH\s0\fR environment variables.
588.IP "\fBfont:\fR \fIfontlist\fR" 4 705.IP "\fBfont:\fR \fIfontlist\fR" 4
589.IX Item "font: fontlist" 706.IX Item "font: fontlist"
590Select the fonts to be used. This is a comma separated list of font 707Select the fonts to be used. This is a comma separated list of font names
591names that are used in turn when trying to display Unicode characters. 708that are checked in order when trying to find glyphs for characters. The
592The first font defines the cell size for characters; other fonts might 709first font defines the cell size for characters; other fonts might be
593be smaller, but not larger. A reasonable default font list is always 710smaller, but not (in general) larger. A (hopefully) reasonable default
594appended to it. option \fB\-fn\fR. 711font list is always appended to it; option \fB\-fn\fR.
595.Sp 712.Sp
596Each font can either be a standard X11 core font (\s-1XLFD\s0) name, with 713Each font can either be a standard X11 core font (\s-1XLFD\s0) name, with
597optional prefix \f(CW\*(C`x:\*(C'\fR or a Xft font (Compile \fIxft\fR), prefixed with \f(CW\*(C`xft:\*(C'\fR. 714optional prefix \f(CW\*(C`x:\*(C'\fR or a Xft font (Compile \fIxft\fR), prefixed with \f(CW\*(C`xft:\*(C'\fR.
598.Sp 715.Sp
599In addition, each font can be prefixed with additional hints and 716In addition, each font can be prefixed with additional hints and
… …
602fonts. 719fonts.
603.Sp 720.Sp
604For example, this font resource 721For example, this font resource
605.Sp 722.Sp
606.Vb 5 723.Vb 5
607\& URxvt*font: 9x15bold,\e 724\& URxvt.font: 9x15bold,\e
608\& -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\e 725\& \-misc\-fixed\-bold\-r\-normal\-\-15\-140\-75\-75\-c\-90\-iso10646\-1,\e
609\& -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \e 726\& \-misc\-fixed\-medium\-r\-normal\-\-15\-140\-75\-75\-c\-90\-iso10646\-1, \e
610\& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e 727\& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e
611\& xft:Code2000:antialias=false 728\& xft:Code2000:antialias=false
612.Ve 729.Ve
613.Sp 730.Sp
614specifies five fonts to be used. The first one is \f(CW\*(C`9x15bold\*(C'\fR (actually 731specifies five fonts to be used. The first one is \f(CW\*(C`9x15bold\*(C'\fR (actually
… …
647\&\*(L"morphing\*(R" the normal text font list into the desired shape. If that is 764\&\*(L"morphing\*(R" the normal text font list into the desired shape. If that is
648not possible, replacement fonts of the desired shape will be tried. 765not possible, replacement fonts of the desired shape will be tried.
649.Sp 766.Sp
650If set, but empty, then this specific style is disabled and the normal 767If set, but empty, then this specific style is disabled and the normal
651text font will being used for the given style. 768text font will being used for the given style.
769.IP "\fBintensityStyles:\fR \fIboolean\fR" 4
770.IX Item "intensityStyles: boolean"
771When font styles are not enabled, or this option is enabled (\fBTrue\fR,
772option \fB\-is\fR, the default), bold and italic font styles imply high
773intensity foreground/background colours. Disabling this option (\fBFalse\fR,
774option \fB+is\fR) disables this behaviour, the high intensity colours are not
775reachable.
652.IP "\fBselectstyle:\fR \fImode\fR" 4 776.IP "\fBselectstyle:\fR \fImode\fR" 4
653.IX Item "selectstyle: mode" 777.IX Item "selectstyle: mode"
654Set mouse selection style to \fBold\fR which is 2.20, \fBoldword\fR which is 778Set mouse selection style to \fBold\fR which is 2.20, \fBoldword\fR which is
655xterm style with 2.20 old word selection, or anything else which gives 779xterm style with 2.20 old word selection, or anything else which gives
656xterm style selection. 780xterm style selection.
657.IP "\fBscrollstyle:\fR \fImode\fR" 4 781.IP "\fBscrollstyle:\fR \fImode\fR" 4
658.IX Item "scrollstyle: mode" 782.IX Item "scrollstyle: mode"
659Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is 783Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is
660the author's favourite.. 784the author's favourite.
661.IP "\fBtitle:\fR \fIstring\fR" 4 785.IP "\fBtitle:\fR \fIstring\fR" 4
662.IX Item "title: string" 786.IX Item "title: string"
663Set window title string, the default title is the command-line 787Set window title string, the default title is the command-line
664specified after the \fB\-e\fR option, if any, otherwise the application 788specified after the \fB\-e\fR option, if any, otherwise the application
665name; option \fB\-title\fR. 789name; option \fB\-title\fR.
… …
689.IP "\fBprint\-pipe:\fR \fIstring\fR" 4 813.IP "\fBprint\-pipe:\fR \fIstring\fR" 4
690.IX Item "print-pipe: string" 814.IX Item "print-pipe: string"
691Specify a command pipe for vt100 printer [default \fI\fIlpr\fI\|(1)\fR]. Use 815Specify a command pipe for vt100 printer [default \fI\fIlpr\fI\|(1)\fR]. Use
692\&\fBPrint\fR to initiate a screen dump to the printer and \fBCtrl-Print\fR or 816\&\fBPrint\fR to initiate a screen dump to the printer and \fBCtrl-Print\fR or
693\&\fBShift-Print\fR to include the scrollback as well. 817\&\fBShift-Print\fR to include the scrollback as well.
818.Sp
819The string will be interpreted as if typed into the shell as\-is.
820.Sp
821Example:
822.Sp
823.Vb 1
824\& URxvt.print\-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
825.Ve
826.Sp
827This creates a new file in your home directory with the screen contents
828every time you hit \f(CW\*(C`Print\*(C'\fR.
694.IP "\fBscrollBar:\fR \fIboolean\fR" 4 829.IP "\fBscrollBar:\fR \fIboolean\fR" 4
695.IX Item "scrollBar: boolean" 830.IX Item "scrollBar: boolean"
696\&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR: 831\&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR:
697disable the scrollbar; option \fB+sb\fR. 832disable the scrollbar; option \fB+sb\fR.
698.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4 833.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4
… …
713\&\fBFalse\fR: do not scroll to bottom when tty receives output; option 848\&\fBFalse\fR: do not scroll to bottom when tty receives output; option
714\&\fB+si\fR. 849\&\fB+si\fR.
715.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4 850.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4
716.IX Item "scrollWithBuffer: boolean" 851.IX Item "scrollWithBuffer: boolean"
717\&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and 852\&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and
718\&\fBscrollTtyOutput\fR is False); option \fB+sw\fR. \fBFalse\fR: do not scroll 853\&\fBscrollTtyOutput\fR is False); option \fB\-sw\fR. \fBFalse\fR: do not scroll
719with scrollback buffer when tty recieves new lines; option \fB\-sw\fR. 854with scrollback buffer when tty receives new lines; option \fB+sw\fR.
720.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4 855.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4
721.IX Item "scrollTtyKeypress: boolean" 856.IX Item "scrollTtyKeypress: boolean"
722\&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys 857\&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys
723are those which are intercepted by rxvt-unicode for special handling and 858are those which are intercepted by rxvt-unicode for special handling and
724are not passed onto the shell; option \fB\-sk\fR. \fBFalse\fR: do not scroll to 859are not passed onto the shell; option \fB\-sk\fR. \fBFalse\fR: do not scroll to
… …
737option \fB\-w\fR, \fB\-bw\fR, \fB\-borderwidth\fR. 872option \fB\-w\fR, \fB\-bw\fR, \fB\-borderwidth\fR.
738.IP "\fBborderLess:\fR \fIboolean\fR" 4 873.IP "\fBborderLess:\fR \fIboolean\fR" 4
739.IX Item "borderLess: boolean" 874.IX Item "borderLess: boolean"
740Set \s-1MWM\s0 hints to request a borderless window, i.e. if honoured by the 875Set \s-1MWM\s0 hints to request a borderless window, i.e. if honoured by the
741\&\s-1WM\s0, the rxvt-unicode window will not have window decorations; option \fB\-bl\fR. 876\&\s-1WM\s0, the rxvt-unicode window will not have window decorations; option \fB\-bl\fR.
877.IP "\fBskipBuiltinGlyphs:\fR \fIboolean\fR" 4
878.IX Item "skipBuiltinGlyphs: boolean"
879Compile \fIfrills\fR: Disable the usage of the built-in block graphics/line
880drawing characters and just rely on what the specified fonts provide. Use
881this if you have a good font and want to use its block graphic glyphs;
882option \fB\-sbg\fR.
742.IP "\fBtermName:\fR \fItermname\fR" 4 883.IP "\fBtermName:\fR \fItermname\fR" 4
743.IX Item "termName: termname" 884.IX Item "termName: termname"
744Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment 885Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment
745variable; option \fB\-tn\fR. 886variable; option \fB\-tn\fR.
746.IP "\fBlinespace:\fR \fInumber\fR" 4 887.IP "\fBlinespace:\fR \fInumber\fR" 4
… …
774.IP "\fBpointerColor2:\fR \fIcolour\fR" 4 915.IP "\fBpointerColor2:\fR \fIcolour\fR" 4
775.IX Item "pointerColor2: colour" 916.IX Item "pointerColor2: colour"
776Mouse pointer background colour. 917Mouse pointer background colour.
777.IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4 918.IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4
778.IX Item "pointerBlankDelay: number" 919.IX Item "pointerBlankDelay: number"
779Specifies number of seconds before blanking the pointer [default 2]. 920Specifies number of seconds before blanking the pointer [default 2]. Use a
921large number (e.g. \f(CW987654321\fR) to effectively disable the timeout.
780.IP "\fBbackspacekey:\fR \fIstring\fR" 4 922.IP "\fBbackspacekey:\fR \fIstring\fR" 4
781.IX Item "backspacekey: string" 923.IX Item "backspacekey: string"
782The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR 924The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR
783or unset it will send \fBDelete\fR (code 127) or, if shifted, \fBBackspace\fR 925or unset it will send \fBDelete\fR (code 127) or, if shifted, \fBBackspace\fR
784(code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode 926(code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode
… …
788The string to send when the delete key (not the keypad delete key) is 930The string to send when the delete key (not the keypad delete key) is
789pressed. If unset it will send the sequence traditionally associated 931pressed. If unset it will send the sequence traditionally associated
790with the \fBExecute\fR key. 932with the \fBExecute\fR key.
791.IP "\fBcutchars:\fR \fIstring\fR" 4 933.IP "\fBcutchars:\fR \fIstring\fR" 4
792.IX Item "cutchars: string" 934.IX Item "cutchars: string"
793The characters used as delimiters for double-click word selection. The 935The characters used as delimiters for double-click word selection
794built-in default: 936(whitespace delimiting is added automatically if resource is given).
937.Sp
938When the selection extension is in use (the default if compiled in, see
939the @@RXVT_NAME@@\fIperl\fR\|(3) manpage), a suitable regex using these characters
940will be created (if the resource exists, otherwise, no regex will be
941created). In this mode, characters outside \s-1ISO\-8859\-1\s0 can be used.
942.Sp
943When the selection extension is not used, only \s-1ISO\-8859\-1\s0 characters can
944be used. If not specified, the built-in default is used:
795.Sp 945.Sp
796\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]{|}\fR 946\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]{|}\fR
797.IP "\fBpreeditType:\fR \fIstyle\fR" 4 947.IP "\fBpreeditType:\fR \fIstyle\fR" 4
798.IX Item "preeditType: style" 948.IX Item "preeditType: style"
799\&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR. 949\&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR.
… …
803.IP "\fBimLocale:\fR \fIname\fR" 4 953.IP "\fBimLocale:\fR \fIname\fR" 4
804.IX Item "imLocale: name" 954.IX Item "imLocale: name"
805The locale to use for opening the \s-1IM\s0. You can use an \f(CW\*(C`LC_CTYPE\*(C'\fR of e.g. 955The locale to use for opening the \s-1IM\s0. You can use an \f(CW\*(C`LC_CTYPE\*(C'\fR of e.g.
806\&\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 956\&\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
807input extension to be able to input japanese characters while staying in 957input extension to be able to input japanese characters while staying in
808another locale. option \fB\-imlocale\fR. 958another locale; option \fB\-imlocale\fR.
809.IP "\fBimFont:\fR \fIfontset\fR" 4 959.IP "\fBimFont:\fR \fIfontset\fR" 4
810.IX Item "imFont: fontset" 960.IX Item "imFont: fontset"
811Specify the font-set used for \s-1XIM\s0 styles \f(CW\*(C`OverTheSpot\*(C'\fR or 961Specify the font-set used for \s-1XIM\s0 styles \f(CW\*(C`OverTheSpot\*(C'\fR or
812\&\f(CW\*(C`OffTheSpot\*(C'\fR. It must be a standard X font set (\s-1XLFD\s0 patterns separated 962\&\f(CW\*(C`OffTheSpot\*(C'\fR. It must be a standard X font set (\s-1XLFD\s0 patterns separated
813by commas), i.e. it's not in the same format as the other font lists used 963by commas), i.e. it's not in the same format as the other font lists used
… …
816option \fB\-imfont\fR. 966option \fB\-imfont\fR.
817.IP "\fBtripleclickwords:\fR \fIboolean\fR" 4 967.IP "\fBtripleclickwords:\fR \fIboolean\fR" 4
818.IX Item "tripleclickwords: boolean" 968.IX Item "tripleclickwords: boolean"
819Change the meaning of triple-click selection with the left mouse 969Change the meaning of triple-click selection with the left mouse
820button. Instead of selecting a full line it will extend the selection to 970button. Instead of selecting a full line it will extend the selection to
821the end of the logical line only. option \fB\-tcw\fR. 971the end of the logical line only; option \fB\-tcw\fR.
822.IP "\fBinsecure:\fR \fIboolean\fR" 4 972.IP "\fBinsecure:\fR \fIboolean\fR" 4
823.IX Item "insecure: boolean" 973.IX Item "insecure: boolean"
824Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that 974Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that
825echo arbitrary strings like the icon name or the locale. This could be 975echo arbitrary strings like the icon name or the locale. This could be
826abused if somebody gets 8\-bit\-clean access to your display, whether 976abused if somebody gets 8\-bit\-clean access to your display, whether
827throuh a mail client displaying mail bodies unfiltered or though 977through a mail client displaying mail bodies unfiltered or through
828\&\fIwrite\fR\|(1). Therefore, these sequences are disabled by default. (Note 978\&\fIwrite\fR\|(1) or any other means. Therefore, these sequences are disabled by
829that other terminals, including xterm, have these sequences 979default. (Note that many other terminals, including xterm, have these
830enabled by default). You can enable them by setting this boolean 980sequences enabled by default, which doesn't make it safer, though).
831resource or specifying \fB\-insecure\fR as an option. At the moment, this 981.Sp
832enabled display\-answer, locale, findfont, icon label and window title 982You can enable them by setting this boolean resource or specifying
833requests as well as dynamic menubar dispatch. 983\&\fB\-insecure\fR as an option. At the moment, this enables display\-answer,
984locale, findfont, icon label and window title requests.
834.IP "\fBmodifier:\fR \fImodifier\fR" 4 985.IP "\fBmodifier:\fR \fImodifier\fR" 4
835.IX Item "modifier: modifier" 986.IX Item "modifier: modifier"
836Set the key to be interpreted as the Meta key to: \fBalt\fR, \fBmeta\fR, 987Set the key to be interpreted as the Meta key to: \fBalt\fR, \fBmeta\fR,
837\&\fBhyper\fR, \fBsuper\fR, \fBmod1\fR, \fBmod2\fR, \fBmod3\fR, \fBmod4\fR, \fBmod5\fR; option 988\&\fBhyper\fR, \fBsuper\fR, \fBmod1\fR, \fBmod2\fR, \fBmod3\fR, \fBmod4\fR, \fBmod5\fR; option
838\&\fB\-mod\fR. 989\&\fB\-mod\fR.
839.IP "\fBanswerbackString:\fR \fIstring\fR" 4 990.IP "\fBanswerbackString:\fR \fIstring\fR" 4
840.IX Item "answerbackString: string" 991.IX Item "answerbackString: string"
841Specify the reply rxvt-unicode sends to the shell when an \s-1ENQ\s0 (control\-E) 992Specify the reply rxvt-unicode sends to the shell when an \s-1ENQ\s0 (control\-E)
842character is passed through. It may contain escape values as described 993character is passed through. It may contain escape values as described
843in the entry on \fBkeysym\fR following. 994in the entry on \fBkeysym\fR following.
844.IP "\fBsecondaryScreen:\fR \fIbool\fR" 4 995.IP "\fBsecondaryScreen:\fR \fIboolean\fR" 4
845.IX Item "secondaryScreen: bool" 996.IX Item "secondaryScreen: boolean"
846Turn on/off secondary screen (default enabled). 997Turn on/off secondary screen (default enabled).
847.IP "\fBsecondaryScroll:\fR \fIbool\fR" 4 998.IP "\fBsecondaryScroll:\fR \fIboolean\fR" 4
848.IX Item "secondaryScroll: bool" 999.IX Item "secondaryScroll: boolean"
849Turn on/off secondary screen scroll (default enabled). If the this 1000Turn on/off secondary screen scroll (default enabled). If the this
850option is enabled, scrolls on the secondary screen will change the 1001option is enabled, scrolls on the secondary screen will change the
851scrollback buffer and switching to/from the secondary screen will 1002scrollback buffer and switching to/from the secondary screen will
852instead scroll the screen up. 1003instead scroll the screen up.
1004.IP "\fBhold\fR: \fIboolean\fR" 4
1005.IX Item "hold: boolean"
1006Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1007will not immediately destroy its window when the program executed within
1008it exits. Instead, it will wait till it is being killed or closed by the
1009user.
853.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4 1010.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4
854.IX Item "keysym.sym: string" 1011.IX Item "keysym.sym: string"
855Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The 1012Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The
856intervening resource name \fBkeysym.\fR cannot be omitted. 1013intervening resource name \fBkeysym.\fR cannot be omitted.
857.Sp 1014.Sp
… …
876\&\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, 1033\&\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,
877\&\f(CW\*(C`\e000\*(C'\fR: octal number) or verbatim control characters (\f(CW\*(C`^?\*(C'\fR: delete, 1034\&\f(CW\*(C`\e000\*(C'\fR: octal number) or verbatim control characters (\f(CW\*(C`^?\*(C'\fR: delete,
878\&\f(CW\*(C`^@\*(C'\fR: null, \f(CW\*(C`^A\*(C'\fR ...) and may be enclosed with double quotes so that it 1035\&\f(CW\*(C`^@\*(C'\fR: null, \f(CW\*(C`^A\*(C'\fR ...) and may be enclosed with double quotes so that it
879can start or end with whitespace. 1036can start or end with whitespace.
880.Sp 1037.Sp
1038Please note that you need to double the \f(CW\*(C`\e\*(C'\fR in resource files, as
1039Xlib itself does its own de-escaping (you can use \f(CW\*(C`\e033\*(C'\fR instead of
1040\&\f(CW\*(C`\ee\*(C'\fR (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1041processing).
1042.Sp
881You can define a range of keysyms in one shot by providing a \fIstring\fR 1043You can define a range of keysyms in one shot by providing a \fIstring\fR
882with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/' 1044with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimiter `/'
883should be a character not used by the strings. 1045should be a character not used by the strings.
884.Sp 1046.Sp
885Its usage can be demonstrated by an example: 1047Its usage can be demonstrated by an example:
886.Sp 1048.Sp
887.Vb 1 1049.Vb 1
888\& URxvt.keysym.M-C-0x61: list|\ee<M-C-|abc|> 1050\& URxvt.keysym.M\-C\-0x61: list|\e033<M\-C\-|abc|>
889.Ve 1051.Ve
890.Sp 1052.Sp
891The above line is equivalent to the following three lines: 1053The above line is equivalent to the following three lines:
892.Sp 1054.Sp
893.Vb 3 1055.Vb 3
894\& URxvt.keysym.Meta-Control-0x61: \ee<M-C-a> 1056\& URxvt.keysym.Meta\-Control\-0x61: \e033<M\-C\-a>
895\& URxvt.keysym.Meta-Control-0x62: \ee<M-C-b> 1057\& URxvt.keysym.Meta\-Control\-0x62: \e033<M\-C\-b>
896\& URxvt.keysym.Meta-Control-0x63: \ee<M-C-c> 1058\& URxvt.keysym.Meta\-Control\-0x63: \e033<M\-C\-c>
897.Ve 1059.Ve
898.Sp 1060.Sp
899If \fIstring\fR takes the form of \f(CW\*(C`proto:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR 1061If \fIstring\fR takes the form of \f(CW\*(C`command:STRING\*(C'\fR, the specified \fB\s-1STRING\s0\fR
900is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1062is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
901example the following means "change the current locale to \f(CW\*(C`zh_CN.GBK\*(C'\fR 1063example the following means "change the current locale to \f(CW\*(C`zh_CN.GBK\*(C'\fR
902when Control-Meta-c is being pressed": 1064when Control-Meta-c is being pressed":
903.Sp 1065.Sp
904.Vb 1 1066.Vb 1
905\& URxvt.keysym.M-C-c: proto:\e033]701;zh_CN.GBK\e007 1067\& URxvt.keysym.M\-C\-c: command:\e033]701;zh_CN.GBK\e007
906.Ve 1068.Ve
1069.Sp
1070If \fIstring\fR takes the form \f(CW\*(C`perl:STRING\*(C'\fR, then the specified \fB\s-1STRING\s0\fR
1071is passed to the \f(CW\*(C`on_keyboard_command\*(C'\fR perl handler. See the @@RXVT_NAME@@\fIperl\fR\|(3)
1072manpage. For example, the \fIselection\fR extension (activated via
1073\&\f(CW\*(C`@@RXVT_NAME@@ \-pe selection\*(C'\fR) listens for \f(CW\*(C`selection:rot13\*(C'\fR events:
1074.Sp
1075.Vb 1
1076\& URxvt.keysym.M\-C\-c: perl:selection:rot13
1077.Ve
1078.Sp
1079Due the the large number of modifier combinations, a defined key mapping
1080will match if at \fIat least\fR the specified identifiers are being set, and
1081no other key mappings with those and more bits are being defined. That
1082means that defining a key map for \f(CW\*(C`a\*(C'\fR will automatically provide
1083definitions for \f(CW\*(C`Meta\-a\*(C'\fR, \f(CW\*(C`Shift\-a\*(C'\fR and so on, unless some of those are defined
1084mappings themselves.
1085.Sp
1086Unfortunately, this will override built-in key mappings. For example
1087if you overwrite the \f(CW\*(C`Insert\*(C'\fR key you will disable @@RXVT_NAME@@'s
1088\&\f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke \*(L"holes\*(R" into the
1089user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement:
1090.Sp
1091.Vb 2
1092\& URxvt.keysym.Insert: <my insert key sequence>
1093\& URxvt.keysym.S\-Insert: builtin:
1094.Ve
1095.Sp
1096The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination
1097of modifiers. The second line re-establishes the default mapping for
1098\&\f(CW\*(C`Shift\-Insert\*(C'\fR.
907.Sp 1099.Sp
908The following example will map Control\-Meta\-1 and Control\-Meta\-2 to 1100The following example will map Control\-Meta\-1 and Control\-Meta\-2 to
909the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you cna have some limited 1101the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited
910font-switching at runtime: 1102font-switching at runtime:
911.Sp 1103.Sp
912.Vb 2 1104.Vb 2
913\& URxvt.keysym.M-C-1: proto:\e033]50;suxuseuro\e007 1105\& URxvt.keysym.M\-C\-1: command:\e033]50;suxuseuro\e007
914\& URxvt.keysym.M-C-2: proto:\e033]50;9x15bold\e007 1106\& URxvt.keysym.M\-C\-2: command:\e033]50;9x15bold\e007
915.Ve 1107.Ve
916.Sp 1108.Sp
917\&\f(CW\*(C`proto:\e033]701;zh_CN.GBK\e007\*(C'\fR means: change the current locale to 1109Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
918\&\f(CW\*(C`zh_CN.GBK\*(C'\fR. 1110info):
1111.Sp
1112.Vb 2
1113\& URxvt.keysym.M\-C\-3: command:\e033[8;25;80t
1114\& URxvt.keysym.M\-C\-4: command:\e033[8;48;110t
1115.Ve
1116.IP "\fBperl-ext-common\fR: \fIstring\fR" 4
1117.IX Item "perl-ext-common: string"
1118.PD 0
1119.IP "\fBperl-ext\fR: \fIstring\fR" 4
1120.IX Item "perl-ext: string"
1121.PD
1122Comma-separated list(s) of perl extension scripts (default: \f(CW\*(C`default\*(C'\fR) to
1123use in this terminal instance; option \fB\-pe\fR.
1124.Sp
1125Extension names can be prefixed with a \f(CW\*(C`\-\*(C'\fR sign to prohibit using
1126them. This can be useful to selectively disable some extensions loaded
1127by default, or specified via the \f(CW\*(C`perl\-ext\-common\*(C'\fR resource. For
1128example, \f(CW\*(C`default,\-selection\*(C'\fR will use all the default extension except
1129\&\f(CW\*(C`selection\*(C'\fR.
1130.Sp
1131Extension names can also be followed by an argument in angle brackets
1132(e.g. \f(CW\*(C`searchable\-scrollback<M\-s>\*(C'\fR, which binds the hotkey for
1133searchable scrollback to Alt/Meta\-s). Mentioning the same extension
1134multiple times with different arguments will pass multiple arguments to
1135the extension.
1136.Sp
1137Each extension is looked up in the library directories, loaded if
1138necessary, and bound to the current terminal instance.
1139.Sp
1140If both of these resources are the empty string, then the perl
1141interpreter will not be initialized. The idea behind two options is that
1142\&\fBperl-ext-common\fR will be used for extensions that should be available to
1143all instances, while \fBperl-ext\fR is used for specific instances.
1144.IP "\fBperl-eval\fR: \fIstring\fR" 4
1145.IX Item "perl-eval: string"
1146Perl code to be evaluated when all extensions have been registered. See
1147the @@RXVT_NAME@@\fIperl\fR\|(3) manpage. Due to security reasons, this resource
1148will be ignored when running setuid/setgid.
1149.IP "\fBperl-lib\fR: \fIpath\fR" 4
1150.IX Item "perl-lib: path"
1151Colon-separated list of additional directories that hold extension
1152scripts. When looking for extensions specified by the \f(CW\*(C`perl\*(C'\fR resource,
1153@@RXVT_NAME@@ will first look in these directories and then in
1154\&\fI@@RXVT_LIBDIR@@/urxvt/perl/\fR. Due to security reasons, this resource
1155will be ignored when running setuid/setgid.
1156.Sp
1157See the @@RXVT_NAME@@\fIperl\fR\|(3) manpage.
1158.IP "\fBselection.pattern\-\f(BIidx\fB\fR: \fIperl-regex\fR" 4
1159.IX Item "selection.pattern-idx: perl-regex"
1160Additional selection patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for
1161details.
1162.IP "\fBselection\-autotransform.\f(BIidx\fB\fR: \fIperl-transform\fR" 4
1163.IX Item "selection-autotransform.idx: perl-transform"
1164Selection auto-transform patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage
1165for details.
1166.IP "\fBsearchable\-scrollback:\fR \fIkeysym\fR" 4
1167.IX Item "searchable-scrollback: keysym"
1168Sets the hotkey that starts the incremental scrollback buffer search
1169(default: \f(CW\*(C`M\-s\*(C'\fR).
1170.IP "\fBurlLauncher\fR: \fIstring\fR" 4
1171.IX Item "urlLauncher: string"
1172Specifies the program to be started with a \s-1URL\s0 argument. Used by the
1173\&\f(CW\*(C`selection\-popup\*(C'\fR and \f(CW\*(C`mark\-urls\*(C'\fR perl extensions.
1174.IP "\fBtransient-for\fR: \fIwindowid\fR" 4
1175.IX Item "transient-for: windowid"
1176Compile \fIfrills\fR: Sets the \s-1WM_TRANSIENT_FOR\s0 property to the given window id.
1177.IP "\fBoverride-redirect\fR: \fIboolean\fR" 4
1178.IX Item "override-redirect: boolean"
1179Compile \fIfrills\fR: Sets override-redirect for the terminal window, making
1180it almost invisible to window managers; option \fB\-override\-redirect\fR.
919.SH "THE SCROLLBAR" 1181.SH "THE SCROLLBAR"
920.IX Header "THE SCROLLBAR" 1182.IX Header "THE SCROLLBAR"
921Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window 1183Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window
922(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar 1184(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar
923or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and 1185or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and
… …
933the normal text selection/insertion, hold either the Shift or the Meta 1195the normal text selection/insertion, hold either the Shift or the Meta
934(Alt) key while performing the desired mouse action. 1196(Alt) key while performing the desired mouse action.
935.PP 1197.PP
936If mouse reporting mode is active, the normal scrollbar actions are 1198If mouse reporting mode is active, the normal scrollbar actions are
937disabled \*(-- on the assumption that we are using a fullscreen 1199disabled \*(-- on the assumption that we are using a fullscreen
938application. Instead, pressing Button1 and Button3 sends \fBESC[6~\fR 1200application. Instead, pressing Button1 and Button3 sends \fB\s-1ESC\s0 [ 6 ~\fR
939(Next) and \fBESC[5~\fR (Prior), respectively. Similarly, clicking on the 1201(Next) and \fB\s-1ESC\s0 [ 5 ~\fR (Prior), respectively. Similarly, clicking on the
940up and down arrows sends \fBESC[A\fR (Up) and \fBESC[B\fR (Down), 1202up and down arrows sends \fB\s-1ESC\s0 [ A\fR (Up) and \fB\s-1ESC\s0 [ B\fR (Down),
941respectively. 1203respectively.
942.SH "TEXT SELECTION AND INSERTION" 1204.SH "TEXT SELECTION AND INSERTION"
943.IX Header "TEXT SELECTION AND INSERTION" 1205.IX Header "TEXT SELECTION AND INSERTION"
944The behaviour of text selection and insertion mechanism is similar to 1206The behaviour of text selection and insertion mechanism is similar to
945\&\fIxterm\fR(1). 1207\&\fIxterm\fR(1).
… …
950to select a word; Left triple-click to select the entire logical line 1212to select a word; Left triple-click to select the entire logical line
951(which can span multiple screen lines), unless modified by resource 1213(which can span multiple screen lines), unless modified by resource
952\&\fBtripleclickwords\fR. 1214\&\fBtripleclickwords\fR.
953.Sp 1215.Sp
954Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys) 1216Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys)
955(Compile: \fIfrills\fR) will create a rectangular selection instead of a normal 1217(Compile: \fIfrills\fR) will create a rectangular selection instead of a
956one. 1218normal one. In this mode, every selected row becomes its own line in the
1219selection, and trailing whitespace is visually underlined and removed from
1220the selection.
957.IP "\fBInsertion\fR:" 4 1221.IP "\fBInsertion\fR:" 4
958.IX Item "Insertion:" 1222.IX Item "Insertion:"
959Pressing and releasing the Middle mouse button (or \fBShift-Insert\fR) in 1223Pressing and releasing the Middle mouse button in an \fB@@RXVT_NAME@@\fR
960an \fB@@RXVT_NAME@@\fR window causes the current text selection to be 1224window causes the value of the \s-1PRIMARY\s0 selection (or \s-1CLIPBOARD\s0 with the
961inserted as if it had been typed on the keyboard. 1225Meta modifier) to be inserted as if it had been typed on the keyboard.
1226.Sp
1227Pressing \fBShift-Insert\fR causes the value of the \s-1PRIMARY\s0 selection to be
1228inserted too.
962.SH "CHANGING FONTS" 1229.SH "CHANGING FONTS"
963.IX Header "CHANGING FONTS" 1230.IX Header "CHANGING FONTS"
964Changing fonts (or font sizes, respectively) via the keypad is not yet 1231Changing fonts (or font sizes, respectively) via the keypad is not yet
965supported in rxvt\-unicode. Bug me if you need this. 1232supported in rxvt\-unicode. Bug me if you need this.
966.PP 1233.PP
967You can, however, switch fonts at runtime using escape sequences (and 1234You can, however, switch fonts at runtime using escape sequences, e.g.:
968therefore using the menubar), e.g.:
969.PP 1235.PP
970.Vb 1 1236.Vb 1
971\& printf '\ee]701;%s\e007' "9x15bold,xft:Kochi Gothic" 1237\& printf '\ee]710;%s\e007' "9x15bold,xft:Kochi Gothic"
1238.Ve
1239.PP
1240You can use keyboard shortcuts, too:
1241.PP
1242.Vb 2
1243\& URxvt.keysym.M\-C\-1: command:\e033]710;suxuseuro\e007\e033]711;suxuseuro\e007
1244\& URxvt.keysym.M\-C\-2: command:\e033]710;9x15bold\e007\e033]711;9x15bold\e007
972.Ve 1245.Ve
973.PP 1246.PP
974rxvt-unicode will automatically re-apply these fonts to the output so far. 1247rxvt-unicode will automatically re-apply these fonts to the output so far.
975.SH "ISO 14755 SUPPORT" 1248.SH "ISO 14755 SUPPORT"
976.IX Header "ISO 14755 SUPPORT" 1249.IX Header "ISO 14755 SUPPORT"
977\&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters 1250\&\s-1ISO\s0 14755 is a standard for entering and viewing unicode characters
978and character codes using the keyboard. It consists of 4 parts. The 1251and character codes using the keyboard. It consists of 4 parts. The
979first part is available rxvt-unicode has been compiled with 1252first part is available rxvt-unicode has been compiled with
980\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled 1253\&\f(CW\*(C`\-\-enable\-frills\*(C'\fR, the rest is available when rxvt-unicode was compiled
981with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR. 1254with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR.
1255.IP "\(bu" 4
982.IP "* 5.1: Basic method" 4 12565.1: Basic method
983.IX Item "5.1: Basic method" 1257.Sp
984This allows you to enter unicode characters using their hexcode. 1258This allows you to enter unicode characters using their hexcode.
985.Sp 1259.Sp
986Start by pressing and holding both \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, then enter 1260Start by pressing and holding both \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR, then enter
987hex-digits (between one and six). Releasing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR will 1261hex-digits (between one and six). Releasing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR will
988commit the character as if it were typed directly. While holding down 1262commit the character as if it were typed directly. While holding down
… …
993As an example of use, imagine a business card with a japanese e\-mail 1267As an example of use, imagine a business card with a japanese e\-mail
994address, which you cannot type. Fortunately, the card has the e\-mail 1268address, which you cannot type. Fortunately, the card has the e\-mail
995address printed as hexcodes, e.g. \f(CW\*(C`671d 65e5\*(C'\fR. You can enter this easily 1269address printed as hexcodes, e.g. \f(CW\*(C`671d 65e5\*(C'\fR. You can enter this easily
996by 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, 1270by 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,
997followed by releasing the modifier keys. 1271followed by releasing the modifier keys.
1272.IP "\(bu" 4
998.IP "* 5.2: Keyboard symbols entry method" 4 12735.2: Keyboard symbols entry method
999.IX Item "5.2: Keyboard symbols entry method" 1274.Sp
1000This mode lets you input characters representing the keycap symbols of 1275This mode lets you input characters representing the keycap symbols of
1001your keyboard, if representable in the current locale encoding. 1276your keyboard, if representable in the current locale encoding.
1002.Sp 1277.Sp
1003Start by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then releasing 1278Start by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then releasing
1004them. The next special key (cursor keys, home etc.) you enter will not 1279them. The next special key (cursor keys, home etc.) you enter will not
1005invoke it's usual function but instead will insert the corresponding 1280invoke its usual function but instead will insert the corresponding
1006keycap symbol. The symbol will only be entered when the key has been 1281keycap symbol. The symbol will only be entered when the key has been
1007released, otherwise pressing e.g. \f(CW\*(C`Shift\*(C'\fR would enter the symbol for 1282released, otherwise pressing e.g. \f(CW\*(C`Shift\*(C'\fR would enter the symbol for
1008\&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a 1283\&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a
1009reverse tab (Shift\-Tab). 1284reverse tab (Shift\-Tab).
1285.IP "\(bu" 4
1010.IP "* 5.3: Screen-selection entry method" 4 12865.3: Screen-selection entry method
1011.IX Item "5.3: Screen-selection entry method" 1287.Sp
1012While this is implemented already (it's basically the selection 1288While this is implemented already (it's basically the selection
1013mechanism), it could be extended by displaying a unicode character map. 1289mechanism), it could be extended by displaying a unicode character map.
1290.IP "\(bu" 4
1014.IP "* 5.4: Feedback method for identifying displayed characters for later input" 4 12915.4: Feedback method for identifying displayed characters for later input
1015.IX Item "5.4: Feedback method for identifying displayed characters for later input" 1292.Sp
1016This method lets you display the unicode character code associated with 1293This method lets you display the unicode character code associated with
1017characters already displayed. 1294characters already displayed.
1018.Sp 1295.Sp
1019You enter this mode by holding down \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then 1296You enter this mode by holding down \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then
1020pressing and holding the left mouse button and moving around. The unicode 1297pressing and holding the left mouse button and moving around. The unicode
… …
1037.SH "COLORS AND GRAPHICS" 1314.SH "COLORS AND GRAPHICS"
1038.IX Header "COLORS AND GRAPHICS" 1315.IX Header "COLORS AND GRAPHICS"
1039In addition to the default foreground and background colours, 1316In addition to the default foreground and background colours,
1040\&\fB@@RXVT_NAME@@\fR can display up to 16 colours (8 \s-1ANSI\s0 colours plus 1317\&\fB@@RXVT_NAME@@\fR can display up to 16 colours (8 \s-1ANSI\s0 colours plus
1041high-intensity bold/blink versions of the same). Here is a list of the 1318high-intensity bold/blink versions of the same). Here is a list of the
1042colours with their \fBrgb.txt\fR names. 1319colours with their names.
1043.TS 1320.TS
1044l l l . 1321l l l .
1045color0 (black) = Black 1322color0 (black) = Black
1046color1 (red) = Red3 1323color1 (red) = Red3
1047color2 (green) = Green3 1324color2 (green) = Green3
… …
1059color14 (bright cyan) = Cyan 1336color14 (bright cyan) = Cyan
1060color15 (bright white) = White 1337color15 (bright white) = White
1061foreground = Black 1338foreground = Black
1062background = White 1339background = White
1063.TE 1340.TE
1064
1065.PP 1341.PP
1066It is also possible to specify the colour values of \fBforeground\fR, 1342It is also possible to specify the colour values of \fBforeground\fR,
1067\&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as 1343\&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as
1068a number 0\-15, as a convenient shorthand to reference the colour name of 1344a number 0\-15, as a convenient shorthand to reference the colour name of
1069color0\-color15. 1345color0\-color15.
1346.PP
1347In addition to the colours defined above, @@RXVT_NAME@@ offers an
1348additional 72 colours. The first 64 of those (with indices 16 to 79)
1349consist of a 4*4*4 \s-1RGB\s0 colour cube (i.e. \fIindex = r * 16 + g * 4 + b +
135016\fR), followed by 8 additional shades of gray (with indices 80 to 87).
1351.PP
1352Together, all those colours implement the 88 colour xterm colours. Only
1353the first 16 can be changed using resources currently, the rest can only
1354be changed via command sequences (\*(L"escape codes\*(R").
1070.PP 1355.PP
1071Note that \fB\-rv\fR (\fB\*(L"reverseVideo: True\*(R"\fR) simulates reverse video by 1356Note that \fB\-rv\fR (\fB\*(L"reverseVideo: True\*(R"\fR) simulates reverse video by
1072always swapping the foreground/background colours. This is in contrast to 1357always swapping the foreground/background colours. This is in contrast to
1073\&\fIxterm\fR(1) where the colours are only swapped if they have not otherwise 1358\&\fIxterm\fR(1) where the colours are only swapped if they have not otherwise
1074been specified. For example, 1359been specified. For example,
1075.IP "\fB@@RXVT_NAME@@ \-fg Black \-bg White \-rv\fR" 4 1360.IP "\fB@@RXVT_NAME@@ \-fg Black \-bg White \-rv\fR" 4
1076.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv" 1361.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv"
1077would yield White on Black, while on \fIxterm\fR(1) it would yield Black 1362would yield White on Black, while on \fIxterm\fR(1) it would yield Black
1078on White. 1363on White.
1364.Sh "\s-1ALPHA\s0 \s-1CHANNEL\s0 \s-1SUPPORT\s0"
1365.IX Subsection "ALPHA CHANNEL SUPPORT"
1366If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1367their act together, rxvt-unicode will support \f(CW\*(C`rgba:rrrr/gggg/bbbb/aaaa\*(C'\fR
1368(recommended, but \fB\s-1MUST\s0\fR have 4 digits/component) colour specifications,
1369in addition to the ones provided by X, where the additional A component
1370specifies opacity (alpha) values. The minimum value of \f(CW0\fR is completely
1371transparent). You can also prefix any color with \f(CW\*(C`[a]\*(C'\fR, where \f(CW\*(C`a\*(C'\fR is on
1372to four hex digits specifiying the opacity value.
1373.PP
1374You probably need to specify \fB\*(L"\-depth 32\*(R"\fR, too, and have the luck that
1375your X\-server uses \s-1ARGB\s0 pixel layout, as X is far from just supporting
1376\&\s-1ARGB\s0 visuals out of the box, and rxvt-unicode just fudges around.
1377.PP
1378For example, the following selects an almost completely transparent red
1379background, and an almost opaque pink foreground:
1380.PP
1381.Vb 1
1382\& @@RXVT_NAME@@ \-depth 32 \-bg rgba:0000/0000/0000/2222 \-fg "[e]pink"
1383.Ve
1384.PP
1385\&\fIPlease note that transparency of any kind if completely unsupported by
1386the author. Don't bug him with installation questions!\fR
1079.SH "ENVIRONMENT" 1387.SH "ENVIRONMENT"
1080.IX Header "ENVIRONMENT" 1388.IX Header "ENVIRONMENT"
1081\&\fB@@RXVT_NAME@@\fR sets the environment variables \fB\s-1TERM\s0\fR, \fB\s-1COLORTERM\s0\fR 1389\&\fB@@RXVT_NAME@@\fR sets and/or uses the following environment variables:
1082and \fB\s-1COLORFGBG\s0\fR. The environment variable \fB\s-1WINDOWID\s0\fR is set to the X 1390.IP "\fB\s-1TERM\s0\fR" 4
1083window id number of the \fB@@RXVT_NAME@@\fR window and it also uses and 1391.IX Item "TERM"
1084sets the environment variable \fB\s-1DISPLAY\s0\fR to specify which display 1392Normally set to \f(CW\*(C`rxvt\-unicode\*(C'\fR, unless overwritten at configure time, via
1085terminal to use. \fB@@RXVT_NAME@@\fR uses the environment variables 1393resources or on the command line.
1086\&\fB\s-1RXVTPATH\s0\fR and \fB\s-1PATH\s0\fR to find \s-1XPM\s0 files. 1394.IP "\fB\s-1COLORTERM\s0\fR" 4
1395.IX Item "COLORTERM"
1396Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on whether @@RXVT_NAME@@ was
1397compiled with \s-1XPM\s0 support, and optionally with the added extension
1398\&\f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome screen.
1399.IP "\fB\s-1COLORFGBG\s0\fR" 4
1400.IX Item "COLORFGBG"
1401Set 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
1402the colour code used as default foreground/text colour (or the string
1403\&\f(CW\*(C`default\*(C'\fR to indicate that the default-colour escape sequence is to be
1404used), \f(CW\*(C`bg\*(C'\fR is the colour code used as default background colour (or the
1405string \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@@
1406was compiled with \s-1XPM\s0 support. Libraries like \f(CW\*(C`ncurses\*(C'\fR and \f(CW\*(C`slang\*(C'\fR can
1407(and do) use this information to optimize screen output.
1408.IP "\fB\s-1WINDOWID\s0\fR" 4
1409.IX Item "WINDOWID"
1410Set to the (decimal) X Window \s-1ID\s0 of the @@RXVT_NAME@@ window (the toplevel
1411window, which usually has subwindows for the scrollbar, the terminal
1412window and so on).
1413.IP "\fB\s-1TERMINFO\s0\fR" 4
1414.IX Item "TERMINFO"
1415Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1416\&\f(CW\*(C`\-\-with\-terminfo=PATH\*(C'\fR.
1417.IP "\fB\s-1DISPLAY\s0\fR" 4
1418.IX Item "DISPLAY"
1419Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1420display in its child processes.
1421.IP "\fB\s-1SHELL\s0\fR" 4
1422.IX Item "SHELL"
1423The shell to be used for command execution, defaults to \f(CW\*(C`/bin/sh\*(C'\fR.
1424.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
1425.IX Item "RXVT_SOCKET"
1426The unix domain socket path used by @@RXVT_NAME@@c(1) and
1427@@RXVT_NAME@@d(1).
1428.Sp
1429Default \fI\f(CI$HOME\fI/.rxvt\-unicode\-\fI<nodename\fI\fR.
1430.IP "\fB\s-1HOME\s0\fR" 4
1431.IX Item "HOME"
1432Used to locate the default directory for the unix domain socket for
1433daemon communications and to locate various resource files (such as
1434\&\f(CW\*(C`.Xdefaults\*(C'\fR)
1435.IP "\fB\s-1XAPPLRESDIR\s0\fR" 4
1436.IX Item "XAPPLRESDIR"
1437Directory where various X resource files are being located.
1438.IP "\fB\s-1XENVIRONMENT\s0\fR" 4
1439.IX Item "XENVIRONMENT"
1440If set and accessible, gives the name of a X resource file to be loaded by
1441@@RXVT_NAME@@.
1087.SH "FILES" 1442.SH "FILES"
1088.IX Header "FILES" 1443.IX Header "FILES"
1089.IP "\fB/usr/lib/X11/rgb.txt\fR" 4 1444.IP "\fB/usr/lib/X11/rgb.txt\fR" 4
1090.IX Item "/usr/lib/X11/rgb.txt" 1445.IX Item "/usr/lib/X11/rgb.txt"
1091Color names. 1446Color names.
1092.SH "SEE ALSO" 1447.SH "SEE ALSO"
1093.IX Header "SEE ALSO" 1448.IX Header "SEE ALSO"
1094@@RXVT_NAME@@(7), \fIxterm\fR\|(1), \fIsh\fR\|(1), \fIresize\fR\|(1), X(1), \fIpty\fR\|(4), \fItty\fR\|(4), \fIutmp\fR\|(5) 1449@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), \fIxterm\fR\|(1), \fIsh\fR\|(1), \fIresize\fR\|(1), X(1), \fIpty\fR\|(4), \fItty\fR\|(4), \fIutmp\fR\|(5)
1095.SH "BUGS"
1096.IX Header "BUGS"
1097Check the \s-1BUGS\s0 file for an up-to-date list.
1098.PP
1099Cursor change support is not yet implemented.
1100.PP
1101Click-and-drag doesn't work with X11 mouse report overriding.
1102.SH "CURRENT PROJECT COORDINATOR" 1450.SH "CURRENT PROJECT COORDINATOR"
1103.IX Header "CURRENT PROJECT COORDINATOR" 1451.IX Header "CURRENT PROJECT COORDINATOR"
1104.IP "Project Coordinator" 4 1452.IP "Project Coordinator" 4
1105.IX Item "Project Coordinator" 1453.IX Item "Project Coordinator"
1106@@RXVT_MAINT@@ @@RXVT_MAINTEMAIL@@ 1454Marc A. Lehmann <rxvt\-unicode@schmorp.de>
1107.IP "Web page maintainter" 4
1108.IX Item "Web page maintainter"
1109@@RXVT_WEBMAINT@@ @@RXVT_WEBMAINTEMAIL@@
1110.Sp 1455.Sp
1111@@RXVT_WEBPAGE@@ 1456<http://software.schmorp.de/pkg/rxvt\-unicode.html>
1112.SH "AUTHORS" 1457.SH "AUTHORS"
1113.IX Header "AUTHORS" 1458.IX Header "AUTHORS"
1114.IP "John Bovey" 4 1459.IP "John Bovey" 4
1115.IX Item "John Bovey" 1460.IX Item "John Bovey"
1116University of Kent, 1992, wrote the original Xvt. 1461University of Kent, 1992, wrote the original Xvt.
… …
1128.IP "Oezguer Kesim <kesim@math.fu\-berlin.de>" 4 1473.IP "Oezguer Kesim <kesim@math.fu\-berlin.de>" 4
1129.IX Item "Oezguer Kesim <kesim@math.fu-berlin.de>" 1474.IX Item "Oezguer Kesim <kesim@math.fu-berlin.de>"
1130Project Coordinator (changes.txt 2.21a to 2.4.5) 1475Project Coordinator (changes.txt 2.21a to 2.4.5)
1131.IP "Geoff Wing <gcw@pobox.com>" 4 1476.IP "Geoff Wing <gcw@pobox.com>" 4
1132.IX Item "Geoff Wing <gcw@pobox.com>" 1477.IX Item "Geoff Wing <gcw@pobox.com>"
1133Rewrote screen display and text selection routines. Project Coordinator 1478Rewrote screen display and text selection routines.
1479.Sp
1134(changes.txt 2.4.6 \- rxvt\-unicode) 1480Project Coordinator (changes.txt 2.4.6 \- rxvt\-unicode)
1135.IP "Marc Alexander Lehmann <rxvt@schmorp.de>" 4 1481.IP "Marc Alexander Lehmann <rxvt\-unicode@schmorp.de>" 4
1136.IX Item "Marc Alexander Lehmann <rxvt@schmorp.de>" 1482.IX Item "Marc Alexander Lehmann <rxvt-unicode@schmorp.de>"
1137Forked rxvt\-unicode, rewrote most of the display code and internal 1483Forked rxvt\-unicode, unicode support, rewrote almost all the code, perl
1138character handling to store text in unicode, improve xterm 1484extension, random hacks, numerous bugfixes and extensions.
1139compatibility and apply numerous other bugfixes and extensions.
1140.Sp 1485.Sp
1141Project Coordinator (Changes 1.0 \-) 1486Project Coordinator (Changes 1.0 \-)
1487.IP "Emanuele Giaquinta <e.giaquinta@glauco.it>" 4
1488.IX Item "Emanuele Giaquinta <e.giaquinta@glauco.it>"
1489Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines