man/flac.sgml

   1 <!doctype refentry PUBLIC "-//Davenport//DTD DocBook V3.0//EN" [
   2
   3   <!-- Fill in your name for FIRSTNAME and SURNAME. -->
   4   <!ENTITY dhfirstname "<firstname>Matt</firstname>">
   5   <!ENTITY dhsurname   "<surname>Zimmerman</surname>">
   6   <!-- Please adjust the date whenever revising the manpage. -->
   7   <!ENTITY dhdate      "<date>February 7, 2001</date>">
   8   <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
   9        allowed: see man(7), man(1). -->
  10   <!ENTITY dhsection   "<manvolnum>1</manvolnum>">
  11   <!ENTITY dhemail     "<email>mdz@debian.org</email>">
  12   <!ENTITY dhusername  "Matt Zimmerman">
  13   <!ENTITY dhucpackage "<refentrytitle>FLAC</refentrytitle>">
  14   <!ENTITY dhpackage   "flac">
  15
  16   <!ENTITY debian      "<productname>Debian GNU/Linux</productname>">
  17   <!ENTITY gnu         "<acronym>GNU</acronym>">
  18 ]>
  19
  20 <refentry>
  21   <docinfo>
  22     <address>
  23         &dhemail;
  24     </address>
  25     <author>
  26         &dhfirstname;
  27         &dhsurname;
  28       </author>
  29         <copyright>
  30                     <year>2000</year>
  31                     <holder>&dhusername;</holder>
  32         </copyright>
  33             &dhdate;
  34         </docinfo>
  35   <refmeta>
  36       &dhucpackage;
  37
  38       &dhsection;
  39     </refmeta>
  40       <refnamediv>
  41                    <refname>&dhpackage;</refname>
  42
  43         <refpurpose>Free Lossless Audio Codec</refpurpose>
  44       </refnamediv>
  45         <refsynopsisdiv>
  46           <cmdsynopsis>
  47             <command>flac</command>
  48
  49             <arg><option><replaceable>OPTION</replaceable></option></arg>
  50             <arg choice=plain><replaceable>infile</replaceable></arg>
  51             <arg choice=plain><replaceable>outfile</replaceable></arg>
  52           </cmdsynopsis>
  53         </refsynopsisdiv>
  54         <refsect1>
  55           <title>DESCRIPTION</title>
  56
  57           <para>This manual page documents briefly the
  58             <command>flac</command> command.</para>
  59
  60           <para>This manual page was written for the &debian;
  61             distribution because the original program does not have a
  62             manual page.  Instead, it has documentation in HTML
  63             format; see below.</para>
  64
  65         </refsect1>
  66         <refsect1>
  67           <title>OPTIONS</title>
  68
  69           <para>A summary of options is included below.  For a complete
  70           description, see the HTML documentation.</para>
  71
  72           <refsect2>
  73             <title>Generic Options</title>
  74
  75             <variablelist>
  76               <varlistentry>
  77                 <term><option>-d</option>
  78                 </term>
  79                 <listitem>
  80                   <para>Decode (default behavior is encode)</para>
  81                 </listitem>
  82               </varlistentry>
  83
  84               <varlistentry>
  85                 <term><option>-t</option>
  86                 </term>
  87                 <listitem>
  88                   <para>Test a flac encoded file (same as -d
  89                     except no decoded file is written)</para>
  90                 </listitem>
  91               </varlistentry>
  92
  93               <varlistentry>
  94                 <term><option>-a</option>
  95                 </term>
  96                 <listitem>
  97                   <para>Analyze a flac encoded file (same as -d
  98                     except an analysis file is written)</para>
  99                 </listitem>
 100               </varlistentry>
 101
 102               <varlistentry>
 103                 <term><option>-s</option>
 104                 </term>
 105                 <listitem>
 106                   <para>Silent mode (do not write runtime
 107                     encode/decode statistics to stdout)</para>
 108                 </listitem>
 109               </varlistentry>
 110
 111               <varlistentry>
 112                 <term><option>--skip</option> <replaceable>samples</replaceable></term>
 113                 <listitem>
 114                   <para>Skip the specified number of samples at the
 115                     beginning of the input file (can be used for both
 116                     encoding and decoding)</para>
 117                 </listitem>
 118               </varlistentry>
 119
 120             </variablelist>
 121           </refsect2>
 122
 123           <refsect2>
 124             <title>Encoding Options</title>
 125
 126             <variablelist>
 127               <varlistentry>
 128                 <term><option>--lax</option></term>
 129
 130                 <listitem>
 131                   <para>Allow encoder to generate non-Subset
 132                     files</para>
 133                 </listitem>
 134               </varlistentry>
 135
 136               <varlistentry>
 137                 <term><option>-P</option> <replaceable>bytes</replaceable></term>
 138
 139                 <listitem>
 140                   <para>Tell the encoder to write a PADDING metadata
 141                     block of the given length (in bytes) after the
 142                     STREAMINFO block.  -P 0 implies no PADDING block,
 143                     which is the default.  This is useful if you plan
 144                     to tag the file later with an APPLICATION block;
 145                     instead of having to rewrite the entire file later
 146                     just to insert your block, you can write directly
 147                     over the PADDING block.</para>
 148                 </listitem>
 149               </varlistentry>
 150
 151               <varlistentry>
 152                 <term><option>-b</option> <replaceable>blocksize</replaceable></term>
 153
 154                 <listitem>
 155                   <para>Default is 1152 for -l 0, else 4608; should
 156                     be 192/576/1152/2304/4608 (unless --lax is
 157                     used)</para>
 158                 </listitem>
 159               </varlistentry>
 160
 161               <varlistentry>
 162                 <term><option>-m</option></term>
 163
 164                 <listitem>
 165                   <para>Try mid-side coding for each frame (stereo
 166                     input only)</para>
 167                 </listitem>
 168               </varlistentry>
 169
 170               <varlistentry>
 171                 <term><option>-m</option></term>
 172
 173                 <listitem>
 174                   <para>Loose mid-side coding for all frames (stereo
 175                     input only)</para>
 176                 </listitem>
 177               </varlistentry>
 178
 179               <varlistentry>
 180                 <term><option>-0</option>..<option>-9</option></term>
 181
 182                 <listitem>
 183                   <para>Fastest compression..highest compression
 184                     (default is -6).  These are synonyms for other
 185                     options:</para>
 186
 187                   <variablelist>
 188                     <varlistentry>
 189                       <term><option>-0</option></term>
 190
 191                       <listitem>
 192                         <para>Synonymous with -l 0</para>
 193                       </listitem>
 194                     </varlistentry>
 195
 196                     <varlistentry>
 197                       <term><option>-1</option></term>
 198
 199                       <listitem>
 200                         <para>Synonymous with -l 0 -M</para>
 201                       </listitem>
 202                     </varlistentry>
 203
 204                     <varlistentry>
 205                       <term><option>-2</option></term>
 206
 207                       <listitem>
 208                         <para>Synonymous with -l 0 -m -r # (# is
 209                           automatically determined by the block
 210                           size)</para>
 211                       </listitem>
 212                     </varlistentry>
 213
 214                     <varlistentry>
 215                       <term><option>-3</option></term>
 216
 217                       <listitem>
 218                         <para>Reserved</para>
 219                       </listitem>
 220                     </varlistentry>
 221
 222                     <varlistentry>
 223                       <term><option>-4</option></term>
 224
 225                       <listitem>
 226                         <para>Synonymous with -l 8</para>
 227                       </listitem>
 228                     </varlistentry>
 229
 230                     <varlistentry>
 231                       <term><option>-5</option></term>
 232
 233                       <listitem>
 234                         <para>Synonymous with -l 8 -M</para>
 235                       </listitem>
 236                     </varlistentry>
 237
 238                     <varlistentry>
 239                       <term><option>-6</option></term>
 240
 241                       <listitem>
 242                         <para>Synonymous with -l 8 -m -r # (# is
 243                           automatically determined by the block
 244                           size)</para>
 245                       </listitem>
 246                     </varlistentry>
 247
 248                     <varlistentry>
 249                       <term><option>-7</option></term>
 250
 251                       <listitem>
 252                         <para>Reserved</para>
 253                       </listitem>
 254                     </varlistentry>
 255
 256                     <varlistentry>
 257                       <term><option>-8</option></term>
 258
 259                       <listitem>
 260                         <para>Synonymous with -l 32 -m -r # (# is
 261                           automatically determined by the block
 262                           size)</para>
 263                       </listitem>
 264                     </varlistentry>
 265
 266                     <varlistentry>
 267                       <term><option>-9</option></term>
 268
 269                       <listitem>
 270                         <para>Synonymous with -l 32 -m -e -r 99 -p
 271                           (very slow!)</para>
 272                       </listitem>
 273                     </varlistentry>
 274                   </variablelist>
 275
 276                 </listitem>
 277
 278
 279               </varlistentry>
 280
 281               <varlistentry>
 282                 <term><option>-e</option></term>
 283
 284                 <listitem>
 285                   <para>Do exhaustive model search
 286                     (expensive!)</para>
 287                 </listitem>
 288               </varlistentry>
 289
 290               <varlistentry>
 291                 <term><option>-l</option> <replaceable>max_lpc_order</replaceable></term>
 292
 293                 <listitem>
 294                   <para>0 => use only fixed predictors</para>
 295                 </listitem>
 296               </varlistentry>
 297
 298               <varlistentry>
 299                 <term><option>-p</option></term>
 300
 301                 <listitem>
 302                   <para>Do exhaustive search of LP coefficient
 303                     quantization (expensive!).  Overrides -q,
 304                     does nothing if using -l 0</para>
 305                 </listitem>
 306               </varlistentry>
 307
 308               <varlistentry>
 309                 <term><option>-q</option> <replaceable>bits</replaceable></term>
 310
 311                 <listitem>
 312                   <para>Precision of the quantized linear-predictor
 313                     coefficients, 0 => let encoder decide (min is 5,
 314                     default is 0)</para>
 315                 </listitem>
 316               </varlistentry>
 317
 318               <varlistentry>
 319                 <term><option>-r</option> <replaceable>level</replaceable></term>
 320
 321                 <listitem>
 322                   <para>Rice parameter optimization level (0..99). 0
 323                     => none, default is 0, above 4 doesn't usually
 324                     help much)</para>
 325                 </listitem>
 326               </varlistentry>
 327
 328               <varlistentry>
 329                 <term><option>-V</option></term>
 330
 331                 <listitem>
 332                   <para>Verify a correct encoding by decoding the
 333                     output in parallel and comparing to the
 334                     original</para>
 335                 </listitem>
 336               </varlistentry>
 337
 338               <varlistentry>
 339                 <term><option>-m-</option> <option>-M-</option> <option>-e-</option> <option>-p-</option> <option>-V-</option> <option>--lax-</option>
 340                 </term>
 341
 342                 <listitem>
 343                   <para>These flags can be used to invert the sense
 344                     of the corresponding normal option.</para>
 345                 </listitem>
 346               </varlistentry>
 347             </variablelist>
 348
 349           </refsect2>
 350           <refsect2>
 351             <title>Format Options</title>
 352
 353             <variablelist>
 354               <varlistentry>
 355                 <term><option>-fb</option></term>
 356
 357                 <listitem>
 358                   <para>Big-endian byte order</para>
 359                 </listitem>
 360               </varlistentry>
 361
 362               <varlistentry>
 363                 <term><option>-fl</option></term>
 364
 365                 <listitem>
 366                   <para>Little-endian byte order</para>
 367                 </listitem>
 368               </varlistentry>
 369
 370               <varlistentry>
 371                 <term><option>-fc</option>
 372                   <replaceable>channels</replaceable></term>
 373
 374                 <listitem>
 375                   <para>Set number of channels.</para>
 376                 </listitem>
 377               </varlistentry>
 378
 379               <varlistentry>
 380                 <term><option>-fp</option>
 381                   <replaceable>bits_per_sample</replaceable></term>
 382
 383                 <listitem>
 384                   <para>Set bits per sample.</para>
 385                 </listitem>
 386               </varlistentry>
 387
 388               <varlistentry>
 389                 <term><option>-fs</option>
 390                   <replaceable>sample_rate</replaceable></term>
 391
 392                 <listitem>
 393                   <para>Set sample rate (in Hz).</para>
 394                 </listitem>
 395               </varlistentry>
 396
 397               <varlistentry>
 398                 <term><option>-fu</option></term>
 399
 400                 <listitem>
 401                   <para>Unsigned samples (default is signed)</para>
 402                 </listitem>
 403               </varlistentry>
 404
 405               <varlistentry>
 406                 <term><option>-fr</option></term>
 407
 408                 <listitem>
 409                   <para>Force to raw format (even if filename ends
 410                     in <filename>.wav</filename>).</para>
 411                 </listitem>
 412               </varlistentry>
 413
 414               <varlistentry>
 415                 <term><option>-fw</option></term>
 416
 417                 <listitem>
 418                   <para>Force to RIFF WAVE.</para>
 419                 </listitem>
 420               </varlistentry>
 421
 422             </variablelist>
 423           </refsect2>
 424
 425         </refsect1>
 426           <refsect1>
 427             <title>SEE ALSO</title>
 428
 429             <para>The programs are documented fully by HTML format
 430               documentation, available in
 431               <filename>/usr/share/doc/flac/html</filename> on
 432                 &debian; systems.</para>
 433           </refsect1>
 434           <refsect1>
 435             <title>AUTHOR</title>
 436
 437             <para>This manual page was written by &dhusername; &dhemail; for
 438               the &debian; system (but may be used by others).</para>
 439
 440             <!-- <para>Permission is granted to copy, distribute and/or modify
 441             this document under the terms of the <acronym>GNU</acronym> Free
 442             Documentation License, Version 1.1 or any later version
 443             published by the Free Software Foundation; with no Invariant
 444             Sections, no Front-Cover Texts and no Back-Cover Texts.  A copy
 445             of the license can be found under
 446           <filename>/usr/share/common-licenses/FDL</filename>.</para> -->
 447
 448         </refsect1>
 449       </refentry>
 450
 451         <!-- Keep this comment at the end of the file
 452               Local variables:
 453               mode: sgml
 454               sgml-omittag:t
 455               sgml-shorttag:t
 456               sgml-minimize-attributes:nil
 457               sgml-always-quote-attributes:t
 458               sgml-indent-step:2
 459               sgml-indent-data:t
 460               sgml-parent-document:nil
 461               sgml-default-dtd-file:nil
 462               sgml-exposed-tags:nil
 463               sgml-local-catalogs:nil
 464               sgml-local-ecat-files:nil
 465               End:
 466               -->