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.89 by root, Sun Jan 8 08:43:11 2006 UTC vs.
Revision 1.225 by sf-exg, Wed Jun 5 07:58:17 2013 UTC

… …
12emulator intended as an I<xterm>(1) replacement for users who do not 12emulator intended as an I<xterm>(1) replacement for users who do not
13require features such as Tektronix 4014 emulation and toolkit-style 13require features such as Tektronix 4014 emulation and toolkit-style
14configurability. As a result, B<rxvt-unicode> uses much less swap space -- 14configurability. As a result, B<rxvt-unicode> uses much less swap space --
15a significant advantage on a machine serving many X sessions. 15a significant advantage on a machine serving many X sessions.
16 16
17This document is also available on the World-Wide-Web at
18L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.1.pod>.
19
17=head1 FREQUENTLY ASKED QUESTIONS 20=head1 FREQUENTLY ASKED QUESTIONS
18 21
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 22See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 23frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 24problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 25L<http://pod.tst.eu/http://cvs.schmorp.de/rxvt-unicode/doc/rxvt.7.pod>.
23 26
24=head1 RXVT-UNICODE VS. RXVT 27=head1 RXVT-UNICODE VS. RXVT
25 28
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 29Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 30internally. That means it can store and display most scripts in the
28world. Being a terminal emulator, however, some things are very difficult, 31world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts 32especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules, 33like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. Don't expect pretty output when using these 34like tibetan or devanagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 35scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are left-to-right scripts, such 36fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 37as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 38belong in the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 39such as cursor-movement while editing -- break otherwise), but that might
37change. 40change.
38 41
39If you are looking for a terminal that supports more exotic scripts, let 42If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very userfriendly, lean and clean 43me recommend C<mlterm>, which is a very user friendly, lean and clean
41terminal emulator. In fact, the reason rxvt-unicode was born was solely 44terminal emulator. In fact, the reason rxvt-unicode was born was solely
42because the author couldn't get C<mlterm> to use one font for latin1 and 45because the author couldn't get C<mlterm> to use one font for latin1 and
43another for japanese. 46another for japanese.
44 47
45Therefore another design rationale was the use of multiple fonts to 48Therefore another design rationale was the use of multiple fonts to
46display characters: The idea of a single unicode font which many other 49display characters: The idea of a single unicode font which many other
47programs force onto it's users never made sense to me: You should be able 50programs force onto its users never made sense to me: You should be able
48to choose any font for any script freely. 51to choose any font for any script freely.
49 52
50Apart from that, rxvt-unicode is also much better internationalised than 53Apart from that, rxvt-unicode is also much better internationalised than
51it's predecessor, supports things such as XFT and ISO 14755 that are handy 54its predecessor, supports things such as XFT and ISO 14755 that are handy
52in i18n-environments, is faster, and has a lot less bugs than the original 55in i18n-environments, is faster, and has a lot bugs less than the original
53rxvt. This all in addition to dozens of other small improvements. 56rxvt. This all in addition to dozens of other small improvements.
54 57
55It is still faithfully following the original rxvt idea of being lean 58It is still faithfully following the original rxvt idea of being lean
56and nice on resources: for example, you can still configure rxvt-unicode 59and nice on resources: for example, you can still configure rxvt-unicode
57without most of it's features to get a lean binary. It also comes with 60without most of its features to get a lean binary. It also comes with
58a client/daemon pair that lets you open any number of terminal windows 61a client/daemon pair that lets you open any number of terminal windows
59from within a single process, which makes startup time very fast and 62from within a single process, which makes startup time very fast and
60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 63drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61@@RXVT_NAME@@c(1) (client). 64@@RXVT_NAME@@c(1) (client).
62 65
63It also makes technical information about escape sequences (which have 66It also makes technical information about escape sequences (which have
64been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 67been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65reference documentation (escape sequences etc.). 68reference documentation (escape sequences etc.).
66 69
67=head1 OPTIONS 70=head1 OPTIONS
68 71
69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed 72The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
… …
89 92
90Print out a message describing available options. 93Print out a message describing available options.
91 94
92=item B<-display> I<displayname> 95=item B<-display> I<displayname>
93 96
94Attempt to open a window on the named X display (B<-d> still 97Attempt to open a window on the named X display (the older form B<-d>
95respected). In the absence of this option, the display specified by the 98is still respected. but deprecated). In the absence of this option, the
96B<DISPLAY> environment variable is used. 99display specified by the B<DISPLAY> environment variable is used.
100
101=item B<-depth> I<bitdepth>
102
103Compile I<frills>: Attempt to find a visual with the given bit depth;
104resource B<depth>.
105
106[Please note that many X servers (and libXft) are buggy with
107respect to C<-depth 32> and/or alpha channels, and will cause all sorts
108of graphical corruption. This is harmless, but we can't do anything about
109this, so watch out]
110
111=item B<-visual> I<visualID>
112
113Compile I<frills>: Use the given visual (see e.g. C<xdpyinfo> for possible
114visual ids).
97 115
98=item B<-geometry> I<geom> 116=item B<-geometry> I<geom>
99 117
100Window geometry (B<-g> still respected); resource B<geometry>. 118Window geometry (B<-g> still respected); resource B<geometry>.
101 119
… …
103 121
104Turn on/off simulated reverse video; resource B<reverseVideo>. 122Turn on/off simulated reverse video; resource B<reverseVideo>.
105 123
106=item B<-j>|B<+j> 124=item B<-j>|B<+j>
107 125
108Turn on/off jump scrolling; resource B<jumpScroll>. 126Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109 127
110=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 128=item B<-ss>|B<+ss>
111 129
112Turn on/off inheriting parent window's pixmap. Alternative form is 130Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
113B<-tr>; resource B<inheritPixmap>.
114 131
115=item B<-fade> I<number> 132=item B<-fade> I<number>
116 133
117Fade the text by the given percentage when focus is lost. Small values 134Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade 135fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>. 136colour; resource B<fading>.
120 137
121=item B<-fadecolor> I<colour> 138=item B<-fadecolor> I<colour>
122 139
123Fade to this colour when fading is used (see B<-fade>). The default colour 140Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>. 141is opaque black. resource B<fadeColor>.
125 142
126=item B<-tint> I<colour> 143=item B<-icon> I<file>
127 144
128Tint the transparent background pixmap with the given colour when 145Compile I<pixbuf>: Use the specified image as application icon. This
129transparency is enabled with B<-tr> or B<-ip>. This only works for 146is used by many window managers, taskbars and pagers to represent the
130non-tiled backgrounds, currently. See also the B<-sh> option that can be 147application 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 148
142=item B<-bg> I<colour> 149=item B<-bg> I<colour>
143 150
144Window background colour; resource B<background>. 151Window background colour; resource B<background>.
145 152
146=item B<-fg> I<colour> 153=item B<-fg> I<colour>
147 154
148Window foreground colour; resource B<foreground>. 155Window 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 156
157=item B<-cr> I<colour> 157=item B<-cr> I<colour>
158 158
159The cursor colour; resource B<cursorColor>. 159The cursor colour; resource B<cursorColor>.
160 160
… …
172resource B<borderColor>. 172resource B<borderColor>.
173 173
174=item B<-fn> I<fontlist> 174=item B<-fn> I<fontlist>
175 175
176Select the fonts to be used. This is a comma separated list of font names 176Select 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 177that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 178first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 179smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 180font list is always appended to it. See resource B<font> for more details.
181 181
182In short, to specify an X11 core font, just specify it's name or prefix it 182In 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:>, 183with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.: 184e.g.:
185 185
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
… …
205italic> >> characters are to be printed. See resource B<boldItalicFont> 205italic> >> characters are to be printed. See resource B<boldItalicFont>
206for details. 206for details.
207 207
208=item B<-is>|B<+is> 208=item B<-is>|B<+is>
209 209
210Compile I<font-styles>: Bold/Italic font styles imply high intensity 210Compile I<font-styles>: Bold/Blink font styles imply high intensity
211foreground/background (default). See resource B<intensityStyles> for 211foreground/background (default). See resource B<intensityStyles> for
212details. 212details.
213 213
214=item B<-name> I<name> 214=item B<-name> I<name>
215 215
… …
233 233
234=item B<-sb>|B<+sb> 234=item B<-sb>|B<+sb>
235 235
236Turn on/off scrollbar; resource B<scrollBar>. 236Turn on/off scrollbar; resource B<scrollBar>.
237 237
238=item B<-sr>|B<+sr>
239
240Put scrollbar on right/left; resource B<scrollBar_right>.
241
242=item B<-st>|B<+st>
243
244Display rxvt (non XTerm/NeXT) scrollbar without/with a trough;
245resource B<scrollBar_floating>.
246
238=item B<-si>|B<+si> 247=item B<-si>|B<+si>
239 248
240Turn on/off scroll-to-bottom on TTY output inhibit; resource 249Turn on/off scroll-to-bottom on TTY output inhibit; resource
241B<scrollTtyOutput> has opposite effect. 250B<scrollTtyOutput> has opposite effect.
242 251
… …
248=item B<-sw>|B<+sw> 257=item B<-sw>|B<+sw>
249 258
250Turn on/off scrolling with the scrollback buffer as new lines appear. 259Turn on/off scrolling with the scrollback buffer as new lines appear.
251This only takes effect if B<-si> is also given; resource 260This only takes effect if B<-si> is also given; resource
252B<scrollWithBuffer>. 261B<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 262
263=item B<-ptab>|B<+ptab> 263=item B<-ptab>|B<+ptab>
264 264
265If enabled (default), "Horizontal Tab" characters are being stored as 265If enabled (default), "Horizontal Tab" characters are being stored as
266actual wide characters in the screen buffer, which makes it possible to 266actual wide characters in the screen buffer, which makes it possible to
… …
270 270
271=item B<-bc>|B<+bc> 271=item B<-bc>|B<+bc>
272 272
273Blink the cursor; resource B<cursorBlink>. 273Blink the cursor; resource B<cursorBlink>.
274 274
275=item B<-uc>|B<+uc>
276
277Make the cursor underlined; resource B<cursorUnderline>.
278
275=item B<-iconic> 279=item B<-iconic>
276 280
277Start iconified, if the window manager supports that option. 281Start iconified, if the window manager supports that option.
278Alternative form is B<-ic>. 282Alternative form is B<-ic>.
279 283
… …
295 299
296=item B<-bl> 300=item B<-bl>
297 301
298Compile I<frills>: Set MWM hints to request a borderless window, i.e. 302Compile 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 303if honoured by the WM, the rxvt-unicode window will not have window
300decorations; resource B<borderLess>. 304decorations; resource B<borderLess>. If the window manager does not
305support MWM hints (e.g. kwin), enables override-redirect mode.
306
307=item B<-override-redirect>
308
309Compile I<frills>: Sets override-redirect on the window; resource
310B<override-redirect>.
301 311
302=item B<-sbg> 312=item B<-sbg>
303 313
304Compile I<frills>: Disable the usage of the built-in block graphics/line 314Compile I<frills>: Disable the usage of the built-in block graphics/line
305drawing characters and just rely on what the specified fonts provide. Use 315drawing characters and just rely on what the specified fonts provide. Use
… …
308 318
309=item B<-lsp> I<number> 319=item B<-lsp> I<number>
310 320
311Compile I<frills>: Lines (pixel height) to insert between each row of 321Compile I<frills>: Lines (pixel height) to insert between each row of
312the display. Useful to work around font rendering problems; resource 322the display. Useful to work around font rendering problems; resource
313B<linespace>. 323B<lineSpace>.
324
325=item B<-letsp> I<number>
326
327Compile I<frills>: Amount to adjust the computed character width by
328to control overall letter spacing. Negative values will tighten up the
329letter spacing, positive values will space letters out more. Useful to
330work around odd font metrics; resource B<letterSpace>.
314 331
315=item B<-tn> I<termname> 332=item B<-tn> I<termname>
316 333
317This option specifies the name of the terminal type to be set in the 334This option specifies the name of the terminal type to be set in the
318B<TERM> environment variable. This terminal type must exist in the 335B<TERM> environment variable. This terminal type must exist in the
… …
372for more info. 389for more info.
373 390
374=item B<-tcw> 391=item B<-tcw>
375 392
376Change the meaning of triple-click selection with the left mouse 393Change the meaning of triple-click selection with the left mouse
394button. Only effective when the original (non-perl) selection code is
377button. Instead of selecting a full line it will extend the selection the 395in-use. Instead of selecting a full line it will extend the selection to
378end of the logical line only. resource B<tripleclickwords>. 396the end of the logical line only. resource B<tripleclickwords>.
379 397
380=item B<-insecure> 398=item B<-insecure>
381 399
382Enable "insecure" mode, which currently enables most of the escape 400Enable "insecure" mode, which currently enables most of the escape
383sequences that echo strings. See the resource B<insecure> for more 401sequences that echo strings. See the resource B<insecure> for more
… …
404Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 422Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
405will not immediately destroy its window when the program executed within 423will not immediately destroy its window when the program executed within
406it exits. Instead, it will wait till it is being killed or closed by the 424it exits. Instead, it will wait till it is being killed or closed by the
407user; resource B<hold>. 425user; resource B<hold>.
408 426
427=item B<-cd> I<path>
428
429Sets the working directory for the shell (or the command specified via
430B<-e>). The I<path> must be an absolute path and it must exist for
431@@RXVT_NAME@@ to start; resource B<chdir>.
432
433=item B<-xrm> I<string>
434
435Works like the X Toolkit option of the same name, by adding the I<string>
436as if it were specified in a resource file. Resource values specified this
437way take precedence over all other resource specifications.
438
439Note that you need to use the I<same> syntax as in the .Xdefaults file,
440e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
441options can be specified as long-options on the commandline, so use
442of B<-xrm> is mostly limited to cases where you want to specify other
443resources (e.g. for input methods) or for compatibility with other
444programs.
445
409=item B<-keysym.>I<sym> I<string> 446=item B<-keysym.>I<sym> I<string>
410 447
411Remap a key symbol. See resource B<keysym>. 448Remap a key symbol. See resource B<keysym>.
412 449
413=item B<-embed> I<windowid> 450=item B<-embed> I<windowid>
414 451
415Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 452Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
416which enables applications to easily embed a terminal. 453which enables applications to easily embed a terminal.
417 454
418Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 455Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it
419shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it 456shouldn't be a top-level window. @@RXVT_NAME@@ will also reconfigure it
420quite a bit, so don't expect it to keep some specific state. It's best to 457quite a bit, so don't expect it to keep some specific state. It's best to
… …
423The window will not be destroyed when @@RXVT_NAME@@ exits. 460The window will not be destroyed when @@RXVT_NAME@@ exits.
424 461
425It might be useful to know that @@RXVT_NAME@@ will not close file 462It might be useful to know that @@RXVT_NAME@@ will not close file
426descriptors passed to it (except for stdin/out/err, of course), so you 463descriptors passed to it (except for stdin/out/err, of course), so you
427can use file descriptors to communicate with the programs within the 464can use file descriptors to communicate with the programs within the
428terminal. This works regardless of wether the C<-embed> option was used or 465terminal. This works regardless of whether the C<-embed> option was used or
429not. 466not.
430 467
431Here is a short Gtk2-perl snippet that illustrates how this option can be 468Here is a short Gtk2-perl snippet that illustrates how this option can be
432used (a longer example is in F<doc/embed>): 469used (a longer example is in F<doc/embed>):
433 470
… …
438 }); 475 });
439 476
440=item B<-pty-fd> I<file descriptor> 477=item B<-pty-fd> I<file descriptor>
441 478
442Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 479Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty
443pair but instead use the given filehandle as the tty master. This is 480pair but instead use the given file descriptor as the tty master. This is
444useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator 481useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445without having to run a program within it. 482without having to run a program within it.
446 483
447If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 484If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp
448entries and will not tinker with pty/tty permissions - you have to do that 485entries and will not tinker with pty/tty permissions - you have to do that
449yourself if you want that. 486yourself if you want that.
450 487
451As an extremely special case, specifying C<-1> will completely suppress 488As an extremely special case, specifying C<-1> will completely suppress
452pty/tty operations. 489pty/tty operations, which is probably only useful in conjunction with some
490perl extension that manages the terminal.
453 491
454Here is a example in perl that illustrates how this option can be used (a 492Here is a example in perl that illustrates how this option can be used (a
455longer example is in F<doc/pty-fd>): 493longer example is in F<doc/pty-fd>):
456 494
457 use IO::Pty; 495 use IO::Pty;
… …
471Comma-separated list of perl extension scripts to use (or not to use) in 509Comma-separated list of perl extension scripts to use (or not to use) in
472this terminal instance. See resource B<perl-ext> for details. 510this terminal instance. See resource B<perl-ext> for details.
473 511
474=back 512=back
475 513
476=head1 RESOURCES (available also as long-options) 514=head1 RESOURCES
477 515
478Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 516Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
479options) compiled into your version. 517options) compiled into your version. All resources are also available as
518long-options.
480 519
481There are two different methods that @@RXVT_NAME@@ can use to get the 520You can set and change the resources using X11 tools like B<xrdb>. Many
482Xresource data: using the X libraries (Xrm*-functions) or internal 521distribution do also load settings from the B<~/.Xresources> file when X
483Xresources reader (B<~/.Xdefaults>). For the first method (ie. 522starts. @@RXVT_NAME@@ will consult the following files/resources in order,
484B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 523with later settings overwriting earlier ones:
485resources using X11 tools like B<xrdb>. Many distribution do also load
486settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
487will consult the following files/resources in order, with later settings
488overwriting earlier ones:
489 524
490 1. system-wide app-defaults file, either locale-dependent OR global
491 2. app-defaults file in $XAPPLRESDIR 525 1. app-defaults file in $XAPPLRESDIR
526 2. $HOME/.Xdefaults
492 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 527 3. RESOURCE_MANAGER property on root-window of screen 0
493 4. SCREEN_RESOURCES for the current screen 528 4. SCREEN_RESOURCES property on root-window of the current screen
494 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 529 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
530 6. resources specified via -xrm on the commandline
495 531
496If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
497lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
498set in XAPPLOADDIR/URxvt (compile-time defined: usually
499B</usr/lib/X11/app-defaults/URxvt>) and resources set in
500B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
501Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 532Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
502class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 533names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
503resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 534common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
504easily configured, while the class name B<URxvt> allows resources 535configured, while the class name B<URxvt> allows resources unique to
505unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 536B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
506shared between different B<@@RXVT_NAME@@> configurations. If no 537configurations. If no resources are specified, suitable defaults will
507resources are specified, suitable defaults will be used. Command-line 538be used. Command-line arguments can be used to override resource
508arguments can be used to override resource settings. The following 539settings. The following resources are supported (you might want to
509resources are allowed: 540check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
541extensions not documented here):
510 542
511=over 4 543=over 4
544
545=item B<depth:> I<bitdepth>
546
547Compile I<xft>: Attempt to find a visual with the given bit depth;
548option B<-depth>.
549
550=item B<buffered:> I<boolean>
551
552Compile I<xft>: Turn on/off double-buffering for xft (default enabled).
553On some card/driver combination enabling it slightly decreases
554performance, on most it greatly helps it. The slowdown is small, so it
555should normally be enabled.
512 556
513=item B<geometry:> I<geom> 557=item B<geometry:> I<geom>
514 558
515Create the window with the specified X window geometry [default 80x24]; 559Create the window with the specified X window geometry [default 80x24];
516option B<-geometry>. 560option B<-geometry>.
… …
530Use the specified colour for the colour value I<n>, where 0-7 574Use the specified colour for the colour value I<n>, where 0-7
531corresponds to low-intensity (normal) colours and 8-15 corresponds to 575corresponds to low-intensity (normal) colours and 8-15 corresponds to
532high-intensity (bold = bright foreground, blink = bright background) 576high-intensity (bold = bright foreground, blink = bright background)
533colours. The canonical names are as follows: 0=black, 1=red, 2=green, 577colours. The canonical names are as follows: 0=black, 1=red, 2=green,
5343=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour 5783=yellow, 4=blue, 5=magenta, 6=cyan, 7=white, but the actual colour
535names used are listed in the B<COLORS AND GRAPHICS> section. 579names used are listed in the B<COLOURS AND GRAPHICS> section.
536 580
537Colours higher than 15 cannot be set using resources (yet), but can be 581Colours higher than 15 cannot be set using resources (yet), but can be
538changed using an escape command (see @@RXVT_NAME@@(7)). 582changed using an escape command (see @@RXVT_NAME@@(7)).
539 583
540Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with 584Colours 16-79 form a standard 4x4x4 colour cube (the same as xterm with
… …
551=item B<colorUL:> I<colour> 595=item B<colorUL:> I<colour>
552 596
553Use the specified colour to display underlined characters when the 597Use the specified colour to display underlined characters when the
554foreground colour is the default. 598foreground colour is the default.
555 599
556=item B<colorRV:> I<colour>
557
558Use the specified colour as the background for reverse video
559characters.
560
561=item B<underlineColor:> I<colour> 600=item B<underlineColor:> I<colour>
562 601
563If set, use the specified colour as the colour for the underline 602If set, use the specified colour as the colour for the underline
564itself. If unset, use the foreground colour. 603itself. If unset, use the foreground colour.
604
605=item B<highlightColor:> I<colour>
606
607If set, use the specified colour as the background for highlighted
608characters. If unset, use reverse video.
609
610=item B<highlightTextColor:> I<colour>
611
612If set and highlightColor is set, use the specified colour as the
613foreground for highlighted characters.
565 614
566=item B<cursorColor:> I<colour> 615=item B<cursorColor:> I<colour>
567 616
568Use the specified colour for the cursor. The default is to use the 617Use the specified colour for the cursor. The default is to use the
569foreground colour; option B<-cr>. 618foreground colour; option B<-cr>.
… …
576 625
577=item B<reverseVideo:> I<boolean> 626=item B<reverseVideo:> I<boolean>
578 627
579B<True>: simulate reverse video by foreground and background colours; 628B<True>: simulate reverse video by foreground and background colours;
580option B<-rv>. B<False>: regular screen colours [default]; option 629option B<-rv>. B<False>: regular screen colours [default]; option
581B<+rv>. See note in B<COLORS AND GRAPHICS> section. 630B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
582 631
583=item B<jumpScroll:> I<boolean> 632=item B<jumpScroll:> I<boolean>
584 633
585B<True>: specify that jump scrolling should be used. When scrolling 634B<True>: specify that jump scrolling should be used. When receiving lots
586quickly, fewer screen updates are performed [default]; option B<-j>. 635of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
636has been read, resulting in fewer updates while still displaying every
637received line; option B<-j>.
638
587B<False>: specify that smooth scrolling should be used; option B<+j>. 639B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
640force a screen refresh on each new line it received; option B<+j>.
588 641
589=item B<inheritPixmap:> I<boolean> 642=item B<skipScroll:> I<boolean>
590 643
591B<True>: make the background inherit the parent windows' pixmap, giving 644B<True>: (the default) specify that skip scrolling should be used. When
592artificial transparency. B<False>: do not inherit the parent windows' 645receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
593pixmap. 646(around 60 times per second), resulting in far fewer updates. This can
647result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
648option B<-ss>.
649
650B<False>: specify that everything is to be displayed, even
651if the refresh is too fast for the human eye to read anything (or the
652monitor to display anything); option B<+ss>.
594 653
595=item B<fading:> I<number> 654=item B<fading:> I<number>
596 655
597Fade the text by the given percentage when focus is lost; option B<-fade>. 656Fade the text by the given percentage when focus is lost; option B<-fade>.
598 657
599=item B<fadeColor:> I<colour> 658=item B<fadeColor:> I<colour>
600 659
601Fade to this colour, when fading is used (see B<fading:>). The default 660Fade to this colour, when fading is used (see B<fading:>). The default
602colour is black; option B<-fadecolor>. 661colour is black; option B<-fadecolor>.
603 662
604=item B<tintColor:> I<colour> 663=item B<iconFile:> I<file>
605 664
606Tint the transparent background pixmap with the given colour; option 665Set the application icon pixmap; option B<-icon>.
607B<-tint>.
608
609=item B<shading:> I<number>
610
611Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
612image in addition to tinting it.
613 666
614=item B<scrollColor:> I<colour> 667=item B<scrollColor:> I<colour>
615 668
616Use the specified colour for the scrollbar [default #B2B2B2]. 669Use the specified colour for the scrollbar [default #B2B2B2].
617 670
… …
623=item B<borderColor:> I<colour> 676=item B<borderColor:> I<colour>
624 677
625The colour of the border around the text area and between the scrollbar 678The colour of the border around the text area and between the scrollbar
626and the text. 679and the text.
627 680
628=item B<backgroundPixmap:> I<file[;geom]>
629
630Use the specified XPM file (note the `.xpm' extension is optional) for
631the background and also optionally specify its scaling with a geometry
632string B<WxH+X+Y>, in which B<"W" / "H"> specify the
633horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image
634centre (percent). A scale of 0 displays the image with tiling. A scale
635of 1 displays the image without any scaling. A scale of 2 to 9
636specifies an integer number of images in that direction. No image will
637be magnified beyond 10 times its original size. The maximum permitted
638scale is 1000. [default 0x0+50+50]
639
640=item B<menu:> I<file[;tag]>
641
642Read in the specified menu file (note the `.menu' extension is
643optional) and also optionally specify a starting tag to find. See the
644reference documentation for details on the syntax for the menuBar.
645
646=item B<path:> I<path>
647
648Specify the colon-delimited search path for finding files (XPM and
649menus), in addition to the paths specified by the B<RXVTPATH> and
650B<PATH> environment variables.
651
652=item B<font:> I<fontlist> 681=item B<font:> I<fontlist>
653 682
654Select the fonts to be used. This is a comma separated list of font 683Select the fonts to be used. This is a comma separated list of font names
655names that are used in turn when trying to display Unicode characters. 684that are checked in order when trying to find glyphs for characters. The
656The first font defines the cell size for characters; other fonts might 685first font defines the cell size for characters; other fonts might be
657be smaller, but not larger. A reasonable default font list is always 686smaller, but not (in general) larger. A (hopefully) reasonable default
658appended to it; option B<-fn>. 687font list is always appended to it; option B<-fn>.
659 688
660Each font can either be a standard X11 core font (XLFD) name, with 689Each font can either be a standard X11 core font (XLFD) name, with
661optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 690optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
662 691
663In addition, each font can be prefixed with additional hints and 692In addition, each font can be prefixed with additional hints and
… …
665hint currently is C<codeset=codeset-name>, and this is only used for Xft 694hint currently is C<codeset=codeset-name>, and this is only used for Xft
666fonts. 695fonts.
667 696
668For example, this font resource 697For example, this font resource
669 698
670 URxvt*font: 9x15bold,\ 699 URxvt.font: 9x15bold,\
671 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 700 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
672 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 701 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
673 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 702 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
674 xft:Code2000:antialias=false 703 xft:Code2000:antialias=false
675 704
… …
678it is named first) and thus defines the character cell grid to be 9 pixels 707it is named first) and thus defines the character cell grid to be 9 pixels
679wide and 15 pixels high. 708wide and 15 pixels high.
680 709
681The second font is just used to add additional unicode characters not in 710The second font is just used to add additional unicode characters not in
682the base font, likewise the third, which is unfortunately non-bold, but 711the base font, likewise the third, which is unfortunately non-bold, but
683the bold version of the font does contain less characters, so this is a 712the bold version of the font does contain fewer characters, so this is a
684useful supplement. 713useful supplement.
685 714
686The third font is an Xft font with aliasing turned off, and the characters 715The third font is an Xft font with aliasing turned off, and the characters
687are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font 716are limited to the B<JIS 0208> codeset (i.e. japanese kanji). The font
688contains other characters, but we are not interested in them. 717contains other characters, but we are not interested in them.
… …
712text font will being used for the given style. 741text font will being used for the given style.
713 742
714=item B<intensityStyles:> I<boolean> 743=item B<intensityStyles:> I<boolean>
715 744
716When font styles are not enabled, or this option is enabled (B<True>, 745When font styles are not enabled, or this option is enabled (B<True>,
717option B<-is>, the default), bold and italic font styles imply high 746option B<-is>, the default), bold/blink font styles imply high
718intensity foreground/backround colours. Disabling this option (B<False>, 747intensity foreground/background colours. Disabling this option (B<False>,
719option B<+is>) disables this behaviour, the high intensity colours are not 748option B<+is>) disables this behaviour, the high intensity colours are not
720reachable. 749reachable.
721
722=item B<selectstyle:> I<mode>
723
724Set mouse selection style to B<old> which is 2.20, B<oldword> which is
725xterm style with 2.20 old word selection, or anything else which gives
726xterm style selection.
727
728=item B<scrollstyle:> I<mode>
729
730Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
731the author's favourite.
732 750
733=item B<title:> I<string> 751=item B<title:> I<string>
734 752
735Set window title string, the default title is the command-line 753Set window title string, the default title is the command-line
736specified after the B<-e> option, if any, otherwise the application 754specified after the B<-e> option, if any, otherwise the application
… …
745=item B<mapAlert:> I<boolean> 763=item B<mapAlert:> I<boolean>
746 764
747B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 765B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
748de-iconify (map) on receipt of a bell character [default]. 766de-iconify (map) on receipt of a bell character [default].
749 767
768=item B<urgentOnBell:> I<boolean>
769
770B<True>: set the urgency hint for the wm on receipt of a bell character.
771B<False>: do not set the urgency hint [default].
772
773@@RXVT_NAME@@ resets the urgency hint on every focus change.
774
750=item B<visualBell:> I<boolean> 775=item B<visualBell:> I<boolean>
751 776
752B<True>: use visual bell on receipt of a bell character; option B<-vb>. 777B<True>: use visual bell on receipt of a bell character; option B<-vb>.
753B<False>: no visual bell [default]; option B<+vb>. 778B<False>: no visual bell [default]; option B<+vb>.
754 779
… …
772 797
773The string will be interpreted as if typed into the shell as-is. 798The string will be interpreted as if typed into the shell as-is.
774 799
775Example: 800Example:
776 801
777 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 802 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
778 803
779This creates a new file in your home directory with the screen contents 804This creates a new file in your home directory with the screen contents
780everytime you hit C<Print>. 805every time you hit C<Print>.
806
807=item B<scrollstyle:> I<mode>
808
809Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
810the author's favourite.
811
812=item B<thickness:> I<number>
813
814Set the scrollbar width in pixels.
781 815
782=item B<scrollBar:> I<boolean> 816=item B<scrollBar:> I<boolean>
783 817
784B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 818B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
785disable the scrollbar; option B<+sb>. 819disable the scrollbar; option B<+sb>.
… …
805B<False>: do not scroll to bottom when tty receives output; option 839B<False>: do not scroll to bottom when tty receives output; option
806B<+si>. 840B<+si>.
807 841
808=item B<scrollWithBuffer:> I<boolean> 842=item B<scrollWithBuffer:> I<boolean>
809 843
810B<True>: scroll with scrollback buffer when tty receives new lines (and 844B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
811B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 845try to show the same lines) and B<scrollTtyOutput> is False; option
812with scrollback buffer when tty recieves new lines; option B<+sw>. 846B<-sw>. B<False>: do not scroll with scrollback buffer when tty receives
847new lines; option B<+sw>.
813 848
814=item B<scrollTtyKeypress:> I<boolean> 849=item B<scrollTtyKeypress:> I<boolean>
815 850
816B<True>: scroll to bottom when a non-special key is pressed. Special keys 851B<True>: scroll to bottom when a non-special key is pressed. Special keys
817are those which are intercepted by rxvt-unicode for special handling and 852are those which are intercepted by rxvt-unicode for special handling and
… …
848=item B<termName:> I<termname> 883=item B<termName:> I<termname>
849 884
850Specifies the terminal type name to be set in the B<TERM> environment 885Specifies the terminal type name to be set in the B<TERM> environment
851variable; option B<-tn>. 886variable; option B<-tn>.
852 887
853=item B<linespace:> I<number> 888=item B<lineSpace:> I<number>
854 889
855Specifies number of lines (pixel height) to insert between each row of 890Specifies number of lines (pixel height) to insert between each row of
856the display [default 0]; option B<-lsp>. 891the display [default 0]; option B<-lsp>.
857 892
858=item B<meta8:> I<boolean> 893=item B<meta8:> I<boolean>
… …
872 907
873=item B<cursorBlink:> I<boolean> 908=item B<cursorBlink:> I<boolean>
874 909
875B<True>: blink the cursor. B<False>: do not blink the cursor [default]; 910B<True>: blink the cursor. B<False>: do not blink the cursor [default];
876option B<-bc>. 911option B<-bc>.
912
913=item B<cursorUnderline:> I<boolean>
914
915B<True>: Make the cursor underlined. B<False>: Make the cursor a box [default];
916option B<-uc>.
877 917
878=item B<pointerBlank:> I<boolean> 918=item B<pointerBlank:> I<boolean>
879 919
880B<True>: blank the pointer when a key is pressed or after a set number 920B<True>: blank the pointer when a key is pressed or after a set number
881of seconds of inactivity. B<False>: the pointer is always visible 921of seconds of inactivity. B<False>: the pointer is always visible
… …
895large number (e.g. C<987654321>) to effectively disable the timeout. 935large number (e.g. C<987654321>) to effectively disable the timeout.
896 936
897=item B<backspacekey:> I<string> 937=item B<backspacekey:> I<string>
898 938
899The string to send when the backspace key is pressed. If set to B<DEC> 939The string to send when the backspace key is pressed. If set to B<DEC>
900or unset it will send B<Delete> (code 127) or, if shifted, B<Backspace> 940or unset it will send B<Delete> (code 127) or, with control, B<Backspace>
901(code 8) - which can be reversed with the appropriate DEC private mode 941(code 8) - which can be reversed with the appropriate DEC private mode
902escape sequence. 942escape sequence.
903 943
904=item B<deletekey:> I<string> 944=item B<deletekey:> I<string>
905 945
… …
907pressed. If unset it will send the sequence traditionally associated 947pressed. If unset it will send the sequence traditionally associated
908with the B<Execute> key. 948with the B<Execute> key.
909 949
910=item B<cutchars:> I<string> 950=item B<cutchars:> I<string>
911 951
912The characters used as delimiters for double-click word selection. The 952The characters used as delimiters for double-click word selection
913built-in default: 953(whitespace delimiting is added automatically if resource is given).
914 954
955When the perl selection extension is in use (the default if compiled
956in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
957characters will be created (if the resource exists, otherwise, no regex
958will be created). In this mode, characters outside ISO-8859-1 can be used.
959
960When the selection extension is not used, only ISO-8859-1 characters can
961be used. If not specified, the built-in default is used:
962
915B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 963B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
916 964
917=item B<preeditType:> I<style> 965=item B<preeditType:> I<style>
918 966
919B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 967B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
920 968
… …
954default. (Note that many other terminals, including xterm, have these 1002default. (Note that many other terminals, including xterm, have these
955sequences enabled by default, which doesn't make it safer, though). 1003sequences enabled by default, which doesn't make it safer, though).
956 1004
957You can enable them by setting this boolean resource or specifying 1005You can enable them by setting this boolean resource or specifying
958B<-insecure> as an option. At the moment, this enables display-answer, 1006B<-insecure> as an option. At the moment, this enables display-answer,
959locale, findfont, icon label and window title requests as well as dynamic 1007locale, findfont, icon label and window title requests.
960menubar dispatch.
961 1008
962=item B<modifier:> I<modifier> 1009=item B<modifier:> I<modifier>
963 1010
964Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 1011Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
965B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 1012B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
… …
969 1016
970Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1017Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
971character is passed through. It may contain escape values as described 1018character is passed through. It may contain escape values as described
972in the entry on B<keysym> following. 1019in the entry on B<keysym> following.
973 1020
974=item B<secondaryScreen:> I<bool> 1021=item B<secondaryScreen:> I<boolean>
975 1022
976Turn on/off secondary screen (default enabled). 1023Turn on/off secondary screen (default enabled).
977 1024
978=item B<secondaryScroll:> I<bool> 1025=item B<secondaryScroll:> I<boolean>
979 1026
980Turn on/off secondary screen scroll (default enabled). If the this 1027Turn on/off secondary screen scroll (default enabled). If this
981option is enabled, scrolls on the secondary screen will change the 1028option is enabled, scrolls on the secondary screen will change the
982scrollback buffer and switching to/from the secondary screen will 1029scrollback buffer and, when secondaryScreen is off, switching
983instead scroll the screen up. 1030to/from the secondary screen will instead scroll the screen up.
984 1031
985=item B<hold>: I<bool> 1032=item B<hold>: I<boolean>
986 1033
987Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1034Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
988will not immediately destroy its window when the program executed within 1035will not immediately destroy its window when the program executed within
989it exits. Instead, it will wait till it is being killed or closed by the 1036it exits. Instead, it will wait till it is being killed or closed by the
990user. 1037user.
1038
1039=item B<chdir>: I<path>
1040
1041Sets the working directory for the shell (or the command specified via
1042B<-e>). The I<path> must be an absolute path and it must exist for
1043@@RXVT_NAME@@ to start. If it isn't specified then the current working
1044directory will be used; option B<-cd>.
991 1045
992=item B<keysym.>I<sym>: I<string> 1046=item B<keysym.>I<sym>: I<string>
993 1047
994Compile I<frills>: Associate I<string> with keysym I<sym>. The 1048Compile I<frills>: Associate I<string> with keysym I<sym>. The
995intervening resource name B<keysym.> cannot be omitted. 1049intervening resource name B<keysym.> cannot be omitted.
… …
1009searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1063searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1010omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1064omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1011keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1065keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1012performed in an exact manner; however, the closest match is assured. 1066performed in an exact manner; however, the closest match is assured.
1013 1067
1014I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1068I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1015C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1069number), see RESOURCES in C<man 7 X> for further details.
1016C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1017C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1018can start or end with whitespace.
1019 1070
1020Please note that you need to double the C<\> when using
1021C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
1022use C<\033> instead of C<\e> (and so on), which will work with both Xt and
1023@@RXVT_NAME@@'s own processing).
1024
1025You can define a range of keysyms in one shot by providing a I<string> 1071You can define a range of keysyms in one shot by
1072loading the C<keysym-list> perl extension and providing a I<string>
1026with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1073with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1027should be a character not used by the strings. 1074should be a character not used by the strings.
1028 1075
1029Its usage can be demonstrated by an example: 1076Its usage can be demonstrated by an example:
1030 1077
1031 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1078 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1032 1079
1033The above line is equivalent to the following three lines: 1080The above line is equivalent to the following three lines:
1034 1081
1035 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1082 URxvt.keysym.Meta-Control-0x61: \033<a>
1036 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1083 URxvt.keysym.Meta-Control-0x62: \033<b>
1037 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1084 URxvt.keysym.Meta-Control-0x63: \033<c>
1038 1085
1039If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1086If I<string> takes the form of C<command:STRING>, the specified B<STRING>
1040is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1087is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1041example the following means "change the current locale to C<zh_CN.GBK> 1088example the following means "change the current locale to C<zh_CN.GBK>
1042when Control-Meta-c is being pressed": 1089when Control-Meta-c is being pressed":
1043 1090
1044 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1091 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1045 1092
1046If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1093If I<string> takes the form C<perl:STRING>, then the specified B<STRING>
1047is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1094is passed to the C<on_user_command> perl handler. See the @@RXVT_NAME@@perl(3)
1048manpage. For example, the F<selection> extension (activated via 1095manpage. For example, the F<selection> extension (activated via
1049C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1096C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1050 1097
1051 URxvt.keysym.M-C-c: perl:selection:rot13 1098 URxvt.keysym.M-C-c: perl:selection:rot13
1052 1099
1053Due the the large number of modifier combinations, a defined key mapping 1100Due the the large number of modifier combinations, a defined key mapping
1054will match if at I<at least> the specified identifiers are being set, and 1101will match if I<at least> the specified identifiers are being set, and
1055no other key mappings with those and more bits are being defined. That 1102no other key mappings with those and more bits are being defined. That
1056means that defining a key map for C<a> will automatically provide 1103means that defining a key map for C<a> will automatically provide
1057definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined 1104definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1058mappings themselves. 1105mappings themselves.
1059 1106
… …
1088 1135
1089Comma-separated list(s) of perl extension scripts (default: C<default>) to 1136Comma-separated list(s) of perl extension scripts (default: C<default>) to
1090use in this terminal instance; option B<-pe>. 1137use in this terminal instance; option B<-pe>.
1091 1138
1092Extension names can be prefixed with a C<-> sign to prohibit using 1139Extension names can be prefixed with a C<-> sign to prohibit using
1093it. This can be useful to selectively disable some extensions loaded 1140them. This can be useful to selectively disable some extensions loaded
1094by default, or specified via the C<perl-ext-common> resource. For 1141by default, or specified via the C<perl-ext-common> resource. For
1095example, C<default,-selection> will use all the default extension except 1142example, C<default,-selection> will use all the default extension except
1096C<selection>. 1143C<selection>.
1144
1145Extension names can also be followed by an argument in angle brackets
1146(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1147searchable scrollback to Alt/Meta-s). Mentioning the same extension
1148multiple times with different arguments will pass multiple arguments to
1149the extension.
1097 1150
1098Each extension is looked up in the library directories, loaded if 1151Each extension is looked up in the library directories, loaded if
1099necessary, and bound to the current terminal instance. 1152necessary, and bound to the current terminal instance.
1100 1153
1101If both of these resources are the empty string, then the perl 1154If both of these resources are the empty string, then the perl
… …
1104all instances, while B<perl-ext> is used for specific instances. 1157all instances, while B<perl-ext> is used for specific instances.
1105 1158
1106=item B<perl-eval>: I<string> 1159=item B<perl-eval>: I<string>
1107 1160
1108Perl code to be evaluated when all extensions have been registered. See 1161Perl code to be evaluated when all extensions have been registered. See
1109the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1162the @@RXVT_NAME@@perl(3) manpage.
1110will be ignored when running setuid/setgid.
1111 1163
1112=item B<perl-lib>: I<path> 1164=item B<perl-lib>: I<path>
1113 1165
1114Colon-separated list of additional directories that hold extension 1166Colon-separated list of additional directories that hold extension
1115scripts. When looking for extensions specified by the C<perl> resource, 1167scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1116@@RXVT_NAME@@ will first look in these directories and then in 1168in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1117F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1169lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1118will be ignored when running setuid/setgid.
1119 1170
1120See the @@RXVT_NAME@@perl(3) manpage. 1171See the @@RXVT_NAME@@perl(3) manpage.
1172
1173=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1174
1175Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1176details.
1177
1178=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1179
1180Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1181for details.
1182
1183=item B<searchable-scrollback:> I<keysym>
1184
1185Sets the hotkey that starts the incremental scrollback buffer search
1186(default: C<M-s>).
1187
1188=item B<url-launcher>: I<string>
1189
1190Specifies the program to be started with a URL argument. Used by the
1191C<selection-popup> and C<matcher> perl extensions.
1192
1193=item B<transient-for>: I<windowid>
1194
1195Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1196
1197=item B<override-redirect>: I<boolean>
1198
1199Compile I<frills>: Sets override-redirect for the terminal window, making
1200it almost invisible to window managers; option B<-override-redirect>.
1201
1202=item B<iso14755:> I<boolean>
1203
1204Turn on/off ISO 14755 (default enabled).
1205
1206=item B<iso14755_52:> I<boolean>
1207
1208Turn on/off ISO 14755 5.2 mode (default enabled).
1209
1210=back
1211
1212=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1213
1214=over 4
1215
1216=item B<-pixmap> I<file[;oplist]>
1217
1218=item B<backgroundPixmap:> I<file[;oplist]>
1219
1220Compile I<pixbuf>: Use the specified image file as the window's
1221background and also optionally specify a colon separated list of
1222operations to modify it. Note that you may need to quote the C<;>
1223character when using the command line option, as C<;> is usually a
1224metacharacter in shells. Supported operations are:
1225
1226=over 4
1227
1228=item B<WxH+X+Y>
1229
1230sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1231scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1232scale of 0 disables scaling.
1233
1234=item B<op=tile>
1235
1236enables tiling
1237
1238=item B<op=keep-aspect>
1239
1240maintain the image aspect ratio when scaling
1241
1242=item B<op=root-align>
1243
1244use the position of the terminal window relative to the root window as
1245the image offset, simulating a root window background
1246
1247=back
1248
1249The default scale and position setting is C<100x100+50+50>.
1250Alternatively, a predefined set of templates can be used to achieve
1251the most common setups:
1252
1253=over 4
1254
1255=item B<style=tiled>
1256
1257the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1258
1259=item B<style=aspect-stretched>
1260
1261the image is scaled to fill the whole window maintaining the aspect
1262ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1263
1264=item B<style=stretched>
1265
1266the image is scaled to fill the whole window. Equivalent to 100x100
1267
1268=item B<style=centered>
1269
1270the image is centered with no scaling. Equivalent to 0x0+50+50
1271
1272=item B<style=root-tiled>
1273
1274the image is tiled with no scaling and using 'root' positioning.
1275Equivalent to 0x0:op=tile:op=root-align
1276
1277=back
1278
1279If multiple templates are specified the last one wins. Note that a
1280template overrides all the scale, position and operations settings.
1281
1282If used in conjunction with pseudo-transparency, the specified pixmap
1283will be blended over the transparent background using alpha-blending.
1284
1285=item B<-tr>|B<+tr>
1286
1287=item B<transparent:> I<boolean>
1288
1289Turn on/off pseudo-transparency by using the root pixmap as background.
1290
1291B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1292will be removed in future versions.
1293
1294=item B<-tint> I<colour>
1295
1296=item B<tintColor:> I<colour>
1297
1298Tint the transparent background with the given colour. Note that a
1299black tint yields a completely black image while a white tint yields
1300the image unchanged.
1301
1302=item B<-sh> I<number>
1303
1304=item B<shading:> I<number>
1305
1306Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1307A value of 100 means no shading.
1308
1309=item B<-blr> I<HxV>
1310
1311=item B<blurRadius:> I<HxV>
1312
1313Apply gaussian blur with the specified radius to the transparent
1314background. If a single number is specified, the vertical and
1315horizontal radii are considered to be the same. Setting one of the
1316radii to 1 and the other to a large number creates interesting effects
1317on some backgrounds. The maximum radius value is 128. An horizontal or
1318vertical radius of 0 disables blurring.
1319
1320=item B<path:> I<path>
1321
1322Specify the colon-delimited search path for finding background image files.
1121 1323
1122=back 1324=back
1123 1325
1124=head1 THE SCROLLBAR 1326=head1 THE SCROLLBAR
1125 1327
… …
1144application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1346application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1145(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1347(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1146up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1348up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1147respectively. 1349respectively.
1148 1350
1149=head1 TEXT SELECTION AND INSERTION 1351=head1 THE SELECTION: SELECTING AND PASTING TEXT
1150 1352
1151The behaviour of text selection and insertion mechanism is similar to 1353The behaviour of text selection and insertion/pasting mechanism is similar
1152I<xterm>(1). 1354to I<xterm>(1).
1153 1355
1154=over 4 1356=over 4
1155 1357
1156=item B<Selection>: 1358=item B<Selecting>:
1157 1359
1158Left click at the beginning of the region, drag to the end of the region 1360Left click at the beginning of the region, drag to the end of the region
1159and release; Right click to extend the marked region; Left double-click 1361and release; Right click to extend the marked region; Left double-click
1160to select a word; Left triple-click to select the entire logical line 1362to select a word; Left triple-click to select the entire logical line
1161(which can span multiple screen lines), unless modified by resource 1363(which can span multiple screen lines), unless modified by resource
… …
1165(Compile: I<frills>) will create a rectangular selection instead of a 1367(Compile: I<frills>) will create a rectangular selection instead of a
1166normal one. In this mode, every selected row becomes its own line in the 1368normal one. In this mode, every selected row becomes its own line in the
1167selection, and trailing whitespace is visually underlined and removed from 1369selection, and trailing whitespace is visually underlined and removed from
1168the selection. 1370the selection.
1169 1371
1170=item B<Insertion>: 1372=item B<Pasting>:
1171 1373
1172Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1374Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1173an B<@@RXVT_NAME@@> window causes the current text selection to be 1375window causes the value of the PRIMARY selection (or CLIPBOARD with the
1174inserted as if it had been typed on the keyboard. 1376B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1377
1378Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1379inserted too.
1175 1380
1176=back 1381=back
1177 1382
1178=head1 CHANGING FONTS 1383=head1 CHANGING FONTS
1179 1384
1180Changing fonts (or font sizes, respectively) via the keypad is not yet 1385Changing fonts (or font sizes, respectively) via the keypad is not yet
1181supported in rxvt-unicode. Bug me if you need this. 1386supported in rxvt-unicode. Bug me if you need this.
1182 1387
1183You can, however, switch fonts at runtime using escape sequences (and 1388You can, however, switch fonts at runtime using escape sequences, e.g.:
1184therefore using the menubar), e.g.:
1185 1389
1186 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1390 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1391
1392You can use keyboard shortcuts, too:
1393
1394 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1395 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1187 1396
1188rxvt-unicode will automatically re-apply these fonts to the output so far. 1397rxvt-unicode will automatically re-apply these fonts to the output so far.
1189 1398
1190=head1 ISO 14755 SUPPORT 1399=head1 ISO 14755 SUPPORT
1191 1400
1192ISO 14755 is a standard for entering and viewing unicode characters 1401ISO 14755 is a standard for entering and viewing unicode characters
1193and character codes using the keyboard. It consists of 4 parts. The 1402and character codes using the keyboard. It consists of 4 parts. The
1194first part is available rxvt-unicode has been compiled with 1403first part is available if rxvt-unicode has been compiled with
1195C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1404C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1196with C<--enable-iso14755>. 1405with C<--enable-iso14755>.
1197 1406
1198=over 4 1407=over 4
1199 1408
… …
1219This mode lets you input characters representing the keycap symbols of 1428This mode lets you input characters representing the keycap symbols of
1220your keyboard, if representable in the current locale encoding. 1429your keyboard, if representable in the current locale encoding.
1221 1430
1222Start by pressing C<Control> and C<Shift> together, then releasing 1431Start by pressing C<Control> and C<Shift> together, then releasing
1223them. The next special key (cursor keys, home etc.) you enter will not 1432them. The next special key (cursor keys, home etc.) you enter will not
1224invoke it's usual function but instead will insert the corresponding 1433invoke its usual function but instead will insert the corresponding
1225keycap symbol. The symbol will only be entered when the key has been 1434keycap symbol. The symbol will only be entered when the key has been
1226released, otherwise pressing e.g. C<Shift> would enter the symbol for 1435released, otherwise pressing e.g. C<Shift> would enter the symbol for
1227C<ISO Level 2 Switch>, although your intention might have been to enter a 1436C<ISO Level 2 Switch>, although your intention might have been to enter a
1228reverse tab (Shift-Tab). 1437reverse tab (Shift-Tab).
1229 1438
… …
1257B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1466B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1258it can be seen via the I<who(1)> command, and can accept messages. To 1467it can be seen via the I<who(1)> command, and can accept messages. To
1259allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1468allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1260on some systems or setgid to root or to some other group on others. 1469on some systems or setgid to root or to some other group on others.
1261 1470
1262=head1 COLORS AND GRAPHICS 1471=head1 COLOURS AND GRAPHICS
1263 1472
1264In addition to the default foreground and background colours, 1473In addition to the default foreground and background colours,
1265B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1474B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1266high-intensity bold/blink versions of the same). Here is a list of the 1475high-intensity (potentially bold/blink) versions of the same, and 72 (or
1267colours with their B<rgb.txt> names. 1476240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1477cube plus a 8 (24) colour greyscale ramp.
1478
1479Here is a list of the ANSI colours with their names.
1268 1480
1269=begin table 1481=begin table
1270 1482
1271 B<color0> (black) = Black 1483 B<color0> (black) = Black
1272 B<color1> (red) = Red3 1484 B<color1> (red) = Red3
… …
1292It is also possible to specify the colour values of B<foreground>, 1504It is also possible to specify the colour values of B<foreground>,
1293B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1505B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1294a number 0-15, as a convenient shorthand to reference the colour name of 1506a number 0-15, as a convenient shorthand to reference the colour name of
1295color0-color15. 1507color0-color15.
1296 1508
1509The following text gives values for the standard 88 colour mode (and
1510values for the 256 colour mode in parentheses).
1511
1512The RGB cube uses indices 16..79 (16..231) using the following formulas:
1513
1514 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1515 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1516
1517The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1518steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1519the RGB cube.
1520
1521Together, all those colours implement the 88 (256) colour xterm
1522colours. Only the first 16 can be changed using resources currently, the
1523rest can only be changed via command sequences ("escape codes").
1524
1525Applications are advised to use terminfo or command sequences to discover
1526number and RGB values of all colours (yes, you can query this...).
1527
1297Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1528Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1298always swapping the foreground/background colours. This is in contrast to 1529always swapping the foreground/background colours. This is in contrast to
1299I<xterm>(1) where the colours are only swapped if they have not otherwise 1530I<xterm>(1) where the colours are only swapped if they have not otherwise
1300been specified. For example, 1531been specified. For example,
1301 1532
1533 @@RXVT_NAME@@ -fg Black -bg White -rv
1534
1535would yield White on Black, while on I<xterm>(1) it would yield Black on
1536White.
1537
1538=head2 ALPHA CHANNEL SUPPORT
1539
1540If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1541their act together, rxvt-unicode will do its own alpha channel management:
1542
1543You can prefix any colour with an opaqueness percentage enclosed in
1544brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1545(0-100) that specifies the opacity of the colour, where C<0> is completely
1546transparent and C<100> is completely opaque. For example, C<[50]red> is a
1547half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1548is the recommended format to specify transparency values, and works with
1549all ways to specify a colour.
1550
1551For complete control, rxvt-unicode also supports
1552C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1553specifications, where the additional C<aaaa> component specifies opacity
1554(alpha) values. The minimum value of C<0000> is completely transparent,
1555while C<ffff> is completely opaque). The two example colours from
1556earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1557C<rgba:0000/ff00/0000/f332>.
1558
1559You probably need to specify B<"-depth 32">, too, to force a visual with
1560alpha channels, and have the luck that your X-server uses ARGB pixel
1561layout, as X is far from just supporting ARGB visuals out of the box, and
1562rxvt-unicode just fudges around.
1563
1564For example, the following selects an almost completely transparent black
1565background, and an almost opaque pink foreground:
1566
1567 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1568
1569When not using a background image, then the interpretation of the
1570alpha channel is up to your compositing manager (most interpret it as
1571transparency of course).
1572
1573When using a background pixmap or pseudo-transparency, then the background
1574colour will always behave as if it were completely transparent (so the
1575background image shows instead), regardless of how it was specified, while
1576other colours will either be transparent as specified (the background
1577image will show through) on servers supporting the RENDER extension, or
1578fully opaque on servers not supporting the RENDER EXTENSION.
1579
1580Please note that due to bugs in Xft, specifying alpha values might result
1581in garbage being displayed when the X-server does not support the RENDER
1582extension.
1583
1584=head1 ENVIRONMENT
1585
1586B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1587
1302=over 4 1588=over 4
1303 1589
1304=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1305
1306would yield White on Black, while on I<xterm>(1) it would yield Black
1307on White.
1308
1309=back
1310
1311=head1 ENVIRONMENT
1312
1313B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1314
1315=over 4
1316
1317=item B<TERM> 1590=item B<TERM>
1318 1591
1319Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1592Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1320resources or on the commandline. 1593resources or on the command line.
1321 1594
1322=item B<COLORTERM> 1595=item B<COLORTERM>
1323 1596
1324Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1597Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1325compiled with XPM support, and optionally with the added extension 1598compiled with background image support, and optionally with the added
1326C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1599extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1600screen.
1327 1601
1328=item B<COLORFGBG> 1602=item B<COLORFGBG>
1329 1603
1330Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1604Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1331the colour code used as default foreground/text colour (or the string 1605the colour code used as default foreground/text colour (or the string
1332C<default> to indicate that the default-colour escape sequence is to be 1606C<default> to indicate that the default-colour escape sequence is to be
1333used), C<bg> is the colour code used as default background colour (or the 1607used), C<bg> is the colour code used as default background colour (or the
1334string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1608string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1335was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1609was compiled with background image support. Libraries like C<ncurses>
1336(and do) use this information to optimize screen output. 1610and C<slang> can (and do) use this information to optimize screen output.
1337 1611
1338=item B<WINDOWID> 1612=item B<WINDOWID>
1339 1613
1340Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1614Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1341window, which usually has subwindows for the scrollbar, the terminal 1615window, which usually has subwindows for the scrollbar, the terminal
… …
1347C<--with-terminfo=PATH>. 1621C<--with-terminfo=PATH>.
1348 1622
1349=item B<DISPLAY> 1623=item B<DISPLAY>
1350 1624
1351Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1625Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1352display in it's child processes. 1626display in its child processes if C<-display> isn't used to override. It
1627defaults to C<:0> if it doesn't exist.
1353 1628
1354=item B<SHELL> 1629=item B<SHELL>
1355 1630
1356The shell to be used for command execution, defaults to C</bin/sh>. 1631The shell to be used for command execution, defaults to C</bin/sh>.
1357 1632
1358=item B<RXVTPATH>
1359
1360The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1361files.
1362
1363=item B<PATH>
1364
1365Used in the same way as C<RXVTPATH>.
1366
1367=item B<RXVT_SOCKET> 1633=item B<RXVT_SOCKET> [I<sic>]
1368 1634
1369The unix domain socket path used by @@RXVT_NAME@@c(1) and 1635The unix domain socket path used by @@RXVT_NAME@@c(1) and
1370@@RXVT_NAME@@d(1). 1636@@RXVT_NAME@@d(1).
1371 1637
1372Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1638Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1639
1640=item B<URXVT_PERL_LIB>
1641
1642Additional F<:>-separated library search path for perl extensions. Will be
1643searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1644directory.
1645
1646=item B<URXVT_PERL_VERBOSITY>
1647
1648See L<@@RXVT_NAME@@perl>(3).
1373 1649
1374=item B<HOME> 1650=item B<HOME>
1375 1651
1376Used to locate the default directory for the unix domain socket for 1652Used to locate the default directory for the unix domain socket for
1377daemon communications and to locate various resource files (such as 1653daemon communications and to locate various resource files (such as
1378C<.Xdefaults>) 1654C<.Xdefaults>)
1379 1655
1380=item B<XAPPLRESDIR> 1656=item B<XAPPLRESDIR>
1381 1657
1382Directory where various X resource files are being located. 1658Directory where application-specific X resource files are located.
1383 1659
1384=item B<XENVIRONMENT> 1660=item B<XENVIRONMENT>
1385 1661
1386If set and accessible, gives the name of a X resource file to be loaded by 1662If set and accessible, gives the name of a X resource file to be loaded by
1387@@RXVT_NAME@@. 1663@@RXVT_NAME@@.
… …
1392 1668
1393=over 4 1669=over 4
1394 1670
1395=item B</usr/lib/X11/rgb.txt> 1671=item B</usr/lib/X11/rgb.txt>
1396 1672
1397Color names. 1673Colour names.
1398 1674
1399=back 1675=back
1400 1676
1401=head1 SEE ALSO 1677=head1 SEE ALSO
1402 1678
1679@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1403@@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) 1680@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1404 1681
1405=head1 CURRENT PROJECT COORDINATOR 1682=head1 CURRENT PROJECT COORDINATOR
1406 1683
1407=over 4 1684=over 4
1408 1685
1409=item Project Coordinator 1686=item Project Coordinator
1410 1687
1411Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1688Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1412 1689
1413L<http://software.schmorp.de/#rxvt-unicode> 1690L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1414 1691
1415=back 1692=back
1416 1693
1417=head1 AUTHORS 1694=head1 AUTHORS
1418 1695
… …
1420 1697
1421=item John Bovey 1698=item John Bovey
1422 1699
1423University of Kent, 1992, wrote the original Xvt. 1700University of Kent, 1992, wrote the original Xvt.
1424 1701
1425=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1702=item Rob Nation <nation@rocket.sanders.lockheed.com>
1426 1703
1427very heavily modified Xvt and came up with Rxvt 1704very heavily modified Xvt and came up with Rxvt
1428 1705
1429=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1706=item Angelo Haritsis <ah@doc.ic.ac.uk>
1430 1707
1431wrote the Greek Keyboard Input (no longer in code) 1708wrote the Greek Keyboard Input (no longer in code)
1432 1709
1433=item mj olesen L<< <olesen@me.QueensU.CA> >> 1710=item mj olesen <olesen@me.QueensU.CA>
1434 1711
1435Wrote the menu system. 1712Wrote the menu system.
1436 1713
1437Project Coordinator (changes.txt 2.11 to 2.21) 1714Project Coordinator (changes.txt 2.11 to 2.21)
1438 1715
1439=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1716=item Oezguer Kesim <kesim@math.fu-berlin.de>
1440 1717
1441Project Coordinator (changes.txt 2.21a to 2.4.5) 1718Project Coordinator (changes.txt 2.21a to 2.4.5)
1442 1719
1443=item Geoff Wing L<< <gcw@pobox.com> >> 1720=item Geoff Wing <gcw@pobox.com>
1444 1721
1445Rewrote screen display and text selection routines. Project Coordinator 1722Rewrote screen display and text selection routines.
1723
1446(changes.txt 2.4.6 - rxvt-unicode) 1724Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1447 1725
1448=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1726=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1449 1727
1450Forked rxvt-unicode, rewrote most of the display code and internal 1728Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1451character handling to store text in unicode, improve xterm 1729extension, random hacks, numerous bugfixes and extensions.
1452compatibility and apply numerous other bugfixes and extensions.
1453 1730
1454Project Coordinator (Changes 1.0 -) 1731Project Coordinator (Changes 1.0 -)
1455 1732
1733=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1734
1735pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1736
1456=back 1737=back
1457 1738

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines