chiark / gitweb /
@image expansion
[disorder] / doc / disorder-decode.8.in
index 522dad26e6c238cce452209cc403a2f4448225c9..47884cc30b017e3432e9a8c1674924c0233183cb 100644 (file)
@@ -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
 .\"
 .\" 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
 .SH NAME
 disorder-decode \- DisOrder audio decoder
 .SH SYNOPSIS
 .SH NAME
 disorder-decode \- DisOrder audio decoder
 .SH SYNOPSIS
-.B disorder-decode
+.B disorder\-decode
 .I PATH
 .SH DESCRIPTION
 .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.
 .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
 .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)
 .SH "SEE ALSO"
 .BR disorderd (8),
 .BR disorder_config (5)