From 5f500be4c68ec4eabb6f787e9b992edcc0a5a074 Mon Sep 17 00:00:00 2001 From: Hugo Osvaldo Barrera Date: Mon, 15 May 2023 16:02:11 +0000 Subject: [PATCH] abuild.1: add new manpage This is mostly based on the output of --help. --- Makefile | 2 +- abuild.1.scd | 167 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 168 insertions(+), 1 deletion(-) create mode 100644 abuild.1.scd diff --git a/Makefile b/Makefile index 89c6ba8..f4e8ca0 100644 --- a/Makefile +++ b/Makefile @@ -11,7 +11,7 @@ SCRIPTS := abuild abuild-keygen abuild-sign newapkbuild \ abump apkgrel buildlab apkbuild-cpan apkbuild-pypi checkapk \ apkbuild-gem-resolver USR_BIN_FILES := $(SCRIPTS) abuild-tar abuild-gzsplit abuild-sudo abuild-fetch abuild-rmtemp -MAN_1_PAGES := newapkbuild.1 +MAN_1_PAGES := newapkbuild.1 abuild.1 MAN_5_PAGES := APKBUILD.5 SAMPLES := sample.APKBUILD sample.initd sample.confd \ sample.pre-install sample.post-install diff --git a/abuild.1.scd b/abuild.1.scd new file mode 100644 index 0000000..efdca5c --- /dev/null +++ b/abuild.1.scd @@ -0,0 +1,167 @@ +abuild(1) + +# NAME + +*abuild* - build an apk from an APKBUILD + +# SYNOPSIS + +*abuild* [options] [-P _REPODEST_] [-s _SRCDEST_] [-D _DESCRIPTION_] [cmd] ...++ +*abuild* [-c] -n _PKGNAME_[-_PKGVER_] + +# DESCRIPTION + +*abuild* builds an apk binary package based on an input APKBUILD(5), as well as +other related operations. + +# OPTIONS + +*-A* + Print CARCH and exit + +*-c* + Enable colored output + +*-d* + Disable dependency checking + +*-D* + Set APKINDEX description (default: *$repo $(git describe)*) + +*-f* + Force specified cmd (skip checks: apk up to date, arch, libc) + +*-F* + Force run as root + +*-h* + Show this help + +*-k* + Keep built packages, even if APKBUILD or sources are newer + +*-K* + Keep buildtime temp dirs and files (srcdir/pkgdir/deps) + +*-m* + Disable colors (monochrome) + +*-P* + Set REPODEST as the repository location for created packages + +*-q* + Quiet + +*-r* + Install missing dependencies from system repository (using sudo) + +*-s* + Set source package destination directory + +*-v* + Verbose: show every command as it is run (very noisy) + +# COMMANDS + +*build* + Compile and install package into *$pkgdir*. + +*check* + Run any defined tests concerning the package + +*checksum* + Generate checksum to be included in APKBUILD + +*clean* + Remove temp build and install dirs + +*cleancache* + Remove downloaded files from $SRCDEST + +*cleanoldpkg* + Remove binary packages except current version + +*cleanpkg* + Remove already built binary and source package + +*deps* + Install packages listed in makedepends and depends + +*fetch* + Fetch sources to $SRCDEST (consider: 'abuild fetch verify') + +*index* + Regenerate indexes in $REPODEST + +*listpkg* + List target packages + +*package* + Install project into + +*prepare* + Apply patches + +*rootbld* + Build package in clean chroot. Requires *abuild-rootbld*. + +*rootpkg* + Run 'package', the split functions and create apks as fakeroot + +*sanitycheck* + Basic sanity check of APKBUILD + +*snapshot* + Create a *$giturl* snapshot and upload to *$disturl* + +*sourcecheck* + Check if remote source package exists upstream + +*srcpkg* + Make a source package + +*undeps* + Uninstall packages listed in makedepends and depends + +*unpack* + Unpack sources to $srcdir + +*up2date* + Compare target and sources dates + +*verify* + Verify checksums + +# FILES + +/etc/abuild.conf + Configuration is read from this file by default. + +$HOME/.abuild/abuild.conf + User-specific configuration is read from this file, if it exists. + +# EXAMPLES + +Update checksums for an APKBUILD: + +``` +abuild checksum +``` + +Build an APKBUILD and print coloured output: + +``` +abuild -rc +``` + +# SEE ALSO + +SPDX license reference (on the Web at ), +newapkbuild(1), apk(8), APKBUILD(5). + +# AUTHORS + +*abuild*: Natanael Copa <_ncopa@alpinelinux.org_> + +Documentation:++ +Hugo Osvaldo Barrera <_hugo@whynothugo.nl_>