File: vedo-convert.xml

package info (click to toggle)
vedo 2020.4.2-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 15,676 kB
  • sloc: python: 26,193; xml: 437; sh: 199; makefile: 21
file content (194 lines) | stat: -rw-r--r-- 6,998 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
<?xml version='1.0' encoding='UTF-8'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [

<!--

`xsltproc -''-nonet \
          -''-param man.charmap.use.subset "0" \
          -''-param make.year.ranges "1" \
          -''-param make.single.year.ranges "1" \
          /usr/share/xml/docbook/stylesheet/docbook-xsl/manpages/docbook.xsl \
          vedo-convert.xml'

A manual page <package>.<section> will be generated. You may view the
manual page with: nroff -man <package>.<section> | less'. A typical entry
in a Makefile or Makefile.am is:

DB2MAN = /usr/share/sgml/docbook/stylesheet/xsl/docbook-xsl/manpages/docbook.xsl
XP     = xsltproc -''-nonet -''-param man.charmap.use.subset "0"

vedo-convert.1: vedo-convert.xml
        $(XP) $(DB2MAN) $<

The xsltproc binary is found in the xsltproc package. The XSL files are in
docbook-xsl. A description of the parameters you can use can be found in the
docbook-xsl-doc-* packages. Please remember that if you create the nroff
version in one of the debian/rules file targets (such as build), you will need
to include xsltproc and docbook-xsl in your Build-Depends control field.
Alternatively use the xmlto command/package. That will also automatically
pull in xsltproc and docbook-xsl.

Notes for using docbook2x: docbook2x-man does not automatically create the
AUTHOR(S) and COPYRIGHT sections. In this case, please add them manually as
<refsect1> ... </refsect1>.

To disable the automatic creation of the AUTHOR(S) and COPYRIGHT sections
read /usr/share/doc/docbook-xsl/doc/manpages/authors.html. This file can be
found in the docbook-xsl-doc-html package.

Validation can be done using: `xmllint -''-noout -''-valid manpage.xml`

General documentation about man-pages and man-page-formatting:
man(1), man(7), http://www.tldp.org/HOWTO/Man-Page/

-->

  <!ENTITY dhfirstname "Drew">
  <!ENTITY dhsurname   "Parsons">
  <!-- dhusername could also be set to "&dhfirstname; &dhsurname;". -->
  <!ENTITY dhusername  "Drew Parsons">
  <!ENTITY dhemail     "dparsons@debian.org">
  <!ENTITY dhsection   "1">
  <!ENTITY dhtitle     "vedo-convert manual">
  <!ENTITY dhucpackage "vedo-convert">
  <!ENTITY dhpackage   "vedo-convert">
]>

<refentry>
  <refentryinfo>
    <title>&dhtitle;</title>
    <productname>&dhpackage;</productname>
    <authorgroup>
      <author>
       <firstname>&dhfirstname;</firstname>
        <surname>&dhsurname;</surname>
        <contrib>Wrote this manpage for the Debian system.</contrib>
        <address>
          <email>&dhemail;</email>
        </address>
      </author>
    </authorgroup>
    <copyright>
      <year>2019</year>
      <holder>&dhusername;</holder>
    </copyright>
    <legalnotice>
      <para>This manual page was written for the Debian system
        (and may be used by others).</para>
      <para>Permission is granted to copy, distribute and/or modify this
        document under the terms of the MIT License.</para>
      <para>On Debian systems, the complete text of the MIT License can be found in
        <filename>/usr/share/doc/python3-vedo/copyright</filename>.</para>
    </legalnotice>
  </refentryinfo>
  <refmeta>
    <refentrytitle>&dhucpackage;</refentrytitle>
    <manvolnum>&dhsection;</manvolnum>
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>
    <refpurpose>convert vtk file formats</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
      <!-- Normally the help and version options make the programs stop
           right after outputting the requested information. -->
      <group choice="opt">
        <arg choice="plain"><option>-h</option></arg>
        <arg choice="plain"><option>--help</option></arg>
      </group>
      <group choice="opt">
        <arg choice="plain"><option>-to</option></arg>
      </group>
      <group choice="opt">
        <arg choice="plain"><replaceable>files</replaceable></arg>
	<group choice="opt">
          <arg choice="plain"><replaceable>files ...</replaceable></arg>
	</group>
      </group>
     </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1 id="description">
    <title>DESCRIPTION</title>
    <para>This manual page documents briefly the
      <command>&dhpackage;</command> command.</para>
    <para>This manual page was written for the Debian distribution
      because the original program does not have a manual page.
    </para>
    <para><command>&dhpackage;</command> is a program that converts between VTK file formats</para>
  </refsect1>
  <refsect1 id="options">
    <title>OPTIONS</title>
    <variablelist>
      <!-- Use the variablelist.term.separator and the
           variablelist.term.break.after parameters to
           control the term elements. -->
      <varlistentry>
        <term><option><replaceable>files</replaceable></option></term>
        <term><option><replaceable>files</replaceable></option></term>
        <listitem>
          <para>Input files to be converted</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-h</option></term>
        <term><option>--help</option></term>
        <listitem>
          <para>Show summary of options.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-n</option></term>
        <term><option>--normalize</option></term>
        <listitem>
          <para>normalize target size.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-c</option></term>
        <term><option>--clean</option></term>
        <listitem>
          <para>remove coincident points.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-m</option></term>
        <term><option>--mirror</option></term>
        <listitem>
          <para>mirror along the x-axis.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-b</option></term>
        <term><option>--binary</option></term>
        <listitem>
          <para>whether output is binary or not.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-t</option></term>
        <term><option>--triangle</option></term>
        <listitem>
          <para>Convert polygons to triangles.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-to</option></term>
        <listitem>
          <para>target format [vtk]. Allowed targets: ['vtk', 'vtp', 'vtu', 'vts', 'ply', 'stl', 'byu', 'xml']</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1 id="see_also">
    <title>SEE ALSO</title>
    <!-- In alpabetical order. -->
    <para><citerefentry>
        <refentrytitle>vedo</refentrytitle>
        <manvolnum>1</manvolnum></citerefentry></para>
    <para>The programs are documented fully at <ulink url="https://vedo.embl.es/" />.</para>
  </refsect1>
</refentry>