X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/975ae0944cdd18a510d803da7a499c2247ac855e..25b35c3c7403202aae19c4a328f6af4d2aae2e68:/doc/usage.mdwn diff --git a/doc/usage.mdwn b/doc/usage.mdwn index 9a8b97ceb..deb94e415 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -22,7 +22,7 @@ These options control the mode that ikiwiki is operating in. * --refresh - Refresh the wiki, updating any changes pages. This is the default + Refresh the wiki, updating any changed pages. This is the default behavior so you don't normally need to specify it. * --rebuild @@ -41,12 +41,12 @@ These options control the mode that ikiwiki is operating in. * --wrapper [file] - Generate a [[wrapper]] binary that is hardcoded to do action specified by + Generate a wrapper binary that is hardcoded to do action specified by the other options, using the specified input files and `destination` directory. The filename to use for the wrapper is optional. The wrapper is designed to be safely made suid and be run by untrusted - users, as a [[Subversion]] [[post-commit]] hook, or as a [[CGI]]. + users, as a [[post-commit]] hook, or as a [[CGI]]. Note that the generated wrapper will ignore all command line parameters. @@ -70,13 +70,6 @@ These options configure the wiki. The name of the wiki, default is "wiki". -* --fixctime - - Pull last changed time for all pages out of the revision control system. - This rarely used option provides a way to get the real creation times of - items in weblogs, for example when building a wiki from a new subversion - checkout. It is unoptimised and quite slow. - * --templatedir Specify the directory that the page [[templates]] are stored in. @@ -92,13 +85,37 @@ These options configure the wiki. Specify a mode to chmod the wrapper to after creating it. -* --svn, --nosvn +* --notify + + Enable email notification of commits. This should be used when running + ikiwiki as a [[post-commit]] hook. + +* --rcs=svn, --no-rcs + + Enable or disable use of a revision control system. + + If you use svn, the `source` directory is assumed to be + a [[Subversion]] working copy. + + If you use git, the `source` directory is assumed to be a clone of the + [[git]] repository. - Enable or disable use of [[subversion]]. If subversion is enabled, the `source` directory is assumed to be a working copy, and is automatically updated before building the wiki. + In [[CGI]] mode, with a revision control system enabled pages edited via + the web will be committed. Also, the [[RecentChanges]] link will be placed + on pages. - In [[CGI]] mode, with subversion enabled pages edited via the web will be committed to subversion. Also, the [[RecentChanges]] link will be placed on pages. + svn is enabled by default. - 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 @@ -109,23 +126,37 @@ These options configure the wiki. * --rss, --norss If rss is set, ikiwiki will generate rss feeds for pages that inline - a blog. + a [[blog]]. + +* --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 http://someurl/ +* --url 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. + 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 @@ -143,9 +174,37 @@ 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. +* --plugin name + + Enables the use of the specified [[plugin|plugins]] in the wiki. + Note that plugin names are case sensative. + +* --disable-plugin name + + Disables use of a plugin. For example "--disable-plugin htmlscrubber" + to do away with html sanitization. + +* --discussion, --no-discussion + + Enables or disables "Discussion" links from being added to the header of + every page. The links are enabled by default. + +* --timeformat format + + Specify how to display the time or date. The format string is passed to the + strftime(3) function. + * --verbose - Be vebose about what it's doing. + Be vebose about what is being done. + +* --getctime + + Pull last changed time for each new page out of the revision control + system. This rarely used option provides a way to get the real creation + times of items in weblogs, for example when building a wiki from a new + subversion checkout. It is unoptimised and quite slow. It is best used + with --rebuild, to force ikiwiki to get the ctime for all pages. # AUTHOR