chiark - git - mdw - disorder/blob - doc/disorder-decode.8.in

   1 .\" -*-nroff-*-
   2 .\"
   3 .\" Copyright (C) 2007, 2008 Richard Kettlewell
   4 .\"
   5 .\" This program is free software; you can redistribute it and/or modify
   6 .\" it under the terms of the GNU General Public License as published by
   7 .\" the Free Software Foundation; either version 2 of the License, or
   8 .\" (at your option) any later version.
   9 .\"
  10 .\" This program is distributed in the hope that it will be useful, but
  11 .\" WITHOUT ANY WARRANTY; without even the implied warranty of
  12 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 .\" General Public License for more details.
  14 .\"
  15 .\" You should have received a copy of the GNU General Public License
  16 .\" along with this program; if not, write to the Free Software
  17 .\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  18 .\" USA
  19 .\"
  20 .TH disorder-decode 8
  21 .SH NAME
  22 disorder-decode \- DisOrder audio decoder
  23 .SH SYNOPSIS
  24 .B disorder\-decode
  25 .I PATH
  26 .SH DESCRIPTION
  27 .B disorder\-decode
  28 converts MP3, OGG, FLAC and WAV files into DisOrders "raw" format.
  29 It is therefore suitable for use as an
  30 .B execraw
  31 player.
  32 .PP
  33 It is not intended to be used from the command line.
  34 .SH OPTIONS
  35 .TP
  36 .B \-\-help\fR, \fB\-h
  37 Display a usage message.
  38 .TP
  39 .B \-\-version\fR, \fB\-V
  40 Display version number.
  41 .SH LIMITATIONS
  42 OGG files with multiple bitstreams are not supported.
  43 .PP
  44 All sample sizes must be multiples of 8 bits (currently).
  45 .PP
  46 WAV files with any kind of compression are not supported.
  47 .SH "SEE ALSO"
  48 .BR disorderd (8),
  49 .BR disorder_config (5)