thirdparty/discount-2.2.6-patched/INSTALL

0001
0002                     HOW TO BUILD AND INSTALL DISCOUNT
0003
0004 1) Unpacking the distribution
0005
0006 The DISCOUNT sources are distributed in tarballs.  After extracting from
0007 the tarball, you should end up with all the source and build files in the
0008 directory
0009                 discount-(version)
0010
0011 2) Installing the distribution
0012
0013 DISCOUNT uses configure.sh to set itself up for compilation.   To run
0014 configure, just do ``./configure.sh'' and it will check your system for
0015 build dependencies and build makefiles for you.   If configure.sh finishes
0016 without complaint, you can then do a ``make'' to compile everything and a
0017 ``make install'' to install the binaries.
0018
0019 Configure.sh has a few options that can be set:
0020
0021 --src=DIR               where the source lives (.)
0022 --prefix=DIR            where to install the final product (/usr/local)
0023 --execdir=DIR           where to put executables (prefix/bin)
0024 --sbindir=DIR           where to put static executables (prefix/sbin)
0025 --confdir=DIR           where to put configuration information (/etc)
0026 --libdir=DIR            where to put libraries (prefix/lib)
0027 --libexecdir=DIR        where to put private executables
0028 --mandir=DIR            where to put manpages
0029 --with-amalloc          Use my paranoid malloc library to catch memory leaks
0030 --shared                Build shared libraries
0031 --debian-glitch         When mangling email addresses, do them deterministically
0032                         so the Debian regression tester won't complain
0033 --pkg-config            Build & install a pkg-config(1) .pc file for
0034                         the discount library.
0035 --h1-title              Have theme & mkd2html use the first h1 in a document
0036                         as the title if there's no pandoc header or title
0037                         specified on the command line.
0038 --cxx-binding           Wrap mkdio.h with (conditional) 'extern "C"' for c++
0039                         binding.
0040
0041 3) Testing
0042
0043 ``make test'' runs discount against a collection of test cases.
0044
0045
0046 4) Installing sample programs and manpages
0047
0048 The standard ``make install'' rule just installs the binaries. If you
0049 want to install the sample programs, they are installed with
0050 ``make install.samples'';  to install manpages, ``make install.man''.
0051 A shortcut to install everything is ``make install.everything''
0052
0053
0054 5) Assorted platform gotchas
0055
0056    1.  On NetBSD (version 8 for certain) running configure.sh by
0057        itself will result in logging output being mixed in with diagnostic
0058        output on the screen instead of having it written to config.log.
0059        If, instead, you do `ksh ./configure.sh`, it will be much less
0060        garbled (the shell defaults all fds > stderr to close on exec,
0061        so my redirecting stdout fails after the first subprocess.)
0062    2.  On 9Front (and maybe every other extant plan9 variant) the
0063        system mkfile sets the `T' flag in CFLAGS; there are several
0064        places where I typedef voids to opaque structure pointers and
0065        this makes the build die when it attempts to link anything.