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 3 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,
  11 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 .\" GNU 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, see <http://www.gnu.org/licenses/>.
  17 .\"
  18 .TH disorder-decode 8
  19 .SH NAME
  20 disorder-decode \- DisOrder audio decoder
  21 .SH SYNOPSIS
  22 .B disorder\-decode
  23 .I PATH
  24 .SH DESCRIPTION
  25 .B disorder\-decode
  26 converts MP3, OGG, FLAC and WAV files into DisOrders "raw" format.
  27 It is therefore suitable for use as an
  28 .B execraw
  29 player.
  30 .PP
  31 It is not intended to be used from the command line.
  32 .SH OPTIONS
  33 .TP
  34 .B \-\-help\fR, \fB\-h
  35 Display a usage message.
  36 .TP
  37 .B \-\-version\fR, \fB\-V
  38 Display version number.
  39 .SH LIMITATIONS
  40 OGG files with multiple bitstreams are not supported.
  41 .PP
  42 All sample sizes must be multiples of 8 bits (currently).
  43 .PP
  44 WAV files with any kind of compression are not supported.
  45 .SH "SEE ALSO"
  46 .BR disorderd (8),
  47 .BR disorder_config (5)