]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blob - doc/ikiwiki-transition.mdwn
already fixed
[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
12 there's a major change in ikiwiki syntax. It also handles other transitions
13 not involving wiki pages.
15 # prefix_directives
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 # indexdb
30 The `indexdb` mode handles converting a plain text `.ikiwiki/index` file to
31 a binary `.ikiwiki/indexdb`. In this mode, you should specify the srcdir of
32 the wiki as the second parameter. You do not normally need to run
33 `ikiwiki-transition indexdb`; ikiwiki will automatically run it as
34 necessary.
36 # hashpassword
38 The `hashpassword` mode forces any plaintext passwords stored in the
39 `.ikiwiki/userdb` file to be replaced with password hashes. (The
40 Authen::Passphrase perl module is needed to do this.) In this mode, you
41 should specify the srcdir of the wiki as the second parameter. 
43 If this is not done explicitly, a user's plaintext password will be
44 automatically converted to a hash when a user logs in for the first time
45 after upgrade to ikiwiki 2.48.
47 # AUTHOR
49 Josh Triplett <josh@freedesktop.org>, Joey Hess <joey@ikiwiki.info>
51 Warning: this page is automatically made into ikiwiki-transition's man page, edit with care