response

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

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

-ikiwiki --setup configfile
+ikiwiki --setup setupfile

 
 # DESCRIPTION
 
 `ikiwiki` is a wiki compiler. It builds static HTML pages for a wiki, from
 
 # 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
+`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
 `destination`.
 
 Note that most options can be shortened to single letters, and boolean


@@ -30,11 +30,38 @@ These options control the mode that ikiwiki operates in.
 
   Force a rebuild of all pages.
 
 
   Force a rebuild of all pages.
 

+* --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.
+  If you only want to build any changed pages, you can use --refresh with
+  --setup.
+
+* --dumpsetup setupfile
+
+  Causes ikiwiki to write to the specified setup file, dumping out
+  its current configuration.
+
+* --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 denerated 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

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


@@ -51,23 +78,6 @@ These options control the mode that ikiwiki operates in.
 
   Note that the generated wrapper will ignore all command line parameters.
 
 
   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
 * --aggregate
 
   If the [[plugins/aggregate]] plugin is enabled, this makes ikiwiki poll


@@ -101,20 +111,26 @@ These options control the mode that ikiwiki operates in.
 # CONFIG OPTIONS
 
 These options configure the wiki. Note that [[plugins]] can add additional
 # CONFIG OPTIONS
 
 These options configure the wiki. Note that [[plugins]] can add additional

-configuration options of their own.
+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.
   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.
 
 
   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
+  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 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


@@ -125,36 +141,29 @@ configuration options of their own.
 
   Specify a mode to chmod the wrapper to after creating it.
 
 
   Specify a mode to chmod the wrapper to after creating it.
 

-* --notify, --no-notify
-
-  Enable email notification of commits. This should be used when running
-  ikiwiki as a [[post-commit]] hook.
-
-* --rcs=svn, --no-rcs
-
-  Enable or disable use of a revision control system.
+* --wrappergroup group

 
 

-  If you use svn, the `source` directory is assumed to be
-  a [[Subversion]] working copy.
+  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.

 
 

-  If you use git, the `source` directory is assumed to be a clone of the
-  [[git]] repository.
+* --rcs=svn|git|.., --no-rcs

 
 

-  If you use tla, the `source` directory is assumed to be a tla import.
+  Enable or disable use of a [[revision_control_system|rcs]].

 
 

-  If you use mercurial, the `source` directory is assumed to be the
-  [[mercurial]] repository.
+  The `source` directory will be assumed to be a working copy, or clone, or
+  whatever the revision control system you select uses.

 
   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.
+  the web will be committed.

 
   No revision control is enabled by default.
 
 * --svnrepo /svn/wiki
 
 
   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]].
+  Specify the location of the svn repository for the wiki.

 
 * --svnpath trunk
 
 
 * --svnpath trunk
 


@@ -165,13 +174,25 @@ configuration options of their own.
 
 * --rss, --norss
 
 
 * --rss, --norss
 

-  If rss is set, ikiwiki will generate RSS feeds for pages that inline
-  a [[blog]].
+  If rss is set, ikiwiki will default to generating RSS feeds for pages
+  that inline a [[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 inline directive can
+  override this default and generate a feed.

 
 * --atom, --noatom
 
 
 * --atom, --noatom
 

-  If atom is set, ikiwiki will generate Atom feeds for pages that inline
-  a [[blog]].
+  If atom is set, ikiwiki will default to generating Atom feeds for pages
+  that inline a [[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 inline directive can
+  override this default and generate a feed.

 
 * --pingurl URL
 
 
 * --pingurl URL
 


@@ -215,10 +236,13 @@ configuration options of their own.
 
 * --adminuser name
 
 
 * --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.
+  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.
 
   May be specified multiple times for multiple admins.
 

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

 * --plugin name
 
   Enables the use of the specified [[plugin|plugins]] in the wiki. 
 * --plugin name
 
   Enables the use of the specified [[plugin|plugins]] in the wiki. 


@@ -231,9 +255,10 @@ configuration options of their own.
 
 * --libdir directory
 
 
 * --libdir directory
 

-  Makes ikiwiki look in the specified directory first, before the regular perl
-  library directories. For example, if you set libdir to "/home/you/.ikiwiki/",
-  you can install plugins in "/home/you/.ikiwiki/IkiWiki/Plugin/".
+  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
 
 
 * --discussion, --no-discussion
 


@@ -273,6 +298,11 @@ configuration options of their own.
 
   Toggle creating output files named page/index.html (default) instead of page.html.
 
 
   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 --prefix-directives.
+

 * --w3mmode, --no-w3mmode
 
   Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,
 * --w3mmode, --no-w3mmode
 
   Enable [[w3mmode]], which allows w3m to use ikiwiki as a local CGI script,


@@ -286,21 +316,55 @@ configuration options of their own.
 
 * --getctime
 
 
 * --getctime
 

-  Pull last changed time for each new page out of the revision control
+  Pull creation 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
   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
+  VCS 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
   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
+  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.
 
   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.
 

+# EXAMPLES
+
+* ikiwiki --setup my.setup
+
+  Completly (re)build the wiki using the specified setup file.
+
+* 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
+
+  Refresh the wiki, including regnerating 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
+  all pages, but that you want to immediatly take effect.
+
+# ENVIRONMENT
+
+* 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)
+* [[ikiwiki-update-wikilist]](1)
+* [[ikiwiki-transition]](1)
+

 # AUTHOR
 
 Joey Hess <joey@ikiwiki.info>
 
 # AUTHOR
 
 Joey Hess <joey@ikiwiki.info>
 

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