path: root/man/opkbuild.7in

.TH OPKBUILD 7 "@DATE@" "@SOURCE@" "@MANUAL@"

.SH NAME
opkbuild \- Distribution build system

.SH DESCRIPTION
opkbuild is a set of programs to build binary packages installable by the
lightweight package manager opkg.  These tools are inspired by dpkg-dev, the
Debian package development tools.
.sp
opkbuild is designed to build source packages that comply with draft version 2.0
of the source package format at <\fIhttp://specs.proteanos.com/spf-2.0/\fP>.

.SH COMMANDS
.TP
.BR opkbuild (1)
Build opkg packages
.TP
.BR ob-checkbuilddeps (1)
Make sure that package build dependencies are installed
.TP
.BR ob-buildenv (1)
Set up build environment variables
.TP
.BR ob-unpacksource (1)
Unpack native or upstream source code
.TP
.BR ob-applypatches (1)
Apply patches to source code
.TP
.BR ob-installplatconf (1)
Copy build-time or run-time platform configuration files
.TP
.BR ob-installdocs (1)
Install package documentation into a binary package staging area
.TP
.BR ob-gencontrol (1)
Generates a control directory with a control file and scripts
.TP
.BR ob-buildopk (1)
Pack binary package files into an opk file

.SH ENVIRONMENT VARIABLES
.BR opkbuild (1)
makes available to other opkbuild tools and package
.B build
files a number of environment variables that describe the packages being built,
the build and host systems, and the toolchain to be used.  The difference
between "build" and "host" systems follows the convention set by GNU Autoconf.
The build system is the one on which software is built.  The host system is the
one on which software is to be run.  For more information, see <\fIhttps://www.\
gnu.org/software/autoconf/manual/html_node/Specifying-Target-Triplets.html\fP>.

.SS PACKAGE
.TP
.B OPK_SOURCE
The source package name
.TP
.B OPK_SOURCE_VERSION
The source package version
.TP
.B OPK_SOURCE_VERSION_UPSTREAM
The upstream source package version (which may include a Software Inclusion
Policy revision number)
.TP
.B OPK_BINARY_VERSION
The binary package version (which is different from
.B OPK_SOURCE_VERSION
during a binary rebuild)

.SS BUILD AND HOST SYSTEMS
.TP
.B OPK_BUILD_ARCH
Build system distribution architecture string
.TP
.B OPK_BUILD_ARCH_CPU
Build system CPU
.TP
.B OPK_BUILD_ARCH_KERNEL
Build system kernel
.TP
.B OPK_BUILD_ARCH_LIBS
Build system C/C++ libraries
.TP
.B OPK_BUILD_ARCH_GNU
Build system GNU system type
.TP
.B OPK_BUILD_PLAT
Build system application platform
.TP
.B OPK_HOST_ARCH
Host system distribution architecture string
.TP
.B OPK_HOST_ARCH_CPU
Host system CPU
.TP
.B OPK_HOST_ARCH_KERNEL
Host system kernel
.TP
.B OPK_HOST_ARCH_LIBS
Host system C/C++ libraries
.TP
.B OPK_HOST_ARCH_GNU
Host system GNU system type
.TP
.B OPK_HOST_PLAT
Host system application platform

.SS TOOLS
.TP
.B AR
"ar" with cross toolchain prefix
.TP
.B AS
"as" with cross toolchain prefix
.TP
.B CC
"gcc" with cross toolchain prefix
.TP
.B CPP
"cpp" with cross toolchain prefix
.TP
.B CXX
"g++" with cross toolchain prefix
.TP
.B LD
"ld" with cross toolchain prefix
.TP
.B NM
"nm" with cross toolchain prefix
.TP
.B OBJCOPY
"objcopy" with cross toolchain prefix
.TP
.B OBJDUMP
"objdump" with cross toolchain prefix
.TP
.B RANLIB
"ranlib" with cross toolchain prefix
.TP
.B READELF
"readelf" with cross toolchain prefix
.TP
.B SIZE
"size" with cross toolchain prefix
.TP
.B STRINGS
"strings" with cross toolchain prefix
.TP
.B STRIP
"strip" with cross toolchain prefix

.SH COPYRIGHT
Copyright (C) 2012, 2019 Patrick McDermott
.sp
This file is part of opkbuild.
.sp
opkbuild is free software: you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
.sp
opkbuild is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.sp
You should have received a copy of the GNU General Public License
along with opkbuild.  If not, see <http://www.gnu.org/licenses/>.