X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/ce6c36be6c2df99afd01a7a602debb321322e113..30d855885418ebe3e7bf76fd800909cdf7bb178a:/doc/disorder-decode.8.in diff --git a/doc/disorder-decode.8.in b/doc/disorder-decode.8.in index 522dad2..47884cc 100644 --- a/doc/disorder-decode.8.in +++ b/doc/disorder-decode.8.in @@ -1,5 +1,6 @@ +.\" -*-nroff-*- .\" -.\" Copyright (C) 2007 Richard Kettlewell +.\" Copyright (C) 2007, 2008 Richard Kettlewell .\" .\" 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 @@ -20,21 +21,29 @@ .SH NAME disorder-decode \- DisOrder audio decoder .SH SYNOPSIS -.B disorder-decode +.B disorder\-decode .I PATH .SH DESCRIPTION -.B disorder-decode -converts MP3, OGG and WAV 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 -WAV files with sample sizes that are not a multiple of 8 bits, or any -kind of compression, are not supported. +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)