use toggles

[ikiwiki.git] / doc / install.mdwn

diff --git a/doc/install.mdwn b/doc/install.mdwn
index e8c94361cfc8792489a38a4b632e9d24aed72f53..ed6d499c5d65945254d9745807c67662ad2ed26b 100644 (file)
--- a/doc/install.mdwn
+++ b/doc/install.mdwn
@@ -1,9 +1,30 @@
-The easiest way to install ikiwiki is using the Debian package.
+The easiest way to install ikiwiki is using the Debian package, but you can
+also [[download]] the source and install it by hand. Ikiwiki should work on
+most unix-like systems.
 
-If you want to install from the tarball, you should make sure that the required perl modules are installed, then run:
+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).
 
-        perl Makefile.PL
-        make
-        make install
+Ikiwiki requires the [[cpan Text::MarkDown]], [[cpan URI]] and
+[[cpan HTML::Parser]] perl modules be installed, and also uses the
+following perl modules if available: 
+[[cpan CGI::Session]], [[cpan CGI::FormBuilder]] (version 3.02.02 or newer,
+but 3.0401 might be broken),
+[[cpan HTML::Template]], [[cpan Mail::Sendmail]], [[cpan Time::Duration]]
+[[cpan TimeDate]], [[cpan HTML::Scrubber]], [[cpan RPC::XML]],
+[[cpan XML::Simple]], [[cpan XML::Feed]], [[cpan File::MimeInfo]].
 
-See [[download]] for where to get it.
\ No newline at end of file
+The [[tla]] support also needs the [[cpan MailTools]] perl module.
+
+Various [[plugins]] use other libraries and utlities; see their individual
+documentation for details.
+
+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.