Merge commit 'upstream/master' into pub/po
[ikiwiki.git] / doc / ikiwiki-transition.mdwn
1 # NAME
2
3 ikiwiki-transition - transition ikiwiki pages to new syntaxes, etc
4
5 # SYNOPSIS
6
7 ikiwiki-transition type ...
8
9 # DESCRIPTION
10
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.
14
15 # prefix_directives your.setup
16
17 The `prefix_directives` mode converts all pages from the old preprocessor
18 directive syntax, requiring a space, to the new syntax, prefixed by '!'.
19
20 Preprocessor directives which already use the new syntax will remain
21 unchanged.
22
23 Note that if a page contains wiki links with spaces, which some
24 older versions of ikiwiki accepted, the prefix_directives transition will
25 treat these as preprocessor directives and convert them.
26
27 # setupformat your.setup
28
29 The `setupformat` mode converts a setup file from using a single `wrappers` block
30 to using `cgi_wrapper`, `git_wrapper`, etc.
31
32 Note that all comments and any unusual stuff like perl code in the setup
33 file will be lost, as it is entirely rewritten by the transition.
34
35 # aggregateinternal your.setup
36
37 The `aggregateinternal` mode moves pages aggregated by the aggregate plugin
38 so that the `aggregateinternal` option can be enabled.
39
40 # moveprefs your.setup
41
42 Moves values that used to be admin preferences into the setup file.
43
44 Note that all comments and any unusual stuff like perl code in the setup
45 file will be lost, as it is entirely rewritten by the move.
46
47 # indexdb your.setup|srcdir
48
49 The `indexdb` mode handles converting a plain text `.ikiwiki/index` file to
50 a binary `.ikiwiki/indexdb`. You do not normally need to run
51 `ikiwiki-transition indexdb`; ikiwiki will automatically run it as
52 necessary.
53
54 # hashpassword your.setup|srcdir
55
56 The `hashpassword` mode forces any plaintext passwords stored in the
57 `.ikiwiki/userdb` file to be replaced with password hashes. (The
58 Authen::Passphrase perl module is needed to do this.)
59
60 If this is not done explicitly, a user's plaintext password will be
61 automatically converted to a hash when a user logs in for the first time
62 after upgrade to ikiwiki 2.48.
63
64 # deduplinks your.setup
65
66 In the past, bugs in ikiwiki have allowed duplicate link information
67 to be stored in its indexdb. This mode removes such duplicate information,
68 which may speed up wikis afflicted by it. Note that rebuilding the wiki
69 will have the same effect.
70
71 # AUTHOR
72
73 Josh Triplett <josh@freedesktop.org>, Joey Hess <joey@ikiwiki.info>
74
75 Warning: this page is automatically made into ikiwiki-transition's man page, edit with care