[mshr] 01/02: generate man page for mshrable
Drew Parsons
dparsons at moszumanska.debian.org
Thu May 19 07:46:54 UTC 2016
This is an automated email from the git hooks/post-receive script.
dparsons pushed a commit to branch master
in repository mshr.
commit 008801e1eb29275c69569941ecb3a8d9f387666c
Author: Drew Parsons <dparsons at debian.org>
Date: Thu May 19 13:33:25 2016 +0800
generate man page for mshrable
using Docbook SGML.
Generate the man page with
docbook-to-man mshrable.sgml > mshrable.1
---
debian/libmshr-dev.manpages | 1 +
debian/mshrable.1 | 61 +++++++++++++
debian/mshrable.sgml | 202 ++++++++++++++++++++++++++++++++++++++++++++
3 files changed, 264 insertions(+)
diff --git a/debian/libmshr-dev.manpages b/debian/libmshr-dev.manpages
new file mode 100644
index 0000000..60ad814
--- /dev/null
+++ b/debian/libmshr-dev.manpages
@@ -0,0 +1 @@
+debian/mshrable.1
diff --git a/debian/mshrable.1 b/debian/mshrable.1
new file mode 100644
index 0000000..336f2f8
--- /dev/null
+++ b/debian/mshrable.1
@@ -0,0 +1,61 @@
+.TH "MSHRABLE" "1"
+.SH "NAME"
+mshrable \(em Generate mesh from surface file
+.SH "SYNOPSIS"
+.PP
+\fBmshrable\fR [\-f \fIFILE\fR]
+.SH "DESCRIPTION"
+.PP
+\fBmshrable\fR generates a mesh from a
+surface file. It uses mshr, which is the mesh generation
+component of FEniCS. It generates simplicial DOLFIN meshes in 2D
+and 3D from geometries described by Constructive Solid Geometry
+(CSG) or from surface files, utilizing CGAL and Tetgen as mesh
+generation backends.
+
+.SH "OPTIONS"
+.PP
+
+.IP "\-o [\-\-outfile] \fIarg\fR" 10
+Filename of generated Dolfin mesh.
+
+.IP "\-r [\-\-resolution] \fIarg (=15)\fR" 10
+Resolution of result mesh.
+
+.IP "\-s [\-\-stats]" 10
+Write some statistics of the mesh to stdout.
+
+.IP "\-\-polyout \fIarg\fR" 10
+Write the polyhedron to .poly which Tetgen can read
+(and do not create a mesh).
+
+.IP "\-\-polystats" 10
+Write statistics of polyhedron (and do not create a
+mesh).
+
+.IP "\-b [\-\-backend] \fIarg (=cgal)\fR" 10
+Use 3D mesh generation backend [tetgen|cgal].
+
+.IP "\-\-degenerate_tolerance \fIarg (=9.9999999999999998e-13)\fR" 10
+Tolerance for considering a facet as degenerate. Set
+to 0 to not remove degenerate facets.
+
+.IP "\-\-check-mesh" 10
+Check consistency of output mesh (most for debugging/testing.
+
+.IP "\-v [\-\-verbose]" 10
+Output more information about what is going on.
+
+.IP "\-h [\-\-help]" 10
+write help message.
+
+.SH "SEE ALSO"
+.PP
+dolfin-convert (1), dolfin-order (1)
+.SH "AUTHOR"
+.PP
+\fBmshrable\fR was written by Benjamin
+Kehlet benjamik at simula.no. This man page was written by
+Drew Parsons dparsons at debian.org.
+
+.\" created by instant / docbook-to-man
diff --git a/debian/mshrable.sgml b/debian/mshrable.sgml
new file mode 100644
index 0000000..a7c8f4a
--- /dev/null
+++ b/debian/mshrable.sgml
@@ -0,0 +1,202 @@
+<!doctype refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
+ <!ENTITY dhfirstname "<firstname>Drew</firstname>">
+ <!ENTITY dhsurname "<surname>Parsons</surname>">
+ <!-- Please adjust the date whenever revising the manpage. -->
+ <!ENTITY dhdate "<date>19 May, 2016</date>">
+ <!ENTITY dhsection "<manvolnum>1</manvolnum>">
+ <!ENTITY dhemail "<email>dparsons at debian.org</email>">
+ <!ENTITY dhusername "Drew Parsons">
+ <!ENTITY dhucpackage "<refentrytitle>MSHRABLE</refentrytitle>">
+ <!ENTITY dhpackage "mshrable">
+
+ <!ENTITY debian "<productname>Debian GNU/Linux</productname>">
+ <!ENTITY gnu "<acronym>GNU</acronym>">
+]>
+
+<!-- generate the man page with "docbook-to-man mshrable.sgml > mshrable.1" -->
+
+<refentry>
+ <docinfo>
+ <address>
+ &dhemail;
+ </address>
+ <author>
+ &dhfirstname;
+ &dhsurname;
+ </author>
+ <copyright>
+ <year>2001</year>
+ <holder>&dhusername;</holder>
+ </copyright>
+ &dhdate;
+ </docinfo>
+ <refmeta>
+ &dhucpackage;
+
+ &dhsection;
+ </refmeta>
+ <refnamediv>
+ <refname>&dhpackage;</refname>
+
+ <refpurpose>Generate mesh from surface file</refpurpose>
+ </refnamediv>
+ <refsynopsisdiv>
+ <cmdsynopsis>
+ <command>&dhpackage;</command>
+ <arg>-f <replaceable>FILE</replaceable></arg>
+ </cmdsynopsis>
+ </refsynopsisdiv>
+
+ <refsect1>
+ <title>DESCRIPTION</title>
+
+ <para><command>&dhpackage;</command> generates a mesh from a
+ surface file. It uses mshr, which is the mesh generation
+ component of FEniCS. It generates simplicial DOLFIN meshes in 2D
+ and 3D from geometries described by Constructive Solid Geometry
+ (CSG) or from surface files, utilizing CGAL and Tetgen as mesh
+ generation backends.
+ </para>
+</refsect1>
+
+<refsect1>
+ <title>OPTIONS</title>
+<para>
+ <variablelist>
+ <varlistentry>
+ <term>-o [--outfile] <replaceable>arg</replaceable></term>
+ <listitem>
+ <para>
+ Filename of generated Dolfin mesh.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-r [--resolution] <replaceable>arg (=15)</replaceable></term>
+ <listitem>
+ <para>
+ Resolution of result mesh.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-s [--stats]</term>
+ <listitem>
+ <para>
+ Write some statistics of the mesh to stdout.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>--polyout <replaceable>arg</replaceable></term>
+ <listitem>
+ <para>
+ Write the polyhedron to .poly which Tetgen can read
+ (and do not create a mesh).
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>--polystats</term>
+ <listitem>
+ <para>
+ Write statistics of polyhedron (and do not create a
+ mesh).
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-b [--backend] <replaceable>arg (=cgal)</replaceable></term>
+ <listitem>
+ <para>
+ Use 3D mesh generation backend [tetgen|cgal].
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>--degenerate_tolerance <replaceable>arg (=9.9999999999999998e-13)</replaceable></term>
+ <listitem>
+ <para>
+ Tolerance for considering a facet as degenerate. Set
+ to 0 to not remove degenerate facets.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>--check-mesh</term>
+ <listitem>
+ <para>
+ Check consistency of output mesh (most for debugging/testing.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-v [--verbose]</term>
+ <listitem>
+ <para>
+ Output more information about what is going on.
+ </para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>-h [--help]</term>
+ <listitem>
+ <para>
+ write help message.
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+</para>
+</refsect1>
+
+ <refsect1>
+ <title>SEE ALSO</title>
+
+ <para>dolfin-convert (1), dolfin-order (1)</para>
+ </refsect1>
+ <refsect1>
+ <title>AUTHOR</title>
+ <para><command>&dhpackage;</command> was written by Benjamin
+ Kehlet <email>benjamik at simula.no</email>. This man page was written by
+ &dhusername; &dhemail;.
+ </para>
+
+
+ <!-- <para>Permission is granted to copy, distribute and/or modify
+ this document under the terms of the <acronym>GNU</acronym> Free
+ Documentation License, Version 1.1 or any later version
+ published by the Free Software Foundation; with no Invariant
+ Sections, no Front-Cover Texts and no Back-Cover Texts. A copy
+ of the license can be found under
+ <filename>/usr/share/common-licenses/FDL</filename>.</para> -->
+
+ </refsect1>
+</refentry>
+
+<!-- Keep this comment at the end of the file
+Local variables:
+mode: sgml
+sgml-omittag:t
+sgml-shorttag:t
+sgml-minimize-attributes:nil
+sgml-always-quote-attributes:t
+sgml-indent-step:2
+sgml-indent-data:t
+sgml-parent-document:nil
+sgml-default-dtd-file:nil
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+-->
+
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/debian-science/packages/fenics/mshr.git
More information about the debian-science-commits
mailing list