pkgmk.8.in

   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 "\-ns, \-\-no\-strip"
  56 Do not strip executable binaries or libraries.
  57 .TP
  58 .B "\-f, \-\-force"
  59 Build package even if it appears to be up to date.
  60 .TP
  61 .B "\-c, \-\-clean"
  62 Remove the (previously built) package and the downloaded source files.
  63 .TP
  64 .B "\-kw, \-\-keep-work"
  65 Keep temporary working directory.
  66 .TP
  67 .B "\-cf, \-\-config\-file <file>"
  68 Use alternative configuration file (default is /etc/pkgmk.conf).
  69 .TP
  70 .B "\-v, \-\-version"
  71 Print version and exit.
  72 .TP
  73 .B "\-h, \-\-help"
  74 Print help and exit.
  75 .SH FILES
  76 .TP
  77 .B "Pkgfile"
  78 Package build description.
  79 .TP
  80 .B ".footprint"
  81 Package footprint (used for regression testing).
  82 .TP
  83 .B ".md5sum"
  84 MD5 checksum of source files.
  85 .TP
  86 .B "/etc/pkgmk.conf"
  87 Global package make configuration.
  88 .TP
  89 .B "wget"
  90 Used by pkgmk to download source code.
  91 .SH EXIT CODES
  92 .TP
  93 .B 0
  94 No error occured.
  95 .TP
  96 .B 1
  97 A general error has occured.
  98 .TP
  99 .B 2
 100 The Pkgfile is invalid.
 101 .TP
 102 .B 3
 103 The source or build directory is missing or is lacking read/write permissions.
 104 .TP
 105 .B 4
 106 An error occured during the download of source files.
 107 .TP
 108 .B 5
 109 An error occured during unpacking of source files.
 110 .TP
 111 .B 6
 112 An md5sum mismatch occured.
 113 .TP
 114 .B 7
 115 A footprint mismatch occured.
 116 .TP
 117 .B 8
 118 An error occured while running the build function.
 119 .TP
 120 .B 9
 121 An error occured while installing the package via pkgadd.
 122 .SH SEE ALSO
 123 pkgmk.conf(5), pkgadd(8), pkgrm(8), pkginfo(8), rejmerge(8), wget(1)
 124 .SH COPYRIGHT
 125 pkgmk (pkgutils) is Copyright (c) 2000-2005 Per Liden and Copyright (c) 2006-2013 CRUX team (http://crux.nu).
 126 pkgmk (pkgutils) is licensed through the GNU General Public License.
 127 Read the COPYING file for the complete license.