File: cmml-fix.1.sgml.in

package info (click to toggle)
libcmml 0.8.3-1
  • links: PTS
  • area: main
  • in suites: sarge
  • size: 4,040 kB
  • ctags: 1,223
  • sloc: sh: 8,179; ansic: 4,206; makefile: 432
file content (188 lines) | stat: -rw-r--r-- 5,579 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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"[
<!-- Process this file with docbook-to-man to generate an nroff manual
     page: `docbook-to-man manpage.sgml > manpage.1'.  You may view
     the manual page with: `docbook-to-man manpage.sgml | nroff -man |
     less'.  A typical entry in a Makefile or Makefile.am is:
 
manpage.1: manpage.sgml
        docbook-to-man $< > $@
  -->
 
  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Silvia</firstname>">
  <!ENTITY dhsurname   "<surname>Pfeiffer</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>November 30, 2003</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>silvia.pfeiffer@csiro.au</email>">
  <!ENTITY dhusername  "CSIRO Australia">
  <!ENTITY dhucpackage "<refentrytitle>cmml-fix</refentrytitle>">
  <!ENTITY dhpackage   "cmml-fix">
]>

<refentry id="cmml-fix">

  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2001</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>

  <refmeta>
    &dhucpackage;
    &dhsection;
  </refmeta>

  <refnamediv>
    <refname>&dhpackage;</refname>
    <refpurpose>
      transforms a sloppily written CMML instance document into a valid one.
    </refpurpose>
  </refnamediv>


<!-- The warning message 
     "document type does not allow element "PARAMETER" here"
     is created for all the <parameter> tags in the refsynopsisdiv.
     Ignore them as the <parameter> tag still gets interpreted correctly in
     the manpage. Deleting the tag however results in non-underlined
     parameters in the man page.
-->
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>

      <group>
	<arg choice="opt">-o <parameter>file</parameter></arg>
	<arg choice="opt">--output <parameter>file</parameter></arg>
      </group>

      <group>
	<arg choice="opt">-i <parameter>clipid</parameter></arg>
	<arg choice="opt">--id <parameter>clipid</parameter></arg>
      </group>

      <group>
	<arg choice="opt">-s <parameter>seconds</parameter></arg>
	<arg choice="opt">--sec <parameter>seconds</parameter></arg>
      </group>

      <group>
	<arg choice="opt">-u <parameter>utc</parameter></arg>
	<arg choice="opt">--utc <parameter>utc</parameter></arg>
      </group>

      <group>
	<arg choice="opt">-h</arg><arg choice="opt">--help</arg>
      </group>

      <group>
	<arg choice="opt">-v</arg><arg choice="opt">--version</arg>
      </group>

      <arg choice="plain">filename</arg>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsect1>
    <title>Description</title>
    <para>
      <command>&dhpackage;</command> parses a CMML instance document
      given as <parameter>filename</parameter>, validates it sloppily
      against the cmml.dtd and some further rules, and creates a
      (fixed) valid CMML instance document from it, which gets written
      to stdout by default. In case of a non-recoverable error the
      faulty tag including line and column number is reported.
    </para>
  </refsect1>

<refsect1>
  <title>Options</title>
  <para>
    <command>&dhpackage;</command> accepts the following options:
  </para>
  <variablelist>

    <varlistentry>
      <term>-o <parameter>file</parameter>, --output <parameter>file</parameter></term>
      <listitem><para>Output file. Writes fixed CMML document to the
      given <parameter>file</parameter> instead of stdout, which is the
      default.</para></listitem>
    </varlistentry>

    <varlistentry>
      <term>-i <parameter>clipid</parameter>, --id <parameter>clipid</parameter></term>
      <listitem><para>Seek clip. Starts writing clip tags from the
      given named clip.</para></listitem>
    </varlistentry>

    <varlistentry>
      <term>-s <parameter>seconds</parameter>, --sec <parameter>seconds</parameter></term>
      <listitem><para>Seek seconds offset. Starts writing clip tags
      from the given time offset in <parameter>seconds</parameter>, e.g. 15.7.
      </para></listitem>
    </varlistentry>

    <varlistentry>
      <term>-u <parameter>utc</parameter>, --utc <parameter>utc</parameter></term>
      <listitem><para>Seek utc time offset. Starts writing clip tags
      from the given time offset in <parameter>utc</parameter>
      time, e.g. 200301031T160000.000Z.</para></listitem>
    </varlistentry>

    <varlistentry>
      <term>-h, --help</term>
      <listitem><para>Print usage message.</para></listitem>
    </varlistentry>

    <varlistentry>
      <term>-v, --version</term>
      <listitem><para>Print version information.</para></listitem>
    </varlistentry>

  </variablelist>
</refsect1>

<refsect1>
  <title>VERSION</title>
  <para>This man page is correct for CMML version 2.0 and libcmml
  version @VERSION@.
 </para>
</refsect1>

<refsect1>
  <title>SEE ALSO</title>
  <para>More information is available at:
    <ulink url="http://www.annodex.net/">Annodex.net</ulink>
  </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:
-->