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.83 by root, Tue Jan 3 22:28:07 2006 UTC vs.
Revision 1.260 by root, Fri Dec 23 21:46:46 2022 UTC

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

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines