From 3a1470de6e286914b8e4101c713928b15a3f3aac Mon Sep 17 00:00:00 2001 From: Andre Noll Date: Mon, 6 Nov 2017 18:02:57 +0100 Subject: [PATCH] doc: Move filter examples to man page. 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 | 12 ++++++++++++ web/manual.md | 11 ----------- 2 files changed, 12 insertions(+), 11 deletions(-) diff --git a/m4/lls/filter.suite.m4 b/m4/lls/filter.suite.m4 index 0cd69ebd..23d5ed01 100644 --- a/m4/lls/filter.suite.m4 +++ b/m4/lls/filter.suite.m4 @@ -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] diff --git a/web/manual.md b/web/manual.md index f041b3da..23966565 100644 --- a/web/manual.md +++ b/web/manual.md @@ -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 ====== -- 2.39.5