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.59 by root, Thu Feb 17 15:07:48 2005 UTC vs.
Revision 1.236 by sf-exg, Sat Aug 16 10:51:23 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 normal (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
398 my $rxvt = new Gtk2::DrawingArea; 480 my $rxvt = new Gtk2::Socket;
399 $...->add ($rxvt); # important to add it somewhere first 481 $rxvt->signal_connect_after (realize => sub {
400 $rxvt->realize; # now it can be realized
401 my $xid = $rxvt->window->get_xid; 482 my $xid = $_[0]->window->get_xid;
402
403 system "@@RXVT_NAME@@ -embed $xid &"; 483 system "@@RXVT_NAME@@ -embed $xid &";
484 });
404 485
405=item B<-pty-fd> I<fileno> 486=item B<-pty-fd> I<file descriptor>
406 487
407Tells @@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
408pair 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
409useful 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
410without having to run a program within it. 491without having to run a program within it.
411 492
412If 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
413entries 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
414yourself if you want that. 495yourself if you want that.
415 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.
500
416Here 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
417longer example is in F<doc/pty-fd>): 502longer example is in F<doc/pty-fd>):
418 503
419 use IO::Pty; 504 use IO::Pty;
420 use Fcntl; 505 use Fcntl;
421 506
422 my $pty = new IO::Pty; 507 my $pty = new IO::Pty;
423 fcntl $pty, F_SETFD, 0; # clear close-on-exec 508 fcntl $pty, F_SETFD, 0; # clear close-on-exec
424
425 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&"; 509 system "@@RXVT_NAME@@ -pty-fd " . (fileno $pty) . "&";
510 close $pty;
426 511
427 # now communicate with rxvt 512 # now communicate with rxvt
428 my $slave = $pty->slave; 513 my $slave = $pty->slave;
429 while (<$slave>) { print $slave "got <$_>\n" } 514 while (<$slave>) { print $slave "got <$_>\n" }
430 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
431=back 521=back
432 522
433=head1 RESOURCES (available also as long-options) 523=head1 RESOURCES
434 524
435Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 525Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
436options) compiled into your version. 526options) compiled into your version. All resources are also available as
527long-options.
437 528
438There 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
439Xresource data: using the X libraries (Xrm*-functions) or internal 530distribution do also load settings from the B<~/.Xresources> file when X
440Xresources reader (B<~/.Xdefaults>). For the first method (ie. 531starts. @@RXVT_NAME@@ will consult the following files/resources in order,
441B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 532with later settings overwriting earlier ones:
442resources using X11 tools like B<xrdb>. Many distribution do also load
443settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
444will consult the following files/resources in order, with later settings
445overwriting earlier ones:
446 533
447 1. system-wide app-defaults file, either locale-dependent OR global
448 2. app-defaults file in $XAPPLRESDIR 534 1. app-defaults file in $XAPPLRESDIR
535 2. $HOME/.Xdefaults
449 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 536 3. RESOURCE_MANAGER property on root-window of screen 0
450 4. SCREEN_RESOURCES for the current screen 537 4. SCREEN_RESOURCES property on root-window of the current screen
451 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 538 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
539 6. resources specified via -xrm on the commandline
452 540
453If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
454lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
455set in XAPPLOADDIR/URxvt (compile-time defined: usually
456B</usr/lib/X11/app-defaults/URxvt>) and resources set in
457B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
458Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 541Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
459class 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
460resources 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
461easily configured, while the class name B<URxvt> allows resources 544configured, while the class name B<URxvt> allows resources unique to
462unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 545B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
463shared between different B<@@RXVT_NAME@@> configurations. If no 546configurations. If no resources are specified, suitable defaults will
464resources are specified, suitable defaults will be used. Command-line 547be used. Command-line arguments can be used to override resource
465arguments can be used to override resource settings. The following 548settings. The following resources are supported (you might want to
466resources are allowed: 549check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
550extensions not documented here):
467 551
468=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.
469 565
470=item B<geometry:> I<geom> 566=item B<geometry:> I<geom>
471 567
472Create the window with the specified X window geometry [default 80x24]; 568Create the window with the specified X window geometry [default 80x24];
473option B<-geometry>. 569option B<-geometry>.
487Use 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
488corresponds to low-intensity (normal) colours and 8-15 corresponds to 584corresponds to low-intensity (normal) colours and 8-15 corresponds to
489high-intensity (bold = bright foreground, blink = bright background) 585high-intensity (bold = bright foreground, blink = bright background)
490colours. 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,
4913=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
492names used are listed in the B<COLORS AND GRAPHICS> section. 588names used are listed in the B<COLOURS AND GRAPHICS> section.
493 589
494Colours 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
495changed using an escape command (see @@RXVT_NAME@@(7)). 591changed using an escape command (see @@RXVT_NAME@@(7)).
496 592
497Colours 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
508=item B<colorUL:> I<colour> 604=item B<colorUL:> I<colour>
509 605
510Use the specified colour to display underlined characters when the 606Use the specified colour to display underlined characters when the
511foreground colour is the default. 607foreground colour is the default.
512 608
513=item B<colorRV:> I<colour>
514
515Use the specified colour as the background for reverse video
516characters.
517
518=item B<underlineColor:> I<colour> 609=item B<underlineColor:> I<colour>
519 610
520If set, use the specified colour as the colour for the underline 611If set, use the specified colour as the colour for the underline
521itself. 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.
522 623
523=item B<cursorColor:> I<colour> 624=item B<cursorColor:> I<colour>
524 625
525Use 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
526foreground colour; option B<-cr>. 627foreground colour; option B<-cr>.
533 634
534=item B<reverseVideo:> I<boolean> 635=item B<reverseVideo:> I<boolean>
535 636
536B<True>: simulate reverse video by foreground and background colours; 637B<True>: simulate reverse video by foreground and background colours;
537option B<-rv>. B<False>: regular screen colours [default]; option 638option B<-rv>. B<False>: regular screen colours [default]; option
538B<+rv>. See note in B<COLORS AND GRAPHICS> section. 639B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
539 640
540=item B<jumpScroll:> I<boolean> 641=item B<jumpScroll:> I<boolean>
541 642
542B<True>: specify that jump scrolling should be used. When scrolling 643B<True>: specify that jump scrolling should be used. When receiving lots
543quickly, 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
544B<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>.
545 650
546=item B<inheritPixmap:> I<boolean> 651=item B<skipScroll:> I<boolean>
547 652
548B<True>: make the background inherit the parent windows' pixmap, giving 653B<True>: (the default) specify that skip scrolling should be used. When
549artificial transparency. B<False>: do not inherit the parent windows' 654receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
550pixmap. 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>.
551 662
552=item B<fading:> I<number> 663=item B<fading:> I<number>
553 664
554Fade the text by the given percentage when focus is lost. 665Fade the text by the given percentage when focus is lost; option B<-fade>.
555 666
556=item B<tintColor:> I<colour> 667=item B<fadeColor:> I<colour>
557 668
558Tint 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>.
559 671
560=item B<shading:> I<number> 672=item B<iconFile:> I<file>
561 673
562Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 674Set the application icon pixmap; option B<-icon>.
563image in addition to tinting it.
564 675
565=item B<scrollColor:> I<colour> 676=item B<scrollColor:> I<colour>
566 677
567Use the specified colour for the scrollbar [default #B2B2B2]. 678Use the specified colour for the scrollbar [default #B2B2B2].
568 679
569=item B<troughColor:> I<colour> 680=item B<troughColor:> I<colour>
570 681
571Use the specified colour for the scrollbar's trough area [default 682Use the specified colour for the scrollbar's trough area [default
572#969696]. Only relevant for normal (non XTerm/NeXT) scrollbar. 683#969696]. Only relevant for rxvt (non XTerm/NeXT) scrollbar.
573 684
574=item B<borderColor:> I<colour> 685=item B<borderColor:> I<colour>
575 686
576The 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
577and the text. 688and the text.
578 689
579=item B<backgroundPixmap:> I<file[;geom]>
580
581Use the specified XPM file (note the `.xpm' extension is optional) for
582the background and also optionally specify its scaling with a geometry
583string B<WxH+X+Y>, in which B<"W" / "H"> specify the
584horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image
585centre (percent). A scale of 0 displays the image with tiling. A scale
586of 1 displays the image without any scaling. A scale of 2 to 9
587specifies an integer number of images in that direction. No image will
588be magnified beyond 10 times its original size. The maximum permitted
589scale is 1000. [default 0x0+50+50]
590
591=item B<menu:> I<file[;tag]>
592
593Read in the specified menu file (note the `.menu' extension is
594optional) and also optionally specify a starting tag to find. See the
595reference documentation for details on the syntax for the menuBar.
596
597=item B<path:> I<path>
598
599Specify the colon-delimited search path for finding files (XPM and
600menus), in addition to the paths specified by the B<RXVTPATH> and
601B<PATH> environment variables.
602
603=item B<font:> I<fontlist> 690=item B<font:> I<fontlist>
604 691
605Select 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
606names that are used in turn when trying to display Unicode characters. 693that are checked in order when trying to find glyphs for characters. The
607The first font defines the cell size for characters; other fonts might 694first font defines the cell size for characters; other fonts might be
608be smaller, but not larger. A reasonable default font list is always 695smaller, but not (in general) larger. A (hopefully) reasonable default
609appended to it. option B<-fn>. 696font list is always appended to it; option B<-fn>.
610 697
611Each 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
612optional 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:>.
613 700
614In addition, each font can be prefixed with additional hints and 701In addition, each font can be prefixed with additional hints and
616hint 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
617fonts. 704fonts.
618 705
619For example, this font resource 706For example, this font resource
620 707
621 URxvt*font: 9x15bold,\ 708 URxvt.font: 9x15bold,\
622 -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,\
623 -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, \
624 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 711 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
625 xft:Code2000:antialias=false 712 xft:Code2000:antialias=false
626 713
629it 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
630wide and 15 pixels high. 717wide and 15 pixels high.
631 718
632The 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
633the base font, likewise the third, which is unfortunately non-bold, but 720the base font, likewise the third, which is unfortunately non-bold, but
634the 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
635useful supplement. 722useful supplement.
636 723
637The 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
638are 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
639contains other characters, but we are not interested in them. 726contains other characters, but we are not interested in them.
660not possible, replacement fonts of the desired shape will be tried. 747not possible, replacement fonts of the desired shape will be tried.
661 748
662If 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
663text font will being used for the given style. 750text font will being used for the given style.
664 751
665=item B<selectstyle:> I<mode> 752=item B<intensityStyles:> I<boolean>
666 753
667Set 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>,
668xterm style with 2.20 old word selection, or anything else which gives 755option B<-is>, the default), bold/blink font styles imply high
669xterm style selection. 756intensity foreground/background colours. Disabling this option (B<False>,
670 757option B<+is>) disables this behaviour, the high intensity colours are not
671=item B<scrollstyle:> I<mode> 758reachable.
672
673Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
674the author's favourite..
675 759
676=item B<title:> I<string> 760=item B<title:> I<string>
677 761
678Set window title string, the default title is the command-line 762Set window title string, the default title is the command-line
679specified after the B<-e> option, if any, otherwise the application 763specified after the B<-e> option, if any, otherwise the application
688=item B<mapAlert:> I<boolean> 772=item B<mapAlert:> I<boolean>
689 773
690B<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
691de-iconify (map) on receipt of a bell character [default]. 775de-iconify (map) on receipt of a bell character [default].
692 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
693=item B<visualBell:> I<boolean> 784=item B<visualBell:> I<boolean>
694 785
695B<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>.
696B<False>: no visual bell [default]; option B<+vb>. 787B<False>: no visual bell [default]; option B<+vb>.
697 788
699 790
700B<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
701the 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
702[default]; option B<+ls>. 793[default]; option B<+ls>.
703 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
704=item B<utmpInhibit:> I<boolean> 800=item B<utmpInhibit:> I<boolean>
705 801
706B<True>: inhibit writing record into the system log file B<utmp>; 802B<True>: inhibit writing record into the system log file B<utmp>;
707option 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>
708[default]; option B<+ut>. 804[default]; option B<+ut>.
711 807
712Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use 808Specify a command pipe for vt100 printer [default I<lpr(1)>]. Use
713B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or 809B<Print> to initiate a screen dump to the printer and B<Ctrl-Print> or
714B<Shift-Print> to include the scrollback as well. 810B<Shift-Print> to include the scrollback as well.
715 811
812The string will be interpreted as if typed into the shell as-is.
813
814Example:
815
816 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
817
818This creates a new file in your home directory with the screen contents
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.
829
716=item B<scrollBar:> I<boolean> 830=item B<scrollBar:> I<boolean>
717 831
718B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 832B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
719disable the scrollbar; option B<+sb>. 833disable the scrollbar; option B<+sb>.
720 834
739B<False>: do not scroll to bottom when tty receives output; option 853B<False>: do not scroll to bottom when tty receives output; option
740B<+si>. 854B<+si>.
741 855
742=item B<scrollWithBuffer:> I<boolean> 856=item B<scrollWithBuffer:> I<boolean>
743 857
744B<True>: scroll with scrollback buffer when tty receives new lines (and 858B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
745B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 859try to show the same lines) and B<scrollTtyOutput> is False; option
746with 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>.
747 862
748=item B<scrollTtyKeypress:> I<boolean> 863=item B<scrollTtyKeypress:> I<boolean>
749 864
750B<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
751are those which are intercepted by rxvt-unicode for special handling and 866are those which are intercepted by rxvt-unicode for special handling and
770=item B<borderLess:> I<boolean> 885=item B<borderLess:> I<boolean>
771 886
772Set 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
773WM, 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>.
774 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
775=item B<termName:> I<termname> 897=item B<termName:> I<termname>
776 898
777Specifies 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
778variable; option B<-tn>. 900variable; option B<-tn>.
779 901
780=item B<linespace:> I<number> 902=item B<lineSpace:> I<number>
781 903
782Specifies number of lines (pixel height) to insert between each row of 904Specifies number of lines (pixel height) to insert between each row of
783the display [default 0]; option B<-lsp>. 905the display [default 0]; option B<-lsp>.
784 906
785=item B<meta8:> I<boolean> 907=item B<meta8:> I<boolean>
799 921
800=item B<cursorBlink:> I<boolean> 922=item B<cursorBlink:> I<boolean>
801 923
802B<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];
803option 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>.
804 931
805=item B<pointerBlank:> I<boolean> 932=item B<pointerBlank:> I<boolean>
806 933
807B<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
808of seconds of inactivity. B<False>: the pointer is always visible 935of seconds of inactivity. B<False>: the pointer is always visible
816 943
817Mouse pointer background colour. 944Mouse pointer background colour.
818 945
819=item B<pointerBlankDelay:> I<number> 946=item B<pointerBlankDelay:> I<number>
820 947
821Specifies number of seconds before blanking the pointer [default 2]. 948Specifies number of seconds before blanking the pointer [default 2]. Use a
949large number (e.g. C<987654321>) to effectively disable the timeout.
822 950
823=item B<backspacekey:> I<string> 951=item B<backspacekey:> I<string>
824 952
825The 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>
826or 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>
827(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
828escape sequence. 956escape sequence.
829 957
830=item B<deletekey:> I<string> 958=item B<deletekey:> I<string>
831 959
833pressed. If unset it will send the sequence traditionally associated 961pressed. If unset it will send the sequence traditionally associated
834with the B<Execute> key. 962with the B<Execute> key.
835 963
836=item B<cutchars:> I<string> 964=item B<cutchars:> I<string>
837 965
838The characters used as delimiters for double-click word selection. The 966The characters used as delimiters for double-click word selection
839built-in default: 967(whitespace delimiting is added automatically if resource is given).
840 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
841B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 977B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
842 978
843=item B<preeditType:> I<style> 979=item B<preeditType:> I<style>
844 980
845B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 981B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
846 982
851=item B<imLocale:> I<name> 987=item B<imLocale:> I<name>
852 988
853The 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.
854C<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
855input extension to be able to input japanese characters while staying in 991input extension to be able to input japanese characters while staying in
856another locale. option B<-imlocale>. 992another locale; option B<-imlocale>.
857 993
858=item B<imFont:> I<fontset> 994=item B<imFont:> I<fontset>
859 995
860Specify the font-set used for XIM styles C<OverTheSpot> or 996Specify the font-set used for XIM styles C<OverTheSpot> or
861C<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
866 1002
867=item B<tripleclickwords:> I<boolean> 1003=item B<tripleclickwords:> I<boolean>
868 1004
869Change the meaning of triple-click selection with the left mouse 1005Change the meaning of triple-click selection with the left mouse
870button. 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
871the end of the logical line only. option B<-tcw>. 1007the end of the logical line only; option B<-tcw>.
872 1008
873=item B<insecure:> I<boolean> 1009=item B<insecure:> I<boolean>
874 1010
875Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1011Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
876echo 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
877abused if somebody gets 8-bit-clean access to your display, whether 1013abused if somebody gets 8-bit-clean access to your display, whether
878throuh a mail client displaying mail bodies unfiltered or though 1014through a mail client displaying mail bodies unfiltered or through
879write(1). Therefore, these sequences are disabled by default. (Note 1015write(1) or any other means. Therefore, these sequences are disabled by
880that other terminals, including xterm, have these sequences 1016default. (Note that many other terminals, including xterm, have these
881enabled by default). You can enable them by setting this boolean 1017sequences enabled by default, which doesn't make it safer, though).
882resource or specifying B<-insecure> as an option. At the moment, this 1018
883enabled display-answer, locale, findfont, icon label and window title 1019You can enable them by setting this boolean resource or specifying
884requests 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.
885 1022
886=item B<modifier:> I<modifier> 1023=item B<modifier:> I<modifier>
887 1024
888Set 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>,
889B<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
893 1030
894Specify 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)
895character is passed through. It may contain escape values as described 1032character is passed through. It may contain escape values as described
896in the entry on B<keysym> following. 1033in the entry on B<keysym> following.
897 1034
898=item B<secondaryScreen:> I<bool> 1035=item B<secondaryScreen:> I<boolean>
899 1036
900Turn on/off secondary screen (default enabled). 1037Turn on/off secondary screen (default enabled).
901 1038
902=item B<secondaryScroll:> I<bool> 1039=item B<secondaryScroll:> I<boolean>
903 1040
904Turn on/off secondary screen scroll (default enabled). If the this 1041Turn on/off secondary screen scroll (default enabled). If this
905option is enabled, scrolls on the secondary screen will change the 1042option is enabled, scrolls on the secondary screen will change the
906scrollback buffer and switching to/from the secondary screen will 1043scrollback buffer and, when secondaryScreen is off, switching
907instead scroll the screen up. 1044to/from the secondary screen will instead scroll the screen up.
908 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
909=item B<keysym.>I<sym>: I<string> 1060=item B<keysym.>I<sym>: I<action>
910 1061
911Compile I<frills>: Associate I<string> with keysym I<sym>. The 1062Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
912intervening resource name B<keysym.> cannot be omitted. 1063resource name B<keysym.> cannot be omitted.
913 1064
914The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1065Using this resource, you can map key combinations such as
915any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1066C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
916B<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
917and 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
918B<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>.
919 1079
920The 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
921whatever 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
922keys 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
923current application keymap mode state. 1083current application keymap mode state.
924 1084
925The 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
926searching 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
927omitting 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
928keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1097value (B<0x0000 - 0xFFFF>).
929performed in an exact manner; however, the closest match is assured.
930 1098
931I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1099As with any resource value, the I<action> string may contain backslash
932C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1100escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
933C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1101number), see RESOURCES in C<man 7 X> for further details.
934C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
935can start or end with whitespace.
936 1102
937Please note that you need to double the C<\> when using 1103An action starts with an action prefix that selects a certain type
938C<--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
939use 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
940@@RXVT_NAME@@'s own processing). 1106prefixed with C<string:>).
941 1107
942You can define a range of keysyms in one shot by providing a I<string> 1108The following action prefixes are known - extensions can provide
943with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1109additional prefixes:
944should be a character not used by the strings.
945 1110
946Its usage can be demonstrated by an example: 1111=over 4
947 1112
948 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1113=item string:STRING
949 1114
950The 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:
951 1119
952 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1120 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
953 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
954 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
955 1121
1122This could in theory be used to completely redefine your keymap.
1123
1124=item command:STRING
1125
956If 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>
957is 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
958example 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>
959when Control-Meta-c is being pressed": 1133when Control-Meta-c is being pressed":
960 1134
961 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
962 1136
963The following example will map Control-Meta-1 and Control-Meta-2 to 1137The following example will map Control-Meta-1 and Control-Meta-2 to
970Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1144Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
971info): 1145info):
972 1146
973 URxvt.keysym.M-C-3: command:\033[8;25;80t 1147 URxvt.keysym.M-C-3: command:\033[8;25;80t
974 URxvt.keysym.M-C-4: command:\033[8;48;110t 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
1157For example if you overwrite the C<Insert> key you will disable
1158@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1159"holes" into the user-defined keymap using the C<builtin:> replacement:
1160
1161 URxvt.keysym.Insert: <my insert key sequence>
1162 URxvt.keysym.S-Insert: builtin:
1163
1164The first line defines a mapping for C<Insert> and I<any> combination
1165of modifiers. The second line re-establishes the default mapping for
1166C<Shift-Insert>.
1167
1168=item builtin-string:
1169
1170This action is mainly useful to restore string mappings for keys that
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.
1175
1176An example might make it clearer: @@RXVT_NAME@@ normally pastes the
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:
1180
1181 URxvt.keysym.S-Insert: builtin-string:
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-S-c: builtin-string:
1193 URxvt.keysym.C-S-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 define
1234keybindings via C<BINDING> meta comments, extensions loaded because
1235their resources/commandline switches were used, and extensions which are
1236mentioned in B<keysym> resources.
1237
1238Each extension is looked up in the library directories, loaded if
1239necessary, and bound to the current terminal instance. When the library
1240search path contains multiple extension files of the same name, then the
1241first one found will be used.
1242
1243If both of these resources are the empty string, then the perl interpreter
1244will not be initialized. The rationale for having two options is that
1245B<perl-ext-common> will be used for extensions that should be available to
1246all instances, while B<perl-ext> is used for specific instances.
1247
1248=item B<perl-eval>: I<string>
1249
1250Perl code to be evaluated when all extensions have been registered. See
1251the @@RXVT_NAME@@perl(3) manpage.
1252
1253=item B<perl-lib>: I<path>
1254
1255Colon-separated list of additional directories that hold extension
1256scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1257in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1258lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1259
1260See the @@RXVT_NAME@@perl(3) manpage.
1261
1262=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1263
1264Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1265details.
1266
1267=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1268
1269Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1270for details.
1271
1272=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1273
1274This resource is deprecated and will be removed. Use a B<keysym> resource
1275instead, e.g.:
1276
1277 URxvt.keysym.M-s: searchable-scrollback:start
1278
1279=item B<url-launcher>: I<string>
1280
1281Specifies the program to be started with a URL argument. Used by the
1282C<selection-popup> and C<matcher> perl extensions.
1283
1284=item B<transient-for>: I<windowid>
1285
1286Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1287
1288=item B<override-redirect>: I<boolean>
1289
1290Compile I<frills>: Sets override-redirect for the terminal window, making
1291it almost invisible to window managers; option B<-override-redirect>.
1292
1293=item B<iso14755:> I<boolean>
1294
1295Turn on/off ISO 14755 (default enabled).
1296
1297=item B<iso14755_52:> I<boolean>
1298
1299Turn on/off ISO 14755 5.2 mode (default enabled).
1300
1301=back
1302
1303=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1304
1305=over 4
1306
1307=item B<-pixmap> I<file[;oplist]>
1308
1309=item B<backgroundPixmap:> I<file[;oplist]>
1310
1311Compile I<pixbuf>: Use the specified image file as the window's
1312background and also optionally specify a colon separated list of
1313operations to modify it. Note that you may need to quote the C<;>
1314character when using the command line option, as C<;> is usually a
1315metacharacter in shells. Supported operations are:
1316
1317=over 4
1318
1319=item B<WxH+X+Y>
1320
1321sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1322scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1323scale of 0 disables scaling.
1324
1325=item B<op=tile>
1326
1327enables tiling
1328
1329=item B<op=keep-aspect>
1330
1331maintain the image aspect ratio when scaling
1332
1333=item B<op=root-align>
1334
1335use the position of the terminal window relative to the root window as
1336the image offset, simulating a root window background
1337
1338=back
1339
1340The default scale and position setting is C<100x100+50+50>.
1341Alternatively, a predefined set of templates can be used to achieve
1342the most common setups:
1343
1344=over 4
1345
1346=item B<style=tiled>
1347
1348the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1349
1350=item B<style=aspect-stretched>
1351
1352the image is scaled to fill the whole window maintaining the aspect
1353ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1354
1355=item B<style=stretched>
1356
1357the image is scaled to fill the whole window. Equivalent to 100x100
1358
1359=item B<style=centered>
1360
1361the image is centered with no scaling. Equivalent to 0x0+50+50
1362
1363=item B<style=root-tiled>
1364
1365the image is tiled with no scaling and using 'root' positioning.
1366Equivalent to 0x0:op=tile:op=root-align
1367
1368=back
1369
1370If multiple templates are specified the last one wins. Note that a
1371template overrides all the scale, position and operations settings.
1372
1373If used in conjunction with pseudo-transparency, the specified pixmap
1374will be blended over the transparent background using alpha-blending.
1375
1376=item B<-tr>|B<+tr>
1377
1378=item B<transparent:> I<boolean>
1379
1380Turn on/off pseudo-transparency by using the root pixmap as background.
1381
1382B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1383will be removed in future versions.
1384
1385=item B<-tint> I<colour>
1386
1387=item B<tintColor:> I<colour>
1388
1389Tint the transparent background with the given colour. Note that a
1390black tint yields a completely black image while a white tint yields
1391the image unchanged.
1392
1393=item B<-sh> I<number>
1394
1395=item B<shading:> I<number>
1396
1397Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1398A value of 100 means no shading.
1399
1400=item B<-blr> I<HxV>
1401
1402=item B<blurRadius:> I<HxV>
1403
1404Apply gaussian blur with the specified radius to the transparent
1405background. If a single number is specified, the vertical and
1406horizontal radii are considered to be the same. Setting one of the
1407radii to 1 and the other to a large number creates interesting effects
1408on some backgrounds. The maximum radius value is 128. An horizontal or
1409vertical radius of 0 disables blurring.
1410
1411=item B<path:> I<path>
1412
1413Specify the colon-delimited search path for finding background image files.
975 1414
976=back 1415=back
977 1416
978=head1 THE SCROLLBAR 1417=head1 THE SCROLLBAR
979 1418
998application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1437application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
999(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1438(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1000up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1439up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1001respectively. 1440respectively.
1002 1441
1003=head1 TEXT SELECTION AND INSERTION 1442=head1 THE SELECTION: SELECTING AND PASTING TEXT
1004 1443
1005The behaviour of text selection and insertion mechanism is similar to 1444The behaviour of text selection and insertion/pasting mechanism is similar
1006I<xterm>(1). 1445to I<xterm>(1).
1007 1446
1008=over 4 1447=over 4
1009 1448
1010=item B<Selection>: 1449=item B<Selecting>:
1011 1450
1012Left click at the beginning of the region, drag to the end of the region 1451Left click at the beginning of the region, drag to the end of the region
1013and release; Right click to extend the marked region; Left double-click 1452and release; Right click to extend the marked region; Left double-click
1014to select a word; Left triple-click to select the entire logical line 1453to select a word; Left triple-click to select the entire logical line
1015(which can span multiple screen lines), unless modified by resource 1454(which can span multiple screen lines), unless modified by resource
1016B<tripleclickwords>. 1455B<tripleclickwords>.
1017 1456
1018Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1457Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1019(Compile: I<frills>) will create a rectangular selection instead of a normal 1458(Compile: I<frills>) will create a rectangular selection instead of a
1020one. 1459normal one. In this mode, every selected row becomes its own line in the
1460selection, and trailing whitespace is visually underlined and removed from
1461the selection.
1021 1462
1022=item B<Insertion>: 1463=item B<Pasting>:
1023 1464
1024Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1465Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1025an B<@@RXVT_NAME@@> window causes the current text selection to be 1466window causes the value of the PRIMARY selection (or CLIPBOARD with the
1026inserted as if it had been typed on the keyboard. 1467B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1468
1469Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1470inserted too.
1471
1472rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1473<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1474binding causes the value of the internal selection to be copied to the
1475CLIPBOARD selection, while the second binding causes the value of the
1476CLIPBOARD selection to be inserted.
1027 1477
1028=back 1478=back
1029 1479
1030=head1 CHANGING FONTS 1480=head1 CHANGING FONTS
1031 1481
1032Changing fonts (or font sizes, respectively) via the keypad is not yet 1482Changing fonts (or font sizes, respectively) via the keypad is not yet
1033supported in rxvt-unicode. Bug me if you need this. 1483supported in rxvt-unicode. Bug me if you need this.
1034 1484
1035You can, however, switch fonts at runtime using escape sequences (and 1485You can, however, switch fonts at runtime using escape sequences, e.g.:
1036therefore using the menubar), e.g.:
1037 1486
1038 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1487 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1488
1489You can use keyboard shortcuts, too:
1490
1491 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1492 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1039 1493
1040rxvt-unicode will automatically re-apply these fonts to the output so far. 1494rxvt-unicode will automatically re-apply these fonts to the output so far.
1041 1495
1042=head1 ISO 14755 SUPPORT 1496=head1 ISO 14755 SUPPORT
1043 1497
1044ISO 14755 is a standard for entering and viewing unicode characters 1498ISO 14755 is a standard for entering and viewing unicode characters
1045and character codes using the keyboard. It consists of 4 parts. The 1499and character codes using the keyboard. It consists of 4 parts. The
1046first part is available rxvt-unicode has been compiled with 1500first part is available if rxvt-unicode has been compiled with
1047C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1501C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1048with C<--enable-iso14755>. 1502with C<--enable-iso14755>.
1049 1503
1050=over 4 1504=over 4
1051 1505
1071This mode lets you input characters representing the keycap symbols of 1525This mode lets you input characters representing the keycap symbols of
1072your keyboard, if representable in the current locale encoding. 1526your keyboard, if representable in the current locale encoding.
1073 1527
1074Start by pressing C<Control> and C<Shift> together, then releasing 1528Start by pressing C<Control> and C<Shift> together, then releasing
1075them. The next special key (cursor keys, home etc.) you enter will not 1529them. The next special key (cursor keys, home etc.) you enter will not
1076invoke it's usual function but instead will insert the corresponding 1530invoke its usual function but instead will insert the corresponding
1077keycap symbol. The symbol will only be entered when the key has been 1531keycap symbol. The symbol will only be entered when the key has been
1078released, otherwise pressing e.g. C<Shift> would enter the symbol for 1532released, otherwise pressing e.g. C<Shift> would enter the symbol for
1079C<ISO Level 2 Switch>, although your intention might have been to enter a 1533C<ISO Level 2 Switch>, although your intention might have been to enter a
1080reverse tab (Shift-Tab). 1534reverse tab (Shift-Tab).
1081 1535
1109B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1563B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1110it can be seen via the I<who(1)> command, and can accept messages. To 1564it can be seen via the I<who(1)> command, and can accept messages. To
1111allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1565allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1112on some systems or setgid to root or to some other group on others. 1566on some systems or setgid to root or to some other group on others.
1113 1567
1114=head1 COLORS AND GRAPHICS 1568=head1 COLOURS AND GRAPHICS
1115 1569
1116In addition to the default foreground and background colours, 1570In addition to the default foreground and background colours,
1117B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1571B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1118high-intensity bold/blink versions of the same). Here is a list of the 1572high-intensity (potentially bold/blink) versions of the same, and 72 (or
1119colours with their B<rgb.txt> names. 1573240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1574cube plus a 8 (24) colour greyscale ramp.
1575
1576Here is a list of the ANSI colours with their names.
1120 1577
1121=begin table 1578=begin table
1122 1579
1123 B<color0> (black) = Black 1580 B<color0> (black) = Black
1124 B<color1> (red) = Red3 1581 B<color1> (red) = Red3
1144It is also possible to specify the colour values of B<foreground>, 1601It is also possible to specify the colour values of B<foreground>,
1145B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1602B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1146a number 0-15, as a convenient shorthand to reference the colour name of 1603a number 0-15, as a convenient shorthand to reference the colour name of
1147color0-color15. 1604color0-color15.
1148 1605
1606The following text gives values for the standard 88 colour mode (and
1607values for the 256 colour mode in parentheses).
1608
1609The RGB cube uses indices 16..79 (16..231) using the following formulas:
1610
1611 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1612 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1613
1614The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1615steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1616the RGB cube.
1617
1618Together, all those colours implement the 88 (256) colour xterm
1619colours. Only the first 16 can be changed using resources currently, the
1620rest can only be changed via command sequences ("escape codes").
1621
1622Applications are advised to use terminfo or command sequences to discover
1623number and RGB values of all colours (yes, you can query this...).
1624
1149Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1625Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1150always swapping the foreground/background colours. This is in contrast to 1626always swapping the foreground/background colours. This is in contrast to
1151I<xterm>(1) where the colours are only swapped if they have not otherwise 1627I<xterm>(1) where the colours are only swapped if they have not otherwise
1152been specified. For example, 1628been specified. For example,
1153 1629
1630 @@RXVT_NAME@@ -fg Black -bg White -rv
1631
1632would yield White on Black, while on I<xterm>(1) it would yield Black on
1633White.
1634
1635=head2 ALPHA CHANNEL SUPPORT
1636
1637If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1638their act together, rxvt-unicode will do its own alpha channel management:
1639
1640You can prefix any colour with an opaqueness percentage enclosed in
1641brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1642(0-100) that specifies the opacity of the colour, where C<0> is completely
1643transparent and C<100> is completely opaque. For example, C<[50]red> is a
1644half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1645is the recommended format to specify transparency values, and works with
1646all ways to specify a colour.
1647
1648For complete control, rxvt-unicode also supports
1649C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1650specifications, where the additional C<aaaa> component specifies opacity
1651(alpha) values. The minimum value of C<0000> is completely transparent,
1652while C<ffff> is completely opaque). The two example colours from
1653earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1654C<rgba:0000/ff00/0000/f332>.
1655
1656You probably need to specify B<"-depth 32">, too, to force a visual with
1657alpha channels, and have the luck that your X-server uses ARGB pixel
1658layout, as X is far from just supporting ARGB visuals out of the box, and
1659rxvt-unicode just fudges around.
1660
1661For example, the following selects an almost completely transparent black
1662background, and an almost opaque pink foreground:
1663
1664 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1665
1666When not using a background image, then the interpretation of the
1667alpha channel is up to your compositing manager (most interpret it as
1668transparency of course).
1669
1670When using a background pixmap or pseudo-transparency, then the background
1671colour will always behave as if it were completely transparent (so the
1672background image shows instead), regardless of how it was specified, while
1673other colours will either be transparent as specified (the background
1674image will show through) on servers supporting the RENDER extension, or
1675fully opaque on servers not supporting the RENDER EXTENSION.
1676
1677Please note that due to bugs in Xft, specifying alpha values might result
1678in garbage being displayed when the X-server does not support the RENDER
1679extension.
1680
1681=head1 ENVIRONMENT
1682
1683B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1684
1154=over 4 1685=over 4
1155 1686
1156=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1157
1158would yield White on Black, while on I<xterm>(1) it would yield Black
1159on White.
1160
1161=back
1162
1163=head1 ENVIRONMENT
1164
1165B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1166
1167=over 4
1168
1169=item B<TERM> 1687=item B<TERM>
1170 1688
1171Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1689Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1172resources or on the commandline. 1690resources or on the command line.
1173 1691
1174=item B<COLORTERM> 1692=item B<COLORTERM>
1175 1693
1176Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1694Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1177compiled with XPM support, and optionally with the added extension 1695compiled with background image support, and optionally with the added
1178C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1696extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1697screen.
1179 1698
1180=item B<COLORFGBG> 1699=item B<COLORFGBG>
1181 1700
1182Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1701Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1183the colour code used as default foreground/text colour (or the string 1702the colour code used as default foreground/text colour (or the string
1184C<default> to indicate that the default-colour escape sequence is to be 1703C<default> to indicate that the default-colour escape sequence is to be
1185used), C<bg> is the colour code used as default background colour (or the 1704used), C<bg> is the colour code used as default background colour (or the
1186string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1705string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1187was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1706was compiled with background image support. Libraries like C<ncurses>
1188(and do) use this information to optimize screen output. 1707and C<slang> can (and do) use this information to optimize screen output.
1189 1708
1190=item B<WINDOWID> 1709=item B<WINDOWID>
1191 1710
1192Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1711Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1193window, which usually has subwindows for the scrollbar, the terminal 1712window, which usually has subwindows for the scrollbar, the terminal
1199C<--with-terminfo=PATH>. 1718C<--with-terminfo=PATH>.
1200 1719
1201=item B<DISPLAY> 1720=item B<DISPLAY>
1202 1721
1203Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1722Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1204display in it's child processes. 1723display in its child processes if C<-display> isn't used to override. It
1724defaults to C<:0> if it doesn't exist.
1205 1725
1206=item B<SHELL> 1726=item B<SHELL>
1207 1727
1208The shell to be used for command execution, defaults to C</bin/sh>. 1728The shell to be used for command execution, defaults to C</bin/sh>.
1209 1729
1210=item B<RXVTPATH>
1211
1212The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1213files.
1214
1215=item B<PATH>
1216
1217Used in the same way as C<RXVTPATH>.
1218
1219=item B<RXVT_SOCKET> 1730=item B<RXVT_SOCKET> [I<sic>]
1220 1731
1221The unix domain socket path used by @@RXVT_NAME@@c(1) and 1732The unix domain socket path used by @@RXVT_NAME@@c(1) and
1222@@RXVT_NAME@@d(1). 1733@@RXVT_NAME@@d(1).
1223 1734
1224Default C<< $HOME/.rxvt-unicode-<nodename >>. 1735Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1736
1737=item B<URXVT_PERL_LIB>
1738
1739Additional F<:>-separated library search path for perl extensions. Will be
1740searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1741directory.
1742
1743=item B<URXVT_PERL_VERBOSITY>
1744
1745See L<@@RXVT_NAME@@perl>(3).
1225 1746
1226=item B<HOME> 1747=item B<HOME>
1227 1748
1228Used to locate the default directory for the unix domain socket for 1749Used to locate the default directory for the unix domain socket for
1229daemon communications and to locate various resource files (such as 1750daemon communications and to locate various resource files (such as
1230C<.Xdefaults>) 1751C<.Xdefaults>)
1231 1752
1232=item B<XAPPLRESDIR> 1753=item B<XAPPLRESDIR>
1233 1754
1234Directory where various X resource files are being located. 1755Directory where application-specific X resource files are located.
1235 1756
1236=item B<XENVIRONMENT> 1757=item B<XENVIRONMENT>
1237 1758
1238If set and accessible, gives the name of a X resource file to be loaded by 1759If set and accessible, gives the name of a X resource file to be loaded by
1239@@RXVT_NAME@@. 1760@@RXVT_NAME@@.
1244 1765
1245=over 4 1766=over 4
1246 1767
1247=item B</usr/lib/X11/rgb.txt> 1768=item B</usr/lib/X11/rgb.txt>
1248 1769
1249Color names. 1770Colour names.
1250 1771
1251=back 1772=back
1252 1773
1253=head1 SEE ALSO 1774=head1 SEE ALSO
1254 1775
1776@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1255@@RXVT_NAME@@(7), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5) 1777@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1256
1257=head1 BUGS
1258
1259Check the BUGS file for an up-to-date list.
1260
1261Cursor change support is not yet implemented.
1262
1263Click-and-drag doesn't work with X11 mouse report overriding.
1264 1778
1265=head1 CURRENT PROJECT COORDINATOR 1779=head1 CURRENT PROJECT COORDINATOR
1266 1780
1267=over 4 1781=over 4
1268 1782
1269=item Project Coordinator 1783=item Project Coordinator
1270 1784
1271Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1785Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1272 1786
1273L<http://software.schmorp.de/#rxvt-unicode> 1787L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1274 1788
1275=back 1789=back
1276 1790
1277=head1 AUTHORS 1791=head1 AUTHORS
1278 1792
1280 1794
1281=item John Bovey 1795=item John Bovey
1282 1796
1283University of Kent, 1992, wrote the original Xvt. 1797University of Kent, 1992, wrote the original Xvt.
1284 1798
1285=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1799=item Rob Nation <nation@rocket.sanders.lockheed.com>
1286 1800
1287very heavily modified Xvt and came up with Rxvt 1801very heavily modified Xvt and came up with Rxvt
1288 1802
1289=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1803=item Angelo Haritsis <ah@doc.ic.ac.uk>
1290 1804
1291wrote the Greek Keyboard Input (no longer in code) 1805wrote the Greek Keyboard Input (no longer in code)
1292 1806
1293=item mj olesen L<< <olesen@me.QueensU.CA> >> 1807=item mj olesen <olesen@me.QueensU.CA>
1294 1808
1295Wrote the menu system. 1809Wrote the menu system.
1296 1810
1297Project Coordinator (changes.txt 2.11 to 2.21) 1811Project Coordinator (changes.txt 2.11 to 2.21)
1298 1812
1299=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1813=item Oezguer Kesim <kesim@math.fu-berlin.de>
1300 1814
1301Project Coordinator (changes.txt 2.21a to 2.4.5) 1815Project Coordinator (changes.txt 2.21a to 2.4.5)
1302 1816
1303=item Geoff Wing L<< <gcw@pobox.com> >> 1817=item Geoff Wing <gcw@pobox.com>
1304 1818
1305Rewrote screen display and text selection routines. Project Coordinator 1819Rewrote screen display and text selection routines.
1820
1306(changes.txt 2.4.6 - rxvt-unicode) 1821Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1307 1822
1308=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1823=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1309 1824
1310Forked rxvt-unicode, rewrote most of the display code and internal 1825Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1311character handling to store text in unicode, improve xterm 1826extension, random hacks, numerous bugfixes and extensions.
1312compatibility and apply numerous other bugfixes and extensions.
1313 1827
1314Project Coordinator (Changes 1.0 -) 1828Project Coordinator (Changes 1.0 -)
1315 1829
1830=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1831
1832pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1833
1316=back 1834=back
1317 1835

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines