aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Bo ├śrsted Andresen <bo.andresen@zlin.dk> 2013-03-29 16:48:45 +0100
committerAvatar Bo ├śrsted Andresen <bo.andresen@zlin.dk> 2013-03-29 16:53:19 +0100
commit6ca518bb0665c9d32ef040fe027e04f403382389 (patch)
tree84e3055bc9285def09fedee87c5c6159024633c9
parent5f4ee74aff5d13911d2114a0737e0ced14d81296 (diff)
downloadpaludis-6ca518bb0665c9d32ef040fe027e04f403382389.tar.gz
paludis-6ca518bb0665c9d32ef040fe027e04f403382389.tar.xz
Document fetchers and syncers in confdir.
-rw-r--r--doc/configuration/fetchers.html.part.in20
-rw-r--r--doc/configuration/syncers.html.part.in20
2 files changed, 34 insertions, 6 deletions
diff --git a/doc/configuration/fetchers.html.part.in b/doc/configuration/fetchers.html.part.in
index a81c8f9..7224250 100644
--- a/doc/configuration/fetchers.html.part.in
+++ b/doc/configuration/fetchers.html.part.in
@@ -19,9 +19,23 @@ fetchers can be replaced (for example, if you want to use something other than <
<h2>User Defined Fetchers</h2>
<p>To write your own fetcher for protocol <code>proto</code>, create an executable script named <code>doproto</code> (the
-<code>do</code> prefix is essential) and place it in <code>SHAREDIR/paludis/fetchers/</code>, where <code>SHAREDIR</code>
-is probably <code>/usr/share</code>. This directory has priority over the usual Paludis fetcher locations, so it can be
-used to override existing fetchers as well as creating new ones.</p>
+<code>do</code> prefix is essential). Fetchers may be located in any of the following directories:
+
+<ul>
+ <li><code><em>confdir</em>/fetchers/</code>, where
+ <code><em>confdir</em></code> is the directory in which <code>use.conf</code>
+ et al. reside.</li>
+
+ <li><code><em>DATADIR</em>/paludis/fetchers/</code>. On most
+ systems, <code><em>DATADIR</em></code> is <code>/usr/share</code>.</li>
+
+ <li><code><em>LIBEXECDIR</em>/paludis/fetchers/</code>. On most
+ systems, <code><em>LIBEXECDIR</em></code> is <code>/usr/libexec</code>.</li>
+</ul>
+
+<p>Paludis places its own fetchers in
+<code><em>LIBEXECDIR</em>/fetchers/<em>doproto</em></code>. This directory is
+not for end user use.</p>
<p>A fetcher is called with two parameters, the source URI and the destination filename. It indicates success or failure
via its exit status.</p>
diff --git a/doc/configuration/syncers.html.part.in b/doc/configuration/syncers.html.part.in
index b302a35..aeaec11 100644
--- a/doc/configuration/syncers.html.part.in
+++ b/doc/configuration/syncers.html.part.in
@@ -29,9 +29,23 @@ Paludis.</p>
<h2>User Defined Syncers</h2>
<p>To write your own syncer for protocol <code>proto</code>, create an executable script named <code>doproto</code> (the
-<code>do</code> prefix is essential) and place it in <code>SHAREDIR/paludis/syncers/</code>, where <code>SHAREDIR</code>
-is probably <code>/usr/share</code>. This directory has priority over the usual Paludis syncer locations, so it can be
-used to override existing syncers as well as creating new ones.</p>
+<code>do</code> prefix is essential). Syncers may be located in any of the following directories:
+
+<ul>
+ <li><code><em>confdir</em>/syncers/</code>, where
+ <code><em>confdir</em></code> is the directory in which <code>use.conf</code>
+ et al. reside.</li>
+
+ <li><code><em>DATADIR</em>/paludis/syncers/</code>. On most
+ systems, <code><em>DATADIR</em></code> is <code>/usr/share</code>.</li>
+
+ <li><code><em>LIBEXECDIR</em>/paludis/syncers/</code>. On most
+ systems, <code><em>LIBEXECDIR</em></code> is <code>/usr/libexec</code>.</li>
+</ul>
+
+<p>Paludis places its own syncers in
+<code><em>LIBEXECDIR</em>/syncers/<em>doproto</em></code>. This directory is
+not for end user use.</p>
<p>A syncer script can be called in two ways:</p>