summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-09-21 21:34:29 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-09-21 21:34:29 +0000
commitc35444826ca47123697a8f2512866f4f99964cc4 (patch)
treeb29bf3982c043867389e5ba4a4ee62789c93f4b2 /doc
parent63f09c7cef0eb10d8051a92ff626bf1b5f29b9b0 (diff)
* Add --render mode, which can be used to preview an edit at the command
line by test rendering a single page.
Diffstat (limited to 'doc')
-rw-r--r--doc/usage.mdwn9
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index 0c7e7d036..aa352736c 100644
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -75,6 +75,15 @@ These options control the mode that ikiwiki is operating in.
along with this one. --rebuild will also force feeds to be polled even if
they were polled recently.
+* --render file
+
+ Renders a single file, outputting the resulting html. Does not save state,
+ so this cannot be used for building whole wikis, but it is useful for
+ previewing an edited file at the command line. Generally used in conjunction
+ with --setup to load in a wiki's setup:
+
+ ikiwiki --setup ~/ikiwiki.setup --render foo.mdwn
+
* --version
Print ikiwiki version number.