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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines