(no commit message)

[git.ikiwiki.info.git] / doc / usage.mdwn

diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index 55ff17e94a7e8b0912c3de1a34869e02fa68b51e..4bfe2312c9263f5c32a94de70a6e5d83270483bc 100644 (file)
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -6,7 +6,7 @@ ikiwiki - a wiki compiler
 
 ikiwiki [options] source destination
 
 
 ikiwiki [options] source destination
 

-ikiwiki --setup setupfile
+ikiwiki --setup setupfile [options]

 
 # DESCRIPTION
 
 
 # DESCRIPTION
 


@@ -14,8 +14,9 @@ ikiwiki --setup setupfile
 `source` in the [[ikiwiki/Markdown]] language (or others), and writes it out to
 `destination`.
 
 `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
-flags such as --verbose can be negated with --no-verbose.
+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.

 
 # MODE OPTIONS
 
 
 # MODE OPTIONS
 


@@ -24,7 +25,8 @@ These options control the mode that ikiwiki operates in.
 * --refresh
 
   Refresh the wiki, updating any changed pages. This is the default
 * --refresh
 
   Refresh the wiki, updating any changed pages. This is the default

-  behavior so you don't normally need to specify it.
+  behavior if no other mode action is specified (but note that --setup is
+  a mode action, and has different default behavior).

 
 * --rebuild
 
 
 * --rebuild
 


@@ -32,14 +34,22 @@ These options control the mode that ikiwiki operates in.
 
 * --setup setupfile
 
 
 * --setup setupfile
 

-  In setup mode, ikiwiki reads the config file, which is really a perl
-  program that can call ikiwiki internal functions.
-
-  The default action when --setup is specified is to automatically generate
-  wrappers for a wiki based on data in a setup file, and rebuild the wiki.
+  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.

   If you only want to build any changed pages, you can use --refresh with
   --setup.
 
   If you only want to build any changed pages, you can use --refresh with
   --setup.
 

+* --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
+

 * --dumpsetup setupfile
 
   Causes ikiwiki to write to the specified setup file, dumping out
 * --dumpsetup setupfile
 
   Causes ikiwiki to write to the specified setup file, dumping out


@@ -50,6 +60,14 @@ These options control the mode that ikiwiki operates in.
   If used with --setup --refresh, this makes it also update any configured
   wrappers.
 
   If used with --setup --refresh, this makes it also update any configured
   wrappers.
 

+* --clean
+
+  This makes ikiwiki clean up by removing any files it generated in the
+  `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.
+

 * --cgi
 
   Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and
 * --cgi
 
   Enable [[CGI]] mode. In cgi mode ikiwiki runs as a cgi script, and


@@ -106,23 +124,24 @@ These options configure the wiki. Note that [[plugins]] can add additional
 configuration options of their own. All of these options and more besides can
 also be configured using a setup file.
 
 configuration options of their own. All of these options and more besides can
 also be configured using a setup file.
 

-* --wikiname
+* --wikiname name

 
   The name of the wiki, default is "wiki".
 
 
   The name of the wiki, default is "wiki".
 

-* --templatedir
+* --templatedir dir

 
 

-  Specify the directory that the page [[templates|wikitemplates]] are stored in.
+  Specify the directory that [[templates|templates]] 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
   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.
+  be searched for in the default location as a fallback. Templates can also be
+  placed in the "templates/" subdirectory of the srcdir.

 
   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.
 
 
   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
+* --underlaydir dir

 
   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
 
   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


@@ -226,12 +245,20 @@ also be configured using a setup file.
   Specifies a rexexp of source files to exclude from processing.
   May be specified multiple times to add to exclude list.
 
   Specifies a rexexp of source files to exclude from processing.
   May be specified multiple times to add to exclude list.
 

+* --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.
+

 * --adminuser name
 
   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,
 * --adminuser name
 
   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|banned_users]] users; other powers may be added later.
-  May be specified multiple times for multiple admins.
+  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.

 
   For an openid user specify the full URL of the login, including "http://".
 
 
   For an openid user specify the full URL of the login, including "http://".
 


@@ -249,8 +276,8 @@ also be configured using a setup file.
 
   Makes ikiwiki look in the specified directory first, before the regular
   locations when loading library files and plugins. For example, if you set
 
   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".
+  libdir to "/home/you/.ikiwiki/", you can install a foo.pm plugin as
+  "/home/you/.ikiwiki/IkiWiki/Plugin/foo.pm".

 
 * --discussion, --no-discussion
 
 
 * --discussion, --no-discussion
 


@@ -306,26 +333,28 @@ also be configured using a setup file.
   intercepted. If you enable this option then you must run at least the 
   CGI portion of ikiwiki over SSL.
 
   intercepted. If you enable this option then you must run at least the 
   CGI portion of ikiwiki over SSL.
 

-* --getctime
+* --gettime, --no-gettime

 
 

-  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.
+  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.

 
 * --set var=value
   
   This allows setting an arbitrary configuration variable, the same as if it
 
 * --set var=value
   
   This allows setting an arbitrary configuration variable, the same as if it

-  were set via a setup 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.
+  were set via a setup file. Since most commonly used options can be
+  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.

 
 # EXAMPLES
 
 * ikiwiki --setup my.setup
 
 
 # EXAMPLES
 
 * ikiwiki --setup my.setup
 

-  Completly (re)build the wiki using the specified setup file.
+  Completely (re)build the wiki using the specified setup file.

 
 * ikiwiki --setup my.setup --refresh
 
 
 * ikiwiki --setup my.setup --refresh
 


@@ -334,10 +363,20 @@ also be configured using a setup file.
 
 * ikiwiki --setup my.setup --refresh --wrappers
 
 
 * ikiwiki --setup my.setup --refresh --wrappers
 

-  Refresh the wiki, including regnerating all wrapper programs,
+  Refresh the wiki, including regenerating all wrapper programs,

   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
   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

-  all pages, but that you want to immediatly take effect.
+  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.

 
 # ENVIRONMENT
 
 
 # ENVIRONMENT
 


@@ -345,6 +384,10 @@ also be configured using a setup file.
 
   This controls what C compiler is used to build wrappers. Default is 'cc'.
 
 
   This controls what C compiler is used to build wrappers. Default is 'cc'.
 

+* CFLAGS
+
+  This can be used to pass options to the C compiler when building wrappers.
+

 # SEE ALSO
 
 * [[ikiwiki-mass-rebuild]](8)
 # SEE ALSO
 
 * [[ikiwiki-mass-rebuild]](8)


@@ -355,4 +398,4 @@ also be configured using a setup file.
 
 Joey Hess <joey@ikiwiki.info>
 
 
 Joey Hess <joey@ikiwiki.info>
 

-Warning: this page is automatically made into ikiwiki's man page via [mdwn2man](http://git.ikiwiki.info/?p=ikiwiki;a=blob;f=mdwn2man;hb=HEAD).  Edit with care
+Warning: Automatically converted into a man page by mdwn2man. Edit with care