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.75 by root, Tue Dec 27 01:50:00 2005 UTC vs.
Revision 1.243 by root, Sat May 30 21:02:05 2015 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines