diff options
author | joey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071> | 2007-07-27 00:48:06 +0000 |
---|---|---|
committer | joey <joey@0fa5a96a-9a0e-0410-b3b2-a0fd24251071> | 2007-07-27 00:48:06 +0000 |
commit | 1e5cd11635ef45e8223f56b952c8636d993e5908 (patch) | |
tree | 7c2b2a3dc1e36e82b5fb7af47118b00396bb6910 /doc | |
parent | b4fa92f9e74d48281f285b4a682ec41e24e686db (diff) |
* Add a libdir config option to let ikiwiki load perl modules, including
plugins, from a user-configurable directory.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/ikiwiki.setup | 2 | ||||
-rw-r--r-- | doc/plugins.mdwn | 8 | ||||
-rw-r--r-- | doc/plugins/contrib.mdwn | 4 | ||||
-rw-r--r-- | doc/usage.mdwn | 6 |
4 files changed, 12 insertions, 8 deletions
diff --git a/doc/ikiwiki.setup b/doc/ikiwiki.setup index a772ca60b..9d2859a86 100644 --- a/doc/ikiwiki.setup +++ b/doc/ikiwiki.setup @@ -109,6 +109,8 @@ use IkiWiki::Setup::Standard { # htmltidy fortune sidebar map rst anonok}], # If you want to disable any of the default plugins, list them here. #disable_plugins => [qw{inline htmlscrubber passwordauth openid}], + # To add a directory to the perl searh path, use this. + #libdir => "/home/me/.ikiwiki/", # For use with the tag plugin, make all tags be located under a # base page. diff --git a/doc/plugins.mdwn b/doc/plugins.mdwn index 255f13f67..3f154f1f0 100644 --- a/doc/plugins.mdwn +++ b/doc/plugins.mdwn @@ -11,14 +11,6 @@ To enable plugins, use the `--plugin` switch described in Enable the [[goodstuff]] plugin to get a nice selection of plugins that will fit most uses of ikiwiki. -Without administrator access, you can add some custom plugins by storing -yourcustomplugin.pm in /home/user/.ikiwiki/IkiWiki/Plugins (or any other -place, keeping the "IkiWiki/Plugins" part of the path) and adding this -line at the begining of your ikiwiki.setup file: - - BEGIN { push @INC, "/home/user/.ikiwiki" } - - ## Plugin directory [[inline pages="plugins/* and !plugins/type/* and !plugins/write and diff --git a/doc/plugins/contrib.mdwn b/doc/plugins/contrib.mdwn index ae234f67b..dc8b90771 100644 --- a/doc/plugins/contrib.mdwn +++ b/doc/plugins/contrib.mdwn @@ -13,3 +13,7 @@ IkiWiki::Plugin namespace, so they go in a IkiWiki/Plugin subdirectory inside the perl search path. For example, if your perl looks in `/usr/local/lib/site_perl` for modules, you can locally install ikiwiki plugins to `/usr/local/lib/site_perl/IkiWiki/Plugin` + +You can use the `libdir` configuration option to add a directory to the +search path. For example, if you set `libdir` to `/home/you/.ikiwiki/`, +then ikiwiki will look for plugins in `/home/you/.ikiwiki/IkiWiki/Plugins`. diff --git a/doc/usage.mdwn b/doc/usage.mdwn index a8bb92d68..c83f833fc 100644 --- a/doc/usage.mdwn +++ b/doc/usage.mdwn @@ -229,6 +229,12 @@ configuration options of their own. Disables use of a plugin. For example "--disable-plugin htmlscrubber" to do away with HTML sanitization. +* --libdir directory + + Makes ikiwiki look in the specified directory first, before the regular perl + library directories. For example, if you set libdir to "/home/you/.ikiwiki/", + you can install plugins in "/home/you/.ikiwiki/IkiWiki/Plugins/". + * --discussion, --no-discussion Enables or disables "Discussion" links from being added to the header of |