web commit by http://jblevins.org/: Ideas about keyboard shortcuts

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

diff --git a/doc/ikiwiki-transition.mdwn b/doc/ikiwiki-transition.mdwn
index f61e4ffd558cf7dae1d33896846eb2d3b87aab36..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
 
 
 # SYNOPSIS
 

-ikiwiki-transition prefix_directives page.mdwn...
+ikiwiki-transition type ...

 
 # DESCRIPTION
 
 
 # DESCRIPTION
 


@@ -12,16 +12,22 @@ 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
 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.
 
 Note that if the page contains wiki links with spaces, which some
 
 Preprocessor directives which already use the new syntax will remain
 unchanged.
 
 Note that if the page contains wiki links with spaces, which some

-older versions of ikiwiki accepted, ikiwiki-prefix-directives will
+older versions of ikiwiki accepted, the prefix_directives transition will

 treat these as preprocessor directives and convert them.
 
 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>
 # AUTHOR
 
 Josh Triplett <josh@freedesktop.org>