aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-22 19:00:42 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-22 19:00:42 +0000
commit9e02b0ab52bb058ad7e0145611317574386f87e7 (patch)
tree17e9eb8a85ea6d24d7cf61f323bc52a185134508
parent191d3a0ac0379aad84d43dd3aa4fcfaf16d21a6a (diff)
downloadpaludis-9e02b0ab52bb058ad7e0145611317574386f87e7.tar.gz
paludis-9e02b0ab52bb058ad7e0145611317574386f87e7.tar.xz
Document environment.conf
-rw-r--r--doc/configuration/Makefile.am17
-rw-r--r--doc/configuration/environment.html.part.in23
2 files changed, 38 insertions, 2 deletions
diff --git a/doc/configuration/Makefile.am b/doc/configuration/Makefile.am
index 9078f1a..1e8032f 100644
--- a/doc/configuration/Makefile.am
+++ b/doc/configuration/Makefile.am
@@ -14,7 +14,9 @@ CLEANFILES = *~ gmon.out *.gcov *.gcno *.gcda \
synclist \
fetchlist \
specpath.html \
- specpath.html.part
+ specpath.html.part \
+ environment.html \
+ environment.html.part
MAINTAINERCLEANFILES = Makefile.in
@@ -26,6 +28,7 @@ EXTRA_DIST = \
fetchers.html.part.in \
envvars.html.part \
specpath.html.part.in \
+ environment.html.part.in \
paludisenvironmentonly.html.part
paludisconfigurationhtmldir = $(htmldir)/configuration
@@ -36,7 +39,8 @@ paludisconfigurationhtml_DATA = \
syncers.html \
fetchers.html \
envvars.html \
- specpath.html
+ specpath.html \
+ environment.html
index.html : header.html.part $(srcdir)/index.html.part footer.html.part
cat header.html.part $(srcdir)/index.html.part footer.html.part > $@
@@ -94,12 +98,21 @@ specpath.html.part : $(srcdir)/specpath.html.part.in $(srcdir)/paludisenvironmen
-e 's,###PALUDISENVIRONMENTONLY###,,g' \
< $(srcdir)/specpath.html.part.in > specpath.html.part
+environment.html.part : $(srcdir)/environment.html.part.in $(srcdir)/paludisenvironmentonly.html.part
+ sed \
+ -e '/###PALUDISENVIRONMENTONLY###/r $(srcdir)/paludisenvironmentonly.html.part' \
+ -e 's,###PALUDISENVIRONMENTONLY###,,g' \
+ < $(srcdir)/environment.html.part.in > environment.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
+environment.html : header.html.part environment.html.part footer.html.part
+ cat header.html.part environment.html.part footer.html.part > $@
+
specpath.html : header.html.part specpath.html.part footer.html.part
cat header.html.part specpath.html.part footer.html.part > $@
diff --git a/doc/configuration/environment.html.part.in b/doc/configuration/environment.html.part.in
new file mode 100644
index 0000000..5698491
--- /dev/null
+++ b/doc/configuration/environment.html.part.in
@@ -0,0 +1,23 @@
+<!-- vim: set tw=120 ft=html sw=4 sts=4 et : -->
+
+<h1>environment.conf</h1>
+
+###PALUDISENVIRONMENTONLY###
+
+<p>The optional file <code>environment.conf</code> can be used to control general environment settings. It is a standard
+key=value configuration file, and may optionally be in bash format. Recognised keys are as follows:</p>
+
+<dl>
+ <dt>reduced_username</dt>
+ <dd>If set, Paludis will use this username rather than <code>paludisbuild</code> when a reduced privilege user is
+ required.</dd>
+
+ <dt>portage_compatible</dt>
+ <dd>If set to a non-empty string, Paludis will automatically mask any packages that would break Portage. This can be
+ used if Paludis and Portage are to be used on the same machine. This does <em>not</em> disable cache options that
+ would cause interoperability problems.</dd>
+
+ <dt>distribution</dt>
+ <dd>If set, overrides the distribution used when distribution-specific defaults are used.</dd>
+</dl>
+