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.100 by root, Thu Jan 19 18:02:28 2006 UTC vs.
Revision 1.221 by sf-exg, Mon Nov 5 12:59:13 2012 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.
301 306
302=item B<-override-redirect> 307=item B<-override-redirect>
303 308
304Compile I<frills>: Sets override-redirect on the window; resource 309Compile I<frills>: Sets override-redirect on the window; resource
305B<override-redirect>. 310B<override-redirect>.
… …
313 318
314=item B<-lsp> I<number> 319=item B<-lsp> I<number>
315 320
316Compile I<frills>: Lines (pixel height) to insert between each row of 321Compile I<frills>: Lines (pixel height) to insert between each row of
317the display. Useful to work around font rendering problems; resource 322the display. Useful to work around font rendering problems; resource
318B<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>.
319 331
320=item B<-tn> I<termname> 332=item B<-tn> I<termname>
321 333
322This 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
323B<TERM> environment variable. This terminal type must exist in the 335B<TERM> environment variable. This terminal type must exist in the
… …
377for more info. 389for more info.
378 390
379=item B<-tcw> 391=item B<-tcw>
380 392
381Change 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
382button. 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
383end of the logical line only. resource B<tripleclickwords>. 396the end of the logical line only. resource B<tripleclickwords>.
384 397
385=item B<-insecure> 398=item B<-insecure>
386 399
387Enable "insecure" mode, which currently enables most of the escape 400Enable "insecure" mode, which currently enables most of the escape
388sequences that echo strings. See the resource B<insecure> for more 401sequences that echo strings. See the resource B<insecure> for more
… …
409Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 422Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
410will not immediately destroy its window when the program executed within 423will not immediately destroy its window when the program executed within
411it 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
412user; resource B<hold>. 425user; resource B<hold>.
413 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
414=item B<-keysym.>I<sym> I<string> 446=item B<-keysym.>I<sym> I<string>
415 447
416Remap a key symbol. See resource B<keysym>. 448Remap a key symbol. See resource B<keysym>.
417 449
418=item B<-embed> I<windowid> 450=item B<-embed> I<windowid>
419 451
420Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 452Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
421which enables applications to easily embed a terminal. 453which enables applications to easily embed a terminal.
422 454
423Right 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
424shouldn'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
425quite 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
… …
428The window will not be destroyed when @@RXVT_NAME@@ exits. 460The window will not be destroyed when @@RXVT_NAME@@ exits.
429 461
430It 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
431descriptors 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
432can use file descriptors to communicate with the programs within the 464can use file descriptors to communicate with the programs within the
433terminal. 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
434not. 466not.
435 467
436Here 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
437used (a longer example is in F<doc/embed>): 469used (a longer example is in F<doc/embed>):
438 470
… …
443 }); 475 });
444 476
445=item B<-pty-fd> I<file descriptor> 477=item B<-pty-fd> I<file descriptor>
446 478
447Tells @@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
448pair 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
449useful 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
450without having to run a program within it. 482without having to run a program within it.
451 483
452If 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
453entries 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
454yourself if you want that. 486yourself if you want that.
455 487
456As an extremely special case, specifying C<-1> will completely suppress 488As an extremely special case, specifying C<-1> will completely suppress
457pty/tty operations. 489pty/tty operations, which is probably only useful in conjunction with some
490perl extension that manages the terminal.
458 491
459Here 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
460longer example is in F<doc/pty-fd>): 493longer example is in F<doc/pty-fd>):
461 494
462 use IO::Pty; 495 use IO::Pty;
… …
476Comma-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
477this terminal instance. See resource B<perl-ext> for details. 510this terminal instance. See resource B<perl-ext> for details.
478 511
479=back 512=back
480 513
481=head1 RESOURCES (available also as long-options) 514=head1 RESOURCES
482 515
483Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 516Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
484options) compiled into your version. 517options) compiled into your version. All resources are also available as
518long-options.
485 519
486You 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
487distribution do also load settings from the B<~/.Xresources> file when X 521distribution do also load settings from the B<~/.Xresources> file when X
488starts. @@RXVT_NAME@@ will consult the following files/resources in order, 522starts. @@RXVT_NAME@@ will consult the following files/resources in order,
489with later settings overwriting earlier ones: 523with later settings overwriting earlier ones:
490 524
491 1. system-wide app-defaults file, either locale-dependent OR global
492 2. app-defaults file in $XAPPLRESDIR 525 1. app-defaults file in $XAPPLRESDIR
526 2. $HOME/.Xdefaults
493 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 527 3. RESOURCE_MANAGER property on root-window of screen 0
494 4. SCREEN_RESOURCES for the current screen 528 4. SCREEN_RESOURCES property on root-window of the current screen
495 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 529 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
530 6. resources specified via -xrm on the commandline
496 531
497Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class 532Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
498names: 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
499common 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
500configured, while the class name B<URxvt> allows resources unique to 535configured, while the class name B<URxvt> allows resources unique to
… …
505check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl 540check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
506extensions not documented here): 541extensions not documented here):
507 542
508=over 4 543=over 4
509 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
510=item B<geometry:> I<geom> 557=item B<geometry:> I<geom>
511 558
512Create the window with the specified X window geometry [default 80x24]; 559Create the window with the specified X window geometry [default 80x24];
513option B<-geometry>. 560option B<-geometry>.
514 561
… …
527Use 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
528corresponds to low-intensity (normal) colours and 8-15 corresponds to 575corresponds to low-intensity (normal) colours and 8-15 corresponds to
529high-intensity (bold = bright foreground, blink = bright background) 576high-intensity (bold = bright foreground, blink = bright background)
530colours. 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,
5313=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
532names used are listed in the B<COLORS AND GRAPHICS> section. 579names used are listed in the B<COLOURS AND GRAPHICS> section.
533 580
534Colours 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
535changed using an escape command (see @@RXVT_NAME@@(7)). 582changed using an escape command (see @@RXVT_NAME@@(7)).
536 583
537Colours 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
… …
548=item B<colorUL:> I<colour> 595=item B<colorUL:> I<colour>
549 596
550Use the specified colour to display underlined characters when the 597Use the specified colour to display underlined characters when the
551foreground colour is the default. 598foreground colour is the default.
552 599
553=item B<colorRV:> I<colour>
554
555Use the specified colour as the background for reverse video
556characters.
557
558=item B<underlineColor:> I<colour> 600=item B<underlineColor:> I<colour>
559 601
560If set, use the specified colour as the colour for the underline 602If set, use the specified colour as the colour for the underline
561itself. 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.
562 614
563=item B<cursorColor:> I<colour> 615=item B<cursorColor:> I<colour>
564 616
565Use 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
566foreground colour; option B<-cr>. 618foreground colour; option B<-cr>.
… …
573 625
574=item B<reverseVideo:> I<boolean> 626=item B<reverseVideo:> I<boolean>
575 627
576B<True>: simulate reverse video by foreground and background colours; 628B<True>: simulate reverse video by foreground and background colours;
577option B<-rv>. B<False>: regular screen colours [default]; option 629option B<-rv>. B<False>: regular screen colours [default]; option
578B<+rv>. See note in B<COLORS AND GRAPHICS> section. 630B<+rv>. See note in B<COLOURS AND GRAPHICS> section.
579 631
580=item B<jumpScroll:> I<boolean> 632=item B<jumpScroll:> I<boolean>
581 633
582B<True>: specify that jump scrolling should be used. When scrolling 634B<True>: specify that jump scrolling should be used. When receiving lots
583quickly, 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
584B<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>.
585 641
586=item B<inheritPixmap:> I<boolean> 642=item B<skipScroll:> I<boolean>
587 643
588B<True>: make the background inherit the parent windows' pixmap, giving 644B<True>: (the default) specify that skip scrolling should be used. When
589artificial transparency. B<False>: do not inherit the parent windows' 645receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
590pixmap. 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>.
591 653
592=item B<fading:> I<number> 654=item B<fading:> I<number>
593 655
594Fade 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>.
595 657
596=item B<fadeColor:> I<colour> 658=item B<fadeColor:> I<colour>
597 659
598Fade 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
599colour is black; option B<-fadecolor>. 661colour is black; option B<-fadecolor>.
600 662
601=item B<tintColor:> I<colour> 663=item B<iconFile:> I<file>
602 664
603Tint the transparent background pixmap with the given colour; option 665Set the application icon pixmap; option B<-icon>.
604B<-tint>.
605
606=item B<shading:> I<number>
607
608Darken (0 .. 100) or lighten (-1 .. -100) the transparent background
609image in addition to tinting it.
610 666
611=item B<scrollColor:> I<colour> 667=item B<scrollColor:> I<colour>
612 668
613Use the specified colour for the scrollbar [default #B2B2B2]. 669Use the specified colour for the scrollbar [default #B2B2B2].
614 670
… …
619 675
620=item B<borderColor:> I<colour> 676=item B<borderColor:> I<colour>
621 677
622The 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
623and the text. 679and the text.
624
625=item B<backgroundPixmap:> I<file[;geom]>
626
627Use the specified XPM file (note the `.xpm' extension is optional) for
628the background and also optionally specify its scaling with a geometry
629string B<WxH+X+Y>, in which B<"W" / "H"> specify the
630horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image
631centre (percent). A scale of 0 displays the image with tiling. A scale
632of 1 displays the image without any scaling. A scale of 2 to 9
633specifies an integer number of images in that direction. No image will
634be magnified beyond 10 times its original size. The maximum permitted
635scale is 1000. [default 0x0+50+50]
636
637=item B<path:> I<path>
638
639Specify the colon-delimited search path for finding XPM files.
640 680
641=item B<font:> I<fontlist> 681=item B<font:> I<fontlist>
642 682
643Select 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
644that 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
… …
667it 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
668wide and 15 pixels high. 708wide and 15 pixels high.
669 709
670The 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
671the base font, likewise the third, which is unfortunately non-bold, but 711the base font, likewise the third, which is unfortunately non-bold, but
672the bold version of the font does contain less characters, so this is a 712the bold version of the font does contain fewer characters, so this is a
673useful supplement. 713useful supplement.
674 714
675The 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
676are 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
677contains other characters, but we are not interested in them. 717contains other characters, but we are not interested in them.
… …
701text font will being used for the given style. 741text font will being used for the given style.
702 742
703=item B<intensityStyles:> I<boolean> 743=item B<intensityStyles:> I<boolean>
704 744
705When 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>,
706option B<-is>, the default), bold and italic font styles imply high 746option B<-is>, the default), bold/blink font styles imply high
707intensity foreground/backround colours. Disabling this option (B<False>, 747intensity foreground/background colours. Disabling this option (B<False>,
708option B<+is>) disables this behaviour, the high intensity colours are not 748option B<+is>) disables this behaviour, the high intensity colours are not
709reachable. 749reachable.
710
711=item B<selectstyle:> I<mode>
712
713Set mouse selection style to B<old> which is 2.20, B<oldword> which is
714xterm style with 2.20 old word selection, or anything else which gives
715xterm style selection.
716
717=item B<scrollstyle:> I<mode>
718
719Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
720the author's favourite.
721 750
722=item B<title:> I<string> 751=item B<title:> I<string>
723 752
724Set window title string, the default title is the command-line 753Set window title string, the default title is the command-line
725specified after the B<-e> option, if any, otherwise the application 754specified after the B<-e> option, if any, otherwise the application
… …
734=item B<mapAlert:> I<boolean> 763=item B<mapAlert:> I<boolean>
735 764
736B<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
737de-iconify (map) on receipt of a bell character [default]. 766de-iconify (map) on receipt of a bell character [default].
738 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
739=item B<visualBell:> I<boolean> 775=item B<visualBell:> I<boolean>
740 776
741B<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>.
742B<False>: no visual bell [default]; option B<+vb>. 778B<False>: no visual bell [default]; option B<+vb>.
743 779
… …
764Example: 800Example:
765 801
766 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 802 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
767 803
768This 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
769everytime 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.
770 815
771=item B<scrollBar:> I<boolean> 816=item B<scrollBar:> I<boolean>
772 817
773B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 818B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
774disable the scrollbar; option B<+sb>. 819disable the scrollbar; option B<+sb>.
… …
794B<False>: do not scroll to bottom when tty receives output; option 839B<False>: do not scroll to bottom when tty receives output; option
795B<+si>. 840B<+si>.
796 841
797=item B<scrollWithBuffer:> I<boolean> 842=item B<scrollWithBuffer:> I<boolean>
798 843
799B<True>: scroll with scrollback buffer when tty receives new lines (and 844B<True>: scroll with scrollback buffer when tty receives new lines (i.e.
800B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 845try to show the same lines) and B<scrollTtyOutput> is False; option
801with 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>.
802 848
803=item B<scrollTtyKeypress:> I<boolean> 849=item B<scrollTtyKeypress:> I<boolean>
804 850
805B<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
806are those which are intercepted by rxvt-unicode for special handling and 852are those which are intercepted by rxvt-unicode for special handling and
… …
837=item B<termName:> I<termname> 883=item B<termName:> I<termname>
838 884
839Specifies 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
840variable; option B<-tn>. 886variable; option B<-tn>.
841 887
842=item B<linespace:> I<number> 888=item B<lineSpace:> I<number>
843 889
844Specifies number of lines (pixel height) to insert between each row of 890Specifies number of lines (pixel height) to insert between each row of
845the display [default 0]; option B<-lsp>. 891the display [default 0]; option B<-lsp>.
846 892
847=item B<meta8:> I<boolean> 893=item B<meta8:> I<boolean>
… …
861 907
862=item B<cursorBlink:> I<boolean> 908=item B<cursorBlink:> I<boolean>
863 909
864B<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];
865option 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>.
866 917
867=item B<pointerBlank:> I<boolean> 918=item B<pointerBlank:> I<boolean>
868 919
869B<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
870of seconds of inactivity. B<False>: the pointer is always visible 921of seconds of inactivity. B<False>: the pointer is always visible
… …
884large number (e.g. C<987654321>) to effectively disable the timeout. 935large number (e.g. C<987654321>) to effectively disable the timeout.
885 936
886=item B<backspacekey:> I<string> 937=item B<backspacekey:> I<string>
887 938
888The 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>
889or 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>
890(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
891escape sequence. 942escape sequence.
892 943
893=item B<deletekey:> I<string> 944=item B<deletekey:> I<string>
894 945
… …
896pressed. If unset it will send the sequence traditionally associated 947pressed. If unset it will send the sequence traditionally associated
897with the B<Execute> key. 948with the B<Execute> key.
898 949
899=item B<cutchars:> I<string> 950=item B<cutchars:> I<string>
900 951
901The characters used as delimiters for double-click word selection. The 952The characters used as delimiters for double-click word selection
902built-in default: 953(whitespace delimiting is added automatically if resource is given).
903 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
904B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 963B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
905 964
906=item B<preeditType:> I<style> 965=item B<preeditType:> I<style>
907 966
908B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 967B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
909 968
… …
963 1022
964Turn on/off secondary screen (default enabled). 1023Turn on/off secondary screen (default enabled).
965 1024
966=item B<secondaryScroll:> I<boolean> 1025=item B<secondaryScroll:> I<boolean>
967 1026
968Turn on/off secondary screen scroll (default enabled). If the this 1027Turn on/off secondary screen scroll (default enabled). If this
969option is enabled, scrolls on the secondary screen will change the 1028option is enabled, scrolls on the secondary screen will change the
970scrollback buffer and switching to/from the secondary screen will 1029scrollback buffer and, when secondaryScreen is off, switching
971instead scroll the screen up. 1030to/from the secondary screen will instead scroll the screen up.
972 1031
973=item B<hold>: I<boolean> 1032=item B<hold>: I<boolean>
974 1033
975Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1034Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
976will not immediately destroy its window when the program executed within 1035will not immediately destroy its window when the program executed within
977it 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
978user. 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>.
979 1045
980=item B<keysym.>I<sym>: I<string> 1046=item B<keysym.>I<sym>: I<string>
981 1047
982Compile I<frills>: Associate I<string> with keysym I<sym>. The 1048Compile I<frills>: Associate I<string> with keysym I<sym>. The
983intervening resource name B<keysym.> cannot be omitted. 1049intervening resource name B<keysym.> cannot be omitted.
… …
997searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1063searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
998omitting 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
999keysym 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
1000performed in an exact manner; however, the closest match is assured. 1066performed in an exact manner; however, the closest match is assured.
1001 1067
1002I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1068I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1003C<\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.
1004C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1005C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1006can start or end with whitespace.
1007 1070
1008Please note that you need to double the C<\> in resource files, as
1009Xlib itself does it's own de-escaping (you can use C<\033> instead of
1010C<\e> (and so on), which will work with both Xt and @@RXVT_NAME@@'s own
1011processing).
1012
1013You 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>
1014with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1073with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1015should be a character not used by the strings. 1074should be a character not used by the strings.
1016 1075
1017Its usage can be demonstrated by an example: 1076Its usage can be demonstrated by an example:
1018 1077
1019 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1078 URxvt.keysym.M-C-0x61: list|\033<|abc|>
1020 1079
1021The above line is equivalent to the following three lines: 1080The above line is equivalent to the following three lines:
1022 1081
1023 URxvt.keysym.Meta-Control-0x61: \033<M-C-a> 1082 URxvt.keysym.Meta-Control-0x61: \033<a>
1024 URxvt.keysym.Meta-Control-0x62: \033<M-C-b> 1083 URxvt.keysym.Meta-Control-0x62: \033<b>
1025 URxvt.keysym.Meta-Control-0x63: \033<M-C-c> 1084 URxvt.keysym.Meta-Control-0x63: \033<c>
1026 1085
1027If 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>
1028is interpreted and executed as @@RXVT_NAME@@'s control sequence. For 1087is interpreted and executed as @@RXVT_NAME@@'s control sequence. For
1029example 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>
1030when Control-Meta-c is being pressed": 1089when Control-Meta-c is being pressed":
1031 1090
1032 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
1033 1092
1034If 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>
1035is 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)
1036manpage. For example, the F<selection> extension (activated via 1095manpage. For example, the F<selection> extension (activated via
1037C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events: 1096C<@@RXVT_NAME@@ -pe selection>) listens for C<selection:rot13> events:
1038 1097
1039 URxvt.keysym.M-C-c: perl:selection:rot13 1098 URxvt.keysym.M-C-c: perl:selection:rot13
1040 1099
1041Due the the large number of modifier combinations, a defined key mapping 1100Due the the large number of modifier combinations, a defined key mapping
1042will 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
1043no 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
1044means that defining a key map for C<a> will automatically provide 1103means that defining a key map for C<a> will automatically provide
1045definitions 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
1046mappings themselves. 1105mappings themselves.
1047 1106
… …
1083example, C<default,-selection> will use all the default extension except 1142example, C<default,-selection> will use all the default extension except
1084C<selection>. 1143C<selection>.
1085 1144
1086Extension names can also be followed by an argument in angle brackets 1145Extension names can also be followed by an argument in angle brackets
1087(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for 1146(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1088searchable scorllback to Alt/Meta-s). Mentioning the same extension 1147searchable scrollback to Alt/Meta-s). Mentioning the same extension
1089multiple times with different arguments will pass multiple arguments to 1148multiple times with different arguments will pass multiple arguments to
1090the extension. 1149the extension.
1091 1150
1092Each extension is looked up in the library directories, loaded if 1151Each extension is looked up in the library directories, loaded if
1093necessary, and bound to the current terminal instance. 1152necessary, and bound to the current terminal instance.
… …
1098all instances, while B<perl-ext> is used for specific instances. 1157all instances, while B<perl-ext> is used for specific instances.
1099 1158
1100=item B<perl-eval>: I<string> 1159=item B<perl-eval>: I<string>
1101 1160
1102Perl code to be evaluated when all extensions have been registered. See 1161Perl code to be evaluated when all extensions have been registered. See
1103the @@RXVT_NAME@@perl(3) manpage. Due to security reasons, this resource 1162the @@RXVT_NAME@@perl(3) manpage.
1104will be ignored when running setuid/setgid.
1105 1163
1106=item B<perl-lib>: I<path> 1164=item B<perl-lib>: I<path>
1107 1165
1108Colon-separated list of additional directories that hold extension 1166Colon-separated list of additional directories that hold extension
1109scripts. When looking for extensions specified by the C<perl> resource, 1167scripts. When looking for perl extensions, @@RXVT_NAME@@ will first look
1110@@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
1111F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1169lastly in F<@@RXVT_LIBDIR@@/urxvt/perl/>.
1112will be ignored when running setuid/setgid.
1113 1170
1114See the @@RXVT_NAME@@perl(3) manpage. 1171See the @@RXVT_NAME@@perl(3) manpage.
1115 1172
1116=item B<< selection.pattern-I<idx> >>: I<perl-regex> 1173=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1117 1174
… …
1129(default: C<M-s>). 1186(default: C<M-s>).
1130 1187
1131=item B<urlLauncher>: I<string> 1188=item B<urlLauncher>: I<string>
1132 1189
1133Specifies the program to be started with a URL argument. Used by the 1190Specifies the program to be started with a URL argument. Used by the
1134C<selection-popup> and C<mark-urls> perl extensions. 1191C<selection-popup> and C<matcher> perl extensions.
1135 1192
1136=item B<transient-for>: I<windowid> 1193=item B<transient-for>: I<windowid>
1137 1194
1138Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id. 1195Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1139 1196
1140=item B<override-redirect>: I<boolean> 1197=item B<override-redirect>: I<boolean>
1141 1198
1142Compile I<frills>: Sets override-redirect for the terminal window, making 1199Compile I<frills>: Sets override-redirect for the terminal window, making
1143it almost invisible to window managers; option B<-override-redirect>. 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=head1 BACKGROUND IMAGE OPTIONS AND RESOURCES
1211
1212=item B<-pixmap> I<file[;oplist]>
1213
1214=item B<backgroundPixmap:> I<file[;oplist]>
1215
1216Compile I<pixbuf>: Use the specified image file as the window's
1217background and also optionally specify a colon separated list of
1218operations to modify it. Note that you may need to quote the C<;>
1219character when using the command line option, as C<;> is usually a
1220metacharacter in shells. Supported operations are:
1221
1222=over 4
1223
1224=item B<WxH+X+Y>
1225
1226sets scale and position. B<"W" / "H"> specify the horizontal/vertical
1227scale (percent), and B<"X" / "Y"> locate the image centre (percent). A
1228scale of 0 disables scaling.
1229
1230=item B<op=tile>
1231
1232enables tiling
1233
1234=item B<op=keep-aspect>
1235
1236maintain the image aspect ratio when scaling
1237
1238=item B<op=root-align>
1239
1240use the position of the terminal window relative to the root window as
1241the image offset, simulating a root window background
1242
1243=back
1244
1245The default scale and position setting is C<100x100+50+50>.
1246Alternatively, a predefined set of templates can be used to achieve
1247the most common setups:
1248
1249=over 4
1250
1251=item B<style=tiled>
1252
1253the image is tiled with no scaling. Equivalent to 0x0+0+0:op=tile
1254
1255=item B<style=aspect-stretched>
1256
1257the image is scaled to fill the whole window maintaining the aspect
1258ratio and centered. Equivalent to 100x100+50+50:op=keep-aspect
1259
1260=item B<style=stretched>
1261
1262the image is scaled to fill the whole window. Equivalent to 100x100
1263
1264=item B<style=centered>
1265
1266the image is centered with no scaling. Equivalent to 0x0+50+50
1267
1268=item B<style=root-tiled>
1269
1270the image is tiled with no scaling and using 'root' positioning.
1271Equivalent to 0x0:op=tile:op=root-align
1272
1273=back
1274
1275If multiple templates are specified the last one wins. Note that a
1276template overrides all the scale, position and operations settings.
1277
1278If used in conjunction with pseudo-transparency, the specified pixmap
1279will be blended over the transparent background using alpha-blending.
1280
1281=item B<-tr>|B<+tr>
1282
1283=item B<transparent:> I<boolean>
1284
1285Turn on/off pseudo-transparency by using the root pixmap as background.
1286
1287B<-ip> (B<inheritPixmap>) is still accepted as an obsolete alias but
1288will be removed in future versions.
1289
1290=item B<-tint> I<colour>
1291
1292=item B<tintColor:> I<colour>
1293
1294Tint the transparent background with the given colour. Note that a
1295black tint yields a completely black image while a white tint yields
1296the image unchanged.
1297
1298=item B<-sh> I<number>
1299
1300=item B<shading:> I<number>
1301
1302Darken (0 .. 99) or lighten (101 .. 200) the transparent background.
1303A value of 100 means no shading.
1304
1305=item B<-blr> I<HxV>
1306
1307=item B<blurRadius:> I<HxV>
1308
1309Apply gaussian blur with the specified radius to the transparent
1310background. If a single number is specified, the vertical and
1311horizontal radii are considered to be the same. Setting one of the
1312radii to 1 and the other to a large number creates interesting effects
1313on some backgrounds. The maximum radius value is 128. An horizontal or
1314vertical radius of 0 disables blurring.
1315
1316=item B<path:> I<path>
1317
1318Specify the colon-delimited search path for finding background image files.
1144 1319
1145=back 1320=back
1146 1321
1147=head1 THE SCROLLBAR 1322=head1 THE SCROLLBAR
1148 1323
… …
1167application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1342application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1168(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1343(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1169up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1344up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1170respectively. 1345respectively.
1171 1346
1172=head1 TEXT SELECTION AND INSERTION 1347=head1 THE SELECTION: SELECTING AND PASTING TEXT
1173 1348
1174The behaviour of text selection and insertion mechanism is similar to 1349The behaviour of text selection and insertion/pasting mechanism is similar
1175I<xterm>(1). 1350to I<xterm>(1).
1176 1351
1177=over 4 1352=over 4
1178 1353
1179=item B<Selection>: 1354=item B<Selecting>:
1180 1355
1181Left click at the beginning of the region, drag to the end of the region 1356Left click at the beginning of the region, drag to the end of the region
1182and release; Right click to extend the marked region; Left double-click 1357and release; Right click to extend the marked region; Left double-click
1183to select a word; Left triple-click to select the entire logical line 1358to select a word; Left triple-click to select the entire logical line
1184(which can span multiple screen lines), unless modified by resource 1359(which can span multiple screen lines), unless modified by resource
… …
1188(Compile: I<frills>) will create a rectangular selection instead of a 1363(Compile: I<frills>) will create a rectangular selection instead of a
1189normal one. In this mode, every selected row becomes its own line in the 1364normal one. In this mode, every selected row becomes its own line in the
1190selection, and trailing whitespace is visually underlined and removed from 1365selection, and trailing whitespace is visually underlined and removed from
1191the selection. 1366the selection.
1192 1367
1193=item B<Insertion>: 1368=item B<Pasting>:
1194 1369
1195Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1370Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1196an B<@@RXVT_NAME@@> window causes the current text selection to be 1371window causes the value of the PRIMARY selection (or CLIPBOARD with the
1197inserted as if it had been typed on the keyboard. 1372B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1373
1374Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1375inserted too.
1198 1376
1199=back 1377=back
1200 1378
1201=head1 CHANGING FONTS 1379=head1 CHANGING FONTS
1202 1380
… …
1216 1394
1217=head1 ISO 14755 SUPPORT 1395=head1 ISO 14755 SUPPORT
1218 1396
1219ISO 14755 is a standard for entering and viewing unicode characters 1397ISO 14755 is a standard for entering and viewing unicode characters
1220and character codes using the keyboard. It consists of 4 parts. The 1398and character codes using the keyboard. It consists of 4 parts. The
1221first part is available rxvt-unicode has been compiled with 1399first part is available if rxvt-unicode has been compiled with
1222C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1400C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1223with C<--enable-iso14755>. 1401with C<--enable-iso14755>.
1224 1402
1225=over 4 1403=over 4
1226 1404
… …
1246This mode lets you input characters representing the keycap symbols of 1424This mode lets you input characters representing the keycap symbols of
1247your keyboard, if representable in the current locale encoding. 1425your keyboard, if representable in the current locale encoding.
1248 1426
1249Start by pressing C<Control> and C<Shift> together, then releasing 1427Start by pressing C<Control> and C<Shift> together, then releasing
1250them. The next special key (cursor keys, home etc.) you enter will not 1428them. The next special key (cursor keys, home etc.) you enter will not
1251invoke it's usual function but instead will insert the corresponding 1429invoke its usual function but instead will insert the corresponding
1252keycap symbol. The symbol will only be entered when the key has been 1430keycap symbol. The symbol will only be entered when the key has been
1253released, otherwise pressing e.g. C<Shift> would enter the symbol for 1431released, otherwise pressing e.g. C<Shift> would enter the symbol for
1254C<ISO Level 2 Switch>, although your intention might have been to enter a 1432C<ISO Level 2 Switch>, although your intention might have been to enter a
1255reverse tab (Shift-Tab). 1433reverse tab (Shift-Tab).
1256 1434
… …
1284B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that 1462B<@@RXVT_NAME@@> tries to write an entry into the I<utmp>(5) file so that
1285it can be seen via the I<who(1)> command, and can accept messages. To 1463it can be seen via the I<who(1)> command, and can accept messages. To
1286allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root 1464allow this feature, B<@@RXVT_NAME@@> may need to be installed setuid root
1287on some systems or setgid to root or to some other group on others. 1465on some systems or setgid to root or to some other group on others.
1288 1466
1289=head1 COLORS AND GRAPHICS 1467=head1 COLOURS AND GRAPHICS
1290 1468
1291In addition to the default foreground and background colours, 1469In addition to the default foreground and background colours,
1292B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1470B<@@RXVT_NAME@@> can display up to 88/256 colours: 8 ANSI colours plus
1293high-intensity bold/blink versions of the same). Here is a list of the 1471high-intensity (potentially bold/blink) versions of the same, and 72 (or
1294colours with their B<rgb.txt> names. 1472240 in 256 colour mode) colours arranged in an 4x4x4 (or 6x6x6) colour RGB
1473cube plus a 8 (24) colour greyscale ramp.
1474
1475Here is a list of the ANSI colours with their names.
1295 1476
1296=begin table 1477=begin table
1297 1478
1298 B<color0> (black) = Black 1479 B<color0> (black) = Black
1299 B<color1> (red) = Red3 1480 B<color1> (red) = Red3
… …
1319It is also possible to specify the colour values of B<foreground>, 1500It is also possible to specify the colour values of B<foreground>,
1320B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1501B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1321a number 0-15, as a convenient shorthand to reference the colour name of 1502a number 0-15, as a convenient shorthand to reference the colour name of
1322color0-color15. 1503color0-color15.
1323 1504
1505The following text gives values for the standard 88 colour mode (and
1506values for the 256 colour mode in parentheses).
1507
1508The RGB cube uses indices 16..79 (16..231) using the following formulas:
1509
1510 index_88 = (r * 4 + g) * 4 + b + 16 # r, g, b = 0..3
1511 index_256 = (r * 16 + g) * 16 + b + 16 # r, g, b = 0..15
1512
1513The grayscale ramp uses indices 80..87 (232..239), from 10% to 90% in 10%
1514steps (1/26 to 25/26 in 1/26 steps) - black and white are already part of
1515the RGB cube.
1516
1517Together, all those colours implement the 88 (256) colour xterm
1518colours. Only the first 16 can be changed using resources currently, the
1519rest can only be changed via command sequences ("escape codes").
1520
1521Applications are advised to use terminfo or command sequences to discover
1522number and RGB values of all colours (yes, you can query this...).
1523
1324Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1524Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1325always swapping the foreground/background colours. This is in contrast to 1525always swapping the foreground/background colours. This is in contrast to
1326I<xterm>(1) where the colours are only swapped if they have not otherwise 1526I<xterm>(1) where the colours are only swapped if they have not otherwise
1327been specified. For example, 1527been specified. For example,
1328 1528
1529 @@RXVT_NAME@@ -fg Black -bg White -rv
1530
1531would yield White on Black, while on I<xterm>(1) it would yield Black on
1532White.
1533
1534=head2 ALPHA CHANNEL SUPPORT
1535
1536If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1537their act together, rxvt-unicode will do its own alpha channel management:
1538
1539You can prefix any colour with an opaqueness percentage enclosed in
1540brackets, i.e. C<[percent]>, where C<percent> is a decimal percentage
1541(0-100) that specifies the opacity of the colour, where C<0> is completely
1542transparent and C<100> is completely opaque. For example, C<[50]red> is a
1543half-transparent red, while C<[95]#00ff00> is an almost opaque green. This
1544is the recommended format to specify transparency values, and works with
1545all ways to specify a colour.
1546
1547For complete control, rxvt-unicode also supports
1548C<rgba:rrrr/gggg/bbbb/aaaa> (exactly four hex digits/component) colour
1549specifications, where the additional C<aaaa> component specifies opacity
1550(alpha) values. The minimum value of C<0000> is completely transparent,
1551while C<ffff> is completely opaque). The two example colours from
1552earlier could also be specified as C<rgba:ff00/0000/0000/8000> and
1553C<rgba:0000/ff00/0000/f332>.
1554
1555You probably need to specify B<"-depth 32">, too, to force a visual with
1556alpha channels, and have the luck that your X-server uses ARGB pixel
1557layout, as X is far from just supporting ARGB visuals out of the box, and
1558rxvt-unicode just fudges around.
1559
1560For example, the following selects an almost completely transparent black
1561background, and an almost opaque pink foreground:
1562
1563 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/4444 -fg "[80]pink"
1564
1565When not using a background image, then the interpretation of the
1566alpha channel is up to your compositing manager (most interpret it as
1567transparency of course).
1568
1569When using a background pixmap or pseudo-transparency, then the background
1570colour will always behave as if it were completely transparent (so the
1571background image shows instead), regardless of how it was specified, while
1572other colours will either be transparent as specified (the background
1573image will show through) on servers supporting the RENDER extension, or
1574fully opaque on servers not supporting the RENDER EXTENSION.
1575
1576Please note that due to bugs in Xft, specifying alpha values might result
1577in garbage being displayed when the X-server does not support the RENDER
1578extension.
1579
1580=head1 ENVIRONMENT
1581
1582B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1583
1329=over 4 1584=over 4
1330 1585
1331=item B<@@RXVT_NAME@@ -fg Black -bg White -rv>
1332
1333would yield White on Black, while on I<xterm>(1) it would yield Black
1334on White.
1335
1336=back
1337
1338=head1 ENVIRONMENT
1339
1340B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1341
1342=over 4
1343
1344=item B<TERM> 1586=item B<TERM>
1345 1587
1346Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1588Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1347resources or on the commandline. 1589resources or on the command line.
1348 1590
1349=item B<COLORTERM> 1591=item B<COLORTERM>
1350 1592
1351Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1593Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1352compiled with XPM support, and optionally with the added extension 1594compiled with background image support, and optionally with the added
1353C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1595extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1596screen.
1354 1597
1355=item B<COLORFGBG> 1598=item B<COLORFGBG>
1356 1599
1357Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1600Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1358the colour code used as default foreground/text colour (or the string 1601the colour code used as default foreground/text colour (or the string
1359C<default> to indicate that the default-colour escape sequence is to be 1602C<default> to indicate that the default-colour escape sequence is to be
1360used), C<bg> is the colour code used as default background colour (or the 1603used), C<bg> is the colour code used as default background colour (or the
1361string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1604string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1362was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1605was compiled with background image support. Libraries like C<ncurses>
1363(and do) use this information to optimize screen output. 1606and C<slang> can (and do) use this information to optimize screen output.
1364 1607
1365=item B<WINDOWID> 1608=item B<WINDOWID>
1366 1609
1367Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1610Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1368window, which usually has subwindows for the scrollbar, the terminal 1611window, which usually has subwindows for the scrollbar, the terminal
… …
1374C<--with-terminfo=PATH>. 1617C<--with-terminfo=PATH>.
1375 1618
1376=item B<DISPLAY> 1619=item B<DISPLAY>
1377 1620
1378Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1621Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1379display in it's child processes. 1622display in its child processes if C<-display> isn't used to override. It
1623defaults to C<:0> if it doesn't exist.
1380 1624
1381=item B<SHELL> 1625=item B<SHELL>
1382 1626
1383The shell to be used for command execution, defaults to C</bin/sh>. 1627The shell to be used for command execution, defaults to C</bin/sh>.
1384 1628
1385=item B<RXVT_SOCKET> 1629=item B<RXVT_SOCKET> [I<sic>]
1386 1630
1387The unix domain socket path used by @@RXVT_NAME@@c(1) and 1631The unix domain socket path used by @@RXVT_NAME@@c(1) and
1388@@RXVT_NAME@@d(1). 1632@@RXVT_NAME@@d(1).
1389 1633
1390Default F<<< $HOME/.rxvt-unicode-I<< <nodename >> >>>. 1634Default F<<< $HOME/.urxvt/urxvtd-I<< <nodename> >> >>>.
1635
1636=item B<URXVT_PERL_LIB>
1637
1638Additional F<:>-separated library search path for perl extensions. Will be
1639searched after B<-perl-lib> but before F<~/.urxvt/ext> and the system library
1640directory.
1641
1642=item B<URXVT_PERL_VERBOSITY>
1643
1644See L<@@RXVT_NAME@@perl>(3).
1391 1645
1392=item B<HOME> 1646=item B<HOME>
1393 1647
1394Used to locate the default directory for the unix domain socket for 1648Used to locate the default directory for the unix domain socket for
1395daemon communications and to locate various resource files (such as 1649daemon communications and to locate various resource files (such as
1396C<.Xdefaults>) 1650C<.Xdefaults>)
1397 1651
1398=item B<XAPPLRESDIR> 1652=item B<XAPPLRESDIR>
1399 1653
1400Directory where various X resource files are being located. 1654Directory where application-specific X resource files are located.
1401 1655
1402=item B<XENVIRONMENT> 1656=item B<XENVIRONMENT>
1403 1657
1404If set and accessible, gives the name of a X resource file to be loaded by 1658If set and accessible, gives the name of a X resource file to be loaded by
1405@@RXVT_NAME@@. 1659@@RXVT_NAME@@.
… …
1410 1664
1411=over 4 1665=over 4
1412 1666
1413=item B</usr/lib/X11/rgb.txt> 1667=item B</usr/lib/X11/rgb.txt>
1414 1668
1415Color names. 1669Colour names.
1416 1670
1417=back 1671=back
1418 1672
1419=head1 SEE ALSO 1673=head1 SEE ALSO
1420 1674
1675@@RXVT_NAME@@(7), @@RXVT_NAME@@c(1), @@RXVT_NAME@@d(1), @@RXVT_NAME@@-extensions(1),
1421@@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) 1676@@RXVT_NAME@@perl(3), xterm(1), sh(1), resize(1), X(1), pty(4), tty(4), utmp(5)
1422 1677
1423=head1 CURRENT PROJECT COORDINATOR 1678=head1 CURRENT PROJECT COORDINATOR
1424 1679
1425=over 4 1680=over 4
1426 1681
1427=item Project Coordinator 1682=item Project Coordinator
1428 1683
1429Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1684Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1430 1685
1431L<http://software.schmorp.de/#rxvt-unicode> 1686L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1432 1687
1433=back 1688=back
1434 1689
1435=head1 AUTHORS 1690=head1 AUTHORS
1436 1691
… …
1459Project Coordinator (changes.txt 2.21a to 2.4.5) 1714Project Coordinator (changes.txt 2.21a to 2.4.5)
1460 1715
1461=item Geoff Wing L<< <gcw@pobox.com> >> 1716=item Geoff Wing L<< <gcw@pobox.com> >>
1462 1717
1463Rewrote screen display and text selection routines. 1718Rewrote screen display and text selection routines.
1464 1719
1465Project Coordinator (changes.txt 2.4.6 - rxvt-unicode) 1720Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1466 1721
1467=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1722=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1468 1723
1469Forked rxvt-unicode, unicode support, rewrote almost all the code, perl 1724Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
… …
1471 1726
1472Project Coordinator (Changes 1.0 -) 1727Project Coordinator (Changes 1.0 -)
1473 1728
1474=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >> 1729=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1475 1730
1476Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugxifing. 1731pty/utmp code rewrite, image code improvements, many random hacks and bugfixes.
1477 1732
1478=back 1733=back
1479 1734

Diff Legend

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