From: Andre Noll <maan@systemlinux.org>
Date: Sun, 30 Nov 2008 14:24:58 +0000 (+0100)
Subject: oggdec_filter.ggo: Add more documentation.
X-Git-Tag: v0.3.3~3
X-Git-Url: http://git.tuebingen.mpg.de/?p=paraslash.git;a=commitdiff_plain;h=5c575441c5ac69d3107d8032c1c1d2d7f5c72ee1

oggdec_filter.ggo: Add more documentation.
---

diff --git a/oggdec_filter.ggo b/oggdec_filter.ggo
index 70f73452..f088b937 100644
--- 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="
+	The oggdec filter waits until at least that many bytes are available
+	in the input buffer.
+"