aboutsummaryrefslogtreecommitdiff
path: root/doc/ikiwiki-update-wikilist.mdwn
diff options
context:
space:
mode:
authorJoey Hess <joey@kodama.kitenet.net>2008-07-27 00:02:04 -0400
committerJoey Hess <joey@kodama.kitenet.net>2008-07-27 00:02:04 -0400
commitbc3363beb767a82e3bdde2d038e7b678bd35f193 (patch)
tree8e3c5cd08dac5029a9546d0f8acbda8dbd7fe26a /doc/ikiwiki-update-wikilist.mdwn
parent4ef96e2d9994c407f0f2f46301eb91fab6b48a37 (diff)
downloadikiwiki-bc3363beb767a82e3bdde2d038e7b678bd35f193.tar
ikiwiki-bc3363beb767a82e3bdde2d038e7b678bd35f193.tar.gz
ikiwiki-update-wikilist: Add -r switch to remove. Default behavior is now always to add.
Diffstat (limited to 'doc/ikiwiki-update-wikilist.mdwn')
-rw-r--r--doc/ikiwiki-update-wikilist.mdwn10
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/ikiwiki-update-wikilist.mdwn b/doc/ikiwiki-update-wikilist.mdwn
index 4e87f92e6..e5ea72e36 100644
--- a/doc/ikiwiki-update-wikilist.mdwn
+++ b/doc/ikiwiki-update-wikilist.mdwn
@@ -4,14 +4,16 @@ ikiwiki-update-wikilist - add or remove user from /etc/ikiwiki/wikilist
# SYNOPSIS
-ikiwiki-update-wikilist
+ikiwiki-update-wikilist [-r]
# DESCRIPTION
-`ikiwiki-update-wikilist` is designed to be made suid root, but not installed
+`ikiwiki-update-wikilist` is designed to be made suid root, but is 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.
+from the `/etc/ikiwiki/wikilist` file.
+
+By default, the user's name will be added.
+The `-r` switch causes the user's name to 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