X-Git-Url: http://git.vanrenterghem.biz/git.ikiwiki.info.git/blobdiff_plain/f7f45d6a0ad41f3cd077b0310ce83f199b658b4d..69065b8e79cce13648db711ed1fefaf6f41713fd:/doc/usage.mdwn?ds=inline diff --git a/doc/usage.mdwn b/doc/usage.mdwn index 0377014fd..aba213f21 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -4,99 +4,304 @@ ikiwiki - a wiki compiler # SYNOPSIS -ikiwiki [options] source templates destination +ikiwiki [options] source destination ikiwiki --setup configfile # DESCRIPTION -`ikiwiki` is a wiki compiler. It builds static html pages for a wiki, from -`source` in the [[MarkDown]] language, using the specified html `templates` -and writes it out to `destination`. - -# OPTIONS +`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 flags such as --verbose can be negated with --no-verbose. -* --wikiname +# MODE OPTIONS - The name of the wiki, default is "wiki". +These options control the mode that ikiwiki operates in. -* --verbose +* --refresh - Be vebose about what it's doing. + Refresh the wiki, updating any changed pages. This is the default + behavior so you don't normally need to specify it. * --rebuild 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, registration, and displaying + [[RecentChanges]]. + + 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 + 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 [[Subversion]] [[post-commit]] hook, or as a [[CGI]]. + 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 + --setup. + +* --wrappers + + If used with --setup --refresh, this makes it also update any configured + wrappers. + +* --aggregate + + If the [[plugins/aggregate]] plugin is enabled, this makes ikiwiki poll + configured feeds and save new posts to the srcdir. + + Note that to rebuild previously aggregated posts, use the --rebuild option + along with this one. --rebuild will also force feeds to be polled even if + they were polled recently. + +* --render file + + Renders a single file, outputting the resulting html. Does not save state, + so this cannot be used for building whole wikis, but it is useful for + previewing an edited file at the command line. Generally used in conjunction + with --setup to load in a wiki's setup: - Note that the generated wrapper will ignore all command line parameters - except for --params, which will make it print out the parameters it would - run ikiwiki with. + 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's version number. + +# CONFIG OPTIONS + +These options configure the wiki. Note that [[plugins]] can add additional +configuration options of their own. + +* --wikiname + + The name of the wiki, default is "wiki". + +* --templatedir + + 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. + +* --underlaydir + + Specify the directory that is used to underlay the source directory. + Source files will be taken from here unless overridden by a file in the + source directory. Default is `/usr/share/ikiwiki/basewiki` or another + location as configured at build time. * --wrappermode mode Specify a mode to chmod the wrapper to after creating it. -* --svn, --nosvn +* --notify, --no-notify - Enable or disable use of [[subversion]]. If subversion is enabled, the `source` directory is assumed to be a working copy, and is automatically updated before building the wiki. + Enable email notification of commits. This should be used when running + ikiwiki as a [[post-commit]] hook. - In [[CGI]] mode, with subversion enabled pages edited via the web will be committed to subversion. Also, the [[RecentChanges]] link will be placed on pages. +* --rcs=svn, --no-rcs - Subversion is enabled by default. + Enable or disable use of a revision control system. -* --anonok, --noanonok + If you use svn, the `source` directory is assumed to be + a [[Subversion]] working copy. - If anonok is set, it will allow anonymous web users, who have not signed in, to make changes to the wiki. + If you use git, the `source` directory is assumed to be a clone of the + [[git]] repository. - By default, anonymous users cannot edit the wiki. + If you use tla, the `source` directory is assumed to be a tla import. -* --cgi + 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 + the web will be committed. Also, the [[RecentChanges]] link will be placed + on pages. + + 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]]. + +* --svnpath trunk + + 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 "". - Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and supports editing pages, signing in, registration, and displaying [[RecentChanges]]. +* --rss, --norss - To use ikiwiki as a [[CGI]] program you need to use --wrapper to generate a wrapper. The wrapper will generally need to run suid 6755 to the user who owns the `source` and `destination` directories. + If rss is set, ikiwiki will generate RSS feeds for pages that inline + a [[blog]]. -* --url http://someurl/ +* --atom, --noatom - Specifies the url to the wiki. This is a required parameter in [[CGI]] mode. + If atom is set, ikiwiki will generate Atom feeds for pages that inline + a [[blog]]. -* --cgiurl http://someurl/ikiwiki.cgi +* --pingurl URL - Specifies the url to the ikiwiki [[CGI]] script [[wrapper]]. Required when building the wiki for links to the cgi script to be generated. + 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 -* --historyurl http://svn.someurl/trunk/[[]]?root=wiki + This parameter can be specified multiple times to specify more than one + URL to ping. - Specifies the url to link to for page history browsing. In the url, "[[]]" is replaced with the page to browse. It's common to use [[ViewCVS]] for this. +* --url URL + + Specifies the URL to the wiki. This is a required parameter in [[CGI]] mode. + +* --cgiurl http://example.org/ikiwiki.cgi + + 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 + + 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 + [[ViewVC]] for this. + +* --adminemail you@example.org + + Specifies the email address that ikiwiki should use for sending email. + +* --diffurl 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 + [[ViewVC]] for this. * --exclude regexp Specifies a rexexp of source files to exclude from processing. May be specified multiple times to add to exclude list. -* --setup configfile +* --adminuser name - In setup mode, ikiwiki reads the config file, which is really a perl - program that can call ikiwiki internal functions. Uses of this are - various; the normal one is to automatically generate wrappers for a - wiki based on data in a config file. - - Note that the wiki will be (re)built as part of the setup process to - ensure that any changes take effect. + 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. - [[ikiwiki.setup]] is an example of such a config file. +* --plugin name + + Enables the use of the specified [[plugin|plugins]] in the wiki. + 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. + +* --libdir directory + + Makes ikiwiki look in the specified directory first, before the regular + locations when loading library files and plugins. For example, if you set + libdir to "/home/you/.ikiwiki/", you can install a Foo.pm plugin as + "/home/you/.ikiwiki/IkiWiki/Plugin/Foo.pm". + +* --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 at the bottom of a page. + 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 + subdirectory of the wiki. The default is to link to pages in the toplevel + directory of the wiki. + +* --htmlext html + + Configures the extension used for generated html files. Default is "html". + +* --timeformat format + + Specify how to display the time or date. The format string is passed to the + strftime(3) function. + +* --verbose, --no-verbose + + Be verbose about what is being done. + +* --syslog, --no-syslog + + Log to syslog(3). + +* --usedirs, --no-usedirs + + Toggle creating output files named page/index.html (default) instead of page.html. + +* --w3mmode, --no-w3mmode + + Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script, + without a web server. + +* --sslcookie + + Only send cookies over an SSL connection. This should prevent them being + intercepted. If you enable this option then you must run at least the + CGI portion of ikiwiki over SSL. + +* --getctime + + 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, 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. + +* --set var=value + + This allows setting an arbitrary configuration variable, the same as if it + were set via a configuration file. Since most options can be configured + 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. # AUTHOR -Joey Hess +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