[syrthes/master] Improved man pages.
Gilles Filippini
gilles.filippini at free.fr
Tue Sep 15 12:28:57 UTC 2009
---
debian/syrthes2ensight.1 | 25 +++++++++++++++++++++++--
debian/syrthes_create_case.1 | 20 +++++++++++++++++++-
2 files changed, 42 insertions(+), 3 deletions(-)
diff --git a/debian/syrthes2ensight.1 b/debian/syrthes2ensight.1
index 5f18a37..1d1cff3 100644
--- a/debian/syrthes2ensight.1
+++ b/debian/syrthes2ensight.1
@@ -18,8 +18,29 @@ This manual page documents briefly the
.B syrthes2ensight
command.
.PP
-\fBsyrthes2ensight\fP can convert both Syrthes .geom and .res files. At least
-one .geom file or one .res file should be specified as input parameters.
+\fBsyrthes2ensight\fP can convert both Syrthes .geom and .res files. Input parameters depend on the way \fBsyrthes2ensight\fP is invoked.
+.PP
+Most of the time \fBsyrthes2ensight\fP is invoked with three parameters:
+.PP
+ \fBsyrthes2ensight\fP [options] syr.geom syr.res ensight_file
+with
+.TP 12
+syr.geom
+Geometrical file generated by \fBsyrthes\fP.
+.TP
+syr.resu
+Result file generated by \fBsyrthes\fP. It can be either a single time step result file or a chrono file containing several time steps. In the latter all time steps will be handled.
+.TP
+ensight_file
+Output Ensight file generated by \fBsyrthes2ensight\fP.
+.PP
+To process a geometrical file only:
+.PP
+ \fBsyrthes2ensight\fP -g [options] syr.geom ensight_file
+.PP
+To process a result file only:
+.PP
+ \fBsyrthes2ensight\fP -r [options] syr.resu ensight_file
.PP
A detailed documentation is available at
<http://rd.edf.com/syrthes>
diff --git a/debian/syrthes_create_case.1 b/debian/syrthes_create_case.1
index e1d65f0..50b4112 100644
--- a/debian/syrthes_create_case.1
+++ b/debian/syrthes_create_case.1
@@ -11,9 +11,27 @@ command.
.PP
\fBsyrthes_create_case\fP creates a new Syrthes case into the directory
\fbdirectory\fP. This directory must not exist for the command to succeed.
+.br
+Once the case is created the new directory should contains the following tree:
.PP
-A detailed documentation is available at
+ directory/
+ |-- Makefile
+ |-- syrthes.data
+ |-- syrthes.env
+ |-- syrthes.ray
+ `-- usr
+ |-- cfluvs.F
+ |-- cphyso.F
+ |-- initmp.F
+ |-- inrefa.F
+ |-- limfso.F
+ |-- limray.F
+ `-- limsol.F
+.PP
+A detailed documentation about how to customize these files to suit your case is available at
<http://rd.edf.com/syrthes>
+.PP
+One your case is ready to run you can build the \fBsyrthes\fP exe using the provided makefile.
.SH AUTHOR
Syrthes was written by EDF S.A. <syrthes-support at edf.fr>
.PP
--
1.5.6.5
More information about the debian-science-commits
mailing list