more PREFIX fun

[ikiwiki.git] / doc / install.mdwn

diff --git a/doc/install.mdwn b/doc/install.mdwn
index f65e1a227fd642d21b9473e7f6eafd8b8452ced4..029323adae22f71ed75806a4e2931a61f5853679 100644 (file)
--- a/doc/install.mdwn
+++ b/doc/install.mdwn
@@ -1,15 +1,27 @@
 The easiest way to install ikiwiki is using the Debian package.
 
-Ikiwiki requires [[MarkDown]] be installed, and also uses the following
-perl modules if available: `CGI::Session` `CGI::FormBuilder` (version
-3.02.02 or newer) `HTML::Template` `Mail::SendMail` `Time::Duration`
-`Date::Parse` (libtimedate-perl), `HTML::Scrubber`, `RPC::XML`,
-`XML::Simple`
+Ikiwiki is a perl program, and needs a recent version of perl such as
+5.8.8. (5.8.0 has been reported not to work).
 
-If you want to install from the tarball, you should make sure that the required perl modules are installed, then run:
+Ikiwiki requires [[MarkDown]] and the `HTML::Parser` perl module be
+installed, and also uses the following perl modules if available: 
+`CGI::Session` `CGI::FormBuilder` (version 3.02.02 or newer)
+`HTML::Template` `Mail::Sendmail` `Time::Duration` `Date::Parse`,
+`HTML::Scrubber`, `RPC::XML`, `XML::Simple`, `XML::Feed`.
 
-        perl Makefile.PL
+Various [[plugins]] use other libraries and utlities; see their individual
+documentation for details.
+
+If you're installing MarkDown by hand, note that it should be installed as
+`Markdown.pm` somewhere in perl's module search path, or alternately as
+`/usr/bin/markdown`. Ikiwiki will find it under either name.
+
+If you want to install from the tarball, you should make sure that the
+required perl modules are installed, then run:
+
+        perl Makefile.PL # PREFIX=/dir to install elsewhere
         make
+       make test # optional
         make install
 
 See [[download]] for where to get it.