web commit by http://joey.kitenet.net/

[git.ikiwiki.info.git] / doc / install.mdwn

diff --git a/doc/install.mdwn b/doc/install.mdwn
index d34de92b14e50a6c5baeef7ddcb97bee54e6fd54..ed6d499c5d65945254d9745807c67662ad2ed26b 100644 (file)
--- a/doc/install.mdwn
+++ b/doc/install.mdwn
@@ -1,21 +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.

 
 

-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`
+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'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.
+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]].
+
+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:
 
 
 If you want to install from the tarball, you should make sure that the
 required perl modules are installed, then run:
 

-        perl Makefile.PL
-        make
+       perl Makefile.PL # PREFIX=/dir to install elsewhere
+       make

        make test # optional
        make test # optional

-        make install
+       make install

 
 See [[download]] for where to get it.
 
 See [[download]] for where to get it.