Updated manual
This commit is contained in:
parent
907b5fa7fe
commit
cf4df7b4a7
5 changed files with 94 additions and 86 deletions
84
debian/autobuild.8
vendored
84
debian/autobuild.8
vendored
|
@ -1,84 +0,0 @@
|
|||
.\" Manpage for autobuild
|
||||
.\" Contact andrew@rail5.org to correct errors or typos.
|
||||
.TH man 8 "1 May 2024" "2.0" "autobuild man page"
|
||||
.SH NAME
|
||||
autobuild \- Automatically build and distribute Debian Packages
|
||||
.SH SYNOPSIS
|
||||
autobuild --amd64 --i386 --arm64 -p package-name
|
||||
.SH DESCRIPTION
|
||||
Autobuild automatically retrieves Debian package sources from Git, builds them, and distributes them.
|
||||
It can save the built packages locally, distribute them to a GitHub Release Page, and distribute them to a Git-based Debian Repository with reprepro.
|
||||
.SH OPTIONS
|
||||
-p
|
||||
--package
|
||||
Add a package to the build list
|
||||
|
||||
-0
|
||||
--local
|
||||
Build packages on local machine (do not use the Build Farm)
|
||||
|
||||
-1
|
||||
--amd64
|
||||
Build packages on the amd64 Build Farm VM
|
||||
The amd64 VM must have already been built by the setup script (Run 'autobuild -s')
|
||||
|
||||
-2
|
||||
--i386
|
||||
Build packages on the i386 Build Farm VM
|
||||
The i386 VM must have already been built by the setup script (Run 'autobuild -s')
|
||||
|
||||
-3
|
||||
--arm64
|
||||
Build packages on the arm64 Build Farm VM
|
||||
The arm64 VM must have already been built by the setup script (Run 'autobuild -s')
|
||||
|
||||
-o
|
||||
--output
|
||||
Specify directory to save built package files
|
||||
(Default: current working directory)
|
||||
|
||||
-d
|
||||
--debian-repo
|
||||
Distribute built packages to a Git-based Debian Repository managed with reprepro
|
||||
This repo must be configured in the CONFIG file
|
||||
|
||||
-f
|
||||
--forgejo-page
|
||||
Create release pages for the built packages' Forgejo repositories
|
||||
Your Forgejo credentials must be present in the CONFIG file
|
||||
|
||||
-g
|
||||
--github-page
|
||||
Create release pages for the built packages' Github repositories
|
||||
Your GitHub credentials must be present in the CONFIG file
|
||||
|
||||
-b
|
||||
--bell
|
||||
Ring a bell when finished
|
||||
|
||||
-s
|
||||
--setup
|
||||
Run the setup program
|
||||
The setup program can automatically install the virtual build farm
|
||||
|
||||
-c
|
||||
--config
|
||||
Open the CONFIG file for editing
|
||||
|
||||
-l
|
||||
--list
|
||||
List all packages available to build
|
||||
|
||||
.SH EXAMPLES
|
||||
autobuild -123dg -p package-1 -p package-2
|
||||
|
||||
autobuild --amd64 --i386 --arm64 --debian-repo --github-page --package package-1 --package package-2
|
||||
|
||||
autobuild -0 -p package-1 -o /path/to/save/packages/
|
||||
|
||||
autobuild -c
|
||||
|
||||
autobuild -s
|
||||
|
||||
.SH AUTHOR
|
||||
rail5 (andrew@rail5.org)
|
2
debian/control
vendored
2
debian/control
vendored
|
@ -1,7 +1,7 @@
|
|||
Source: autobuild
|
||||
Priority: optional
|
||||
Maintainer: rail5 <andrew@rail5.org>
|
||||
Build-Depends: debhelper (>= 8.0.0)
|
||||
Build-Depends: debhelper (>= 8.0.0), pandoc
|
||||
Standards-Version: 3.9.3
|
||||
Section: utils
|
||||
|
||||
|
|
2
debian/manpages
vendored
2
debian/manpages
vendored
|
@ -1 +1 @@
|
|||
debian/autobuild.8
|
||||
debian/autobuild.1
|
||||
|
|
1
debian/rules
vendored
1
debian/rules
vendored
|
@ -3,6 +3,7 @@
|
|||
dh $@
|
||||
|
||||
override_dh_auto_install:
|
||||
pandoc --standalone --to man "$$(pwd)/manual/autobuild.1.md" -o "$$(pwd)/debian/autobuild.1"
|
||||
mkdir -p "$$(pwd)/debian/autobuild/usr/share/autobuild"
|
||||
cp config.toml "$$(pwd)/debian/autobuild/usr/share/autobuild/config.toml"
|
||||
cp -r build-farm "$$(pwd)/debian/autobuild/usr/share/autobuild/build-farm"
|
||||
|
|
91
manual/autobuild.1.md
Normal file
91
manual/autobuild.1.md
Normal file
|
@ -0,0 +1,91 @@
|
|||
% autobuild(1) Version 3.0 | Manual for autobuild
|
||||
# NAME
|
||||
autobuild \- Automatically build and distribute Debian packages
|
||||
|
||||
# SYNOPSIS
|
||||
`autobuild --amd64 --i386 --arm64 -p package-name -p another-package`
|
||||
|
||||
`autobuild --amd64 --github-page -p https://github.com/user/package.git`
|
||||
|
||||
`autobuild --i386 --debian-repo --forgejo-page -p /path/to/package.tar.gz`
|
||||
|
||||
# DESCRIPTION
|
||||
Autobuild automatically retrieves Debian source packages (via Git or local tar.gz archive), builds them on a virtual machine build-farm for multiple architectures, and distributes them. It can save the built package locally, distribute them to a GitHub/Forgejo Release Page, and distribute them to a Git-based Debian Repository with reprepro.
|
||||
|
||||
The configuration file can be found at /var/autobuild/config.toml. You may edit this file to change various settings.
|
||||
|
||||
# OPTIONS
|
||||
|
||||
## GENERAL OPTIONS
|
||||
-p, \--package
|
||||
|
||||
Add a package to the build list. The argument can be:
|
||||
|
||||
- The name of a package in the config file
|
||||
|
||||
- A valid Git URL
|
||||
|
||||
- A local path to a .tar.gz archive
|
||||
|
||||
-o, \--output
|
||||
|
||||
Specify directory to save built package files (default: current working directory)
|
||||
|
||||
-b, \--bell
|
||||
|
||||
Ring a bell when finished
|
||||
|
||||
-l, \--list
|
||||
|
||||
List packages present in the config file and quit
|
||||
|
||||
-r, \--remove-old-builds
|
||||
|
||||
Remove a given subdirectory under /var/autobuild/builds, and quit
|
||||
|
||||
If the given argument is 'all', remove everything under /var/autobuild/builds
|
||||
|
||||
-s, \--setup
|
||||
|
||||
Run the setup program (must be run as root)
|
||||
|
||||
The setup program can automatically install (or reinstall) the build farm
|
||||
|
||||
## BUILD FARM OPTIONS
|
||||
-0, \--local
|
||||
|
||||
Build packages on the local machine (do not use the build farm)
|
||||
|
||||
-1, \--amd64
|
||||
|
||||
Build packages on the amd64 build farm VM
|
||||
|
||||
-2, \--i386
|
||||
|
||||
Build packages on the i386 build farm VM
|
||||
|
||||
-3, \--arm64
|
||||
|
||||
Build packages on the arm64 build farm VM
|
||||
|
||||
## DISTRIBUTION OPTIONS
|
||||
-g, \--github-page
|
||||
|
||||
Create release pages for the built packages' GitHub repositories
|
||||
|
||||
Your GitHub credentials must be stored in the config file
|
||||
|
||||
-f, \--forgejo-page
|
||||
|
||||
Create release pages for the built packages' Forgejo repositories
|
||||
|
||||
Your Forgejo credentials (and instance URL) must be stored in the config file
|
||||
|
||||
-d, \--debian-repo
|
||||
|
||||
Distribute built packages to a Git-based Debian Repository via reprepro
|
||||
|
||||
This repository must be configured via the config file
|
||||
|
||||
# AUTHOR
|
||||
rail5 (andrew@rail5.org)
|
Loading…
Reference in a new issue