Go to file
Joey Hess ed41d7c70f document 2008-07-26 12:47:54 -04:00
Bundle typo 2008-06-12 14:54:28 -04:00
IkiWiki add dumpsetup option; refactor 2008-07-26 12:46:31 -04:00
cpan enhancesments for shared hosting 2008-05-05 14:51:26 -04:00
debian attachment: Use relative paths when inserting links. 2008-07-25 19:22:29 -04:00
doc document 2008-07-26 12:47:54 -04:00
plugins scan hook works, remove NotImplemented exception 2008-03-21 19:17:00 -04:00
po fix feed urls 2008-07-25 16:16:44 -04:00
t add test data 2008-07-25 19:41:01 -04:00
templates link fixup on rename working 2008-07-23 19:12:05 -04:00
underlays add to basewiki 2008-07-02 18:22:49 -04:00
.gitignore .gitignore: Ignore build-stamp 2008-01-26 22:25:43 -08:00
.perlcriticrc * Various minor fixes and stylistic improvements suggested by Perl::Critic. 2007-08-15 08:08:32 +00:00
CHANGELOG * Work on firming up the plugin interface: 2006-09-09 22:50:27 +00:00
IkiWiki.pm fix feed urls 2008-07-25 16:16:44 -04:00
Makefile.PL use PERL 2008-06-02 12:14:09 -04:00
NEWS * Work on firming up the plugin interface: 2006-09-09 22:50:27 +00:00
README hype INSTALL_BASE more 2008-07-20 22:32:43 -04:00
docwiki.setup prefix_directives enabled in doc wiki, all preprocessor directives converted. (Simon McVittie) 2008-07-21 11:41:32 -04:00
ikiwiki-makerepo Also seed gitignore with recentchanges 2008-05-10 12:43:38 -04:00
ikiwiki-mass-rebuild fix two build bugs 2008-06-13 13:05:44 -04:00
ikiwiki-transition Fix aggregateinternal migration so it skips expired entries, and deletes output 2008-07-15 03:24:05 +01:00
ikiwiki-update-wikilist commit. 2007-09-06 00:32:11 +00:00
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 add dumpsetup option; refactor 2008-07-26 12:46:31 -04:00
mdwn2man improved period escape 2008-05-30 18:01:16 -04:00
pm_filter If PERL5LIB is set to the libdir when building ikiwiki, calculate and hardcode a proper 'use lib' statement anyway. This fixes a gotcha, since PERL5LIB won't work once ikiwiki is running via a wrapper or as a cgi. 2008-05-14 02:42:01 -04:00
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/>