Going to rename ChangeLog to NEWS
[jackmeter.git] / jack_meter.1
blob4f3519448c095b26648d6601692b8d34a1d7689f
1 .TH jack_meter "1" 0.1 "March 2005"
2 .SH NAME
3 jack_meter \- Console based Digital Peak Meter for JACK
4 .SH SYNOPSYS
5 \fBjack_meter\fR [ \-f \fIfreqency\fR ] [ \-r \fIref-level\fR ]
6 [ \-w \fIwidth\fR ] [ \fI<port>\fR ]
7 .br
8 \fBjack_meter\fR
9 \-h
11 .SH DESCRIPTION
12 \fBjack_meter\fR is a basic console based DPM (Digital Peak Meter).
13 I wrote it for quickly checking remote signal levels, without having to 
14 run X11 to use a pretty graphical meter such as \fBmeterbridge\fR.
16 The port parameter is optional - when missing then you have to connect 
17 up the meter to an input port manually.
19 .SH OPTIONS
20 .TP
21 \fB\-f \fI freqency \fR
22 .br
23 How many times per second to refresh the meter. Default is \fB8\fR.
24 .TP
25 \fB\-r \fI ref-level \fR
26 .br
27 The reference signal level for 0dB on the meter.
28 .TP
29 \fB\-w \fI width \fR
30 .br
31 The width of the meter (number of characters). The default is \fB79\fR,
32 one less than the typical terminal width.
34 .SH SEE ALSO:
35 .br
36 http://www.ecs.soton.ac.uk/~njh/jackmeter/
37 .br
38 http://plugin.org.uk/meterbridge/
39 .br
40 http://jackit.sourceforge.net/
42 .SH AUTHORS
43 Nicholas Humfrey <njh@aelius.com>