X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/e059c9eff94ab37598d740cc5777e591216368a1..38ce4c3cef71518610cb934fde171e2d4aeff99e:/doc/usage.mdwn diff --git a/doc/usage.mdwn b/doc/usage.mdwn index 7bc9e5314..daef18c1f 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -24,8 +24,7 @@ These options control the mode that ikiwiki is operating in. * --refresh Refresh the wiki, updating any changed pages. This is the default - behavior so you don't normally need to specify it. If used with -setup also - updates any configured wrappers. + behavior so you don't normally need to specify it. * --rebuild @@ -59,14 +58,31 @@ These options control the mode that ikiwiki is operating in. The default action when --setup is specified is to automatically generate wrappers for a wiki based on data in a config file, and rebuild the wiki. - If you also pass the --refresh option, ikiwiki will instead just refresh - the wiki described in the setup file. [[ikiwiki.setup]] is an example of such a config file. +* --wrappers + + If used with --setup --refresh, this makes it also update any configured + wrappers. + +* --aggregate + + If the 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. + +* --version + + Print ikiwiki version number. + # CONFIG OPTIONS -These options configure the wiki. +These options configure the wiki. Note that plugins can add additional +configuration options of their own. * --wikiname @@ -75,13 +91,15 @@ These options configure the wiki. * --templatedir Specify the directory that the page [[templates]] are stored in. - Default is `/usr/share/ikiwiki/templates`. + Default is `/usr/share/ikiwiki/templates`, or another location as + configured at build time. * --underlaydir Specify the directory that is used to underlay the source directory. Source files will be taken from here unless overridden by a file in the - source directory. Default is `/usr/share/ikiwiki/basewiki`. + source directory. Default is `/usr/share/ikiwiki/basewiki` or another + location as configured at build time. * --wrappermode mode @@ -148,7 +166,7 @@ These options configure the wiki. Specifies the url to the ikiwiki [[CGI]] script wrapper. Required when building the wiki for links to the cgi script to be generated. -* --historyurl http://url/trunk/\[[file]]?root=wiki +* --historyurl url Specifies the url to link to for page history browsing. In the url, "\[[file]]" is replaced with the file to browse. It's common to use @@ -158,7 +176,7 @@ These options configure the wiki. Specifies the email address that ikiwiki should use for sending email. -* --diffurl http://url/trunk/\[[file]]?root=wiki&r1=\[[r1]]&r2=\[[r2]] +* --diffurl url Specifies the url to link to for a diff of changes to a page. In the url, "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old @@ -196,10 +214,19 @@ These options configure the wiki. Specify how to display the time or date. The format string is passed to the strftime(3) function. -* --verbose +* --verbose, --no-verbose Be vebose about what is being done. +* --syslog, --no-syslog + + Log to syslog. + +* --w3mmode, --no-w3mmode + + Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script, + without a web server. + * --getctime Pull last changed time for each new page out of the revision control