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.68 by root, Thu Aug 11 02:05:07 2005 UTC vs.
Revision 1.157 by ayin, Sat Jan 19 16:20:09 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
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 (B<-d> still
95respected). In the absence of this option, the display specified by the 98respected). In the absence of this option, the display specified by the
96B<DISPLAY> environment variable is used. 99B<DISPLAY> environment variable is used.
97 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
98=item B<-geometry> I<geom> 106=item B<-geometry> I<geom>
99 107
100Window geometry (B<-g> still respected); resource B<geometry>. 108Window geometry (B<-g> still respected); resource B<geometry>.
101 109
102=item B<-rv>|B<+rv> 110=item B<-rv>|B<+rv>
103 111
104Turn on/off simulated reverse video; resource B<reverseVideo>. 112Turn on/off simulated reverse video; resource B<reverseVideo>.
105 113
106=item B<-j>|B<+j> 114=item B<-j>|B<+j>
107 115
108Turn on/off jump scrolling; resource B<jumpScroll>. 116Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109 117
110=item B<-ip>|B<+ip> 118=item B<-ss>|B<+ss>
111 119
112Turn on/off inheriting parent window's pixmap. Alternative form is 120Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
113B<-tr>; resource B<inheritPixmap>. 121
122=item B<-tr>|B<+tr>
123
124Turn on/off illusion of a transparent window background; resource B<transparent>.
125
126B<-ip> is still accepted as an obsolete alias but will be removed in
127future versions.
128
129I<Please address all transparency related issues to Sasha Vasko at
130sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
114 131
115=item B<-fade> I<number> 132=item B<-fade> I<number>
116 133
117Fade the text by the given percentage when focus is lost. Small values 134Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade 135fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>. 136colour; resource B<fading>.
120 137
121=item B<-fadecolor> I<colour> 138=item B<-fadecolor> I<colour>
122 139
123Fade to this colour when fading is used (see B<-fade>). The default colour 140Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>. 141is opaque black. resource B<fadeColor>.
125 142
126=item B<-tint> I<colour> 143=item B<-tint> I<colour>
127 144
128Tint the transparent background pixmap with the given colour when 145Tint the transparent background pixmap with the given colour when
129transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> 146transparency is enabled with B<-tr>. This only works for
147non-tiled backgrounds, currently. See also the B<-sh> option that can be
130option that can be used to brighten or darken the image in addition to 148used to brighten or darken the image in addition to tinting it.
131tinting it; resource I<tintColor>. 149Please note that certain tint colours can be applied on the server-side,
150thus yielding performance gain of two orders of magnitude. These colours are:
151blue, red, green, cyan, magenta, yellow, and those close to them. Also
152pure black and pure white colors essentially mean no tinting; resource
153I<tintColor>. Example:
132 154
133=item B<-sh> 155 @@RXVT_NAME@@ -tr -tint blue -sh 40
134 156
157=item B<-sh> I<number>
158
135I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 159Darken (0 .. 100) or lighten (100 .. 200) the transparent
136background image in addition to tinting it (i.e. B<-tint> must be 160background image in addition to (or instead of) tinting it;
137specified, too, e.g. C<-tint white>). 161resource I<shading>.
162
163=item B<-blt> I<string>
164
165Specify background blending type. If background pixmap is specified
166at the same time as transparency - such pixmap will be blended over
167transparency image, using method specified. Supported values are :
168B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
169B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
170B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
171alpha-blending. Compile I<afterimage>; resource I<blendType>.
172
173=item B<-blr> I<HxV>
174
175Apply Gaussian Blur with the specified radii to the transparent
176background image. If single number is specified - both vertical and
177horizontal radii are considered to be the same. Setting one of the
178radii to 1 and another to a large number creates interesting effects
179on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
180resource I<blurRadius>.
138 181
139=item B<-bg> I<colour> 182=item B<-bg> I<colour>
140 183
141Window background colour; resource B<background>. 184Window background colour; resource B<background>.
142 185
143=item B<-fg> I<colour> 186=item B<-fg> I<colour>
144 187
145Window foreground colour; resource B<foreground>. 188Window foreground colour; resource B<foreground>.
146 189
147=item B<-pixmap> I<file[;geom]> 190=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
148 191
149Compile I<XPM>: Specify XPM file for the background and also optionally 192Compile I<afterimage>: Specify image file for the background and also
150specify its scaling with a geometry string. Note you may need to 193optionally specify its scaling with a geometry string. Note you may need to
151add quotes to avoid special shell interpretation of the C<;> in the 194add quotes to avoid special shell interpretation of the C<;> in the
152command-line; resource B<backgroundPixmap>. 195command-line; for more details see resource B<backgroundPixmap>.
153 196
154=item B<-cr> I<colour> 197=item B<-cr> I<colour>
155 198
156The cursor colour; resource B<cursorColor>. 199The cursor colour; resource B<cursorColor>.
157 200
169resource B<borderColor>. 212resource B<borderColor>.
170 213
171=item B<-fn> I<fontlist> 214=item B<-fn> I<fontlist>
172 215
173Select the fonts to be used. This is a comma separated list of font names 216Select the fonts to be used. This is a comma separated list of font names
174that are used in turn when trying to display Unicode characters. The 217that are checked in order when trying to find glyphs for characters. The
175first font defines the cell size for characters; other fonts might be 218first font defines the cell size for characters; other fonts might be
176smaller, but not (in general) larger. A (hopefully) reasonable default 219smaller, but not (in general) larger. A (hopefully) reasonable default
177font list is always appended to it. See resource B<font> for more details. 220font list is always appended to it. See resource B<font> for more details.
178 221
179In short, to specify an X11 core font, just specify it's name or prefix it 222In short, to specify an X11 core font, just specify its name or prefix it
180with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, 223with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
181e.g.: 224e.g.:
182 225
183 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 226 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
184 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 227 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
186See also the question "How does rxvt-unicode choose fonts?" in the FAQ 229See also the question "How does rxvt-unicode choose fonts?" in the FAQ
187section of @@RXVT_NAME@@(7). 230section of @@RXVT_NAME@@(7).
188 231
189=item B<-fb> I<fontlist> 232=item B<-fb> I<fontlist>
190 233
191Compile font-styles: The bold font list to use when bold characters are to 234Compile I<font-styles>: The bold font list to use when B<bold> characters
192be printed. See resource B<boldFont> for details. 235are to be printed. See resource B<boldFont> for details.
193 236
194=item B<-fi> I<fontlist> 237=item B<-fi> I<fontlist>
195 238
196Compile font-styles: The italic font list to use when bold characters are to 239Compile I<font-styles>: The italic font list to use when I<italic>
197be printed. See resource B<italicFont> for details. 240characters are to be printed. See resource B<italicFont> for details.
198 241
199=item B<-fbi> I<fontlist> 242=item B<-fbi> I<fontlist>
200 243
201Compile font-styles: The bold italic font list to use when bold characters are to 244Compile I<font-styles>: The bold italic font list to use when B<< I<bold
202be printed. See resource B<boldItalicFont> for details. 245italic> >> characters are to be printed. See resource B<boldItalicFont>
246for details.
247
248=item B<-is>|B<+is>
249
250Compile I<font-styles>: Bold/Blink font styles imply high intensity
251foreground/background (default). See resource B<intensityStyles> for
252details.
203 253
204=item B<-name> I<name> 254=item B<-name> I<name>
205 255
206Specify the application name under which resources are to be obtained, 256Specify the application name under which resources are to be obtained,
207rather than the default executable file name. Name should not contain 257rather than the default executable file name. Name should not contain
223 273
224=item B<-sb>|B<+sb> 274=item B<-sb>|B<+sb>
225 275
226Turn on/off scrollbar; resource B<scrollBar>. 276Turn on/off scrollbar; resource B<scrollBar>.
227 277
278=item B<-sr>|B<+sr>
279
280Put scrollbar on right/left; resource B<scrollBar_right>.
281
282=item B<-st>|B<+st>
283
284Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
285resource B<scrollBar_floating>.
286
228=item B<-si>|B<+si> 287=item B<-si>|B<+si>
229 288
230Turn on/off scroll-to-bottom on TTY output inhibit; resource 289Turn on/off scroll-to-bottom on TTY output inhibit; resource
231B<scrollTtyOutput> has opposite effect. 290B<scrollTtyOutput> has opposite effect.
232 291
238=item B<-sw>|B<+sw> 297=item B<-sw>|B<+sw>
239 298
240Turn on/off scrolling with the scrollback buffer as new lines appear. 299Turn on/off scrolling with the scrollback buffer as new lines appear.
241This only takes effect if B<-si> is also given; resource 300This only takes effect if B<-si> is also given; resource
242B<scrollWithBuffer>. 301B<scrollWithBuffer>.
243
244=item B<-sr>|B<+sr>
245
246Put scrollbar on right/left; resource B<scrollBar_right>.
247
248=item B<-st>|B<+st>
249
250Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
251resource B<scrollBar_floating>.
252 302
253=item B<-ptab>|B<+ptab> 303=item B<-ptab>|B<+ptab>
254 304
255If enabled (default), "Horizontal Tab" characters are being stored as 305If enabled (default), "Horizontal Tab" characters are being stored as
256actual wide characters in the screen buffer, which makes it possible to 306actual wide characters in the screen buffer, which makes it possible to
287 337
288Compile I<frills>: Set MWM hints to request a borderless window, i.e. 338Compile I<frills>: Set MWM hints to request a borderless window, i.e.
289if honoured by the WM, the rxvt-unicode window will not have window 339if honoured by the WM, the rxvt-unicode window will not have window
290decorations; resource B<borderLess>. 340decorations; resource B<borderLess>.
291 341
342=item B<-override-redirect>
343
344Compile I<frills>: Sets override-redirect on the window; resource
345B<override-redirect>.
346
347=item B<-sbg>
348
349Compile I<frills>: Disable the usage of the built-in block graphics/line
350drawing characters and just rely on what the specified fonts provide. Use
351this if you have a good font and want to use its block graphic glyphs;
352resource B<skipBuiltinGlyphs>.
353
292=item B<-lsp> I<number> 354=item B<-lsp> I<number>
293 355
294Compile I<frills>: Lines (pixel height) to insert between each row of 356Compile I<frills>: Lines (pixel height) to insert between each row of
295the display. Useful to work around font rendering problems; resource 357the display. Useful to work around font rendering problems; resource
296B<linespace>. 358B<lineSpace>.
297 359
298=item B<-tn> I<termname> 360=item B<-tn> I<termname>
299 361
300This option specifies the name of the terminal type to be set in the 362This option specifies the name of the terminal type to be set in the
301B<TERM> environment variable. This terminal type must exist in the 363B<TERM> environment variable. This terminal type must exist in the
310given on the command line. If this option is used, it must be the last 372given on the command line. If this option is used, it must be the last
311on the command-line. If there is no B<-e> option then the default is to 373on the command-line. If there is no B<-e> option then the default is to
312run the program specified by the B<SHELL> environment variable or, 374run the program specified by the B<SHELL> environment variable or,
313failing that, I<sh(1)>. 375failing that, I<sh(1)>.
314 376
377Please note that you must specify a program with arguments. If you want to
378run shell commands, you have to specify the shell, like this:
379
380 @@RXVT_NAME@@ -e sh -c "shell commands"
381
315=item B<-title> I<text> 382=item B<-title> I<text>
316 383
317Window title (B<-T> still respected); the default title is the basename 384Window title (B<-T> still respected); the default title is the basename
318of the program specified after the B<-e> option, if any, otherwise the 385of the program specified after the B<-e> option, if any, otherwise the
319application name; resource B<title>. 386application name; resource B<title>.
350for more info. 417for more info.
351 418
352=item B<-tcw> 419=item B<-tcw>
353 420
354Change the meaning of triple-click selection with the left mouse 421Change the meaning of triple-click selection with the left mouse
422button. Only effective when the original (non-perl) selection code is
355button. Instead of selecting a full line it will extend the selection the 423in-use. Instead of selecting a full line it will extend the selection to
356end of the logical line only. resource B<tripleclickwords>. 424the end of the logical line only. resource B<tripleclickwords>.
357 425
358=item B<-insecure> 426=item B<-insecure>
359 427
360Enable "insecure" mode, which currently enables most of the escape 428Enable "insecure" mode, which currently enables most of the escape
361sequences that echo strings. See the resource B<insecure> for more 429sequences that echo strings. See the resource B<insecure> for more
375=item B<-ssr>|B<+ssr> 443=item B<-ssr>|B<+ssr>
376 444
377Turn on/off secondary screen scroll (default enabled); resource 445Turn on/off secondary screen scroll (default enabled); resource
378B<secondaryScroll>. 446B<secondaryScroll>.
379 447
448=item B<-hold>|B<+hold>
449
450Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
451will not immediately destroy its window when the program executed within
452it exits. Instead, it will wait till it is being killed or closed by the
453user; resource B<hold>.
454
455=item B<-xrm> I<string>
456
457Works like the X Toolkit option of the same name, by adding the I<string>
458as if it were specified in a resource file. Resource values specified this
459way take precedence over all other resource specifications.
460
461Note that you need to use the I<same> syntax as in the .Xdefaults file,
462e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
463options can be specified as long-options on the commandline, so use
464of B<-xrm> is mostly limited to cases where you want to specify other
465resources (e.g. for input methods) or for compatibility with other
466programs.
467
380=item B<-keysym.>I<sym> I<string> 468=item B<-keysym.>I<sym> I<string>
381 469
382Remap a key symbol. See resource B<keysym>. 470Remap a key symbol. See resource B<keysym>.
383 471
384=item B<-embed> I<windowid> 472=item B<-embed> I<windowid>
385 473
386Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 474Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
387which enables applications to easily embed a terminal. 475which enables applications to easily embed a terminal.
388 476
389Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 477Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
390shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 478shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
391quite a bit, so don't expect it to keep some specific state. It's best to 479quite a bit, so don't expect it to keep some specific state. It's best to
394The window will not be destroyed when @@RXVT_NAME@@ exits. 482The window will not be destroyed when @@RXVT_NAME@@ exits.
395 483
396It might be useful to know that @@RXVT_NAME@@ will not close file 484It might be useful to know that @@RXVT_NAME@@ will not close file
397descriptors passed to it (except for stdin/out/err, of course), so you 485descriptors passed to it (except for stdin/out/err, of course), so you
398can use file descriptors to communicate with the programs within the 486can use file descriptors to communicate with the programs within the
399terminal. This works regardless of wether the C<-embed> option was used or 487terminal. This works regardless of whether the C<-embed> option was used or
400not. 488not.
401 489
402Here is a short Gtk2-perl snippet that illustrates how this option can be 490Here is a short Gtk2-perl snippet that illustrates how this option can be
403used (a longer example is in F<doc/embed>): 491used (a longer example is in F<doc/embed>):
404 492
406 $rxvt->signal_connect_after (realize => sub { 494 $rxvt->signal_connect_after (realize => sub {
407 my $xid = $_[0]->window->get_xid; 495 my $xid = $_[0]->window->get_xid;
408 system "@@RXVT_NAME@@ -embed $xid &"; 496 system "@@RXVT_NAME@@ -embed $xid &";
409 }); 497 });
410 498
411=item B<-pty-fd> I<fileno> 499=item B<-pty-fd> I<file descriptor>
412 500
413Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 501Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
414pair but instead use the given filehandle as the tty master. This is 502pair but instead use the given file descriptor as the tty master. This is
415useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 503useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
416without having to run a program within it. 504without having to run a program within it.
417 505
418If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 506If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
419entries and will not tinker with pty/tty permissions - you have to do that 507entries and will not tinker with pty/tty permissions - you have to do that
420yourself if you want that. 508yourself if you want that.
509
510As an extremely special case, specifying C<-1> will completely suppress
511pty/tty operations, which is probably only useful in conjunction with some
512perl extension that manages the terminal.
421 513
422Here is a example in perl that illustrates how this option can be used (a 514Here is a example in perl that illustrates how this option can be used (a
423longer example is in F<doc/pty-fd>): 515longer example is in F<doc/pty-fd>):
424 516
425 use IO::Pty; 517 use IO::Pty;
432 524
433 # now communicate with rxvt 525 # now communicate with rxvt
434 my $slave = $pty->slave; 526 my $slave = $pty->slave;
435 while (<$slave>) { print $slave "got <$_>\n" } 527 while (<$slave>) { print $slave "got <$_>\n" }
436 528
529=item B<-pe> I<string>
530
531Comma-separated list of perl extension scripts to use (or not to use) in
532this terminal instance. See resource B<perl-ext> for details.
533
437=back 534=back
438 535
439=head1 RESOURCES (available also as long-options) 536=head1 RESOURCES
440 537
441Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 538Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
442options) compiled into your version. 539options) compiled into your version. All resources are also available as
540long-options.
443 541
444There are two different methods that @@RXVT_NAME@@ can use to get the 542You can set and change the resources using X11 tools like B<xrdb>. Many
445Xresource data: using the X libraries (Xrm*-functions) or internal 543distribution do also load settings from the B<~/.Xresources> file when X
446Xresources reader (B<~/.Xdefaults>). For the first method (ie. 544starts. @@RXVT_NAME@@ will consult the following files/resources in order,
447B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 545with later settings overwriting earlier ones:
448resources using X11 tools like B<xrdb>. Many distribution do also load
449settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
450will consult the following files/resources in order, with later settings
451overwriting earlier ones:
452 546
453 1. system-wide app-defaults file, either locale-dependent OR global 547 1. system-wide app-defaults file, either locale-dependent OR global
454 2. app-defaults file in $XAPPLRESDIR 548 2. app-defaults file in $XAPPLRESDIR
455 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 549 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
456 4. SCREEN_RESOURCES for the current screen 550 4. SCREEN_RESOURCES for the current screen
457 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 551 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
552 6. resources specified via -xrm on the commandline
458 553
459If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
460lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
461set in XAPPLOADDIR/URxvt (compile-time defined: usually
462B</usr/lib/X11/app-defaults/URxvt>) and resources set in
463B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
464Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 554Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
465class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 555names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
466resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 556common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
467easily configured, while the class name B<URxvt> allows resources 557configured, while the class name B<URxvt> allows resources unique to
468unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 558B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
469shared between different B<@@RXVT_NAME@@> configurations. If no 559configurations. If no resources are specified, suitable defaults will
470resources are specified, suitable defaults will be used. Command-line 560be used. Command-line arguments can be used to override resource
471arguments can be used to override resource settings. The following 561settings. The following resources are supported (you might want to
472resources are allowed: 562check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
563extensions not documented here):
473 564
474=over 4 565=over 4
566
567=item B<depth:> I<bitdepth>
568
569Compile I<xft>: Attempt to find a visual with the given bit depth;
570option B<-depth>.
475 571
476=item B<geometry:> I<geom> 572=item B<geometry:> I<geom>
477 573
478Create the window with the specified X window geometry [default 80x24]; 574Create the window with the specified X window geometry [default 80x24];
479option B<-geometry>. 575option B<-geometry>.
516Use the specified colour to display underlined characters when the 612Use the specified colour to display underlined characters when the
517foreground colour is the default. 613foreground colour is the default.
518 614
519=item B<colorRV:> I<colour> 615=item B<colorRV:> I<colour>
520 616
521Use the specified colour as the background for reverse video 617Use the specified colour as the background for reverse video characters
522characters. 618when OPTION_HC is disabled (--disable-frills).
523 619
524=item B<underlineColor:> I<colour> 620=item B<underlineColor:> I<colour>
525 621
526If set, use the specified colour as the colour for the underline 622If set, use the specified colour as the colour for the underline
527itself. If unset, use the foreground colour. 623itself. If unset, use the foreground colour.
543option B<-rv>. B<False>: regular screen colours [default]; option 639option B<-rv>. B<False>: regular screen colours [default]; option
544B<+rv>. See note in B<COLORS AND GRAPHICS> section. 640B<+rv>. See note in B<COLORS AND GRAPHICS> section.
545 641
546=item B<jumpScroll:> I<boolean> 642=item B<jumpScroll:> I<boolean>
547 643
548B<True>: specify that jump scrolling should be used. When scrolling 644B<True>: specify that jump scrolling should be used. When receiving lots
549quickly, fewer screen updates are performed [default]; option B<-j>. 645of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
646has been read, resulting in fewer updates while still displaying every
647received line; option B<-j>.
648
550B<False>: specify that smooth scrolling should be used; option B<+j>. 649B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
650force a screen refresh on each new line it received; option B<+j>.
551 651
552=item B<inheritPixmap:> I<boolean> 652=item B<skipScroll:> I<boolean>
553 653
554B<True>: make the background inherit the parent windows' pixmap, giving 654B<True>: (the default) specify that skip scrolling should be used. When
555artificial transparency. B<False>: do not inherit the parent windows' 655receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
556pixmap. 656(around 60 times per second), resulting in far fewer updates. This can
657result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
658option B<-ss>.
659
660B<False>: specify that everything is to be displayed, even
661if the refresh is too fast for the human eye to read anything (or the
662monitor to display anything); option B<+ss>.
663
664=item B<transparent:> I<boolean>
665
666Turn on/off illusion of a transparent window background.
667
668B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
669future versions.
670
671I<Please address all transparency related issues to Sasha Vasko at
672sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
557 673
558=item B<fading:> I<number> 674=item B<fading:> I<number>
559 675
560Fade the text by the given percentage when focus is lost; option B<-fade>. 676Fade the text by the given percentage when focus is lost; option B<-fade>.
561 677
569Tint the transparent background pixmap with the given colour; option 685Tint the transparent background pixmap with the given colour; option
570B<-tint>. 686B<-tint>.
571 687
572=item B<shading:> I<number> 688=item B<shading:> I<number>
573 689
574Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 690Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
575image in addition to tinting it. 691in addition to tinting it; option B<-sh>.
692
693=item B<blendType:> I<string>
694
695Specify background blending type; option B<-blt>.
696
697=item B<blurRadius:> I<number>
698
699Apply Gaussian Blurr with the specified radius to the transparent
700background image; option B<-blr>.
576 701
577=item B<scrollColor:> I<colour> 702=item B<scrollColor:> I<colour>
578 703
579Use the specified colour for the scrollbar [default #B2B2B2]. 704Use the specified colour for the scrollbar [default #B2B2B2].
580 705
586=item B<borderColor:> I<colour> 711=item B<borderColor:> I<colour>
587 712
588The colour of the border around the text area and between the scrollbar 713The colour of the border around the text area and between the scrollbar
589and the text. 714and the text.
590 715
591=item B<backgroundPixmap:> I<file[;geom]> 716=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
592 717
593Use the specified XPM file (note the `.xpm' extension is optional) for 718Use the specified image file for the background and also
594the background and also optionally specify its scaling with a geometry 719optionally specify its scaling with a geometry string B<WxH+X+Y>,
595string B<WxH+X+Y>, in which B<"W" / "H"> specify the 720(default C<0x0+50+50>) in which B<"W" / "H"> specify the
596horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 721horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
597centre (percent). A scale of 0 displays the image with tiling. A scale 722centre (percent). A scale of 0 displays the image with tiling. A scale
598of 1 displays the image without any scaling. A scale of 2 to 9 723of 1 displays the image without any scaling. A scale of 2 to 9 specifies
599specifies an integer number of images in that direction. No image will 724an integer number of images in that direction. No image will be magnified
600be magnified beyond 10 times its original size. The maximum permitted 725beyond 10 times its original size. The maximum permitted scale is 1000.
601scale is 1000. [default 0x0+50+50] 726Additional operations can be specified after colon B<:op1:op2...>.
727Supported operations are:
602 728
603=item B<menu:> I<file[;tag]> 729 tile force background image to be tiled and not scaled. Equivalent to 0x0
730 propscale will scale image keeping proportions
731 auto will scale image to match window size. Equivalent to 100x100
732 hscale will scale image horizontally to the window size
733 vscale will scale image vertically to the window size
734 scale will scale image to match window size
735 root will tile image as if it was a root window background, auto-adjusting
736 whenever terminal window moves
604 737
605Read in the specified menu file (note the `.menu' extension is 738If used in conjunction with B<-tr> option, the specified pixmap will be
606optional) and also optionally specify a starting tag to find. See the 739blended over transparency image using either alpha-blending, or any
607reference documentation for details on the syntax for the menuBar. 740other blending type, specified with B<-blt "type"> option.
608 741
609=item B<path:> I<path> 742=item B<path:> I<path>
610 743
611Specify the colon-delimited search path for finding files (XPM and 744Specify the colon-delimited search path for finding background image files.
612menus), in addition to the paths specified by the B<RXVTPATH> and
613B<PATH> environment variables.
614 745
615=item B<font:> I<fontlist> 746=item B<font:> I<fontlist>
616 747
617Select the fonts to be used. This is a comma separated list of font 748Select the fonts to be used. This is a comma separated list of font names
618names that are used in turn when trying to display Unicode characters. 749that are checked in order when trying to find glyphs for characters. The
619The first font defines the cell size for characters; other fonts might 750first font defines the cell size for characters; other fonts might be
620be smaller, but not larger. A reasonable default font list is always 751smaller, but not (in general) larger. A (hopefully) reasonable default
621appended to it. option B<-fn>. 752font list is always appended to it; option B<-fn>.
622 753
623Each font can either be a standard X11 core font (XLFD) name, with 754Each font can either be a standard X11 core font (XLFD) name, with
624optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 755optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
625 756
626In addition, each font can be prefixed with additional hints and 757In addition, each font can be prefixed with additional hints and
628hint currently is C<codeset=codeset-name>, and this is only used for Xft 759hint currently is C<codeset=codeset-name>, and this is only used for Xft
629fonts. 760fonts.
630 761
631For example, this font resource 762For example, this font resource
632 763
633 URxvt*font: 9x15bold,\ 764 URxvt.font: 9x15bold,\
634 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 765 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
635 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 766 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
636 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 767 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
637 xft:Code2000:antialias=false 768 xft:Code2000:antialias=false
638 769
672not possible, replacement fonts of the desired shape will be tried. 803not possible, replacement fonts of the desired shape will be tried.
673 804
674If set, but empty, then this specific style is disabled and the normal 805If set, but empty, then this specific style is disabled and the normal
675text font will being used for the given style. 806text font will being used for the given style.
676 807
677=item B<selectstyle:> I<mode> 808=item B<intensityStyles:> I<boolean>
678 809
679Set mouse selection style to B<old> which is 2.20, B<oldword> which is 810When font styles are not enabled, or this option is enabled (B<True>,
680xterm style with 2.20 old word selection, or anything else which gives 811option B<-is>, the default), bold/blink font styles imply high
681xterm style selection. 812intensity foreground/background colours. Disabling this option (B<False>,
682 813option B<+is>) disables this behaviour, the high intensity colours are not
683=item B<scrollstyle:> I<mode> 814reachable.
684
685Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
686the author's favourite.
687 815
688=item B<title:> I<string> 816=item B<title:> I<string>
689 817
690Set window title string, the default title is the command-line 818Set window title string, the default title is the command-line
691specified after the B<-e> option, if any, otherwise the application 819specified after the B<-e> option, if any, otherwise the application
700=item B<mapAlert:> I<boolean> 828=item B<mapAlert:> I<boolean>
701 829
702B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 830B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
703de-iconify (map) on receipt of a bell character [default]. 831de-iconify (map) on receipt of a bell character [default].
704 832
833=item B<urgentOnBell:> I<boolean>
834
835B<True>: set the urgency hint for the wm on receipt of a bell character.
836B<False>: do not set the urgency hint [default].
837
705=item B<visualBell:> I<boolean> 838=item B<visualBell:> I<boolean>
706 839
707B<True>: use visual bell on receipt of a bell character; option B<-vb>. 840B<True>: use visual bell on receipt of a bell character; option B<-vb>.
708B<False>: no visual bell [default]; option B<+vb>. 841B<False>: no visual bell [default]; option B<+vb>.
709 842
727 860
728The string will be interpreted as if typed into the shell as-is. 861The string will be interpreted as if typed into the shell as-is.
729 862
730Example: 863Example:
731 864
732 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 865 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
733 866
734This creates a new file in your home directory with the screen contents 867This creates a new file in your home directory with the screen contents
735everytime you hit C<Print>. 868every time you hit C<Print>.
869
870=item B<scrollstyle:> I<mode>
871
872Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
873the author's favourite.
736 874
737=item B<scrollBar:> I<boolean> 875=item B<scrollBar:> I<boolean>
738 876
739B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 877B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
740disable the scrollbar; option B<+sb>. 878disable the scrollbar; option B<+sb>.
762 900
763=item B<scrollWithBuffer:> I<boolean> 901=item B<scrollWithBuffer:> I<boolean>
764 902
765B<True>: scroll with scrollback buffer when tty receives new lines (and 903B<True>: scroll with scrollback buffer when tty receives new lines (and
766B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 904B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
767with scrollback buffer when tty recieves new lines; option B<+sw>. 905with scrollback buffer when tty receives new lines; option B<+sw>.
768 906
769=item B<scrollTtyKeypress:> I<boolean> 907=item B<scrollTtyKeypress:> I<boolean>
770 908
771B<True>: scroll to bottom when a non-special key is pressed. Special keys 909B<True>: scroll to bottom when a non-special key is pressed. Special keys
772are those which are intercepted by rxvt-unicode for special handling and 910are those which are intercepted by rxvt-unicode for special handling and
791=item B<borderLess:> I<boolean> 929=item B<borderLess:> I<boolean>
792 930
793Set MWM hints to request a borderless window, i.e. if honoured by the 931Set MWM hints to request a borderless window, i.e. if honoured by the
794WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 932WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
795 933
934=item B<skipBuiltinGlyphs:> I<boolean>
935
936Compile I<frills>: Disable the usage of the built-in block graphics/line
937drawing characters and just rely on what the specified fonts provide. Use
938this if you have a good font and want to use its block graphic glyphs;
939option B<-sbg>.
940
796=item B<termName:> I<termname> 941=item B<termName:> I<termname>
797 942
798Specifies the terminal type name to be set in the B<TERM> environment 943Specifies the terminal type name to be set in the B<TERM> environment
799variable; option B<-tn>. 944variable; option B<-tn>.
800 945
801=item B<linespace:> I<number> 946=item B<lineSpace:> I<number>
802 947
803Specifies number of lines (pixel height) to insert between each row of 948Specifies number of lines (pixel height) to insert between each row of
804the display [default 0]; option B<-lsp>. 949the display [default 0]; option B<-lsp>.
805 950
806=item B<meta8:> I<boolean> 951=item B<meta8:> I<boolean>
855pressed. If unset it will send the sequence traditionally associated 1000pressed. If unset it will send the sequence traditionally associated
856with the B<Execute> key. 1001with the B<Execute> key.
857 1002
858=item B<cutchars:> I<string> 1003=item B<cutchars:> I<string>
859 1004
860The characters used as delimiters for double-click word selection. The 1005The characters used as delimiters for double-click word selection
861built-in default: 1006(whitespace delimiting is added automatically if resource is given).
862 1007
1008When the perl selection extension is in use (the default if compiled
1009in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
1010characters will be created (if the resource exists, otherwise, no regex
1011will be created). In this mode, characters outside ISO-8859-1 can be used.
1012
1013When the selection extension is not used, only ISO-8859-1 characters can
1014be used. If not specified, the built-in default is used:
1015
863B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1016B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
864 1017
865=item B<preeditType:> I<style> 1018=item B<preeditType:> I<style>
866 1019
867B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1020B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
868 1021
873=item B<imLocale:> I<name> 1026=item B<imLocale:> I<name>
874 1027
875The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 1028The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
876C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the 1029C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
877input extension to be able to input japanese characters while staying in 1030input extension to be able to input japanese characters while staying in
878another locale. option B<-imlocale>. 1031another locale; option B<-imlocale>.
879 1032
880=item B<imFont:> I<fontset> 1033=item B<imFont:> I<fontset>
881 1034
882Specify the font-set used for XIM styles C<OverTheSpot> or 1035Specify the font-set used for XIM styles C<OverTheSpot> or
883C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 1036C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
888 1041
889=item B<tripleclickwords:> I<boolean> 1042=item B<tripleclickwords:> I<boolean>
890 1043
891Change the meaning of triple-click selection with the left mouse 1044Change the meaning of triple-click selection with the left mouse
892button. Instead of selecting a full line it will extend the selection to 1045button. Instead of selecting a full line it will extend the selection to
893the end of the logical line only. option B<-tcw>. 1046the end of the logical line only; option B<-tcw>.
894 1047
895=item B<insecure:> I<boolean> 1048=item B<insecure:> I<boolean>
896 1049
897Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1050Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
898echo arbitrary strings like the icon name or the locale. This could be 1051echo arbitrary strings like the icon name or the locale. This could be
899abused if somebody gets 8-bit-clean access to your display, whether 1052abused if somebody gets 8-bit-clean access to your display, whether
900throuh a mail client displaying mail bodies unfiltered or though 1053through a mail client displaying mail bodies unfiltered or through
901write(1). Therefore, these sequences are disabled by default. (Note 1054write(1) or any other means. Therefore, these sequences are disabled by
902that other terminals, including xterm, have these sequences 1055default. (Note that many other terminals, including xterm, have these
903enabled by default). You can enable them by setting this boolean 1056sequences enabled by default, which doesn't make it safer, though).
904resource or specifying B<-insecure> as an option. At the moment, this 1057
905enabled display-answer, locale, findfont, icon label and window title 1058You can enable them by setting this boolean resource or specifying
906requests as well as dynamic menubar dispatch. 1059B<-insecure> as an option. At the moment, this enables display-answer,
1060locale, findfont, icon label and window title requests.
907 1061
908=item B<modifier:> I<modifier> 1062=item B<modifier:> I<modifier>
909 1063
910Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 1064Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
911B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 1065B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
915 1069
916Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1070Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
917character is passed through. It may contain escape values as described 1071character is passed through. It may contain escape values as described
918in the entry on B<keysym> following. 1072in the entry on B<keysym> following.
919 1073
920=item B<secondaryScreen:> I<bool> 1074=item B<secondaryScreen:> I<boolean>
921 1075
922Turn on/off secondary screen (default enabled). 1076Turn on/off secondary screen (default enabled).
923 1077
924=item B<secondaryScroll:> I<bool> 1078=item B<secondaryScroll:> I<boolean>
925 1079
926Turn on/off secondary screen scroll (default enabled). If the this 1080Turn on/off secondary screen scroll (default enabled). If this
927option is enabled, scrolls on the secondary screen will change the 1081option is enabled, scrolls on the secondary screen will change the
928scrollback buffer and switching to/from the secondary screen will 1082scrollback buffer and switching to/from the secondary screen will
929instead scroll the screen up. 1083instead scroll the screen up.
1084
1085=item B<hold>: I<boolean>
1086
1087Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1088will not immediately destroy its window when the program executed within
1089it exits. Instead, it will wait till it is being killed or closed by the
1090user.
930 1091
931=item B<keysym.>I<sym>: I<string> 1092=item B<keysym.>I<sym>: I<string>
932 1093
933Compile I<frills>: Associate I<string> with keysym I<sym>. The 1094Compile I<frills>: Associate I<string> with keysym I<sym>. The
934intervening resource name B<keysym.> cannot be omitted. 1095intervening resource name B<keysym.> cannot be omitted.
948searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1109searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
949omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1110omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
950keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1111keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
951performed in an exact manner; however, the closest match is assured. 1112performed in an exact manner; however, the closest match is assured.
952 1113
953I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1114I<string> may contain escape values (C<\n>: newline, C<\000>: octal
954C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1115number), see RESOURCES in C<man 7 X> for futher details.
955C<\000>: octal number) or verbatim control characters (C<^?>: delete,
956C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
957can start or end with whitespace.
958
959Please note that you need to double the C<\> when using
960C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
961use C<\033> instead of C<\e> (and so on), which will work with both Xt and
962@@RXVT_NAME@@'s own processing).
963 1116
964You can define a range of keysyms in one shot by providing a I<string> 1117You can define a range of keysyms in one shot by providing a I<string>
965with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1118with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
966should be a character not used by the strings. 1119should be a character not used by the strings.
967 1120
968Its usage can be demonstrated by an example: 1121Its usage can be demonstrated by an example:
969 1122
970 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1123 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
979is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1132is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
980example the following means "change the current locale to C<zh_CN.GBK> 1133example the following means "change the current locale to C<zh_CN.GBK>
981when Control-Meta-c is being pressed": 1134when Control-Meta-c is being pressed":
982 1135
983 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1136 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1137
1138If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1139is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3)
1140manpage. For example, the F<selection> extension (activated via
1141C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1142
1143 URxvt.keysym.M-C-c: perl:selection:rot13
984 1144
985Due the the large number of modifier combinations, a defined key mapping 1145Due the the large number of modifier combinations, a defined key mapping
986will match if at I<at least> the specified identifiers are being set, and 1146will match if at I<at least> the specified identifiers are being set, and
987no other key mappings with those and more bits are being defined. That 1147no other key mappings with those and more bits are being defined. That
988means that defining a key map for C<a> will automatically provide 1148means that defining a key map for C<a> will automatically provide
1012info): 1172info):
1013 1173
1014 URxvt.keysym.M-C-3: command:\033[8;25;80t 1174 URxvt.keysym.M-C-3: command:\033[8;25;80t
1015 URxvt.keysym.M-C-4: command:\033[8;48;110t 1175 URxvt.keysym.M-C-4: command:\033[8;48;110t
1016 1176
1177=item B<perl-ext-common>: I<string>
1178
1179=item B<perl-ext>: I<string>
1180
1181Comma-separated list(s) of perl extension scripts (default: C<default>) to
1182use in this terminal instance; option B<-pe>.
1183
1184Extension names can be prefixed with a C<-> sign to prohibit using
1185them. This can be useful to selectively disable some extensions loaded
1186by default, or specified via the C<perl-ext-common> resource. For
1187example, C<default,-selection> will use all the default extension except
1188C<selection>.
1189
1190Extension names can also be followed by an argument in angle brackets
1191(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1192searchable scrollback to Alt/Meta-s). Mentioning the same extension
1193multiple times with different arguments will pass multiple arguments to
1194the extension.
1195
1196Each extension is looked up in the library directories, loaded if
1197necessary, and bound to the current terminal instance.
1198
1199If both of these resources are the empty string, then the perl
1200interpreter will not be initialized. The idea behind two options is that
1201B<perl-ext-common> will be used for extensions that should be available to
1202all instances, while B<perl-ext> is used for specific instances.
1203
1204=item B<perl-eval>: I<string>
1205
1206Perl code to be evaluated when all extensions have been registered. See
1207the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource
1208will be ignored when running setuid/setgid.
1209
1210=item B<perl-lib>: I<path>
1211
1212Colon-separated list of additional directories that hold extension
1213scripts. When looking for extensions specified by the C<perl> resource,
1214@@RXVT_NAME@@ will first look in these directories and then in
1215F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1216will be ignored when running setuid/setgid.
1217
1218See the @@RXVT_NAME@@perl(3) manpage.
1219
1220=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1221
1222Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1223details.
1224
1225=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1226
1227Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1228for details.
1229
1230=item B<searchable-scrollback:> I<keysym>
1231
1232Sets the hotkey that starts the incremental scrollback buffer search
1233(default: C<M-s>).
1234
1235=item B<urlLauncher>: I<string>
1236
1237Specifies the program to be started with a URL argument. Used by the
1238C<selection-popup> and C<matcher> perl extensions.
1239
1240=item B<transient-for>: I<windowid>
1241
1242Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1243
1244=item B<override-redirect>: I<boolean>
1245
1246Compile I<frills>: Sets override-redirect for the terminal window, making
1247it almost invisible to window managers; option B<-override-redirect>.
1248
1249=item B<iso14755_52:> I<boolean>
1250
1251Turn on/off ISO 14755 5.2 mode (default enabled).
1252
1017=back 1253=back
1018 1254
1019=head1 THE SCROLLBAR 1255=head1 THE SCROLLBAR
1020 1256
1021Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window 1257Lines of text that scroll off the top of the B<@@RXVT_NAME@@> window
1039application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1275application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1040(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1276(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1041up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1277up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1042respectively. 1278respectively.
1043 1279
1044=head1 TEXT SELECTION AND INSERTION 1280=head1 THE SELECTION: SELECTING AND PASTING TEXT
1045 1281
1046The behaviour of text selection and insertion mechanism is similar to 1282The behaviour of text selection and insertion/pasting mechanism is similar
1047I<xterm>(1). 1283to I<xterm>(1).
1048 1284
1049=over 4 1285=over 4
1050 1286
1051=item B<Selection>: 1287=item B<Selecting>:
1052 1288
1053Left click at the beginning of the region, drag to the end of the region 1289Left click at the beginning of the region, drag to the end of the region
1054and release; Right click to extend the marked region; Left double-click 1290and release; Right click to extend the marked region; Left double-click
1055to select a word; Left triple-click to select the entire logical line 1291to select a word; Left triple-click to select the entire logical line
1056(which can span multiple screen lines), unless modified by resource 1292(which can span multiple screen lines), unless modified by resource
1057B<tripleclickwords>. 1293B<tripleclickwords>.
1058 1294
1059Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1295Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1060(Compile: I<frills>) will create a rectangular selection instead of a normal 1296(Compile: I<frills>) will create a rectangular selection instead of a
1061one. 1297normal one. In this mode, every selected row becomes its own line in the
1298selection, and trailing whitespace is visually underlined and removed from
1299the selection.
1062 1300
1063=item B<Insertion>: 1301=item B<Pasting>:
1064 1302
1065Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1303Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1066an B<@@RXVT_NAME@@> window causes the current text selection to be 1304window causes the value of the PRIMARY selection (or CLIPBOARD with the
1067inserted as if it had been typed on the keyboard. 1305B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1306
1307Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1308inserted too.
1068 1309
1069=back 1310=back
1070 1311
1071=head1 CHANGING FONTS 1312=head1 CHANGING FONTS
1072 1313
1073Changing fonts (or font sizes, respectively) via the keypad is not yet 1314Changing fonts (or font sizes, respectively) via the keypad is not yet
1074supported in rxvt-unicode. Bug me if you need this. 1315supported in rxvt-unicode. Bug me if you need this.
1075 1316
1076You can, however, switch fonts at runtime using escape sequences (and 1317You can, however, switch fonts at runtime using escape sequences, e.g.:
1077therefore using the menubar), e.g.:
1078 1318
1079 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1319 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1320
1321You can use keyboard shortcuts, too:
1322
1323 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1324 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1080 1325
1081rxvt-unicode will automatically re-apply these fonts to the output so far. 1326rxvt-unicode will automatically re-apply these fonts to the output so far.
1082 1327
1083=head1 ISO 14755 SUPPORT 1328=head1 ISO 14755 SUPPORT
1084 1329
1085ISO 14755 is a standard for entering and viewing unicode characters 1330ISO 14755 is a standard for entering and viewing unicode characters
1086and character codes using the keyboard. It consists of 4 parts. The 1331and character codes using the keyboard. It consists of 4 parts. The
1087first part is available rxvt-unicode has been compiled with 1332first part is available if rxvt-unicode has been compiled with
1088C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1333C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1089with C<--enable-iso14755>. 1334with C<--enable-iso14755>.
1090 1335
1091=over 4 1336=over 4
1092 1337
1112This mode lets you input characters representing the keycap symbols of 1357This mode lets you input characters representing the keycap symbols of
1113your keyboard, if representable in the current locale encoding. 1358your keyboard, if representable in the current locale encoding.
1114 1359
1115Start by pressing C<Control> and C<Shift> together, then releasing 1360Start by pressing C<Control> and C<Shift> together, then releasing
1116them. The next special key (cursor keys, home etc.) you enter will not 1361them. The next special key (cursor keys, home etc.) you enter will not
1117invoke it's usual function but instead will insert the corresponding 1362invoke its usual function but instead will insert the corresponding
1118keycap symbol. The symbol will only be entered when the key has been 1363keycap symbol. The symbol will only be entered when the key has been
1119released, otherwise pressing e.g. C<Shift> would enter the symbol for 1364released, otherwise pressing e.g. C<Shift> would enter the symbol for
1120C<ISO Level 2 Switch>, although your intention might have been to enter a 1365C<ISO Level 2 Switch>, although your intention might have been to enter a
1121reverse tab (Shift-Tab). 1366reverse tab (Shift-Tab).
1122 1367
1155=head1 COLORS AND GRAPHICS 1400=head1 COLORS AND GRAPHICS
1156 1401
1157In addition to the default foreground and background colours, 1402In addition to the default foreground and background colours,
1158B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1403B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1159high-intensity bold/blink versions of the same). Here is a list of the 1404high-intensity bold/blink versions of the same). Here is a list of the
1160colours with their B<rgb.txt> names. 1405colours with their names.
1161 1406
1162=begin table 1407=begin table
1163 1408
1164 B<color0> (black) = Black 1409 B<color0> (black) = Black
1165 B<color1> (red) = Red3 1410 B<color1> (red) = Red3
1185It is also possible to specify the colour values of B<foreground>, 1430It is also possible to specify the colour values of B<foreground>,
1186B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1431B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1187a number 0-15, as a convenient shorthand to reference the colour name of 1432a number 0-15, as a convenient shorthand to reference the colour name of
1188color0-color15. 1433color0-color15.
1189 1434
1435In addition to the colours defined above, @@RXVT_NAME@@ offers an
1436additional 72 colours. The first 64 of those (with indices 16 to 79)
1437consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
143816>), followed by 8 additional shades of gray (with indices 80 to 87).
1439
1440Together, all those colours implement the 88 colour xterm colours. Only
1441the first 16 can be changed using resources currently, the rest can only
1442be changed via command sequences ("escape codes").
1443
1190Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1444Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1191always swapping the foreground/background colours. This is in contrast to 1445always swapping the foreground/background colours. This is in contrast to
1192I<xterm>(1) where the colours are only swapped if they have not otherwise 1446I<xterm>(1) where the colours are only swapped if they have not otherwise
1193been specified. For example, 1447been specified. For example,
1194 1448
1199would yield White on Black, while on I<xterm>(1) it would yield Black 1453would yield White on Black, while on I<xterm>(1) it would yield Black
1200on White. 1454on White.
1201 1455
1202=back 1456=back
1203 1457
1458=head2 ALPHA CHANNEL SUPPORT
1459
1460If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1461their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1462(recommended, but B<MUST> have 4 digits/component) colour specifications,
1463in addition to the ones provided by X, where the additional A component
1464specifies opacity (alpha) values. The minimum value of C<0> is completely
1465transparent). You can also prefix any color with C<[percent]>, where
1466C<percent> is a decimal percentage (0-100) that specifies the opacity of
1467the color, where C<0> is completely transparent and C<100> is completelxy
1468opaque.
1469
1470You probably need to specify B<"-depth 32">, too, and have the luck that
1471your X-server uses ARGB pixel layout, as X is far from just supporting
1472ARGB visuals out of the box, and rxvt-unicode just fudges around.
1473
1474For example, the following selects an almost completely transparent red
1475background, and an almost opaque pink foreground:
1476
1477 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1478
1479I<Please note that transparency of any kind if completely unsupported by
1480the author. Don't bug him with installation questions!>
1481
1204=head1 ENVIRONMENT 1482=head1 ENVIRONMENT
1205 1483
1206B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1484B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1207 1485
1208=over 4 1486=over 4
1209 1487
1210=item B<TERM> 1488=item B<TERM>
1211 1489
1212Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1490Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1213resources or on the commandline. 1491resources or on the command line.
1214 1492
1215=item B<COLORTERM> 1493=item B<COLORTERM>
1216 1494
1217Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1495Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1218compiled with XPM support, and optionally with the added extension 1496compiled with background image support, and optionally with the added
1219C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1497extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1498screen.
1220 1499
1221=item B<COLORFGBG> 1500=item B<COLORFGBG>
1222 1501
1223Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1502Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1224the colour code used as default foreground/text colour (or the string 1503the colour code used as default foreground/text colour (or the string
1225C<default> to indicate that the default-colour escape sequence is to be 1504C<default> to indicate that the default-colour escape sequence is to be
1226used), C<bg> is the colour code used as default background colour (or the 1505used), C<bg> is the colour code used as default background colour (or the
1227string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1506string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1228was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1507was compiled with background image support. Libraries like C<ncurses>
1229(and do) use this information to optimize screen output. 1508and C<slang> can (and do) use this information to optimize screen output.
1230 1509
1231=item B<WINDOWID> 1510=item B<WINDOWID>
1232 1511
1233Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1512Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1234window, which usually has subwindows for the scrollbar, the terminal 1513window, which usually has subwindows for the scrollbar, the terminal
1240C<--with-terminfo=PATH>. 1519C<--with-terminfo=PATH>.
1241 1520
1242=item B<DISPLAY> 1521=item B<DISPLAY>
1243 1522
1244Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1523Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1245display in it's child processes. 1524display in its child processes.
1246 1525
1247=item B<SHELL> 1526=item B<SHELL>
1248 1527
1249The shell to be used for command execution, defaults to C</bin/sh>. 1528The shell to be used for command execution, defaults to C</bin/sh>.
1250
1251=item B<RXVTPATH>
1252
1253The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1254files.
1255
1256=item B<PATH>
1257
1258Used in the same way as C<RXVTPATH>.
1259 1529
1260=item B<RXVT_SOCKET> 1530=item B<RXVT_SOCKET>
1261 1531
1262The unix domain socket path used by @@RXVT_NAME@@c(1) and 1532The unix domain socket path used by @@RXVT_NAME@@c(1) and
1263@@RXVT_NAME@@d(1). 1533@@RXVT_NAME@@d(1).
1293 1563
1294=head1 SEE ALSO 1564=head1 SEE ALSO
1295 1565
1296@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1566@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1297 1567
1298=head1 BUGS
1299
1300Check the BUGS file for an up-to-date list.
1301
1302Cursor change support is not yet implemented.
1303
1304Click-and-drag doesn't work with X11 mouse report overriding.
1305
1306=head1 CURRENT PROJECT COORDINATOR 1568=head1 CURRENT PROJECT COORDINATOR
1307 1569
1308=over 4 1570=over 4
1309 1571
1310=item Project Coordinator 1572=item Project Coordinator
1311 1573
1312Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1574Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1313 1575
1314L<http://software.schmorp.de/#rxvt-unicode> 1576L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1315 1577
1316=back 1578=back
1317 1579
1318=head1 AUTHORS 1580=head1 AUTHORS
1319 1581
1341 1603
1342Project Coordinator (changes.txt 2.21a to 2.4.5) 1604Project Coordinator (changes.txt 2.21a to 2.4.5)
1343 1605
1344=item Geoff Wing L<< <gcw@pobox.com> >> 1606=item Geoff Wing L<< <gcw@pobox.com> >>
1345 1607
1346Rewrote screen display and text selection routines. Project Coordinator 1608Rewrote screen display and text selection routines.
1609
1347(changes.txt 2.4.6 - rxvt-unicode) 1610Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1348 1611
1349=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1612=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1350 1613
1351Forked rxvt-unicode, rewrote most of the display code and internal 1614Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1352character handling to store text in unicode, improve xterm 1615extension, random hacks, numerous bugfixes and extensions.
1353compatibility and apply numerous other bugfixes and extensions.
1354 1616
1355Project Coordinator (Changes 1.0 -) 1617Project Coordinator (Changes 1.0 -)
1356 1618
1619=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1620
1621Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1622
1357=back 1623=back
1358 1624

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines