sync with disorder.dev
[disorder] / doc / disorder-decode.8.in
index 82f3f8d..91c5996 100644 (file)
@@ -1,3 +1,4 @@
+.\" -*-nroff-*-
 .\"
 .\" Copyright (C) 2007 Richard Kettlewell
 .\"
 .\"
 .\" Copyright (C) 2007 Richard Kettlewell
 .\"
@@ -24,10 +25,18 @@ disorder-decode \- DisOrder audio decoder
 .I PATH
 .SH DESCRIPTION
 .B disorder-decode
 .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.
 therefore suitable for use as an
 .B execraw
 player.
+.PP
+It is not intended to be used from the command line.
+.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)
 .SH "SEE ALSO"
 .BR disorderd (8),
 .BR disorder_config (5)