posaune
[projects.git] / 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
21 If a
22 .B PAKET.build
23 file is present in the debian directory, it is called with a -prepare parameter.
24 .TP
25 compile
26 To perform the compile step a
27 .B PAKET.build
28 script is needed in the 
29 .B debian 
30 directory.
31 .TP
32 pack
33 To perform the pack step a
34 .B PAKET.cp
35 script and a
36 .B PAKET.control
37 file are needed in the debian directory. If pre/post installation scripts
38 are needed, these files must be also placed in the
39 .B debian 
40 directory.
41 .SH FILES
42 .TP
43 PAKET.changelog
44 Example:
45 .br
46 projects (0.2-%BUILD%) unstable; urgency=medium
47   * Build in svn-Umgebung
48  -- Michael Wagner <michael@wagnertech.de>  Fr 10. Aug 22:54:48 CEST 2018
49 .TP
50 PAKET.build
51 Any executable script file executing the build in the ../build directory
52 .TP
53 PAKET.cp
54 An executable script file copying the artefacts to target paths preposed by $1:
55 .br
56 cp ../build/my_artefact $1/usr/bin/
57 .TP
58 PAKET.preinst PAKET.postint PAKET.prerm PAKET.postrm
59 Optional pre/post installation scripts
60 .TP
61 PAKET.control
62 Debian control file
63 .PP
64 These files are expected in a
65 .B debian
66 directory, placed below the projects main directory.
67 .SH SEE ALSO
68 make(1), mconfigure(1)
69 .SH BUGS
70 No known bugs.
71 .SH AUTHOR
72 Michael Wagner (michael@wagnertech.de)
73