posaune
authorMichael J.M. Wagner <michael@wagnertech.de>
Mon, 4 Apr 2022 10:42:44 +0000 (12:42 +0200)
committerMichael J.M. Wagner <michael@wagnertech.de>
Mon, 4 Apr 2022 10:42:44 +0000 (12:42 +0200)
doc/mbuild.7 [new file with mode: 0644]
doc/mbuild.8 [deleted file]
doc/mconfigure.1

diff --git a/doc/mbuild.7 b/doc/mbuild.7
new file mode 100644 (file)
index 0000000..c098321
--- /dev/null
@@ -0,0 +1,108 @@
+.\" Manpage for mbuild.
+.\" Contact mail@wagnertech.de to correct errors or typos.
+.TH mbuild 7 "Jul 2018" GNU "WagnerTech Utilities"
+.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. The configuration step has the following tasks:
+
+Determination of version and build number. The version number can be set in a 
+.B PAKET.changelog
+file, can be set by the -v option of
+.B mconfigure
+or be set by the project itself in the
+.B PAKET.prepare
+script. The build number is always taken from the CM system: With SVN it is the global version number, with
+GIT the build number is taken from the tag. On build a tag in the form project_version-build is expected. If not
+present a tag in the form v_version-build is searched. Verion may be 0.0 if set elsewhere.
+
+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 directory 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 or a
+.B PAKET.cmake
+file is needed in the 
+.B debian 
+directory.
+.TP
+pack
+To perform the pack step a
+.B PAKET.cp
+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.
+
+A standard copyright file is included. An user defined file can be used by copying it to debian/copyright
+in the PAKET.prepare script.
+
+If files are present to be placed unter /etc a conffiles is creates to avoid changes made by the administrator.
+
+.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.cmake
+cmake file (CMakeLists.txt) for building C/C++ code. If a cross compile option is set in the mconfigure
+script, according definitions are included.
+.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(1)
+.SH BUGS
+No known bugs.
+.SH AUTHOR
+Michael Wagner (michael@wagnertech.de)
+
diff --git a/doc/mbuild.8 b/doc/mbuild.8
deleted file mode 100644 (file)
index 4b57e02..0000000
+++ /dev/null
@@ -1,108 +0,0 @@
-.\" Manpage for mbuild.
-.\" Contact mail@wagnertech.de to correct errors or typos.
-.TH mbuild 8 "Jul 2018" GNU "WagnerTech Utilities"
-.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. The configuration step has the following tasks:
-
-Determination of version and build number. The version number can be set in a 
-.B PAKET.changelog
-file, can be set by the -v option of
-.B mconfigure
-or be set by the project itself in the
-.B PAKET.prepare
-script. The build number is always taken from the CM system: With SVN it is the global version number, with
-GIT the build number is taken from the tag. On build a tag in the form project_version-build is expected. If not
-present a tag in the form v_version-build is searched. Verion may be 0.0 if set elsewhere.
-
-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 or a
-.B PAKET.cmake
-file is needed in the 
-.B debian 
-directory.
-.TP
-pack
-To perform the pack step a
-.B PAKET.cp
-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.
-
-A standard copyright file is included. An user defined file can be used by copying it to debian/copyright
-in the PAKET.prepare script.
-
-If files are present to be placed unter /etc a conffiles is creates to avoid changes made by the administrator.
-
-.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.cmake
-cmake file (CMakeLists.txt) for building C/C++ code. If a cross compile option is set in the mconfigure
-script, according definitions are included.
-.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(1)
-.SH BUGS
-No known bugs.
-.SH AUTHOR
-Michael Wagner (michael@wagnertech.de)
-
index 08e160b..02022fe 100644 (file)
@@ -8,12 +8,12 @@ mconfigure \- interface to build system of WagnerTech UG
 [-cdpoV] [-a ARCH] [-C TOOLSET] [-v VERSION]
 .I paket 
 .SH DESCRIPTION
-mconfigure builds the package 
+mconfigure builds the artefact 
 .I paket.
 mconfigure has to be called in the projects base directory containing a directoty named
 .B debian,
 that contains the files described in
-.B mbuild(8).
+.B mbuild(7).
 .SH OPTIONS
 .TP
 -a ARCH
@@ -47,7 +47,7 @@ have to be added to the setenv.sh file in the debian directory.
 .PP
 If no steps are selected all steps are performed.
 .SH SEE ALSO
-mbuild(8): Overview description
+mbuild(7): Overview description
 .SH BUGS
 No known bugs.
 .SH AUTHOR