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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines