aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-22 20:09:29 +0000
committerAvatar Ciaran McCreesh <ciaran.mccreesh@googlemail.com> 2007-10-22 20:09:29 +0000
commit35c6e1d677bf193186e9d7f570c64ada5df6fcf2 (patch)
tree8635b39307496a8485a658935f421d420977ef24
parent51fbce3fc832e342f9fb2b6991f7640fb0ab03f2 (diff)
downloadpaludis-35c6e1d677bf193186e9d7f570c64ada5df6fcf2.tar.gz
paludis-35c6e1d677bf193186e9d7f570c64ada5df6fcf2.tar.xz
keywords.conf docs
-rw-r--r--doc/configuration/Makefile.am13
-rw-r--r--doc/configuration/keywords.html.part.in35
2 files changed, 48 insertions, 0 deletions
diff --git a/doc/configuration/Makefile.am b/doc/configuration/Makefile.am
index 313d1d4..66a3aad 100644
--- a/doc/configuration/Makefile.am
+++ b/doc/configuration/Makefile.am
@@ -17,6 +17,8 @@ CLEANFILES = *~ gmon.out *.gcov *.gcno *.gcda \
specpath.html.part \
environment.html \
environment.html.part \
+ keywords.html \
+ keywords.html.part \
configfiles.html
MAINTAINERCLEANFILES = Makefile.in
@@ -30,6 +32,7 @@ EXTRA_DIST = \
envvars.html.part \
specpath.html.part.in \
environment.html.part.in \
+ keywords.html.part.in \
paludisenvironmentonly.html.part \
configfiles.html.part
@@ -43,6 +46,7 @@ paludisconfigurationhtml_DATA = \
envvars.html \
specpath.html \
environment.html \
+ keywords.html \
configfiles.html
index.html : header.html.part $(srcdir)/index.html.part footer.html.part
@@ -110,6 +114,12 @@ environment.html.part : $(srcdir)/environment.html.part.in $(srcdir)/paludisenvi
-e 's,###PALUDISENVIRONMENTONLY###,,g' \
< $(srcdir)/environment.html.part.in > environment.html.part
+keywords.html.part : $(srcdir)/keywords.html.part.in $(srcdir)/paludisenvironmentonly.html.part
+ sed \
+ -e '/###PALUDISENVIRONMENTONLY###/r $(srcdir)/paludisenvironmentonly.html.part' \
+ -e 's,###PALUDISENVIRONMENTONLY###,,g' \
+ < $(srcdir)/keywords.html.part.in > keywords.html.part
+
fetchers.html.part : $(srcdir)/fetchers.html.part.in fetchlist
sed \
-e '/###FETCHERS###/r fetchlist' \
@@ -119,6 +129,9 @@ fetchers.html.part : $(srcdir)/fetchers.html.part.in fetchlist
environment.html : header.html.part environment.html.part footer.html.part
cat header.html.part environment.html.part footer.html.part > $@
+keywords.html : header.html.part keywords.html.part footer.html.part
+ cat header.html.part keywords.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/keywords.html.part.in b/doc/configuration/keywords.html.part.in
new file mode 100644
index 0000000..91f4db5
--- /dev/null
+++ b/doc/configuration/keywords.html.part.in
@@ -0,0 +1,35 @@
+<!-- vim: set tw=120 ft=html sw=4 sts=4 et : -->
+
+<h1>keywords.conf</h1>
+
+###PALUDISENVIRONMENTONLY###
+
+<p>The <code>keywords.conf</code> file controls which keywords are and are not accepted. It is a standard configuration
+file which may be a bash file and which may use the <code>keywords.conf.d/</code> directory.</p>
+
+<p>Each line in the file consists of a specification followed by one or more accepted keywords. A specification may be
+any of:</p>
+
+<ul>
+ <li>The special specification <code>*/*</code>, which matches all packages. Nearly all users will have at least one
+ line using this specification.</li>
+ <li>A simple <code>category/package</code> name.</li>
+ <li>A simple <code>set</code> name.</li>
+ <li>A complex dependency specification, which may use the full range of operators supported by Paludis, along with
+ <code>:slot</code> and <code>::repository</code> restrictions. Either or both of the category and package parts may
+ be an asterisk (but both must be supplied, even if they are).</li>
+</ul>
+
+<p>Accepted keywords are one of:</p>
+
+<ul>
+ <li><code>keyword</code>, which accepts any package containing that keyword.</li>
+ <li><code>~keyword</code>, which accepts any package containing that ~keyword. This does <em>not</em> automatically
+ accept the regular, non-tilde keyword.</li>
+ <li><code>*</code>, which accepts any package, including one with empty keywords.</li>
+ <li><code>-*</code>, which cancels any previously accepted match (see below).</li>
+</ul>
+
+<p>Accepted keywords are usually cumulative, so if you have a <code>*/* arch ~arch</code> line, you will need to use
+<code>cat/pkg -* arch</code> if you only wish to accept <code>arch</code> for a particular package.</p>
+