[SCM] zita-alsa-pcmi/master: adding manpages (Closes: #716677)

[zmoelnig-guest at users.alioth.debian.org]

The following commit has been merged in the master branch:
commit 6104841884a29430e35468b587fe7652f4481e90
Author: IOhannes m zmoelnig <zmoelnig at umlautO.umlaeute.mur.at>
Date:   Thu Jul 11 13:58:12 2013 +0200

    adding manpages (Closes: #716677)
    
    made up some manpages, based on the information found in the
    source code and the internet.

diff --git a/debian/alsa_delay.1 b/debian/alsa_delay.1
new file mode 100644
index 0000000..5684ab0
--- /dev/null
+++ b/debian/alsa_delay.1
@@ -0,0 +1,56 @@
+.TH zita-alsa-pcmi "1" "July 2013"
+.SH NAME
+alsa_delay \- measure round-trip latency of a soundcard
+.SH SYNOPSIS
+.B alsa_delay
+.RI playdev
+.RI captdev
+.RI fsamp
+.RI frsize
+.RI nfrags
+.SH DESCRIPTION
+This tool can be used to measure the round-trip latency of a soundcard.
+To do this, start the program and connect like this:
+.nf
+  alsa_delay -> playdev -> cable from soundcard output to input -> captdev -> alsa_delay
+.fi
+.PP
+.BR alsa_delay
+should be able to measure the round-trip latency with an accuracy of
+around 1/1000 of a sample.
+The assumption is, that the latency is more or less independent of frequency,
+and that the cable between soundcard output and input has virtually zero
+latency.
+.SH ARGUMENTS
+.TP
+\fBplaydev\fR
+ALSA playback device (e.g.: hw:0)
+.TP
+\fBcaptdev\fR
+ALSA capture device (e.g.: hw:0)
+.TP
+\fBfsamp\fR
+Sample rate (e.g.: 48000)
+.TP
+\fBfrsize\fR
+Period size (e.g.: 256)
+.TP
+\fBnfrags\fR
+Number of fragments (e.g.: 2)
+.SH EXAMPLES
+This will measure and display the round-trip latency of soundcard
+.BR hw:0
+using 48kHz samplerate, and 10 fragments each 2048 samples.
+.nf
+  alsa_delay hw:0 hw:0 48000 2048 10
+.fi
+.SH NOTES
+.BR alsa_delay
+is a port of
+.BR jack_delay
+(by the same author) to ALSA.
+.SH "AUTHOR"
+zita-alsa-pcmi was written by Fons Adriaensen <fons at linuxaudio.org>.
+.PP
+This manual page was written by IOhannes m zmoelnig <zmoelnig at iem.at>
+for the Debian project (but may be used by others).
diff --git a/debian/alsa_loopback.1 b/debian/alsa_loopback.1
new file mode 100644
index 0000000..f7bd7b1
--- /dev/null
+++ b/debian/alsa_loopback.1
@@ -0,0 +1,50 @@
+.TH zita-alsa-pcmi "1" "July 2013"
+.SH NAME
+alsa_loopback \- loop back the first two channels of a alsa device to another device
+.SH SYNOPSIS
+.B alsa_loopback
+.RI playdev
+.RI captdev
+.RI fsamp
+.RI frsize
+.RI nfrags
+.SH DESCRIPTION
+This tool is mainly for testing whether a given soundcard works with the
+.BR zita-alsa-pcmi
+library.
+It will send the 1st two channels of the given capture device
+to the playback device, using the specified settings.
+.PP
+Note, that this might give massive (ear and equipment damaging) feedback
+if your capture device is connected to a microphone near some speakers
+connected to the playback device.
+.SH ARGUMENTS
+.TP
+\fBplaydev\fR
+ALSA playback device (e.g.: hw:0)
+.TP
+\fBcaptdev\fR
+ALSA capture device (e.g.: hw:0)
+.TP
+\fBfsamp\fR
+Sample rate (e.g.: 48000)
+.TP
+\fBfrsize\fR
+Period size (e.g.: 256)
+.TP
+\fBnfrags\fR
+Number of fragments (e.g.: 2)
+.SH EXAMPLES
+This will loopback the 1st two channels of
+.BR hw:0
+to 
+.BR hw:1
+using 48kHz samplerate, and 10 fragments each 2048 samples.
+.nf
+  alsa_loopback hw:0 hw:1 48000 2048 10
+.fi
+.SH "AUTHOR"
+zita-alsa-pcmi was written by Fons Adriaensen <fons at linuxaudio.org>.
+.PP
+This manual page was written by IOhannes m zmoelnig <zmoelnig at iem.at>
+for the Debian project (but may be used by others).
diff --git a/debian/zita-alsa-pcmi-utils.manpages b/debian/zita-alsa-pcmi-utils.manpages
new file mode 100644
index 0000000..49168f3
--- /dev/null
+++ b/debian/zita-alsa-pcmi-utils.manpages
@@ -0,0 +1,2 @@
+debian/alsa_delay.1
+debian/alsa_loopback.1

-- 
zita-alsa-pcmi packaging