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.46 by root, Fri Jan 13 12:40:46 2006 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 "2006-01-13" "7.0" "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
… …
285that are checked in order when trying to find glyphs for 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
… …
385.IP "\fB\-bl\fR" 4 393.IP "\fB\-bl\fR" 4
386.IX Item "-bl" 394.IX Item "-bl"
387Compile \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.
388if 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
389decorations; 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.
390.IP "\fB\-sbg\fR" 4 402.IP "\fB\-sbg\fR" 4
391.IX Item "-sbg" 403.IX Item "-sbg"
392Compile \fIfrills\fR: Disable the usage of the built-in block graphics/line 404Compile \fIfrills\fR: Disable the usage of the built-in block graphics/line
393drawing characters and just rely on what the specified fonts provide. Use 405drawing characters and just rely on what the specified fonts provide. Use
394this if you have a good font and want to use its block graphic glyphs; 406this if you have a good font and want to use its block graphic glyphs;
… …
416.Sp 428.Sp
417Please note that you must specify a program with arguments. If you want to 429Please note that you must specify a program with arguments. If you want to
418run shell commands, you have to specify the shell, like this: 430run shell commands, you have to specify the shell, like this:
419.Sp 431.Sp
420.Vb 1 432.Vb 1
421\& @@RXVT_NAME@@ -e sh -c "shell commands" 433\& @@RXVT_NAME@@ \-e sh \-c "shell commands"
422.Ve 434.Ve
423.IP "\fB\-title\fR \fItext\fR" 4 435.IP "\fB\-title\fR \fItext\fR" 4
424.IX Item "-title text" 436.IX Item "-title text"
425Window 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
426of 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
… …
482.IP "\fB\-keysym.\fR\fIsym\fR \fIstring\fR" 4 494.IP "\fB\-keysym.\fR\fIsym\fR \fIstring\fR" 4
483.IX Item "-keysym.sym string" 495.IX Item "-keysym.sym string"
484Remap a key symbol. See resource \fBkeysym\fR. 496Remap a key symbol. See resource \fBkeysym\fR.
485.IP "\fB\-embed\fR \fIwindowid\fR" 4 497.IP "\fB\-embed\fR \fIwindowid\fR" 4
486.IX Item "-embed windowid" 498.IX Item "-embed windowid"
487Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 499Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
488which enables applications to easily embed a terminal. 500which enables applications to easily embed a terminal.
489.Sp 501.Sp
490Right 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
491shouldn'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
492quite 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
… …
495The window will not be destroyed when @@RXVT_NAME@@ exits. 507The window will not be destroyed when @@RXVT_NAME@@ exits.
496.Sp 508.Sp
497It 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
498descriptors 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
499can use file descriptors to communicate with the programs within the 511can use file descriptors to communicate with the programs within the
500terminal. 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
501not. 513not.
502.Sp 514.Sp
503Here 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
504used (a longer example is in \fIdoc/embed\fR): 516used (a longer example is in \fIdoc/embed\fR):
505.Sp 517.Sp
506.Vb 5 518.Vb 5
507\& my $rxvt = new Gtk2::Socket; 519\& my $rxvt = new Gtk2::Socket;
508\& $rxvt->signal_connect_after (realize => sub { 520\& $rxvt\->signal_connect_after (realize => sub {
509\& my $xid = $_[0]->window->get_xid; 521\& my $xid = $_[0]\->window\->get_xid;
510\& system "@@RXVT_NAME@@ -embed $xid &"; 522\& system "@@RXVT_NAME@@ \-embed $xid &";
511\& }); 523\& });
512.Ve 524.Ve
513.IP "\fB\-pty\-fd\fR \fIfile descriptor\fR" 4 525.IP "\fB\-pty\-fd\fR \fIfile descriptor\fR" 4
514.IX Item "-pty-fd file descriptor" 526.IX Item "-pty-fd file descriptor"
515Tells @@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
516pair 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
517useful 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
518without having to run a program within it. 530without having to run a program within it.
519.Sp 531.Sp
520If 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
521entries 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
… …
528longer example is in \fIdoc/pty\-fd\fR): 540longer example is in \fIdoc/pty\-fd\fR):
529.Sp 541.Sp
530.Vb 2 542.Vb 2
531\& use IO::Pty; 543\& use IO::Pty;
532\& use Fcntl; 544\& use Fcntl;
533.Ve 545\&
534.Sp
535.Vb 4
536\& my $pty = new IO::Pty; 546\& my $pty = new IO::Pty;
537\& fcntl $pty, F_SETFD, 0; # clear close-on-exec 547\& fcntl $pty, F_SETFD, 0; # clear close\-on\-exec
538\& system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&"; 548\& system "@@RXVT_NAME@@ \-pty\-fd " . (fileno $pty) . "&";
539\& close $pty; 549\& close $pty;
540.Ve 550\&
541.Sp
542.Vb 3
543\& # now communicate with rxvt 551\& # now communicate with rxvt
544\& my $slave = $pty->slave; 552\& my $slave = $pty\->slave;
545\& while (<$slave>) { print $slave "got <$_>\en" } 553\& while (<$slave>) { print $slave "got <$_>\en" }
546.Ve 554.Ve
547.IP "\fB\-pe\fR \fIstring\fR" 4 555.IP "\fB\-pe\fR \fIstring\fR" 4
548.IX Item "-pe string" 556.IX Item "-pe string"
549Comma-separated list of perl extension scripts to use (or not to use) in 557Comma-separated list of perl extension scripts to use (or not to use) in
… …
557distribution do also load settings from the \fB~/.Xresources\fR file when X 565distribution do also load settings from the \fB~/.Xresources\fR file when X
558starts. @@RXVT_NAME@@ will consult the following files/resources in order, 566starts. @@RXVT_NAME@@ will consult the following files/resources in order,
559with later settings overwriting earlier ones: 567with later settings overwriting earlier ones:
560.PP 568.PP
561.Vb 5 569.Vb 5
562\& 1. system-wide app-defaults file, either locale-dependent OR global 570\& 1. system\-wide app\-defaults file, either locale\-dependent OR global
563\& 2. app-defaults file in $XAPPLRESDIR 571\& 2. app\-defaults file in $XAPPLRESDIR
564\& 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 572\& 3. RESOURCE_MANAGER property on root\-window OR $HOME/.Xdefaults
565\& 4. SCREEN_RESOURCES for the current screen 573\& 4. SCREEN_RESOURCES for the current screen
566\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 574\& 5. $XENVIRONMENT file OR $HOME/.Xdefaults\-<nodename>
567.Ve 575.Ve
568.PP 576.PP
569Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two class 577Note that when reading X resources, \fB@@RXVT_NAME@@\fR recognizes two class
570names: \fBRxvt\fR and \fBURxvt\fR. The class name \fBRxvt\fR allows resources 578names: \fBRxvt\fR and \fBURxvt\fR. The class name \fBRxvt\fR allows resources
571common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be easily 579common to both \fB@@RXVT_NAME@@\fR and the original \fIrxvt\fR to be easily
… …
574configurations. If no resources are specified, suitable defaults will 582configurations. If no resources are specified, suitable defaults will
575be used. Command-line arguments can be used to override resource 583be used. Command-line arguments can be used to override resource
576settings. The following resources are supported (you might want to 584settings. The following resources are supported (you might want to
577check the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for additional settings by perl 585check the @@RXVT_NAME@@\fIperl\fR\|(3) manpage for additional settings by perl
578extensions not documented here): 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.
579.IP "\fBgeometry:\fR \fIgeom\fR" 4 591.IP "\fBgeometry:\fR \fIgeom\fR" 4
580.IX Item "geometry: geom" 592.IX Item "geometry: geom"
581Create the window with the specified X window geometry [default 80x24]; 593Create the window with the specified X window geometry [default 80x24];
582option \fB\-geometry\fR. 594option \fB\-geometry\fR.
583.IP "\fBbackground:\fR \fIcolour\fR" 4 595.IP "\fBbackground:\fR \fIcolour\fR" 4
… …
645.IP "\fBinheritPixmap:\fR \fIboolean\fR" 4 657.IP "\fBinheritPixmap:\fR \fIboolean\fR" 4
646.IX Item "inheritPixmap: boolean" 658.IX Item "inheritPixmap: boolean"
647\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving 659\&\fBTrue\fR: make the background inherit the parent windows' pixmap, giving
648artificial transparency. \fBFalse\fR: do not inherit the parent windows' 660artificial transparency. \fBFalse\fR: do not inherit the parent windows'
649pixmap. 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
650.IP "\fBfading:\fR \fInumber\fR" 4 665.IP "\fBfading:\fR \fInumber\fR" 4
651.IX Item "fading: number" 666.IX Item "fading: number"
652Fade 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.
653.IP "\fBfadeColor:\fR \fIcolour\fR" 4 668.IP "\fBfadeColor:\fR \fIcolour\fR" 4
654.IX Item "fadeColor: colour" 669.IX Item "fadeColor: colour"
… …
682centre (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
683of 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
684specifies an integer number of images in that direction. No image will 699specifies an integer number of images in that direction. No image will
685be magnified beyond 10 times its original size. The maximum permitted 700be magnified beyond 10 times its original size. The maximum permitted
686scale is 1000. [default 0x0+50+50] 701scale is 1000. [default 0x0+50+50]
687.IP "\fBmenu:\fR \fIfile[;tag]\fR" 4
688.IX Item "menu: file[;tag]"
689Read in the specified menu file (note the `.menu' extension is
690optional) and also optionally specify a starting tag to find. See the
691reference documentation for details on the syntax for the menuBar.
692.IP "\fBpath:\fR \fIpath\fR" 4 702.IP "\fBpath:\fR \fIpath\fR" 4
693.IX Item "path: path" 703.IX Item "path: path"
694Specify the colon-delimited search path for finding files (\s-1XPM\s0 and 704Specify the colon-delimited search path for finding \s-1XPM\s0 files.
695menus), in addition to the paths specified by the \fB\s-1RXVTPATH\s0\fR and
696\&\fB\s-1PATH\s0\fR environment variables.
697.IP "\fBfont:\fR \fIfontlist\fR" 4 705.IP "\fBfont:\fR \fIfontlist\fR" 4
698.IX Item "font: fontlist" 706.IX Item "font: fontlist"
699Select the fonts to be used. This is a comma separated list of font names 707Select the fonts to be used. This is a comma separated list of font names
700that are checked in order when trying to find glyphs for characters. The 708that are checked in order when trying to find glyphs for characters. The
701first font defines the cell size for characters; other fonts might be 709first font defines the cell size for characters; other fonts might be
… …
711fonts. 719fonts.
712.Sp 720.Sp
713For example, this font resource 721For example, this font resource
714.Sp 722.Sp
715.Vb 5 723.Vb 5
716\& URxvt*font: 9x15bold,\e 724\& URxvt.font: 9x15bold,\e
717\& -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
718\& -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
719\& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e 727\& [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \e
720\& xft:Code2000:antialias=false 728\& xft:Code2000:antialias=false
721.Ve 729.Ve
722.Sp 730.Sp
723specifies 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
… …
760text font will being used for the given style. 768text font will being used for the given style.
761.IP "\fBintensityStyles:\fR \fIboolean\fR" 4 769.IP "\fBintensityStyles:\fR \fIboolean\fR" 4
762.IX Item "intensityStyles: boolean" 770.IX Item "intensityStyles: boolean"
763When font styles are not enabled, or this option is enabled (\fBTrue\fR, 771When font styles are not enabled, or this option is enabled (\fBTrue\fR,
764option \fB\-is\fR, the default), bold and italic font styles imply high 772option \fB\-is\fR, the default), bold and italic font styles imply high
765intensity foreground/backround colours. Disabling this option (\fBFalse\fR, 773intensity foreground/background colours. Disabling this option (\fBFalse\fR,
766option \fB+is\fR) disables this behaviour, the high intensity colours are not 774option \fB+is\fR) disables this behaviour, the high intensity colours are not
767reachable. 775reachable.
768.IP "\fBselectstyle:\fR \fImode\fR" 4 776.IP "\fBselectstyle:\fR \fImode\fR" 4
769.IX Item "selectstyle: mode" 777.IX Item "selectstyle: mode"
770Set 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
… …
811The 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.
812.Sp 820.Sp
813Example: 821Example:
814.Sp 822.Sp
815.Vb 1 823.Vb 1
816\& URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 824\& URxvt.print\-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
817.Ve 825.Ve
818.Sp 826.Sp
819This 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
820everytime you hit \f(CW\*(C`Print\*(C'\fR. 828every time you hit \f(CW\*(C`Print\*(C'\fR.
821.IP "\fBscrollBar:\fR \fIboolean\fR" 4 829.IP "\fBscrollBar:\fR \fIboolean\fR" 4
822.IX Item "scrollBar: boolean" 830.IX Item "scrollBar: boolean"
823\&\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:
824disable the scrollbar; option \fB+sb\fR. 832disable the scrollbar; option \fB+sb\fR.
825.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4 833.IP "\fBscrollBar_right:\fR \fIboolean\fR" 4
… …
841\&\fB+si\fR. 849\&\fB+si\fR.
842.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4 850.IP "\fBscrollWithBuffer:\fR \fIboolean\fR" 4
843.IX Item "scrollWithBuffer: boolean" 851.IX Item "scrollWithBuffer: boolean"
844\&\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
845\&\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
846with scrollback buffer when tty recieves new lines; option \fB+sw\fR. 854with scrollback buffer when tty receives new lines; option \fB+sw\fR.
847.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4 855.IP "\fBscrollTtyKeypress:\fR \fIboolean\fR" 4
848.IX Item "scrollTtyKeypress: boolean" 856.IX Item "scrollTtyKeypress: boolean"
849\&\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
850are those which are intercepted by rxvt-unicode for special handling and 858are those which are intercepted by rxvt-unicode for special handling and
851are 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
… …
922The 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
923pressed. If unset it will send the sequence traditionally associated 931pressed. If unset it will send the sequence traditionally associated
924with the \fBExecute\fR key. 932with the \fBExecute\fR key.
925.IP "\fBcutchars:\fR \fIstring\fR" 4 933.IP "\fBcutchars:\fR \fIstring\fR" 4
926.IX Item "cutchars: string" 934.IX Item "cutchars: string"
927The characters used as delimiters for double-click word selection. The 935The characters used as delimiters for double-click word selection
928built-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:
929.Sp 945.Sp
930\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]{|}\fR 946\&\fB\s-1BACKSLASH\s0 `"'&()*,;<=>?@[]{|}\fR
931.IP "\fBpreeditType:\fR \fIstyle\fR" 4 947.IP "\fBpreeditType:\fR \fIstyle\fR" 4
932.IX Item "preeditType: style" 948.IX Item "preeditType: style"
933\&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR. 949\&\fBOverTheSpot\fR, \fBOffTheSpot\fR, \fBRoot\fR; option \fB\-pt\fR.
… …
963default. (Note that many other terminals, including xterm, have these 979default. (Note that many other terminals, including xterm, have these
964sequences enabled by default, which doesn't make it safer, though). 980sequences enabled by default, which doesn't make it safer, though).
965.Sp 981.Sp
966You can enable them by setting this boolean resource or specifying 982You can enable them by setting this boolean resource or specifying
967\&\fB\-insecure\fR as an option. At the moment, this enables display\-answer, 983\&\fB\-insecure\fR as an option. At the moment, this enables display\-answer,
968locale, findfont, icon label and window title requests as well as dynamic 984locale, findfont, icon label and window title requests.
969menubar dispatch.
970.IP "\fBmodifier:\fR \fImodifier\fR" 4 985.IP "\fBmodifier:\fR \fImodifier\fR" 4
971.IX Item "modifier: modifier" 986.IX Item "modifier: modifier"
972Set 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,
973\&\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
974\&\fB\-mod\fR. 989\&\fB\-mod\fR.
975.IP "\fBanswerbackString:\fR \fIstring\fR" 4 990.IP "\fBanswerbackString:\fR \fIstring\fR" 4
976.IX Item "answerbackString: string" 991.IX Item "answerbackString: string"
977Specify 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)
978character is passed through. It may contain escape values as described 993character is passed through. It may contain escape values as described
979in the entry on \fBkeysym\fR following. 994in the entry on \fBkeysym\fR following.
980.IP "\fBsecondaryScreen:\fR \fIbool\fR" 4 995.IP "\fBsecondaryScreen:\fR \fIboolean\fR" 4
981.IX Item "secondaryScreen: bool" 996.IX Item "secondaryScreen: boolean"
982Turn on/off secondary screen (default enabled). 997Turn on/off secondary screen (default enabled).
983.IP "\fBsecondaryScroll:\fR \fIbool\fR" 4 998.IP "\fBsecondaryScroll:\fR \fIboolean\fR" 4
984.IX Item "secondaryScroll: bool" 999.IX Item "secondaryScroll: boolean"
985Turn on/off secondary screen scroll (default enabled). If the this 1000Turn on/off secondary screen scroll (default enabled). If the this
986option is enabled, scrolls on the secondary screen will change the 1001option is enabled, scrolls on the secondary screen will change the
987scrollback buffer and switching to/from the secondary screen will 1002scrollback buffer and switching to/from the secondary screen will
988instead scroll the screen up. 1003instead scroll the screen up.
989.IP "\fBhold\fR: \fIbool\fR" 4 1004.IP "\fBhold\fR: \fIboolean\fR" 4
990.IX Item "hold: bool" 1005.IX Item "hold: boolean"
991Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1006Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
992will not immediately destroy its window when the program executed within 1007will not immediately destroy its window when the program executed within
993it exits. Instead, it will wait till it is being killed or closed by the 1008it exits. Instead, it will wait till it is being killed or closed by the
994user. 1009user.
995.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4 1010.IP "\fBkeysym.\fR\fIsym\fR: \fIstring\fR" 4
… …
1019\&\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,
1020\&\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
1021can start or end with whitespace. 1036can start or end with whitespace.
1022.Sp 1037.Sp
1023Please note that you need to double the \f(CW\*(C`\e\*(C'\fR in resource files, as 1038Please note that you need to double the \f(CW\*(C`\e\*(C'\fR in resource files, as
1024Xlib itself does it's own de-escaping (you can use \f(CW\*(C`\e033\*(C'\fR instead of 1039Xlib itself does its own de-escaping (you can use \f(CW\*(C`\e033\*(C'\fR instead of
1025\&\f(CW\*(C`\ee\*(C'\fR (and so on), which will work with both Xt and @@RXVT_NAME@@'s own 1040\&\f(CW\*(C`\ee\*(C'\fR (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1026processing). 1041processing).
1027.Sp 1042.Sp
1028You 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
1029with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimeter `/' 1044with pattern \fBlist/PREFIX/MIDDLE/SUFFIX\fR, where the delimiter `/'
1030should be a character not used by the strings. 1045should be a character not used by the strings.
1031.Sp 1046.Sp
1032Its usage can be demonstrated by an example: 1047Its usage can be demonstrated by an example:
1033.Sp 1048.Sp
1034.Vb 1 1049.Vb 1
1035\& URxvt.keysym.M-C-0x61: list|\e033<M-C-|abc|> 1050\& URxvt.keysym.M\-C\-0x61: list|\e033<M\-C\-|abc|>
1036.Ve 1051.Ve
1037.Sp 1052.Sp
1038The above line is equivalent to the following three lines: 1053The above line is equivalent to the following three lines:
1039.Sp 1054.Sp
1040.Vb 3 1055.Vb 3
1041\& URxvt.keysym.Meta-Control-0x61: \e033<M-C-a> 1056\& URxvt.keysym.Meta\-Control\-0x61: \e033<M\-C\-a>
1042\& URxvt.keysym.Meta-Control-0x62: \e033<M-C-b> 1057\& URxvt.keysym.Meta\-Control\-0x62: \e033<M\-C\-b>
1043\& URxvt.keysym.Meta-Control-0x63: \e033<M-C-c> 1058\& URxvt.keysym.Meta\-Control\-0x63: \e033<M\-C\-c>
1044.Ve 1059.Ve
1045.Sp 1060.Sp
1046If \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
1047is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1062is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1048example 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
1049when Control-Meta-c is being pressed": 1064when Control-Meta-c is being pressed":
1050.Sp 1065.Sp
1051.Vb 1 1066.Vb 1
1052\& 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
1053.Ve 1068.Ve
1054.Sp 1069.Sp
1055If \fIstring\fR takes the form \f(CW\*(C`perl:STRING\*(C'\fR, then the specified \fB\s-1STRING\s0\fR 1070If \fIstring\fR takes the form \f(CW\*(C`perl:STRING\*(C'\fR, then the specified \fB\s-1STRING\s0\fR
1056is passed to the \f(CW\*(C`on_keyboard_command\*(C'\fR perl handler. See the @@RXVT_NAME@@\fIperl\fR\|(3) 1071is passed to the \f(CW\*(C`on_keyboard_command\*(C'\fR perl handler. See the @@RXVT_NAME@@\fIperl\fR\|(3)
1057manpage. For example, the \fIselection\fR extension (activated via 1072manpage. For example, the \fIselection\fR extension (activated via
1058\&\f(CW\*(C`@@RXVT_NAME@@ \-pe selection\*(C'\fR) listens for \f(CW\*(C`selection:rot13\*(C'\fR events: 1073\&\f(CW\*(C`@@RXVT_NAME@@ \-pe selection\*(C'\fR) listens for \f(CW\*(C`selection:rot13\*(C'\fR events:
1059.Sp 1074.Sp
1060.Vb 1 1075.Vb 1
1061\& URxvt.keysym.M-C-c: perl:selection:rot13 1076\& URxvt.keysym.M\-C\-c: perl:selection:rot13
1062.Ve 1077.Ve
1063.Sp 1078.Sp
1064Due the the large number of modifier combinations, a defined key mapping 1079Due the the large number of modifier combinations, a defined key mapping
1065will 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
1066no 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
… …
1073\&\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
1074user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement: 1089user-defined keymap using the \f(CW\*(C`builtin:\*(C'\fR replacement:
1075.Sp 1090.Sp
1076.Vb 2 1091.Vb 2
1077\& URxvt.keysym.Insert: <my insert key sequence> 1092\& URxvt.keysym.Insert: <my insert key sequence>
1078\& URxvt.keysym.S-Insert: builtin: 1093\& URxvt.keysym.S\-Insert: builtin:
1079.Ve 1094.Ve
1080.Sp 1095.Sp
1081The 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
1082of modifiers. The second line re-establishes the default mapping for 1097of modifiers. The second line re-establishes the default mapping for
1083\&\f(CW\*(C`Shift\-Insert\*(C'\fR. 1098\&\f(CW\*(C`Shift\-Insert\*(C'\fR.
… …
1085The 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
1086the 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
1087font-switching at runtime: 1102font-switching at runtime:
1088.Sp 1103.Sp
1089.Vb 2 1104.Vb 2
1090\& URxvt.keysym.M-C-1: command:\e033]50;suxuseuro\e007 1105\& URxvt.keysym.M\-C\-1: command:\e033]50;suxuseuro\e007
1091\& URxvt.keysym.M-C-2: command:\e033]50;9x15bold\e007 1106\& URxvt.keysym.M\-C\-2: command:\e033]50;9x15bold\e007
1092.Ve 1107.Ve
1093.Sp 1108.Sp
1094Other 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
1095info): 1110info):
1096.Sp 1111.Sp
1097.Vb 2 1112.Vb 2
1098\& URxvt.keysym.M-C-3: command:\e033[8;25;80t 1113\& URxvt.keysym.M\-C\-3: command:\e033[8;25;80t
1099\& URxvt.keysym.M-C-4: command:\e033[8;48;110t 1114\& URxvt.keysym.M\-C\-4: command:\e033[8;48;110t
1100.Ve 1115.Ve
1101.IP "\fBperl-ext-common\fR: \fIstring\fR" 4 1116.IP "\fBperl-ext-common\fR: \fIstring\fR" 4
1102.IX Item "perl-ext-common: string" 1117.IX Item "perl-ext-common: string"
1103.PD 0 1118.PD 0
1104.IP "\fBperl-ext\fR: \fIstring\fR" 4 1119.IP "\fBperl-ext\fR: \fIstring\fR" 4
… …
1113example, \f(CW\*(C`default,\-selection\*(C'\fR will use all the default extension except 1128example, \f(CW\*(C`default,\-selection\*(C'\fR will use all the default extension except
1114\&\f(CW\*(C`selection\*(C'\fR. 1129\&\f(CW\*(C`selection\*(C'\fR.
1115.Sp 1130.Sp
1116Extension names can also be followed by an argument in angle brackets 1131Extension names can also be followed by an argument in angle brackets
1117(e.g. \f(CW\*(C`searchable\-scrollback<M\-s>\*(C'\fR, which binds the hotkey for 1132(e.g. \f(CW\*(C`searchable\-scrollback<M\-s>\*(C'\fR, which binds the hotkey for
1118searchable scorllback to Alt/Meta\-s). Mentioning the same extension 1133searchable scrollback to Alt/Meta\-s). Mentioning the same extension
1119multiple times with different arguments will pass multiple arguments to 1134multiple times with different arguments will pass multiple arguments to
1120the extension. 1135the extension.
1121.Sp 1136.Sp
1122Each extension is looked up in the library directories, loaded if 1137Each extension is looked up in the library directories, loaded if
1123necessary, and bound to the current terminal instance. 1138necessary, and bound to the current terminal instance.
… …
1156.IX Item "urlLauncher: string" 1171.IX Item "urlLauncher: string"
1157Specifies the program to be started with a \s-1URL\s0 argument. Used by the 1172Specifies the program to be started with a \s-1URL\s0 argument. Used by the
1158\&\f(CW\*(C`selection\-popup\*(C'\fR and \f(CW\*(C`mark\-urls\*(C'\fR perl extensions. 1173\&\f(CW\*(C`selection\-popup\*(C'\fR and \f(CW\*(C`mark\-urls\*(C'\fR perl extensions.
1159.IP "\fBtransient-for\fR: \fIwindowid\fR" 4 1174.IP "\fBtransient-for\fR: \fIwindowid\fR" 4
1160.IX Item "transient-for: windowid" 1175.IX Item "transient-for: windowid"
1161Sets the \s-1WM_TRANSIENT_FOR\s0 property to the given window iw. 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.
1162.SH "THE SCROLLBAR" 1181.SH "THE SCROLLBAR"
1163.IX Header "THE SCROLLBAR" 1182.IX Header "THE SCROLLBAR"
1164Lines 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
1165(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar 1184(resource: \fBsaveLines\fR) and can be scrolled back using the scrollbar
1166or 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
… …
1199normal one. In this mode, every selected row becomes its own line in the 1218normal one. In this mode, every selected row becomes its own line in the
1200selection, and trailing whitespace is visually underlined and removed from 1219selection, and trailing whitespace is visually underlined and removed from
1201the selection. 1220the selection.
1202.IP "\fBInsertion\fR:" 4 1221.IP "\fBInsertion\fR:" 4
1203.IX Item "Insertion:" 1222.IX Item "Insertion:"
1204Pressing and releasing the Middle mouse button (or \fBShift-Insert\fR) in 1223Pressing and releasing the Middle mouse button in an \fB@@RXVT_NAME@@\fR
1205an \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
1206inserted 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.
1207.SH "CHANGING FONTS" 1229.SH "CHANGING FONTS"
1208.IX Header "CHANGING FONTS" 1230.IX Header "CHANGING FONTS"
1209Changing fonts (or font sizes, respectively) via the keypad is not yet 1231Changing fonts (or font sizes, respectively) via the keypad is not yet
1210supported in rxvt\-unicode. Bug me if you need this. 1232supported in rxvt\-unicode. Bug me if you need this.
1211.PP 1233.PP
1212You can, however, switch fonts at runtime using escape sequences (and 1234You can, however, switch fonts at runtime using escape sequences, e.g.:
1213therefore using the menubar), e.g.:
1214.PP 1235.PP
1215.Vb 1 1236.Vb 1
1216\& printf '\ee]710;%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
1217.Ve 1245.Ve
1218.PP 1246.PP
1219rxvt-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.
1220.SH "ISO 14755 SUPPORT" 1248.SH "ISO 14755 SUPPORT"
1221.IX Header "ISO 14755 SUPPORT" 1249.IX Header "ISO 14755 SUPPORT"
1222\&\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
1223and character codes using the keyboard. It consists of 4 parts. The 1251and character codes using the keyboard. It consists of 4 parts. The
1224first part is available rxvt-unicode has been compiled with 1252first part is available rxvt-unicode has been compiled with
1225\&\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
1226with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR. 1254with \f(CW\*(C`\-\-enable\-iso14755\*(C'\fR.
1255.IP "\(bu" 4
1227.IP "* 5.1: Basic method" 4 12565.1: Basic method
1228.IX Item "5.1: Basic method" 1257.Sp
1229This allows you to enter unicode characters using their hexcode. 1258This allows you to enter unicode characters using their hexcode.
1230.Sp 1259.Sp
1231Start 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
1232hex-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
1233commit the character as if it were typed directly. While holding down 1262commit the character as if it were typed directly. While holding down
… …
1238As 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
1239address, which you cannot type. Fortunately, the card has the e\-mail 1268address, which you cannot type. Fortunately, the card has the e\-mail
1240address 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
1241by 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,
1242followed by releasing the modifier keys. 1271followed by releasing the modifier keys.
1272.IP "\(bu" 4
1243.IP "* 5.2: Keyboard symbols entry method" 4 12735.2: Keyboard symbols entry method
1244.IX Item "5.2: Keyboard symbols entry method" 1274.Sp
1245This mode lets you input characters representing the keycap symbols of 1275This mode lets you input characters representing the keycap symbols of
1246your keyboard, if representable in the current locale encoding. 1276your keyboard, if representable in the current locale encoding.
1247.Sp 1277.Sp
1248Start 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
1249them. 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
1250invoke it's usual function but instead will insert the corresponding 1280invoke its usual function but instead will insert the corresponding
1251keycap 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
1252released, 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
1253\&\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
1254reverse tab (Shift\-Tab). 1284reverse tab (Shift\-Tab).
1285.IP "\(bu" 4
1255.IP "* 5.3: Screen-selection entry method" 4 12865.3: Screen-selection entry method
1256.IX Item "5.3: Screen-selection entry method" 1287.Sp
1257While this is implemented already (it's basically the selection 1288While this is implemented already (it's basically the selection
1258mechanism), 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
1259.IP "* 5.4: Feedback method for identifying displayed characters for later input" 4 12915.4: Feedback method for identifying displayed characters for later input
1260.IX Item "5.4: Feedback method for identifying displayed characters for later input" 1292.Sp
1261This method lets you display the unicode character code associated with 1293This method lets you display the unicode character code associated with
1262characters already displayed. 1294characters already displayed.
1263.Sp 1295.Sp
1264You 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
1265pressing and holding the left mouse button and moving around. The unicode 1297pressing and holding the left mouse button and moving around. The unicode
… …
1282.SH "COLORS AND GRAPHICS" 1314.SH "COLORS AND GRAPHICS"
1283.IX Header "COLORS AND GRAPHICS" 1315.IX Header "COLORS AND GRAPHICS"
1284In addition to the default foreground and background colours, 1316In addition to the default foreground and background colours,
1285\&\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
1286high-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
1287colours with their \fBrgb.txt\fR names. 1319colours with their names.
1288.TS 1320.TS
1289l l l . 1321l l l .
1290color0 (black) = Black 1322color0 (black) = Black
1291color1 (red) = Red3 1323color1 (red) = Red3
1292color2 (green) = Green3 1324color2 (green) = Green3
… …
1304color14 (bright cyan) = Cyan 1336color14 (bright cyan) = Cyan
1305color15 (bright white) = White 1337color15 (bright white) = White
1306foreground = Black 1338foreground = Black
1307background = White 1339background = White
1308.TE 1340.TE
1309
1310.PP 1341.PP
1311It is also possible to specify the colour values of \fBforeground\fR, 1342It is also possible to specify the colour values of \fBforeground\fR,
1312\&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as 1343\&\fBbackground\fR, \fBcursorColor\fR, \fBcursorColor2\fR, \fBcolorBD\fR, \fBcolorUL\fR as
1313a 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
1314color0\-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").
1315.PP 1355.PP
1316Note 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
1317always swapping the foreground/background colours. This is in contrast to 1357always swapping the foreground/background colours. This is in contrast to
1318\&\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
1319been specified. For example, 1359been specified. For example,
1320.IP "\fB@@RXVT_NAME@@ \-fg Black \-bg White \-rv\fR" 4 1360.IP "\fB@@RXVT_NAME@@ \-fg Black \-bg White \-rv\fR" 4
1321.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv" 1361.IX Item "@@RXVT_NAME@@ -fg Black -bg White -rv"
1322would 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
1323on 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
1324.SH "ENVIRONMENT" 1387.SH "ENVIRONMENT"
1325.IX Header "ENVIRONMENT" 1388.IX Header "ENVIRONMENT"
1326\&\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:
1327.IP "\fB\s-1TERM\s0\fR" 4 1390.IP "\fB\s-1TERM\s0\fR" 4
1328.IX Item "TERM" 1391.IX Item "TERM"
1329Normally 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
1330resources or on the commandline. 1393resources or on the command line.
1331.IP "\fB\s-1COLORTERM\s0\fR" 4 1394.IP "\fB\s-1COLORTERM\s0\fR" 4
1332.IX Item "COLORTERM" 1395.IX Item "COLORTERM"
1333Either \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
1334compiled with \s-1XPM\s0 support, and optionally with the added extension 1397compiled with \s-1XPM\s0 support, and optionally with the added extension
1335\&\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.
1336.IP "\fB\s-1COLORFGBG\s0\fR" 4 1399.IP "\fB\s-1COLORFGBG\s0\fR" 4
1337.IX Item "COLORFGBG" 1400.IX Item "COLORFGBG"
1338Set 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
… …
1352Set to the terminfo directory iff @@RXVT_NAME@@ was configured with 1415Set to the terminfo directory iff @@RXVT_NAME@@ was configured with
1353\&\f(CW\*(C`\-\-with\-terminfo=PATH\*(C'\fR. 1416\&\f(CW\*(C`\-\-with\-terminfo=PATH\*(C'\fR.
1354.IP "\fB\s-1DISPLAY\s0\fR" 4 1417.IP "\fB\s-1DISPLAY\s0\fR" 4
1355.IX Item "DISPLAY" 1418.IX Item "DISPLAY"
1356Used 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
1357display in it's child processes. 1420display in its child processes.
1358.IP "\fB\s-1SHELL\s0\fR" 4 1421.IP "\fB\s-1SHELL\s0\fR" 4
1359.IX Item "SHELL" 1422.IX Item "SHELL"
1360The 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.
1361.IP "\fB\s-1RXVTPATH\s0\fR" 4
1362.IX Item "RXVTPATH"
1363The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1364files.
1365.IP "\fB\s-1PATH\s0\fR" 4
1366.IX Item "PATH"
1367Used in the same way as \f(CW\*(C`RXVTPATH\*(C'\fR.
1368.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4 1424.IP "\fB\s-1RXVT_SOCKET\s0\fR" 4
1369.IX Item "RXVT_SOCKET" 1425.IX Item "RXVT_SOCKET"
1370The unix domain socket path used by @@RXVT_NAME@@c(1) and 1426The unix domain socket path used by @@RXVT_NAME@@c(1) and
1371@@RXVT_NAME@@d(1). 1427@@RXVT_NAME@@d(1).
1372.Sp 1428.Sp
1373Default \fI$HOME/.rxvt\-unicode\-\fI<nodename\fI\fR. 1429Default \fI\f(CI$HOME\fI/.rxvt\-unicode\-\fI<nodename\fI\fR.
1374.IP "\fB\s-1HOME\s0\fR" 4 1430.IP "\fB\s-1HOME\s0\fR" 4
1375.IX Item "HOME" 1431.IX Item "HOME"
1376Used to locate the default directory for the unix domain socket for 1432Used to locate the default directory for the unix domain socket for
1377daemon communications and to locate various resource files (such as 1433daemon communications and to locate various resource files (such as
1378\&\f(CW\*(C`.Xdefaults\*(C'\fR) 1434\&\f(CW\*(C`.Xdefaults\*(C'\fR)
… …
1395.IX Header "CURRENT PROJECT COORDINATOR" 1451.IX Header "CURRENT PROJECT COORDINATOR"
1396.IP "Project Coordinator" 4 1452.IP "Project Coordinator" 4
1397.IX Item "Project Coordinator" 1453.IX Item "Project Coordinator"
1398Marc A. Lehmann <rxvt\-unicode@schmorp.de> 1454Marc A. Lehmann <rxvt\-unicode@schmorp.de>
1399.Sp 1455.Sp
1400<http://software.schmorp.de/#rxvt\-unicode> 1456<http://software.schmorp.de/pkg/rxvt\-unicode.html>
1401.SH "AUTHORS" 1457.SH "AUTHORS"
1402.IX Header "AUTHORS" 1458.IX Header "AUTHORS"
1403.IP "John Bovey" 4 1459.IP "John Bovey" 4
1404.IX Item "John Bovey" 1460.IX Item "John Bovey"
1405University of Kent, 1992, wrote the original Xvt. 1461University of Kent, 1992, wrote the original Xvt.
… …
1417.IP "Oezguer Kesim <kesim@math.fu\-berlin.de>" 4 1473.IP "Oezguer Kesim <kesim@math.fu\-berlin.de>" 4
1418.IX Item "Oezguer Kesim <kesim@math.fu-berlin.de>" 1474.IX Item "Oezguer Kesim <kesim@math.fu-berlin.de>"
1419Project Coordinator (changes.txt 2.21a to 2.4.5) 1475Project Coordinator (changes.txt 2.21a to 2.4.5)
1420.IP "Geoff Wing <gcw@pobox.com>" 4 1476.IP "Geoff Wing <gcw@pobox.com>" 4
1421.IX Item "Geoff Wing <gcw@pobox.com>" 1477.IX Item "Geoff Wing <gcw@pobox.com>"
1422Rewrote screen display and text selection routines. Project Coordinator 1478Rewrote screen display and text selection routines.
1479.Sp
1423(changes.txt 2.4.6 \- rxvt\-unicode) 1480Project Coordinator (changes.txt 2.4.6 \- rxvt\-unicode)
1424.IP "Marc Alexander Lehmann <rxvt\-unicode@schmorp.de>" 4 1481.IP "Marc Alexander Lehmann <rxvt\-unicode@schmorp.de>" 4
1425.IX Item "Marc Alexander Lehmann <rxvt-unicode@schmorp.de>" 1482.IX Item "Marc Alexander Lehmann <rxvt-unicode@schmorp.de>"
1426Forked rxvt\-unicode, rewrote most of the display code and internal 1483Forked rxvt\-unicode, unicode support, rewrote almost all the code, perl
1427character handling to store text in unicode, improve xterm 1484extension, random hacks, numerous bugfixes and extensions.
1428compatibility and apply numerous other bugfixes and extensions.
1429.Sp 1485.Sp
1430Project 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