1 .TH pkgmk 8 "" "pkgutils #VERSION#" ""
2 .SH NAME
3 pkgmk \- make software package
4 .SH SYNOPSIS
5 \fBpkgmk [options]\fP
6 .SH DESCRIPTION
7 \fBpkgmk\fP is a \fIpackage management\fP utility, which makes
8 a software package. A \fIpackage\fP is an archive of files (.pkg.tar.gz, .pkg.tar.bz2 or .pkg.tar.xz)
9 that can be installed using pkgadd(8).
10
11 To prepare to use pkgmk, you must write a file named \fIPkgfile\fP
12 that describes how the package should be build. Once a suitable
13 \fIPkgfile\fP file exists, each time you change some source files,
14 you simply execute pkgmk to bring the package up to date. The pkgmk
15 program uses the \fIPkgfile\fP file and the last-modification
16 times of the source files to decide if the package needs to be updated.
17
18 Global build configuration is stored in \fI/etc/pkgmk.conf\fP. This
19 file is read by pkgmk at startup.
20 .SH OPTIONS
21 .TP
22 .B "\-i, \-\-install"
23 Install package using pkgadd(8) after successful build.
24 .TP
25 .B "\-u, \-\-upgrade"
26 Install package as an upgrade using pkgadd(8) after successful build.
27 .TP
28 .B "\-r, \-\-recursive"
29 Search for and build packages recursively.
30 .TP
31 .B "\-d, \-\-download"
32 Download missing source file(s).
33 .TP
34 .B "\-do, \-\-download\-only"
35 Do not build, only download missing source file(s).
36 .TP
37 .B "\-utd, \-\-up\-to\-date"
38 Do not build, only check if the package is up to date.
39 .TP
40 .B "\-uf, \-\-update\-footprint"
41 Update footprint and treat last build as successful.
42 .TP
43 .B "\-if, \-\-ignore\-footprint"
44 Build package without checking footprint.
45 .TP
46 .B "\-in, \-\-ignore\-new"
47 Build package, ignore new files in a footprint mismatch.
48 .TP
49 .B "\-um, \-\-update\-md5sum"
50 Update md5sum using the current source files.
51 .TP
52 .B "\-im, \-\-ignore\-md5sum"
53 Build package without checking md5sum first.
54 .TP
55 .B "\-cm, \-\-check\-md5sum"
56 Check md5sum without building the package.
57 .TP
58 .B "\-us, \-\-update\-signature"
59 Update port signature and sha256sums.
60 .TP
61 .B "\-cs, \-\-check\-signature"
62 Check the validity of files using the signature and sha256sums.
63 .TP
64 .B "\-is, \-\-ignore\-signature"
65 Build package without checking the signature and sha256sums.
66 .TP
67 .B "\-rs, \-\-refresh\-signature"
68 Create new signature and keep existing sha256sums.
69 .TP
70 .B "\-sk, \-\-secret\-key <file>"
71 Use private key in <file> to sign the port. By default, the name of the port's
72 parent directory $repo is evaluated and the private key is read from /etc/ports/$repo.sec, if it exists.
73 .TP
74 .B "\-pk, \-\-public\-key <file>"
75 Use public key in <file> to check the signature. By default, the name of the
76 port's parent directory $repo is evaluated and the public key is read from /etc/ports/$repo.pub, if it exists.
77 .TP
78 .B "\-ns, \-\-no\-strip"
79 Do not strip executable binaries or libraries.
80 .TP
81 .B "\-f, \-\-force"
82 Build package even if it appears to be up to date.
83 .TP
84 .B "\-c, \-\-clean"
85 Remove the (previously built) package and the downloaded source files.
86 .TP
87 .B "\-kw, \-\-keep-work"
88 Keep temporary working directory.
89 .TP
90 .B "\-cf, \-\-config\-file <file>"
91 Use alternative configuration file (default is /etc/pkgmk.conf).
92 .TP
93 .B "\-v, \-\-version"
94 Print version and exit.
95 .TP
96 .B "\-h, \-\-help"
97 Print help and exit.
98 .SH FILES
99 .TP
100 .B "Pkgfile"
101 Package build description.
102 .TP
103 .B ".footprint"
104 Package footprint (used for regression testing).
105 .TP
106 .B ".md5sum"
107 MD5 checksum of source files.
108 .TP
109 .B ".signature"
110 SHA256 checksum and signify checksum.
111 .TP
112 .B "/etc/pkgmk.conf"
113 Global package make configuration.
114 .TP
115 .B "curl"
116 Used by pkgmk to download source code.
117 .TP
118 .B "wget"
119 Used by pkgmk to download source code.
120 .SH EXIT CODES
121 .TP
122 .B 0
123 No error occured.
124 .TP
125 .B 1
126 A general error has occured.
127 .TP
128 .B 2
129 The Pkgfile is invalid.
130 .TP
131 .B 3
132 The source or build directory is missing or is lacking read/write permissions.
133 .TP
134 .B 4
135 An error occured during the download of source files.
136 .TP
137 .B 5
138 An error occured during unpacking of source files.
139 .TP
140 .B 6
141 An md5sum mismatch occured.
142 .TP
143 .B 7
144 A footprint mismatch occured.
145 .TP
146 .B 8
147 An error occured while running the build function.
148 .TP
149 .B 9
150 An error occured while installing the package via pkgadd.
151 .SH SEE ALSO
152 pkgmk.conf(5), pkgadd(8), pkgrm(8), pkginfo(8), rejmerge(8), signify(1), curl(1), wget(1)
153 .SH COPYRIGHT
154 pkgmk (pkgutils) is Copyright (c) 2000-2005 Per Liden and Copyright (c) 2006-2021 CRUX team (http://crux.nu).
155 pkgmk (pkgutils) is licensed through the GNU General Public License.
156 Read the COPYING file for the complete license.
|
