Merge branch 'master' of http://wagnertech.de/git/projects

[projects.git] / doc / mbuild.8

diff --git a/doc/mbuild.8 b/doc/mbuild.8
new file mode 100644 (file)
index 0000000..0f7b4f1
--- /dev/null
+++ b/doc/mbuild.8
@@ -0,0 +1,39 @@
+.\" Manpage for mbuild.
+.\" Contact mail@wagnertech.de to correct errors or typos.
+.TH man 8 "12 Jul 2018" "0.1" "mbuild man page"
+.SH NAME
+mbuild \- build system of WagnerTech UG
+.SH SYNOPSIS
+.B mbuild
+.SH DESCRIPTION
+.PP
+mbuild provides a simple build system based on make, git, subversion. The build process
+consists of 3 phases: configuration - compile - pack
+.TP
+configuration
+is done by the
+.B mconfigure
+script. It determins the verion number from the git/subversion status. Per 
+default this script also performs compile and pack step.
+.TP
+compile
+To perform the compile step a
+.B PAKET.build
+script is needed in the debian directory.
+.TP
+pack
+To perform the pack step a
+.B PAKET.cp
+script is needed in the debian directory.
+
+.SH FILES
+PAKET.build
+
+PAKET.cp
+.SH SEE ALSO
+make(1), mconfigure(8) 
+.SH BUGS
+No known bugs.
+.SH AUTHOR
+Michael Wagner (michael@wagnertech.de)
+