improve

[git.ikiwiki.info.git] / doc / ikiwiki.setup

diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup
index a25d9f50ec18e19dab46e1fe86eb618b0ffb4123..af4e623149e44611d566c0e2b6f1543d2849dabb 100644 (file)
--- a/doc/ikiwiki.setup
+++ b/doc/ikiwiki.setup
@@ -1,6 +1,6 @@
 #!/usr/bin/perl
 # Configuration file for ikiwiki.
 #!/usr/bin/perl
 # Configuration file for ikiwiki.

-# Passing this to ikiwiki --setup will make ikiwiki generate wrappers and 
+# Passing this to ikiwiki --setup will make ikiwiki generate wrappers and

 # build the wiki.
 #
 # Remember to re-run ikiwiki --setup any time you edit this file.
 # build the wiki.
 #
 # Remember to re-run ikiwiki --setup any time you edit this file.


@@ -9,15 +9,16 @@ use IkiWiki::Setup::Standard {
        wikiname => "MyWiki",
        #adminuser => ["yourname", ],
        adminemail => 'me@example.org',
        wikiname => "MyWiki",
        #adminuser => ["yourname", ],
        adminemail => 'me@example.org',

-       
+

        # Be sure to customise these..
        srcdir => "/path/to/source",
        destdir => "/var/www/wiki",
        # Be sure to customise these..
        srcdir => "/path/to/source",
        destdir => "/var/www/wiki",

-       
+

        url => "http://example.org/wiki",
        cgiurl => "http://example.org/ikiwiki.cgi",
        #templatedir => "/usr/share/ikiwiki/templates",
        url => "http://example.org/wiki",
        cgiurl => "http://example.org/ikiwiki.cgi",
        #templatedir => "/usr/share/ikiwiki/templates",

-       
+       #underlaydir => "/usr/share/ikiwiki/basewiki",
+

        # Subversion stuff.
        #rcs => "svn",
        #historyurl => "http://svn.example.org/trunk/[[file]]",
        # Subversion stuff.
        #rcs => "svn",
        #historyurl => "http://svn.example.org/trunk/[[file]]",


@@ -70,7 +71,7 @@ use IkiWiki::Setup::Standard {
                #       notify => 1,
                #},
        ],
                #       notify => 1,
                #},
        ],

-       
+

        # Generate rss feeds for blogs?
        rss => 1,
        # Generate atom feeds for blogs?
        # Generate rss feeds for blogs?
        rss => 1,
        # Generate atom feeds for blogs?


@@ -93,7 +94,7 @@ use IkiWiki::Setup::Standard {
        syslog => 0,
        # To link to user pages in a subdirectory of the wiki.
        #userdir => "users",
        syslog => 0,
        # To link to user pages in a subdirectory of the wiki.
        #userdir => "users",

-       
+

        # To add plugins, list them here.
        #add_plugins => [qw{goodstuff openid search wikitext camelcase
        #                   htmltidy fortune sidebar map rst anonok}],
        # To add plugins, list them here.
        #add_plugins => [qw{goodstuff openid search wikitext camelcase
        #                   htmltidy fortune sidebar map rst anonok}],


@@ -103,15 +104,15 @@ use IkiWiki::Setup::Standard {
        # For use with the tag plugin, make all tags be located under a
        # base page.
        #tagbase => "tag",
        # For use with the tag plugin, make all tags be located under a
        # base page.
        #tagbase => "tag",

-       
-       # For use with the search plugin if your estseek.cgi is located 
+
+       # For use with the search plugin if your estseek.cgi is located

        # somewhere else.
        #estseek => "/usr/lib/estraier/estseek.cgi",
        # somewhere else.
        #estseek => "/usr/lib/estraier/estseek.cgi",

-       
+

        # For use with the openid plugin, to give an url to a page users
        # can use to signup for an OpenID.
        #openidsignup => "http://myopenid.com/",
        # For use with the openid plugin, to give an url to a page users
        # can use to signup for an OpenID.
        #openidsignup => "http://myopenid.com/",

-       
+

        # For use with the mirrorlist plugin, a list of mirrors.
        #mirrorlist => {
        #       mirror1 => "http://hostname1",
        # For use with the mirrorlist plugin, a list of mirrors.
        #mirrorlist => {
        #       mirror1 => "http://hostname1",