X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/bf522a347f9749522a4f575cb48000123b79978a..3b3278857c748ca62edabdafcd8fb0cf56825726:/doc/usage.mdwn diff --git a/doc/usage.mdwn b/doc/usage.mdwn index cd8f0542c..511bb687a 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -55,13 +55,16 @@ These options control the mode that ikiwiki operates in. In setup mode, ikiwiki reads the config file, which is really a perl program that can call ikiwiki internal functions. - [[ikiwiki.setup]] is an example of such a config file. - 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 only want to build any changed pages, you can use --refresh with --setup. +* --dumpsetup configfile + + Causes ikiwiki to write to the specified config file, dumping out + its current configuration. + * --wrappers If used with --setup --refresh, this makes it also update any configured @@ -113,6 +116,11 @@ configuration options of their own. build time. If the templatedir is changed, missing templates will still be searched for in the default location as a fallback. + Note that if you choose to copy and modify ikiwiki's templates, you will need + to be careful to keep them up to date when upgrading to new versions of + ikiwiki. Old versions of templates do not always work with new ikiwiki + versions. + * --underlaydir Specify the directory that is used to underlay the source directory. @@ -144,6 +152,10 @@ configuration options of their own. No revision control is enabled by default. +* --svnrepo /svn/wiki + + Specify the location of the svn repository for the wiki. + * --svnpath trunk Specify the path inside your svn repository where the wiki is located. @@ -217,8 +229,8 @@ configuration options of their own. Specifies a username of a user (or, if openid is enabled, an openid) who has the powers of a wiki admin. Currently allows locking of any page, - and banning of users; other powers may be added later. May be specified - multiple times for multiple admins. + and [[banning|banned_users]] users; other powers may be added later. + May be specified multiple times for multiple admins. For an openid user specify the full URL of the login, including "http://". @@ -277,6 +289,11 @@ configuration options of their own. Toggle creating output files named page/index.html (default) instead of page.html. +* --prefix-directives, --no-prefix-directives + + Toggle new '!'-prefixed syntax for preprocessor directives. ikiwiki currently + defaults to --no-prefix-directives. + * --w3mmode, --no-w3mmode Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script, @@ -313,6 +330,7 @@ configuration options of their own. * [[ikiwiki-mass-rebuild]](8) * [[ikiwiki-update-wikilist]](1) +* [[ikiwiki-transition]](1) # AUTHOR