Add support for copying to clipboard (based on patch by Dana Jansens).
[dana/urxvt.git] / README.configure
index c9afe41..672f685 100644 (file)
@@ -1,15 +1,15 @@
 CONFIGURE OPTIONS
     General hint: if you get compile errors, then likely your configuration
     hasn't been tested well. Either try with "--enable-everything" or use
-    the default configuration (i.e. "--enable-xxx" or "--disable-xxx"). Of
-    course, you should always report when a combination doesn't work, so it
-    can be fixed. Marc Lehmann <rxvt@schmorp.de>.
+    the default configuration (i.e. no "--enable-xxx" or "--disable-xxx"
+    switches). Of course, you should always report when a combination
+    doesn't work, so it can be fixed. Marc Lehmann <rxvt@schmorp.de>.
 
     All
 
     --enable-everything
         Add (or remove) support for all non-multichoice options listed in
-        "./configure --help".
+        "./configure --help", except for "--enable-assert".
 
         You can specify this and then disable options you do not like by
         *following* this with the appropriate "--disable-..." arguments, or
@@ -36,13 +36,12 @@ CONFIGURE OPTIONS
         about 700kB), but it doesn't increase memory usage unless you use a
         font requiring one of these encodings.
 
-           all             all available codeset groups 
-           zh              common chinese encodings 
-           zh_ext          rarely used but very big chinese encodings 
-           jp              common japanese encodings 
-           jp_ext          rarely used but big japanese encodings 
-           kr              korean encodings 
-
+   all             all available codeset groups 
+   zh              common chinese encodings 
+   zh_ext          rarely used but very big chinese encodings 
+   jp              common japanese encodings 
+   jp_ext          rarely used but big japanese encodings 
+   kr              korean encodings 
     --enable-xim (default: on)
         Add support for XIM (X Input Method) protocol. This allows using
         alternative input methods (e.g. kinput2) and will also correctly set
@@ -88,7 +87,7 @@ CONFIGURE OPTIONS
         Use the given name as default application name when reading
         resources. Specify --with-res-name=rxvt to replace rxvt.
 
-    --with-res-class=CLASS /default: URxvt)
+    --with-res-class=CLASS (default: URxvt)
         Use the given class as default application class when reading
         resources. Specify --with-res-class=Rxvt to replace rxvt.
 
@@ -106,20 +105,29 @@ CONFIGURE OPTIONS
         at start of rxvt execution. This option requires --enable-utmp to
         also be specified.
 
-    --enable-xpm-background (default: on)
-        Add support for XPM background pixmaps.
+    --enable-afterimage (default: on)
+        Add support for libAfterImage to be used for transparency and
+        background images. It adds support for many file formats including
+        JPG, PNG, SVG, TIFF, GIF, XPM, BMP, ICO, XCF, TGA and AfterStep
+        image XML
+        (<http://www.afterstep.org/visualdoc.php?show=asimagexml>).
+
+        This option also adds such eye candy as blending an image over the
+        root background, as well as dynamic scaling and bluring of
+        background images.
+
+        Note that with this option enabled, rxvt's memory footprint might
+        increase by a few megabytes even if no extra features are used
+        (mostly due to third-party libraries used by libAI). Memory
+        footprint may somewhat be lowered if libAfterImage is configured
+        without support for SVG.
 
     --enable-transparency (default: on)
-        Add support for inheriting parent backgrounds thus giving a fake
-        transparency to the term.
+        Add support for backgrounds, creating illusion of transparency in
+        the term.
 
     --enable-fading (default: on)
-        Add support for fading the text when focus is lost (requires
-        "--enable-transparency").
-
-    --enable-tinting (default: on)
-        Add support for tinting of transparent backgrounds (requires
-        "--enable-transparency").
+        Add support for fading the text when focus is lost.
 
     --enable-rxvt-scroll (default: on)
         Add support for the original rxvt scrollbar.
@@ -130,15 +138,6 @@ CONFIGURE OPTIONS
     --enable-xterm-scroll (default: on)
         Add support for an Xterm-like scrollbar.
 
-    --enable-plain-scroll (default: on)
-        Add support for a very unobtrusive, plain-looking scrollbar that is
-        the favourite of the rxvt-unicode author, having used it for many
-        years.
-
-    --enable-ttygid (default: off)
-        Change tty device setting to group "tty" - only use this if your
-        system uses this type of security.
-
     --disable-backspace-key
         Removes any handling of the backspace key by us - let the X server
         do it.
@@ -172,10 +171,11 @@ CONFIGURE OPTIONS
           tripleclickwords (-tcw)
           settable insecure mode (-insecure)
           keysym remapping support
-          cursor blinking and underline cursor (-cb, -uc)
+          cursor blinking and underline cursor (-bc, -uc)
           XEmbed support (-embed)
           user-pty (-pty-fd)
           hold on exit (-hold)
+          compile in built-in block graphics
           skip builtin block graphics (-sbg)
           separate highlightcolor support (-hc)
 
@@ -195,14 +195,18 @@ CONFIGURE OPTIONS
           verbose X error handling
 
     --enable-iso14755 (default: on)
-        Enable extended ISO 14755 support (see rxvt(1), or doc/rxvt.1.txt).
-        Basic support (section 5.1) is enabled by "--enable-frills", while
-        support for 5.2, 5.3 and 5.4 is enabled with this switch.
+        Enable extended ISO 14755 support (see rxvt(1)). Basic support
+        (section 5.1) is enabled by "--enable-frills", while support for
+        5.2, 5.3 and 5.4 is enabled with this switch.
 
     --enable-keepscrolling (default: on)
         Add support for continual scrolling of the display when you hold the
         mouse button down on a scrollbar arrow.
 
+    --enable-selectionscrolling (default: on)
+        Add support for scrolling when the selection moves to the top or
+        bottom of the screen.
+
     --enable-mousewheel (default: on)
         Add support for scrolling via mouse wheel or buttons 4 & 5.
 
@@ -211,39 +215,33 @@ CONFIGURE OPTIONS
         accelerator) while the control key is held down. This option
         requires --enable-mousewheel to also be specified.
 
