]> git.0d.be Git - jackwsmeter.git/blob - jackwsmeter.1
update NEWS file with new change
[jackwsmeter.git] / jackwsmeter.1
1 .TH jackwsmeter "1" "1" "July 2014"
2 .SH NAME
3 jackwsmeter \- jack meter over websockets
4 .SH SYNOPSYS
5 .B jackswmeter
6 .RI [ options ]
7 .RI portname
8 .RI [ portname ]
9 .RI [ portname ]
10 .RI ...
11 .br
12 .SH DESCRIPTION
13 \fBjackwsmeter\fR get the signal values of the audio signals that flow
14 through JACK ports and make the peak levels available over a websocket
15 link.
16
17 .SH OPTIONS
18 jackwsmeter supports up to 20 input ports, they may be created connected
19 to existing output ports, or unconnected if invalid port names are given.
20
21 A summary of options is included below.
22
23 .TP
24 .B \-p, \-\-port=PORT
25 .br
26 Use PORT as the HTTP/Websocket port, instead of the default 7681
27 .TP
28 .B \-i, \-\-interface=INTERFACE
29 Bind to the specified interface
30 .TP
31 .B \-\-ssl-cert=FILEPATH, --ssl-private-key=FILEPATH
32 Use the specified certificate and private key to secure the connection
33 .TP
34 .B \-d, \-\-daemonize
35 Daemonize the process
36 .TP
37 .B \-n, \-\-name=NAME
38 Register as a jack client with the specified NAME, instead of the default jackswmeter
39
40 .SH EXAMPLE
41 .PP
42 Start in foreground connected to two exiting output ports, open your browser
43 at http://localhost:7681 afterwards.
44 .IP
45 \fBjackwsmeter\fR system:capture_1 system:capture_2
46
47 .SH SEE ALSO
48 .BR jackd (1),
49 .BR jackmeter (1),
50 .BR meterbridge (1)
51 .br
52
53 .SH AUTHOR
54 Frederic Peters <fpeters@0d.be>