aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-22 20:09:18 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-22 20:09:18 +0000
commit51fbce3fc832e342f9fb2b6991f7640fb0ab03f2 (patch)
tree24c43720e9b703de7cdee4aa180598d9d02d2327
parent9e02b0ab52bb058ad7e0145611317574386f87e7 (diff)
downloadpaludis-51fbce3fc832e342f9fb2b6991f7640fb0ab03f2.tar.gz
paludis-51fbce3fc832e342f9fb2b6991f7640fb0ab03f2.tar.xz
Config files doc
-rw-r--r--doc/configuration/Makefile.am12
-rw-r--r--doc/configuration/configfiles.html.part28
2 files changed, 37 insertions, 3 deletions
diff --git a/doc/configuration/Makefile.am b/doc/configuration/Makefile.am
index 1e8032f..313d1d4 100644
--- a/doc/configuration/Makefile.am
+++ b/doc/configuration/Makefile.am
@@ -16,7 +16,8 @@ CLEANFILES = *~ gmon.out *.gcov *.gcno *.gcda \
specpath.html \
specpath.html.part \
environment.html \
- environment.html.part
+ environment.html.part \
+ configfiles.html
MAINTAINERCLEANFILES = Makefile.in
@@ -29,7 +30,8 @@ EXTRA_DIST = \
envvars.html.part \
specpath.html.part.in \
environment.html.part.in \
- paludisenvironmentonly.html.part
+ paludisenvironmentonly.html.part \
+ configfiles.html.part
paludisconfigurationhtmldir = $(htmldir)/configuration
@@ -40,11 +42,15 @@ paludisconfigurationhtml_DATA = \
fetchers.html \
envvars.html \
specpath.html \
- environment.html
+ environment.html \
+ configfiles.html
index.html : header.html.part $(srcdir)/index.html.part footer.html.part
cat header.html.part $(srcdir)/index.html.part footer.html.part > $@
+configfiles.html : header.html.part $(srcdir)/configfiles.html.part footer.html.part
+ cat header.html.part $(srcdir)/configfiles.html.part footer.html.part > $@
+
envvars.html : header.html.part $(srcdir)/envvars.html.part footer.html.part
cat header.html.part $(srcdir)/envvars.html.part footer.html.part > $@
diff --git a/doc/configuration/configfiles.html.part b/doc/configuration/configfiles.html.part
new file mode 100644
index 0000000..d16fbaf
--- /dev/null
+++ b/doc/configuration/configfiles.html.part
@@ -0,0 +1,28 @@
+<!-- vim: set tw=120 ft=html sw=4 sts=4 et : -->
+
+<h1>Configuration File Formats</h1>
+
+<h2>In General</h2>
+
+<p>Configuration files for Paludis are plain text files. Blank lines are ignored, as are lines that start with a hash
+(<code>#</code>) character. Leading and trailing whitespace is not generally significant. Lines ending in a single
+backslash are continuations.</p>
+
+<h2>Key=Value Files</h2>
+
+<p>Some configuration files use a key=value format. Keys are typically case sensitive. Variable expansion of previously
+set variables is supported via <code>$var</code> or <code>${var}</code>. Quoting with single or double quotes is usually
+supported but not usually required.</p>
+
+<h2>Bash Files</h2>
+
+<p>Where explicitly noted, if a configuration file with a <code>.conf</code> extension does not exist, but a like-named
+executable file with a <code>.bash</code> extension does exist, Paludis will execute the bash file and treat its
+standard output as if it were the contents of the <code>.conf</code> file.</p>
+
+<h2>conf.d Directories</h2>
+
+<p>Where explicitly noted, for configuration files named <code>foo.conf</code>, Paludis will also look in the directory
+<code>foo.conf.d/</code> for any additional files named <code>*.conf</code> (and, if bash is supported for that file,
+<code>*.bash</code> as above).</p>
+