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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines