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.142 by ayin, Wed Oct 31 14:10:33 2007 UTC vs.
Revision 1.253 by root, Sat Jul 3 15:34:35 2021 UTC

12emulator intended as an I<xterm>(1) replacement for users who do not 12emulator intended as an I<xterm>(1) replacement for users who do not
13require features such as Tektronix 4014 emulation and toolkit-style 13require features such as Tektronix 4014 emulation and toolkit-style
14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16 16
17This document is also available on the World-Wide-Web at
18L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
19
17=head1 FREQUENTLY ASKED QUESTIONS 20=head1 FREQUENTLY ASKED QUESTIONS
18 21
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 22See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 23frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 24problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/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
30like mongolian or scripts requiring extremely complex combining rules, 33like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devanagari. 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 right-to-left 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 user friendly, lean and clean 43me recommend C<mlterm>, which is a very user friendly, lean and clean
89 92
90Print out a message describing available options. 93Print out a message describing available options.
91 94
92=item B<-display> I<displayname> 95=item B<-display> I<displayname>
93 96
94Attempt to open a window on the named X display (B<-d> still 97Attempt to open a window on the named X display (the older form B<-d>
95respected). In the absence of this option, the display specified by the 98is still respected. but deprecated). In the absence of this option, the
96B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
97 100
98=item B<-depth> I<bitdepth> 101=item B<-depth> I<bitdepth>
99 102
100Compile I<xft>: Attempt to find a visual with the given bit depth; 103Compile I<frills>: Attempt to find a visual with the given bit depth;
101resource B<depth>. 104resource B<depth>.
102 105
106[Please note that many X servers (and libXft) are buggy with
107respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out]
110
111=item B<-visual> I<visualID>
112
113Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for
114possible visual ids) instead of the default, and also allocate a private
115colormap. All visual types except for DirectColor are supported.
116
103=item B<-geometry> I<geom> 117=item B<-geometry> I<geom>
104 118
105Window geometry (B<-g> still respected); resource B<geometry>. 119Window geometry (B<-g> still respected); resource B<geometry>.
106 120
107=item B<-rv>|B<+rv> 121=item B<-rv>|B<+rv>
113Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>. 127Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
114 128
115=item B<-ss>|B<+ss> 129=item B<-ss>|B<+ss>
116 130
117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>. 131Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
118
119=item B<-tr>|B<+tr>
120
121Turn on/off illusion of a transparent window background. Obsolete form of it is
122B<-ip> and it should not be used anymore; resource B<transparent>.
123
124I<Please note that old resource name of B<inheritPixmap> is obsolete and should be
125changed to B<transparent>. Backwards compatibility support for B<inheritPixmap> will
126be phased out in future versions of rxvt!>
127
128I<Please address all transparency related issues to Sasha Vasko at
129sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
130 132
131=item B<-fade> I<number> 133=item B<-fade> I<number>
132 134
133Fade the text by the given percentage when focus is lost. Small values 135Fade the text by the given percentage when focus is lost. Small values
134fade a little only, 100 completely replaces all colours by the fade 136fade a little only, 100 completely replaces all colours by the fade
137=item B<-fadecolor> I<colour> 139=item B<-fadecolor> I<colour>
138 140
139Fade to this colour when fading is used (see B<-fade>). The default colour 141Fade to this colour when fading is used (see B<-fade>). The default colour
140is opaque black. resource B<fadeColor>. 142is opaque black. resource B<fadeColor>.
141 143
142=item B<-tint> I<colour> 144=item B<-icon> I<file>
143 145
144Tint the transparent background pixmap with the given colour when 146Compile I<pixbuf>: Use the specified image as application icon. This
145transparency is enabled with B<-tr>. This only works for 147is used by many window managers, taskbars and pagers to represent the
146non-tiled backgrounds, currently. See also the B<-sh> option that can be 148application window; resource I<iconFile>.
147used to brighten or darken the image in addition to tinting it.
148Please note that certain tint colours can be applied on the server-side,
149thus yielding performance gain of two orders of magnitude. These colours are:
150blue, red, green, cyan, magenta, yellow, and those close to them. Also
151pure black and pure white colors essentially mean no tinting; resource
152I<tintColor>. Example:
153
154 @@RXVT_NAME@@ -tr -tint blue -sh 40
155
156=item B<-sh> I<number>
157
158Darken (0 .. 100) or lighten (100 .. 200) the transparent
159background image in addition to (or instead of) tinting it;
160resource I<shading>.
161
162=item B<-blt> I<string>
163
164Specify background blending type. If background pixmap is specified
165at the same time as transparency - such pixmap will be blended over
166transparency image, using method specified. Supported values are :
167B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
168B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
169B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
170alpha-blending. Compile I<afterimage>; resource I<blendType>.
171
172=item B<-blr> I<HxV>
173
174Apply Gaussian Blur with the specified radii to the transparent
175background image. If single number is specified - both vertical and
176horizontal radii are considered to be the same. Setting one of the
177radii to 1 and another to a large number creates interesting effects
178on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
179resource I<blurRadius>.
180 149
181=item B<-bg> I<colour> 150=item B<-bg> I<colour>
182 151
183Window background colour; resource B<background>. 152Window background colour; resource B<background>.
184 153
185=item B<-fg> I<colour> 154=item B<-fg> I<colour>
186 155
187Window foreground colour; resource B<foreground>. 156Window foreground colour; resource B<foreground>.
188
189=item B<-pixmap> I<file[;geom]>
190
191Compile I<afterimage>: Specify image file for the background and also
192optionally specify its scaling with a geometry string. Note you may need to
193add quotes to avoid special shell interpretation of the C<;> in the
194command-line; for more details see resource B<backgroundPixmap>.
195 157
196=item B<-cr> I<colour> 158=item B<-cr> I<colour>
197 159
198The cursor colour; resource B<cursorColor>. 160The cursor colour; resource B<cursorColor>.
199 161
244italic> >> characters are to be printed. See resource B<boldItalicFont> 206italic> >> characters are to be printed. See resource B<boldItalicFont>
245for details. 207for details.
246 208
247=item B<-is>|B<+is> 209=item B<-is>|B<+is>
248 210
249Compile I<font-styles>: Bold/Italic font styles imply high intensity 211Compile I<font-styles>: Bold/Blink font styles imply high intensity
250foreground/background (default). See resource B<intensityStyles> for 212foreground/background (default). See resource B<intensityStyles> for
251details. 213details.
252 214
253=item B<-name> I<name> 215=item B<-name> I<name>
254 216
258 220
259=item B<-ls>|B<+ls> 221=item B<-ls>|B<+ls>
260 222
261Start as a login-shell/sub-shell; resource B<loginShell>. 223Start as a login-shell/sub-shell; resource B<loginShell>.
262 224
225=item B<-mc> I<milliseconds>
226
227Specify the maximum time between multi-click selections.
228
263=item B<-ut>|B<+ut> 229=item B<-ut>|B<+ut>
264 230
265Compile I<utmp>: Inhibit/enable writing a utmp entry; resource 231Compile I<utmp>: Inhibit/enable writing a utmp entry; resource
266B<utmpInhibit>. 232B<utmpInhibit>.
267 233
271B<visualBell>. 237B<visualBell>.
272 238
273=item B<-sb>|B<+sb> 239=item B<-sb>|B<+sb>
274 240
275Turn on/off scrollbar; resource B<scrollBar>. 241Turn on/off scrollbar; resource B<scrollBar>.
242
243=item B<-sr>|B<+sr>
244
245Put scrollbar on right/left; resource B<scrollBar_right>.
246
247=item B<-st>|B<+st>
248
249Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
250resource B<scrollBar_floating>.
276 251
277=item B<-si>|B<+si> 252=item B<-si>|B<+si>
278 253
279Turn on/off scroll-to-bottom on TTY output inhibit; resource 254Turn on/off scroll-to-bottom on TTY output inhibit; resource
280B<scrollTtyOutput> has opposite effect. 255B<scrollTtyOutput> has opposite effect.
287=item B<-sw>|B<+sw> 262=item B<-sw>|B<+sw>
288 263
289Turn on/off scrolling with the scrollback buffer as new lines appear. 264Turn on/off scrolling with the scrollback buffer as new lines appear.
290This only takes effect if B<-si> is also given; resource 265This only takes effect if B<-si> is also given; resource
291B<scrollWithBuffer>. 266B<scrollWithBuffer>.
292
293=item B<-sr>|B<+sr>
294
295Put scrollbar on right/left; resource B<scrollBar_right>.
296
297=item B<-st>|B<+st>
298
299Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
300resource B<scrollBar_floating>.
301 267
302=item B<-ptab>|B<+ptab> 268=item B<-ptab>|B<+ptab>
303 269
304If enabled (default), "Horizontal Tab" characters are being stored as 270If enabled (default), "Horizontal Tab" characters are being stored as
305actual wide characters in the screen buffer, which makes it possible to 271actual wide characters in the screen buffer, which makes it possible to
309 275
310=item B<-bc>|B<+bc> 276=item B<-bc>|B<+bc>
311 277
312Blink the cursor; resource B<cursorBlink>. 278Blink the cursor; resource B<cursorBlink>.
313 279
280=item B<-uc>|B<+uc>
281
282Make the cursor underlined; resource B<cursorUnderline>.
283
314=item B<-iconic> 284=item B<-iconic>
315 285
316Start iconified, if the window manager supports that option. 286Start iconified, if the window manager supports that option.
317Alternative form is B<-ic>. 287Alternative form is B<-ic>.
318 288
334 304
335=item B<-bl> 305=item B<-bl>
336 306
337Compile I<frills>: Set MWM hints to request a borderless window, i.e. 307Compile I<frills>: Set MWM hints to request a borderless window, i.e.
338if honoured by the WM, the rxvt-unicode window will not have window 308if honoured by the WM, the rxvt-unicode window will not have window
339decorations; resource B<borderLess>. 309decorations; resource B<borderLess>. If the window manager does not
310support MWM hints (e.g. kwin), enables override-redirect mode.
340 311
341=item B<-override-redirect> 312=item B<-override-redirect>
342 313
343Compile I<frills>: Sets override-redirect on the window; resource 314Compile I<frills>: Sets override-redirect on the window; resource
344B<override-redirect>. 315B<override-redirect>.
316
317=item B<-dockapp>
318
319Sets the initial state of the window to WithdrawnState, which makes
320window managers that support this extension treat it as a dockapp.
345 321
346=item B<-sbg> 322=item B<-sbg>
347 323
348Compile I<frills>: Disable the usage of the built-in block graphics/line 324Compile I<frills>: Disable the usage of the built-in block graphics/line
349drawing characters and just rely on what the specified fonts provide. Use 325drawing characters and just rely on what the specified fonts provide. Use
353=item B<-lsp> I<number> 329=item B<-lsp> I<number>
354 330
355Compile I<frills>: Lines (pixel height) to insert between each row of 331Compile I<frills>: Lines (pixel height) to insert between each row of
356the display. Useful to work around font rendering problems; resource 332the display. Useful to work around font rendering problems; resource
357B<lineSpace>. 333B<lineSpace>.
334
335=item B<-letsp> I<number>
336
337Compile I<frills>: Amount to adjust the computed character width by
338to control overall letter spacing. Negative values will tighten up the
339letter spacing, positive values will space letters out more. Useful to
340work around odd font metrics; resource B<letterSpace>.
358 341
359=item B<-tn> I<termname> 342=item B<-tn> I<termname>
360 343
361This option specifies the name of the terminal type to be set in the 344This option specifies the name of the terminal type to be set in the
362B<TERM> environment variable. This terminal type must exist in the 345B<TERM> environment variable. This terminal type must exist in the
397=item B<-pt> I<style> 380=item B<-pt> I<style>
398 381
399Compile I<XIM>: input style for input method; B<OverTheSpot>, 382Compile I<XIM>: input style for input method; B<OverTheSpot>,
400B<OffTheSpot>, B<Root>; resource B<preeditType>. 383B<OffTheSpot>, B<Root>; resource B<preeditType>.
401 384
385If the perl extension C<xim-onthespot> is used (which is the default),
386then additionally the C<OnTheSpot> preedit type is available.
387
402=item B<-im> I<text> 388=item B<-im> I<text>
403 389
404Compile I<XIM>: input method name. resource B<inputMethod>. 390Compile I<XIM>: input method name. resource B<inputMethod>.
405 391
406=item B<-imlocale> I<string> 392=item B<-imlocale> I<string>
417 403
418=item B<-tcw> 404=item B<-tcw>
419 405
420Change the meaning of triple-click selection with the left mouse 406Change the meaning of triple-click selection with the left mouse
421button. Only effective when the original (non-perl) selection code is 407button. Only effective when the original (non-perl) selection code is
422in-use. Instead of selecting a full line it will extend the selection the 408in-use. Instead of selecting a full line it will extend the selection to
423end of the logical line only. resource B<tripleclickwords>. 409the end of the logical line only. resource B<tripleclickwords>.
410
411=item B<-dpb>|B<+dpb>
412
413Compile frills: Disable (or enable) emitting bracketed paste mode
414sequences (default enabled). Bracketed paste mode allows programs
415to detect when something is pasted. Since more and more programs
416abuse this, these sequences can be disabled. The command sequences to
417enable and query paste mode will still work, but the actual bracket
418sequences will no longer be emitted. You can also toggle this from the
419ctrl-middle-mouse-button menu; resource B<disablePasteBrackets>.
424 420
425=item B<-insecure> 421=item B<-insecure>
426 422
427Enable "insecure" mode, which currently enables most of the escape 423Enable "insecure" mode, which currently enables most of the escape
428sequences that echo strings. See the resource B<insecure> for more 424sequences that echo strings. See the resource B<insecure> for more
441 437
442=item B<-ssr>|B<+ssr> 438=item B<-ssr>|B<+ssr>
443 439
444Turn on/off secondary screen scroll (default enabled); resource 440Turn on/off secondary screen scroll (default enabled); resource
445B<secondaryScroll>. 441B<secondaryScroll>.
442
443=item B<-rm> I<mode>
444
445Compile I<frills>: Sets long line rewrapping behaviour on window resizes
446to one of B<auto> (the default), B<always> or B<never>. The latter two
447modes do the obvious, B<auto> rewraps (acts like B<always>) if scrollback
448is non-empty, and wings lines (acts like B<never>) otherwise; resource
449B<rewrapMode>.
446 450
447=item B<-hold>|B<+hold> 451=item B<-hold>|B<+hold>
448 452
449Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 453Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
450will not immediately destroy its window when the program executed within 454will not immediately destroy its window when the program executed within
451it exits. Instead, it will wait till it is being killed or closed by the 455it exits. Instead, it will wait till it is being killed or closed by the
452user; resource B<hold>. 456user; resource B<hold>.
457
458=item B<-cd> I<path>
459
460Sets the working directory for the shell (or the command specified via
461B<-e>). The I<path> must be an absolute path and it must exist for
462@@RXVT_NAME@@ to start; resource B<chdir>.
463
464=item B<-xrm> I<string>
465
466Works like the X Toolkit option of the same name, by adding the I<string>
467as if it were specified in a resource file. Resource values specified this
468way take precedence over all other resource specifications.
469
470Note that you need to use the I<same> syntax as in the .Xdefaults file,
471e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
472options can be specified as long-options on the commandline, so use
473of B<-xrm> is mostly limited to cases where you want to specify other
474resources (e.g. for input methods) or for compatibility with other
475programs.
453 476
454=item B<-keysym.>I<sym> I<string> 477=item B<-keysym.>I<sym> I<string>
455 478
456Remap a key symbol. See resource B<keysym>. 479Remap a key symbol. See resource B<keysym>.
457 480
492If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 515If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
493entries and will not tinker with pty/tty permissions - you have to do that 516entries and will not tinker with pty/tty permissions - you have to do that
494yourself if you want that. 517yourself if you want that.
495 518
496As an extremely special case, specifying C<-1> will completely suppress 519As an extremely special case, specifying C<-1> will completely suppress
497pty/tty operations. 520pty/tty operations, which is probably only useful in conjunction with some
521perl extension that manages the terminal.
498 522
499Here is a example in perl that illustrates how this option can be used (a 523Here is a example in perl that illustrates how this option can be used (a
500longer example is in F<doc/pty-fd>): 524longer example is in F<doc/pty-fd>):
501 525
502 use IO::Pty; 526 use IO::Pty;
516Comma-separated list of perl extension scripts to use (or not to use) in 540Comma-separated list of perl extension scripts to use (or not to use) in
517this terminal instance. See resource B<perl-ext> for details. 541this terminal instance. See resource B<perl-ext> for details.
518 542
519=back 543=back
520 544
521=head1 RESOURCES (available also as long-options) 545=head1 RESOURCES
522 546
523Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 547Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
524options) compiled into your version. 548options) compiled into your version. All resources are also available as
549long-options.
525 550
526You can set and change the resources using X11 tools like B<xrdb>. Many 551You can set and change the resources using X11 tools like B<xrdb>. Many
527distribution do also load settings from the B<~/.Xresources> file when X 552distribution do also load settings from the B<~/.Xresources> file when X
528starts. @@RXVT_NAME@@ will consult the following files/resources in order, 553starts. @@RXVT_NAME@@ will consult the following files/resources in order,
529with later settings overwriting earlier ones: 554with later settings overwriting earlier ones:
530 555
531 1. system-wide app-defaults file, either locale-dependent OR global
532 2. app-defaults file in $XAPPLRESDIR 556 1. app-defaults file in $XAPPLRESDIR
557 2. $HOME/.Xdefaults
533 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 558 3. RESOURCE_MANAGER property on root-window of screen 0
534 4. SCREEN_RESOURCES for the current screen 559 4. SCREEN_RESOURCES property on root-window of the current screen
535 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 560 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
561 6. resources specified via -xrm on the commandline
536 562
537Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 563Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
538names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 564names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
539common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily 565common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
540configured, while the class name B<URxvt> allows resources unique to 566configured, while the class name B<URxvt> allows resources unique to
550=item B<depth:> I<bitdepth> 576=item B<depth:> I<bitdepth>
551 577
552Compile I<xft>: Attempt to find a visual with the given bit depth; 578Compile I<xft>: Attempt to find a visual with the given bit depth;
553option B<-depth>. 579option B<-depth>.
554 580
581=item B<buffered:> I<boolean>
582
583Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
584On some card/driver combination enabling it slightly decreases
585performance, on most it greatly helps it. The slowdown is small, so it
586should normally be enabled.
587
555=item B<geometry:> I<geom> 588=item B<geometry:> I<geom>
556 589
557Create the window with the specified X window geometry [default 80x24]; 590Create the window with the specified X window geometry [default 80x24];
558option B<-geometry>. 591option B<-geometry>.
559 592
572Use the specified colour for the colour value I<n>, where 0-7 605Use the specified colour for the colour value I<n>, where 0-7
573corresponds to low-intensity (normal) colours and 8-15 corresponds to 606corresponds to low-intensity (normal) colours and 8-15 corresponds to
574high-intensity (bold = bright foreground, blink = bright background) 607high-intensity (bold = bright foreground, blink = bright background)
575colours. The canonical names are as follows: 0=black, 1=red, 2=green, 608colours. The canonical names are as follows: 0=black, 1=red, 2=green,
5763=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 6093=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
577names used are listed in the B<COLORS AND GRAPHICS> section. 610names used are listed in the B<COLOURS AND GRAPHICS> section.
578 611
579Colours higher than 15 cannot be set using resources (yet), but can be 612Colours higher than 15 cannot be set using resources (yet), but can be
580changed using an escape command (see @@RXVT_NAME@@(7)). 613changed using an escape command (see @@RXVT_NAME@@(7)).
581 614
582Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 615Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
593=item B<colorUL:> I<colour> 626=item B<colorUL:> I<colour>
594 627
595Use the specified colour to display underlined characters when the 628Use the specified colour to display underlined characters when the
596foreground colour is the default. 629foreground colour is the default.
597 630
598=item B<colorRV:> I<colour>
599
600Use the specified colour as the background for reverse video characters
601when OPTION_HC is disabled (--disable-frills).
602
603=item B<underlineColor:> I<colour> 631=item B<underlineColor:> I<colour>
604 632
605If set, use the specified colour as the colour for the underline 633If set, use the specified colour as the colour for the underline
606itself. If unset, use the foreground colour. 634itself. If unset, use the foreground colour.
635
636=item B<highlightColor:> I<colour>
637
638If set, use the specified colour as the background for highlighted
639characters. If unset, use reverse video.
640
641=item B<highlightTextColor:> I<colour>
642
643If set and highlightColor is set, use the specified colour as the
644foreground for highlighted characters.
607 645
608=item B<cursorColor:> I<colour> 646=item B<cursorColor:> I<colour>
609 647
610Use the specified colour for the cursor. The default is to use the 648Use the specified colour for the cursor. The default is to use the
611foreground colour; option B<-cr>. 649foreground colour; option B<-cr>.
618 656
619=item B<reverseVideo:> I<boolean> 657=item B<reverseVideo:> I<boolean>
620 658
621B<True>: simulate reverse video by foreground and background colours; 659B<True>: simulate reverse video by foreground and background colours;
622option B<-rv>. B<False>: regular screen colours [default]; option 660option B<-rv>. B<False>: regular screen colours [default]; option
623B<+rv>. See note in B<COLORS AND GRAPHICS> section. 661B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
624 662
625=item B<jumpScroll:> I<boolean> 663=item B<jumpScroll:> I<boolean>
626 664
627B<True>: specify that jump scrolling should be used. When receiving lots 665B<True>: specify that jump scrolling should be used. When receiving lots
628of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines 666of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
642 680
643B<False>: specify that everything is to be displayed, even 681B<False>: specify that everything is to be displayed, even
644if the refresh is too fast for the human eye to read anything (or the 682if the refresh is too fast for the human eye to read anything (or the
645monitor to display anything); option B<+ss>. 683monitor to display anything); option B<+ss>.
646 684
647=item B<inheritPixmap:> I<boolean>
648
649B<True>: make the background inherit the parent windows' pixmap, giving
650artificial transparency. B<False>: do not inherit the parent windows'
651pixmap.
652
653I<Please note that transparency of any kind if completely unsupported by
654the author. Don't bug him with installation questions!>
655
656=item B<fading:> I<number> 685=item B<fading:> I<number>
657 686
658Fade the text by the given percentage when focus is lost; option B<-fade>. 687Fade the text by the given percentage when focus is lost; option B<-fade>.
659 688
660=item B<fadeColor:> I<colour> 689=item B<fadeColor:> I<colour>
661 690
662Fade to this colour, when fading is used (see B<fading:>). The default 691Fade to this colour, when fading is used (see B<fading:>). The default
663colour is black; option B<-fadecolor>. 692colour is black; option B<-fadecolor>.
664 693
665=item B<tintColor:> I<colour> 694=item B<iconFile:> I<file>
666 695
667Tint the transparent background pixmap with the given colour; option 696Set the application icon pixmap; option B<-icon>.
668B<-tint>.
669
670=item B<shading:> I<number>
671
672Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
673in addition to tinting it; option B<-sh>.
674
675=item B<blendType:> I<string>
676
677Specify background blending type; option B<-blt>.
678
679=item B<blurRadius:> I<number>
680
681Apply Gaussian Blurr with the specified radius to the transparent
682background image; option B<-blr>.
683 697
684=item B<scrollColor:> I<colour> 698=item B<scrollColor:> I<colour>
685 699
686Use the specified colour for the scrollbar [default #B2B2B2]. 700Use the specified colour for the scrollbar [default #B2B2B2].
687 701
692 706
693=item B<borderColor:> I<colour> 707=item B<borderColor:> I<colour>
694 708
695The colour of the border around the text area and between the scrollbar 709The colour of the border around the text area and between the scrollbar
696and the text. 710and the text.
697
698=item B<backgroundPixmap:> I<file[;geom]>
699
700Use the specified image file for the background and also optionally
701specify its scaling with a geometry string B<WxH+X+Y>,
702in which B<"W" / "H"> specify the horizontal/vertical scale (percent),
703and B<"X" / "Y"> locate the image centre (percent).
704A scale of 0 displays the image with tiling. A scale of 1 displays the
705image without any scaling. A scale of 2 to 9 specifies an integer
706number of images in that direction. No image will be magnified beyond
70710 times its original size. The maximum permitted scale is 1000.
708Special string of B<"auto"> used as a geometry will cause image to be
709automatically scaled to match window size.
710If used in conjunction with B<-tr> option - specified pixmap will be
711blended over transparency image using either alpha-blending, or any
712other blending type, specified with B<-blt "type"> option.
713[default 0x0+50+50]
714
715=item B<path:> I<path>
716
717Specify the colon-delimited search path for finding background image files.
718 711
719=item B<font:> I<fontlist> 712=item B<font:> I<fontlist>
720 713
721Select the fonts to be used. This is a comma separated list of font names 714Select the fonts to be used. This is a comma separated list of font names
722that are checked in order when trying to find glyphs for characters. The 715that are checked in order when trying to find glyphs for characters. The
745it is named first) and thus defines the character cell grid to be 9 pixels 738it is named first) and thus defines the character cell grid to be 9 pixels
746wide and 15 pixels high. 739wide and 15 pixels high.
747 740
748The second font is just used to add additional unicode characters not in 741The second font is just used to add additional unicode characters not in
749the base font, likewise the third, which is unfortunately non-bold, but 742the base font, likewise the third, which is unfortunately non-bold, but
750the bold version of the font does contain less characters, so this is a 743the bold version of the font does contain fewer characters, so this is a
751useful supplement. 744useful supplement.
752 745
753The third font is an Xft font with aliasing turned off, and the characters 746The third font is an Xft font with aliasing turned off, and the characters
754are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 747are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
755contains other characters, but we are not interested in them. 748contains other characters, but we are not interested in them.
779text font will being used for the given style. 772text font will being used for the given style.
780 773
781=item B<intensityStyles:> I<boolean> 774=item B<intensityStyles:> I<boolean>
782 775
783When font styles are not enabled, or this option is enabled (B<True>, 776When font styles are not enabled, or this option is enabled (B<True>,
784option B<-is>, the default), bold and italic font styles imply high 777option B<-is>, the default), bold/blink font styles imply high
785intensity foreground/background colours. Disabling this option (B<False>, 778intensity foreground/background colours. Disabling this option (B<False>,
786option B<+is>) disables this behaviour, the high intensity colours are not 779option B<+is>) disables this behaviour, the high intensity colours are not
787reachable. 780reachable.
788 781
789=item B<selectstyle:> I<mode>
790
791Set mouse selection style to B<old> which is 2.20, B<oldword> which
792is xterm style with 2.20 old word selection, or anything else which
793gives xterm style selection. Only effective when the original (non-perl)
794selection code is in use.
795
796=item B<scrollstyle:> I<mode>
797
798Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
799the author's favourite.
800
801=item B<title:> I<string> 782=item B<title:> I<string>
802 783
803Set window title string, the default title is the command-line 784Set window title string, the default title is the command-line
804specified after the B<-e> option, if any, otherwise the application 785specified after the B<-e> option, if any, otherwise the application
805name; option B<-title>. 786name; option B<-title>.
818=item B<urgentOnBell:> I<boolean> 799=item B<urgentOnBell:> I<boolean>
819 800
820B<True>: set the urgency hint for the wm on receipt of a bell character. 801B<True>: set the urgency hint for the wm on receipt of a bell character.
821B<False>: do not set the urgency hint [default]. 802B<False>: do not set the urgency hint [default].
822 803
804@@RXVT_NAME@@ resets the urgency hint on every focus change.
805
823=item B<visualBell:> I<boolean> 806=item B<visualBell:> I<boolean>
824 807
825B<True>: use visual bell on receipt of a bell character; option B<-vb>. 808B<True>: use visual bell on receipt of a bell character; option B<-vb>.
826B<False>: no visual bell [default]; option B<+vb>. 809B<False>: no visual bell [default]; option B<+vb>.
827 810
829 812
830B<True>: start as a login shell by prepending a `-' to B<argv[0]> of 813B<True>: start as a login shell by prepending a `-' to B<argv[0]> of
831the shell; option B<-ls>. B<False>: start as a normal sub-shell 814the shell; option B<-ls>. B<False>: start as a normal sub-shell
832[default]; option B<+ls>. 815[default]; option B<+ls>.
833 816
817=item B<multiClickTime:> I<number>
818
819Specify the maximum time in milliseconds between multi-click select
820events. The default is 500 milliseconds; option B<-mc>.
821
834=item B<utmpInhibit:> I<boolean> 822=item B<utmpInhibit:> I<boolean>
835 823
836B<True>: inhibit writing record into the system log file B<utmp>; 824B<True>: inhibit writing record into the system log file B<utmp>;
837option B<-ut>. B<False>: write record into the system log file B<utmp> 825option B<-ut>. B<False>: write record into the system log file B<utmp>
838[default]; option B<+ut>. 826[default]; option B<+ut>.
850 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 838 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
851 839
852This creates a new file in your home directory with the screen contents 840This creates a new file in your home directory with the screen contents
853every time you hit C<Print>. 841every time you hit C<Print>.
854 842
843=item B<scrollstyle:> I<mode>
844
845Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
846the author's favourite.
847
848=item B<thickness:> I<number>
849
850Set the scrollbar width in pixels.
851
855=item B<scrollBar:> I<boolean> 852=item B<scrollBar:> I<boolean>
856 853
857B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 854B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
858disable the scrollbar; option B<+sb>. 855disable the scrollbar; option B<+sb>.
859 856
878B<False>: do not scroll to bottom when tty receives output; option 875B<False>: do not scroll to bottom when tty receives output; option
879B<+si>. 876B<+si>.
880 877
881=item B<scrollWithBuffer:> I<boolean> 878=item B<scrollWithBuffer:> I<boolean>
882 879
883B<True>: scroll with scrollback buffer when tty receives new lines (and 880B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
884B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 881try to show the same lines) and B<scrollTtyOutput> is False; option
885with scrollback buffer when tty receives new lines; option B<+sw>. 882B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
883new lines; option B<+sw>.
886 884
887=item B<scrollTtyKeypress:> I<boolean> 885=item B<scrollTtyKeypress:> I<boolean>
888 886
889B<True>: scroll to bottom when a non-special key is pressed. Special keys 887B<True>: scroll to bottom when a non-special key is pressed. Special keys
890are those which are intercepted by rxvt-unicode for special handling and 888are those which are intercepted by rxvt-unicode for special handling and
891are not passed onto the shell; option B<-sk>. B<False>: do not scroll to 889are not passed onto the shell; option B<-sk>. B<False>: do not scroll to
892bottom when a non-special key is pressed; option B<+sk>. 890bottom when a non-special key is pressed; option B<+sk>.
893 891
894=item B<saveLines:> I<number> 892=item B<saveLines:> I<number>
895 893
896Save I<number> lines in the scrollback buffer [default 64]. This 894Save I<number> lines in the scrollback buffer [default 1000]; option B<-sl>.
897resource is limited on most machines to 65535; option B<-sl>.
898 895
899=item B<internalBorder:> I<number> 896=item B<internalBorder:> I<number>
900 897
901Internal border of I<number> pixels. This resource is limited to 100; 898Internal border of I<number> pixels. This resource is limited to 100;
902option B<-b>. 899option B<-b>.
946=item B<cursorBlink:> I<boolean> 943=item B<cursorBlink:> I<boolean>
947 944
948B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 945B<True>: blink the cursor. B<False>: do not blink the cursor [default];
949option B<-bc>. 946option B<-bc>.
950 947
948=item B<cursorUnderline:> I<boolean>
949
950B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
951option B<-uc>.
952
951=item B<pointerBlank:> I<boolean> 953=item B<pointerBlank:> I<boolean>
952 954
953B<True>: blank the pointer when a key is pressed or after a set number 955B<True>: blank the pointer when a key is pressed or after a set number
954of seconds of inactivity. B<False>: the pointer is always visible 956of seconds of inactivity. B<False>: the pointer is always visible
955[default]. 957[default].
960 962
961=item B<pointerColor2:> I<colour> 963=item B<pointerColor2:> I<colour>
962 964
963Mouse pointer background colour. 965Mouse pointer background colour.
964 966
967=item B<pointerShape:> I<string>
968
969Compile I<frills>: Specifies the name of the mouse pointer shape
970[default B<xterm>]. See the macros in the B<X11/cursorfont.h> include
971file for possible values (omit the C<XC_> prefix).
972
965=item B<pointerBlankDelay:> I<number> 973=item B<pointerBlankDelay:> I<number>
966 974
967Specifies number of seconds before blanking the pointer [default 2]. Use a 975Specifies number of seconds before blanking the pointer [default 2]. Use a
968large number (e.g. C<987654321>) to effectively disable the timeout. 976large number (e.g. C<987654321>) to effectively disable the timeout.
969 977
970=item B<backspacekey:> I<string> 978=item B<backspacekey:> I<string>
971 979
972The string to send when the backspace key is pressed. If set to B<DEC> 980The string to send when the backspace key is pressed. If set to B<DEC>
973or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 981or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
974(code 8) - which can be reversed with the appropriate DEC private mode 982(code 8) - which can be reversed with the appropriate DEC private mode
975escape sequence. 983escape sequence.
976 984
977=item B<deletekey:> I<string> 985=item B<deletekey:> I<string>
978 986
991will be created). In this mode, characters outside ISO-8859-1 can be used. 999will be created). In this mode, characters outside ISO-8859-1 can be used.
992 1000
993When the selection extension is not used, only ISO-8859-1 characters can 1001When the selection extension is not used, only ISO-8859-1 characters can
994be used. If not specified, the built-in default is used: 1002be used. If not specified, the built-in default is used:
995 1003
996B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1004B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
997 1005
998=item B<preeditType:> I<style> 1006=item B<preeditType:> I<style>
999 1007
1000B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1008B<OnTheSpot>, B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
1001 1009
1002=item B<inputMethod:> I<name> 1010=item B<inputMethod:> I<name>
1003 1011
1004I<name> of inputMethod to use; option B<-im>. 1012I<name> of inputMethod to use; option B<-im>.
1005 1013
1023 1031
1024Change the meaning of triple-click selection with the left mouse 1032Change the meaning of triple-click selection with the left mouse
1025button. Instead of selecting a full line it will extend the selection to 1033button. Instead of selecting a full line it will extend the selection to
1026the end of the logical line only; option B<-tcw>. 1034the end of the logical line only; option B<-tcw>.
1027 1035
1036=item B<disablePasteBrackets:> I<boolean>
1037
1038Prevent emission of paste bracket sequences; option B<-dpb>.
1039
1028=item B<insecure:> I<boolean> 1040=item B<insecure:> I<boolean>
1029 1041
1030Enables "insecure" mode. Rxvt-unicode offers some escape sequences that 1042Enable "insecure" mode. Rxvt-unicode offers some escape sequences that
1031echo arbitrary strings like the icon name or the locale. This could be 1043echo arbitrary strings like the icon name or the locale. This could be
1032abused if somebody gets 8-bit-clean access to your display, whether 1044abused if somebody gets 8-bit-clean access to your display, whether
1033through a mail client displaying mail bodies unfiltered or through 1045through a mail client displaying mail bodies unfiltered or through
1034write(1) or any other means. Therefore, these sequences are disabled by 1046write(1) or any other means. Therefore, these sequences are disabled by
1035default. (Note that many other terminals, including xterm, have these 1047default. (Note that many other terminals, including xterm, have these
1053 1065
1054=item B<secondaryScreen:> I<boolean> 1066=item B<secondaryScreen:> I<boolean>
1055 1067
1056Turn on/off secondary screen (default enabled). 1068Turn on/off secondary screen (default enabled).
1057 1069
1070=item B<rewrapMode:> I<mode>
1071
1072Sets long line rewrap behaviour on window resize to one of B<auto>
1073(default), B<always> or B<never>.
1074
1058=item B<secondaryScroll:> I<boolean> 1075=item B<secondaryScroll:> I<boolean>
1059 1076
1060Turn on/off secondary screen scroll (default enabled). If this 1077Turn on/off secondary screen scroll (default enabled). If this
1061option is enabled, scrolls on the secondary screen will change the 1078option is enabled, scrolls on the secondary screen will change the
1062scrollback buffer and switching to/from the secondary screen will 1079scrollback buffer and, when secondaryScreen is off, switching
1063instead scroll the screen up. 1080to/from the secondary screen will instead scroll the screen up.
1064 1081
1065=item B<hold>: I<boolean> 1082=item B<hold>: I<boolean>
1066 1083
1067Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1084Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
1068will not immediately destroy its window when the program executed within 1085will not immediately destroy its window when the program executed within
1069it exits. Instead, it will wait till it is being killed or closed by the 1086it exits. Instead, it will wait till it is being killed or closed by the
1070user. 1087user.
1071 1088
1089=item B<chdir>: I<path>
1090
1091Sets the working directory for the shell (or the command specified via
1092B<-e>). The I<path> must be an absolute path and it must exist for
1093@@RXVT_NAME@@ to start. If it isn't specified then the current working
1094directory will be used; option B<-cd>.
1095
1072=item B<keysym.>I<sym>: I<string> 1096=item B<keysym.>I<sym>: I<action>
1073 1097
1074Compile I<frills>: Associate I<string> with keysym I<sym>. The 1098Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
1075intervening resource name B<keysym.> cannot be omitted. 1099resource name B<keysym.> cannot be omitted.
1076 1100
1077The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1101Using this resource, you can map key combinations such as
1078any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1102C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
1079B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, 1103string than would normally result from that combination, making the
1080and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 1104terminal scroll up or down the way you want it, or any other thing an
1081B<2>, B<3>, B<4>, B<5>. 1105extension might provide.
1106
1107The key combination that triggers the action, I<sym>, has the following format:
1108
1109 (modifiers-)key
1110
1111Where I<modifiers> can be any combination of the following full or
1112abbreviated modifier names:
1113
1114=begin table
1115
1116 B<ISOLevel3> B<I>
1117 B<AppKeypad> B<K>
1118 B<Control> B<C>
1119 B<NumLock> B<N>
1120 B<Shift> B<S>
1121 B<Meta> B<M> I<or> B<A>
1122 B<Lock> B<L>
1123 B<Mod1> B<1>
1124 B<Mod2> B<2>
1125 B<Mod3> B<3>
1126 B<Mod4> B<4>
1127 B<Mod5> B<5>
1128
1129=end table
1082 1130
1083The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1131The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
1084whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1132whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
1085keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1133keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
1086current application keymap mode state. 1134current application keymap mode state.
1087 1135
1088The spellings of I<key> can be obtained by using B<xev>(1) command or 1136Due the the large number of modifier combinations, a key mapping will
1089searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1137match if I<at least> the specified identifiers are being set, and no other
1138key mappings with those and more bits are being defined. That means that
1139defining a mapping for C<a> will automatically provide definitions for
1140C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1141themselves. See the C<builtin:> action, below, for a way to work around
1142this when this is a problem.
1143
1144The spelling of I<key> depends on your implementation of X. An easy way to
1145find a key name is to use the B<xev>(1) command. You can find a list by
1146looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
1090omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1147the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
1091keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1148value (B<0x0000 - 0xFFFF>).
1092performed in an exact manner; however, the closest match is assured.
1093 1149
1094I<string> may contain escape values (C<\n>: newline, C<\000>: octal 1150As with any resource value, the I<action> string may contain backslash
1151escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
1095number), see RESOURCES in C<man 7 X> for futher details. 1152number), see RESOURCES in C<man 7 X> for further details.
1096 1153
1097You can define a range of keysyms in one shot by providing a I<string> 1154An action starts with an action prefix that selects a certain type
1098with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' 1155of action, followed by a colon. An action string without colons is
1156interpreted as a literal string to pass to the tty (as if it was
1157prefixed with C<string:>).
1158
1159The following action prefixes are known - extensions can provide
1160additional prefixes:
1161
1162=over 4
1163
1164=item string:STRING
1165
1166If the I<action> starts with C<string:> (or otherwise contains no colons),
1167then the remaining C<STRING> will be passed to the program running in the
1168terminal. For example, you could replace whatever Shift-Tab outputs by the
1169string C<echo rm -rf /> followed by a newline:
1170
1171 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1172
1173This could in theory be used to completely redefine your keymap.
1174
1175In addition, for actions of this type, you can define a range of
1176keysyms in one shot by loading the C<keysym-list> perl extension and
1177providing an I<action> with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where
1099should be a character not used by the strings. 1178the delimiter `/' should be a character not used by the strings.
1100 1179
1101Its usage can be demonstrated by an example: 1180Its usage can be demonstrated by an example:
1102 1181
1103 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1182 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1104 1183
1105The above line is equivalent to the following three lines: 1184The above line is equivalent to the following three lines:
1106 1185
1107 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1186 URxvt.keysym.Meta-Control-0x61: string:\033<a>
1108 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1187 URxvt.keysym.Meta-Control-0x62: string:\033<b>
1109 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1188 URxvt.keysym.Meta-Control-0x63: string:\033<c>
1110 1189
1190=item command:STRING
1191
1111If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1192If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1112is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1193is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1194the opposite of C<string:> - instead of sending it to the program running
1195in the terminal, it will be treated as if it were program output). This is
1196most useful to feed command sequences into @@RXVT_NAME@@.
1197
1113example the following means "change the current locale to C<zh_CN.GBK> 1198For example the following means "change the current locale to C<zh_CN.GBK>
1114when Control-Meta-c is being pressed": 1199when Control-Meta-c is being pressed":
1115 1200
1116 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1201 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1117 1202
1118If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1203The following example will map Control-Meta-1 and Control-Meta-2 to
1119is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1204the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1120manpage. For example, the F<selection> extension (activated via 1205font-switching at runtime:
1121C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1122 1206
1123 URxvt.keysym.M-C-c: perl:selection:rot13 1207 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1208 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1124 1209
1125Due the the large number of modifier combinations, a defined key mapping 1210Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1126will match if at I<at least> the specified identifiers are being set, and 1211info):
1127no other key mappings with those and more bits are being defined. That
1128means that defining a key map for C<a> will automatically provide
1129definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1130mappings themselves.
1131 1212
1132Unfortunately, this will override built-in key mappings. For example 1213 URxvt.keysym.M-C-3: command:\033[8;25;80t
1214 URxvt.keysym.M-C-4: command:\033[8;48;110t
1215
1216=item builtin:
1217
1218The builtin action is the action that @@RXVT_NAME@@ would execute if no
1219key binding existed for the key combination. The obvious use is to undo
1220the effect of existing bindings. The not so obvious use is to reinstate
1221bindings when another binding overrides too many modifiers.
1222
1133if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1223For example if you overwrite the C<Insert> key you will disable
1134C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1224@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1135user-defined keymap using the C<builtin:> replacement: 1225"holes" into the user-defined keymap using the C<builtin:> replacement:
1136 1226
1137 URxvt.keysym.Insert: <my insert key sequence> 1227 URxvt.keysym.Insert: <my insert key sequence>
1138 URxvt.keysym.S-Insert: builtin: 1228 URxvt.keysym.S-Insert: builtin:
1139 1229
1140The first line defines a mapping for C<Insert> and I<any> combination 1230The first line defines a mapping for C<Insert> and I<any> combination
1141of modifiers. The second line re-establishes the default mapping for 1231of modifiers. The second line re-establishes the default mapping for
1142C<Shift-Insert>. 1232C<Shift-Insert>.
1143 1233
1144The following example will map Control-Meta-1 and Control-Meta-2 to 1234=item builtin-string:
1145the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1146font-switching at runtime:
1147 1235
1148 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1236This action is mainly useful to restore string mappings for keys that
1149 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1237have predefined actions in @@RXVT_NAME@@. The exact semantics are a bit
1238difficult to explain - basically, this action will send the string to the
1239application that would be sent if @@RXVT_NAME@@ wouldn't have a built-in
1240action for it.
1150 1241
1151Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1242An example might make it clearer: @@RXVT_NAME@@ normally pastes the
1152info): 1243selection when you press C<Shift-Insert>. With the following bindings, it
1244would instead emit the (undocumented, but what applications running in the
1245terminal might expect) sequence C<ESC [ 2 $> instead:
1153 1246
1154 URxvt.keysym.M-C-3: command:\033[8;25;80t 1247 URxvt.keysym.S-Insert: builtin-string:
1155 URxvt.keysym.M-C-4: command:\033[8;48;110t 1248 URxvt.keysym.C-S-Insert: builtin:
1249
1250The first line disables the paste functionality for that key
1251combination, and the second reinstates the default behaviour for
1252C<Control-Shift-Insert>, which would otherwise be overridden.
1253
1254Similarly, to let applications gain access to the C<C-M-c> (copy to
1255clipboard) and C<C-M-v> (paste clipboard) key combination, you can do
1256this:
1257
1258 URxvt.keysym.C-M-c: builtin-string:
1259 URxvt.keysym.C-M-v: builtin-string:
1260
1261=item EXTENSION:STRING
1262
1263An action of this form invokes the action B<STRING>, if any, provided
1264by the @@RXVT_NAME@@perl(3) extension B<EXTENSION>. The extension will
1265be loaded automatically if necessary.
1266
1267Not all extensions define actions, but popular extensions that do
1268include the I<selection> and I<matcher> extensions (documented in their
1269own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1270respectively).
1271
1272From the silly examples department, this will rot13-"encrypt"
1273@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1274keyboards:
1275
1276 URxvt.keysym.M-C-c: selection:rot13
1277
1278=item perl:STRING *DEPRECATED*
1279
1280This is a deprecated way of invoking commands provided by perl
1281extensions. It is still supported, but should not be used anymore.
1282
1283=back
1156 1284
1157=item B<perl-ext-common>: I<string> 1285=item B<perl-ext-common>: I<string>
1158 1286
1159=item B<perl-ext>: I<string> 1287=item B<perl-ext>: I<string>
1160 1288
1162use in this terminal instance; option B<-pe>. 1290use in this terminal instance; option B<-pe>.
1163 1291
1164Extension names can be prefixed with a C<-> sign to prohibit using 1292Extension names can be prefixed with a C<-> sign to prohibit using
1165them. This can be useful to selectively disable some extensions loaded 1293them. This can be useful to selectively disable some extensions loaded
1166by default, or specified via the C<perl-ext-common> resource. For 1294by default, or specified via the C<perl-ext-common> resource. For
1167example, C<default,-selection> will use all the default extension except 1295example, C<default,-selection> will use all the default extensions except
1168C<selection>. 1296C<selection>.
1169 1297
1170Extension names can also be followed by an argument in angle brackets 1298The default set includes the C<selection>, C<option-popup>,
1171(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1299C<selection-popup>, C<readline> and C<searchable-scrollback>
1172searchable scrollback to Alt/Meta-s). Mentioning the same extension 1300extensions, and extensions which are mentioned in B<keysym> resources.
1173multiple times with different arguments will pass multiple arguments to 1301
1174the extension. 1302Any extension such that a corresponding resource is given on the
1303command line is automatically appended to B<perl-ext>.
1175 1304
1176Each extension is looked up in the library directories, loaded if 1305Each extension is looked up in the library directories, loaded if
1177necessary, and bound to the current terminal instance. 1306necessary, and bound to the current terminal instance. When the library
1307search path contains multiple extension files of the same name, then the
1308first one found will be used.
1178 1309
1179If both of these resources are the empty string, then the perl 1310If both of these resources are the empty string, then the perl interpreter
1180interpreter will not be initialized. The idea behind two options is that 1311will not be initialized. The rationale for having two options is that
1181B<perl-ext-common> will be used for extensions that should be available to 1312B<perl-ext-common> will be used for extensions that should be available to
1182all instances, while B<perl-ext> is used for specific instances. 1313all instances, while B<perl-ext> is used for specific instances.
1183 1314
1184=item B<perl-eval>: I<string> 1315=item B<perl-eval>: I<string>
1185 1316
1186Perl code to be evaluated when all extensions have been registered. See 1317Perl code to be evaluated when all extensions have been registered. See
1187the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1318the @@RXVT_NAME@@perl(3) manpage.
1188will be ignored when running setuid/setgid.
1189 1319
1190=item B<perl-lib>: I<path> 1320=item B<perl-lib>: I<path>
1191 1321
1192Colon-separated list of additional directories that hold extension 1322Colon-separated list of additional directories that hold extension
1193scripts. When looking for extensions specified by the C<perl> resource, 1323scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1194@@RXVT_NAME@@ will first look in these directories and then in 1324in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1195F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1325lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1196will be ignored when running setuid/setgid.
1197 1326
1198See the @@RXVT_NAME@@perl(3) manpage. 1327See the @@RXVT_NAME@@perl(3) manpage.
1199 1328
1200=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1329=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1201 1330
1205=item B<< selection-autotransform.I<idx> >>: I<perl-transform> 1334=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1206 1335
1207Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage 1336Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1208for details. 1337for details.
1209 1338
1210=item B<searchable-scrollback:> I<keysym> 1339=item B<searchable-scrollback:> I<keysym> *DEPRECATED*
1211 1340
1212Sets the hotkey that starts the incremental scrollback buffer search 1341This resource is deprecated and will be removed. Use a B<keysym> resource
1213(default: C<M-s>). 1342instead, e.g.:
1214 1343
1344 URxvt.keysym.M-s: searchable-scrollback:start
1345
1215=item B<urlLauncher>: I<string> 1346=item B<url-launcher>: I<string>
1216 1347
1217Specifies the program to be started with a URL argument. Used by the 1348Specifies the program to be started with a URL argument. Used by the
1218C<selection-popup> and C<matcher> perl extensions. 1349C<selection-popup> and C<matcher> perl extensions.
1219 1350
1220=item B<transient-for>: I<windowid> 1351=item B<transient-for>: I<windowid>
1223 1354
1224=item B<override-redirect>: I<boolean> 1355=item B<override-redirect>: I<boolean>
1225 1356
1226Compile I<frills>: Sets override-redirect for the terminal window, making 1357Compile I<frills>: Sets override-redirect for the terminal window, making
1227it almost invisible to window managers; option B<-override-redirect>. 1358it almost invisible to window managers; option B<-override-redirect>.
1359
1360=item B<iso14755:> I<boolean>
1361
1362Turn on/off ISO 14755 (default enabled).
1228 1363
1229=item B<iso14755_52:> I<boolean> 1364=item B<iso14755_52:> I<boolean>
1230 1365
1231Turn on/off ISO 14755 5.2 mode (default enabled). 1366Turn on/off ISO 14755 5.2 mode (default enabled).
1232 1367
1284window causes the value of the PRIMARY selection (or CLIPBOARD with the 1419window causes the value of the PRIMARY selection (or CLIPBOARD with the
1285B<Meta> modifier) to be inserted as if it had been typed on the keyboard. 1420B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1286 1421
1287Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be 1422Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1288inserted too. 1423inserted too.
1424
1425rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1426<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1427binding causes the value of the internal selection to be copied to the
1428CLIPBOARD selection, while the second binding causes the value of the
1429CLIPBOARD selection to be inserted.
1289 1430
1290=back 1431=back
1291 1432
1292=head1 CHANGING FONTS 1433=head1 CHANGING FONTS
1293 1434
1375B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1516B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1376it can be seen via the I<who(1)> command, and can accept messages. To 1517it can be seen via the I<who(1)> command, and can accept messages. To
1377allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1518allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1378on some systems or setgid to root or to some other group on others. 1519on some systems or setgid to root or to some other group on others.
1379 1520
1380=head1 COLORS AND GRAPHICS 1521=head1 COLOURS AND GRAPHICS
1381 1522
1382In addition to the default foreground and background colours, 1523In addition to the default foreground and background colours,
1383B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1524B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1384high-intensity bold/blink versions of the same). Here is a list of the 1525high-intensity (potentially bold/blink) versions of the same, and 72 (or
1385colours with their names. 1526240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1527cube plus a 8 (24) colour greyscale ramp.
1528
1529B<@@RXVT_NAME@@> supports direct 24-bit fg/bg RGB colour escapes
1530C< ESC [ 38 ; 2 ; R ; G ; Bm > / C< ESC [ 48 ; 2; R ; G ; Bm >. However the
1531number of 24-bit colours that can be used is limited: an internal 7x7x5 (256
1532colour mode) or 6x6x4 (88 colour mode) colour cube is used to index into the
153324-bit colour space. When indexing collisions happen, the nearest old colour in
1534the cube will be adapted to the new 24-bit RGB colour. That means one cannot
1535use many similar 24-bit colours. It's typically not a problem in common
1536scenarios.
1537
1538Here is a list of the ANSI colours with their names.
1386 1539
1387=begin table 1540=begin table
1388 1541
1389 B<color0> (black) = Black 1542 B<color0> (black) = Black
1390 B<color1> (red) = Red3 1543 B<color1> (red) = Red3
1410It is also possible to specify the colour values of B<foreground>, 1563It is also possible to specify the colour values of B<foreground>,
1411B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1564B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1412a number 0-15, as a convenient shorthand to reference the colour name of 1565a number 0-15, as a convenient shorthand to reference the colour name of
1413color0-color15. 1566color0-color15.
1414 1567
1415In addition to the colours defined above, @@RXVT_NAME@@ offers an 1568The following text gives values for the standard 88 colour mode (and
1416additional 72 colours. The first 64 of those (with indices 16 to 79) 1569values for the 256 colour mode in parentheses).
1417consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
141816>), followed by 8 additional shades of gray (with indices 80 to 87).
1419 1570
1571The RGB cube uses indices 16..79 (16..231) using the following formulas:
1572
1573 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1574 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1575
1576The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1577steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1578the RGB cube.
1579
1420Together, all those colours implement the 88 colour xterm colours. Only 1580Together, all those colours implement the 88 (256) colour xterm
1421the first 16 can be changed using resources currently, the rest can only 1581colours. Only the first 16 can be changed using resources currently, the
1422be changed via command sequences ("escape codes"). 1582rest can only be changed via command sequences ("escape codes").
1583
1584Applications are advised to use terminfo or command sequences to discover
1585number and RGB values of all colours (yes, you can query this...).
1423 1586
1424Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1587Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1425always swapping the foreground/background colours. This is in contrast to 1588always swapping the foreground/background colours. This is in contrast to
1426I<xterm>(1) where the colours are only swapped if they have not otherwise 1589I<xterm>(1) where the colours are only swapped if they have not otherwise
1427been specified. For example, 1590been specified. For example,
1428 1591
1429=over 4
1430
1431=item B<@@RXVT_NAME@@ -fg Black -bg White -rv> 1592 @@RXVT_NAME@@ -fg Black -bg White -rv
1432 1593
1433would yield White on Black, while on I<xterm>(1) it would yield Black 1594would yield White on Black, while on I<xterm>(1) it would yield Black on
1434on White. 1595White.
1435
1436=back
1437 1596
1438=head2 ALPHA CHANNEL SUPPORT 1597=head2 ALPHA CHANNEL SUPPORT
1439 1598
1440If Xft support has been compiled in and as long as Xft/Xrender/X don't get 1599If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1441their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa> 1600their act together, rxvt-unicode will do its own alpha channel management:
1442(recommended, but B<MUST> have 4 digits/component) colour specifications, 1601
1443in addition to the ones provided by X, where the additional A component 1602You can prefix any colour with an opaqueness percentage enclosed in
1603brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1604(0-100) that specifies the opacity of the colour, where C<0> is completely
1605transparent and C<100> is completely opaque. For example, C<[50]red> is a
1606half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1607is the recommended format to specify transparency values, and works with
1608all ways to specify a colour.
1609
1610For complete control, rxvt-unicode also supports
1611C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1612specifications, where the additional C<aaaa> component specifies opacity
1444specifies opacity (alpha) values. The minimum value of C<0> is completely 1613(alpha) values. The minimum value of C<0000> is completely transparent,
1445transparent). You can also prefix any color with C<[percent]>, where 1614while C<ffff> is completely opaque). The two example colours from
1446C<percent> is a decimal percentage (0-100) that specifies the opacity of 1615earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1447the color, where C<0> is completely transparent and C<100> is completelxy 1616C<rgba:0000/ff00/0000/f332>.
1448opaque.
1449 1617
1450You probably need to specify B<"-depth 32">, too, and have the luck that 1618You probably need to specify B<"-depth 32">, too, to force a visual with
1451your X-server uses ARGB pixel layout, as X is far from just supporting 1619alpha channels, and have the luck that your X-server uses ARGB pixel
1452ARGB visuals out of the box, and rxvt-unicode just fudges around. 1620layout, as X is far from just supporting ARGB visuals out of the box, and
1621rxvt-unicode just fudges around.
1453 1622
1454For example, the following selects an almost completely transparent red 1623For example, the following selects an almost completely transparent black
1455background, and an almost opaque pink foreground: 1624background, and an almost opaque pink foreground:
1456 1625
1457 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink" 1626 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1458 1627
1459I<Please note that transparency of any kind if completely unsupported by 1628When not using a background image, then the interpretation of the
1460the author. Don't bug him with installation questions!> 1629alpha channel is up to your compositing manager (most interpret it as
1630transparency of course).
1631
1632When using a background pixmap or pseudo-transparency, then the background
1633colour will always behave as if it were completely transparent (so the
1634background image shows instead), regardless of how it was specified, while
1635other colours will either be transparent as specified (the background
1636image will show through) on servers supporting the RENDER extension, or
1637fully opaque on servers not supporting the RENDER EXTENSION.
1638
1639Please note that due to bugs in Xft, specifying alpha values might result
1640in garbage being displayed when the X-server does not support the RENDER
1641extension.
1461 1642
1462=head1 ENVIRONMENT 1643=head1 ENVIRONMENT
1463 1644
1464B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1645B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1465 1646
1471resources or on the command line. 1652resources or on the command line.
1472 1653
1473=item B<COLORTERM> 1654=item B<COLORTERM>
1474 1655
1475Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was 1656Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1476compiled with background image support, and optionally with the added 1657compiled with background image support, and optionally with the added
1477extension C<-mono> to indicate that rxvt-unicode runs on a monochrome 1658extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1478screen. 1659screen.
1479 1660
1480=item B<COLORFGBG> 1661=item B<COLORFGBG>
1481 1662
1482Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1663Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1483the colour code used as default foreground/text colour (or the string 1664the colour code used as default foreground/text colour (or the string
1484C<default> to indicate that the default-colour escape sequence is to be 1665C<default> to indicate that the default-colour escape sequence is to be
1485used), C<bg> is the colour code used as default background colour (or the 1666used), C<bg> is the colour code used as default background colour (or the
1486string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1667string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1487was compiled with background image support. Libraries like C<ncurses> 1668was compiled with background image support. Libraries like C<ncurses>
1488and C<slang> can (and do) use this information to optimize screen output. 1669and C<slang> can (and do) use this information to optimize screen output.
1489 1670
1490=item B<WINDOWID> 1671=item B<WINDOWID>
1491 1672
1492Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1673Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1499C<--with-terminfo=PATH>. 1680C<--with-terminfo=PATH>.
1500 1681
1501=item B<DISPLAY> 1682=item B<DISPLAY>
1502 1683
1503Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1684Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1504display in its child processes. 1685display in its child processes if C<-display> isn't used to override. It
1686defaults to C<:0> if it doesn't exist.
1505 1687
1506=item B<SHELL> 1688=item B<SHELL>
1507 1689
1508The shell to be used for command execution, defaults to C</bin/sh>. 1690The shell to be used for command execution, defaults to C</bin/sh>.
1509 1691
1510=item B<RXVT_SOCKET> 1692=item B<RXVT_SOCKET> [I<sic>]
1511 1693
1512The unix domain socket path used by @@RXVT_NAME@@c(1) and 1694The unix domain socket path used by @@RXVT_NAME@@c(1) and
1513@@RXVT_NAME@@d(1). 1695@@RXVT_NAME@@d(1).
1514 1696
1515Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1697Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1698
1699=item B<URXVT_PERL_LIB>
1700
1701Additional F<:>-separated library search path for perl extensions. Will be
1702searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1703directory.
1704
1705=item B<URXVT_PERL_VERBOSITY>
1706
1707See L<@@RXVT_NAME@@perl>(3).
1516 1708
1517=item B<HOME> 1709=item B<HOME>
1518 1710
1519Used to locate the default directory for the unix domain socket for 1711Used to locate the default directory for the unix domain socket for
1520daemon communications and to locate various resource files (such as 1712daemon communications and to locate various resource files (such as
1521C<.Xdefaults>) 1713C<.Xdefaults>)
1522 1714
1523=item B<XAPPLRESDIR> 1715=item B<XAPPLRESDIR>
1524 1716
1525Directory where various X resource files are being located. 1717Directory where application-specific X resource files are located.
1526 1718
1527=item B<XENVIRONMENT> 1719=item B<XENVIRONMENT>
1528 1720
1529If set and accessible, gives the name of a X resource file to be loaded by 1721If set and accessible, gives the name of a X resource file to be loaded by
1530@@RXVT_NAME@@. 1722@@RXVT_NAME@@.
1535 1727
1536=over 4 1728=over 4
1537 1729
1538=item B</usr/lib/X11/rgb.txt> 1730=item B</usr/lib/X11/rgb.txt>
1539 1731
1540Color names. 1732Colour names.
1541 1733
1542=back 1734=back
1543 1735
1544=head1 SEE ALSO 1736=head1 SEE ALSO
1545 1737
1738@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1546@@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) 1739@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1547 1740
1548=head1 CURRENT PROJECT COORDINATOR 1741=head1 CURRENT PROJECT COORDINATOR
1549 1742
1550=over 4 1743=over 4
1551 1744
1552=item Project Coordinator 1745=item Project Coordinator
1553 1746
1554Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1747Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1555 1748
1556L<http://software.schmorp.de/pkg/rxvt-unicode.html> 1749L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1557 1750
1558=back 1751=back
1559 1752
1563 1756
1564=item John Bovey 1757=item John Bovey
1565 1758
1566University of Kent, 1992, wrote the original Xvt. 1759University of Kent, 1992, wrote the original Xvt.
1567 1760
1568=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1761=item Rob Nation <nation@rocket.sanders.lockheed.com>
1569 1762
1570very heavily modified Xvt and came up with Rxvt 1763very heavily modified Xvt and came up with Rxvt
1571 1764
1572=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1765=item Angelo Haritsis <ah@doc.ic.ac.uk>
1573 1766
1574wrote the Greek Keyboard Input (no longer in code) 1767wrote the Greek Keyboard Input (no longer in code)
1575 1768
1576=item mj olesen L<< <olesen@me.QueensU.CA> >> 1769=item mj olesen <olesen@me.QueensU.CA>
1577 1770
1578Wrote the menu system. 1771Wrote the menu system.
1579 1772
1580Project Coordinator (changes.txt 2.11 to 2.21) 1773Project Coordinator (changes.txt 2.11 to 2.21)
1581 1774
1582=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1775=item Oezguer Kesim <kesim@math.fu-berlin.de>
1583 1776
1584Project Coordinator (changes.txt 2.21a to 2.4.5) 1777Project Coordinator (changes.txt 2.21a to 2.4.5)
1585 1778
1586=item Geoff Wing L<< <gcw@pobox.com> >> 1779=item Geoff Wing <gcw@pobox.com>
1587 1780
1588Rewrote screen display and text selection routines. 1781Rewrote screen display and text selection routines.
1589 1782
1590Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1783Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1591 1784
1592=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1785=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1593 1786
1594Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1787Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1595extension, random hacks, numerous bugfixes and extensions. 1788extension, random hacks, numerous bugfixes and extensions.
1596 1789
1597Project Coordinator (Changes 1.0 -) 1790Project Coordinator (Changes 1.0 -)
1598 1791
1599=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1792=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1600 1793
1601Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing. 1794pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1602 1795
1603=back 1796=back
1604 1797

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines