path: root/man/opkhelper.7.in

.\" Author: Patrick "P. J." McDermott
.TH opkhelper 7 \
"2012-07-29" "@@PACKAGE@@-@@VERSION@@" "opkg Build Helper Tools"

.SH NAME
opkhelper \- opkg build helper tools

.SH DESCRIPTION
opkhelper is a set of programs to assist in building binary packages installable
by the lightweight package manager
.BR opkg .
These tools are inspired by debhelper, a similar set of programs written
primarily by Joey Hess for Debian.
.sp
opkhelper 2.0.x is designed to build source packages that comply with draft
version 2.0 of the source package format at
.IR http://specs.os.pehjota.net/source-package-format-2.0.html .

.SH MAINTAINER AND PACKAGE INTERFACES
opkhelper exposes various interfaces to users building packages and to packages
themselves.  Users generally just call
.B opkbuild(1)
to begin building packages.  The
.I build
file of a package generally calls a number of opkhelper tools to help it manage
and pack data and control files for packages.  Additionally,
.B opkbuild(1)
documents the build environment by setting environment variables that are
available to the
.I build
file and other opkhelper tools.

.SH OPKHELPER COMMANDS
.TP
.B opkbuild(1)
Build opkg packages.
.sp
Executed by the user to begin building packages.
.TP
.B oh-checkbuilddeps(1)
Make sure that package build dependencies are installed.
.sp
Executed by
.BR opkbuild(1) .
.TP
.B oh-applypatches(1)
Apply patches to source code.
.sp
Executed by
.BR opkbuild(1) .
.TP
.B oh-copyconfig(1)
Copy build-time or run-time platform configuration files.
.sp
Executed by
.BR opkbuild(1) .
.TP
.B oh-strip(1)
Strip binary objects of symbols.
.sp
Generally executed by package
.I build
files.
.TP
.B oh-installfiles(1)
Install files into a binary package staging area.
.sp
Generally executed by package
.I build
files.
.TP
.B oh-installdocs(1)
Install package documentation into a binary package staging area.
.sp
Generally executed by package
.I build
files.
.TP
.B oh-gencontrol(1)
Generates a control directory with a control file and scripts.
.sp
Generally executed by package
.I build
files.
.TP
.B oh-buildopk(1)
Pack binary package files into an opk file.
.sp
Generally executed by package
.I build
files.

.SH ENVIRONMENT VARIABLES
opkbuild makes available to package
.IR config and build
files and other opkhelper tools 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
.IR https://www.gnu.org/software/autoconf/manual/autoconf.html#Specifying-Targe\
t-Triplets .

.SS PACKAGE
.TP
.B OH_SOURCE
The source package name
.TP
.B OH_SOURCE_VERSION
The source package version
.TP
.B OH_SOURCE_VERSION_UPSTREAM
The upstream source package version (which may include a Software Inclusion
Policy revision number)
.TP
.B OH_BINARY_VERSION
The binary package version (which is different from
.B OH_SOURCE_VERSION
during a binary rebuild)

.SS BUILD AND HOST SYSTEMS
.TP
.B OH_BUILD_ARCH
Build system distribution architecture string
.TP
.B OH_BUILD_ARCH_CPU
Build system CPU
.TP
.B OH_BUILD_ARCH_KERNEL
Build system kernel
.TP
.B OH_BUILD_ARCH_LIBS
Build system C/C++ libraries
.TP
.B OH_BUILD_PLATFORM
Build system application platform
.TP
.B OH_BUILD_ARCH_GNU
Build system GNU system type
.TP
.B OH_BUILD_ARCH_KBUILD
Build system kbuild srchitecture name
.sp
This is deprecated.
.TP
.B OH_HOST_ARCH
Host system distribution architecture string
.TP
.B OH_HOST_ARCH_CPU
Host system CPU
.TP
.B OH_HOST_ARCH_KERNEL
Host system kernel
.TP
.B OH_HOST_ARCH_LIBS
Host system C/C++ libraries
.TP
.B OH_HOST_PLATFORM
Host system application platform
.TP
.B OH_HOST_ARCH_GNU
Host system GNU system type
.TP
.B OH_HOST_ARCH_KBUILD
Host system kbuild srchitecture name
.sp
This is deprecated.
.TP
.B ARCH
Host system architecture name as used by kbuild.
.sp
This is deprecated.

.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
.TP
.B CROSS_COMPILE
Cross toolchain prefix as used by kbuild.
.sp
This is deprecated.

.SH COPYRIGHT
Copyright (C) 2012 Patrick "P. J." McDermott
.sp
This program 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
This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.