Go to file
HenrikBrixAndersen 15424d405b Add wish about not using 'cp -a' 2008-08-13 15:28:33 -04:00
Bundle
IkiWiki
cpan
debian
doc Add wish about not using 'cp -a' 2008-08-13 15:28:33 -04:00
plugins
po
t
templates
underlays
.gitignore update ignore 2008-07-26 23:04:54 -04:00
.perlcriticrc
CHANGELOG
IkiWiki.pm
Makefile.PL
NEWS
README
auto.setup
docwiki.setup
ikiwiki-makerepo
ikiwiki-mass-rebuild
ikiwiki-transition
ikiwiki-update-wikilist
ikiwiki-w3m.cgi * Support a w3mmode, which lets w3m run ikiwiki using its local CGI 2006-07-07 21:00:48 +00:00
ikiwiki.in
mdwn2man
pm_filter
wikilist Fix typo. 2007-04-09 23:54:32 +00:00

README

Use ./Makefile.PL to generate a Makefile, "make" will build the
documentation wiki and a man page, and "make install" will install ikiwiki.

A few special variables you can set while using the Makefile:

PROFILE=1 turns on profiling for the build of the doc wiki. Uses Devel::Profile

NOTAINT=0 turns on the taint flag in the ikiwiki program. (Not recommended
unless your perl is less buggy than mine -- see
http://bugs.debian.org/411786)

There are also other variables supported by MakeMaker, including PREFIX,
INSTALL_BASE, and DESTDIR. See ExtUtils::MakeMaker(3).

In particular, INSTALL_BASE is very useful if you want to install ikiwiki
to some other location, as it configures it to see the perl libraries
there. See `doc/tips/nearlyfreespeech.mdwn` for an example of using this to
install ikiwiki and its dependencies in a home directory.

All other documentation is in the ikiwiki documentation wiki, which is also
available online at <http://ikiwiki.info/>