diff options
Diffstat (limited to 'man')
| -rw-r--r-- | man/opkbuild.7in | 178 |
1 files changed, 55 insertions, 123 deletions
diff --git a/man/opkbuild.7in b/man/opkbuild.7in index ad13686..b3ed50b 100644 --- a/man/opkbuild.7in +++ b/man/opkbuild.7in @@ -1,174 +1,111 @@ -.TH OPKHELPER 7 \ +.TH OPKBUILD 7 \ "@DATE@" "@SOURCE@" "@MANUAL@" .SH NAME -opkhelper \- opkg build helper tools +opkbuild \- Distribution build system .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. +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 -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 . +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 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 +.SH COMMANDS .TP -.B opkbuild(1) -Build opkg packages. -.sp -Executed by the user to begin building packages. +.BR opkbuild (1) +Build opkg packages .TP -.B ob-checkbuilddeps(1) -Make sure that package build dependencies are installed. -.sp -Executed by -.BR opkbuild(1) . +.BR ob-checkbuilddeps (1) +Make sure that package build dependencies are installed .TP -.B ob-applypatches(1) -Apply patches to source code. -.sp -Executed by -.BR opkbuild(1) . +.BR ob-buildenv (1) +Set up build environment variables .TP -.B ob-installplatconf(1) -Copy build-time or run-time platform configuration files. -.sp -Executed by -.BR opkbuild(1) . +.BR ob-unpacksource (1) +Unpack native or upstream source code .TP -.B ob-strip(1) -Strip binary objects of symbols. -.sp -Generally executed by package -.I build -files. +.BR ob-applypatches (1) +Apply patches to source code .TP -.B ob-installfiles(1) -Install files into a binary package staging area. -.sp -Generally executed by package -.I build -files. +.BR ob-installplatconf (1) +Copy build-time or run-time platform configuration files .TP -.B ob-installdocs(1) -Install package documentation into a binary package staging area. -.sp -Generally executed by package -.I build -files. +.BR ob-installdocs (1) +Install package documentation into a binary package staging area .TP -.B ob-gencontrol(1) -Generates a control directory with a control file and scripts. -.sp -Generally executed by package -.I build -files. +.BR ob-gencontrol (1) +Generates a control directory with a control file and scripts .TP -.B ob-buildopk(1) -Pack binary package files into an opk file. -.sp -Generally executed by package -.I build -files. +.BR ob-buildopk (1) +Pack binary package files into an opk file .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 . +.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 OH_SOURCE +.B OPK_SOURCE The source package name .TP -.B OH_SOURCE_VERSION +.B OPK_SOURCE_VERSION The source package version .TP -.B OH_SOURCE_VERSION_UPSTREAM +.B OPK_SOURCE_VERSION_UPSTREAM The upstream source package version (which may include a Software Inclusion Policy revision number) .TP -.B OH_BINARY_VERSION +.B OPK_BINARY_VERSION The binary package version (which is different from -.B OH_SOURCE_VERSION +.B OPK_SOURCE_VERSION during a binary rebuild) .SS BUILD AND HOST SYSTEMS .TP -.B OH_BUILD_ARCH +.B OPK_BUILD_ARCH Build system distribution architecture string .TP -.B OH_BUILD_ARCH_CPU +.B OPK_BUILD_ARCH_CPU Build system CPU .TP -.B OH_BUILD_ARCH_KERNEL +.B OPK_BUILD_ARCH_KERNEL Build system kernel .TP -.B OH_BUILD_ARCH_LIBS +.B OPK_BUILD_ARCH_LIBS Build system C/C++ libraries .TP -.B OH_BUILD_PLATFORM -Build system application platform -.TP -.B OH_BUILD_ARCH_GNU +.B OPK_BUILD_ARCH_GNU Build system GNU system type .TP -.B OH_BUILD_ARCH_KBUILD -Build system kbuild srchitecture name -.sp -This is deprecated. +.B OPK_BUILD_PLAT +Build system application platform .TP -.B OH_HOST_ARCH +.B OPK_HOST_ARCH Host system distribution architecture string .TP -.B OH_HOST_ARCH_CPU +.B OPK_HOST_ARCH_CPU Host system CPU .TP -.B OH_HOST_ARCH_KERNEL +.B OPK_HOST_ARCH_KERNEL Host system kernel .TP -.B OH_HOST_ARCH_LIBS +.B OPK_HOST_ARCH_LIBS Host system C/C++ libraries .TP -.B OH_HOST_PLATFORM -Host system application platform -.TP -.B OH_HOST_ARCH_GNU +.B OPK_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. +.B OPK_HOST_PLAT +Host system application platform .SS TOOLS .TP @@ -213,14 +150,9 @@ This is deprecated. .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 McDermott +Copyright (C) 2012, 2019 Patrick McDermott .sp This file is part of opkbuild. .sp |