From: Tilman Sauerbeck <tilman@code-monkey.de>
Date: Sun, 1 Oct 2006 09:42:46 +0000 (+0200)
Subject: added documentation for the INSTALL rules
X-Git-Url: http://gitweb/?a=commitdiff_plain;h=14ab4111bddf38e32facfb586955d39e077d1fd5;p=pkgutils-cross.git

added documentation for the INSTALL rules
---

diff --git a/pkgadd.8.in b/pkgadd.8.in
index 1cfb195..564672c 100644
--- a/pkgadd.8.in
+++ b/pkgadd.8.in
@@ -32,13 +32,7 @@ Print version and exit.
 .B "\-h, \-\-help"
 Print help and exit.
 .SH CONFIGURATION
-When using \fBpkgadd\fP in upgrade mode (i.e. option -u is used) the
-file \fI/etc/pkgadd.conf\fP will be read. This file can contain rules describing
-how pkgadd should behave when doing upgrades. A rule is built out of three
-fragments, \fIevent\fP, \fIpattern\fP and \fIaction\fP. The event describes
-in what kind of situation this rule applies. Currently only one type of event is
-supported, that is \fBUPGRADE\fP. The pattern is a regular expression and the action
-applicable to the \fBUPGRADE\fP event is \fBYES\fP and \fBNO\fP. More than one rule of the same
+\fBpkgadd\fP is configured by the file \fI/etc/pkgadd.conf\fP. This file can contain rules, that are built out of three fragments: \fIevent\fP, \fIpattern\fP and \fIaction\fP. The event describes in what kind of situation this rule applies. Currently there are two types of events: \fBUPGRADE\fP and \fBINSTALL\fP. \fBUPGRADE\fP rules are applied when a package is installed over an existing version, and \fBINSTALL\fP rules are applied in any case. The pattern is a regular expression. The action applicable to both the \fBUPGRADE\fP and \fBINSTALL\fP event is \fBYES\fP and \fBNO\fP. More than one rule of the same
 event type is allowed, in which case the first rule will have the lowest priority and the last rule
 will have the highest priority. Example:
 
@@ -51,7 +45,7 @@ UPGRADE         ^etc/X11/XF86Config$    NO
 
 The above example will cause pkgadd to never upgrade anything in /etc/ or /var/log/ (subdirectories included),
 except files in /etc/X11/ (subdirectories included), unless it is the file /etc/X11/XF86Config.
-The default rule is to upgrade everything, rules in this file are exceptions to that rule.
+The default rule is to upgrade/install everything, rules in this file are exceptions to that rule.
 (NOTE! A \fIpattern\fP should never contain an initial "/" since you are referring to the files in the
 package, not the files on the disk.)