From 626aecb4724fe5adc65f755d142804306fadb307 Mon Sep 17 00:00:00 2001 From: Levente Polyak Date: Mon, 20 Jun 2022 01:15:34 +0200 Subject: make: split out man page files into doc/man folder --- doc/man/offload-build.1.asciidoc | 52 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 doc/man/offload-build.1.asciidoc (limited to 'doc/man/offload-build.1.asciidoc') diff --git a/doc/man/offload-build.1.asciidoc b/doc/man/offload-build.1.asciidoc new file mode 100644 index 0000000..6b39711 --- /dev/null +++ b/doc/man/offload-build.1.asciidoc @@ -0,0 +1,52 @@ +offload-build(1) +================ + +Name +---- +offload-build - Build a PKGBUILD on a remote server using makechrootpkg + +Synopsis +-------- +offload-build [OPTIONS] -- [ARCHBUILD_OPTIONS] + +Description +----------- + +Build a PKGBUILD on a remote server using makechrootpkg. Requires a remote user +that can run archbuild in a non-interactive manner, e.g. must be able to +elevate permissions using passwordless sudo. + +Options +------- + +*-r, --repo* :: + Build against a specific repository. The default is `extra`, to build packages using + the stable repositories via extra-x86_64-build. + +*-a, --arch* :: + Build against a specific architecture. The default is `x86_64`, the only + architecture officially supported by Arch Linux. + +*-s, --server* :: + Offload to a specific build server. The default is build.archlinux.org + which is used as part of the build toolchain for the official Arch Linux + repos. + +*-h, --help*:: + Show a help text. + +Passing options to archbuild +---------------------------- + +Options after a delimiting -- are passed on to archbuild on the remote. +archbuild in turn supports passing arguments on to makechrootpkg, which in turn +supports passing options to makepkg. Since each uses -- to delimit options that +are forwarded, make sure to escape them properly: + + `offload-build offload-args -- archbuild-args -- makechrootpkg-args -- makepkg-args` + +Example: To use a second `testing-x86_64-build` instance with another copydir: + + `offload-build -r testing -- -- -l ` + +include::include/footer.asciidoc[] -- cgit v1.2.3-70-g09d2