Go to file
Joey Hess adc2eb3d8c Options set in the setup file are now immediatly loaded by ikiwiki -setup. This allows later switches to override them. Previously, setup file options overrode most command line options. 2008-08-06 01:58:04 -04:00
Bundle typo 2008-06-12 14:54:28 -04:00
IkiWiki Options set in the setup file are now immediatly loaded by ikiwiki -setup. This allows later switches to override them. Previously, setup file options overrode most command line options. 2008-08-06 01:58:04 -04:00
cpan enhancesments for shared hosting 2008-05-05 14:51:26 -04:00
debian Options set in the setup file are now immediatly loaded by ikiwiki -setup. This allows later switches to override them. Previously, setup file options overrode most command line options. 2008-08-06 01:58:04 -04:00
doc add ikiwiki-transition setupformat subcommand. 2008-08-05 20:40:49 -04:00
plugins add getsetup hook 2008-08-06 01:04:45 -04:00
po Options set in the setup file are now immediatly loaded by ikiwiki -setup. This allows later switches to override them. Previously, setup file options overrode most command line options. 2008-08-06 01:58:04 -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 * Work on firming up the plugin interface: 2006-09-09 22:50:27 +00:00
IkiWiki.pm Options set in the setup file are now immediatly loaded by ikiwiki -setup. This allows later switches to override them. Previously, setup file options overrode most command line options. 2008-08-06 01:58:04 -04:00
Makefile.PL don't install demo external plugins by default 2008-08-02 16:53:20 -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
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 add a guard against multiple cgi or rcs wrappers 2008-08-05 21:02:18 -04:00
ikiwiki-update-wikilist add new wiki to wikilist 2008-07-27 16:01:29 -04: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 Options set in the setup file are now immediatly loaded by ikiwiki -setup. This allows later switches to override them. Previously, setup file options overrode most command line options. 2008-08-06 01:58:04 -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/>