]> sipb.mit.edu Git - ikiwiki.git/blobdiff - doc/ikiwiki-makerepo.mdwn
Code formatting.
[ikiwiki.git] / doc / ikiwiki-makerepo.mdwn
index d5034b2c724da9780890985351d1b7fc5c59b6a4..acb1211de76f787e800f58b43b47bdc9a0d56c83 100644 (file)
@@ -4,28 +4,33 @@ ikiwiki-makerepo - check an ikiwiki srcdir into revision control
 
 # SYNOPSIS
 
-ikiwiki-makerepo svn|git|monotone|darcs srcdir repository
+ikiwiki-makerepo git|svn|monotone|darcs|cvs srcdir repository
 
-ikiwiki-makerepo mercurial|darcs srcdir
+ikiwiki-makerepo bzr|mercurial srcdir
 
 # DESCRIPTION
 
 `ikiwiki-makerepo` injects a `srcdir` directory, containing an ikiwiki wiki,
-into a `repository` that it creates. The repository can be a svn, git, or
-mercurial repository.
+into a `repository` that it creates. The repository can be created using
+any of a variety of revision control systems.
 
-Note that for mercurial, the srcdir is converted into a mercurial
-repository. There is no need to have a separate repository with mercurial.
+Note that for mercurial and bzr, the srcdir is converted into a
+repository. There is no need to have a separate repository with mercurial
+or bzr.
 
-For darcs, the second (one-argument) form turns the given srcdir into a
-darcs master repository with the (new) srcdir inside. Adjust your ikiwiki.setup
-according to the command output! Also, the master repo's apply hook will be
-preconfigured to call a (hypothetical) ikiwiki wrapper. The command
-reports the relevant file. Adjust it as needed or remove it if you don't use
-the cgi script.
+For darcs, the master repo's apply hook will be preconfigured to call a
+ikiwiki wrapper.
 
-Note that for monotone, you are assumed to already have run "mtn genkey" to generate
-key.
+Note that for monotone, you are assumed to already have run "mtn genkey"
+to generate a key.
+
+
+# EXAMPLE 
+
+`ikiwiki-makerepo git /var/www/wiki /home/user/wiki/`
+
+The above command creates a new git repo in /home/user/wiki as well as a new git repo in the /var/www/wiki directory. 
+It then initializes the /home/user/wiki git repo and makes the /var/www/wiki a clone. 
 
 # AUTHOR