X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/d7fdd04b5a113b6dded40cb79b670b16570c11b3..9020cfde2da85e98768e76903517177a6a41be42:/doc/usage.mdwn diff --git a/doc/usage.mdwn b/doc/usage.mdwn index 354e266f1..2b104bcdb 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -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 @@ -114,6 +113,11 @@ configuration options of their own. build time. If the templatedir is changed, missing templates will still be searched for in the default location as a fallback. + Note that if you choose to copy and modify ikiwiki's templates, you will need + to be careful to keep them up to date when upgrading to new versions of + ikiwiki. Old versions of templates do not always work with new ikiwiki + versions. + * --underlaydir Specify the directory that is used to underlay the source directory. @@ -141,11 +145,14 @@ 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. + * --svnpath trunk Specify the path inside your svn repository where the wiki is located. @@ -155,13 +162,25 @@ configuration options of their own. * --rss, --norss - If rss is set, ikiwiki will generate RSS feeds for pages that inline - a [[ikiwiki/blog]]. + If rss is set, ikiwiki will default to generating RSS feeds for pages + that inline a [[ikiwiki/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. * --atom, --noatom - If atom is set, ikiwiki will generate Atom feeds for pages that inline - a [[ikiwiki/blog]]. + If atom is set, ikiwiki will default to generating Atom feeds for pages + that inline a [[ikiwiki/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. * --pingurl URL @@ -207,8 +226,8 @@ configuration options of their own. 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. + and [[banning|banned_users]] 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://". @@ -267,6 +286,11 @@ configuration options of their own. Toggle creating output files named page/index.html (default) instead of page.html. +* --prefix-directives, --no-prefix-directives + + Toggle new '!'-prefixed syntax for preprocessor directives. ikiwiki currently + defaults to --no-prefix-directives. + * --w3mmode, --no-w3mmode Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script, @@ -303,6 +327,7 @@ configuration options of their own. * [[ikiwiki-mass-rebuild]](8) * [[ikiwiki-update-wikilist]](1) +* [[ikiwiki-transition]](1) # AUTHOR