add transition code for indexdb

[ikiwiki.git] / doc / ikiwiki-transition.mdwn

diff --git a/doc/ikiwiki-transition.mdwn b/doc/ikiwiki-transition.mdwn
index 118050a6ce05c98c78c47261def9e223367826cc..da3b3a8d55a0cf3b8b03c87eaad9015b16fa7051 100644 (file)
--- a/doc/ikiwiki-transition.mdwn
+++ b/doc/ikiwiki-transition.mdwn
@@ -4,7 +4,7 @@ ikiwiki-transition - transition ikiwiki pages to new syntaxes
 
 # SYNOPSIS
 
-ikiwiki-transition prefix_directives page.mdwn...
+ikiwiki-transition type ...
 
 # DESCRIPTION
 
@@ -12,8 +12,8 @@ ikiwiki-transition prefix_directives page.mdwn...
 there's a major change in ikiwiki syntax.
 
 Currently only one such transition is handled, the `prefix_directives` mode
-converts an ikiwiki page from the old preprocessor directive syntax,
-requiring a space, to the new syntax, prefixed by '!'.
+converts the specified ikiwiki page from the old preprocessor directive
+syntax, requiring a space, to the new syntax, prefixed by '!'.
 
 Preprocessor directives which already use the new syntax will remain
 unchanged.
@@ -22,6 +22,12 @@ Note that if the page contains wiki links with spaces, which some
 older versions of ikiwiki accepted, the prefix_directives transition will
 treat these as preprocessor directives and convert them.
 
+One other transition is handled, the `indexdb` mode handles converting
+a plain text `.ikiwiki/index` file to a binary `.ikiwiki/indexdb`. In this
+mode, you should specify the srcdir of the wiki as the second parameter.
+You do not normally need to run `ikiwiki-transition indexdb`; ikiwiki will
+automatically run it as necessary.
+
 # AUTHOR
 
 Josh Triplett <josh@freedesktop.org>