oggzmerge.1.sgml 4.74 KB
Newer Older
conrad's avatar
conrad committed
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
<!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>Conrad</firstname>">
  <!ENTITY dhsurname   "<surname>Parker</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>September 21, 2004</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>conrad.parker@csiro.au</email>">
  <!ENTITY dhusername  "CSIRO Australia">
  <!ENTITY dhucpackage "<refentrytitle>oggzmerge</refentrytitle>">
  <!ENTITY dhpackage   "oggzmerge">
                                                                                 <!ENTITY debian      "<productname>Debian GNU/Linux</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
]>

<refentry id="oggzmerge">

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

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

  <refnamediv>
    <refname>&dhpackage;</refname>
    <refpurpose>Merge Ogg files together, interleaving pages in order of
      presentation time.
    </refpurpose>
  </refnamediv>

  <!-- A warning of 
  "document type does not allow element "PARAMETER" here"
  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 
  -->
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
      
      <group>
	<arg choice="opt">-o <parameter>filename</parameter></arg>
	<arg choice="opt">--output <parameter>filename</parameter></arg>
      </group>

conrad's avatar
conrad committed
71 72
      <arg choice="plain" rep="repeat">filename</arg>
    </cmdsynopsis>
conrad's avatar
conrad committed
73

conrad's avatar
conrad committed
74 75 76 77
    <cmdsynopsis>
      <command>&dhpackage;</command>
      <group><arg choice="opt">-h</arg><arg choice="opt">--help</arg></group>
      <group><arg choice="opt">-v</arg><arg choice="opt">--version</arg></group>
conrad's avatar
conrad committed
78 79 80 81 82 83 84 85 86
    </cmdsynopsis>
    
  </refsynopsisdiv>
    
  <refsect1>
    <title>Description</title>
    <para>
      <command>&dhpackage;</command> merges Ogg files together, interleaving
      pages in order of presentation time. It correctly interprets the
87 88
      granulepos timestamps of Ogg Vorbis, Speex, FLAC and Theora bitstreams,
      and all bitstreams of Annodex files.
conrad's avatar
conrad committed
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
    </para>
  </refsect1>
  
  <refsect1>
    <title>Options</title>
    <para>
      <command>&dhpackage;</command> accepts the following options:
    </para>
            
    <refsect2>
      <title>Miscellaneous options</title>
      <variablelist>
	<varlistentry>
	  <term>-o <parameter>filename</parameter>, --output <parameter>filename</parameter></term>
	  <listitem><para>Write output to the specified
	      <parameter>filename</parameter> instead of printing it to
	      standard output.
	    </para></listitem>
	</varlistentry>
	
	<varlistentry>
	  <term>-h, --help</term>
	  <listitem><para>Display usage information and exit.</para></listitem>
	</varlistentry>
	
114 115 116 117 118
	<varlistentry>
	  <term>-v, --version</term>
	  <listitem><para>Output version information and exit.</para></listitem>
	</varlistentry>

conrad's avatar
conrad committed
119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
      </variablelist>
    </refsect2>
  </refsect1>

  <refsect1>
    <title>AUTHOR</title>
    <para>
      <author>
	&dhfirstname; &dhsurname;
      </author>
      &dhdate
    </para>
  </refsect1>

  <refsect1>
    <title>COPYRIGHT</title>
    <para>
      Copyright &copy; 2004 &dhusername;
    </para>
  </refsect1>

  <refsect1>
    <title>SEE ALSO</title>
    <para>
conrad's avatar
conrad committed
143 144 145 146
      <citerefentry>
	<refentrytitle>oggzrip</refentrytitle>
	<manvolnum>1</manvolnum>
      </citerefentry>,
conrad's avatar
conrad committed
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
      <citerefentry>
	<refentrytitle>oggzdump</refentrytitle>
	<manvolnum>1</manvolnum>
      </citerefentry>,
      <citerefentry>
	<refentrytitle>oggzdiff</refentrytitle>
	<manvolnum>1</manvolnum>
      </citerefentry>
    </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:
-->