X-Git-Url: https://sipb.mit.edu/gitweb.cgi/ikiwiki.git/blobdiff_plain/8a801dc02d0d259d546c7ee392493bc97bbb1638..804ebb7289d0c92a73ba13c95ad8e9a50deb4349:/doc/usage.mdwn diff --git a/doc/usage.mdwn b/doc/usage.mdwn index 9980cca03..0107b36ce 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -10,8 +10,8 @@ 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 +`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 `destination`. Note that most options can be shortened to single letters, and boolean @@ -19,7 +19,7 @@ flags such as --verbose can be negated with --no-verbose. # MODE OPTIONS -These options control the mode that ikiwiki is operating in. +These options control the mode that ikiwiki operates in. * --refresh @@ -86,9 +86,17 @@ These options control the mode that ikiwiki is operating in. ikiwiki --setup ~/ikiwiki.setup --render foo.mdwn +* --post-commit + + Run in post-commit mode, the same as if called by a [[post-commit]] hook. + This is probably only useful when using ikiwiki with a web server on one host + and a repository on another, to allow the repository's real post-commit + hook to ssh to the web server host and manually run ikiwiki to update + the web site. + * --version - Print ikiwiki version number. + Print ikiwiki's version number. # CONFIG OPTIONS @@ -101,8 +109,8 @@ configuration options of their own. * --templatedir - Specify the directory that the page [[templates]] are stored in. Default - is `/usr/share/ikiwiki/templates`, or another location as configured at + Specify the directory that the page [[templates|wikitemplates]] are stored in. + Default is `/usr/share/ikiwiki/templates`, or another location as configured at build time. If the templatedir is changed, missing templates will still be searched for in the default location as a fallback. @@ -117,7 +125,7 @@ configuration options of their own. Specify a mode to chmod the wrapper to after creating it. -* --notify +* --notify, --no-notify Enable email notification of commits. This should be used when running ikiwiki as a [[post-commit]] hook. @@ -137,7 +145,7 @@ configuration options of their own. If you use mercurial, the `source` directory is assumed to be the [[mercurial]] repository. - In [[CGI]] mode, with a revision control system enabled pages edited via + 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. @@ -146,19 +154,14 @@ configuration options of their own. * --svnrepo /svn/wiki Specify the location of the svn repository for the wiki. This is required - for using --notify with [[subversion]]. + for using --notify with [[Subversion]]. * --svnpath trunk - 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. - - By default, anonymous users cannot edit the wiki. + Specify the path inside your svn repository where the wiki is located. + This defaults to `trunk`; change it if your wiki is at some other path + inside the repository. If your wiki is rooted at the top of the repository, + set svnpath to "". * --rss, --norss @@ -167,43 +170,43 @@ configuration options of their own. * --atom, --noatom - If atom is set, ikiwiki will generate Arom feeds for pages that inline + If atom is set, ikiwiki will generate Atom feeds for pages that inline a [[blog]]. -* --pingurl url +* --pingurl URL - Set this to the url to an XML-RPC service to ping when an RSS feed is - updated. For example, to ping Technorati, use the url + Set this to the URL of an XML-RPC service to ping when an RSS feed is + updated. For example, to ping Technorati, use the URL http://rpc.technorati.com/rpc/ping This parameter can be specified multiple times to specify more than one - url to ping. + URL to ping. -* --url url +* --url URL - 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://url/ikiwiki.cgi +* --cgiurl http://example.org/ikiwiki.cgi - Specifies the url to the ikiwiki [[CGI]] script wrapper. Required when + Specifies the URL to the ikiwiki [[CGI]] script wrapper. Required when building the wiki for links to the cgi script to be generated. -* --historyurl url +* --historyurl URL - Specifies the url to link to for page history browsing. In the url, + 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. + [[ViewVC]] for this. -* --adminemail you@yourhost +* --adminemail you@example.org Specifies the email address that ikiwiki should use for sending email. -* --diffurl url +* --diffurl URL - Specifies the url to link to for a diff of changes to a page. In the url, + 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. + [[ViewVC]] for this. * --exclude regexp @@ -213,24 +216,29 @@ 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. + Currently allows locking of any page; other powers may be added later. May be specified multiple times for multiple admins. * --plugin name Enables the use of the specified [[plugin|plugins]] in the wiki. - Note that plugin names are case sensative. + Note that plugin names are case sensitive. * --disable-plugin name Disables use of a plugin. For example "--disable-plugin htmlscrubber" - to do away with html sanitization. + to do away with HTML sanitization. * --discussion, --no-discussion Enables or disables "Discussion" links from being added to the header of every page. The links are enabled by default. +* --numbacklinks n + + Controls how many backlinks should be displayed maximum. Excess backlinks + will be hidden in a popup. Default is 10. Set to 0 to disable this feature. + * --userdir subdir Optionally, allows links to users of the wiki to link to pages inside a @@ -248,7 +256,11 @@ configuration options of their own. * --syslog, --no-syslog - Log to syslog. + Log to syslog(3). + +* --usedirs, --no-usedirs + + Create output files named page/index.html instead of page.html. * --w3mmode, --no-w3mmode @@ -265,12 +277,12 @@ configuration options of their own. Pull last changed time for each new page 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. It is best used + times of items in weblogs, such as when building a wiki from a new + Subversion checkout. It is unoptimised and quite slow. It is best used with --rebuild, to force ikiwiki to get the ctime for all pages. # AUTHOR -Joey Hess +Joey Hess -Warning: this page is automatically made into ikiwiki's man page, edit with care +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