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.97 by root, Mon Jan 16 15:07:27 2006 UTC vs.
Revision 1.228 by root, Sun Apr 27 19:43:46 2014 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
… …
177that are checked in order when trying to find glyphs for 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
481You can set and change the resources using X11 tools like B<xrdb>. Many 520You can set and change the resources using X11 tools like B<xrdb>. Many
482distribution do also load settings from the B<~/.Xresources> file when X 521distribution do also load settings from the B<~/.Xresources> file when X
483starts. @@RXVT_NAME@@ will consult the following files/resources in order, 522starts. @@RXVT_NAME@@ will consult the following files/resources in order,
484with later settings overwriting earlier ones: 523with later settings overwriting earlier ones:
485 524
486 1. system-wide app-defaults file, either locale-dependent OR global
487 2. app-defaults file in $XAPPLRESDIR 525 1. app-defaults file in $XAPPLRESDIR
526 2. $HOME/.Xdefaults
488 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 527 3. RESOURCE_MANAGER property on root-window of screen 0
489 4. SCREEN_RESOURCES for the current screen 528 4. SCREEN_RESOURCES property on root-window of the current screen
490 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 529 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
530 6. resources specified via -xrm on the commandline
491 531
492Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 532Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
493names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources 533names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
494common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily 534common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
495configured, while the class name B<URxvt> allows resources unique to 535configured, while the class name B<URxvt> allows resources unique to
… …
500check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 540check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
501extensions not documented here): 541extensions not documented here):
502 542
503=over 4 543=over 4
504 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.
556
505=item B<geometry:> I<geom> 557=item B<geometry:> I<geom>
506 558
507Create the window with the specified X window geometry [default 80x24]; 559Create the window with the specified X window geometry [default 80x24];
508option B<-geometry>. 560option B<-geometry>.
509 561
… …
522Use 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
523corresponds to low-intensity (normal) colours and 8-15 corresponds to 575corresponds to low-intensity (normal) colours and 8-15 corresponds to
524high-intensity (bold = bright foreground, blink = bright background) 576high-intensity (bold = bright foreground, blink = bright background)
525colours. 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,
5263=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
527names used are listed in the B<COLORS AND GRAPHICS> section. 579names used are listed in the B<COLOURS AND GRAPHICS> section.
528 580
529Colours 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
530changed using an escape command (see @@RXVT_NAME@@(7)). 582changed using an escape command (see @@RXVT_NAME@@(7)).
531 583
532Colours 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
… …
543=item B<colorUL:> I<colour> 595=item B<colorUL:> I<colour>
544 596
545Use the specified colour to display underlined characters when the 597Use the specified colour to display underlined characters when the
546foreground colour is the default. 598foreground colour is the default.
547 599
548=item B<colorRV:> I<colour>
549
550Use the specified colour as the background for reverse video
551characters.
552
553=item B<underlineColor:> I<colour> 600=item B<underlineColor:> I<colour>
554 601
555If set, use the specified colour as the colour for the underline 602If set, use the specified colour as the colour for the underline
556itself. 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.
557 614
558=item B<cursorColor:> I<colour> 615=item B<cursorColor:> I<colour>
559 616
560Use 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
561foreground colour; option B<-cr>. 618foreground colour; option B<-cr>.
… …
568 625
569=item B<reverseVideo:> I<boolean> 626=item B<reverseVideo:> I<boolean>
570 627
571B<True>: simulate reverse video by foreground and background colours; 628B<True>: simulate reverse video by foreground and background colours;
572option B<-rv>. B<False>: regular screen colours [default]; option 629option B<-rv>. B<False>: regular screen colours [default]; option
573B<+rv>. See note in B<COLORS AND GRAPHICS> section. 630B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
574 631
575=item B<jumpScroll:> I<boolean> 632=item B<jumpScroll:> I<boolean>
576 633
577B<True>: specify that jump scrolling should be used. When scrolling 634B<True>: specify that jump scrolling should be used. When receiving lots
578quickly, 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
579B<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>.
580 641
581=item B<inheritPixmap:> I<boolean> 642=item B<skipScroll:> I<boolean>
582 643
583B<True>: make the background inherit the parent windows' pixmap, giving 644B<True>: (the default) specify that skip scrolling should be used. When
584artificial transparency. B<False>: do not inherit the parent windows' 645receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
585pixmap. 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>.
586 653
587=item B<fading:> I<number> 654=item B<fading:> I<number>
588 655
589Fade 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>.
590 657
591=item B<fadeColor:> I<colour> 658=item B<fadeColor:> I<colour>
592 659
593Fade 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
594colour is black; option B<-fadecolor>. 661colour is black; option B<-fadecolor>.
595 662
596=item B<tintColor:> I<colour> 663=item B<iconFile:> I<file>
597 664
598Tint the transparent background pixmap with the given colour; option 665Set the application icon pixmap; option B<-icon>.
599B<-tint>.
600
601=item B<shading:> I<number>
602
603Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
604image in addition to tinting it.
605 666
606=item B<scrollColor:> I<colour> 667=item B<scrollColor:> I<colour>
607 668
608Use the specified colour for the scrollbar [default #B2B2B2]. 669Use the specified colour for the scrollbar [default #B2B2B2].
609 670
… …
614 675
615=item B<borderColor:> I<colour> 676=item B<borderColor:> I<colour>
616 677
617The 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
618and the text. 679and the text.
619
620=item B<backgroundPixmap:> I<file[;geom]>
621
622Use the specified XPM file (note the `.xpm' extension is optional) for
623the background and also optionally specify its scaling with a geometry
624string B<WxH+X+Y>, in which B<"W" / "H"> specify the
625horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image
626centre (percent). A scale of 0 displays the image with tiling. A scale
627of 1 displays the image without any scaling. A scale of 2 to 9
628specifies an integer number of images in that direction. No image will
629be magnified beyond 10 times its original size. The maximum permitted
630scale is 1000. [default 0x0+50+50]
631
632=item B<path:> I<path>
633
634Specify the colon-delimited search path for finding XPM files.
635 680
636=item B<font:> I<fontlist> 681=item B<font:> I<fontlist>
637 682
638Select the fonts to be used. This is a comma separated list of font names 683Select the fonts to be used. This is a comma separated list of font names
639that are checked in order when trying to find glyphs for characters. The 684that are checked in order when trying to find glyphs for characters. The
… …
662it 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
663wide and 15 pixels high. 708wide and 15 pixels high.
664 709
665The 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
666the base font, likewise the third, which is unfortunately non-bold, but 711the base font, likewise the third, which is unfortunately non-bold, but
667the 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
668useful supplement. 713useful supplement.
669 714
670The 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
671are 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
672contains other characters, but we are not interested in them. 717contains other characters, but we are not interested in them.
… …
696text font will being used for the given style. 741text font will being used for the given style.
697 742
698=item B<intensityStyles:> I<boolean> 743=item B<intensityStyles:> I<boolean>
699 744
700When 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>,
701option B<-is>, the default), bold and italic font styles imply high 746option B<-is>, the default), bold/blink font styles imply high
702intensity foreground/backround colours. Disabling this option (B<False>, 747intensity foreground/background colours. Disabling this option (B<False>,
703option B<+is>) disables this behaviour, the high intensity colours are not 748option B<+is>) disables this behaviour, the high intensity colours are not
704reachable. 749reachable.
705
706=item B<selectstyle:> I<mode>
707
708Set mouse selection style to B<old> which is 2.20, B<oldword> which is
709xterm style with 2.20 old word selection, or anything else which gives
710xterm style selection.
711
712=item B<scrollstyle:> I<mode>
713
714Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
715the author's favourite.
716 750
717=item B<title:> I<string> 751=item B<title:> I<string>
718 752
719Set window title string, the default title is the command-line 753Set window title string, the default title is the command-line
720specified after the B<-e> option, if any, otherwise the application 754specified after the B<-e> option, if any, otherwise the application
… …
729=item B<mapAlert:> I<boolean> 763=item B<mapAlert:> I<boolean>
730 764
731B<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
732de-iconify (map) on receipt of a bell character [default]. 766de-iconify (map) on receipt of a bell character [default].
733 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
734=item B<visualBell:> I<boolean> 775=item B<visualBell:> I<boolean>
735 776
736B<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>.
737B<False>: no visual bell [default]; option B<+vb>. 778B<False>: no visual bell [default]; option B<+vb>.
738 779
… …
759Example: 800Example:
760 801
761 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 802 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
762 803
763This 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
764everytime 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.
765 815
766=item B<scrollBar:> I<boolean> 816=item B<scrollBar:> I<boolean>
767 817
768B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 818B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
769disable the scrollbar; option B<+sb>. 819disable the scrollbar; option B<+sb>.
… …
789B<False>: do not scroll to bottom when tty receives output; option 839B<False>: do not scroll to bottom when tty receives output; option
790B<+si>. 840B<+si>.
791 841
792=item B<scrollWithBuffer:> I<boolean> 842=item B<scrollWithBuffer:> I<boolean>
793 843
794B<True>: scroll with scrollback buffer when tty receives new lines (and 844B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
795B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 845try to show the same lines) and B<scrollTtyOutput> is False; option
796with 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>.
797 848
798=item B<scrollTtyKeypress:> I<boolean> 849=item B<scrollTtyKeypress:> I<boolean>
799 850
800B<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
801are those which are intercepted by rxvt-unicode for special handling and 852are those which are intercepted by rxvt-unicode for special handling and
… …
832=item B<termName:> I<termname> 883=item B<termName:> I<termname>
833 884
834Specifies 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
835variable; option B<-tn>. 886variable; option B<-tn>.
836 887
837=item B<linespace:> I<number> 888=item B<lineSpace:> I<number>
838 889
839Specifies number of lines (pixel height) to insert between each row of 890Specifies number of lines (pixel height) to insert between each row of
840the display [default 0]; option B<-lsp>. 891the display [default 0]; option B<-lsp>.
841 892
842=item B<meta8:> I<boolean> 893=item B<meta8:> I<boolean>
… …
856 907
857=item B<cursorBlink:> I<boolean> 908=item B<cursorBlink:> I<boolean>
858 909
859B<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];
860option 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>.
861 917
862=item B<pointerBlank:> I<boolean> 918=item B<pointerBlank:> I<boolean>
863 919
864B<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
865of seconds of inactivity. B<False>: the pointer is always visible 921of seconds of inactivity. B<False>: the pointer is always visible
… …
879large number (e.g. C<987654321>) to effectively disable the timeout. 935large number (e.g. C<987654321>) to effectively disable the timeout.
880 936
881=item B<backspacekey:> I<string> 937=item B<backspacekey:> I<string>
882 938
883The 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>
884or 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>
885(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
886escape sequence. 942escape sequence.
887 943
888=item B<deletekey:> I<string> 944=item B<deletekey:> I<string>
889 945
… …
891pressed. If unset it will send the sequence traditionally associated 947pressed. If unset it will send the sequence traditionally associated
892with the B<Execute> key. 948with the B<Execute> key.
893 949
894=item B<cutchars:> I<string> 950=item B<cutchars:> I<string>
895 951
896The characters used as delimiters for double-click word selection. The 952The characters used as delimiters for double-click word selection
897built-in default: 953(whitespace delimiting is added automatically if resource is given).
898 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
899B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 963B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
900 964
901=item B<preeditType:> I<style> 965=item B<preeditType:> I<style>
902 966
903B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 967B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
904 968
… …
952 1016
953Specify 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)
954character is passed through. It may contain escape values as described 1018character is passed through. It may contain escape values as described
955in the entry on B<keysym> following. 1019in the entry on B<keysym> following.
956 1020
957=item B<secondaryScreen:> I<bool> 1021=item B<secondaryScreen:> I<boolean>
958 1022
959Turn on/off secondary screen (default enabled). 1023Turn on/off secondary screen (default enabled).
960 1024
961=item B<secondaryScroll:> I<bool> 1025=item B<secondaryScroll:> I<boolean>
962 1026
963Turn on/off secondary screen scroll (default enabled). If the this 1027Turn on/off secondary screen scroll (default enabled). If this
964option is enabled, scrolls on the secondary screen will change the 1028option is enabled, scrolls on the secondary screen will change the
965scrollback buffer and switching to/from the secondary screen will 1029scrollback buffer and, when secondaryScreen is off, switching
966instead scroll the screen up. 1030to/from the secondary screen will instead scroll the screen up.
967 1031
968=item B<hold>: I<bool> 1032=item B<hold>: I<boolean>
969 1033
970Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1034Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
971will not immediately destroy its window when the program executed within 1035will not immediately destroy its window when the program executed within
972it 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
973user. 1037user.
974 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>.
1045
975=item B<keysym.>I<sym>: I<string> 1046=item B<keysym.>I<sym>: I<action>
976 1047
977Compile I<frills>: Associate I<string> with keysym I<sym>. The 1048Compile I<frills>: Associate I<action> with keysym I<sym>. The intervening
978intervening resource name B<keysym.> cannot be omitted. 1049resource name B<keysym.> cannot be omitted.
979 1050
980The format of I<sym> is "I<(modifiers-)key>", where I<modifiers> can be 1051Using this resource, you can map key combinations such as
981any combination of B<ISOLevel3>, B<AppKeypad>, B<Control>, B<NumLock>, 1052C<Ctrl-Shift-BackSpace> to various actions, such as outputting a different
982B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>, B<Mod3>, B<Mod4>, B<Mod5>, 1053string than would normally result from that combination, making the
983and the abbreviated B<I>, B<K>, B<C>, B<N>, B<S>, B<M>, B<A>, B<L>, B<1>, 1054terminal scroll up or down the way you want it, or any other thing an
984B<2>, B<3>, B<4>, B<5>. 1055extension might provide.
1056
1057The key combination that triggers the action, I<sym>, has the following format:
1058
1059 (modifiers-)key
1060
1061Where I<modifiers> can be any combination of B<ISOLevel3>, B<AppKeypad>,
1062B<Control>, B<NumLock>, B<Shift>, B<Meta>, B<Lock>, B<Mod1>, B<Mod2>,
1063B<Mod3>, B<Mod4>, B<Mod5>, and the abbreviated B<I>, B<K>, B<C>, B<N>,
1064B<S>, B<M>, B<A>, B<L>, B<1>, B<2>, B<3>, B<4>, B<5>.
985 1065
986The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to 1066The B<NumLock>, B<Meta> and B<ISOLevel3> modifiers are usually aliased to
987whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr 1067whatever modifier the NumLock key, Meta/Alt keys or ISO Level3 Shift/AltGr
988keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the 1068keys are being mapped. B<AppKeypad> is a synthetic modifier mapped to the
989current application keymap mode state. 1069current application keymap mode state.
990 1070
991The spellings of I<key> can be obtained by using B<xev>(1) command or 1071Due the the large number of modifier combinations, a key mapping will
992searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1072match if I<at least> the specified identifiers are being set, and no other
1073key mappings with those and more bits are being defined. That means that
1074defining a mapping for C<a> will automatically provide definitions for
1075C<Meta-a>, C<Shift-a> and so on, unless some of those are defined mappings
1076themselves. See the C<builtin:> action, below, for a way to work around
1077this when this is a problem.
1078
1079The spelling of I<key> depends on your implementation of X. An easy way to
1080find a key name is to use the B<xev>(1) command. You can find a list by
1081looking for the C<XK_> macros in the B<X11/keysymdef.h> include file (omit
993omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1082the C<XK_> prefix). Alternatively you can specify I<key> by its hex keysym
994keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1083value (B<0x0000 - 0xFFFF>).
995performed in an exact manner; however, the closest match is assured.
996 1084
997I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1085As with any resource value, the I<action> string may contain backslash
998C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1086escape sequences (C<\n>: newline, C<\\>: backslash, C<\000>: octal
999C<\000>: octal number) or verbatim control characters (C<^?>: delete, 1087number), see RESOURCES in C<man 7 X> for further details.
1000C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1001can start or end with whitespace.
1002 1088
1003Please note that you need to double the C<\> in resource files, as 1089An action starts with an action prefix that selects a certain type
1004Xlib itself does it's own de-escaping (you can use C<\033> instead of 1090of action, followed by a colon. An action strings without colons is
1005C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own 1091interpreted as a literal string to pass to the tty (as if they were
1006processing). 1092prefixed with C<string:>).
1007 1093
1008You can define a range of keysyms in one shot by providing a I<string> 1094The following action prefixes are known - extensions can provide
1009with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1095additional prefixes:
1010should be a character not used by the strings.
1011 1096
1012Its usage can be demonstrated by an example: 1097=over 4
1013 1098
1014 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1099=item string:STRING
1015 1100
1016The above line is equivalent to the following three lines: 1101If the I<action> starts with C<string:> (or otherwise contains no colons),
1102then the remaining C<STRING> will be passed to the program running in the
1103terminal. For example, you could replace whatever Shift-Tab outputs by the
1104string C<echo rm -rf /> followed by a newline:
1017 1105
1018 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1106 URxvt.keysym.Shift-Tab: string:echo rm -rf /\n
1019 URxvt.keysym.Meta-Control-0x62: \033<M-C-b>
1020 URxvt.keysym.Meta-Control-0x63: \033<M-C-c>
1021 1107
1108This could in theory be used to completely redefine your keymap.
1109
1110=item command:STRING
1111
1022If I<string> takes the form of C<command:STRING>, the specified B<STRING> 1112If I<action> takes the form of C<command:STRING>, the specified B<STRING>
1023is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1113is interpreted and executed as @@RXVT_NAME@@'s control sequence (basically
1114the opposite of C<string:> - instead of sending it to the program running
1115in the terminal, it will be treated as if it were program output). This is
1116most useful to feed command sequences into @@RXVT_NAME@@.
1117
1024example the following means "change the current locale to C<zh_CN.GBK> 1118For example the following means "change the current locale to C<zh_CN.GBK>
1025when Control-Meta-c is being pressed": 1119when Control-Meta-c is being pressed":
1026 1120
1027 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007 1121 URxvt.keysym.M-C-c: command:\033]701;zh_CN.GBK\007
1028 1122
1029If I<string> takes the form C<perl:STRING>, then the specified B<STRING> 1123The following example will map Control-Meta-1 and Control-Meta-2 to
1030is passed to the C<on_keyboard_command> perl handler. See the @@RXVT_NAME@@perl(3) 1124the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1031manpage. For example, the F<selection> extension (activated via 1125font-switching at runtime:
1032C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1033 1126
1034 URxvt.keysym.M-C-c: perl:selection:rot13 1127 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007
1128 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007
1035 1129
1036Due the the large number of modifier combinations, a defined key mapping 1130Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more
1037will match if at I<at least> the specified identifiers are being set, and 1131info):
1038no other key mappings with those and more bits are being defined. That
1039means that defining a key map for C<a> will automatically provide
1040definitions for C<Meta-a>, C<Shift-a> and so on, unless some of those are defined
1041mappings themselves.
1042 1132
1043Unfortunately, this will override built-in key mappings. For example 1133 URxvt.keysym.M-C-3: command:\033[8;25;80t
1134 URxvt.keysym.M-C-4: command:\033[8;48;110t
1135
1136=item builtin:
1137
1138The builtin action is the action that @@RXVT_NAME@@ would execute if no
1139key binding existed for the key combination. The obvious use is to undo
1140the effect of existing bindings. The not so obvious use is to reinstate
1141bindings when another binding overrides too many modifiers.
1142
1044if you overwrite the C<Insert> key you will disable @@RXVT_NAME@@'s 1143For example if you overwrite the C<Insert> key you will disable
1045C<Shift-Insert> mapping. To re-enable that, you can poke "holes" into the 1144@@RXVT_NAME@@'s C<Shift-Insert> mapping. To re-enable that, you can poke
1046user-defined keymap using the C<builtin:> replacement: 1145"holes" into the user-defined keymap using the C<builtin:> replacement:
1047 1146
1048 URxvt.keysym.Insert: <my insert key sequence> 1147 URxvt.keysym.Insert: <my insert key sequence>
1049 URxvt.keysym.S-Insert: builtin: 1148 URxvt.keysym.S-Insert: builtin:
1050 1149
1051The first line defines a mapping for C<Insert> and I<any> combination 1150The first line defines a mapping for C<Insert> and I<any> combination
1052of modifiers. The second line re-establishes the default mapping for 1151of modifiers. The second line re-establishes the default mapping for
1053C<Shift-Insert>. 1152C<Shift-Insert>.
1054 1153
1055The following example will map Control-Meta-1 and Control-Meta-2 to 1154=item EXTENSION:STRING
1056the fonts C<suxuseuro> and C<9x15bold>, so you can have some limited
1057font-switching at runtime:
1058 1155
1059 URxvt.keysym.M-C-1: command:\033]50;suxuseuro\007 1156An action of this form passes the B<STRING> to the @@RXVT_NAME@@perl(3)
1060 URxvt.keysym.M-C-2: command:\033]50;9x15bold\007 1157extension of the same name. The extension will be loaded automatically if
1158neccessary.
1061 1159
1062Other things are possible, e.g. resizing (see @@RXVT_NAME@@(7) for more 1160Not all extensions define key actions, but popular extensions that do
1063info): 1161include the I<selection> and I<matcher> extensions (documented in their
1162own manpages, @@RXVT_NAME@@-selection(1) and @@RXVT_NAME@@-matcher(1),
1163respectively).
1064 1164
1065 URxvt.keysym.M-C-3: command:\033[8;25;80t 1165From the silly examples department, this will rot13-"encrypt"
1066 URxvt.keysym.M-C-4: command:\033[8;48;110t 1166@@RXVT_NAME@@'s selection when Alt-Control-c is pressed on typical PC
1167keyboards:
1168
1169 URxvt.keysym.M-C-c: selection:rot13
1170
1171=item perl:STRING
1172
1173This is a deprecated way of passing key mappings to perl extensions. It is
1174still supported, but should not be used anymore.
1175
1176=back
1177
1178In addition, you can define a range of keysyms in one shot by loading
1179the C<keysym-list> perl extension and providing a I<string> with pattern
1180B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/' should be a
1181character not used by the strings.
1182
1183Its usage can be demonstrated by an example:
1184
1185 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1186
1187The above line is equivalent to the following three lines:
1188
1189 URxvt.keysym.Meta-Control-0x61: \033<a>
1190 URxvt.keysym.Meta-Control-0x62: \033<b>
1191 URxvt.keysym.Meta-Control-0x63: \033<c>
1067 1192
1068=item B<perl-ext-common>: I<string> 1193=item B<perl-ext-common>: I<string>
1069 1194
1070=item B<perl-ext>: I<string> 1195=item B<perl-ext>: I<string>
1071 1196
… …
1078example, C<default,-selection> will use all the default extension except 1203example, C<default,-selection> will use all the default extension except
1079C<selection>. 1204C<selection>.
1080 1205
1081Extension names can also be followed by an argument in angle brackets 1206Extension names can also be followed by an argument in angle brackets
1082(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1207(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1083searchable scorllback to Alt/Meta-s). Mentioning the same extension 1208searchable scrollback to Alt/Meta-s). Mentioning the same extension
1084multiple times with different arguments will pass multiple arguments to 1209multiple times with different arguments will pass multiple arguments to
1085the extension. 1210the extension.
1086 1211
1087Each extension is looked up in the library directories, loaded if 1212Each extension is looked up in the library directories, loaded if
1088necessary, and bound to the current terminal instance. 1213necessary, and bound to the current terminal instance.
… …
1093all instances, while B<perl-ext> is used for specific instances. 1218all instances, while B<perl-ext> is used for specific instances.
1094 1219
1095=item B<perl-eval>: I<string> 1220=item B<perl-eval>: I<string>
1096 1221
1097Perl code to be evaluated when all extensions have been registered. See 1222Perl code to be evaluated when all extensions have been registered. See
1098the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1223the @@RXVT_NAME@@perl(3) manpage.
1099will be ignored when running setuid/setgid.
1100 1224
1101=item B<perl-lib>: I<path> 1225=item B<perl-lib>: I<path>
1102 1226
1103Colon-separated list of additional directories that hold extension 1227Colon-separated list of additional directories that hold extension
1104scripts. When looking for extensions specified by the C<perl> resource, 1228scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1105@@RXVT_NAME@@ will first look in these directories and then in 1229in these directories, then in C<$URXVT_PERL_LIB>, F<$HOME/.urxvt/ext> and
1106F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1230lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1107will be ignored when running setuid/setgid.
1108 1231
1109See the @@RXVT_NAME@@perl(3) manpage. 1232See the @@RXVT_NAME@@perl(3) manpage.
1110 1233
1111=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1234=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1112 1235
… …
1121=item B<searchable-scrollback:> I<keysym> 1244=item B<searchable-scrollback:> I<keysym>
1122 1245
1123Sets the hotkey that starts the incremental scrollback buffer search 1246Sets the hotkey that starts the incremental scrollback buffer search
1124(default: C<M-s>). 1247(default: C<M-s>).
1125 1248
1126=item B<urlLauncher>: I<string> 1249=item B<url-launcher>: I<string>
1127 1250
1128Specifies the program to be started with a URL argument. Used by the 1251Specifies the program to be started with a URL argument. Used by the
1129C<selection-popup> and C<mark-urls> perl extensions. 1252C<selection-popup> and C<matcher> perl extensions.
1130 1253
1131=item B<transient-for>: I<windowid> 1254=item B<transient-for>: I<windowid>
1132 1255
1133Sets the WM_TRANSIENT_FOR property to the given window iw. 1256Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1257
1258=item B<override-redirect>: I<boolean>
1259
1260Compile I<frills>: Sets override-redirect for the terminal window, making
1261it almost invisible to window managers; option B<-override-redirect>.
1262
1263=item B<iso14755:> I<boolean>
1264
1265Turn on/off ISO 14755 (default enabled).
1266
1267=item B<iso14755_52:> I<boolean>
1268
1269Turn on/off ISO 14755 5.2 mode (default enabled).
1270
1271=back
1272
1273=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1274
1275=over 4
1276
1277=item B<-pixmap> I<file[;oplist]>
1278
1279=item B<backgroundPixmap:> I<file[;oplist]>
1280
1281Compile I<pixbuf>: Use the specified image file as the window's
1282background and also optionally specify a colon separated list of
1283operations to modify it. Note that you may need to quote the C<;>
1284character when using the command line option, as C<;> is usually a
1285metacharacter in shells. Supported operations are:
1286
1287=over 4
1288
1289=item B<WxH+X+Y>
1290
1291sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1292scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1293scale of 0 disables scaling.
1294
1295=item B<op=tile>
1296
1297enables tiling
1298
1299=item B<op=keep-aspect>
1300
1301maintain the image aspect ratio when scaling
1302
1303=item B<op=root-align>
1304
1305use the position of the terminal window relative to the root window as
1306the image offset, simulating a root window background
1307
1308=back
1309
1310The default scale and position setting is C<100x100+50+50>.
1311Alternatively, a predefined set of templates can be used to achieve
1312the most common setups:
1313
1314=over 4
1315
1316=item B<style=tiled>
1317
1318the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1319
1320=item B<style=aspect-stretched>
1321
1322the image is scaled to fill the whole window maintaining the aspect
1323ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1324
1325=item B<style=stretched>
1326
1327the image is scaled to fill the whole window. Equivalent to 100x100
1328
1329=item B<style=centered>
1330
1331the image is centered with no scaling. Equivalent to 0x0+50+50
1332
1333=item B<style=root-tiled>
1334
1335the image is tiled with no scaling and using 'root' positioning.
1336Equivalent to 0x0:op=tile:op=root-align
1337
1338=back
1339
1340If multiple templates are specified the last one wins. Note that a
1341template overrides all the scale, position and operations settings.
1342
1343If used in conjunction with pseudo-transparency, the specified pixmap
1344will be blended over the transparent background using alpha-blending.
1345
1346=item B<-tr>|B<+tr>
1347
1348=item B<transparent:> I<boolean>
1349
1350Turn on/off pseudo-transparency by using the root pixmap as background.
1351
1352B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1353will be removed in future versions.
1354
1355=item B<-tint> I<colour>
1356
1357=item B<tintColor:> I<colour>
1358
1359Tint the transparent background with the given colour. Note that a
1360black tint yields a completely black image while a white tint yields
1361the image unchanged.
1362
1363=item B<-sh> I<number>
1364
1365=item B<shading:> I<number>
1366
1367Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1368A value of 100 means no shading.
1369
1370=item B<-blr> I<HxV>
1371
1372=item B<blurRadius:> I<HxV>
1373
1374Apply gaussian blur with the specified radius to the transparent
1375background. If a single number is specified, the vertical and
1376horizontal radii are considered to be the same. Setting one of the
1377radii to 1 and the other to a large number creates interesting effects
1378on some backgrounds. The maximum radius value is 128. An horizontal or
1379vertical radius of 0 disables blurring.
1380
1381=item B<path:> I<path>
1382
1383Specify the colon-delimited search path for finding background image files.
1134 1384
1135=back 1385=back
1136 1386
1137=head1 THE SCROLLBAR 1387=head1 THE SCROLLBAR
1138 1388
… …
1157application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1407application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1158(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1408(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1159up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1409up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1160respectively. 1410respectively.
1161 1411
1162=head1 TEXT SELECTION AND INSERTION 1412=head1 THE SELECTION: SELECTING AND PASTING TEXT
1163 1413
1164The behaviour of text selection and insertion mechanism is similar to 1414The behaviour of text selection and insertion/pasting mechanism is similar
1165I<xterm>(1). 1415to I<xterm>(1).
1166 1416
1167=over 4 1417=over 4
1168 1418
1169=item B<Selection>: 1419=item B<Selecting>:
1170 1420
1171Left click at the beginning of the region, drag to the end of the region 1421Left click at the beginning of the region, drag to the end of the region
1172and release; Right click to extend the marked region; Left double-click 1422and release; Right click to extend the marked region; Left double-click
1173to select a word; Left triple-click to select the entire logical line 1423to select a word; Left triple-click to select the entire logical line
1174(which can span multiple screen lines), unless modified by resource 1424(which can span multiple screen lines), unless modified by resource
… …
1178(Compile: I<frills>) will create a rectangular selection instead of a 1428(Compile: I<frills>) will create a rectangular selection instead of a
1179normal one. In this mode, every selected row becomes its own line in the 1429normal one. In this mode, every selected row becomes its own line in the
1180selection, and trailing whitespace is visually underlined and removed from 1430selection, and trailing whitespace is visually underlined and removed from
1181the selection. 1431the selection.
1182 1432
1183=item B<Insertion>: 1433=item B<Pasting>:
1184 1434
1185Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1435Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1186an B<@@RXVT_NAME@@> window causes the current text selection to be 1436window causes the value of the PRIMARY selection (or CLIPBOARD with the
1187inserted as if it had been typed on the keyboard. 1437B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1438
1439Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1440inserted too.
1441
1442rxvt-unicode also provides the bindings B<Ctrl-Meta-c> and
1443<Ctrl-Meta-v> to interact with the CLIPBOARD selection. The first
1444binding causes the value of the internal selection to be copied to the
1445CLIPBOARD selection, while the second binding causes the value of the
1446CLIPBOARD selection to be inserted.
1188 1447
1189=back 1448=back
1190 1449
1191=head1 CHANGING FONTS 1450=head1 CHANGING FONTS
1192 1451
… …
1206 1465
1207=head1 ISO 14755 SUPPORT 1466=head1 ISO 14755 SUPPORT
1208 1467
1209ISO 14755 is a standard for entering and viewing unicode characters 1468ISO 14755 is a standard for entering and viewing unicode characters
1210and character codes using the keyboard. It consists of 4 parts. The 1469and character codes using the keyboard. It consists of 4 parts. The
1211first part is available rxvt-unicode has been compiled with 1470first part is available if rxvt-unicode has been compiled with
1212C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1471C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1213with C<--enable-iso14755>. 1472with C<--enable-iso14755>.
1214 1473
1215=over 4 1474=over 4
1216 1475
… …
1236This mode lets you input characters representing the keycap symbols of 1495This mode lets you input characters representing the keycap symbols of
1237your keyboard, if representable in the current locale encoding. 1496your keyboard, if representable in the current locale encoding.
1238 1497
1239Start by pressing C<Control> and C<Shift> together, then releasing 1498Start by pressing C<Control> and C<Shift> together, then releasing
1240them. The next special key (cursor keys, home etc.) you enter will not 1499them. The next special key (cursor keys, home etc.) you enter will not
1241invoke it's usual function but instead will insert the corresponding 1500invoke its usual function but instead will insert the corresponding
1242keycap symbol. The symbol will only be entered when the key has been 1501keycap symbol. The symbol will only be entered when the key has been
1243released, otherwise pressing e.g. C<Shift> would enter the symbol for 1502released, otherwise pressing e.g. C<Shift> would enter the symbol for
1244C<ISO Level 2 Switch>, although your intention might have been to enter a 1503C<ISO Level 2 Switch>, although your intention might have been to enter a
1245reverse tab (Shift-Tab). 1504reverse tab (Shift-Tab).
1246 1505
… …
1274B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1533B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1275it can be seen via the I<who(1)> command, and can accept messages. To 1534it can be seen via the I<who(1)> command, and can accept messages. To
1276allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1535allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1277on some systems or setgid to root or to some other group on others. 1536on some systems or setgid to root or to some other group on others.
1278 1537
1279=head1 COLORS AND GRAPHICS 1538=head1 COLOURS AND GRAPHICS
1280 1539
1281In addition to the default foreground and background colours, 1540In addition to the default foreground and background colours,
1282B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1541B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1283high-intensity bold/blink versions of the same). Here is a list of the 1542high-intensity (potentially bold/blink) versions of the same, and 72 (or
1284colours with their B<rgb.txt> names. 1543240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1544cube plus a 8 (24) colour greyscale ramp.
1545
1546Here is a list of the ANSI colours with their names.
1285 1547
1286=begin table 1548=begin table
1287 1549
1288 B<color0> (black) = Black 1550 B<color0> (black) = Black
1289 B<color1> (red) = Red3 1551 B<color1> (red) = Red3
… …
1309It is also possible to specify the colour values of B<foreground>, 1571It is also possible to specify the colour values of B<foreground>,
1310B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1572B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1311a number 0-15, as a convenient shorthand to reference the colour name of 1573a number 0-15, as a convenient shorthand to reference the colour name of
1312color0-color15. 1574color0-color15.
1313 1575
1576The following text gives values for the standard 88 colour mode (and
1577values for the 256 colour mode in parentheses).
1578
1579The RGB cube uses indices 16..79 (16..231) using the following formulas:
1580
1581 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1582 index_256 = (r * 6 + g) * 6 + b + 16 # r, g, b = 0..5
1583
1584The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1585steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1586the RGB cube.
1587
1588Together, all those colours implement the 88 (256) colour xterm
1589colours. Only the first 16 can be changed using resources currently, the
1590rest can only be changed via command sequences ("escape codes").
1591
1592Applications are advised to use terminfo or command sequences to discover
1593number and RGB values of all colours (yes, you can query this...).
1594
1314Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1595Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1315always swapping the foreground/background colours. This is in contrast to 1596always swapping the foreground/background colours. This is in contrast to
1316I<xterm>(1) where the colours are only swapped if they have not otherwise 1597I<xterm>(1) where the colours are only swapped if they have not otherwise
1317been specified. For example, 1598been specified. For example,
1318 1599
1600 @@RXVT_NAME@@ -fg Black -bg White -rv
1601
1602would yield White on Black, while on I<xterm>(1) it would yield Black on
1603White.
1604
1605=head2 ALPHA CHANNEL SUPPORT
1606
1607If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1608their act together, rxvt-unicode will do its own alpha channel management:
1609
1610You can prefix any colour with an opaqueness percentage enclosed in
1611brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1612(0-100) that specifies the opacity of the colour, where C<0> is completely
1613transparent and C<100> is completely opaque. For example, C<[50]red> is a
1614half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1615is the recommended format to specify transparency values, and works with
1616all ways to specify a colour.
1617
1618For complete control, rxvt-unicode also supports
1619C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1620specifications, where the additional C<aaaa> component specifies opacity
1621(alpha) values. The minimum value of C<0000> is completely transparent,
1622while C<ffff> is completely opaque). The two example colours from
1623earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1624C<rgba:0000/ff00/0000/f332>.
1625
1626You probably need to specify B<"-depth 32">, too, to force a visual with
1627alpha channels, and have the luck that your X-server uses ARGB pixel
1628layout, as X is far from just supporting ARGB visuals out of the box, and
1629rxvt-unicode just fudges around.
1630
1631For example, the following selects an almost completely transparent black
1632background, and an almost opaque pink foreground:
1633
1634 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1635
1636When not using a background image, then the interpretation of the
1637alpha channel is up to your compositing manager (most interpret it as
1638transparency of course).
1639
1640When using a background pixmap or pseudo-transparency, then the background
1641colour will always behave as if it were completely transparent (so the
1642background image shows instead), regardless of how it was specified, while
1643other colours will either be transparent as specified (the background
1644image will show through) on servers supporting the RENDER extension, or
1645fully opaque on servers not supporting the RENDER EXTENSION.
1646
1647Please note that due to bugs in Xft, specifying alpha values might result
1648in garbage being displayed when the X-server does not support the RENDER
1649extension.
1650
1651=head1 ENVIRONMENT
1652
1653B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1654
1319=over 4 1655=over 4
1320 1656
1321=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1322
1323would yield White on Black, while on I<xterm>(1) it would yield Black
1324on White.
1325
1326=back
1327
1328=head1 ENVIRONMENT
1329
1330B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1331
1332=over 4
1333
1334=item B<TERM> 1657=item B<TERM>
1335 1658
1336Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1659Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1337resources or on the commandline. 1660resources or on the command line.
1338 1661
1339=item B<COLORTERM> 1662=item B<COLORTERM>
1340 1663
1341Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1664Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1342compiled with XPM support, and optionally with the added extension 1665compiled with background image support, and optionally with the added
1343C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1666extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1667screen.
1344 1668
1345=item B<COLORFGBG> 1669=item B<COLORFGBG>
1346 1670
1347Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1671Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1348the colour code used as default foreground/text colour (or the string 1672the colour code used as default foreground/text colour (or the string
1349C<default> to indicate that the default-colour escape sequence is to be 1673C<default> to indicate that the default-colour escape sequence is to be
1350used), C<bg> is the colour code used as default background colour (or the 1674used), C<bg> is the colour code used as default background colour (or the
1351string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1675string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1352was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1676was compiled with background image support. Libraries like C<ncurses>
1353(and do) use this information to optimize screen output. 1677and C<slang> can (and do) use this information to optimize screen output.
1354 1678
1355=item B<WINDOWID> 1679=item B<WINDOWID>
1356 1680
1357Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1681Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1358window, which usually has subwindows for the scrollbar, the terminal 1682window, which usually has subwindows for the scrollbar, the terminal
… …
1364C<--with-terminfo=PATH>. 1688C<--with-terminfo=PATH>.
1365 1689
1366=item B<DISPLAY> 1690=item B<DISPLAY>
1367 1691
1368Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1692Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1369display in it's child processes. 1693display in its child processes if C<-display> isn't used to override. It
1694defaults to C<:0> if it doesn't exist.
1370 1695
1371=item B<SHELL> 1696=item B<SHELL>
1372 1697
1373The shell to be used for command execution, defaults to C</bin/sh>. 1698The shell to be used for command execution, defaults to C</bin/sh>.
1374 1699
1375=item B<RXVTPATH>
1376
1377The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1378files.
1379
1380=item B<PATH>
1381
1382Used in the same way as C<RXVTPATH>.
1383
1384=item B<RXVT_SOCKET> 1700=item B<RXVT_SOCKET> [I<sic>]
1385 1701
1386The unix domain socket path used by @@RXVT_NAME@@c(1) and 1702The unix domain socket path used by @@RXVT_NAME@@c(1) and
1387@@RXVT_NAME@@d(1). 1703@@RXVT_NAME@@d(1).
1388 1704
1389Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1705Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1706
1707=item B<URXVT_PERL_LIB>
1708
1709Additional F<:>-separated library search path for perl extensions. Will be
1710searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1711directory.
1712
1713=item B<URXVT_PERL_VERBOSITY>
1714
1715See L<@@RXVT_NAME@@perl>(3).
1390 1716
1391=item B<HOME> 1717=item B<HOME>
1392 1718
1393Used to locate the default directory for the unix domain socket for 1719Used to locate the default directory for the unix domain socket for
1394daemon communications and to locate various resource files (such as 1720daemon communications and to locate various resource files (such as
1395C<.Xdefaults>) 1721C<.Xdefaults>)
1396 1722
1397=item B<XAPPLRESDIR> 1723=item B<XAPPLRESDIR>
1398 1724
1399Directory where various X resource files are being located. 1725Directory where application-specific X resource files are located.
1400 1726
1401=item B<XENVIRONMENT> 1727=item B<XENVIRONMENT>
1402 1728
1403If set and accessible, gives the name of a X resource file to be loaded by 1729If set and accessible, gives the name of a X resource file to be loaded by
1404@@RXVT_NAME@@. 1730@@RXVT_NAME@@.
… …
1409 1735
1410=over 4 1736=over 4
1411 1737
1412=item B</usr/lib/X11/rgb.txt> 1738=item B</usr/lib/X11/rgb.txt>
1413 1739
1414Color names. 1740Colour names.
1415 1741
1416=back 1742=back
1417 1743
1418=head1 SEE ALSO 1744=head1 SEE ALSO
1419 1745
1746@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1420@@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) 1747@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1421 1748
1422=head1 CURRENT PROJECT COORDINATOR 1749=head1 CURRENT PROJECT COORDINATOR
1423 1750
1424=over 4 1751=over 4
1425 1752
1426=item Project Coordinator 1753=item Project Coordinator
1427 1754
1428Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1755Marc A. Lehmann <rxvt-unicode@schmorp.de>.
1429 1756
1430L<http://software.schmorp.de/#rxvt-unicode> 1757L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1431 1758
1432=back 1759=back
1433 1760
1434=head1 AUTHORS 1761=head1 AUTHORS
1435 1762
… …
1437 1764
1438=item John Bovey 1765=item John Bovey
1439 1766
1440University of Kent, 1992, wrote the original Xvt. 1767University of Kent, 1992, wrote the original Xvt.
1441 1768
1442=item Rob Nation L<< <nation@rocket.sanders.lockheed.com> >> 1769=item Rob Nation <nation@rocket.sanders.lockheed.com>
1443 1770
1444very heavily modified Xvt and came up with Rxvt 1771very heavily modified Xvt and came up with Rxvt
1445 1772
1446=item Angelo Haritsis L<< <ah@doc.ic.ac.uk> >> 1773=item Angelo Haritsis <ah@doc.ic.ac.uk>
1447 1774
1448wrote the Greek Keyboard Input (no longer in code) 1775wrote the Greek Keyboard Input (no longer in code)
1449 1776
1450=item mj olesen L<< <olesen@me.QueensU.CA> >> 1777=item mj olesen <olesen@me.QueensU.CA>
1451 1778
1452Wrote the menu system. 1779Wrote the menu system.
1453 1780
1454Project Coordinator (changes.txt 2.11 to 2.21) 1781Project Coordinator (changes.txt 2.11 to 2.21)
1455 1782
1456=item Oezguer Kesim L<< <kesim@math.fu-berlin.de> >> 1783=item Oezguer Kesim <kesim@math.fu-berlin.de>
1457 1784
1458Project Coordinator (changes.txt 2.21a to 2.4.5) 1785Project Coordinator (changes.txt 2.21a to 2.4.5)
1459 1786
1460=item Geoff Wing L<< <gcw@pobox.com> >> 1787=item Geoff Wing <gcw@pobox.com>
1461 1788
1462Rewrote screen display and text selection routines. Project Coordinator 1789Rewrote screen display and text selection routines.
1790
1463(changes.txt 2.4.6 - rxvt-unicode) 1791Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1464 1792
1465=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1793=item Marc Alexander Lehmann <rxvt-unicode@schmorp.de>
1466 1794
1467Forked rxvt-unicode, rewrote most of the display code and internal 1795Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1468character handling to store text in unicode, improve xterm 1796extension, random hacks, numerous bugfixes and extensions.
1469compatibility and apply numerous other bugfixes and extensions.
1470 1797
1471Project Coordinator (Changes 1.0 -) 1798Project Coordinator (Changes 1.0 -)
1472 1799
1800=item Emanuele Giaquinta <emanuele.giaquinta@gmail.com>
1801
1802pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1803
1473=back 1804=back
1474 1805

Diff Legend

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