X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/f7f3b0bb7d91c74f67023e970cee71ad2ea260da..389ad222ec2e0457106339fb71713dad7b95f80e:/doc/usage.mdwn diff --git a/doc/usage.mdwn b/doc/usage.mdwn index 0c7e7d036..ce60d91a4 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. @@ -150,7 +159,12 @@ configuration options of their own. * --rss, --norss - If rss is set, ikiwiki will generate rss feeds for pages that inline + If rss is set, ikiwiki will generate RSS feeds for pages that inline + a [[blog]]. + +* --atom, --noatom + + If atom is set, ikiwiki will generate Arom feeds for pages that inline a [[blog]]. * --pingurl url @@ -214,6 +228,12 @@ configuration options of their own. Enables or disables "Discussion" links from being added to the header of every page. The links are enabled by default. +* --userdir subdir + + Optionally, allows links to users of the wiki to link to pages inside a + subdirectory of the wiki. The default is to link to pages in the toplevel + directory of the wiki. + * --timeformat format Specify how to display the time or date. The format string is passed to the