2007-11-18 23:25:23 +01:00
|
|
|
# NAME
|
2006-03-12 06:14:41 +01:00
|
|
|
|
|
|
|
ikiwiki - a wiki compiler
|
|
|
|
|
|
|
|
# SYNOPSIS
|
|
|
|
|
2006-03-23 03:53:03 +01:00
|
|
|
ikiwiki [options] source destination
|
2006-03-12 06:14:41 +01:00
|
|
|
|
2015-03-01 16:26:20 +01:00
|
|
|
ikiwiki --setup setupfile [options]
|
2006-03-13 19:35:23 +01:00
|
|
|
|
2006-03-12 06:14:41 +01:00
|
|
|
# DESCRIPTION
|
|
|
|
|
2007-02-14 02:30:55 +01:00
|
|
|
`ikiwiki` is a wiki compiler. It builds static HTML pages for a wiki, from
|
2007-12-08 21:59:08 +01:00
|
|
|
`source` in the [[ikiwiki/Markdown]] language (or others), and writes it out to
|
2006-07-04 00:08:04 +02:00
|
|
|
`destination`.
|
2006-03-12 06:14:41 +01:00
|
|
|
|
2015-03-01 16:26:20 +01:00
|
|
|
Note that most options can be shortened to single letters, boolean
|
|
|
|
flags such as --verbose can be negated with --no-verbose, and
|
|
|
|
options such as --verbose can also be spelled like -verbose.
|
2006-03-12 06:14:41 +01:00
|
|
|
|
2006-03-26 07:24:03 +02:00
|
|
|
# MODE OPTIONS
|
2006-03-12 06:14:41 +01:00
|
|
|
|
2007-02-14 02:30:55 +01:00
|
|
|
These options control the mode that ikiwiki operates in.
|
2006-03-12 06:14:41 +01:00
|
|
|
|
2006-03-26 07:08:41 +02:00
|
|
|
* --refresh
|
|
|
|
|
2015-03-01 16:26:20 +01:00
|
|
|
Refresh the wiki, updating any changed pages. This is the default
|
|
|
|
behavior if no other mode action is specified (but note that --setup is
|
|
|
|
a mode action, and has different default behavior).
|
2006-03-26 07:08:41 +02:00
|
|
|
|
2006-03-26 07:24:03 +02:00
|
|
|
* --rebuild
|
2006-03-26 04:30:44 +02:00
|
|
|
|
2006-03-26 07:24:03 +02:00
|
|
|
Force a rebuild of all pages.
|
2006-03-26 04:30:44 +02:00
|
|
|
|
2009-03-08 01:11:34 +01:00
|
|
|
* --setup setupfile
|
2006-03-26 07:24:03 +02:00
|
|
|
|
2015-03-01 16:26:20 +01:00
|
|
|
Load options from the given setup file. If no other mode action is specified,
|
|
|
|
generate wrappers and rebuild the wiki, as if --rebuild --wrappers were used.
|
2006-12-23 06:58:15 +01:00
|
|
|
If you only want to build any changed pages, you can use --refresh with
|
|
|
|
--setup.
|
2006-03-26 07:24:03 +02:00
|
|
|
|
2010-07-08 20:01:52 +02:00
|
|
|
* --changesetup setupfile
|
|
|
|
|
|
|
|
Reads the setup file, adds any configuration changes specified by other
|
|
|
|
options, and writes the new configuration back to the setup file. Also
|
|
|
|
updates any configured wrappers. In this mode, the wiki is not fully
|
|
|
|
rebuilt, unless you also add --rebuild.
|
|
|
|
|
|
|
|
Example, to enable some plugins:
|
|
|
|
|
|
|
|
ikiwiki --changesetup ~/ikiwiki.setup --plugin goodstuff --plugin calendar
|
|
|
|
|
2009-03-08 01:11:34 +01:00
|
|
|
* --dumpsetup setupfile
|
2008-07-26 18:47:54 +02:00
|
|
|
|
2009-03-08 01:11:34 +01:00
|
|
|
Causes ikiwiki to write to the specified setup file, dumping out
|
2008-07-26 18:47:54 +02:00
|
|
|
its current configuration.
|
|
|
|
|
2006-07-30 06:31:08 +02:00
|
|
|
* --wrappers
|
|
|
|
|
|
|
|
If used with --setup --refresh, this makes it also update any configured
|
|
|
|
wrappers.
|
|
|
|
|
2010-02-28 06:12:47 +01:00
|
|
|
* --clean
|
|
|
|
|
2011-03-23 17:54:39 +01:00
|
|
|
This makes ikiwiki clean up by removing any files it generated in the
|
2010-02-28 06:12:47 +01:00
|
|
|
`destination` directory, as well as any configured wrappers, and the
|
|
|
|
`.ikiwiki` state directory. This is mostly useful if you're running
|
|
|
|
ikiwiki in a Makefile to build documentation and want a corresponding
|
|
|
|
`clean` target.
|
|
|
|
|
2008-08-08 22:41:55 +02:00
|
|
|
* --cgi
|
|
|
|
|
|
|
|
Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and
|
|
|
|
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
|
|
|
|
the user who owns the `source` and `destination` directories.
|
|
|
|
|
|
|
|
* --wrapper [file]
|
|
|
|
|
|
|
|
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 [[post-commit]] hook, or as a [[CGI]].
|
|
|
|
|
|
|
|
Note that the generated wrapper will ignore all command line parameters.
|
|
|
|
|
2006-07-30 06:31:08 +02:00
|
|
|
* --aggregate
|
|
|
|
|
2006-08-27 07:36:16 +02:00
|
|
|
If the [[plugins/aggregate]] plugin is enabled, this makes ikiwiki poll
|
|
|
|
configured feeds and save new posts to the srcdir.
|
2006-07-30 06:31:08 +02:00
|
|
|
|
2006-07-31 00:58:48 +02:00
|
|
|
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.
|
|
|
|
|
2006-09-21 23:34:29 +02:00
|
|
|
* --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:
|
|
|
|
|
|
|
|
ikiwiki --setup ~/ikiwiki.setup --render foo.mdwn
|
|
|
|
|
2007-03-29 20:27:00 +02:00
|
|
|
* --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.
|
|
|
|
|
2006-08-13 04:03:43 +02:00
|
|
|
* --version
|
|
|
|
|
2007-02-14 02:30:55 +01:00
|
|
|
Print ikiwiki's version number.
|
2006-08-13 04:03:43 +02:00
|
|
|
|
2006-03-26 07:24:03 +02:00
|
|
|
# CONFIG OPTIONS
|
|
|
|
|
2006-08-27 07:36:16 +02:00
|
|
|
These options configure the wiki. Note that [[plugins]] can add additional
|
2009-03-08 01:11:34 +01:00
|
|
|
configuration options of their own. All of these options and more besides can
|
|
|
|
also be configured using a setup file.
|
2006-03-26 07:24:03 +02:00
|
|
|
|
2009-03-13 21:31:27 +01:00
|
|
|
* --wikiname name
|
2006-03-26 07:24:03 +02:00
|
|
|
|
|
|
|
The name of the wiki, default is "wiki".
|
|
|
|
|
2009-03-13 21:31:27 +01:00
|
|
|
* --templatedir dir
|
2006-03-26 07:24:03 +02:00
|
|
|
|
2010-04-23 22:10:46 +02:00
|
|
|
Specify the directory that [[templates|templates]] are stored in.
|
2007-03-31 08:55:12 +02:00
|
|
|
Default is `/usr/share/ikiwiki/templates`, or another location as configured at
|
2007-01-12 21:48:19 +01:00
|
|
|
build time. If the templatedir is changed, missing templates will still
|
2010-04-23 22:10:46 +02:00
|
|
|
be searched for in the default location as a fallback. Templates can also be
|
|
|
|
placed in the "templates/" subdirectory of the srcdir.
|
2006-03-26 07:24:03 +02:00
|
|
|
|
2008-05-06 20:33:03 +02:00
|
|
|
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.
|
|
|
|
|
2009-03-13 21:31:27 +01:00
|
|
|
* --underlaydir dir
|
2006-03-29 20:21:01 +02:00
|
|
|
|
|
|
|
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
|
2006-08-25 04:12:43 +02:00
|
|
|
source directory. Default is `/usr/share/ikiwiki/basewiki` or another
|
|
|
|
location as configured at build time.
|
2006-03-29 20:21:01 +02:00
|
|
|
|
2006-03-13 19:35:23 +01:00
|
|
|
* --wrappermode mode
|
2006-03-12 06:14:41 +01:00
|
|
|
|
2006-03-13 19:35:23 +01:00
|
|
|
Specify a mode to chmod the wrapper to after creating it.
|
2006-03-12 06:14:41 +01:00
|
|
|
|
2007-11-14 15:27:11 +01:00
|
|
|
* --wrappergroup group
|
|
|
|
|
|
|
|
Specify what unix group the wrapper should be owned by. This can be
|
|
|
|
useful if the wrapper needs to be owned by a group other than the default.
|
|
|
|
For example, if a project has a repository with multiple committers with
|
|
|
|
access controlled by a group, it makes sense for the ikiwiki wrappers
|
|
|
|
to run setgid to that group.
|
|
|
|
|
2007-08-21 06:25:03 +02:00
|
|
|
* --rcs=svn|git|.., --no-rcs
|
2006-03-12 06:14:41 +01:00
|
|
|
|
2007-08-21 06:25:03 +02:00
|
|
|
Enable or disable use of a [[revision_control_system|rcs]].
|
2006-03-12 06:14:41 +01:00
|
|
|
|
2007-08-21 06:25:03 +02:00
|
|
|
The `source` directory will be assumed to be a working copy, or clone, or
|
|
|
|
whatever the revision control system you select uses.
|
2006-09-06 22:31:55 +02:00
|
|
|
|
2007-02-14 02:30:55 +01:00
|
|
|
In [[CGI]] mode, with a revision control system enabled, pages edited via
|
2008-01-29 21:51:32 +01:00
|
|
|
the web will be committed.
|
2006-03-12 06:14:41 +01:00
|
|
|
|
2007-01-24 22:11:07 +01:00
|
|
|
No revision control is enabled by default.
|
2006-03-12 06:14:41 +01:00
|
|
|
|
2008-04-17 20:37:55 +02:00
|
|
|
* --svnrepo /svn/wiki
|
|
|
|
|
|
|
|
Specify the location of the svn repository for the wiki.
|
|
|
|
|
2006-04-25 01:05:17 +02:00
|
|
|
* --svnpath trunk
|
|
|
|
|
2007-02-14 02:30:55 +01:00
|
|
|
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
|
2007-04-16 21:07:52 +02:00
|
|
|
inside the repository. If your wiki is rooted at the top of the repository,
|
|
|
|
set svnpath to "".
|
2006-04-25 01:05:17 +02:00
|
|
|
|
2006-03-23 22:00:51 +01:00
|
|
|
* --rss, --norss
|
|
|
|
|
2008-02-05 00:36:50 +01:00
|
|
|
If rss is set, ikiwiki will default to generating RSS feeds for pages
|
2008-09-12 01:39:05 +02:00
|
|
|
that inline a [[blog]].
|
2008-02-05 00:36:50 +01:00
|
|
|
|
|
|
|
* --allowrss
|
|
|
|
|
|
|
|
If allowrss is set, and rss is not set, ikiwiki will not default to
|
2008-09-12 01:39:05 +02:00
|
|
|
generating RSS feeds, but setting `rss=yes` in the inline directive can
|
|
|
|
override this default and generate a feed.
|
2006-10-09 01:57:37 +02:00
|
|
|
|
|
|
|
* --atom, --noatom
|
|
|
|
|
2008-02-05 00:36:50 +01:00
|
|
|
If atom is set, ikiwiki will default to generating Atom feeds for pages
|
2008-09-12 01:39:05 +02:00
|
|
|
that inline a [[blog]].
|
2008-02-05 00:36:50 +01:00
|
|
|
|
|
|
|
* --allowatom
|
|
|
|
|
|
|
|
If allowatom is set, and rss is not set, ikiwiki will not default to
|
2008-09-12 01:39:05 +02:00
|
|
|
generating Atom feeds, but setting `atom=yes` in the inline directive can
|
|
|
|
override this default and generate a feed.
|
2006-03-23 22:00:51 +01:00
|
|
|
|
2007-02-14 02:30:55 +01:00
|
|
|
* --pingurl URL
|
2006-06-27 03:13:03 +02:00
|
|
|
|
2007-02-14 02:30:55 +01:00
|
|
|
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
|
2006-06-27 03:13:03 +02:00
|
|
|
http://rpc.technorati.com/rpc/ping
|
|
|
|
|
|
|
|
This parameter can be specified multiple times to specify more than one
|
2007-02-14 02:30:55 +01:00
|
|
|
URL to ping.
|
2006-06-27 03:13:03 +02:00
|
|
|
|
2007-02-14 02:30:55 +01:00
|
|
|
* --url URL
|
2006-03-12 06:14:41 +01:00
|
|
|
|
2007-02-14 02:30:55 +01:00
|
|
|
Specifies the URL to the wiki. This is a required parameter in [[CGI]] mode.
|
2006-03-12 06:14:41 +01:00
|
|
|
|
2007-02-14 02:30:55 +01:00
|
|
|
* --cgiurl http://example.org/ikiwiki.cgi
|
2006-03-12 06:14:41 +01:00
|
|
|
|
2007-02-14 02:30:55 +01:00
|
|
|
Specifies the URL to the ikiwiki [[CGI]] script wrapper. Required when
|
2006-05-02 04:34:33 +02:00
|
|
|
building the wiki for links to the cgi script to be generated.
|
2006-03-12 06:14:41 +01:00
|
|
|
|
2007-02-14 02:30:55 +01:00
|
|
|
* --historyurl URL
|
2006-03-12 06:14:41 +01:00
|
|
|
|
2007-02-14 02:30:55 +01:00
|
|
|
Specifies the URL to link to for page history browsing. In the URL,
|
2006-03-21 02:18:01 +01:00
|
|
|
"\[[file]]" is replaced with the file to browse. It's common to use
|
2007-02-09 06:34:40 +01:00
|
|
|
[[ViewVC]] for this.
|
2006-03-21 02:18:01 +01:00
|
|
|
|
2007-02-14 02:30:55 +01:00
|
|
|
* --adminemail you@example.org
|
2006-04-25 01:05:17 +02:00
|
|
|
|
|
|
|
Specifies the email address that ikiwiki should use for sending email.
|
|
|
|
|
2007-02-14 02:30:55 +01:00
|
|
|
* --diffurl URL
|
2006-03-21 02:18:01 +01:00
|
|
|
|
2007-02-14 02:30:55 +01:00
|
|
|
Specifies the URL to link to for a diff of changes to a page. In the URL,
|
2006-03-21 02:18:01 +01:00
|
|
|
"\[[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
|
2007-02-09 06:34:40 +01:00
|
|
|
[[ViewVC]] for this.
|
2006-03-12 06:14:41 +01:00
|
|
|
|
2006-03-13 03:08:04 +01:00
|
|
|
* --exclude regexp
|
|
|
|
|
|
|
|
Specifies a rexexp of source files to exclude from processing.
|
|
|
|
May be specified multiple times to add to exclude list.
|
|
|
|
|
2010-03-14 19:58:13 +01:00
|
|
|
* --include regexp
|
|
|
|
|
|
|
|
Specifies a rexexp of source files, that would normally be excluded,
|
|
|
|
but that you wish to include in processing.
|
|
|
|
May be specified multiple times to add to include list.
|
|
|
|
|
2006-03-23 02:40:46 +01:00
|
|
|
* --adminuser name
|
|
|
|
|
2008-01-19 19:57:37 +01:00
|
|
|
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,
|
2012-02-24 16:45:33 +01:00
|
|
|
and [[banning|banned_users]] users, as well as powers granted by
|
|
|
|
enabled plugins (such as [[moderating comments|plugins/moderatedcomments]]
|
|
|
|
and [[plugins/websetup]]. May be specified multiple times for multiple
|
|
|
|
admins.
|
2006-03-23 02:40:46 +01:00
|
|
|
|
2008-01-19 20:55:22 +01:00
|
|
|
For an openid user specify the full URL of the login, including "http://".
|
|
|
|
|
2006-05-02 04:34:33 +02:00
|
|
|
* --plugin name
|
|
|
|
|
2006-06-02 07:32:20 +02:00
|
|
|
Enables the use of the specified [[plugin|plugins]] in the wiki.
|
2007-02-14 02:30:55 +01:00
|
|
|
Note that plugin names are case sensitive.
|
2006-05-02 04:34:33 +02:00
|
|
|
|
2006-05-05 07:41:11 +02:00
|
|
|
* --disable-plugin name
|
|
|
|
|
|
|
|
Disables use of a plugin. For example "--disable-plugin htmlscrubber"
|
2007-02-14 02:30:55 +01:00
|
|
|
to do away with HTML sanitization.
|
2006-05-05 07:41:11 +02:00
|
|
|
|
2007-07-27 02:48:06 +02:00
|
|
|
* --libdir directory
|
|
|
|
|
2007-08-13 05:07:31 +02:00
|
|
|
Makes ikiwiki look in the specified directory first, before the regular
|
|
|
|
locations when loading library files and plugins. For example, if you set
|
2010-01-02 00:48:00 +01:00
|
|
|
libdir to "/home/you/.ikiwiki/", you can install a foo.pm plugin as
|
|
|
|
"/home/you/.ikiwiki/IkiWiki/Plugin/foo.pm".
|
2007-07-27 02:48:06 +02:00
|
|
|
|
2006-05-05 20:20:52 +02:00
|
|
|
* --discussion, --no-discussion
|
|
|
|
|
|
|
|
Enables or disables "Discussion" links from being added to the header of
|
|
|
|
every page. The links are enabled by default.
|
|
|
|
|
2007-03-31 10:48:10 +02:00
|
|
|
* --numbacklinks n
|
|
|
|
|
2007-07-25 04:34:48 +02:00
|
|
|
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.
|
2007-03-31 10:48:10 +02:00
|
|
|
|
2006-12-19 17:58:55 +01:00
|
|
|
* --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.
|
|
|
|
|
2007-07-25 03:16:53 +02:00
|
|
|
* --htmlext html
|
|
|
|
|
|
|
|
Configures the extension used for generated html files. Default is "html".
|
|
|
|
|
2006-05-29 07:09:43 +02:00
|
|
|
* --timeformat format
|
|
|
|
|
|
|
|
Specify how to display the time or date. The format string is passed to the
|
|
|
|
strftime(3) function.
|
|
|
|
|
2006-08-16 23:17:49 +02:00
|
|
|
* --verbose, --no-verbose
|
2006-03-13 20:10:29 +01:00
|
|
|
|
2006-12-28 20:58:11 +01:00
|
|
|
Be verbose about what is being done.
|
2006-05-02 04:34:33 +02:00
|
|
|
|
2006-08-16 23:17:49 +02:00
|
|
|
* --syslog, --no-syslog
|
|
|
|
|
2007-02-14 02:30:55 +01:00
|
|
|
Log to syslog(3).
|
2006-08-16 23:17:49 +02:00
|
|
|
|
2007-04-01 21:59:42 +02:00
|
|
|
* --usedirs, --no-usedirs
|
|
|
|
|
2007-08-08 23:33:34 +02:00
|
|
|
Toggle creating output files named page/index.html (default) instead of page.html.
|
2007-04-01 21:59:42 +02:00
|
|
|
|
2008-02-09 03:35:12 +01:00
|
|
|
* --prefix-directives, --no-prefix-directives
|
|
|
|
|
|
|
|
Toggle new '!'-prefixed syntax for preprocessor directives. ikiwiki currently
|
2009-03-08 22:07:12 +01:00
|
|
|
defaults to --prefix-directives.
|
2008-02-09 03:35:12 +01:00
|
|
|
|
2006-07-07 23:00:48 +02:00
|
|
|
* --w3mmode, --no-w3mmode
|
|
|
|
|
|
|
|
Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,
|
|
|
|
without a web server.
|
|
|
|
|
2006-08-27 22:25:05 +02:00
|
|
|
* --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.
|
|
|
|
|
2010-04-17 00:29:45 +02:00
|
|
|
* --gettime, --no-gettime
|
2006-05-02 04:34:33 +02:00
|
|
|
|
2010-04-16 23:02:29 +02:00
|
|
|
Extract creation and modification times for each new page from the
|
|
|
|
the revision control's log. This is done automatically when building a
|
|
|
|
wiki for the first time, so you normally do not need to use this option.
|
2006-03-13 19:35:23 +01:00
|
|
|
|
2007-08-04 08:27:47 +02:00
|
|
|
* --set var=value
|
|
|
|
|
|
|
|
This allows setting an arbitrary configuration variable, the same as if it
|
2010-04-25 20:16:53 +02:00
|
|
|
were set via a setup file. Since most commonly used options can be
|
2010-03-24 19:39:50 +01:00
|
|
|
configured using command-line switches, you will rarely need to use this.
|
|
|
|
|
|
|
|
* --set-yaml var=value
|
|
|
|
|
|
|
|
This is like --set, but it allows setting configuration variables that
|
|
|
|
use complex data structures, by passing in a YAML document.
|
2007-08-04 08:27:47 +02:00
|
|
|
|
2009-03-08 01:11:34 +01:00
|
|
|
# EXAMPLES
|
|
|
|
|
|
|
|
* ikiwiki --setup my.setup
|
|
|
|
|
2010-10-02 14:56:15 +02:00
|
|
|
Completely (re)build the wiki using the specified setup file.
|
2009-03-08 01:11:34 +01:00
|
|
|
|
|
|
|
* ikiwiki --setup my.setup --refresh
|
|
|
|
|
|
|
|
Refresh the wiki, using settings from my.setup, and avoid
|
|
|
|
rebuilding any pages that have not changed. This is faster.
|
|
|
|
|
|
|
|
* ikiwiki --setup my.setup --refresh --wrappers
|
|
|
|
|
2015-03-01 16:26:20 +01:00
|
|
|
Refresh the wiki, including regenerating all wrapper programs,
|
2009-03-08 01:11:34 +01:00
|
|
|
but do not rebuild all pages. Useful if you have changed something
|
|
|
|
in the setup file that does not need a full wiki rebuild to update
|
2015-03-01 16:26:20 +01:00
|
|
|
all pages, but that you want to immediately take effect.
|
|
|
|
|
|
|
|
* ikiwiki --rebuild srcdir destdir
|
|
|
|
|
|
|
|
Use srcdir as source and build HTML in destdir, without using a
|
|
|
|
setup file.
|
|
|
|
|
|
|
|
* ikiwiki srcdir destdir
|
|
|
|
|
|
|
|
Use srcdir as source to update changed pages' HTML in destdir,
|
|
|
|
without using a setup file.
|
2009-03-08 01:11:34 +01:00
|
|
|
|
2007-11-25 21:50:31 +01:00
|
|
|
# ENVIRONMENT
|
|
|
|
|
|
|
|
* CC
|
|
|
|
|
|
|
|
This controls what C compiler is used to build wrappers. Default is 'cc'.
|
|
|
|
|
2009-10-21 22:27:44 +02:00
|
|
|
* CFLAGS
|
|
|
|
|
|
|
|
This can be used to pass options to the C compiler when building wrappers.
|
|
|
|
|
2007-09-06 01:31:24 +02:00
|
|
|
# SEE ALSO
|
|
|
|
|
|
|
|
* [[ikiwiki-mass-rebuild]](8)
|
2007-09-06 02:32:11 +02:00
|
|
|
* [[ikiwiki-update-wikilist]](1)
|
2008-05-15 22:54:41 +02:00
|
|
|
* [[ikiwiki-transition]](1)
|
2007-09-06 01:31:24 +02:00
|
|
|
|
2006-03-12 06:14:41 +01:00
|
|
|
# AUTHOR
|
|
|
|
|
2007-02-18 21:24:40 +01:00
|
|
|
Joey Hess <joey@ikiwiki.info>
|
2006-03-15 05:40:32 +01:00
|
|
|
|
2011-12-07 18:24:59 +01:00
|
|
|
Warning: Automatically converted into a man page by mdwn2man. Edit with care
|