X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/a1a7019f276902c53aad2b2cb71e74f6e974fa05..6c8cf5dd571662f981227489f7c4652a1a1f10cd:/doc/usage.mdwn?ds=sidebyside diff --git a/doc/usage.mdwn b/doc/usage.mdwn index 75e3aa246..83866c1a8 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -4,15 +4,14 @@ ikiwiki - a wiki compiler # SYNOPSIS -ikiwiki [options] source templates destination +ikiwiki [options] source destination ikiwiki --setup configfile # DESCRIPTION `ikiwiki` is a wiki compiler. It builds static html pages for a wiki, from -`source` in the [[MarkDown]] language, using the specified html `templates` -and writes it out to `destination`. +`source` in the [[MarkDown]] language, and writes it out to `destination`. # OPTIONS @@ -31,6 +30,11 @@ flags such as --verbose can be negated with --no-verbose. Force a rebuild of all pages. +* --templatedir + + Specify the directory that the page [[templates]] are stored in. + Default is `/usr/share/ikiwiki/templates`. + * --wrapper [file] Generate a [[wrapper]] binary that is hardcoded to do action specified by @@ -76,15 +80,30 @@ flags such as --verbose can be negated with --no-verbose. Specifies the url to the ikiwiki [[CGI]] script [[wrapper]]. Required when building the wiki for links to the cgi script to be generated. -* --historyurl http://svn.someurl/trunk/[[]]?root=wiki +* --historyurl http://svn.someurl/trunk/\[[file]]?root=wiki + + Specifies the url to link to for page history browsing. In the url, + "\[[file]]" is replaced with the file to browse. It's common to use + [[ViewCVS]] for this. - Specifies the url to link to for page history browsing. In the url, "[[]]" is replaced with the page to browse. It's common to use [[ViewCVS]] for this. +* --diffurl http://svn.someurl/trunk/\[[file]]?root=wiki&r1=\[[r1]]&r2=\[[r2]] + + Specifies the url to link to for a diff of changes to a page. In the url, + "\[[file]]" is replaced with the file to browse, "\[[r1]]" is the old + revision of the page, and "\[[r2]]" is the new revision. It's common to use + [[ViewCVS]] for this. * --exclude regexp Specifies a rexexp of source files to exclude from processing. May be specified multiple times to add to exclude list. +* --adminuser name + + Specifies a username of a user who has the powers of a wiki admin. + Currently allows locking of any page, other powers may be added later. + May be specified multiple times for multiple admins. + * --setup configfile In setup mode, ikiwiki reads the config file, which is really a perl