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.25 by root, Tue Oct 25 20:04:59 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
… …
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-10-25" "5.8" "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 ]]
… …
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"
… …
227Turn on/off jump scrolling; resource \fBjumpScroll\fR. 231Turn on/off jump scrolling; resource \fBjumpScroll\fR.
228.IP "\fB\-ip\fR|\fB+ip\fR | \fB\-tr\fR|\fB+tr\fR" 4 232.IP "\fB\-ip\fR|\fB+ip\fR | \fB\-tr\fR|\fB+tr\fR" 4
229.IX Item "-ip|+ip | -tr|+tr" 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. Small values 242Fade the text by the given percentage when focus is lost. Small values
235fade a little only, 100 completely replaces all colours by the fade 243fade a little only, 100 completely replaces all colours by the fade
236colour; resource \fBfading\fR. 244colour; resource \fBfading\fR.
237.IP "\fB\-fadecolor\fR \fIcolour\fR" 4 245.IP "\fB\-fadecolor\fR \fIcolour\fR" 4
238.IX Item "-fadecolor colour" 246.IX Item "-fadecolor colour"
239Fade to this colour when fading is used (see \fB\-fade\fR). The default colour 247Fade to this colour when fading is used (see \fB\-fade\fR). The default colour
240is black. resource \fBfadeColor\fR. 248is opaque black. resource \fBfadeColor\fR.
241.IP "\fB\-tint\fR \fIcolour\fR" 4 249.IP "\fB\-tint\fR \fIcolour\fR" 4
242.IX Item "-tint colour" 250.IX Item "-tint colour"
243Tint the transparent background pixmap with the given colour when 251Tint the transparent background pixmap with the given colour when
244transparency is enabled with \fB\-tr\fR or \fB\-ip\fR. This only works for 252transparency is enabled with \fB\-tr\fR or \fB\-ip\fR. This only works for
245non-tiled backgrounds, currently. See also the \fB\-sh\fR option that can be 253non-tiled backgrounds, currently. See also the \fB\-sh\fR option that can be
246used to brighten or darken the image in addition to tinting it; resource 254used to brighten or darken the image in addition to tinting it; resource
247\&\fItintColor\fR. Example: 255\&\fItintColor\fR. Example:
248.Sp 256.Sp
249.Vb 1 257.Vb 1
250\& @@RXVT_NAME@@ -tr -tint blue -sh 40 258\& @@RXVT_NAME@@ \-tr \-tint blue \-sh 40
251.Ve 259.Ve
252.IP "\fB\-sh\fR" 4 260.IP "\fB\-sh\fR" 4
253.IX Item "-sh" 261.IX Item "-sh"
254\&\fInumber\fR Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent 262\&\fInumber\fR Darken (0 .. 100) or lighten (\-1 .. \-100) the transparent
255background 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
… …
280The 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;
281resource \fBborderColor\fR. 289resource \fBborderColor\fR.
282.IP "\fB\-fn\fR \fIfontlist\fR" 4 290.IP "\fB\-fn\fR \fIfontlist\fR" 4
283.IX Item "-fn fontlist" 291.IX Item "-fn fontlist"
284Select 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
285that are used in turn when trying to display Unicode characters. The 293that are checked in order when trying to find glyphs for characters. The
286first font defines the cell size for characters; other fonts might be 294first font defines the cell size for characters; other fonts might be
287smaller, but not (in general) larger. A (hopefully) reasonable default 295smaller, but not (in general) larger. A (hopefully) reasonable default
288font 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.
289.Sp 297.Sp
290In 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
291with \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,
292e.g.: 300e.g.:
293.Sp 301.Sp
294.Vb 2 302.Vb 2
295\& @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 303\& @@RXVT_NAME@@ \-fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
296\& @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 304\& @@RXVT_NAME@@ \-fn "9x15bold,xft:Bitstream Vera Sans Mono"
297.Ve 305.Ve
298.Sp 306.Sp
299See 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
300section of @@RXVT_NAME@@(7). 308section of @@RXVT_NAME@@(7).
301.IP "\fB\-fb\fR \fIfontlist\fR" 4 309.IP "\fB\-fb\fR \fIfontlist\fR" 4
302.IX Item "-fb fontlist" 310.IX Item "-fb fontlist"
303Compile 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
304be printed. See resource \fBboldFont\fR for details. 312are to be printed. See resource \fBboldFont\fR for details.
305.IP "\fB\-fi\fR \fIfontlist\fR" 4 313.IP "\fB\-fi\fR \fIfontlist\fR" 4
306.IX Item "-fi fontlist" 314.IX Item "-fi fontlist"
307Compile 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
308be printed. See resource \fBitalicFont\fR for details. 316characters are to be printed. See resource \fBitalicFont\fR for details.
309.IP "\fB\-fbi\fR \fIfontlist\fR" 4 317.IP "\fB\-fbi\fR \fIfontlist\fR" 4
310.IX Item "-fbi fontlist" 318.IX Item "-fbi fontlist"
311Compile 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
312be 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.
313.IP "\fB\-name\fR \fIname\fR" 4 327.IP "\fB\-name\fR \fIname\fR" 4
314.IX Item "-name name" 328.IX Item "-name name"
315Specify the application name under which resources are to be obtained, 329Specify the application name under which resources are to be obtained,
316rather than the default executable file name. Name should not contain 330rather than the default executable file name. Name should not contain
317`.' or `*' characters. Also sets the icon and title name. 331`.' or `*' characters. Also sets the icon and title name.
… …
379.IP "\fB\-bl\fR" 4 393.IP "\fB\-bl\fR" 4
380.IX Item "-bl" 394.IX Item "-bl"
381Compile \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.
382if 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
383decorations; 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.
384.IP "\fB\-lsp\fR \fInumber\fR" 4 408.IP "\fB\-lsp\fR \fInumber\fR" 4
385.IX Item "-lsp number" 409.IX Item "-lsp number"
386Compile \fIfrills\fR: Lines (pixel height) to insert between each row of 410Compile \fIfrills\fR: Lines (pixel height) to insert between each row of
387the display. Useful to work around font rendering problems; resource 411the display. Useful to work around font rendering problems; resource
388\&\fBlinespace\fR. 412\&\fBlinespace\fR.
… …
399the 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
400given 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
401on 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
402run 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,
403failing 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
404.IP "\fB\-title\fR \fItext\fR" 4 435.IP "\fB\-title\fR \fItext\fR" 4
405.IX Item "-title text" 436.IX Item "-title text"
406Window 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
407of 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
408application name; resource \fBtitle\fR. 439application name; resource \fBtitle\fR.
… …
452\&\fBsecondaryScreen\fR. 483\&\fBsecondaryScreen\fR.
453.IP "\fB\-ssr\fR|\fB+ssr\fR" 4 484.IP "\fB\-ssr\fR|\fB+ssr\fR" 4
454.IX Item "-ssr|+ssr" 485.IX Item "-ssr|+ssr"
455Turn on/off secondary screen scroll (default enabled); resource 486Turn on/off secondary screen scroll (default enabled); resource
456\&\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.
457.IP "\fB\-keysym.\fR\fIsym\fR \fIstring\fR" 4 494.IP "\fB\-keysym.\fR\fIsym\fR \fIstring\fR" 4
458.IX Item "-keysym.sym string" 495.IX Item "-keysym.sym string"
459Remap a key symbol. See resource \fBkeysym\fR. 496Remap a key symbol. See resource \fBkeysym\fR.
460.IP "\fB\-embed\fR \fIwindowid\fR" 4 497.IP "\fB\-embed\fR \fIwindowid\fR" 4
461.IX Item "-embed windowid" 498.IX Item "-embed windowid"
462Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 499Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
463which enables applications to easily embed a terminal. 500which enables applications to easily embed a terminal.
464.Sp 501.Sp
465Right 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
466shouldn'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
467quite 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
… …
470The window will not be destroyed when @@RXVT_NAME@@ exits. 507The window will not be destroyed when @@RXVT_NAME@@ exits.
471.Sp 508.Sp
472It 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
473descriptors 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
474can use file descriptors to communicate with the programs within the 511can use file descriptors to communicate with the programs within the
475terminal. 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
476not. 513not.
477.Sp 514.Sp
478Here is a short Gtk2\-perl snippet that illustrates how this option can be 515Here is a short Gtk2\-perl snippet that illustrates how this option can be
479used (a longer example is in \fIdoc/embed\fR): 516used (a longer example is in \fIdoc/embed\fR):
480.Sp 517.Sp
481.Vb 5 518.Vb 5
482\& my $rxvt = new Gtk2::Socket; 519\& my $rxvt = new Gtk2::Socket;
483\& $rxvt->signal_connect_after (realize => sub { 520\& $rxvt\->signal_connect_after (realize => sub {
484\& my $xid = $_[0]->window->get_xid; 521\& my $xid = $_[0]\->window\->get_xid;
485\& system "@@RXVT_NAME@@ -embed $xid &"; 522\& system "@@RXVT_NAME@@ \-embed $xid &";
486\& }); 523\& });
487.Ve 524.Ve
488.IP "\fB\-pty\-fd\fR \fIfileno\fR" 4 525.IP "\fB\-pty\-fd\fR \fIfile descriptor\fR" 4
489.IX Item "-pty-fd fileno" 526.IX Item "-pty-fd file descriptor"
490Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty 527Tells @@RXVT_NAME@@ \s-1NOT\s0 to execute any commands or create a new pty/tty
491pair but instead use the given filehandle as the tty master. This is 528pair but instead use the given file descriptor as the tty master. This is
492useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 529useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
493without having to run a program within it. 530without having to run a program within it.
494.Sp 531.Sp
495If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 532If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
496entries and will not tinker with pty/tty permissions \- you have to do that 533entries and will not tinker with pty/tty permissions \- you have to do that
497yourself if you want that. 534yourself if you want that.
498.Sp 535.Sp
536As an extremely special case, specifying \f(CW\*(C`\-1\*(C'\fR will completely suppress
537pty/tty operations.
538.Sp
499Here is a example in perl that illustrates how this option can be used (a 539Here is a example in perl that illustrates how this option can be used (a
500longer example is in \fIdoc/pty\-fd\fR): 540longer example is in \fIdoc/pty\-fd\fR):
501.Sp 541.Sp
502.Vb 2 542.Vb 2
503\& use IO::Pty; 543\& use IO::Pty;
504\& use Fcntl; 544\& use Fcntl;
505.Ve 545\&
506.Sp
507.Vb 4
508\& my $pty = new IO::Pty; 546\& my $pty = new IO::Pty;
509\& fcntl $pty, F_SETFD, 0; # clear close-on-exec 547\& fcntl $pty, F_SETFD, 0; # clear close\-on\-exec
510\& system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&"; 548\& system "@@RXVT_NAME@@ \-pty\-fd " . (fileno $pty) . "&";
511\& close $pty; 549\& close $pty;
512.Ve 550\&
513.Sp
514.Vb 3
515\& # now communicate with rxvt 551\& # now communicate with rxvt
516\& my $slave = $pty->slave; 552\& my $slave = $pty\->slave;
517\& while (<$slave>) { print $slave "got <$_>\en" } 553\& while (<$slave>) { print $slave "got <$_>\en" }
518.Ve 554.Ve
555.IP "\fB\-pe\fR \fIstring\fR" 4
556.IX Item "-pe string"
557Comma-separated list of perl extension scripts to use (or not to use) in
558this terminal instance. See resource \fBperl-ext\fR for details.
519.SH "RESOURCES (available also as long\-options)" 559.SH "RESOURCES (available also as long\-options)"
520.IX Header "RESOURCES (available also as long-options)" 560.IX Header "RESOURCES (available also as long-options)"
521Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long 561Note: `@@RXVT_NAME@@ \-\-help' gives a list of all resources (long
522options) compiled into your version. 562options) compiled into your version.
523.PP 563.PP
524There 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
525Xresource data: using the X libraries (Xrm*\-functions) or internal 565distribution do also load settings from the \fB~/.Xresources\fR file when X
526Xresources reader (\fB~/.Xdefaults\fR). For the first method (ie. 566starts. @@RXVT_NAME@@ will consult the following files/resources in order,
527\&\fB@@RXVT_NAME@@ \-h\fR lists \fBXGetDefaults\fR), you can set and change the 567with later settings overwriting earlier ones:
528resources using X11 tools like \fBxrdb\fR. Many distribution do also load
529settings from the \fB~/.Xresources\fR file when X starts. @@RXVT_NAME@@
530will consult the following files/resources in order, with later settings
531overwriting earlier ones:
532.PP 568.PP
533.Vb 5 569.Vb 5
534\& 1. system-wide app-defaults file, either locale-dependent OR global 570\& 1. system\-wide app\-defaults file, either locale\-dependent OR global
535\& 2. app-defaults file in $XAPPLRESDIR 571\& 2. app\-defaults file in $XAPPLRESDIR
536\& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 572\& 3. RESOURCE_MANAGER property on root\-window OR $HOME/.Xdefaults
537\& 4. SCREEN_RESOURCES for the current screen 573\& 4. SCREEN_RESOURCES for the current screen
538\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 574\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults\-<nodename>
539.Ve 575.Ve
540.PP 576.PP
541If compiled with internal Xresources support (i.e. \fB@@RXVT_NAME@@ \-h\fR
542lists \fB.Xdefaults\fR) then \fB@@RXVT_NAME@@\fR accepts application defaults
543set in XAPPLOADDIR/URxvt (compile\-time defined: usually
544\&\fB/usr/lib/X11/app\-defaults/URxvt\fR) and resources set in
545\&\fB~/.Xdefaults\fR, or \fB~/.Xresources\fR if \fB~/.Xdefaults\fR does not exist.
546Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two 577Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two class
547class 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
548resources 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
549easily configured, while the class name \fBURxvt\fR allows resources 580configured, while the class name \fBURxvt\fR allows resources unique to
550unique 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
551shared between different \fB@@RXVT_NAME@@\fR configurations. If no 582configurations. If no resources are specified, suitable defaults will
552resources are specified, suitable defaults will be used. Command-line 583be used. Command-line arguments can be used to override resource
553arguments can be used to override resource settings. The following 584settings. The following resources are supported (you might want to
554resources 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.
555.IP "\fBgeometry:\fR \fIgeom\fR" 4 591.IP "\fBgeometry:\fR \fIgeom\fR" 4
556.IX Item "geometry: geom" 592.IX Item "geometry: geom"
557Create the window with the specified X window geometry [default 80x24]; 593Create the window with the specified X window geometry [default 80x24];
558option \fB\-geometry\fR. 594option \fB\-geometry\fR.
559.IP "\fBbackground:\fR \fIcolour\fR" 4 595.IP "\fBbackground:\fR \fIcolour\fR" 4
… …
621.IP "\fBinheritPixmap:\fR \fIboolean\fR" 4 657.IP "\fBinheritPixmap:\fR \fIboolean\fR" 4
622.IX Item "inheritPixmap: boolean" 658.IX Item "inheritPixmap: boolean"
623\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving 659\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving
624artificial transparency. \fBFalse\fR: do not inherit the parent windows' 660artificial transparency. \fBFalse\fR: do not inherit the parent windows'
625pixmap. 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
626.IP "\fBfading:\fR \fInumber\fR" 4 665.IP "\fBfading:\fR \fInumber\fR" 4
627.IX Item "fading: number" 666.IX Item "fading: number"
628Fade the text by the given percentage when focus is lost; option \fB\-fade\fR. 667Fade the text by the given percentage when focus is lost; option \fB\-fade\fR.
629.IP "\fBfadeColor:\fR \fIcolour\fR" 4 668.IP "\fBfadeColor:\fR \fIcolour\fR" 4
630.IX Item "fadeColor: colour" 669.IX Item "fadeColor: colour"
… …
658centre (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
659of 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
660specifies an integer number of images in that direction. No image will 699specifies an integer number of images in that direction. No image will
661be magnified beyond 10 times its original size. The maximum permitted 700be magnified beyond 10 times its original size. The maximum permitted
662scale is 1000. [default 0x0+50+50] 701scale is 1000. [default 0x0+50+50]
663.IP "\fBmenu:\fR \fIfile[;tag]\fR" 4
664.IX Item "menu: file[;tag]"
665Read in the specified menu file (note the `.menu' extension is
666optional) and also optionally specify a starting tag to find. See the
667reference documentation for details on the syntax for the menuBar.
668.IP "\fBpath:\fR \fIpath\fR" 4 702.IP "\fBpath:\fR \fIpath\fR" 4
669.IX Item "path: path" 703.IX Item "path: path"
670Specify the colon-delimited search path for finding files (\s-1XPM\s0 and 704Specify the colon-delimited search path for finding \s-1XPM\s0 files.
671menus), in addition to the paths specified by the \fB\s-1RXVTPATH\s0\fR and
672\&\fB\s-1PATH\s0\fR environment variables.
673.IP "\fBfont:\fR \fIfontlist\fR" 4 705.IP "\fBfont:\fR \fIfontlist\fR" 4
674.IX Item "font: fontlist" 706.IX Item "font: fontlist"
675Select 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
676names that are used in turn when trying to display Unicode characters. 708that are checked in order when trying to find glyphs for characters. The
677The first font defines the cell size for characters; other fonts might 709first font defines the cell size for characters; other fonts might be
678be smaller, but not larger. A reasonable default font list is always 710smaller, but not (in general) larger. A (hopefully) reasonable default
679appended to it. option \fB\-fn\fR. 711font list is always appended to it; option \fB\-fn\fR.
680.Sp 712.Sp
681Each 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
682optional 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.
683.Sp 715.Sp
684In addition, each font can be prefixed with additional hints and 716In addition, each font can be prefixed with additional hints and
… …
687fonts. 719fonts.
688.Sp 720.Sp
689For example, this font resource 721For example, this font resource
690.Sp 722.Sp
691.Vb 5 723.Vb 5
692\& URxvt*font: 9x15bold,\e 724\& URxvt.font: 9x15bold,\e
693\& -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
694\& -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
695\& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e 727\& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e
696\& xft:Code2000:antialias=false 728\& xft:Code2000:antialias=false
697.Ve 729.Ve
698.Sp 730.Sp
699specifies 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
… …
732\&\*(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
733not possible, replacement fonts of the desired shape will be tried. 765not possible, replacement fonts of the desired shape will be tried.
734.Sp 766.Sp
735If 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
736text 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.
737.IP "\fBselectstyle:\fR \fImode\fR" 4 776.IP "\fBselectstyle:\fR \fImode\fR" 4
738.IX Item "selectstyle: mode" 777.IX Item "selectstyle: mode"
739Set 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
740xterm 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
741xterm style selection. 780xterm style selection.
… …
780The string will be interpreted as if typed into the shell as\-is. 819The string will be interpreted as if typed into the shell as\-is.
781.Sp 820.Sp
782Example: 821Example:
783.Sp 822.Sp
784.Vb 1 823.Vb 1
785\& URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 824\& URxvt.print\-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
786.Ve 825.Ve
787.Sp 826.Sp
788This creates a new file in your home directory with the screen contents 827This creates a new file in your home directory with the screen contents
789everytime you hit \f(CW\*(C`Print\*(C'\fR. 828every time you hit \f(CW\*(C`Print\*(C'\fR.
790.IP "\fBscrollBar:\fR \fIboolean\fR" 4 829.IP "\fBscrollBar:\fR \fIboolean\fR" 4
791.IX Item "scrollBar: boolean" 830.IX Item "scrollBar: boolean"
792\&\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:
793disable the scrollbar; option \fB+sb\fR. 832disable the scrollbar; option \fB+sb\fR.
794.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4 833.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4
… …
810\&\fB+si\fR. 849\&\fB+si\fR.
811.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4 850.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4
812.IX Item "scrollWithBuffer: boolean" 851.IX Item "scrollWithBuffer: boolean"
813\&\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
814\&\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
815with scrollback buffer when tty recieves new lines; option \fB+sw\fR. 854with scrollback buffer when tty receives new lines; option \fB+sw\fR.
816.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4 855.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4
817.IX Item "scrollTtyKeypress: boolean" 856.IX Item "scrollTtyKeypress: boolean"
818\&\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
819are those which are intercepted by rxvt-unicode for special handling and 858are those which are intercepted by rxvt-unicode for special handling and
820are 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
… …
833option \fB\-w\fR, \fB\-bw\fR, \fB\-borderwidth\fR. 872option \fB\-w\fR, \fB\-bw\fR, \fB\-borderwidth\fR.
834.IP "\fBborderLess:\fR \fIboolean\fR" 4 873.IP "\fBborderLess:\fR \fIboolean\fR" 4
835.IX Item "borderLess: boolean" 874.IX Item "borderLess: boolean"
836Set \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
837\&\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.
838.IP "\fBtermName:\fR \fItermname\fR" 4 883.IP "\fBtermName:\fR \fItermname\fR" 4
839.IX Item "termName: termname" 884.IX Item "termName: termname"
840Specifies 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
841variable; option \fB\-tn\fR. 886variable; option \fB\-tn\fR.
842.IP "\fBlinespace:\fR \fInumber\fR" 4 887.IP "\fBlinespace:\fR \fInumber\fR" 4
… …
885The 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
886pressed. If unset it will send the sequence traditionally associated 931pressed. If unset it will send the sequence traditionally associated
887with the \fBExecute\fR key. 932with the \fBExecute\fR key.
888.IP "\fBcutchars:\fR \fIstring\fR" 4 933.IP "\fBcutchars:\fR \fIstring\fR" 4
889.IX Item "cutchars: string" 934.IX Item "cutchars: string"
890The characters used as delimiters for double-click word selection. The 935The characters used as delimiters for double-click word selection
891built-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:
892.Sp 945.Sp
893\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]{|}\fR 946\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]{|}\fR
894.IP "\fBpreeditType:\fR \fIstyle\fR" 4 947.IP "\fBpreeditType:\fR \fIstyle\fR" 4
895.IX Item "preeditType: style" 948.IX Item "preeditType: style"
896\&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR. 949\&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR.
… …
900.IP "\fBimLocale:\fR \fIname\fR" 4 953.IP "\fBimLocale:\fR \fIname\fR" 4
901.IX Item "imLocale: name" 954.IX Item "imLocale: name"
902The 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.
903\&\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
904input extension to be able to input japanese characters while staying in 957input extension to be able to input japanese characters while staying in
905another locale. option \fB\-imlocale\fR. 958another locale; option \fB\-imlocale\fR.
906.IP "\fBimFont:\fR \fIfontset\fR" 4 959.IP "\fBimFont:\fR \fIfontset\fR" 4
907.IX Item "imFont: fontset" 960.IX Item "imFont: fontset"
908Specify 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
909\&\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
910by 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
… …
913option \fB\-imfont\fR. 966option \fB\-imfont\fR.
914.IP "\fBtripleclickwords:\fR \fIboolean\fR" 4 967.IP "\fBtripleclickwords:\fR \fIboolean\fR" 4
915.IX Item "tripleclickwords: boolean" 968.IX Item "tripleclickwords: boolean"
916Change the meaning of triple-click selection with the left mouse 969Change the meaning of triple-click selection with the left mouse
917button. 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
918the end of the logical line only. option \fB\-tcw\fR. 971the end of the logical line only; option \fB\-tcw\fR.
919.IP "\fBinsecure:\fR \fIboolean\fR" 4 972.IP "\fBinsecure:\fR \fIboolean\fR" 4
920.IX Item "insecure: boolean" 973.IX Item "insecure: boolean"
921Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that 974Enables \*(L"insecure\*(R" mode. Rxvt-unicode offers some escape sequences that
922echo 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
923abused if somebody gets 8\-bit\-clean access to your display, whether 976abused if somebody gets 8\-bit\-clean access to your display, whether
924throuh a mail client displaying mail bodies unfiltered or though 977through a mail client displaying mail bodies unfiltered or through
925\&\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
926that other terminals, including xterm, have these sequences 979default. (Note that many other terminals, including xterm, have these
927enabled by default). You can enable them by setting this boolean 980sequences enabled by default, which doesn't make it safer, though).
928resource or specifying \fB\-insecure\fR as an option. At the moment, this 981.Sp
929enabled display\-answer, locale, findfont, icon label and window title 982You can enable them by setting this boolean resource or specifying
930requests 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.
931.IP "\fBmodifier:\fR \fImodifier\fR" 4 985.IP "\fBmodifier:\fR \fImodifier\fR" 4
932.IX Item "modifier: modifier" 986.IX Item "modifier: modifier"
933Set 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,
934\&\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
935\&\fB\-mod\fR. 989\&\fB\-mod\fR.
936.IP "\fBanswerbackString:\fR \fIstring\fR" 4 990.IP "\fBanswerbackString:\fR \fIstring\fR" 4
937.IX Item "answerbackString: string" 991.IX Item "answerbackString: string"
938Specify 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)
939character is passed through. It may contain escape values as described 993character is passed through. It may contain escape values as described
940in the entry on \fBkeysym\fR following. 994in the entry on \fBkeysym\fR following.
941.IP "\fBsecondaryScreen:\fR \fIbool\fR" 4 995.IP "\fBsecondaryScreen:\fR \fIboolean\fR" 4
942.IX Item "secondaryScreen: bool" 996.IX Item "secondaryScreen: boolean"
943Turn on/off secondary screen (default enabled). 997Turn on/off secondary screen (default enabled).
944.IP "\fBsecondaryScroll:\fR \fIbool\fR" 4 998.IP "\fBsecondaryScroll:\fR \fIboolean\fR" 4
945.IX Item "secondaryScroll: bool" 999.IX Item "secondaryScroll: boolean"
946Turn on/off secondary screen scroll (default enabled). If the this 1000Turn on/off secondary screen scroll (default enabled). If the this
947option is enabled, scrolls on the secondary screen will change the 1001option is enabled, scrolls on the secondary screen will change the
948scrollback buffer and switching to/from the secondary screen will 1002scrollback buffer and switching to/from the secondary screen will
949instead 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.
950.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4 1010.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4
951.IX Item "keysym.sym: string" 1011.IX Item "keysym.sym: string"
952Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The 1012Compile \fIfrills\fR: Associate \fIstring\fR with keysym \fIsym\fR. The
953intervening resource name \fBkeysym.\fR cannot be omitted. 1013intervening resource name \fBkeysym.\fR cannot be omitted.
954.Sp 1014.Sp
… …
973\&\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,
974\&\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,
975\&\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
976can start or end with whitespace. 1036can start or end with whitespace.
977.Sp 1037.Sp
978Please note that you need to double the \f(CW\*(C`\e\*(C'\fR when using 1038Please note that you need to double the \f(CW\*(C`\e\*(C'\fR in resource files, as
979\&\f(CW\*(C`\-\-enable\-xgetdefault\*(C'\fR, as X itself does it's own de-escaping (you can 1039Xlib itself does its own de-escaping (you can use \f(CW\*(C`\e033\*(C'\fR instead of
980use \f(CW\*(C`\e033\*(C'\fR instead of \f(CW\*(C`\ee\*(C'\fR (and so on), which will work with both Xt and 1040\&\f(CW\*(C`\ee\*(C'\fR (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
981@@RXVT_NAME@@'s own processing). 1041processing).
982.Sp 1042.Sp
983You 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
984with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/' 1044with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimiter `/'
985should be a character not used by the strings. 1045should be a character not used by the strings.
986.Sp 1046.Sp
987Its usage can be demonstrated by an example: 1047Its usage can be demonstrated by an example:
988.Sp 1048.Sp
989.Vb 1 1049.Vb 1
990\& URxvt.keysym.M-C-0x61: list|\e033<M-C-|abc|> 1050\& URxvt.keysym.M\-C\-0x61: list|\e033<M\-C\-|abc|>
991.Ve 1051.Ve
992.Sp 1052.Sp
993The above line is equivalent to the following three lines: 1053The above line is equivalent to the following three lines:
994.Sp 1054.Sp
995.Vb 3 1055.Vb 3
996\& URxvt.keysym.Meta-Control-0x61: \e033<M-C-a> 1056\& URxvt.keysym.Meta\-Control\-0x61: \e033<M\-C\-a>
997\& URxvt.keysym.Meta-Control-0x62: \e033<M-C-b> 1057\& URxvt.keysym.Meta\-Control\-0x62: \e033<M\-C\-b>
998\& URxvt.keysym.Meta-Control-0x63: \e033<M-C-c> 1058\& URxvt.keysym.Meta\-Control\-0x63: \e033<M\-C\-c>
999.Ve 1059.Ve
1000.Sp 1060.Sp
1001If \fIstring\fR takes the form of \f(CW\*(C`command: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
1002is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1062is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1003example 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
1004when Control-Meta-c is being pressed": 1064when Control-Meta-c is being pressed":
1005.Sp 1065.Sp
1006.Vb 1 1066.Vb 1
1007\& URxvt.keysym.M-C-c: command:\e033]701;zh_CN.GBK\e007 1067\& URxvt.keysym.M\-C\-c: command:\e033]701;zh_CN.GBK\e007
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
1008.Ve 1077.Ve
1009.Sp 1078.Sp
1010Due the the large number of modifier combinations, a defined key mapping 1079Due the the large number of modifier combinations, a defined key mapping
1011will match if at \fIat least\fR the specified identifiers are being set, and 1080will match if at \fIat least\fR the specified identifiers are being set, and
1012no other key mappings with those and more bits are being defined. That 1081no other key mappings with those and more bits are being defined. That
… …
1019\&\f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke \*(L"holes\*(R" into the 1088\&\f(CW\*(C`Shift\-Insert\*(C'\fR mapping. To re-enable that, you can poke \*(L"holes\*(R" into the
1020user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement: 1089user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement:
1021.Sp 1090.Sp
1022.Vb 2 1091.Vb 2
1023\& URxvt.keysym.Insert: <my insert key sequence> 1092\& URxvt.keysym.Insert: <my insert key sequence>
1024\& URxvt.keysym.S-Insert: builtin: 1093\& URxvt.keysym.S\-Insert: builtin:
1025.Ve 1094.Ve
1026.Sp 1095.Sp
1027The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination 1096The first line defines a mapping for \f(CW\*(C`Insert\*(C'\fR and \fIany\fR combination
1028of modifiers. The second line re-establishes the default mapping for 1097of modifiers. The second line re-establishes the default mapping for
1029\&\f(CW\*(C`Shift\-Insert\*(C'\fR. 1098\&\f(CW\*(C`Shift\-Insert\*(C'\fR.
… …
1031The 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
1032the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited 1101the fonts \f(CW\*(C`suxuseuro\*(C'\fR and \f(CW\*(C`9x15bold\*(C'\fR, so you can have some limited
1033font-switching at runtime: 1102font-switching at runtime:
1034.Sp 1103.Sp
1035.Vb 2 1104.Vb 2
1036\& URxvt.keysym.M-C-1: command:\e033]50;suxuseuro\e007 1105\& URxvt.keysym.M\-C\-1: command:\e033]50;suxuseuro\e007
1037\& URxvt.keysym.M-C-2: command:\e033]50;9x15bold\e007 1106\& URxvt.keysym.M\-C\-2: command:\e033]50;9x15bold\e007
1038.Ve 1107.Ve
1039.Sp 1108.Sp
1040Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1109Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1041info): 1110info):
1042.Sp 1111.Sp
1043.Vb 2 1112.Vb 2
1044\& URxvt.keysym.M-C-3: command:\e033[8;25;80t 1113\& URxvt.keysym.M\-C\-3: command:\e033[8;25;80t
1045\& URxvt.keysym.M-C-4: command:\e033[8;48;110t 1114\& URxvt.keysym.M\-C\-4: command:\e033[8;48;110t
1046.Ve 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.
1047.SH "THE SCROLLBAR" 1181.SH "THE SCROLLBAR"
1048.IX Header "THE SCROLLBAR" 1182.IX Header "THE SCROLLBAR"
1049Lines 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
1050(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar 1184(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar
1051or 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
… …
1078to 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
1079(which can span multiple screen lines), unless modified by resource 1213(which can span multiple screen lines), unless modified by resource
1080\&\fBtripleclickwords\fR. 1214\&\fBtripleclickwords\fR.
1081.Sp 1215.Sp
1082Starting 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)
1083(Compile: \fIfrills\fR) will create a rectangular selection instead of a normal 1217(Compile: \fIfrills\fR) will create a rectangular selection instead of a
1084one. 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.
1085.IP "\fBInsertion\fR:" 4 1221.IP "\fBInsertion\fR:" 4
1086.IX Item "Insertion:" 1222.IX Item "Insertion:"
1087Pressing and releasing the Middle mouse button (or \fBShift-Insert\fR) in 1223Pressing and releasing the Middle mouse button in an \fB@@RXVT_NAME@@\fR
1088an \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
1089inserted 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.
1090.SH "CHANGING FONTS" 1229.SH "CHANGING FONTS"
1091.IX Header "CHANGING FONTS" 1230.IX Header "CHANGING FONTS"
1092Changing fonts (or font sizes, respectively) via the keypad is not yet 1231Changing fonts (or font sizes, respectively) via the keypad is not yet
1093supported in rxvt\-unicode. Bug me if you need this. 1232supported in rxvt\-unicode. Bug me if you need this.
1094.PP 1233.PP
1095You can, however, switch fonts at runtime using escape sequences (and 1234You can, however, switch fonts at runtime using escape sequences, e.g.:
1096therefore using the menubar), e.g.:
1097.PP 1235.PP
1098.Vb 1 1236.Vb 1
1099\& 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
1100.Ve 1245.Ve
1101.PP 1246.PP
1102rxvt-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.
1103.SH "ISO 14755 SUPPORT" 1248.SH "ISO 14755 SUPPORT"
1104.IX Header "ISO 14755 SUPPORT" 1249.IX Header "ISO 14755 SUPPORT"
1105\&\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
1106and character codes using the keyboard. It consists of 4 parts. The 1251and character codes using the keyboard. It consists of 4 parts. The
1107first part is available rxvt-unicode has been compiled with 1252first part is available rxvt-unicode has been compiled with
1108\&\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
1109with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR. 1254with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR.
1255.IP "\(bu" 4
1110.IP "* 5.1: Basic method" 4 12565.1: Basic method
1111.IX Item "5.1: Basic method" 1257.Sp
1112This allows you to enter unicode characters using their hexcode. 1258This allows you to enter unicode characters using their hexcode.
1113.Sp 1259.Sp
1114Start 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
1115hex-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
1116commit the character as if it were typed directly. While holding down 1262commit the character as if it were typed directly. While holding down
… …
1121As 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
1122address, which you cannot type. Fortunately, the card has the e\-mail 1268address, which you cannot type. Fortunately, the card has the e\-mail
1123address 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
1124by 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,
1125followed by releasing the modifier keys. 1271followed by releasing the modifier keys.
1272.IP "\(bu" 4
1126.IP "* 5.2: Keyboard symbols entry method" 4 12735.2: Keyboard symbols entry method
1127.IX Item "5.2: Keyboard symbols entry method" 1274.Sp
1128This mode lets you input characters representing the keycap symbols of 1275This mode lets you input characters representing the keycap symbols of
1129your keyboard, if representable in the current locale encoding. 1276your keyboard, if representable in the current locale encoding.
1130.Sp 1277.Sp
1131Start 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
1132them. 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
1133invoke it's usual function but instead will insert the corresponding 1280invoke its usual function but instead will insert the corresponding
1134keycap 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
1135released, 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
1136\&\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
1137reverse tab (Shift\-Tab). 1284reverse tab (Shift\-Tab).
1285.IP "\(bu" 4
1138.IP "* 5.3: Screen-selection entry method" 4 12865.3: Screen-selection entry method
1139.IX Item "5.3: Screen-selection entry method" 1287.Sp
1140While this is implemented already (it's basically the selection 1288While this is implemented already (it's basically the selection
1141mechanism), 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
1142.IP "* 5.4: Feedback method for identifying displayed characters for later input" 4 12915.4: Feedback method for identifying displayed characters for later input
1143.IX Item "5.4: Feedback method for identifying displayed characters for later input" 1292.Sp
1144This method lets you display the unicode character code associated with 1293This method lets you display the unicode character code associated with
1145characters already displayed. 1294characters already displayed.
1146.Sp 1295.Sp
1147You 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
1148pressing and holding the left mouse button and moving around. The unicode 1297pressing and holding the left mouse button and moving around. The unicode
… …
1165.SH "COLORS AND GRAPHICS" 1314.SH "COLORS AND GRAPHICS"
1166.IX Header "COLORS AND GRAPHICS" 1315.IX Header "COLORS AND GRAPHICS"
1167In addition to the default foreground and background colours, 1316In addition to the default foreground and background colours,
1168\&\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
1169high-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
1170colours with their \fBrgb.txt\fR names. 1319colours with their names.
1171.TS 1320.TS
1172l l l . 1321l l l .
1173color0 (black) = Black 1322color0 (black) = Black
1174color1 (red) = Red3 1323color1 (red) = Red3
1175color2 (green) = Green3 1324color2 (green) = Green3
… …
1187color14 (bright cyan) = Cyan 1336color14 (bright cyan) = Cyan
1188color15 (bright white) = White 1337color15 (bright white) = White
1189foreground = Black 1338foreground = Black
1190background = White 1339background = White
1191.TE 1340.TE
1192
1193.PP 1341.PP
1194It is also possible to specify the colour values of \fBforeground\fR, 1342It is also possible to specify the colour values of \fBforeground\fR,
1195\&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as 1343\&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as
1196a 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
1197color0\-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").
1198.PP 1355.PP
1199Note 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
1200always swapping the foreground/background colours. This is in contrast to 1357always swapping the foreground/background colours. This is in contrast to
1201\&\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
1202been specified. For example, 1359been specified. For example,
1203.IP "\fB@@RXVT_NAME@@ \-fg Black \-bg White \-rv\fR" 4 1360.IP "\fB@@RXVT_NAME@@ \-fg Black \-bg White \-rv\fR" 4
1204.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv" 1361.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv"
1205would 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
1206on 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
1207.SH "ENVIRONMENT" 1387.SH "ENVIRONMENT"
1208.IX Header "ENVIRONMENT" 1388.IX Header "ENVIRONMENT"
1209\&\fB@@RXVT_NAME@@\fR sets and/or uses the following environment variables: 1389\&\fB@@RXVT_NAME@@\fR sets and/or uses the following environment variables:
1210.IP "\fB\s-1TERM\s0\fR" 4 1390.IP "\fB\s-1TERM\s0\fR" 4
1211.IX Item "TERM" 1391.IX Item "TERM"
1212Normally set to \f(CW\*(C`rxvt\-unicode\*(C'\fR, unless overwritten at configure time, via 1392Normally set to \f(CW\*(C`rxvt\-unicode\*(C'\fR, unless overwritten at configure time, via
1213resources or on the commandline. 1393resources or on the command line.
1214.IP "\fB\s-1COLORTERM\s0\fR" 4 1394.IP "\fB\s-1COLORTERM\s0\fR" 4
1215.IX Item "COLORTERM" 1395.IX Item "COLORTERM"
1216Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on wether @@RXVT_NAME@@ was 1396Either \f(CW\*(C`rxvt\*(C'\fR, \f(CW\*(C`rxvt\-xpm\*(C'\fR, depending on whether @@RXVT_NAME@@ was
1217compiled with \s-1XPM\s0 support, and optionally with the added extension 1397compiled with \s-1XPM\s0 support, and optionally with the added extension
1218\&\f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome screen. 1398\&\f(CW\*(C`\-mono\*(C'\fR to indicate that rxvt-unicode runs on a monochrome screen.
1219.IP "\fB\s-1COLORFGBG\s0\fR" 4 1399.IP "\fB\s-1COLORFGBG\s0\fR" 4
1220.IX Item "COLORFGBG" 1400.IX Item "COLORFGBG"
1221Set 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 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
… …
1235Set to the terminfo directory iff @@RXVT_NAME@@ was configured with 1415Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1236\&\f(CW\*(C`\-\-with\-terminfo=PATH\*(C'\fR. 1416\&\f(CW\*(C`\-\-with\-terminfo=PATH\*(C'\fR.
1237.IP "\fB\s-1DISPLAY\s0\fR" 4 1417.IP "\fB\s-1DISPLAY\s0\fR" 4
1238.IX Item "DISPLAY" 1418.IX Item "DISPLAY"
1239Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1419Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1240display in it's child processes. 1420display in its child processes.
1241.IP "\fB\s-1SHELL\s0\fR" 4 1421.IP "\fB\s-1SHELL\s0\fR" 4
1242.IX Item "SHELL" 1422.IX Item "SHELL"
1243The shell to be used for command execution, defaults to \f(CW\*(C`/bin/sh\*(C'\fR. 1423The shell to be used for command execution, defaults to \f(CW\*(C`/bin/sh\*(C'\fR.
1244.IP "\fB\s-1RXVTPATH\s0\fR" 4
1245.IX Item "RXVTPATH"
1246The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1247files.
1248.IP "\fB\s-1PATH\s0\fR" 4
1249.IX Item "PATH"
1250Used in the same way as \f(CW\*(C`RXVTPATH\*(C'\fR.
1251.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4 1424.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
1252.IX Item "RXVT_SOCKET" 1425.IX Item "RXVT_SOCKET"
1253The unix domain socket path used by @@RXVT_NAME@@c(1) and 1426The unix domain socket path used by @@RXVT_NAME@@c(1) and
1254@@RXVT_NAME@@d(1). 1427@@RXVT_NAME@@d(1).
1255.Sp 1428.Sp
1256Default \fI$HOME/.rxvt\-unicode\-\fI<nodename\fI\fR. 1429Default \fI\f(CI$HOME\fI/.rxvt\-unicode\-\fI<nodename\fI\fR.
1257.IP "\fB\s-1HOME\s0\fR" 4 1430.IP "\fB\s-1HOME\s0\fR" 4
1258.IX Item "HOME" 1431.IX Item "HOME"
1259Used to locate the default directory for the unix domain socket for 1432Used to locate the default directory for the unix domain socket for
1260daemon communications and to locate various resource files (such as 1433daemon communications and to locate various resource files (such as
1261\&\f(CW\*(C`.Xdefaults\*(C'\fR) 1434\&\f(CW\*(C`.Xdefaults\*(C'\fR)
… …
1272.IX Item "/usr/lib/X11/rgb.txt" 1445.IX Item "/usr/lib/X11/rgb.txt"
1273Color names. 1446Color names.
1274.SH "SEE ALSO" 1447.SH "SEE ALSO"
1275.IX Header "SEE ALSO" 1448.IX Header "SEE ALSO"
1276@@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) 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)
1277.SH "BUGS"
1278.IX Header "BUGS"
1279Check the \s-1BUGS\s0 file for an up-to-date list.
1280.PP
1281Cursor change support is not yet implemented.
1282.PP
1283Click-and-drag doesn't work with X11 mouse report overriding.
1284.SH "CURRENT PROJECT COORDINATOR" 1450.SH "CURRENT PROJECT COORDINATOR"
1285.IX Header "CURRENT PROJECT COORDINATOR" 1451.IX Header "CURRENT PROJECT COORDINATOR"
1286.IP "Project Coordinator" 4 1452.IP "Project Coordinator" 4
1287.IX Item "Project Coordinator" 1453.IX Item "Project Coordinator"
1288Marc A. Lehmann <rxvt\-unicode@schmorp.de> 1454Marc A. Lehmann <rxvt\-unicode@schmorp.de>
1289.Sp 1455.Sp
1290<http://software.schmorp.de/#rxvt\-unicode> 1456<http://software.schmorp.de/pkg/rxvt\-unicode.html>
1291.SH "AUTHORS" 1457.SH "AUTHORS"
1292.IX Header "AUTHORS" 1458.IX Header "AUTHORS"
1293.IP "John Bovey" 4 1459.IP "John Bovey" 4
1294.IX Item "John Bovey" 1460.IX Item "John Bovey"
1295University of Kent, 1992, wrote the original Xvt. 1461University of Kent, 1992, wrote the original Xvt.
… …
1307.IP "Oezguer Kesim <kesim@math.fu\-berlin.de>" 4 1473.IP "Oezguer Kesim <kesim@math.fu\-berlin.de>" 4
1308.IX Item "Oezguer Kesim <kesim@math.fu-berlin.de>" 1474.IX Item "Oezguer Kesim <kesim@math.fu-berlin.de>"
1309Project Coordinator (changes.txt 2.21a to 2.4.5) 1475Project Coordinator (changes.txt 2.21a to 2.4.5)
1310.IP "Geoff Wing <gcw@pobox.com>" 4 1476.IP "Geoff Wing <gcw@pobox.com>" 4
1311.IX Item "Geoff Wing <gcw@pobox.com>" 1477.IX Item "Geoff Wing <gcw@pobox.com>"
1312Rewrote screen display and text selection routines. Project Coordinator 1478Rewrote screen display and text selection routines.
1479.Sp
1313(changes.txt 2.4.6 \- rxvt\-unicode) 1480Project Coordinator (changes.txt 2.4.6 \- rxvt\-unicode)
1314.IP "Marc Alexander Lehmann <rxvt\-unicode@schmorp.de>" 4 1481.IP "Marc Alexander Lehmann <rxvt\-unicode@schmorp.de>" 4
1315.IX Item "Marc Alexander Lehmann <rxvt-unicode@schmorp.de>" 1482.IX Item "Marc Alexander Lehmann <rxvt-unicode@schmorp.de>"
1316Forked rxvt\-unicode, rewrote most of the display code and internal 1483Forked rxvt\-unicode, unicode support, rewrote almost all the code, perl
1317character handling to store text in unicode, improve xterm 1484extension, random hacks, numerous bugfixes and extensions.
1318compatibility and apply numerous other bugfixes and extensions.
1319.Sp 1485.Sp
1320Project 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