CRUX-ARM : Home

Home :: Documentation :: Download :: Development :: Community :: Ports :: Packages :: Bugs :: Links :: About :: Donors
prepared the code for the addition of the INSTALL rule
[pkgutils-cross.git] / pkgadd.8.in
CommitLineData
9ac667e6
SR
1.TH pkgadd 8 "" "pkgutils #VERSION#" ""
2.SH NAME
3pkgadd \- install software package
4.SH SYNOPSIS
5\fBpkgadd [options] <file>\fP
6.SH DESCRIPTION
7\fBpkgadd\fP is a \fIpackage management\fP utility, which installs
8a software package. A \fIpackage\fP is an archive of files (.pkg.tar.gz).
9.SH OPTIONS
10.TP
11.B "\-u, \-\-upgrade"
12Upgrade/replace package with the same name as <file>.
13.TP
14.B "\-f, \-\-force"
15Force installation, overwrite conflicting files. If the package
16that is about to be installed contains files that are already
17installed this option will cause all those files to be overwritten.
18This option should be used with care, preferably not at all.
19.TP
20.B "\-r, \-\-root <path>"
21Specify alternative installation root (default is "/"). This
22should \fInot\fP be used as a way to install software into
23e.g. /usr/local instead of /usr. Instead this should be used
24if you want to install a package on a temporary mounted partition,
25which is "owned" by another system. By using this option you not only
26specify where the software should be installed, but you also
27specify which package database to use.
28.TP
29.B "\-v, \-\-version"
30Print version and exit.
31.TP
32.B "\-h, \-\-help"
33Print help and exit.
34.SH CONFIGURATION
35When using \fBpkgadd\fP in upgrade mode (i.e. option -u is used) the
36file \fI/etc/pkgadd.conf\fP will be read. This file can contain rules describing
37how pkgadd should behave when doing upgrades. A rule is built out of three
38fragments, \fIevent\fP, \fIpattern\fP and \fIaction\fP. The event describes
39in what kind of situation this rule applies. Currently only one type of event is
40supported, that is \fBUPGRADE\fP. The pattern is a regular expression and the action
41applicable to the \fBUPGRADE\fP event is \fBYES\fP and \fBNO\fP. More than one rule of the same
42event type is allowed, in which case the first rule will have the lowest priority and the last rule
43will have the highest priority. Example:
44
45.nf
46UPGRADE ^etc/.*$ NO
47UPGRADE ^var/log/.*$ NO
48UPGRADE ^etc/X11/.*$ YES
49UPGRADE ^etc/X11/XF86Config$ NO
50.fi
51
52The above example will cause pkgadd to never upgrade anything in /etc/ or /var/log/ (subdirectories included),
53except files in /etc/X11/ (subdirectories included), unless it is the file /etc/X11/XF86Config.
54The default rule is to upgrade everything, rules in this file are exceptions to that rule.
55(NOTE! A \fIpattern\fP should never contain an initial "/" since you are referring to the files in the
56package, not the files on the disk.)
57
58If pkgadd finds that a specific file should not be upgraded it will install it under \fI/var/lib/pkg/rejected/\fP.
59The user is then free to examine/use/remove that file manually.
60.SH FILES
61.TP
62.B "/etc/pkgadd.conf"
63Configuration file.
64.SH SEE ALSO
65pkgrm(8), pkginfo(8), pkgmk(8), rejmerge(8)
66.SH COPYRIGHT
67pkgadd (pkgutils) is Copyright (c) 2000-2005 Per Liden and is licensed through
68the GNU General Public License. Read the COPYING file for the complete license.