CRUX-ARM : Home

Home :: Documentation :: Download :: Development :: Community :: Ports :: Packages :: Bugs :: Links :: About :: Donors
Fixed documentation to not only talk about pkg.tar.gz but also bz2 and xz.
[pkgutils-cross.git] / pkgmk.8.in
CommitLineData
9ac667e6
SR
1.TH pkgmk 8 "" "pkgutils #VERSION#" ""
2.SH NAME
3pkgmk \- make software package
4.SH SYNOPSIS
5\fBpkgmk [options]\fP
6.SH DESCRIPTION
7\fBpkgmk\fP is a \fIpackage management\fP utility, which makes
26620067 8a software package. A \fIpackage\fP is an archive of files (.pkg.tar.gz, .pkg.tar.bz2 or .pkg.tar.xz)
9ac667e6
SR
9that can be installed using pkgadd(8).
10
11To prepare to use pkgmk, you must write a file named \fIPkgfile\fP
12that describes how the package should be build. Once a suitable
13\fIPkgfile\fP file exists, each time you change some source files,
14you simply execute pkgmk to bring the package up to date. The pkgmk
15program uses the \fIPkgfile\fP file and the last-modification
16times of the source files to decide if the package needs to be updated.
17
18Global build configuration is stored in \fI/etc/pkgmk.conf\fP. This
19file is read by pkgmk at startup.
20.SH OPTIONS
21.TP
22.B "\-i, \-\-install"
23Install package using pkgadd(8) after successful build.
24.TP
25.B "\-u, \-\-upgrade"
26Install package as an upgrade using pkgadd(8) after successful build.
27.TP
28.B "\-r, \-\-recursive"
29Search for and build packages recursively.
30.TP
31.B "\-d, \-\-download"
32Download missing source file(s).
33.TP
34.B "\-do, \-\-download\-only"
35Do not build, only download missing source file(s).
36.TP
37.B "\-utd, \-\-up\-to\-date"
38Do not build, only check if the package is up to date.
39.TP
40.B "\-uf, \-\-update\-footprint"
41Update footprint and treat last build as successful.
42.TP
43.B "\-if, \-\-ignore\-footprint"
44Build package without checking footprint.
45.TP
163aacb1
JW
46.B "\-in, \-\-ignore\-new"
47Build package, ignore new files in a footprint mismatch.
48.TP
9ac667e6
SR
49.B "\-um, \-\-update\-md5sum"
50Update md5sum using the current source files.
51.TP
52.B "\-im, \-\-ignore\-md5sum"
53Build package without checking md5sum first.
54.TP
55.B "\-ns, \-\-no\-strip"
56Do not strip executable binaries or libraries.
57.TP
58.B "\-f, \-\-force"
59Build package even if it appears to be up to date.
60.TP
61.B "\-c, \-\-clean"
62Remove the (previously built) package and the downloaded source files.
63.TP
64.B "\-kw, \-\-keep-work"
65Keep temporary working directory.
66.TP
67.B "\-cf, \-\-config\-file <file>"
68Use alternative configuration file (default is /etc/pkgmk.conf).
69.TP
70.B "\-v, \-\-version"
71Print version and exit.
72.TP
73.B "\-h, \-\-help"
74Print help and exit.
75.SH FILES
76.TP
77.B "Pkgfile"
78Package build description.
79.TP
80.B ".footprint"
81Package footprint (used for regression testing).
82.TP
83.B ".md5sum"
84MD5 checksum of source files.
85.TP
86.B "/etc/pkgmk.conf"
87Global package make configuration.
88.TP
89.B "wget"
90Used by pkgmk to download source code.
91.SH SEE ALSO
140951a0 92pkgmk.conf(5), pkgadd(8), pkgrm(8), pkginfo(8), rejmerge(8), wget(1)
9ac667e6 93.SH COPYRIGHT
6fe55c25
TS
94pkgmk (pkgutils) is Copyright (c) 2000-2005 Per Liden and Copyright (c) 2006-2007 CRUX team (http://crux.nu).
95pkgmk (pkgutils) is licensed through the GNU General Public License.
96Read the COPYING file for the complete license.