ikiwiki

Go to file

Joey Hess cdb8e968a1 add websetup to auto setup		2008-08-03 22:17:45 -04:00
Bundle	typo	2008-06-12 14:54:28 -04:00
IkiWiki	plugin enable/disable working and bugfixes	2008-08-03 22:16:38 -04:00
cpan	enhancesments for shared hosting	2008-05-05 14:51:26 -04:00
debian	remove description_html, add link	2008-08-03 14:36:17 -04:00
doc	Full po4a support!	2008-08-03 21:25:21 -04:00
plugins	scan hook works, remove NotImplemented exception	2008-03-21 19:17:00 -04:00
po	add advanced and basic modes	2008-08-03 14:57:24 -04:00
t	test skeleton.pm.example	2008-08-03 19:36:10 -04:00
templates	Escape HTML in Atom feed metadata rather than treating it as XHTML	2008-07-31 22:15:22 +01:00
underlays	add to basewiki	2008-07-02 18:20:54 -04:00
.gitignore	update ignore	2008-07-26 23:04:54 -04:00
.perlcriticrc	* Various minor fixes and stylistic improvements suggested by Perl::Critic.	2007-08-15 08:08:32 +00:00
CHANGELOG	…
IkiWiki.pm	reorg settings	2008-08-03 17:02:00 -04:00
Makefile.PL	don't install demo external plugins by default	2008-08-02 16:53:20 -04:00
NEWS	…
README	hype INSTALL_BASE more	2008-07-20 22:32:43 -04:00
auto.setup	add websetup to auto setup	2008-08-03 22:17:45 -04:00
docwiki.setup	wrappers option is not needed, obsolete	2008-07-27 16:39:25 -04:00
ikiwiki-makerepo	Bail if both srcdir and repository are not specified.	2008-08-03 14:21:43 -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	add new wiki to wikilist	2008-07-27 16:01:29 -04:00
ikiwiki-w3m.cgi	…
ikiwiki.in	checkconfig before wrapper setup	2008-07-27 01:52:36 -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/>