CRUX-ARM : Home

Home :: Documentation :: Download :: Development :: Community :: Ports :: Packages :: Bugs :: Links :: About :: Donors
pkgmk-cross.conf: adapted to 64b
[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
14ab4111 35\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
9ac667e6
SR
36event type is allowed, in which case the first rule will have the lowest priority and the last rule
37will have the highest priority. Example:
38
39.nf
40UPGRADE ^etc/.*$ NO
41UPGRADE ^var/log/.*$ NO
42UPGRADE ^etc/X11/.*$ YES
43UPGRADE ^etc/X11/XF86Config$ NO
44.fi
45
46The above example will cause pkgadd to never upgrade anything in /etc/ or /var/log/ (subdirectories included),
47except files in /etc/X11/ (subdirectories included), unless it is the file /etc/X11/XF86Config.
14ab4111 48The default rule is to upgrade/install everything, rules in this file are exceptions to that rule.
9ac667e6
SR
49(NOTE! A \fIpattern\fP should never contain an initial "/" since you are referring to the files in the
50package, not the files on the disk.)
51
52If pkgadd finds that a specific file should not be upgraded it will install it under \fI/var/lib/pkg/rejected/\fP.
53The user is then free to examine/use/remove that file manually.
54.SH FILES
55.TP
56.B "/etc/pkgadd.conf"
57Configuration file.
58.SH SEE ALSO
59pkgrm(8), pkginfo(8), pkgmk(8), rejmerge(8)
60.SH COPYRIGHT
d804a38f 61pkgadd (pkgutils) is Copyright (c) 2000-2005 Per Liden and Copyright (c) 2006-2013 CRUX team (http://crux.nu).
6fe55c25
TS
62pkgadd (pkgutils) is licensed through the GNU General Public License.
63Read the COPYING file for the complete license.