doc/mbuild.8

   1 .\" Manpage for mbuild.
   2 .\" Contact mail@wagnertech.de to correct errors or typos.
   3 .TH mbuild 8 "Jul 2018" GNU "WagnerTech Utilities"
   4 .SH NAME
   5 mbuild \- build system of WagnerTech UG
   6 .SH SYNOPSIS
   7 .B mbuild
   8 .SH DESCRIPTION
   9 .PP
  10 mbuild provides a simple build system based on make, git, subversion. The build process
  11 consists of 3 phases: configuration - compile - pack
  12 .TP
  13 configuration
  14 is done by the
  15 .B mconfigure
  16 script. It determins the verion number from the git/subversion status. A
  17 .B PAKET.changelog
  18 file is needed. Per
  19 default this script also performs compile and pack step.
  20 .TP
  21 compile
  22 To perform the compile step a
  23 .B PAKET.build
  24 script is needed in the
  25 .B debian
  26 directory.
  27 .TP
  28 pack
  29 To perform the pack step a
  30 .B PAKET.cp
  31 script is needed in the debian directory. If pre/post installation scripts
  32 are needed, these files must be also placed in the
  33 .B debian
  34 directory.
  35 .SH FILES
  36 .TP
  37 PAKET.changelog
  38 Example:
  39 .br
  40 projects (0.2-%BUILD%) unstable; urgency=medium
  41   * Build in svn-Umgebung
  42  -- Michael Wagner <michael@wagnertech.de>  Fr 10. Aug 22:54:48 CEST 2018
  43 .TP
  44 PAKET.build
  45 Any executable script file executing the build in the ../build directory
  46 .TP
  47 PAKET.cp
  48 An executable script file copying the artefacts to target paths preposed by $1:
  49 .br
  50 cp ../build/my_artefact $1/usr/bin/
  51 .TP
  52 PAKET.preinst PAKET.postint PAKET.prerm PAKET.postrm
  53 Optional pre/post installation scripts
  54 .PP
  55 These files are expected in a
  56 .B debian
  57 directory, placed below the projects main directory.
  58 .SH SEE ALSO
  59 make(1), mconfigure(1)
  60 .SH BUGS
  61 No known bugs.
  62 .SH AUTHOR
  63 Michael Wagner (michael@wagnertech.de)
  64