[med-svn] [conquest-dicom-server] 09/17: Add man parts and modifiers for help2man

Mon Feb 3 16:47:51 UTC 2014

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

spectra pushed a commit to branch master
in repository conquest-dicom-server.

commit 131dfddb5b0ba86c7457d0ebb53f5820df6c912b
Author: Pablo Lorenzzoni <spectra at debian.org>
Date:   Sat Feb 1 13:35:58 2014 +0000

    Add man parts and modifiers for help2man
---
 debian/make-manpage               | 16 ++++++++++++++++
 debian/make_manpage               |  8 --------
 debian/manparts/author.h2m        | 10 ++++++++++
 debian/manparts/description.h2m   |  6 ++++++
 debian/manparts/files.h2m         | 37 +++++++++++++++++++++++++++++++++++++
 debian/manparts/options.h2m       |  6 ++++++
 debian/manparts/otheroptions.h2m  |  2 ++
 debian/manparts/reportingbugs.h2m | 11 +++++++++++
 debian/manparts/synopsis.h2m      | 12 ++++++++++++
 9 files changed, 100 insertions(+), 8 deletions(-)

diff --git a/debian/make-manpage b/debian/make-manpage
new file mode 100755
index 0000000..89a6c53
--- /dev/null
+++ b/debian/make-manpage
@@ -0,0 +1,16 @@
+#!/bin/sh
+
+PACKAGE=conquest-dicom-server
+VERSION=`dpkg-parsechangelog | sed -n -e 's/^Version: \(.*\)-[^-]*$/\1/p'`
+
+help2man -h "-?" -N -s 1 -n "UCDMC/NKI DICOM server thread and PACS utility application" \
+         --no-discard-stderr --version-string $VERSION -m "ConQuest DICOM server" -S \
+         "Netherlands Cancer Institute" \
+         --include debian/manparts/synopsis.h2m \
+         --include debian/manparts/description.h2m \
+         --include debian/manparts/options.h2m \
+         --include debian/manparts/otheroptions.h2m \
+         --include debian/manparts/files.h2m \
+         --include debian/manparts/author.h2m \
+         --include debian/manparts/reportingbugs.h2m \
+         -o dgate.1 ./dgate
diff --git a/debian/make_manpage b/debian/make_manpage
deleted file mode 100755
index d473eec..0000000
--- a/debian/make_manpage
+++ /dev/null
@@ -1,8 +0,0 @@
-#!/bin/sh
-
-PACKAGE=conquest-dicom-server
-VERSION=`dpkg-parsechangelog | sed -n -e 's/^Version: \(.*\)-[^-]*$/\1/p'`
-
-help2man -h "-?" -N -s 1 -n "UCDMC/NKI DICOM server thread and PACS utility application" \
-         --no-discard-stderr --version-string $VERSION -m "ConQuest DICOM server" -S \
-         "The Netherlands Cancer Institute; RT Department" -o dgate.1 ./dgate
diff --git a/debian/manparts/author.h2m b/debian/manparts/author.h2m
new file mode 100644
index 0000000..d162e8b
--- /dev/null
+++ b/debian/manparts/author.h2m
@@ -0,0 +1,10 @@
+[author]
+.B ConQuest DICOM Server
+was written by Marcel van Herk and Lambert Zijp at Netherlands Cancer
+Institute based on University of California at Davis Medical Center DICOM
+code, originally developed by Mark Oskin.
+.PP
+This manpage was written by
+.B help2man
+with parts supplied by Pablo Lorenzzoni <spectra at debian.org> for the Debian
+package.
diff --git a/debian/manparts/description.h2m b/debian/manparts/description.h2m
new file mode 100644
index 0000000..5b3285c
--- /dev/null
+++ b/debian/manparts/description.h2m
@@ -0,0 +1,6 @@
+[description]
+.PP
+ConQuest is a full featured and Lua-scriptable DICOM server.
+.PP
+To check DICOM conformance, please check
+.B /usr/share/doc/conquest-dicom-server/DicomConformance_FilesLST_Changes.pdf.gz
diff --git a/debian/manparts/files.h2m b/debian/manparts/files.h2m
new file mode 100644
index 0000000..8f8a261
--- /dev/null
+++ b/debian/manparts/files.h2m
@@ -0,0 +1,37 @@
+[files]
+All of the locations below can be configured in
+.B dicom.ini
+file. By default,
+.B ConQuest
+expects dicom.ini to be present in the same path as
+the executable. In this package, this behaviour was changed by using
+.B -w/etc/conquest-dicom-server
+option. Please consider this while messing with the files below:
+.TP 15
+/etc/conquest-dicom-server/dicom.ini
+Several self-explanatory configuration parameters for the server.
+.TP
+/etc/conquest-dicom-server/acrnema.map
+Map of the DICOM nodes allowed to retrieve studies from ConQuest and their
+compression methods
+.TP
+/etc/conquest-dicom-server/dicom.sql
+Database schema for the server
+.TP
+/etc/conquest-dicom-server/dgate.dic
+DICOM dictionary
+.TP
+/var/log/conquest-dicom-server/dgate.log
+Log from the running server (equivalent to stderr)
+.TP
+/var/log/conquest-dicom-server/trouble.log
+Errors from the running server
+.TP
+/var/log/conquest-dicom-server/user.log
+Application user log
+.TP
+/var/lib/conquest-dicom-server/dbase/conquest.sqlite
+Database of DICOM information on Patients, Studies, Series, etc
+.TP
+/var/lib/conquest-dicom-server/MAG0/*
+Where images are placed
diff --git a/debian/manparts/options.h2m b/debian/manparts/options.h2m
new file mode 100644
index 0000000..78b2e42
--- /dev/null
+++ b/debian/manparts/options.h2m
@@ -0,0 +1,6 @@
+/DGATE: UCDMC\/NKI DICOM server thread and PACS utility application/
+.SH OPTIONS
+There are three common patterns to use
+.B dgate.
+And those patterns have different ways to interpret options, as follows.
+Other options are described below.
diff --git a/debian/manparts/otheroptions.h2m b/debian/manparts/otheroptions.h2m
new file mode 100644
index 0000000..89f8e11
--- /dev/null
+++ b/debian/manparts/otheroptions.h2m
@@ -0,0 +1,2 @@
+/works directly \- use with care/
+.SH OTHER OPTIONS
diff --git a/debian/manparts/reportingbugs.h2m b/debian/manparts/reportingbugs.h2m
new file mode 100644
index 0000000..46afb1f
--- /dev/null
+++ b/debian/manparts/reportingbugs.h2m
@@ -0,0 +1,11 @@
+[reporting bugs]
+For ConQuest specific bugs, please first check their forum at
+.B http://forum.image-systems.biz/viewforum.php?f=33
+and, if needed, send email to
+.B Lambert Zijp <zijp at nki.nl>.
+.PP
+For bugs in the Debian package, please use Debian's BTS at
+.B http://bugs.debian.org
+or the tool provided in
+.B reportbug
+package.
diff --git a/debian/manparts/synopsis.h2m b/debian/manparts/synopsis.h2m
new file mode 100644
index 0000000..167efc1
--- /dev/null
+++ b/debian/manparts/synopsis.h2m
@@ -0,0 +1,12 @@
+[synopsis]
+.br
+.B dgate
+\-wDIR \-^LOGFILE
+.br
+Starts dgate with dicom.ini located at DIR and logging to LOGFILE
+.PP
+
+.B dgate
+\-pPORT \-qIP \-\-COMMAND:ARGS
+.br
+Sends COMMAND with ARGS directly to dgate instance at IP:PORT

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-med/conquest-dicom-server.git

