X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/b0e7e2e123079a2e68924cfb90d19c44571b1f65..8f2d8142e40a883e0208904db99a7dea24679098:/doc/usage.mdwn diff --git a/doc/usage.mdwn b/doc/usage.mdwn index deb94e415..691880a96 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -11,7 +11,8 @@ ikiwiki --setup configfile # DESCRIPTION `ikiwiki` is a wiki compiler. It builds static html pages for a wiki, from -`source` in the [[MarkDown]] language, and writes it out to `destination`. +`source` in the [[MarkDown]] language (or others), and writes it out to +`destination`. Note that most options can be shortened to single letters, and boolean flags such as --verbose can be negated with --no-verbose. @@ -23,7 +24,8 @@ These options control the mode that ikiwiki is operating in. * --refresh Refresh the wiki, updating any changed pages. This is the default - behavior so you don't normally need to specify it. + behavior so you don't normally need to specify it. If used with -setup also + updates any configured wrappers. * --rebuild @@ -64,7 +66,8 @@ These options control the mode that ikiwiki is operating in. # CONFIG OPTIONS -These options configure the wiki. +These options configure the wiki. Note that plugins can add additional +configuration options of their own. * --wikiname @@ -156,7 +159,7 @@ These options configure the wiki. Specifies the email address that ikiwiki should use for sending email. -* --diffurl http://url/trunk/\[[file]]?root=wiki&r1=\[[r1]]&r2=\[[r2]] +* --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 @@ -198,6 +201,11 @@ These options configure the wiki. Be vebose about what is being done. +* --w3mmode, --no-w3mmode + + Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script, + without a web server. + * --getctime Pull last changed time for each new page out of the revision control