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.17 by root, Wed Feb 16 22:16:30 2005 UTC vs.
Revision 1.66 by root, Sat Feb 17 20:36:36 2007 UTC

1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 1.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
2.\" 2.\"
3.\" Standard preamble: 3.\" Standard preamble:
4.\" ======================================================================== 4.\" ========================================================================
5.de Sh \" Subsection heading 5.de Sh \" Subsection heading
6.br 6.br
… …
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-16" "5.2" "RXVT-UNICODE" 132.TH @@RXVT_NAME@@ 1 "2007-02-17" "8.2" "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 ]]
… …
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 147See @@RXVT_NAME@@(7) (try \f(CW\*(C`man 7 @@RXVT_NAME@@\*(C'\fR) for a list of
148frequently asked questions and answer to them and some common 148frequently asked questions and answer to them and some common
149problems. That document is also accessible on the World-Wide-Web at 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>. 150<http://cvs.schmorp.de/browse/rxvt\-unicode/doc/rxvt.7.html>.
151.SH "RXVT-UNICODE VS. RXVT" 151.SH "RXVT-UNICODE VS. RXVT"
152.IX Header "RXVT-UNICODE VS. RXVT" 152.IX Header "RXVT-UNICODE VS. RXVT"
153Unlike the original rxvt, \fBrxvt-unicode\fR stores all text in Unicode 153Unlike the original rxvt, \fBrxvt-unicode\fR stores all text in Unicode
154internally. That means it can store and display most scripts in the 154internally. That means it can store and display most scripts in the
155world. Being a terminal emulator, however, some things are very difficult, 155world. Being a terminal emulator, however, some things are very difficult,
156especially cursive scripts such as arabic, vertically written scripts 156especially cursive scripts such as arabic, vertically written scripts
157like mongolian or scripts requiring extremely complex combining rules, 157like mongolian or scripts requiring extremely complex combining rules,
158like tibetan or devenagari. Don't expect pretty output when using these 158like tibetan or devenagari. Don't expect pretty output when using these
159scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 159scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
160fine, though. A somewhat difficult case are left-to-right scripts, such 160fine, though. A somewhat difficult case are right-to-left scripts, such
161as hebrew: \fBrxvt-unicode\fR adopts the view that bidirectional algorithms 161as hebrew: \fBrxvt-unicode\fR adopts the view that bidirectional algorithms
162belong into the application, not the terminal emulator (too many things \*(-- 162belong into the application, not the terminal emulator (too many things \*(--
163such as cursor-movement while editing \*(-- break otherwise), but that might 163such as cursor-movement while editing \*(-- break otherwise), but that might
164change. 164change.
165.PP 165.PP
166If 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
167me 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
168terminal emulator. In fact, the reason rxvt-unicode was born was solely 168terminal emulator. In fact, the reason rxvt-unicode was born was solely
169because 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
170another for japanese. 170another for japanese.
171.PP 171.PP
172Therefore another design rationale was the use of multiple fonts to 172Therefore another design rationale was the use of multiple fonts to
173display characters: The idea of a single unicode font which many other 173display characters: The idea of a single unicode font which many other
174programs 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
175to choose any font for any script freely. 175to choose any font for any script freely.
176.PP 176.PP
177Apart from that, rxvt-unicode is also much better internationalised than 177Apart from that, rxvt-unicode is also much better internationalised than
178it'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
179in 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
180rxvt. This all in addition to dozens of other small improvements. 180rxvt. This all in addition to dozens of other small improvements.
181.PP 181.PP
182It is still faithfully following the original rxvt idea of being lean 182It is still faithfully following the original rxvt idea of being lean
183and nice on resources: for example, you can still configure rxvt-unicode 183and nice on resources: for example, you can still configure rxvt-unicode
184without 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
185a 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
186from within a single process, which makes startup time very fast and 186from within a single process, which makes startup time very fast and
187drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 187drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
188@@RXVT_NAME@@c(1) (client). 188@@RXVT_NAME@@c(1) (client).
189.PP 189.PP
190It also makes technical information about escape sequences (which have 190It also makes technical information about escape sequences (which have
191been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 191been extended) more accessible: see @@RXVT_NAME@@(7) for technical
192reference documentation (escape sequences etc.). 192reference documentation (escape sequences etc.).
193.SH "OPTIONS" 193.SH "OPTIONS"
194.IX Header "OPTIONS" 194.IX Header "OPTIONS"
195The \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
196below. In keeping with the smaller-is-better philosophy, options may be 196below. In keeping with the smaller-is-better philosophy, options may be
… …
214.IP "\fB\-display\fR \fIdisplayname\fR" 4 214.IP "\fB\-display\fR \fIdisplayname\fR" 4
215.IX Item "-display displayname" 215.IX Item "-display displayname"
216Attempt 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
217respected). In the absence of this option, the display specified by the 217respected). In the absence of this option, the display specified by the
218\&\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.
219.IP "\fB\-geometry\fR \fIgeom\fR" 4 223.IP "\fB\-geometry\fR \fIgeom\fR" 4
220.IX Item "-geometry geom" 224.IX Item "-geometry geom"
221Window geometry (\fB\-g\fR still respected); resource \fBgeometry\fR. 225Window geometry (\fB\-g\fR still respected); resource \fBgeometry\fR.
222.IP "\fB\-rv\fR|\fB+rv\fR" 4 226.IP "\fB\-rv\fR|\fB+rv\fR" 4
223.IX Item "-rv|+rv" 227.IX Item "-rv|+rv"
224Turn on/off simulated reverse video; resource \fBreverseVideo\fR. 228Turn on/off simulated reverse video; resource \fBreverseVideo\fR.
225.IP "\fB\-j\fR|\fB+j\fR" 4 229.IP "\fB\-j\fR|\fB+j\fR" 4
226.IX Item "-j|+j" 230.IX Item "-j|+j"
227Turn on/off jump scrolling; resource \fBjumpScroll\fR. 231Turn on/off jump scrolling; resource \fBjumpScroll\fR.
228.IP "\fB\-ip\fR|\fB+ip\fR" 4 232.IP "\fB\-ip\fR|\fB+ip\fR | \fB\-tr\fR|\fB+tr\fR" 4
229.IX Item "-ip|+ip" 233.IX Item "-ip|+ip | -tr|+tr"
230Turn on/off inheriting parent window's pixmap. Alternative form is 234Turn on/off inheriting parent window's pixmap. Alternative form is
231\&\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
232.IP "\fB\-fade\fR \fInumber\fR" 4 240.IP "\fB\-fade\fR \fInumber\fR" 4
233.IX Item "-fade number" 241.IX Item "-fade number"
234Fade 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.
235.IP "\fB\-tint\fR \fIcolour\fR" 4 249.IP "\fB\-tint\fR \fIcolour\fR" 4
236.IX Item "-tint colour" 250.IX Item "-tint colour"
237Tint the transparent background pixmap with the given colour when 251Tint the transparent background pixmap with the given colour when
238transparency 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
239option 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
240tinting 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
241.IP "\fB\-sh\fR" 4 260.IP "\fB\-sh\fR" 4
242.IX Item "-sh" 261.IX Item "-sh"
243\&\fInumber\fR Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent 262\&\fInumber\fR Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent
244background 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
245specified, too, e.g. \f(CW\*(C`\-tint white\*(C'\fR). 264specified, too, e.g. \f(CW\*(C`\-tint white\*(C'\fR); resource \fIshading\fR.
246.IP "\fB\-bg\fR \fIcolour\fR" 4 265.IP "\fB\-bg\fR \fIcolour\fR" 4
247.IX Item "-bg colour" 266.IX Item "-bg colour"
248Window background colour; resource \fBbackground\fR. 267Window background colour; resource \fBbackground\fR.
249.IP "\fB\-fg\fR \fIcolour\fR" 4 268.IP "\fB\-fg\fR \fIcolour\fR" 4
250.IX Item "-fg colour" 269.IX Item "-fg colour"
… …
269The 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;
270resource \fBborderColor\fR. 289resource \fBborderColor\fR.
271.IP "\fB\-fn\fR \fIfontlist\fR" 4 290.IP "\fB\-fn\fR \fIfontlist\fR" 4
272.IX Item "-fn fontlist" 291.IX Item "-fn fontlist"
273Select 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
274that are used in turn when trying to display Unicode characters. The 293that are checked in order when trying to find glyphs for characters. The
275first font defines the cell size for characters; other fonts might be 294first font defines the cell size for characters; other fonts might be
276smaller, but not (in general) larger. A (hopefully) reasonable default 295smaller, but not (in general) larger. A (hopefully) reasonable default
277font 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.
278.Sp 297.Sp
279In 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
280with \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,
281e.g.: 300e.g.:
282.Sp 301.Sp
283.Vb 2 302.Vb 2
284\& @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 303\& @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
… …
287.Sp 306.Sp
288See 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
289section of @@RXVT_NAME@@(7). 308section of @@RXVT_NAME@@(7).
290.IP "\fB\-fb\fR \fIfontlist\fR" 4 309.IP "\fB\-fb\fR \fIfontlist\fR" 4
291.IX Item "-fb fontlist" 310.IX Item "-fb fontlist"
292Compile 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
293be printed. See resource \fBboldFont\fR for details. 312are to be printed. See resource \fBboldFont\fR for details.
294.IP "\fB\-fi\fR \fIfontlist\fR" 4 313.IP "\fB\-fi\fR \fIfontlist\fR" 4
295.IX Item "-fi fontlist" 314.IX Item "-fi fontlist"
296Compile 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
297be printed. See resource \fBitalicFont\fR for details. 316characters are to be printed. See resource \fBitalicFont\fR for details.
298.IP "\fB\-fbi\fR \fIfontlist\fR" 4 317.IP "\fB\-fbi\fR \fIfontlist\fR" 4
299.IX Item "-fbi fontlist" 318.IX Item "-fbi fontlist"
300Compile 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
301be 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.
302.IP "\fB\-name\fR \fIname\fR" 4 327.IP "\fB\-name\fR \fIname\fR" 4
303.IX Item "-name name" 328.IX Item "-name name"
304Specify the application name under which resources are to be obtained, 329Specify the application name under which resources are to be obtained,
305rather than the default executable file name. Name should not contain 330rather than the default executable file name. Name should not contain
306`.' or `*' characters. Also sets the icon and title name. 331`.' or `*' characters. Also sets the icon and title name.
… …
334.IP "\fB\-sr\fR|\fB+sr\fR" 4 359.IP "\fB\-sr\fR|\fB+sr\fR" 4
335.IX Item "-sr|+sr" 360.IX Item "-sr|+sr"
336Put scrollbar on right/left; resource \fBscrollBar_right\fR. 361Put scrollbar on right/left; resource \fBscrollBar_right\fR.
337.IP "\fB\-st\fR|\fB+st\fR" 4 362.IP "\fB\-st\fR|\fB+st\fR" 4
338.IX Item "-st|+st" 363.IX Item "-st|+st"
339Display normal (non XTerm/NeXT) scrollbar without/with a trough; 364Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
340resource \fBscrollBar_floating\fR. 365resource \fBscrollBar_floating\fR.
341.IP "\fB\-ptab\fR|\fB+ptab\fR" 4 366.IP "\fB\-ptab\fR|\fB+ptab\fR" 4
342.IX Item "-ptab|+ptab" 367.IX Item "-ptab|+ptab"
343If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as 368If enabled (default), \*(L"Horizontal Tab\*(R" characters are being stored as
344actual wide characters in the screen buffer, which makes it possible to 369actual wide characters in the screen buffer, which makes it possible to
… …
368.IP "\fB\-bl\fR" 4 393.IP "\fB\-bl\fR" 4
369.IX Item "-bl" 394.IX Item "-bl"
370Compile \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.
371if 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
372decorations; 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.
373.IP "\fB\-lsp\fR \fInumber\fR" 4 408.IP "\fB\-lsp\fR \fInumber\fR" 4
374.IX Item "-lsp number" 409.IX Item "-lsp number"
375Compile \fIfrills\fR: Lines (pixel height) to insert between each row of 410Compile \fIfrills\fR: Lines (pixel height) to insert between each row of
376the display. Useful to work around font rendering problems; resource 411the display. Useful to work around font rendering problems; resource
377\&\fBlinespace\fR. 412\&\fBlinespace\fR.
… …
388the 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
389given 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
390on 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
391run 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,
392failing 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
393.IP "\fB\-title\fR \fItext\fR" 4 435.IP "\fB\-title\fR \fItext\fR" 4
394.IX Item "-title text" 436.IX Item "-title text"
395Window 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
396of 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
397application name; resource \fBtitle\fR. 439application name; resource \fBtitle\fR.
… …
441\&\fBsecondaryScreen\fR. 483\&\fBsecondaryScreen\fR.
442.IP "\fB\-ssr\fR|\fB+ssr\fR" 4 484.IP "\fB\-ssr\fR|\fB+ssr\fR" 4
443.IX Item "-ssr|+ssr" 485.IX Item "-ssr|+ssr"
444Turn on/off secondary screen scroll (default enabled); resource 486Turn on/off secondary screen scroll (default enabled); resource
445\&\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.
446.IP "\fB\-keysym.\fR\fIsym\fR: \fIstring\fR" 4 494.IP "\fB\-keysym.\fR\fIsym\fR \fIstring\fR" 4
447.IX Item "-keysym.sym: string" 495.IX Item "-keysym.sym string"
448Remap a key symbol. See resource \fBkeysym\fR. 496Remap a key symbol. See resource \fBkeysym\fR.
449.IP "\fB\-embed\fR: \fIwindowid\fR" 4 497.IP "\fB\-embed\fR \fIwindowid\fR" 4
450.IX Item "-embed: windowid" 498.IX Item "-embed windowid"
451Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 499Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
452which enables applications to easily embed a terminal. 500which enables applications to easily embed a terminal.
453.Sp 501.Sp
454Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 502Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
455shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 503shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
456quite a bit, so don't expect it to keep some specific state. It's best to 504quite a bit, so don't expect it to keep some specific state. It's best to
… …
459The window will not be destroyed when @@RXVT_NAME@@ exits. 507The window will not be destroyed when @@RXVT_NAME@@ exits.
460.Sp 508.Sp
461It might be useful to know that @@RXVT_NAME@@ will not close file 509It might be useful to know that @@RXVT_NAME@@ will not close file
462descriptors passed to it (except for stdin/out/err, of course), so you 510descriptors passed to it (except for stdin/out/err, of course), so you
463can use file descriptors to communicate with the programs within the 511can use file descriptors to communicate with the programs within the
464terminal. This works regardless of wether the \f(CW\*(C`\-embed\*(C'\fR option was used or 512terminal. This works regardless of whether the \f(CW\*(C`\-embed\*(C'\fR option was used or
465not. 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.Ve
546.Sp
547.Vb 4
548\& my $pty = new IO::Pty;
549\& fcntl $pty, F_SETFD, 0; # clear close-on-exec
550\& system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
551\& close $pty;
552.Ve
553.Sp
554.Vb 3
555\& # now communicate with rxvt
556\& my $slave = $pty->slave;
557\& while (<$slave>) { print $slave "got <$_>\en" }
558.Ve
559.IP "\fB\-pe\fR \fIstring\fR" 4
560.IX Item "-pe string"
561Comma-separated list of perl extension scripts to use (or not to use) in
562this terminal instance. See resource \fBperl-ext\fR for details.
466.SH "RESOURCES (available also as long\-options)" 563.SH "RESOURCES (available also as long\-options)"
467.IX Header "RESOURCES (available also as long-options)" 564.IX Header "RESOURCES (available also as long-options)"
468Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long 565Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long
469options) compiled into your version. 566options) compiled into your version.
470.PP 567.PP
471There are two different methods that @@RXVT_NAME@@ can use to get the 568You can set and change the resources using X11 tools like \fBxrdb\fR. Many
472Xresource data: using the X libraries (Xrm*\-functions) or internal 569distribution do also load settings from the \fB~/.Xresources\fR file when X
473Xresources reader (\fB~/.Xdefaults\fR). For the first method (ie. 570starts. @@RXVT_NAME@@ will consult the following files/resources in order,
474\&\fB@@RXVT_NAME@@ \-h\fR lists \fBXGetDefaults\fR), you can set and change the 571with later settings overwriting earlier ones:
475resources using X11 tools like \fBxrdb\fR. Many distribution do also load
476settings from the \fB~/.Xresources\fR file when X starts. @@RXVT_NAME@@
477will consult the following files/resources in order, with later settings
478overwriting earlier ones:
479.PP 572.PP
480.Vb 5 573.Vb 5
481\& 1. system-wide app-defaults file, either locale-dependent OR global 574\& 1. system-wide app-defaults file, either locale-dependent OR global
482\& 2. app-defaults file in $XAPPLRESDIR 575\& 2. app-defaults file in $XAPPLRESDIR
483\& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 576\& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
484\& 4. SCREEN_RESOURCES for the current screen 577\& 4. SCREEN_RESOURCES for the current screen
485\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 578\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
486.Ve 579.Ve
487.PP 580.PP
488If compiled with internal Xresources support (i.e. \fB@@RXVT_NAME@@ \-h\fR
489lists \fB.Xdefaults\fR) then \fB@@RXVT_NAME@@\fR accepts application defaults
490set in XAPPLOADDIR/URxvt (compile\-time defined: usually
491\&\fB/usr/lib/X11/app\-defaults/URxvt\fR) and resources set in
492\&\fB~/.Xdefaults\fR, or \fB~/.Xresources\fR if \fB~/.Xdefaults\fR does not exist.
493Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two 581Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two class
494class names: \fBXTerm\fR and \fBURxvt\fR. The class name \fBRxvt\fR allows 582names: \fBRxvt\fR and \fBURxvt\fR. The class name \fBRxvt\fR allows resources
495resources common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be 583common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be easily
496easily configured, while the class name \fBURxvt\fR allows resources 584configured, while the class name \fBURxvt\fR allows resources unique to
497unique to \fB@@RXVT_NAME@@\fR, notably colours and key\-handling, to be 585\&\fB@@RXVT_NAME@@\fR, to be shared between different \fB@@RXVT_NAME@@\fR
498shared between different \fB@@RXVT_NAME@@\fR configurations. If no 586configurations. If no resources are specified, suitable defaults will
499resources are specified, suitable defaults will be used. Command-line 587be used. Command-line arguments can be used to override resource
500arguments can be used to override resource settings. The following 588settings. The following resources are supported (you might want to
501resources are allowed: 589check the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for additional settings by perl
590extensions not documented here):
591.IP "\fBdepth:\fR \fIbitdepth\fR" 4
592.IX Item "depth: bitdepth"
593Compile \fIxft\fR: Attempt to find a visual with the given bit depth;
594option \fB\-depth\fR.
502.IP "\fBgeometry:\fR \fIgeom\fR" 4 595.IP "\fBgeometry:\fR \fIgeom\fR" 4
503.IX Item "geometry: geom" 596.IX Item "geometry: geom"
504Create the window with the specified X window geometry [default 80x24]; 597Create the window with the specified X window geometry [default 80x24];
505option \fB\-geometry\fR. 598option \fB\-geometry\fR.
506.IP "\fBbackground:\fR \fIcolour\fR" 4 599.IP "\fBbackground:\fR \fIcolour\fR" 4
… …
538.IX Item "colorUL: colour" 631.IX Item "colorUL: colour"
539Use the specified colour to display underlined characters when the 632Use the specified colour to display underlined characters when the
540foreground colour is the default. 633foreground colour is the default.
541.IP "\fBcolorRV:\fR \fIcolour\fR" 4 634.IP "\fBcolorRV:\fR \fIcolour\fR" 4
542.IX Item "colorRV: colour" 635.IX Item "colorRV: colour"
543Use the specified colour as the background for reverse video 636Use the specified colour as the background for reverse video characters
544characters. 637when \s-1OPTION_HC\s0 is disabled (\-\-disable\-frills).
545.IP "\fBunderlineColor:\fR \fIcolour\fR" 4 638.IP "\fBunderlineColor:\fR \fIcolour\fR" 4
546.IX Item "underlineColor: colour" 639.IX Item "underlineColor: colour"
547If set, use the specified colour as the colour for the underline 640If set, use the specified colour as the colour for the underline
548itself. If unset, use the foreground colour. 641itself. If unset, use the foreground colour.
549.IP "\fBcursorColor:\fR \fIcolour\fR" 4 642.IP "\fBcursorColor:\fR \fIcolour\fR" 4
… …
568.IP "\fBinheritPixmap:\fR \fIboolean\fR" 4 661.IP "\fBinheritPixmap:\fR \fIboolean\fR" 4
569.IX Item "inheritPixmap: boolean" 662.IX Item "inheritPixmap: boolean"
570\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving 663\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving
571artificial transparency. \fBFalse\fR: do not inherit the parent windows' 664artificial transparency. \fBFalse\fR: do not inherit the parent windows'
572pixmap. 665pixmap.
666.Sp
667\&\fIPlease note that transparency of any kind if completely unsupported by
668the author. Don't bug him with installation questions!\fR
573.IP "\fBfading:\fR \fInumber\fR" 4 669.IP "\fBfading:\fR \fInumber\fR" 4
574.IX Item "fading: number" 670.IX Item "fading: number"
575Fade the text by the given percentage when focus is lost. 671Fade the text by the given percentage when focus is lost; option \fB\-fade\fR.
672.IP "\fBfadeColor:\fR \fIcolour\fR" 4
673.IX Item "fadeColor: colour"
674Fade to this colour, when fading is used (see \fBfading:\fR). The default
675colour is black; option \fB\-fadecolor\fR.
576.IP "\fBtintColor:\fR \fIcolour\fR" 4 676.IP "\fBtintColor:\fR \fIcolour\fR" 4
577.IX Item "tintColor: colour" 677.IX Item "tintColor: colour"
578Tint the transparent background pixmap with the given colour. 678Tint the transparent background pixmap with the given colour; option
679\&\fB\-tint\fR.
579.IP "\fBshading:\fR \fInumber\fR" 4 680.IP "\fBshading:\fR \fInumber\fR" 4
580.IX Item "shading: number" 681.IX Item "shading: number"
581Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background 682Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent background image
582image in addition to tinting it. 683in addition to tinting it; option \fB\-sh\fR.
583.IP "\fBscrollColor:\fR \fIcolour\fR" 4 684.IP "\fBscrollColor:\fR \fIcolour\fR" 4
584.IX Item "scrollColor: colour" 685.IX Item "scrollColor: colour"
585Use the specified colour for the scrollbar [default #B2B2B2]. 686Use the specified colour for the scrollbar [default #B2B2B2].
586.IP "\fBtroughColor:\fR \fIcolour\fR" 4 687.IP "\fBtroughColor:\fR \fIcolour\fR" 4
587.IX Item "troughColor: colour" 688.IX Item "troughColor: colour"
588Use the specified colour for the scrollbar's trough area [default 689Use the specified colour for the scrollbar's trough area [default
589#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 690#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
590.IP "\fBborderColor:\fR \fIcolour\fR" 4 691.IP "\fBborderColor:\fR \fIcolour\fR" 4
591.IX Item "borderColor: colour" 692.IX Item "borderColor: colour"
592The colour of the border around the text area and between the scrollbar 693The colour of the border around the text area and between the scrollbar
593and the text. 694and the text.
594.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4 695.IP "\fBbackgroundPixmap:\fR \fIfile[;geom]\fR" 4
… …
600centre (percent). A scale of 0 displays the image with tiling. A scale 701centre (percent). A scale of 0 displays the image with tiling. A scale
601of 1 displays the image without any scaling. A scale of 2 to 9 702of 1 displays the image without any scaling. A scale of 2 to 9
602specifies an integer number of images in that direction. No image will 703specifies an integer number of images in that direction. No image will
603be magnified beyond 10 times its original size. The maximum permitted 704be magnified beyond 10 times its original size. The maximum permitted
604scale is 1000. [default 0x0+50+50] 705scale is 1000. [default 0x0+50+50]
605.IP "\fBmenu:\fR \fIfile[;tag]\fR" 4
606.IX Item "menu: file[;tag]"
607Read in the specified menu file (note the `.menu' extension is
608optional) and also optionally specify a starting tag to find. See the
609reference documentation for details on the syntax for the menuBar.
610.IP "\fBpath:\fR \fIpath\fR" 4 706.IP "\fBpath:\fR \fIpath\fR" 4
611.IX Item "path: path" 707.IX Item "path: path"
612Specify the colon-delimited search path for finding files (\s-1XPM\s0 and 708Specify the colon-delimited search path for finding \s-1XPM\s0 files.
613menus), in addition to the paths specified by the \fB\s-1RXVTPATH\s0\fR and
614\&\fB\s-1PATH\s0\fR environment variables.
615.IP "\fBfont:\fR \fIfontlist\fR" 4 709.IP "\fBfont:\fR \fIfontlist\fR" 4
616.IX Item "font: fontlist" 710.IX Item "font: fontlist"
617Select the fonts to be used. This is a comma separated list of font 711Select the fonts to be used. This is a comma separated list of font names
618names that are used in turn when trying to display Unicode characters. 712that are checked in order when trying to find glyphs for characters. The
619The first font defines the cell size for characters; other fonts might 713first font defines the cell size for characters; other fonts might be
620be smaller, but not larger. A reasonable default font list is always 714smaller, but not (in general) larger. A (hopefully) reasonable default
621appended to it. option \fB\-fn\fR. 715font list is always appended to it; option \fB\-fn\fR.
622.Sp 716.Sp
623Each font can either be a standard X11 core font (\s-1XLFD\s0) name, with 717Each font can either be a standard X11 core font (\s-1XLFD\s0) name, with
624optional prefix \f(CW\*(C`x:\*(C'\fR or a Xft font (Compile \fIxft\fR), prefixed with \f(CW\*(C`xft:\*(C'\fR. 718optional prefix \f(CW\*(C`x:\*(C'\fR or a Xft font (Compile \fIxft\fR), prefixed with \f(CW\*(C`xft:\*(C'\fR.
625.Sp 719.Sp
626In addition, each font can be prefixed with additional hints and 720In addition, each font can be prefixed with additional hints and
… …
629fonts. 723fonts.
630.Sp 724.Sp
631For example, this font resource 725For example, this font resource
632.Sp 726.Sp
633.Vb 5 727.Vb 5
634\& URxvt*font: 9x15bold,\e 728\& URxvt.font: 9x15bold,\e
635\& -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\e 729\& -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\e
636\& -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \e 730\& -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \e
637\& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e 731\& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e
638\& xft:Code2000:antialias=false 732\& xft:Code2000:antialias=false
639.Ve 733.Ve
… …
674\&\*(L"morphing\*(R" the normal text font list into the desired shape. If that is 768\&\*(L"morphing\*(R" the normal text font list into the desired shape. If that is
675not possible, replacement fonts of the desired shape will be tried. 769not possible, replacement fonts of the desired shape will be tried.
676.Sp 770.Sp
677If set, but empty, then this specific style is disabled and the normal 771If set, but empty, then this specific style is disabled and the normal
678text font will being used for the given style. 772text font will being used for the given style.
773.IP "\fBintensityStyles:\fR \fIboolean\fR" 4
774.IX Item "intensityStyles: boolean"
775When font styles are not enabled, or this option is enabled (\fBTrue\fR,
776option \fB\-is\fR, the default), bold and italic font styles imply high
777intensity foreground/background colours. Disabling this option (\fBFalse\fR,
778option \fB+is\fR) disables this behaviour, the high intensity colours are not
779reachable.
679.IP "\fBselectstyle:\fR \fImode\fR" 4 780.IP "\fBselectstyle:\fR \fImode\fR" 4
680.IX Item "selectstyle: mode" 781.IX Item "selectstyle: mode"
681Set mouse selection style to \fBold\fR which is 2.20, \fBoldword\fR which is 782Set mouse selection style to \fBold\fR which is 2.20, \fBoldword\fR which is
682xterm style with 2.20 old word selection, or anything else which gives 783xterm style with 2.20 old word selection, or anything else which gives
683xterm style selection. 784xterm style selection.
684.IP "\fBscrollstyle:\fR \fImode\fR" 4 785.IP "\fBscrollstyle:\fR \fImode\fR" 4
685.IX Item "scrollstyle: mode" 786.IX Item "scrollstyle: mode"
686Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is 787Set scrollbar style to \fBrxvt\fR, \fBplain\fR, \fBnext\fR or \fBxterm\fR. \fBplain\fR is
687the author's favourite.. 788the author's favourite.
688.IP "\fBtitle:\fR \fIstring\fR" 4 789.IP "\fBtitle:\fR \fIstring\fR" 4
689.IX Item "title: string" 790.IX Item "title: string"
690Set window title string, the default title is the command-line 791Set window title string, the default title is the command-line
691specified after the \fB\-e\fR option, if any, otherwise the application 792specified after the \fB\-e\fR option, if any, otherwise the application
692name; option \fB\-title\fR. 793name; option \fB\-title\fR.
… …
716.IP "\fBprint\-pipe:\fR \fIstring\fR" 4 817.IP "\fBprint\-pipe:\fR \fIstring\fR" 4
717.IX Item "print-pipe: string" 818.IX Item "print-pipe: string"
718Specify a command pipe for vt100 printer [default \fI\fIlpr\fI\|(1)\fR]. Use 819Specify a command pipe for vt100 printer [default \fI\fIlpr\fI\|(1)\fR]. Use
719\&\fBPrint\fR to initiate a screen dump to the printer and \fBCtrl-Print\fR or 820\&\fBPrint\fR to initiate a screen dump to the printer and \fBCtrl-Print\fR or
720\&\fBShift-Print\fR to include the scrollback as well. 821\&\fBShift-Print\fR to include the scrollback as well.
822.Sp
823The string will be interpreted as if typed into the shell as\-is.
824.Sp
825Example:
826.Sp
827.Vb 1
828\& URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
829.Ve
830.Sp
831This creates a new file in your home directory with the screen contents
832every time you hit \f(CW\*(C`Print\*(C'\fR.
721.IP "\fBscrollBar:\fR \fIboolean\fR" 4 833.IP "\fBscrollBar:\fR \fIboolean\fR" 4
722.IX Item "scrollBar: boolean" 834.IX Item "scrollBar: boolean"
723\&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR: 835\&\fBTrue\fR: enable the scrollbar [default]; option \fB\-sb\fR. \fBFalse\fR:
724disable the scrollbar; option \fB+sb\fR. 836disable the scrollbar; option \fB+sb\fR.
725.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4 837.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4
… …
741\&\fB+si\fR. 853\&\fB+si\fR.
742.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4 854.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4
743.IX Item "scrollWithBuffer: boolean" 855.IX Item "scrollWithBuffer: boolean"
744\&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and 856\&\fBTrue\fR: scroll with scrollback buffer when tty receives new lines (and
745\&\fBscrollTtyOutput\fR is False); option \fB\-sw\fR. \fBFalse\fR: do not scroll 857\&\fBscrollTtyOutput\fR is False); option \fB\-sw\fR. \fBFalse\fR: do not scroll
746with scrollback buffer when tty recieves new lines; option \fB+sw\fR. 858with scrollback buffer when tty receives new lines; option \fB+sw\fR.
747.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4 859.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4
748.IX Item "scrollTtyKeypress: boolean" 860.IX Item "scrollTtyKeypress: boolean"
749\&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys 861\&\fBTrue\fR: scroll to bottom when a non-special key is pressed. Special keys
750are those which are intercepted by rxvt-unicode for special handling and 862are those which are intercepted by rxvt-unicode for special handling and
751are not passed onto the shell; option \fB\-sk\fR. \fBFalse\fR: do not scroll to 863are not passed onto the shell; option \fB\-sk\fR. \fBFalse\fR: do not scroll to
… …
764option \fB\-w\fR, \fB\-bw\fR, \fB\-borderwidth\fR. 876option \fB\-w\fR, \fB\-bw\fR, \fB\-borderwidth\fR.
765.IP "\fBborderLess:\fR \fIboolean\fR" 4 877.IP "\fBborderLess:\fR \fIboolean\fR" 4
766.IX Item "borderLess: boolean" 878.IX Item "borderLess: boolean"
767Set \s-1MWM\s0 hints to request a borderless window, i.e. if honoured by the 879Set \s-1MWM\s0 hints to request a borderless window, i.e. if honoured by the
768\&\s-1WM\s0, the rxvt-unicode window will not have window decorations; option \fB\-bl\fR. 880\&\s-1WM\s0, the rxvt-unicode window will not have window decorations; option \fB\-bl\fR.
881.IP "\fBskipBuiltinGlyphs:\fR \fIboolean\fR" 4
882.IX Item "skipBuiltinGlyphs: boolean"
883Compile \fIfrills\fR: Disable the usage of the built-in block graphics/line
884drawing characters and just rely on what the specified fonts provide. Use
885this if you have a good font and want to use its block graphic glyphs;
886option \fB\-sbg\fR.
769.IP "\fBtermName:\fR \fItermname\fR" 4 887.IP "\fBtermName:\fR \fItermname\fR" 4
770.IX Item "termName: termname" 888.IX Item "termName: termname"
771Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment 889Specifies the terminal type name to be set in the \fB\s-1TERM\s0\fR environment
772variable; option \fB\-tn\fR. 890variable; option \fB\-tn\fR.
773.IP "\fBlinespace:\fR \fInumber\fR" 4 891.IP "\fBlinespace:\fR \fInumber\fR" 4
… …
801.IP "\fBpointerColor2:\fR \fIcolour\fR" 4 919.IP "\fBpointerColor2:\fR \fIcolour\fR" 4
802.IX Item "pointerColor2: colour" 920.IX Item "pointerColor2: colour"
803Mouse pointer background colour. 921Mouse pointer background colour.
804.IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4 922.IP "\fBpointerBlankDelay:\fR \fInumber\fR" 4
805.IX Item "pointerBlankDelay: number" 923.IX Item "pointerBlankDelay: number"
806Specifies number of seconds before blanking the pointer [default 2]. 924Specifies number of seconds before blanking the pointer [default 2]. Use a
925large number (e.g. \f(CW987654321\fR) to effectively disable the timeout.
807.IP "\fBbackspacekey:\fR \fIstring\fR" 4 926.IP "\fBbackspacekey:\fR \fIstring\fR" 4
808.IX Item "backspacekey: string" 927.IX Item "backspacekey: string"
809The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR 928The string to send when the backspace key is pressed. If set to \fB\s-1DEC\s0\fR
810or unset it will send \fBDelete\fR (code 127) or, if shifted, \fBBackspace\fR 929or unset it will send \fBDelete\fR (code 127) or, if shifted, \fBBackspace\fR
811(code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode 930(code 8) \- which can be reversed with the appropriate \s-1DEC\s0 private mode
… …
815The string to send when the delete key (not the keypad delete key) is 934The string to send when the delete key (not the keypad delete key) is
816pressed. If unset it will send the sequence traditionally associated 935pressed. If unset it will send the sequence traditionally associated
817with the \fBExecute\fR key. 936with the \fBExecute\fR key.
818.IP "\fBcutchars:\fR \fIstring\fR" 4 937.IP "\fBcutchars:\fR \fIstring\fR" 4
819.IX Item "cutchars: string" 938.IX Item "cutchars: string"
820The characters used as delimiters for double-click word selection. The 939The characters used as delimiters for double-click word selection
821built-in default: 940(whitespace delimiting is added automatically if resource is given).
941.Sp
942When the selection extension is in use (the default if compiled in, see
943the @@RXVT_NAME@@\fIperl\fR\|(3) manpage), a suitable regex using these characters
944will be created (if the resource exists, otherwise, no regex will be
945created). In this mode, characters outside \s-1ISO\-8859\-1\s0 can be used.
946.Sp
947When the selection extension is not used, only \s-1ISO\-8859\-1\s0 characters can
948be used. If not specified, the built-in default is used:
822.Sp 949.Sp
823\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]{|}\fR 950\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]{|}\fR
824.IP "\fBpreeditType:\fR \fIstyle\fR" 4 951.IP "\fBpreeditType:\fR \fIstyle\fR" 4
825.IX Item "preeditType: style" 952.IX Item "preeditType: style"
826\&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR. 953\&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR.
… …
830.IP "\fBimLocale:\fR \fIname\fR" 4 957.IP "\fBimLocale:\fR \fIname\fR" 4
831.IX Item "imLocale: name" 958.IX Item "imLocale: name"
832The locale to use for opening the \s-1IM\s0. You can use an \f(CW\*(C`LC_CTYPE\*(C'\fR of e.g. 959The locale to use for opening the \s-1IM\s0. You can use an \f(CW\*(C`LC_CTYPE\*(C'\fR of e.g.
833\&\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 960\&\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
834input extension to be able to input japanese characters while staying in 961input extension to be able to input japanese characters while staying in
835another locale. option \fB\-imlocale\fR. 962another locale; option \fB\-imlocale\fR.
836.IP "\fBimFont:\fR \fIfontset\fR" 4 963.IP "\fBimFont:\fR \fIfontset\fR" 4
837.IX Item "imFont: fontset" 964.IX Item "imFont: fontset"
838Specify the font-set used for \s-1XIM\s0 styles \f(CW\*(C`OverTheSpot\*(C'\fR or 965Specify the font-set used for \s-1XIM\s0 styles \f(CW\*(C`OverTheSpot\*(C'\fR or
839\&\f(CW\*(C`OffTheSpot\*(C'\fR. It must be a standard X font set (\s-1XLFD\s0 patterns separated 966\&\f(CW\*(C`OffTheSpot\*(C'\fR. It must be a standard X font set (\s-1XLFD\s0 patterns separated
840by commas), i.e. it's not in the same format as the other font lists used 967by commas), i.e. it's not in the same format as the other font lists used
… …
843option \fB\-imfont\fR. 970option \fB\-imfont\fR.
844.IP "\fBtripleclickwords:\fR \fIboolean\fR" 4 971.IP "\fBtripleclickwords:\fR \fIboolean\fR" 4
845.IX Item "tripleclickwords: boolean" 972.IX Item "tripleclickwords: boolean"
846Change the meaning of triple-click selection with the left mouse 973Change the meaning of triple-click selection with the left mouse
847button. Instead of selecting a full line it will extend the selection to 974button. Instead of selecting a full line it will extend the selection to
848the end of the logical line only. option \fB\-tcw\fR. 975the end of the logical line only; option \fB\-tcw\fR.
849.IP "\fBinsecure:\fR \fIboolean\fR" 4 976.IP "\fBinsecure:\fR \fIboolean\fR" 4
850.IX Item "insecure: boolean" 977.IX Item "insecure: boolean"
851Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that 978Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that
852echo arbitrary strings like the icon name or the locale. This could be 979echo arbitrary strings like the icon name or the locale. This could be
853abused if somebody gets 8\-bit\-clean access to your display, whether 980abused if somebody gets 8\-bit\-clean access to your display, whether
854throuh a mail client displaying mail bodies unfiltered or though 981through a mail client displaying mail bodies unfiltered or through
855\&\fIwrite\fR\|(1). Therefore, these sequences are disabled by default. (Note 982\&\fIwrite\fR\|(1) or any other means. Therefore, these sequences are disabled by
856that other terminals, including xterm, have these sequences 983default. (Note that many other terminals, including xterm, have these
857enabled by default). You can enable them by setting this boolean 984sequences enabled by default, which doesn't make it safer, though).
858resource or specifying \fB\-insecure\fR as an option. At the moment, this 985.Sp
859enabled display\-answer, locale, findfont, icon label and window title 986You can enable them by setting this boolean resource or specifying
860requests as well as dynamic menubar dispatch. 987\&\fB\-insecure\fR as an option. At the moment, this enables display\-answer,
988locale, findfont, icon label and window title requests.
861.IP "\fBmodifier:\fR \fImodifier\fR" 4 989.IP "\fBmodifier:\fR \fImodifier\fR" 4
862.IX Item "modifier: modifier" 990.IX Item "modifier: modifier"
863Set the key to be interpreted as the Meta key to: \fBalt\fR, \fBmeta\fR, 991Set the key to be interpreted as the Meta key to: \fBalt\fR, \fBmeta\fR,
864\&\fBhyper\fR, \fBsuper\fR, \fBmod1\fR, \fBmod2\fR, \fBmod3\fR, \fBmod4\fR, \fBmod5\fR; option 992\&\fBhyper\fR, \fBsuper\fR, \fBmod1\fR, \fBmod2\fR, \fBmod3\fR, \fBmod4\fR, \fBmod5\fR; option
865\&\fB\-mod\fR. 993\&\fB\-mod\fR.
866.IP "\fBanswerbackString:\fR \fIstring\fR" 4 994.IP "\fBanswerbackString:\fR \fIstring\fR" 4
867.IX Item "answerbackString: string" 995.IX Item "answerbackString: string"
868Specify the reply rxvt-unicode sends to the shell when an \s-1ENQ\s0 (control\-E) 996Specify the reply rxvt-unicode sends to the shell when an \s-1ENQ\s0 (control\-E)
869character is passed through. It may contain escape values as described 997character is passed through. It may contain escape values as described
870in the entry on \fBkeysym\fR following. 998in the entry on \fBkeysym\fR following.
871.IP "\fBsecondaryScreen:\fR \fIbool\fR" 4 999.IP "\fBsecondaryScreen:\fR \fIboolean\fR" 4
872.IX Item "secondaryScreen: bool" 1000.IX Item "secondaryScreen: boolean"
873Turn on/off secondary screen (default enabled). 1001Turn on/off secondary screen (default enabled).
874.IP "\fBsecondaryScroll:\fR \fIbool\fR" 4 1002.IP "\fBsecondaryScroll:\fR \fIboolean\fR" 4
875.IX Item "secondaryScroll: bool" 1003.IX Item "secondaryScroll: boolean"
876Turn on/off secondary screen scroll (default enabled). If the this 1004Turn on/off secondary screen scroll (default enabled). If the this
877option is enabled, scrolls on the secondary screen will change the 1005option is enabled, scrolls on the secondary screen will change the
878scrollback buffer and switching to/from the secondary screen will 1006scrollback buffer and switching to/from the secondary screen will
879instead scroll the screen up. 1007instead scroll the screen up.
1008.IP "\fBhold\fR: \fIboolean\fR" 4
1009.IX Item "hold: boolean"
1010Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1011will not immediately destroy its window when the program executed within
1012it exits. Instead, it will wait till it is being killed or closed by the
1013user.
880.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4 1014.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4
881.IX Item "keysym.sym: string" 1015.IX Item "keysym.sym: string"
882Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The 1016Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The
883intervening resource name \fBkeysym.\fR cannot be omitted. 1017intervening resource name \fBkeysym.\fR cannot be omitted.
884.Sp 1018.Sp
… …
901.Sp 1035.Sp
902\&\fIstring\fR may contain escape values (\f(CW\*(C`\ea\*(C'\fR: bell, \f(CW\*(C`\eb\*(C'\fR: backspace, 1036\&\fIstring\fR may contain escape values (\f(CW\*(C`\ea\*(C'\fR: bell, \f(CW\*(C`\eb\*(C'\fR: backspace,
903\&\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, 1037\&\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,
904\&\f(CW\*(C`\e000\*(C'\fR: octal number) or verbatim control characters (\f(CW\*(C`^?\*(C'\fR: delete, 1038\&\f(CW\*(C`\e000\*(C'\fR: octal number) or verbatim control characters (\f(CW\*(C`^?\*(C'\fR: delete,
905\&\f(CW\*(C`^@\*(C'\fR: null, \f(CW\*(C`^A\*(C'\fR ...) and may be enclosed with double quotes so that it 1039\&\f(CW\*(C`^@\*(C'\fR: null, \f(CW\*(C`^A\*(C'\fR ...) and may be enclosed with double quotes so that it
906can start or end with whitespace. 1040can start or end with whitespace. \fBThis feature is deprecated and will
1041be removed\fR.
907.Sp 1042.Sp
908Please note that you need to double the \f(CW\*(C`\e\*(C'\fR when using 1043Please note that you need to double the \f(CW\*(C`\e\*(C'\fR in resource files, as
909\&\f(CW\*(C`\-\-enable\-xgetdefault\*(C'\fR, as X itself does it's own de-escaping (you can 1044Xlib itself does its own de-escaping (you can use \f(CW\*(C`\e033\*(C'\fR instead of
910use \f(CW\*(C`\e033\*(C'\fR instead of \f(CW\*(C`\ee\*(C'\fR (and so on), which will work with both Xt and 1045\&\f(CW\*(C`\ee\*(C'\fR (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
911@@RXVT_NAME@@'s own processing). 1046processing).
912.Sp 1047.Sp
913You can define a range of keysyms in one shot by providing a \fIstring\fR 1048You can define a range of keysyms in one shot by providing a \fIstring\fR
914with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/' 1049with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimiter `/'
915should be a character not used by the strings. 1050should be a character not used by the strings.
916.Sp 1051.Sp
917Its usage can be demonstrated by an example: 1052Its usage can be demonstrated by an example:
918.Sp 1053.Sp
919.Vb 1 1054.Vb 1
… …
935.Sp 1070.Sp
936.Vb 1 1071.Vb 1
937\& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007 1072\& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007
938.Ve 1073.Ve
939.Sp 1074.Sp
1075If \fIstring\fR takes the form \f(CW\*(C`perl:STRING\*(C'\fR, then the specified \fB\s-1STRING\s0\fR
1076is passed to the \f(CW\*(C`on_keyboard_command\*(C'\fR perl handler. See the @@RXVT_NAME@@\fIperl\fR\|(3)
1077manpage. For example, the \fIselection\fR extension (activated via
1078\&\f(CW\*(C`@@RXVT_NAME@@ \-pe selection\*(C'\fR) listens for \f(CW\*(C`selection:rot13\*(C'\fR events:
1079.Sp
1080.Vb 1
1081\& URxvt.keysym.M-C-c: perl:selection:rot13
1082.Ve
1083.Sp
1084Due the the large number of modifier combinations, a defined key mapping
1085will match if at \fIat least\fR the specified identifiers are being set, and
1086no other key mappings with those and more bits are being defined. That
1087means that defining a key map for \f(CW\*(C`a\*(C'\fR will automatically provide
1088definitions for \f(CW\*(C`Meta\-a\*(C'\fR, \f(CW\*(C`Shift\-a\*(C'\fR and so on, unless some of those are defined
1089mappings themselves.
1090.Sp
1091Unfortunately, this will override built-in key mappings. For example
1092if you overwrite the \f(CW\*(C`Insert\*(C'\fR key you will disable @@RXVT_NAME@@'s
1093\&\f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke \*(L"holes\*(R" into the
1094user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement:
1095.Sp
1096.Vb 2
1097\& URxvt.keysym.Insert: <my insert key sequence>
1098\& URxvt.keysym.S-Insert: builtin:
1099.Ve
1100.Sp
1101The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination
1102of modifiers. The second line re-establishes the default mapping for
1103\&\f(CW\*(C`Shift\-Insert\*(C'\fR.
1104.Sp
940The following example will map Control\-Meta\-1 and Control\-Meta\-2 to 1105The following example will map Control\-Meta\-1 and Control\-Meta\-2 to
941the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited 1106the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited
942font-switching at runtime: 1107font-switching at runtime:
943.Sp 1108.Sp
944.Vb 2 1109.Vb 2
… …
951.Sp 1116.Sp
952.Vb 2 1117.Vb 2
953\& URxvt.keysym.M-C-3: command:\e033[8;25;80t 1118\& URxvt.keysym.M-C-3: command:\e033[8;25;80t
954\& URxvt.keysym.M-C-4: command:\e033[8;48;110t 1119\& URxvt.keysym.M-C-4: command:\e033[8;48;110t
955.Ve 1120.Ve
1121.IP "\fBperl-ext-common\fR: \fIstring\fR" 4
1122.IX Item "perl-ext-common: string"
1123.PD 0
1124.IP "\fBperl-ext\fR: \fIstring\fR" 4
1125.IX Item "perl-ext: string"
1126.PD
1127Comma-separated list(s) of perl extension scripts (default: \f(CW\*(C`default\*(C'\fR) to
1128use in this terminal instance; option \fB\-pe\fR.
1129.Sp
1130Extension names can be prefixed with a \f(CW\*(C`\-\*(C'\fR sign to prohibit using
1131them. This can be useful to selectively disable some extensions loaded
1132by default, or specified via the \f(CW\*(C`perl\-ext\-common\*(C'\fR resource. For
1133example, \f(CW\*(C`default,\-selection\*(C'\fR will use all the default extension except
1134\&\f(CW\*(C`selection\*(C'\fR.
1135.Sp
1136Extension names can also be followed by an argument in angle brackets
1137(e.g. \f(CW\*(C`searchable\-scrollback<M\-s>\*(C'\fR, which binds the hotkey for
1138searchable scrollback to Alt/Meta\-s). Mentioning the same extension
1139multiple times with different arguments will pass multiple arguments to
1140the extension.
1141.Sp
1142Each extension is looked up in the library directories, loaded if
1143necessary, and bound to the current terminal instance.
1144.Sp
1145If both of these resources are the empty string, then the perl
1146interpreter will not be initialized. The idea behind two options is that
1147\&\fBperl-ext-common\fR will be used for extensions that should be available to
1148all instances, while \fBperl-ext\fR is used for specific instances.
1149.IP "\fBperl-eval\fR: \fIstring\fR" 4
1150.IX Item "perl-eval: string"
1151Perl code to be evaluated when all extensions have been registered. See
1152the @@RXVT_NAME@@\fIperl\fR\|(3) manpage. Due to security reasons, this resource
1153will be ignored when running setuid/setgid.
1154.IP "\fBperl-lib\fR: \fIpath\fR" 4
1155.IX Item "perl-lib: path"
1156Colon-separated list of additional directories that hold extension
1157scripts. When looking for extensions specified by the \f(CW\*(C`perl\*(C'\fR resource,
1158@@RXVT_NAME@@ will first look in these directories and then in
1159\&\fI@@RXVT_LIBDIR@@/urxvt/perl/\fR. Due to security reasons, this resource
1160will be ignored when running setuid/setgid.
1161.Sp
1162See the @@RXVT_NAME@@\fIperl\fR\|(3) manpage.
1163.IP "\fBselection.pattern\-\f(BIidx\fB\fR: \fIperl-regex\fR" 4
1164.IX Item "selection.pattern-idx: perl-regex"
1165Additional selection patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for
1166details.
1167.IP "\fBselection\-autotransform.\f(BIidx\fB\fR: \fIperl-transform\fR" 4
1168.IX Item "selection-autotransform.idx: perl-transform"
1169Selection auto-transform patterns, see the @@RXVT_NAME@@\fIperl\fR\|(3) manpage
1170for details.
1171.IP "\fBsearchable\-scrollback:\fR \fIkeysym\fR" 4
1172.IX Item "searchable-scrollback: keysym"
1173Sets the hotkey that starts the incremental scrollback buffer search
1174(default: \f(CW\*(C`M\-s\*(C'\fR).
1175.IP "\fBurlLauncher\fR: \fIstring\fR" 4
1176.IX Item "urlLauncher: string"
1177Specifies the program to be started with a \s-1URL\s0 argument. Used by the
1178\&\f(CW\*(C`selection\-popup\*(C'\fR and \f(CW\*(C`matcher\*(C'\fR perl extensions.
1179.IP "\fBtransient-for\fR: \fIwindowid\fR" 4
1180.IX Item "transient-for: windowid"
1181Compile \fIfrills\fR: Sets the \s-1WM_TRANSIENT_FOR\s0 property to the given window id.
1182.IP "\fBoverride-redirect\fR: \fIboolean\fR" 4
1183.IX Item "override-redirect: boolean"
1184Compile \fIfrills\fR: Sets override-redirect for the terminal window, making
1185it almost invisible to window managers; option \fB\-override\-redirect\fR.
956.SH "THE SCROLLBAR" 1186.SH "THE SCROLLBAR"
957.IX Header "THE SCROLLBAR" 1187.IX Header "THE SCROLLBAR"
958Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window 1188Lines of text that scroll off the top of the \fB@@RXVT_NAME@@\fR window
959(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar 1189(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar
960or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and 1190or by keystrokes. The normal \fB@@RXVT_NAME@@\fR scrollbar has arrows and
… …
987to select a word; Left triple-click to select the entire logical line 1217to select a word; Left triple-click to select the entire logical line
988(which can span multiple screen lines), unless modified by resource 1218(which can span multiple screen lines), unless modified by resource
989\&\fBtripleclickwords\fR. 1219\&\fBtripleclickwords\fR.
990.Sp 1220.Sp
991Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys) 1221Starting a selection while pressing the \fBMeta\fR key (or \fBMeta+Ctrl\fR keys)
992(Compile: \fIfrills\fR) will create a rectangular selection instead of a normal 1222(Compile: \fIfrills\fR) will create a rectangular selection instead of a
993one. 1223normal one. In this mode, every selected row becomes its own line in the
1224selection, and trailing whitespace is visually underlined and removed from
1225the selection.
994.IP "\fBInsertion\fR:" 4 1226.IP "\fBInsertion\fR:" 4
995.IX Item "Insertion:" 1227.IX Item "Insertion:"
996Pressing and releasing the Middle mouse button (or \fBShift-Insert\fR) in 1228Pressing and releasing the Middle mouse button in an \fB@@RXVT_NAME@@\fR
997an \fB@@RXVT_NAME@@\fR window causes the current text selection to be 1229window causes the value of the \s-1PRIMARY\s0 selection (or \s-1CLIPBOARD\s0 with the
998inserted as if it had been typed on the keyboard. 1230Meta modifier) to be inserted as if it had been typed on the keyboard.
1231.Sp
1232Pressing \fBShift-Insert\fR causes the value of the \s-1PRIMARY\s0 selection to be
1233inserted too.
999.SH "CHANGING FONTS" 1234.SH "CHANGING FONTS"
1000.IX Header "CHANGING FONTS" 1235.IX Header "CHANGING FONTS"
1001Changing fonts (or font sizes, respectively) via the keypad is not yet 1236Changing fonts (or font sizes, respectively) via the keypad is not yet
1002supported in rxvt\-unicode. Bug me if you need this. 1237supported in rxvt\-unicode. Bug me if you need this.
1003.PP 1238.PP
1004You can, however, switch fonts at runtime using escape sequences (and 1239You can, however, switch fonts at runtime using escape sequences, e.g.:
1005therefore using the menubar), e.g.:
1006.PP 1240.PP
1007.Vb 1 1241.Vb 1
1008\& printf '\ee]701;%s\e007' "9x15bold,xft:Kochi Gothic" 1242\& printf '\ee]710;%s\e007' "9x15bold,xft:Kochi Gothic"
1243.Ve
1244.PP
1245You can use keyboard shortcuts, too:
1246.PP
1247.Vb 2
1248\& URxvt.keysym.M-C-1: command:\e033]710;suxuseuro\e007\e033]711;suxuseuro\e007
1249\& URxvt.keysym.M-C-2: command:\e033]710;9x15bold\e007\e033]711;9x15bold\e007
1009.Ve 1250.Ve
1010.PP 1251.PP
1011rxvt-unicode will automatically re-apply these fonts to the output so far. 1252rxvt-unicode will automatically re-apply these fonts to the output so far.
1012.SH "ISO 14755 SUPPORT" 1253.SH "ISO 14755 SUPPORT"
1013.IX Header "ISO 14755 SUPPORT" 1254.IX Header "ISO 14755 SUPPORT"
… …
1037This mode lets you input characters representing the keycap symbols of 1278This mode lets you input characters representing the keycap symbols of
1038your keyboard, if representable in the current locale encoding. 1279your keyboard, if representable in the current locale encoding.
1039.Sp 1280.Sp
1040Start by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then releasing 1281Start by pressing \f(CW\*(C`Control\*(C'\fR and \f(CW\*(C`Shift\*(C'\fR together, then releasing
1041them. The next special key (cursor keys, home etc.) you enter will not 1282them. The next special key (cursor keys, home etc.) you enter will not
1042invoke it's usual function but instead will insert the corresponding 1283invoke its usual function but instead will insert the corresponding
1043keycap symbol. The symbol will only be entered when the key has been 1284keycap symbol. The symbol will only be entered when the key has been
1044released, otherwise pressing e.g. \f(CW\*(C`Shift\*(C'\fR would enter the symbol for 1285released, otherwise pressing e.g. \f(CW\*(C`Shift\*(C'\fR would enter the symbol for
1045\&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a 1286\&\f(CW\*(C`ISO Level 2 Switch\*(C'\fR, although your intention might have been to enter a
1046reverse tab (Shift\-Tab). 1287reverse tab (Shift\-Tab).
1047.IP "* 5.3: Screen-selection entry method" 4 1288.IP "* 5.3: Screen-selection entry method" 4
… …
1074.SH "COLORS AND GRAPHICS" 1315.SH "COLORS AND GRAPHICS"
1075.IX Header "COLORS AND GRAPHICS" 1316.IX Header "COLORS AND GRAPHICS"
1076In addition to the default foreground and background colours, 1317In addition to the default foreground and background colours,
1077\&\fB@@RXVT_NAME@@\fR can display up to 16 colours (8 \s-1ANSI\s0 colours plus 1318\&\fB@@RXVT_NAME@@\fR can display up to 16 colours (8 \s-1ANSI\s0 colours plus
1078high-intensity bold/blink versions of the same). Here is a list of the 1319high-intensity bold/blink versions of the same). Here is a list of the
1079colours with their \fBrgb.txt\fR names. 1320colours with their names.
1080.TS 1321.TS
1081l l l . 1322l l l .
1082color0 (black) = Black 1323color0 (black) = Black
1083color1 (red) = Red3 1324color1 (red) = Red3
1084color2 (green) = Green3 1325color2 (green) = Green3
… …
1103It is also possible to specify the colour values of \fBforeground\fR, 1344It is also possible to specify the colour values of \fBforeground\fR,
1104\&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as 1345\&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as
1105a number 0\-15, as a convenient shorthand to reference the colour name of 1346a number 0\-15, as a convenient shorthand to reference the colour name of
1106color0\-color15. 1347color0\-color15.
1107.PP 1348.PP
1349In addition to the colours defined above, @@RXVT_NAME@@ offers an
1350additional 72 colours. The first 64 of those (with indices 16 to 79)
1351consist of a 4*4*4 \s-1RGB\s0 colour cube (i.e. \fIindex = r * 16 + g * 4 + b +
135216\fR), followed by 8 additional shades of gray (with indices 80 to 87).
1353.PP
1354Together, all those colours implement the 88 colour xterm colours. Only
1355the first 16 can be changed using resources currently, the rest can only
1356be changed via command sequences (\*(L"escape codes\*(R").
1357.PP
1108Note that \fB\-rv\fR (\fB\*(L"reverseVideo: True\*(R"\fR) simulates reverse video by 1358Note that \fB\-rv\fR (\fB\*(L"reverseVideo: True\*(R"\fR) simulates reverse video by
1109always swapping the foreground/background colours. This is in contrast to 1359always swapping the foreground/background colours. This is in contrast to
1110\&\fIxterm\fR(1) where the colours are only swapped if they have not otherwise 1360\&\fIxterm\fR(1) where the colours are only swapped if they have not otherwise
1111been specified. For example, 1361been specified. For example,
1112.IP "\fB@@RXVT_NAME@@ \-fg Black \-bg White \-rv\fR" 4 1362.IP "\fB@@RXVT_NAME@@ \-fg Black \-bg White \-rv\fR" 4
1113.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv" 1363.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv"
1114would yield White on Black, while on \fIxterm\fR(1) it would yield Black 1364would yield White on Black, while on \fIxterm\fR(1) it would yield Black
1115on White. 1365on White.
1366.Sh "\s-1ALPHA\s0 \s-1CHANNEL\s0 \s-1SUPPORT\s0"
1367.IX Subsection "ALPHA CHANNEL SUPPORT"
1368If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1369their act together, rxvt-unicode will support \f(CW\*(C`rgba:rrrr/gggg/bbbb/aaaa\*(C'\fR
1370(recommended, but \fB\s-1MUST\s0\fR have 4 digits/component) colour specifications,
1371in addition to the ones provided by X, where the additional A component
1372specifies opacity (alpha) values. The minimum value of \f(CW0\fR is completely
1373transparent). You can also prefix any color with \f(CW\*(C`[percent]\*(C'\fR, where
1374\&\f(CW\*(C`percent\*(C'\fR is a decimal percentage (0\-100) that specifies the opacity of
1375the color, where \f(CW0\fR is completely transparent and \f(CW100\fR is completelxy
1376opaque.
1377.PP
1378You probably need to specify \fB\*(L"\-depth 32\*(R"\fR, too, and have the luck that
1379your X\-server uses \s-1ARGB\s0 pixel layout, as X is far from just supporting
1380\&\s-1ARGB\s0 visuals out of the box, and rxvt-unicode just fudges around.
1381.PP
1382For example, the following selects an almost completely transparent red
1383background, and an almost opaque pink foreground:
1384.PP
1385.Vb 1
1386\& @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1387.Ve
1388.PP
1389\&\fIPlease note that transparency of any kind if completely unsupported by
1390the author. Don't bug him with installation questions!\fR
1116.SH "ENVIRONMENT" 1391.SH "ENVIRONMENT"
1117.IX Header "ENVIRONMENT" 1392.IX Header "ENVIRONMENT"
1118\&\fB@@RXVT_NAME@@\fR sets and/or uses the following environment variables: 1393\&\fB@@RXVT_NAME@@\fR sets and/or uses the following environment variables:
1119.IP "\fB\s-1TERM\s0\fR" 4 1394.IP "\fB\s-1TERM\s0\fR" 4
1120.IX Item "TERM" 1395.IX Item "TERM"
1121Normally set to \f(CW\*(C`rxvt\-unicode\*(C'\fR, unless overwritten at configure time, via 1396Normally set to \f(CW\*(C`rxvt\-unicode\*(C'\fR, unless overwritten at configure time, via
1122resources or on the commandline. 1397resources or on the command line.
1123.IP "\fB\s-1COLORTERM\s0\fR" 4 1398.IP "\fB\s-1COLORTERM\s0\fR" 4
1124.IX Item "COLORTERM" 1399.IX Item "COLORTERM"
1125Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on wether @@RXVT_NAME@@ was 1400Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on whether @@RXVT_NAME@@ was
1126compiled with \s-1XPM\s0 support, and optionally with the added extension 1401compiled with \s-1XPM\s0 support, and optionally with the added extension
1127\&\f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome screen. 1402\&\f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome screen.
1128.IP "\fB\s-1COLORFGBG\s0\fR" 4 1403.IP "\fB\s-1COLORFGBG\s0\fR" 4
1129.IX Item "COLORFGBG" 1404.IX Item "COLORFGBG"
1130Set 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 1405Set 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
… …
1144Set to the terminfo directory iff @@RXVT_NAME@@ was configured with 1419Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1145\&\f(CW\*(C`\-\-with\-terminfo=PATH\*(C'\fR. 1420\&\f(CW\*(C`\-\-with\-terminfo=PATH\*(C'\fR.
1146.IP "\fB\s-1DISPLAY\s0\fR" 4 1421.IP "\fB\s-1DISPLAY\s0\fR" 4
1147.IX Item "DISPLAY" 1422.IX Item "DISPLAY"
1148Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1423Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1149display in it's child processes. 1424display in its child processes.
1150.IP "\fB\s-1SHELL\s0\fR" 4 1425.IP "\fB\s-1SHELL\s0\fR" 4
1151.IX Item "SHELL" 1426.IX Item "SHELL"
1152The shell to be used for command execution, defaults to \f(CW\*(C`/bin/sh\*(C'\fR. 1427The shell to be used for command execution, defaults to \f(CW\*(C`/bin/sh\*(C'\fR.
1153.IP "\fB\s-1RXVTPATH\s0\fR" 4
1154.IX Item "RXVTPATH"
1155The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1156files.
1157.IP "\fB\s-1PATH\s0\fR" 4
1158.IX Item "PATH"
1159Used in the same way as \f(CW\*(C`RXVTPATH\*(C'\fR.
1160.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4 1428.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
1161.IX Item "RXVT_SOCKET" 1429.IX Item "RXVT_SOCKET"
1162The unix domain socket path used by @@RXVT_NAME@@c(1) and 1430The unix domain socket path used by @@RXVT_NAME@@c(1) and
1163@@RXVT_NAME@@d(1). 1431@@RXVT_NAME@@d(1).
1164.Sp 1432.Sp
1165Default \f(CW\*(C`$HOME/.rxvt\-unicode\-<nodename\*(C'\fR. 1433Default \fI$HOME/.rxvt\-unicode\-\fI<nodename\fI\fR.
1166.IP "\fB\s-1HOME\s0\fR" 4 1434.IP "\fB\s-1HOME\s0\fR" 4
1167.IX Item "HOME" 1435.IX Item "HOME"
1168Used to locate the default directory for the unix domain socket for 1436Used to locate the default directory for the unix domain socket for
1169daemon communications and to locate various resource files (such as 1437daemon communications and to locate various resource files (such as
1170\&\f(CW\*(C`.Xdefaults\*(C'\fR) 1438\&\f(CW\*(C`.Xdefaults\*(C'\fR)
… …
1180.IP "\fB/usr/lib/X11/rgb.txt\fR" 4 1448.IP "\fB/usr/lib/X11/rgb.txt\fR" 4
1181.IX Item "/usr/lib/X11/rgb.txt" 1449.IX Item "/usr/lib/X11/rgb.txt"
1182Color names. 1450Color names.
1183.SH "SEE ALSO" 1451.SH "SEE ALSO"
1184.IX Header "SEE ALSO" 1452.IX Header "SEE ALSO"
1185@@RXVT_NAME@@(7), \fIxterm\fR\|(1), \fIsh\fR\|(1), \fIresize\fR\|(1), X(1), \fIpty\fR\|(4), \fItty\fR\|(4), \fIutmp\fR\|(5) 1453@@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)
1186.SH "BUGS"
1187.IX Header "BUGS"
1188Check the \s-1BUGS\s0 file for an up-to-date list.
1189.PP
1190Cursor change support is not yet implemented.
1191.PP
1192Click-and-drag doesn't work with X11 mouse report overriding.
1193.SH "CURRENT PROJECT COORDINATOR" 1454.SH "CURRENT PROJECT COORDINATOR"
1194.IX Header "CURRENT PROJECT COORDINATOR" 1455.IX Header "CURRENT PROJECT COORDINATOR"
1195.IP "Project Coordinator" 4 1456.IP "Project Coordinator" 4
1196.IX Item "Project Coordinator" 1457.IX Item "Project Coordinator"
1197Marc A. Lehmann <rxvt\-unicode@schmorp.de> 1458Marc A. Lehmann <rxvt\-unicode@schmorp.de>
1198.Sp 1459.Sp
1199<http://software.schmorp.de/#rxvt\-unicode> 1460<http://software.schmorp.de/pkg/rxvt\-unicode.html>
1200.SH "AUTHORS" 1461.SH "AUTHORS"
1201.IX Header "AUTHORS" 1462.IX Header "AUTHORS"
1202.IP "John Bovey" 4 1463.IP "John Bovey" 4
1203.IX Item "John Bovey" 1464.IX Item "John Bovey"
1204University of Kent, 1992, wrote the original Xvt. 1465University of Kent, 1992, wrote the original Xvt.
… …
1216.IP "Oezguer Kesim <kesim@math.fu\-berlin.de>" 4 1477.IP "Oezguer Kesim <kesim@math.fu\-berlin.de>" 4
1217.IX Item "Oezguer Kesim <kesim@math.fu-berlin.de>" 1478.IX Item "Oezguer Kesim <kesim@math.fu-berlin.de>"
1218Project Coordinator (changes.txt 2.21a to 2.4.5) 1479Project Coordinator (changes.txt 2.21a to 2.4.5)
1219.IP "Geoff Wing <gcw@pobox.com>" 4 1480.IP "Geoff Wing <gcw@pobox.com>" 4
1220.IX Item "Geoff Wing <gcw@pobox.com>" 1481.IX Item "Geoff Wing <gcw@pobox.com>"
1221Rewrote screen display and text selection routines. Project Coordinator 1482Rewrote screen display and text selection routines.
1483.Sp
1222(changes.txt 2.4.6 \- rxvt\-unicode) 1484Project Coordinator (changes.txt 2.4.6 \- rxvt\-unicode)
1223.IP "Marc Alexander Lehmann <rxvt\-unicode@schmorp.de>" 4 1485.IP "Marc Alexander Lehmann <rxvt\-unicode@schmorp.de>" 4
1224.IX Item "Marc Alexander Lehmann <rxvt-unicode@schmorp.de>" 1486.IX Item "Marc Alexander Lehmann <rxvt-unicode@schmorp.de>"
1225Forked rxvt\-unicode, rewrote most of the display code and internal 1487Forked rxvt\-unicode, unicode support, rewrote almost all the code, perl
1226character handling to store text in unicode, improve xterm 1488extension, random hacks, numerous bugfixes and extensions.
1227compatibility and apply numerous other bugfixes and extensions.
1228.Sp 1489.Sp
1229Project Coordinator (Changes 1.0 \-) 1490Project Coordinator (Changes 1.0 \-)
1491.IP "Emanuele Giaquinta <e.giaquinta@glauco.it>" 4
1492.IX Item "Emanuele Giaquinta <e.giaquinta@glauco.it>"
1493Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.

Diff Legend

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