use shell variables in setup and other updates

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

diff --git a/doc/install.mdwn b/doc/install.mdwn
index 0aa55fb0b7e9204cc35e547bcc90c53077b3cc3a..08a446fb85beae8c39b93d898615067d76e015ea 100644 (file)
--- a/doc/install.mdwn
+++ b/doc/install.mdwn
@@ -1,14 +1,28 @@
-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]] 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`
+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 the `Text::MarkDown`, `URI` and `HTML::Parser` perl
+modules 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`, `File::MimeInfo`.

 
 

-        perl Makefile.PL
+The [[tla]] support also needs the `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

+       make test # optional

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