From 8051316904d13de3e467f01ebaeacaa5d8efb1b6 Mon Sep 17 00:00:00 2001 From: Joey Hess Date: Sat, 26 Jul 2008 19:28:15 -0400 Subject: add missing setup options, tweak others' display --- IkiWiki.pm | 34 ++++++++++++++++++++++++---------- IkiWiki/Plugin/amazon_s3.pm | 12 +++++------- IkiWiki/Plugin/anonok.pm | 3 +-- IkiWiki/Plugin/attachment.pm | 2 +- IkiWiki/Plugin/mirrorlist.pm | 2 +- 5 files changed, 32 insertions(+), 21 deletions(-) diff --git a/IkiWiki.pm b/IkiWiki.pm index a2b9a3e24..2f274f384 100644 --- a/IkiWiki.pm +++ b/IkiWiki.pm @@ -252,7 +252,29 @@ sub getsetup () { #{{{ safe => 0, # paranoia rebuild => 0, }, - + umask => { + type => "integer", + description => "", + example => "022", + description => "force ikiwiki to use a particular umask", + safe => 0, # paranoia + rebuild => 0, + }, + libdir => { + type => "string", + default => "", + example => "$ENV{HOME}/.ikiwiki/", + description => "extra library and plugin directory", + safe => 0, # directory + rebuild => 0, + }, + ENV => { + type => "string", + default => {}, + description => "environment variables", + safe => 0, # paranoia + rebuild => 0, + }, exclude => { type => "string", default => undef, @@ -342,14 +364,6 @@ sub getsetup () { #{{{ safe => 0, rebuild => 0, }, - libdir => { - type => "internal", - default => undef, - example => "$ENV{HOME}/.ikiwiki/", - description => "extra library and plugin directory", - safe => 0, - rebuild => 0, - }, } #}}} sub defaultconfig () { #{{{ @@ -408,7 +422,7 @@ sub checkconfig () { #{{{ require IkiWiki::Rcs::Stub; } - if (exists $config{umask}) { + if (defined $config{umask}) { umask(possibly_foolish_untaint($config{umask})); } diff --git a/IkiWiki/Plugin/amazon_s3.pm b/IkiWiki/Plugin/amazon_s3.pm index 9cb74fb1e..d9279b680 100644 --- a/IkiWiki/Plugin/amazon_s3.pm +++ b/IkiWiki/Plugin/amazon_s3.pm @@ -44,21 +44,20 @@ sub getsetup () { #{{{ return amazon_s3_key_id => { type => "string", - default => "", + example => "XXXXXXXXXXXXXXXXXXXX", description => "public access key id", safe => 1, rebuild => 0, }, amazon_s3_key_id => { type => "string", - default => "", - description => "file holding secret key", + example => "$ENV{HOME}/.s3_key", + description => "file holding secret key (must not be readable by others!)", safe => 0, # ikiwiki reads this file rebuild => 0, }, amazon_s3_bucket => { type => "string", - default => "", example => "mywiki", description => "globally unique name of bucket to store wiki in", safe => 1, @@ -66,14 +65,13 @@ sub getsetup () { #{{{ }, amazon_s3_prefix => { type => "string", - default => "wiki/", + example => "wiki/", description => "a prefix to prepend to each page name", safe => 1, rebuild => 1, }, amazon_s3_location => { type => "string", - default => "", example => "EU", description => "which S3 datacenter to use (leave blank for default)", safe => 1, @@ -82,7 +80,7 @@ sub getsetup () { #{{{ amazon_s3_dupindex => { type => "boolean", default => 0, - description => "store each index file twice? (to allow urls ending in \"/index.html\" and \"/\")", + description => "store each index file twice? (allows urls ending in \"/index.html\" and \"/\")", safe => 1, rebuild => 1, }, diff --git a/IkiWiki/Plugin/anonok.pm b/IkiWiki/Plugin/anonok.pm index e61549986..7b966f845 100644 --- a/IkiWiki/Plugin/anonok.pm +++ b/IkiWiki/Plugin/anonok.pm @@ -14,9 +14,8 @@ sub getsetup () { #{{{ return anonok_pagespec => { type => "string", - default => "", example => "*/discussion", - description => "PageSpec to limit which pages anonymouse users can edit", + description => "PageSpec to limit which pages anonymous users can edit", safe => 1, rebuild => 0, }, diff --git a/IkiWiki/Plugin/attachment.pm b/IkiWiki/Plugin/attachment.pm index 3fe33c858..6f707832d 100644 --- a/IkiWiki/Plugin/attachment.pm +++ b/IkiWiki/Plugin/attachment.pm @@ -14,7 +14,7 @@ sub import { #{{{ sub getsetup () { #{{{ return - => { + virus_checker => { type => "string", default => "", example => "clamdscan -", diff --git a/IkiWiki/Plugin/mirrorlist.pm b/IkiWiki/Plugin/mirrorlist.pm index c7630d81f..eb273561d 100644 --- a/IkiWiki/Plugin/mirrorlist.pm +++ b/IkiWiki/Plugin/mirrorlist.pm @@ -14,7 +14,7 @@ sub getsetup () { #{{{ return mirrorlist => { type => "string", - default => "", + default => {}, description => "list of mirrors", safe => 1, rebuild => 1, -- cgit v1.2.3