.\" -*- mode: troff; coding: utf-8 -*-
.TH "" "7" ""
.SH NAME
.LP
package base - an identifier that tracks from which sources an ALPM based package originates.
.SH DESCRIPTION
.LP
The \fBpackage base\fR format represents an identifier, that describes the source origin of each \fBalpm-package\fR file.
It is particularly useful in \fBalpm-split-package\fR files to track the sources from which each package file is built.
.PP
More specifically, the \fBalpm-package-base\fR format is used throughout the package management life cycle:
.IP "\(bu" 3
in build scripts and source metadata files (i.e. \fBPKGBUILD\fR and \fBSRCINFO\fR)
.if n \
.sp -1
.if t \
.sp -0.25v
.IP "\(bu" 3
in file formats for package metadata (i.e. \fBBUILDINFO\fR and \fBPKGINFO\fR)
.if n \
.sp -1
.if t \
.sp -0.25v
.IP "\(bu" 3
in file formats for repository metadata (i.e. \fBalpm-repo-desc\fR)
.if n \
.sp -1
.if t \
.sp -0.25v
.IP "\(bu" 3
and in system state metadata (i.e. \fBalpm-db-desc\fR).
.SS
General Format
.LP
The identifier name for \fBalpm-package-base\fR may differ depending on context.
However, the value restrictions for it are the same as those for \fBalpm-package-name\fR.
.SH EXAMPLES
.LP
The \fBPKGBUILD\fR of a package named \f(CRexample\fR, that implicitly specifies its \fBalpm-package-base\fR as \f(CRexample\fR.
.LP
.EX
pkgname=example
pkgver=1.0.0
pkgrel=1
pkgdesc=\(dqAn example package\(dq
arch=(any)
url=\(dqhttps://example.org\(dq
license=('CC0-1.0')

package() {
  install -vdm 755 \(dq$pkgdir/usr/share/doc/$pkgname/\(dq
  printf \(dqexample\en\(dq > \(dq$pkgdir/usr/share/doc/$pkgname/example.txt\(dq
}
.EE
.PP
The \fBPKGBUILD\fR of a package named \f(CRexample\fR, that explicitly specifies its \fBalpm-package-base\fR as \f(CRsomething-else\fR.
.LP
.EX
pkgname=example
pkgbase=something-else
pkgver=1.0.0
pkgrel=1
pkgdesc=\(dqAn example package\(dq
arch=(any)
url=\(dqhttps://example.org\(dq
license=('CC0-1.0')

package() {
  install -vdm 755 \(dq$pkgdir/usr/share/doc/$pkgname/\(dq
  printf \(dqexample\en\(dq > \(dq$pkgdir/usr/share/doc/$pkgname/example.txt\(dq
}
.EE
.PP
The \fBPKGBUILD\fR of a split package setup with the packages \f(CRexample\fR and \f(CRother-example\fR that both share the implicit \fBalpm-package-base\fR \f(CRexample\fR.
.LP
.EX
pkgname=(
  example
  other-example
)
pkgver=1.0.0
pkgrel=1
pkgdesc=\(dqAn example package\(dq
arch=(any)
url=\(dqhttps://example.org\(dq
license=('CC0-1.0')

package_example() {
  install -vdm 755 \(dq$pkgdir/usr/share/doc/$pkgname/\(dq
  printf \(dqexample\en\(dq > \(dq$pkgdir/usr/share/doc/$pkgname/example.txt\(dq
}

package_other-example() {
  install -vdm 755 \(dq$pkgdir/usr/share/doc/$pkgname/\(dq
  printf \(dqother-example\en\(dq > \(dq$pkgdir/usr/share/doc/$pkgname/example.txt\(dq
}
.EE
.PP
The \fBPKGBUILD\fR of a split package setup with the packages \f(CRexample1\fR and \f(CRexample2\fR that both share the explicit \fBalpm-package-base\fR \f(CRexample\fR.
.LP
.EX
pkgname=(
  example1
  example2
)
pkgbase=example
pkgver=1.0.0
pkgrel=1
pkgdesc=\(dqAn example package\(dq
arch=(any)
url=\(dqhttps://example.org\(dq
license=('CC0-1.0')

package_example1() {
  install -vdm 755 \(dq$pkgdir/usr/share/doc/$pkgname/\(dq
  printf \(dqexample1\en\(dq > \(dq$pkgdir/usr/share/doc/$pkgname/example.txt\(dq
}

package_example2() {
  install -vdm 755 \(dq$pkgdir/usr/share/doc/$pkgname/\(dq
  printf \(dqexample2\en\(dq > \(dq$pkgdir/usr/share/doc/$pkgname/example.txt\(dq
}
.EE
.SH SEE ALSO
.LP
\fBBUILDINFO\fR(5), \fBPKGBUILD\fR(5), \fBPKGINFO\fR(5), \fBSRCINFO\fR(5), \fBalpm-db-desc\fR(7), \fBalpm-package\fR(7), \fBalpm-package-name\fR(7), \fBalpm-repo-desc\fR(7), \fBalpm-split-package\fR(7)