File: vedo.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 (347 lines) | stat: -rw-r--r-- 12,727 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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
<?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.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.1: vedo.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 manual">
  <!ENTITY dhucpackage "vedo">
  <!ENTITY dhpackage   "vedo">
]>

<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>Visualization, analysis and animation of 3D objects and point clouds in VTK files.</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></group>
      <group choice="opt"><arg choice="plain"><option>-c</option></arg></group>
      <group choice="opt"><arg choice="plain"><option>-a</option></arg></group>
      <group choice="opt"><arg choice="plain"><option>-w</option></arg></group>
      <group choice="opt"><arg choice="plain"><option>-p</option></arg></group>
      <group choice="opt"><arg choice="plain"><option>-k</option></arg></group>
      <group choice="opt"><arg choice="plain"><option>-x</option></arg></group>
      <group choice="opt"><arg choice="plain"><option>-i</option></arg></group>
      <group choice="opt"><arg choice="plain"><option>-l</option></arg></group>
      <group choice="opt"><arg choice="plain"><option>-f</option></arg></group>
      <group choice="opt"><arg choice="plain"><option>-bg</option></arg></group>
      <group choice="opt"><arg choice="plain"><option>-z</option></arg></group>
      <group choice="opt"><arg choice="plain"><option>-q</option></arg></group>
      <group choice="opt"><arg choice="plain"><option>-n</option></arg></group>
      <group choice="opt"><arg choice="plain"><option>-s</option></arg></group>
      <group choice="opt"><arg choice="plain"><option>-g</option></arg></group>
      <group choice="opt"><arg choice="plain"><option>-gz</option></arg></group>
      <group choice="opt"><arg choice="plain"><option>-gy</option></arg></group>
      <group choice="opt"><arg choice="plain"><option>--slicer</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 plots and visualises VTK files.</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>
        <listitem>
          <para>Input filename(s)</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-c</option></term>
        <term><option>--color</option></term>
        <listitem>
          <para>mesh color [integer or color name]</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-a</option></term>
        <term><option>--alpha</option></term>
        <listitem>
          <para>alpha value [0-1]</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-w</option></term>
        <term><option>--wireframe</option></term>
        <listitem>
          <para>use wireframe representation</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-p</option></term>
        <term><option>--point-size</option></term>
        <listitem>
          <para>specify point size</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-e</option></term>
        <term><option>--showedges</option></term>
        <listitem>
          <para>show a thin line on mesh edges</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-k</option></term>
        <term><option>--lighting</option></term>
        <listitem>
          <para>metallic, plastic, shiny or glossy</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-K</option></term>
        <term><option>--flat</option></term>
        <listitem>
          <para>use flat shading</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-x</option></term>
        <term><option>--axes-type</option></term>
        <listitem>
          <para>specify axes type [0-5] (default=4)</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-i</option></term>
        <term><option>--no-camera-share</option></term>
        <listitem>
          <para>do not share camera in renderers</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-l</option></term>
        <term><option>--legend-off</option></term>
        <listitem>
          <para>do not show legends</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-f</option></term>
        <term><option>--full-screen</option></term>
        <listitem>
          <para>full screen mode</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-bg</option></term>
        <term><option>--background</option></term>
        <listitem>
          <para>background color [integer or color name]</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--background-grad</option></term>
        <listitem>
          <para>use background color gradient</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-z</option></term>
        <term><option>--zoom</option></term>
        <listitem>
          <para>zooming factor</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-q</option></term>
        <term><option>--quiet</option></term>
        <listitem>
          <para>quiet mode, less verbose</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-n</option></term>
        <term><option>--multirenderer-mode</option></term>
        <listitem>
          <para>Multi renderer Mode: files go to separate renderers</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-s</option></term>
        <term><option>--scrolling-mode</option></term>
        <listitem>
          <para>Scrolling Mode: use arrows to scroll files</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-g</option></term>
        <term><option>--ray-cast-mode</option></term>
        <listitem>
          <para>GPU Ray-casting Mode for 3D image files</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-gx</option></term>
        <term><option>--x-spacing</option></term>
        <listitem>
          <para>Volume x-spacing factor [1]</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-gy</option></term>
        <term><option>--y-spacing</option></term>
        <listitem>
          <para>Volume y-spacing factor [1]</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-gz</option></term>
        <term><option>--z-spacing</option></term>
        <listitem>
          <para>Volume z-spacing factor [1]</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--slicer</option></term>
        <listitem>
          <para>Slicer Mode for 3D image files</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--lego</option></term>
        <listitem>
          <para>Voxel rendering for 3D image files</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--cmap</option></term>
        <listitem>
          <para>Voxel rendering color map name (default='jet')</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--mode</option></term>
        <listitem>
          <para>Voxel rendering composite mode (default=0)</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-r</option></term>
        <term><option>--run</option></term>
        <listitem>
          <para>Run example from vedo-examples</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--list</option></term>
        <listitem>
          <para>List examples in vedo-examples</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-h</option></term>
        <term><option>--help</option></term>
        <listitem>
          <para>show help message and exit</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>