[syrthes/master] Manpage for convert2syrthes

[Gilles Filippini]

---
 debian/changelog         |    6 ++--
 debian/convert2syrthes.1 |   56 ++++++++++++++++++++++++++++++++++++++++++++++
 debian/manpages          |    1 +
 3 files changed, 60 insertions(+), 3 deletions(-)
 create mode 100644 debian/convert2syrthes.1

diff --git a/debian/changelog b/debian/changelog
index da8d410..8659085 100644
--- a/debian/changelog
+++ b/debian/changelog
@@ -12,10 +12,10 @@ syrthes (3.4.3-dfsg1-1) unstable; urgency=low
     + Build-Depends: libmedc-dev, libhdf5-openmpi-dev (for convert2syrthes)
   * New patch:
     + libmed-mesgerr: the macro MESGERR has to be defined explicitly
+  * debian/convert2syrthes.1: manpage for convert2syrthes written after
+    the convert2syrthes README.txt file
 
-  * #### convert2syrthes needs a manpage
-
- -- Gilles Filippini <pini at debian.org>  Wed, 09 Feb 2011 00:04:32 +0100
+ -- Gilles Filippini <pini at debian.org>  Fri, 11 Feb 2011 00:09:05 +0100
 
 syrthes (3.4.2-dfsg1-3) unstable; urgency=low
 
diff --git a/debian/convert2syrthes.1 b/debian/convert2syrthes.1
new file mode 100644
index 0000000..1923ee5
--- /dev/null
+++ b/debian/convert2syrthes.1
@@ -0,0 +1,56 @@
+.TH CONVERT2SYRTHES 1 "February 10, 2011"
+.SH NAME
+convert2syrthes \- Convert mesh files to SYRTHES format
+.SH SYNOPSIS
+.B convert2syrthes
+\-m mesh_file.ext [\-dim dimension] [\-o output_file.syr]
+.SH DESCRIPTION
+This manual page documents briefly the
+.B convert2syrthes
+command.
+.PP
+\fBconvert2syrthes\fP can convert mesh files from GAMBIT, GMSH or MED to
+SYRTHES format
+.PP
+A detailed documentation is available at
+<http://rd.edf.com/syrthes>
+.SH OPTIONS
+.TP 12
+\-m mesh_file.ext
+Specify the mesh file to convert. The mesh format is inferred from the file's
+extension:
+.br
+* .neu (GAMBIT format)
+.br
+* .msh (GMSH format)
+.br
+* .med (MED format) 
+.br
+Note: For MED format, convert2syrthes creates an additionnal ASCII file
+(..._desc) where one finds the links between group names (used in Salome)
+and family (or references) numbers used in SYRTHES
+.TP
+\-dim dimension
+With dimension = 2 or 3. This options is requested for the GMSH file format,
+and ignored in the other cases
+.TP
+\-o output_file.syr
+To change the name of the output file.
+.SH EXAMPLES
+.TP
+.B convert2syrthes \-m square.med
+--> square.syr square.syr_desc
+.TP
+.B convert2syrthes \-m square.neu
+--> square.syr
+.TP
+.B convert2syrthes \-m square.msh \-dim 2
+--> square.syr
+.TP
+.B convert2syrthes \-m square.med \-o square2.syr
+--> square2.syr square2.syr_desc
+.SH AUTHOR
+Syrthes was written by EDF S.A. <syrthes-support at edf.fr>
+.PP
+This manual page was written by Gilles Filippini <gilles.filippini at free.fr>
+for Debian from the convert2syrthes README.txt file.
diff --git a/debian/manpages b/debian/manpages
index aef1058..ad2d791 100644
--- a/debian/manpages
+++ b/debian/manpages
@@ -1,2 +1,3 @@
 debian/syrthes_create_case.1
 debian/syrthes2ensight.1
+debian/convert2syrthes.1
-- 
1.7.1