chiark / gitweb /
insufficient rights always produces 51x response
[disorder] / doc / disorder-decode.8.in
index 82f3f8d2bfc4478d89721a2e3680f74fef57441e..f4ae673a3829ff5d9ed407736c6f80cf5857bf75 100644 (file)
@@ -1,3 +1,4 @@
+.\" -*-nroff-*-
 .\"
 .\" Copyright (C) 2007 Richard Kettlewell
 .\"
@@ -24,10 +25,25 @@ disorder-decode \- DisOrder audio decoder
 .I PATH
 .SH DESCRIPTION
 .B disorder-decode
-converts MP3 and OGG files into DisOrders "raw" format.  It is
+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)