ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/doc/rxvt.1.pod
(Generate patch)

Comparing rxvt-unicode/doc/rxvt.1.pod (file contents):
Revision 1.89 by root, Sun Jan 8 08:43:11 2006 UTC vs.
Revision 1.148 by ayin, Sat Nov 24 17:07:46 2007 UTC

17=head1 FREQUENTLY ASKED QUESTIONS 17=head1 FREQUENTLY ASKED QUESTIONS
18 18
19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of 19See @@RXVT_NAME@@(7) (try C<man 7 @@RXVT_NAME@@>) for a list of
20frequently asked questions and answer to them and some common 20frequently asked questions and answer to them and some common
21problems. That document is also accessible on the World-Wide-Web at 21problems. That document is also accessible on the World-Wide-Web at
22L<http://cvs.schmorp.de/browse/*checkout*/rxvt-unicode/doc/rxvt.7.html>. 22L<http://cvs.schmorp.de/browse/rxvt-unicode/doc/rxvt.7.html>.
23 23
24=head1 RXVT-UNICODE VS. RXVT 24=head1 RXVT-UNICODE VS. RXVT
25 25
26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode 26Unlike the original rxvt, B<rxvt-unicode> stores all text in Unicode
27internally. That means it can store and display most scripts in the 27internally. That means it can store and display most scripts in the
28world. Being a terminal emulator, however, some things are very difficult, 28world. Being a terminal emulator, however, some things are very difficult,
29especially cursive scripts such as arabic, vertically written scripts 29especially cursive scripts such as arabic, vertically written scripts
30like mongolian or scripts requiring extremely complex combining rules, 30like mongolian or scripts requiring extremely complex combining rules,
31like tibetan or devenagari. Don't expect pretty output when using these 31like tibetan or devanagari. Don't expect pretty output when using these
32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work 32scripts. Most other scripts, latin, cyrillic, kanji, thai etc. should work
33fine, though. A somewhat difficult case are left-to-right scripts, such 33fine, though. A somewhat difficult case are right-to-left scripts, such
34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms 34as hebrew: B<rxvt-unicode> adopts the view that bidirectional algorithms
35belong into the application, not the terminal emulator (too many things -- 35belong into the application, not the terminal emulator (too many things --
36such as cursor-movement while editing -- break otherwise), but that might 36such as cursor-movement while editing -- break otherwise), but that might
37change. 37change.
38 38
39If you are looking for a terminal that supports more exotic scripts, let 39If you are looking for a terminal that supports more exotic scripts, let
40me recommend C<mlterm>, which is a very userfriendly, lean and clean 40me recommend C<mlterm>, which is a very user friendly, lean and clean
41terminal emulator. In fact, the reason rxvt-unicode was born was solely 41terminal 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 42because the author couldn't get C<mlterm> to use one font for latin1 and
43another for japanese. 43another for japanese.
44 44
45Therefore another design rationale was the use of multiple fonts to 45Therefore another design rationale was the use of multiple fonts to
46display characters: The idea of a single unicode font which many other 46display 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 47programs force onto its users never made sense to me: You should be able
48to choose any font for any script freely. 48to choose any font for any script freely.
49 49
50Apart from that, rxvt-unicode is also much better internationalised than 50Apart from that, rxvt-unicode is also much better internationalised than
51it's predecessor, supports things such as XFT and ISO 14755 that are handy 51its 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 52in i18n-environments, is faster, and has a lot bugs less than the original
53rxvt. This all in addition to dozens of other small improvements. 53rxvt. This all in addition to dozens of other small improvements.
54 54
55It is still faithfully following the original rxvt idea of being lean 55It is still faithfully following the original rxvt idea of being lean
56and nice on resources: for example, you can still configure rxvt-unicode 56and 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 57without 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 58a client/daemon pair that lets you open any number of terminal windows
59from within a single process, which makes startup time very fast and 59from within a single process, which makes startup time very fast and
60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and 60drastically reduces memory usage. See @@RXVT_NAME@@d(1) (daemon) and
61@@RXVT_NAME@@c(1) (client). 61@@RXVT_NAME@@c(1) (client).
62 62
63It also makes technical information about escape sequences (which have 63It also makes technical information about escape sequences (which have
64been extended) easier accessible: see @@RXVT_NAME@@(7) for technical 64been extended) more accessible: see @@RXVT_NAME@@(7) for technical
65reference documentation (escape sequences etc.). 65reference documentation (escape sequences etc.).
66 66
67=head1 OPTIONS 67=head1 OPTIONS
68 68
69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed 69The B<@@RXVT_NAME@@> options (mostly a subset of I<xterm>'s) are listed
93 93
94Attempt to open a window on the named X display (B<-d> still 94Attempt to open a window on the named X display (B<-d> still
95respected). In the absence of this option, the display specified by the 95respected). In the absence of this option, the display specified by the
96B<DISPLAY> environment variable is used. 96B<DISPLAY> environment variable is used.
97 97
98=item B<-depth> I<bitdepth>
99
100Compile I<xft>: Attempt to find a visual with the given bit depth;
101resource B<depth>.
102
98=item B<-geometry> I<geom> 103=item B<-geometry> I<geom>
99 104
100Window geometry (B<-g> still respected); resource B<geometry>. 105Window geometry (B<-g> still respected); resource B<geometry>.
101 106
102=item B<-rv>|B<+rv> 107=item B<-rv>|B<+rv>
103 108
104Turn on/off simulated reverse video; resource B<reverseVideo>. 109Turn on/off simulated reverse video; resource B<reverseVideo>.
105 110
106=item B<-j>|B<+j> 111=item B<-j>|B<+j>
107 112
108Turn on/off jump scrolling; resource B<jumpScroll>. 113Turn on/off jump scrolling (allow multiple lines per refresh); resource B<jumpScroll>.
109 114
110=item B<-ip>|B<+ip> | B<-tr>|B<+tr> 115=item B<-ss>|B<+ss>
111 116
112Turn on/off inheriting parent window's pixmap. Alternative form is 117Turn on/off skip scrolling (allow multiple screens per refresh); resource B<skipScroll>.
113B<-tr>; resource B<inheritPixmap>. 118
119=item B<-tr>|B<+tr>
120
121Turn on/off illusion of a transparent window background; resource B<transparent>.
122
123B<-ip> is still accepted as an obsolete alias but will be removed in
124future versions.
125
126I<Please address all transparency related issues to Sasha Vasko at
127sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
114 128
115=item B<-fade> I<number> 129=item B<-fade> I<number>
116 130
117Fade the text by the given percentage when focus is lost. Small values 131Fade the text by the given percentage when focus is lost. Small values
118fade a little only, 100 completely replaces all colours by the fade 132fade a little only, 100 completely replaces all colours by the fade
119colour; resource B<fading>. 133colour; resource B<fading>.
120 134
121=item B<-fadecolor> I<colour> 135=item B<-fadecolor> I<colour>
122 136
123Fade to this colour when fading is used (see B<-fade>). The default colour 137Fade to this colour when fading is used (see B<-fade>). The default colour
124is black. resource B<fadeColor>. 138is opaque black. resource B<fadeColor>.
125 139
126=item B<-tint> I<colour> 140=item B<-tint> I<colour>
127 141
128Tint the transparent background pixmap with the given colour when 142Tint the transparent background pixmap with the given colour when
129transparency is enabled with B<-tr> or B<-ip>. This only works for 143transparency is enabled with B<-tr>. This only works for
130non-tiled backgrounds, currently. See also the B<-sh> option that can be 144non-tiled backgrounds, currently. See also the B<-sh> option that can be
131used to brighten or darken the image in addition to tinting it; resource 145used to brighten or darken the image in addition to tinting it.
146Please note that certain tint colours can be applied on the server-side,
147thus yielding performance gain of two orders of magnitude. These colours are:
148blue, red, green, cyan, magenta, yellow, and those close to them. Also
149pure black and pure white colors essentially mean no tinting; resource
132I<tintColor>. Example: 150I<tintColor>. Example:
133 151
134 @@RXVT_NAME@@ -tr -tint blue -sh 40 152 @@RXVT_NAME@@ -tr -tint blue -sh 40
135 153
136=item B<-sh> 154=item B<-sh> I<number>
137 155
138I<number> Darken (0 .. 100) or lighten (-1 .. -100) the transparent 156Darken (0 .. 100) or lighten (100 .. 200) the transparent
139background image in addition to tinting it (i.e. B<-tint> must be 157background image in addition to (or instead of) tinting it;
140specified, too, e.g. C<-tint white>). 158resource I<shading>.
159
160=item B<-blt> I<string>
161
162Specify background blending type. If background pixmap is specified
163at the same time as transparency - such pixmap will be blended over
164transparency image, using method specified. Supported values are :
165B<add>, B<alphablend>, B<allanon> - color values averaging, B<colorize>,
166B<darken>, B<diff>, B<dissipate>, B<hue>, B<lighten>, B<overlay>,
167B<saturate>, B<screen>, B<sub>, B<tint>, B<value>. The default is
168alpha-blending. Compile I<afterimage>; resource I<blendType>.
169
170=item B<-blr> I<HxV>
171
172Apply Gaussian Blur with the specified radii to the transparent
173background image. If single number is specified - both vertical and
174horizontal radii are considered to be the same. Setting one of the
175radii to 1 and another to a large number creates interesting effects
176on some backgrounds. Maximum radius value is 128. Compile I<afterimage>;
177resource I<blurRadius>.
141 178
142=item B<-bg> I<colour> 179=item B<-bg> I<colour>
143 180
144Window background colour; resource B<background>. 181Window background colour; resource B<background>.
145 182
146=item B<-fg> I<colour> 183=item B<-fg> I<colour>
147 184
148Window foreground colour; resource B<foreground>. 185Window foreground colour; resource B<foreground>.
149 186
150=item B<-pixmap> I<file[;geom]> 187=item B<-pixmap> I<file[;geom[:op1][:op2][...]]>
151 188
152Compile I<XPM>: Specify XPM file for the background and also optionally 189Compile I<afterimage>: Specify image file for the background and also
153specify its scaling with a geometry string. Note you may need to 190optionally specify its scaling with a geometry string. Note you may need to
154add quotes to avoid special shell interpretation of the C<;> in the 191add quotes to avoid special shell interpretation of the C<;> in the
155command-line; resource B<backgroundPixmap>. 192command-line; for more details see resource B<backgroundPixmap>.
156 193
157=item B<-cr> I<colour> 194=item B<-cr> I<colour>
158 195
159The cursor colour; resource B<cursorColor>. 196The cursor colour; resource B<cursorColor>.
160 197
172resource B<borderColor>. 209resource B<borderColor>.
173 210
174=item B<-fn> I<fontlist> 211=item B<-fn> I<fontlist>
175 212
176Select the fonts to be used. This is a comma separated list of font names 213Select the fonts to be used. This is a comma separated list of font names
177that are used in turn when trying to display Unicode characters. The 214that are checked in order when trying to find glyphs for characters. The
178first font defines the cell size for characters; other fonts might be 215first font defines the cell size for characters; other fonts might be
179smaller, but not (in general) larger. A (hopefully) reasonable default 216smaller, but not (in general) larger. A (hopefully) reasonable default
180font list is always appended to it. See resource B<font> for more details. 217font list is always appended to it. See resource B<font> for more details.
181 218
182In short, to specify an X11 core font, just specify it's name or prefix it 219In 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:>, 220with C<x:>. To specify an XFT-font, you need to prefix it with C<xft:>,
184e.g.: 221e.g.:
185 222
186 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15" 223 @@RXVT_NAME@@ -fn "xft:Bitstream Vera Sans Mono:pixelsize=15"
187 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono" 224 @@RXVT_NAME@@ -fn "9x15bold,xft:Bitstream Vera Sans Mono"
297 334
298Compile I<frills>: Set MWM hints to request a borderless window, i.e. 335Compile 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 336if honoured by the WM, the rxvt-unicode window will not have window
300decorations; resource B<borderLess>. 337decorations; resource B<borderLess>.
301 338
339=item B<-override-redirect>
340
341Compile I<frills>: Sets override-redirect on the window; resource
342B<override-redirect>.
343
302=item B<-sbg> 344=item B<-sbg>
303 345
304Compile I<frills>: Disable the usage of the built-in block graphics/line 346Compile I<frills>: Disable the usage of the built-in block graphics/line
305drawing characters and just rely on what the specified fonts provide. Use 347drawing characters and just rely on what the specified fonts provide. Use
306this if you have a good font and want to use its block graphic glyphs; 348this if you have a good font and want to use its block graphic glyphs;
308 350
309=item B<-lsp> I<number> 351=item B<-lsp> I<number>
310 352
311Compile I<frills>: Lines (pixel height) to insert between each row of 353Compile I<frills>: Lines (pixel height) to insert between each row of
312the display. Useful to work around font rendering problems; resource 354the display. Useful to work around font rendering problems; resource
313B<linespace>. 355B<lineSpace>.
314 356
315=item B<-tn> I<termname> 357=item B<-tn> I<termname>
316 358
317This option specifies the name of the terminal type to be set in the 359This option specifies the name of the terminal type to be set in the
318B<TERM> environment variable. This terminal type must exist in the 360B<TERM> environment variable. This terminal type must exist in the
372for more info. 414for more info.
373 415
374=item B<-tcw> 416=item B<-tcw>
375 417
376Change the meaning of triple-click selection with the left mouse 418Change the meaning of triple-click selection with the left mouse
419button. Only effective when the original (non-perl) selection code is
377button. Instead of selecting a full line it will extend the selection the 420in-use. Instead of selecting a full line it will extend the selection the
378end of the logical line only. resource B<tripleclickwords>. 421end of the logical line only. resource B<tripleclickwords>.
379 422
380=item B<-insecure> 423=item B<-insecure>
381 424
382Enable "insecure" mode, which currently enables most of the escape 425Enable "insecure" mode, which currently enables most of the escape
404Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 447Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
405will not immediately destroy its window when the program executed within 448will 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 449it exits. Instead, it will wait till it is being killed or closed by the
407user; resource B<hold>. 450user; resource B<hold>.
408 451
452=item B<-xrm> I<string>
453
454Works like the X Toolkit option of the same name, by adding the I<string>
455as if it were specified in a resource file. Resource values specified this
456way take precedence over all other resource specifications.
457
458Note that you need to use the I<same> syntax as in the .Xdefaults file,
459e.g. C<*.background: black>. Also note that all @@RXVT_NAME@@-specific
460options can be specified as long-options on the commandline, so use
461of B<-xrm> is mostly limited to cases where you want to specify other
462resources (e.g. for input methods) or for compatibility with other
463programs.
464
409=item B<-keysym.>I<sym> I<string> 465=item B<-keysym.>I<sym> I<string>
410 466
411Remap a key symbol. See resource B<keysym>. 467Remap a key symbol. See resource B<keysym>.
412 468
413=item B<-embed> I<windowid> 469=item B<-embed> I<windowid>
414 470
415Tells @@RXVT_NAME@@ to embed it's windows into an already-existing window, 471Tells @@RXVT_NAME@@ to embed its windows into an already-existing window,
416which enables applications to easily embed a terminal. 472which enables applications to easily embed a terminal.
417 473
418Right now, @@RXVT_NAME@@ will first unmap/map the specified window, so it 474Right 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 475shouldn'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 476quite 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. 479The window will not be destroyed when @@RXVT_NAME@@ exits.
424 480
425It might be useful to know that @@RXVT_NAME@@ will not close file 481It 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 482descriptors passed to it (except for stdin/out/err, of course), so you
427can use file descriptors to communicate with the programs within the 483can use file descriptors to communicate with the programs within the
428terminal. This works regardless of wether the C<-embed> option was used or 484terminal. This works regardless of whether the C<-embed> option was used or
429not. 485not.
430 486
431Here is a short Gtk2-perl snippet that illustrates how this option can be 487Here is a short Gtk2-perl snippet that illustrates how this option can be
432used (a longer example is in F<doc/embed>): 488used (a longer example is in F<doc/embed>):
433 489
438 }); 494 });
439 495
440=item B<-pty-fd> I<file descriptor> 496=item B<-pty-fd> I<file descriptor>
441 497
442Tells @@RXVT_NAME@@ NOT to execute any commands or create a new pty/tty 498Tells @@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 499pair 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 500useful if you want to drive @@RXVT_NAME@@ as a generic terminal emulator
445without having to run a program within it. 501without having to run a program within it.
446 502
447If this switch is given, @@RXVT_NAME@@ will not create any utmp/wtmp 503If 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 504entries and will not tinker with pty/tty permissions - you have to do that
476=head1 RESOURCES (available also as long-options) 532=head1 RESOURCES (available also as long-options)
477 533
478Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long 534Note: `@@RXVT_NAME@@ --help' gives a list of all resources (long
479options) compiled into your version. 535options) compiled into your version.
480 536
481There are two different methods that @@RXVT_NAME@@ can use to get the 537You can set and change the resources using X11 tools like B<xrdb>. Many
482Xresource data: using the X libraries (Xrm*-functions) or internal 538distribution do also load settings from the B<~/.Xresources> file when X
483Xresources reader (B<~/.Xdefaults>). For the first method (ie. 539starts. @@RXVT_NAME@@ will consult the following files/resources in order,
484B<@@RXVT_NAME@@ -h> lists B<XGetDefaults>), you can set and change the 540with later settings overwriting earlier ones:
485resources using X11 tools like B<xrdb>. Many distribution do also load
486settings from the B<~/.Xresources> file when X starts. @@RXVT_NAME@@
487will consult the following files/resources in order, with later settings
488overwriting earlier ones:
489 541
490 1. system-wide app-defaults file, either locale-dependent OR global 542 1. system-wide app-defaults file, either locale-dependent OR global
491 2. app-defaults file in $XAPPLRESDIR 543 2. app-defaults file in $XAPPLRESDIR
492 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults 544 3. RESOURCE_MANAGER property on root-window OR $HOME/.Xdefaults
493 4. SCREEN_RESOURCES for the current screen 545 4. SCREEN_RESOURCES for the current screen
494 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename> 546 5. $XENVIRONMENT file OR $HOME/.Xdefaults-<nodename>
547 6. resources specified via -xrm on the commandline
495 548
496If compiled with internal Xresources support (i.e. B<@@RXVT_NAME@@ -h>
497lists B<.Xdefaults>) then B<@@RXVT_NAME@@> accepts application defaults
498set in XAPPLOADDIR/URxvt (compile-time defined: usually
499B</usr/lib/X11/app-defaults/URxvt>) and resources set in
500B<~/.Xdefaults>, or B<~/.Xresources> if B<~/.Xdefaults> does not exist.
501Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two 549Note that when reading X resources, B<@@RXVT_NAME@@> recognizes two class
502class names: B<XTerm> and B<URxvt>. The class name B<Rxvt> allows 550names: B<Rxvt> and B<URxvt>. The class name B<Rxvt> allows resources
503resources common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be 551common to both B<@@RXVT_NAME@@> and the original I<rxvt> to be easily
504easily configured, while the class name B<URxvt> allows resources 552configured, while the class name B<URxvt> allows resources unique to
505unique to B<@@RXVT_NAME@@>, notably colours and key-handling, to be 553B<@@RXVT_NAME@@>, to be shared between different B<@@RXVT_NAME@@>
506shared between different B<@@RXVT_NAME@@> configurations. If no 554configurations. If no resources are specified, suitable defaults will
507resources are specified, suitable defaults will be used. Command-line 555be used. Command-line arguments can be used to override resource
508arguments can be used to override resource settings. The following 556settings. The following resources are supported (you might want to
509resources are allowed: 557check the @@RXVT_NAME@@perl(3) manpage for additional settings by perl
558extensions not documented here):
510 559
511=over 4 560=over 4
561
562=item B<depth:> I<bitdepth>
563
564Compile I<xft>: Attempt to find a visual with the given bit depth;
565option B<-depth>.
512 566
513=item B<geometry:> I<geom> 567=item B<geometry:> I<geom>
514 568
515Create the window with the specified X window geometry [default 80x24]; 569Create the window with the specified X window geometry [default 80x24];
516option B<-geometry>. 570option B<-geometry>.
553Use the specified colour to display underlined characters when the 607Use the specified colour to display underlined characters when the
554foreground colour is the default. 608foreground colour is the default.
555 609
556=item B<colorRV:> I<colour> 610=item B<colorRV:> I<colour>
557 611
558Use the specified colour as the background for reverse video 612Use the specified colour as the background for reverse video characters
559characters. 613when OPTION_HC is disabled (--disable-frills).
560 614
561=item B<underlineColor:> I<colour> 615=item B<underlineColor:> I<colour>
562 616
563If set, use the specified colour as the colour for the underline 617If set, use the specified colour as the colour for the underline
564itself. If unset, use the foreground colour. 618itself. If unset, use the foreground colour.
580option B<-rv>. B<False>: regular screen colours [default]; option 634option B<-rv>. B<False>: regular screen colours [default]; option
581B<+rv>. See note in B<COLORS AND GRAPHICS> section. 635B<+rv>. See note in B<COLORS AND GRAPHICS> section.
582 636
583=item B<jumpScroll:> I<boolean> 637=item B<jumpScroll:> I<boolean>
584 638
585B<True>: specify that jump scrolling should be used. When scrolling 639B<True>: specify that jump scrolling should be used. When receiving lots
586quickly, fewer screen updates are performed [default]; option B<-j>. 640of lines, @@RXVT_NAME@@ will only scroll once a whole screen height of lines
641has been read, resulting in fewer updates while still displaying every
642received line; option B<-j>.
643
587B<False>: specify that smooth scrolling should be used; option B<+j>. 644B<False>: specify that smooth scrolling should be used. @@RXVT_NAME@@ will
645force a screen refresh on each new line it received; option B<+j>.
588 646
589=item B<inheritPixmap:> I<boolean> 647=item B<skipScroll:> I<boolean>
590 648
591B<True>: make the background inherit the parent windows' pixmap, giving 649B<True>: (the default) specify that skip scrolling should be used. When
592artificial transparency. B<False>: do not inherit the parent windows' 650receiving lots of lines, @@RXVT_NAME@@ will only scroll once in a while
593pixmap. 651(around 60 times per second), resulting in far fewer updates. This can
652result in @@RXVT_NAME@@ not ever displaying some of the lines it receives;
653option B<-ss>.
654
655B<False>: specify that everything is to be displayed, even
656if the refresh is too fast for the human eye to read anything (or the
657monitor to display anything); option B<+ss>.
658
659=item B<transparent:> I<boolean>
660
661Turn on/off illusion of a transparent window background.
662
663B<inheritPixmap> is still accepted as an obsolete alias but will be removed in
664future versions.
665
666I<Please address all transparency related issues to Sasha Vasko at
667sasha@aftercode.net. Read the FAQ (man 7 @@RXVT_NAME@@)!>
594 668
595=item B<fading:> I<number> 669=item B<fading:> I<number>
596 670
597Fade the text by the given percentage when focus is lost; option B<-fade>. 671Fade the text by the given percentage when focus is lost; option B<-fade>.
598 672
606Tint the transparent background pixmap with the given colour; option 680Tint the transparent background pixmap with the given colour; option
607B<-tint>. 681B<-tint>.
608 682
609=item B<shading:> I<number> 683=item B<shading:> I<number>
610 684
611Darken (0 .. 100) or lighten (-1 .. -100) the transparent background 685Darken (0 .. 100) or lighten (-1 .. -100) the transparent background image
612image in addition to tinting it. 686in addition to tinting it; option B<-sh>.
687
688=item B<blendType:> I<string>
689
690Specify background blending type; option B<-blt>.
691
692=item B<blurRadius:> I<number>
693
694Apply Gaussian Blurr with the specified radius to the transparent
695background image; option B<-blr>.
613 696
614=item B<scrollColor:> I<colour> 697=item B<scrollColor:> I<colour>
615 698
616Use the specified colour for the scrollbar [default #B2B2B2]. 699Use the specified colour for the scrollbar [default #B2B2B2].
617 700
623=item B<borderColor:> I<colour> 706=item B<borderColor:> I<colour>
624 707
625The colour of the border around the text area and between the scrollbar 708The colour of the border around the text area and between the scrollbar
626and the text. 709and the text.
627 710
628=item B<backgroundPixmap:> I<file[;geom]> 711=item B<backgroundPixmap:> I<file[;geom[:op1][:op2][...]]>
629 712
630Use the specified XPM file (note the `.xpm' extension is optional) for 713Use the specified image file for the background and also
631the background and also optionally specify its scaling with a geometry 714optionally specify its scaling with a geometry string B<WxH+X+Y>,
632string B<WxH+X+Y>, in which B<"W" / "H"> specify the 715(default C<0x0+50+50>) in which B<"W" / "H"> specify the
633horizontal/vertical scale (percent) and B<"X" / "Y"> locate the image 716horizontal/vertical scale (percent), and B<"X" / "Y"> locate the image
634centre (percent). A scale of 0 displays the image with tiling. A scale 717centre (percent). A scale of 0 displays the image with tiling. A scale
635of 1 displays the image without any scaling. A scale of 2 to 9 718of 1 displays the image without any scaling. A scale of 2 to 9 specifies
636specifies an integer number of images in that direction. No image will 719an integer number of images in that direction. No image will be magnified
637be magnified beyond 10 times its original size. The maximum permitted 720beyond 10 times its original size. The maximum permitted scale is 1000.
638scale is 1000. [default 0x0+50+50] 721Additional operations can be specified after colon B<:op1:op2...>.
722Supported operations are:
639 723
640=item B<menu:> I<file[;tag]> 724 tile force background image to be tiled and not scaled. Equivalent to 0x0,
725 propscale will scale image keeping proportions,
726 auto will scale image to match window size. Equivalent to 100x100;
727 hscale will scale image horizontally to the window size;
728 vscale will scale image vertically to the window size;
729 scale will scale image to match window size;
730 root will tile image as if it was a root window background, auto-adjusting
731 whenever terminal window moves.
641 732
642Read in the specified menu file (note the `.menu' extension is 733If used in conjunction with B<-tr> option, the specified pixmap will be
643optional) and also optionally specify a starting tag to find. See the 734blended over transparency image using either alpha-blending, or any
644reference documentation for details on the syntax for the menuBar. 735other blending type, specified with B<-blt "type"> option.
645 736
646=item B<path:> I<path> 737=item B<path:> I<path>
647 738
648Specify the colon-delimited search path for finding files (XPM and 739Specify the colon-delimited search path for finding background image files.
649menus), in addition to the paths specified by the B<RXVTPATH> and
650B<PATH> environment variables.
651 740
652=item B<font:> I<fontlist> 741=item B<font:> I<fontlist>
653 742
654Select the fonts to be used. This is a comma separated list of font 743Select the fonts to be used. This is a comma separated list of font names
655names that are used in turn when trying to display Unicode characters. 744that are checked in order when trying to find glyphs for characters. The
656The first font defines the cell size for characters; other fonts might 745first font defines the cell size for characters; other fonts might be
657be smaller, but not larger. A reasonable default font list is always 746smaller, but not (in general) larger. A (hopefully) reasonable default
658appended to it; option B<-fn>. 747font list is always appended to it; option B<-fn>.
659 748
660Each font can either be a standard X11 core font (XLFD) name, with 749Each font can either be a standard X11 core font (XLFD) name, with
661optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>. 750optional prefix C<x:> or a Xft font (Compile I<xft>), prefixed with C<xft:>.
662 751
663In addition, each font can be prefixed with additional hints and 752In addition, each font can be prefixed with additional hints and
665hint currently is C<codeset=codeset-name>, and this is only used for Xft 754hint currently is C<codeset=codeset-name>, and this is only used for Xft
666fonts. 755fonts.
667 756
668For example, this font resource 757For example, this font resource
669 758
670 URxvt*font: 9x15bold,\ 759 URxvt.font: 9x15bold,\
671 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\ 760 -misc-fixed-bold-r-normal--15-140-75-75-c-90-iso10646-1,\
672 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \ 761 -misc-fixed-medium-r-normal--15-140-75-75-c-90-iso10646-1, \
673 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \ 762 [codeset=JISX0208]xft:Kochi Gothic:antialias=false, \
674 xft:Code2000:antialias=false 763 xft:Code2000:antialias=false
675 764
713 802
714=item B<intensityStyles:> I<boolean> 803=item B<intensityStyles:> I<boolean>
715 804
716When font styles are not enabled, or this option is enabled (B<True>, 805When font styles are not enabled, or this option is enabled (B<True>,
717option B<-is>, the default), bold and italic font styles imply high 806option B<-is>, the default), bold and italic font styles imply high
718intensity foreground/backround colours. Disabling this option (B<False>, 807intensity foreground/background colours. Disabling this option (B<False>,
719option B<+is>) disables this behaviour, the high intensity colours are not 808option B<+is>) disables this behaviour, the high intensity colours are not
720reachable. 809reachable.
721 810
722=item B<selectstyle:> I<mode> 811=item B<selectstyle:> I<mode>
723 812
724Set mouse selection style to B<old> which is 2.20, B<oldword> which is 813Set mouse selection style to B<old> which is 2.20, B<oldword> which
725xterm style with 2.20 old word selection, or anything else which gives 814is xterm style with 2.20 old word selection, or anything else which
726xterm style selection. 815gives xterm style selection. Only effective when the original (non-perl)
816selection code is in use.
727 817
728=item B<scrollstyle:> I<mode> 818=item B<scrollstyle:> I<mode>
729 819
730Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is 820Set scrollbar style to B<rxvt>, B<plain>, B<next> or B<xterm>. B<plain> is
731the author's favourite. 821the author's favourite.
745=item B<mapAlert:> I<boolean> 835=item B<mapAlert:> I<boolean>
746 836
747B<True>: de-iconify (map) on receipt of a bell character. B<False>: no 837B<True>: de-iconify (map) on receipt of a bell character. B<False>: no
748de-iconify (map) on receipt of a bell character [default]. 838de-iconify (map) on receipt of a bell character [default].
749 839
840=item B<urgentOnBell:> I<boolean>
841
842B<True>: set the urgency hint for the wm on receipt of a bell character.
843B<False>: do not set the urgency hint [default].
844
750=item B<visualBell:> I<boolean> 845=item B<visualBell:> I<boolean>
751 846
752B<True>: use visual bell on receipt of a bell character; option B<-vb>. 847B<True>: use visual bell on receipt of a bell character; option B<-vb>.
753B<False>: no visual bell [default]; option B<+vb>. 848B<False>: no visual bell [default]; option B<+vb>.
754 849
772 867
773The string will be interpreted as if typed into the shell as-is. 868The string will be interpreted as if typed into the shell as-is.
774 869
775Example: 870Example:
776 871
777 URxvt*print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX) 872 URxvt.print-pipe: cat > $(TMPDIR=$HOME mktemp urxvt.XXXXXX)
778 873
779This creates a new file in your home directory with the screen contents 874This creates a new file in your home directory with the screen contents
780everytime you hit C<Print>. 875every time you hit C<Print>.
781 876
782=item B<scrollBar:> I<boolean> 877=item B<scrollBar:> I<boolean>
783 878
784B<True>: enable the scrollbar [default]; option B<-sb>. B<False>: 879B<True>: enable the scrollbar [default]; option B<-sb>. B<False>:
785disable the scrollbar; option B<+sb>. 880disable the scrollbar; option B<+sb>.
807 902
808=item B<scrollWithBuffer:> I<boolean> 903=item B<scrollWithBuffer:> I<boolean>
809 904
810B<True>: scroll with scrollback buffer when tty receives new lines (and 905B<True>: scroll with scrollback buffer when tty receives new lines (and
811B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll 906B<scrollTtyOutput> is False); option B<-sw>. B<False>: do not scroll
812with scrollback buffer when tty recieves new lines; option B<+sw>. 907with scrollback buffer when tty receives new lines; option B<+sw>.
813 908
814=item B<scrollTtyKeypress:> I<boolean> 909=item B<scrollTtyKeypress:> I<boolean>
815 910
816B<True>: scroll to bottom when a non-special key is pressed. Special keys 911B<True>: scroll to bottom when a non-special key is pressed. Special keys
817are those which are intercepted by rxvt-unicode for special handling and 912are those which are intercepted by rxvt-unicode for special handling and
848=item B<termName:> I<termname> 943=item B<termName:> I<termname>
849 944
850Specifies the terminal type name to be set in the B<TERM> environment 945Specifies the terminal type name to be set in the B<TERM> environment
851variable; option B<-tn>. 946variable; option B<-tn>.
852 947
853=item B<linespace:> I<number> 948=item B<lineSpace:> I<number>
854 949
855Specifies number of lines (pixel height) to insert between each row of 950Specifies number of lines (pixel height) to insert between each row of
856the display [default 0]; option B<-lsp>. 951the display [default 0]; option B<-lsp>.
857 952
858=item B<meta8:> I<boolean> 953=item B<meta8:> I<boolean>
907pressed. If unset it will send the sequence traditionally associated 1002pressed. If unset it will send the sequence traditionally associated
908with the B<Execute> key. 1003with the B<Execute> key.
909 1004
910=item B<cutchars:> I<string> 1005=item B<cutchars:> I<string>
911 1006
912The characters used as delimiters for double-click word selection. The 1007The characters used as delimiters for double-click word selection
913built-in default: 1008(whitespace delimiting is added automatically if resource is given).
914 1009
1010When the perl selection extension is in use (the default if compiled
1011in, see the @@RXVT_NAME@@perl(3) manpage), a suitable regex using these
1012characters will be created (if the resource exists, otherwise, no regex
1013will be created). In this mode, characters outside ISO-8859-1 can be used.
1014
1015When the selection extension is not used, only ISO-8859-1 characters can
1016be used. If not specified, the built-in default is used:
1017
915B<< BACKSLASH `"'&()*,;<=>?@[]{|} >> 1018B<< BACKSLASH `"'&()*,;<=>?@[]^{|} >>
916 1019
917=item B<preeditType:> I<style> 1020=item B<preeditType:> I<style>
918 1021
919B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>. 1022B<OverTheSpot>, B<OffTheSpot>, B<Root>; option B<-pt>.
920 1023
954default. (Note that many other terminals, including xterm, have these 1057default. (Note that many other terminals, including xterm, have these
955sequences enabled by default, which doesn't make it safer, though). 1058sequences enabled by default, which doesn't make it safer, though).
956 1059
957You can enable them by setting this boolean resource or specifying 1060You can enable them by setting this boolean resource or specifying
958B<-insecure> as an option. At the moment, this enables display-answer, 1061B<-insecure> as an option. At the moment, this enables display-answer,
959locale, findfont, icon label and window title requests as well as dynamic 1062locale, findfont, icon label and window title requests.
960menubar dispatch.
961 1063
962=item B<modifier:> I<modifier> 1064=item B<modifier:> I<modifier>
963 1065
964Set the key to be interpreted as the Meta key to: B<alt>, B<meta>, 1066Set the key to be interpreted as the Meta key to: B<alt>, B<meta>,
965B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option 1067B<hyper>, B<super>, B<mod1>, B<mod2>, B<mod3>, B<mod4>, B<mod5>; option
969 1071
970Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E) 1072Specify the reply rxvt-unicode sends to the shell when an ENQ (control-E)
971character is passed through. It may contain escape values as described 1073character is passed through. It may contain escape values as described
972in the entry on B<keysym> following. 1074in the entry on B<keysym> following.
973 1075
974=item B<secondaryScreen:> I<bool> 1076=item B<secondaryScreen:> I<boolean>
975 1077
976Turn on/off secondary screen (default enabled). 1078Turn on/off secondary screen (default enabled).
977 1079
978=item B<secondaryScroll:> I<bool> 1080=item B<secondaryScroll:> I<boolean>
979 1081
980Turn on/off secondary screen scroll (default enabled). If the this 1082Turn on/off secondary screen scroll (default enabled). If this
981option is enabled, scrolls on the secondary screen will change the 1083option is enabled, scrolls on the secondary screen will change the
982scrollback buffer and switching to/from the secondary screen will 1084scrollback buffer and switching to/from the secondary screen will
983instead scroll the screen up. 1085instead scroll the screen up.
984 1086
985=item B<hold>: I<bool> 1087=item B<hold>: I<boolean>
986 1088
987Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@ 1089Turn on/off hold window after exit support. If enabled, @@RXVT_NAME@@
988will not immediately destroy its window when the program executed within 1090will not immediately destroy its window when the program executed within
989it exits. Instead, it will wait till it is being killed or closed by the 1091it exits. Instead, it will wait till it is being killed or closed by the
990user. 1092user.
1009searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and 1111searching keysym macros from B</usr/X11R6/include/X11/keysymdef.h> and
1010omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex 1112omitting the prefix B<XK_>. Alternatively you can specify I<key> by its hex
1011keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not 1113keysym value (B<0x0000 - 0xFFFF>). Note that the lookup of I<sym>s is not
1012performed in an exact manner; however, the closest match is assured. 1114performed in an exact manner; however, the closest match is assured.
1013 1115
1014I<string> may contain escape values (C<\a>: bell, C<\b>: backspace, 1116I<string> may contain escape values (C<\n>: newline, C<\000>: octal
1015C<\e>, C<\E>: escape, C<\n>: newline, C<\r>: carriage return, C<\t>: tab, 1117number), see RESOURCES in C<man 7 X> for futher details.
1016C<\000>: octal number) or verbatim control characters (C<^?>: delete,
1017C<^@>: null, C<^A> ...) and may be enclosed with double quotes so that it
1018can start or end with whitespace.
1019
1020Please note that you need to double the C<\> when using
1021C<--enable-xgetdefault>, as X itself does it's own de-escaping (you can
1022use C<\033> instead of C<\e> (and so on), which will work with both Xt and
1023@@RXVT_NAME@@'s own processing).
1024 1118
1025You can define a range of keysyms in one shot by providing a I<string> 1119You can define a range of keysyms in one shot by providing a I<string>
1026with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimeter `/' 1120with pattern B<list/PREFIX/MIDDLE/SUFFIX>, where the delimiter `/'
1027should be a character not used by the strings. 1121should be a character not used by the strings.
1028 1122
1029Its usage can be demonstrated by an example: 1123Its usage can be demonstrated by an example:
1030 1124
1031 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|> 1125 URxvt.keysym.M-C-0x61: list|\033<M-C-|abc|>
1088 1182
1089Comma-separated list(s) of perl extension scripts (default: C<default>) to 1183Comma-separated list(s) of perl extension scripts (default: C<default>) to
1090use in this terminal instance; option B<-pe>. 1184use in this terminal instance; option B<-pe>.
1091 1185
1092Extension names can be prefixed with a C<-> sign to prohibit using 1186Extension names can be prefixed with a C<-> sign to prohibit using
1093it. This can be useful to selectively disable some extensions loaded 1187them. This can be useful to selectively disable some extensions loaded
1094by default, or specified via the C<perl-ext-common> resource. For 1188by default, or specified via the C<perl-ext-common> resource. For
1095example, C<default,-selection> will use all the default extension except 1189example, C<default,-selection> will use all the default extension except
1096C<selection>. 1190C<selection>.
1191
1192Extension names can also be followed by an argument in angle brackets
1193(e.g. C<< searchable-scrollback<M-s> >>, which binds the hotkey for
1194searchable scrollback to Alt/Meta-s). Mentioning the same extension
1195multiple times with different arguments will pass multiple arguments to
1196the extension.
1097 1197
1098Each extension is looked up in the library directories, loaded if 1198Each extension is looked up in the library directories, loaded if
1099necessary, and bound to the current terminal instance. 1199necessary, and bound to the current terminal instance.
1100 1200
1101If both of these resources are the empty string, then the perl 1201If both of these resources are the empty string, then the perl
1116@@RXVT_NAME@@ will first look in these directories and then in 1216@@RXVT_NAME@@ will first look in these directories and then in
1117F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource 1217F<@@RXVT_LIBDIR@@/urxvt/perl/>. Due to security reasons, this resource
1118will be ignored when running setuid/setgid. 1218will be ignored when running setuid/setgid.
1119 1219
1120See the @@RXVT_NAME@@perl(3) manpage. 1220See the @@RXVT_NAME@@perl(3) manpage.
1221
1222=item B<< selection.pattern-I<idx> >>: I<perl-regex>
1223
1224Additional selection patterns, see the @@RXVT_NAME@@perl(3) manpage for
1225details.
1226
1227=item B<< selection-autotransform.I<idx> >>: I<perl-transform>
1228
1229Selection auto-transform patterns, see the @@RXVT_NAME@@perl(3) manpage
1230for details.
1231
1232=item B<searchable-scrollback:> I<keysym>
1233
1234Sets the hotkey that starts the incremental scrollback buffer search
1235(default: C<M-s>).
1236
1237=item B<urlLauncher>: I<string>
1238
1239Specifies the program to be started with a URL argument. Used by the
1240C<selection-popup> and C<matcher> perl extensions.
1241
1242=item B<transient-for>: I<windowid>
1243
1244Compile I<frills>: Sets the WM_TRANSIENT_FOR property to the given window id.
1245
1246=item B<override-redirect>: I<boolean>
1247
1248Compile I<frills>: Sets override-redirect for the terminal window, making
1249it almost invisible to window managers; option B<-override-redirect>.
1250
1251=item B<iso14755_52:> I<boolean>
1252
1253Turn on/off ISO 14755 5.2 mode (default enabled).
1121 1254
1122=back 1255=back
1123 1256
1124=head1 THE SCROLLBAR 1257=head1 THE SCROLLBAR
1125 1258
1144application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~> 1277application. Instead, pressing Button1 and Button3 sends B<ESC [ 6 ~>
1145(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the 1278(Next) and B<ESC [ 5 ~> (Prior), respectively. Similarly, clicking on the
1146up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down), 1279up and down arrows sends B<ESC [ A> (Up) and B<ESC [ B> (Down),
1147respectively. 1280respectively.
1148 1281
1149=head1 TEXT SELECTION AND INSERTION 1282=head1 THE SELECTION: SELECTING AND PASTING TEXT
1150 1283
1151The behaviour of text selection and insertion mechanism is similar to 1284The behaviour of text selection and insertion/pasting mechanism is similar
1152I<xterm>(1). 1285to I<xterm>(1).
1153 1286
1154=over 4 1287=over 4
1155 1288
1156=item B<Selection>: 1289=item B<Selecting>:
1157 1290
1158Left click at the beginning of the region, drag to the end of the region 1291Left click at the beginning of the region, drag to the end of the region
1159and release; Right click to extend the marked region; Left double-click 1292and release; Right click to extend the marked region; Left double-click
1160to select a word; Left triple-click to select the entire logical line 1293to select a word; Left triple-click to select the entire logical line
1161(which can span multiple screen lines), unless modified by resource 1294(which can span multiple screen lines), unless modified by resource
1165(Compile: I<frills>) will create a rectangular selection instead of a 1298(Compile: I<frills>) will create a rectangular selection instead of a
1166normal one. In this mode, every selected row becomes its own line in the 1299normal one. In this mode, every selected row becomes its own line in the
1167selection, and trailing whitespace is visually underlined and removed from 1300selection, and trailing whitespace is visually underlined and removed from
1168the selection. 1301the selection.
1169 1302
1170=item B<Insertion>: 1303=item B<Pasting>:
1171 1304
1172Pressing and releasing the Middle mouse button (or B<Shift-Insert>) in 1305Pressing and releasing the Middle mouse button in an B<@@RXVT_NAME@@>
1173an B<@@RXVT_NAME@@> window causes the current text selection to be 1306window causes the value of the PRIMARY selection (or CLIPBOARD with the
1174inserted as if it had been typed on the keyboard. 1307B<Meta> modifier) to be inserted as if it had been typed on the keyboard.
1308
1309Pressing B<Shift-Insert> causes the value of the PRIMARY selection to be
1310inserted too.
1175 1311
1176=back 1312=back
1177 1313
1178=head1 CHANGING FONTS 1314=head1 CHANGING FONTS
1179 1315
1180Changing fonts (or font sizes, respectively) via the keypad is not yet 1316Changing fonts (or font sizes, respectively) via the keypad is not yet
1181supported in rxvt-unicode. Bug me if you need this. 1317supported in rxvt-unicode. Bug me if you need this.
1182 1318
1183You can, however, switch fonts at runtime using escape sequences (and 1319You can, however, switch fonts at runtime using escape sequences, e.g.:
1184therefore using the menubar), e.g.:
1185 1320
1186 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic" 1321 printf '\e]710;%s\007' "9x15bold,xft:Kochi Gothic"
1322
1323You can use keyboard shortcuts, too:
1324
1325 URxvt.keysym.M-C-1: command:\033]710;suxuseuro\007\033]711;suxuseuro\007
1326 URxvt.keysym.M-C-2: command:\033]710;9x15bold\007\033]711;9x15bold\007
1187 1327
1188rxvt-unicode will automatically re-apply these fonts to the output so far. 1328rxvt-unicode will automatically re-apply these fonts to the output so far.
1189 1329
1190=head1 ISO 14755 SUPPORT 1330=head1 ISO 14755 SUPPORT
1191 1331
1192ISO 14755 is a standard for entering and viewing unicode characters 1332ISO 14755 is a standard for entering and viewing unicode characters
1193and character codes using the keyboard. It consists of 4 parts. The 1333and character codes using the keyboard. It consists of 4 parts. The
1194first part is available rxvt-unicode has been compiled with 1334first part is available if rxvt-unicode has been compiled with
1195C<--enable-frills>, the rest is available when rxvt-unicode was compiled 1335C<--enable-frills>, the rest is available when rxvt-unicode was compiled
1196with C<--enable-iso14755>. 1336with C<--enable-iso14755>.
1197 1337
1198=over 4 1338=over 4
1199 1339
1219This mode lets you input characters representing the keycap symbols of 1359This mode lets you input characters representing the keycap symbols of
1220your keyboard, if representable in the current locale encoding. 1360your keyboard, if representable in the current locale encoding.
1221 1361
1222Start by pressing C<Control> and C<Shift> together, then releasing 1362Start by pressing C<Control> and C<Shift> together, then releasing
1223them. The next special key (cursor keys, home etc.) you enter will not 1363them. The next special key (cursor keys, home etc.) you enter will not
1224invoke it's usual function but instead will insert the corresponding 1364invoke its usual function but instead will insert the corresponding
1225keycap symbol. The symbol will only be entered when the key has been 1365keycap symbol. The symbol will only be entered when the key has been
1226released, otherwise pressing e.g. C<Shift> would enter the symbol for 1366released, otherwise pressing e.g. C<Shift> would enter the symbol for
1227C<ISO Level 2 Switch>, although your intention might have been to enter a 1367C<ISO Level 2 Switch>, although your intention might have been to enter a
1228reverse tab (Shift-Tab). 1368reverse tab (Shift-Tab).
1229 1369
1262=head1 COLORS AND GRAPHICS 1402=head1 COLORS AND GRAPHICS
1263 1403
1264In addition to the default foreground and background colours, 1404In addition to the default foreground and background colours,
1265B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus 1405B<@@RXVT_NAME@@> can display up to 16 colours (8 ANSI colours plus
1266high-intensity bold/blink versions of the same). Here is a list of the 1406high-intensity bold/blink versions of the same). Here is a list of the
1267colours with their B<rgb.txt> names. 1407colours with their names.
1268 1408
1269=begin table 1409=begin table
1270 1410
1271 B<color0> (black) = Black 1411 B<color0> (black) = Black
1272 B<color1> (red) = Red3 1412 B<color1> (red) = Red3
1292It is also possible to specify the colour values of B<foreground>, 1432It is also possible to specify the colour values of B<foreground>,
1293B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as 1433B<background>, B<cursorColor>, B<cursorColor2>, B<colorBD>, B<colorUL> as
1294a number 0-15, as a convenient shorthand to reference the colour name of 1434a number 0-15, as a convenient shorthand to reference the colour name of
1295color0-color15. 1435color0-color15.
1296 1436
1437In addition to the colours defined above, @@RXVT_NAME@@ offers an
1438additional 72 colours. The first 64 of those (with indices 16 to 79)
1439consist of a 4*4*4 RGB colour cube (i.e. I<index = r * 16 + g * 4 + b +
144016>), followed by 8 additional shades of gray (with indices 80 to 87).
1441
1442Together, all those colours implement the 88 colour xterm colours. Only
1443the first 16 can be changed using resources currently, the rest can only
1444be changed via command sequences ("escape codes").
1445
1297Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by 1446Note that B<-rv> (B<"reverseVideo: True">) simulates reverse video by
1298always swapping the foreground/background colours. This is in contrast to 1447always swapping the foreground/background colours. This is in contrast to
1299I<xterm>(1) where the colours are only swapped if they have not otherwise 1448I<xterm>(1) where the colours are only swapped if they have not otherwise
1300been specified. For example, 1449been specified. For example,
1301 1450
1306would yield White on Black, while on I<xterm>(1) it would yield Black 1455would yield White on Black, while on I<xterm>(1) it would yield Black
1307on White. 1456on White.
1308 1457
1309=back 1458=back
1310 1459
1460=head2 ALPHA CHANNEL SUPPORT
1461
1462If Xft support has been compiled in and as long as Xft/Xrender/X don't get
1463their act together, rxvt-unicode will support C<rgba:rrrr/gggg/bbbb/aaaa>
1464(recommended, but B<MUST> have 4 digits/component) colour specifications,
1465in addition to the ones provided by X, where the additional A component
1466specifies opacity (alpha) values. The minimum value of C<0> is completely
1467transparent). You can also prefix any color with C<[percent]>, where
1468C<percent> is a decimal percentage (0-100) that specifies the opacity of
1469the color, where C<0> is completely transparent and C<100> is completelxy
1470opaque.
1471
1472You probably need to specify B<"-depth 32">, too, and have the luck that
1473your X-server uses ARGB pixel layout, as X is far from just supporting
1474ARGB visuals out of the box, and rxvt-unicode just fudges around.
1475
1476For example, the following selects an almost completely transparent red
1477background, and an almost opaque pink foreground:
1478
1479 @@RXVT_NAME@@ -depth 32 -bg rgba:0000/0000/0000/aaaa -fg "[80]pink"
1480
1481I<Please note that transparency of any kind if completely unsupported by
1482the author. Don't bug him with installation questions!>
1483
1311=head1 ENVIRONMENT 1484=head1 ENVIRONMENT
1312 1485
1313B<@@RXVT_NAME@@> sets and/or uses the following environment variables: 1486B<@@RXVT_NAME@@> sets and/or uses the following environment variables:
1314 1487
1315=over 4 1488=over 4
1316 1489
1317=item B<TERM> 1490=item B<TERM>
1318 1491
1319Normally set to C<rxvt-unicode>, unless overwritten at configure time, via 1492Normally set to C<rxvt-unicode>, unless overwritten at configure time, via
1320resources or on the commandline. 1493resources or on the command line.
1321 1494
1322=item B<COLORTERM> 1495=item B<COLORTERM>
1323 1496
1324Either C<rxvt>, C<rxvt-xpm>, depending on wether @@RXVT_NAME@@ was 1497Either C<rxvt>, C<rxvt-xpm>, depending on whether @@RXVT_NAME@@ was
1325compiled with XPM support, and optionally with the added extension 1498compiled with background image support, and optionally with the added
1326C<-mono> to indicate that rxvt-unicode runs on a monochrome screen. 1499extension C<-mono> to indicate that rxvt-unicode runs on a monochrome
1500screen.
1327 1501
1328=item B<COLORFGBG> 1502=item B<COLORFGBG>
1329 1503
1330Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is 1504Set to a string of the form C<fg;bg> or C<fg;xpm;bg>, where C<fg> is
1331the colour code used as default foreground/text colour (or the string 1505the colour code used as default foreground/text colour (or the string
1332C<default> to indicate that the default-colour escape sequence is to be 1506C<default> to indicate that the default-colour escape sequence is to be
1333used), C<bg> is the colour code used as default background colour (or the 1507used), C<bg> is the colour code used as default background colour (or the
1334string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@ 1508string C<default>), and C<xpm> is the string C<default> if @@RXVT_NAME@@
1335was compiled with XPM support. Libraries like C<ncurses> and C<slang> can 1509was compiled with background image support. Libraries like C<ncurses>
1336(and do) use this information to optimize screen output. 1510and C<slang> can (and do) use this information to optimize screen output.
1337 1511
1338=item B<WINDOWID> 1512=item B<WINDOWID>
1339 1513
1340Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel 1514Set to the (decimal) X Window ID of the @@RXVT_NAME@@ window (the toplevel
1341window, which usually has subwindows for the scrollbar, the terminal 1515window, which usually has subwindows for the scrollbar, the terminal
1347C<--with-terminfo=PATH>. 1521C<--with-terminfo=PATH>.
1348 1522
1349=item B<DISPLAY> 1523=item B<DISPLAY>
1350 1524
1351Used by @@RXVT_NAME@@ to connect to the display and set to the correct 1525Used by @@RXVT_NAME@@ to connect to the display and set to the correct
1352display in it's child processes. 1526display in its child processes.
1353 1527
1354=item B<SHELL> 1528=item B<SHELL>
1355 1529
1356The shell to be used for command execution, defaults to C</bin/sh>. 1530The shell to be used for command execution, defaults to C</bin/sh>.
1357
1358=item B<RXVTPATH>
1359
1360The path where @@RXVT_NAME@@ looks for support files such as menu and xpm
1361files.
1362
1363=item B<PATH>
1364
1365Used in the same way as C<RXVTPATH>.
1366 1531
1367=item B<RXVT_SOCKET> 1532=item B<RXVT_SOCKET>
1368 1533
1369The unix domain socket path used by @@RXVT_NAME@@c(1) and 1534The unix domain socket path used by @@RXVT_NAME@@c(1) and
1370@@RXVT_NAME@@d(1). 1535@@RXVT_NAME@@d(1).
1408 1573
1409=item Project Coordinator 1574=item Project Coordinator
1410 1575
1411Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >> 1576Marc A. Lehmann L<< <rxvt-unicode@schmorp.de> >>
1412 1577
1413L<http://software.schmorp.de/#rxvt-unicode> 1578L<http://software.schmorp.de/pkg/rxvt-unicode.html>
1414 1579
1415=back 1580=back
1416 1581
1417=head1 AUTHORS 1582=head1 AUTHORS
1418 1583
1440 1605
1441Project Coordinator (changes.txt 2.21a to 2.4.5) 1606Project Coordinator (changes.txt 2.21a to 2.4.5)
1442 1607
1443=item Geoff Wing L<< <gcw@pobox.com> >> 1608=item Geoff Wing L<< <gcw@pobox.com> >>
1444 1609
1445Rewrote screen display and text selection routines. Project Coordinator 1610Rewrote screen display and text selection routines.
1611
1446(changes.txt 2.4.6 - rxvt-unicode) 1612Project Coordinator (changes.txt 2.4.6 - rxvt-unicode)
1447 1613
1448=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >> 1614=item Marc Alexander Lehmann L<< <rxvt-unicode@schmorp.de> >>
1449 1615
1450Forked rxvt-unicode, rewrote most of the display code and internal 1616Forked rxvt-unicode, unicode support, rewrote almost all the code, perl
1451character handling to store text in unicode, improve xterm 1617extension, random hacks, numerous bugfixes and extensions.
1452compatibility and apply numerous other bugfixes and extensions.
1453 1618
1454Project Coordinator (Changes 1.0 -) 1619Project Coordinator (Changes 1.0 -)
1455 1620
1621=item Emanuele Giaquinta L<< <e.giaquinta@glauco.it> >>
1622
1623Pty/tty/utmp/wtmp rewrite, lots of random hacking and bugfixing.
1624
1456=back 1625=back
1457 1626

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines