aboutsummaryrefslogtreecommitdiff
path: root/doc/usage.mdwn
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-07-30 04:31:08 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-07-30 04:31:08 +0000
commite49ff966a39d1037ccbf168b8dbd12618cf1b41e (patch)
treecedd803bbefbef0f8fded40fa084bd1eeb9394b1 /doc/usage.mdwn
parent7bb447675fced4861eeec9e687935b9eedf98033 (diff)
downloadikiwiki-e49ff966a39d1037ccbf168b8dbd12618cf1b41e.tar
ikiwiki-e49ff966a39d1037ccbf168b8dbd12618cf1b41e.tar.gz
* ikiwiki can now download and aggregate feeds with its new aggregate
plugin, so it's possible to implement a Planet using ikiwiki! * --setup --refresh no longer rebuilds wrappers. Use --setup --refresh --wrappers to do that. * Add %IkiWiki::forcerebuild to provide a way for plugins like aggregate to update pages that haven't changed on disk.
Diffstat (limited to 'doc/usage.mdwn')
-rw-r--r--doc/usage.mdwn15
1 files changed, 11 insertions, 4 deletions
diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index 691880a96..a6ded5ec2 100644
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -24,8 +24,7 @@ These options control the mode that ikiwiki is operating in.
* --refresh
Refresh the wiki, updating any changed pages. This is the default
- behavior so you don't normally need to specify it. If used with -setup also
- updates any configured wrappers.
+ behavior so you don't normally need to specify it.
* --rebuild
@@ -59,11 +58,19 @@ These options control the mode that ikiwiki is operating in.
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.
- If you also pass the --refresh option, ikiwiki will instead just refresh
- the wiki described in the setup file.
[[ikiwiki.setup]] is an example of such a config file.
+* --wrappers
+
+ If used with --setup --refresh, this makes it also update any configured
+ wrappers.
+
+* --aggregate
+
+ If the aggregate plugin is enabled, this makes ikiwiki poll configured
+ feeds and save new posts to the srcdir.
+
# CONFIG OPTIONS
These options configure the wiki. Note that plugins can add additional