oggz-chop.1.sgml 6.81 KB
Newer Older
conrad's avatar
conrad committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14
<!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. -->
15
  <!ENTITY dhdate      "<date>February 25, 2008</date>">
conrad's avatar
conrad committed
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
  <!-- 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@annodex.net</email>">
  <!ENTITY dhusername  "Annodex Association">
  <!ENTITY dhucpackage "<refentrytitle>oggz-chop</refentrytitle>">
  <!ENTITY dhpackage   "oggz-chop">
                                                                                 <!ENTITY debian      "<productname>Debian GNU/Linux</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
]>

<refentry id="oggz-chop">

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

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

  <refnamediv>
    <refname>&dhpackage;</refname>
    <refpurpose>Chop an Ogg file.
    </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>

      <group>
	<arg choice="opt">-s <parameter>start_time</parameter></arg>
	<arg choice="opt">--start <parameter>start_time</parameter></arg>
      </group>

      <group>
	<arg choice="opt">-e <parameter>end_time</parameter></arg>
	<arg choice="opt">--end <parameter>end_time</parameter></arg>
      </group>

      <arg choice="plain">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> chops a section of an Ogg file.
      It correctly interprets the granulepos timestamps of Ogg Vorbis, Speex,
      FLAC and Theora bitstreams, and all bitstreams of Annodex files.
    </para>
    <para>
      The output file contains copies of the headers of the input file, and
      all the codec data required to correctly decode the content between the
      start and end times specified on the commandline. For codecs with data
      dependencies like video keyframes, the keyframe prior to the starting
      time will be included in the output.
    </para>
    <para>
      Note that <command>&dhpackage</command> operates by copying pages of 
      Ogg data; it does not strip partial packets from the first or last
      data page included in the output. It does however ensure to set the
      end of stream flag on the last page of each logical bitstream.
    </para>
  </refsect1>
  
  <refsect1>
    <title>Options</title>
    <para>
      <command>&dhpackage;</command> accepts the following options:
    </para>
            
    <refsect2>
      <title>Output 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>-s <parameter>start_time</parameter>, --start <parameter>start_time</parameter></term>
	  <listitem><para>Specify the start time of the chopped section to output.
	    </para></listitem>
	</varlistentry>

	<varlistentry>
	  <term>-e <parameter>end_time</parameter>, --end <parameter>end_time</parameter></term>
	  <listitem><para>Specify the end time of the chopped section to output.
	    </para></listitem>
	</varlistentry>
      </variablelist>
	
      <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>

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
  <refsect1>
    <title>Server configuration</title>

    <para>
The following configuration for Apache httpd will enable FastPhoto. As with
most Apache directives, this may of course be restricted to particular
Directories or Locations:
</para>

  <para>
ScriptAlias /fastphoto /usr/local/bin/fastphoto
  </para><para>
Action image/jpeg /fastphoto
  </para>

    <refsect2>
      <title>HTTP/1.1 Cacheability</title>
      <para>
      FastPhoto generates Last-Modified HTTP headers, and
      responds correctly to If-Modified-Since conditional GET requests. 
      </para>

    </refsect2>
  </refsect1>

conrad's avatar
conrad committed
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
  <refsect1>
    <title>AUTHOR</title>
    <para>
      <author>
	&dhfirstname; &dhsurname;
      </author>
      &dhdate
    </para>
  </refsect1>

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

  <refsect1>
    <title>SEE ALSO</title>
    <para>
      <citerefentry>
	<refentrytitle>oggz-validate</refentrytitle>
	<manvolnum>1</manvolnum>
      </citerefentry>,
      <citerefentry>
	<refentrytitle>oggzmerge</refentrytitle>
	<manvolnum>1</manvolnum>
      </citerefentry>,
      <citerefentry>
	<refentrytitle>oggzdump</refentrytitle>
	<manvolnum>1</manvolnum>
      </citerefentry>,
      <citerefentry>
	<refentrytitle>hogg</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:
-->