doc: Move filter examples to man page.
authorAndre Noll <maan@tuebingen.mpg.de>
Mon, 6 Nov 2017 17:02:57 +0000 (18:02 +0100)
committerAndre Noll <maan@tuebingen.mpg.de>
Wed, 3 Jan 2018 19:05:15 +0000 (20:05 +0100)
para_filter(1) is a better place for examples than the user manual
because the man pages explain one command command while purpose of
the manual is to describe the connection and the interaction of the
various commands.

m4/lls/filter.suite.m4
web/manual.md

index 0cd69ebd311b7a008f9a8731ebbba3a9a8b3b65b..23d5ed01f7600cd0f4bb754a6a4b3aec0626a125 100644 (file)
@@ -35,3 +35,15 @@ version-string = GIT_VERSION()
                        through all given filters (in a single thread without copying the
                        data). The same filter may appear more than once, and order matters.
                [/help]
+[section Examples]
+       .IP \(bu 4
+       Decode a wma file to wav format:
+       .EX
+       \       para_filter -f wmadec -f wav < file.wma > file.wav
+       .EE
+       .IP \(bu 4
+       Amplify a raw audio file by a factor of 1.5:
+       .EX
+       \       para_filter -f amp --amp 32 < foo.raw > bar.raw
+       .EE
+[/section]
index f041b3da77fcfb1402211b0cf102e47a5fbb08fc..23966565a50040379fc524736f92093bc57150ef 100644 (file)
@@ -1755,17 +1755,6 @@ Both filters require almost no additional computing time, even when
 operating on uncompressed audio streams, since data buffers are simply
 "pushed down" rather than copied.
 
-Examples
---------
-
--> Decode an mp3 file to wav format:
-
-       para_filter -f mp3dec -f wav < file.mp3 > file.wav
-
--> Amplify a raw audio file by a factor of 1.5:
-
-       para_filter -f amp --amp 32 < foo.raw > bar.raw
-
 ======
 Output
 ======