Correct GPL licence to LGPL for files needed to build libjack (3)
[jack2.git] / man / jack_metro.0
blobe38a9542eed333790af832cc6951189d185ca497
1 .TH JACK_METRO "1" "!DATE!" "!VERSION!"
2 .SH NAME
3 jack_metro \- JACK toolkit metronome
4 .SH SYNOPSIS
5 \fBjack_metro\fR [ \fI-n\fR name ] [ \fI-f\fR hz ] [ \fI-D\fR msecs ] [\fI-a\fR % ] [ \fI-d\fR % ] \fI-b\fR bpm 
6 .SH DESCRIPTION
7 \fBjack_metro\fR is a simple metronome for JACK. It generates a
8 synthetic "tick" sound for every beat. Note that is does \fBnot\fR
9 connect its output port by default - to hear the sound it makes you must
10 connect them using some other tool.
11 .SH OPTIONS
12 .TP
13 \fB-n\fR, \fB--name\fR
14 .br
15 Specify a name for this instance of the metronome.
16 .TP
17 \fB-f\fR, \fB--frequency\fR Hz
18 .br
19 Define the frequency of the "tick" in Hz.
20 .TP
21 \fB-D\fR, \fB--duration\fR msecs
22 .br
23 Define the duration of the "tick" in milliseconds.
24 .TP
25 \fB-a\fR, \fB--attack\fR %-age
26 .br
27 Define the duration of the attack phase of the "tick" as a percentage
28 of the duration.
29 .TP
30 \fB-d\fR, \fB--decay\fR %-age
31 .br
32 Define the duration of the decay phase of the "tick" as a percentage
33 of the duration.
34 .TP
35 \fB--b\fR, \fB--bpm\fR bpm
36 .br
37 Define the number of beats per minute.
38 .SH AUTHOR
39 Anthony Van Groningen