[SCM] ir.lv2/master: man pages improved

mira-guest at users.alioth.debian.org mira-guest at users.alioth.debian.org
Sat Jan 15 22:51:22 UTC 2011


The following commit has been merged in the master branch:
commit dc5bd98588527f6c94acfcee3618b7056bfa0f0d
Author: Jaromír Mikeš <mira.mikes at seznam.cz>
Date:   Sat Jan 15 23:55:43 2011 +0100

    man pages improved

diff --git a/debian/convert4chan.1 b/debian/convert4chan.1
index 1fe3683..5d02a62 100644
--- a/debian/convert4chan.1
+++ b/debian/convert4chan.1
@@ -1,8 +1,9 @@
 .TH CONVERT4CHAN "1" "January 15, 2011" "convert4chan" "convert4chan Manual Page"
 
 .SH NAME
-\fBconvert4chan\fP \- is a utility for converting pairs of stereo impulse response files to to a single 4-channel files.
-ir.lv2 - LV2 IR reverb plugin supports these so-called 'True Stereo' impulses.
+\fBconvert4chan\fP \- is a utility for converting pairs of stereo impulse response files to to a single 'True Stereo' 4-channel files.
+.br
+\fBir.lv2\fP \- LV2 IR reverb plugin supports these so-called 'True Stereo' impulses.
 .br
 .SH USAGE
 .B convert4chan
@@ -16,11 +17,38 @@ or
 .br
 .PP
 .SH DESCRIPTION
+.PP 
+\fBconvert4chan\fP is not itself a generally useful program, but just a utility with very limited scope, Error checking is limited; you are not supposed to run
+convert4chan on your / .
 .PP
-\'True Stereo' impulses are four channel impulses that describe a full convolution matrix (the four channels contain, in order, the convolution paths L->L, L->R, R->L, R->R). You can convert a full directory tree of stereo impulse response files with similar names that end with L.wav and R.wav to 'True Stereo' format. The conversion does not remove the source files so you can use original files as well.
 .br
+You can use it to convert a full directory tree of stereo impulse response files with similar names that end with L.wav and R.wav to 'True Stereo' format, while your original files in directory stay untouched and can be later used as impulses as well.
+.PP 
+.br
+\fB\'True Stereo'\fP impulses are four channel impulses that describe a full convolution matrix (the four channels contain, in order, the convolution paths L->L, L->R, R->L, R->R).
+.PP 
+.br
+\fBconvert4chan\fP
+searching for stereo files named:
+.PP 
+.br
+.B root/somewhere/somethingL.wav
+.br
+.B root/somewhere/somethingR.wav
+.PP 
+.br
+and covert them to:
+.PP 
+.br
+.B root/somewhere/something4.wav
+.PP 
+.PP 
+.br  
+
+\fBconvert4chan\fP supports filenames ending in .wav by design, but it is possible that in future will supports other audio formats too (It could all audio formats supported by libsndfile in theory.)
 .PP
-More information can be found on the project website http://factorial.hu/plugins/lv2/ir.
+More information can be found on the project website
+.B http://factorial.hu/plugins/lv2/ir.
 
 .SH AUTHOR
 This manual page was written by Jaromír Mikeš <mira.mikes at seznam.cz>,

-- 
ir.lv2 packaging



More information about the pkg-multimedia-commits mailing list