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

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.74 by root, Thu Dec 22 16:44:10 2005 UTC vs.
Revision 1.169 by root, Wed Nov 5 00:14:18 2008 UTC

12emulator intended as an I<xterm>(1) replacement for users who do not 12emulator intended as an I<xterm>(1) replacement for users who do not
13require features such as Tektronix 4014 emulation and toolkit-style 13require features such as Tektronix 4014 emulation and toolkit-style
14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16 16
17This document is also available on the World-Wide-Web at
18L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
19
17=head1 FREQUENTLY ASKED QUESTIONS 20=head1 FREQUENTLY ASKED QUESTIONS
18 21
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 22See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 23frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 24problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23 26
24=head1 RXVT-UNICODE VS. RXVT 27=head1 RXVT-UNICODE VS. RXVT
25 28
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 29Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 30internally. That means it can store and display most scripts in the
28world. Being a terminal emulator, however, some things are very difficult, 31world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts 32especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules, 33like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. Don't expect pretty output when using these 34like tibetan or devanagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 35scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are left-to-right scripts, such 36fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 37as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 38belong in the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 39such as cursor-movement while editing -- break otherwise), but that might
37change. 40change.
38 41
39If you are looking for a terminal that supports more exotic scripts, let 42If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very userfriendly, lean and clean 43me recommend C<mlterm>, which is a very user friendly, lean and clean
41terminal emulator. In fact, the reason rxvt-unicode was born was solely 44terminal emulator. In fact, the reason rxvt-unicode was born was solely
42because the author couldn't get C<mlterm> to use one font for latin1 and 45because the author couldn't get C<mlterm> to use one font for latin1 and
43another for japanese. 46another for japanese.
44 47
45Therefore another design rationale was the use of multiple fonts to 48Therefore another design rationale was the use of multiple fonts to
46display characters: The idea of a single unicode font which many other 49display characters: The idea of a single unicode font which many other
47programs force onto it's users never made sense to me: You should be able 50programs force onto its users never made sense to me: You should be able
48to choose any font for any script freely. 51to choose any font for any script freely.
49 52
50Apart from that, rxvt-unicode is also much better internationalised than 53Apart from that, rxvt-unicode is also much better internationalised than
51it's predecessor, supports things such as XFT and ISO 14755 that are handy 54its predecessor, supports things such as XFT and ISO 14755 that are handy
52in i18n-environments, is faster, and has a lot less bugs than the original 55in i18n-environments, is faster, and has a lot bugs less than the original
53rxvt. This all in addition to dozens of other small improvements. 56rxvt. This all in addition to dozens of other small improvements.
54 57
55It is still faithfully following the original rxvt idea of being lean 58It is still faithfully following the original rxvt idea of being lean
56and nice on resources: for example, you can still configure rxvt-unicode 59and nice on resources: for example, you can still configure rxvt-unicode
57without most of it's features to get a lean binary. It also comes with 60without most of its features to get a lean binary. It also comes with
58a client/daemon pair that lets you open any number of terminal windows 61a client/daemon pair that lets you open any number of terminal windows
59from within a single process, which makes startup time very fast and 62from within a single process, which makes startup time very fast and
60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 63drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61@@RXVT_NAME@@c(1) (client). 64@@RXVT_NAME@@c(1) (client).
62 65
63It also makes technical information about escape sequences (which have 66It also makes technical information about escape sequences (which have
64been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 67been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65reference documentation (escape sequences etc.). 68reference documentation (escape sequences etc.).
66 69
67=head1 OPTIONS 70=head1 OPTIONS
68 71
69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed 72The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
89 92
90Print out a message describing available options. 93Print out a message describing available options.
91 94
92=item B<-display> I<displayname> 95=item B<-display> I<displayname>
93 96
94Attempt to open a window on the named X display (B<-d> still 97Attempt to open a window on the named X display (the older form B<-d>
95respected). In the absence of this option, the display specified by the 98is still respected. but deprecated). In the absence of this option, the
96B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
100
101=item B<-depth> I<bitdepth>
102
103Compile I<xft>: Attempt to find a visual with the given bit depth;
104resource B<depth>.
105
106[Please note that many X servers (and libXft) are buggy with
107respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out]
97 110
98=item B<-geometry> I<geom> 111=item B<-geometry> I<geom>
99 112
100Window geometry (B<-g> still respected); resource B<geometry>. 113Window geometry (B<-g> still respected); resource B<geometry>.
101 114
103 116
104Turn on/off simulated reverse video; resource B<reverseVideo>. 117Turn on/off simulated reverse video; resource B<reverseVideo>.
105 118
106=item B<-j>|B<+j> 119=item B<-j>|B<+j>
107 120
108Turn on/off jump scrolling; resource B<jumpScroll>. 121Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109 122
110=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 123=item B<-ss>|B<+ss>
111 124
112Turn on/off inheriting parent window's pixmap. Alternative form is 125Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
113B<-tr>; resource B<inheritPixmap>. 126
127=item B<-tr>|B<+tr>
128
129Turn on/off illusion of a transparent window background; resource B<transparent>.
130
131B<-ip> is still accepted as an obsolete alias but will be removed in
132future versions.
133
134I<Please address all transparency related issues to Sasha Vasko at
135sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
114 136
115=item B<-fade> I<number> 137=item B<-fade> I<number>
116 138
117Fade the text by the given percentage when focus is lost. Small values 139Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade 140fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>. 141colour; resource B<fading>.
120 142
121=item B<-fadecolor> I<colour> 143=item B<-fadecolor> I<colour>
122 144
123Fade to this colour when fading is used (see B<-fade>). The default colour 145Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>. 146is opaque black. resource B<fadeColor>.
125 147
126=item B<-tint> I<colour> 148=item B<-tint> I<colour>
127 149
128Tint the transparent background pixmap with the given colour when 150Tint the transparent background pixmap with the given colour when
129transparency is enabled with B<-tr> or B<-ip>. This only works for 151transparency is enabled with B<-tr>. This only works for
130non-tiled backgrounds, currently. See also the B<-sh> option that can be 152non-tiled backgrounds, currently. See also the B<-sh> option that can be
131used to brighten or darken the image in addition to tinting it; resource 153used to brighten or darken the image in addition to tinting it.
154Please note that certain tint colours can be applied on the server-side,
155thus yielding performance gain of two orders of magnitude. These colours are:
156blue, red, green, cyan, magenta, yellow, and those close to them. Also
157pure black and pure white colors essentially mean no tinting; resource
132I<tintColor>. Example: 158I<tintColor>. Example:
133 159
134 @@RXVT_NAME@@ -tr -tint blue -sh 40 160 @@RXVT_NAME@@ -tr -tint blue -sh 40
135 161
136=item B<-sh> 162=item B<-sh> I<number>
137 163
138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 164Darken (0 .. 100) or lighten (100 .. 200) the transparent
139background image in addition to tinting it (i.e. B<-tint> must be 165background image in addition to (or instead of) tinting it;
140specified, too, e.g. C<-tint white>). 166resource I<shading>.
167
168=item B<-blt> I<string>
169
170Specify background blending type. If background pixmap is specified
171at the same time as transparency - such pixmap will be blended over
172transparency image, using method specified. Supported values are :
173B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
174B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
175B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
176alpha-blending. Compile I<afterimage>; resource I<blendType>.
177
178=item B<-blr> I<HxV>
179
180Apply Gaussian Blur with the specified radii to the transparent
181background image. If single number is specified - both vertical and
182horizontal radii are considered to be the same. Setting one of the
183radii to 1 and another to a large number creates interesting effects
184on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
185resource I<blurRadius>.
186
187=item B<-icon> I<file>
188
189Compile I<afterimage>: Use the specified image as application icon. This
190is used by many window managers, taskbars and pagers to represent the
191application window; resource I<iconFile>.
141 192
142=item B<-bg> I<colour> 193=item B<-bg> I<colour>
143 194
144Window background colour; resource B<background>. 195Window background colour; resource B<background>.
145 196
146=item B<-fg> I<colour> 197=item B<-fg> I<colour>
147 198
148Window foreground colour; resource B<foreground>. 199Window foreground colour; resource B<foreground>.
149 200
150=item B<-pixmap> I<file[;geom]> 201=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
151 202
152Compile I<XPM>: Specify XPM file for the background and also optionally 203Compile I<afterimage>: Specify image file for the background and also
153specify its scaling with a geometry string. Note you may need to 204optionally specify its scaling with a geometry string. Note you may need to
154add quotes to avoid special shell interpretation of the C<;> in the 205add quotes to avoid special shell interpretation of the C<;> in the
155command-line; resource B<backgroundPixmap>. 206command-line; for more details see resource B<backgroundPixmap>.
156 207
157=item B<-cr> I<colour> 208=item B<-cr> I<colour>
158 209
159The cursor colour; resource B<cursorColor>. 210The cursor colour; resource B<cursorColor>.
160 211
172resource B<borderColor>. 223resource B<borderColor>.
173 224
174=item B<-fn> I<fontlist> 225=item B<-fn> I<fontlist>
175 226
176Select the fonts to be used. This is a comma separated list of font names 227Select the fonts to be used. This is a comma separated list of font names
177that are used in turn when trying to display Unicode characters. The 228that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 229first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 230smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 231font list is always appended to it. See resource B<font> for more details.
181 232
182In short, to specify an X11 core font, just specify it's name or prefix it 233In short, to specify an X11 core font, just specify its name or prefix it
183with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, 234with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.: 235e.g.:
185 236
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 237 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 238 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
189See also the question "How does rxvt-unicode choose fonts?" in the FAQ 240See also the question "How does rxvt-unicode choose fonts?" in the FAQ
190section of @@RXVT_NAME@@(7). 241section of @@RXVT_NAME@@(7).
191 242
192=item B<-fb> I<fontlist> 243=item B<-fb> I<fontlist>
193 244
194Compile font-styles: The bold font list to use when bold characters are to 245Compile I<font-styles>: The bold font list to use when B<bold> characters
195be printed. See resource B<boldFont> for details. 246are to be printed. See resource B<boldFont> for details.
196 247
197=item B<-fi> I<fontlist> 248=item B<-fi> I<fontlist>
198 249
199Compile font-styles: The italic font list to use when bold characters are to 250Compile I<font-styles>: The italic font list to use when I<italic>
200be printed. See resource B<italicFont> for details. 251characters are to be printed. See resource B<italicFont> for details.
201 252
202=item B<-fbi> I<fontlist> 253=item B<-fbi> I<fontlist>
203 254
204Compile font-styles: The bold italic font list to use when bold characters are to 255Compile I<font-styles>: The bold italic font list to use when B<< I<bold
205be printed. See resource B<boldItalicFont> for details. 256italic> >> characters are to be printed. See resource B<boldItalicFont>
257for details.
258
259=item B<-is>|B<+is>
260
261Compile I<font-styles>: Bold/Blink font styles imply high intensity
262foreground/background (default). See resource B<intensityStyles> for
263details.
206 264
207=item B<-name> I<name> 265=item B<-name> I<name>
208 266
209Specify the application name under which resources are to be obtained, 267Specify the application name under which resources are to be obtained,
210rather than the default executable file name. Name should not contain 268rather than the default executable file name. Name should not contain
226 284
227=item B<-sb>|B<+sb> 285=item B<-sb>|B<+sb>
228 286
229Turn on/off scrollbar; resource B<scrollBar>. 287Turn on/off scrollbar; resource B<scrollBar>.
230 288
289=item B<-sr>|B<+sr>
290
291Put scrollbar on right/left; resource B<scrollBar_right>.
292
293=item B<-st>|B<+st>
294
295Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
296resource B<scrollBar_floating>.
297
231=item B<-si>|B<+si> 298=item B<-si>|B<+si>
232 299
233Turn on/off scroll-to-bottom on TTY output inhibit; resource 300Turn on/off scroll-to-bottom on TTY output inhibit; resource
234B<scrollTtyOutput> has opposite effect. 301B<scrollTtyOutput> has opposite effect.
235 302
241=item B<-sw>|B<+sw> 308=item B<-sw>|B<+sw>
242 309
243Turn on/off scrolling with the scrollback buffer as new lines appear. 310Turn on/off scrolling with the scrollback buffer as new lines appear.
244This only takes effect if B<-si> is also given; resource 311This only takes effect if B<-si> is also given; resource
245B<scrollWithBuffer>. 312B<scrollWithBuffer>.
246
247=item B<-sr>|B<+sr>
248
249Put scrollbar on right/left; resource B<scrollBar_right>.
250
251=item B<-st>|B<+st>
252
253Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
254resource B<scrollBar_floating>.
255 313
256=item B<-ptab>|B<+ptab> 314=item B<-ptab>|B<+ptab>
257 315
258If enabled (default), "Horizontal Tab" characters are being stored as 316If enabled (default), "Horizontal Tab" characters are being stored as
259actual wide characters in the screen buffer, which makes it possible to 317actual wide characters in the screen buffer, which makes it possible to
288 346
289=item B<-bl> 347=item B<-bl>
290 348
291Compile I<frills>: Set MWM hints to request a borderless window, i.e. 349Compile I<frills>: Set MWM hints to request a borderless window, i.e.
292if honoured by the WM, the rxvt-unicode window will not have window 350if honoured by the WM, the rxvt-unicode window will not have window
293decorations; resource B<borderLess>. 351decorations; resource B<borderLess>. If the window manager does not
352support MWM hints (e.g. kwin), enables override-redirect mode.
353
354=item B<-override-redirect>
355
356Compile I<frills>: Sets override-redirect on the window; resource
357B<override-redirect>.
358
359=item B<-sbg>
360
361Compile I<frills>: Disable the usage of the built-in block graphics/line
362drawing characters and just rely on what the specified fonts provide. Use
363this if you have a good font and want to use its block graphic glyphs;
364resource B<skipBuiltinGlyphs>.
294 365
295=item B<-lsp> I<number> 366=item B<-lsp> I<number>
296 367
297Compile I<frills>: Lines (pixel height) to insert between each row of 368Compile I<frills>: Lines (pixel height) to insert between each row of
298the display. Useful to work around font rendering problems; resource 369the display. Useful to work around font rendering problems; resource
299B<linespace>. 370B<lineSpace>.
300 371
301=item B<-tn> I<termname> 372=item B<-tn> I<termname>
302 373
303This option specifies the name of the terminal type to be set in the 374This option specifies the name of the terminal type to be set in the
304B<TERM> environment variable. This terminal type must exist in the 375B<TERM> environment variable. This terminal type must exist in the
358for more info. 429for more info.
359 430
360=item B<-tcw> 431=item B<-tcw>
361 432
362Change the meaning of triple-click selection with the left mouse 433Change the meaning of triple-click selection with the left mouse
434button. Only effective when the original (non-perl) selection code is
363button. Instead of selecting a full line it will extend the selection the 435in-use. Instead of selecting a full line it will extend the selection to
364end of the logical line only. resource B<tripleclickwords>. 436the end of the logical line only. resource B<tripleclickwords>.
365 437
366=item B<-insecure> 438=item B<-insecure>
367 439
368Enable "insecure" mode, which currently enables most of the escape 440Enable "insecure" mode, which currently enables most of the escape
369sequences that echo strings. See the resource B<insecure> for more 441sequences that echo strings. See the resource B<insecure> for more
390Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 462Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
391will not immediately destroy its window when the program executed within 463will not immediately destroy its window when the program executed within
392it exits. Instead, it will wait till it is being killed or closed by the 464it exits. Instead, it will wait till it is being killed or closed by the
393user; resource B<hold>. 465user; resource B<hold>.
394 466
467=item B<-cd> I<path>
468
469Sets the working directory for the shell (or the command specified via
470B<-e>). The I<path> must be an absolute path and it must exist for
471@@RXVT_NAME@@ to start; resource B<chdir>.
472
473=item B<-xrm> I<string>
474
475Works like the X Toolkit option of the same name, by adding the I<string>
476as if it were specified in a resource file. Resource values specified this
477way take precedence over all other resource specifications.
478
479Note that you need to use the I<same> syntax as in the .Xdefaults file,
480e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
481options can be specified as long-options on the commandline, so use
482of B<-xrm> is mostly limited to cases where you want to specify other
483resources (e.g. for input methods) or for compatibility with other
484programs.
485
395=item B<-keysym.>I<sym> I<string> 486=item B<-keysym.>I<sym> I<string>
396 487
397Remap a key symbol. See resource B<keysym>. 488Remap a key symbol. See resource B<keysym>.
398 489
399=item B<-embed> I<windowid> 490=item B<-embed> I<windowid>
400 491
401Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 492Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
402which enables applications to easily embed a terminal. 493which enables applications to easily embed a terminal.
403 494
404Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 495Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
405shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 496shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
406quite a bit, so don't expect it to keep some specific state. It's best to 497quite a bit, so don't expect it to keep some specific state. It's best to
409The window will not be destroyed when @@RXVT_NAME@@ exits. 500The window will not be destroyed when @@RXVT_NAME@@ exits.
410 501
411It might be useful to know that @@RXVT_NAME@@ will not close file 502It might be useful to know that @@RXVT_NAME@@ will not close file
412descriptors passed to it (except for stdin/out/err, of course), so you 503descriptors passed to it (except for stdin/out/err, of course), so you
413can use file descriptors to communicate with the programs within the 504can use file descriptors to communicate with the programs within the
414terminal. This works regardless of wether the C<-embed> option was used or 505terminal. This works regardless of whether the C<-embed> option was used or
415not. 506not.
416 507
417Here is a short Gtk2-perl snippet that illustrates how this option can be 508Here is a short Gtk2-perl snippet that illustrates how this option can be
418used (a longer example is in F<doc/embed>): 509used (a longer example is in F<doc/embed>):
419 510
421 $rxvt->signal_connect_after (realize => sub { 512 $rxvt->signal_connect_after (realize => sub {
422 my $xid = $_[0]->window->get_xid; 513 my $xid = $_[0]->window->get_xid;
423 system "@@RXVT_NAME@@ -embed $xid &"; 514 system "@@RXVT_NAME@@ -embed $xid &";
424 }); 515 });
425 516
426=item B<-pty-fd> I<fileno> 517=item B<-pty-fd> I<file descriptor>
427 518
428Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 519Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
429pair but instead use the given filehandle as the tty master. This is 520pair but instead use the given file descriptor as the tty master. This is
430useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 521useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
431without having to run a program within it. 522without having to run a program within it.
432 523
433If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 524If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
434entries and will not tinker with pty/tty permissions - you have to do that 525entries and will not tinker with pty/tty permissions - you have to do that
435yourself if you want that. 526yourself if you want that.
527
528As an extremely special case, specifying C<-1> will completely suppress
529pty/tty operations, which is probably only useful in conjunction with some
530perl extension that manages the terminal.
436 531
437Here is a example in perl that illustrates how this option can be used (a 532Here is a example in perl that illustrates how this option can be used (a
438longer example is in F<doc/pty-fd>): 533longer example is in F<doc/pty-fd>):
439 534
440 use IO::Pty; 535 use IO::Pty;
447 542
448 # now communicate with rxvt 543 # now communicate with rxvt
449 my $slave = $pty->slave; 544 my $slave = $pty->slave;
450 while (<$slave>) { print $slave "got <$_>\n" } 545 while (<$slave>) { print $slave "got <$_>\n" }
451 546
547=item B<-pe> I<string>
548
549Comma-separated list of perl extension scripts to use (or not to use) in
550this terminal instance. See resource B<perl-ext> for details.
551
452=back 552=back
453 553
454=head1 RESOURCES (available also as long-options) 554=head1 RESOURCES
455 555
456Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 556Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
457options) compiled into your version. 557options) compiled into your version. All resources are also available as
558long-options.
458 559
459There are two different methods that @@RXVT_NAME@@ can use to get the 560You can set and change the resources using X11 tools like B<xrdb>. Many
460Xresource data: using the X libraries (Xrm*-functions) or internal 561distribution do also load settings from the B<~/.Xresources> file when X
461Xresources reader (B<~/.Xdefaults>). For the first method (ie. 562starts. @@RXVT_NAME@@ will consult the following files/resources in order,
462B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 563with later settings overwriting earlier ones:
463resources using X11 tools like B<xrdb>. Many distribution do also load
464settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
465will consult the following files/resources in order, with later settings
466overwriting earlier ones:
467 564
468 1. system-wide app-defaults file, either locale-dependent OR global 565 1. system-wide app-defaults file, either locale-dependent OR global
469 2. app-defaults file in $XAPPLRESDIR 566 2. app-defaults file in $XAPPLRESDIR
470 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 567 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
471 4. SCREEN_RESOURCES for the current screen 568 4. SCREEN_RESOURCES for the current screen
472 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 569 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
570 6. resources specified via -xrm on the commandline
473 571
474If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
475lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
476set in XAPPLOADDIR/URxvt (compile-time defined: usually
477B</usr/lib/X11/app-defaults/URxvt>) and resources set in
478B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
479Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 572Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
480class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 573names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
481resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 574common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
482easily configured, while the class name B<URxvt> allows resources 575configured, while the class name B<URxvt> allows resources unique to
483unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 576B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
484shared between different B<@@RXVT_NAME@@> configurations. If no 577configurations. If no resources are specified, suitable defaults will
485resources are specified, suitable defaults will be used. Command-line 578be used. Command-line arguments can be used to override resource
486arguments can be used to override resource settings. The following 579settings. The following resources are supported (you might want to
487resources are allowed: 580check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
581extensions not documented here):
488 582
489=over 4 583=over 4
584
585=item B<depth:> I<bitdepth>
586
587Compile I<xft>: Attempt to find a visual with the given bit depth;
588option B<-depth>.
589
590=item B<buffered:> I<boolean>
591
592Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
593On some card/driver combination enabling it slightly decreases
594performance, on most it greatly helps it. The slowdown is small, so it
595should normally be enabled.
490 596
491=item B<geometry:> I<geom> 597=item B<geometry:> I<geom>
492 598
493Create the window with the specified X window geometry [default 80x24]; 599Create the window with the specified X window geometry [default 80x24];
494option B<-geometry>. 600option B<-geometry>.
531Use the specified colour to display underlined characters when the 637Use the specified colour to display underlined characters when the
532foreground colour is the default. 638foreground colour is the default.
533 639
534=item B<colorRV:> I<colour> 640=item B<colorRV:> I<colour>
535 641
536Use the specified colour as the background for reverse video 642Use the specified colour as the background for reverse video characters
537characters. 643when OPTION_HC is disabled (--disable-frills).
538 644
539=item B<underlineColor:> I<colour> 645=item B<underlineColor:> I<colour>
540 646
541If set, use the specified colour as the colour for the underline 647If set, use the specified colour as the colour for the underline
542itself. If unset, use the foreground colour. 648itself. If unset, use the foreground colour.
558option B<-rv>. B<False>: regular screen colours [default]; option 664option B<-rv>. B<False>: regular screen colours [default]; option
559B<+rv>. See note in B<COLORS AND GRAPHICS> section. 665B<+rv>. See note in B<COLORS AND GRAPHICS> section.
560 666
561=item B<jumpScroll:> I<boolean> 667=item B<jumpScroll:> I<boolean>
562 668
563B<True>: specify that jump scrolling should be used. When scrolling 669B<True>: specify that jump scrolling should be used. When receiving lots
564quickly, fewer screen updates are performed [default]; option B<-j>. 670of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
671has been read, resulting in fewer updates while still displaying every
672received line; option B<-j>.
673
565B<False>: specify that smooth scrolling should be used; option B<+j>. 674B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
675force a screen refresh on each new line it received; option B<+j>.
566 676
567=item B<inheritPixmap:> I<boolean> 677=item B<skipScroll:> I<boolean>
568 678
569B<True>: make the background inherit the parent windows' pixmap, giving 679B<True>: (the default) specify that skip scrolling should be used. When
570artificial transparency. B<False>: do not inherit the parent windows' 680receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
571pixmap. 681(around 60 times per second), resulting in far fewer updates. This can
682result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
683option B<-ss>.
684
685B<False>: specify that everything is to be displayed, even
686if the refresh is too fast for the human eye to read anything (or the
687monitor to display anything); option B<+ss>.
688
689=item B<transparent:> I<boolean>
690
691Turn on/off illusion of a transparent window background.
692
693B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
694future versions.
695
696I<Please address all transparency related issues to Sasha Vasko at
697sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
572 698
573=item B<fading:> I<number> 699=item B<fading:> I<number>
574 700
575Fade the text by the given percentage when focus is lost; option B<-fade>. 701Fade the text by the given percentage when focus is lost; option B<-fade>.
576 702
584Tint the transparent background pixmap with the given colour; option 710Tint the transparent background pixmap with the given colour; option
585B<-tint>. 711B<-tint>.
586 712
587=item B<shading:> I<number> 713=item B<shading:> I<number>
588 714
589Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 715Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
590image in addition to tinting it. 716in addition to tinting it; option B<-sh>.
717
718=item B<blendType:> I<string>
719
720Specify background blending type; option B<-blt>.
721
722=item B<blurRadius:> I<number>
723
724Apply gaussian blur with the specified radius to the transparent
725background image; option B<-blr>.
726
727=item B<iconFile:> I<file>
728
729Set the application icon pixmap; option B<-icon>.
591 730
592=item B<scrollColor:> I<colour> 731=item B<scrollColor:> I<colour>
593 732
594Use the specified colour for the scrollbar [default #B2B2B2]. 733Use the specified colour for the scrollbar [default #B2B2B2].
595 734
601=item B<borderColor:> I<colour> 740=item B<borderColor:> I<colour>
602 741
603The colour of the border around the text area and between the scrollbar 742The colour of the border around the text area and between the scrollbar
604and the text. 743and the text.
605 744
606=item B<backgroundPixmap:> I<file[;geom]> 745=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
607 746
608Use the specified XPM file (note the `.xpm' extension is optional) for 747Use the specified image file for the background and also
609the background and also optionally specify its scaling with a geometry 748optionally specify its scaling with a geometry string B<WxH+X+Y>,
610string B<WxH+X+Y>, in which B<"W" / "H"> specify the 749(default C<0x0+50+50>) in which B<"W" / "H"> specify the
611horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 750horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
612centre (percent). A scale of 0 displays the image with tiling. A scale 751centre (percent). A scale of 0 displays the image with tiling. A scale
613of 1 displays the image without any scaling. A scale of 2 to 9 752of 1 displays the image without any scaling. A scale of 2 to 9 specifies
614specifies an integer number of images in that direction. No image will 753an integer number of images in that direction. No image will be magnified
615be magnified beyond 10 times its original size. The maximum permitted 754beyond 10 times its original size. The maximum permitted scale is 1000.
616scale is 1000. [default 0x0+50+50] 755Additional operations can be specified after colon B<:op1:op2...>.
756Supported operations are:
617 757
618=item B<menu:> I<file[;tag]> 758 tile force background image to be tiled and not scaled. Equivalent to 0x0
759 propscale will scale image keeping proportions
760 auto will scale image to match window size. Equivalent to 100x100
761 hscale will scale image horizontally to the window size
762 vscale will scale image vertically to the window size
763 scale will scale image to match window size
764 root will tile image as if it was a root window background, auto-adjusting
765 whenever terminal window moves
619 766
620Read in the specified menu file (note the `.menu' extension is 767If used in conjunction with B<-tr> option, the specified pixmap will be
621optional) and also optionally specify a starting tag to find. See the 768blended over transparency image using either alpha-blending, or any
622reference documentation for details on the syntax for the menuBar. 769other blending type, specified with B<-blt "type"> option.
623 770
624=item B<path:> I<path> 771=item B<path:> I<path>
625 772
626Specify the colon-delimited search path for finding files (XPM and 773Specify the colon-delimited search path for finding background image files.
627menus), in addition to the paths specified by the B<RXVTPATH> and
628B<PATH> environment variables.
629 774
630=item B<font:> I<fontlist> 775=item B<font:> I<fontlist>
631 776
632Select the fonts to be used. This is a comma separated list of font 777Select the fonts to be used. This is a comma separated list of font names
633names that are used in turn when trying to display Unicode characters. 778that are checked in order when trying to find glyphs for characters. The
634The first font defines the cell size for characters; other fonts might 779first font defines the cell size for characters; other fonts might be
635be smaller, but not larger. A reasonable default font list is always 780smaller, but not (in general) larger. A (hopefully) reasonable default
636appended to it. option B<-fn>. 781font list is always appended to it; option B<-fn>.
637 782
638Each font can either be a standard X11 core font (XLFD) name, with 783Each font can either be a standard X11 core font (XLFD) name, with
639optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 784optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
640 785
641In addition, each font can be prefixed with additional hints and 786In addition, each font can be prefixed with additional hints and
643hint currently is C<codeset=codeset-name>, and this is only used for Xft 788hint currently is C<codeset=codeset-name>, and this is only used for Xft
644fonts. 789fonts.
645 790
646For example, this font resource 791For example, this font resource
647 792
648 URxvt*font: 9x15bold,\ 793 URxvt.font: 9x15bold,\
649 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 794 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
650 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 795 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
651 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 796 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
652 xft:Code2000:antialias=false 797 xft:Code2000:antialias=false
653 798
687not possible, replacement fonts of the desired shape will be tried. 832not possible, replacement fonts of the desired shape will be tried.
688 833
689If set, but empty, then this specific style is disabled and the normal 834If set, but empty, then this specific style is disabled and the normal
690text font will being used for the given style. 835text font will being used for the given style.
691 836
692=item B<selectstyle:> I<mode> 837=item B<intensityStyles:> I<boolean>
693 838
694Set mouse selection style to B<old> which is 2.20, B<oldword> which is 839When font styles are not enabled, or this option is enabled (B<True>,
695xterm style with 2.20 old word selection, or anything else which gives 840option B<-is>, the default), bold/blink font styles imply high
696xterm style selection. 841intensity foreground/background colours. Disabling this option (B<False>,
697 842option B<+is>) disables this behaviour, the high intensity colours are not
698=item B<scrollstyle:> I<mode> 843reachable.
699
700Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
701the author's favourite.
702 844
703=item B<title:> I<string> 845=item B<title:> I<string>
704 846
705Set window title string, the default title is the command-line 847Set window title string, the default title is the command-line
706specified after the B<-e> option, if any, otherwise the application 848specified after the B<-e> option, if any, otherwise the application
715=item B<mapAlert:> I<boolean> 857=item B<mapAlert:> I<boolean>
716 858
717B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 859B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
718de-iconify (map) on receipt of a bell character [default]. 860de-iconify (map) on receipt of a bell character [default].
719 861
862=item B<urgentOnBell:> I<boolean>
863
864B<True>: set the urgency hint for the wm on receipt of a bell character.
865B<False>: do not set the urgency hint [default].
866
867@@RXVT_NAME@@ resets the urgency hint on every focus change.
868
720=item B<visualBell:> I<boolean> 869=item B<visualBell:> I<boolean>
721 870
722B<True>: use visual bell on receipt of a bell character; option B<-vb>. 871B<True>: use visual bell on receipt of a bell character; option B<-vb>.
723B<False>: no visual bell [default]; option B<+vb>. 872B<False>: no visual bell [default]; option B<+vb>.
724 873
742 891
743The string will be interpreted as if typed into the shell as-is. 892The string will be interpreted as if typed into the shell as-is.
744 893
745Example: 894Example:
746 895
747 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 896 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
748 897
749This creates a new file in your home directory with the screen contents 898This creates a new file in your home directory with the screen contents
750everytime you hit C<Print>. 899every time you hit C<Print>.
900
901=item B<scrollstyle:> I<mode>
902
903Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
904the author's favourite.
751 905
752=item B<scrollBar:> I<boolean> 906=item B<scrollBar:> I<boolean>
753 907
754B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 908B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
755disable the scrollbar; option B<+sb>. 909disable the scrollbar; option B<+sb>.
777 931
778=item B<scrollWithBuffer:> I<boolean> 932=item B<scrollWithBuffer:> I<boolean>
779 933
780B<True>: scroll with scrollback buffer when tty receives new lines (and 934B<True>: scroll with scrollback buffer when tty receives new lines (and
781B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 935B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
782with scrollback buffer when tty recieves new lines; option B<+sw>. 936with scrollback buffer when tty receives new lines; option B<+sw>.
783 937
784=item B<scrollTtyKeypress:> I<boolean> 938=item B<scrollTtyKeypress:> I<boolean>
785 939
786B<True>: scroll to bottom when a non-special key is pressed. Special keys 940B<True>: scroll to bottom when a non-special key is pressed. Special keys
787are those which are intercepted by rxvt-unicode for special handling and 941are those which are intercepted by rxvt-unicode for special handling and
806=item B<borderLess:> I<boolean> 960=item B<borderLess:> I<boolean>
807 961
808Set MWM hints to request a borderless window, i.e. if honoured by the 962Set MWM hints to request a borderless window, i.e. if honoured by the
809WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 963WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
810 964
965=item B<skipBuiltinGlyphs:> I<boolean>
966
967Compile I<frills>: Disable the usage of the built-in block graphics/line
968drawing characters and just rely on what the specified fonts provide. Use
969this if you have a good font and want to use its block graphic glyphs;
970option B<-sbg>.
971
811=item B<termName:> I<termname> 972=item B<termName:> I<termname>
812 973
813Specifies the terminal type name to be set in the B<TERM> environment 974Specifies the terminal type name to be set in the B<TERM> environment
814variable; option B<-tn>. 975variable; option B<-tn>.
815 976
816=item B<linespace:> I<number> 977=item B<lineSpace:> I<number>
817 978
818Specifies number of lines (pixel height) to insert between each row of 979Specifies number of lines (pixel height) to insert between each row of
819the display [default 0]; option B<-lsp>. 980the display [default 0]; option B<-lsp>.
820 981
821=item B<meta8:> I<boolean> 982=item B<meta8:> I<boolean>
870pressed. If unset it will send the sequence traditionally associated 1031pressed. If unset it will send the sequence traditionally associated
871with the B<Execute> key. 1032with the B<Execute> key.
872 1033
873=item B<cutchars:> I<string> 1034=item B<cutchars:> I<string>
874 1035
875The characters used as delimiters for double-click word selection. The 1036The characters used as delimiters for double-click word selection
876built-in default: 1037(whitespace delimiting is added automatically if resource is given).
877 1038
1039When the perl selection extension is in use (the default if compiled
1040in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
1041characters will be created (if the resource exists, otherwise, no regex
1042will be created). In this mode, characters outside ISO-8859-1 can be used.
1043
1044When the selection extension is not used, only ISO-8859-1 characters can
1045be used. If not specified, the built-in default is used:
1046
878B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1047B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
879 1048
880=item B<preeditType:> I<style> 1049=item B<preeditType:> I<style>
881 1050
882B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1051B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
883 1052
888=item B<imLocale:> I<name> 1057=item B<imLocale:> I<name>
889 1058
890The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 1059The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
891C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the 1060C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
892input extension to be able to input japanese characters while staying in 1061input extension to be able to input japanese characters while staying in
893another locale. option B<-imlocale>. 1062another locale; option B<-imlocale>.
894 1063
895=item B<imFont:> I<fontset> 1064=item B<imFont:> I<fontset>
896 1065
897Specify the font-set used for XIM styles C<OverTheSpot> or 1066Specify the font-set used for XIM styles C<OverTheSpot> or
898C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 1067C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
903 1072
904=item B<tripleclickwords:> I<boolean> 1073=item B<tripleclickwords:> I<boolean>
905 1074
906Change the meaning of triple-click selection with the left mouse 1075Change the meaning of triple-click selection with the left mouse
907button. Instead of selecting a full line it will extend the selection to 1076button. Instead of selecting a full line it will extend the selection to
908the end of the logical line only. option B<-tcw>. 1077the end of the logical line only; option B<-tcw>.
909 1078
910=item B<insecure:> I<boolean> 1079=item B<insecure:> I<boolean>
911 1080
912Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1081Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
913echo arbitrary strings like the icon name or the locale. This could be 1082echo arbitrary strings like the icon name or the locale. This could be
917default. (Note that many other terminals, including xterm, have these 1086default. (Note that many other terminals, including xterm, have these
918sequences enabled by default, which doesn't make it safer, though). 1087sequences enabled by default, which doesn't make it safer, though).
919 1088
920You can enable them by setting this boolean resource or specifying 1089You can enable them by setting this boolean resource or specifying
921B<-insecure> as an option. At the moment, this enables display-answer, 1090B<-insecure> as an option. At the moment, this enables display-answer,
922locale, findfont, icon label and window title requests as well as dynamic 1091locale, findfont, icon label and window title requests.
923menubar dispatch.
924 1092
925=item B<modifier:> I<modifier> 1093=item B<modifier:> I<modifier>
926 1094
927Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 1095Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
928B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 1096B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
932 1100
933Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1101Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
934character is passed through. It may contain escape values as described 1102character is passed through. It may contain escape values as described
935in the entry on B<keysym> following. 1103in the entry on B<keysym> following.
936 1104
937=item B<secondaryScreen:> I<bool> 1105=item B<secondaryScreen:> I<boolean>
938 1106
939Turn on/off secondary screen (default enabled). 1107Turn on/off secondary screen (default enabled).
940 1108
941=item B<secondaryScroll:> I<bool> 1109=item B<secondaryScroll:> I<boolean>
942 1110
943Turn on/off secondary screen scroll (default enabled). If the this 1111Turn on/off secondary screen scroll (default enabled). If this
944option is enabled, scrolls on the secondary screen will change the 1112option is enabled, scrolls on the secondary screen will change the
945scrollback buffer and switching to/from the secondary screen will 1113scrollback buffer and, when secondaryScreen is off, switching
946instead scroll the screen up. 1114to/from the secondary screen will instead scroll the screen up.
947 1115
948=item B<hold>: I<bool> 1116=item B<hold>: I<boolean>
949 1117
950Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1118Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
951will not immediately destroy its window when the program executed within 1119will not immediately destroy its window when the program executed within
952it exits. Instead, it will wait till it is being killed or closed by the 1120it exits. Instead, it will wait till it is being killed or closed by the
953user. 1121user.
1122
1123=item B<chdir>: I<path>
1124
1125Sets the working directory for the shell (or the command specified via
1126B<-e>). The I<path> must be an absolute path and it must exist for
1127@@RXVT_NAME@@ to start. If it isn't specified then the current working
1128directory will be used; option B<-cd>.
954 1129
955=item B<keysym.>I<sym>: I<string> 1130=item B<keysym.>I<sym>: I<string>
956 1131
957Compile I<frills>: Associate I<string> with keysym I<sym>. The 1132Compile I<frills>: Associate I<string> with keysym I<sym>. The
958intervening resource name B<keysym.> cannot be omitted. 1133intervening resource name B<keysym.> cannot be omitted.
972searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1147searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
973omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1148omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
974keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1149keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
975performed in an exact manner; however, the closest match is assured. 1150performed in an exact manner; however, the closest match is assured.
976 1151
977I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1152I<string> may contain escape values (C<\n>: newline, C<\000>: octal
978C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1153number), see RESOURCES in C<man 7 X> for futher details.
979C<\000>: octal number) or verbatim control characters (C<^?>: delete,
980C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
981can start or end with whitespace.
982
983Please note that you need to double the C<\> when using
984C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
985use C<\033> instead of C<\e> (and so on), which will work with both Xt and
986@@RXVT_NAME@@'s own processing).
987 1154
988You can define a range of keysyms in one shot by providing a I<string> 1155You can define a range of keysyms in one shot by providing a I<string>
989with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1156with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
990should be a character not used by the strings. 1157should be a character not used by the strings.
991 1158
992Its usage can be demonstrated by an example: 1159Its usage can be demonstrated by an example:
993 1160
994 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1161 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1003is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1170is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1004example the following means "change the current locale to C<zh_CN.GBK> 1171example the following means "change the current locale to C<zh_CN.GBK>
1005when Control-Meta-c is being pressed": 1172when Control-Meta-c is being pressed":
1006 1173
1007 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1174 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1175
1176If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1177is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1178manpage. For example, the F<selection> extension (activated via
1179C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1180
1181 URxvt.keysym.M-C-c: perl:selection:rot13
1008 1182
1009Due the the large number of modifier combinations, a defined key mapping 1183Due the the large number of modifier combinations, a defined key mapping
1010will match if at I<at least> the specified identifiers are being set, and 1184will match if at I<at least> the specified identifiers are being set, and
1011no other key mappings with those and more bits are being defined. That 1185no other key mappings with those and more bits are being defined. That
1012means that defining a key map for C<a> will automatically provide 1186means that defining a key map for C<a> will automatically provide
1036info): 1210info):
1037 1211
1038 URxvt.keysym.M-C-3: command:\033[8;25;80t 1212 URxvt.keysym.M-C-3: command:\033[8;25;80t
1039 URxvt.keysym.M-C-4: command:\033[8;48;110t 1213 URxvt.keysym.M-C-4: command:\033[8;48;110t
1040 1214
1215=item B<perl-ext-common>: I<string>
1216
1217=item B<perl-ext>: I<string>
1218
1219Comma-separated list(s) of perl extension scripts (default: C<default>) to
1220use in this terminal instance; option B<-pe>.
1221
1222Extension names can be prefixed with a C<-> sign to prohibit using
1223them. This can be useful to selectively disable some extensions loaded
1224by default, or specified via the C<perl-ext-common> resource. For
1225example, C<default,-selection> will use all the default extension except
1226C<selection>.
1227
1228Extension names can also be followed by an argument in angle brackets
1229(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1230searchable scrollback to Alt/Meta-s). Mentioning the same extension
1231multiple times with different arguments will pass multiple arguments to
1232the extension.
1233
1234Each extension is looked up in the library directories, loaded if
1235necessary, and bound to the current terminal instance.
1236
1237If both of these resources are the empty string, then the perl
1238interpreter will not be initialized. The idea behind two options is that
1239B<perl-ext-common> will be used for extensions that should be available to
1240all instances, while B<perl-ext> is used for specific instances.
1241
1242=item B<perl-eval>: I<string>
1243
1244Perl code to be evaluated when all extensions have been registered. See
1245the @@RXVT_NAME@@perl(3) manpage.
1246
1247=item B<perl-lib>: I<path>
1248
1249Colon-separated list of additional directories that hold extension
1250scripts. When looking for extensions specified by the C<perl> resource,
1251@@RXVT_NAME@@ will first look in these directories and then in
1252F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1253
1254See the @@RXVT_NAME@@perl(3) manpage.
1255
1256=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1257
1258Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1259details.
1260
1261=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1262
1263Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1264for details.
1265
1266=item B<searchable-scrollback:> I<keysym>
1267
1268Sets the hotkey that starts the incremental scrollback buffer search
1269(default: C<M-s>).
1270
1271=item B<urlLauncher>: I<string>
1272
1273Specifies the program to be started with a URL argument. Used by the
1274C<selection-popup> and C<matcher> perl extensions.
1275
1276=item B<transient-for>: I<windowid>
1277
1278Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1279
1280=item B<override-redirect>: I<boolean>
1281
1282Compile I<frills>: Sets override-redirect for the terminal window, making
1283it almost invisible to window managers; option B<-override-redirect>.
1284
1285=item B<iso14755_52:> I<boolean>
1286
1287Turn on/off ISO 14755 5.2 mode (default enabled).
1288
1041=back 1289=back
1042 1290
1043=head1 THE SCROLLBAR 1291=head1 THE SCROLLBAR
1044 1292
1045Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1293Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
1063application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1311application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1064(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1312(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1065up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1313up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1066respectively. 1314respectively.
1067 1315
1068=head1 TEXT SELECTION AND INSERTION 1316=head1 THE SELECTION: SELECTING AND PASTING TEXT
1069 1317
1070The behaviour of text selection and insertion mechanism is similar to 1318The behaviour of text selection and insertion/pasting mechanism is similar
1071I<xterm>(1). 1319to I<xterm>(1).
1072 1320
1073=over 4 1321=over 4
1074 1322
1075=item B<Selection>: 1323=item B<Selecting>:
1076 1324
1077Left click at the beginning of the region, drag to the end of the region 1325Left click at the beginning of the region, drag to the end of the region
1078and release; Right click to extend the marked region; Left double-click 1326and release; Right click to extend the marked region; Left double-click
1079to select a word; Left triple-click to select the entire logical line 1327to select a word; Left triple-click to select the entire logical line
1080(which can span multiple screen lines), unless modified by resource 1328(which can span multiple screen lines), unless modified by resource
1081B<tripleclickwords>. 1329B<tripleclickwords>.
1082 1330
1083Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1331Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1084(Compile: I<frills>) will create a rectangular selection instead of a normal 1332(Compile: I<frills>) will create a rectangular selection instead of a
1085one. 1333normal one. In this mode, every selected row becomes its own line in the
1334selection, and trailing whitespace is visually underlined and removed from
1335the selection.
1086 1336
1087=item B<Insertion>: 1337=item B<Pasting>:
1088 1338
1089Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1339Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1090an B<@@RXVT_NAME@@> window causes the current text selection to be 1340window causes the value of the PRIMARY selection (or CLIPBOARD with the
1091inserted as if it had been typed on the keyboard. 1341B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1342
1343Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1344inserted too.
1092 1345
1093=back 1346=back
1094 1347
1095=head1 CHANGING FONTS 1348=head1 CHANGING FONTS
1096 1349
1097Changing fonts (or font sizes, respectively) via the keypad is not yet 1350Changing fonts (or font sizes, respectively) via the keypad is not yet
1098supported in rxvt-unicode. Bug me if you need this. 1351supported in rxvt-unicode. Bug me if you need this.
1099 1352
1100You can, however, switch fonts at runtime using escape sequences (and 1353You can, however, switch fonts at runtime using escape sequences, e.g.:
1101therefore using the menubar), e.g.:
1102 1354
1103 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1355 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1356
1357You can use keyboard shortcuts, too:
1358
1359 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1360 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1104 1361
1105rxvt-unicode will automatically re-apply these fonts to the output so far. 1362rxvt-unicode will automatically re-apply these fonts to the output so far.
1106 1363
1107=head1 ISO 14755 SUPPORT 1364=head1 ISO 14755 SUPPORT
1108 1365
1109ISO 14755 is a standard for entering and viewing unicode characters 1366ISO 14755 is a standard for entering and viewing unicode characters
1110and character codes using the keyboard. It consists of 4 parts. The 1367and character codes using the keyboard. It consists of 4 parts. The
1111first part is available rxvt-unicode has been compiled with 1368first part is available if rxvt-unicode has been compiled with
1112C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1369C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1113with C<--enable-iso14755>. 1370with C<--enable-iso14755>.
1114 1371
1115=over 4 1372=over 4
1116 1373
1136This mode lets you input characters representing the keycap symbols of 1393This mode lets you input characters representing the keycap symbols of
1137your keyboard, if representable in the current locale encoding. 1394your keyboard, if representable in the current locale encoding.
1138 1395
1139Start by pressing C<Control> and C<Shift> together, then releasing 1396Start by pressing C<Control> and C<Shift> together, then releasing
1140them. The next special key (cursor keys, home etc.) you enter will not 1397them. The next special key (cursor keys, home etc.) you enter will not
1141invoke it's usual function but instead will insert the corresponding 1398invoke its usual function but instead will insert the corresponding
1142keycap symbol. The symbol will only be entered when the key has been 1399keycap symbol. The symbol will only be entered when the key has been
1143released, otherwise pressing e.g. C<Shift> would enter the symbol for 1400released, otherwise pressing e.g. C<Shift> would enter the symbol for
1144C<ISO Level 2 Switch>, although your intention might have been to enter a 1401C<ISO Level 2 Switch>, although your intention might have been to enter a
1145reverse tab (Shift-Tab). 1402reverse tab (Shift-Tab).
1146 1403
1179=head1 COLORS AND GRAPHICS 1436=head1 COLORS AND GRAPHICS
1180 1437
1181In addition to the default foreground and background colours, 1438In addition to the default foreground and background colours,
1182B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1439B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1183high-intensity bold/blink versions of the same). Here is a list of the 1440high-intensity bold/blink versions of the same). Here is a list of the
1184colours with their B<rgb.txt> names. 1441colours with their names.
1185 1442
1186=begin table 1443=begin table
1187 1444
1188 B<color0> (black) = Black 1445 B<color0> (black) = Black
1189 B<color1> (red) = Red3 1446 B<color1> (red) = Red3
1209It is also possible to specify the colour values of B<foreground>, 1466It is also possible to specify the colour values of B<foreground>,
1210B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1467B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1211a number 0-15, as a convenient shorthand to reference the colour name of 1468a number 0-15, as a convenient shorthand to reference the colour name of
1212color0-color15. 1469color0-color15.
1213 1470
1471In addition to the colours defined above, @@RXVT_NAME@@ offers an
1472additional 72 colours. The first 64 of those (with indices 16 to 79)
1473consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
147416>), followed by 8 additional shades of gray (with indices 80 to 87).
1475
1476Together, all those colours implement the 88 colour xterm colours. Only
1477the first 16 can be changed using resources currently, the rest can only
1478be changed via command sequences ("escape codes").
1479
1214Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1480Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1215always swapping the foreground/background colours. This is in contrast to 1481always swapping the foreground/background colours. This is in contrast to
1216I<xterm>(1) where the colours are only swapped if they have not otherwise 1482I<xterm>(1) where the colours are only swapped if they have not otherwise
1217been specified. For example, 1483been specified. For example,
1218 1484
1223would yield White on Black, while on I<xterm>(1) it would yield Black 1489would yield White on Black, while on I<xterm>(1) it would yield Black
1224on White. 1490on White.
1225 1491
1226=back 1492=back
1227 1493
1494=head2 ALPHA CHANNEL SUPPORT
1495
1496If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1497their act together, rxvt-unicode will do it's own alpha channel management:
1498
1499You can prefix any color with an opaquenes percentage enclosed in
1500brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1501(0-100) that specifies the opacity of the color, where C<0> is completely
1502transparent and C<100> is completely opaque. For example, C<[50]red> is a
1503half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1504is the recommended format to specify transparency values, and works with
1505all ways to specify a colour.
1506
1507For complete control, rxvt-unicode also supports
1508C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1509specifications, where the additional C<aaaa> component specifies opacity
1510(alpha) values. The minimum value of C<0000> is completely transparent,
1511while C<ffff> is completely opaque). The two example colours from
1512earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1513C<rgba:0000/ff00/0000/f332>.
1514
1515You probably need to specify B<"-depth 32">, too, to force a visual with
1516alpha channels, and have the luck that your X-server uses ARGB pixel
1517layout, as X is far from just supporting ARGB visuals out of the box, and
1518rxvt-unicode just fudges around.
1519
1520For example, the following selects an almost completely transparent black
1521background, and an almost opaque pink foreground:
1522
1523 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1524
1525When not using a background image, then the interpretation of the
1526alpha channel is up to your compositing manager (most interpret it as
1527transparency of course).
1528
1529When using a background pixmap or pseudo-transparency, then the background
1530colour will always behave as if it were completely transparent (so the
1531background image shows instead), regardless of how it was specified, while
1532other colours will either be transparent as specified (the background
1533image will show through) on servers supporting the RENDER extension, or
1534fully opaque on servers not supporting the RENDER EXTENSION.
1535
1536Please note that due to bugs in Xft, specifying alpha values might result
1537in garbage being displayed when the X-server does not support the RENDER
1538extension.
1539
1228=head1 ENVIRONMENT 1540=head1 ENVIRONMENT
1229 1541
1230B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1542B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1231 1543
1232=over 4 1544=over 4
1233 1545
1234=item B<TERM> 1546=item B<TERM>
1235 1547
1236Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1548Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1237resources or on the commandline. 1549resources or on the command line.
1238 1550
1239=item B<COLORTERM> 1551=item B<COLORTERM>
1240 1552
1241Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1553Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1242compiled with XPM support, and optionally with the added extension 1554compiled with background image support, and optionally with the added
1243C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1555extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1556screen.
1244 1557
1245=item B<COLORFGBG> 1558=item B<COLORFGBG>
1246 1559
1247Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1560Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1248the colour code used as default foreground/text colour (or the string 1561the colour code used as default foreground/text colour (or the string
1249C<default> to indicate that the default-colour escape sequence is to be 1562C<default> to indicate that the default-colour escape sequence is to be
1250used), C<bg> is the colour code used as default background colour (or the 1563used), C<bg> is the colour code used as default background colour (or the
1251string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1564string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1252was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1565was compiled with background image support. Libraries like C<ncurses>
1253(and do) use this information to optimize screen output. 1566and C<slang> can (and do) use this information to optimize screen output.
1254 1567
1255=item B<WINDOWID> 1568=item B<WINDOWID>
1256 1569
1257Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1570Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1258window, which usually has subwindows for the scrollbar, the terminal 1571window, which usually has subwindows for the scrollbar, the terminal
1264C<--with-terminfo=PATH>. 1577C<--with-terminfo=PATH>.
1265 1578
1266=item B<DISPLAY> 1579=item B<DISPLAY>
1267 1580
1268Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1581Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1269display in it's child processes. 1582display in its child processes if C<-display> isn't used to override. It
1583defaults to C<:0> if it doesn't exist.
1270 1584
1271=item B<SHELL> 1585=item B<SHELL>
1272 1586
1273The shell to be used for command execution, defaults to C</bin/sh>. 1587The shell to be used for command execution, defaults to C</bin/sh>.
1274
1275=item B<RXVTPATH>
1276
1277The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1278files.
1279
1280=item B<PATH>
1281
1282Used in the same way as C<RXVTPATH>.
1283 1588
1284=item B<RXVT_SOCKET> 1589=item B<RXVT_SOCKET>
1285 1590
1286The unix domain socket path used by @@RXVT_NAME@@c(1) and 1591The unix domain socket path used by @@RXVT_NAME@@c(1) and
1287@@RXVT_NAME@@d(1). 1592@@RXVT_NAME@@d(1).
1325 1630
1326=item Project Coordinator 1631=item Project Coordinator
1327 1632
1328Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1633Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1329 1634
1330L<http://software.schmorp.de/#rxvt-unicode> 1635L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1331 1636
1332=back 1637=back
1333 1638
1334=head1 AUTHORS 1639=head1 AUTHORS
1335 1640
1357 1662
1358Project Coordinator (changes.txt 2.21a to 2.4.5) 1663Project Coordinator (changes.txt 2.21a to 2.4.5)
1359 1664
1360=item Geoff Wing L<< <gcw@pobox.com> >> 1665=item Geoff Wing L<< <gcw@pobox.com> >>
1361 1666
1362Rewrote screen display and text selection routines. Project Coordinator 1667Rewrote screen display and text selection routines.
1668
1363(changes.txt 2.4.6 - rxvt-unicode) 1669Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1364 1670
1365=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1671=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1366 1672
1367Forked rxvt-unicode, rewrote most of the display code and internal 1673Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1368character handling to store text in unicode, improve xterm 1674extension, random hacks, numerous bugfixes and extensions.
1369compatibility and apply numerous other bugfixes and extensions.
1370 1675
1371Project Coordinator (Changes 1.0 -) 1676Project Coordinator (Changes 1.0 -)
1372 1677
1678=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1679
1680Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1681
1373=back 1682=back
1374 1683

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines