[SCM] Gerris Flow Solver branch, upstream, updated. b3aa46814a06c9cb2912790b23916ffb44f1f203
Stephane Popinet
popinet at users.sf.net
Fri May 15 02:56:19 UTC 2009
The following commit has been merged in the upstream branch:
commit 71550a39d19eed351fa23e564c643cc123aabb2e
Author: Stephane Popinet <popinet at users.sf.net>
Date: Fri May 1 14:13:55 2009 +1000
Added man pages from debian (thanks Ruben and Drew!)
Ignore-this: ec2eff1be78eaa2a9e64f3af33bb6583
darcs-hash:20090501041355-d4795-248138fd8b536c886bd1ad157b9f403a276659a1.gz
diff --git a/AUTHORS b/AUTHORS
index 0463664..06937b7 100644
--- a/AUTHORS
+++ b/AUTHORS
@@ -1,10 +1,10 @@
Original Authors
----------------
-Stéphane Popinet <s.popinet at niwa.cri.nz>
+Stéphane Popinet <popinet at users.sf.net>
Contributors
------------
-Marcelo E. Magallon: Debian packages.
+Marcelo E. Magallon, Ruben Molina, Drew Parsons: Debian packages.
Ruben Scardovelli: - author of the Fortran version of gfs_plane_alpha()
- Mixed Youngs-Centered VOF normal calculation
Ivan Adam Vari: RPM packages.
diff --git a/configure.in b/configure.in
index 48b8461..b5982c8 100644
--- a/configure.in
+++ b/configure.in
@@ -463,6 +463,7 @@ test/Makefile
doc/Makefile
doc/tutorial/Makefile
doc/examples/Makefile
+doc/manpages/Makefile
doc/examples/gfs2doc
doc/examples/gfs-highlight
doc/examples/crossref.sh
diff --git a/doc/Makefile.am b/doc/Makefile.am
index 31f8d6f..60c58c8 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -1,6 +1,6 @@
## Process this file with automake to produce Makefile.in
-SUBDIRS = tutorial examples
+SUBDIRS = tutorial examples manpages
# The name of the module.
DOC_MODULE=gfs
diff --git a/doc/manpages/Makefile.am b/doc/manpages/Makefile.am
new file mode 100644
index 0000000..cecde09
--- /dev/null
+++ b/doc/manpages/Makefile.am
@@ -0,0 +1,22 @@
+man_MANS = \
+ bat2gts.1 \
+ gerris2D.1 \
+ gerris2D3.1 \
+ gerris3D.1 \
+ gfs2gfs.1 \
+ gfs2oogl2D.1 \
+ gfs2oogl2D3.1 \
+ gfs2oogl3D.1 \
+ gfscompare2D.1 \
+ gfscompare2D3.1 \
+ gfscompare3D.1 \
+ gfs-config.1 \
+ gfs-highlight.1 \
+ gfsjoin.1 \
+ gfsxref.1 \
+ ppm2mpeg.1 \
+ ppmcombine.1 \
+ rsurfacequery.1 \
+ shapes.1 \
+ streamanime.1 \
+ xyz2rsurface.1
diff --git a/doc/manpages/bat2gts.1 b/doc/manpages/bat2gts.1
new file mode 100644
index 0000000..68bfaa5
--- /dev/null
+++ b/doc/manpages/bat2gts.1
@@ -0,0 +1,50 @@
+.TH bat2gts 1 "August 9, 2008" "" "User Commands"
+
+.SH NAME
+bat2gts \- takes a bathymetry file (three columns: longitude, latitude (degree), depth (meters)) and generates a GTS depth file for the given domain.
+
+.SH SYNOPSIS
+.B bat2gts
+.RI [OPTIONS] < BATHY
+.SH DESCRIPTION
+This manual page documents briefly the
+.B bat2gts
+command.
+
+.SH OPTIONS
+These programs follow the usual GNU command line syntax, with long
+options starting with two dashes (`-').
+A summary of options is included below.
+.TP
+.B \-\-long=V
+Set reference longitude to V (default 174 deg)
+.TP
+.B \-\-lat=V
+Set reference latitude to V (default \-41 deg)
+.TP
+.B \-\-width=V
+Set domain width (default is 500 km)
+.TP
+.B \-\-depth=V
+Set reference depth to V (default is 5000 meters)
+.TP
+.B \-\-coast=V
+Set coastline reference depth to V (default is 0.1 meters)
+.TP
+.B \-\-rel=T
+Set relative error allowed on bathymetry (default is 0.05)
+.TP
+.B \-\-angle=V
+Rotation of V degrees (default is 0)
+.TP
+.B \-v, \-\-verbose
+Display info about the process
+.TP
+.B \-h, \-\-help
+Display the help and exit.
+
+.SH AUTHOR
+bat2gts was written by Stephane Popinet <s.popinet at niwa.co.nz>.
+.PP
+This manual page was written by Ruben Molina <rmolina at udea.edu.co>,
+for the Debian project (but may be used by others).
diff --git a/doc/manpages/gerris2D.1 b/doc/manpages/gerris2D.1
new file mode 100644
index 0000000..b521f4c
--- /dev/null
+++ b/doc/manpages/gerris2D.1
@@ -0,0 +1,47 @@
+.TH gerris 1 "July 9, 2008" "" "User Commands"
+
+.SH NAME
+gerris2D, gerris2D3, gerris3D \- the Gerris flow solver simulation engine.
+
+.SH SYNOPSIS
+.B gerris
+.RI [OPTION] FILE
+.SH DESCRIPTION
+This manual page documents briefly the
+.B gerris
+command.
+
+.SH OPTIONS
+These programs follow the usual GNU command line syntax, with long
+options starting with two dashes (`-').
+A summary of options is included below.
+.TP
+.B \-s N, \-\-split=N
+Splits the domain N times and returns the corresponding simulation.
+.TP
+.B \-P N, \-\-partition=N
+Partition the domain in 2^N subdomains and returns the corresponding simulation.
+.TP
+.B \-d, \-\-data
+When splitting or partitioning, output all data.
+.TP
+.B \-P, \-\-profile
+Profiles calls to boundary conditions.
+.TP
+.B \-m, \-\-macros
+Turn macros support on.
+.TP
+.B \-DNAME, \-DNAME=VALUE, \-\-define=NAME, \-\-define=NAME=VALUE
+Defines NAME as a macro expanding to VALUE (macro support is implicitly turned on).
+.TP
+.B \-V, \-\-version
+Output version information and exit.
+.TP
+.B \-h, \-\-help
+Display the help and exit.
+
+.SH AUTHOR
+gerris was written by Stephane Popinet <s.popinet at niwa.co.nz>.
+.PP
+This manual page was written by Ruben Molina <rmolina at udea.edu.co>,
+for the Debian project (but may be used by others).
diff --git a/doc/manpages/gerris2D3.1 b/doc/manpages/gerris2D3.1
new file mode 100644
index 0000000..6fe6b25
--- /dev/null
+++ b/doc/manpages/gerris2D3.1
@@ -0,0 +1 @@
+.so man1/gerris2D.1
diff --git a/doc/manpages/gerris3D.1 b/doc/manpages/gerris3D.1
new file mode 100644
index 0000000..6fe6b25
--- /dev/null
+++ b/doc/manpages/gerris3D.1
@@ -0,0 +1 @@
+.so man1/gerris2D.1
diff --git a/doc/manpages/gfs-config.1 b/doc/manpages/gfs-config.1
new file mode 100644
index 0000000..99781c9
--- /dev/null
+++ b/doc/manpages/gfs-config.1
@@ -0,0 +1,35 @@
+.TH gfs-config 1 "August 9, 2008" "" "User Commands"
+
+.SH NAME
+gfs-config \- defines values for programs using gts.
+
+.SH SYNOPSIS
+.B gfs-config
+.RI [OPTIONS]
+.SH DESCRIPTION
+This manual page documents briefly the
+.B gfs-config
+command.
+
+.SH OPTIONS
+These programs follow the usual GNU command line syntax, with long
+options starting with two dashes (`-').
+A summary of options is included below.
+.TP
+.B \-\-prefix[=DIR]
+.TP
+.B \-\-exec-prefix[=DIR]
+.TP
+.B \-\-version
+.TP
+.B \-\-libs
+.TP
+.B \-\-cflags
+.TP
+.B \-\-2D
+
+.SH AUTHOR
+gfs-config was written by Stephane Popinet <popinet at users.sourceforge.net>.
+.PP
+This manual page was written by Ruben Molina <rmolina at udea.edu.co>,
+for the Debian project (but may be used by others).
diff --git a/doc/manpages/gfs-highlight.1 b/doc/manpages/gfs-highlight.1
new file mode 100644
index 0000000..c1025eb
--- /dev/null
+++ b/doc/manpages/gfs-highlight.1
@@ -0,0 +1,32 @@
+.TH gfs-highlight 1 "July 9, 2008" "" "User Commands"
+
+.SH NAME
+gfs-highlight \- syntax highlighting/hypertext linking of Gerris simulation files.
+
+.SH SYNOPSIS
+.B gfs-highlight
+.RI [OPTIONS] < input.gfs > output.html
+.SH DESCRIPTION
+This manual page documents briefly the
+.B gfs-highlight
+command.
+
+.SH OPTIONS
+These programs follow the usual GNU command line syntax, with long
+options starting with two dashes (`-').
+A summary of options is included below.
+.TP
+.B \-\-title=TITLE
+Sets the page title.
+.TP
+.B \-\-css=FILE
+Sets the CSS stylesheet filename.
+.TP
+.B \-h, \-\-help
+Display the help and exit.
+
+.SH AUTHOR
+gfs-highlight was written by Stephane Popinet <s.popinet at niwa.co.nz>.
+.PP
+This manual page was written by Ruben Molina <rmolina at udea.edu.co>,
+for the Debian project (but may be used by others).
diff --git a/doc/manpages/gfs2gfs.1 b/doc/manpages/gfs2gfs.1
new file mode 100644
index 0000000..6962516
--- /dev/null
+++ b/doc/manpages/gfs2gfs.1
@@ -0,0 +1,26 @@
+.TH gfs2gfs 1 "July 9, 2008" "" "User Commands"
+
+.SH NAME
+gfs2gfs \- converts old Gerris simulation files to the current format.
+
+.SH SYNOPSIS
+.B gfs2gfs
+.RI [OPTIONS] < OLDFILE > NEWFILE
+.SH DESCRIPTION
+This manual page documents briefly the
+.B gfs2gfs
+command.
+
+.SH OPTIONS
+These programs follow the usual GNU command line syntax, with long
+options starting with two dashes (`-').
+A summary of options is included below.
+.TP
+.B \-h, \-\-help
+Display the help and exit.
+
+.SH AUTHOR
+gfs2gfs was written by Stephane Popinet <s.popinet at niwa.co.nz>.
+.PP
+This manual page was written by Ruben Molina <rmolina at udea.edu.co>,
+for the Debian project (but may be used by others).
diff --git a/doc/manpages/gfs2oogl2D.1 b/doc/manpages/gfs2oogl2D.1
new file mode 100644
index 0000000..1b23e63
--- /dev/null
+++ b/doc/manpages/gfs2oogl2D.1
@@ -0,0 +1,105 @@
+.TH gfs2oogl 1 "July 9, 2008" "" "User Commands"
+
+.SH NAME
+gfs2oogl2D, gfs2oogl2D3, gfs2oogl3D \- converts a Gerris simulation file to other (graphical) formats.
+
+.SH SYNOPSIS
+.B gfs2oogl
+.RI [OPTION] < GFS_FILE
+.SH DESCRIPTION
+This manual page documents briefly the
+.B gfs2oogl
+command.
+
+.SH OPTIONS
+These programs follow the usual GNU command line syntax, with long
+options starting with two dashes (`-').
+A summary of options is included below.
+
+.TP
+.B \-u V, \-\-iso=V
+Outputs a GTS file isosurface for value V the variable needs to be specified using \-c.
+.TP
+.B \-f D, \-\-stream=D
+Draw evenly-spaced streamlines (D is the spacing).
+.TP
+.B \-I M, \-\-dmin=M
+Controls length of evenly-spaced streamlines default is 0.5.
+.TP
+.B \-O M, \-\-maxcost=M
+Controls compression of streamlines (default is 2e-7).
+.TP
+.B \-b x,.., \-\-box=x,y,..
+Specify bounding box for streamline calculation.
+.TP
+.B \-j, \-\-closed
+Outputs only closed streamlines.
+.TP
+.B \-p F, \-\-profile=F
+Output list of values for coordinates defined in F.
+.TP
+.B \-o, \-\-mixed
+Output text values in mixed cells only.
+.TP
+.B \-L L, \-\-level=L
+Use cells at level L only.
+.TP
+.B \-i, \-\-reinit
+Reinitializes refinement and solid fractions.
+.TP
+.B \-e, \-\-merged
+Draw boundaries of merged cells.
+.TP
+.B \-S, \-\-squares
+Draw (colored) squares.
+.TP
+.B \-g, \-\-gnuplot
+Output gnuplot data.
+.TP
+.B \-x VAL, \-\-sx=VAL
+outputs a GTS surface, cross section for x = VAL of the scalar variable.
+.TP
+.B \-y VAL, \-\-sy=VAL
+outputs a GTS surface, cross section for y = VAL of the scalar variable.
+.TP
+.B \-z VAL, \-\-sz=VAL
+outputs a GTS surface, cross section for z = VAL of the scalar variable.
+.TP
+.B \-s S, \-\-surface=S
+outputs the surface defined by file S (or the solid surface is S is equal to `solid').
+.TP
+.B \-V S, \-\-vector=S
+output an OOGL representation of the velocity vector field in the mixed cells.
+.TP
+.B \-l F, \-\-streamlines=F
+draw streamlines starting from each point defined in file F.
+.TP
+.B \-C F, \-\-cylinder=F
+draw stream cylinders starting from each point defined in file F.
+.TP
+.B \-R F, \-\-ribbon=F
+draw stream ribbons starting from each point defined in file F.
+.TP
+.B \-r
+refines the solid surface according to the local resolution.
+.TP
+.B \-c V, \-\-color=V
+color surfaces, streamlines etc... according to the.
+.TP
+.B \-m V, \-\-min=V
+set minimum scalar value to V.
+.TP
+.B \-M V, \-\-max=V
+set maximum scalar value to V.
+.TP
+.B \-v, \-\-verbose
+display statistics and other info.
+.TP
+.B \-h, \-\-help
+display the help and exit.
+
+.SH AUTHOR
+gfs2oogl was written by Stephane Popinet <s.popinet at niwa.co.nz>.
+.PP
+This manual page was written by Ruben Molina <rmolina at udea.edu.co>,
+for the Debian project (but may be used by others).
diff --git a/doc/manpages/gfs2oogl2D3.1 b/doc/manpages/gfs2oogl2D3.1
new file mode 100644
index 0000000..676f9cf
--- /dev/null
+++ b/doc/manpages/gfs2oogl2D3.1
@@ -0,0 +1 @@
+.so man1/gfs2oogl2D.1
diff --git a/doc/manpages/gfs2oogl3D.1 b/doc/manpages/gfs2oogl3D.1
new file mode 100644
index 0000000..676f9cf
--- /dev/null
+++ b/doc/manpages/gfs2oogl3D.1
@@ -0,0 +1 @@
+.so man1/gfs2oogl2D.1
diff --git a/doc/manpages/gfscompare2D.1 b/doc/manpages/gfscompare2D.1
new file mode 100644
index 0000000..3682236
--- /dev/null
+++ b/doc/manpages/gfscompare2D.1
@@ -0,0 +1,84 @@
+.TH gfscompare 1 "July 10, 2008" "" "User Commands"
+
+.SH NAME
+gfscompare2D, gfscompare2D3, gfscompare3D \- computes the difference between the solutions in FILE1 and FILE2 for variable VAR.
+
+.SH SYNOPSIS
+.B gfscompare
+.RI [OPTION] FILE
+.SH DESCRIPTION
+This manual page documents briefly the
+.B gfscompare
+command.
+
+.SH OPTIONS
+These programs follow the usual GNU command line syntax, with long
+options starting with two dashes (`-').
+A summary of options is included below.
+
+.TP
+.B \-x, \-\-mixed
+Compute error only in mixed cells.
+.TP
+.B \-m V, \-\-min=V
+Set minimum of color scale to V (used with \-S).
+.TP
+.B \-M V, \-\-max=V
+Set maximum of color scale to V.
+.TP
+.B \-a, \-\-abs
+Output the absolute value of the error field.
+.TP
+.B \-C, \-\-constant
+Apply a constant shift to one of the field, minimizing the error between the two fields (useful for pressure).
+.TP
+.B \-w, \-\-not-weighted
+Do not use area-weighted norm estimation.
+.TP
+.B \-c, \-\-centered
+Use error estimation for cell-centered variables.
+.TP
+.B \-p P, \-\-period=P
+Shifts FILE1 by P along the x axis.
+.TP
+.B \-H, \-\-histogram
+Output (error,volume) pairs for each cell used to compute the error norms.
+.TP
+.B \-o, \-\-output
+Output a GTS representation of the error field.
+.TP
+.B \-S, \-\-squares
+Output an OOGL representation of the error field.
+.TP
+.B \-G, \-\-gnuplot
+Output a gnuplot representation of the error field.
+.TP
+.B \-t, \-\-triangulate
+Use center of mass triangulation.
+.TP
+.B \-l, \-\-log
+Output the log10 of the absolute value of the error field.
+.TP
+.B \-f L, \-\-full=L
+Compare only leaf cells descendants of a cell full at level L or all full leaf cells if L = \-1.
+.TP
+.B \-r, \-\-refined
+Display error norm on the finest grid.
+.TP
+.B \-n, \-\-nocheck
+Do not check solid fractions.
+.TP
+.B \-g C, \-\-gradient=C
+Use the C component of the gradient of VAR.
+.TP
+.B \-v, \-\-verbose
+Display difference statistics and other info.
+.TP
+.B \-h, \-\-help
+Display the help and exit.
+
+.SH AUTHOR
+gfscompare was written by Stephane Popinet <s.popinet at niwa.co.nz>.
+.PP
+This manual page was written by Ruben Molina <rmolina at udea.edu.co>,
+for the Debian project (but may be used by others).
diff --git a/doc/manpages/gfscompare2D3.1 b/doc/manpages/gfscompare2D3.1
new file mode 100644
index 0000000..e4143ea
--- /dev/null
+++ b/doc/manpages/gfscompare2D3.1
@@ -0,0 +1 @@
+.so man1/gfscompare2D.1
diff --git a/doc/manpages/gfscompare3D.1 b/doc/manpages/gfscompare3D.1
new file mode 100644
index 0000000..e4143ea
--- /dev/null
+++ b/doc/manpages/gfscompare3D.1
@@ -0,0 +1 @@
+.so man1/gfscompare2D.1
diff --git a/doc/manpages/gfsjoin.1 b/doc/manpages/gfsjoin.1
new file mode 100644
index 0000000..8504076
--- /dev/null
+++ b/doc/manpages/gfsjoin.1
@@ -0,0 +1,25 @@
+.TH xyz2rsurface 1 "August 9, 2008" "" "User Commands"
+
+.SH NAME
+gfsjoin \- joins Gerris files.
+
+.SH SYNOPSIS
+.B gfsjoin
+.RI Simfile Directory Rootname NP Tailname > Joined
+.SH DESCRIPTION
+This manual page documents briefly the
+.B gfsjoin
+command.
+
+.SH OPTIONS
+Simfile: Name of the simulation file
+Directory: Directory where results are located
+Rootname: File root name
+NP: Number of processors
+Tailname: File tail name
+
+.SH AUTHOR
+gfsjoin was written by Stephane Popinet <s.popinet at niwa.co.nz>.
+.PP
+This manual page was written by Ruben Molina <rmolina at udea.edu.co>,
+for the Debian project (but may be used by others).
diff --git a/doc/manpages/gfsxref.1 b/doc/manpages/gfsxref.1
new file mode 100644
index 0000000..61c1e61
--- /dev/null
+++ b/doc/manpages/gfsxref.1
@@ -0,0 +1,29 @@
+.TH gfsxref 1 "August 9, 2008" "" "User Commands"
+
+.SH NAME
+gfsxref \- creates cross-references for occurences of KEYWORD in input.gfs
+
+.SH SYNOPSIS
+.B gfsxref
+.RI [OPTIONS] KEYWORD < input.gfs > output.html
+.SH DESCRIPTION
+This manual page documents briefly the
+.B gfsxref
+command.
+
+.SH OPTIONS
+These programs follow the usual GNU command line syntax, with long
+options starting with two dashes (`-').
+A summary of options is included below.
+.TP
+.B \-\-url=URL
+Reference URL for input.gfs.
+.TP
+.B \-\-help
+Display the help and exit.
+
+.SH AUTHOR
+gfsxref was written by Stephane Popinet <s.popinet at niwa.co.nz>.
+.PP
+This manual page was written by Ruben Molina <rmolina at udea.edu.co>,
+for the Debian project (but may be used by others).
diff --git a/doc/manpages/ppm2mpeg.1 b/doc/manpages/ppm2mpeg.1
new file mode 100644
index 0000000..6fe6b25
--- /dev/null
+++ b/doc/manpages/ppm2mpeg.1
@@ -0,0 +1 @@
+.so man1/gerris2D.1
diff --git a/doc/manpages/ppmcombine.1 b/doc/manpages/ppmcombine.1
new file mode 100644
index 0000000..938c360
--- /dev/null
+++ b/doc/manpages/ppmcombine.1
@@ -0,0 +1,29 @@
+.TH ppmcombine 1 "August 9, 2008" "" "User Commands"
+
+.SH NAME
+ppmcombine \- combines several PPM files produced by a parallel run of Gerris.
+
+.SH SYNOPSIS
+.B ppmcombine
+.RI [OPTIONS] KEYWORD < input.gfs > output.html
+.SH DESCRIPTION
+This manual page documents briefly the
+.B ppmcombine
+command.
+
+.SH OPTIONS
+These programs follow the usual GNU command line syntax, with long
+options starting with two dashes (`-').
+A summary of options is included below.
+.TP
+.B \-v, \-\-url=URL
+Display statistics and other info
+.TP
+.B \-h, \-\-help
+Display the help and exit.
+
+.SH AUTHOR
+ppmcombine was written by Stephane Popinet <s.popinet at niwa.co.nz>.
+.PP
+This manual page was written by Ruben Molina <rmolina at udea.edu.co>,
+for the Debian project (but may be used by others).
diff --git a/doc/manpages/rsurfacequery.1 b/doc/manpages/rsurfacequery.1
new file mode 100644
index 0000000..6fe6b25
--- /dev/null
+++ b/doc/manpages/rsurfacequery.1
@@ -0,0 +1 @@
+.so man1/gerris2D.1
diff --git a/doc/manpages/shapes.1 b/doc/manpages/shapes.1
new file mode 100644
index 0000000..56b9305
--- /dev/null
+++ b/doc/manpages/shapes.1
@@ -0,0 +1,48 @@
+.TH shapes 1 "August 9, 2008" "" "User Commands"
+
+.SH NAME
+shapes \- generates various shapes for Gerris.
+
+.SH SYNOPSIS
+.B shapes
+.RI [OPTIONS] SHAPE
+.PP
+SHAPE can be one of: ellipse, star, 4ellipses, square, almgren, channel,
+half-cylinder, rayleigh-taylor, FILE.
+
+.SH DESCRIPTION
+This manual page documents briefly the
+.B shapes
+command.
+
+.SH OPTIONS
+These programs follow the usual GNU command line syntax, with long
+options starting with two dashes (`-').
+A summary of options is included below.
+.TP
+.B \-z, \-\-zextrude
+Shape file contains z coordinate.
+.TP
+.B \-n N, \-\-number=N
+Set number of points for polar surfaces (default is 100).
+.TP
+.B \-o, \-\-open
+Generate open surfaces.
+.TP
+.B \-d R, \-\-dr=R
+Set inner radius for star to R (default is 0.15).
+.TP
+.B \-r R, \-\-ratio=R
+Ratio x/y of the ellipse (default is 1).
+.TP
+.B \-v, \-\-url=URL
+Display surface statistics.
+.TP
+.B \-h, \-\-help
+Display the help and exit.
+
+.SH AUTHOR
+shapes was written by Stephane Popinet <s.popinet at niwa.co.nz>.
+.PP
+This manual page was written by Ruben Molina <rmolina at udea.edu.co>,
+for the Debian project (but may be used by others).
diff --git a/doc/manpages/streamanime.1 b/doc/manpages/streamanime.1
new file mode 100644
index 0000000..6fe6b25
--- /dev/null
+++ b/doc/manpages/streamanime.1
@@ -0,0 +1 @@
+.so man1/gerris2D.1
diff --git a/doc/manpages/xyz2rsurface.1 b/doc/manpages/xyz2rsurface.1
new file mode 100644
index 0000000..1737fdc
--- /dev/null
+++ b/doc/manpages/xyz2rsurface.1
@@ -0,0 +1,32 @@
+.TH xyz2rsurface 1 "August 9, 2008" "" "User Commands"
+
+.SH NAME
+xyz2rsurface \- converts the x, y and z coordinates on standard input to an R*-tree-indexed database suitable for use with the GfsRefineTerrain object of Gerris.
+
+.SH SYNOPSIS
+.B xyz2rsurface
+.RI [OPTION] BASENAME
+.SH DESCRIPTION
+This manual page documents briefly the
+.B xyz2rsurface
+command.
+
+.SH OPTIONS
+These programs follow the usual GNU command line syntax, with long
+options starting with two dashes (`-').
+A summary of options is included below.
+.TP
+.B \-p N \-\-pagesize=N
+Sets the pagesize in bytes (default is 4096)
+.TP
+.B \-v, \-\-verbose
+Display progress bar.
+.TP
+.B \-h, \-\-help
+Display the help and exit.
+
+.SH AUTHOR
+xyz2rsurface was written by Stephane Popinet <s.popinet at niwa.co.nz>.
+.PP
+This manual page was written by Ruben Molina <rmolina at udea.edu.co>,
+for the Debian project (but may be used by others).
--
Gerris Flow Solver
More information about the debian-science-commits
mailing list