oggzinfo.1.sgml 6.92 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
<!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>March 10, 2005</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>oggzinfo</refentrytitle>">
  <!ENTITY dhpackage   "oggzinfo">
                                                                                 <!ENTITY debian      "<productname>Debian GNU/Linux</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
]>

<refentry id="oggzinfo">

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

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

  <refnamediv>
    <refname>&dhpackage;</refname>
    <refpurpose>Display information about one or more Ogg files and their bitstreams.
    </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">-l</arg><arg choice="opt">--length</arg></group>
      <group><arg choice="opt">-b</arg><arg choice="opt">--bitrate</arg></group>
      <group><arg choice="opt">-g</arg><arg choice="opt">--page-stats</arg></group>
      <group><arg choice="opt">-p</arg><arg choice="opt">--packet-stats</arg></group>
68
      <group><arg choice="opt">-k</arg><arg choice="opt">--skeleton</arg></group>
conrad's avatar
conrad committed
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
      <group><arg choice="opt">-a</arg><arg choice="opt">--all</arg></group>
      <arg choice="plain" rep="repeat">filename</arg>
    </cmdsynopsis>

    <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>
    </cmdsynopsis>
    
  </refsynopsisdiv>
    
  <refsect1>
    <title>Description</title>
    <para>
      <command>&dhpackage;</command> displays information about one or more
      Ogg files and their bitstreams.
    </para>
  </refsect1>
  
  <refsect1>
    <title>Options</title>
    <para>
      <command>&dhpackage;</command> accepts the following options:
    </para>

    <refsect2>
      <title>Display options</title>
      <variablelist>

	<varlistentry>
	  <term>-l, --length</term>
	  <listitem><para>Display content lengths.</para></listitem>
	</varlistentry>

	<varlistentry>
	  <term>-b, --bitrate</term>
	  <listitem><para>Display bitrate information.</para></listitem>
	</varlistentry>

	<varlistentry>
	  <term>-g, --page-stats</term>
	  <listitem><para>Display Ogg page statistics.</para></listitem>
	</varlistentry>

	<varlistentry>
	  <term>-p, --packet-stats</term>
	  <listitem><para>Display Ogg packet statistics.</para></listitem>
	</varlistentry>
118 119 120 121 122 123
  
	<varlistentry>
	  <term>-k, --skeleton</term>
	  <listitem><para>Display Extra data from OggSkeleton bitstream.</para></listitem>
	</varlistentry>
	
conrad's avatar
conrad committed
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
	<varlistentry>
	  <term>-a, --all</term>
	  <listitem><para>Display all information.</para></listitem>
	</varlistentry>

      </variablelist>
    </refsect2>
            
    <refsect2>
      <title>Miscellaneous options</title>
      <variablelist>

	<varlistentry>
	  <term>-h, --help</term>
	  <listitem><para>Display usage information and exit.</para></listitem>
	</varlistentry>

	<varlistentry>
	  <term>-v, --version</term>
	  <listitem><para>Output version information and exit.</para></listitem>
	</varlistentry>
	
      </variablelist>
    </refsect2>

  </refsect1>

  <refsect1>
    <title>Units of measurement</title>

    <para><command>&dhpackage;</command> displays information using the
      following units:
    </para>

    <refsect2>
      <title>Byte lengths</title>
      <variablelist>

	<varlistentry>
	  <term>bytes</term>
	  <listitem><para>(8 bits)</para></listitem>
	</varlistentry>

	<varlistentry>
	  <term>kB</term>
	  <listitem><para>kilobytes (1024 bytes)</para></listitem>
	</varlistentry>

	<varlistentry>
	  <term>MB</term>
	  <listitem><para>megabytes (1024*1024 bytes)</para></listitem>
	</varlistentry>

	<varlistentry>
	  <term>GB</term>
	  <listitem><para>gigabytes (1024*1024*1024 bytes)</para></listitem>
	</varlistentry>

      </variablelist>
    </refsect2>

    <refsect2>
      <title>Bitrates</title>
      <variablelist>
	
	<varlistentry>
	  <term>bps</term>
	  <listitem><para>bits per second (bit/s)</para></listitem>
	</varlistentry>

	<varlistentry>
	  <term>kbps</term>
	  <listitem><para>kilobits per second (1000 bit/s)</para></listitem>
	</varlistentry>

	<varlistentry>
	  <term>Mbps</term>
	  <listitem><para>megabits per second (1000000 bit/s)</para></listitem>
	</varlistentry>

	<varlistentry>
	  <term>Gbps</term>
	  <listitem><para>gigabits per second (1000000000 bit/s)</para></listitem>
	</varlistentry>
	
      </variablelist>
    </refsect2>
  </refsect1>

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

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

  <refsect1>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
	<refentrytitle>oggzdump</refentrytitle>
	<manvolnum>1</manvolnum>
      </citerefentry>,
      <citerefentry>
	<refentrytitle>oggzrip</refentrytitle>
	<manvolnum>1</manvolnum>
      </citerefentry>,
      <citerefentry>
	<refentrytitle>oggzdiff</refentrytitle>
	<manvolnum>1</manvolnum>
      </citerefentry>
245 246 247 248
      <citerefentry>
	<refentrytitle>hogg</refentrytitle>
	<manvolnum>1</manvolnum>
      </citerefentry>
conrad's avatar
conrad committed
249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269
    </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:
-->