X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/9efbadb35d407d6ff345beff91b8b11b269c3d47..d7aecf6ddc19d1dac30ec5616134c2a7e7f4d573:/doc/usage.mdwn diff --git a/doc/usage.mdwn b/doc/usage.mdwn index 8292e7c63..34e6bd1d4 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -4,68 +4,185 @@ 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`. +`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`. + +Note that most options can be shortened to single letters, and boolean +flags such as --verbose can be negated with --no-verbose. + +# MODE OPTIONS + +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. + +* --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]]. -# OPTIONS + 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. -Note that most options can be shortened to single letters. +* --wrapper [file] + + 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]]. + + 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". + The name of the wiki, default is "wiki". -* --verbose +* --fixctime -Be vebose about what it's doing. + 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. -* --rebuild +* --templatedir + + Specify the directory that the page [[templates]] are stored in. + Default is `/usr/share/ikiwiki/templates`. -Force a rebuild of all pages. +* --underlaydir -* --wrapper + 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`. -Generate a [[wrapper]] binary that is hardcoded to do action specified by the other options, using the specified input files and `destination` directory. +* --wrappermode mode -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]]. + Specify a mode to chmod the wrapper to after creating it. -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. +* --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 `source` directory is assumed to be a working copy, and is automatically updated before building the wiki. + 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 subversion enabled pages edited via the web will be committed to subversion. 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. -Subversion is enabled by default. + Subversion is enabled by default. -* --anonok, --noanonok +* --svnrepo /svn/wiki -If anonok is set, it will allow anonymous web users, who have not signed in, to make changes to the wiki. + Specify the location of the svn repository for the wiki. This is required + for using --notify with [[subversion]]. -By default, anonymous users cannot edit the wiki. +* --svnpath trunk -* --cgi + 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. -Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and supports editing pages, signing in, registration, and displaying [[RecentChanges]]. + By default, anonymous users cannot edit the wiki. -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. +* --rss, --norss + + If rss is set, ikiwiki will generate rss feeds for pages that inline + a blog. * --url http://someurl/ -Specifies the url to the wiki. This is a required parameter in [[CGI]] mode. + Specifies the url to the wiki. This is a required parameter in [[CGI]] mode. * --cgiurl http://someurl/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 + + 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. + +* --adminemail you@yourhost + + Specifies the email address that ikiwiki should use for sending email. + +* --diffurl http://svn.someurl/trunk/\[[file]]?root=wiki&r1=\[[r1]]&r2=\[[r2]] -* --historyurl http://svn.someurl/trunk/[[]]?root=wiki + 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 + revision of the page, and "\[[r2]]" is the new revision. It's common to use + [[ViewCVS]] for this. -Specifies the url to link to for page history browsing. In the url, "[[]]" is replaced with the page to browse. It's common to use [[ViewCVS]] for this. +* --exclude regexp + + Specifies a rexexp of source files to exclude from processing. + May be specified multiple times to add to exclude list. + +* --adminuser name + + Specifies a username of a user who has the powers of a wiki admin. + 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 + searches. + +* --verbose + + Be vebose about what it's doing. # AUTHOR -Joey Hess \ No newline at end of file +Joey Hess + +Warning: this page is automatically made into ikiwiki's man page, edit with care