summaryrefslogtreecommitdiff
path: root/pkgadd.8.in
blob: 9a40f412d8d7cee146a564b675cc0d4c29ad9288 (plain)
    1 .TH pkgadd 8 "" "pkgutils #VERSION#" ""
    2 .SH NAME
    3 pkgadd \- 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
    8 a software package. A \fIpackage\fP is an archive of files (.pkg.tar.gz).
    9 .SH OPTIONS
   10 .TP
   11 .B "\-u, \-\-upgrade"
   12 Upgrade/replace package with the same name as <file>.
   13 .TP
   14 .B "\-f, \-\-force"
   15 Force installation, overwrite conflicting files. If the package
   16 that is about to be installed contains files that are already
   17 installed this option will cause all those files to be overwritten.
   18 This option should be used with care, preferably not at all.
   19 .TP
   20 .B "\-r, \-\-root <path>"
   21 Specify alternative installation root (default is "/"). This
   22 should \fInot\fP be used as a way to install software into
   23 e.g. /usr/local instead of /usr. Instead this should be used
   24 if you want to install a package on a temporary mounted partition,
   25 which is "owned" by another system. By using this option you not only
   26 specify where the software should be installed, but you also
   27 specify which package database to use.
   28 .TP
   29 .B "\-v, \-\-version"
   30 Print version and exit.
   31 .TP
   32 .B "\-h, \-\-help"
   33 Print help and exit.
   34 .SH CONFIGURATION
   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
   36 event type is allowed, in which case the first rule will have the lowest priority and the last rule
   37 will have the highest priority. Example:
   38 
   39 .nf
   40 UPGRADE         ^etc/.*$                NO
   41 UPGRADE         ^var/log/.*$            NO
   42 UPGRADE         ^etc/X11/.*$            YES
   43 UPGRADE         ^etc/X11/XF86Config$    NO
   44 .fi
   45 
   46 The above example will cause pkgadd to never upgrade anything in /etc/ or /var/log/ (subdirectories included),
   47 except files in /etc/X11/ (subdirectories included), unless it is the file /etc/X11/XF86Config.
   48 The default rule is to upgrade/install everything, rules in this file are exceptions to that rule.
   49 (NOTE! A \fIpattern\fP should never contain an initial "/" since you are referring to the files in the
   50 package, not the files on the disk.)
   51 
   52 If pkgadd finds that a specific file should not be upgraded it will install it under \fI/var/lib/pkg/rejected/\fP.
   53 The user is then free to examine/use/remove that file manually.
   54 .SH FILES
   55 .TP
   56 .B "/etc/pkgadd.conf"
   57 Configuration file.
   58 .SH SEE ALSO
   59 pkgrm(8), pkginfo(8), pkgmk(8), rejmerge(8)
   60 .SH COPYRIGHT
   61 pkgadd (pkgutils) is Copyright (c) 2000-2005 Per Liden and Copyright (c) 2006-2017 CRUX team (http://crux.nu).
   62 pkgadd (pkgutils) is licensed through the GNU General Public License.
   63 Read the COPYING file for the complete license.

Generated by cgit