]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/usage.mdwn
template: Add support for a BASENAME variable.
[git.ikiwiki.info.git] / doc / usage.mdwn
index f34d5bad653ba4119ca968d71a77a19be8dafbd3..2b104bcdb5597659f08c734046ba89ddd711741c 100644 (file)
@@ -113,6 +113,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 +149,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.
@@ -153,13 +162,25 @@ configuration options of their own.
 
 * --rss, --norss
 
-  If rss is set, ikiwiki will generate RSS feeds for pages that inline
-  a [[ikiwiki/blog]].
+  If rss is set, ikiwiki will default to generating RSS feeds for pages
+  that inline a [[ikiwiki/blog]].
+
+* --allowrss
+
+  If allowrss is set, and rss is not set, ikiwiki will not default to
+  generating RSS feeds, but setting `rss=yes` in the blog can override
+  this default and generate a feed.
 
 * --atom, --noatom
 
-  If atom is set, ikiwiki will generate Atom feeds for pages that inline
-  a [[ikiwiki/blog]].
+  If atom is set, ikiwiki will default to generating Atom feeds for pages
+  that inline a [[ikiwiki/blog]].
+
+* --allowatom
+
+  If allowatom is set, and rss is not set, ikiwiki will not default to
+  generating Atom feeds, but setting `atom=yes` in the blog can override
+  this default and generate a feed.
 
 * --pingurl URL
 
@@ -205,8 +226,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://".
 
@@ -265,6 +286,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,
@@ -301,6 +327,7 @@ configuration options of their own.
 
 * [[ikiwiki-mass-rebuild]](8)
 * [[ikiwiki-update-wikilist]](1)
+* [[ikiwiki-transition]](1)
 
 # AUTHOR