summaryrefslogtreecommitdiff
path: root/README
blob: a4dc0d641dbfd7a7bf13995f5ef111f0977563aa (plain)
  1. Use ./Makefile.PL to generate a Makefile, "make" will build the
  2. documentation wiki and a man page, and "make install" will install ikiwiki.
  3. All other documentation is in the ikiwiki documentation wiki, which is also
  4. available online at <http://ikiwiki.info/>
  5. A few special variables you can set while using the Makefile:
  6. PROFILE=1 turns on profiling for the build of the doc wiki.
  7. (Uses Devel::NYTProf)
  8. NOTAINT=0 turns on the taint flag in the ikiwiki program. (Not recommended
  9. unless your perl is less buggy than mine -- see
  10. http://bugs.debian.org/411786)
  11. There are also other variables supported by MakeMaker, including PREFIX,
  12. INSTALL_BASE, and DESTDIR. See ExtUtils::MakeMaker(3).
  13. In particular, INSTALL_BASE is very useful if you want to install ikiwiki
  14. to some other location, as it configures it to see the perl libraries
  15. there. See `doc/tips/nearlyfreespeech.mdwn` for an example of using this to
  16. install ikiwiki and its dependencies in a home directory.