summaryrefslogtreecommitdiff
path: root/doc/usage.mdwn
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-03-13 19:10:29 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-03-13 19:10:29 +0000
commitf7f45d6a0ad41f3cd077b0310ce83f199b658b4d (patch)
treeda4f915ff1e4c4883923c18480922b2466d71c69 /doc/usage.mdwn
parentac69a979059198a3716d1e177d177e978e1f1785 (diff)
add rebuild after calling setup, better format for setup files
Diffstat (limited to 'doc/usage.mdwn')
-rw-r--r--doc/usage.mdwn9
1 files changed, 7 insertions, 2 deletions
diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index 8efb9a63d..0377014fd 100644
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -89,8 +89,13 @@ flags such as --verbose can be negated with --no-verbose.
In setup mode, ikiwiki reads the config file, which is really a perl
program that can call ikiwiki internal functions. Uses of this are
- various; one is to automatically generate wrappers for a wiki based on
- data in a config file.
+ various; the normal one is to automatically generate wrappers for a
+ wiki based on data in a config file.
+
+ Note that the wiki will be (re)built as part of the setup process to
+ ensure that any changes take effect.
+
+ [[ikiwiki.setup]] is an example of such a config file.
# AUTHOR