X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/30afedcfe2799bb6cc4bf329bd273ad9d8dd6da3..1bdfa4d8b54763eee1c266e3516bb50dd864cedc:/doc/usage.mdwn diff --git a/doc/usage.mdwn b/doc/usage.mdwn index eec1856a7..8404d15da 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 @@ -128,7 +130,16 @@ These options configure the wiki. If rss is set, ikiwiki will generate rss feeds for pages that inline a [[blog]]. -* --url http://url/ +* --pingurl url + + Set this to the url to an XML-RPC service to ping when an RSS feed is + updated. For example, to ping Technorati, use the url + http://rpc.technorati.com/rpc/ping + + This parameter can be specified multiple times to specify more than one + url to ping. + +* --url url Specifies the url to the wiki. This is a required parameter in [[CGI]] mode. @@ -147,7 +158,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 @@ -189,6 +200,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