File: manpage.xml

package info (click to toggle)
pymecavideo 6.0-5
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 6,680 kB
  • sloc: python: 4,123; xml: 888; makefile: 130
file content (166 lines) | stat: -rw-r--r-- 5,680 bytes parent folder | download
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
<?xml version='1.0' encoding='ISO-8859-1'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"file:///usr/share/xml/docbook/schema/dtd/4.2/docbookx.dtd" [

<!--

Process this file with an XSLT processor: `xsltproc \
-''-nonet /usr/share/sgml/docbook/stylesheet/xsl/nwalsh/\
manpages/docbook.xsl manpage.dbk'.  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/nwalsh/\
manpages/docbook.xsl
XP=xsltproc -''-nonet

manpage.1: manpage.dbk
        $(XP) $(DB2MAN) $<

The xsltproc binary is found in the xsltproc package.  The
XSL files are in docbook-xsl.  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.

-->

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>FIRSTNAME</firstname>">
  <!ENTITY dhsurname   "<surname>SURNAME</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>24 June 2012</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  <!ENTITY dhemail     "<email>georgesk@ofset.org</email>">
  <!ENTITY dhusername  "Georges Khaznadar">
  <!ENTITY dhucpackage "<refentrytitle>PYMECAVIDEO</refentrytitle>">
  <!ENTITY dhpackage   "pymecavideo">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <copyright>
      <year>2007-2012</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
    <refmiscinfo class="source">Pymecavideo</refmiscinfo>
    <refmiscinfo class="manual">Pymecavideo</refmiscinfo>
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose>pedagogical program to teach mechanics</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>

      <arg choice="opt">
        <group choice="req">
          <arg choice="plain"><option>-f</option></arg>
          <arg choice="plain"><option>--fichier_pymecavideo=</option></arg>
        </group>
        <replaceable class="option">file</replaceable>
      </arg>
      <arg choice="opt">
        <group choice="req">
          <arg choice="plain"><option>--maxi</option></arg>
        </group>
      </arg>
      <arg choice="opt">
        <group choice="req">
          <arg choice="plain"><option>-d</option></arg>
          <arg choice="plain"><option>--debug=</option></arg>
        </group>
        <replaceable class="option">verbosity (level from 1 to 3)</replaceable>
      </arg>
      <arg><option><replaceable>nomDeFichier.{avi|mpg|...}</replaceable></option></arg>
    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para><command>&dhpackage;</command> is a program to track a
set of moving points in a video frameset. The size of the image can be
calibrated, then you track the relevant points and export a file containing
the timecode and the coordinates, to be analyzed by some other standard 
software.
</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>-f <replaceable>file</replaceable></option></term>
        <term><option>--fichier_pymecavideo=<replaceable>file</replaceable></option></term>
        <listitem>
          <para>Declares a previous snapshot file made by pymecavideo. Allows to continue
	  just after the snapshot point.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>--maxi</option></term>
        <listitem>
          <para>Use the bigger user interface.</para>
        </listitem>
      </varlistentry>
      <varlistentry>
        <term><option>-d <replaceable>level</replaceable></option></term>
        <term><option>--debug=<replaceable>level</replaceable></option></term>
        <listitem>
          <para>Declares the level of verbosity to debug the application. This level is zero by
	  default (no messages emitted), it can take values between 1 and 3.</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>ARGUMENTS</title>

    <variablelist>
      <varlistentry>
        <term><option><replaceable>filename.{avi|mpg|...}</replaceable></option>
        </term>
        <listitem>
          <para>Defines sone video file to begin with (optional).</para>
        </listitem>
      </varlistentry>
    </variablelist>
  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &dhemail; for
      the &debian; system (but may be used by others).  Permission is
      granted to copy, distribute and/or modify this document under
      the terms of the &gnu; General Public License, Version 3 any
	  later version published by the Free Software Foundation.
    </para>
	<para>
	  On Debian systems, the complete text of the GNU General Public
	  License can be found in /usr/share/common-licenses/GPL-3.
	</para>

  </refsect1>
</refentry>