From ce480820e03122468a29db0cad1c8a97b62bf6c1 Mon Sep 17 00:00:00 2001 From: Wojtek Kosior Date: Tue, 14 Jun 2022 11:49:12 +0200 Subject: update hydrilla-builder manpage --- doc/man/man1/hydrilla-builder.1 | 39 ++++++++++++++++++++++++++------------- 1 file changed, 26 insertions(+), 13 deletions(-) (limited to 'doc') diff --git a/doc/man/man1/hydrilla-builder.1 b/doc/man/man1/hydrilla-builder.1 index f58ab97..20825d2 100644 --- a/doc/man/man1/hydrilla-builder.1 +++ b/doc/man/man1/hydrilla-builder.1 @@ -6,10 +6,10 @@ .\" .\" Available under the terms of Creative Commons Zero v1.0 Universal. -.TH HYDRILLA-BUILDER 1 2022-04-22 "Hydrilla 1.0" "Hydrilla Manual" +.TH HYDRILLA-BUILDER 1 2022-06-14 "Hydrilla 1.1" "Hydrilla Manual" .SH NAME -hydrilla-builder \- Generate packages to be served by Hydrilla +hydrilla\-builder \- Generate packages to be served by Hydrilla .SH SYNOPSIS .B "hydrilla\-builder \-\-help" @@ -21,19 +21,24 @@ hydrilla-builder \- Generate packages to be served by Hydrilla names.) .SH DESCRIPTION -.I hydrilla-builder +.I hydrilla\-builder is a tool which takes a Hydrilla source package and generates files of a built package, suitable for serving by the Hydrilla server. -As of Hydrilla version 1.0 -.I hydrilla-builder -does not yet perform nor trigger actions like compilation, minification or -bundling of source code files. Its main function is to automate the process -of computing SHA256 cryptographic sums of package files and including them -in JSON definitions. +The main function of +.I hydrilla\-builder +is to automate the process of computing SHA256 cryptographic sums of package +files and including them in JSON definitions. + +This tool does not perform nor trigger actions like compilation, minification or +bundling of source code files. When this is needed, +.I hydrilla\-builder +instead relies on facilities already provided by other software distribution +systems like APT and extracts the requested files from .deb packages. This +feature is called \*(lqpiggybacking\*(rq. In addition, -.B hydrilla\-builder +.I hydrilla\-builder can generate an SPDX report from source package if the \*(lqreuse_generate_spdx_report\*(rq property is set to true in index.json. @@ -64,18 +69,26 @@ will also be included in the generated source archive as \*(lqindex.json\*(rq, substituting any file with such name that could be present in the source directory. +.TP +.BI \-p " PIGGYBACK_PATH" "\fR,\fP \-\^\-piggyback\-files=" PIGGYBACK_PATH +Read and write foreign package archives under +.IR PIGGYBACK_PATH . +If not specified, a default value is computed by appending +\*(lq.foreign-packages\*(rq to the +.I SOURCE +directory path. + .TP .BI \-d " DESTINATION" "\fR,\fP \-\^\-dstdir=" DESTINATION Write generated files under .IR DESTINATION . -Files are written in such way that .I DESTINATION -is valid for being passed to Hydrilla to serve packages from. +can then be passed to Hydrilla to serve packages from. .TP .B \-\^\-version Show version information for this instance of -.I hydrilla-builder +.I hydrilla\-builder on the standard output and exit successfully. .SH "EXIT STATUS" -- cgit v1.2.3