Go to file
William Uther 4f0ac7fe59 add underlay files for listdirectives
As was noted, 'listdirectives' didn't include the underlay files that make
it really worthwhile.  I've just gone through all the plugin
documentation, modified it to remove installation information and renamed
the files to match the directives rather than the plugins.  This can now
serve as useful underlay.

I've only gone through plugins in the 'plugins' dir.  I did not go through
the 'contrib' dir.
2008-09-11 17:05:19 -04:00
Bundle typo 2008-06-12 14:54:28 -04:00
IkiWiki change git hook description 2008-09-11 15:53:25 -04:00
cpan enhancesments for shared hosting 2008-05-05 14:51:26 -04:00
debian Improve error message if external plugin fails to load. Closes: #498458 2008-09-11 01:41:55 -04:00
doc thought 2008-09-11 16:15:22 -04:00
plugins add getsetup hook 2008-08-06 01:04:45 -04:00
po progress: New plugin to generate progress bars (willu) 2008-09-09 14:44:58 -04:00
t test skeleton.pm.example 2008-08-03 19:36:10 -04:00
templates avoid link fixup if page name stayed the same 2008-08-07 16:17:50 -04:00
underlays add underlay files for listdirectives 2008-09-11 17:05:19 -04:00
.gitignore update ignore 2008-07-26 23:04:54 -04:00
.perlcriticrc fix a common case typo 2008-08-12 15:48:44 -04:00
CHANGELOG * Work on firming up the plugin interface: 2006-09-09 22:50:27 +00:00
IkiWiki.pm Improve error message if external plugin fails to load. Closes: #498458 2008-09-11 01:41:55 -04:00
Makefile.PL Ignore failure to install files into /etc, in case install is running as non-root. 2008-08-29 15:53:46 -04:00
NEWS * Work on firming up the plugin interface: 2006-09-09 22:50:27 +00:00
README reformat 2008-09-09 20:24:59 -04:00
auto.setup put monotone dir name munging code in auto.setup 2008-08-22 21:19:53 -04:00
docwiki.setup wrappers option is not needed, obsolete 2008-07-27 16:39:25 -04:00
ikiwiki-makerepo put monotone dir name munging code in auto.setup 2008-08-22 21:19:53 -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 Avoid uninitialised value when --dumpsetup is used and no srcdir/destdir specified. 2008-09-08 19:21:45 -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.

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


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.