X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/325d5c791fc50dc3868b2f1938d052d39b676248..03867bf323fda5d582a53341f8f1a0a3460d76d6:/doc/usage.mdwn diff --git a/doc/usage.mdwn b/doc/usage.mdwn index 7d7acf16a..eec1856a7 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -4,57 +4,118 @@ 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`. - -# OPTIONS +`source` in the [[MarkDown]] language, 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. -* --wikiname +# MODE OPTIONS - The name of the wiki, default is "wiki". +These options control the mode that ikiwiki is operating in. -* --verbose +* --refresh - Be vebose about what it's doing. + Refresh the wiki, updating any changed pages. This is the default + behavior so you don't normally need to specify it. * --rebuild Force a rebuild of all pages. +* --cgi + + Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and + supports editing pages, signing in, registration, and displaying + [[RecentChanges]]. + + To use ikiwiki as a [[CGI]] program you need to use --wrapper or --setup + to generate a wrapper. The wrapper will generally need to run suid 6755 to + the user who owns the `source` and `destination` directories. + * --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. + +* --setup configfile + + In setup mode, ikiwiki reads the config file, which is really a perl + program that can call ikiwiki internal functions. + + The default action when --setup is specified is to automatically generate + wrappers for a wiki based on data in a config file, and rebuild the wiki. + If you also pass the --refresh option, ikiwiki will instead just refresh + the wiki described in the setup file. + + [[ikiwiki.setup]] is an example of such a config file. + +# CONFIG OPTIONS + +These options configure the wiki. + +* --wikiname + + The name of the wiki, default is "wiki". + +* --templatedir + + Specify the directory that the page [[templates]] are stored in. + Default is `/usr/share/ikiwiki/templates`. + +* --underlaydir - Note that the generated wrapper will ignore all command line parameters - except for --params, which will make it print out the parameters it would - run ikiwiki with. + Specify the directory that is used to underlay the source directory. + Source files will be taken from here unless overridden by a file in the + source directory. Default is `/usr/share/ikiwiki/basewiki`. * --wrappermode mode Specify a mode to chmod the wrapper to after creating it. -* --svn, --nosvn +* --notify - 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. + Enable email notification of commits. This should be used when running + ikiwiki as a [[post-commit]] hook. - 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. +* --rcs=svn, --no-rcs - Subversion is enabled by default. + 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. + + 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. + + svn 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 @@ -62,27 +123,31 @@ flags such as --verbose can be negated with --no-verbose. By default, anonymous users cannot edit the wiki. -* --cgi - - Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and supports editing pages, signing in, registration, and displaying [[RecentChanges]]. +* --rss, --norss - To use ikiwiki as a [[CGI]] program you need to use --wrapper to generate a wrapper. The wrapper will generally need to run suid 6755 to the user who owns the `source` and `destination` directories. + 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. + 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 @@ -100,17 +165,37 @@ flags such as --verbose can be negated with --no-verbose. Currently allows locking of any page, other powers may be added later. May be specified multiple times for multiple admins. -* --setup configfile +* --plugin name - In setup mode, ikiwiki reads the config file, which is really a perl - program that can call ikiwiki internal functions. Uses of this are - various; the normal one is to automatically generate wrappers for a - wiki based on data in a config file. - - Note that the wiki will be (re)built as part of the setup process to - ensure that any changes take effect. + Enables the use of the specified [[plugin|plugins]] in the wiki. + Note that plugin names are case sensative. - [[ikiwiki.setup]] is an example of such a config file. +* --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 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