clarify

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

diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup
index 89a331790afca50c110ea465cd761e7903c73c17..bf1aa3703a41d8d48f1a66a98e849929947d5664 100644 (file)
--- a/doc/ikiwiki.setup
+++ b/doc/ikiwiki.setup
@@ -1,7 +1,7 @@
 #!/usr/bin/perl
 # Configuration file for ikiwiki.
-# Passing this to ikiwiki --setup will make ikiwiki generate two
-# wrapper programs, one for cgi and one for a subversion post-commit hook.
+# 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.
 
@@ -16,18 +16,19 @@ use IkiWiki::Setup::Standard {
        
        url => "http://myhost/wiki",
        cgiurl => "http://myhost/ikiwiki.cgi",
-       #diffurl => "http://svn.someurl/trunk/[[file]]?root=wiki&r1=[[r1]]&r2=[[r2]]",
        #templatedir => "/usr/share/ikiwiki/templates",
        
        # Subversion stuff.
        rcs => "svn",
        #historyurl => "http://svn.myhost/trunk/[[file]]",
+       #diffurl => "http://svn.someurl/trunk/[[file]]?root=wiki&r1=[[r1]]&r2=[[r2]]",
        svnrepo => "/svn/wiki",
        svnpath => "trunk",
 
        # Git stuff.
        #rcs => "git",
        #historyurl => "http://git.host/gitweb.cgi?p=wiki.git;a=history;f=[[file]]",
+       #diffurl => "http://git.host/gitweb.cgi?p=wiki.git;a=blobdiff;h=[[sha1_to]];hp=[[sha1_from]];hb=[[sha1_parent]];f=[[file]]",
 
        wrappers => [
                #{
@@ -38,7 +39,7 @@ use IkiWiki::Setup::Standard {
                #},
                {
                        # The svn post-commit wrapper.
-                       # Note that this will overwrite any exsting
+                       # Note that this will overwrite any existing
                        # post-commit hook script, which may not be
                        # what you want.
                        wrapper => "/svn/wikirepo/hooks/post-commit",
@@ -48,10 +49,10 @@ use IkiWiki::Setup::Standard {
                },
                #{
                #       # The git post-update wrapper.
-               #       # Note that this will overwrite any exsting
-               #       # post-commit hook script, which may not be
+               #       # Note that this will overwrite any existing
+               #       # post-update hook script, which may not be
                #       # what you want.
-               #       wrapper => "/git/wikirepo/hooks/post-update",
+               #       wrapper => "/git/wikirepo/.git/hooks/post-update",
                #       wrappermode => "04755",
                #       # Enable mail notifications of commits.
                #       notify => 1,
@@ -62,11 +63,25 @@ use IkiWiki::Setup::Standard {
        #anonok => 1,
        # Generate rss feeds for pages?
        rss => 1,
+       # Urls to ping with XML-RPC when rss feeds are updated
+       #pingurl => [qw{http://rpc.technorati.com/rpc/ping}],
        # Include discussion links on all pages?
        discussion => 1,
+       # To exclude files matching a regexp from processing. This adds to
+       # the default exclude list.
+       #exclude => qr/\*.wav/,
        # Time format (for strftime)
        #timeformat => '%c',
-       # To change the enabled plugins, edit this list
-       #plugin => [qw{pagecount inline brokenlinks search smiley
-       #              htmlscrubber}],
+       # Locale to use. Must be a UTF-8 locale.
+       #locale => 'en_US.UTF-8',
+       # Logging settings:
+       verbose => 0,
+       syslog => 0,
+       
+       # To add plugins, list them here.
+       #add_plugins => [qw{meta tag pagecount brokenlinks search smiley
+       #                   wikitext camelcase pagestats htmltidy fortune
+       #                   sidebar map rst}],
+       # If you want to disable any of the default plugins, list them here.
+       #disable_plugins => [qw{inline htmlscrubber}],
 }