X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/fcdcbfee1fbd5d821b210f8593d0725d001ffd01..900fa0b8688dd81e08ae487dfe3ddcbbb0098cc1:/doc/disorder-decode.8.in diff --git a/doc/disorder-decode.8.in b/doc/disorder-decode.8.in index 82f3f8d..b240ff8 100644 --- a/doc/disorder-decode.8.in +++ b/doc/disorder-decode.8.in @@ -1,33 +1,47 @@ +.\" -*-nroff-*- .\" -.\" Copyright (C) 2007 Richard Kettlewell +.\" Copyright (C) 2007, 2008 Richard Kettlewell .\" -.\" This program is free software; you can redistribute it and/or modify +.\" This program is free software: you can redistribute it and/or modify .\" it under the terms of the GNU General Public License as published by -.\" the Free Software Foundation; either version 2 of the License, or +.\" the Free Software Foundation, either version 3 of the License, or .\" (at your option) any later version. -.\" -.\" This program is distributed in the hope that it will be useful, but -.\" WITHOUT ANY WARRANTY; without even the implied warranty of -.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -.\" General Public License for more details. -.\" +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" .\" You should have received a copy of the GNU General Public License -.\" along with this program; if not, write to the Free Software -.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 -.\" USA +.\" along with this program. If not, see . .\" .TH disorder-decode 8 .SH NAME disorder-decode \- DisOrder audio decoder .SH SYNOPSIS -.B disorder-decode +.B disorder\-decode .I PATH .SH DESCRIPTION -.B disorder-decode -converts MP3 and OGG files into DisOrders "raw" format. It is -therefore suitable for use as an +.B disorder\-decode +converts MP3, OGG, FLAC and WAV files into DisOrders "raw" format. +It is therefore suitable for use as an .B execraw player. +.PP +It is not intended to be used from the command line. +.SH OPTIONS +.TP +.B \-\-help\fR, \fB\-h +Display a usage message. +.TP +.B \-\-version\fR, \fB\-V +Display version number. +.SH LIMITATIONS +OGG files with multiple bitstreams are not supported. +.PP +All sample sizes must be multiples of 8 bits (currently). +.PP +WAV files with any kind of compression are not supported. .SH "SEE ALSO" .BR disorderd (8), .BR disorder_config (5)