posaune

[projects.git] / doc / mbuild.8

diff --git a/doc/mbuild.8 b/doc/mbuild.8
index 0f7b4f1..3c26a7c 100644 (file)
--- a/doc/mbuild.8
+++ b/doc/mbuild.8
@@ -1,6 +1,6 @@
 .\" Manpage for mbuild.
 .\" Contact mail@wagnertech.de to correct errors or typos.
-.TH man 8 "12 Jul 2018" "0.1" "mbuild man page"
+.TH mbuild 8 "Jul 2018" GNU "WagnerTech Utilities"
 .SH NAME
 mbuild \- build system of WagnerTech UG
 .SH SYNOPSIS
@@ -13,25 +13,80 @@ consists of 3 phases: configuration - compile - pack
 configuration
 is done by the
 .B mconfigure
-script. It determins the verion number from the git/subversion status. Per 
+script. It determins the verion number from the git/subversion status. A
+.B PAKET.changelog
+file is needed. Per 
 default this script also performs compile and pack step.
+
+If a
+.B PAKET.prepare
+file is present in the debian directory, it is called.
+
+If a
+.B PAKET.build
+file is present in the debian directory, it is called with a -prepare parameter (deprecated).
+The current tree is rsync_ed to ~/build.
+
+If a
+.B PAKET.prebuild
+file is present in the debian directory, it is called in the ~/build directory.
+
 .TP
 compile
 To perform the compile step a
 .B PAKET.build
-script is needed in the debian directory.
+script is needed in the 
+.B debian 
+directory.
 .TP
 pack
 To perform the pack step a
 .B PAKET.cp
-script is needed in the debian directory.
-
+script and a
+.B PAKET.control
+file are needed in the debian directory. If pre/post installation scripts
+are needed, these files must be also placed in the
+.B debian 
+directory.
+.br
+A standard copyright file is included. An user defined file can be used by copying it to debian/copyright
+in the PAKET.prepare script.
+.br
+A standard README.debian file is included. An user defined file can be used by defining a debian/PAKET.README.debian.
 .SH FILES
+.TP
+PAKET.changelog
+Example:
+.br
+projects (0.2-%BUILD%) unstable; urgency=medium
+  * Build in svn-Umgebung
+ -- Michael Wagner <michael@wagnertech.de>  Fr 10. Aug 22:54:48 CEST 2018
+.TP
+PAKET.prepare
+Any executable script file executed in configure step
+.TP
+PAKET.prebuild
+Any executable script file executed in configure step in the ../build directory
+.TP
 PAKET.build
-
+Any executable script file executing the build in the ../build directory
+.TP
 PAKET.cp
+An executable script file copying the artefacts to target paths preposed by $1:
+.br
+cp ../build/my_artefact $1/usr/bin/
+.TP
+PAKET.preinst PAKET.postint PAKET.prerm PAKET.postrm
+Optional pre/post installation scripts
+.TP
+PAKET.control
+Debian control file
+.PP
+These files are expected in a
+.B debian
+directory, placed below the projects main directory.
 .SH SEE ALSO
-make(1), mconfigure(8) 
+make(1), mconfigure(1)
 .SH BUGS
 No known bugs.
 .SH AUTHOR