Added a hardlink option in the setup file, useful if the source and dest are on the...

[ikiwiki.git] / doc / ikiwiki.setup

diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup
index 0094bcb2acf3f4b796807b8c1e5a1fa3f8d38470..99c81cf040107e36ebdd3cb86a5656a5fc9029c0 100644 (file)
--- a/doc/ikiwiki.setup
+++ b/doc/ikiwiki.setup
@@ -50,19 +50,13 @@ use IkiWiki::Setup::Standard {
        # Monotone stuff
        #rcs => "monotone",
        #mtnkey => "web\@machine.company.com",
-       #historyurl => "http://viewmtn.example.com/",
+       #historyurl => "http://viewmtn.example.com/branch/head/filechanges/com.example.branch/[[file]]",
        #diffurl => "http://viewmtn.example.com/revision/diff/[[r1]]/with/[[r2]]/[[file]]",
        # Set if you want the wiki to sync on update and commit.
        #mtnsync => 0,
        # The path to your workspace (defaults to the srcdir itself)
        # e.g. use if your srcdir is a subdirectory of the workspace.
        #mtnrootdir => "path/to/root/of/workspace",
-       # This is a monotone lua hook file used by ikiwiki for
-       # inserting conflict markers. By default it will use
-       # mtnrootdir/_MTN/mergerc. This hook will be populated with
-       # default code the first time you use ikiwiki.  You can
-       # change it to alter how conflict markers are inserted.
-       #mtnmergerc => "path/to/mergerc",
 
        wrappers => [
                #{
@@ -90,6 +84,11 @@ use IkiWiki::Setup::Standard {
                #       wrapper => "/git/wiki.git/hooks/post-update",
                #       wrappermode => "06755",
                #},
+               #{
+               #       # The monotone netsync hook.
+               #       wrapper => "path/to/root/of/workspace/_MTN/ikiwiki-netsync-hook",
+               #       wrappermode => "06755",
+               #},
        ],
 
        # Default to generating rss feeds for blogs?
@@ -105,7 +104,7 @@ use IkiWiki::Setup::Standard {
        discussion => 1,
        # To exclude files matching a regexp from processing. This adds to
        # the default exclude list.
-       #exclude => qr/*\.wav/,
+       #exclude => qr/\.wav$/,
        # To change the extension used for generated html files.
        #htmlext => 'htm',
        # Time format (for strftime)
@@ -130,6 +129,9 @@ use IkiWiki::Setup::Standard {
        #recentchangesnum => 100,
        # Use new '!'-prefixed preprocessor directive syntax
        #prefix_directives => 0,
+       # Attempt to make hardlinks to source files instead of copying them.
+       # Useful if the wiki contains large media files.
+       #hardlink => 1,
 
        # To add plugins, list them here.
        #add_plugins => [qw{goodstuff search wikitext camelcase