aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-22 17:23:53 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-22 17:23:53 +0000
commitba4e552fe2ce62c7c4f73eab2f09deca1cc24550 (patch)
treecfdb648d95d4745097e4757acedb5510ae63f4f8
parent7cfa6912d7330accaaebc0f84e9397e72eb9e276 (diff)
downloadpaludis-ba4e552fe2ce62c7c4f73eab2f09deca1cc24550.tar.gz
paludis-ba4e552fe2ce62c7c4f73eab2f09deca1cc24550.tar.xz
More configuration docs worl
-rw-r--r--doc/configuration/Makefile.am20
-rw-r--r--doc/configuration/paludisenvironmentonly.html.part9
-rw-r--r--doc/configuration/specpath.html.part.in37
-rw-r--r--doc/paludis.css12
4 files changed, 75 insertions, 3 deletions
diff --git a/doc/configuration/Makefile.am b/doc/configuration/Makefile.am
index 790b3e5..9078f1a 100644
--- a/doc/configuration/Makefile.am
+++ b/doc/configuration/Makefile.am
@@ -12,7 +12,9 @@ CLEANFILES = *~ gmon.out *.gcov *.gcno *.gcda \
fetchers.html \
envvars.html \
synclist \
- fetchlist
+ fetchlist \
+ specpath.html \
+ specpath.html.part
MAINTAINERCLEANFILES = Makefile.in
@@ -22,7 +24,9 @@ EXTRA_DIST = \
hooks.html.part \
syncers.html.part.in \
fetchers.html.part.in \
- envvars.html.part
+ envvars.html.part \
+ specpath.html.part.in \
+ paludisenvironmentonly.html.part
paludisconfigurationhtmldir = $(htmldir)/configuration
@@ -31,7 +35,8 @@ paludisconfigurationhtml_DATA = \
hooks.html \
syncers.html \
fetchers.html \
- envvars.html
+ envvars.html \
+ specpath.html
index.html : header.html.part $(srcdir)/index.html.part footer.html.part
cat header.html.part $(srcdir)/index.html.part footer.html.part > $@
@@ -83,12 +88,21 @@ syncers.html.part : $(srcdir)/syncers.html.part.in synclist
-e 's,###SYNCERS###,,g' \
< $(srcdir)/syncers.html.part.in > syncers.html.part
+specpath.html.part : $(srcdir)/specpath.html.part.in $(srcdir)/paludisenvironmentonly.html.part
+ sed \
+ -e '/###PALUDISENVIRONMENTONLY###/r $(srcdir)/paludisenvironmentonly.html.part' \
+ -e 's,###PALUDISENVIRONMENTONLY###,,g' \
+ < $(srcdir)/specpath.html.part.in > specpath.html.part
+
fetchers.html.part : $(srcdir)/fetchers.html.part.in fetchlist
sed \
-e '/###FETCHERS###/r fetchlist' \
-e 's,###FETCHERS###,,g' \
< $(srcdir)/fetchers.html.part.in > fetchers.html.part
+specpath.html : header.html.part specpath.html.part footer.html.part
+ cat header.html.part specpath.html.part footer.html.part > $@
+
syncers.html : header.html.part syncers.html.part footer.html.part
cat header.html.part syncers.html.part footer.html.part > $@
diff --git a/doc/configuration/paludisenvironmentonly.html.part b/doc/configuration/paludisenvironmentonly.html.part
new file mode 100644
index 0000000..b3e678d
--- /dev/null
+++ b/doc/configuration/paludisenvironmentonly.html.part
@@ -0,0 +1,9 @@
+<!-- vim: set tw=120 ft=html sw=4 sts=4 et : -->
+
+<div class="note">
+ <p>This document applies only to clients using <code>PaludisEnvironment</code>. Any standard client that supports a
+ <code>--environment</code> command line option uses <code>PaludisEnvironment</code> unless overridden, either by
+ explicitly selecting another environment (e.g. <code>--environment portage</code>) or, on distributions also
+ supporting Portage, by lack of a Paludis configuration and presence of a Portage configuration.</p>
+</div>
+
diff --git a/doc/configuration/specpath.html.part.in b/doc/configuration/specpath.html.part.in
new file mode 100644
index 0000000..e091539
--- /dev/null
+++ b/doc/configuration/specpath.html.part.in
@@ -0,0 +1,37 @@
+<!-- vim: set tw=120 ft=html sw=4 sts=4 et : -->
+
+<h1>specpath.conf</h1>
+
+###PALUDISENVIRONMENTONLY###
+
+<h2>Configuration File Locations</h2>
+
+<p>Paludis looks in the following places for configuration files:</p>
+
+<ul>
+ <li><code>${PALUDIS_HOME}/.paludis</code>, if the <code>PALUDIS_HOME</code> environment variable is set, or
+ <code>${HOME}/.paludis</code> otherwise.</li>
+ <li><code>${SYSCONFDIR}/paludis</code>, where <code>SYSCONFDIR</code> is <code>/etc</code> on most systems.</li>
+</ul>
+
+<p>If <code>--environment :suffix</code> or <code>--environment paludis:suffix</code> is specified, Paludis will use
+<code>.paludis-suffix</code> or <code>paludis-suffix</code>. This can be used to maintain multiple configurations, for
+example for chroots.</p>
+
+<h2>specpath.conf</h2>
+
+<p>If a file named <code>specpath.conf</code> exists in the configuration directory, Paludis uses this to find a second,
+real configuration directory. <code>specpath.conf</code> is a standard key=value configuration file, with the following
+keys having recognised meaning:</p>
+
+<dl>
+ <dt><code>root</code></dt>
+ <dd>The real configuration directory is taken to be <code>${root}/SYSCONFDIR/paludis/</code> (note that HOME values
+ are <em>not</em> used). When installing, <code>${root}/</code> is used rather than <code>/</code> as the base
+ install location.</dd>
+
+ <dt><code>config-suffix</code></dt>
+ <dd>If set, Paludis will instead look in <code>${root}/SYSCONFDIR/paludis-suffix</code> for configuration files. By
+ default, no configuration suffix is used under root.</dd>
+</dl>
+
diff --git a/doc/paludis.css b/doc/paludis.css
index 0be9187..1b22996 100644
--- a/doc/paludis.css
+++ b/doc/paludis.css
@@ -14,6 +14,18 @@ div.main p, div.main * p, div.main * li {
text-align: justify;
}
+div.note {
+ margin: 0.2em 2em;
+ padding: 0.2em 0.5em;
+ background-color: #ffeedd;
+ border: 1px solid #996600;
+}
+
+div.note p:first-child:before {
+ content: "Note: ";
+ font-weight: bold;
+}
+
a:link {
text-decoration: none;
font-weight: bold;