summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoey Hess <joey@gnu.kitenet.net>2009-03-07 19:11:34 -0500
committerJoey Hess <joey@gnu.kitenet.net>2009-03-07 19:11:34 -0500
commit4e11380c75ae66230139641b215d8ffbb0a74d5e (patch)
tree724822f49e62c2d1393ff61b503ff274e4e2232f
parent29d387d2bacfdf10cc8712af1250e5655967f1b9 (diff)
update, add some examples
-rw-r--r--doc/usage.mdwn33
1 files changed, 26 insertions, 7 deletions
diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index b6af75ac8..e411b127a 100644
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -6,7 +6,7 @@ ikiwiki - a wiki compiler
ikiwiki [options] source destination
-ikiwiki --setup configfile
+ikiwiki --setup setupfile
# DESCRIPTION
@@ -30,19 +30,19 @@ These options control the mode that ikiwiki operates in.
Force a rebuild of all pages.
-* --setup configfile
+* --setup setupfile
In setup mode, ikiwiki reads the config file, which is really a perl
program that can call ikiwiki internal functions.
The default action when --setup is specified is to automatically generate
- wrappers for a wiki based on data in a config file, and rebuild the wiki.
+ wrappers for a wiki based on data in a setup file, and rebuild the wiki.
If you only want to build any changed pages, you can use --refresh with
--setup.
-* --dumpsetup configfile
+* --dumpsetup setupfile
- Causes ikiwiki to write to the specified config file, dumping out
+ Causes ikiwiki to write to the specified setup file, dumping out
its current configuration.
* --wrappers
@@ -103,7 +103,8 @@ These options control the mode that ikiwiki operates in.
# CONFIG OPTIONS
These options configure the wiki. Note that [[plugins]] can add additional
-configuration options of their own.
+configuration options of their own. All of these options and more besides can
+also be configured using a setup file.
* --wikiname
@@ -316,10 +317,28 @@ configuration options of their own.
* --set var=value
This allows setting an arbitrary configuration variable, the same as if it
- were set via a configuration file. Since most options can be configured
+ were set via a setup file. Since most options can be configured
using command-line switches, you will rarely need to use this, but it can be
useful for the odd option that lacks a command-line switch.
+# EXAMPLES
+
+* ikiwiki --setup my.setup
+
+ Completly (re)build the wiki using the specified setup file.
+
+* ikiwiki --setup my.setup --refresh
+
+ Refresh the wiki, using settings from my.setup, and avoid
+ rebuilding any pages that have not changed. This is faster.
+
+* ikiwiki --setup my.setup --refresh --wrappers
+
+ Refresh the wiki, including regnerating all wrapper programs,
+ but do not rebuild all pages. Useful if you have changed something
+ in the setup file that does not need a full wiki rebuild to update
+ all pages, but that you want to immediatly take effect.
+
# ENVIRONMENT
* CC