updated branch; this is ready for review for inclusion in IkIWiki

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

diff --git a/doc/install.mdwn b/doc/install.mdwn
index 68f1c10dfd8e29a40cffe2c1e49ca4e476a628e1..48c11272b0e0ba9fdae6dff7f68a093c4e2212a7 100644 (file)
--- a/doc/install.mdwn
+++ b/doc/install.mdwn
@@ -1,6 +1,7 @@
-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.
+This page documents how to install ikiwiki if a prepackaged version is not
+available for your distribution, and you are faced with [[downloading|download]]
+the source and installing by hand. Ikiwiki should work on most unix-like
+systems.

 
 ## Dependencies
 
 
 ## Dependencies
 


@@ -10,45 +11,30 @@ Ikiwiki is a perl program, and needs a recent version of perl such as
 It's recommended you have a C compiler, as ikiwiki uses one to build
 wrappers.
 
 It's recommended you have a C compiler, as ikiwiki uses one to build
 wrappers.
 

-Ikiwiki requires the [[cpan Text::Markdown]], [[cpan URI]],
-[[cpan HTML::Parser]], [[cpan HTML::Template]], and [[cpan HTML::Scrubber]]
-perl modules be installed. It can also use a lot of other perl modules, if
+Ikiwiki requires the [[!cpan Text::Markdown::Discount]] (or 
+[[!cpan Text::Markdown]]), [[!cpan URI]],
+[[!cpan HTML::Parser]], [[!cpan HTML::Template]], [[!cpan YAML::XS]] and [[!cpan HTML::Scrubber]]
+perl modules be installed. 
+It can also use a lot of other perl modules, if

 they are available.
 
 Various [[plugins]] use other perl modules and utilities; see their individual
 documentation for details.
 
 they are available.
 
 Various [[plugins]] use other perl modules and utilities; see their individual
 documentation for details.
 

-## Debian
-
-The Debian packages depend on and recommend an appropriate set of packages,
-so just install ikiwiki using apt.
-
-## Fedora 7
-
-While Fedora 7 doesn't have an ikiwiki package, you can install needed
-perl modules using this command:
-
-       yum install perl-Text-Markdown perl-Mail-Sendmail perl-HTML-Scrubber \
-         perl-XML-Simple perl-TimeDate perl-HTML-Template perl-CGI-FormBuilder \
-         perl-CGI-Session perl-File-MimeInfo perl-gettext perl-Authen-Passphrase
-
-## macports
-
-IkiWiki can be installed [from macports](http://www.macports.org/ports.php?by=name&substr=ikiwiki)
-by running `sudo port install ikiwiki`.
-
-## Installing by hand
+### Installing dependencies by hand

 
 If you want to install by hand from the tarball, you should make sure that
 all the perl modules are installed. This is one way to install them, using
 
 If you want to install by hand from the tarball, you should make sure that
 all the perl modules are installed. This is one way to install them, using

-CPAN:
+CPAN to install modules from your local machine after you extract the ikiwiki tarball:

 
        PERL5LIB=`pwd` PERL_MM_USE_DEFAULT=1 perl -MCPAN -e 'CPAN::Shell->install("Bundle::IkiWiki")'
        PERL5LIB=`pwd` PERL_MM_USE_DEFAULT=1 perl -MCPAN -e 'CPAN::Shell->install("Bundle::IkiWiki::Extras")'
 
 
        PERL5LIB=`pwd` PERL_MM_USE_DEFAULT=1 perl -MCPAN -e 'CPAN::Shell->install("Bundle::IkiWiki")'
        PERL5LIB=`pwd` PERL_MM_USE_DEFAULT=1 perl -MCPAN -e 'CPAN::Shell->install("Bundle::IkiWiki::Extras")'
 

+## Installing ikiwiki by hand
+

 Then to build and install ikiwiki:
 
 Then to build and install ikiwiki:
 

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

        make
        make test # optional
        make install
        make
        make test # optional
        make install


@@ -57,5 +43,6 @@ If you're using a shared hosting provider, of the sort where you don't have
 root, you can still install ikiwiki. There are tutorials covering this for
 a few providers:
 
 root, you can still install ikiwiki. There are tutorials covering this for
 a few providers:
 

+

 * [[tips/NearlyFreeSpeech]]
 * [[tips/DreamHost]]
 * [[tips/NearlyFreeSpeech]]
 * [[tips/DreamHost]]