X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/4db40b4e59c1e735e4176f3e82b825e895306c4c..035d5bca488fa7a98b93b11929bf51816753bcdf:/doc/usage.mdwn?ds=sidebyside diff --git a/doc/usage.mdwn b/doc/usage.mdwn index af3634e13..136e969c2 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 @@ -166,12 +166,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 +215,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 +303,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)