|
1
|
.\" 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
|
.TH HYDRILLA-BUILDER 1 2022-04-22 "Hydrilla 1.0" "Hydrilla Manual"
|
|
10
|
|
|
11
|
.SH NAME
|
|
12
|
hydrilla-builder \- Generate packages to be served by Hydrilla
|
|
13
|
|
|
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
|
.I hydrilla-builder
|
|
25
|
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
|
As of Hydrilla version 1.0
|
|
29
|
.I hydrilla-builder
|
|
30
|
does not yet perform nor trigger actions like compilation, minification or
|
|
31
|
bundling of source code files. Its main function is to automate the process
|
|
32
|
of computing SHA256 cryptographic sums of package files and including them
|
|
33
|
in JSON definitions.
|
|
34
|
|
|
35
|
In addition,
|
|
36
|
.B hydrilla\-builder
|
|
37
|
can generate an SPDX report from source package if the
|
|
38
|
\*(lqreuse_generate_spdx_report\*(rq property is set to true in index.json.
|
|
39
|
|
|
40
|
.SH OPTIONS
|
|
41
|
.TP
|
|
42
|
.B \-\^\-help
|
|
43
|
Output a usage message and exit.
|
|
44
|
|
|
45
|
.TP
|
|
46
|
.BI \-s " SOURCE" "\fR,\fP \-\^\-srcdir=" SOURCE
|
|
47
|
Use
|
|
48
|
.I SOURCE
|
|
49
|
as source package directory to build from.
|
|
50
|
If not specified, current directory is used.
|
|
51
|
|
|
52
|
.TP
|
|
53
|
.BI \-i " INDEX_PATH" "\fR,\fP \-\^\-index\-json=" INDEX_PATH
|
|
54
|
Process the JSON file under
|
|
55
|
.I INDEX_PATH
|
|
56
|
instead of index.json inside source directory.
|
|
57
|
.I INDEX_PATH
|
|
58
|
may be either absolute or relative.
|
|
59
|
In the latter case it is resolved with respect to the source directory.
|
|
60
|
|
|
61
|
File provided as
|
|
62
|
.I INDEX_PATH
|
|
63
|
will also be included in the generated source archive as
|
|
64
|
\*(lqindex.json\*(rq, substituting any file with such name that could be
|
|
65
|
present in the source directory.
|
|
66
|
|
|
67
|
.TP
|
|
68
|
.BI \-d " DESTINATION" "\fR,\fP \-\^\-dstdir=" DESTINATION
|
|
69
|
Write generated files under
|
|
70
|
.IR DESTINATION .
|
|
71
|
Files are written in such way that
|
|
72
|
.I DESTINATION
|
|
73
|
is valid for being passed to Hydrilla to serve packages from.
|
|
74
|
|
|
75
|
.TP
|
|
76
|
.B \-\^\-version
|
|
77
|
Show version information for this instance of
|
|
78
|
.I hydrilla-builder
|
|
79
|
on the standard output and exit successfully.
|
|
80
|
|
|
81
|
.SH "EXIT STATUS"
|
|
82
|
The exit status is 0 if build was performed successfully or if the
|
|
83
|
.B \-\^\-help
|
|
84
|
option was passed. It is a number different from 0 in all other cases.
|
|
85
|
|
|
86
|
.SH "SEE ALSO"
|
|
87
|
.SS "Manual Pages"
|
|
88
|
.BR hydrilla (1).
|
|
89
|
|
|
90
|
.SS "Full Documentation"
|
|
91
|
.UR https://hydrillabugs.koszko.org/projects/hydrilla/wiki
|
|
92
|
Online documentation
|
|
93
|
.UE
|
|
94
|
is available on Hydrilla issue tracker.
|