]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/usage.mdwn
* Add --render mode, which can be used to preview an edit at the command
[ikiwiki.git] / doc / usage.mdwn
index 0c7e7d036cb266c30374cb81a0c481b63b13a631..aa352736c44285acf70740d8df3d972c4ac07a27 100644 (file)
@@ -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.