commit.

[git.ikiwiki.info.git] / doc / ikiwiki-update-wikilist.mdwn

diff --git a/doc/ikiwiki-update-wikilist.mdwn b/doc/ikiwiki-update-wikilist.mdwn
new file mode 100644 (file)
index 0000000..4e87f92
--- /dev/null
+++ b/doc/ikiwiki-update-wikilist.mdwn
@@ -0,0 +1,28 @@
+# NAME
+
+ikiwiki-update-wikilist - add or remove user from /etc/ikiwiki/wikilist
+
+# SYNOPSIS
+
+ikiwiki-update-wikilist
+
+# DESCRIPTION
+
+`ikiwiki-update-wikilist` is designed to be made suid root, but not installed
+suid by default. If made suid, it allows users to add or remove their names
+from the `/etc/ikiwiki/wikilist` file. If a user's name is not in the file,
+it will be added; if the name is already present, it will be removed.
+
+If your name is in `/etc/ikiwiki/wikilist`, the [[ikiwiki-mass-rebuild]](8)
+command will look for a ~/.ikiwiki/wikilist file, and rebuild the wikis listed
+in that file.
+
+# OPTIONS
+
+None.
+
+# AUTHOR
+
+Joey Hess <joey@ikiwiki.info>
+
+Warning: this page is automatically made into ikiwiki-update-wikilist's man page, edit with care