| 1 |
363cbbb6
|
Wojtek Kosior
|
.\" SPDX-License-Identifier: CC0-1.0
|
| 2 |
|
|
.\"
|
| 3 |
|
|
.\" Man page for Hydrilla builder.
|
| 4 |
|
|
.\"
|
| 5 |
|
|
.\" Copyright (C) 2022 Wojtek Kosior <koszko@koszko.org>
|
| 6 |
|
|
.\"
|
| 7 |
|
|
.\" Available under the terms of Creative Commons Zero v1.0 Universal.
|
| 8 |
|
|
|
| 9 |
ce480820
|
Wojtek Kosior
|
.TH HYDRILLA-BUILDER 1 2022-06-14 "Hydrilla 1.1" "Hydrilla Manual"
|
| 10 |
363cbbb6
|
Wojtek Kosior
|
|
| 11 |
|
|
.SH NAME
|
| 12 |
ce480820
|
Wojtek Kosior
|
hydrilla\-builder \- Generate packages to be served by Hydrilla
|
| 13 |
363cbbb6
|
Wojtek Kosior
|
|
| 14 |
|
|
.SH SYNOPSIS
|
| 15 |
|
|
.B "hydrilla\-builder \-\-help"
|
| 16 |
|
|
.br
|
| 17 |
|
|
.B "hydrilla\-builder [\-s \fISOURCE\/\fP] [\-i\ \fIINDEX_PATH\/\fP]"
|
| 18 |
|
|
.B "\-d \fIDESTINATION\/\fP"
|
| 19 |
|
|
.br
|
| 20 |
|
|
(See the OPTIONS section for alternate option syntax with long option
|
| 21 |
|
|
names.)
|
| 22 |
|
|
|
| 23 |
|
|
.SH DESCRIPTION
|
| 24 |
ce480820
|
Wojtek Kosior
|
.I hydrilla\-builder
|
| 25 |
363cbbb6
|
Wojtek Kosior
|
is a tool which takes a Hydrilla source package and generates files of a
|
| 26 |
|
|
built package, suitable for serving by the Hydrilla server.
|
| 27 |
|
|
|
| 28 |
ce480820
|
Wojtek Kosior
|
The main function of
|
| 29 |
|
|
.I hydrilla\-builder
|
| 30 |
|
|
is to automate the process of computing SHA256 cryptographic sums of package
|
| 31 |
|
|
files and including them in JSON definitions.
|
| 32 |
|
|
|
| 33 |
|
|
This tool does not perform nor trigger actions like compilation, minification or
|
| 34 |
|
|
bundling of source code files. When this is needed,
|
| 35 |
|
|
.I hydrilla\-builder
|
| 36 |
|
|
instead relies on facilities already provided by other software distribution
|
| 37 |
|
|
systems like APT and extracts the requested files from .deb packages. This
|
| 38 |
|
|
feature is called \*(lqpiggybacking\*(rq.
|
| 39 |
363cbbb6
|
Wojtek Kosior
|
|
| 40 |
|
|
In addition,
|
| 41 |
ce480820
|
Wojtek Kosior
|
.I hydrilla\-builder
|
| 42 |
363cbbb6
|
Wojtek Kosior
|
can generate an SPDX report from source package if the
|
| 43 |
|
|
\*(lqreuse_generate_spdx_report\*(rq property is set to true in index.json.
|
| 44 |
|
|
|
| 45 |
|
|
.SH OPTIONS
|
| 46 |
|
|
.TP
|
| 47 |
|
|
.B \-\^\-help
|
| 48 |
|
|
Output a usage message and exit.
|
| 49 |
|
|
|
| 50 |
|
|
.TP
|
| 51 |
|
|
.BI \-s " SOURCE" "\fR,\fP \-\^\-srcdir=" SOURCE
|
| 52 |
|
|
Use
|
| 53 |
|
|
.I SOURCE
|
| 54 |
|
|
as source package directory to build from.
|
| 55 |
|
|
If not specified, current directory is used.
|
| 56 |
|
|
|
| 57 |
|
|
.TP
|
| 58 |
|
|
.BI \-i " INDEX_PATH" "\fR,\fP \-\^\-index\-json=" INDEX_PATH
|
| 59 |
|
|
Process the JSON file under
|
| 60 |
|
|
.I INDEX_PATH
|
| 61 |
|
|
instead of index.json inside source directory.
|
| 62 |
|
|
.I INDEX_PATH
|
| 63 |
|
|
may be either absolute or relative.
|
| 64 |
|
|
In the latter case it is resolved with respect to the source directory.
|
| 65 |
|
|
|
| 66 |
|
|
File provided as
|
| 67 |
|
|
.I INDEX_PATH
|
| 68 |
|
|
will also be included in the generated source archive as
|
| 69 |
|
|
\*(lqindex.json\*(rq, substituting any file with such name that could be
|
| 70 |
|
|
present in the source directory.
|
| 71 |
|
|
|
| 72 |
ce480820
|
Wojtek Kosior
|
.TP
|
| 73 |
|
|
.BI \-p " PIGGYBACK_PATH" "\fR,\fP \-\^\-piggyback\-files=" PIGGYBACK_PATH
|
| 74 |
|
|
Read and write foreign package archives under
|
| 75 |
|
|
.IR PIGGYBACK_PATH .
|
| 76 |
|
|
If not specified, a default value is computed by appending
|
| 77 |
|
|
\*(lq.foreign-packages\*(rq to the
|
| 78 |
|
|
.I SOURCE
|
| 79 |
|
|
directory path.
|
| 80 |
|
|
|
| 81 |
363cbbb6
|
Wojtek Kosior
|
.TP
|
| 82 |
|
|
.BI \-d " DESTINATION" "\fR,\fP \-\^\-dstdir=" DESTINATION
|
| 83 |
|
|
Write generated files under
|
| 84 |
|
|
.IR DESTINATION .
|
| 85 |
|
|
.I DESTINATION
|
| 86 |
ce480820
|
Wojtek Kosior
|
can then be passed to Hydrilla to serve packages from.
|
| 87 |
363cbbb6
|
Wojtek Kosior
|
|
| 88 |
6f745d21
|
Wojtek Kosior
|
.TP
|
| 89 |
|
|
.B \-\^\-version
|
| 90 |
|
|
Show version information for this instance of
|
| 91 |
ce480820
|
Wojtek Kosior
|
.I hydrilla\-builder
|
| 92 |
6f745d21
|
Wojtek Kosior
|
on the standard output and exit successfully.
|
| 93 |
|
|
|
| 94 |
363cbbb6
|
Wojtek Kosior
|
.SH "EXIT STATUS"
|
| 95 |
|
|
The exit status is 0 if build was performed successfully or if the
|
| 96 |
|
|
.B \-\^\-help
|
| 97 |
|
|
option was passed. It is a number different from 0 in all other cases.
|
| 98 |
|
|
|
| 99 |
|
|
.SH "SEE ALSO"
|
| 100 |
|
|
.SS "Manual Pages"
|
| 101 |
|
|
.BR hydrilla (1).
|
| 102 |
|
|
|
| 103 |
|
|
.SS "Full Documentation"
|
| 104 |
|
|
.UR https://hydrillabugs.koszko.org/projects/hydrilla/wiki
|
| 105 |
|
|
Online documentation
|
| 106 |
|
|
.UE
|
| 107 |
|
|
is available on Hydrilla issue tracker.
|