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.69 by root, Tue Oct 25 19:04:45 2005 UTC vs.
Revision 1.250 by root, Sat Oct 10 20:06:45 2020 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>. See also the B<-sh> 147is used by many window managers, taskbars and pagers to represent the
130option that can be used to brighten or darken the image in addition to 148application window; resource I<iconFile>.
131tinting it; resource I<tintColor>. Example:
132
133 @@RXVT_NAME@@ -tr -tint blue -sh 40
134
135=item B<-sh>
136
137I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent
138background image in addition to tinting it (i.e. B<-tint> must be
139specified, too, e.g. C<-tint white>).
140 149
141=item B<-bg> I<colour> 150=item B<-bg> I<colour>
142 151
143Window background colour; resource B<background>. 152Window background colour; resource B<background>.
144 153
145=item B<-fg> I<colour> 154=item B<-fg> I<colour>
146 155
147Window foreground colour; resource B<foreground>. 156Window foreground colour; resource B<foreground>.
148
149=item B<-pixmap> I<file[;geom]>
150
151Compile I<XPM>: Specify XPM file for the background and also optionally
152specify its scaling with a geometry string. Note you may need to
153add quotes to avoid special shell interpretation of the C<;> in the
154command-line; resource B<backgroundPixmap>.
155 157
156=item B<-cr> I<colour> 158=item B<-cr> I<colour>
157 159
158The cursor colour; resource B<cursorColor>. 160The cursor colour; resource B<cursorColor>.
159 161
171resource B<borderColor>. 173resource B<borderColor>.
172 174
173=item B<-fn> I<fontlist> 175=item B<-fn> I<fontlist>
174 176
175Select 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
176that are used in turn when trying to display Unicode characters. The 178that are checked in order when trying to find glyphs for characters. The
177first font defines the cell size for characters; other fonts might be 179first font defines the cell size for characters; other fonts might be
178smaller, but not (in general) larger. A (hopefully) reasonable default 180smaller, but not (in general) larger. A (hopefully) reasonable default
179font 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.
180 182
181In 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
182with 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:>,
183e.g.: 185e.g.:
184 186
185 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 187 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
186 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 188 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
188See 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
189section of @@RXVT_NAME@@(7). 191section of @@RXVT_NAME@@(7).
190 192
191=item B<-fb> I<fontlist> 193=item B<-fb> I<fontlist>
192 194
193Compile 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
194be printed. See resource B<boldFont> for details. 196are to be printed. See resource B<boldFont> for details.
195 197
196=item B<-fi> I<fontlist> 198=item B<-fi> I<fontlist>
197 199
198Compile 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>
199be printed. See resource B<italicFont> for details. 201characters are to be printed. See resource B<italicFont> for details.
200 202
201=item B<-fbi> I<fontlist> 203=item B<-fbi> I<fontlist>
202 204
203Compile 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
204be 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.
205 214
206=item B<-name> I<name> 215=item B<-name> I<name>
207 216
208Specify the application name under which resources are to be obtained, 217Specify the application name under which resources are to be obtained,
209rather than the default executable file name. Name should not contain 218rather than the default executable file name. Name should not contain
211 220
212=item B<-ls>|B<+ls> 221=item B<-ls>|B<+ls>
213 222
214Start as a login-shell/sub-shell; resource B<loginShell>. 223Start as a login-shell/sub-shell; resource B<loginShell>.
215 224
225=item B<-mc> I<milliseconds>
226
227Specify the maximum time between multi-click selections.
228
216=item B<-ut>|B<+ut> 229=item B<-ut>|B<+ut>
217 230
218Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 231Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
219B<utmpInhibit>. 232B<utmpInhibit>.
220 233
224B<visualBell>. 237B<visualBell>.
225 238
226=item B<-sb>|B<+sb> 239=item B<-sb>|B<+sb>
227 240
228Turn 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>.
229 251
230=item B<-si>|B<+si> 252=item B<-si>|B<+si>
231 253
232Turn on/off scroll-to-bottom on TTY output inhibit; resource 254Turn on/off scroll-to-bottom on TTY output inhibit; resource
233B<scrollTtyOutput> has opposite effect. 255B<scrollTtyOutput> has opposite effect.
240=item B<-sw>|B<+sw> 262=item B<-sw>|B<+sw>
241 263
242Turn on/off scrolling with the scrollback buffer as new lines appear. 264Turn on/off scrolling with the scrollback buffer as new lines appear.
243This only takes effect if B<-si> is also given; resource 265This only takes effect if B<-si> is also given; resource
244B<scrollWithBuffer>. 266B<scrollWithBuffer>.
245
246=item B<-sr>|B<+sr>
247
248Put scrollbar on right/left; resource B<scrollBar_right>.
249
250=item B<-st>|B<+st>
251
252Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
253resource B<scrollBar_floating>.
254 267
255=item B<-ptab>|B<+ptab> 268=item B<-ptab>|B<+ptab>
256 269
257If enabled (default), "Horizontal Tab" characters are being stored as 270If enabled (default), "Horizontal Tab" characters are being stored as
258actual wide characters in the screen buffer, which makes it possible to 271actual wide characters in the screen buffer, which makes it possible to
262 275
263=item B<-bc>|B<+bc> 276=item B<-bc>|B<+bc>
264 277
265Blink the cursor; resource B<cursorBlink>. 278Blink the cursor; resource B<cursorBlink>.
266 279
280=item B<-uc>|B<+uc>
281
282Make the cursor underlined; resource B<cursorUnderline>.
283
267=item B<-iconic> 284=item B<-iconic>
268 285
269Start iconified, if the window manager supports that option. 286Start iconified, if the window manager supports that option.
270Alternative form is B<-ic>. 287Alternative form is B<-ic>.
271 288
287 304
288=item B<-bl> 305=item B<-bl>
289 306
290Compile 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.
291if 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
292decorations; 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>.
293 328
294=item B<-lsp> I<number> 329=item B<-lsp> I<number>
295 330
296Compile I<frills>: Lines (pixel height) to insert between each row of 331Compile I<frills>: Lines (pixel height) to insert between each row of
297the display. Useful to work around font rendering problems; resource 332the display. Useful to work around font rendering problems; resource
298B<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>.
299 341
300=item B<-tn> I<termname> 342=item B<-tn> I<termname>
301 343
302This 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
303B<TERM> environment variable. This terminal type must exist in the 345B<TERM> environment variable. This terminal type must exist in the
312given on the command line. If this option is used, it must be the last 354given on the command line. If this option is used, it must be the last
313on the command-line. If there is no B<-e> option then the default is to 355on the command-line. If there is no B<-e> option then the default is to
314run the program specified by the B<SHELL> environment variable or, 356run the program specified by the B<SHELL> environment variable or,
315failing that, I<sh(1)>. 357failing that, I<sh(1)>.
316 358
359Please note that you must specify a program with arguments. If you want to
360run shell commands, you have to specify the shell, like this:
361
362 @@RXVT_NAME@@ -e sh -c "shell commands"
363
317=item B<-title> I<text> 364=item B<-title> I<text>
318 365
319Window title (B<-T> still respected); the default title is the basename 366Window title (B<-T> still respected); the default title is the basename
320of the program specified after the B<-e> option, if any, otherwise the 367of the program specified after the B<-e> option, if any, otherwise the
321application name; resource B<title>. 368application name; resource B<title>.
332 379
333=item B<-pt> I<style> 380=item B<-pt> I<style>
334 381
335Compile I<XIM>: input style for input method; B<OverTheSpot>, 382Compile I<XIM>: input style for input method; B<OverTheSpot>,
336B<OffTheSpot>, B<Root>; resource B<preeditType>. 383B<OffTheSpot>, B<Root>; resource B<preeditType>.
384
385If the perl extension C<xim-onthespot> is used (which is the default),
386then additionally the C<OnTheSpot> preedit type is available.
337 387
338=item B<-im> I<text> 388=item B<-im> I<text>
339 389
340Compile I<XIM>: input method name. resource B<inputMethod>. 390Compile I<XIM>: input method name. resource B<inputMethod>.
341 391
352for more info. 402for more info.
353 403
354=item B<-tcw> 404=item B<-tcw>
355 405
356Change 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
357button. 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
358end of the logical line only. resource B<tripleclickwords>. 409the end of the logical line only. resource B<tripleclickwords>.
359 410
360=item B<-insecure> 411=item B<-insecure>
361 412
362Enable "insecure" mode, which currently enables most of the escape 413Enable "insecure" mode, which currently enables most of the escape
363sequences that echo strings. See the resource B<insecure> for more 414sequences that echo strings. See the resource B<insecure> for more
377=item B<-ssr>|B<+ssr> 428=item B<-ssr>|B<+ssr>
378 429
379Turn on/off secondary screen scroll (default enabled); resource 430Turn on/off secondary screen scroll (default enabled); resource
380B<secondaryScroll>. 431B<secondaryScroll>.
381 432
433=item B<-hold>|B<+hold>
434
435Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
436will not immediately destroy its window when the program executed within
437it exits. Instead, it will wait till it is being killed or closed by the
438user; resource B<hold>.
439
440=item B<-cd> I<path>
441
442Sets the working directory for the shell (or the command specified via
443B<-e>). The I<path> must be an absolute path and it must exist for
444@@RXVT_NAME@@ to start; resource B<chdir>.
445
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
382=item B<-keysym.>I<sym> I<string> 459=item B<-keysym.>I<sym> I<string>
383 460
384Remap a key symbol. See resource B<keysym>. 461Remap a key symbol. See resource B<keysym>.
385 462
386=item B<-embed> I<windowid> 463=item B<-embed> I<windowid>
387 464
388Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 465Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
389which enables applications to easily embed a terminal. 466which enables applications to easily embed a terminal.
390 467
391Right 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
392shouldn'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
393quite 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
396The window will not be destroyed when @@RXVT_NAME@@ exits. 473The window will not be destroyed when @@RXVT_NAME@@ exits.
397 474
398It 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
399descriptors 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
400can use file descriptors to communicate with the programs within the 477can use file descriptors to communicate with the programs within the
401terminal. 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
402not. 479not.
403 480
404Here 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
405used (a longer example is in F<doc/embed>): 482used (a longer example is in F<doc/embed>):
406 483
408 $rxvt->signal_connect_after (realize => sub { 485 $rxvt->signal_connect_after (realize => sub {
409 my $xid = $_[0]->window->get_xid; 486 my $xid = $_[0]->window->get_xid;
410 system "@@RXVT_NAME@@ -embed $xid &"; 487 system "@@RXVT_NAME@@ -embed $xid &";
411 }); 488 });
412 489
413=item B<-pty-fd> I<fileno> 490=item B<-pty-fd> I<file descriptor>
414 491
415Tells @@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
416pair 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
417useful 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
418without having to run a program within it. 495without having to run a program within it.
419 496
420If 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
421entries 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
422yourself 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.
423 504
424Here 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
425longer example is in F<doc/pty-fd>): 506longer example is in F<doc/pty-fd>):
426 507
427 use IO::Pty; 508 use IO::Pty;
434 515
435 # now communicate with rxvt 516 # now communicate with rxvt
436 my $slave = $pty->slave; 517 my $slave = $pty->slave;
437 while (<$slave>) { print $slave "got <$_>\n" } 518 while (<$slave>) { print $slave "got <$_>\n" }
438 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
439=back 525=back
440 526
441=head1 RESOURCES (available also as long-options) 527=head1 RESOURCES
442 528
443Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 529Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
444options) compiled into your version. 530options) compiled into your version. All resources are also available as
531long-options.
445 532
446There 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
447Xresource data: using the X libraries (Xrm*-functions) or internal 534distribution do also load settings from the B<~/.Xresources> file when X
448Xresources reader (B<~/.Xdefaults>). For the first method (ie. 535starts. @@RXVT_NAME@@ will consult the following files/resources in order,
449B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 536with later settings overwriting earlier ones:
450resources using X11 tools like B<xrdb>. Many distribution do also load
451settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
452will consult the following files/resources in order, with later settings
453overwriting earlier ones:
454 537
455 1. system-wide app-defaults file, either locale-dependent OR global
456 2. app-defaults file in $XAPPLRESDIR 538 1. app-defaults file in $XAPPLRESDIR
539 2. $HOME/.Xdefaults
457 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 540 3. RESOURCE_MANAGER property on root-window of screen 0
458 4. SCREEN_RESOURCES for the current screen 541 4. SCREEN_RESOURCES property on root-window of the current screen
459 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 542 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
543 6. resources specified via -xrm on the commandline
460 544
461If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
462lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
463set in XAPPLOADDIR/URxvt (compile-time defined: usually
464B</usr/lib/X11/app-defaults/URxvt>) and resources set in
465B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
466Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 545Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
467class 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
468resources 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
469easily configured, while the class name B<URxvt> allows resources 548configured, while the class name B<URxvt> allows resources unique to
470unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 549B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
471shared between different B<@@RXVT_NAME@@> configurations. If no 550configurations. If no resources are specified, suitable defaults will
472resources are specified, suitable defaults will be used. Command-line 551be used. Command-line arguments can be used to override resource
473arguments can be used to override resource settings. The following 552settings. The following resources are supported (you might want to
474resources are allowed: 553check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
554extensions not documented here):
475 555
476=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.
477 569
478=item B<geometry:> I<geom> 570=item B<geometry:> I<geom>
479 571
480Create the window with the specified X window geometry [default 80x24]; 572Create the window with the specified X window geometry [default 80x24];
481option B<-geometry>. 573option B<-geometry>.
495Use 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
496corresponds to low-intensity (normal) colours and 8-15 corresponds to 588corresponds to low-intensity (normal) colours and 8-15 corresponds to
497high-intensity (bold = bright foreground, blink = bright background) 589high-intensity (bold = bright foreground, blink = bright background)
498colours. 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,
4993=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
500names used are listed in the B<COLORS AND GRAPHICS> section. 592names used are listed in the B<COLOURS AND GRAPHICS> section.
501 593
502Colours 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
503changed using an escape command (see @@RXVT_NAME@@(7)). 595changed using an escape command (see @@RXVT_NAME@@(7)).
504 596
505Colours 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
516=item B<colorUL:> I<colour> 608=item B<colorUL:> I<colour>
517 609
518Use the specified colour to display underlined characters when the 610Use the specified colour to display underlined characters when the
519foreground colour is the default. 611foreground colour is the default.
520 612
521=item B<colorRV:> I<colour>
522
523Use the specified colour as the background for reverse video
524characters.
525
526=item B<underlineColor:> I<colour> 613=item B<underlineColor:> I<colour>
527 614
528If set, use the specified colour as the colour for the underline 615If set, use the specified colour as the colour for the underline
529itself. 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.
530 627
531=item B<cursorColor:> I<colour> 628=item B<cursorColor:> I<colour>
532 629
533Use 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
534foreground colour; option B<-cr>. 631foreground colour; option B<-cr>.
541 638
542=item B<reverseVideo:> I<boolean> 639=item B<reverseVideo:> I<boolean>
543 640
544B<True>: simulate reverse video by foreground and background colours; 641B<True>: simulate reverse video by foreground and background colours;
545option B<-rv>. B<False>: regular screen colours [default]; option 642option B<-rv>. B<False>: regular screen colours [default]; option
546B<+rv>. See note in B<COLORS AND GRAPHICS> section. 643B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
547 644
548=item B<jumpScroll:> I<boolean> 645=item B<jumpScroll:> I<boolean>
549 646
550B<True>: specify that jump scrolling should be used. When scrolling 647B<True>: specify that jump scrolling should be used. When receiving lots
551quickly, 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
552B<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>.
553 654
554=item B<inheritPixmap:> I<boolean> 655=item B<skipScroll:> I<boolean>
555 656
556B<True>: make the background inherit the parent windows' pixmap, giving 657B<True>: (the default) specify that skip scrolling should be used. When
557artificial transparency. B<False>: do not inherit the parent windows' 658receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
558pixmap. 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>.
559 666
560=item B<fading:> I<number> 667=item B<fading:> I<number>
561 668
562Fade 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>.
563 670
564=item B<fadeColor:> I<colour> 671=item B<fadeColor:> I<colour>
565 672
566Fade 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
567colour is black; option B<-fadecolor>. 674colour is black; option B<-fadecolor>.
568 675
569=item B<tintColor:> I<colour> 676=item B<iconFile:> I<file>
570 677
571Tint the transparent background pixmap with the given colour; option 678Set the application icon pixmap; option B<-icon>.
572B<-tint>.
573
574=item B<shading:> I<number>
575
576Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
577image in addition to tinting it.
578 679
579=item B<scrollColor:> I<colour> 680=item B<scrollColor:> I<colour>
580 681
581Use the specified colour for the scrollbar [default #B2B2B2]. 682Use the specified colour for the scrollbar [default #B2B2B2].
582 683
588=item B<borderColor:> I<colour> 689=item B<borderColor:> I<colour>
589 690
590The 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
591and the text. 692and the text.
592 693
593=item B<backgroundPixmap:> I<file[;geom]>
594
595Use the specified XPM file (note the `.xpm' extension is optional) for
596the background and also optionally specify its scaling with a geometry
597string B<WxH+X+Y>, in which B<"W" / "H"> specify the
598horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image
599centre (percent). A scale of 0 displays the image with tiling. A scale
600of 1 displays the image without any scaling. A scale of 2 to 9
601specifies an integer number of images in that direction. No image will
602be magnified beyond 10 times its original size. The maximum permitted
603scale is 1000. [default 0x0+50+50]
604
605=item B<menu:> I<file[;tag]>
606
607Read in the specified menu file (note the `.menu' extension is
608optional) and also optionally specify a starting tag to find. See the
609reference documentation for details on the syntax for the menuBar.
610
611=item B<path:> I<path>
612
613Specify the colon-delimited search path for finding files (XPM and
614menus), in addition to the paths specified by the B<RXVTPATH> and
615B<PATH> environment variables.
616
617=item B<font:> I<fontlist> 694=item B<font:> I<fontlist>
618 695
619Select 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
620names that are used in turn when trying to display Unicode characters. 697that are checked in order when trying to find glyphs for characters. The
621The first font defines the cell size for characters; other fonts might 698first font defines the cell size for characters; other fonts might be
622be smaller, but not larger. A reasonable default font list is always 699smaller, but not (in general) larger. A (hopefully) reasonable default
623appended to it. option B<-fn>. 700font list is always appended to it; option B<-fn>.
624 701
625Each 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
626optional 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:>.
627 704
628In addition, each font can be prefixed with additional hints and 705In addition, each font can be prefixed with additional hints and
630hint 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
631fonts. 708fonts.
632 709
633For example, this font resource 710For example, this font resource
634 711
635 URxvt*font: 9x15bold,\ 712 URxvt.font: 9x15bold,\
636 -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,\
637 -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, \
638 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 715 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
639 xft:Code2000:antialias=false 716 xft:Code2000:antialias=false
640 717
643it 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
644wide and 15 pixels high. 721wide and 15 pixels high.
645 722
646The 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
647the base font, likewise the third, which is unfortunately non-bold, but 724the base font, likewise the third, which is unfortunately non-bold, but
648the 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
649useful supplement. 726useful supplement.
650 727
651The 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
652are 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
653contains other characters, but we are not interested in them. 730contains other characters, but we are not interested in them.
674not possible, replacement fonts of the desired shape will be tried. 751not possible, replacement fonts of the desired shape will be tried.
675 752
676If 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
677text font will being used for the given style. 754text font will being used for the given style.
678 755
679=item B<selectstyle:> I<mode> 756=item B<intensityStyles:> I<boolean>
680 757
681Set 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>,
682xterm style with 2.20 old word selection, or anything else which gives 759option B<-is>, the default), bold/blink font styles imply high
683xterm style selection. 760intensity foreground/background colours. Disabling this option (B<False>,
684 761option B<+is>) disables this behaviour, the high intensity colours are not
685=item B<scrollstyle:> I<mode> 762reachable.
686
687Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
688the author's favourite.
689 763
690=item B<title:> I<string> 764=item B<title:> I<string>
691 765
692Set window title string, the default title is the command-line 766Set window title string, the default title is the command-line
693specified after the B<-e> option, if any, otherwise the application 767specified after the B<-e> option, if any, otherwise the application
702=item B<mapAlert:> I<boolean> 776=item B<mapAlert:> I<boolean>
703 777
704B<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
705de-iconify (map) on receipt of a bell character [default]. 779de-iconify (map) on receipt of a bell character [default].
706 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
707=item B<visualBell:> I<boolean> 788=item B<visualBell:> I<boolean>
708 789
709B<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>.
710B<False>: no visual bell [default]; option B<+vb>. 791B<False>: no visual bell [default]; option B<+vb>.
711 792
713 794
714B<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
715the 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
716[default]; option B<+ls>. 797[default]; option B<+ls>.
717 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
718=item B<utmpInhibit:> I<boolean> 804=item B<utmpInhibit:> I<boolean>
719 805
720B<True>: inhibit writing record into the system log file B<utmp>; 806B<True>: inhibit writing record into the system log file B<utmp>;
721option 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>
722[default]; option B<+ut>. 808[default]; option B<+ut>.
729 815
730The 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.
731 817
732Example: 818Example:
733 819
734 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 820 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
735 821
736This 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
737everytime 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.
738 833
739=item B<scrollBar:> I<boolean> 834=item B<scrollBar:> I<boolean>
740 835
741B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 836B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
742disable the scrollbar; option B<+sb>. 837disable the scrollbar; option B<+sb>.
762B<False>: do not scroll to bottom when tty receives output; option 857B<False>: do not scroll to bottom when tty receives output; option
763B<+si>. 858B<+si>.
764 859
765=item B<scrollWithBuffer:> I<boolean> 860=item B<scrollWithBuffer:> I<boolean>
766 861
767B<True>: scroll with scrollback buffer when tty receives new lines (and 862B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
768B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 863try to show the same lines) and B<scrollTtyOutput> is False; option
769with 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>.
770 866
771=item B<scrollTtyKeypress:> I<boolean> 867=item B<scrollTtyKeypress:> I<boolean>
772 868
773B<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
774are those which are intercepted by rxvt-unicode for special handling and 870are those which are intercepted by rxvt-unicode for special handling and
775are not passed onto the shell; option B<-sk>. B<False>: do not scroll to 871are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
776bottom when a non-special key is pressed; option B<+sk>. 872bottom when a non-special key is pressed; option B<+sk>.
777 873
778=item B<saveLines:> I<number> 874=item B<saveLines:> I<number>
779 875
780Save I<number> lines in the scrollback buffer [default 64]. This 876Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
781resource is limited on most machines to 65535; option B<-sl>.
782 877
783=item B<internalBorder:> I<number> 878=item B<internalBorder:> I<number>
784 879
785Internal border of I<number> pixels. This resource is limited to 100; 880Internal border of I<number> pixels. This resource is limited to 100;
786option B<-b>. 881option B<-b>.
793=item B<borderLess:> I<boolean> 888=item B<borderLess:> I<boolean>
794 889
795Set MWM hints to request a borderless window, i.e. if honoured by the 890Set MWM hints to request a borderless window, i.e. if honoured by the
796WM, the rxvt-unicode window will not have window decorations; option B<-bl>. 891WM, the rxvt-unicode window will not have window decorations; option B<-bl>.
797 892
893=item B<skipBuiltinGlyphs:> I<boolean>
894
895Compile I<frills>: Disable the usage of the built-in block graphics/line
896drawing characters and just rely on what the specified fonts provide. Use
897this if you have a good font and want to use its block graphic glyphs;
898option B<-sbg>.
899
798=item B<termName:> I<termname> 900=item B<termName:> I<termname>
799 901
800Specifies the terminal type name to be set in the B<TERM> environment 902Specifies the terminal type name to be set in the B<TERM> environment
801variable; option B<-tn>. 903variable; option B<-tn>.
802 904
803=item B<linespace:> I<number> 905=item B<lineSpace:> I<number>
804 906
805Specifies number of lines (pixel height) to insert between each row of 907Specifies number of lines (pixel height) to insert between each row of
806the display [default 0]; option B<-lsp>. 908the display [default 0]; option B<-lsp>.
807 909
808=item B<meta8:> I<boolean> 910=item B<meta8:> I<boolean>
822 924
823=item B<cursorBlink:> I<boolean> 925=item B<cursorBlink:> I<boolean>
824 926
825B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 927B<True>: blink the cursor. B<False>: do not blink the cursor [default];
826option B<-bc>. 928option B<-bc>.
929
930=item B<cursorUnderline:> I<boolean>
931
932B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
933option B<-uc>.
827 934
828=item B<pointerBlank:> I<boolean> 935=item B<pointerBlank:> I<boolean>
829 936
830B<True>: blank the pointer when a key is pressed or after a set number 937B<True>: blank the pointer when a key is pressed or after a set number
831of seconds of inactivity. B<False>: the pointer is always visible 938of seconds of inactivity. B<False>: the pointer is always visible
837 944
838=item B<pointerColor2:> I<colour> 945=item B<pointerColor2:> I<colour>
839 946
840Mouse pointer background colour. 947Mouse pointer background colour.
841 948
949=item B<pointerShape:> I<string>
950
951Compile I<frills>: Specifies the name of the mouse pointer shape
952[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
953file for possible values (omit the C<XC_> prefix).
954
842=item B<pointerBlankDelay:> I<number> 955=item B<pointerBlankDelay:> I<number>
843 956
844Specifies number of seconds before blanking the pointer [default 2]. Use a 957Specifies number of seconds before blanking the pointer [default 2]. Use a
845large number (e.g. C<987654321>) to effectively disable the timeout. 958large number (e.g. C<987654321>) to effectively disable the timeout.
846 959
847=item B<backspacekey:> I<string> 960=item B<backspacekey:> I<string>
848 961
849The string to send when the backspace key is pressed. If set to B<DEC> 962The string to send when the backspace key is pressed. If set to B<DEC>
850or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 963or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
851(code 8) - which can be reversed with the appropriate DEC private mode 964(code 8) - which can be reversed with the appropriate DEC private mode
852escape sequence. 965escape sequence.
853 966
854=item B<deletekey:> I<string> 967=item B<deletekey:> I<string>
855 968
857pressed. If unset it will send the sequence traditionally associated 970pressed. If unset it will send the sequence traditionally associated
858with the B<Execute> key. 971with the B<Execute> key.
859 972
860=item B<cutchars:> I<string> 973=item B<cutchars:> I<string>
861 974
862The characters used as delimiters for double-click word selection. The 975The characters used as delimiters for double-click word selection
863built-in default: 976(whitespace delimiting is added automatically if resource is given).
864 977
978When the perl selection extension is in use (the default if compiled
979in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
980characters will be created (if the resource exists, otherwise, no regex
981will be created). In this mode, characters outside ISO-8859-1 can be used.
982
983When the selection extension is not used, only ISO-8859-1 characters can
984be used. If not specified, the built-in default is used:
985
865B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 986B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
866 987
867=item B<preeditType:> I<style> 988=item B<preeditType:> I<style>
868 989
869B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 990B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
870 991
871=item B<inputMethod:> I<name> 992=item B<inputMethod:> I<name>
872 993
873I<name> of inputMethod to use; option B<-im>. 994I<name> of inputMethod to use; option B<-im>.
874 995
875=item B<imLocale:> I<name> 996=item B<imLocale:> I<name>
876 997
877The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g. 998The locale to use for opening the IM. You can use an C<LC_CTYPE> of e.g.
878C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the 999C<de_DE.UTF-8> for normal text processing but C<ja_JP.EUC-JP> for the
879input extension to be able to input japanese characters while staying in 1000input extension to be able to input japanese characters while staying in
880another locale. option B<-imlocale>. 1001another locale; option B<-imlocale>.
881 1002
882=item B<imFont:> I<fontset> 1003=item B<imFont:> I<fontset>
883 1004
884Specify the font-set used for XIM styles C<OverTheSpot> or 1005Specify the font-set used for XIM styles C<OverTheSpot> or
885C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated 1006C<OffTheSpot>. It must be a standard X font set (XLFD patterns separated
890 1011
891=item B<tripleclickwords:> I<boolean> 1012=item B<tripleclickwords:> I<boolean>
892 1013
893Change the meaning of triple-click selection with the left mouse 1014Change the meaning of triple-click selection with the left mouse
894button. Instead of selecting a full line it will extend the selection to 1015button. Instead of selecting a full line it will extend the selection to
895the end of the logical line only. option B<-tcw>. 1016the end of the logical line only; option B<-tcw>.
896 1017
897=item B<insecure:> I<boolean> 1018=item B<insecure:> I<boolean>
898 1019
899Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1020Enables "insecure" mode. Rxvt-unicode offers some escape sequences that
900echo arbitrary strings like the icon name or the locale. This could be 1021echo arbitrary strings like the icon name or the locale. This could be
901abused if somebody gets 8-bit-clean access to your display, whether 1022abused if somebody gets 8-bit-clean access to your display, whether
902throuh a mail client displaying mail bodies unfiltered or though 1023through a mail client displaying mail bodies unfiltered or through
903write(1). Therefore, these sequences are disabled by default. (Note 1024write(1) or any other means. Therefore, these sequences are disabled by
904that other terminals, including xterm, have these sequences 1025default. (Note that many other terminals, including xterm, have these
905enabled by default). You can enable them by setting this boolean 1026sequences enabled by default, which doesn't make it safer, though).
906resource or specifying B<-insecure> as an option. At the moment, this 1027
907enabled display-answer, locale, findfont, icon label and window title 1028You can enable them by setting this boolean resource or specifying
908requests as well as dynamic menubar dispatch. 1029B<-insecure> as an option. At the moment, this enables display-answer,
1030locale, findfont, icon label and window title requests.
909 1031
910=item B<modifier:> I<modifier> 1032=item B<modifier:> I<modifier>
911 1033
912Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 1034Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
913B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 1035B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
917 1039
918Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1040Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
919character is passed through. It may contain escape values as described 1041character is passed through. It may contain escape values as described
920in the entry on B<keysym> following. 1042in the entry on B<keysym> following.
921 1043
922=item B<secondaryScreen:> I<bool> 1044=item B<secondaryScreen:> I<boolean>
923 1045
924Turn on/off secondary screen (default enabled). 1046Turn on/off secondary screen (default enabled).
925 1047
926=item B<secondaryScroll:> I<bool> 1048=item B<secondaryScroll:> I<boolean>
927 1049
928Turn on/off secondary screen scroll (default enabled). If the this 1050Turn on/off secondary screen scroll (default enabled). If this
929option is enabled, scrolls on the secondary screen will change the 1051option is enabled, scrolls on the secondary screen will change the
930scrollback buffer and switching to/from the secondary screen will 1052scrollback buffer and, when secondaryScreen is off, switching
931instead scroll the screen up. 1053to/from the secondary screen will instead scroll the screen up.
932 1054
1055=item B<hold>: I<boolean>
1056
1057Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1058will not immediately destroy its window when the program executed within
1059it exits. Instead, it will wait till it is being killed or closed by the
1060user.
1061
1062=item B<chdir>: I<path>
1063
1064Sets the working directory for the shell (or the command specified via
1065B<-e>). The I<path> must be an absolute path and it must exist for
1066@@RXVT_NAME@@ to start. If it isn't specified then the current working
1067directory will be used; option B<-cd>.
1068
933=item B<keysym.>I<sym>: I<string> 1069=item B<keysym.>I<sym>: I<action>
934 1070
935Compile I<frills>: Associate I<string> with keysym I<sym>. The 1071Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
936intervening resource name B<keysym.> cannot be omitted. 1072resource name B<keysym.> cannot be omitted.
937 1073
938The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1074Using this resource, you can map key combinations such as
939any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1075C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
940B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, 1076string than would normally result from that combination, making the
941and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 1077terminal scroll up or down the way you want it, or any other thing an
942B<2>, B<3>, B<4>, B<5>. 1078extension might provide.
1079
1080The key combination that triggers the action, I<sym>, has the following format:
1081
1082 (modifiers-)key
1083
1084Where I<modifiers> can be any combination of the following full or
1085abbreviated modifier names:
1086
1087=begin table
1088
1089 B<ISOLevel3> B<I>
1090 B<AppKeypad> B<K>
1091 B<Control> B<C>
1092 B<NumLock> B<N>
1093 B<Shift> B<S>
1094 B<Meta> B<M> I<or> B<A>
1095 B<Lock> B<L>
1096 B<Mod1> B<1>
1097 B<Mod2> B<2>
1098 B<Mod3> B<3>
1099 B<Mod4> B<4>
1100 B<Mod5> B<5>
1101
1102=end table
943 1103
944The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1104The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
945whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1105whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
946keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1106keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
947current application keymap mode state. 1107current application keymap mode state.
948 1108
949The spellings of I<key> can be obtained by using B<xev>(1) command or 1109Due the the large number of modifier combinations, a key mapping will
950searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1110match if I<at least> the specified identifiers are being set, and no other
1111key mappings with those and more bits are being defined. That means that
1112defining a mapping for C<a> will automatically provide definitions for
1113C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1114themselves. See the C<builtin:> action, below, for a way to work around
1115this when this is a problem.
1116
1117The spelling of I<key> depends on your implementation of X. An easy way to
1118find a key name is to use the B<xev>(1) command. You can find a list by
1119looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
951omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1120the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
952keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1121value (B<0x0000 - 0xFFFF>).
953performed in an exact manner; however, the closest match is assured.
954 1122
955I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1123As with any resource value, the I<action> string may contain backslash
956C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1124escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
957C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1125number), see RESOURCES in C<man 7 X> for further details.
958C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
959can start or end with whitespace.
960 1126
961Please note that you need to double the C<\> when using 1127An action starts with an action prefix that selects a certain type
962C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can 1128of action, followed by a colon. An action string without colons is
963use C<\033> instead of C<\e> (and so on), which will work with both Xt and 1129interpreted as a literal string to pass to the tty (as if it was
964@@RXVT_NAME@@'s own processing). 1130prefixed with C<string:>).
965 1131
966You can define a range of keysyms in one shot by providing a I<string> 1132The following action prefixes are known - extensions can provide
967with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1133additional prefixes:
1134
1135=over 4
1136
1137=item string:STRING
1138
1139If the I<action> starts with C<string:> (or otherwise contains no colons),
1140then the remaining C<STRING> will be passed to the program running in the
1141terminal. For example, you could replace whatever Shift-Tab outputs by the
1142string C<echo rm -rf /> followed by a newline:
1143
1144 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1145
1146This could in theory be used to completely redefine your keymap.
1147
1148In addition, for actions of this type, you can define a range of
1149keysyms in one shot by loading the C<keysym-list> perl extension and
1150providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
968should be a character not used by the strings. 1151the delimiter `/' should be a character not used by the strings.
969 1152
970Its usage can be demonstrated by an example: 1153Its usage can be demonstrated by an example:
971 1154
972 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1155 URxvt.keysym.M-C-0x61: list|\033<|abc|>
973 1156
974The above line is equivalent to the following three lines: 1157The above line is equivalent to the following three lines:
975 1158
976 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1159 URxvt.keysym.Meta-Control-0x61: string:\033<a>
977 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1160 URxvt.keysym.Meta-Control-0x62: string:\033<b>
978 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1161 URxvt.keysym.Meta-Control-0x63: string:\033<c>
979 1162
1163=item command:STRING
1164
980If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1165If I<action> takes the form of C<command:STRING>, the specified B<STRING>
981is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1166is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1167the opposite of C<string:> - instead of sending it to the program running
1168in the terminal, it will be treated as if it were program output). This is
1169most useful to feed command sequences into @@RXVT_NAME@@.
1170
982example the following means "change the current locale to C<zh_CN.GBK> 1171For example the following means "change the current locale to C<zh_CN.GBK>
983when Control-Meta-c is being pressed": 1172when Control-Meta-c is being pressed":
984 1173
985 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1174 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
986 1175
987Due the the large number of modifier combinations, a defined key mapping 1176The following example will map Control-Meta-1 and Control-Meta-2 to
988will match if at I<at least> the specified identifiers are being set, and 1177the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
989no other key mappings with those and more bits are being defined. That 1178font-switching at runtime:
990means that defining a key map for C<a> will automatically provide
991definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
992mappings themselves.
993 1179
994Unfortunately, this will override built-in key mappings. For example 1180 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1181 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1182
1183Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1184info):
1185
1186 URxvt.keysym.M-C-3: command:\033[8;25;80t
1187 URxvt.keysym.M-C-4: command:\033[8;48;110t
1188
1189=item builtin:
1190
1191The builtin action is the action that @@RXVT_NAME@@ would execute if no
1192key binding existed for the key combination. The obvious use is to undo
1193the effect of existing bindings. The not so obvious use is to reinstate
1194bindings when another binding overrides too many modifiers.
1195
995if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1196For example if you overwrite the C<Insert> key you will disable
996C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1197@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
997user-defined keymap using the C<builtin:> replacement: 1198"holes" into the user-defined keymap using the C<builtin:> replacement:
998 1199
999 URxvt.keysym.Insert: <my insert key sequence> 1200 URxvt.keysym.Insert: <my insert key sequence>
1000 URxvt.keysym.S-Insert: builtin: 1201 URxvt.keysym.S-Insert: builtin:
1001 1202
1002The first line defines a mapping for C<Insert> and I<any> combination 1203The first line defines a mapping for C<Insert> and I<any> combination
1003of modifiers. The second line re-establishes the default mapping for 1204of modifiers. The second line re-establishes the default mapping for
1004C<Shift-Insert>. 1205C<Shift-Insert>.
1005 1206
1006The following example will map Control-Meta-1 and Control-Meta-2 to 1207=item builtin-string:
1007the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1008font-switching at runtime:
1009 1208
1010 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1209This action is mainly useful to restore string mappings for keys that
1011 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1210have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1211difficult to explain - basically, this action will send the string to the
1212application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1213action for it.
1012 1214
1013Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1215An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1014info): 1216selection when you press C<Shift-Insert>. With the following bindings, it
1217would instead emit the (undocumented, but what applications running in the
1218terminal might expect) sequence C<ESC [ 2 $> instead:
1015 1219
1016 URxvt.keysym.M-C-3: command:\033[8;25;80t 1220 URxvt.keysym.S-Insert: builtin-string:
1017 URxvt.keysym.M-C-4: command:\033[8;48;110t 1221 URxvt.keysym.C-S-Insert: builtin:
1222
1223The first line disables the paste functionality for that key
1224combination, and the second reinstates the default behaviour for
1225C<Control-Shift-Insert>, which would otherwise be overridden.
1226
1227Similarly, to let applications gain access to the C<C-M-c> (copy to
1228clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1229this:
1230
1231 URxvt.keysym.C-M-c: builtin-string:
1232 URxvt.keysym.C-M-v: builtin-string:
1233
1234=item EXTENSION:STRING
1235
1236An action of this form invokes the action B<STRING>, if any, provided
1237by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1238be loaded automatically if necessary.
1239
1240Not all extensions define actions, but popular extensions that do
1241include the I<selection> and I<matcher> extensions (documented in their
1242own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1243respectively).
1244
1245From the silly examples department, this will rot13-"encrypt"
1246@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1247keyboards:
1248
1249 URxvt.keysym.M-C-c: selection:rot13
1250
1251=item perl:STRING *DEPRECATED*
1252
1253This is a deprecated way of invoking commands provided by perl
1254extensions. It is still supported, but should not be used anymore.
1255
1256=back
1257
1258=item B<perl-ext-common>: I<string>
1259
1260=item B<perl-ext>: I<string>
1261
1262Comma-separated list(s) of perl extension scripts (default: C<default>) to
1263use in this terminal instance; option B<-pe>.
1264
1265Extension names can be prefixed with a C<-> sign to prohibit using
1266them. This can be useful to selectively disable some extensions loaded
1267by default, or specified via the C<perl-ext-common> resource. For
1268example, C<default,-selection> will use all the default extensions except
1269C<selection>.
1270
1271The default set includes the C<selection>, C<option-popup>,
1272C<selection-popup>, C<readline> and C<searchable-scrollback>
1273extensions, and extensions which are mentioned in B<keysym> resources.
1274
1275Any extension such that a corresponding resource is given on the
1276command line is automatically appended to B<perl-ext>.
1277
1278Each extension is looked up in the library directories, loaded if
1279necessary, and bound to the current terminal instance. When the library
1280search path contains multiple extension files of the same name, then the
1281first one found will be used.
1282
1283If both of these resources are the empty string, then the perl interpreter
1284will not be initialized. The rationale for having two options is that
1285B<perl-ext-common> will be used for extensions that should be available to
1286all instances, while B<perl-ext> is used for specific instances.
1287
1288=item B<perl-eval>: I<string>
1289
1290Perl code to be evaluated when all extensions have been registered. See
1291the @@RXVT_NAME@@perl(3) manpage.
1292
1293=item B<perl-lib>: I<path>
1294
1295Colon-separated list of additional directories that hold extension
1296scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1297in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1298lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1299
1300See the @@RXVT_NAME@@perl(3) manpage.
1301
1302=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1303
1304Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1305details.
1306
1307=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1308
1309Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1310for details.
1311
1312=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1313
1314This resource is deprecated and will be removed. Use a B<keysym> resource
1315instead, e.g.:
1316
1317 URxvt.keysym.M-s: searchable-scrollback:start
1318
1319=item B<url-launcher>: I<string>
1320
1321Specifies the program to be started with a URL argument. Used by the
1322C<selection-popup> and C<matcher> perl extensions.
1323
1324=item B<transient-for>: I<windowid>
1325
1326Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1327
1328=item B<override-redirect>: I<boolean>
1329
1330Compile I<frills>: Sets override-redirect for the terminal window, making
1331it almost invisible to window managers; option B<-override-redirect>.
1332
1333=item B<iso14755:> I<boolean>
1334
1335Turn on/off ISO 14755 (default enabled).
1336
1337=item B<iso14755_52:> I<boolean>
1338
1339Turn on/off ISO 14755 5.2 mode (default enabled).
1018 1340
1019=back 1341=back
1020 1342
1021=head1 THE SCROLLBAR 1343=head1 THE SCROLLBAR
1022 1344
1041application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1363application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1042(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1364(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1043up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1365up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1044respectively. 1366respectively.
1045 1367
1046=head1 TEXT SELECTION AND INSERTION 1368=head1 THE SELECTION: SELECTING AND PASTING TEXT
1047 1369
1048The behaviour of text selection and insertion mechanism is similar to 1370The behaviour of text selection and insertion/pasting mechanism is similar
1049I<xterm>(1). 1371to I<xterm>(1).
1050 1372
1051=over 4 1373=over 4
1052 1374
1053=item B<Selection>: 1375=item B<Selecting>:
1054 1376
1055Left click at the beginning of the region, drag to the end of the region 1377Left click at the beginning of the region, drag to the end of the region
1056and release; Right click to extend the marked region; Left double-click 1378and release; Right click to extend the marked region; Left double-click
1057to select a word; Left triple-click to select the entire logical line 1379to select a word; Left triple-click to select the entire logical line
1058(which can span multiple screen lines), unless modified by resource 1380(which can span multiple screen lines), unless modified by resource
1059B<tripleclickwords>. 1381B<tripleclickwords>.
1060 1382
1061Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys) 1383Starting a selection while pressing the B<Meta> key (or B<Meta+Ctrl> keys)
1062(Compile: I<frills>) will create a rectangular selection instead of a normal 1384(Compile: I<frills>) will create a rectangular selection instead of a
1063one. 1385normal one. In this mode, every selected row becomes its own line in the
1386selection, and trailing whitespace is visually underlined and removed from
1387the selection.
1064 1388
1065=item B<Insertion>: 1389=item B<Pasting>:
1066 1390
1067Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1391Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1068an B<@@RXVT_NAME@@> window causes the current text selection to be 1392window causes the value of the PRIMARY selection (or CLIPBOARD with the
1069inserted as if it had been typed on the keyboard. 1393B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1394
1395Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1396inserted too.
1397
1398rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1399<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1400binding causes the value of the internal selection to be copied to the
1401CLIPBOARD selection, while the second binding causes the value of the
1402CLIPBOARD selection to be inserted.
1070 1403
1071=back 1404=back
1072 1405
1073=head1 CHANGING FONTS 1406=head1 CHANGING FONTS
1074 1407
1075Changing fonts (or font sizes, respectively) via the keypad is not yet 1408Changing fonts (or font sizes, respectively) via the keypad is not yet
1076supported in rxvt-unicode. Bug me if you need this. 1409supported in rxvt-unicode. Bug me if you need this.
1077 1410
1078You can, however, switch fonts at runtime using escape sequences (and 1411You can, however, switch fonts at runtime using escape sequences, e.g.:
1079therefore using the menubar), e.g.:
1080 1412
1081 printf '\e]701;%s\007' "9x15bold,xft:Kochi Gothic" 1413 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1414
1415You can use keyboard shortcuts, too:
1416
1417 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1418 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1082 1419
1083rxvt-unicode will automatically re-apply these fonts to the output so far. 1420rxvt-unicode will automatically re-apply these fonts to the output so far.
1084 1421
1085=head1 ISO 14755 SUPPORT 1422=head1 ISO 14755 SUPPORT
1086 1423
1087ISO 14755 is a standard for entering and viewing unicode characters 1424ISO 14755 is a standard for entering and viewing unicode characters
1088and character codes using the keyboard. It consists of 4 parts. The 1425and character codes using the keyboard. It consists of 4 parts. The
1089first part is available rxvt-unicode has been compiled with 1426first part is available if rxvt-unicode has been compiled with
1090C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1427C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1091with C<--enable-iso14755>. 1428with C<--enable-iso14755>.
1092 1429
1093=over 4 1430=over 4
1094 1431
1114This mode lets you input characters representing the keycap symbols of 1451This mode lets you input characters representing the keycap symbols of
1115your keyboard, if representable in the current locale encoding. 1452your keyboard, if representable in the current locale encoding.
1116 1453
1117Start by pressing C<Control> and C<Shift> together, then releasing 1454Start by pressing C<Control> and C<Shift> together, then releasing
1118them. The next special key (cursor keys, home etc.) you enter will not 1455them. The next special key (cursor keys, home etc.) you enter will not
1119invoke it's usual function but instead will insert the corresponding 1456invoke its usual function but instead will insert the corresponding
1120keycap symbol. The symbol will only be entered when the key has been 1457keycap symbol. The symbol will only be entered when the key has been
1121released, otherwise pressing e.g. C<Shift> would enter the symbol for 1458released, otherwise pressing e.g. C<Shift> would enter the symbol for
1122C<ISO Level 2 Switch>, although your intention might have been to enter a 1459C<ISO Level 2 Switch>, although your intention might have been to enter a
1123reverse tab (Shift-Tab). 1460reverse tab (Shift-Tab).
1124 1461
1152B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1489B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1153it can be seen via the I<who(1)> command, and can accept messages. To 1490it can be seen via the I<who(1)> command, and can accept messages. To
1154allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1491allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1155on some systems or setgid to root or to some other group on others. 1492on some systems or setgid to root or to some other group on others.
1156 1493
1157=head1 COLORS AND GRAPHICS 1494=head1 COLOURS AND GRAPHICS
1158 1495
1159In addition to the default foreground and background colours, 1496In addition to the default foreground and background colours,
1160B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1497B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1161high-intensity bold/blink versions of the same). Here is a list of the 1498high-intensity (potentially bold/blink) versions of the same, and 72 (or
1162colours with their B<rgb.txt> names. 1499240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1500cube plus a 8 (24) colour greyscale ramp.
1501
1502B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
1503C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
1504number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
1505colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
150624-bit colour space. When indexing collisions happen, the nearest old colour in
1507the cube will be adapted to the new 24-bit RGB colour. That means one cannot
1508use many similar 24-bit colours. It's typically not a problem in common
1509scenarios.
1510
1511Here is a list of the ANSI colours with their names.
1163 1512
1164=begin table 1513=begin table
1165 1514
1166 B<color0> (black) = Black 1515 B<color0> (black) = Black
1167 B<color1> (red) = Red3 1516 B<color1> (red) = Red3
1187It is also possible to specify the colour values of B<foreground>, 1536It is also possible to specify the colour values of B<foreground>,
1188B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1537B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1189a number 0-15, as a convenient shorthand to reference the colour name of 1538a number 0-15, as a convenient shorthand to reference the colour name of
1190color0-color15. 1539color0-color15.
1191 1540
1541The following text gives values for the standard 88 colour mode (and
1542values for the 256 colour mode in parentheses).
1543
1544The RGB cube uses indices 16..79 (16..231) using the following formulas:
1545
1546 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1547 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1548
1549The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1550steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1551the RGB cube.
1552
1553Together, all those colours implement the 88 (256) colour xterm
1554colours. Only the first 16 can be changed using resources currently, the
1555rest can only be changed via command sequences ("escape codes").
1556
1557Applications are advised to use terminfo or command sequences to discover
1558number and RGB values of all colours (yes, you can query this...).
1559
1192Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1560Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1193always swapping the foreground/background colours. This is in contrast to 1561always swapping the foreground/background colours. This is in contrast to
1194I<xterm>(1) where the colours are only swapped if they have not otherwise 1562I<xterm>(1) where the colours are only swapped if they have not otherwise
1195been specified. For example, 1563been specified. For example,
1196 1564
1565 @@RXVT_NAME@@ -fg Black -bg White -rv
1566
1567would yield White on Black, while on I<xterm>(1) it would yield Black on
1568White.
1569
1570=head2 ALPHA CHANNEL SUPPORT
1571
1572If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1573their act together, rxvt-unicode will do its own alpha channel management:
1574
1575You can prefix any colour with an opaqueness percentage enclosed in
1576brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1577(0-100) that specifies the opacity of the colour, where C<0> is completely
1578transparent and C<100> is completely opaque. For example, C<[50]red> is a
1579half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1580is the recommended format to specify transparency values, and works with
1581all ways to specify a colour.
1582
1583For complete control, rxvt-unicode also supports
1584C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1585specifications, where the additional C<aaaa> component specifies opacity
1586(alpha) values. The minimum value of C<0000> is completely transparent,
1587while C<ffff> is completely opaque). The two example colours from
1588earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1589C<rgba:0000/ff00/0000/f332>.
1590
1591You probably need to specify B<"-depth 32">, too, to force a visual with
1592alpha channels, and have the luck that your X-server uses ARGB pixel
1593layout, as X is far from just supporting ARGB visuals out of the box, and
1594rxvt-unicode just fudges around.
1595
1596For example, the following selects an almost completely transparent black
1597background, and an almost opaque pink foreground:
1598
1599 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1600
1601When not using a background image, then the interpretation of the
1602alpha channel is up to your compositing manager (most interpret it as
1603transparency of course).
1604
1605When using a background pixmap or pseudo-transparency, then the background
1606colour will always behave as if it were completely transparent (so the
1607background image shows instead), regardless of how it was specified, while
1608other colours will either be transparent as specified (the background
1609image will show through) on servers supporting the RENDER extension, or
1610fully opaque on servers not supporting the RENDER EXTENSION.
1611
1612Please note that due to bugs in Xft, specifying alpha values might result
1613in garbage being displayed when the X-server does not support the RENDER
1614extension.
1615
1616=head1 ENVIRONMENT
1617
1618B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1619
1197=over 4 1620=over 4
1198 1621
1199=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1200
1201would yield White on Black, while on I<xterm>(1) it would yield Black
1202on White.
1203
1204=back
1205
1206=head1 ENVIRONMENT
1207
1208B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1209
1210=over 4
1211
1212=item B<TERM> 1622=item B<TERM>
1213 1623
1214Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1624Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1215resources or on the commandline. 1625resources or on the command line.
1216 1626
1217=item B<COLORTERM> 1627=item B<COLORTERM>
1218 1628
1219Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1629Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1220compiled with XPM support, and optionally with the added extension 1630compiled with background image support, and optionally with the added
1221C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1631extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1632screen.
1222 1633
1223=item B<COLORFGBG> 1634=item B<COLORFGBG>
1224 1635
1225Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1636Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1226the colour code used as default foreground/text colour (or the string 1637the colour code used as default foreground/text colour (or the string
1227C<default> to indicate that the default-colour escape sequence is to be 1638C<default> to indicate that the default-colour escape sequence is to be
1228used), C<bg> is the colour code used as default background colour (or the 1639used), C<bg> is the colour code used as default background colour (or the
1229string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1640string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1230was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1641was compiled with background image support. Libraries like C<ncurses>
1231(and do) use this information to optimize screen output. 1642and C<slang> can (and do) use this information to optimize screen output.
1232 1643
1233=item B<WINDOWID> 1644=item B<WINDOWID>
1234 1645
1235Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1646Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1236window, which usually has subwindows for the scrollbar, the terminal 1647window, which usually has subwindows for the scrollbar, the terminal
1242C<--with-terminfo=PATH>. 1653C<--with-terminfo=PATH>.
1243 1654
1244=item B<DISPLAY> 1655=item B<DISPLAY>
1245 1656
1246Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1657Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1247display in it's child processes. 1658display in its child processes if C<-display> isn't used to override. It
1659defaults to C<:0> if it doesn't exist.
1248 1660
1249=item B<SHELL> 1661=item B<SHELL>
1250 1662
1251The shell to be used for command execution, defaults to C</bin/sh>. 1663The shell to be used for command execution, defaults to C</bin/sh>.
1252 1664
1253=item B<RXVTPATH>
1254
1255The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1256files.
1257
1258=item B<PATH>
1259
1260Used in the same way as C<RXVTPATH>.
1261
1262=item B<RXVT_SOCKET> 1665=item B<RXVT_SOCKET> [I<sic>]
1263 1666
1264The unix domain socket path used by @@RXVT_NAME@@c(1) and 1667The unix domain socket path used by @@RXVT_NAME@@c(1) and
1265@@RXVT_NAME@@d(1). 1668@@RXVT_NAME@@d(1).
1266 1669
1267Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1670Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1671
1672=item B<URXVT_PERL_LIB>
1673
1674Additional F<:>-separated library search path for perl extensions. Will be
1675searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1676directory.
1677
1678=item B<URXVT_PERL_VERBOSITY>
1679
1680See L<@@RXVT_NAME@@perl>(3).
1268 1681
1269=item B<HOME> 1682=item B<HOME>
1270 1683
1271Used to locate the default directory for the unix domain socket for 1684Used to locate the default directory for the unix domain socket for
1272daemon communications and to locate various resource files (such as 1685daemon communications and to locate various resource files (such as
1273C<.Xdefaults>) 1686C<.Xdefaults>)
1274 1687
1275=item B<XAPPLRESDIR> 1688=item B<XAPPLRESDIR>
1276 1689
1277Directory where various X resource files are being located. 1690Directory where application-specific X resource files are located.
1278 1691
1279=item B<XENVIRONMENT> 1692=item B<XENVIRONMENT>
1280 1693
1281If set and accessible, gives the name of a X resource file to be loaded by 1694If set and accessible, gives the name of a X resource file to be loaded by
1282@@RXVT_NAME@@. 1695@@RXVT_NAME@@.
1287 1700
1288=over 4 1701=over 4
1289 1702
1290=item B</usr/lib/X11/rgb.txt> 1703=item B</usr/lib/X11/rgb.txt>
1291 1704
1292Color names. 1705Colour names.
1293 1706
1294=back 1707=back
1295 1708
1296=head1 SEE ALSO 1709=head1 SEE ALSO
1297 1710
1711@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1298@@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) 1712@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1299
1300=head1 BUGS
1301
1302Check the BUGS file for an up-to-date list.
1303
1304Cursor change support is not yet implemented.
1305
1306Click-and-drag doesn't work with X11 mouse report overriding.
1307 1713
1308=head1 CURRENT PROJECT COORDINATOR 1714=head1 CURRENT PROJECT COORDINATOR
1309 1715
1310=over 4 1716=over 4
1311 1717
1312=item Project Coordinator 1718=item Project Coordinator
1313 1719
1314Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1720Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1315 1721
1316L<http://software.schmorp.de/#rxvt-unicode> 1722L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1317 1723
1318=back 1724=back
1319 1725
1320=head1 AUTHORS 1726=head1 AUTHORS
1321 1727
1323 1729
1324=item John Bovey 1730=item John Bovey
1325 1731
1326University of Kent, 1992, wrote the original Xvt. 1732University of Kent, 1992, wrote the original Xvt.
1327 1733
1328=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1734=item Rob Nation <nation@rocket.sanders.lockheed.com>
1329 1735
1330very heavily modified Xvt and came up with Rxvt 1736very heavily modified Xvt and came up with Rxvt
1331 1737
1332=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1738=item Angelo Haritsis <ah@doc.ic.ac.uk>
1333 1739
1334wrote the Greek Keyboard Input (no longer in code) 1740wrote the Greek Keyboard Input (no longer in code)
1335 1741
1336=item mj olesen L<< <olesen@me.QueensU.CA> >> 1742=item mj olesen <olesen@me.QueensU.CA>
1337 1743
1338Wrote the menu system. 1744Wrote the menu system.
1339 1745
1340Project Coordinator (changes.txt 2.11 to 2.21) 1746Project Coordinator (changes.txt 2.11 to 2.21)
1341 1747
1342=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1748=item Oezguer Kesim <kesim@math.fu-berlin.de>
1343 1749
1344Project Coordinator (changes.txt 2.21a to 2.4.5) 1750Project Coordinator (changes.txt 2.21a to 2.4.5)
1345 1751
1346=item Geoff Wing L<< <gcw@pobox.com> >> 1752=item Geoff Wing <gcw@pobox.com>
1347 1753
1348Rewrote screen display and text selection routines. Project Coordinator 1754Rewrote screen display and text selection routines.
1755
1349(changes.txt 2.4.6 - rxvt-unicode) 1756Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1350 1757
1351=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1758=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1352 1759
1353Forked rxvt-unicode, rewrote most of the display code and internal 1760Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1354character handling to store text in unicode, improve xterm 1761extension, random hacks, numerous bugfixes and extensions.
1355compatibility and apply numerous other bugfixes and extensions.
1356 1762
1357Project Coordinator (Changes 1.0 -) 1763Project Coordinator (Changes 1.0 -)
1358 1764
1765=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1766
1767pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1768
1359=back 1769=back
1360 1770

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines