]> git.vanrenterghem.biz Git - git.ikiwiki.info.git/blobdiff - doc/usage.mdwn
format plugin categorization
[git.ikiwiki.info.git] / doc / usage.mdwn
index 55ff17e94a7e8b0912c3de1a34869e02fa68b51e..e4808d4c256dc6a6d9472dcca21b9c623f01a71f 100644 (file)
@@ -106,11 +106,11 @@ 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.
 
-* --wikiname
+* --wikiname name
 
   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
@@ -122,7 +122,7 @@ also be configured using a setup file.
   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
@@ -249,8 +249,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
-  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
 
@@ -308,10 +308,10 @@ also be configured using a setup file.
 
 * --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
-  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
@@ -345,6 +345,10 @@ also be configured using a setup file.
 
   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)