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