Merge commit 'upstream/master'

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

diff --git a/doc/ikiwiki-transition.mdwn b/doc/ikiwiki-transition.mdwn
index f61e4ffd558cf7dae1d33896846eb2d3b87aab36..8b7c3579fabd3c1af8cc58bb43d4a0f7b7d00985 100644 (file)
--- a/doc/ikiwiki-transition.mdwn
+++ b/doc/ikiwiki-transition.mdwn
@@ -1,29 +1,64 @@
 # NAME
 
 # NAME
 

-ikiwiki-transition - transition ikiwiki pages to new syntaxes
+ikiwiki-transition - transition ikiwiki pages to new syntaxes, etc

 
 # SYNOPSIS
 
 
 # SYNOPSIS
 

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

 
 # DESCRIPTION
 
 
 # DESCRIPTION
 

-`ikiwiki-transition` aids in converting ikiwiki pages when
-there's a major change in ikiwiki syntax.
+`ikiwiki-transition` aids in converting wiki pages when
+there's a major change in ikiwiki syntax. It also handles other transitions
+not involving wiki pages.

 
 

-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 '!'.
+# prefix_directives
+
+The `prefix_directives` mode 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.
 

+# setupformat
+
+The `setupformat` mode converts a setup file from using a single `wrappers` block
+to using `cgi_wrapper`, `git_wrapper`, etc.
+
+Note that all comments and any unusual stuff like perl code in the setup
+file will be lost, as it is entirely rewritten by the transition.
+
+# aggregateinternal
+
+The `aggregateinternal` mode moves pages aggregated by the aggregate plugin
+so that the `aggregateinternal` option can be enabled.
+
+# indexdb
+
+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.
+
+# hashpassword
+
+The `hashpassword` mode forces any plaintext passwords stored in the
+`.ikiwiki/userdb` file to be replaced with password hashes. (The
+Authen::Passphrase perl module is needed to do this.) In this mode, you
+should specify the srcdir of the wiki as the second parameter. 
+
+If this is not done explicitly, a user's plaintext password will be
+automatically converted to a hash when a user logs in for the first time
+after upgrade to ikiwiki 2.48.
+

 # AUTHOR
 
 # AUTHOR
 

-Josh Triplett <josh@freedesktop.org>
+Josh Triplett <josh@freedesktop.org>, Joey Hess <joey@ikiwiki.info>

 
 Warning: this page is automatically made into ikiwiki-transition's man page, edit with care
 
 Warning: this page is automatically made into ikiwiki-transition's man page, edit with care