aboutsummaryrefslogtreecommitdiff
path: root/doc/usage.mdwn
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-05-02 02:34:33 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-05-02 02:34:33 +0000
commit54d5308cd83c67e7e9c32450c776ef0dac63549f (patch)
tree0352882349bca8952a59fd322099470b7952e0c8 /doc/usage.mdwn
parent457d6bbbbfbb0474749a0d68e959613c86facf72 (diff)
downloadikiwiki-54d5308cd83c67e7e9c32450c776ef0dac63549f.tar
ikiwiki-54d5308cd83c67e7e9c32450c776ef0dac63549f.tar.gz
* Added plugin system, currently only supporting for PreProcessorDirectives.
* Added a pagecount plugin, enabled by default. * Support PreProcessorDirectives with no parameters, ie "[[pagecount ]]". * Fixed/optimised backlinks code, to avoid rebuilding pages to update backlinks when the backlinks hadn't really changed. * Moved inline page support, rss generation etc into the inline plugin, enabled by default. * Added brokenlinks plugin, not enabled by default, but rather handy. * Fix several broken links in the doc wiki.
Diffstat (limited to 'doc/usage.mdwn')
-rw-r--r--doc/usage.mdwn28
1 files changed, 17 insertions, 11 deletions
diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index 4936039b6..c4d1f5818 100644
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -41,7 +41,7 @@ These options control the mode that ikiwiki is operating in.
* --wrapper [file]
- Generate a [[wrapper]] binary that is hardcoded to do action specified by
+ Generate a wrapper binary that is hardcoded to do action specified by
the other options, using the specified input files and `destination`
directory. The filename to use for the wrapper is optional.
@@ -70,13 +70,6 @@ These options configure the wiki.
The name of the wiki, default is "wiki".
-* --fixctime
-
- Pull last changed time for all pages out of the revision control system.
- This rarely used option provides a way to get the real creation times of
- items in weblogs, for example when building a wiki from a new subversion
- checkout. It is unoptimised and quite slow.
-
* --templatedir
Specify the directory that the page [[templates]] are stored in.
@@ -129,7 +122,7 @@ These options configure the wiki.
* --rss, --norss
If rss is set, ikiwiki will generate rss feeds for pages that inline
- a blog.
+ a [[blog]].
* --url http://url/
@@ -137,7 +130,8 @@ These options configure the wiki.
* --cgiurl http://url/ikiwiki.cgi
- Specifies the url to the ikiwiki [[CGI]] script [[wrapper]]. Required when building the wiki for links to the cgi script to be generated.
+ Specifies the url to the ikiwiki [[CGI]] script wrapper. Required when
+ building the wiki for links to the cgi script to be generated.
* --historyurl http://url/trunk/\[[file]]?root=wiki
@@ -172,6 +166,11 @@ These options configure the wiki.
Enable [[HtmlSanitization]] of wiki content. On by default, disable with
--no-sanitize.
+* --plugin name
+
+ Enables the use of the specified plugin in the wiki. See [[plugins]] for
+ details. Note that plugin names are case sensative.
+
* --hyperestraier
Enables use of the [[HyperEstraier]] search engine for full test page
@@ -179,7 +178,14 @@ These options configure the wiki.
* --verbose
- Be vebose about what it's doing.
+ Be vebose about what is being done.
+
+* --fixctime
+
+ Pull last changed time for all pages out of the revision control system.
+ This rarely used option provides a way to get the real creation times of
+ items in weblogs, for example when building a wiki from a new subversion
+ checkout. It is unoptimised and quite slow.
# AUTHOR