X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/4ad7c9d6257ca106b2949d22f6300823190991a0..54f447b97ebaf70609238fc1e4236718a5e24e22:/doc/usage.mdwn diff --git a/doc/usage.mdwn b/doc/usage.mdwn index 4456e8c1c..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. @@ -120,6 +129,11 @@ configuration options of their own. If you use git, the `source` directory is assumed to be a clone of the [[git]] repository. + If you use tla, the `source` directory is assumed to be a tla import. + + If you use mercurial, the `source` directory is assumed to be the + [[mercurial]] repository. + In [[CGI]] mode, with a revision control system enabled pages edited via the web will be committed. Also, the [[RecentChanges]] link will be placed on pages.