X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/f4d99ac1ca03121255e545df89e7d841a02cc0bf..f8cbf79735bc4588ba6fde12f3855a51efeb7ae8:/doc/usage.mdwn diff --git a/doc/usage.mdwn b/doc/usage.mdwn index daef18c1f..9e260adc2 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -68,20 +68,29 @@ These options control the mode that ikiwiki is operating in. * --aggregate - If the aggregate plugin is enabled, this makes ikiwiki poll configured - feeds and save new posts to the srcdir. + If the [[plugins/aggregate]] plugin is enabled, this makes ikiwiki poll + configured feeds and save new posts to the srcdir. Note that to rebuild previously aggregated posts, use the --rebuild option 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. # CONFIG OPTIONS -These options configure the wiki. Note that plugins can add additional +These options configure the wiki. Note that [[plugins]] can add additional configuration options of their own. * --wikiname @@ -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. @@ -145,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 @@ -227,6 +246,12 @@ configuration options of their own. Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script, without a web server. +* --sslcookie + + Only send cookies over an SSL connection. This should prevent them being + intercepted. If you enable this option then you must run at least the + CGI portion of ikiwiki over SSL. + * --getctime Pull last changed time for each new page out of the revision control