X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/44a74ec022d1ab0fe3fe12fb26b3f2a432dbb2eb..d89d6c9b5bdc96a88648adb8fdba92e33c1ff765:/doc/usage.mdwn diff --git a/doc/usage.mdwn b/doc/usage.mdwn index 89c30d56e..4936039b6 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -92,6 +92,11 @@ These options configure the wiki. Specify a mode to chmod the wrapper to after creating it. +* --notify + + Enable email notification of commits. This should be used when running + ikiwiki as a [[Subversion]] [[post-commit]] hook. + * --svn, --nosvn Enable or disable use of [[subversion]]. If subversion is enabled, the @@ -104,6 +109,17 @@ These options configure the wiki. Subversion is enabled by default. +* --svnrepo /svn/wiki + + Specify the location of the svn repository for the wiki. This is required + for using --notify with [[subversion]]. + +* --svnpath trunk + + Specify the path inside your svn reporistory where the wiki is located. + This defaults to trunk; change it if your wiki is at some other location + inside the repository. + * --anonok, --noanonok If anonok is set, it will allow anonymous web users, who have not signed in, to make changes to the wiki. @@ -115,21 +131,25 @@ These options configure the wiki. If rss is set, ikiwiki will generate rss feeds for pages that inline a blog. -* --url http://someurl/ +* --url http://url/ Specifies the url to the wiki. This is a required parameter in [[CGI]] mode. -* --cgiurl http://someurl/ikiwiki.cgi +* --cgiurl http://url/ikiwiki.cgi 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/\[[file]]?root=wiki +* --historyurl http://url/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. -* --diffurl http://svn.someurl/trunk/\[[file]]?root=wiki&r1=\[[r1]]&r2=\[[r2]] +* --adminemail you@yourhost + + Specifies the email address that ikiwiki should use for sending email. + +* --diffurl http://url/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 @@ -147,6 +167,11 @@ These options configure the wiki. Currently allows locking of any page, other powers may be added later. May be specified multiple times for multiple admins. +* --sanitize + + Enable [[HtmlSanitization]] of wiki content. On by default, disable with + --no-sanitize. + * --hyperestraier Enables use of the [[HyperEstraier]] search engine for full test page