Improve help/man page of para_filter.

[paraslash.git] / oggdec_filter.ggo

diff --git a/oggdec_filter.ggo b/oggdec_filter.ggo
index 70f73452e8600edb929feffa929549276144abdb..e2d653d7dafc8674ea95eff31197597284ae29e3 100644 (file)
--- a/oggdec_filter.ggo
+++ b/oggdec_filter.ggo
@@ -1,2 +1,21 @@
-option "bufsize" b "size of output buffer" int typestr="kilobyte" default="128" optional
-option "initial_buffer" i "size of initial input buffer" int typestr="kilobyte" default="16" optional
+option "bufsize" b
+#~~~~~~~~~~~~~~~~~
+"size of output buffer"
+int typestr="kilobyte"
+default="128"
+optional
+details="
+       Increase this if you encounter output buffer overrun errors. Smaller
+       values make the oggdec filter use less memory.
+"
+
+option "initial_buffer" i
+#~~~~~~~~~~~~~~~~~~~~~~~~
+"size of initial input buffer"
+int typestr="kilobyte"
+default="16"
+optional
+details="
+       On startup, defer decoding until that many kilobytes are
+       available in the input buffer.
+"