X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/61ffa4a81653bc499abb358244dba102323abc99..2bd8ada5a619a1c32bf19f44e4f96e083ceb17b8:/doc/ikiwiki-transition.mdwn?ds=sidebyside diff --git a/doc/ikiwiki-transition.mdwn b/doc/ikiwiki-transition.mdwn index f61e4ffd5..693c1db83 100644 --- a/doc/ikiwiki-transition.mdwn +++ b/doc/ikiwiki-transition.mdwn @@ -1,29 +1,51 @@ # NAME -ikiwiki-transition - transition ikiwiki pages to new syntaxes +ikiwiki-transition - transition ikiwiki pages to new syntaxes, etc # SYNOPSIS -ikiwiki-transition prefix_directives page.mdwn... +ikiwiki-transition type ... # 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 -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. +# 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 -Josh Triplett +Josh Triplett , Joey Hess Warning: this page is automatically made into ikiwiki-transition's man page, edit with care