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.prepare
23 file is present in the debian directory, it is called.
24
25 If a
26 .B PAKET.build
27 file is present in the debian directory, it is called with a -prepare parameter (deprecated).
28 The current tree is rsync_ed to ~/build.
29
30 If a
31 .B PAKET.prebuild
32 file is present in the debian directory, it is called in the ~/build directory.
33
34 .TP
35 compile
36 To perform the compile step a
37 .B PAKET.build
38 script is needed in the 
39 .B debian 
40 directory.
41 .TP
42 pack
43 To perform the pack step a
44 .B PAKET.cp
45 script and a
46 .B PAKET.control
47 file are needed in the debian directory. If pre/post installation scripts
48 are needed, these files must be also placed in the
49 .B debian 
50 directory.
51 .br
52 A standard copyright file is included. An user defined file can be used by copying it to debian/copyright
53 in the PAKET.prepare script.
54 .br
55 A standard README.debian file is included. An user defined file can be used by defining a debian/PAKET.README.debian.
56 .SH FILES
57 .TP
58 PAKET.changelog
59 Example:
60 .br
61 projects (0.2-%BUILD%) unstable; urgency=medium
62   * Build in svn-Umgebung
63  -- Michael Wagner <michael@wagnertech.de>  Fr 10. Aug 22:54:48 CEST 2018
64 .TP
65 PAKET.prepare
66 Any executable script file executed in configure step
67 .TP
68 PAKET.prebuild
69 Any executable script file executed in configure step in the ../build directory
70 .TP
71 PAKET.build
72 Any executable script file executing the build in the ../build directory
73 .TP
74 PAKET.cp
75 An executable script file copying the artefacts to target paths preposed by $1:
76 .br
77 cp ../build/my_artefact $1/usr/bin/
78 .TP
79 PAKET.preinst PAKET.postint PAKET.prerm PAKET.postrm
80 Optional pre/post installation scripts
81 .TP
82 PAKET.control
83 Debian control file
84 .PP
85 These files are expected in a
86 .B debian
87 directory, placed below the projects main directory.
88 .SH SEE ALSO
89 make(1), mconfigure(1)
90 .SH BUGS
91 No known bugs.
92 .SH AUTHOR
93 Michael Wagner (michael@wagnertech.de)
94