[openems] 01/01: Added man pages

[Ruben Undheim]

This is an automated email from the git hooks/post-receive script.

rubund-guest pushed a commit to branch master
in repository openems.

commit 7884172eaeaabd4217e944e415cbe89777278565
Author: Ruben Undheim <ruben.undheim at gmail.com>
Date:   Mon Nov 21 21:27:50 2016 +0100

    Added man pages
---
 debian/control            |  3 ++-
 debian/man/AppCSXCAD.txt  | 19 +++++++++++++++++++
 debian/man/genmanpages.sh |  6 ++++++
 debian/man/nf2ff.txt      | 16 ++++++++++++++++
 debian/man/openEMS.txt    | 22 ++++++++++++++++++++++
 debian/openems.manpages   |  1 +
 debian/rules              |  5 +++++
 7 files changed, 71 insertions(+), 1 deletion(-)

diff --git a/debian/control b/debian/control
index acd2a7f..51fe625 100644
--- a/debian/control
+++ b/debian/control
@@ -10,7 +10,8 @@ Build-Depends: debhelper (>= 9),
                libcgal-dev,
                libtinyxml-dev,
                libvtk6-qt-dev,
-               octave-pkg-dev
+               octave-pkg-dev,
+               txt2man
 Standards-Version: 3.9.8
 Vcs-Browser: https://anonscm.debian.org/cgit/debian-science/packages/openems.git
 Vcs-Git: https://anonscm.debian.org/git/debian-science/packages/openems.git
diff --git a/debian/man/AppCSXCAD.txt b/debian/man/AppCSXCAD.txt
new file mode 100644
index 0000000..e759b04
--- /dev/null
+++ b/debian/man/AppCSXCAD.txt
@@ -0,0 +1,19 @@
+NAME
+  AppCSXCAD - GUI for looking at geometries for openEMS
+
+SYNOPSIS
+  AppCSXCAD
+
+DESCRIPTION
+
+  Runnning the command launches a GUI
+
+OPTIONS
+
+
+
+AUTHOR
+  This manual page was written by Ruben Undheim <ruben.undheim at gmail.com> for the Debian project (and may be used by others).
+
+
+
diff --git a/debian/man/genmanpages.sh b/debian/man/genmanpages.sh
new file mode 100755
index 0000000..5ecfefd
--- /dev/null
+++ b/debian/man/genmanpages.sh
@@ -0,0 +1,6 @@
+#!/bin/bash
+
+
+txt2man -d "${CHANGELOG_DATE}" -t OPENEMS     -s 1 openEMS.txt          > openEMS.1
+txt2man -d "${CHANGELOG_DATE}" -t NF2FF       -s 1 nf2ff.txt            > nf2ff.1
+txt2man -d "${CHANGELOG_DATE}" -t APPCSXCAD   -s 1 AppCSXCAD.txt        > AppCSXCAD.1
diff --git a/debian/man/nf2ff.txt b/debian/man/nf2ff.txt
new file mode 100644
index 0000000..341e1dd
--- /dev/null
+++ b/debian/man/nf2ff.txt
@@ -0,0 +1,16 @@
+NAME
+  nf2ff - Near-field to Far-field Transformation for openEMS
+
+SYNOPSIS
+  nf2ff <nf2ff-xml-file>
+
+DESCRIPTION
+
+ 
+
+
+AUTHOR
+  This manual page was written by Ruben Undheim <ruben.undheim at gmail.com> for the Debian project (and may be used by others).
+
+
+
diff --git a/debian/man/openEMS.txt b/debian/man/openEMS.txt
new file mode 100644
index 0000000..4d406ec
--- /dev/null
+++ b/debian/man/openEMS.txt
@@ -0,0 +1,22 @@
+NAME
+  openEMS - Electromagnetic simulator using the FDTD algorithm
+
+SYNOPSIS
+  openEMS <FDTD_XML_FILE> [<options>...]
+
+DESCRIPTION
+
+
+OPTIONS
+
+    --disable-dumps     Disable all field dumps for faster simulation
+    --debug-material    Dump material distribution to a vtk file for debugging
+    ...
+ 
+
+
+AUTHOR
+  This manual page was written by Ruben Undheim <ruben.undheim at gmail.com> for the Debian project (and may be used by others).
+
+
+
diff --git a/debian/openems.manpages b/debian/openems.manpages
new file mode 100644
index 0000000..13cdaf4
--- /dev/null
+++ b/debian/openems.manpages
@@ -0,0 +1 @@
+debian/man/*.1
diff --git a/debian/rules b/debian/rules
index d8c9736..fc87dbc 100755
--- a/debian/rules
+++ b/debian/rules
@@ -10,6 +10,7 @@ PKD  = $(abspath $(dir $(MAKEFILE_LIST)))
 PKG  = $(word 2,$(shell dpkg-parsechangelog -l$(PKD)/changelog | grep ^Source))
 VER ?= $(shell dpkg-parsechangelog -l$(PKD)/changelog | perl -ne 'print $$1 if m{^Version:\s+(?:\d+:)?(\d.*)(?:\-\d+.*)};')
 DEB_HOST_MULTIARCH ?= $(shell dpkg-architecture -qDEB_HOST_MULTIARCH)
+CHANGELOG_DATE ?= $(shell LC_ALL=C date -u -d "`dpkg-parsechangelog --show-field Date`" +"%d %B %Y")
 
 OCTAVE_BPATH = usr/lib/$(shell dpkg-architecture -qDEB_HOST_MULTIARCH)/octave/packages
 OCTAVE_HOSTTYPE = $(shell octave-config -p CANONICAL_HOST_TYPE)
@@ -39,6 +40,10 @@ override_dh_auto_install:
 	rm debian/tmp/usr/share/openEMS/matlab/h5readatt_octave.o
 
 
+override_dh_installman:
+	cd debian/man ; CHANGELOG_DATE="$(CHANGELOG_DATE)" ./genmanpages.sh
+	dh_installman
+
 
 get-orig-source: $(info I: $(PKG)_$(VER))
 	@echo "# Downloading..."

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/openems.git