ikiwiki

Go to file

Joey Hess f0090d8c57 check generated pages in I considered not checking them in, or making the checkin configurable. However, then they would remain not checked in if edited by a user, which is probably not desired. Note that passing undef as the username/ip to rcs_commit_staged may not result in ideal behavior; the commit may seem to come from "anonymous" with some revision control systems. Most of them handle it a bit better and just have it come from whatever user is running the build.		2008-07-29 15:51:25 -04:00
Bundle	…
IkiWiki	…
cpan	…
debian	…
doc	…
plugins	…
po	…
t	…
templates	…
underlays	…
.gitignore	…
.perlcriticrc	…
CHANGELOG	…
IkiWiki.pm	…
Makefile.PL	…
NEWS	…
README	…
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	…

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/>