-    --disable-new-selection
-        Remove support for mouse selection style like that of xterm.
+    --enable-smart-resize (default: off)
+        Add smart growth/shrink behaviour when resizing. This should keep
+        the window corner which is closest to a corner of the screen in a
+        fixed position.
 
-    --enable-dmalloc (default: off)
-        Use Gray Watson's malloc - which is good for debugging See
-        <http://www.letters.com/dmalloc/> for details If you use either this
-        or the next option, you may need to edit src/Makefile after
-        compiling to point DINCLUDE and DLIB to the right places.
-
-        You can only use either this option and the following (should you
-        use either) .
-
-    --enable-dlmalloc (default: off)
-        Use Doug Lea's malloc - which is good for a production version See
-        <http://g.oswego.edu/dl/html/malloc.html> for details.
-
-    --enable-smart-resize (default: on)
-        Add smart growth/shrink behaviour when changing font size via hot
-        keys. This should keep the window corner which is closest to a
-        corner of the screen in a fixed position.
+    --enable-text-blink (default: on)
+        Add support for blinking text.
 
     --enable-pointer-blank (default: on)
         Add support to have the pointer disappear when typing or inactive.
 
     --enable-perl (default: on)
-        Enable an embedded perl interpreter. See the rxvtperl(3) manpage
-        (doc/rxvtperl.txt) for more info on this feature, or the files in
-        src/perl-ext/ for the extensions that are installed by default. The
-        perl interpreter that is used can be specified via the "PERL"
-        environment variable when running configure. Even when compiled in,
-        perl will *not* be initialised when all extensions have been
-        disabled "-pe "" --perl-ext-common """, so it should be safe to
-        enable from a resource standpoint.
+        Enable an embedded perl interpreter. See the rxvtperl(3) manpage for
+        more info on this feature, or the files in src/perl/ for the
+        extensions that are installed by default. The perl interpreter that
+        is used can be specified via the "PERL" environment variable when
+        running configure. Even when compiled in, perl will *not* be
+        initialised when all extensions have been disabled "-pe ""
+        --perl-ext-common """, so it should be safe to enable from a
+        resource standpoint.
+
+    --enable-assert (default: off)
+        Enables the assertions in the code, normally disabled. This switch
+        is only useful when developing rxvt-unicode.
+
+    --with-afterimage-config=DIR
+        Look for the libAfterImage config script in DIR.
 
     --with-name=NAME (default: urxvt)
         Set the basename for the installed binaries, resulting in "urxvt",
@@ -259,12 +257,3 @@ CONFIGURE OPTIONS
     --with-x
         Use the X Window System (pretty much default, eh?).
 
-    --with-xpm-includes=DIR
-        Look for the XPM includes in DIR.
-
-    --with-xpm-library=DIR
-        Look for the XPM library in DIR.
-
-    --with-xpm
-        Not needed - define via --enable-xpm-background.
-