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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines