X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/cb80809aec56e1b6f0194f3d6f778fc8db3c7783..3f8858445ca8eafb36ab5079f2c941e8d719de91:/doc/usage.mdwn?ds=sidebyside diff --git a/doc/usage.mdwn b/doc/usage.mdwn index af3634e13..f34d5bad6 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -11,7 +11,7 @@ ikiwiki --setup configfile # DESCRIPTION `ikiwiki` is a wiki compiler. It builds static HTML pages for a wiki, from -`source` in the [[Markdown]] language (or others), and writes it out to +`source` in the [[ikiwiki/Markdown]] language (or others), and writes it out to `destination`. Note that most options can be shortened to single letters, and boolean @@ -33,8 +33,7 @@ These options control the mode that ikiwiki operates in. * --cgi Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and - supports editing pages, signing in, registration, and displaying - [[RecentChanges]]. + 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 @@ -133,11 +132,6 @@ configuration options of their own. access controlled by a group, it makes sense for the ikiwiki wrappers to run setgid to that group. -* --notify, --no-notify - - Enable email notification of commits. This should be used when running - ikiwiki as a [[post-commit]] hook. - * --rcs=svn|git|.., --no-rcs Enable or disable use of a [[revision_control_system|rcs]]. @@ -146,16 +140,10 @@ configuration options of their own. whatever the revision control system you select uses. 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. + the web will be committed. No revision control 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|rcs/svn]]. - * --svnpath trunk Specify the path inside your svn repository where the wiki is located. @@ -166,12 +154,12 @@ configuration options of their own. * --rss, --norss If rss is set, ikiwiki will generate RSS feeds for pages that inline - a [[blog]]. + a [[ikiwiki/blog]]. * --atom, --noatom If atom is set, ikiwiki will generate Atom feeds for pages that inline - a [[blog]]. + a [[ikiwiki/blog]]. * --pingurl URL @@ -215,9 +203,12 @@ configuration options of their own. * --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. + Specifies a username of a user (or, if openid is enabled, an openid) + who has the powers of a wiki admin. Currently allows locking of any page, + and banning of users; other powers may be added later. May be specified + multiple times for multiple admins. + + For an openid user specify the full URL of the login, including "http://". * --plugin name @@ -300,6 +291,12 @@ configuration options of their own. using command-line switches, you will rarely need to use this, but it can be useful for the odd option that lacks a command-line switch. +# ENVIRONMENT + +* CC + + This controls what C compiler is used to build wrappers. Default is 'cc'. + # SEE ALSO * [[ikiwiki-mass-rebuild]](8)