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.67 by root, Thu Jul 7 19:37:46 2005 UTC vs.
Revision 1.238 by sf-exg, Sat Oct 11 22:02:50 2014 UTC

12emulator intended as an I<xterm>(1) replacement for users who do not 12emulator intended as an I<xterm>(1) replacement for users who do not
13require features such as Tektronix 4014 emulation and toolkit-style 13require features such as Tektronix 4014 emulation and toolkit-style
14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16 16
17This document is also available on the World-Wide-Web at
18L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
19
17=head1 FREQUENTLY ASKED QUESTIONS 20=head1 FREQUENTLY ASKED QUESTIONS
18 21
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 22See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 23frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 24problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23 26
24=head1 RXVT-UNICODE VS. RXVT 27=head1 RXVT-UNICODE VS. RXVT
25 28
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 29Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 30internally. That means it can store and display most scripts in the
28world. Being a terminal emulator, however, some things are very difficult, 31world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts 32especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules, 33like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. Don't expect pretty output when using these 34like tibetan or devanagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 35scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are left-to-right scripts, such 36fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 37as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 38belong in the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 39such as cursor-movement while editing -- break otherwise), but that might
37change. 40change.
38 41
39If you are looking for a terminal that supports more exotic scripts, let 42If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very userfriendly, lean and clean 43me recommend C<mlterm>, which is a very user friendly, lean and clean
41terminal emulator. In fact, the reason rxvt-unicode was born was solely 44terminal emulator. In fact, the reason rxvt-unicode was born was solely
42because the author couldn't get C<mlterm> to use one font for latin1 and 45because the author couldn't get C<mlterm> to use one font for latin1 and
43another for japanese. 46another for japanese.
44 47
45Therefore another design rationale was the use of multiple fonts to 48Therefore another design rationale was the use of multiple fonts to
46display characters: The idea of a single unicode font which many other 49display characters: The idea of a single unicode font which many other
47programs force onto it's users never made sense to me: You should be able 50programs force onto its users never made sense to me: You should be able
48to choose any font for any script freely. 51to choose any font for any script freely.
49 52
50Apart from that, rxvt-unicode is also much better internationalised than 53Apart from that, rxvt-unicode is also much better internationalised than
51it's predecessor, supports things such as XFT and ISO 14755 that are handy 54its predecessor, supports things such as XFT and ISO 14755 that are handy
52in i18n-environments, is faster, and has a lot less bugs than the original 55in i18n-environments, is faster, and has a lot bugs less than the original
53rxvt. This all in addition to dozens of other small improvements. 56rxvt. This all in addition to dozens of other small improvements.
54 57
55It is still faithfully following the original rxvt idea of being lean 58It is still faithfully following the original rxvt idea of being lean
56and nice on resources: for example, you can still configure rxvt-unicode 59and nice on resources: for example, you can still configure rxvt-unicode
57without most of it's features to get a lean binary. It also comes with 60without most of its features to get a lean binary. It also comes with
58a client/daemon pair that lets you open any number of terminal windows 61a client/daemon pair that lets you open any number of terminal windows
59from within a single process, which makes startup time very fast and 62from within a single process, which makes startup time very fast and
60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 63drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61@@RXVT_NAME@@c(1) (client). 64@@RXVT_NAME@@c(1) (client).
62 65
63It also makes technical information about escape sequences (which have 66It also makes technical information about escape sequences (which have
64been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 67been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65reference documentation (escape sequences etc.). 68reference documentation (escape sequences etc.).
66 69
67=head1 OPTIONS 70=head1 OPTIONS
68 71
69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed 72The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
89 92
90Print out a message describing available options. 93Print out a message describing available options.
91 94
92=item B<-display> I<displayname> 95=item B<-display> I<displayname>
93 96
94Attempt to open a window on the named X display (B<-d> still 97Attempt to open a window on the named X display (the older form B<-d>
95respected). In the absence of this option, the display specified by the 98is still respected. but deprecated). In the absence of this option, the
96B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
100
101=item B<-depth> I<bitdepth>
102
103Compile I<frills>: 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
111=item B<-visual> I<visualID>
112
113Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible
114visual ids).
97 115
98=item B<-geometry> I<geom> 116=item B<-geometry> I<geom>
99 117
100Window geometry (B<-g> still respected); resource B<geometry>. 118Window geometry (B<-g> still respected); resource B<geometry>.
101 119
103 121
104Turn on/off simulated reverse video; resource B<reverseVideo>. 122Turn on/off simulated reverse video; resource B<reverseVideo>.
105 123
106=item B<-j>|B<+j> 124=item B<-j>|B<+j>
107 125
108Turn on/off jump scrolling; resource B<jumpScroll>. 126Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109 127
110=item B<-ip>|B<+ip> 128=item B<-ss>|B<+ss>
111 129
112Turn on/off inheriting parent window's pixmap. Alternative form is 130Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
113B<-tr>; resource B<inheritPixmap>.
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. resource B<fading>. 134Fade the text by the given percentage when focus is lost. Small values
135fade a little only, 100 completely replaces all colours by the fade
136colour; resource B<fading>.
118 137
119=item B<-tint> I<colour> 138=item B<-fadecolor> I<colour>
120 139
121Tint the transparent background pixmap with the given colour when 140Fade to this colour when fading is used (see B<-fade>). The default colour
122transparency is enabled with B<-tr> or B<-ip>. See also the B<-sh> 141is opaque black. resource B<fadeColor>.
123option that can be used to brighten or darken the image in addition to
124tinting it.
125 142
126=item B<-sh> 143=item B<-icon> I<file>
127 144
128I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 145Compile I<pixbuf>: Use the specified image as application icon. This
129background image in addition to tinting it (i.e. B<-tint> must be 146is used by many window managers, taskbars and pagers to represent the
130specified, too, e.g. C<-tint white>). 147application window; resource I<iconFile>.
131 148
132=item B<-bg> I<colour> 149=item B<-bg> I<colour>
133 150
134Window background colour; resource B<background>. 151Window background colour; resource B<background>.
135 152
136=item B<-fg> I<colour> 153=item B<-fg> I<colour>
137 154
138Window foreground colour; resource B<foreground>. 155Window foreground colour; resource B<foreground>.
139
140=item B<-pixmap> I<file[;geom]>
141
142Compile I<XPM>: Specify XPM file for the background and also optionally
143specify its scaling with a geometry string. Note you may need to
144add quotes to avoid special shell interpretation of the C<;> in the
145command-line; resource B<backgroundPixmap>.
146 156
147=item B<-cr> I<colour> 157=item B<-cr> I<colour>
148 158
149The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
150 160
162resource B<borderColor>. 172resource B<borderColor>.
163 173
164=item B<-fn> I<fontlist> 174=item B<-fn> I<fontlist>
165 175
166Select the fonts to be used. This is a comma separated list of font names 176Select the fonts to be used. This is a comma separated list of font names
167that are used in turn when trying to display Unicode characters. The 177that are checked in order when trying to find glyphs for characters. The
168first font defines the cell size for characters; other fonts might be 178first font defines the cell size for characters; other fonts might be
169smaller, but not (in general) larger. A (hopefully) reasonable default 179smaller, but not (in general) larger. A (hopefully) reasonable default
170font list is always appended to it. See resource B<font> for more details. 180font list is always appended to it. See resource B<font> for more details.
171 181
172In short, to specify an X11 core font, just specify it's name or prefix it 182In short, to specify an X11 core font, just specify its name or prefix it
173with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>, 183with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
174e.g.: 184e.g.:
175 185
176 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
177 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
179See also the question "How does rxvt-unicode choose fonts?" in the FAQ 189See also the question "How does rxvt-unicode choose fonts?" in the FAQ
180section of @@RXVT_NAME@@(7). 190section of @@RXVT_NAME@@(7).
181 191
182=item B<-fb> I<fontlist> 192=item B<-fb> I<fontlist>
183 193
184Compile font-styles: The bold font list to use when bold characters are to 194Compile I<font-styles>: The bold font list to use when B<bold> characters
185be printed. See resource B<boldFont> for details. 195are to be printed. See resource B<boldFont> for details.
186 196
187=item B<-fi> I<fontlist> 197=item B<-fi> I<fontlist>
188 198
189Compile font-styles: The italic font list to use when bold characters are to 199Compile I<font-styles>: The italic font list to use when I<italic>
190be printed. See resource B<italicFont> for details. 200characters are to be printed. See resource B<italicFont> for details.
191 201
192=item B<-fbi> I<fontlist> 202=item B<-fbi> I<fontlist>
193 203
194Compile font-styles: The bold italic font list to use when bold characters are to 204Compile I<font-styles>: The bold italic font list to use when B<< I<bold
195be printed. See resource B<boldItalicFont> for details. 205italic> >> characters are to be printed. See resource B<boldItalicFont>
206for details.
207
208=item B<-is>|B<+is>
209
210Compile I<font-styles>: Bold/Blink font styles imply high intensity
211foreground/background (default). See resource B<intensityStyles> for
212details.
196 213
197=item B<-name> I<name> 214=item B<-name> I<name>
198 215
199Specify the application name under which resources are to be obtained, 216Specify the application name under which resources are to be obtained,
200rather than the default executable file name. Name should not contain 217rather than the default executable file name. Name should not contain
202 219
203=item B<-ls>|B<+ls> 220=item B<-ls>|B<+ls>
204 221
205Start as a login-shell/sub-shell; resource B<loginShell>. 222Start as a login-shell/sub-shell; resource B<loginShell>.
206 223
224=item B<-mc> I<milliseconds>
225
226Specify the maximum time between multi-click selections.
227
207=item B<-ut>|B<+ut> 228=item B<-ut>|B<+ut>
208 229
209Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 230Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
210B<utmpInhibit>. 231B<utmpInhibit>.
211 232
215B<visualBell>. 236B<visualBell>.
216 237
217=item B<-sb>|B<+sb> 238=item B<-sb>|B<+sb>
218 239
219Turn on/off scrollbar; resource B<scrollBar>. 240Turn on/off scrollbar; resource B<scrollBar>.
241
242=item B<-sr>|B<+sr>
243
244Put scrollbar on right/left; resource B<scrollBar_right>.
245
246=item B<-st>|B<+st>
247
248Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
249resource B<scrollBar_floating>.
220 250
221=item B<-si>|B<+si> 251=item B<-si>|B<+si>
222 252
223Turn on/off scroll-to-bottom on TTY output inhibit; resource 253Turn on/off scroll-to-bottom on TTY output inhibit; resource
224B<scrollTtyOutput> has opposite effect. 254B<scrollTtyOutput> has opposite effect.
231=item B<-sw>|B<+sw> 261=item B<-sw>|B<+sw>
232 262
233Turn on/off scrolling with the scrollback buffer as new lines appear. 263Turn on/off scrolling with the scrollback buffer as new lines appear.
234This only takes effect if B<-si> is also given; resource 264This only takes effect if B<-si> is also given; resource
235B<scrollWithBuffer>. 265B<scrollWithBuffer>.
236
237=item B<-sr>|B<+sr>
238
239Put scrollbar on right/left; resource B<scrollBar_right>.
240
241=item B<-st>|B<+st>
242
243Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
244resource B<scrollBar_floating>.
245 266
246=item B<-ptab>|B<+ptab> 267=item B<-ptab>|B<+ptab>
247 268
248If enabled (default), "Horizontal Tab" characters are being stored as 269If enabled (default), "Horizontal Tab" characters are being stored as
249actual wide characters in the screen buffer, which makes it possible to 270actual wide characters in the screen buffer, which makes it possible to
253 274
254=item B<-bc>|B<+bc> 275=item B<-bc>|B<+bc>
255 276
256Blink the cursor; resource B<cursorBlink>. 277Blink the cursor; resource B<cursorBlink>.
257 278
279=item B<-uc>|B<+uc>
280
281Make the cursor underlined; resource B<cursorUnderline>.
282
258=item B<-iconic> 283=item B<-iconic>
259 284
260Start iconified, if the window manager supports that option. 285Start iconified, if the window manager supports that option.
261Alternative form is B<-ic>. 286Alternative form is B<-ic>.
262 287
278 303
279=item B<-bl> 304=item B<-bl>
280 305
281Compile I<frills>: Set MWM hints to request a borderless window, i.e. 306Compile I<frills>: Set MWM hints to request a borderless window, i.e.
282if honoured by the WM, the rxvt-unicode window will not have window 307if honoured by the WM, the rxvt-unicode window will not have window
283decorations; resource B<borderLess>. 308decorations; resource B<borderLess>. If the window manager does not
309support MWM hints (e.g. kwin), enables override-redirect mode.
310
311=item B<-override-redirect>
312
313Compile I<frills>: Sets override-redirect on the window; resource
314B<override-redirect>.
315
316=item B<-dockapp>
317
318Sets the initial state of the window to WithdrawnState, which makes
319window managers that support this extension treat it as a dockapp.
320
321=item B<-sbg>
322
323Compile I<frills>: Disable the usage of the built-in block graphics/line
324drawing characters and just rely on what the specified fonts provide. Use
325this if you have a good font and want to use its block graphic glyphs;
326resource B<skipBuiltinGlyphs>.
284 327
285=item B<-lsp> I<number> 328=item B<-lsp> I<number>
286 329
287Compile I<frills>: Lines (pixel height) to insert between each row of 330Compile I<frills>: Lines (pixel height) to insert between each row of
288the display. Useful to work around font rendering problems; resource 331the display. Useful to work around font rendering problems; resource
289B<linespace>. 332B<lineSpace>.
333
334=item B<-letsp> I<number>
335
336Compile I<frills>: Amount to adjust the computed character width by
337to control overall letter spacing. Negative values will tighten up the
338letter spacing, positive values will space letters out more. Useful to
339work around odd font metrics; resource B<letterSpace>.
290 340
291=item B<-tn> I<termname> 341=item B<-tn> I<termname>
292 342
293This option specifies the name of the terminal type to be set in the 343This option specifies the name of the terminal type to be set in the
294B<TERM> environment variable. This terminal type must exist in the 344B<TERM> environment variable. This terminal type must exist in the
303given on the command line. If this option is used, it must be the last 353given on the command line. If this option is used, it must be the last
304on the command-line. If there is no B<-e> option then the default is to 354on the command-line. If there is no B<-e> option then the default is to
305run the program specified by the B<SHELL> environment variable or, 355run the program specified by the B<SHELL> environment variable or,
306failing that, I<sh(1)>. 356failing that, I<sh(1)>.
307 357
358Please note that you must specify a program with arguments. If you want to
359run shell commands, you have to specify the shell, like this:
360
361 @@RXVT_NAME@@ -e sh -c "shell commands"
362
308=item B<-title> I<text> 363=item B<-title> I<text>
309 364
310Window title (B<-T> still respected); the default title is the basename 365Window title (B<-T> still respected); the default title is the basename
311of the program specified after the B<-e> option, if any, otherwise the 366of the program specified after the B<-e> option, if any, otherwise the
312application name; resource B<title>. 367application name; resource B<title>.
343for more info. 398for more info.
344 399
345=item B<-tcw> 400=item B<-tcw>
346 401
347Change the meaning of triple-click selection with the left mouse 402Change the meaning of triple-click selection with the left mouse
403button. Only effective when the original (non-perl) selection code is
348button. Instead of selecting a full line it will extend the selection the 404in-use. Instead of selecting a full line it will extend the selection to
349end of the logical line only. resource B<tripleclickwords>. 405the end of the logical line only. resource B<tripleclickwords>.
350 406
351=item B<-insecure> 407=item B<-insecure>
352 408
353Enable "insecure" mode, which currently enables most of the escape 409Enable "insecure" mode, which currently enables most of the escape
354sequences that echo strings. See the resource B<insecure> for more 410sequences that echo strings. See the resource B<insecure> for more
368=item B<-ssr>|B<+ssr> 424=item B<-ssr>|B<+ssr>
369 425
370Turn on/off secondary screen scroll (default enabled); resource 426Turn on/off secondary screen scroll (default enabled); resource
371B<secondaryScroll>. 427B<secondaryScroll>.
372 428
429=item B<-hold>|B<+hold>
430
431Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
432will not immediately destroy its window when the program executed within
433it exits. Instead, it will wait till it is being killed or closed by the
434user; resource B<hold>.
435
436=item B<-cd> I<path>
437
438Sets the working directory for the shell (or the command specified via
439B<-e>). The I<path> must be an absolute path and it must exist for
440@@RXVT_NAME@@ to start; resource B<chdir>.
441
442=item B<-xrm> I<string>
443
444Works like the X Toolkit option of the same name, by adding the I<string>
445as if it were specified in a resource file. Resource values specified this
446way take precedence over all other resource specifications.
447
448Note that you need to use the I<same> syntax as in the .Xdefaults file,
449e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
450options can be specified as long-options on the commandline, so use
451of B<-xrm> is mostly limited to cases where you want to specify other
452resources (e.g. for input methods) or for compatibility with other
453programs.
454
373=item B<-keysym.>I<sym> I<string> 455=item B<-keysym.>I<sym> I<string>
374 456
375Remap a key symbol. See resource B<keysym>. 457Remap a key symbol. See resource B<keysym>.
376 458
377=item B<-embed> I<windowid> 459=item B<-embed> I<windowid>
378 460
379Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 461Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
380which enables applications to easily embed a terminal. 462which enables applications to easily embed a terminal.
381 463
382Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 464Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
383shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 465shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
384quite a bit, so don't expect it to keep some specific state. It's best to 466quite a bit, so don't expect it to keep some specific state. It's best to
387The window will not be destroyed when @@RXVT_NAME@@ exits. 469The window will not be destroyed when @@RXVT_NAME@@ exits.
388 470
389It might be useful to know that @@RXVT_NAME@@ will not close file 471It might be useful to know that @@RXVT_NAME@@ will not close file
390descriptors passed to it (except for stdin/out/err, of course), so you 472descriptors passed to it (except for stdin/out/err, of course), so you
391can use file descriptors to communicate with the programs within the 473can use file descriptors to communicate with the programs within the
392terminal. This works regardless of wether the C<-embed> option was used or 474terminal. This works regardless of whether the C<-embed> option was used or
393not. 475not.
394 476
395Here is a short Gtk2-perl snippet that illustrates how this option can be 477Here is a short Gtk2-perl snippet that illustrates how this option can be
396used (a longer example is in F<doc/embed>): 478used (a longer example is in F<doc/embed>):
397 479
399 $rxvt->signal_connect_after (realize => sub { 481 $rxvt->signal_connect_after (realize => sub {
400 my $xid = $_[0]->window->get_xid; 482 my $xid = $_[0]->window->get_xid;
401 system "@@RXVT_NAME@@ -embed $xid &"; 483 system "@@RXVT_NAME@@ -embed $xid &";
402 }); 484 });
403 485
404=item B<-pty-fd> I<fileno> 486=item B<-pty-fd> I<file descriptor>
405 487
406Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 488Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
407pair but instead use the given filehandle as the tty master. This is 489pair but instead use the given file descriptor as the tty master. This is
408useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 490useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
409without having to run a program within it. 491without having to run a program within it.
410 492
411If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 493If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
412entries and will not tinker with pty/tty permissions - you have to do that 494entries and will not tinker with pty/tty permissions - you have to do that
413yourself if you want that. 495yourself if you want that.
496
497As an extremely special case, specifying C<-1> will completely suppress
498pty/tty operations, which is probably only useful in conjunction with some
499perl extension that manages the terminal.
414 500
415Here is a example in perl that illustrates how this option can be used (a 501Here is a example in perl that illustrates how this option can be used (a
416longer example is in F<doc/pty-fd>): 502longer example is in F<doc/pty-fd>):
417 503
418 use IO::Pty; 504 use IO::Pty;
425 511
426 # now communicate with rxvt 512 # now communicate with rxvt
427 my $slave = $pty->slave; 513 my $slave = $pty->slave;
428 while (<$slave>) { print $slave "got <$_>\n" } 514 while (<$slave>) { print $slave "got <$_>\n" }
429 515
516=item B<-pe> I<string>
517
518Comma-separated list of perl extension scripts to use (or not to use) in
519this terminal instance. See resource B<perl-ext> for details.
520
430=back 521=back
431 522
432=head1 RESOURCES (available also as long-options) 523=head1 RESOURCES
433 524
434Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 525Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
435options) compiled into your version. 526options) compiled into your version. All resources are also available as
527long-options.
436 528
437There are two different methods that @@RXVT_NAME@@ can use to get the 529You can set and change the resources using X11 tools like B<xrdb>. Many
438Xresource data: using the X libraries (Xrm*-functions) or internal 530distribution do also load settings from the B<~/.Xresources> file when X
439Xresources reader (B<~/.Xdefaults>). For the first method (ie. 531starts. @@RXVT_NAME@@ will consult the following files/resources in order,
440B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 532with later settings overwriting earlier ones:
441resources using X11 tools like B<xrdb>. Many distribution do also load
442settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
443will consult the following files/resources in order, with later settings
444overwriting earlier ones:
445 533
446 1. system-wide app-defaults file, either locale-dependent OR global
447 2. app-defaults file in $XAPPLRESDIR 534 1. app-defaults file in $XAPPLRESDIR
535 2. $HOME/.Xdefaults
448 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 536 3. RESOURCE_MANAGER property on root-window of screen 0
449 4. SCREEN_RESOURCES for the current screen 537 4. SCREEN_RESOURCES property on root-window of the current screen
450 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 538 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
539 6. resources specified via -xrm on the commandline
451 540
452If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
453lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
454set in XAPPLOADDIR/URxvt (compile-time defined: usually
455B</usr/lib/X11/app-defaults/URxvt>) and resources set in
456B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
457Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 541Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
458class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 542names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
459resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 543common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
460easily configured, while the class name B<URxvt> allows resources 544configured, while the class name B<URxvt> allows resources unique to
461unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 545B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
462shared between different B<@@RXVT_NAME@@> configurations. If no 546configurations. If no resources are specified, suitable defaults will
463resources are specified, suitable defaults will be used. Command-line 547be used. Command-line arguments can be used to override resource
464arguments can be used to override resource settings. The following 548settings. The following resources are supported (you might want to
465resources are allowed: 549check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
550extensions not documented here):
466 551
467=over 4 552=over 4
553
554=item B<depth:> I<bitdepth>
555
556Compile I<xft>: Attempt to find a visual with the given bit depth;
557option B<-depth>.
558
559=item B<buffered:> I<boolean>
560
561Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
562On some card/driver combination enabling it slightly decreases
563performance, on most it greatly helps it. The slowdown is small, so it
564should normally be enabled.
468 565
469=item B<geometry:> I<geom> 566=item B<geometry:> I<geom>
470 567
471Create the window with the specified X window geometry [default 80x24]; 568Create the window with the specified X window geometry [default 80x24];
472option B<-geometry>. 569option B<-geometry>.
486Use the specified colour for the colour value I<n>, where 0-7 583Use the specified colour for the colour value I<n>, where 0-7
487corresponds to low-intensity (normal) colours and 8-15 corresponds to 584corresponds to low-intensity (normal) colours and 8-15 corresponds to
488high-intensity (bold = bright foreground, blink = bright background) 585high-intensity (bold = bright foreground, blink = bright background)
489colours. The canonical names are as follows: 0=black, 1=red, 2=green, 586colours. The canonical names are as follows: 0=black, 1=red, 2=green,
4903=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 5873=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
491names used are listed in the B<COLORS AND GRAPHICS> section. 588names used are listed in the B<COLOURS AND GRAPHICS> section.
492 589
493Colours higher than 15 cannot be set using resources (yet), but can be 590Colours higher than 15 cannot be set using resources (yet), but can be
494changed using an escape command (see @@RXVT_NAME@@(7)). 591changed using an escape command (see @@RXVT_NAME@@(7)).
495 592
496Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 593Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
507=item B<colorUL:> I<colour> 604=item B<colorUL:> I<colour>
508 605
509Use the specified colour to display underlined characters when the 606Use the specified colour to display underlined characters when the
510foreground colour is the default. 607foreground colour is the default.
511 608
512=item B<colorRV:> I<colour>
513
514Use the specified colour as the background for reverse video
515characters.
516
517=item B<underlineColor:> I<colour> 609=item B<underlineColor:> I<colour>
518 610
519If set, use the specified colour as the colour for the underline 611If set, use the specified colour as the colour for the underline
520itself. If unset, use the foreground colour. 612itself. If unset, use the foreground colour.
613
614=item B<highlightColor:> I<colour>
615
616If set, use the specified colour as the background for highlighted
617characters. If unset, use reverse video.
618
619=item B<highlightTextColor:> I<colour>
620
621If set and highlightColor is set, use the specified colour as the
622foreground for highlighted characters.
521 623
522=item B<cursorColor:> I<colour> 624=item B<cursorColor:> I<colour>
523 625
524Use the specified colour for the cursor. The default is to use the 626Use the specified colour for the cursor. The default is to use the
525foreground colour; option B<-cr>. 627foreground colour; option B<-cr>.
532 634
533=item B<reverseVideo:> I<boolean> 635=item B<reverseVideo:> I<boolean>
534 636
535B<True>: simulate reverse video by foreground and background colours; 637B<True>: simulate reverse video by foreground and background colours;
536option B<-rv>. B<False>: regular screen colours [default]; option 638option B<-rv>. B<False>: regular screen colours [default]; option
537B<+rv>. See note in B<COLORS AND GRAPHICS> section. 639B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
538 640
539=item B<jumpScroll:> I<boolean> 641=item B<jumpScroll:> I<boolean>
540 642
541B<True>: specify that jump scrolling should be used. When scrolling 643B<True>: specify that jump scrolling should be used. When receiving lots
542quickly, fewer screen updates are performed [default]; option B<-j>. 644of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
645has been read, resulting in fewer updates while still displaying every
646received line; option B<-j>.
647
543B<False>: specify that smooth scrolling should be used; option B<+j>. 648B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
649force a screen refresh on each new line it received; option B<+j>.
544 650
545=item B<inheritPixmap:> I<boolean> 651=item B<skipScroll:> I<boolean>
546 652
547B<True>: make the background inherit the parent windows' pixmap, giving 653B<True>: (the default) specify that skip scrolling should be used. When
548artificial transparency. B<False>: do not inherit the parent windows' 654receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
549pixmap. 655(around 60 times per second), resulting in far fewer updates. This can
656result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
657option B<-ss>.
658
659B<False>: specify that everything is to be displayed, even
660if the refresh is too fast for the human eye to read anything (or the
661monitor to display anything); option B<+ss>.
550 662
551=item B<fading:> I<number> 663=item B<fading:> I<number>
552 664
553Fade the text by the given percentage when focus is lost. 665Fade the text by the given percentage when focus is lost; option B<-fade>.
554 666
555=item B<tintColor:> I<colour> 667=item B<fadeColor:> I<colour>
556 668
557Tint the transparent background pixmap with the given colour. 669Fade to this colour, when fading is used (see B<fading:>). The default
670colour is black; option B<-fadecolor>.
558 671
559=item B<shading:> I<number> 672=item B<iconFile:> I<file>
560 673
561Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 674Set the application icon pixmap; option B<-icon>.
562image in addition to tinting it.
563 675
564=item B<scrollColor:> I<colour> 676=item B<scrollColor:> I<colour>
565 677
566Use the specified colour for the scrollbar [default #B2B2B2]. 678Use the specified colour for the scrollbar [default #B2B2B2].
567 679
573=item B<borderColor:> I<colour> 685=item B<borderColor:> I<colour>
574 686
575The colour of the border around the text area and between the scrollbar 687The colour of the border around the text area and between the scrollbar
576and the text. 688and the text.
577 689
578=item B<backgroundPixmap:> I<file[;geom]>
579
580Use the specified XPM file (note the `.xpm' extension is optional) for
581the background and also optionally specify its scaling with a geometry
582string B<WxH+X+Y>, in which B<"W" / "H"> specify the
583horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image
584centre (percent). A scale of 0 displays the image with tiling. A scale
585of 1 displays the image without any scaling. A scale of 2 to 9
586specifies an integer number of images in that direction. No image will
587be magnified beyond 10 times its original size. The maximum permitted
588scale is 1000. [default 0x0+50+50]
589
590=item B<menu:> I<file[;tag]>
591
592Read in the specified menu file (note the `.menu' extension is
593optional) and also optionally specify a starting tag to find. See the
594reference documentation for details on the syntax for the menuBar.
595
596=item B<path:> I<path>
597
598Specify the colon-delimited search path for finding files (XPM and
599menus), in addition to the paths specified by the B<RXVTPATH> and
600B<PATH> environment variables.
601
602=item B<font:> I<fontlist> 690=item B<font:> I<fontlist>
603 691
604Select the fonts to be used. This is a comma separated list of font 692Select the fonts to be used. This is a comma separated list of font names
605names that are used in turn when trying to display Unicode characters. 693that are checked in order when trying to find glyphs for characters. The
606The first font defines the cell size for characters; other fonts might 694first font defines the cell size for characters; other fonts might be
607be smaller, but not larger. A reasonable default font list is always 695smaller, but not (in general) larger. A (hopefully) reasonable default
608appended to it. option B<-fn>. 696font list is always appended to it; option B<-fn>.
609 697
610Each font can either be a standard X11 core font (XLFD) name, with 698Each font can either be a standard X11 core font (XLFD) name, with
611optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 699optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
612 700
613In addition, each font can be prefixed with additional hints and 701In addition, each font can be prefixed with additional hints and
615hint currently is C<codeset=codeset-name>, and this is only used for Xft 703hint currently is C<codeset=codeset-name>, and this is only used for Xft
616fonts. 704fonts.
617 705
618For example, this font resource 706For example, this font resource
619 707
620 URxvt*font: 9x15bold,\ 708 URxvt.font: 9x15bold,\
621 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 709 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
622 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 710 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
623 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 711 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
624 xft:Code2000:antialias=false 712 xft:Code2000:antialias=false
625 713
628it is named first) and thus defines the character cell grid to be 9 pixels 716it is named first) and thus defines the character cell grid to be 9 pixels
629wide and 15 pixels high. 717wide and 15 pixels high.
630 718
631The second font is just used to add additional unicode characters not in 719The second font is just used to add additional unicode characters not in
632the base font, likewise the third, which is unfortunately non-bold, but 720the base font, likewise the third, which is unfortunately non-bold, but
633the bold version of the font does contain less characters, so this is a 721the bold version of the font does contain fewer characters, so this is a
634useful supplement. 722useful supplement.
635 723
636The third font is an Xft font with aliasing turned off, and the characters 724The third font is an Xft font with aliasing turned off, and the characters
637are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 725are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
638contains other characters, but we are not interested in them. 726contains other characters, but we are not interested in them.
659not possible, replacement fonts of the desired shape will be tried. 747not possible, replacement fonts of the desired shape will be tried.
660 748
661If set, but empty, then this specific style is disabled and the normal 749If set, but empty, then this specific style is disabled and the normal
662text font will being used for the given style. 750text font will being used for the given style.
663 751
664=item B<selectstyle:> I<mode> 752=item B<intensityStyles:> I<boolean>
665 753
666Set mouse selection style to B<old> which is 2.20, B<oldword> which is 754When font styles are not enabled, or this option is enabled (B<True>,
667xterm style with 2.20 old word selection, or anything else which gives 755option B<-is>, the default), bold/blink font styles imply high
668xterm style selection. 756intensity foreground/background colours. Disabling this option (B<False>,
669 757option B<+is>) disables this behaviour, the high intensity colours are not
670=item B<scrollstyle:> I<mode> 758reachable.
671
672Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
673the author's favourite.
674 759
675=item B<title:> I<string> 760=item B<title:> I<string>
676 761
677Set window title string, the default title is the command-line 762Set window title string, the default title is the command-line
678specified after the B<-e> option, if any, otherwise the application 763specified after the B<-e> option, if any, otherwise the application
687=item B<mapAlert:> I<boolean> 772=item B<mapAlert:> I<boolean>
688 773
689B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 774B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
690de-iconify (map) on receipt of a bell character [default]. 775de-iconify (map) on receipt of a bell character [default].
691 776
777=item B<urgentOnBell:> I<boolean>
778
779B<True>: set the urgency hint for the wm on receipt of a bell character.
780B<False>: do not set the urgency hint [default].
781
782@@RXVT_NAME@@ resets the urgency hint on every focus change.
783
692=item B<visualBell:> I<boolean> 784=item B<visualBell:> I<boolean>
693 785
694B<True>: use visual bell on receipt of a bell character; option B<-vb>. 786B<True>: use visual bell on receipt of a bell character; option B<-vb>.
695B<False>: no visual bell [default]; option B<+vb>. 787B<False>: no visual bell [default]; option B<+vb>.
696 788
698 790
699B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 791B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
700the shell; option B<-ls>. B<False>: start as a normal sub-shell 792the shell; option B<-ls>. B<False>: start as a normal sub-shell
701[default]; option B<+ls>. 793[default]; option B<+ls>.
702 794
795=item B<multiClickTime:> I<number>
796
797Specify the maximum time in milliseconds between multi-click select
798events. The default is 500 milliseconds; option B<-mc>.
799
703=item B<utmpInhibit:> I<boolean> 800=item B<utmpInhibit:> I<boolean>
704 801
705B<True>: inhibit writing record into the system log file B<utmp>; 802B<True>: inhibit writing record into the system log file B<utmp>;
706option B<-ut>. B<False>: write record into the system log file B<utmp> 803option B<-ut>. B<False>: write record into the system log file B<utmp>
707[default]; option B<+ut>. 804[default]; option B<+ut>.
714 811
715The string will be interpreted as if typed into the shell as-is. 812The string will be interpreted as if typed into the shell as-is.
716 813
717Example: 814Example:
718 815
719 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 816 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
720 817
721This creates a new file in your home directory with the screen contents 818This creates a new file in your home directory with the screen contents
722everytime you hit C<Print>. 819every time you hit C<Print>.
820
821=item B<scrollstyle:> I<mode>
822
823Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
824the author's favourite.
825
826=item B<thickness:> I<number>
827
828Set the scrollbar width in pixels.
723 829
724=item B<scrollBar:> I<boolean> 830=item B<scrollBar:> I<boolean>
725 831
726B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 832B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
727disable the scrollbar; option B<+sb>. 833disable the scrollbar; option B<+sb>.
747B<False>: do not scroll to bottom when tty receives output; option 853B<False>: do not scroll to bottom when tty receives output; option
748B<+si>. 854B<+si>.
749 855
750=item B<scrollWithBuffer:> I<boolean> 856=item B<scrollWithBuffer:> I<boolean>
751 857
752B<True>: scroll with scrollback buffer when tty receives new lines (and 858B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
753B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 859try to show the same lines) and B<scrollTtyOutput> is False; option
754with scrollback buffer when tty recieves new lines; option B<+sw>. 860B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
861new lines; option B<+sw>.
755 862
756=item B<scrollTtyKeypress:> I<boolean> 863=item B<scrollTtyKeypress:> I<boolean>
757 864
758B<True>: scroll to bottom when a non-special key is pressed. Special keys 865B<True>: scroll to bottom when a non-special key is pressed. Special keys
759are those which are intercepted by rxvt-unicode for special handling and 866are those which are intercepted by rxvt-unicode for special handling and
778=item B<borderLess:> I<boolean> 885=item B<borderLess:> I<boolean>
779 886
780Set MWM hints to request a borderless window, i.e. if honoured by the 887Set MWM hints to request a borderless window, i.e. if honoured by the
781WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 888WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
782 889
890=item B<skipBuiltinGlyphs:> I<boolean>
891
892Compile I<frills>: Disable the usage of the built-in block graphics/line
893drawing characters and just rely on what the specified fonts provide. Use
894this if you have a good font and want to use its block graphic glyphs;
895option B<-sbg>.
896
783=item B<termName:> I<termname> 897=item B<termName:> I<termname>
784 898
785Specifies the terminal type name to be set in the B<TERM> environment 899Specifies the terminal type name to be set in the B<TERM> environment
786variable; option B<-tn>. 900variable; option B<-tn>.
787 901
788=item B<linespace:> I<number> 902=item B<lineSpace:> I<number>
789 903
790Specifies number of lines (pixel height) to insert between each row of 904Specifies number of lines (pixel height) to insert between each row of
791the display [default 0]; option B<-lsp>. 905the display [default 0]; option B<-lsp>.
792 906
793=item B<meta8:> I<boolean> 907=item B<meta8:> I<boolean>
807 921
808=item B<cursorBlink:> I<boolean> 922=item B<cursorBlink:> I<boolean>
809 923
810B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 924B<True>: blink the cursor. B<False>: do not blink the cursor [default];
811option B<-bc>. 925option B<-bc>.
926
927=item B<cursorUnderline:> I<boolean>
928
929B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
930option B<-uc>.
812 931
813=item B<pointerBlank:> I<boolean> 932=item B<pointerBlank:> I<boolean>
814 933
815B<True>: blank the pointer when a key is pressed or after a set number 934B<True>: blank the pointer when a key is pressed or after a set number
816of seconds of inactivity. B<False>: the pointer is always visible 935of seconds of inactivity. B<False>: the pointer is always visible
830large number (e.g. C<987654321>) to effectively disable the timeout. 949large number (e.g. C<987654321>) to effectively disable the timeout.
831 950
832=item B<backspacekey:> I<string> 951=item B<backspacekey:> I<string>
833 952
834The string to send when the backspace key is pressed. If set to B<DEC> 953The string to send when the backspace key is pressed. If set to B<DEC>
835or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 954or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
836(code 8) - which can be reversed with the appropriate DEC private mode 955(code 8) - which can be reversed with the appropriate DEC private mode
837escape sequence. 956escape sequence.
838 957
839=item B<deletekey:> I<string> 958=item B<deletekey:> I<string>
840 959
842pressed. If unset it will send the sequence traditionally associated 961pressed. If unset it will send the sequence traditionally associated
843with the B<Execute> key. 962with the B<Execute> key.
844 963
845=item B<cutchars:> I<string> 964=item B<cutchars:> I<string>
846 965
847The characters used as delimiters for double-click word selection. The 966The characters used as delimiters for double-click word selection
848built-in default: 967(whitespace delimiting is added automatically if resource is given).
849 968
969When the perl selection extension is in use (the default if compiled
970in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
971characters will be created (if the resource exists, otherwise, no regex
972will be created). In this mode, characters outside ISO-8859-1 can be used.
973
974When the selection extension is not used, only ISO-8859-1 characters can
975be used. If not specified, the built-in default is used:
976
850B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 977B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
851 978
852=item B<preeditType:> I<style> 979=item B<preeditType:> I<style>
853 980
854B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 981B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
855 982
860=item B<imLocale:> I<name> 987=item B<imLocale:> I<name>
861 988
862The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 989The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
863C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the 990C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
864input extension to be able to input japanese characters while staying in 991input extension to be able to input japanese characters while staying in
865another locale. option B<-imlocale>. 992another locale; option B<-imlocale>.
866 993
867=item B<imFont:> I<fontset> 994=item B<imFont:> I<fontset>
868 995
869Specify the font-set used for XIM styles C<OverTheSpot> or 996Specify the font-set used for XIM styles C<OverTheSpot> or
870C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 997C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
875 1002
876=item B<tripleclickwords:> I<boolean> 1003=item B<tripleclickwords:> I<boolean>
877 1004
878Change the meaning of triple-click selection with the left mouse 1005Change the meaning of triple-click selection with the left mouse
879button. Instead of selecting a full line it will extend the selection to 1006button. Instead of selecting a full line it will extend the selection to
880the end of the logical line only. option B<-tcw>. 1007the end of the logical line only; option B<-tcw>.
881 1008
882=item B<insecure:> I<boolean> 1009=item B<insecure:> I<boolean>
883 1010
884Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1011Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
885echo arbitrary strings like the icon name or the locale. This could be 1012echo arbitrary strings like the icon name or the locale. This could be
886abused if somebody gets 8-bit-clean access to your display, whether 1013abused if somebody gets 8-bit-clean access to your display, whether
887throuh a mail client displaying mail bodies unfiltered or though 1014through a mail client displaying mail bodies unfiltered or through
888write(1). Therefore, these sequences are disabled by default. (Note 1015write(1) or any other means. Therefore, these sequences are disabled by
889that other terminals, including xterm, have these sequences 1016default. (Note that many other terminals, including xterm, have these
890enabled by default). You can enable them by setting this boolean 1017sequences enabled by default, which doesn't make it safer, though).
891resource or specifying B<-insecure> as an option. At the moment, this 1018
892enabled display-answer, locale, findfont, icon label and window title 1019You can enable them by setting this boolean resource or specifying
893requests as well as dynamic menubar dispatch. 1020B<-insecure> as an option. At the moment, this enables display-answer,
1021locale, findfont, icon label and window title requests.
894 1022
895=item B<modifier:> I<modifier> 1023=item B<modifier:> I<modifier>
896 1024
897Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 1025Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
898B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 1026B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
902 1030
903Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1031Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
904character is passed through. It may contain escape values as described 1032character is passed through. It may contain escape values as described
905in the entry on B<keysym> following. 1033in the entry on B<keysym> following.
906 1034
907=item B<secondaryScreen:> I<bool> 1035=item B<secondaryScreen:> I<boolean>
908 1036
909Turn on/off secondary screen (default enabled). 1037Turn on/off secondary screen (default enabled).
910 1038
911=item B<secondaryScroll:> I<bool> 1039=item B<secondaryScroll:> I<boolean>
912 1040
913Turn on/off secondary screen scroll (default enabled). If the this 1041Turn on/off secondary screen scroll (default enabled). If this
914option is enabled, scrolls on the secondary screen will change the 1042option is enabled, scrolls on the secondary screen will change the
915scrollback buffer and switching to/from the secondary screen will 1043scrollback buffer and, when secondaryScreen is off, switching
916instead scroll the screen up. 1044to/from the secondary screen will instead scroll the screen up.
917 1045
1046=item B<hold>: I<boolean>
1047
1048Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1049will not immediately destroy its window when the program executed within
1050it exits. Instead, it will wait till it is being killed or closed by the
1051user.
1052
1053=item B<chdir>: I<path>
1054
1055Sets the working directory for the shell (or the command specified via
1056B<-e>). The I<path> must be an absolute path and it must exist for
1057@@RXVT_NAME@@ to start. If it isn't specified then the current working
1058directory will be used; option B<-cd>.
1059
918=item B<keysym.>I<sym>: I<string> 1060=item B<keysym.>I<sym>: I<action>
919 1061
920Compile I<frills>: Associate I<string> with keysym I<sym>. The 1062Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
921intervening resource name B<keysym.> cannot be omitted. 1063resource name B<keysym.> cannot be omitted.
922 1064
923The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1065Using this resource, you can map key combinations such as
924any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1066C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
925B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, 1067string than would normally result from that combination, making the
926and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 1068terminal scroll up or down the way you want it, or any other thing an
927B<2>, B<3>, B<4>, B<5>. 1069extension might provide.
1070
1071The key combination that triggers the action, I<sym>, has the following format:
1072
1073 (modifiers-)key
1074
1075Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
1076B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
1077B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
1078B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
928 1079
929The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1080The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
930whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1081whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
931keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1082keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
932current application keymap mode state. 1083current application keymap mode state.
933 1084
934The spellings of I<key> can be obtained by using B<xev>(1) command or 1085Due the the large number of modifier combinations, a key mapping will
935searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1086match if I<at least> the specified identifiers are being set, and no other
1087key mappings with those and more bits are being defined. That means that
1088defining a mapping for C<a> will automatically provide definitions for
1089C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1090themselves. See the C<builtin:> action, below, for a way to work around
1091this when this is a problem.
1092
1093The spelling of I<key> depends on your implementation of X. An easy way to
1094find a key name is to use the B<xev>(1) command. You can find a list by
1095looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
936omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1096the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
937keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1097value (B<0x0000 - 0xFFFF>).
938performed in an exact manner; however, the closest match is assured.
939 1098
940I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1099As with any resource value, the I<action> string may contain backslash
941C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1100escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
942C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1101number), see RESOURCES in C<man 7 X> for further details.
943C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
944can start or end with whitespace.
945 1102
946Please note that you need to double the C<\> when using 1103An action starts with an action prefix that selects a certain type
947C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can 1104of action, followed by a colon. An action string without colons is
948use C<\033> instead of C<\e> (and so on), which will work with both Xt and 1105interpreted as a literal string to pass to the tty (as if it was
949@@RXVT_NAME@@'s own processing). 1106prefixed with C<string:>).
950 1107
951You can define a range of keysyms in one shot by providing a I<string> 1108The following action prefixes are known - extensions can provide
952with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1109additional prefixes:
953should be a character not used by the strings.
954 1110
955Its usage can be demonstrated by an example: 1111=over 4
956 1112
957 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1113=item string:STRING
958 1114
959The above line is equivalent to the following three lines: 1115If the I<action> starts with C<string:> (or otherwise contains no colons),
1116then the remaining C<STRING> will be passed to the program running in the
1117terminal. For example, you could replace whatever Shift-Tab outputs by the
1118string C<echo rm -rf /> followed by a newline:
960 1119
961 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1120 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
962 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
963 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
964 1121
1122This could in theory be used to completely redefine your keymap.
1123
1124=item command:STRING
1125
965If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1126If I<action> takes the form of C<command:STRING>, the specified B<STRING>
966is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1127is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1128the opposite of C<string:> - instead of sending it to the program running
1129in the terminal, it will be treated as if it were program output). This is
1130most useful to feed command sequences into @@RXVT_NAME@@.
1131
967example the following means "change the current locale to C<zh_CN.GBK> 1132For example the following means "change the current locale to C<zh_CN.GBK>
968when Control-Meta-c is being pressed": 1133when Control-Meta-c is being pressed":
969 1134
970 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1135 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
971 1136
972Due the the large number of modifier combinations, a defined key mapping 1137The following example will map Control-Meta-1 and Control-Meta-2 to
973will match if at I<at least> the specified identifiers are being set, and 1138the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
974no other key mappings with those and more bits are being defined. That 1139font-switching at runtime:
975means that defining a key map for C<a> will automatically provide
976definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
977mappings themselves.
978 1140
979Unfortunately, this will override built-in key mappings. For example 1141 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1142 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1143
1144Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1145info):
1146
1147 URxvt.keysym.M-C-3: command:\033[8;25;80t
1148 URxvt.keysym.M-C-4: command:\033[8;48;110t
1149
1150=item builtin:
1151
1152The builtin action is the action that @@RXVT_NAME@@ would execute if no
1153key binding existed for the key combination. The obvious use is to undo
1154the effect of existing bindings. The not so obvious use is to reinstate
1155bindings when another binding overrides too many modifiers.
1156
980if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1157For example if you overwrite the C<Insert> key you will disable
981C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1158@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
982user-defined keymap using the C<builtin:> replacement: 1159"holes" into the user-defined keymap using the C<builtin:> replacement:
983 1160
984 URxvt.keysym.Insert: <my insert key sequence> 1161 URxvt.keysym.Insert: <my insert key sequence>
985 URxvt.keysym.S-Insert: builtin: 1162 URxvt.keysym.S-Insert: builtin:
986 1163
987The first line defines a mapping for C<Insert> and I<any> combination 1164The first line defines a mapping for C<Insert> and I<any> combination
988of modifiers. The second line re-establishes the default mapping for 1165of modifiers. The second line re-establishes the default mapping for
989C<Shift-Insert>. 1166C<Shift-Insert>.
990 1167
991The following example will map Control-Meta-1 and Control-Meta-2 to 1168=item builtin-string:
992the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
993font-switching at runtime:
994 1169
995 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1170This action is mainly useful to restore string mappings for keys that
996 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1171have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1172difficult to explain - basically, this action will send the string to the
1173application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1174action for it.
997 1175
998Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1176An example might make it clearer: @@RXVT_NAME@@ normally pastes the
999info): 1177selection when you press C<Shift-Insert>. With the following bindings, it
1178would instead emit the (undocumented, but what applications running in the
1179terminal might expect) sequence C<ESC [ 2 $> instead:
1000 1180
1001 URxvt.keysym.M-C-3: command:\033[8;25;80t 1181 URxvt.keysym.S-Insert: builtin-string:
1002 URxvt.keysym.M-C-4: command:\033[8;48;110t 1182 URxvt.keysym.C-S-Insert: builtin:
1183
1184The first line disables the paste functionality for that key
1185combination, and the second reinstates the default behaviour for
1186C<Control-Shift-Insert>, which would otherwise be overridden.
1187
1188Similarly, to let applications gain access to the C<C-M-c> (copy to
1189clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1190this:
1191
1192 URxvt.keysym.C-M-c: builtin-string:
1193 URxvt.keysym.C-M-v: builtin-string:
1194
1195=item EXTENSION:STRING
1196
1197An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)
1198extension of the same name. The extension will be loaded automatically if
1199necessary.
1200
1201Not all extensions define key actions, but popular extensions that do
1202include the I<selection> and I<matcher> extensions (documented in their
1203own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1204respectively).
1205
1206From the silly examples department, this will rot13-"encrypt"
1207@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1208keyboards:
1209
1210 URxvt.keysym.M-C-c: selection:rot13
1211
1212=item perl:STRING *DEPRECATED*
1213
1214This is a deprecated way of passing key mappings to perl extensions. It is
1215still supported, but should not be used anymore.
1216
1217=back
1218
1219=item B<perl-ext-common>: I<string>
1220
1221=item B<perl-ext>: I<string>
1222
1223Comma-separated list(s) of perl extension scripts (default: C<default>) to
1224use in this terminal instance; option B<-pe>.
1225
1226Extension names can be prefixed with a C<-> sign to prohibit using
1227them. This can be useful to selectively disable some extensions loaded
1228by default, or specified via the C<perl-ext-common> resource. For
1229example, C<default,-selection> will use all the default extensions except
1230C<selection>.
1231
1232The default set includes the C<selection>, C<option-popup>,
1233C<selection-popup> and C<readline> extensions, any extensions that
1234define keybindings via C<BINDING> meta comments, and extensions which
1235are mentioned in B<keysym> resources.
1236
1237Any extension such that a corresponding resource is given on the
1238command line is automatically appended to B<perl-ext>.
1239
1240Each extension is looked up in the library directories, loaded if
1241necessary, and bound to the current terminal instance. When the library
1242search path contains multiple extension files of the same name, then the
1243first one found will be used.
1244
1245If both of these resources are the empty string, then the perl interpreter
1246will not be initialized. The rationale for having two options is that
1247B<perl-ext-common> will be used for extensions that should be available to
1248all instances, while B<perl-ext> is used for specific instances.
1249
1250=item B<perl-eval>: I<string>
1251
1252Perl code to be evaluated when all extensions have been registered. See
1253the @@RXVT_NAME@@perl(3) manpage.
1254
1255=item B<perl-lib>: I<path>
1256
1257Colon-separated list of additional directories that hold extension
1258scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1259in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1260lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1261
1262See the @@RXVT_NAME@@perl(3) manpage.
1263
1264=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1265
1266Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1267details.
1268
1269=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1270
1271Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1272for details.
1273
1274=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1275
1276This resource is deprecated and will be removed. Use a B<keysym> resource
1277instead, e.g.:
1278
1279 URxvt.keysym.M-s: searchable-scrollback:start
1280
1281=item B<url-launcher>: I<string>
1282
1283Specifies the program to be started with a URL argument. Used by the
1284C<selection-popup> and C<matcher> perl extensions.
1285
1286=item B<transient-for>: I<windowid>
1287
1288Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1289
1290=item B<override-redirect>: I<boolean>
1291
1292Compile I<frills>: Sets override-redirect for the terminal window, making
1293it almost invisible to window managers; option B<-override-redirect>.
1294
1295=item B<iso14755:> I<boolean>
1296
1297Turn on/off ISO 14755 (default enabled).
1298
1299=item B<iso14755_52:> I<boolean>
1300
1301Turn on/off ISO 14755 5.2 mode (default enabled).
1302
1303=back
1304
1305=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1306
1307=over 4
1308
1309=item B<-pixmap> I<file[;oplist]>
1310
1311=item B<backgroundPixmap:> I<file[;oplist]>
1312
1313Compile I<pixbuf>: Use the specified image file as the window's
1314background and also optionally specify a colon separated list of
1315operations to modify it. Note that you may need to quote the C<;>
1316character when using the command line option, as C<;> is usually a
1317metacharacter in shells. Supported operations are:
1318
1319=over 4
1320
1321=item B<WxH+X+Y>
1322
1323sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1324scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1325scale of 0 disables scaling.
1326
1327=item B<op=tile>
1328
1329enables tiling
1330
1331=item B<op=keep-aspect>
1332
1333maintain the image aspect ratio when scaling
1334
1335=item B<op=root-align>
1336
1337use the position of the terminal window relative to the root window as
1338the image offset, simulating a root window background
1339
1340=back
1341
1342The default scale and position setting is C<100x100+50+50>.
1343Alternatively, a predefined set of templates can be used to achieve
1344the most common setups:
1345
1346=over 4
1347
1348=item B<style=tiled>
1349
1350the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1351
1352=item B<style=aspect-stretched>
1353
1354the image is scaled to fill the whole window maintaining the aspect
1355ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1356
1357=item B<style=stretched>
1358
1359the image is scaled to fill the whole window. Equivalent to 100x100
1360
1361=item B<style=centered>
1362
1363the image is centered with no scaling. Equivalent to 0x0+50+50
1364
1365=item B<style=root-tiled>
1366
1367the image is tiled with no scaling and using 'root' positioning.
1368Equivalent to 0x0:op=tile:op=root-align
1369
1370=back
1371
1372If multiple templates are specified the last one wins. Note that a
1373template overrides all the scale, position and operations settings.
1374
1375If used in conjunction with pseudo-transparency, the specified pixmap
1376will be blended over the transparent background using alpha-blending.
1377
1378=item B<-tr>|B<+tr>
1379
1380=item B<transparent:> I<boolean>
1381
1382Turn on/off pseudo-transparency by using the root pixmap as background.
1383
1384B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1385will be removed in future versions.
1386
1387=item B<-tint> I<colour>
1388
1389=item B<tintColor:> I<colour>
1390
1391Tint the transparent background with the given colour. Note that a
1392black tint yields a completely black image while a white tint yields
1393the image unchanged.
1394
1395=item B<-sh> I<number>
1396
1397=item B<shading:> I<number>
1398
1399Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1400A value of 100 means no shading.
1401
1402=item B<-blr> I<HxV>
1403
1404=item B<blurRadius:> I<HxV>
1405
1406Apply gaussian blur with the specified radius to the transparent
1407background. If a single number is specified, the vertical and
1408horizontal radii are considered to be the same. Setting one of the
1409radii to 1 and the other to a large number creates interesting effects
1410on some backgrounds. The maximum radius value is 128. An horizontal or
1411vertical radius of 0 disables blurring.
1412
1413=item B<path:> I<path>
1414
1415Specify the colon-delimited search path for finding background image files.
1003 1416
1004=back 1417=back
1005 1418
1006=head1 THE SCROLLBAR 1419=head1 THE SCROLLBAR
1007 1420
1026application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1439application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1027(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1440(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1028up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1441up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1029respectively. 1442respectively.
1030 1443
1031=head1 TEXT SELECTION AND INSERTION 1444=head1 THE SELECTION: SELECTING AND PASTING TEXT
1032 1445
1033The behaviour of text selection and insertion mechanism is similar to 1446The behaviour of text selection and insertion/pasting mechanism is similar
1034I<xterm>(1). 1447to I<xterm>(1).
1035 1448
1036=over 4 1449=over 4
1037 1450
1038=item B<Selection>: 1451=item B<Selecting>:
1039 1452
1040Left click at the beginning of the region, drag to the end of the region 1453Left click at the beginning of the region, drag to the end of the region
1041and release; Right click to extend the marked region; Left double-click 1454and release; Right click to extend the marked region; Left double-click
1042to select a word; Left triple-click to select the entire logical line 1455to select a word; Left triple-click to select the entire logical line
1043(which can span multiple screen lines), unless modified by resource 1456(which can span multiple screen lines), unless modified by resource
1044B<tripleclickwords>. 1457B<tripleclickwords>.
1045 1458
1046Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1459Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1047(Compile: I<frills>) will create a rectangular selection instead of a normal 1460(Compile: I<frills>) will create a rectangular selection instead of a
1048one. 1461normal one. In this mode, every selected row becomes its own line in the
1462selection, and trailing whitespace is visually underlined and removed from
1463the selection.
1049 1464
1050=item B<Insertion>: 1465=item B<Pasting>:
1051 1466
1052Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1467Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1053an B<@@RXVT_NAME@@> window causes the current text selection to be 1468window causes the value of the PRIMARY selection (or CLIPBOARD with the
1054inserted as if it had been typed on the keyboard. 1469B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1470
1471Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1472inserted too.
1473
1474rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1475<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1476binding causes the value of the internal selection to be copied to the
1477CLIPBOARD selection, while the second binding causes the value of the
1478CLIPBOARD selection to be inserted.
1055 1479
1056=back 1480=back
1057 1481
1058=head1 CHANGING FONTS 1482=head1 CHANGING FONTS
1059 1483
1060Changing fonts (or font sizes, respectively) via the keypad is not yet 1484Changing fonts (or font sizes, respectively) via the keypad is not yet
1061supported in rxvt-unicode. Bug me if you need this. 1485supported in rxvt-unicode. Bug me if you need this.
1062 1486
1063You can, however, switch fonts at runtime using escape sequences (and 1487You can, however, switch fonts at runtime using escape sequences, e.g.:
1064therefore using the menubar), e.g.:
1065 1488
1066 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1489 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1490
1491You can use keyboard shortcuts, too:
1492
1493 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1494 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1067 1495
1068rxvt-unicode will automatically re-apply these fonts to the output so far. 1496rxvt-unicode will automatically re-apply these fonts to the output so far.
1069 1497
1070=head1 ISO 14755 SUPPORT 1498=head1 ISO 14755 SUPPORT
1071 1499
1072ISO 14755 is a standard for entering and viewing unicode characters 1500ISO 14755 is a standard for entering and viewing unicode characters
1073and character codes using the keyboard. It consists of 4 parts. The 1501and character codes using the keyboard. It consists of 4 parts. The
1074first part is available rxvt-unicode has been compiled with 1502first part is available if rxvt-unicode has been compiled with
1075C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1503C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1076with C<--enable-iso14755>. 1504with C<--enable-iso14755>.
1077 1505
1078=over 4 1506=over 4
1079 1507
1099This mode lets you input characters representing the keycap symbols of 1527This mode lets you input characters representing the keycap symbols of
1100your keyboard, if representable in the current locale encoding. 1528your keyboard, if representable in the current locale encoding.
1101 1529
1102Start by pressing C<Control> and C<Shift> together, then releasing 1530Start by pressing C<Control> and C<Shift> together, then releasing
1103them. The next special key (cursor keys, home etc.) you enter will not 1531them. The next special key (cursor keys, home etc.) you enter will not
1104invoke it's usual function but instead will insert the corresponding 1532invoke its usual function but instead will insert the corresponding
1105keycap symbol. The symbol will only be entered when the key has been 1533keycap symbol. The symbol will only be entered when the key has been
1106released, otherwise pressing e.g. C<Shift> would enter the symbol for 1534released, otherwise pressing e.g. C<Shift> would enter the symbol for
1107C<ISO Level 2 Switch>, although your intention might have been to enter a 1535C<ISO Level 2 Switch>, although your intention might have been to enter a
1108reverse tab (Shift-Tab). 1536reverse tab (Shift-Tab).
1109 1537
1137B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1565B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1138it can be seen via the I<who(1)> command, and can accept messages. To 1566it can be seen via the I<who(1)> command, and can accept messages. To
1139allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1567allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1140on some systems or setgid to root or to some other group on others. 1568on some systems or setgid to root or to some other group on others.
1141 1569
1142=head1 COLORS AND GRAPHICS 1570=head1 COLOURS AND GRAPHICS
1143 1571
1144In addition to the default foreground and background colours, 1572In addition to the default foreground and background colours,
1145B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1573B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1146high-intensity bold/blink versions of the same). Here is a list of the 1574high-intensity (potentially bold/blink) versions of the same, and 72 (or
1147colours with their B<rgb.txt> names. 1575240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1576cube plus a 8 (24) colour greyscale ramp.
1577
1578Here is a list of the ANSI colours with their names.
1148 1579
1149=begin table 1580=begin table
1150 1581
1151 B<color0> (black) = Black 1582 B<color0> (black) = Black
1152 B<color1> (red) = Red3 1583 B<color1> (red) = Red3
1172It is also possible to specify the colour values of B<foreground>, 1603It is also possible to specify the colour values of B<foreground>,
1173B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1604B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1174a number 0-15, as a convenient shorthand to reference the colour name of 1605a number 0-15, as a convenient shorthand to reference the colour name of
1175color0-color15. 1606color0-color15.
1176 1607
1608The following text gives values for the standard 88 colour mode (and
1609values for the 256 colour mode in parentheses).
1610
1611The RGB cube uses indices 16..79 (16..231) using the following formulas:
1612
1613 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1614 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1615
1616The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1617steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1618the RGB cube.
1619
1620Together, all those colours implement the 88 (256) colour xterm
1621colours. Only the first 16 can be changed using resources currently, the
1622rest can only be changed via command sequences ("escape codes").
1623
1624Applications are advised to use terminfo or command sequences to discover
1625number and RGB values of all colours (yes, you can query this...).
1626
1177Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1627Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1178always swapping the foreground/background colours. This is in contrast to 1628always swapping the foreground/background colours. This is in contrast to
1179I<xterm>(1) where the colours are only swapped if they have not otherwise 1629I<xterm>(1) where the colours are only swapped if they have not otherwise
1180been specified. For example, 1630been specified. For example,
1181 1631
1632 @@RXVT_NAME@@ -fg Black -bg White -rv
1633
1634would yield White on Black, while on I<xterm>(1) it would yield Black on
1635White.
1636
1637=head2 ALPHA CHANNEL SUPPORT
1638
1639If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1640their act together, rxvt-unicode will do its own alpha channel management:
1641
1642You can prefix any colour with an opaqueness percentage enclosed in
1643brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1644(0-100) that specifies the opacity of the colour, where C<0> is completely
1645transparent and C<100> is completely opaque. For example, C<[50]red> is a
1646half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1647is the recommended format to specify transparency values, and works with
1648all ways to specify a colour.
1649
1650For complete control, rxvt-unicode also supports
1651C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1652specifications, where the additional C<aaaa> component specifies opacity
1653(alpha) values. The minimum value of C<0000> is completely transparent,
1654while C<ffff> is completely opaque). The two example colours from
1655earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1656C<rgba:0000/ff00/0000/f332>.
1657
1658You probably need to specify B<"-depth 32">, too, to force a visual with
1659alpha channels, and have the luck that your X-server uses ARGB pixel
1660layout, as X is far from just supporting ARGB visuals out of the box, and
1661rxvt-unicode just fudges around.
1662
1663For example, the following selects an almost completely transparent black
1664background, and an almost opaque pink foreground:
1665
1666 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1667
1668When not using a background image, then the interpretation of the
1669alpha channel is up to your compositing manager (most interpret it as
1670transparency of course).
1671
1672When using a background pixmap or pseudo-transparency, then the background
1673colour will always behave as if it were completely transparent (so the
1674background image shows instead), regardless of how it was specified, while
1675other colours will either be transparent as specified (the background
1676image will show through) on servers supporting the RENDER extension, or
1677fully opaque on servers not supporting the RENDER EXTENSION.
1678
1679Please note that due to bugs in Xft, specifying alpha values might result
1680in garbage being displayed when the X-server does not support the RENDER
1681extension.
1682
1683=head1 ENVIRONMENT
1684
1685B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1686
1182=over 4 1687=over 4
1183 1688
1184=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1185
1186would yield White on Black, while on I<xterm>(1) it would yield Black
1187on White.
1188
1189=back
1190
1191=head1 ENVIRONMENT
1192
1193B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1194
1195=over 4
1196
1197=item B<TERM> 1689=item B<TERM>
1198 1690
1199Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1691Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1200resources or on the commandline. 1692resources or on the command line.
1201 1693
1202=item B<COLORTERM> 1694=item B<COLORTERM>
1203 1695
1204Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1696Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1205compiled with XPM support, and optionally with the added extension 1697compiled with background image support, and optionally with the added
1206C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1698extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1699screen.
1207 1700
1208=item B<COLORFGBG> 1701=item B<COLORFGBG>
1209 1702
1210Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1703Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1211the colour code used as default foreground/text colour (or the string 1704the colour code used as default foreground/text colour (or the string
1212C<default> to indicate that the default-colour escape sequence is to be 1705C<default> to indicate that the default-colour escape sequence is to be
1213used), C<bg> is the colour code used as default background colour (or the 1706used), C<bg> is the colour code used as default background colour (or the
1214string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1707string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1215was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1708was compiled with background image support. Libraries like C<ncurses>
1216(and do) use this information to optimize screen output. 1709and C<slang> can (and do) use this information to optimize screen output.
1217 1710
1218=item B<WINDOWID> 1711=item B<WINDOWID>
1219 1712
1220Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1713Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1221window, which usually has subwindows for the scrollbar, the terminal 1714window, which usually has subwindows for the scrollbar, the terminal
1227C<--with-terminfo=PATH>. 1720C<--with-terminfo=PATH>.
1228 1721
1229=item B<DISPLAY> 1722=item B<DISPLAY>
1230 1723
1231Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1724Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1232display in it's child processes. 1725display in its child processes if C<-display> isn't used to override. It
1726defaults to C<:0> if it doesn't exist.
1233 1727
1234=item B<SHELL> 1728=item B<SHELL>
1235 1729
1236The shell to be used for command execution, defaults to C</bin/sh>. 1730The shell to be used for command execution, defaults to C</bin/sh>.
1237 1731
1238=item B<RXVTPATH>
1239
1240The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1241files.
1242
1243=item B<PATH>
1244
1245Used in the same way as C<RXVTPATH>.
1246
1247=item B<RXVT_SOCKET> 1732=item B<RXVT_SOCKET> [I<sic>]
1248 1733
1249The unix domain socket path used by @@RXVT_NAME@@c(1) and 1734The unix domain socket path used by @@RXVT_NAME@@c(1) and
1250@@RXVT_NAME@@d(1). 1735@@RXVT_NAME@@d(1).
1251 1736
1252Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1737Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1738
1739=item B<URXVT_PERL_LIB>
1740
1741Additional F<:>-separated library search path for perl extensions. Will be
1742searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1743directory.
1744
1745=item B<URXVT_PERL_VERBOSITY>
1746
1747See L<@@RXVT_NAME@@perl>(3).
1253 1748
1254=item B<HOME> 1749=item B<HOME>
1255 1750
1256Used to locate the default directory for the unix domain socket for 1751Used to locate the default directory for the unix domain socket for
1257daemon communications and to locate various resource files (such as 1752daemon communications and to locate various resource files (such as
1258C<.Xdefaults>) 1753C<.Xdefaults>)
1259 1754
1260=item B<XAPPLRESDIR> 1755=item B<XAPPLRESDIR>
1261 1756
1262Directory where various X resource files are being located. 1757Directory where application-specific X resource files are located.
1263 1758
1264=item B<XENVIRONMENT> 1759=item B<XENVIRONMENT>
1265 1760
1266If set and accessible, gives the name of a X resource file to be loaded by 1761If set and accessible, gives the name of a X resource file to be loaded by
1267@@RXVT_NAME@@. 1762@@RXVT_NAME@@.
1272 1767
1273=over 4 1768=over 4
1274 1769
1275=item B</usr/lib/X11/rgb.txt> 1770=item B</usr/lib/X11/rgb.txt>
1276 1771
1277Color names. 1772Colour names.
1278 1773
1279=back 1774=back
1280 1775
1281=head1 SEE ALSO 1776=head1 SEE ALSO
1282 1777
1778@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1283@@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) 1779@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1284
1285=head1 BUGS
1286
1287Check the BUGS file for an up-to-date list.
1288
1289Cursor change support is not yet implemented.
1290
1291Click-and-drag doesn't work with X11 mouse report overriding.
1292 1780
1293=head1 CURRENT PROJECT COORDINATOR 1781=head1 CURRENT PROJECT COORDINATOR
1294 1782
1295=over 4 1783=over 4
1296 1784
1297=item Project Coordinator 1785=item Project Coordinator
1298 1786
1299Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1787Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1300 1788
1301L<http://software.schmorp.de/#rxvt-unicode> 1789L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1302 1790
1303=back 1791=back
1304 1792
1305=head1 AUTHORS 1793=head1 AUTHORS
1306 1794
1308 1796
1309=item John Bovey 1797=item John Bovey
1310 1798
1311University of Kent, 1992, wrote the original Xvt. 1799University of Kent, 1992, wrote the original Xvt.
1312 1800
1313=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1801=item Rob Nation <nation@rocket.sanders.lockheed.com>
1314 1802
1315very heavily modified Xvt and came up with Rxvt 1803very heavily modified Xvt and came up with Rxvt
1316 1804
1317=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1805=item Angelo Haritsis <ah@doc.ic.ac.uk>
1318 1806
1319wrote the Greek Keyboard Input (no longer in code) 1807wrote the Greek Keyboard Input (no longer in code)
1320 1808
1321=item mj olesen L<< <olesen@me.QueensU.CA> >> 1809=item mj olesen <olesen@me.QueensU.CA>
1322 1810
1323Wrote the menu system. 1811Wrote the menu system.
1324 1812
1325Project Coordinator (changes.txt 2.11 to 2.21) 1813Project Coordinator (changes.txt 2.11 to 2.21)
1326 1814
1327=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1815=item Oezguer Kesim <kesim@math.fu-berlin.de>
1328 1816
1329Project Coordinator (changes.txt 2.21a to 2.4.5) 1817Project Coordinator (changes.txt 2.21a to 2.4.5)
1330 1818
1331=item Geoff Wing L<< <gcw@pobox.com> >> 1819=item Geoff Wing <gcw@pobox.com>
1332 1820
1333Rewrote screen display and text selection routines. Project Coordinator 1821Rewrote screen display and text selection routines.
1822
1334(changes.txt 2.4.6 - rxvt-unicode) 1823Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1335 1824
1336=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1825=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1337 1826
1338Forked rxvt-unicode, rewrote most of the display code and internal 1827Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1339character handling to store text in unicode, improve xterm 1828extension, random hacks, numerous bugfixes and extensions.
1340compatibility and apply numerous other bugfixes and extensions.
1341 1829
1342Project Coordinator (Changes 1.0 -) 1830Project Coordinator (Changes 1.0 -)
1343 1831
1832=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1833
1834pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1835
1344=back 1836=back
1345 1837

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines