Project

General

Profile

« Previous | Next » 

Revision ce480820

Added by koszko about 1 year ago

update hydrilla-builder manpage

View differences:

doc/man/man1/hydrilla-builder.1
6 6 
.\"
7 7 
.\" Available under the terms of Creative Commons Zero v1.0 Universal.
8 8 

  		




  9
  
  
    
.TH HYDRILLA-BUILDER 1 2022-04-22 "Hydrilla 1.0" "Hydrilla Manual"


  		




  
  9
  
    
.TH HYDRILLA-BUILDER 1 2022-06-14 "Hydrilla 1.1" "Hydrilla Manual"


  		




  10
  10
  
    

  		




  11
  11
  
    
.SH NAME


  		




  12
  
  
    
hydrilla-builder \- Generate packages to be served by Hydrilla


  		




  
  12
  
    
hydrilla\-builder \- Generate packages to be served by Hydrilla


  		




  13
  13
  
    

  		




  14
  14
  
    
.SH SYNOPSIS


  		




  15
  15
  
    
.B "hydrilla\-builder \-\-help"


  		




  ......




  21
  21
  
    
names.)


  		




  22
  22
  
    

  		




  23
  23
  
    
.SH DESCRIPTION


  		




  24
  
  
    
.I hydrilla-builder


  		




  
  24
  
    
.I hydrilla\-builder


  		




  25
  25
  
    
is a tool which takes a Hydrilla source package and generates files of a


  		




  26
  26
  
    
built package, suitable for serving by the Hydrilla server.


  		




  27
  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.


  		




  
  28
  
    
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.


  		




  34
  39
  
    

  		




  35
  40
  
    
In addition,


  		




  36
  
  
    
.B hydrilla\-builder


  		




  
  41
  
    
.I hydrilla\-builder


  		




  37
  42
  
    
can generate an SPDX report from source package if the


  		




  38
  43
  
    
\*(lqreuse_generate_spdx_report\*(rq property is set to true in index.json.


  		




  39
  44
  
    

  		




  ......




  64
  69
  
    
\*(lqindex.json\*(rq, substituting any file with such name that could be


  		




  65
  70
  
    
present in the source directory.


  		




  66
  71
  
    

  		




  
  72
  
    
.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
  
    

  		




  67
  81
  
    
.TP


  		




  68
  82
  
    
.BI \-d " DESTINATION" "\fR,\fP \-\^\-dstdir=" DESTINATION


  		




  69
  83
  
    
Write generated files under


  		




  70
  84
  
    
.IR DESTINATION .


  		




  71
  
  
    
Files are written in such way that


  		




  72
  85
  
    
.I DESTINATION


  		




  73
  
  
    
is valid for being passed to Hydrilla to serve packages from.


  		




  
  86
  
    
can then be passed to Hydrilla to serve packages from.


  		




  74
  87
  
    

  		




  75
  88
  
    
.TP


  		




  76
  89
  
    
.B \-\^\-version


  		




  77
  90
  
    
Show version information for this instance of


  		




  78
  
  
    
.I hydrilla-builder


  		




  
  91
  
    
.I hydrilla\-builder


  		




  79
  92
  
    
on the standard output and exit successfully.


  		




  80
  93
  
    

  		




  81
  94
  
    
.SH "EXIT STATUS"


  		












Also available in:  Unified diff