From 2c5e6db3173a8f70e12a1f7f2723432b00466eb6 Mon Sep 17 00:00:00 2001 From: Johannes Schauer Marin Rodrigues Date: Tue, 19 Sep 2023 12:56:03 +0200 Subject: [PATCH] mmdebstrap-autopkgtest-build-qemu: add POD manual --- mmdebstrap-autopkgtest-build-qemu | 100 +++++++++++++++++++++++++++--- 1 file changed, 93 insertions(+), 7 deletions(-) diff --git a/mmdebstrap-autopkgtest-build-qemu b/mmdebstrap-autopkgtest-build-qemu index 9eaca51..b3012e3 100755 --- a/mmdebstrap-autopkgtest-build-qemu +++ b/mmdebstrap-autopkgtest-build-qemu @@ -2,16 +2,102 @@ # Copyright 2023 Johannes Schauer Marin Rodrigues # Copyright 2023 Helmut Grohne # SPDX-License-Identifier: MIT -# -# This script is mostly compatible with autopkgtest-build-qemu as shipped in -# autopkgtest. Main differences: -# * It does not support any value for --boot but efi. -# * It uses different tools, most importantly swaps out vmdb2. -# * It can be run as non-root via user namespaces. # We generally use single quotes to avoid variable expansion: # shellcheck disable=SC2016 +: <<'POD2MAN' +=head1 NAME + +mmdebstrap-autopkgtest-build-qemu - autopkgtest-build-qemu without vmdb2 but mmdebstrap and EFI boot + +=head1 SYNOPSIS + +B [I] B<--boot>=B I I + +=head1 DESCRIPTION + +B is a mostly compatible drop-in replacement +for B(1) with two main differences: Firstly, it uses +B(1) instead of B(1) and thus is able to create QEMU disk +images without requiring superuser privileges. Secondly, it uses +B(7) and thus only supports booting via EFI. + +=head1 POSITIONAL PARAMETERS + +=over 8 + +=item I + +The release to download from the I. This parameter is required. + +=item I + +The file to write, in raw format. This parameter is required. + +=back + +=head1 OPTIONS + +=over 8 + +=item B<--mirror>=I + +Specify which distribution to install. It defaults to +http://deb.debian.org/debian (i.e. Debian), but you can pass a mirror of any +Debian derivative. + +=item B<--architecture>=I + +Set the architecture for the virtual machine image, specified as a B(1) +architecture. If omitted, the host architecture is assumed. + +B<--arch>=I is an alias for this option. + +=item B<--script>=I