aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-03-13 18:35:23 +0000
committerjoey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071>2006-03-13 18:35:23 +0000
commit4796acdae76a294199e8d8152c3c9ed53db808a2 (patch)
tree26f6088eca8762009cf50de4e20ea3f8421fd83c /doc
parent15d316a812d89abf49be1641b4a611200c49c762 (diff)
downloadikiwiki-4796acdae76a294199e8d8152c3c9ed53db808a2.tar
ikiwiki-4796acdae76a294199e8d8152c3c9ed53db808a2.tar.gz
add --setup, --wrappermode
allow filename param to --wrapper
Diffstat (limited to 'doc')
-rw-r--r--doc/bugs.mdwn6
-rw-r--r--doc/setup.mdwn2
-rw-r--r--doc/todo.mdwn7
-rw-r--r--doc/usage.mdwn33
4 files changed, 34 insertions, 14 deletions
diff --git a/doc/bugs.mdwn b/doc/bugs.mdwn
index 72719ba29..2c712de6d 100644
--- a/doc/bugs.mdwn
+++ b/doc/bugs.mdwn
@@ -27,9 +27,3 @@
markdown, but that will probably be a bear. I guess the question is how
common "[[ ]]" is, and maybe we should just provide a way to escape a
wikilink..
-
-Fixed bugs:
-
-* RecentChanges is supposed to linkify WikiNames and it does, but only if
- the user's page exists. It doesn't add a ?link to a noneistant page to
- aid creating it. (Fixed. -- [[Joey]])
diff --git a/doc/setup.mdwn b/doc/setup.mdwn
index acb401cfc..541131cf9 100644
--- a/doc/setup.mdwn
+++ b/doc/setup.mdwn
@@ -74,4 +74,4 @@ optional support for commits from the web.
--historyurl='http://svn.host/trunk/[[]]?root=wiki'
-11. Enjoy your new wiki! Add yourself to [[IkiWikiUsers]] \ No newline at end of file
+11. Enjoy your new wiki! Add yourself to [[IkiWikiUsers]]
diff --git a/doc/todo.mdwn b/doc/todo.mdwn
index 98b98e3f2..23ade8cbd 100644
--- a/doc/todo.mdwn
+++ b/doc/todo.mdwn
@@ -15,7 +15,7 @@ is built. (As long as all changes to all pages is ok.)
* Should support mail notification of new and changed pages.
- Hmm, should be easy to implement this.. it runs as a svn post-cookit hook
+ Hmm, should be easy to implement this.. it runs as a svn post-coommit hook
already, so just look at the userdb, svnlook at what's changed, and send
mails to people who have subscribed.
@@ -62,6 +62,11 @@ and that includes the date.
What syntax do other wikis use for this? I'm considering "[[ -- ]]" (with
spaces removed) as it has a nice nmemonic.
+OTOH, adding additional syntax for this would be counter to one of the
+design goals for ikiwiki: keeping as much markup as possible out of the
+wiki and not adding nonstandard markup. And it's not significantly hard to
+type "--[[Joey]]", and as to the date, we do have page history.
+
## recentchanges links to commit diffs
Would take a bit more viewcvs integration, let the be a "[diff]" link in
diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index 8f57a1593..8efb9a63d 100644
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -6,13 +6,18 @@ ikiwiki - a wiki compiler
ikiwiki [options] source templates 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`.
+`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
-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, and boolean
+flags such as --verbose can be negated with --no-verbose.
* --wikiname
@@ -26,13 +31,22 @@ Note that most options can be shortened to single letters, and boolean flags suc
Force a rebuild of all pages.
-* --wrapper
+* --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 [[Subversion]] [[post-commit]] hook, or as a [[CGI]].
- Generate a [[wrapper]] binary that is hardcoded to do action specified by the other options, using the specified input files and `destination` directory.
+ 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.
- 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]].
+* --wrappermode mode
- 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.
+ Specify a mode to chmod the wrapper to after creating it.
* --svn, --nosvn
@@ -71,6 +85,13 @@ Note that most options can be shortened to single letters, and boolean flags suc
Specifies a rexexp of source files to exclude from processing.
May be specified multiple times to add to exclude list.
+* --setup configfile
+
+ 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; one is to automatically generate wrappers for a wiki based on
+ data in a config file.
+
# AUTHOR
Joey Hess <joey@kitenet.net>