X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/cebbb6f482492ba776a1ca542e81a74fb74fbfce..b78a9e270424574b3f585fce9d83e7ba3296267f:/doc/usage.mdwn diff --git a/doc/usage.mdwn b/doc/usage.mdwn index 473d1c9b1..b6af75ac8 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -30,33 +30,11 @@ These options control the mode that ikiwiki operates in. 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, and registration. - - 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 - 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 [[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. - [[ikiwiki.setup]] is an example of such a config file. - 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 only want to build any changed pages, you can use --refresh with @@ -72,6 +50,26 @@ These options control the mode that ikiwiki operates in. If used with --setup --refresh, this makes it also update any configured wrappers. +* --cgi + + Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and + supports editing pages, signing in, and registration. + + 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 + 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 [[post-commit]] hook, or as a [[CGI]]. + + Note that the generated wrapper will ignore all command line parameters. + * --aggregate If the [[plugins/aggregate]] plugin is enabled, this makes ikiwiki poll @@ -168,24 +166,24 @@ configuration options of their own. * --rss, --norss If rss is set, ikiwiki will default to generating RSS feeds for pages - that inline a [[ikiwiki/blog]]. + that inline a [[blog]]. * --allowrss If allowrss is set, and rss is not set, ikiwiki will not default to - generating RSS feeds, but setting `rss=yes` in the blog can override - this default and generate a feed. + generating RSS feeds, but setting `rss=yes` in the inline directive can + override this default and generate a feed. * --atom, --noatom If atom is set, ikiwiki will default to generating Atom feeds for pages - that inline a [[ikiwiki/blog]]. + that inline a [[blog]]. * --allowatom If allowatom is set, and rss is not set, ikiwiki will not default to - generating Atom feeds, but setting `atom=yes` in the blog can override - this default and generate a feed. + generating Atom feeds, but setting `atom=yes` in the inline directive can + override this default and generate a feed. * --pingurl URL @@ -338,4 +336,4 @@ configuration options of their own. Joey Hess -Warning: this page is automatically made into ikiwiki's man page via [mdwn2man](http://ikiwiki.info/cgi-bin/viewvc.cgi/trunk/mdwn2man?root=ikiwiki&view=markup). Edit with care +Warning: this page is automatically made into ikiwiki's man page via [mdwn2man](http://git.ikiwiki.info/?p=ikiwiki;a=blob;f=mdwn2man;hb=HEAD). Edit with care