]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blob - doc/ikiwiki-transition.mdwn
remove deprecated admin prefs
[git.ikiwiki.info.git] / doc / ikiwiki-transition.mdwn
1 # NAME
3 ikiwiki-transition - transition ikiwiki pages to new syntaxes, etc
5 # SYNOPSIS
7 ikiwiki-transition type ...
9 # DESCRIPTION
11 `ikiwiki-transition` aids in converting wiki pages when there's a major
12 change in ikiwiki syntax. It also handles other transitions not involving
13 wiki pages.
15 # prefix_directives file ...
17 The `prefix_directives` mode converts the specified ikiwiki page from
18 the old preprocessor directive syntax, requiring a space, to the new
19 syntax, prefixed by '!'.
21 Preprocessor directives which already use the new syntax will remain
22 unchanged.
24 Note that if the page contains wiki links with spaces, which some
25 older versions of ikiwiki accepted, the prefix_directives transition will
26 treat these as preprocessor directives and convert them.
28 # setupformat your.setup
30 The `setupformat` mode converts a setup file from using a single `wrappers` block
31 to using `cgi_wrapper`, `git_wrapper`, etc.
33 Note that all comments and any unusual stuff like perl code in the setup
34 file will be lost, as it is entirely rewritten by the transition.
36 # aggregateinternal your.setup
38 The `aggregateinternal` mode moves pages aggregated by the aggregate plugin
39 so that the `aggregateinternal` option can be enabled.
41 # moveprefs your.setup
43 Moves values that used to be admin preferences into the setup file.
45 Note that all comments and any unusual stuff like perl code in the setup
46 file will be lost, as it is entirely rewritten by the move.
48 # indexdb srcdir
50 The `indexdb` mode handles converting a plain text `.ikiwiki/index` file to
51 a binary `.ikiwiki/indexdb`. You do not normally need to run
52 `ikiwiki-transition indexdb`; ikiwiki will automatically run it as
53 necessary.
55 # hashpassword srcdir
57 The `hashpassword` mode forces any plaintext passwords stored in the
58 `.ikiwiki/userdb` file to be replaced with password hashes. (The
59 Authen::Passphrase perl module is needed to do this.)
61 If this is not done explicitly, a user's plaintext password will be
62 automatically converted to a hash when a user logs in for the first time
63 after upgrade to ikiwiki 2.48.
65 # AUTHOR
67 Josh Triplett <josh@freedesktop.org>, Joey Hess <joey@ikiwiki.info>
69 Warning: this page is automatically made into ikiwiki-transition's man page, edit with care