Command on compile plugin
[ikiwiki.git] / doc / ikiwiki-makerepo.mdwn
1 # NAME
2
3 ikiwiki-makerepo - check an ikiwiki srcdir into revision control
4
5 # SYNOPSIS
6
7 ikiwiki-makerepo git|svn|monotone|darcs|cvs srcdir repo
8
9 ikiwiki-makerepo bzr|mercurial srcdir
10
11 # DESCRIPTION
12
13 `ikiwiki-makerepo` injects an existing `srcdir` directory, containing
14 sources for an ikiwiki wiki, into revision control. It is rarely
15 run directly; consider using `ikiwiki --setup /etc/ikiwiki/wiki.setup` instead
16 to set up a wiki.
17
18 For git, the `repo` is created as a bare git repository, and the srcdir is
19 made into a clone of it. (monotone and darcs are similar.)
20
21 For svn and cvs, the `repo` is the centralized repository, and the `srcdir`
22 is a checkout of it.
23
24 For mercurial and bzr, the srcdir is the only repository set up.
25
26 For darcs, the master repo's apply hook will be preconfigured to call a
27 ikiwiki wrapper.
28
29 Note that for monotone, you are assumed to already have run "mtn genkey"
30 to generate a key.
31
32 # EXAMPLE 
33
34 `ikiwiki-makerepo git /srv/web/wiki /srv/git/wiki.git/`
35
36 This creates a bare repository `/srv/git/wiki.git/`,
37 and sets up `/srv/web/wiki` to be a clone of it, committing
38 any files that already exist in that directory.
39
40 # AUTHOR
41
42 Joey Hess <joey@ikiwiki.info>
43
44 Warning: this page is automatically made into ikiwiki-makerepo's man page, edit with care