aboutsummaryrefslogtreecommitdiff
path: root/doc/ikiwiki-transition.mdwn
blob: 693c1db832472f85d3fc6823197b6970082dec2a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# NAME

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

# SYNOPSIS

ikiwiki-transition type ...

# DESCRIPTION

`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.

# 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, 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@freedesktop.org>, Joey Hess <joey@ikiwiki.info>

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